1 /* Copyright (C) 2009 Red Hat, Inc.
2 * Author: Michael S. Tsirkin <mst@redhat.com>
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 * Not sure it's worth it, it's straight-forward enough. */
133 sock = rcu_dereference_check(vq->private_data, 1);
137 wmem = atomic_read(&sock->sk->sk_wmem_alloc);
138 if (wmem >= sock->sk->sk_sndbuf) {
139 mutex_lock(&vq->mutex);
140 tx_poll_start(net, sock);
141 mutex_unlock(&vq->mutex);
145 mutex_lock(&vq->mutex);
146 vhost_disable_notify(vq);
148 if (wmem < sock->sk->sk_sndbuf / 2)
150 hdr_size = vq->vhost_hlen;
153 head = vhost_get_vq_desc(&net->dev, vq, vq->iov,
157 /* On error, stop handling until the next kick. */
158 if (unlikely(head < 0))
160 /* Nothing new? Wait for eventfd to tell us they refilled. */
161 if (head == vq->num) {
162 wmem = atomic_read(&sock->sk->sk_wmem_alloc);
163 if (wmem >= sock->sk->sk_sndbuf * 3 / 4) {
164 tx_poll_start(net, sock);
165 set_bit(SOCK_ASYNC_NOSPACE, &sock->flags);
168 if (unlikely(vhost_enable_notify(vq))) {
169 vhost_disable_notify(vq);
175 vq_err(vq, "Unexpected descriptor format for TX: "
176 "out %d, int %d\n", out, in);
179 /* Skip header. TODO: support TSO. */
180 s = move_iovec_hdr(vq->iov, vq->hdr, hdr_size, out);
181 msg.msg_iovlen = out;
182 len = iov_length(vq->iov, out);
185 vq_err(vq, "Unexpected header len for TX: "
186 "%zd expected %zd\n",
187 iov_length(vq->hdr, s), hdr_size);
190 /* TODO: Check specific error and bomb out unless ENOBUFS? */
191 err = sock->ops->sendmsg(NULL, sock, &msg, len);
192 if (unlikely(err < 0)) {
193 vhost_discard_vq_desc(vq, 1);
194 tx_poll_start(net, sock);
198 pr_debug("Truncated TX packet: "
199 " len %d != %zd\n", err, len);
200 vhost_add_used_and_signal(&net->dev, vq, head, 0);
202 if (unlikely(total_len >= VHOST_NET_WEIGHT)) {
203 vhost_poll_queue(&vq->poll);
208 mutex_unlock(&vq->mutex);
211 static int peek_head_len(struct sock *sk)
213 struct sk_buff *head;
217 head = skb_peek(&sk->sk_receive_queue);
224 /* This is a multi-buffer version of vhost_get_desc, that works if
225 * vq has read descriptors only.
226 * @vq - the relevant virtqueue
227 * @datalen - data length we'll be reading
228 * @iovcount - returned count of io vectors we fill
230 * @log_num - log offset
231 * returns number of buffer heads allocated, negative on error
233 static int get_rx_bufs(struct vhost_virtqueue *vq,
234 struct vring_used_elem *heads,
237 struct vhost_log *log,
240 unsigned int out, in;
246 while (datalen > 0) {
247 if (unlikely(seg >= UIO_MAXIOV)) {
251 d = vhost_get_vq_desc(vq->dev, vq, vq->iov + seg,
252 ARRAY_SIZE(vq->iov) - seg, &out,
258 if (unlikely(out || in <= 0)) {
259 vq_err(vq, "unexpected descriptor format for RX: "
260 "out %d, in %d\n", out, in);
268 heads[headcount].id = d;
269 heads[headcount].len = iov_length(vq->iov + seg, in);
270 datalen -= heads[headcount].len;
274 heads[headcount - 1].len += datalen;
280 vhost_discard_vq_desc(vq, headcount);
284 /* Expects to be always run from workqueue - which acts as
285 * read-size critical section for our kind of RCU. */
286 static void handle_rx_big(struct vhost_net *net)
288 struct vhost_virtqueue *vq = &net->dev.vqs[VHOST_NET_VQ_RX];
289 unsigned out, in, log, s;
291 struct vhost_log *vq_log;
292 struct msghdr msg = {
295 .msg_control = NULL, /* FIXME: get and handle RX aux data. */
298 .msg_flags = MSG_DONTWAIT,
301 struct virtio_net_hdr hdr = {
303 .gso_type = VIRTIO_NET_HDR_GSO_NONE
306 size_t len, total_len = 0;
309 struct socket *sock = rcu_dereference(vq->private_data);
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 struct socket *sock = rcu_dereference(vq->private_data);
419 if (!sock || skb_queue_empty(&sock->sk->sk_receive_queue))
422 mutex_lock(&vq->mutex);
423 vhost_disable_notify(vq);
424 vhost_hlen = vq->vhost_hlen;
425 sock_hlen = vq->sock_hlen;
427 vq_log = unlikely(vhost_has_feature(&net->dev, VHOST_F_LOG_ALL)) ?
430 while ((sock_len = peek_head_len(sock->sk))) {
431 sock_len += sock_hlen;
432 vhost_len = sock_len + vhost_hlen;
433 headcount = get_rx_bufs(vq, vq->heads, vhost_len,
435 /* On error, stop handling until the next kick. */
436 if (unlikely(headcount < 0))
438 /* OK, now we need to know about added descriptors. */
440 if (unlikely(vhost_enable_notify(vq))) {
441 /* They have slipped one in as we were
442 * doing that: check again. */
443 vhost_disable_notify(vq);
446 /* Nothing new? Wait for eventfd to tell us
450 /* We don't need to be notified again. */
451 if (unlikely((vhost_hlen)))
452 /* Skip header. TODO: support TSO. */
453 move_iovec_hdr(vq->iov, vq->hdr, vhost_hlen, in);
455 /* Copy the header for use in VIRTIO_NET_F_MRG_RXBUF:
456 * needed because recvmsg can modify msg_iov. */
457 copy_iovec_hdr(vq->iov, vq->hdr, sock_hlen, in);
459 err = sock->ops->recvmsg(NULL, sock, &msg,
460 sock_len, MSG_DONTWAIT | MSG_TRUNC);
461 /* Userspace might have consumed the packet meanwhile:
462 * it's not supposed to do this usually, but might be hard
463 * to prevent. Discard data we got (if any) and keep going. */
464 if (unlikely(err != sock_len)) {
465 pr_debug("Discarded rx packet: "
466 " len %d, expected %zd\n", err, sock_len);
467 vhost_discard_vq_desc(vq, headcount);
470 if (unlikely(vhost_hlen) &&
471 memcpy_toiovecend(vq->hdr, (unsigned char *)&hdr, 0,
473 vq_err(vq, "Unable to write vnet_hdr at addr %p\n",
477 /* TODO: Should check and handle checksum. */
478 if (vhost_has_feature(&net->dev, VIRTIO_NET_F_MRG_RXBUF) &&
479 memcpy_toiovecend(vq->hdr, (unsigned char *)&headcount,
480 offsetof(typeof(hdr), num_buffers),
481 sizeof hdr.num_buffers)) {
482 vq_err(vq, "Failed num_buffers write");
483 vhost_discard_vq_desc(vq, headcount);
486 vhost_add_used_and_signal_n(&net->dev, vq, vq->heads,
488 if (unlikely(vq_log))
489 vhost_log_write(vq, vq_log, log, vhost_len);
490 total_len += vhost_len;
491 if (unlikely(total_len >= VHOST_NET_WEIGHT)) {
492 vhost_poll_queue(&vq->poll);
497 mutex_unlock(&vq->mutex);
500 static void handle_rx(struct vhost_net *net)
502 if (vhost_has_feature(&net->dev, VIRTIO_NET_F_MRG_RXBUF))
503 handle_rx_mergeable(net);
508 static void handle_tx_kick(struct vhost_work *work)
510 struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
512 struct vhost_net *net = container_of(vq->dev, struct vhost_net, dev);
517 static void handle_rx_kick(struct vhost_work *work)
519 struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
521 struct vhost_net *net = container_of(vq->dev, struct vhost_net, dev);
526 static void handle_tx_net(struct vhost_work *work)
528 struct vhost_net *net = container_of(work, struct vhost_net,
529 poll[VHOST_NET_VQ_TX].work);
533 static void handle_rx_net(struct vhost_work *work)
535 struct vhost_net *net = container_of(work, struct vhost_net,
536 poll[VHOST_NET_VQ_RX].work);
540 static int vhost_net_open(struct inode *inode, struct file *f)
542 struct vhost_net *n = kmalloc(sizeof *n, GFP_KERNEL);
543 struct vhost_dev *dev;
550 n->vqs[VHOST_NET_VQ_TX].handle_kick = handle_tx_kick;
551 n->vqs[VHOST_NET_VQ_RX].handle_kick = handle_rx_kick;
552 r = vhost_dev_init(dev, n->vqs, VHOST_NET_VQ_MAX);
558 vhost_poll_init(n->poll + VHOST_NET_VQ_TX, handle_tx_net, POLLOUT, dev);
559 vhost_poll_init(n->poll + VHOST_NET_VQ_RX, handle_rx_net, POLLIN, dev);
560 n->tx_poll_state = VHOST_NET_POLL_DISABLED;
567 static void vhost_net_disable_vq(struct vhost_net *n,
568 struct vhost_virtqueue *vq)
570 if (!vq->private_data)
572 if (vq == n->vqs + VHOST_NET_VQ_TX) {
574 n->tx_poll_state = VHOST_NET_POLL_DISABLED;
576 vhost_poll_stop(n->poll + VHOST_NET_VQ_RX);
579 static void vhost_net_enable_vq(struct vhost_net *n,
580 struct vhost_virtqueue *vq)
584 sock = rcu_dereference_protected(vq->private_data,
585 lockdep_is_held(&vq->mutex));
588 if (vq == n->vqs + VHOST_NET_VQ_TX) {
589 n->tx_poll_state = VHOST_NET_POLL_STOPPED;
590 tx_poll_start(n, sock);
592 vhost_poll_start(n->poll + VHOST_NET_VQ_RX, sock->file);
595 static struct socket *vhost_net_stop_vq(struct vhost_net *n,
596 struct vhost_virtqueue *vq)
600 mutex_lock(&vq->mutex);
601 sock = rcu_dereference_protected(vq->private_data,
602 lockdep_is_held(&vq->mutex));
603 vhost_net_disable_vq(n, vq);
604 rcu_assign_pointer(vq->private_data, NULL);
605 mutex_unlock(&vq->mutex);
609 static void vhost_net_stop(struct vhost_net *n, struct socket **tx_sock,
610 struct socket **rx_sock)
612 *tx_sock = vhost_net_stop_vq(n, n->vqs + VHOST_NET_VQ_TX);
613 *rx_sock = vhost_net_stop_vq(n, n->vqs + VHOST_NET_VQ_RX);
616 static void vhost_net_flush_vq(struct vhost_net *n, int index)
618 vhost_poll_flush(n->poll + index);
619 vhost_poll_flush(&n->dev.vqs[index].poll);
622 static void vhost_net_flush(struct vhost_net *n)
624 vhost_net_flush_vq(n, VHOST_NET_VQ_TX);
625 vhost_net_flush_vq(n, VHOST_NET_VQ_RX);
628 static int vhost_net_release(struct inode *inode, struct file *f)
630 struct vhost_net *n = f->private_data;
631 struct socket *tx_sock;
632 struct socket *rx_sock;
634 vhost_net_stop(n, &tx_sock, &rx_sock);
636 vhost_dev_cleanup(&n->dev);
641 /* We do an extra flush before freeing memory,
642 * since jobs can re-queue themselves. */
648 static struct socket *get_raw_socket(int fd)
651 struct sockaddr_ll sa;
652 char buf[MAX_ADDR_LEN];
654 int uaddr_len = sizeof uaddr, r;
655 struct socket *sock = sockfd_lookup(fd, &r);
657 return ERR_PTR(-ENOTSOCK);
659 /* Parameter checking */
660 if (sock->sk->sk_type != SOCK_RAW) {
661 r = -ESOCKTNOSUPPORT;
665 r = sock->ops->getname(sock, (struct sockaddr *)&uaddr.sa,
670 if (uaddr.sa.sll_family != AF_PACKET) {
680 static struct socket *get_tap_socket(int fd)
682 struct file *file = fget(fd);
685 return ERR_PTR(-EBADF);
686 sock = tun_get_socket(file);
689 sock = macvtap_get_socket(file);
695 static struct socket *get_socket(int fd)
698 /* special case to disable backend */
701 sock = get_raw_socket(fd);
704 sock = get_tap_socket(fd);
707 return ERR_PTR(-ENOTSOCK);
710 static long vhost_net_set_backend(struct vhost_net *n, unsigned index, int fd)
712 struct socket *sock, *oldsock;
713 struct vhost_virtqueue *vq;
716 mutex_lock(&n->dev.mutex);
717 r = vhost_dev_check_owner(&n->dev);
721 if (index >= VHOST_NET_VQ_MAX) {
726 mutex_lock(&vq->mutex);
728 /* Verify that ring has been setup correctly. */
729 if (!vhost_vq_access_ok(vq)) {
733 sock = get_socket(fd);
739 /* start polling new socket */
740 oldsock = rcu_dereference_protected(vq->private_data,
741 lockdep_is_held(&vq->mutex));
742 if (sock != oldsock) {
743 vhost_net_disable_vq(n, vq);
744 rcu_assign_pointer(vq->private_data, sock);
745 vhost_net_enable_vq(n, vq);
748 mutex_unlock(&vq->mutex);
751 vhost_net_flush_vq(n, index);
755 mutex_unlock(&n->dev.mutex);
759 mutex_unlock(&vq->mutex);
761 mutex_unlock(&n->dev.mutex);
765 static long vhost_net_reset_owner(struct vhost_net *n)
767 struct socket *tx_sock = NULL;
768 struct socket *rx_sock = NULL;
770 mutex_lock(&n->dev.mutex);
771 err = vhost_dev_check_owner(&n->dev);
774 vhost_net_stop(n, &tx_sock, &rx_sock);
776 err = vhost_dev_reset_owner(&n->dev);
778 mutex_unlock(&n->dev.mutex);
786 static int vhost_net_set_features(struct vhost_net *n, u64 features)
788 size_t vhost_hlen, sock_hlen, hdr_len;
791 hdr_len = (features & (1 << VIRTIO_NET_F_MRG_RXBUF)) ?
792 sizeof(struct virtio_net_hdr_mrg_rxbuf) :
793 sizeof(struct virtio_net_hdr);
794 if (features & (1 << VHOST_NET_F_VIRTIO_NET_HDR)) {
795 /* vhost provides vnet_hdr */
796 vhost_hlen = hdr_len;
799 /* socket provides vnet_hdr */
803 mutex_lock(&n->dev.mutex);
804 if ((features & (1 << VHOST_F_LOG_ALL)) &&
805 !vhost_log_access_ok(&n->dev)) {
806 mutex_unlock(&n->dev.mutex);
809 n->dev.acked_features = features;
811 for (i = 0; i < VHOST_NET_VQ_MAX; ++i) {
812 mutex_lock(&n->vqs[i].mutex);
813 n->vqs[i].vhost_hlen = vhost_hlen;
814 n->vqs[i].sock_hlen = sock_hlen;
815 mutex_unlock(&n->vqs[i].mutex);
818 mutex_unlock(&n->dev.mutex);
822 static long vhost_net_ioctl(struct file *f, unsigned int ioctl,
825 struct vhost_net *n = f->private_data;
826 void __user *argp = (void __user *)arg;
827 u64 __user *featurep = argp;
828 struct vhost_vring_file backend;
832 case VHOST_NET_SET_BACKEND:
833 if (copy_from_user(&backend, argp, sizeof backend))
835 return vhost_net_set_backend(n, backend.index, backend.fd);
836 case VHOST_GET_FEATURES:
837 features = VHOST_FEATURES;
838 if (copy_to_user(featurep, &features, sizeof features))
841 case VHOST_SET_FEATURES:
842 if (copy_from_user(&features, featurep, sizeof features))
844 if (features & ~VHOST_FEATURES)
846 return vhost_net_set_features(n, features);
847 case VHOST_RESET_OWNER:
848 return vhost_net_reset_owner(n);
850 mutex_lock(&n->dev.mutex);
851 r = vhost_dev_ioctl(&n->dev, ioctl, arg);
853 mutex_unlock(&n->dev.mutex);
859 static long vhost_net_compat_ioctl(struct file *f, unsigned int ioctl,
862 return vhost_net_ioctl(f, ioctl, (unsigned long)compat_ptr(arg));
866 static const struct file_operations vhost_net_fops = {
867 .owner = THIS_MODULE,
868 .release = vhost_net_release,
869 .unlocked_ioctl = vhost_net_ioctl,
871 .compat_ioctl = vhost_net_compat_ioctl,
873 .open = vhost_net_open,
874 .llseek = noop_llseek,
877 static struct miscdevice vhost_net_misc = {
883 static int vhost_net_init(void)
885 return misc_register(&vhost_net_misc);
887 module_init(vhost_net_init);
889 static void vhost_net_exit(void)
891 misc_deregister(&vhost_net_misc);
893 module_exit(vhost_net_exit);
895 MODULE_VERSION("0.0.1");
896 MODULE_LICENSE("GPL v2");
897 MODULE_AUTHOR("Michael S. Tsirkin");
898 MODULE_DESCRIPTION("Host kernel accelerator for virtio net");