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