xref: /linux/net/xdp/xsk.c (revision 07fdad3a93756b872da7b53647715c48d0f4a2d0)
1 // SPDX-License-Identifier: GPL-2.0
2 /* XDP sockets
3  *
4  * AF_XDP sockets allows a channel between XDP programs and userspace
5  * applications.
6  * Copyright(c) 2018 Intel Corporation.
7  *
8  * Author(s): Björn Töpel <bjorn.topel@intel.com>
9  *	      Magnus Karlsson <magnus.karlsson@intel.com>
10  */
11 
12 #define pr_fmt(fmt) "AF_XDP: %s: " fmt, __func__
13 
14 #include <linux/if_xdp.h>
15 #include <linux/init.h>
16 #include <linux/sched/mm.h>
17 #include <linux/sched/signal.h>
18 #include <linux/sched/task.h>
19 #include <linux/socket.h>
20 #include <linux/file.h>
21 #include <linux/uaccess.h>
22 #include <linux/net.h>
23 #include <linux/netdevice.h>
24 #include <linux/rculist.h>
25 #include <linux/vmalloc.h>
26 #include <net/xdp_sock_drv.h>
27 #include <net/busy_poll.h>
28 #include <net/netdev_lock.h>
29 #include <net/netdev_rx_queue.h>
30 #include <net/xdp.h>
31 
32 #include "xsk_queue.h"
33 #include "xdp_umem.h"
34 #include "xsk.h"
35 
36 #define TX_BATCH_SIZE 32
37 #define MAX_PER_SOCKET_BUDGET 32
38 
39 struct xsk_addr_node {
40 	u64 addr;
41 	struct list_head addr_node;
42 };
43 
44 struct xsk_addr_head {
45 	u32 num_descs;
46 	struct list_head addrs_list;
47 };
48 
49 static struct kmem_cache *xsk_tx_generic_cache;
50 
51 #define XSKCB(skb) ((struct xsk_addr_head *)((skb)->cb))
52 
53 void xsk_set_rx_need_wakeup(struct xsk_buff_pool *pool)
54 {
55 	if (pool->cached_need_wakeup & XDP_WAKEUP_RX)
56 		return;
57 
58 	pool->fq->ring->flags |= XDP_RING_NEED_WAKEUP;
59 	pool->cached_need_wakeup |= XDP_WAKEUP_RX;
60 }
61 EXPORT_SYMBOL(xsk_set_rx_need_wakeup);
62 
63 void xsk_set_tx_need_wakeup(struct xsk_buff_pool *pool)
64 {
65 	struct xdp_sock *xs;
66 
67 	if (pool->cached_need_wakeup & XDP_WAKEUP_TX)
68 		return;
69 
70 	rcu_read_lock();
71 	list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list) {
72 		xs->tx->ring->flags |= XDP_RING_NEED_WAKEUP;
73 	}
74 	rcu_read_unlock();
75 
76 	pool->cached_need_wakeup |= XDP_WAKEUP_TX;
77 }
78 EXPORT_SYMBOL(xsk_set_tx_need_wakeup);
79 
80 void xsk_clear_rx_need_wakeup(struct xsk_buff_pool *pool)
81 {
82 	if (!(pool->cached_need_wakeup & XDP_WAKEUP_RX))
83 		return;
84 
85 	pool->fq->ring->flags &= ~XDP_RING_NEED_WAKEUP;
86 	pool->cached_need_wakeup &= ~XDP_WAKEUP_RX;
87 }
88 EXPORT_SYMBOL(xsk_clear_rx_need_wakeup);
89 
90 void xsk_clear_tx_need_wakeup(struct xsk_buff_pool *pool)
91 {
92 	struct xdp_sock *xs;
93 
94 	if (!(pool->cached_need_wakeup & XDP_WAKEUP_TX))
95 		return;
96 
97 	rcu_read_lock();
98 	list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list) {
99 		xs->tx->ring->flags &= ~XDP_RING_NEED_WAKEUP;
100 	}
101 	rcu_read_unlock();
102 
103 	pool->cached_need_wakeup &= ~XDP_WAKEUP_TX;
104 }
105 EXPORT_SYMBOL(xsk_clear_tx_need_wakeup);
106 
107 bool xsk_uses_need_wakeup(struct xsk_buff_pool *pool)
108 {
109 	return pool->uses_need_wakeup;
110 }
111 EXPORT_SYMBOL(xsk_uses_need_wakeup);
112 
113 struct xsk_buff_pool *xsk_get_pool_from_qid(struct net_device *dev,
114 					    u16 queue_id)
115 {
116 	if (queue_id < dev->real_num_rx_queues)
117 		return dev->_rx[queue_id].pool;
118 	if (queue_id < dev->real_num_tx_queues)
119 		return dev->_tx[queue_id].pool;
120 
121 	return NULL;
122 }
123 EXPORT_SYMBOL(xsk_get_pool_from_qid);
124 
125 void xsk_clear_pool_at_qid(struct net_device *dev, u16 queue_id)
126 {
127 	if (queue_id < dev->num_rx_queues)
128 		dev->_rx[queue_id].pool = NULL;
129 	if (queue_id < dev->num_tx_queues)
130 		dev->_tx[queue_id].pool = NULL;
131 }
132 
133 /* The buffer pool is stored both in the _rx struct and the _tx struct as we do
134  * not know if the device has more tx queues than rx, or the opposite.
135  * This might also change during run time.
136  */
137 int xsk_reg_pool_at_qid(struct net_device *dev, struct xsk_buff_pool *pool,
138 			u16 queue_id)
139 {
140 	if (queue_id >= max_t(unsigned int,
141 			      dev->real_num_rx_queues,
142 			      dev->real_num_tx_queues))
143 		return -EINVAL;
144 
145 	if (queue_id < dev->real_num_rx_queues)
146 		dev->_rx[queue_id].pool = pool;
147 	if (queue_id < dev->real_num_tx_queues)
148 		dev->_tx[queue_id].pool = pool;
149 
150 	return 0;
151 }
152 
153 static int __xsk_rcv_zc(struct xdp_sock *xs, struct xdp_buff_xsk *xskb, u32 len,
154 			u32 flags)
155 {
156 	u64 addr;
157 	int err;
158 
159 	addr = xp_get_handle(xskb, xskb->pool);
160 	err = xskq_prod_reserve_desc(xs->rx, addr, len, flags);
161 	if (err) {
162 		xs->rx_queue_full++;
163 		return err;
164 	}
165 
166 	xp_release(xskb);
167 	return 0;
168 }
169 
170 static int xsk_rcv_zc(struct xdp_sock *xs, struct xdp_buff *xdp, u32 len)
171 {
172 	struct xdp_buff_xsk *xskb = container_of(xdp, struct xdp_buff_xsk, xdp);
173 	u32 frags = xdp_buff_has_frags(xdp);
174 	struct xdp_buff_xsk *pos, *tmp;
175 	struct list_head *xskb_list;
176 	u32 contd = 0;
177 	int err;
178 
179 	if (frags)
180 		contd = XDP_PKT_CONTD;
181 
182 	err = __xsk_rcv_zc(xs, xskb, len, contd);
183 	if (err)
184 		goto err;
185 	if (likely(!frags))
186 		return 0;
187 
188 	xskb_list = &xskb->pool->xskb_list;
189 	list_for_each_entry_safe(pos, tmp, xskb_list, list_node) {
190 		if (list_is_singular(xskb_list))
191 			contd = 0;
192 		len = pos->xdp.data_end - pos->xdp.data;
193 		err = __xsk_rcv_zc(xs, pos, len, contd);
194 		if (err)
195 			goto err;
196 		list_del(&pos->list_node);
197 	}
198 
199 	return 0;
200 err:
201 	xsk_buff_free(xdp);
202 	return err;
203 }
204 
205 static void *xsk_copy_xdp_start(struct xdp_buff *from)
206 {
207 	if (unlikely(xdp_data_meta_unsupported(from)))
208 		return from->data;
209 	else
210 		return from->data_meta;
211 }
212 
213 static u32 xsk_copy_xdp(void *to, void **from, u32 to_len,
214 			u32 *from_len, skb_frag_t **frag, u32 rem)
215 {
216 	u32 copied = 0;
217 
218 	while (1) {
219 		u32 copy_len = min_t(u32, *from_len, to_len);
220 
221 		memcpy(to, *from, copy_len);
222 		copied += copy_len;
223 		if (rem == copied)
224 			return copied;
225 
226 		if (*from_len == copy_len) {
227 			*from = skb_frag_address(*frag);
228 			*from_len = skb_frag_size((*frag)++);
229 		} else {
230 			*from += copy_len;
231 			*from_len -= copy_len;
232 		}
233 		if (to_len == copy_len)
234 			return copied;
235 
236 		to_len -= copy_len;
237 		to += copy_len;
238 	}
239 }
240 
241 static int __xsk_rcv(struct xdp_sock *xs, struct xdp_buff *xdp, u32 len)
242 {
243 	u32 frame_size = xsk_pool_get_rx_frame_size(xs->pool);
244 	void *copy_from = xsk_copy_xdp_start(xdp), *copy_to;
245 	u32 from_len, meta_len, rem, num_desc;
246 	struct xdp_buff_xsk *xskb;
247 	struct xdp_buff *xsk_xdp;
248 	skb_frag_t *frag;
249 
250 	from_len = xdp->data_end - copy_from;
251 	meta_len = xdp->data - copy_from;
252 	rem = len + meta_len;
253 
254 	if (len <= frame_size && !xdp_buff_has_frags(xdp)) {
255 		int err;
256 
257 		xsk_xdp = xsk_buff_alloc(xs->pool);
258 		if (!xsk_xdp) {
259 			xs->rx_dropped++;
260 			return -ENOMEM;
261 		}
262 		memcpy(xsk_xdp->data - meta_len, copy_from, rem);
263 		xskb = container_of(xsk_xdp, struct xdp_buff_xsk, xdp);
264 		err = __xsk_rcv_zc(xs, xskb, len, 0);
265 		if (err) {
266 			xsk_buff_free(xsk_xdp);
267 			return err;
268 		}
269 
270 		return 0;
271 	}
272 
273 	num_desc = (len - 1) / frame_size + 1;
274 
275 	if (!xsk_buff_can_alloc(xs->pool, num_desc)) {
276 		xs->rx_dropped++;
277 		return -ENOMEM;
278 	}
279 	if (xskq_prod_nb_free(xs->rx, num_desc) < num_desc) {
280 		xs->rx_queue_full++;
281 		return -ENOBUFS;
282 	}
283 
284 	if (xdp_buff_has_frags(xdp)) {
285 		struct skb_shared_info *sinfo;
286 
287 		sinfo = xdp_get_shared_info_from_buff(xdp);
288 		frag =  &sinfo->frags[0];
289 	}
290 
291 	do {
292 		u32 to_len = frame_size + meta_len;
293 		u32 copied;
294 
295 		xsk_xdp = xsk_buff_alloc(xs->pool);
296 		copy_to = xsk_xdp->data - meta_len;
297 
298 		copied = xsk_copy_xdp(copy_to, &copy_from, to_len, &from_len, &frag, rem);
299 		rem -= copied;
300 
301 		xskb = container_of(xsk_xdp, struct xdp_buff_xsk, xdp);
302 		__xsk_rcv_zc(xs, xskb, copied - meta_len, rem ? XDP_PKT_CONTD : 0);
303 		meta_len = 0;
304 	} while (rem);
305 
306 	return 0;
307 }
308 
309 static bool xsk_tx_writeable(struct xdp_sock *xs)
310 {
311 	if (xskq_cons_present_entries(xs->tx) > xs->tx->nentries / 2)
312 		return false;
313 
314 	return true;
315 }
316 
317 static void __xsk_tx_release(struct xdp_sock *xs)
318 {
319 	__xskq_cons_release(xs->tx);
320 	if (xsk_tx_writeable(xs))
321 		xs->sk.sk_write_space(&xs->sk);
322 }
323 
324 static bool xsk_is_bound(struct xdp_sock *xs)
325 {
326 	if (READ_ONCE(xs->state) == XSK_BOUND) {
327 		/* Matches smp_wmb() in bind(). */
328 		smp_rmb();
329 		return true;
330 	}
331 	return false;
332 }
333 
334 static int xsk_rcv_check(struct xdp_sock *xs, struct xdp_buff *xdp, u32 len)
335 {
336 	if (!xsk_is_bound(xs))
337 		return -ENXIO;
338 
339 	if (xs->dev != xdp->rxq->dev || xs->queue_id != xdp->rxq->queue_index)
340 		return -EINVAL;
341 
342 	if (len > xsk_pool_get_rx_frame_size(xs->pool) && !xs->sg) {
343 		xs->rx_dropped++;
344 		return -ENOSPC;
345 	}
346 
347 	return 0;
348 }
349 
350 static void xsk_flush(struct xdp_sock *xs)
351 {
352 	xskq_prod_submit(xs->rx);
353 	__xskq_cons_release(xs->pool->fq);
354 	sock_def_readable(&xs->sk);
355 }
356 
357 int xsk_generic_rcv(struct xdp_sock *xs, struct xdp_buff *xdp)
358 {
359 	u32 len = xdp_get_buff_len(xdp);
360 	int err;
361 
362 	err = xsk_rcv_check(xs, xdp, len);
363 	if (!err) {
364 		spin_lock_bh(&xs->pool->rx_lock);
365 		err = __xsk_rcv(xs, xdp, len);
366 		xsk_flush(xs);
367 		spin_unlock_bh(&xs->pool->rx_lock);
368 	}
369 
370 	return err;
371 }
372 
373 static int xsk_rcv(struct xdp_sock *xs, struct xdp_buff *xdp)
374 {
375 	u32 len = xdp_get_buff_len(xdp);
376 	int err;
377 
378 	err = xsk_rcv_check(xs, xdp, len);
379 	if (err)
380 		return err;
381 
382 	if (xdp->rxq->mem.type == MEM_TYPE_XSK_BUFF_POOL) {
383 		len = xdp->data_end - xdp->data;
384 		return xsk_rcv_zc(xs, xdp, len);
385 	}
386 
387 	err = __xsk_rcv(xs, xdp, len);
388 	if (!err)
389 		xdp_return_buff(xdp);
390 	return err;
391 }
392 
393 int __xsk_map_redirect(struct xdp_sock *xs, struct xdp_buff *xdp)
394 {
395 	int err;
396 
397 	err = xsk_rcv(xs, xdp);
398 	if (err)
399 		return err;
400 
401 	if (!xs->flush_node.prev) {
402 		struct list_head *flush_list = bpf_net_ctx_get_xskmap_flush_list();
403 
404 		list_add(&xs->flush_node, flush_list);
405 	}
406 
407 	return 0;
408 }
409 
410 void __xsk_map_flush(struct list_head *flush_list)
411 {
412 	struct xdp_sock *xs, *tmp;
413 
414 	list_for_each_entry_safe(xs, tmp, flush_list, flush_node) {
415 		xsk_flush(xs);
416 		__list_del_clearprev(&xs->flush_node);
417 	}
418 }
419 
420 void xsk_tx_completed(struct xsk_buff_pool *pool, u32 nb_entries)
421 {
422 	xskq_prod_submit_n(pool->cq, nb_entries);
423 }
424 EXPORT_SYMBOL(xsk_tx_completed);
425 
426 void xsk_tx_release(struct xsk_buff_pool *pool)
427 {
428 	struct xdp_sock *xs;
429 
430 	rcu_read_lock();
431 	list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list)
432 		__xsk_tx_release(xs);
433 	rcu_read_unlock();
434 }
435 EXPORT_SYMBOL(xsk_tx_release);
436 
437 bool xsk_tx_peek_desc(struct xsk_buff_pool *pool, struct xdp_desc *desc)
438 {
439 	bool budget_exhausted = false;
440 	struct xdp_sock *xs;
441 
442 	rcu_read_lock();
443 again:
444 	list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list) {
445 		if (xs->tx_budget_spent >= MAX_PER_SOCKET_BUDGET) {
446 			budget_exhausted = true;
447 			continue;
448 		}
449 
450 		if (!xskq_cons_peek_desc(xs->tx, desc, pool)) {
451 			if (xskq_has_descs(xs->tx))
452 				xskq_cons_release(xs->tx);
453 			continue;
454 		}
455 
456 		xs->tx_budget_spent++;
457 
458 		/* This is the backpressure mechanism for the Tx path.
459 		 * Reserve space in the completion queue and only proceed
460 		 * if there is space in it. This avoids having to implement
461 		 * any buffering in the Tx path.
462 		 */
463 		if (xskq_prod_reserve_addr(pool->cq, desc->addr))
464 			goto out;
465 
466 		xskq_cons_release(xs->tx);
467 		rcu_read_unlock();
468 		return true;
469 	}
470 
471 	if (budget_exhausted) {
472 		list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list)
473 			xs->tx_budget_spent = 0;
474 
475 		budget_exhausted = false;
476 		goto again;
477 	}
478 
479 out:
480 	rcu_read_unlock();
481 	return false;
482 }
483 EXPORT_SYMBOL(xsk_tx_peek_desc);
484 
485 static u32 xsk_tx_peek_release_fallback(struct xsk_buff_pool *pool, u32 max_entries)
486 {
487 	struct xdp_desc *descs = pool->tx_descs;
488 	u32 nb_pkts = 0;
489 
490 	while (nb_pkts < max_entries && xsk_tx_peek_desc(pool, &descs[nb_pkts]))
491 		nb_pkts++;
492 
493 	xsk_tx_release(pool);
494 	return nb_pkts;
495 }
496 
497 u32 xsk_tx_peek_release_desc_batch(struct xsk_buff_pool *pool, u32 nb_pkts)
498 {
499 	struct xdp_sock *xs;
500 
501 	rcu_read_lock();
502 	if (!list_is_singular(&pool->xsk_tx_list)) {
503 		/* Fallback to the non-batched version */
504 		rcu_read_unlock();
505 		return xsk_tx_peek_release_fallback(pool, nb_pkts);
506 	}
507 
508 	xs = list_first_or_null_rcu(&pool->xsk_tx_list, struct xdp_sock, tx_list);
509 	if (!xs) {
510 		nb_pkts = 0;
511 		goto out;
512 	}
513 
514 	nb_pkts = xskq_cons_nb_entries(xs->tx, nb_pkts);
515 
516 	/* This is the backpressure mechanism for the Tx path. Try to
517 	 * reserve space in the completion queue for all packets, but
518 	 * if there are fewer slots available, just process that many
519 	 * packets. This avoids having to implement any buffering in
520 	 * the Tx path.
521 	 */
522 	nb_pkts = xskq_prod_nb_free(pool->cq, nb_pkts);
523 	if (!nb_pkts)
524 		goto out;
525 
526 	nb_pkts = xskq_cons_read_desc_batch(xs->tx, pool, nb_pkts);
527 	if (!nb_pkts) {
528 		xs->tx->queue_empty_descs++;
529 		goto out;
530 	}
531 
532 	__xskq_cons_release(xs->tx);
533 	xskq_prod_write_addr_batch(pool->cq, pool->tx_descs, nb_pkts);
534 	xs->sk.sk_write_space(&xs->sk);
535 
536 out:
537 	rcu_read_unlock();
538 	return nb_pkts;
539 }
540 EXPORT_SYMBOL(xsk_tx_peek_release_desc_batch);
541 
542 static int xsk_wakeup(struct xdp_sock *xs, u8 flags)
543 {
544 	struct net_device *dev = xs->dev;
545 
546 	return dev->netdev_ops->ndo_xsk_wakeup(dev, xs->queue_id, flags);
547 }
548 
549 static int xsk_cq_reserve_locked(struct xsk_buff_pool *pool)
550 {
551 	unsigned long flags;
552 	int ret;
553 
554 	spin_lock_irqsave(&pool->cq_lock, flags);
555 	ret = xskq_prod_reserve(pool->cq);
556 	spin_unlock_irqrestore(&pool->cq_lock, flags);
557 
558 	return ret;
559 }
560 
561 static void xsk_cq_submit_addr_locked(struct xsk_buff_pool *pool,
562 				      struct sk_buff *skb)
563 {
564 	struct xsk_addr_node *pos, *tmp;
565 	u32 descs_processed = 0;
566 	unsigned long flags;
567 	u32 idx;
568 
569 	spin_lock_irqsave(&pool->cq_lock, flags);
570 	idx = xskq_get_prod(pool->cq);
571 
572 	xskq_prod_write_addr(pool->cq, idx,
573 			     (u64)(uintptr_t)skb_shinfo(skb)->destructor_arg);
574 	descs_processed++;
575 
576 	if (unlikely(XSKCB(skb)->num_descs > 1)) {
577 		list_for_each_entry_safe(pos, tmp, &XSKCB(skb)->addrs_list, addr_node) {
578 			xskq_prod_write_addr(pool->cq, idx + descs_processed,
579 					     pos->addr);
580 			descs_processed++;
581 			list_del(&pos->addr_node);
582 			kmem_cache_free(xsk_tx_generic_cache, pos);
583 		}
584 	}
585 	xskq_prod_submit_n(pool->cq, descs_processed);
586 	spin_unlock_irqrestore(&pool->cq_lock, flags);
587 }
588 
589 static void xsk_cq_cancel_locked(struct xsk_buff_pool *pool, u32 n)
590 {
591 	unsigned long flags;
592 
593 	spin_lock_irqsave(&pool->cq_lock, flags);
594 	xskq_prod_cancel_n(pool->cq, n);
595 	spin_unlock_irqrestore(&pool->cq_lock, flags);
596 }
597 
598 static void xsk_inc_num_desc(struct sk_buff *skb)
599 {
600 	XSKCB(skb)->num_descs++;
601 }
602 
603 static u32 xsk_get_num_desc(struct sk_buff *skb)
604 {
605 	return XSKCB(skb)->num_descs;
606 }
607 
608 static void xsk_destruct_skb(struct sk_buff *skb)
609 {
610 	struct xsk_tx_metadata_compl *compl = &skb_shinfo(skb)->xsk_meta;
611 
612 	if (compl->tx_timestamp) {
613 		/* sw completion timestamp, not a real one */
614 		*compl->tx_timestamp = ktime_get_tai_fast_ns();
615 	}
616 
617 	xsk_cq_submit_addr_locked(xdp_sk(skb->sk)->pool, skb);
618 	sock_wfree(skb);
619 }
620 
621 static void xsk_skb_init_misc(struct sk_buff *skb, struct xdp_sock *xs,
622 			      u64 addr)
623 {
624 	BUILD_BUG_ON(sizeof(struct xsk_addr_head) > sizeof(skb->cb));
625 	INIT_LIST_HEAD(&XSKCB(skb)->addrs_list);
626 	skb->dev = xs->dev;
627 	skb->priority = READ_ONCE(xs->sk.sk_priority);
628 	skb->mark = READ_ONCE(xs->sk.sk_mark);
629 	XSKCB(skb)->num_descs = 0;
630 	skb->destructor = xsk_destruct_skb;
631 	skb_shinfo(skb)->destructor_arg = (void *)(uintptr_t)addr;
632 }
633 
634 static void xsk_consume_skb(struct sk_buff *skb)
635 {
636 	struct xdp_sock *xs = xdp_sk(skb->sk);
637 	u32 num_descs = xsk_get_num_desc(skb);
638 	struct xsk_addr_node *pos, *tmp;
639 
640 	if (unlikely(num_descs > 1)) {
641 		list_for_each_entry_safe(pos, tmp, &XSKCB(skb)->addrs_list, addr_node) {
642 			list_del(&pos->addr_node);
643 			kmem_cache_free(xsk_tx_generic_cache, pos);
644 		}
645 	}
646 
647 	skb->destructor = sock_wfree;
648 	xsk_cq_cancel_locked(xs->pool, num_descs);
649 	/* Free skb without triggering the perf drop trace */
650 	consume_skb(skb);
651 	xs->skb = NULL;
652 }
653 
654 static void xsk_drop_skb(struct sk_buff *skb)
655 {
656 	xdp_sk(skb->sk)->tx->invalid_descs += xsk_get_num_desc(skb);
657 	xsk_consume_skb(skb);
658 }
659 
660 static int xsk_skb_metadata(struct sk_buff *skb, void *buffer,
661 			    struct xdp_desc *desc, struct xsk_buff_pool *pool,
662 			    u32 hr)
663 {
664 	struct xsk_tx_metadata *meta = NULL;
665 
666 	if (unlikely(pool->tx_metadata_len == 0))
667 		return -EINVAL;
668 
669 	meta = buffer - pool->tx_metadata_len;
670 	if (unlikely(!xsk_buff_valid_tx_metadata(meta)))
671 		return -EINVAL;
672 
673 	if (meta->flags & XDP_TXMD_FLAGS_CHECKSUM) {
674 		if (unlikely(meta->request.csum_start +
675 			     meta->request.csum_offset +
676 			     sizeof(__sum16) > desc->len))
677 			return -EINVAL;
678 
679 		skb->csum_start = hr + meta->request.csum_start;
680 		skb->csum_offset = meta->request.csum_offset;
681 		skb->ip_summed = CHECKSUM_PARTIAL;
682 
683 		if (unlikely(pool->tx_sw_csum)) {
684 			int err;
685 
686 			err = skb_checksum_help(skb);
687 			if (err)
688 				return err;
689 		}
690 	}
691 
692 	if (meta->flags & XDP_TXMD_FLAGS_LAUNCH_TIME)
693 		skb->skb_mstamp_ns = meta->request.launch_time;
694 	xsk_tx_metadata_to_compl(meta, &skb_shinfo(skb)->xsk_meta);
695 
696 	return 0;
697 }
698 
699 static struct sk_buff *xsk_build_skb_zerocopy(struct xdp_sock *xs,
700 					      struct xdp_desc *desc)
701 {
702 	struct xsk_buff_pool *pool = xs->pool;
703 	u32 hr, len, ts, offset, copy, copied;
704 	struct xsk_addr_node *xsk_addr;
705 	struct sk_buff *skb = xs->skb;
706 	struct page *page;
707 	void *buffer;
708 	int err, i;
709 	u64 addr;
710 
711 	addr = desc->addr;
712 	buffer = xsk_buff_raw_get_data(pool, addr);
713 
714 	if (!skb) {
715 		hr = max(NET_SKB_PAD, L1_CACHE_ALIGN(xs->dev->needed_headroom));
716 
717 		skb = sock_alloc_send_skb(&xs->sk, hr, 1, &err);
718 		if (unlikely(!skb))
719 			return ERR_PTR(err);
720 
721 		skb_reserve(skb, hr);
722 
723 		xsk_skb_init_misc(skb, xs, desc->addr);
724 		if (desc->options & XDP_TX_METADATA) {
725 			err = xsk_skb_metadata(skb, buffer, desc, pool, hr);
726 			if (unlikely(err))
727 				return ERR_PTR(err);
728 		}
729 	} else {
730 		xsk_addr = kmem_cache_zalloc(xsk_tx_generic_cache, GFP_KERNEL);
731 		if (!xsk_addr)
732 			return ERR_PTR(-ENOMEM);
733 
734 		/* in case of -EOVERFLOW that could happen below,
735 		 * xsk_consume_skb() will release this node as whole skb
736 		 * would be dropped, which implies freeing all list elements
737 		 */
738 		xsk_addr->addr = desc->addr;
739 		list_add_tail(&xsk_addr->addr_node, &XSKCB(skb)->addrs_list);
740 	}
741 
742 	len = desc->len;
743 	ts = pool->unaligned ? len : pool->chunk_size;
744 
745 	offset = offset_in_page(buffer);
746 	addr = buffer - pool->addrs;
747 
748 	for (copied = 0, i = skb_shinfo(skb)->nr_frags; copied < len; i++) {
749 		if (unlikely(i >= MAX_SKB_FRAGS))
750 			return ERR_PTR(-EOVERFLOW);
751 
752 		page = pool->umem->pgs[addr >> PAGE_SHIFT];
753 		get_page(page);
754 
755 		copy = min_t(u32, PAGE_SIZE - offset, len - copied);
756 		skb_fill_page_desc(skb, i, page, offset, copy);
757 
758 		copied += copy;
759 		addr += copy;
760 		offset = 0;
761 	}
762 
763 	skb->len += len;
764 	skb->data_len += len;
765 	skb->truesize += ts;
766 
767 	refcount_add(ts, &xs->sk.sk_wmem_alloc);
768 
769 	return skb;
770 }
771 
772 static struct sk_buff *xsk_build_skb(struct xdp_sock *xs,
773 				     struct xdp_desc *desc)
774 {
775 	struct net_device *dev = xs->dev;
776 	struct sk_buff *skb = xs->skb;
777 	int err;
778 
779 	if (dev->priv_flags & IFF_TX_SKB_NO_LINEAR) {
780 		skb = xsk_build_skb_zerocopy(xs, desc);
781 		if (IS_ERR(skb)) {
782 			err = PTR_ERR(skb);
783 			skb = NULL;
784 			goto free_err;
785 		}
786 	} else {
787 		u32 hr, tr, len;
788 		void *buffer;
789 
790 		buffer = xsk_buff_raw_get_data(xs->pool, desc->addr);
791 		len = desc->len;
792 
793 		if (!skb) {
794 			hr = max(NET_SKB_PAD, L1_CACHE_ALIGN(dev->needed_headroom));
795 			tr = dev->needed_tailroom;
796 			skb = sock_alloc_send_skb(&xs->sk, hr + len + tr, 1, &err);
797 			if (unlikely(!skb))
798 				goto free_err;
799 
800 			skb_reserve(skb, hr);
801 			skb_put(skb, len);
802 
803 			err = skb_store_bits(skb, 0, buffer, len);
804 			if (unlikely(err))
805 				goto free_err;
806 
807 			xsk_skb_init_misc(skb, xs, desc->addr);
808 			if (desc->options & XDP_TX_METADATA) {
809 				err = xsk_skb_metadata(skb, buffer, desc,
810 						       xs->pool, hr);
811 				if (unlikely(err))
812 					goto free_err;
813 			}
814 		} else {
815 			int nr_frags = skb_shinfo(skb)->nr_frags;
816 			struct xsk_addr_node *xsk_addr;
817 			struct page *page;
818 			u8 *vaddr;
819 
820 			if (unlikely(nr_frags == (MAX_SKB_FRAGS - 1) && xp_mb_desc(desc))) {
821 				err = -EOVERFLOW;
822 				goto free_err;
823 			}
824 
825 			page = alloc_page(xs->sk.sk_allocation);
826 			if (unlikely(!page)) {
827 				err = -EAGAIN;
828 				goto free_err;
829 			}
830 
831 			xsk_addr = kmem_cache_zalloc(xsk_tx_generic_cache, GFP_KERNEL);
832 			if (!xsk_addr) {
833 				__free_page(page);
834 				err = -ENOMEM;
835 				goto free_err;
836 			}
837 
838 			vaddr = kmap_local_page(page);
839 			memcpy(vaddr, buffer, len);
840 			kunmap_local(vaddr);
841 
842 			skb_add_rx_frag(skb, nr_frags, page, 0, len, PAGE_SIZE);
843 			refcount_add(PAGE_SIZE, &xs->sk.sk_wmem_alloc);
844 
845 			xsk_addr->addr = desc->addr;
846 			list_add_tail(&xsk_addr->addr_node, &XSKCB(skb)->addrs_list);
847 		}
848 	}
849 
850 	xsk_inc_num_desc(skb);
851 
852 	return skb;
853 
854 free_err:
855 	if (skb && !skb_shinfo(skb)->nr_frags)
856 		kfree_skb(skb);
857 
858 	if (err == -EOVERFLOW) {
859 		/* Drop the packet */
860 		xsk_inc_num_desc(xs->skb);
861 		xsk_drop_skb(xs->skb);
862 		xskq_cons_release(xs->tx);
863 	} else {
864 		/* Let application retry */
865 		xsk_cq_cancel_locked(xs->pool, 1);
866 	}
867 
868 	return ERR_PTR(err);
869 }
870 
871 static int __xsk_generic_xmit(struct sock *sk)
872 {
873 	struct xdp_sock *xs = xdp_sk(sk);
874 	bool sent_frame = false;
875 	struct xdp_desc desc;
876 	struct sk_buff *skb;
877 	u32 max_batch;
878 	int err = 0;
879 
880 	mutex_lock(&xs->mutex);
881 
882 	/* Since we dropped the RCU read lock, the socket state might have changed. */
883 	if (unlikely(!xsk_is_bound(xs))) {
884 		err = -ENXIO;
885 		goto out;
886 	}
887 
888 	if (xs->queue_id >= xs->dev->real_num_tx_queues)
889 		goto out;
890 
891 	max_batch = READ_ONCE(xs->max_tx_budget);
892 	while (xskq_cons_peek_desc(xs->tx, &desc, xs->pool)) {
893 		if (max_batch-- == 0) {
894 			err = -EAGAIN;
895 			goto out;
896 		}
897 
898 		/* This is the backpressure mechanism for the Tx path.
899 		 * Reserve space in the completion queue and only proceed
900 		 * if there is space in it. This avoids having to implement
901 		 * any buffering in the Tx path.
902 		 */
903 		err = xsk_cq_reserve_locked(xs->pool);
904 		if (err) {
905 			err = -EAGAIN;
906 			goto out;
907 		}
908 
909 		skb = xsk_build_skb(xs, &desc);
910 		if (IS_ERR(skb)) {
911 			err = PTR_ERR(skb);
912 			if (err != -EOVERFLOW)
913 				goto out;
914 			err = 0;
915 			continue;
916 		}
917 
918 		xskq_cons_release(xs->tx);
919 
920 		if (xp_mb_desc(&desc)) {
921 			xs->skb = skb;
922 			continue;
923 		}
924 
925 		err = __dev_direct_xmit(skb, xs->queue_id);
926 		if  (err == NETDEV_TX_BUSY) {
927 			/* Tell user-space to retry the send */
928 			xskq_cons_cancel_n(xs->tx, xsk_get_num_desc(skb));
929 			xsk_consume_skb(skb);
930 			err = -EAGAIN;
931 			goto out;
932 		}
933 
934 		/* Ignore NET_XMIT_CN as packet might have been sent */
935 		if (err == NET_XMIT_DROP) {
936 			/* SKB completed but not sent */
937 			err = -EBUSY;
938 			xs->skb = NULL;
939 			goto out;
940 		}
941 
942 		sent_frame = true;
943 		xs->skb = NULL;
944 	}
945 
946 	if (xskq_has_descs(xs->tx)) {
947 		if (xs->skb)
948 			xsk_drop_skb(xs->skb);
949 		xskq_cons_release(xs->tx);
950 	}
951 
952 out:
953 	if (sent_frame)
954 		__xsk_tx_release(xs);
955 
956 	mutex_unlock(&xs->mutex);
957 	return err;
958 }
959 
960 static int xsk_generic_xmit(struct sock *sk)
961 {
962 	int ret;
963 
964 	/* Drop the RCU lock since the SKB path might sleep. */
965 	rcu_read_unlock();
966 	ret = __xsk_generic_xmit(sk);
967 	/* Reaquire RCU lock before going into common code. */
968 	rcu_read_lock();
969 
970 	return ret;
971 }
972 
973 static bool xsk_no_wakeup(struct sock *sk)
974 {
975 #ifdef CONFIG_NET_RX_BUSY_POLL
976 	/* Prefer busy-polling, skip the wakeup. */
977 	return READ_ONCE(sk->sk_prefer_busy_poll) && READ_ONCE(sk->sk_ll_usec) &&
978 		napi_id_valid(READ_ONCE(sk->sk_napi_id));
979 #else
980 	return false;
981 #endif
982 }
983 
984 static int xsk_check_common(struct xdp_sock *xs)
985 {
986 	if (unlikely(!xsk_is_bound(xs)))
987 		return -ENXIO;
988 	if (unlikely(!(xs->dev->flags & IFF_UP)))
989 		return -ENETDOWN;
990 
991 	return 0;
992 }
993 
994 static int __xsk_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
995 {
996 	bool need_wait = !(m->msg_flags & MSG_DONTWAIT);
997 	struct sock *sk = sock->sk;
998 	struct xdp_sock *xs = xdp_sk(sk);
999 	struct xsk_buff_pool *pool;
1000 	int err;
1001 
1002 	err = xsk_check_common(xs);
1003 	if (err)
1004 		return err;
1005 	if (unlikely(need_wait))
1006 		return -EOPNOTSUPP;
1007 	if (unlikely(!xs->tx))
1008 		return -ENOBUFS;
1009 
1010 	if (sk_can_busy_loop(sk))
1011 		sk_busy_loop(sk, 1); /* only support non-blocking sockets */
1012 
1013 	if (xs->zc && xsk_no_wakeup(sk))
1014 		return 0;
1015 
1016 	pool = xs->pool;
1017 	if (pool->cached_need_wakeup & XDP_WAKEUP_TX) {
1018 		if (xs->zc)
1019 			return xsk_wakeup(xs, XDP_WAKEUP_TX);
1020 		return xsk_generic_xmit(sk);
1021 	}
1022 	return 0;
1023 }
1024 
1025 static int xsk_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
1026 {
1027 	int ret;
1028 
1029 	rcu_read_lock();
1030 	ret = __xsk_sendmsg(sock, m, total_len);
1031 	rcu_read_unlock();
1032 
1033 	return ret;
1034 }
1035 
1036 static int __xsk_recvmsg(struct socket *sock, struct msghdr *m, size_t len, int flags)
1037 {
1038 	bool need_wait = !(flags & MSG_DONTWAIT);
1039 	struct sock *sk = sock->sk;
1040 	struct xdp_sock *xs = xdp_sk(sk);
1041 	int err;
1042 
1043 	err = xsk_check_common(xs);
1044 	if (err)
1045 		return err;
1046 	if (unlikely(!xs->rx))
1047 		return -ENOBUFS;
1048 	if (unlikely(need_wait))
1049 		return -EOPNOTSUPP;
1050 
1051 	if (sk_can_busy_loop(sk))
1052 		sk_busy_loop(sk, 1); /* only support non-blocking sockets */
1053 
1054 	if (xsk_no_wakeup(sk))
1055 		return 0;
1056 
1057 	if (xs->pool->cached_need_wakeup & XDP_WAKEUP_RX && xs->zc)
1058 		return xsk_wakeup(xs, XDP_WAKEUP_RX);
1059 	return 0;
1060 }
1061 
1062 static int xsk_recvmsg(struct socket *sock, struct msghdr *m, size_t len, int flags)
1063 {
1064 	int ret;
1065 
1066 	rcu_read_lock();
1067 	ret = __xsk_recvmsg(sock, m, len, flags);
1068 	rcu_read_unlock();
1069 
1070 	return ret;
1071 }
1072 
1073 static __poll_t xsk_poll(struct file *file, struct socket *sock,
1074 			     struct poll_table_struct *wait)
1075 {
1076 	__poll_t mask = 0;
1077 	struct sock *sk = sock->sk;
1078 	struct xdp_sock *xs = xdp_sk(sk);
1079 	struct xsk_buff_pool *pool;
1080 
1081 	sock_poll_wait(file, sock, wait);
1082 
1083 	rcu_read_lock();
1084 	if (xsk_check_common(xs))
1085 		goto out;
1086 
1087 	pool = xs->pool;
1088 
1089 	if (pool->cached_need_wakeup) {
1090 		if (xs->zc)
1091 			xsk_wakeup(xs, pool->cached_need_wakeup);
1092 		else if (xs->tx)
1093 			/* Poll needs to drive Tx also in copy mode */
1094 			xsk_generic_xmit(sk);
1095 	}
1096 
1097 	if (xs->rx && !xskq_prod_is_empty(xs->rx))
1098 		mask |= EPOLLIN | EPOLLRDNORM;
1099 	if (xs->tx && xsk_tx_writeable(xs))
1100 		mask |= EPOLLOUT | EPOLLWRNORM;
1101 out:
1102 	rcu_read_unlock();
1103 	return mask;
1104 }
1105 
1106 static int xsk_init_queue(u32 entries, struct xsk_queue **queue,
1107 			  bool umem_queue)
1108 {
1109 	struct xsk_queue *q;
1110 
1111 	if (entries == 0 || *queue || !is_power_of_2(entries))
1112 		return -EINVAL;
1113 
1114 	q = xskq_create(entries, umem_queue);
1115 	if (!q)
1116 		return -ENOMEM;
1117 
1118 	/* Make sure queue is ready before it can be seen by others */
1119 	smp_wmb();
1120 	WRITE_ONCE(*queue, q);
1121 	return 0;
1122 }
1123 
1124 static void xsk_unbind_dev(struct xdp_sock *xs)
1125 {
1126 	struct net_device *dev = xs->dev;
1127 
1128 	if (xs->state != XSK_BOUND)
1129 		return;
1130 	WRITE_ONCE(xs->state, XSK_UNBOUND);
1131 
1132 	/* Wait for driver to stop using the xdp socket. */
1133 	xp_del_xsk(xs->pool, xs);
1134 	synchronize_net();
1135 	dev_put(dev);
1136 }
1137 
1138 static struct xsk_map *xsk_get_map_list_entry(struct xdp_sock *xs,
1139 					      struct xdp_sock __rcu ***map_entry)
1140 {
1141 	struct xsk_map *map = NULL;
1142 	struct xsk_map_node *node;
1143 
1144 	*map_entry = NULL;
1145 
1146 	spin_lock_bh(&xs->map_list_lock);
1147 	node = list_first_entry_or_null(&xs->map_list, struct xsk_map_node,
1148 					node);
1149 	if (node) {
1150 		bpf_map_inc(&node->map->map);
1151 		map = node->map;
1152 		*map_entry = node->map_entry;
1153 	}
1154 	spin_unlock_bh(&xs->map_list_lock);
1155 	return map;
1156 }
1157 
1158 static void xsk_delete_from_maps(struct xdp_sock *xs)
1159 {
1160 	/* This function removes the current XDP socket from all the
1161 	 * maps it resides in. We need to take extra care here, due to
1162 	 * the two locks involved. Each map has a lock synchronizing
1163 	 * updates to the entries, and each socket has a lock that
1164 	 * synchronizes access to the list of maps (map_list). For
1165 	 * deadlock avoidance the locks need to be taken in the order
1166 	 * "map lock"->"socket map list lock". We start off by
1167 	 * accessing the socket map list, and take a reference to the
1168 	 * map to guarantee existence between the
1169 	 * xsk_get_map_list_entry() and xsk_map_try_sock_delete()
1170 	 * calls. Then we ask the map to remove the socket, which
1171 	 * tries to remove the socket from the map. Note that there
1172 	 * might be updates to the map between
1173 	 * xsk_get_map_list_entry() and xsk_map_try_sock_delete().
1174 	 */
1175 	struct xdp_sock __rcu **map_entry = NULL;
1176 	struct xsk_map *map;
1177 
1178 	while ((map = xsk_get_map_list_entry(xs, &map_entry))) {
1179 		xsk_map_try_sock_delete(map, xs, map_entry);
1180 		bpf_map_put(&map->map);
1181 	}
1182 }
1183 
1184 static int xsk_release(struct socket *sock)
1185 {
1186 	struct sock *sk = sock->sk;
1187 	struct xdp_sock *xs = xdp_sk(sk);
1188 	struct net *net;
1189 
1190 	if (!sk)
1191 		return 0;
1192 
1193 	net = sock_net(sk);
1194 
1195 	if (xs->skb)
1196 		xsk_drop_skb(xs->skb);
1197 
1198 	mutex_lock(&net->xdp.lock);
1199 	sk_del_node_init_rcu(sk);
1200 	mutex_unlock(&net->xdp.lock);
1201 
1202 	sock_prot_inuse_add(net, sk->sk_prot, -1);
1203 
1204 	xsk_delete_from_maps(xs);
1205 	mutex_lock(&xs->mutex);
1206 	xsk_unbind_dev(xs);
1207 	mutex_unlock(&xs->mutex);
1208 
1209 	xskq_destroy(xs->rx);
1210 	xskq_destroy(xs->tx);
1211 	xskq_destroy(xs->fq_tmp);
1212 	xskq_destroy(xs->cq_tmp);
1213 
1214 	sock_orphan(sk);
1215 	sock->sk = NULL;
1216 
1217 	sock_put(sk);
1218 
1219 	return 0;
1220 }
1221 
1222 static struct socket *xsk_lookup_xsk_from_fd(int fd)
1223 {
1224 	struct socket *sock;
1225 	int err;
1226 
1227 	sock = sockfd_lookup(fd, &err);
1228 	if (!sock)
1229 		return ERR_PTR(-ENOTSOCK);
1230 
1231 	if (sock->sk->sk_family != PF_XDP) {
1232 		sockfd_put(sock);
1233 		return ERR_PTR(-ENOPROTOOPT);
1234 	}
1235 
1236 	return sock;
1237 }
1238 
1239 static bool xsk_validate_queues(struct xdp_sock *xs)
1240 {
1241 	return xs->fq_tmp && xs->cq_tmp;
1242 }
1243 
1244 static int xsk_bind(struct socket *sock, struct sockaddr *addr, int addr_len)
1245 {
1246 	struct sockaddr_xdp *sxdp = (struct sockaddr_xdp *)addr;
1247 	struct sock *sk = sock->sk;
1248 	struct xdp_sock *xs = xdp_sk(sk);
1249 	struct net_device *dev;
1250 	int bound_dev_if;
1251 	u32 flags, qid;
1252 	int err = 0;
1253 
1254 	if (addr_len < sizeof(struct sockaddr_xdp))
1255 		return -EINVAL;
1256 	if (sxdp->sxdp_family != AF_XDP)
1257 		return -EINVAL;
1258 
1259 	flags = sxdp->sxdp_flags;
1260 	if (flags & ~(XDP_SHARED_UMEM | XDP_COPY | XDP_ZEROCOPY |
1261 		      XDP_USE_NEED_WAKEUP | XDP_USE_SG))
1262 		return -EINVAL;
1263 
1264 	bound_dev_if = READ_ONCE(sk->sk_bound_dev_if);
1265 	if (bound_dev_if && bound_dev_if != sxdp->sxdp_ifindex)
1266 		return -EINVAL;
1267 
1268 	rtnl_lock();
1269 	mutex_lock(&xs->mutex);
1270 	if (xs->state != XSK_READY) {
1271 		err = -EBUSY;
1272 		goto out_release;
1273 	}
1274 
1275 	dev = dev_get_by_index(sock_net(sk), sxdp->sxdp_ifindex);
1276 	if (!dev) {
1277 		err = -ENODEV;
1278 		goto out_release;
1279 	}
1280 
1281 	netdev_lock_ops(dev);
1282 
1283 	if (!xs->rx && !xs->tx) {
1284 		err = -EINVAL;
1285 		goto out_unlock;
1286 	}
1287 
1288 	qid = sxdp->sxdp_queue_id;
1289 
1290 	if (flags & XDP_SHARED_UMEM) {
1291 		struct xdp_sock *umem_xs;
1292 		struct socket *sock;
1293 
1294 		if ((flags & XDP_COPY) || (flags & XDP_ZEROCOPY) ||
1295 		    (flags & XDP_USE_NEED_WAKEUP) || (flags & XDP_USE_SG)) {
1296 			/* Cannot specify flags for shared sockets. */
1297 			err = -EINVAL;
1298 			goto out_unlock;
1299 		}
1300 
1301 		if (xs->umem) {
1302 			/* We have already our own. */
1303 			err = -EINVAL;
1304 			goto out_unlock;
1305 		}
1306 
1307 		sock = xsk_lookup_xsk_from_fd(sxdp->sxdp_shared_umem_fd);
1308 		if (IS_ERR(sock)) {
1309 			err = PTR_ERR(sock);
1310 			goto out_unlock;
1311 		}
1312 
1313 		umem_xs = xdp_sk(sock->sk);
1314 		if (!xsk_is_bound(umem_xs)) {
1315 			err = -EBADF;
1316 			sockfd_put(sock);
1317 			goto out_unlock;
1318 		}
1319 
1320 		if (umem_xs->queue_id != qid || umem_xs->dev != dev) {
1321 			/* Share the umem with another socket on another qid
1322 			 * and/or device.
1323 			 */
1324 			xs->pool = xp_create_and_assign_umem(xs,
1325 							     umem_xs->umem);
1326 			if (!xs->pool) {
1327 				err = -ENOMEM;
1328 				sockfd_put(sock);
1329 				goto out_unlock;
1330 			}
1331 
1332 			err = xp_assign_dev_shared(xs->pool, umem_xs, dev,
1333 						   qid);
1334 			if (err) {
1335 				xp_destroy(xs->pool);
1336 				xs->pool = NULL;
1337 				sockfd_put(sock);
1338 				goto out_unlock;
1339 			}
1340 		} else {
1341 			/* Share the buffer pool with the other socket. */
1342 			if (xs->fq_tmp || xs->cq_tmp) {
1343 				/* Do not allow setting your own fq or cq. */
1344 				err = -EINVAL;
1345 				sockfd_put(sock);
1346 				goto out_unlock;
1347 			}
1348 
1349 			xp_get_pool(umem_xs->pool);
1350 			xs->pool = umem_xs->pool;
1351 
1352 			/* If underlying shared umem was created without Tx
1353 			 * ring, allocate Tx descs array that Tx batching API
1354 			 * utilizes
1355 			 */
1356 			if (xs->tx && !xs->pool->tx_descs) {
1357 				err = xp_alloc_tx_descs(xs->pool, xs);
1358 				if (err) {
1359 					xp_put_pool(xs->pool);
1360 					xs->pool = NULL;
1361 					sockfd_put(sock);
1362 					goto out_unlock;
1363 				}
1364 			}
1365 		}
1366 
1367 		xdp_get_umem(umem_xs->umem);
1368 		WRITE_ONCE(xs->umem, umem_xs->umem);
1369 		sockfd_put(sock);
1370 	} else if (!xs->umem || !xsk_validate_queues(xs)) {
1371 		err = -EINVAL;
1372 		goto out_unlock;
1373 	} else {
1374 		/* This xsk has its own umem. */
1375 		xs->pool = xp_create_and_assign_umem(xs, xs->umem);
1376 		if (!xs->pool) {
1377 			err = -ENOMEM;
1378 			goto out_unlock;
1379 		}
1380 
1381 		err = xp_assign_dev(xs->pool, dev, qid, flags);
1382 		if (err) {
1383 			xp_destroy(xs->pool);
1384 			xs->pool = NULL;
1385 			goto out_unlock;
1386 		}
1387 	}
1388 
1389 	/* FQ and CQ are now owned by the buffer pool and cleaned up with it. */
1390 	xs->fq_tmp = NULL;
1391 	xs->cq_tmp = NULL;
1392 
1393 	xs->dev = dev;
1394 	xs->zc = xs->umem->zc;
1395 	xs->sg = !!(xs->umem->flags & XDP_UMEM_SG_FLAG);
1396 	xs->queue_id = qid;
1397 	xp_add_xsk(xs->pool, xs);
1398 
1399 	if (qid < dev->real_num_rx_queues) {
1400 		struct netdev_rx_queue *rxq;
1401 
1402 		rxq = __netif_get_rx_queue(dev, qid);
1403 		if (rxq->napi)
1404 			__sk_mark_napi_id_once(sk, rxq->napi->napi_id);
1405 	}
1406 
1407 out_unlock:
1408 	if (err) {
1409 		dev_put(dev);
1410 	} else {
1411 		/* Matches smp_rmb() in bind() for shared umem
1412 		 * sockets, and xsk_is_bound().
1413 		 */
1414 		smp_wmb();
1415 		WRITE_ONCE(xs->state, XSK_BOUND);
1416 	}
1417 	netdev_unlock_ops(dev);
1418 out_release:
1419 	mutex_unlock(&xs->mutex);
1420 	rtnl_unlock();
1421 	return err;
1422 }
1423 
1424 struct xdp_umem_reg_v1 {
1425 	__u64 addr; /* Start of packet data area */
1426 	__u64 len; /* Length of packet data area */
1427 	__u32 chunk_size;
1428 	__u32 headroom;
1429 };
1430 
1431 static int xsk_setsockopt(struct socket *sock, int level, int optname,
1432 			  sockptr_t optval, unsigned int optlen)
1433 {
1434 	struct sock *sk = sock->sk;
1435 	struct xdp_sock *xs = xdp_sk(sk);
1436 	int err;
1437 
1438 	if (level != SOL_XDP)
1439 		return -ENOPROTOOPT;
1440 
1441 	switch (optname) {
1442 	case XDP_RX_RING:
1443 	case XDP_TX_RING:
1444 	{
1445 		struct xsk_queue **q;
1446 		int entries;
1447 
1448 		if (optlen < sizeof(entries))
1449 			return -EINVAL;
1450 		if (copy_from_sockptr(&entries, optval, sizeof(entries)))
1451 			return -EFAULT;
1452 
1453 		mutex_lock(&xs->mutex);
1454 		if (xs->state != XSK_READY) {
1455 			mutex_unlock(&xs->mutex);
1456 			return -EBUSY;
1457 		}
1458 		q = (optname == XDP_TX_RING) ? &xs->tx : &xs->rx;
1459 		err = xsk_init_queue(entries, q, false);
1460 		if (!err && optname == XDP_TX_RING)
1461 			/* Tx needs to be explicitly woken up the first time */
1462 			xs->tx->ring->flags |= XDP_RING_NEED_WAKEUP;
1463 		mutex_unlock(&xs->mutex);
1464 		return err;
1465 	}
1466 	case XDP_UMEM_REG:
1467 	{
1468 		size_t mr_size = sizeof(struct xdp_umem_reg);
1469 		struct xdp_umem_reg mr = {};
1470 		struct xdp_umem *umem;
1471 
1472 		if (optlen < sizeof(struct xdp_umem_reg_v1))
1473 			return -EINVAL;
1474 		else if (optlen < sizeof(mr))
1475 			mr_size = sizeof(struct xdp_umem_reg_v1);
1476 
1477 		BUILD_BUG_ON(sizeof(struct xdp_umem_reg_v1) >= sizeof(struct xdp_umem_reg));
1478 
1479 		/* Make sure the last field of the struct doesn't have
1480 		 * uninitialized padding. All padding has to be explicit
1481 		 * and has to be set to zero by the userspace to make
1482 		 * struct xdp_umem_reg extensible in the future.
1483 		 */
1484 		BUILD_BUG_ON(offsetof(struct xdp_umem_reg, tx_metadata_len) +
1485 			     sizeof_field(struct xdp_umem_reg, tx_metadata_len) !=
1486 			     sizeof(struct xdp_umem_reg));
1487 
1488 		if (copy_from_sockptr(&mr, optval, mr_size))
1489 			return -EFAULT;
1490 
1491 		mutex_lock(&xs->mutex);
1492 		if (xs->state != XSK_READY || xs->umem) {
1493 			mutex_unlock(&xs->mutex);
1494 			return -EBUSY;
1495 		}
1496 
1497 		umem = xdp_umem_create(&mr);
1498 		if (IS_ERR(umem)) {
1499 			mutex_unlock(&xs->mutex);
1500 			return PTR_ERR(umem);
1501 		}
1502 
1503 		/* Make sure umem is ready before it can be seen by others */
1504 		smp_wmb();
1505 		WRITE_ONCE(xs->umem, umem);
1506 		mutex_unlock(&xs->mutex);
1507 		return 0;
1508 	}
1509 	case XDP_UMEM_FILL_RING:
1510 	case XDP_UMEM_COMPLETION_RING:
1511 	{
1512 		struct xsk_queue **q;
1513 		int entries;
1514 
1515 		if (optlen < sizeof(entries))
1516 			return -EINVAL;
1517 		if (copy_from_sockptr(&entries, optval, sizeof(entries)))
1518 			return -EFAULT;
1519 
1520 		mutex_lock(&xs->mutex);
1521 		if (xs->state != XSK_READY) {
1522 			mutex_unlock(&xs->mutex);
1523 			return -EBUSY;
1524 		}
1525 
1526 		q = (optname == XDP_UMEM_FILL_RING) ? &xs->fq_tmp :
1527 			&xs->cq_tmp;
1528 		err = xsk_init_queue(entries, q, true);
1529 		mutex_unlock(&xs->mutex);
1530 		return err;
1531 	}
1532 	case XDP_MAX_TX_SKB_BUDGET:
1533 	{
1534 		unsigned int budget;
1535 
1536 		if (optlen != sizeof(budget))
1537 			return -EINVAL;
1538 		if (copy_from_sockptr(&budget, optval, sizeof(budget)))
1539 			return -EFAULT;
1540 		if (!xs->tx ||
1541 		    budget < TX_BATCH_SIZE || budget > xs->tx->nentries)
1542 			return -EACCES;
1543 
1544 		WRITE_ONCE(xs->max_tx_budget, budget);
1545 		return 0;
1546 	}
1547 	default:
1548 		break;
1549 	}
1550 
1551 	return -ENOPROTOOPT;
1552 }
1553 
1554 static void xsk_enter_rxtx_offsets(struct xdp_ring_offset_v1 *ring)
1555 {
1556 	ring->producer = offsetof(struct xdp_rxtx_ring, ptrs.producer);
1557 	ring->consumer = offsetof(struct xdp_rxtx_ring, ptrs.consumer);
1558 	ring->desc = offsetof(struct xdp_rxtx_ring, desc);
1559 }
1560 
1561 static void xsk_enter_umem_offsets(struct xdp_ring_offset_v1 *ring)
1562 {
1563 	ring->producer = offsetof(struct xdp_umem_ring, ptrs.producer);
1564 	ring->consumer = offsetof(struct xdp_umem_ring, ptrs.consumer);
1565 	ring->desc = offsetof(struct xdp_umem_ring, desc);
1566 }
1567 
1568 struct xdp_statistics_v1 {
1569 	__u64 rx_dropped;
1570 	__u64 rx_invalid_descs;
1571 	__u64 tx_invalid_descs;
1572 };
1573 
1574 static int xsk_getsockopt(struct socket *sock, int level, int optname,
1575 			  char __user *optval, int __user *optlen)
1576 {
1577 	struct sock *sk = sock->sk;
1578 	struct xdp_sock *xs = xdp_sk(sk);
1579 	int len;
1580 
1581 	if (level != SOL_XDP)
1582 		return -ENOPROTOOPT;
1583 
1584 	if (get_user(len, optlen))
1585 		return -EFAULT;
1586 	if (len < 0)
1587 		return -EINVAL;
1588 
1589 	switch (optname) {
1590 	case XDP_STATISTICS:
1591 	{
1592 		struct xdp_statistics stats = {};
1593 		bool extra_stats = true;
1594 		size_t stats_size;
1595 
1596 		if (len < sizeof(struct xdp_statistics_v1)) {
1597 			return -EINVAL;
1598 		} else if (len < sizeof(stats)) {
1599 			extra_stats = false;
1600 			stats_size = sizeof(struct xdp_statistics_v1);
1601 		} else {
1602 			stats_size = sizeof(stats);
1603 		}
1604 
1605 		mutex_lock(&xs->mutex);
1606 		stats.rx_dropped = xs->rx_dropped;
1607 		if (extra_stats) {
1608 			stats.rx_ring_full = xs->rx_queue_full;
1609 			stats.rx_fill_ring_empty_descs =
1610 				xs->pool ? xskq_nb_queue_empty_descs(xs->pool->fq) : 0;
1611 			stats.tx_ring_empty_descs = xskq_nb_queue_empty_descs(xs->tx);
1612 		} else {
1613 			stats.rx_dropped += xs->rx_queue_full;
1614 		}
1615 		stats.rx_invalid_descs = xskq_nb_invalid_descs(xs->rx);
1616 		stats.tx_invalid_descs = xskq_nb_invalid_descs(xs->tx);
1617 		mutex_unlock(&xs->mutex);
1618 
1619 		if (copy_to_user(optval, &stats, stats_size))
1620 			return -EFAULT;
1621 		if (put_user(stats_size, optlen))
1622 			return -EFAULT;
1623 
1624 		return 0;
1625 	}
1626 	case XDP_MMAP_OFFSETS:
1627 	{
1628 		struct xdp_mmap_offsets off;
1629 		struct xdp_mmap_offsets_v1 off_v1;
1630 		bool flags_supported = true;
1631 		void *to_copy;
1632 
1633 		if (len < sizeof(off_v1))
1634 			return -EINVAL;
1635 		else if (len < sizeof(off))
1636 			flags_supported = false;
1637 
1638 		if (flags_supported) {
1639 			/* xdp_ring_offset is identical to xdp_ring_offset_v1
1640 			 * except for the flags field added to the end.
1641 			 */
1642 			xsk_enter_rxtx_offsets((struct xdp_ring_offset_v1 *)
1643 					       &off.rx);
1644 			xsk_enter_rxtx_offsets((struct xdp_ring_offset_v1 *)
1645 					       &off.tx);
1646 			xsk_enter_umem_offsets((struct xdp_ring_offset_v1 *)
1647 					       &off.fr);
1648 			xsk_enter_umem_offsets((struct xdp_ring_offset_v1 *)
1649 					       &off.cr);
1650 			off.rx.flags = offsetof(struct xdp_rxtx_ring,
1651 						ptrs.flags);
1652 			off.tx.flags = offsetof(struct xdp_rxtx_ring,
1653 						ptrs.flags);
1654 			off.fr.flags = offsetof(struct xdp_umem_ring,
1655 						ptrs.flags);
1656 			off.cr.flags = offsetof(struct xdp_umem_ring,
1657 						ptrs.flags);
1658 
1659 			len = sizeof(off);
1660 			to_copy = &off;
1661 		} else {
1662 			xsk_enter_rxtx_offsets(&off_v1.rx);
1663 			xsk_enter_rxtx_offsets(&off_v1.tx);
1664 			xsk_enter_umem_offsets(&off_v1.fr);
1665 			xsk_enter_umem_offsets(&off_v1.cr);
1666 
1667 			len = sizeof(off_v1);
1668 			to_copy = &off_v1;
1669 		}
1670 
1671 		if (copy_to_user(optval, to_copy, len))
1672 			return -EFAULT;
1673 		if (put_user(len, optlen))
1674 			return -EFAULT;
1675 
1676 		return 0;
1677 	}
1678 	case XDP_OPTIONS:
1679 	{
1680 		struct xdp_options opts = {};
1681 
1682 		if (len < sizeof(opts))
1683 			return -EINVAL;
1684 
1685 		mutex_lock(&xs->mutex);
1686 		if (xs->zc)
1687 			opts.flags |= XDP_OPTIONS_ZEROCOPY;
1688 		mutex_unlock(&xs->mutex);
1689 
1690 		len = sizeof(opts);
1691 		if (copy_to_user(optval, &opts, len))
1692 			return -EFAULT;
1693 		if (put_user(len, optlen))
1694 			return -EFAULT;
1695 
1696 		return 0;
1697 	}
1698 	default:
1699 		break;
1700 	}
1701 
1702 	return -EOPNOTSUPP;
1703 }
1704 
1705 static int xsk_mmap(struct file *file, struct socket *sock,
1706 		    struct vm_area_struct *vma)
1707 {
1708 	loff_t offset = (loff_t)vma->vm_pgoff << PAGE_SHIFT;
1709 	unsigned long size = vma->vm_end - vma->vm_start;
1710 	struct xdp_sock *xs = xdp_sk(sock->sk);
1711 	int state = READ_ONCE(xs->state);
1712 	struct xsk_queue *q = NULL;
1713 
1714 	if (state != XSK_READY && state != XSK_BOUND)
1715 		return -EBUSY;
1716 
1717 	if (offset == XDP_PGOFF_RX_RING) {
1718 		q = READ_ONCE(xs->rx);
1719 	} else if (offset == XDP_PGOFF_TX_RING) {
1720 		q = READ_ONCE(xs->tx);
1721 	} else {
1722 		/* Matches the smp_wmb() in XDP_UMEM_REG */
1723 		smp_rmb();
1724 		if (offset == XDP_UMEM_PGOFF_FILL_RING)
1725 			q = state == XSK_READY ? READ_ONCE(xs->fq_tmp) :
1726 						 READ_ONCE(xs->pool->fq);
1727 		else if (offset == XDP_UMEM_PGOFF_COMPLETION_RING)
1728 			q = state == XSK_READY ? READ_ONCE(xs->cq_tmp) :
1729 						 READ_ONCE(xs->pool->cq);
1730 	}
1731 
1732 	if (!q)
1733 		return -EINVAL;
1734 
1735 	/* Matches the smp_wmb() in xsk_init_queue */
1736 	smp_rmb();
1737 	if (size > q->ring_vmalloc_size)
1738 		return -EINVAL;
1739 
1740 	return remap_vmalloc_range(vma, q->ring, 0);
1741 }
1742 
1743 static int xsk_notifier(struct notifier_block *this,
1744 			unsigned long msg, void *ptr)
1745 {
1746 	struct net_device *dev = netdev_notifier_info_to_dev(ptr);
1747 	struct net *net = dev_net(dev);
1748 	struct sock *sk;
1749 
1750 	switch (msg) {
1751 	case NETDEV_UNREGISTER:
1752 		mutex_lock(&net->xdp.lock);
1753 		sk_for_each(sk, &net->xdp.list) {
1754 			struct xdp_sock *xs = xdp_sk(sk);
1755 
1756 			mutex_lock(&xs->mutex);
1757 			if (xs->dev == dev) {
1758 				sk->sk_err = ENETDOWN;
1759 				if (!sock_flag(sk, SOCK_DEAD))
1760 					sk_error_report(sk);
1761 
1762 				xsk_unbind_dev(xs);
1763 
1764 				/* Clear device references. */
1765 				xp_clear_dev(xs->pool);
1766 			}
1767 			mutex_unlock(&xs->mutex);
1768 		}
1769 		mutex_unlock(&net->xdp.lock);
1770 		break;
1771 	}
1772 	return NOTIFY_DONE;
1773 }
1774 
1775 static struct proto xsk_proto = {
1776 	.name =		"XDP",
1777 	.owner =	THIS_MODULE,
1778 	.obj_size =	sizeof(struct xdp_sock),
1779 };
1780 
1781 static const struct proto_ops xsk_proto_ops = {
1782 	.family		= PF_XDP,
1783 	.owner		= THIS_MODULE,
1784 	.release	= xsk_release,
1785 	.bind		= xsk_bind,
1786 	.connect	= sock_no_connect,
1787 	.socketpair	= sock_no_socketpair,
1788 	.accept		= sock_no_accept,
1789 	.getname	= sock_no_getname,
1790 	.poll		= xsk_poll,
1791 	.ioctl		= sock_no_ioctl,
1792 	.listen		= sock_no_listen,
1793 	.shutdown	= sock_no_shutdown,
1794 	.setsockopt	= xsk_setsockopt,
1795 	.getsockopt	= xsk_getsockopt,
1796 	.sendmsg	= xsk_sendmsg,
1797 	.recvmsg	= xsk_recvmsg,
1798 	.mmap		= xsk_mmap,
1799 };
1800 
1801 static void xsk_destruct(struct sock *sk)
1802 {
1803 	struct xdp_sock *xs = xdp_sk(sk);
1804 
1805 	if (!sock_flag(sk, SOCK_DEAD))
1806 		return;
1807 
1808 	if (!xp_put_pool(xs->pool))
1809 		xdp_put_umem(xs->umem, !xs->pool);
1810 }
1811 
1812 static int xsk_create(struct net *net, struct socket *sock, int protocol,
1813 		      int kern)
1814 {
1815 	struct xdp_sock *xs;
1816 	struct sock *sk;
1817 
1818 	if (!ns_capable(net->user_ns, CAP_NET_RAW))
1819 		return -EPERM;
1820 	if (sock->type != SOCK_RAW)
1821 		return -ESOCKTNOSUPPORT;
1822 
1823 	if (protocol)
1824 		return -EPROTONOSUPPORT;
1825 
1826 	sock->state = SS_UNCONNECTED;
1827 
1828 	sk = sk_alloc(net, PF_XDP, GFP_KERNEL, &xsk_proto, kern);
1829 	if (!sk)
1830 		return -ENOBUFS;
1831 
1832 	sock->ops = &xsk_proto_ops;
1833 
1834 	sock_init_data(sock, sk);
1835 
1836 	sk->sk_family = PF_XDP;
1837 
1838 	sk->sk_destruct = xsk_destruct;
1839 
1840 	sock_set_flag(sk, SOCK_RCU_FREE);
1841 
1842 	xs = xdp_sk(sk);
1843 	xs->state = XSK_READY;
1844 	xs->max_tx_budget = TX_BATCH_SIZE;
1845 	mutex_init(&xs->mutex);
1846 
1847 	INIT_LIST_HEAD(&xs->map_list);
1848 	spin_lock_init(&xs->map_list_lock);
1849 
1850 	mutex_lock(&net->xdp.lock);
1851 	sk_add_node_rcu(sk, &net->xdp.list);
1852 	mutex_unlock(&net->xdp.lock);
1853 
1854 	sock_prot_inuse_add(net, &xsk_proto, 1);
1855 
1856 	return 0;
1857 }
1858 
1859 static const struct net_proto_family xsk_family_ops = {
1860 	.family = PF_XDP,
1861 	.create = xsk_create,
1862 	.owner	= THIS_MODULE,
1863 };
1864 
1865 static struct notifier_block xsk_netdev_notifier = {
1866 	.notifier_call	= xsk_notifier,
1867 };
1868 
1869 static int __net_init xsk_net_init(struct net *net)
1870 {
1871 	mutex_init(&net->xdp.lock);
1872 	INIT_HLIST_HEAD(&net->xdp.list);
1873 	return 0;
1874 }
1875 
1876 static void __net_exit xsk_net_exit(struct net *net)
1877 {
1878 	WARN_ON_ONCE(!hlist_empty(&net->xdp.list));
1879 }
1880 
1881 static struct pernet_operations xsk_net_ops = {
1882 	.init = xsk_net_init,
1883 	.exit = xsk_net_exit,
1884 };
1885 
1886 static int __init xsk_init(void)
1887 {
1888 	int err;
1889 
1890 	err = proto_register(&xsk_proto, 0 /* no slab */);
1891 	if (err)
1892 		goto out;
1893 
1894 	err = sock_register(&xsk_family_ops);
1895 	if (err)
1896 		goto out_proto;
1897 
1898 	err = register_pernet_subsys(&xsk_net_ops);
1899 	if (err)
1900 		goto out_sk;
1901 
1902 	err = register_netdevice_notifier(&xsk_netdev_notifier);
1903 	if (err)
1904 		goto out_pernet;
1905 
1906 	xsk_tx_generic_cache = kmem_cache_create("xsk_generic_xmit_cache",
1907 						 sizeof(struct xsk_addr_node),
1908 						 0, SLAB_HWCACHE_ALIGN, NULL);
1909 	if (!xsk_tx_generic_cache) {
1910 		err = -ENOMEM;
1911 		goto out_unreg_notif;
1912 	}
1913 
1914 	return 0;
1915 
1916 out_unreg_notif:
1917 	unregister_netdevice_notifier(&xsk_netdev_notifier);
1918 out_pernet:
1919 	unregister_pernet_subsys(&xsk_net_ops);
1920 out_sk:
1921 	sock_unregister(PF_XDP);
1922 out_proto:
1923 	proto_unregister(&xsk_proto);
1924 out:
1925 	return err;
1926 }
1927 
1928 fs_initcall(xsk_init);
1929