blob: bcc5551c6424bd71e6cae73a2e61ad67c26ca330 [file] [log] [blame]
Thomas Gleixnerddc64d02019-05-31 01:09:24 -07001// SPDX-License-Identifier: GPL-2.0-only
Jesper Dangaard Broueraecd67b2018-01-03 11:25:13 +01002/* net/core/xdp.c
3 *
4 * Copyright (c) 2017 Jesper Dangaard Brouer, Red Hat Inc.
Jesper Dangaard Broueraecd67b2018-01-03 11:25:13 +01005 */
Jakub Kicinski05296622018-07-11 20:36:40 -07006#include <linux/bpf.h>
David Vernet400031e2023-02-01 11:30:15 -06007#include <linux/btf.h>
Stanislav Fomichev3d76a4d2023-01-19 14:15:26 -08008#include <linux/btf_ids.h>
Jakub Kicinski05296622018-07-11 20:36:40 -07009#include <linux/filter.h>
Jesper Dangaard Broueraecd67b2018-01-03 11:25:13 +010010#include <linux/types.h>
11#include <linux/mm.h>
Jakub Kicinski05296622018-07-11 20:36:40 -070012#include <linux/netdevice.h>
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +020013#include <linux/slab.h>
14#include <linux/idr.h>
15#include <linux/rhashtable.h>
Jesper Dangaard Brouer34cc0b32020-05-14 12:49:33 +020016#include <linux/bug.h>
Yunsheng Lina9ca9f92023-08-04 20:05:24 +020017#include <net/page_pool/helpers.h>
Jesper Dangaard Broueraecd67b2018-01-03 11:25:13 +010018
Eric Dumazetaa70d2d2024-03-06 16:00:23 +000019#include <net/hotdata.h>
Jesper Dangaard Broueraecd67b2018-01-03 11:25:13 +010020#include <net/xdp.h>
Jesper Dangaard Brouerf033b682019-06-18 15:05:58 +020021#include <net/xdp_priv.h> /* struct xdp_mem_allocator */
22#include <trace/events/xdp.h>
Björn Töpel2b43470a2020-05-20 21:20:53 +020023#include <net/xdp_sock_drv.h>
Jesper Dangaard Broueraecd67b2018-01-03 11:25:13 +010024
25#define REG_STATE_NEW 0x0
26#define REG_STATE_REGISTERED 0x1
27#define REG_STATE_UNREGISTERED 0x2
28#define REG_STATE_UNUSED 0x3
29
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +020030static DEFINE_IDA(mem_id_pool);
31static DEFINE_MUTEX(mem_id_lock);
32#define MEM_ID_MAX 0xFFFE
33#define MEM_ID_MIN 1
34static int mem_id_next = MEM_ID_MIN;
35
36static bool mem_id_init; /* false */
37static struct rhashtable *mem_id_ht;
38
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +020039static u32 xdp_mem_id_hashfn(const void *data, u32 len, u32 seed)
40{
41 const u32 *k = data;
42 const u32 key = *k;
43
Pankaj Bharadiyac5936422019-12-09 10:31:43 -080044 BUILD_BUG_ON(sizeof_field(struct xdp_mem_allocator, mem.id)
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +020045 != sizeof(u32));
46
NeilBrown9f9a7072018-06-18 12:52:50 +100047 /* Use cyclic increasing ID as direct hash key */
48 return key;
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +020049}
50
51static int xdp_mem_id_cmp(struct rhashtable_compare_arg *arg,
52 const void *ptr)
53{
54 const struct xdp_mem_allocator *xa = ptr;
55 u32 mem_id = *(u32 *)arg->key;
56
57 return xa->mem.id != mem_id;
58}
59
60static const struct rhashtable_params mem_id_rht_params = {
61 .nelem_hint = 64,
62 .head_offset = offsetof(struct xdp_mem_allocator, node),
63 .key_offset = offsetof(struct xdp_mem_allocator, mem.id),
Pankaj Bharadiyac5936422019-12-09 10:31:43 -080064 .key_len = sizeof_field(struct xdp_mem_allocator, mem.id),
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +020065 .max_size = MEM_ID_MAX,
66 .min_size = 8,
67 .automatic_shrinking = true,
68 .hashfn = xdp_mem_id_hashfn,
69 .obj_cmpfn = xdp_mem_id_cmp,
70};
71
72static void __xdp_mem_allocator_rcu_free(struct rcu_head *rcu)
73{
74 struct xdp_mem_allocator *xa;
75
76 xa = container_of(rcu, struct xdp_mem_allocator, rcu);
77
78 /* Allow this ID to be reused */
Christophe JAILLET6a571892024-01-20 08:02:20 +010079 ida_free(&mem_id_pool, xa->mem.id);
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +020080
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +020081 kfree(xa);
82}
83
Jonathan Lemonc3f812c2019-11-14 14:13:00 -080084static void mem_xa_remove(struct xdp_mem_allocator *xa)
85{
86 trace_mem_disconnect(xa);
87
Jonathan Lemonc3f812c2019-11-14 14:13:00 -080088 if (!rhashtable_remove_fast(mem_id_ht, &xa->node, mem_id_rht_params))
89 call_rcu(&xa->rcu, __xdp_mem_allocator_rcu_free);
Jonathan Lemonc3f812c2019-11-14 14:13:00 -080090}
91
92static void mem_allocator_disconnect(void *allocator)
Jesper Dangaard Brouer99c07c42019-06-18 15:05:47 +020093{
94 struct xdp_mem_allocator *xa;
Jonathan Lemonc3f812c2019-11-14 14:13:00 -080095 struct rhashtable_iter iter;
96
Jonathan Lemon86c76c02019-12-03 14:01:14 -080097 mutex_lock(&mem_id_lock);
98
Jonathan Lemonc3f812c2019-11-14 14:13:00 -080099 rhashtable_walk_enter(mem_id_ht, &iter);
100 do {
101 rhashtable_walk_start(&iter);
102
103 while ((xa = rhashtable_walk_next(&iter)) && !IS_ERR(xa)) {
104 if (xa->allocator == allocator)
105 mem_xa_remove(xa);
106 }
107
108 rhashtable_walk_stop(&iter);
109
110 } while (xa == ERR_PTR(-EAGAIN));
111 rhashtable_walk_exit(&iter);
Jonathan Lemon86c76c02019-12-03 14:01:14 -0800112
113 mutex_unlock(&mem_id_lock);
Jonathan Lemonc3f812c2019-11-14 14:13:00 -0800114}
115
Toke Høiland-Jørgensen4a48ef72022-01-03 16:08:06 +0100116void xdp_unreg_mem_model(struct xdp_mem_info *mem)
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +0200117{
118 struct xdp_mem_allocator *xa;
Toke Høiland-Jørgensen4a48ef72022-01-03 16:08:06 +0100119 int type = mem->type;
120 int id = mem->id;
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +0200121
Jakub Kicinskia78cae22021-06-25 15:16:12 -0700122 /* Reset mem info to defaults */
Toke Høiland-Jørgensen4a48ef72022-01-03 16:08:06 +0100123 mem->id = 0;
124 mem->type = 0;
Björn Töpeldce5bd62018-08-28 14:44:26 +0200125
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +0200126 if (id == 0)
127 return;
128
Jakub Kicinskia78cae22021-06-25 15:16:12 -0700129 if (type == MEM_TYPE_PAGE_POOL) {
Taehee Yoo59a931c2024-07-12 09:51:16 +0000130 xa = rhashtable_lookup_fast(mem_id_ht, &id, mem_id_rht_params);
Jonathan Lemonc3f812c2019-11-14 14:13:00 -0800131 page_pool_destroy(xa->page_pool);
Jesper Dangaard Brouer99c07c42019-06-18 15:05:47 +0200132 }
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +0200133}
Toke Høiland-Jørgensen4a48ef72022-01-03 16:08:06 +0100134EXPORT_SYMBOL_GPL(xdp_unreg_mem_model);
135
136void xdp_rxq_info_unreg_mem_model(struct xdp_rxq_info *xdp_rxq)
137{
138 if (xdp_rxq->reg_state != REG_STATE_REGISTERED) {
139 WARN(1, "Missing register, driver bug");
140 return;
141 }
142
143 xdp_unreg_mem_model(&xdp_rxq->mem);
144}
Björn Töpeldce5bd62018-08-28 14:44:26 +0200145EXPORT_SYMBOL_GPL(xdp_rxq_info_unreg_mem_model);
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +0200146
Jesper Dangaard Broueraecd67b2018-01-03 11:25:13 +0100147void xdp_rxq_info_unreg(struct xdp_rxq_info *xdp_rxq)
148{
149 /* Simplify driver cleanup code paths, allow unreg "unused" */
150 if (xdp_rxq->reg_state == REG_STATE_UNUSED)
151 return;
152
Björn Töpeldce5bd62018-08-28 14:44:26 +0200153 xdp_rxq_info_unreg_mem_model(xdp_rxq);
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +0200154
Jesper Dangaard Broueraecd67b2018-01-03 11:25:13 +0100155 xdp_rxq->reg_state = REG_STATE_UNREGISTERED;
156 xdp_rxq->dev = NULL;
157}
158EXPORT_SYMBOL_GPL(xdp_rxq_info_unreg);
159
160static void xdp_rxq_info_init(struct xdp_rxq_info *xdp_rxq)
161{
162 memset(xdp_rxq, 0, sizeof(*xdp_rxq));
163}
164
165/* Returns 0 on success, negative on failure */
Eelco Chaudronbf251462022-01-21 11:09:55 +0100166int __xdp_rxq_info_reg(struct xdp_rxq_info *xdp_rxq,
167 struct net_device *dev, u32 queue_index,
168 unsigned int napi_id, u32 frag_size)
Jesper Dangaard Broueraecd67b2018-01-03 11:25:13 +0100169{
Yajun Dengf85b2442021-12-17 17:25:45 +0800170 if (!dev) {
171 WARN(1, "Missing net_device from driver");
172 return -ENODEV;
173 }
174
Jesper Dangaard Broueraecd67b2018-01-03 11:25:13 +0100175 if (xdp_rxq->reg_state == REG_STATE_UNUSED) {
176 WARN(1, "Driver promised not to register this");
177 return -EINVAL;
178 }
179
180 if (xdp_rxq->reg_state == REG_STATE_REGISTERED) {
181 WARN(1, "Missing unregister, handled but fix driver");
182 xdp_rxq_info_unreg(xdp_rxq);
183 }
184
Jesper Dangaard Broueraecd67b2018-01-03 11:25:13 +0100185 /* State either UNREGISTERED or NEW */
186 xdp_rxq_info_init(xdp_rxq);
187 xdp_rxq->dev = dev;
188 xdp_rxq->queue_index = queue_index;
Björn Töpelb02e5a02020-11-30 19:52:01 +0100189 xdp_rxq->napi_id = napi_id;
Eelco Chaudronbf251462022-01-21 11:09:55 +0100190 xdp_rxq->frag_size = frag_size;
Jesper Dangaard Broueraecd67b2018-01-03 11:25:13 +0100191
192 xdp_rxq->reg_state = REG_STATE_REGISTERED;
193 return 0;
194}
Eelco Chaudronbf251462022-01-21 11:09:55 +0100195EXPORT_SYMBOL_GPL(__xdp_rxq_info_reg);
Jesper Dangaard Broueraecd67b2018-01-03 11:25:13 +0100196
197void xdp_rxq_info_unused(struct xdp_rxq_info *xdp_rxq)
198{
199 xdp_rxq->reg_state = REG_STATE_UNUSED;
200}
201EXPORT_SYMBOL_GPL(xdp_rxq_info_unused);
Jesper Dangaard Brouerc0124f32018-01-03 11:25:34 +0100202
203bool xdp_rxq_info_is_reg(struct xdp_rxq_info *xdp_rxq)
204{
205 return (xdp_rxq->reg_state == REG_STATE_REGISTERED);
206}
207EXPORT_SYMBOL_GPL(xdp_rxq_info_is_reg);
Jesper Dangaard Brouer5ab073f2018-04-17 16:45:26 +0200208
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +0200209static int __mem_id_init_hash_table(void)
210{
211 struct rhashtable *rht;
212 int ret;
213
214 if (unlikely(mem_id_init))
215 return 0;
216
217 rht = kzalloc(sizeof(*rht), GFP_KERNEL);
218 if (!rht)
219 return -ENOMEM;
220
221 ret = rhashtable_init(rht, &mem_id_rht_params);
222 if (ret < 0) {
223 kfree(rht);
224 return ret;
225 }
226 mem_id_ht = rht;
227 smp_mb(); /* mutex lock should provide enough pairing */
228 mem_id_init = true;
229
230 return 0;
231}
232
233/* Allocate a cyclic ID that maps to allocator pointer.
234 * See: https://www.kernel.org/doc/html/latest/core-api/idr.html
235 *
236 * Caller must lock mem_id_lock.
237 */
238static int __mem_id_cyclic_get(gfp_t gfp)
239{
240 int retries = 1;
241 int id;
242
243again:
Christophe JAILLET6a571892024-01-20 08:02:20 +0100244 id = ida_alloc_range(&mem_id_pool, mem_id_next, MEM_ID_MAX - 1, gfp);
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +0200245 if (id < 0) {
246 if (id == -ENOSPC) {
247 /* Cyclic allocator, reset next id */
248 if (retries--) {
249 mem_id_next = MEM_ID_MIN;
250 goto again;
251 }
252 }
253 return id; /* errno */
254 }
255 mem_id_next = id + 1;
256
257 return id;
258}
259
Jesper Dangaard Brouer57d0a1c2018-04-17 16:46:22 +0200260static bool __is_supported_mem_type(enum xdp_mem_type type)
261{
262 if (type == MEM_TYPE_PAGE_POOL)
263 return is_page_pool_compiled_in();
264
265 if (type >= MEM_TYPE_MAX)
266 return false;
267
268 return true;
269}
270
Toke Høiland-Jørgensen4a48ef72022-01-03 16:08:06 +0100271static struct xdp_mem_allocator *__xdp_reg_mem_model(struct xdp_mem_info *mem,
272 enum xdp_mem_type type,
273 void *allocator)
Jesper Dangaard Brouer5ab073f2018-04-17 16:45:26 +0200274{
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +0200275 struct xdp_mem_allocator *xdp_alloc;
276 gfp_t gfp = GFP_KERNEL;
277 int id, errno, ret;
278 void *ptr;
279
Jesper Dangaard Brouer57d0a1c2018-04-17 16:46:22 +0200280 if (!__is_supported_mem_type(type))
Toke Høiland-Jørgensen4a48ef72022-01-03 16:08:06 +0100281 return ERR_PTR(-EOPNOTSUPP);
Jesper Dangaard Brouer5ab073f2018-04-17 16:45:26 +0200282
Toke Høiland-Jørgensen4a48ef72022-01-03 16:08:06 +0100283 mem->type = type;
Jesper Dangaard Brouer5ab073f2018-04-17 16:45:26 +0200284
Jesper Dangaard Brouer57d0a1c2018-04-17 16:46:22 +0200285 if (!allocator) {
Björn Töpel08078922020-05-20 21:21:00 +0200286 if (type == MEM_TYPE_PAGE_POOL)
Toke Høiland-Jørgensen4a48ef72022-01-03 16:08:06 +0100287 return ERR_PTR(-EINVAL); /* Setup time check page_pool req */
288 return NULL;
Jesper Dangaard Brouer57d0a1c2018-04-17 16:46:22 +0200289 }
Jesper Dangaard Brouer5ab073f2018-04-17 16:45:26 +0200290
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +0200291 /* Delay init of rhashtable to save memory if feature isn't used */
292 if (!mem_id_init) {
293 mutex_lock(&mem_id_lock);
294 ret = __mem_id_init_hash_table();
295 mutex_unlock(&mem_id_lock);
Daniil Dulov7e9f7942024-06-24 11:07:47 +0300296 if (ret < 0)
Toke Høiland-Jørgensen4a48ef72022-01-03 16:08:06 +0100297 return ERR_PTR(ret);
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +0200298 }
299
300 xdp_alloc = kzalloc(sizeof(*xdp_alloc), gfp);
301 if (!xdp_alloc)
Toke Høiland-Jørgensen4a48ef72022-01-03 16:08:06 +0100302 return ERR_PTR(-ENOMEM);
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +0200303
304 mutex_lock(&mem_id_lock);
305 id = __mem_id_cyclic_get(gfp);
306 if (id < 0) {
307 errno = id;
308 goto err;
309 }
Toke Høiland-Jørgensen4a48ef72022-01-03 16:08:06 +0100310 mem->id = id;
311 xdp_alloc->mem = *mem;
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +0200312 xdp_alloc->allocator = allocator;
313
314 /* Insert allocator into ID lookup table */
315 ptr = rhashtable_insert_slow(mem_id_ht, &id, &xdp_alloc->node);
316 if (IS_ERR(ptr)) {
Christophe JAILLET6a571892024-01-20 08:02:20 +0100317 ida_free(&mem_id_pool, mem->id);
Toke Høiland-Jørgensen4a48ef72022-01-03 16:08:06 +0100318 mem->id = 0;
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +0200319 errno = PTR_ERR(ptr);
320 goto err;
321 }
322
Ivan Khoronzhuk1da4bbe2019-07-09 00:34:28 +0300323 if (type == MEM_TYPE_PAGE_POOL)
Toke Høiland-Jørgensen64693ec2022-01-03 16:08:08 +0100324 page_pool_use_xdp_mem(allocator, mem_allocator_disconnect, mem);
Ivan Khoronzhuk1da4bbe2019-07-09 00:34:28 +0300325
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +0200326 mutex_unlock(&mem_id_lock);
327
Toke Høiland-Jørgensen4a48ef72022-01-03 16:08:06 +0100328 return xdp_alloc;
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +0200329err:
330 mutex_unlock(&mem_id_lock);
331 kfree(xdp_alloc);
Toke Høiland-Jørgensen4a48ef72022-01-03 16:08:06 +0100332 return ERR_PTR(errno);
Jesper Dangaard Brouer5ab073f2018-04-17 16:45:26 +0200333}
Toke Høiland-Jørgensen4a48ef72022-01-03 16:08:06 +0100334
335int xdp_reg_mem_model(struct xdp_mem_info *mem,
336 enum xdp_mem_type type, void *allocator)
337{
338 struct xdp_mem_allocator *xdp_alloc;
339
340 xdp_alloc = __xdp_reg_mem_model(mem, type, allocator);
341 if (IS_ERR(xdp_alloc))
342 return PTR_ERR(xdp_alloc);
343 return 0;
344}
345EXPORT_SYMBOL_GPL(xdp_reg_mem_model);
346
347int xdp_rxq_info_reg_mem_model(struct xdp_rxq_info *xdp_rxq,
348 enum xdp_mem_type type, void *allocator)
349{
350 struct xdp_mem_allocator *xdp_alloc;
351
352 if (xdp_rxq->reg_state != REG_STATE_REGISTERED) {
353 WARN(1, "Missing register, driver bug");
354 return -EFAULT;
355 }
356
357 xdp_alloc = __xdp_reg_mem_model(&xdp_rxq->mem, type, allocator);
358 if (IS_ERR(xdp_alloc))
359 return PTR_ERR(xdp_alloc);
360
Sebastian Andrzej Siewiore0ae7132022-03-09 23:13:45 +0100361 if (trace_mem_connect_enabled() && xdp_alloc)
362 trace_mem_connect(xdp_alloc, xdp_rxq);
Toke Høiland-Jørgensen4a48ef72022-01-03 16:08:06 +0100363 return 0;
364}
365
Jesper Dangaard Brouer5ab073f2018-04-17 16:45:26 +0200366EXPORT_SYMBOL_GPL(xdp_rxq_info_reg_mem_model);
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +0200367
Jesper Dangaard Brouer389ab7f2018-05-24 16:46:07 +0200368/* XDP RX runs under NAPI protection, and in different delivery error
369 * scenarios (e.g. queue full), it is possible to return the xdp_frame
Anton Ivanovbaead852019-10-11 09:43:03 +0100370 * while still leveraging this protection. The @napi_direct boolean
Jesper Dangaard Brouer389ab7f2018-05-24 16:46:07 +0200371 * is used for those calls sites. Thus, allowing for faster recycling
Björn Töpeled1182d2020-11-27 18:17:26 +0100372 * of xdp_frames/pages in those cases.
Jesper Dangaard Brouer389ab7f2018-05-24 16:46:07 +0200373 */
Eelco Chaudronbf251462022-01-21 11:09:55 +0100374void __xdp_return(void *data, struct xdp_mem_info *mem, bool napi_direct,
375 struct xdp_buff *xdp)
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +0200376{
Jesper Dangaard Brouer57d0a1c2018-04-17 16:46:22 +0200377 struct page *page;
378
379 switch (mem->type) {
380 case MEM_TYPE_PAGE_POOL:
Jesper Dangaard Brouer57d0a1c2018-04-17 16:46:22 +0200381 page = virt_to_head_page(data);
Ong Boon Leong622d1362021-03-31 21:25:03 +0800382 if (napi_direct && xdp_return_frame_no_direct())
383 napi_direct = false;
Jesper Dangaard Brouerfb33ec02022-09-21 19:05:32 +0200384 /* No need to check ((page->pp_magic & ~0x3UL) == PP_SIGNATURE)
385 * as mem->type knows this a page_pool page
386 */
387 page_pool_put_full_page(page->pp, page, napi_direct);
Jesper Dangaard Brouer57d0a1c2018-04-17 16:46:22 +0200388 break;
389 case MEM_TYPE_PAGE_SHARED:
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +0200390 page_frag_free(data);
Jesper Dangaard Brouer57d0a1c2018-04-17 16:46:22 +0200391 break;
392 case MEM_TYPE_PAGE_ORDER0:
393 page = virt_to_page(data); /* Assumes order0 page*/
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +0200394 put_page(page);
Jesper Dangaard Brouer57d0a1c2018-04-17 16:46:22 +0200395 break;
Björn Töpeled1182d2020-11-27 18:17:26 +0100396 case MEM_TYPE_XSK_BUFF_POOL:
397 /* NB! Only valid from an xdp_buff! */
398 xsk_buff_free(xdp);
399 break;
Jesper Dangaard Brouer57d0a1c2018-04-17 16:46:22 +0200400 default:
401 /* Not possible, checked in xdp_rxq_info_reg_mem_model() */
Björn Töpel82c41672020-05-20 21:21:01 +0200402 WARN(1, "Incorrect XDP memory type (%d) usage", mem->type);
Jesper Dangaard Brouer57d0a1c2018-04-17 16:46:22 +0200403 break;
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +0200404 }
405}
Björn Töpelc4971762018-05-02 13:01:27 +0200406
407void xdp_return_frame(struct xdp_frame *xdpf)
408{
Lorenzo Bianconi7c48cb02022-01-21 11:09:50 +0100409 struct skb_shared_info *sinfo;
410 int i;
411
412 if (likely(!xdp_frame_has_frags(xdpf)))
413 goto out;
414
415 sinfo = xdp_get_shared_info_from_frame(xdpf);
416 for (i = 0; i < sinfo->nr_frags; i++) {
417 struct page *page = skb_frag_page(&sinfo->frags[i]);
418
419 __xdp_return(page_address(page), &xdpf->mem, false, NULL);
420 }
421out:
Björn Töpeled1182d2020-11-27 18:17:26 +0100422 __xdp_return(xdpf->data, &xdpf->mem, false, NULL);
Björn Töpelc4971762018-05-02 13:01:27 +0200423}
Jesper Dangaard Brouer8d5d8852018-04-17 16:46:12 +0200424EXPORT_SYMBOL_GPL(xdp_return_frame);
Björn Töpelc4971762018-05-02 13:01:27 +0200425
Jesper Dangaard Brouer389ab7f2018-05-24 16:46:07 +0200426void xdp_return_frame_rx_napi(struct xdp_frame *xdpf)
427{
Lorenzo Bianconi7c48cb02022-01-21 11:09:50 +0100428 struct skb_shared_info *sinfo;
429 int i;
430
431 if (likely(!xdp_frame_has_frags(xdpf)))
432 goto out;
433
434 sinfo = xdp_get_shared_info_from_frame(xdpf);
435 for (i = 0; i < sinfo->nr_frags; i++) {
436 struct page *page = skb_frag_page(&sinfo->frags[i]);
437
438 __xdp_return(page_address(page), &xdpf->mem, true, NULL);
439 }
440out:
Björn Töpeled1182d2020-11-27 18:17:26 +0100441 __xdp_return(xdpf->data, &xdpf->mem, true, NULL);
Jesper Dangaard Brouer389ab7f2018-05-24 16:46:07 +0200442}
443EXPORT_SYMBOL_GPL(xdp_return_frame_rx_napi);
444
Lorenzo Bianconi89653982020-11-13 12:48:28 +0100445/* XDP bulk APIs introduce a defer/flush mechanism to return
446 * pages belonging to the same xdp_mem_allocator object
447 * (identified via the mem.id field) in bulk to optimize
448 * I-cache and D-cache.
449 * The bulk queue size is set to 16 to be aligned to how
450 * XDP_REDIRECT bulking works. The bulk is flushed when
451 * it is full or when mem.id changes.
452 * xdp_frame_bulk is usually stored/allocated on the function
453 * call-stack to avoid locking penalties.
454 */
455void xdp_flush_frame_bulk(struct xdp_frame_bulk *bq)
456{
457 struct xdp_mem_allocator *xa = bq->xa;
Lorenzo Bianconi89653982020-11-13 12:48:28 +0100458
Lorenzo Bianconi78862442020-11-13 12:48:29 +0100459 if (unlikely(!xa || !bq->count))
Lorenzo Bianconi89653982020-11-13 12:48:28 +0100460 return;
461
Lorenzo Bianconi78862442020-11-13 12:48:29 +0100462 page_pool_put_page_bulk(xa->page_pool, bq->q, bq->count);
Lorenzo Bianconi89653982020-11-13 12:48:28 +0100463 /* bq->xa is not cleared to save lookup, if mem.id same in next bulk */
464 bq->count = 0;
465}
466EXPORT_SYMBOL_GPL(xdp_flush_frame_bulk);
467
468/* Must be called with rcu_read_lock held */
469void xdp_return_frame_bulk(struct xdp_frame *xdpf,
470 struct xdp_frame_bulk *bq)
471{
472 struct xdp_mem_info *mem = &xdpf->mem;
473 struct xdp_mem_allocator *xa;
474
475 if (mem->type != MEM_TYPE_PAGE_POOL) {
Lorenzo Bianconi7c48cb02022-01-21 11:09:50 +0100476 xdp_return_frame(xdpf);
Lorenzo Bianconi89653982020-11-13 12:48:28 +0100477 return;
478 }
479
480 xa = bq->xa;
481 if (unlikely(!xa)) {
482 xa = rhashtable_lookup(mem_id_ht, &mem->id, mem_id_rht_params);
483 bq->count = 0;
484 bq->xa = xa;
485 }
486
487 if (bq->count == XDP_BULK_QUEUE_SIZE)
488 xdp_flush_frame_bulk(bq);
489
490 if (unlikely(mem->id != xa->mem.id)) {
491 xdp_flush_frame_bulk(bq);
492 bq->xa = rhashtable_lookup(mem_id_ht, &mem->id, mem_id_rht_params);
493 }
494
Lorenzo Bianconi7c48cb02022-01-21 11:09:50 +0100495 if (unlikely(xdp_frame_has_frags(xdpf))) {
496 struct skb_shared_info *sinfo;
497 int i;
498
499 sinfo = xdp_get_shared_info_from_frame(xdpf);
500 for (i = 0; i < sinfo->nr_frags; i++) {
501 skb_frag_t *frag = &sinfo->frags[i];
502
503 bq->q[bq->count++] = skb_frag_address(frag);
504 if (bq->count == XDP_BULK_QUEUE_SIZE)
505 xdp_flush_frame_bulk(bq);
506 }
507 }
Lorenzo Bianconi89653982020-11-13 12:48:28 +0100508 bq->q[bq->count++] = xdpf->data;
509}
510EXPORT_SYMBOL_GPL(xdp_return_frame_bulk);
511
Björn Töpelc4971762018-05-02 13:01:27 +0200512void xdp_return_buff(struct xdp_buff *xdp)
513{
Lorenzo Bianconi7c48cb02022-01-21 11:09:50 +0100514 struct skb_shared_info *sinfo;
515 int i;
516
517 if (likely(!xdp_buff_has_frags(xdp)))
518 goto out;
519
520 sinfo = xdp_get_shared_info_from_buff(xdp);
521 for (i = 0; i < sinfo->nr_frags; i++) {
522 struct page *page = skb_frag_page(&sinfo->frags[i]);
523
524 __xdp_return(page_address(page), &xdp->rxq->mem, true, xdp);
525 }
526out:
Björn Töpeled1182d2020-11-27 18:17:26 +0100527 __xdp_return(xdp->data, &xdp->rxq->mem, true, xdp);
Björn Töpelc4971762018-05-02 13:01:27 +0200528}
Lorenzo Bianconi718a18a2022-03-11 10:14:19 +0100529EXPORT_SYMBOL_GPL(xdp_return_buff);
Jakub Kicinski05296622018-07-11 20:36:40 -0700530
Jakub Kicinski05296622018-07-11 20:36:40 -0700531void xdp_attachment_setup(struct xdp_attachment_info *info,
532 struct netdev_bpf *bpf)
533{
534 if (info->prog)
535 bpf_prog_put(info->prog);
536 info->prog = bpf->prog;
537 info->flags = bpf->flags;
538}
539EXPORT_SYMBOL_GPL(xdp_attachment_setup);
Björn Töpelb0d1bee2018-08-28 14:44:25 +0200540
541struct xdp_frame *xdp_convert_zc_to_xdp_frame(struct xdp_buff *xdp)
542{
Colin Ian King72962162018-08-30 15:27:18 +0100543 unsigned int metasize, totsize;
Björn Töpelb0d1bee2018-08-28 14:44:25 +0200544 void *addr, *data_to_copy;
545 struct xdp_frame *xdpf;
546 struct page *page;
547
548 /* Clone into a MEM_TYPE_PAGE_ORDER0 xdp_frame. */
549 metasize = xdp_data_meta_unsupported(xdp) ? 0 :
550 xdp->data - xdp->data_meta;
Björn Töpelb0d1bee2018-08-28 14:44:25 +0200551 totsize = xdp->data_end - xdp->data + metasize;
552
553 if (sizeof(*xdpf) + totsize > PAGE_SIZE)
554 return NULL;
555
556 page = dev_alloc_page();
557 if (!page)
558 return NULL;
559
560 addr = page_to_virt(page);
561 xdpf = addr;
562 memset(xdpf, 0, sizeof(*xdpf));
563
564 addr += sizeof(*xdpf);
565 data_to_copy = metasize ? xdp->data_meta : xdp->data;
566 memcpy(addr, data_to_copy, totsize);
567
568 xdpf->data = addr + metasize;
569 xdpf->len = totsize - metasize;
570 xdpf->headroom = 0;
571 xdpf->metasize = metasize;
Hangbin Liu3ff23512020-06-16 18:35:18 +0800572 xdpf->frame_sz = PAGE_SIZE;
Björn Töpelb0d1bee2018-08-28 14:44:25 +0200573 xdpf->mem.type = MEM_TYPE_PAGE_ORDER0;
574
Björn Töpel82c41672020-05-20 21:21:01 +0200575 xsk_buff_free(xdp);
Björn Töpelb0d1bee2018-08-28 14:44:25 +0200576 return xdpf;
577}
578EXPORT_SYMBOL_GPL(xdp_convert_zc_to_xdp_frame);
Jesper Dangaard Brouer34cc0b32020-05-14 12:49:33 +0200579
580/* Used by XDP_WARN macro, to avoid inlining WARN() in fast-path */
581void xdp_warn(const char *msg, const char *func, const int line)
582{
583 WARN(1, "XDP_WARN: %s(line:%d): %s\n", func, line, msg);
584};
585EXPORT_SYMBOL_GPL(xdp_warn);
Lorenzo Bianconi97a0e1e2021-01-12 19:26:12 +0100586
Lorenzo Bianconi65e6dcf2021-01-29 23:04:08 +0100587int xdp_alloc_skb_bulk(void **skbs, int n_skb, gfp_t gfp)
588{
Eric Dumazetaa70d2d2024-03-06 16:00:23 +0000589 n_skb = kmem_cache_alloc_bulk(net_hotdata.skbuff_cache, gfp, n_skb, skbs);
Lorenzo Bianconi65e6dcf2021-01-29 23:04:08 +0100590 if (unlikely(!n_skb))
591 return -ENOMEM;
592
593 return 0;
594}
595EXPORT_SYMBOL_GPL(xdp_alloc_skb_bulk);
596
Lorenzo Bianconi97a0e1e2021-01-12 19:26:12 +0100597struct sk_buff *__xdp_build_skb_from_frame(struct xdp_frame *xdpf,
598 struct sk_buff *skb,
599 struct net_device *dev)
600{
Lorenzo Bianconid65a1902022-01-21 11:09:48 +0100601 struct skb_shared_info *sinfo = xdp_get_shared_info_from_frame(xdpf);
Lorenzo Bianconi97a0e1e2021-01-12 19:26:12 +0100602 unsigned int headroom, frame_size;
603 void *hard_start;
Lorenzo Bianconid65a1902022-01-21 11:09:48 +0100604 u8 nr_frags;
605
606 /* xdp frags frame */
607 if (unlikely(xdp_frame_has_frags(xdpf)))
608 nr_frags = sinfo->nr_frags;
Lorenzo Bianconi97a0e1e2021-01-12 19:26:12 +0100609
610 /* Part of headroom was reserved to xdpf */
611 headroom = sizeof(*xdpf) + xdpf->headroom;
612
613 /* Memory size backing xdp_frame data already have reserved
614 * room for build_skb to place skb_shared_info in tailroom.
615 */
616 frame_size = xdpf->frame_sz;
617
618 hard_start = xdpf->data - headroom;
619 skb = build_skb_around(skb, hard_start, frame_size);
620 if (unlikely(!skb))
621 return NULL;
622
623 skb_reserve(skb, headroom);
624 __skb_put(skb, xdpf->len);
625 if (xdpf->metasize)
626 skb_metadata_set(skb, xdpf->metasize);
627
Lorenzo Bianconid65a1902022-01-21 11:09:48 +0100628 if (unlikely(xdp_frame_has_frags(xdpf)))
629 xdp_update_skb_shared_info(skb, nr_frags,
630 sinfo->xdp_frags_size,
631 nr_frags * xdpf->frame_sz,
632 xdp_frame_is_frag_pfmemalloc(xdpf));
633
Lorenzo Bianconi97a0e1e2021-01-12 19:26:12 +0100634 /* Essential SKB info: protocol and skb->dev */
635 skb->protocol = eth_type_trans(skb, dev);
636
637 /* Optional SKB info, currently missing:
638 * - HW checksum info (skb->ip_summed)
639 * - HW RX hash (skb_set_hash)
640 * - RX ring dev queue index (skb_record_rx_queue)
641 */
642
Alexander Lobakin9c94bbf2023-03-13 22:55:52 +0100643 if (xdpf->mem.type == MEM_TYPE_PAGE_POOL)
644 skb_mark_for_recycle(skb);
Lorenzo Bianconi97a0e1e2021-01-12 19:26:12 +0100645
646 /* Allow SKB to reuse area used by xdp_frame */
647 xdp_scrub_frame(xdpf);
648
649 return skb;
650}
651EXPORT_SYMBOL_GPL(__xdp_build_skb_from_frame);
Lorenzo Bianconi89f479f2021-01-12 19:26:13 +0100652
653struct sk_buff *xdp_build_skb_from_frame(struct xdp_frame *xdpf,
654 struct net_device *dev)
655{
656 struct sk_buff *skb;
657
Eric Dumazetaa70d2d2024-03-06 16:00:23 +0000658 skb = kmem_cache_alloc(net_hotdata.skbuff_cache, GFP_ATOMIC);
Lorenzo Bianconi89f479f2021-01-12 19:26:13 +0100659 if (unlikely(!skb))
660 return NULL;
661
662 memset(skb, 0, offsetof(struct sk_buff, tail));
663
664 return __xdp_build_skb_from_frame(xdpf, skb, dev);
665}
666EXPORT_SYMBOL_GPL(xdp_build_skb_from_frame);
Hangbin Liue624d4e2021-05-19 17:07:45 +0800667
668struct xdp_frame *xdpf_clone(struct xdp_frame *xdpf)
669{
670 unsigned int headroom, totalsize;
671 struct xdp_frame *nxdpf;
672 struct page *page;
673 void *addr;
674
675 headroom = xdpf->headroom + sizeof(*xdpf);
676 totalsize = headroom + xdpf->len;
677
678 if (unlikely(totalsize > PAGE_SIZE))
679 return NULL;
680 page = dev_alloc_page();
681 if (!page)
682 return NULL;
683 addr = page_to_virt(page);
684
685 memcpy(addr, xdpf, totalsize);
686
687 nxdpf = addr;
688 nxdpf->data = addr + headroom;
689 nxdpf->frame_sz = PAGE_SIZE;
690 nxdpf->mem.type = MEM_TYPE_PAGE_ORDER0;
691 nxdpf->mem.id = 0;
692
693 return nxdpf;
694}
Stanislav Fomichev3d76a4d2023-01-19 14:15:26 -0800695
Dave Marchevsky391145b2023-10-31 14:56:24 -0700696__bpf_kfunc_start_defs();
Stanislav Fomichev3d76a4d2023-01-19 14:15:26 -0800697
698/**
699 * bpf_xdp_metadata_rx_timestamp - Read XDP frame RX timestamp.
700 * @ctx: XDP context pointer.
701 * @timestamp: Return value pointer.
702 *
Jesper Dangaard Brouer915efd82023-03-21 14:52:31 +0100703 * Return:
704 * * Returns 0 on success or ``-errno`` on error.
705 * * ``-EOPNOTSUPP`` : means device driver does not implement kfunc
706 * * ``-ENODATA`` : means no RX-timestamp available for this frame
Stanislav Fomichev3d76a4d2023-01-19 14:15:26 -0800707 */
David Vernet400031e2023-02-01 11:30:15 -0600708__bpf_kfunc int bpf_xdp_metadata_rx_timestamp(const struct xdp_md *ctx, u64 *timestamp)
Stanislav Fomichev3d76a4d2023-01-19 14:15:26 -0800709{
710 return -EOPNOTSUPP;
711}
712
713/**
714 * bpf_xdp_metadata_rx_hash - Read XDP frame RX hash.
715 * @ctx: XDP context pointer.
716 * @hash: Return value pointer.
Jesper Dangaard Brouer0cd917a2023-04-12 21:48:40 +0200717 * @rss_type: Return value pointer for RSS type.
718 *
719 * The RSS hash type (@rss_type) specifies what portion of packet headers NIC
720 * hardware used when calculating RSS hash value. The RSS type can be decoded
721 * via &enum xdp_rss_hash_type either matching on individual L3/L4 bits
722 * ``XDP_RSS_L*`` or by combined traditional *RSS Hashing Types*
723 * ``XDP_RSS_TYPE_L*``.
Stanislav Fomichev3d76a4d2023-01-19 14:15:26 -0800724 *
Jesper Dangaard Brouer915efd82023-03-21 14:52:31 +0100725 * Return:
726 * * Returns 0 on success or ``-errno`` on error.
727 * * ``-EOPNOTSUPP`` : means device driver doesn't implement kfunc
728 * * ``-ENODATA`` : means no RX-hash available for this frame
Stanislav Fomichev3d76a4d2023-01-19 14:15:26 -0800729 */
Jesper Dangaard Brouer0cd917a2023-04-12 21:48:40 +0200730__bpf_kfunc int bpf_xdp_metadata_rx_hash(const struct xdp_md *ctx, u32 *hash,
731 enum xdp_rss_hash_type *rss_type)
Stanislav Fomichev3d76a4d2023-01-19 14:15:26 -0800732{
733 return -EOPNOTSUPP;
734}
735
Larysa Zarembae6795332023-12-05 22:08:38 +0100736/**
737 * bpf_xdp_metadata_rx_vlan_tag - Get XDP packet outermost VLAN tag
738 * @ctx: XDP context pointer.
739 * @vlan_proto: Destination pointer for VLAN Tag protocol identifier (TPID).
740 * @vlan_tci: Destination pointer for VLAN TCI (VID + DEI + PCP)
741 *
742 * In case of success, ``vlan_proto`` contains *Tag protocol identifier (TPID)*,
743 * usually ``ETH_P_8021Q`` or ``ETH_P_8021AD``, but some networks can use
744 * custom TPIDs. ``vlan_proto`` is stored in **network byte order (BE)**
745 * and should be used as follows:
746 * ``if (vlan_proto == bpf_htons(ETH_P_8021Q)) do_something();``
747 *
748 * ``vlan_tci`` contains the remaining 16 bits of a VLAN tag.
749 * Driver is expected to provide those in **host byte order (usually LE)**,
750 * so the bpf program should not perform byte conversion.
751 * According to 802.1Q standard, *VLAN TCI (Tag control information)*
752 * is a bit field that contains:
753 * *VLAN identifier (VID)* that can be read with ``vlan_tci & 0xfff``,
754 * *Drop eligible indicator (DEI)* - 1 bit,
755 * *Priority code point (PCP)* - 3 bits.
756 * For detailed meaning of DEI and PCP, please refer to other sources.
757 *
758 * Return:
759 * * Returns 0 on success or ``-errno`` on error.
760 * * ``-EOPNOTSUPP`` : device driver doesn't implement kfunc
761 * * ``-ENODATA`` : VLAN tag was not stripped or is not available
762 */
763__bpf_kfunc int bpf_xdp_metadata_rx_vlan_tag(const struct xdp_md *ctx,
764 __be16 *vlan_proto, u16 *vlan_tci)
765{
766 return -EOPNOTSUPP;
767}
768
Dave Marchevsky391145b2023-10-31 14:56:24 -0700769__bpf_kfunc_end_defs();
Stanislav Fomichev3d76a4d2023-01-19 14:15:26 -0800770
Daniel Xu6f3189f2024-01-28 18:24:08 -0700771BTF_KFUNCS_START(xdp_metadata_kfunc_ids)
Stanislav Fomicheva9c2a602023-09-13 10:13:49 -0700772#define XDP_METADATA_KFUNC(_, __, name, ___) BTF_ID_FLAGS(func, name, KF_TRUSTED_ARGS)
Stanislav Fomichev3d76a4d2023-01-19 14:15:26 -0800773XDP_METADATA_KFUNC_xxx
774#undef XDP_METADATA_KFUNC
Daniel Xu6f3189f2024-01-28 18:24:08 -0700775BTF_KFUNCS_END(xdp_metadata_kfunc_ids)
Stanislav Fomichev3d76a4d2023-01-19 14:15:26 -0800776
777static const struct btf_kfunc_id_set xdp_metadata_kfunc_set = {
778 .owner = THIS_MODULE,
779 .set = &xdp_metadata_kfunc_ids,
780};
781
782BTF_ID_LIST(xdp_metadata_kfunc_ids_unsorted)
Stanislav Fomicheva9c2a602023-09-13 10:13:49 -0700783#define XDP_METADATA_KFUNC(name, _, str, __) BTF_ID(func, str)
Stanislav Fomichev3d76a4d2023-01-19 14:15:26 -0800784XDP_METADATA_KFUNC_xxx
785#undef XDP_METADATA_KFUNC
786
787u32 bpf_xdp_metadata_kfunc_id(int id)
788{
789 /* xdp_metadata_kfunc_ids is sorted and can't be used */
790 return xdp_metadata_kfunc_ids_unsorted[id];
791}
792
793bool bpf_dev_bound_kfunc_id(u32 btf_id)
794{
795 return btf_id_set8_contains(&xdp_metadata_kfunc_ids, btf_id);
796}
797
798static int __init xdp_metadata_init(void)
799{
800 return register_btf_kfunc_id_set(BPF_PROG_TYPE_XDP, &xdp_metadata_kfunc_set);
801}
802late_initcall(xdp_metadata_init);
Marek Majtyka66c0e132023-02-01 11:24:18 +0100803
Lorenzo Bianconif85949f2023-03-09 13:25:27 +0100804void xdp_set_features_flag(struct net_device *dev, xdp_features_t val)
805{
806 val &= NETDEV_XDP_ACT_MASK;
807 if (dev->xdp_features == val)
808 return;
809
810 dev->xdp_features = val;
Jakub Kicinski769639c2023-03-16 15:02:34 -0700811
812 if (dev->reg_state == NETREG_REGISTERED)
813 call_netdevice_notifiers(NETDEV_XDP_FEAT_CHANGE, dev);
Lorenzo Bianconif85949f2023-03-09 13:25:27 +0100814}
815EXPORT_SYMBOL_GPL(xdp_set_features_flag);
816
Marek Majtyka66c0e132023-02-01 11:24:18 +0100817void xdp_features_set_redirect_target(struct net_device *dev, bool support_sg)
818{
Lorenzo Bianconif85949f2023-03-09 13:25:27 +0100819 xdp_features_t val = (dev->xdp_features | NETDEV_XDP_ACT_NDO_XMIT);
Marek Majtyka66c0e132023-02-01 11:24:18 +0100820
Lorenzo Bianconif85949f2023-03-09 13:25:27 +0100821 if (support_sg)
822 val |= NETDEV_XDP_ACT_NDO_XMIT_SG;
823 xdp_set_features_flag(dev, val);
Marek Majtyka66c0e132023-02-01 11:24:18 +0100824}
825EXPORT_SYMBOL_GPL(xdp_features_set_redirect_target);
826
827void xdp_features_clear_redirect_target(struct net_device *dev)
828{
Lorenzo Bianconif85949f2023-03-09 13:25:27 +0100829 xdp_features_t val = dev->xdp_features;
830
831 val &= ~(NETDEV_XDP_ACT_NDO_XMIT | NETDEV_XDP_ACT_NDO_XMIT_SG);
832 xdp_set_features_flag(dev, val);
Marek Majtyka66c0e132023-02-01 11:24:18 +0100833}
834EXPORT_SYMBOL_GPL(xdp_features_clear_redirect_target);