4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of version 2 of the GNU General Public License as
8 * published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
18 * The full GNU General Public License is included in this distribution
19 * in the file called LICENSE.GPL.
21 * Contact Information:
25 #include <linux/module.h>
26 #include <linux/net.h>
28 #include <linux/virtio_net.h>
29 #include <linux/wait.h>
31 #include <linux/nsproxy.h>
32 #include <linux/sched.h>
33 #include <linux/if_tun.h>
34 #include <linux/version.h>
35 #include <linux/file.h>
43 #if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 7, 0)
44 static int kni_sock_map_fd(struct socket *sock)
47 int fd = get_unused_fd_flags(0);
52 file = sock_alloc_file(sock, 0, NULL);
61 #define kni_sock_map_fd(s) sock_map_fd(s, 0)
64 static struct proto kni_raw_proto = {
67 .obj_size = sizeof(struct kni_vhost_queue),
71 kni_vhost_net_tx(struct kni_dev *kni, struct msghdr *m,
72 unsigned int offset, unsigned int len)
74 struct rte_kni_mbuf *pkt_kva = NULL;
75 struct rte_kni_mbuf *pkt_va = NULL;
78 KNI_DBG_TX("tx offset=%d, len=%d, iovlen=%d\n",
79 #ifdef HAVE_IOV_ITER_MSGHDR
80 offset, len, (int)m->msg_iter.iov->iov_len);
82 offset, len, (int)m->msg_iov->iov_len);
86 * Check if it has at least one free entry in tx_q and
87 * one entry in alloc_q.
89 if (kni_fifo_free_count(kni->tx_q) == 0 ||
90 kni_fifo_count(kni->alloc_q) == 0) {
92 * If no free entry in tx_q or no entry in alloc_q,
93 * drops skb and goes out.
98 /* dequeue a mbuf from alloc_q */
99 ret = kni_fifo_get(kni->alloc_q, (void **)&pkt_va, 1);
100 if (likely(ret == 1)) {
103 pkt_kva = (void *)pkt_va - kni->mbuf_va + kni->mbuf_kva;
104 data_kva = pkt_kva->buf_addr + pkt_kva->data_off
105 - kni->mbuf_va + kni->mbuf_kva;
107 #ifdef HAVE_IOV_ITER_MSGHDR
108 copy_from_iter(data_kva, len, &m->msg_iter);
110 memcpy_fromiovecend(data_kva, m->msg_iov, offset, len);
113 if (unlikely(len < ETH_ZLEN)) {
114 memset(data_kva + len, 0, ETH_ZLEN - len);
117 pkt_kva->pkt_len = len;
118 pkt_kva->data_len = len;
120 /* enqueue mbuf into tx_q */
121 ret = kni_fifo_put(kni->tx_q, (void **)&pkt_va, 1);
122 if (unlikely(ret != 1)) {
123 /* Failing should not happen */
124 KNI_ERR("Fail to enqueue mbuf into tx_q\n");
128 /* Failing should not happen */
129 KNI_ERR("Fail to dequeue mbuf from alloc_q\n");
133 /* update statistics */
134 kni->stats.tx_bytes += len;
135 kni->stats.tx_packets++;
140 /* update statistics */
141 kni->stats.tx_dropped++;
147 kni_vhost_net_rx(struct kni_dev *kni, struct msghdr *m,
148 unsigned int offset, unsigned int len)
151 struct rte_kni_mbuf *kva;
152 struct rte_kni_mbuf *va;
155 struct kni_vhost_queue *q = kni->vhost_queue;
157 if (unlikely(q == NULL))
160 /* ensure at least one entry in free_q */
161 if (unlikely(kni_fifo_free_count(kni->free_q) == 0))
164 skb = skb_dequeue(&q->sk.sk_receive_queue);
165 if (unlikely(skb == NULL))
168 kva = (struct rte_kni_mbuf *)skb->data;
170 /* free skb to cache */
172 if (unlikely(kni_fifo_put(q->fifo, (void **)&skb, 1) != 1))
173 /* Failing should not happen */
174 KNI_ERR("Fail to enqueue entries into rx cache fifo\n");
176 pkt_len = kva->data_len;
177 if (unlikely(pkt_len > len))
180 KNI_DBG_RX("rx offset=%d, len=%d, pkt_len=%d, iovlen=%d\n",
181 #ifdef HAVE_IOV_ITER_MSGHDR
182 offset, len, pkt_len, (int)m->msg_iter.iov->iov_len);
184 offset, len, pkt_len, (int)m->msg_iov->iov_len);
187 data_kva = kva->buf_addr + kva->data_off - kni->mbuf_va + kni->mbuf_kva;
188 #ifdef HAVE_IOV_ITER_MSGHDR
189 if (unlikely(copy_to_iter(data_kva, pkt_len, &m->msg_iter)))
191 if (unlikely(memcpy_toiovecend(m->msg_iov, data_kva, offset, pkt_len)))
195 /* Update statistics */
196 kni->stats.rx_bytes += pkt_len;
197 kni->stats.rx_packets++;
199 /* enqueue mbufs into free_q */
200 va = (void *)kva - kni->mbuf_kva + kni->mbuf_va;
201 if (unlikely(kni_fifo_put(kni->free_q, (void **)&va, 1) != 1))
202 /* Failing should not happen */
203 KNI_ERR("Fail to enqueue entries into free_q\n");
205 KNI_DBG_RX("receive done %d\n", pkt_len);
210 /* Update drop statistics */
211 kni->stats.rx_dropped++;
217 kni_sock_poll(struct file *file, struct socket *sock, poll_table *wait)
219 struct kni_vhost_queue *q =
220 container_of(sock->sk, struct kni_vhost_queue, sk);
222 unsigned int mask = 0;
224 if (unlikely(q == NULL || q->kni == NULL))
228 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 35)
229 KNI_DBG("start kni_poll on group %d, wq 0x%16llx\n",
230 kni->group_id, (uint64_t)sock->wq);
232 KNI_DBG("start kni_poll on group %d, wait at 0x%16llx\n",
233 kni->group_id, (uint64_t)&sock->wait);
236 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 35)
237 poll_wait(file, &sock->wq->wait, wait);
239 poll_wait(file, &sock->wait, wait);
242 if (kni_fifo_count(kni->rx_q) > 0)
243 mask |= POLLIN | POLLRDNORM;
245 if (sock_writeable(&q->sk) ||
246 #ifdef SOCKWQ_ASYNC_NOSPACE
247 (!test_and_set_bit(SOCKWQ_ASYNC_NOSPACE, &q->sock->flags) &&
248 sock_writeable(&q->sk)))
250 (!test_and_set_bit(SOCK_ASYNC_NOSPACE, &q->sock->flags) &&
251 sock_writeable(&q->sk)))
253 mask |= POLLOUT | POLLWRNORM;
259 kni_vhost_enqueue(struct kni_dev *kni, struct kni_vhost_queue *q,
260 struct sk_buff *skb, struct rte_kni_mbuf *va)
262 struct rte_kni_mbuf *kva;
264 kva = (void *)(va) - kni->mbuf_va + kni->mbuf_kva;
265 (skb)->data = (unsigned char *)kva;
266 (skb)->len = kva->data_len;
267 skb_queue_tail(&q->sk.sk_receive_queue, skb);
271 kni_vhost_enqueue_burst(struct kni_dev *kni, struct kni_vhost_queue *q,
272 struct sk_buff **skb, struct rte_kni_mbuf **va)
276 for (i = 0; i < RX_BURST_SZ; skb++, va++, i++)
277 kni_vhost_enqueue(kni, q, *skb, *va);
281 kni_chk_vhost_rx(struct kni_dev *kni)
283 struct kni_vhost_queue *q = kni->vhost_queue;
284 unsigned int nb_in, nb_mbuf, nb_skb;
285 const unsigned int BURST_MASK = RX_BURST_SZ - 1;
286 unsigned int nb_burst, nb_backlog, i;
287 struct sk_buff *skb[RX_BURST_SZ];
288 struct rte_kni_mbuf *va[RX_BURST_SZ];
290 if (unlikely(BE_STOP & kni->vq_status)) {
291 kni->vq_status |= BE_FINISH;
295 if (unlikely(q == NULL))
298 nb_skb = kni_fifo_count(q->fifo);
299 nb_mbuf = kni_fifo_count(kni->rx_q);
301 nb_in = min(nb_mbuf, nb_skb);
302 nb_in = min_t(unsigned int, nb_in, RX_BURST_SZ);
303 nb_burst = (nb_in & ~BURST_MASK);
304 nb_backlog = (nb_in & BURST_MASK);
306 /* enqueue skb_queue per BURST_SIZE bulk */
308 if (unlikely(kni_fifo_get(kni->rx_q, (void **)&va, RX_BURST_SZ)
312 if (unlikely(kni_fifo_get(q->fifo, (void **)&skb, RX_BURST_SZ)
316 kni_vhost_enqueue_burst(kni, q, skb, va);
319 /* all leftover, do one by one */
320 for (i = 0; i < nb_backlog; ++i) {
321 if (unlikely(kni_fifo_get(kni->rx_q, (void **)&va, 1) != 1))
324 if (unlikely(kni_fifo_get(q->fifo, (void **)&skb, 1) != 1))
327 kni_vhost_enqueue(kni, q, *skb, *va);
330 /* Ondemand wake up */
331 if ((nb_in == RX_BURST_SZ) || (nb_skb == 0) ||
332 ((nb_mbuf < RX_BURST_SZ) && (nb_mbuf != 0))) {
333 wake_up_interruptible_poll(sk_sleep(&q->sk),
334 POLLIN | POLLRDNORM | POLLRDBAND);
335 KNI_DBG_RX("RX CHK KICK nb_mbuf %d, nb_skb %d, nb_in %d\n",
336 nb_mbuf, nb_skb, nb_in);
342 /* Failing should not happen */
343 KNI_ERR("Fail to enqueue fifo, it shouldn't happen\n");
350 #ifdef HAVE_KIOCB_MSG_PARAM
351 kni_sock_sndmsg(struct kiocb *iocb, struct socket *sock,
352 struct msghdr *m, size_t total_len)
354 kni_sock_sndmsg(struct socket *sock,
355 struct msghdr *m, size_t total_len)
356 #endif /* HAVE_KIOCB_MSG_PARAM */
358 struct kni_vhost_queue *q =
359 container_of(sock->sk, struct kni_vhost_queue, sk);
360 int vnet_hdr_len = 0;
361 unsigned long len = total_len;
363 if (unlikely(q == NULL || q->kni == NULL))
366 KNI_DBG_TX("kni_sndmsg len %ld, flags 0x%08x, nb_iov %d\n",
367 #ifdef HAVE_IOV_ITER_MSGHDR
368 len, q->flags, (int)m->msg_iter.iov->iov_len);
370 len, q->flags, (int)m->msg_iovlen);
373 #ifdef RTE_KNI_VHOST_VNET_HDR_EN
374 if (likely(q->flags & IFF_VNET_HDR)) {
375 vnet_hdr_len = q->vnet_hdr_sz;
376 if (unlikely(len < vnet_hdr_len))
382 if (unlikely(len < ETH_HLEN + q->vnet_hdr_sz))
385 return kni_vhost_net_tx(q->kni, m, vnet_hdr_len, len);
389 #ifdef HAVE_KIOCB_MSG_PARAM
390 kni_sock_rcvmsg(struct kiocb *iocb, struct socket *sock,
391 struct msghdr *m, size_t len, int flags)
393 kni_sock_rcvmsg(struct socket *sock,
394 struct msghdr *m, size_t len, int flags)
395 #endif /* HAVE_KIOCB_MSG_PARAM */
397 int vnet_hdr_len = 0;
399 struct kni_vhost_queue *q =
400 container_of(sock->sk, struct kni_vhost_queue, sk);
401 static struct virtio_net_hdr
402 __attribute__ ((unused)) vnet_hdr = {
404 .gso_type = VIRTIO_NET_HDR_GSO_NONE
407 if (unlikely(q == NULL || q->kni == NULL))
410 #ifdef RTE_KNI_VHOST_VNET_HDR_EN
411 if (likely(q->flags & IFF_VNET_HDR)) {
412 vnet_hdr_len = q->vnet_hdr_sz;
419 pkt_len = kni_vhost_net_rx(q->kni, m, vnet_hdr_len, len);
420 if (unlikely(pkt_len == 0))
423 #ifdef RTE_KNI_VHOST_VNET_HDR_EN
424 /* no need to copy hdr when no pkt received */
425 #ifdef HAVE_IOV_ITER_MSGHDR
426 if (unlikely(copy_to_iter((void *)&vnet_hdr, vnet_hdr_len,
429 if (unlikely(memcpy_toiovecend(m->msg_iov,
430 (void *)&vnet_hdr, 0, vnet_hdr_len)))
431 #endif /* HAVE_IOV_ITER_MSGHDR */
433 #endif /* RTE_KNI_VHOST_VNET_HDR_EN */
434 KNI_DBG_RX("kni_rcvmsg expect_len %ld, flags 0x%08x, pkt_len %d\n",
435 (unsigned long)len, q->flags, pkt_len);
437 return pkt_len + vnet_hdr_len;
440 /* dummy tap like ioctl */
442 kni_sock_ioctl(struct socket *sock, unsigned int cmd,
445 void __user *argp = (void __user *)arg;
446 struct ifreq __user *ifr = argp;
447 unsigned int __user *up = argp;
448 struct kni_vhost_queue *q =
449 container_of(sock->sk, struct kni_vhost_queue, sk);
452 int __user *sp = argp;
456 KNI_DBG("tap ioctl cmd 0x%08x\n", cmd);
460 KNI_DBG("TUNSETIFF\n");
461 /* ignore the name, just look at flags */
462 if (get_user(u, &ifr->ifr_flags))
466 if ((u & ~IFF_VNET_HDR) != (IFF_NO_PI | IFF_TAP))
474 KNI_DBG("TUNGETIFF\n");
476 kni = rcu_dereference_bh(q->kni);
478 dev_hold(kni->net_dev);
479 rcu_read_unlock_bh();
485 if (copy_to_user(&ifr->ifr_name, kni->net_dev->name, IFNAMSIZ)
486 || put_user(q->flags, &ifr->ifr_flags))
488 dev_put(kni->net_dev);
492 KNI_DBG("TUNGETFEATURES\n");
493 u = IFF_TAP | IFF_NO_PI;
494 #ifdef RTE_KNI_VHOST_VNET_HDR_EN
502 KNI_DBG("TUNSETSNDBUF\n");
509 case TUNGETVNETHDRSZ:
513 KNI_DBG("TUNGETVNETHDRSZ %d\n", s);
516 case TUNSETVNETHDRSZ:
519 if (s < (int)sizeof(struct virtio_net_hdr))
522 KNI_DBG("TUNSETVNETHDRSZ %d\n", s);
527 KNI_DBG("TUNSETOFFLOAD %lx\n", arg);
528 #ifdef RTE_KNI_VHOST_VNET_HDR_EN
529 /* not support any offload yet */
530 if (!(q->flags & IFF_VNET_HDR))
539 KNI_DBG("NOT SUPPORT\n");
545 kni_sock_compat_ioctl(struct socket *sock, unsigned int cmd,
548 /* 32 bits app on 64 bits OS to be supported later */
549 KNI_PRINT("Not implemented.\n");
554 #define KNI_VHOST_WAIT_WQ_SAFE() \
556 while ((BE_FINISH | BE_STOP) == kni->vq_status) \
562 kni_sock_release(struct socket *sock)
564 struct kni_vhost_queue *q =
565 container_of(sock->sk, struct kni_vhost_queue, sk);
573 kni->vq_status = BE_STOP;
574 KNI_VHOST_WAIT_WQ_SAFE();
575 kni->vhost_queue = NULL;
582 sk_set_socket(&q->sk, NULL);
587 KNI_DBG("dummy sock release done\n");
593 kni_sock_getname(struct socket *sock, struct sockaddr *addr,
594 int *sockaddr_len, int peer)
596 KNI_DBG("dummy sock getname\n");
597 ((struct sockaddr_ll *)addr)->sll_family = AF_PACKET;
601 static const struct proto_ops kni_socket_ops = {
602 .getname = kni_sock_getname,
603 .sendmsg = kni_sock_sndmsg,
604 .recvmsg = kni_sock_rcvmsg,
605 .release = kni_sock_release,
606 .poll = kni_sock_poll,
607 .ioctl = kni_sock_ioctl,
608 .compat_ioctl = kni_sock_compat_ioctl,
612 kni_sk_write_space(struct sock *sk)
614 wait_queue_head_t *wqueue;
616 if (!sock_writeable(sk) ||
617 #ifdef SOCKWQ_ASYNC_NOSPACE
618 !test_and_clear_bit(SOCKWQ_ASYNC_NOSPACE, &sk->sk_socket->flags))
620 !test_and_clear_bit(SOCK_ASYNC_NOSPACE, &sk->sk_socket->flags))
623 wqueue = sk_sleep(sk);
624 if (wqueue && waitqueue_active(wqueue))
625 wake_up_interruptible_poll(
626 wqueue, POLLOUT | POLLWRNORM | POLLWRBAND);
630 kni_sk_destruct(struct sock *sk)
632 struct kni_vhost_queue *q =
633 container_of(sk, struct kni_vhost_queue, sk);
638 /* make sure there's no packet in buffer */
639 while (skb_dequeue(&sk->sk_receive_queue) != NULL)
644 if (q->fifo != NULL) {
649 if (q->cache != NULL) {
656 kni_vhost_backend_init(struct kni_dev *kni)
658 struct kni_vhost_queue *q;
659 struct net *net = current->nsproxy->net_ns;
661 struct rte_kni_fifo *fifo;
662 struct sk_buff *elem;
664 if (kni->vhost_queue != NULL)
667 #if LINUX_VERSION_CODE >= KERNEL_VERSION(4, 2, 0)
668 q = (struct kni_vhost_queue *)sk_alloc(net, AF_UNSPEC, GFP_KERNEL,
671 q = (struct kni_vhost_queue *)sk_alloc(net, AF_UNSPEC, GFP_KERNEL,
677 err = sock_create_lite(AF_UNSPEC, SOCK_RAW, IPPROTO_RAW, &q->sock);
681 sockfd = kni_sock_map_fd(q->sock);
689 RTE_KNI_VHOST_MAX_CACHE_SIZE * sizeof(struct sk_buff),
694 fifo = kzalloc(RTE_KNI_VHOST_MAX_CACHE_SIZE * sizeof(void *)
695 + sizeof(struct rte_kni_fifo), GFP_KERNEL);
699 kni_fifo_init(fifo, RTE_KNI_VHOST_MAX_CACHE_SIZE);
701 for (i = 0; i < RTE_KNI_VHOST_MAX_CACHE_SIZE; i++) {
703 kni_fifo_put(fifo, (void **)&elem, 1);
707 /* store sockfd in vhost_queue */
711 q->sock->type = SOCK_RAW;
712 q->sock->state = SS_CONNECTED;
713 q->sock->ops = &kni_socket_ops;
714 sock_init_data(q->sock, &q->sk);
717 q->sk.sk_write_space = kni_sk_write_space;
718 q->sk.sk_destruct = kni_sk_destruct;
719 q->flags = IFF_NO_PI | IFF_TAP;
720 q->vnet_hdr_sz = sizeof(struct virtio_net_hdr);
721 #ifdef RTE_KNI_VHOST_VNET_HDR_EN
722 q->flags |= IFF_VNET_HDR;
725 /* bind kni_dev with vhost_queue */
727 kni->vhost_queue = q;
731 kni->vq_status = BE_START;
733 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 35)
734 KNI_DBG("backend init sockfd=%d, sock->wq=0x%16llx,sk->sk_wq=0x%16llx",
735 q->sockfd, (uint64_t)q->sock->wq,
736 (uint64_t)q->sk.sk_wq);
738 KNI_DBG("backend init sockfd=%d, sock->wait at 0x%16llx,sk->sk_sleep=0x%16llx",
739 q->sockfd, (uint64_t)&q->sock->wait,
740 (uint64_t)q->sk.sk_sleep);
750 put_unused_fd(sockfd);
754 kni->vhost_queue = NULL;
755 kni->vq_status |= BE_FINISH;
756 sock_release(q->sock);
761 sk_free((struct sock *)q);
766 /* kni vhost sock sysfs */
768 show_sock_fd(struct device *dev, struct device_attribute *attr,
771 struct net_device *net_dev = container_of(dev, struct net_device, dev);
772 struct kni_dev *kni = netdev_priv(net_dev);
775 if (kni->vhost_queue != NULL)
776 sockfd = kni->vhost_queue->sockfd;
777 return snprintf(buf, 10, "%d\n", sockfd);
781 show_sock_en(struct device *dev, struct device_attribute *attr,
784 struct net_device *net_dev = container_of(dev, struct net_device, dev);
785 struct kni_dev *kni = netdev_priv(net_dev);
787 return snprintf(buf, 10, "%u\n", (kni->vhost_queue == NULL ? 0 : 1));
791 set_sock_en(struct device *dev, struct device_attribute *attr,
792 const char *buf, size_t count)
794 struct net_device *net_dev = container_of(dev, struct net_device, dev);
795 struct kni_dev *kni = netdev_priv(net_dev);
799 if (kstrtoul(buf, 0, &en) != 0)
803 err = kni_vhost_backend_init(kni);
805 return err ? err : count;
808 static DEVICE_ATTR(sock_fd, S_IRUGO | S_IRUSR, show_sock_fd, NULL);
809 static DEVICE_ATTR(sock_en, S_IRUGO | S_IWUSR, show_sock_en, set_sock_en);
810 static struct attribute *dev_attrs[] = {
811 &dev_attr_sock_fd.attr,
812 &dev_attr_sock_en.attr,
816 static const struct attribute_group dev_attr_grp = {
821 kni_vhost_backend_release(struct kni_dev *kni)
823 struct kni_vhost_queue *q = kni->vhost_queue;
828 /* dettach from kni */
831 KNI_DBG("release backend done\n");
837 kni_vhost_init(struct kni_dev *kni)
839 struct net_device *dev = kni->net_dev;
841 if (sysfs_create_group(&dev->dev.kobj, &dev_attr_grp))
842 sysfs_remove_group(&dev->dev.kobj, &dev_attr_grp);
844 kni->vq_status = BE_STOP;
846 KNI_DBG("kni_vhost_init done\n");