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/mmu_context.h>
14 #include <linux/miscdevice.h>
15 #include <linux/module.h>
16 #include <linux/mutex.h>
17 #include <linux/workqueue.h>
18 #include <linux/rcupdate.h>
19 #include <linux/file.h>
20 #include <linux/slab.h>
22 #include <linux/net.h>
23 #include <linux/if_packet.h>
24 #include <linux/if_arp.h>
25 #include <linux/if_tun.h>
26 #include <linux/if_macvlan.h>
32 /* Max number of bytes transferred before requeueing the job.
33 * Using this limit prevents one virtqueue from starving others. */
34 #define VHOST_NET_WEIGHT 0x80000
42 enum vhost_net_poll_state {
43 VHOST_NET_POLL_DISABLED = 0,
44 VHOST_NET_POLL_STARTED = 1,
45 VHOST_NET_POLL_STOPPED = 2,
50 struct vhost_virtqueue vqs[VHOST_NET_VQ_MAX];
51 struct vhost_poll poll[VHOST_NET_VQ_MAX];
52 /* Tells us whether we are polling a socket for TX.
53 * We only do this when socket buffer fills up.
54 * Protected by tx vq lock. */
55 enum vhost_net_poll_state tx_poll_state;
58 /* Pop first len bytes from iovec. Return number of segments used. */
59 static int move_iovec_hdr(struct iovec *from, struct iovec *to,
60 size_t len, int iov_count)
64 while (len && seg < iov_count) {
65 size = min(from->iov_len, len);
66 to->iov_base = from->iov_base;
68 from->iov_len -= size;
69 from->iov_base += size;
77 /* Copy iovec entries for len bytes from iovec. */
78 static void copy_iovec_hdr(const struct iovec *from, struct iovec *to,
79 size_t len, int iovcount)
83 while (len && seg < iovcount) {
84 size = min(from->iov_len, len);
85 to->iov_base = from->iov_base;
94 /* Caller must have TX VQ lock */
95 static void tx_poll_stop(struct vhost_net *net)
97 if (likely(net->tx_poll_state != VHOST_NET_POLL_STARTED))
99 vhost_poll_stop(net->poll + VHOST_NET_VQ_TX);
100 net->tx_poll_state = VHOST_NET_POLL_STOPPED;
103 /* Caller must have TX VQ lock */
104 static void tx_poll_start(struct vhost_net *net, struct socket *sock)
106 if (unlikely(net->tx_poll_state != VHOST_NET_POLL_STOPPED))
108 vhost_poll_start(net->poll + VHOST_NET_VQ_TX, sock->file);
109 net->tx_poll_state = VHOST_NET_POLL_STARTED;
112 /* Expects to be always run from workqueue - which acts as
113 * read-size critical section for our kind of RCU. */
114 static void handle_tx(struct vhost_net *net)
116 struct vhost_virtqueue *vq = &net->dev.vqs[VHOST_NET_VQ_TX];
119 struct msghdr msg = {
125 .msg_flags = MSG_DONTWAIT,
127 size_t len, total_len = 0;
130 struct socket *sock = rcu_dereference(vq->private_data);
134 wmem = atomic_read(&sock->sk->sk_wmem_alloc);
135 if (wmem >= sock->sk->sk_sndbuf) {
136 mutex_lock(&vq->mutex);
137 tx_poll_start(net, sock);
138 mutex_unlock(&vq->mutex);
143 mutex_lock(&vq->mutex);
144 vhost_disable_notify(vq);
146 if (wmem < sock->sk->sk_sndbuf / 2)
148 hdr_size = vq->vhost_hlen;
151 head = vhost_get_vq_desc(&net->dev, vq, vq->iov,
155 /* On error, stop handling until the next kick. */
156 if (unlikely(head < 0))
158 /* Nothing new? Wait for eventfd to tell us they refilled. */
159 if (head == vq->num) {
160 wmem = atomic_read(&sock->sk->sk_wmem_alloc);
161 if (wmem >= sock->sk->sk_sndbuf * 3 / 4) {
162 tx_poll_start(net, sock);
163 set_bit(SOCK_ASYNC_NOSPACE, &sock->flags);
166 if (unlikely(vhost_enable_notify(vq))) {
167 vhost_disable_notify(vq);
173 vq_err(vq, "Unexpected descriptor format for TX: "
174 "out %d, int %d\n", out, in);
177 /* Skip header. TODO: support TSO. */
178 s = move_iovec_hdr(vq->iov, vq->hdr, hdr_size, out);
179 msg.msg_iovlen = out;
180 len = iov_length(vq->iov, out);
183 vq_err(vq, "Unexpected header len for TX: "
184 "%zd expected %zd\n",
185 iov_length(vq->hdr, s), hdr_size);
188 /* TODO: Check specific error and bomb out unless ENOBUFS? */
189 err = sock->ops->sendmsg(NULL, sock, &msg, len);
190 if (unlikely(err < 0)) {
191 vhost_discard_vq_desc(vq, 1);
192 tx_poll_start(net, sock);
196 pr_debug("Truncated TX packet: "
197 " len %d != %zd\n", err, len);
198 vhost_add_used_and_signal(&net->dev, vq, head, 0);
200 if (unlikely(total_len >= VHOST_NET_WEIGHT)) {
201 vhost_poll_queue(&vq->poll);
206 mutex_unlock(&vq->mutex);
207 unuse_mm(net->dev.mm);
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(headcount >= VHOST_NET_MAX_SG)) {
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 struct socket *sock = rcu_dereference(vq->private_data);
309 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);
391 unuse_mm(net->dev.mm);
394 /* Expects to be always run from workqueue - which acts as
395 * read-size critical section for our kind of RCU. */
396 static void handle_rx_mergeable(struct vhost_net *net)
398 struct vhost_virtqueue *vq = &net->dev.vqs[VHOST_NET_VQ_RX];
399 unsigned uninitialized_var(in), log;
400 struct vhost_log *vq_log;
401 struct msghdr msg = {
404 .msg_control = NULL, /* FIXME: get and handle RX aux data. */
407 .msg_flags = MSG_DONTWAIT,
410 struct virtio_net_hdr_mrg_rxbuf hdr = {
412 .hdr.gso_type = VIRTIO_NET_HDR_GSO_NONE
415 size_t total_len = 0;
417 size_t vhost_hlen, sock_hlen;
418 size_t vhost_len, sock_len;
419 struct socket *sock = rcu_dereference(vq->private_data);
420 if (!sock || skb_queue_empty(&sock->sk->sk_receive_queue))
424 mutex_lock(&vq->mutex);
425 vhost_disable_notify(vq);
426 vhost_hlen = vq->vhost_hlen;
427 sock_hlen = vq->sock_hlen;
429 vq_log = unlikely(vhost_has_feature(&net->dev, VHOST_F_LOG_ALL)) ?
432 while ((sock_len = peek_head_len(sock->sk))) {
433 sock_len += sock_hlen;
434 vhost_len = sock_len + vhost_hlen;
435 headcount = get_rx_bufs(vq, vq->heads, vhost_len,
437 /* On error, stop handling until the next kick. */
438 if (unlikely(headcount < 0))
440 /* OK, now we need to know about added descriptors. */
442 if (unlikely(vhost_enable_notify(vq))) {
443 /* They have slipped one in as we were
444 * doing that: check again. */
445 vhost_disable_notify(vq);
448 /* Nothing new? Wait for eventfd to tell us
452 /* We don't need to be notified again. */
453 if (unlikely((vhost_hlen)))
454 /* Skip header. TODO: support TSO. */
455 move_iovec_hdr(vq->iov, vq->hdr, vhost_hlen, in);
457 /* Copy the header for use in VIRTIO_NET_F_MRG_RXBUF:
458 * needed because sendmsg can modify msg_iov. */
459 copy_iovec_hdr(vq->iov, vq->hdr, sock_hlen, in);
461 err = sock->ops->recvmsg(NULL, sock, &msg,
462 sock_len, MSG_DONTWAIT | MSG_TRUNC);
463 /* Userspace might have consumed the packet meanwhile:
464 * it's not supposed to do this usually, but might be hard
465 * to prevent. Discard data we got (if any) and keep going. */
466 if (unlikely(err != sock_len)) {
467 pr_debug("Discarded rx packet: "
468 " len %d, expected %zd\n", err, sock_len);
469 vhost_discard_vq_desc(vq, headcount);
472 if (unlikely(vhost_hlen) &&
473 memcpy_toiovecend(vq->hdr, (unsigned char *)&hdr, 0,
475 vq_err(vq, "Unable to write vnet_hdr at addr %p\n",
479 /* TODO: Should check and handle checksum. */
480 if (vhost_has_feature(&net->dev, VIRTIO_NET_F_MRG_RXBUF) &&
481 memcpy_toiovecend(vq->hdr, (unsigned char *)&headcount,
482 offsetof(typeof(hdr), num_buffers),
483 sizeof hdr.num_buffers)) {
484 vq_err(vq, "Failed num_buffers write");
485 vhost_discard_vq_desc(vq, headcount);
488 vhost_add_used_and_signal_n(&net->dev, vq, vq->heads,
490 if (unlikely(vq_log))
491 vhost_log_write(vq, vq_log, log, vhost_len);
492 total_len += vhost_len;
493 if (unlikely(total_len >= VHOST_NET_WEIGHT)) {
494 vhost_poll_queue(&vq->poll);
499 mutex_unlock(&vq->mutex);
500 unuse_mm(net->dev.mm);
503 static void handle_rx(struct vhost_net *net)
505 if (vhost_has_feature(&net->dev, VIRTIO_NET_F_MRG_RXBUF))
506 handle_rx_mergeable(net);
511 static void handle_tx_kick(struct vhost_work *work)
513 struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
515 struct vhost_net *net = container_of(vq->dev, struct vhost_net, dev);
520 static void handle_rx_kick(struct vhost_work *work)
522 struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
524 struct vhost_net *net = container_of(vq->dev, struct vhost_net, dev);
529 static void handle_tx_net(struct vhost_work *work)
531 struct vhost_net *net = container_of(work, struct vhost_net,
532 poll[VHOST_NET_VQ_TX].work);
536 static void handle_rx_net(struct vhost_work *work)
538 struct vhost_net *net = container_of(work, struct vhost_net,
539 poll[VHOST_NET_VQ_RX].work);
543 static int vhost_net_open(struct inode *inode, struct file *f)
545 struct vhost_net *n = kmalloc(sizeof *n, GFP_KERNEL);
546 struct vhost_dev *dev;
553 n->vqs[VHOST_NET_VQ_TX].handle_kick = handle_tx_kick;
554 n->vqs[VHOST_NET_VQ_RX].handle_kick = handle_rx_kick;
555 r = vhost_dev_init(dev, n->vqs, VHOST_NET_VQ_MAX);
561 vhost_poll_init(n->poll + VHOST_NET_VQ_TX, handle_tx_net, POLLOUT, dev);
562 vhost_poll_init(n->poll + VHOST_NET_VQ_RX, handle_rx_net, POLLIN, dev);
563 n->tx_poll_state = VHOST_NET_POLL_DISABLED;
570 static void vhost_net_disable_vq(struct vhost_net *n,
571 struct vhost_virtqueue *vq)
573 if (!vq->private_data)
575 if (vq == n->vqs + VHOST_NET_VQ_TX) {
577 n->tx_poll_state = VHOST_NET_POLL_DISABLED;
579 vhost_poll_stop(n->poll + VHOST_NET_VQ_RX);
582 static void vhost_net_enable_vq(struct vhost_net *n,
583 struct vhost_virtqueue *vq)
585 struct socket *sock = vq->private_data;
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 = vq->private_data;
602 vhost_net_disable_vq(n, vq);
603 rcu_assign_pointer(vq->private_data, NULL);
604 mutex_unlock(&vq->mutex);
608 static void vhost_net_stop(struct vhost_net *n, struct socket **tx_sock,
609 struct socket **rx_sock)
611 *tx_sock = vhost_net_stop_vq(n, n->vqs + VHOST_NET_VQ_TX);
612 *rx_sock = vhost_net_stop_vq(n, n->vqs + VHOST_NET_VQ_RX);
615 static void vhost_net_flush_vq(struct vhost_net *n, int index)
617 vhost_poll_flush(n->poll + index);
618 vhost_poll_flush(&n->dev.vqs[index].poll);
621 static void vhost_net_flush(struct vhost_net *n)
623 vhost_net_flush_vq(n, VHOST_NET_VQ_TX);
624 vhost_net_flush_vq(n, VHOST_NET_VQ_RX);
627 static int vhost_net_release(struct inode *inode, struct file *f)
629 struct vhost_net *n = f->private_data;
630 struct socket *tx_sock;
631 struct socket *rx_sock;
633 vhost_net_stop(n, &tx_sock, &rx_sock);
635 vhost_dev_cleanup(&n->dev);
640 /* We do an extra flush before freeing memory,
641 * since jobs can re-queue themselves. */
647 static struct socket *get_raw_socket(int fd)
650 struct sockaddr_ll sa;
651 char buf[MAX_ADDR_LEN];
653 int uaddr_len = sizeof uaddr, r;
654 struct socket *sock = sockfd_lookup(fd, &r);
656 return ERR_PTR(-ENOTSOCK);
658 /* Parameter checking */
659 if (sock->sk->sk_type != SOCK_RAW) {
660 r = -ESOCKTNOSUPPORT;
664 r = sock->ops->getname(sock, (struct sockaddr *)&uaddr.sa,
669 if (uaddr.sa.sll_family != AF_PACKET) {
679 static struct socket *get_tap_socket(int fd)
681 struct file *file = fget(fd);
684 return ERR_PTR(-EBADF);
685 sock = tun_get_socket(file);
688 sock = macvtap_get_socket(file);
694 static struct socket *get_socket(int fd)
697 /* special case to disable backend */
700 sock = get_raw_socket(fd);
703 sock = get_tap_socket(fd);
706 return ERR_PTR(-ENOTSOCK);
709 static long vhost_net_set_backend(struct vhost_net *n, unsigned index, int fd)
711 struct socket *sock, *oldsock;
712 struct vhost_virtqueue *vq;
715 mutex_lock(&n->dev.mutex);
716 r = vhost_dev_check_owner(&n->dev);
720 if (index >= VHOST_NET_VQ_MAX) {
725 mutex_lock(&vq->mutex);
727 /* Verify that ring has been setup correctly. */
728 if (!vhost_vq_access_ok(vq)) {
732 sock = get_socket(fd);
738 /* start polling new socket */
739 oldsock = vq->private_data;
740 if (sock != oldsock) {
741 vhost_net_disable_vq(n, vq);
742 rcu_assign_pointer(vq->private_data, sock);
743 vhost_net_enable_vq(n, vq);
746 mutex_unlock(&vq->mutex);
749 vhost_net_flush_vq(n, index);
753 mutex_unlock(&n->dev.mutex);
757 mutex_unlock(&vq->mutex);
759 mutex_unlock(&n->dev.mutex);
763 static long vhost_net_reset_owner(struct vhost_net *n)
765 struct socket *tx_sock = NULL;
766 struct socket *rx_sock = NULL;
768 mutex_lock(&n->dev.mutex);
769 err = vhost_dev_check_owner(&n->dev);
772 vhost_net_stop(n, &tx_sock, &rx_sock);
774 err = vhost_dev_reset_owner(&n->dev);
776 mutex_unlock(&n->dev.mutex);
784 static int vhost_net_set_features(struct vhost_net *n, u64 features)
786 size_t vhost_hlen, sock_hlen, hdr_len;
789 hdr_len = (features & (1 << VIRTIO_NET_F_MRG_RXBUF)) ?
790 sizeof(struct virtio_net_hdr_mrg_rxbuf) :
791 sizeof(struct virtio_net_hdr);
792 if (features & (1 << VHOST_NET_F_VIRTIO_NET_HDR)) {
793 /* vhost provides vnet_hdr */
794 vhost_hlen = hdr_len;
797 /* socket provides vnet_hdr */
801 mutex_lock(&n->dev.mutex);
802 if ((features & (1 << VHOST_F_LOG_ALL)) &&
803 !vhost_log_access_ok(&n->dev)) {
804 mutex_unlock(&n->dev.mutex);
807 n->dev.acked_features = features;
809 for (i = 0; i < VHOST_NET_VQ_MAX; ++i) {
810 mutex_lock(&n->vqs[i].mutex);
811 n->vqs[i].vhost_hlen = vhost_hlen;
812 n->vqs[i].sock_hlen = sock_hlen;
813 mutex_unlock(&n->vqs[i].mutex);
816 mutex_unlock(&n->dev.mutex);
820 static long vhost_net_ioctl(struct file *f, unsigned int ioctl,
823 struct vhost_net *n = f->private_data;
824 void __user *argp = (void __user *)arg;
825 u64 __user *featurep = argp;
826 struct vhost_vring_file backend;
830 case VHOST_NET_SET_BACKEND:
831 if (copy_from_user(&backend, argp, sizeof backend))
833 return vhost_net_set_backend(n, backend.index, backend.fd);
834 case VHOST_GET_FEATURES:
835 features = VHOST_FEATURES;
836 if (copy_to_user(featurep, &features, sizeof features))
839 case VHOST_SET_FEATURES:
840 if (copy_from_user(&features, featurep, sizeof features))
842 if (features & ~VHOST_FEATURES)
844 return vhost_net_set_features(n, features);
845 case VHOST_RESET_OWNER:
846 return vhost_net_reset_owner(n);
848 mutex_lock(&n->dev.mutex);
849 r = vhost_dev_ioctl(&n->dev, ioctl, arg);
851 mutex_unlock(&n->dev.mutex);
857 static long vhost_net_compat_ioctl(struct file *f, unsigned int ioctl,
860 return vhost_net_ioctl(f, ioctl, (unsigned long)compat_ptr(arg));
864 static const struct file_operations vhost_net_fops = {
865 .owner = THIS_MODULE,
866 .release = vhost_net_release,
867 .unlocked_ioctl = vhost_net_ioctl,
869 .compat_ioctl = vhost_net_compat_ioctl,
871 .open = vhost_net_open,
874 static struct miscdevice vhost_net_misc = {
880 static int vhost_net_init(void)
882 return misc_register(&vhost_net_misc);
884 module_init(vhost_net_init);
886 static void vhost_net_exit(void)
888 misc_deregister(&vhost_net_misc);
890 module_exit(vhost_net_exit);
892 MODULE_VERSION("0.0.1");
893 MODULE_LICENSE("GPL v2");
894 MODULE_AUTHOR("Michael S. Tsirkin");
895 MODULE_DESCRIPTION("Host kernel accelerator for virtio net");