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