1 /* Copyright (C) 2009 Red Hat, Inc.
4 * This work is licensed under the terms of the GNU GPL, version 2.
6 * virtio-net server in host kernel.
9 #include <linux/compat.h>
10 #include <linux/eventfd.h>
11 #include <linux/vhost.h>
12 #include <linux/virtio_net.h>
13 #include <linux/miscdevice.h>
14 #include <linux/module.h>
15 #include <linux/mutex.h>
16 #include <linux/workqueue.h>
17 #include <linux/rcupdate.h>
18 #include <linux/file.h>
19 #include <linux/slab.h>
21 #include <linux/net.h>
22 #include <linux/if_packet.h>
23 #include <linux/if_arp.h>
24 #include <linux/if_tun.h>
25 #include <linux/if_macvlan.h>
31 /* Max number of bytes transferred before requeueing the job.
32 * Using this limit prevents one virtqueue from starving others. */
33 #define VHOST_NET_WEIGHT 0x80000
41 enum vhost_net_poll_state {
42 VHOST_NET_POLL_DISABLED = 0,
43 VHOST_NET_POLL_STARTED = 1,
44 VHOST_NET_POLL_STOPPED = 2,
49 struct vhost_virtqueue vqs[VHOST_NET_VQ_MAX];
50 struct vhost_poll poll[VHOST_NET_VQ_MAX];
51 /* Tells us whether we are polling a socket for TX.
52 * We only do this when socket buffer fills up.
53 * Protected by tx vq lock. */
54 enum vhost_net_poll_state tx_poll_state;
57 /* Pop first len bytes from iovec. Return number of segments used. */
58 static int move_iovec_hdr(struct iovec *from, struct iovec *to,
59 size_t len, int iov_count)
63 while (len && seg < iov_count) {
64 size = min(from->iov_len, len);
65 to->iov_base = from->iov_base;
67 from->iov_len -= size;
68 from->iov_base += size;
76 /* Copy iovec entries for len bytes from iovec. */
77 static void copy_iovec_hdr(const struct iovec *from, struct iovec *to,
78 size_t len, int iovcount)
82 while (len && seg < iovcount) {
83 size = min(from->iov_len, len);
84 to->iov_base = from->iov_base;
93 /* Caller must have TX VQ lock */
94 static void tx_poll_stop(struct vhost_net *net)
96 if (likely(net->tx_poll_state != VHOST_NET_POLL_STARTED))
98 vhost_poll_stop(net->poll + VHOST_NET_VQ_TX);
99 net->tx_poll_state = VHOST_NET_POLL_STOPPED;
102 /* Caller must have TX VQ lock */
103 static void tx_poll_start(struct vhost_net *net, struct socket *sock)
105 if (unlikely(net->tx_poll_state != VHOST_NET_POLL_STOPPED))
107 vhost_poll_start(net->poll + VHOST_NET_VQ_TX, sock->file);
108 net->tx_poll_state = VHOST_NET_POLL_STARTED;
111 /* Expects to be always run from workqueue - which acts as
112 * read-size critical section for our kind of RCU. */
113 static void handle_tx(struct vhost_net *net)
115 struct vhost_virtqueue *vq = &net->dev.vqs[VHOST_NET_VQ_TX];
118 struct msghdr msg = {
124 .msg_flags = MSG_DONTWAIT,
126 size_t len, total_len = 0;
131 /* TODO: check that we are running from vhost_worker? */
132 sock = rcu_dereference_check(vq->private_data, 1);
136 wmem = atomic_read(&sock->sk->sk_wmem_alloc);
137 if (wmem >= sock->sk->sk_sndbuf) {
138 mutex_lock(&vq->mutex);
139 tx_poll_start(net, sock);
140 mutex_unlock(&vq->mutex);
144 mutex_lock(&vq->mutex);
145 vhost_disable_notify(vq);
147 if (wmem < sock->sk->sk_sndbuf / 2)
149 hdr_size = vq->vhost_hlen;
152 head = vhost_get_vq_desc(&net->dev, vq, vq->iov,
156 /* On error, stop handling until the next kick. */
157 if (unlikely(head < 0))
159 /* Nothing new? Wait for eventfd to tell us they refilled. */
160 if (head == vq->num) {
161 wmem = atomic_read(&sock->sk->sk_wmem_alloc);
162 if (wmem >= sock->sk->sk_sndbuf * 3 / 4) {
163 tx_poll_start(net, sock);
164 set_bit(SOCK_ASYNC_NOSPACE, &sock->flags);
167 if (unlikely(vhost_enable_notify(vq))) {
168 vhost_disable_notify(vq);
174 vq_err(vq, "Unexpected descriptor format for TX: "
175 "out %d, int %d\n", out, in);
178 /* Skip header. TODO: support TSO. */
179 s = move_iovec_hdr(vq->iov, vq->hdr, hdr_size, out);
180 msg.msg_iovlen = out;
181 len = iov_length(vq->iov, out);
184 vq_err(vq, "Unexpected header len for TX: "
185 "%zd expected %zd\n",
186 iov_length(vq->hdr, s), hdr_size);
189 /* TODO: Check specific error and bomb out unless ENOBUFS? */
190 err = sock->ops->sendmsg(NULL, sock, &msg, len);
191 if (unlikely(err < 0)) {
192 vhost_discard_vq_desc(vq, 1);
193 tx_poll_start(net, sock);
197 pr_debug("Truncated TX packet: "
198 " len %d != %zd\n", err, len);
199 vhost_add_used_and_signal(&net->dev, vq, head, 0);
201 if (unlikely(total_len >= VHOST_NET_WEIGHT)) {
202 vhost_poll_queue(&vq->poll);
207 mutex_unlock(&vq->mutex);
210 static int peek_head_len(struct sock *sk)
212 struct sk_buff *head;
216 head = skb_peek(&sk->sk_receive_queue);
223 /* This is a multi-buffer version of vhost_get_desc, that works if
224 * vq has read descriptors only.
225 * @vq - the relevant virtqueue
226 * @datalen - data length we'll be reading
227 * @iovcount - returned count of io vectors we fill
229 * @log_num - log offset
230 * returns number of buffer heads allocated, negative on error
232 static int get_rx_bufs(struct vhost_virtqueue *vq,
233 struct vring_used_elem *heads,
236 struct vhost_log *log,
239 unsigned int out, in;
245 while (datalen > 0) {
246 if (unlikely(seg >= UIO_MAXIOV)) {
250 d = vhost_get_vq_desc(vq->dev, vq, vq->iov + seg,
251 ARRAY_SIZE(vq->iov) - seg, &out,
257 if (unlikely(out || in <= 0)) {
258 vq_err(vq, "unexpected descriptor format for RX: "
259 "out %d, in %d\n", out, in);
267 heads[headcount].id = d;
268 heads[headcount].len = iov_length(vq->iov + seg, in);
269 datalen -= heads[headcount].len;
273 heads[headcount - 1].len += datalen;
279 vhost_discard_vq_desc(vq, headcount);
283 /* Expects to be always run from workqueue - which acts as
284 * read-size critical section for our kind of RCU. */
285 static void handle_rx_big(struct vhost_net *net)
287 struct vhost_virtqueue *vq = &net->dev.vqs[VHOST_NET_VQ_RX];
288 unsigned out, in, log, s;
290 struct vhost_log *vq_log;
291 struct msghdr msg = {
294 .msg_control = NULL, /* FIXME: get and handle RX aux data. */
297 .msg_flags = MSG_DONTWAIT,
300 struct virtio_net_hdr hdr = {
302 .gso_type = VIRTIO_NET_HDR_GSO_NONE
305 size_t len, total_len = 0;
308 /* TODO: check that we are running from vhost_worker? */
309 struct socket *sock = rcu_dereference_check(vq->private_data, 1);
310 if (!sock || skb_queue_empty(&sock->sk->sk_receive_queue))
313 mutex_lock(&vq->mutex);
314 vhost_disable_notify(vq);
315 hdr_size = vq->vhost_hlen;
317 vq_log = unlikely(vhost_has_feature(&net->dev, VHOST_F_LOG_ALL)) ?
321 head = vhost_get_vq_desc(&net->dev, vq, vq->iov,
325 /* On error, stop handling until the next kick. */
326 if (unlikely(head < 0))
328 /* OK, now we need to know about added descriptors. */
329 if (head == vq->num) {
330 if (unlikely(vhost_enable_notify(vq))) {
331 /* They have slipped one in as we were
332 * doing that: check again. */
333 vhost_disable_notify(vq);
336 /* Nothing new? Wait for eventfd to tell us
340 /* We don't need to be notified again. */
342 vq_err(vq, "Unexpected descriptor format for RX: "
347 /* Skip header. TODO: support TSO/mergeable rx buffers. */
348 s = move_iovec_hdr(vq->iov, vq->hdr, hdr_size, in);
350 len = iov_length(vq->iov, in);
353 vq_err(vq, "Unexpected header len for RX: "
354 "%zd expected %zd\n",
355 iov_length(vq->hdr, s), hdr_size);
358 err = sock->ops->recvmsg(NULL, sock, &msg,
359 len, MSG_DONTWAIT | MSG_TRUNC);
360 /* TODO: Check specific error and bomb out unless EAGAIN? */
362 vhost_discard_vq_desc(vq, 1);
365 /* TODO: Should check and handle checksum. */
367 pr_debug("Discarded truncated rx packet: "
368 " len %d > %zd\n", err, len);
369 vhost_discard_vq_desc(vq, 1);
373 err = memcpy_toiovec(vq->hdr, (unsigned char *)&hdr, hdr_size);
375 vq_err(vq, "Unable to write vnet_hdr at addr %p: %d\n",
376 vq->iov->iov_base, err);
380 vhost_add_used_and_signal(&net->dev, vq, head, len);
381 if (unlikely(vq_log))
382 vhost_log_write(vq, vq_log, log, len);
384 if (unlikely(total_len >= VHOST_NET_WEIGHT)) {
385 vhost_poll_queue(&vq->poll);
390 mutex_unlock(&vq->mutex);
393 /* Expects to be always run from workqueue - which acts as
394 * read-size critical section for our kind of RCU. */
395 static void handle_rx_mergeable(struct vhost_net *net)
397 struct vhost_virtqueue *vq = &net->dev.vqs[VHOST_NET_VQ_RX];
398 unsigned uninitialized_var(in), log;
399 struct vhost_log *vq_log;
400 struct msghdr msg = {
403 .msg_control = NULL, /* FIXME: get and handle RX aux data. */
406 .msg_flags = MSG_DONTWAIT,
409 struct virtio_net_hdr_mrg_rxbuf hdr = {
411 .hdr.gso_type = VIRTIO_NET_HDR_GSO_NONE
414 size_t total_len = 0;
416 size_t vhost_hlen, sock_hlen;
417 size_t vhost_len, sock_len;
418 /* TODO: check that we are running from vhost_worker? */
419 struct socket *sock = rcu_dereference_check(vq->private_data, 1);
420 if (!sock || skb_queue_empty(&sock->sk->sk_receive_queue))
423 mutex_lock(&vq->mutex);
424 vhost_disable_notify(vq);
425 vhost_hlen = vq->vhost_hlen;
426 sock_hlen = vq->sock_hlen;
428 vq_log = unlikely(vhost_has_feature(&net->dev, VHOST_F_LOG_ALL)) ?
431 while ((sock_len = peek_head_len(sock->sk))) {
432 sock_len += sock_hlen;
433 vhost_len = sock_len + vhost_hlen;
434 headcount = get_rx_bufs(vq, vq->heads, vhost_len,
436 /* On error, stop handling until the next kick. */
437 if (unlikely(headcount < 0))
439 /* OK, now we need to know about added descriptors. */
441 if (unlikely(vhost_enable_notify(vq))) {
442 /* They have slipped one in as we were
443 * doing that: check again. */
444 vhost_disable_notify(vq);
447 /* Nothing new? Wait for eventfd to tell us
451 /* We don't need to be notified again. */
452 if (unlikely((vhost_hlen)))
453 /* Skip header. TODO: support TSO. */
454 move_iovec_hdr(vq->iov, vq->hdr, vhost_hlen, in);
456 /* Copy the header for use in VIRTIO_NET_F_MRG_RXBUF:
457 * needed because recvmsg can modify msg_iov. */
458 copy_iovec_hdr(vq->iov, vq->hdr, sock_hlen, in);
460 err = sock->ops->recvmsg(NULL, sock, &msg,
461 sock_len, MSG_DONTWAIT | MSG_TRUNC);
462 /* Userspace might have consumed the packet meanwhile:
463 * it's not supposed to do this usually, but might be hard
464 * to prevent. Discard data we got (if any) and keep going. */
465 if (unlikely(err != sock_len)) {
466 pr_debug("Discarded rx packet: "
467 " len %d, expected %zd\n", err, sock_len);
468 vhost_discard_vq_desc(vq, headcount);
471 if (unlikely(vhost_hlen) &&
472 memcpy_toiovecend(vq->hdr, (unsigned char *)&hdr, 0,
474 vq_err(vq, "Unable to write vnet_hdr at addr %p\n",
478 /* TODO: Should check and handle checksum. */
479 if (vhost_has_feature(&net->dev, VIRTIO_NET_F_MRG_RXBUF) &&
480 memcpy_toiovecend(vq->hdr, (unsigned char *)&headcount,
481 offsetof(typeof(hdr), num_buffers),
482 sizeof hdr.num_buffers)) {
483 vq_err(vq, "Failed num_buffers write");
484 vhost_discard_vq_desc(vq, headcount);
487 vhost_add_used_and_signal_n(&net->dev, vq, vq->heads,
489 if (unlikely(vq_log))
490 vhost_log_write(vq, vq_log, log, vhost_len);
491 total_len += vhost_len;
492 if (unlikely(total_len >= VHOST_NET_WEIGHT)) {
493 vhost_poll_queue(&vq->poll);
498 mutex_unlock(&vq->mutex);
501 static void handle_rx(struct vhost_net *net)
503 if (vhost_has_feature(&net->dev, VIRTIO_NET_F_MRG_RXBUF))
504 handle_rx_mergeable(net);
509 static void handle_tx_kick(struct vhost_work *work)
511 struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
513 struct vhost_net *net = container_of(vq->dev, struct vhost_net, dev);
518 static void handle_rx_kick(struct vhost_work *work)
520 struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
522 struct vhost_net *net = container_of(vq->dev, struct vhost_net, dev);
527 static void handle_tx_net(struct vhost_work *work)
529 struct vhost_net *net = container_of(work, struct vhost_net,
530 poll[VHOST_NET_VQ_TX].work);
534 static void handle_rx_net(struct vhost_work *work)
536 struct vhost_net *net = container_of(work, struct vhost_net,
537 poll[VHOST_NET_VQ_RX].work);
541 static int vhost_net_open(struct inode *inode, struct file *f)
543 struct vhost_net *n = kmalloc(sizeof *n, GFP_KERNEL);
544 struct vhost_dev *dev;
551 n->vqs[VHOST_NET_VQ_TX].handle_kick = handle_tx_kick;
552 n->vqs[VHOST_NET_VQ_RX].handle_kick = handle_rx_kick;
553 r = vhost_dev_init(dev, n->vqs, VHOST_NET_VQ_MAX);
559 vhost_poll_init(n->poll + VHOST_NET_VQ_TX, handle_tx_net, POLLOUT, dev);
560 vhost_poll_init(n->poll + VHOST_NET_VQ_RX, handle_rx_net, POLLIN, dev);
561 n->tx_poll_state = VHOST_NET_POLL_DISABLED;
568 static void vhost_net_disable_vq(struct vhost_net *n,
569 struct vhost_virtqueue *vq)
571 if (!vq->private_data)
573 if (vq == n->vqs + VHOST_NET_VQ_TX) {
575 n->tx_poll_state = VHOST_NET_POLL_DISABLED;
577 vhost_poll_stop(n->poll + VHOST_NET_VQ_RX);
580 static void vhost_net_enable_vq(struct vhost_net *n,
581 struct vhost_virtqueue *vq)
585 sock = rcu_dereference_protected(vq->private_data,
586 lockdep_is_held(&vq->mutex));
589 if (vq == n->vqs + VHOST_NET_VQ_TX) {
590 n->tx_poll_state = VHOST_NET_POLL_STOPPED;
591 tx_poll_start(n, sock);
593 vhost_poll_start(n->poll + VHOST_NET_VQ_RX, sock->file);
596 static struct socket *vhost_net_stop_vq(struct vhost_net *n,
597 struct vhost_virtqueue *vq)
601 mutex_lock(&vq->mutex);
602 sock = rcu_dereference_protected(vq->private_data,
603 lockdep_is_held(&vq->mutex));
604 vhost_net_disable_vq(n, vq);
605 rcu_assign_pointer(vq->private_data, NULL);
606 mutex_unlock(&vq->mutex);
610 static void vhost_net_stop(struct vhost_net *n, struct socket **tx_sock,
611 struct socket **rx_sock)
613 *tx_sock = vhost_net_stop_vq(n, n->vqs + VHOST_NET_VQ_TX);
614 *rx_sock = vhost_net_stop_vq(n, n->vqs + VHOST_NET_VQ_RX);
617 static void vhost_net_flush_vq(struct vhost_net *n, int index)
619 vhost_poll_flush(n->poll + index);
620 vhost_poll_flush(&n->dev.vqs[index].poll);
623 static void vhost_net_flush(struct vhost_net *n)
625 vhost_net_flush_vq(n, VHOST_NET_VQ_TX);
626 vhost_net_flush_vq(n, VHOST_NET_VQ_RX);
629 static int vhost_net_release(struct inode *inode, struct file *f)
631 struct vhost_net *n = f->private_data;
632 struct socket *tx_sock;
633 struct socket *rx_sock;
635 vhost_net_stop(n, &tx_sock, &rx_sock);
637 vhost_dev_cleanup(&n->dev);
642 /* We do an extra flush before freeing memory,
643 * since jobs can re-queue themselves. */
649 static struct socket *get_raw_socket(int fd)
652 struct sockaddr_ll sa;
653 char buf[MAX_ADDR_LEN];
655 int uaddr_len = sizeof uaddr, r;
656 struct socket *sock = sockfd_lookup(fd, &r);
658 return ERR_PTR(-ENOTSOCK);
660 /* Parameter checking */
661 if (sock->sk->sk_type != SOCK_RAW) {
662 r = -ESOCKTNOSUPPORT;
666 r = sock->ops->getname(sock, (struct sockaddr *)&uaddr.sa,
671 if (uaddr.sa.sll_family != AF_PACKET) {
681 static struct socket *get_tap_socket(int fd)
683 struct file *file = fget(fd);
686 return ERR_PTR(-EBADF);
687 sock = tun_get_socket(file);
690 sock = macvtap_get_socket(file);
696 static struct socket *get_socket(int fd)
699 /* special case to disable backend */
702 sock = get_raw_socket(fd);
705 sock = get_tap_socket(fd);
708 return ERR_PTR(-ENOTSOCK);
711 static long vhost_net_set_backend(struct vhost_net *n, unsigned index, int fd)
713 struct socket *sock, *oldsock;
714 struct vhost_virtqueue *vq;
717 mutex_lock(&n->dev.mutex);
718 r = vhost_dev_check_owner(&n->dev);
722 if (index >= VHOST_NET_VQ_MAX) {
727 mutex_lock(&vq->mutex);
729 /* Verify that ring has been setup correctly. */
730 if (!vhost_vq_access_ok(vq)) {
734 sock = get_socket(fd);
740 /* start polling new socket */
741 oldsock = rcu_dereference_protected(vq->private_data,
742 lockdep_is_held(&vq->mutex));
743 if (sock != oldsock) {
744 vhost_net_disable_vq(n, vq);
745 rcu_assign_pointer(vq->private_data, sock);
746 vhost_net_enable_vq(n, vq);
749 mutex_unlock(&vq->mutex);
752 vhost_net_flush_vq(n, index);
756 mutex_unlock(&n->dev.mutex);
760 mutex_unlock(&vq->mutex);
762 mutex_unlock(&n->dev.mutex);
766 static long vhost_net_reset_owner(struct vhost_net *n)
768 struct socket *tx_sock = NULL;
769 struct socket *rx_sock = NULL;
771 mutex_lock(&n->dev.mutex);
772 err = vhost_dev_check_owner(&n->dev);
775 vhost_net_stop(n, &tx_sock, &rx_sock);
777 err = vhost_dev_reset_owner(&n->dev);
779 mutex_unlock(&n->dev.mutex);
787 static int vhost_net_set_features(struct vhost_net *n, u64 features)
789 size_t vhost_hlen, sock_hlen, hdr_len;
792 hdr_len = (features & (1 << VIRTIO_NET_F_MRG_RXBUF)) ?
793 sizeof(struct virtio_net_hdr_mrg_rxbuf) :
794 sizeof(struct virtio_net_hdr);
795 if (features & (1 << VHOST_NET_F_VIRTIO_NET_HDR)) {
796 /* vhost provides vnet_hdr */
797 vhost_hlen = hdr_len;
800 /* socket provides vnet_hdr */
804 mutex_lock(&n->dev.mutex);
805 if ((features & (1 << VHOST_F_LOG_ALL)) &&
806 !vhost_log_access_ok(&n->dev)) {
807 mutex_unlock(&n->dev.mutex);
810 n->dev.acked_features = features;
812 for (i = 0; i < VHOST_NET_VQ_MAX; ++i) {
813 mutex_lock(&n->vqs[i].mutex);
814 n->vqs[i].vhost_hlen = vhost_hlen;
815 n->vqs[i].sock_hlen = sock_hlen;
816 mutex_unlock(&n->vqs[i].mutex);
819 mutex_unlock(&n->dev.mutex);
823 static long vhost_net_ioctl(struct file *f, unsigned int ioctl,
826 struct vhost_net *n = f->private_data;
827 void __user *argp = (void __user *)arg;
828 u64 __user *featurep = argp;
829 struct vhost_vring_file backend;
833 case VHOST_NET_SET_BACKEND:
834 if (copy_from_user(&backend, argp, sizeof backend))
836 return vhost_net_set_backend(n, backend.index, backend.fd);
837 case VHOST_GET_FEATURES:
838 features = VHOST_FEATURES;
839 if (copy_to_user(featurep, &features, sizeof features))
842 case VHOST_SET_FEATURES:
843 if (copy_from_user(&features, featurep, sizeof features))
845 if (features & ~VHOST_FEATURES)
847 return vhost_net_set_features(n, features);
848 case VHOST_RESET_OWNER:
849 return vhost_net_reset_owner(n);
851 mutex_lock(&n->dev.mutex);
852 r = vhost_dev_ioctl(&n->dev, ioctl, arg);
854 mutex_unlock(&n->dev.mutex);
860 static long vhost_net_compat_ioctl(struct file *f, unsigned int ioctl,
863 return vhost_net_ioctl(f, ioctl, (unsigned long)compat_ptr(arg));
867 static const struct file_operations vhost_net_fops = {
868 .owner = THIS_MODULE,
869 .release = vhost_net_release,
870 .unlocked_ioctl = vhost_net_ioctl,
872 .compat_ioctl = vhost_net_compat_ioctl,
874 .open = vhost_net_open,
875 .llseek = noop_llseek,
878 static struct miscdevice vhost_net_misc = {
884 static int vhost_net_init(void)
886 return misc_register(&vhost_net_misc);
888 module_init(vhost_net_init);
890 static void vhost_net_exit(void)
892 misc_deregister(&vhost_net_misc);
894 module_exit(vhost_net_exit);
896 MODULE_VERSION("0.0.1");
897 MODULE_LICENSE("GPL v2");
898 MODULE_AUTHOR("Michael S. Tsirkin");
899 MODULE_DESCRIPTION("Host kernel accelerator for virtio net");