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