xref: /linux-6.15/kernel/bpf/cpumap.c (revision 640a6045)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /* bpf/cpumap.c
3  *
4  * Copyright (c) 2017 Jesper Dangaard Brouer, Red Hat Inc.
5  */
6 
7 /**
8  * DOC: cpu map
9  * The 'cpumap' is primarily used as a backend map for XDP BPF helper
10  * call bpf_redirect_map() and XDP_REDIRECT action, like 'devmap'.
11  *
12  * Unlike devmap which redirects XDP frames out to another NIC device,
13  * this map type redirects raw XDP frames to another CPU.  The remote
14  * CPU will do SKB-allocation and call the normal network stack.
15  */
16 /*
17  * This is a scalability and isolation mechanism, that allow
18  * separating the early driver network XDP layer, from the rest of the
19  * netstack, and assigning dedicated CPUs for this stage.  This
20  * basically allows for 10G wirespeed pre-filtering via bpf.
21  */
22 #include <linux/bitops.h>
23 #include <linux/bpf.h>
24 #include <linux/filter.h>
25 #include <linux/ptr_ring.h>
26 #include <net/xdp.h>
27 
28 #include <linux/sched.h>
29 #include <linux/workqueue.h>
30 #include <linux/kthread.h>
31 #include <linux/completion.h>
32 #include <trace/events/xdp.h>
33 #include <linux/btf_ids.h>
34 
35 #include <linux/netdevice.h>   /* netif_receive_skb_list */
36 #include <linux/etherdevice.h> /* eth_type_trans */
37 
38 /* General idea: XDP packets getting XDP redirected to another CPU,
39  * will maximum be stored/queued for one driver ->poll() call.  It is
40  * guaranteed that queueing the frame and the flush operation happen on
41  * same CPU.  Thus, cpu_map_flush operation can deduct via this_cpu_ptr()
42  * which queue in bpf_cpu_map_entry contains packets.
43  */
44 
45 #define CPU_MAP_BULK_SIZE 8  /* 8 == one cacheline on 64-bit archs */
46 struct bpf_cpu_map_entry;
47 struct bpf_cpu_map;
48 
49 struct xdp_bulk_queue {
50 	void *q[CPU_MAP_BULK_SIZE];
51 	struct list_head flush_node;
52 	struct bpf_cpu_map_entry *obj;
53 	unsigned int count;
54 };
55 
56 /* Struct for every remote "destination" CPU in map */
57 struct bpf_cpu_map_entry {
58 	u32 cpu;    /* kthread CPU and map index */
59 	int map_id; /* Back reference to map */
60 
61 	/* XDP can run multiple RX-ring queues, need __percpu enqueue store */
62 	struct xdp_bulk_queue __percpu *bulkq;
63 
64 	struct bpf_cpu_map *cmap;
65 
66 	/* Queue with potential multi-producers, and single-consumer kthread */
67 	struct ptr_ring *queue;
68 	struct task_struct *kthread;
69 
70 	struct bpf_cpumap_val value;
71 	struct bpf_prog *prog;
72 
73 	atomic_t refcnt; /* Control when this struct can be free'ed */
74 	struct rcu_head rcu;
75 
76 	struct work_struct kthread_stop_wq;
77 	struct completion kthread_running;
78 };
79 
80 struct bpf_cpu_map {
81 	struct bpf_map map;
82 	/* Below members specific for map type */
83 	struct bpf_cpu_map_entry __rcu **cpu_map;
84 };
85 
86 static DEFINE_PER_CPU(struct list_head, cpu_map_flush_list);
87 
88 static struct bpf_map *cpu_map_alloc(union bpf_attr *attr)
89 {
90 	u32 value_size = attr->value_size;
91 	struct bpf_cpu_map *cmap;
92 
93 	/* check sanity of attributes */
94 	if (attr->max_entries == 0 || attr->key_size != 4 ||
95 	    (value_size != offsetofend(struct bpf_cpumap_val, qsize) &&
96 	     value_size != offsetofend(struct bpf_cpumap_val, bpf_prog.fd)) ||
97 	    attr->map_flags & ~BPF_F_NUMA_NODE)
98 		return ERR_PTR(-EINVAL);
99 
100 	/* Pre-limit array size based on NR_CPUS, not final CPU check */
101 	if (attr->max_entries > NR_CPUS)
102 		return ERR_PTR(-E2BIG);
103 
104 	cmap = bpf_map_area_alloc(sizeof(*cmap), NUMA_NO_NODE);
105 	if (!cmap)
106 		return ERR_PTR(-ENOMEM);
107 
108 	bpf_map_init_from_attr(&cmap->map, attr);
109 
110 	/* Alloc array for possible remote "destination" CPUs */
111 	cmap->cpu_map = bpf_map_area_alloc(cmap->map.max_entries *
112 					   sizeof(struct bpf_cpu_map_entry *),
113 					   cmap->map.numa_node);
114 	if (!cmap->cpu_map) {
115 		bpf_map_area_free(cmap);
116 		return ERR_PTR(-ENOMEM);
117 	}
118 
119 	return &cmap->map;
120 }
121 
122 static void get_cpu_map_entry(struct bpf_cpu_map_entry *rcpu)
123 {
124 	atomic_inc(&rcpu->refcnt);
125 }
126 
127 static void __cpu_map_ring_cleanup(struct ptr_ring *ring)
128 {
129 	/* The tear-down procedure should have made sure that queue is
130 	 * empty.  See __cpu_map_entry_replace() and work-queue
131 	 * invoked cpu_map_kthread_stop(). Catch any broken behaviour
132 	 * gracefully and warn once.
133 	 */
134 	struct xdp_frame *xdpf;
135 
136 	while ((xdpf = ptr_ring_consume(ring)))
137 		if (WARN_ON_ONCE(xdpf))
138 			xdp_return_frame(xdpf);
139 }
140 
141 static void put_cpu_map_entry(struct bpf_cpu_map_entry *rcpu)
142 {
143 	if (atomic_dec_and_test(&rcpu->refcnt)) {
144 		if (rcpu->prog)
145 			bpf_prog_put(rcpu->prog);
146 		/* The queue should be empty at this point */
147 		__cpu_map_ring_cleanup(rcpu->queue);
148 		ptr_ring_cleanup(rcpu->queue, NULL);
149 		kfree(rcpu->queue);
150 		kfree(rcpu);
151 	}
152 }
153 
154 /* called from workqueue, to workaround syscall using preempt_disable */
155 static void cpu_map_kthread_stop(struct work_struct *work)
156 {
157 	struct bpf_cpu_map_entry *rcpu;
158 
159 	rcpu = container_of(work, struct bpf_cpu_map_entry, kthread_stop_wq);
160 
161 	/* Wait for flush in __cpu_map_entry_free(), via full RCU barrier,
162 	 * as it waits until all in-flight call_rcu() callbacks complete.
163 	 */
164 	rcu_barrier();
165 
166 	/* kthread_stop will wake_up_process and wait for it to complete */
167 	kthread_stop(rcpu->kthread);
168 }
169 
170 static void cpu_map_bpf_prog_run_skb(struct bpf_cpu_map_entry *rcpu,
171 				     struct list_head *listp,
172 				     struct xdp_cpumap_stats *stats)
173 {
174 	struct sk_buff *skb, *tmp;
175 	struct xdp_buff xdp;
176 	u32 act;
177 	int err;
178 
179 	list_for_each_entry_safe(skb, tmp, listp, list) {
180 		act = bpf_prog_run_generic_xdp(skb, &xdp, rcpu->prog);
181 		switch (act) {
182 		case XDP_PASS:
183 			break;
184 		case XDP_REDIRECT:
185 			skb_list_del_init(skb);
186 			err = xdp_do_generic_redirect(skb->dev, skb, &xdp,
187 						      rcpu->prog);
188 			if (unlikely(err)) {
189 				kfree_skb(skb);
190 				stats->drop++;
191 			} else {
192 				stats->redirect++;
193 			}
194 			return;
195 		default:
196 			bpf_warn_invalid_xdp_action(NULL, rcpu->prog, act);
197 			fallthrough;
198 		case XDP_ABORTED:
199 			trace_xdp_exception(skb->dev, rcpu->prog, act);
200 			fallthrough;
201 		case XDP_DROP:
202 			skb_list_del_init(skb);
203 			kfree_skb(skb);
204 			stats->drop++;
205 			return;
206 		}
207 	}
208 }
209 
210 static int cpu_map_bpf_prog_run_xdp(struct bpf_cpu_map_entry *rcpu,
211 				    void **frames, int n,
212 				    struct xdp_cpumap_stats *stats)
213 {
214 	struct xdp_rxq_info rxq;
215 	struct xdp_buff xdp;
216 	int i, nframes = 0;
217 
218 	xdp_set_return_frame_no_direct();
219 	xdp.rxq = &rxq;
220 
221 	for (i = 0; i < n; i++) {
222 		struct xdp_frame *xdpf = frames[i];
223 		u32 act;
224 		int err;
225 
226 		rxq.dev = xdpf->dev_rx;
227 		rxq.mem = xdpf->mem;
228 		/* TODO: report queue_index to xdp_rxq_info */
229 
230 		xdp_convert_frame_to_buff(xdpf, &xdp);
231 
232 		act = bpf_prog_run_xdp(rcpu->prog, &xdp);
233 		switch (act) {
234 		case XDP_PASS:
235 			err = xdp_update_frame_from_buff(&xdp, xdpf);
236 			if (err < 0) {
237 				xdp_return_frame(xdpf);
238 				stats->drop++;
239 			} else {
240 				frames[nframes++] = xdpf;
241 				stats->pass++;
242 			}
243 			break;
244 		case XDP_REDIRECT:
245 			err = xdp_do_redirect(xdpf->dev_rx, &xdp,
246 					      rcpu->prog);
247 			if (unlikely(err)) {
248 				xdp_return_frame(xdpf);
249 				stats->drop++;
250 			} else {
251 				stats->redirect++;
252 			}
253 			break;
254 		default:
255 			bpf_warn_invalid_xdp_action(NULL, rcpu->prog, act);
256 			fallthrough;
257 		case XDP_DROP:
258 			xdp_return_frame(xdpf);
259 			stats->drop++;
260 			break;
261 		}
262 	}
263 
264 	xdp_clear_return_frame_no_direct();
265 
266 	return nframes;
267 }
268 
269 #define CPUMAP_BATCH 8
270 
271 static int cpu_map_bpf_prog_run(struct bpf_cpu_map_entry *rcpu, void **frames,
272 				int xdp_n, struct xdp_cpumap_stats *stats,
273 				struct list_head *list)
274 {
275 	int nframes;
276 
277 	if (!rcpu->prog)
278 		return xdp_n;
279 
280 	rcu_read_lock_bh();
281 
282 	nframes = cpu_map_bpf_prog_run_xdp(rcpu, frames, xdp_n, stats);
283 
284 	if (stats->redirect)
285 		xdp_do_flush();
286 
287 	if (unlikely(!list_empty(list)))
288 		cpu_map_bpf_prog_run_skb(rcpu, list, stats);
289 
290 	rcu_read_unlock_bh(); /* resched point, may call do_softirq() */
291 
292 	return nframes;
293 }
294 
295 static int cpu_map_kthread_run(void *data)
296 {
297 	struct bpf_cpu_map_entry *rcpu = data;
298 
299 	complete(&rcpu->kthread_running);
300 	set_current_state(TASK_INTERRUPTIBLE);
301 
302 	/* When kthread gives stop order, then rcpu have been disconnected
303 	 * from map, thus no new packets can enter. Remaining in-flight
304 	 * per CPU stored packets are flushed to this queue.  Wait honoring
305 	 * kthread_stop signal until queue is empty.
306 	 */
307 	while (!kthread_should_stop() || !__ptr_ring_empty(rcpu->queue)) {
308 		struct xdp_cpumap_stats stats = {}; /* zero stats */
309 		unsigned int kmem_alloc_drops = 0, sched = 0;
310 		gfp_t gfp = __GFP_ZERO | GFP_ATOMIC;
311 		int i, n, m, nframes, xdp_n;
312 		void *frames[CPUMAP_BATCH];
313 		void *skbs[CPUMAP_BATCH];
314 		LIST_HEAD(list);
315 
316 		/* Release CPU reschedule checks */
317 		if (__ptr_ring_empty(rcpu->queue)) {
318 			set_current_state(TASK_INTERRUPTIBLE);
319 			/* Recheck to avoid lost wake-up */
320 			if (__ptr_ring_empty(rcpu->queue)) {
321 				schedule();
322 				sched = 1;
323 			} else {
324 				__set_current_state(TASK_RUNNING);
325 			}
326 		} else {
327 			sched = cond_resched();
328 		}
329 
330 		/*
331 		 * The bpf_cpu_map_entry is single consumer, with this
332 		 * kthread CPU pinned. Lockless access to ptr_ring
333 		 * consume side valid as no-resize allowed of queue.
334 		 */
335 		n = __ptr_ring_consume_batched(rcpu->queue, frames,
336 					       CPUMAP_BATCH);
337 		for (i = 0, xdp_n = 0; i < n; i++) {
338 			void *f = frames[i];
339 			struct page *page;
340 
341 			if (unlikely(__ptr_test_bit(0, &f))) {
342 				struct sk_buff *skb = f;
343 
344 				__ptr_clear_bit(0, &skb);
345 				list_add_tail(&skb->list, &list);
346 				continue;
347 			}
348 
349 			frames[xdp_n++] = f;
350 			page = virt_to_page(f);
351 
352 			/* Bring struct page memory area to curr CPU. Read by
353 			 * build_skb_around via page_is_pfmemalloc(), and when
354 			 * freed written by page_frag_free call.
355 			 */
356 			prefetchw(page);
357 		}
358 
359 		/* Support running another XDP prog on this CPU */
360 		nframes = cpu_map_bpf_prog_run(rcpu, frames, xdp_n, &stats, &list);
361 		if (nframes) {
362 			m = kmem_cache_alloc_bulk(skbuff_cache, gfp, nframes, skbs);
363 			if (unlikely(m == 0)) {
364 				for (i = 0; i < nframes; i++)
365 					skbs[i] = NULL; /* effect: xdp_return_frame */
366 				kmem_alloc_drops += nframes;
367 			}
368 		}
369 
370 		local_bh_disable();
371 		for (i = 0; i < nframes; i++) {
372 			struct xdp_frame *xdpf = frames[i];
373 			struct sk_buff *skb = skbs[i];
374 
375 			skb = __xdp_build_skb_from_frame(xdpf, skb,
376 							 xdpf->dev_rx);
377 			if (!skb) {
378 				xdp_return_frame(xdpf);
379 				continue;
380 			}
381 
382 			list_add_tail(&skb->list, &list);
383 		}
384 		netif_receive_skb_list(&list);
385 
386 		/* Feedback loop via tracepoint */
387 		trace_xdp_cpumap_kthread(rcpu->map_id, n, kmem_alloc_drops,
388 					 sched, &stats);
389 
390 		local_bh_enable(); /* resched point, may call do_softirq() */
391 	}
392 	__set_current_state(TASK_RUNNING);
393 
394 	put_cpu_map_entry(rcpu);
395 	return 0;
396 }
397 
398 static int __cpu_map_load_bpf_program(struct bpf_cpu_map_entry *rcpu,
399 				      struct bpf_map *map, int fd)
400 {
401 	struct bpf_prog *prog;
402 
403 	prog = bpf_prog_get_type(fd, BPF_PROG_TYPE_XDP);
404 	if (IS_ERR(prog))
405 		return PTR_ERR(prog);
406 
407 	if (prog->expected_attach_type != BPF_XDP_CPUMAP ||
408 	    !bpf_prog_map_compatible(map, prog)) {
409 		bpf_prog_put(prog);
410 		return -EINVAL;
411 	}
412 
413 	rcpu->value.bpf_prog.id = prog->aux->id;
414 	rcpu->prog = prog;
415 
416 	return 0;
417 }
418 
419 static struct bpf_cpu_map_entry *
420 __cpu_map_entry_alloc(struct bpf_map *map, struct bpf_cpumap_val *value,
421 		      u32 cpu)
422 {
423 	int numa, err, i, fd = value->bpf_prog.fd;
424 	gfp_t gfp = GFP_KERNEL | __GFP_NOWARN;
425 	struct bpf_cpu_map_entry *rcpu;
426 	struct xdp_bulk_queue *bq;
427 
428 	/* Have map->numa_node, but choose node of redirect target CPU */
429 	numa = cpu_to_node(cpu);
430 
431 	rcpu = bpf_map_kmalloc_node(map, sizeof(*rcpu), gfp | __GFP_ZERO, numa);
432 	if (!rcpu)
433 		return NULL;
434 
435 	/* Alloc percpu bulkq */
436 	rcpu->bulkq = bpf_map_alloc_percpu(map, sizeof(*rcpu->bulkq),
437 					   sizeof(void *), gfp);
438 	if (!rcpu->bulkq)
439 		goto free_rcu;
440 
441 	for_each_possible_cpu(i) {
442 		bq = per_cpu_ptr(rcpu->bulkq, i);
443 		bq->obj = rcpu;
444 	}
445 
446 	/* Alloc queue */
447 	rcpu->queue = bpf_map_kmalloc_node(map, sizeof(*rcpu->queue), gfp,
448 					   numa);
449 	if (!rcpu->queue)
450 		goto free_bulkq;
451 
452 	err = ptr_ring_init(rcpu->queue, value->qsize, gfp);
453 	if (err)
454 		goto free_queue;
455 
456 	rcpu->cpu    = cpu;
457 	rcpu->map_id = map->id;
458 	rcpu->value.qsize  = value->qsize;
459 
460 	if (fd > 0 && __cpu_map_load_bpf_program(rcpu, map, fd))
461 		goto free_ptr_ring;
462 
463 	/* Setup kthread */
464 	init_completion(&rcpu->kthread_running);
465 	rcpu->kthread = kthread_create_on_node(cpu_map_kthread_run, rcpu, numa,
466 					       "cpumap/%d/map:%d", cpu,
467 					       map->id);
468 	if (IS_ERR(rcpu->kthread))
469 		goto free_prog;
470 
471 	get_cpu_map_entry(rcpu); /* 1-refcnt for being in cmap->cpu_map[] */
472 	get_cpu_map_entry(rcpu); /* 1-refcnt for kthread */
473 
474 	/* Make sure kthread runs on a single CPU */
475 	kthread_bind(rcpu->kthread, cpu);
476 	wake_up_process(rcpu->kthread);
477 
478 	/* Make sure kthread has been running, so kthread_stop() will not
479 	 * stop the kthread prematurely and all pending frames or skbs
480 	 * will be handled by the kthread before kthread_stop() returns.
481 	 */
482 	wait_for_completion(&rcpu->kthread_running);
483 
484 	return rcpu;
485 
486 free_prog:
487 	if (rcpu->prog)
488 		bpf_prog_put(rcpu->prog);
489 free_ptr_ring:
490 	ptr_ring_cleanup(rcpu->queue, NULL);
491 free_queue:
492 	kfree(rcpu->queue);
493 free_bulkq:
494 	free_percpu(rcpu->bulkq);
495 free_rcu:
496 	kfree(rcpu);
497 	return NULL;
498 }
499 
500 static void __cpu_map_entry_free(struct rcu_head *rcu)
501 {
502 	struct bpf_cpu_map_entry *rcpu;
503 
504 	/* This cpu_map_entry have been disconnected from map and one
505 	 * RCU grace-period have elapsed.  Thus, XDP cannot queue any
506 	 * new packets and cannot change/set flush_needed that can
507 	 * find this entry.
508 	 */
509 	rcpu = container_of(rcu, struct bpf_cpu_map_entry, rcu);
510 
511 	free_percpu(rcpu->bulkq);
512 	/* Cannot kthread_stop() here, last put free rcpu resources */
513 	put_cpu_map_entry(rcpu);
514 }
515 
516 /* After xchg pointer to bpf_cpu_map_entry, use the call_rcu() to
517  * ensure any driver rcu critical sections have completed, but this
518  * does not guarantee a flush has happened yet. Because driver side
519  * rcu_read_lock/unlock only protects the running XDP program.  The
520  * atomic xchg and NULL-ptr check in __cpu_map_flush() makes sure a
521  * pending flush op doesn't fail.
522  *
523  * The bpf_cpu_map_entry is still used by the kthread, and there can
524  * still be pending packets (in queue and percpu bulkq).  A refcnt
525  * makes sure to last user (kthread_stop vs. call_rcu) free memory
526  * resources.
527  *
528  * The rcu callback __cpu_map_entry_free flush remaining packets in
529  * percpu bulkq to queue.  Due to caller map_delete_elem() disable
530  * preemption, cannot call kthread_stop() to make sure queue is empty.
531  * Instead a work_queue is started for stopping kthread,
532  * cpu_map_kthread_stop, which waits for an RCU grace period before
533  * stopping kthread, emptying the queue.
534  */
535 static void __cpu_map_entry_replace(struct bpf_cpu_map *cmap,
536 				    u32 key_cpu, struct bpf_cpu_map_entry *rcpu)
537 {
538 	struct bpf_cpu_map_entry *old_rcpu;
539 
540 	old_rcpu = unrcu_pointer(xchg(&cmap->cpu_map[key_cpu], RCU_INITIALIZER(rcpu)));
541 	if (old_rcpu) {
542 		call_rcu(&old_rcpu->rcu, __cpu_map_entry_free);
543 		INIT_WORK(&old_rcpu->kthread_stop_wq, cpu_map_kthread_stop);
544 		schedule_work(&old_rcpu->kthread_stop_wq);
545 	}
546 }
547 
548 static long cpu_map_delete_elem(struct bpf_map *map, void *key)
549 {
550 	struct bpf_cpu_map *cmap = container_of(map, struct bpf_cpu_map, map);
551 	u32 key_cpu = *(u32 *)key;
552 
553 	if (key_cpu >= map->max_entries)
554 		return -EINVAL;
555 
556 	/* notice caller map_delete_elem() use preempt_disable() */
557 	__cpu_map_entry_replace(cmap, key_cpu, NULL);
558 	return 0;
559 }
560 
561 static long cpu_map_update_elem(struct bpf_map *map, void *key, void *value,
562 				u64 map_flags)
563 {
564 	struct bpf_cpu_map *cmap = container_of(map, struct bpf_cpu_map, map);
565 	struct bpf_cpumap_val cpumap_value = {};
566 	struct bpf_cpu_map_entry *rcpu;
567 	/* Array index key correspond to CPU number */
568 	u32 key_cpu = *(u32 *)key;
569 
570 	memcpy(&cpumap_value, value, map->value_size);
571 
572 	if (unlikely(map_flags > BPF_EXIST))
573 		return -EINVAL;
574 	if (unlikely(key_cpu >= cmap->map.max_entries))
575 		return -E2BIG;
576 	if (unlikely(map_flags == BPF_NOEXIST))
577 		return -EEXIST;
578 	if (unlikely(cpumap_value.qsize > 16384)) /* sanity limit on qsize */
579 		return -EOVERFLOW;
580 
581 	/* Make sure CPU is a valid possible cpu */
582 	if (key_cpu >= nr_cpumask_bits || !cpu_possible(key_cpu))
583 		return -ENODEV;
584 
585 	if (cpumap_value.qsize == 0) {
586 		rcpu = NULL; /* Same as deleting */
587 	} else {
588 		/* Updating qsize cause re-allocation of bpf_cpu_map_entry */
589 		rcpu = __cpu_map_entry_alloc(map, &cpumap_value, key_cpu);
590 		if (!rcpu)
591 			return -ENOMEM;
592 		rcpu->cmap = cmap;
593 	}
594 	rcu_read_lock();
595 	__cpu_map_entry_replace(cmap, key_cpu, rcpu);
596 	rcu_read_unlock();
597 	return 0;
598 }
599 
600 static void cpu_map_free(struct bpf_map *map)
601 {
602 	struct bpf_cpu_map *cmap = container_of(map, struct bpf_cpu_map, map);
603 	u32 i;
604 
605 	/* At this point bpf_prog->aux->refcnt == 0 and this map->refcnt == 0,
606 	 * so the bpf programs (can be more than one that used this map) were
607 	 * disconnected from events. Wait for outstanding critical sections in
608 	 * these programs to complete. The rcu critical section only guarantees
609 	 * no further "XDP/bpf-side" reads against bpf_cpu_map->cpu_map.
610 	 * It does __not__ ensure pending flush operations (if any) are
611 	 * complete.
612 	 */
613 
614 	synchronize_rcu();
615 
616 	/* For cpu_map the remote CPUs can still be using the entries
617 	 * (struct bpf_cpu_map_entry).
618 	 */
619 	for (i = 0; i < cmap->map.max_entries; i++) {
620 		struct bpf_cpu_map_entry *rcpu;
621 
622 		rcpu = rcu_dereference_raw(cmap->cpu_map[i]);
623 		if (!rcpu)
624 			continue;
625 
626 		/* bq flush and cleanup happens after RCU grace-period */
627 		__cpu_map_entry_replace(cmap, i, NULL); /* call_rcu */
628 	}
629 	bpf_map_area_free(cmap->cpu_map);
630 	bpf_map_area_free(cmap);
631 }
632 
633 /* Elements are kept alive by RCU; either by rcu_read_lock() (from syscall) or
634  * by local_bh_disable() (from XDP calls inside NAPI). The
635  * rcu_read_lock_bh_held() below makes lockdep accept both.
636  */
637 static void *__cpu_map_lookup_elem(struct bpf_map *map, u32 key)
638 {
639 	struct bpf_cpu_map *cmap = container_of(map, struct bpf_cpu_map, map);
640 	struct bpf_cpu_map_entry *rcpu;
641 
642 	if (key >= map->max_entries)
643 		return NULL;
644 
645 	rcpu = rcu_dereference_check(cmap->cpu_map[key],
646 				     rcu_read_lock_bh_held());
647 	return rcpu;
648 }
649 
650 static void *cpu_map_lookup_elem(struct bpf_map *map, void *key)
651 {
652 	struct bpf_cpu_map_entry *rcpu =
653 		__cpu_map_lookup_elem(map, *(u32 *)key);
654 
655 	return rcpu ? &rcpu->value : NULL;
656 }
657 
658 static int cpu_map_get_next_key(struct bpf_map *map, void *key, void *next_key)
659 {
660 	struct bpf_cpu_map *cmap = container_of(map, struct bpf_cpu_map, map);
661 	u32 index = key ? *(u32 *)key : U32_MAX;
662 	u32 *next = next_key;
663 
664 	if (index >= cmap->map.max_entries) {
665 		*next = 0;
666 		return 0;
667 	}
668 
669 	if (index == cmap->map.max_entries - 1)
670 		return -ENOENT;
671 	*next = index + 1;
672 	return 0;
673 }
674 
675 static long cpu_map_redirect(struct bpf_map *map, u64 index, u64 flags)
676 {
677 	return __bpf_xdp_redirect_map(map, index, flags, 0,
678 				      __cpu_map_lookup_elem);
679 }
680 
681 static u64 cpu_map_mem_usage(const struct bpf_map *map)
682 {
683 	u64 usage = sizeof(struct bpf_cpu_map);
684 
685 	/* Currently the dynamically allocated elements are not counted */
686 	usage += (u64)map->max_entries * sizeof(struct bpf_cpu_map_entry *);
687 	return usage;
688 }
689 
690 BTF_ID_LIST_SINGLE(cpu_map_btf_ids, struct, bpf_cpu_map)
691 const struct bpf_map_ops cpu_map_ops = {
692 	.map_meta_equal		= bpf_map_meta_equal,
693 	.map_alloc		= cpu_map_alloc,
694 	.map_free		= cpu_map_free,
695 	.map_delete_elem	= cpu_map_delete_elem,
696 	.map_update_elem	= cpu_map_update_elem,
697 	.map_lookup_elem	= cpu_map_lookup_elem,
698 	.map_get_next_key	= cpu_map_get_next_key,
699 	.map_check_btf		= map_check_no_btf,
700 	.map_mem_usage		= cpu_map_mem_usage,
701 	.map_btf_id		= &cpu_map_btf_ids[0],
702 	.map_redirect		= cpu_map_redirect,
703 };
704 
705 static void bq_flush_to_queue(struct xdp_bulk_queue *bq)
706 {
707 	struct bpf_cpu_map_entry *rcpu = bq->obj;
708 	unsigned int processed = 0, drops = 0;
709 	const int to_cpu = rcpu->cpu;
710 	struct ptr_ring *q;
711 	int i;
712 
713 	if (unlikely(!bq->count))
714 		return;
715 
716 	q = rcpu->queue;
717 	spin_lock(&q->producer_lock);
718 
719 	for (i = 0; i < bq->count; i++) {
720 		struct xdp_frame *xdpf = bq->q[i];
721 		int err;
722 
723 		err = __ptr_ring_produce(q, xdpf);
724 		if (err) {
725 			drops++;
726 			xdp_return_frame_rx_napi(xdpf);
727 		}
728 		processed++;
729 	}
730 	bq->count = 0;
731 	spin_unlock(&q->producer_lock);
732 
733 	__list_del_clearprev(&bq->flush_node);
734 
735 	/* Feedback loop via tracepoints */
736 	trace_xdp_cpumap_enqueue(rcpu->map_id, processed, drops, to_cpu);
737 }
738 
739 /* Runs under RCU-read-side, plus in softirq under NAPI protection.
740  * Thus, safe percpu variable access.
741  */
742 static void bq_enqueue(struct bpf_cpu_map_entry *rcpu, struct xdp_frame *xdpf)
743 {
744 	struct list_head *flush_list = this_cpu_ptr(&cpu_map_flush_list);
745 	struct xdp_bulk_queue *bq = this_cpu_ptr(rcpu->bulkq);
746 
747 	if (unlikely(bq->count == CPU_MAP_BULK_SIZE))
748 		bq_flush_to_queue(bq);
749 
750 	/* Notice, xdp_buff/page MUST be queued here, long enough for
751 	 * driver to code invoking us to finished, due to driver
752 	 * (e.g. ixgbe) recycle tricks based on page-refcnt.
753 	 *
754 	 * Thus, incoming xdp_frame is always queued here (else we race
755 	 * with another CPU on page-refcnt and remaining driver code).
756 	 * Queue time is very short, as driver will invoke flush
757 	 * operation, when completing napi->poll call.
758 	 */
759 	bq->q[bq->count++] = xdpf;
760 
761 	if (!bq->flush_node.prev)
762 		list_add(&bq->flush_node, flush_list);
763 }
764 
765 int cpu_map_enqueue(struct bpf_cpu_map_entry *rcpu, struct xdp_frame *xdpf,
766 		    struct net_device *dev_rx)
767 {
768 	/* Info needed when constructing SKB on remote CPU */
769 	xdpf->dev_rx = dev_rx;
770 
771 	bq_enqueue(rcpu, xdpf);
772 	return 0;
773 }
774 
775 int cpu_map_generic_redirect(struct bpf_cpu_map_entry *rcpu,
776 			     struct sk_buff *skb)
777 {
778 	int ret;
779 
780 	__skb_pull(skb, skb->mac_len);
781 	skb_set_redirected(skb, false);
782 	__ptr_set_bit(0, &skb);
783 
784 	ret = ptr_ring_produce(rcpu->queue, skb);
785 	if (ret < 0)
786 		goto trace;
787 
788 	wake_up_process(rcpu->kthread);
789 trace:
790 	trace_xdp_cpumap_enqueue(rcpu->map_id, !ret, !!ret, rcpu->cpu);
791 	return ret;
792 }
793 
794 void __cpu_map_flush(void)
795 {
796 	struct list_head *flush_list = this_cpu_ptr(&cpu_map_flush_list);
797 	struct xdp_bulk_queue *bq, *tmp;
798 
799 	list_for_each_entry_safe(bq, tmp, flush_list, flush_node) {
800 		bq_flush_to_queue(bq);
801 
802 		/* If already running, costs spin_lock_irqsave + smb_mb */
803 		wake_up_process(bq->obj->kthread);
804 	}
805 }
806 
807 static int __init cpu_map_init(void)
808 {
809 	int cpu;
810 
811 	for_each_possible_cpu(cpu)
812 		INIT_LIST_HEAD(&per_cpu(cpu_map_flush_list, cpu));
813 	return 0;
814 }
815 
816 subsys_initcall(cpu_map_init);
817