xref: /openbmc/linux/drivers/vhost/net.c (revision 6cd70754)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /* Copyright (C) 2009 Red Hat, Inc.
3  * Author: Michael S. Tsirkin <mst@redhat.com>
4  *
5  * virtio-net server in host kernel.
6  */
7 
8 #include <linux/compat.h>
9 #include <linux/eventfd.h>
10 #include <linux/vhost.h>
11 #include <linux/virtio_net.h>
12 #include <linux/miscdevice.h>
13 #include <linux/module.h>
14 #include <linux/moduleparam.h>
15 #include <linux/mutex.h>
16 #include <linux/workqueue.h>
17 #include <linux/file.h>
18 #include <linux/slab.h>
19 #include <linux/sched/clock.h>
20 #include <linux/sched/signal.h>
21 #include <linux/vmalloc.h>
22 
23 #include <linux/net.h>
24 #include <linux/if_packet.h>
25 #include <linux/if_arp.h>
26 #include <linux/if_tun.h>
27 #include <linux/if_macvlan.h>
28 #include <linux/if_tap.h>
29 #include <linux/if_vlan.h>
30 #include <linux/skb_array.h>
31 #include <linux/skbuff.h>
32 
33 #include <net/sock.h>
34 #include <net/xdp.h>
35 
36 #include "vhost.h"
37 
38 static int experimental_zcopytx = 0;
39 module_param(experimental_zcopytx, int, 0444);
40 MODULE_PARM_DESC(experimental_zcopytx, "Enable Zero Copy TX;"
41 		                       " 1 -Enable; 0 - Disable");
42 
43 /* Max number of bytes transferred before requeueing the job.
44  * Using this limit prevents one virtqueue from starving others. */
45 #define VHOST_NET_WEIGHT 0x80000
46 
47 /* Max number of packets transferred before requeueing the job.
48  * Using this limit prevents one virtqueue from starving others with small
49  * pkts.
50  */
51 #define VHOST_NET_PKT_WEIGHT 256
52 
53 /* MAX number of TX used buffers for outstanding zerocopy */
54 #define VHOST_MAX_PEND 128
55 #define VHOST_GOODCOPY_LEN 256
56 
57 /*
58  * For transmit, used buffer len is unused; we override it to track buffer
59  * status internally; used for zerocopy tx only.
60  */
61 /* Lower device DMA failed */
62 #define VHOST_DMA_FAILED_LEN	((__force __virtio32)3)
63 /* Lower device DMA done */
64 #define VHOST_DMA_DONE_LEN	((__force __virtio32)2)
65 /* Lower device DMA in progress */
66 #define VHOST_DMA_IN_PROGRESS	((__force __virtio32)1)
67 /* Buffer unused */
68 #define VHOST_DMA_CLEAR_LEN	((__force __virtio32)0)
69 
70 #define VHOST_DMA_IS_DONE(len) ((__force u32)(len) >= (__force u32)VHOST_DMA_DONE_LEN)
71 
72 enum {
73 	VHOST_NET_FEATURES = VHOST_FEATURES |
74 			 (1ULL << VHOST_NET_F_VIRTIO_NET_HDR) |
75 			 (1ULL << VIRTIO_NET_F_MRG_RXBUF) |
76 			 (1ULL << VIRTIO_F_ACCESS_PLATFORM)
77 };
78 
79 enum {
80 	VHOST_NET_BACKEND_FEATURES = (1ULL << VHOST_BACKEND_F_IOTLB_MSG_V2)
81 };
82 
83 enum {
84 	VHOST_NET_VQ_RX = 0,
85 	VHOST_NET_VQ_TX = 1,
86 	VHOST_NET_VQ_MAX = 2,
87 };
88 
89 struct vhost_net_ubuf_ref {
90 	/* refcount follows semantics similar to kref:
91 	 *  0: object is released
92 	 *  1: no outstanding ubufs
93 	 * >1: outstanding ubufs
94 	 */
95 	atomic_t refcount;
96 	wait_queue_head_t wait;
97 	struct vhost_virtqueue *vq;
98 };
99 
100 #define VHOST_NET_BATCH 64
101 struct vhost_net_buf {
102 	void **queue;
103 	int tail;
104 	int head;
105 };
106 
107 struct vhost_net_virtqueue {
108 	struct vhost_virtqueue vq;
109 	size_t vhost_hlen;
110 	size_t sock_hlen;
111 	/* vhost zerocopy support fields below: */
112 	/* last used idx for outstanding DMA zerocopy buffers */
113 	int upend_idx;
114 	/* For TX, first used idx for DMA done zerocopy buffers
115 	 * For RX, number of batched heads
116 	 */
117 	int done_idx;
118 	/* Number of XDP frames batched */
119 	int batched_xdp;
120 	/* an array of userspace buffers info */
121 	struct ubuf_info *ubuf_info;
122 	/* Reference counting for outstanding ubufs.
123 	 * Protected by vq mutex. Writers must also take device mutex. */
124 	struct vhost_net_ubuf_ref *ubufs;
125 	struct ptr_ring *rx_ring;
126 	struct vhost_net_buf rxq;
127 	/* Batched XDP buffs */
128 	struct xdp_buff *xdp;
129 };
130 
131 struct vhost_net {
132 	struct vhost_dev dev;
133 	struct vhost_net_virtqueue vqs[VHOST_NET_VQ_MAX];
134 	struct vhost_poll poll[VHOST_NET_VQ_MAX];
135 	/* Number of TX recently submitted.
136 	 * Protected by tx vq lock. */
137 	unsigned tx_packets;
138 	/* Number of times zerocopy TX recently failed.
139 	 * Protected by tx vq lock. */
140 	unsigned tx_zcopy_err;
141 	/* Flush in progress. Protected by tx vq lock. */
142 	bool tx_flush;
143 	/* Private page frag */
144 	struct page_frag page_frag;
145 	/* Refcount bias of page frag */
146 	int refcnt_bias;
147 };
148 
149 static unsigned vhost_net_zcopy_mask __read_mostly;
150 
151 static void *vhost_net_buf_get_ptr(struct vhost_net_buf *rxq)
152 {
153 	if (rxq->tail != rxq->head)
154 		return rxq->queue[rxq->head];
155 	else
156 		return NULL;
157 }
158 
159 static int vhost_net_buf_get_size(struct vhost_net_buf *rxq)
160 {
161 	return rxq->tail - rxq->head;
162 }
163 
164 static int vhost_net_buf_is_empty(struct vhost_net_buf *rxq)
165 {
166 	return rxq->tail == rxq->head;
167 }
168 
169 static void *vhost_net_buf_consume(struct vhost_net_buf *rxq)
170 {
171 	void *ret = vhost_net_buf_get_ptr(rxq);
172 	++rxq->head;
173 	return ret;
174 }
175 
176 static int vhost_net_buf_produce(struct vhost_net_virtqueue *nvq)
177 {
178 	struct vhost_net_buf *rxq = &nvq->rxq;
179 
180 	rxq->head = 0;
181 	rxq->tail = ptr_ring_consume_batched(nvq->rx_ring, rxq->queue,
182 					      VHOST_NET_BATCH);
183 	return rxq->tail;
184 }
185 
186 static void vhost_net_buf_unproduce(struct vhost_net_virtqueue *nvq)
187 {
188 	struct vhost_net_buf *rxq = &nvq->rxq;
189 
190 	if (nvq->rx_ring && !vhost_net_buf_is_empty(rxq)) {
191 		ptr_ring_unconsume(nvq->rx_ring, rxq->queue + rxq->head,
192 				   vhost_net_buf_get_size(rxq),
193 				   tun_ptr_free);
194 		rxq->head = rxq->tail = 0;
195 	}
196 }
197 
198 static int vhost_net_buf_peek_len(void *ptr)
199 {
200 	if (tun_is_xdp_frame(ptr)) {
201 		struct xdp_frame *xdpf = tun_ptr_to_xdp(ptr);
202 
203 		return xdpf->len;
204 	}
205 
206 	return __skb_array_len_with_tag(ptr);
207 }
208 
209 static int vhost_net_buf_peek(struct vhost_net_virtqueue *nvq)
210 {
211 	struct vhost_net_buf *rxq = &nvq->rxq;
212 
213 	if (!vhost_net_buf_is_empty(rxq))
214 		goto out;
215 
216 	if (!vhost_net_buf_produce(nvq))
217 		return 0;
218 
219 out:
220 	return vhost_net_buf_peek_len(vhost_net_buf_get_ptr(rxq));
221 }
222 
223 static void vhost_net_buf_init(struct vhost_net_buf *rxq)
224 {
225 	rxq->head = rxq->tail = 0;
226 }
227 
228 static void vhost_net_enable_zcopy(int vq)
229 {
230 	vhost_net_zcopy_mask |= 0x1 << vq;
231 }
232 
233 static struct vhost_net_ubuf_ref *
234 vhost_net_ubuf_alloc(struct vhost_virtqueue *vq, bool zcopy)
235 {
236 	struct vhost_net_ubuf_ref *ubufs;
237 	/* No zero copy backend? Nothing to count. */
238 	if (!zcopy)
239 		return NULL;
240 	ubufs = kmalloc(sizeof(*ubufs), GFP_KERNEL);
241 	if (!ubufs)
242 		return ERR_PTR(-ENOMEM);
243 	atomic_set(&ubufs->refcount, 1);
244 	init_waitqueue_head(&ubufs->wait);
245 	ubufs->vq = vq;
246 	return ubufs;
247 }
248 
249 static int vhost_net_ubuf_put(struct vhost_net_ubuf_ref *ubufs)
250 {
251 	int r = atomic_sub_return(1, &ubufs->refcount);
252 	if (unlikely(!r))
253 		wake_up(&ubufs->wait);
254 	return r;
255 }
256 
257 static void vhost_net_ubuf_put_and_wait(struct vhost_net_ubuf_ref *ubufs)
258 {
259 	vhost_net_ubuf_put(ubufs);
260 	wait_event(ubufs->wait, !atomic_read(&ubufs->refcount));
261 }
262 
263 static void vhost_net_ubuf_put_wait_and_free(struct vhost_net_ubuf_ref *ubufs)
264 {
265 	vhost_net_ubuf_put_and_wait(ubufs);
266 	kfree(ubufs);
267 }
268 
269 static void vhost_net_clear_ubuf_info(struct vhost_net *n)
270 {
271 	int i;
272 
273 	for (i = 0; i < VHOST_NET_VQ_MAX; ++i) {
274 		kfree(n->vqs[i].ubuf_info);
275 		n->vqs[i].ubuf_info = NULL;
276 	}
277 }
278 
279 static int vhost_net_set_ubuf_info(struct vhost_net *n)
280 {
281 	bool zcopy;
282 	int i;
283 
284 	for (i = 0; i < VHOST_NET_VQ_MAX; ++i) {
285 		zcopy = vhost_net_zcopy_mask & (0x1 << i);
286 		if (!zcopy)
287 			continue;
288 		n->vqs[i].ubuf_info =
289 			kmalloc_array(UIO_MAXIOV,
290 				      sizeof(*n->vqs[i].ubuf_info),
291 				      GFP_KERNEL);
292 		if  (!n->vqs[i].ubuf_info)
293 			goto err;
294 	}
295 	return 0;
296 
297 err:
298 	vhost_net_clear_ubuf_info(n);
299 	return -ENOMEM;
300 }
301 
302 static void vhost_net_vq_reset(struct vhost_net *n)
303 {
304 	int i;
305 
306 	vhost_net_clear_ubuf_info(n);
307 
308 	for (i = 0; i < VHOST_NET_VQ_MAX; i++) {
309 		n->vqs[i].done_idx = 0;
310 		n->vqs[i].upend_idx = 0;
311 		n->vqs[i].ubufs = NULL;
312 		n->vqs[i].vhost_hlen = 0;
313 		n->vqs[i].sock_hlen = 0;
314 		vhost_net_buf_init(&n->vqs[i].rxq);
315 	}
316 
317 }
318 
319 static void vhost_net_tx_packet(struct vhost_net *net)
320 {
321 	++net->tx_packets;
322 	if (net->tx_packets < 1024)
323 		return;
324 	net->tx_packets = 0;
325 	net->tx_zcopy_err = 0;
326 }
327 
328 static void vhost_net_tx_err(struct vhost_net *net)
329 {
330 	++net->tx_zcopy_err;
331 }
332 
333 static bool vhost_net_tx_select_zcopy(struct vhost_net *net)
334 {
335 	/* TX flush waits for outstanding DMAs to be done.
336 	 * Don't start new DMAs.
337 	 */
338 	return !net->tx_flush &&
339 		net->tx_packets / 64 >= net->tx_zcopy_err;
340 }
341 
342 static bool vhost_sock_zcopy(struct socket *sock)
343 {
344 	return unlikely(experimental_zcopytx) &&
345 		sock_flag(sock->sk, SOCK_ZEROCOPY);
346 }
347 
348 static bool vhost_sock_xdp(struct socket *sock)
349 {
350 	return sock_flag(sock->sk, SOCK_XDP);
351 }
352 
353 /* In case of DMA done not in order in lower device driver for some reason.
354  * upend_idx is used to track end of used idx, done_idx is used to track head
355  * of used idx. Once lower device DMA done contiguously, we will signal KVM
356  * guest used idx.
357  */
358 static void vhost_zerocopy_signal_used(struct vhost_net *net,
359 				       struct vhost_virtqueue *vq)
360 {
361 	struct vhost_net_virtqueue *nvq =
362 		container_of(vq, struct vhost_net_virtqueue, vq);
363 	int i, add;
364 	int j = 0;
365 
366 	for (i = nvq->done_idx; i != nvq->upend_idx; i = (i + 1) % UIO_MAXIOV) {
367 		if (vq->heads[i].len == VHOST_DMA_FAILED_LEN)
368 			vhost_net_tx_err(net);
369 		if (VHOST_DMA_IS_DONE(vq->heads[i].len)) {
370 			vq->heads[i].len = VHOST_DMA_CLEAR_LEN;
371 			++j;
372 		} else
373 			break;
374 	}
375 	while (j) {
376 		add = min(UIO_MAXIOV - nvq->done_idx, j);
377 		vhost_add_used_and_signal_n(vq->dev, vq,
378 					    &vq->heads[nvq->done_idx], add);
379 		nvq->done_idx = (nvq->done_idx + add) % UIO_MAXIOV;
380 		j -= add;
381 	}
382 }
383 
384 static void vhost_zerocopy_callback(struct sk_buff *skb,
385 				    struct ubuf_info *ubuf, bool success)
386 {
387 	struct vhost_net_ubuf_ref *ubufs = ubuf->ctx;
388 	struct vhost_virtqueue *vq = ubufs->vq;
389 	int cnt;
390 
391 	rcu_read_lock_bh();
392 
393 	/* set len to mark this desc buffers done DMA */
394 	vq->heads[ubuf->desc].len = success ?
395 		VHOST_DMA_DONE_LEN : VHOST_DMA_FAILED_LEN;
396 	cnt = vhost_net_ubuf_put(ubufs);
397 
398 	/*
399 	 * Trigger polling thread if guest stopped submitting new buffers:
400 	 * in this case, the refcount after decrement will eventually reach 1.
401 	 * We also trigger polling periodically after each 16 packets
402 	 * (the value 16 here is more or less arbitrary, it's tuned to trigger
403 	 * less than 10% of times).
404 	 */
405 	if (cnt <= 1 || !(cnt % 16))
406 		vhost_poll_queue(&vq->poll);
407 
408 	rcu_read_unlock_bh();
409 }
410 
411 static inline unsigned long busy_clock(void)
412 {
413 	return local_clock() >> 10;
414 }
415 
416 static bool vhost_can_busy_poll(unsigned long endtime)
417 {
418 	return likely(!need_resched() && !time_after(busy_clock(), endtime) &&
419 		      !signal_pending(current));
420 }
421 
422 static void vhost_net_disable_vq(struct vhost_net *n,
423 				 struct vhost_virtqueue *vq)
424 {
425 	struct vhost_net_virtqueue *nvq =
426 		container_of(vq, struct vhost_net_virtqueue, vq);
427 	struct vhost_poll *poll = n->poll + (nvq - n->vqs);
428 	if (!vhost_vq_get_backend(vq))
429 		return;
430 	vhost_poll_stop(poll);
431 }
432 
433 static int vhost_net_enable_vq(struct vhost_net *n,
434 				struct vhost_virtqueue *vq)
435 {
436 	struct vhost_net_virtqueue *nvq =
437 		container_of(vq, struct vhost_net_virtqueue, vq);
438 	struct vhost_poll *poll = n->poll + (nvq - n->vqs);
439 	struct socket *sock;
440 
441 	sock = vhost_vq_get_backend(vq);
442 	if (!sock)
443 		return 0;
444 
445 	return vhost_poll_start(poll, sock->file);
446 }
447 
448 static void vhost_net_signal_used(struct vhost_net_virtqueue *nvq)
449 {
450 	struct vhost_virtqueue *vq = &nvq->vq;
451 	struct vhost_dev *dev = vq->dev;
452 
453 	if (!nvq->done_idx)
454 		return;
455 
456 	vhost_add_used_and_signal_n(dev, vq, vq->heads, nvq->done_idx);
457 	nvq->done_idx = 0;
458 }
459 
460 static void vhost_tx_batch(struct vhost_net *net,
461 			   struct vhost_net_virtqueue *nvq,
462 			   struct socket *sock,
463 			   struct msghdr *msghdr)
464 {
465 	struct tun_msg_ctl ctl = {
466 		.type = TUN_MSG_PTR,
467 		.num = nvq->batched_xdp,
468 		.ptr = nvq->xdp,
469 	};
470 	int err;
471 
472 	if (nvq->batched_xdp == 0)
473 		goto signal_used;
474 
475 	msghdr->msg_control = &ctl;
476 	err = sock->ops->sendmsg(sock, msghdr, 0);
477 	if (unlikely(err < 0)) {
478 		vq_err(&nvq->vq, "Fail to batch sending packets\n");
479 		return;
480 	}
481 
482 signal_used:
483 	vhost_net_signal_used(nvq);
484 	nvq->batched_xdp = 0;
485 }
486 
487 static int sock_has_rx_data(struct socket *sock)
488 {
489 	if (unlikely(!sock))
490 		return 0;
491 
492 	if (sock->ops->peek_len)
493 		return sock->ops->peek_len(sock);
494 
495 	return skb_queue_empty(&sock->sk->sk_receive_queue);
496 }
497 
498 static void vhost_net_busy_poll_try_queue(struct vhost_net *net,
499 					  struct vhost_virtqueue *vq)
500 {
501 	if (!vhost_vq_avail_empty(&net->dev, vq)) {
502 		vhost_poll_queue(&vq->poll);
503 	} else if (unlikely(vhost_enable_notify(&net->dev, vq))) {
504 		vhost_disable_notify(&net->dev, vq);
505 		vhost_poll_queue(&vq->poll);
506 	}
507 }
508 
509 static void vhost_net_busy_poll(struct vhost_net *net,
510 				struct vhost_virtqueue *rvq,
511 				struct vhost_virtqueue *tvq,
512 				bool *busyloop_intr,
513 				bool poll_rx)
514 {
515 	unsigned long busyloop_timeout;
516 	unsigned long endtime;
517 	struct socket *sock;
518 	struct vhost_virtqueue *vq = poll_rx ? tvq : rvq;
519 
520 	/* Try to hold the vq mutex of the paired virtqueue. We can't
521 	 * use mutex_lock() here since we could not guarantee a
522 	 * consistenet lock ordering.
523 	 */
524 	if (!mutex_trylock(&vq->mutex))
525 		return;
526 
527 	vhost_disable_notify(&net->dev, vq);
528 	sock = vhost_vq_get_backend(rvq);
529 
530 	busyloop_timeout = poll_rx ? rvq->busyloop_timeout:
531 				     tvq->busyloop_timeout;
532 
533 	preempt_disable();
534 	endtime = busy_clock() + busyloop_timeout;
535 
536 	while (vhost_can_busy_poll(endtime)) {
537 		if (vhost_has_work(&net->dev)) {
538 			*busyloop_intr = true;
539 			break;
540 		}
541 
542 		if ((sock_has_rx_data(sock) &&
543 		     !vhost_vq_avail_empty(&net->dev, rvq)) ||
544 		    !vhost_vq_avail_empty(&net->dev, tvq))
545 			break;
546 
547 		cpu_relax();
548 	}
549 
550 	preempt_enable();
551 
552 	if (poll_rx || sock_has_rx_data(sock))
553 		vhost_net_busy_poll_try_queue(net, vq);
554 	else if (!poll_rx) /* On tx here, sock has no rx data. */
555 		vhost_enable_notify(&net->dev, rvq);
556 
557 	mutex_unlock(&vq->mutex);
558 }
559 
560 static int vhost_net_tx_get_vq_desc(struct vhost_net *net,
561 				    struct vhost_net_virtqueue *tnvq,
562 				    unsigned int *out_num, unsigned int *in_num,
563 				    struct msghdr *msghdr, bool *busyloop_intr)
564 {
565 	struct vhost_net_virtqueue *rnvq = &net->vqs[VHOST_NET_VQ_RX];
566 	struct vhost_virtqueue *rvq = &rnvq->vq;
567 	struct vhost_virtqueue *tvq = &tnvq->vq;
568 
569 	int r = vhost_get_vq_desc(tvq, tvq->iov, ARRAY_SIZE(tvq->iov),
570 				  out_num, in_num, NULL, NULL);
571 
572 	if (r == tvq->num && tvq->busyloop_timeout) {
573 		/* Flush batched packets first */
574 		if (!vhost_sock_zcopy(vhost_vq_get_backend(tvq)))
575 			vhost_tx_batch(net, tnvq,
576 				       vhost_vq_get_backend(tvq),
577 				       msghdr);
578 
579 		vhost_net_busy_poll(net, rvq, tvq, busyloop_intr, false);
580 
581 		r = vhost_get_vq_desc(tvq, tvq->iov, ARRAY_SIZE(tvq->iov),
582 				      out_num, in_num, NULL, NULL);
583 	}
584 
585 	return r;
586 }
587 
588 static bool vhost_exceeds_maxpend(struct vhost_net *net)
589 {
590 	struct vhost_net_virtqueue *nvq = &net->vqs[VHOST_NET_VQ_TX];
591 	struct vhost_virtqueue *vq = &nvq->vq;
592 
593 	return (nvq->upend_idx + UIO_MAXIOV - nvq->done_idx) % UIO_MAXIOV >
594 	       min_t(unsigned int, VHOST_MAX_PEND, vq->num >> 2);
595 }
596 
597 static size_t init_iov_iter(struct vhost_virtqueue *vq, struct iov_iter *iter,
598 			    size_t hdr_size, int out)
599 {
600 	/* Skip header. TODO: support TSO. */
601 	size_t len = iov_length(vq->iov, out);
602 
603 	iov_iter_init(iter, WRITE, vq->iov, out, len);
604 	iov_iter_advance(iter, hdr_size);
605 
606 	return iov_iter_count(iter);
607 }
608 
609 static int get_tx_bufs(struct vhost_net *net,
610 		       struct vhost_net_virtqueue *nvq,
611 		       struct msghdr *msg,
612 		       unsigned int *out, unsigned int *in,
613 		       size_t *len, bool *busyloop_intr)
614 {
615 	struct vhost_virtqueue *vq = &nvq->vq;
616 	int ret;
617 
618 	ret = vhost_net_tx_get_vq_desc(net, nvq, out, in, msg, busyloop_intr);
619 
620 	if (ret < 0 || ret == vq->num)
621 		return ret;
622 
623 	if (*in) {
624 		vq_err(vq, "Unexpected descriptor format for TX: out %d, int %d\n",
625 			*out, *in);
626 		return -EFAULT;
627 	}
628 
629 	/* Sanity check */
630 	*len = init_iov_iter(vq, &msg->msg_iter, nvq->vhost_hlen, *out);
631 	if (*len == 0) {
632 		vq_err(vq, "Unexpected header len for TX: %zd expected %zd\n",
633 			*len, nvq->vhost_hlen);
634 		return -EFAULT;
635 	}
636 
637 	return ret;
638 }
639 
640 static bool tx_can_batch(struct vhost_virtqueue *vq, size_t total_len)
641 {
642 	return total_len < VHOST_NET_WEIGHT &&
643 	       !vhost_vq_avail_empty(vq->dev, vq);
644 }
645 
646 #define SKB_FRAG_PAGE_ORDER     get_order(32768)
647 
648 static bool vhost_net_page_frag_refill(struct vhost_net *net, unsigned int sz,
649 				       struct page_frag *pfrag, gfp_t gfp)
650 {
651 	if (pfrag->page) {
652 		if (pfrag->offset + sz <= pfrag->size)
653 			return true;
654 		__page_frag_cache_drain(pfrag->page, net->refcnt_bias);
655 	}
656 
657 	pfrag->offset = 0;
658 	net->refcnt_bias = 0;
659 	if (SKB_FRAG_PAGE_ORDER) {
660 		/* Avoid direct reclaim but allow kswapd to wake */
661 		pfrag->page = alloc_pages((gfp & ~__GFP_DIRECT_RECLAIM) |
662 					  __GFP_COMP | __GFP_NOWARN |
663 					  __GFP_NORETRY,
664 					  SKB_FRAG_PAGE_ORDER);
665 		if (likely(pfrag->page)) {
666 			pfrag->size = PAGE_SIZE << SKB_FRAG_PAGE_ORDER;
667 			goto done;
668 		}
669 	}
670 	pfrag->page = alloc_page(gfp);
671 	if (likely(pfrag->page)) {
672 		pfrag->size = PAGE_SIZE;
673 		goto done;
674 	}
675 	return false;
676 
677 done:
678 	net->refcnt_bias = USHRT_MAX;
679 	page_ref_add(pfrag->page, USHRT_MAX - 1);
680 	return true;
681 }
682 
683 #define VHOST_NET_RX_PAD (NET_IP_ALIGN + NET_SKB_PAD)
684 
685 static int vhost_net_build_xdp(struct vhost_net_virtqueue *nvq,
686 			       struct iov_iter *from)
687 {
688 	struct vhost_virtqueue *vq = &nvq->vq;
689 	struct vhost_net *net = container_of(vq->dev, struct vhost_net,
690 					     dev);
691 	struct socket *sock = vhost_vq_get_backend(vq);
692 	struct page_frag *alloc_frag = &net->page_frag;
693 	struct virtio_net_hdr *gso;
694 	struct xdp_buff *xdp = &nvq->xdp[nvq->batched_xdp];
695 	struct tun_xdp_hdr *hdr;
696 	size_t len = iov_iter_count(from);
697 	int headroom = vhost_sock_xdp(sock) ? XDP_PACKET_HEADROOM : 0;
698 	int buflen = SKB_DATA_ALIGN(sizeof(struct skb_shared_info));
699 	int pad = SKB_DATA_ALIGN(VHOST_NET_RX_PAD + headroom + nvq->sock_hlen);
700 	int sock_hlen = nvq->sock_hlen;
701 	void *buf;
702 	int copied;
703 
704 	if (unlikely(len < nvq->sock_hlen))
705 		return -EFAULT;
706 
707 	if (SKB_DATA_ALIGN(len + pad) +
708 	    SKB_DATA_ALIGN(sizeof(struct skb_shared_info)) > PAGE_SIZE)
709 		return -ENOSPC;
710 
711 	buflen += SKB_DATA_ALIGN(len + pad);
712 	alloc_frag->offset = ALIGN((u64)alloc_frag->offset, SMP_CACHE_BYTES);
713 	if (unlikely(!vhost_net_page_frag_refill(net, buflen,
714 						 alloc_frag, GFP_KERNEL)))
715 		return -ENOMEM;
716 
717 	buf = (char *)page_address(alloc_frag->page) + alloc_frag->offset;
718 	copied = copy_page_from_iter(alloc_frag->page,
719 				     alloc_frag->offset +
720 				     offsetof(struct tun_xdp_hdr, gso),
721 				     sock_hlen, from);
722 	if (copied != sock_hlen)
723 		return -EFAULT;
724 
725 	hdr = buf;
726 	gso = &hdr->gso;
727 
728 	if ((gso->flags & VIRTIO_NET_HDR_F_NEEDS_CSUM) &&
729 	    vhost16_to_cpu(vq, gso->csum_start) +
730 	    vhost16_to_cpu(vq, gso->csum_offset) + 2 >
731 	    vhost16_to_cpu(vq, gso->hdr_len)) {
732 		gso->hdr_len = cpu_to_vhost16(vq,
733 			       vhost16_to_cpu(vq, gso->csum_start) +
734 			       vhost16_to_cpu(vq, gso->csum_offset) + 2);
735 
736 		if (vhost16_to_cpu(vq, gso->hdr_len) > len)
737 			return -EINVAL;
738 	}
739 
740 	len -= sock_hlen;
741 	copied = copy_page_from_iter(alloc_frag->page,
742 				     alloc_frag->offset + pad,
743 				     len, from);
744 	if (copied != len)
745 		return -EFAULT;
746 
747 	xdp->data_hard_start = buf;
748 	xdp->data = buf + pad;
749 	xdp->data_end = xdp->data + len;
750 	hdr->buflen = buflen;
751 	xdp->frame_sz = buflen;
752 
753 	--net->refcnt_bias;
754 	alloc_frag->offset += buflen;
755 
756 	++nvq->batched_xdp;
757 
758 	return 0;
759 }
760 
761 static void handle_tx_copy(struct vhost_net *net, struct socket *sock)
762 {
763 	struct vhost_net_virtqueue *nvq = &net->vqs[VHOST_NET_VQ_TX];
764 	struct vhost_virtqueue *vq = &nvq->vq;
765 	unsigned out, in;
766 	int head;
767 	struct msghdr msg = {
768 		.msg_name = NULL,
769 		.msg_namelen = 0,
770 		.msg_control = NULL,
771 		.msg_controllen = 0,
772 		.msg_flags = MSG_DONTWAIT,
773 	};
774 	size_t len, total_len = 0;
775 	int err;
776 	int sent_pkts = 0;
777 	bool sock_can_batch = (sock->sk->sk_sndbuf == INT_MAX);
778 
779 	do {
780 		bool busyloop_intr = false;
781 
782 		if (nvq->done_idx == VHOST_NET_BATCH)
783 			vhost_tx_batch(net, nvq, sock, &msg);
784 
785 		head = get_tx_bufs(net, nvq, &msg, &out, &in, &len,
786 				   &busyloop_intr);
787 		/* On error, stop handling until the next kick. */
788 		if (unlikely(head < 0))
789 			break;
790 		/* Nothing new?  Wait for eventfd to tell us they refilled. */
791 		if (head == vq->num) {
792 			if (unlikely(busyloop_intr)) {
793 				vhost_poll_queue(&vq->poll);
794 			} else if (unlikely(vhost_enable_notify(&net->dev,
795 								vq))) {
796 				vhost_disable_notify(&net->dev, vq);
797 				continue;
798 			}
799 			break;
800 		}
801 
802 		total_len += len;
803 
804 		/* For simplicity, TX batching is only enabled if
805 		 * sndbuf is unlimited.
806 		 */
807 		if (sock_can_batch) {
808 			err = vhost_net_build_xdp(nvq, &msg.msg_iter);
809 			if (!err) {
810 				goto done;
811 			} else if (unlikely(err != -ENOSPC)) {
812 				vhost_tx_batch(net, nvq, sock, &msg);
813 				vhost_discard_vq_desc(vq, 1);
814 				vhost_net_enable_vq(net, vq);
815 				break;
816 			}
817 
818 			/* We can't build XDP buff, go for single
819 			 * packet path but let's flush batched
820 			 * packets.
821 			 */
822 			vhost_tx_batch(net, nvq, sock, &msg);
823 			msg.msg_control = NULL;
824 		} else {
825 			if (tx_can_batch(vq, total_len))
826 				msg.msg_flags |= MSG_MORE;
827 			else
828 				msg.msg_flags &= ~MSG_MORE;
829 		}
830 
831 		err = sock->ops->sendmsg(sock, &msg, len);
832 		if (unlikely(err < 0)) {
833 			if (err == -EAGAIN || err == -ENOMEM || err == -ENOBUFS) {
834 				vhost_discard_vq_desc(vq, 1);
835 				vhost_net_enable_vq(net, vq);
836 				break;
837 			}
838 			pr_debug("Fail to send packet: err %d", err);
839 		} else if (unlikely(err != len))
840 			pr_debug("Truncated TX packet: len %d != %zd\n",
841 				 err, len);
842 done:
843 		vq->heads[nvq->done_idx].id = cpu_to_vhost32(vq, head);
844 		vq->heads[nvq->done_idx].len = 0;
845 		++nvq->done_idx;
846 	} while (likely(!vhost_exceeds_weight(vq, ++sent_pkts, total_len)));
847 
848 	vhost_tx_batch(net, nvq, sock, &msg);
849 }
850 
851 static void handle_tx_zerocopy(struct vhost_net *net, struct socket *sock)
852 {
853 	struct vhost_net_virtqueue *nvq = &net->vqs[VHOST_NET_VQ_TX];
854 	struct vhost_virtqueue *vq = &nvq->vq;
855 	unsigned out, in;
856 	int head;
857 	struct msghdr msg = {
858 		.msg_name = NULL,
859 		.msg_namelen = 0,
860 		.msg_control = NULL,
861 		.msg_controllen = 0,
862 		.msg_flags = MSG_DONTWAIT,
863 	};
864 	struct tun_msg_ctl ctl;
865 	size_t len, total_len = 0;
866 	int err;
867 	struct vhost_net_ubuf_ref *ubufs;
868 	struct ubuf_info *ubuf;
869 	bool zcopy_used;
870 	int sent_pkts = 0;
871 
872 	do {
873 		bool busyloop_intr;
874 
875 		/* Release DMAs done buffers first */
876 		vhost_zerocopy_signal_used(net, vq);
877 
878 		busyloop_intr = false;
879 		head = get_tx_bufs(net, nvq, &msg, &out, &in, &len,
880 				   &busyloop_intr);
881 		/* On error, stop handling until the next kick. */
882 		if (unlikely(head < 0))
883 			break;
884 		/* Nothing new?  Wait for eventfd to tell us they refilled. */
885 		if (head == vq->num) {
886 			if (unlikely(busyloop_intr)) {
887 				vhost_poll_queue(&vq->poll);
888 			} else if (unlikely(vhost_enable_notify(&net->dev, vq))) {
889 				vhost_disable_notify(&net->dev, vq);
890 				continue;
891 			}
892 			break;
893 		}
894 
895 		zcopy_used = len >= VHOST_GOODCOPY_LEN
896 			     && !vhost_exceeds_maxpend(net)
897 			     && vhost_net_tx_select_zcopy(net);
898 
899 		/* use msg_control to pass vhost zerocopy ubuf info to skb */
900 		if (zcopy_used) {
901 			ubuf = nvq->ubuf_info + nvq->upend_idx;
902 			vq->heads[nvq->upend_idx].id = cpu_to_vhost32(vq, head);
903 			vq->heads[nvq->upend_idx].len = VHOST_DMA_IN_PROGRESS;
904 			ubuf->callback = vhost_zerocopy_callback;
905 			ubuf->ctx = nvq->ubufs;
906 			ubuf->desc = nvq->upend_idx;
907 			ubuf->flags = SKBFL_ZEROCOPY_FRAG;
908 			refcount_set(&ubuf->refcnt, 1);
909 			msg.msg_control = &ctl;
910 			ctl.type = TUN_MSG_UBUF;
911 			ctl.ptr = ubuf;
912 			msg.msg_controllen = sizeof(ctl);
913 			ubufs = nvq->ubufs;
914 			atomic_inc(&ubufs->refcount);
915 			nvq->upend_idx = (nvq->upend_idx + 1) % UIO_MAXIOV;
916 		} else {
917 			msg.msg_control = NULL;
918 			ubufs = NULL;
919 		}
920 		total_len += len;
921 		if (tx_can_batch(vq, total_len) &&
922 		    likely(!vhost_exceeds_maxpend(net))) {
923 			msg.msg_flags |= MSG_MORE;
924 		} else {
925 			msg.msg_flags &= ~MSG_MORE;
926 		}
927 
928 		err = sock->ops->sendmsg(sock, &msg, len);
929 		if (unlikely(err < 0)) {
930 			if (zcopy_used) {
931 				if (vq->heads[ubuf->desc].len == VHOST_DMA_IN_PROGRESS)
932 					vhost_net_ubuf_put(ubufs);
933 				nvq->upend_idx = ((unsigned)nvq->upend_idx - 1)
934 					% UIO_MAXIOV;
935 			}
936 			if (err == -EAGAIN || err == -ENOMEM || err == -ENOBUFS) {
937 				vhost_discard_vq_desc(vq, 1);
938 				vhost_net_enable_vq(net, vq);
939 				break;
940 			}
941 			pr_debug("Fail to send packet: err %d", err);
942 		} else if (unlikely(err != len))
943 			pr_debug("Truncated TX packet: "
944 				 " len %d != %zd\n", err, len);
945 		if (!zcopy_used)
946 			vhost_add_used_and_signal(&net->dev, vq, head, 0);
947 		else
948 			vhost_zerocopy_signal_used(net, vq);
949 		vhost_net_tx_packet(net);
950 	} while (likely(!vhost_exceeds_weight(vq, ++sent_pkts, total_len)));
951 }
952 
953 /* Expects to be always run from workqueue - which acts as
954  * read-size critical section for our kind of RCU. */
955 static void handle_tx(struct vhost_net *net)
956 {
957 	struct vhost_net_virtqueue *nvq = &net->vqs[VHOST_NET_VQ_TX];
958 	struct vhost_virtqueue *vq = &nvq->vq;
959 	struct socket *sock;
960 
961 	mutex_lock_nested(&vq->mutex, VHOST_NET_VQ_TX);
962 	sock = vhost_vq_get_backend(vq);
963 	if (!sock)
964 		goto out;
965 
966 	if (!vq_meta_prefetch(vq))
967 		goto out;
968 
969 	vhost_disable_notify(&net->dev, vq);
970 	vhost_net_disable_vq(net, vq);
971 
972 	if (vhost_sock_zcopy(sock))
973 		handle_tx_zerocopy(net, sock);
974 	else
975 		handle_tx_copy(net, sock);
976 
977 out:
978 	mutex_unlock(&vq->mutex);
979 }
980 
981 static int peek_head_len(struct vhost_net_virtqueue *rvq, struct sock *sk)
982 {
983 	struct sk_buff *head;
984 	int len = 0;
985 	unsigned long flags;
986 
987 	if (rvq->rx_ring)
988 		return vhost_net_buf_peek(rvq);
989 
990 	spin_lock_irqsave(&sk->sk_receive_queue.lock, flags);
991 	head = skb_peek(&sk->sk_receive_queue);
992 	if (likely(head)) {
993 		len = head->len;
994 		if (skb_vlan_tag_present(head))
995 			len += VLAN_HLEN;
996 	}
997 
998 	spin_unlock_irqrestore(&sk->sk_receive_queue.lock, flags);
999 	return len;
1000 }
1001 
1002 static int vhost_net_rx_peek_head_len(struct vhost_net *net, struct sock *sk,
1003 				      bool *busyloop_intr)
1004 {
1005 	struct vhost_net_virtqueue *rnvq = &net->vqs[VHOST_NET_VQ_RX];
1006 	struct vhost_net_virtqueue *tnvq = &net->vqs[VHOST_NET_VQ_TX];
1007 	struct vhost_virtqueue *rvq = &rnvq->vq;
1008 	struct vhost_virtqueue *tvq = &tnvq->vq;
1009 	int len = peek_head_len(rnvq, sk);
1010 
1011 	if (!len && rvq->busyloop_timeout) {
1012 		/* Flush batched heads first */
1013 		vhost_net_signal_used(rnvq);
1014 		/* Both tx vq and rx socket were polled here */
1015 		vhost_net_busy_poll(net, rvq, tvq, busyloop_intr, true);
1016 
1017 		len = peek_head_len(rnvq, sk);
1018 	}
1019 
1020 	return len;
1021 }
1022 
1023 /* This is a multi-buffer version of vhost_get_desc, that works if
1024  *	vq has read descriptors only.
1025  * @vq		- the relevant virtqueue
1026  * @datalen	- data length we'll be reading
1027  * @iovcount	- returned count of io vectors we fill
1028  * @log		- vhost log
1029  * @log_num	- log offset
1030  * @quota       - headcount quota, 1 for big buffer
1031  *	returns number of buffer heads allocated, negative on error
1032  */
1033 static int get_rx_bufs(struct vhost_virtqueue *vq,
1034 		       struct vring_used_elem *heads,
1035 		       int datalen,
1036 		       unsigned *iovcount,
1037 		       struct vhost_log *log,
1038 		       unsigned *log_num,
1039 		       unsigned int quota)
1040 {
1041 	unsigned int out, in;
1042 	int seg = 0;
1043 	int headcount = 0;
1044 	unsigned d;
1045 	int r, nlogs = 0;
1046 	/* len is always initialized before use since we are always called with
1047 	 * datalen > 0.
1048 	 */
1049 	u32 len;
1050 
1051 	while (datalen > 0 && headcount < quota) {
1052 		if (unlikely(seg >= UIO_MAXIOV)) {
1053 			r = -ENOBUFS;
1054 			goto err;
1055 		}
1056 		r = vhost_get_vq_desc(vq, vq->iov + seg,
1057 				      ARRAY_SIZE(vq->iov) - seg, &out,
1058 				      &in, log, log_num);
1059 		if (unlikely(r < 0))
1060 			goto err;
1061 
1062 		d = r;
1063 		if (d == vq->num) {
1064 			r = 0;
1065 			goto err;
1066 		}
1067 		if (unlikely(out || in <= 0)) {
1068 			vq_err(vq, "unexpected descriptor format for RX: "
1069 				"out %d, in %d\n", out, in);
1070 			r = -EINVAL;
1071 			goto err;
1072 		}
1073 		if (unlikely(log)) {
1074 			nlogs += *log_num;
1075 			log += *log_num;
1076 		}
1077 		heads[headcount].id = cpu_to_vhost32(vq, d);
1078 		len = iov_length(vq->iov + seg, in);
1079 		heads[headcount].len = cpu_to_vhost32(vq, len);
1080 		datalen -= len;
1081 		++headcount;
1082 		seg += in;
1083 	}
1084 	heads[headcount - 1].len = cpu_to_vhost32(vq, len + datalen);
1085 	*iovcount = seg;
1086 	if (unlikely(log))
1087 		*log_num = nlogs;
1088 
1089 	/* Detect overrun */
1090 	if (unlikely(datalen > 0)) {
1091 		r = UIO_MAXIOV + 1;
1092 		goto err;
1093 	}
1094 	return headcount;
1095 err:
1096 	vhost_discard_vq_desc(vq, headcount);
1097 	return r;
1098 }
1099 
1100 /* Expects to be always run from workqueue - which acts as
1101  * read-size critical section for our kind of RCU. */
1102 static void handle_rx(struct vhost_net *net)
1103 {
1104 	struct vhost_net_virtqueue *nvq = &net->vqs[VHOST_NET_VQ_RX];
1105 	struct vhost_virtqueue *vq = &nvq->vq;
1106 	unsigned in, log;
1107 	struct vhost_log *vq_log;
1108 	struct msghdr msg = {
1109 		.msg_name = NULL,
1110 		.msg_namelen = 0,
1111 		.msg_control = NULL, /* FIXME: get and handle RX aux data. */
1112 		.msg_controllen = 0,
1113 		.msg_flags = MSG_DONTWAIT,
1114 	};
1115 	struct virtio_net_hdr hdr = {
1116 		.flags = 0,
1117 		.gso_type = VIRTIO_NET_HDR_GSO_NONE
1118 	};
1119 	size_t total_len = 0;
1120 	int err, mergeable;
1121 	s16 headcount;
1122 	size_t vhost_hlen, sock_hlen;
1123 	size_t vhost_len, sock_len;
1124 	bool busyloop_intr = false;
1125 	struct socket *sock;
1126 	struct iov_iter fixup;
1127 	__virtio16 num_buffers;
1128 	int recv_pkts = 0;
1129 
1130 	mutex_lock_nested(&vq->mutex, VHOST_NET_VQ_RX);
1131 	sock = vhost_vq_get_backend(vq);
1132 	if (!sock)
1133 		goto out;
1134 
1135 	if (!vq_meta_prefetch(vq))
1136 		goto out;
1137 
1138 	vhost_disable_notify(&net->dev, vq);
1139 	vhost_net_disable_vq(net, vq);
1140 
1141 	vhost_hlen = nvq->vhost_hlen;
1142 	sock_hlen = nvq->sock_hlen;
1143 
1144 	vq_log = unlikely(vhost_has_feature(vq, VHOST_F_LOG_ALL)) ?
1145 		vq->log : NULL;
1146 	mergeable = vhost_has_feature(vq, VIRTIO_NET_F_MRG_RXBUF);
1147 
1148 	do {
1149 		sock_len = vhost_net_rx_peek_head_len(net, sock->sk,
1150 						      &busyloop_intr);
1151 		if (!sock_len)
1152 			break;
1153 		sock_len += sock_hlen;
1154 		vhost_len = sock_len + vhost_hlen;
1155 		headcount = get_rx_bufs(vq, vq->heads + nvq->done_idx,
1156 					vhost_len, &in, vq_log, &log,
1157 					likely(mergeable) ? UIO_MAXIOV : 1);
1158 		/* On error, stop handling until the next kick. */
1159 		if (unlikely(headcount < 0))
1160 			goto out;
1161 		/* OK, now we need to know about added descriptors. */
1162 		if (!headcount) {
1163 			if (unlikely(busyloop_intr)) {
1164 				vhost_poll_queue(&vq->poll);
1165 			} else if (unlikely(vhost_enable_notify(&net->dev, vq))) {
1166 				/* They have slipped one in as we were
1167 				 * doing that: check again. */
1168 				vhost_disable_notify(&net->dev, vq);
1169 				continue;
1170 			}
1171 			/* Nothing new?  Wait for eventfd to tell us
1172 			 * they refilled. */
1173 			goto out;
1174 		}
1175 		busyloop_intr = false;
1176 		if (nvq->rx_ring)
1177 			msg.msg_control = vhost_net_buf_consume(&nvq->rxq);
1178 		/* On overrun, truncate and discard */
1179 		if (unlikely(headcount > UIO_MAXIOV)) {
1180 			iov_iter_init(&msg.msg_iter, READ, vq->iov, 1, 1);
1181 			err = sock->ops->recvmsg(sock, &msg,
1182 						 1, MSG_DONTWAIT | MSG_TRUNC);
1183 			pr_debug("Discarded rx packet: len %zd\n", sock_len);
1184 			continue;
1185 		}
1186 		/* We don't need to be notified again. */
1187 		iov_iter_init(&msg.msg_iter, READ, vq->iov, in, vhost_len);
1188 		fixup = msg.msg_iter;
1189 		if (unlikely((vhost_hlen))) {
1190 			/* We will supply the header ourselves
1191 			 * TODO: support TSO.
1192 			 */
1193 			iov_iter_advance(&msg.msg_iter, vhost_hlen);
1194 		}
1195 		err = sock->ops->recvmsg(sock, &msg,
1196 					 sock_len, MSG_DONTWAIT | MSG_TRUNC);
1197 		/* Userspace might have consumed the packet meanwhile:
1198 		 * it's not supposed to do this usually, but might be hard
1199 		 * to prevent. Discard data we got (if any) and keep going. */
1200 		if (unlikely(err != sock_len)) {
1201 			pr_debug("Discarded rx packet: "
1202 				 " len %d, expected %zd\n", err, sock_len);
1203 			vhost_discard_vq_desc(vq, headcount);
1204 			continue;
1205 		}
1206 		/* Supply virtio_net_hdr if VHOST_NET_F_VIRTIO_NET_HDR */
1207 		if (unlikely(vhost_hlen)) {
1208 			if (copy_to_iter(&hdr, sizeof(hdr),
1209 					 &fixup) != sizeof(hdr)) {
1210 				vq_err(vq, "Unable to write vnet_hdr "
1211 				       "at addr %p\n", vq->iov->iov_base);
1212 				goto out;
1213 			}
1214 		} else {
1215 			/* Header came from socket; we'll need to patch
1216 			 * ->num_buffers over if VIRTIO_NET_F_MRG_RXBUF
1217 			 */
1218 			iov_iter_advance(&fixup, sizeof(hdr));
1219 		}
1220 		/* TODO: Should check and handle checksum. */
1221 
1222 		num_buffers = cpu_to_vhost16(vq, headcount);
1223 		if (likely(mergeable) &&
1224 		    copy_to_iter(&num_buffers, sizeof num_buffers,
1225 				 &fixup) != sizeof num_buffers) {
1226 			vq_err(vq, "Failed num_buffers write");
1227 			vhost_discard_vq_desc(vq, headcount);
1228 			goto out;
1229 		}
1230 		nvq->done_idx += headcount;
1231 		if (nvq->done_idx > VHOST_NET_BATCH)
1232 			vhost_net_signal_used(nvq);
1233 		if (unlikely(vq_log))
1234 			vhost_log_write(vq, vq_log, log, vhost_len,
1235 					vq->iov, in);
1236 		total_len += vhost_len;
1237 	} while (likely(!vhost_exceeds_weight(vq, ++recv_pkts, total_len)));
1238 
1239 	if (unlikely(busyloop_intr))
1240 		vhost_poll_queue(&vq->poll);
1241 	else if (!sock_len)
1242 		vhost_net_enable_vq(net, vq);
1243 out:
1244 	vhost_net_signal_used(nvq);
1245 	mutex_unlock(&vq->mutex);
1246 }
1247 
1248 static void handle_tx_kick(struct vhost_work *work)
1249 {
1250 	struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
1251 						  poll.work);
1252 	struct vhost_net *net = container_of(vq->dev, struct vhost_net, dev);
1253 
1254 	handle_tx(net);
1255 }
1256 
1257 static void handle_rx_kick(struct vhost_work *work)
1258 {
1259 	struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
1260 						  poll.work);
1261 	struct vhost_net *net = container_of(vq->dev, struct vhost_net, dev);
1262 
1263 	handle_rx(net);
1264 }
1265 
1266 static void handle_tx_net(struct vhost_work *work)
1267 {
1268 	struct vhost_net *net = container_of(work, struct vhost_net,
1269 					     poll[VHOST_NET_VQ_TX].work);
1270 	handle_tx(net);
1271 }
1272 
1273 static void handle_rx_net(struct vhost_work *work)
1274 {
1275 	struct vhost_net *net = container_of(work, struct vhost_net,
1276 					     poll[VHOST_NET_VQ_RX].work);
1277 	handle_rx(net);
1278 }
1279 
1280 static int vhost_net_open(struct inode *inode, struct file *f)
1281 {
1282 	struct vhost_net *n;
1283 	struct vhost_dev *dev;
1284 	struct vhost_virtqueue **vqs;
1285 	void **queue;
1286 	struct xdp_buff *xdp;
1287 	int i;
1288 
1289 	n = kvmalloc(sizeof *n, GFP_KERNEL | __GFP_RETRY_MAYFAIL);
1290 	if (!n)
1291 		return -ENOMEM;
1292 	vqs = kmalloc_array(VHOST_NET_VQ_MAX, sizeof(*vqs), GFP_KERNEL);
1293 	if (!vqs) {
1294 		kvfree(n);
1295 		return -ENOMEM;
1296 	}
1297 
1298 	queue = kmalloc_array(VHOST_NET_BATCH, sizeof(void *),
1299 			      GFP_KERNEL);
1300 	if (!queue) {
1301 		kfree(vqs);
1302 		kvfree(n);
1303 		return -ENOMEM;
1304 	}
1305 	n->vqs[VHOST_NET_VQ_RX].rxq.queue = queue;
1306 
1307 	xdp = kmalloc_array(VHOST_NET_BATCH, sizeof(*xdp), GFP_KERNEL);
1308 	if (!xdp) {
1309 		kfree(vqs);
1310 		kvfree(n);
1311 		kfree(queue);
1312 		return -ENOMEM;
1313 	}
1314 	n->vqs[VHOST_NET_VQ_TX].xdp = xdp;
1315 
1316 	dev = &n->dev;
1317 	vqs[VHOST_NET_VQ_TX] = &n->vqs[VHOST_NET_VQ_TX].vq;
1318 	vqs[VHOST_NET_VQ_RX] = &n->vqs[VHOST_NET_VQ_RX].vq;
1319 	n->vqs[VHOST_NET_VQ_TX].vq.handle_kick = handle_tx_kick;
1320 	n->vqs[VHOST_NET_VQ_RX].vq.handle_kick = handle_rx_kick;
1321 	for (i = 0; i < VHOST_NET_VQ_MAX; i++) {
1322 		n->vqs[i].ubufs = NULL;
1323 		n->vqs[i].ubuf_info = NULL;
1324 		n->vqs[i].upend_idx = 0;
1325 		n->vqs[i].done_idx = 0;
1326 		n->vqs[i].batched_xdp = 0;
1327 		n->vqs[i].vhost_hlen = 0;
1328 		n->vqs[i].sock_hlen = 0;
1329 		n->vqs[i].rx_ring = NULL;
1330 		vhost_net_buf_init(&n->vqs[i].rxq);
1331 	}
1332 	vhost_dev_init(dev, vqs, VHOST_NET_VQ_MAX,
1333 		       UIO_MAXIOV + VHOST_NET_BATCH,
1334 		       VHOST_NET_PKT_WEIGHT, VHOST_NET_WEIGHT, true,
1335 		       NULL);
1336 
1337 	vhost_poll_init(n->poll + VHOST_NET_VQ_TX, handle_tx_net, EPOLLOUT, dev);
1338 	vhost_poll_init(n->poll + VHOST_NET_VQ_RX, handle_rx_net, EPOLLIN, dev);
1339 
1340 	f->private_data = n;
1341 	n->page_frag.page = NULL;
1342 	n->refcnt_bias = 0;
1343 
1344 	return 0;
1345 }
1346 
1347 static struct socket *vhost_net_stop_vq(struct vhost_net *n,
1348 					struct vhost_virtqueue *vq)
1349 {
1350 	struct socket *sock;
1351 	struct vhost_net_virtqueue *nvq =
1352 		container_of(vq, struct vhost_net_virtqueue, vq);
1353 
1354 	mutex_lock(&vq->mutex);
1355 	sock = vhost_vq_get_backend(vq);
1356 	vhost_net_disable_vq(n, vq);
1357 	vhost_vq_set_backend(vq, NULL);
1358 	vhost_net_buf_unproduce(nvq);
1359 	nvq->rx_ring = NULL;
1360 	mutex_unlock(&vq->mutex);
1361 	return sock;
1362 }
1363 
1364 static void vhost_net_stop(struct vhost_net *n, struct socket **tx_sock,
1365 			   struct socket **rx_sock)
1366 {
1367 	*tx_sock = vhost_net_stop_vq(n, &n->vqs[VHOST_NET_VQ_TX].vq);
1368 	*rx_sock = vhost_net_stop_vq(n, &n->vqs[VHOST_NET_VQ_RX].vq);
1369 }
1370 
1371 static void vhost_net_flush_vq(struct vhost_net *n, int index)
1372 {
1373 	vhost_poll_flush(n->poll + index);
1374 	vhost_poll_flush(&n->vqs[index].vq.poll);
1375 }
1376 
1377 static void vhost_net_flush(struct vhost_net *n)
1378 {
1379 	vhost_net_flush_vq(n, VHOST_NET_VQ_TX);
1380 	vhost_net_flush_vq(n, VHOST_NET_VQ_RX);
1381 	if (n->vqs[VHOST_NET_VQ_TX].ubufs) {
1382 		mutex_lock(&n->vqs[VHOST_NET_VQ_TX].vq.mutex);
1383 		n->tx_flush = true;
1384 		mutex_unlock(&n->vqs[VHOST_NET_VQ_TX].vq.mutex);
1385 		/* Wait for all lower device DMAs done. */
1386 		vhost_net_ubuf_put_and_wait(n->vqs[VHOST_NET_VQ_TX].ubufs);
1387 		mutex_lock(&n->vqs[VHOST_NET_VQ_TX].vq.mutex);
1388 		n->tx_flush = false;
1389 		atomic_set(&n->vqs[VHOST_NET_VQ_TX].ubufs->refcount, 1);
1390 		mutex_unlock(&n->vqs[VHOST_NET_VQ_TX].vq.mutex);
1391 	}
1392 }
1393 
1394 static int vhost_net_release(struct inode *inode, struct file *f)
1395 {
1396 	struct vhost_net *n = f->private_data;
1397 	struct socket *tx_sock;
1398 	struct socket *rx_sock;
1399 
1400 	vhost_net_stop(n, &tx_sock, &rx_sock);
1401 	vhost_net_flush(n);
1402 	vhost_dev_stop(&n->dev);
1403 	vhost_dev_cleanup(&n->dev);
1404 	vhost_net_vq_reset(n);
1405 	if (tx_sock)
1406 		sockfd_put(tx_sock);
1407 	if (rx_sock)
1408 		sockfd_put(rx_sock);
1409 	/* Make sure no callbacks are outstanding */
1410 	synchronize_rcu();
1411 	/* We do an extra flush before freeing memory,
1412 	 * since jobs can re-queue themselves. */
1413 	vhost_net_flush(n);
1414 	kfree(n->vqs[VHOST_NET_VQ_RX].rxq.queue);
1415 	kfree(n->vqs[VHOST_NET_VQ_TX].xdp);
1416 	kfree(n->dev.vqs);
1417 	if (n->page_frag.page)
1418 		__page_frag_cache_drain(n->page_frag.page, n->refcnt_bias);
1419 	kvfree(n);
1420 	return 0;
1421 }
1422 
1423 static struct socket *get_raw_socket(int fd)
1424 {
1425 	int r;
1426 	struct socket *sock = sockfd_lookup(fd, &r);
1427 
1428 	if (!sock)
1429 		return ERR_PTR(-ENOTSOCK);
1430 
1431 	/* Parameter checking */
1432 	if (sock->sk->sk_type != SOCK_RAW) {
1433 		r = -ESOCKTNOSUPPORT;
1434 		goto err;
1435 	}
1436 
1437 	if (sock->sk->sk_family != AF_PACKET) {
1438 		r = -EPFNOSUPPORT;
1439 		goto err;
1440 	}
1441 	return sock;
1442 err:
1443 	sockfd_put(sock);
1444 	return ERR_PTR(r);
1445 }
1446 
1447 static struct ptr_ring *get_tap_ptr_ring(int fd)
1448 {
1449 	struct ptr_ring *ring;
1450 	struct file *file = fget(fd);
1451 
1452 	if (!file)
1453 		return NULL;
1454 	ring = tun_get_tx_ring(file);
1455 	if (!IS_ERR(ring))
1456 		goto out;
1457 	ring = tap_get_ptr_ring(file);
1458 	if (!IS_ERR(ring))
1459 		goto out;
1460 	ring = NULL;
1461 out:
1462 	fput(file);
1463 	return ring;
1464 }
1465 
1466 static struct socket *get_tap_socket(int fd)
1467 {
1468 	struct file *file = fget(fd);
1469 	struct socket *sock;
1470 
1471 	if (!file)
1472 		return ERR_PTR(-EBADF);
1473 	sock = tun_get_socket(file);
1474 	if (!IS_ERR(sock))
1475 		return sock;
1476 	sock = tap_get_socket(file);
1477 	if (IS_ERR(sock))
1478 		fput(file);
1479 	return sock;
1480 }
1481 
1482 static struct socket *get_socket(int fd)
1483 {
1484 	struct socket *sock;
1485 
1486 	/* special case to disable backend */
1487 	if (fd == -1)
1488 		return NULL;
1489 	sock = get_raw_socket(fd);
1490 	if (!IS_ERR(sock))
1491 		return sock;
1492 	sock = get_tap_socket(fd);
1493 	if (!IS_ERR(sock))
1494 		return sock;
1495 	return ERR_PTR(-ENOTSOCK);
1496 }
1497 
1498 static long vhost_net_set_backend(struct vhost_net *n, unsigned index, int fd)
1499 {
1500 	struct socket *sock, *oldsock;
1501 	struct vhost_virtqueue *vq;
1502 	struct vhost_net_virtqueue *nvq;
1503 	struct vhost_net_ubuf_ref *ubufs, *oldubufs = NULL;
1504 	int r;
1505 
1506 	mutex_lock(&n->dev.mutex);
1507 	r = vhost_dev_check_owner(&n->dev);
1508 	if (r)
1509 		goto err;
1510 
1511 	if (index >= VHOST_NET_VQ_MAX) {
1512 		r = -ENOBUFS;
1513 		goto err;
1514 	}
1515 	vq = &n->vqs[index].vq;
1516 	nvq = &n->vqs[index];
1517 	mutex_lock(&vq->mutex);
1518 
1519 	/* Verify that ring has been setup correctly. */
1520 	if (!vhost_vq_access_ok(vq)) {
1521 		r = -EFAULT;
1522 		goto err_vq;
1523 	}
1524 	sock = get_socket(fd);
1525 	if (IS_ERR(sock)) {
1526 		r = PTR_ERR(sock);
1527 		goto err_vq;
1528 	}
1529 
1530 	/* start polling new socket */
1531 	oldsock = vhost_vq_get_backend(vq);
1532 	if (sock != oldsock) {
1533 		ubufs = vhost_net_ubuf_alloc(vq,
1534 					     sock && vhost_sock_zcopy(sock));
1535 		if (IS_ERR(ubufs)) {
1536 			r = PTR_ERR(ubufs);
1537 			goto err_ubufs;
1538 		}
1539 
1540 		vhost_net_disable_vq(n, vq);
1541 		vhost_vq_set_backend(vq, sock);
1542 		vhost_net_buf_unproduce(nvq);
1543 		r = vhost_vq_init_access(vq);
1544 		if (r)
1545 			goto err_used;
1546 		r = vhost_net_enable_vq(n, vq);
1547 		if (r)
1548 			goto err_used;
1549 		if (index == VHOST_NET_VQ_RX)
1550 			nvq->rx_ring = get_tap_ptr_ring(fd);
1551 
1552 		oldubufs = nvq->ubufs;
1553 		nvq->ubufs = ubufs;
1554 
1555 		n->tx_packets = 0;
1556 		n->tx_zcopy_err = 0;
1557 		n->tx_flush = false;
1558 	}
1559 
1560 	mutex_unlock(&vq->mutex);
1561 
1562 	if (oldubufs) {
1563 		vhost_net_ubuf_put_wait_and_free(oldubufs);
1564 		mutex_lock(&vq->mutex);
1565 		vhost_zerocopy_signal_used(n, vq);
1566 		mutex_unlock(&vq->mutex);
1567 	}
1568 
1569 	if (oldsock) {
1570 		vhost_net_flush_vq(n, index);
1571 		sockfd_put(oldsock);
1572 	}
1573 
1574 	mutex_unlock(&n->dev.mutex);
1575 	return 0;
1576 
1577 err_used:
1578 	vhost_vq_set_backend(vq, oldsock);
1579 	vhost_net_enable_vq(n, vq);
1580 	if (ubufs)
1581 		vhost_net_ubuf_put_wait_and_free(ubufs);
1582 err_ubufs:
1583 	if (sock)
1584 		sockfd_put(sock);
1585 err_vq:
1586 	mutex_unlock(&vq->mutex);
1587 err:
1588 	mutex_unlock(&n->dev.mutex);
1589 	return r;
1590 }
1591 
1592 static long vhost_net_reset_owner(struct vhost_net *n)
1593 {
1594 	struct socket *tx_sock = NULL;
1595 	struct socket *rx_sock = NULL;
1596 	long err;
1597 	struct vhost_iotlb *umem;
1598 
1599 	mutex_lock(&n->dev.mutex);
1600 	err = vhost_dev_check_owner(&n->dev);
1601 	if (err)
1602 		goto done;
1603 	umem = vhost_dev_reset_owner_prepare();
1604 	if (!umem) {
1605 		err = -ENOMEM;
1606 		goto done;
1607 	}
1608 	vhost_net_stop(n, &tx_sock, &rx_sock);
1609 	vhost_net_flush(n);
1610 	vhost_dev_stop(&n->dev);
1611 	vhost_dev_reset_owner(&n->dev, umem);
1612 	vhost_net_vq_reset(n);
1613 done:
1614 	mutex_unlock(&n->dev.mutex);
1615 	if (tx_sock)
1616 		sockfd_put(tx_sock);
1617 	if (rx_sock)
1618 		sockfd_put(rx_sock);
1619 	return err;
1620 }
1621 
1622 static int vhost_net_set_features(struct vhost_net *n, u64 features)
1623 {
1624 	size_t vhost_hlen, sock_hlen, hdr_len;
1625 	int i;
1626 
1627 	hdr_len = (features & ((1ULL << VIRTIO_NET_F_MRG_RXBUF) |
1628 			       (1ULL << VIRTIO_F_VERSION_1))) ?
1629 			sizeof(struct virtio_net_hdr_mrg_rxbuf) :
1630 			sizeof(struct virtio_net_hdr);
1631 	if (features & (1 << VHOST_NET_F_VIRTIO_NET_HDR)) {
1632 		/* vhost provides vnet_hdr */
1633 		vhost_hlen = hdr_len;
1634 		sock_hlen = 0;
1635 	} else {
1636 		/* socket provides vnet_hdr */
1637 		vhost_hlen = 0;
1638 		sock_hlen = hdr_len;
1639 	}
1640 	mutex_lock(&n->dev.mutex);
1641 	if ((features & (1 << VHOST_F_LOG_ALL)) &&
1642 	    !vhost_log_access_ok(&n->dev))
1643 		goto out_unlock;
1644 
1645 	if ((features & (1ULL << VIRTIO_F_ACCESS_PLATFORM))) {
1646 		if (vhost_init_device_iotlb(&n->dev, true))
1647 			goto out_unlock;
1648 	}
1649 
1650 	for (i = 0; i < VHOST_NET_VQ_MAX; ++i) {
1651 		mutex_lock(&n->vqs[i].vq.mutex);
1652 		n->vqs[i].vq.acked_features = features;
1653 		n->vqs[i].vhost_hlen = vhost_hlen;
1654 		n->vqs[i].sock_hlen = sock_hlen;
1655 		mutex_unlock(&n->vqs[i].vq.mutex);
1656 	}
1657 	mutex_unlock(&n->dev.mutex);
1658 	return 0;
1659 
1660 out_unlock:
1661 	mutex_unlock(&n->dev.mutex);
1662 	return -EFAULT;
1663 }
1664 
1665 static long vhost_net_set_owner(struct vhost_net *n)
1666 {
1667 	int r;
1668 
1669 	mutex_lock(&n->dev.mutex);
1670 	if (vhost_dev_has_owner(&n->dev)) {
1671 		r = -EBUSY;
1672 		goto out;
1673 	}
1674 	r = vhost_net_set_ubuf_info(n);
1675 	if (r)
1676 		goto out;
1677 	r = vhost_dev_set_owner(&n->dev);
1678 	if (r)
1679 		vhost_net_clear_ubuf_info(n);
1680 	vhost_net_flush(n);
1681 out:
1682 	mutex_unlock(&n->dev.mutex);
1683 	return r;
1684 }
1685 
1686 static long vhost_net_ioctl(struct file *f, unsigned int ioctl,
1687 			    unsigned long arg)
1688 {
1689 	struct vhost_net *n = f->private_data;
1690 	void __user *argp = (void __user *)arg;
1691 	u64 __user *featurep = argp;
1692 	struct vhost_vring_file backend;
1693 	u64 features;
1694 	int r;
1695 
1696 	switch (ioctl) {
1697 	case VHOST_NET_SET_BACKEND:
1698 		if (copy_from_user(&backend, argp, sizeof backend))
1699 			return -EFAULT;
1700 		return vhost_net_set_backend(n, backend.index, backend.fd);
1701 	case VHOST_GET_FEATURES:
1702 		features = VHOST_NET_FEATURES;
1703 		if (copy_to_user(featurep, &features, sizeof features))
1704 			return -EFAULT;
1705 		return 0;
1706 	case VHOST_SET_FEATURES:
1707 		if (copy_from_user(&features, featurep, sizeof features))
1708 			return -EFAULT;
1709 		if (features & ~VHOST_NET_FEATURES)
1710 			return -EOPNOTSUPP;
1711 		return vhost_net_set_features(n, features);
1712 	case VHOST_GET_BACKEND_FEATURES:
1713 		features = VHOST_NET_BACKEND_FEATURES;
1714 		if (copy_to_user(featurep, &features, sizeof(features)))
1715 			return -EFAULT;
1716 		return 0;
1717 	case VHOST_SET_BACKEND_FEATURES:
1718 		if (copy_from_user(&features, featurep, sizeof(features)))
1719 			return -EFAULT;
1720 		if (features & ~VHOST_NET_BACKEND_FEATURES)
1721 			return -EOPNOTSUPP;
1722 		vhost_set_backend_features(&n->dev, features);
1723 		return 0;
1724 	case VHOST_RESET_OWNER:
1725 		return vhost_net_reset_owner(n);
1726 	case VHOST_SET_OWNER:
1727 		return vhost_net_set_owner(n);
1728 	default:
1729 		mutex_lock(&n->dev.mutex);
1730 		r = vhost_dev_ioctl(&n->dev, ioctl, argp);
1731 		if (r == -ENOIOCTLCMD)
1732 			r = vhost_vring_ioctl(&n->dev, ioctl, argp);
1733 		else
1734 			vhost_net_flush(n);
1735 		mutex_unlock(&n->dev.mutex);
1736 		return r;
1737 	}
1738 }
1739 
1740 static ssize_t vhost_net_chr_read_iter(struct kiocb *iocb, struct iov_iter *to)
1741 {
1742 	struct file *file = iocb->ki_filp;
1743 	struct vhost_net *n = file->private_data;
1744 	struct vhost_dev *dev = &n->dev;
1745 	int noblock = file->f_flags & O_NONBLOCK;
1746 
1747 	return vhost_chr_read_iter(dev, to, noblock);
1748 }
1749 
1750 static ssize_t vhost_net_chr_write_iter(struct kiocb *iocb,
1751 					struct iov_iter *from)
1752 {
1753 	struct file *file = iocb->ki_filp;
1754 	struct vhost_net *n = file->private_data;
1755 	struct vhost_dev *dev = &n->dev;
1756 
1757 	return vhost_chr_write_iter(dev, from);
1758 }
1759 
1760 static __poll_t vhost_net_chr_poll(struct file *file, poll_table *wait)
1761 {
1762 	struct vhost_net *n = file->private_data;
1763 	struct vhost_dev *dev = &n->dev;
1764 
1765 	return vhost_chr_poll(file, dev, wait);
1766 }
1767 
1768 static const struct file_operations vhost_net_fops = {
1769 	.owner          = THIS_MODULE,
1770 	.release        = vhost_net_release,
1771 	.read_iter      = vhost_net_chr_read_iter,
1772 	.write_iter     = vhost_net_chr_write_iter,
1773 	.poll           = vhost_net_chr_poll,
1774 	.unlocked_ioctl = vhost_net_ioctl,
1775 	.compat_ioctl   = compat_ptr_ioctl,
1776 	.open           = vhost_net_open,
1777 	.llseek		= noop_llseek,
1778 };
1779 
1780 static struct miscdevice vhost_net_misc = {
1781 	.minor = VHOST_NET_MINOR,
1782 	.name = "vhost-net",
1783 	.fops = &vhost_net_fops,
1784 };
1785 
1786 static int vhost_net_init(void)
1787 {
1788 	if (experimental_zcopytx)
1789 		vhost_net_enable_zcopy(VHOST_NET_VQ_TX);
1790 	return misc_register(&vhost_net_misc);
1791 }
1792 module_init(vhost_net_init);
1793 
1794 static void vhost_net_exit(void)
1795 {
1796 	misc_deregister(&vhost_net_misc);
1797 }
1798 module_exit(vhost_net_exit);
1799 
1800 MODULE_VERSION("0.0.1");
1801 MODULE_LICENSE("GPL v2");
1802 MODULE_AUTHOR("Michael S. Tsirkin");
1803 MODULE_DESCRIPTION("Host kernel accelerator for virtio net");
1804 MODULE_ALIAS_MISCDEV(VHOST_NET_MINOR);
1805 MODULE_ALIAS("devname:vhost-net");
1806