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>
42 extern void put_unused_fd(unsigned int fd);
44 #if LINUX_VERSION_CODE >= KERNEL_VERSION(3,7,0)
46 sock_alloc_file(struct socket *sock,
47 int flags, const char *dname);
49 extern int get_unused_fd_flags(unsigned flags);
51 extern void fd_install(unsigned int fd, struct file *file);
53 static int kni_sock_map_fd(struct socket *sock)
56 int fd = get_unused_fd_flags(0);
60 file = sock_alloc_file(sock, 0, NULL);
69 #define kni_sock_map_fd(s) sock_map_fd(s, 0)
72 static struct proto kni_raw_proto = {
75 .obj_size = sizeof(struct kni_vhost_queue),
79 kni_vhost_net_tx(struct kni_dev *kni, struct msghdr *m,
80 unsigned offset, unsigned len)
82 struct rte_kni_mbuf *pkt_kva = NULL;
83 struct rte_kni_mbuf *pkt_va = NULL;
86 KNI_DBG_TX("tx offset=%d, len=%d, iovlen=%d\n",
87 #ifdef HAVE_IOV_ITER_MSGHDR
88 offset, len, (int)m->msg_iter.iov->iov_len);
90 offset, len, (int)m->msg_iov->iov_len);
94 * Check if it has at least one free entry in tx_q and
95 * one entry in alloc_q.
97 if (kni_fifo_free_count(kni->tx_q) == 0 ||
98 kni_fifo_count(kni->alloc_q) == 0) {
100 * If no free entry in tx_q or no entry in alloc_q,
101 * drops skb and goes out.
106 /* dequeue a mbuf from alloc_q */
107 ret = kni_fifo_get(kni->alloc_q, (void **)&pkt_va, 1);
108 if (likely(ret == 1)) {
111 pkt_kva = (void *)pkt_va - kni->mbuf_va + kni->mbuf_kva;
112 data_kva = pkt_kva->buf_addr + pkt_kva->data_off
113 - kni->mbuf_va + kni->mbuf_kva;
115 #ifdef HAVE_IOV_ITER_MSGHDR
116 copy_from_iter(data_kva, len, &m->msg_iter);
118 memcpy_fromiovecend(data_kva, m->msg_iov, offset, len);
121 if (unlikely(len < ETH_ZLEN)) {
122 memset(data_kva + len, 0, ETH_ZLEN - len);
125 pkt_kva->pkt_len = len;
126 pkt_kva->data_len = len;
128 /* enqueue mbuf into tx_q */
129 ret = kni_fifo_put(kni->tx_q, (void **)&pkt_va, 1);
130 if (unlikely(ret != 1)) {
131 /* Failing should not happen */
132 KNI_ERR("Fail to enqueue mbuf into tx_q\n");
136 /* Failing should not happen */
137 KNI_ERR("Fail to dequeue mbuf from alloc_q\n");
141 /* update statistics */
142 kni->stats.tx_bytes += len;
143 kni->stats.tx_packets++;
148 /* update statistics */
149 kni->stats.tx_dropped++;
155 kni_vhost_net_rx(struct kni_dev *kni, struct msghdr *m,
156 unsigned offset, unsigned len)
159 struct rte_kni_mbuf *kva;
160 struct rte_kni_mbuf *va;
163 struct kni_vhost_queue *q = kni->vhost_queue;
165 if (unlikely(q == NULL))
168 /* ensure at least one entry in free_q */
169 if (unlikely(kni_fifo_free_count(kni->free_q) == 0))
172 skb = skb_dequeue(&q->sk.sk_receive_queue);
173 if (unlikely(skb == NULL))
176 kva = (struct rte_kni_mbuf*)skb->data;
178 /* free skb to cache */
180 if (unlikely(1 != kni_fifo_put(q->fifo, (void **)&skb, 1)))
181 /* Failing should not happen */
182 KNI_ERR("Fail to enqueue entries into rx cache fifo\n");
184 pkt_len = kva->data_len;
185 if (unlikely(pkt_len > len))
188 KNI_DBG_RX("rx offset=%d, len=%d, pkt_len=%d, iovlen=%d\n",
189 #ifdef HAVE_IOV_ITER_MSGHDR
190 offset, len, pkt_len, (int)m->msg_iter.iov->iov_len);
192 offset, len, pkt_len, (int)m->msg_iov->iov_len);
195 data_kva = kva->buf_addr + kva->data_off - kni->mbuf_va + kni->mbuf_kva;
196 #ifdef HAVE_IOV_ITER_MSGHDR
197 if (unlikely(copy_to_iter(data_kva, pkt_len, &m->msg_iter)))
199 if (unlikely(memcpy_toiovecend(m->msg_iov, data_kva, offset, pkt_len)))
203 /* Update statistics */
204 kni->stats.rx_bytes += pkt_len;
205 kni->stats.rx_packets++;
207 /* enqueue mbufs into free_q */
208 va = (void*)kva - kni->mbuf_kva + kni->mbuf_va;
209 if (unlikely(1 != kni_fifo_put(kni->free_q, (void **)&va, 1)))
210 /* Failing should not happen */
211 KNI_ERR("Fail to enqueue entries into free_q\n");
213 KNI_DBG_RX("receive done %d\n", pkt_len);
218 /* Update drop statistics */
219 kni->stats.rx_dropped++;
225 kni_sock_poll(struct file *file, struct socket *sock, poll_table * wait)
227 struct kni_vhost_queue *q =
228 container_of(sock->sk, struct kni_vhost_queue, sk);
230 unsigned int mask = 0;
232 if (unlikely(q == NULL || q->kni == NULL))
236 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,35)
237 KNI_DBG("start kni_poll on group %d, wq 0x%16llx\n",
238 kni->group_id, (uint64_t)sock->wq);
240 KNI_DBG("start kni_poll on group %d, wait at 0x%16llx\n",
241 kni->group_id, (uint64_t)&sock->wait);
244 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,35)
245 poll_wait(file, &sock->wq->wait, wait);
247 poll_wait(file, &sock->wait, wait);
250 if (kni_fifo_count(kni->rx_q) > 0)
251 mask |= POLLIN | POLLRDNORM;
253 if (sock_writeable(&q->sk) ||
254 (!test_and_set_bit(SOCK_ASYNC_NOSPACE, &q->sock->flags) &&
255 sock_writeable(&q->sk)))
256 mask |= POLLOUT | POLLWRNORM;
262 kni_vhost_enqueue(struct kni_dev *kni, struct kni_vhost_queue *q,
263 struct sk_buff *skb, struct rte_kni_mbuf *va)
265 struct rte_kni_mbuf *kva;
267 kva = (void *)(va) - kni->mbuf_va + kni->mbuf_kva;
268 (skb)->data = (unsigned char*)kva;
269 (skb)->len = kva->data_len;
270 skb_queue_tail(&q->sk.sk_receive_queue, skb);
274 kni_vhost_enqueue_burst(struct kni_dev *kni, struct kni_vhost_queue *q,
275 struct sk_buff **skb, struct rte_kni_mbuf **va)
278 for (i = 0; i < RX_BURST_SZ; skb++, va++, i++)
279 kni_vhost_enqueue(kni, q, *skb, *va);
283 kni_chk_vhost_rx(struct kni_dev *kni)
285 struct kni_vhost_queue *q = kni->vhost_queue;
286 unsigned nb_in, nb_mbuf, nb_skb;
287 const unsigned BURST_MASK = RX_BURST_SZ - 1;
288 unsigned nb_burst, nb_backlog, i;
289 struct sk_buff *skb[RX_BURST_SZ];
290 struct rte_kni_mbuf *va[RX_BURST_SZ];
292 if (unlikely(BE_STOP & kni->vq_status)) {
293 kni->vq_status |= BE_FINISH;
297 if (unlikely(q == NULL))
300 nb_skb = kni_fifo_count(q->fifo);
301 nb_mbuf = kni_fifo_count(kni->rx_q);
303 nb_in = min(nb_mbuf, nb_skb);
304 nb_in = min(nb_in, (unsigned)RX_BURST_SZ);
305 nb_burst = (nb_in & ~BURST_MASK);
306 nb_backlog = (nb_in & BURST_MASK);
308 /* enqueue skb_queue per BURST_SIZE bulk */
310 if (unlikely(RX_BURST_SZ != kni_fifo_get(
311 kni->rx_q, (void **)&va,
315 if (unlikely(RX_BURST_SZ != kni_fifo_get(
316 q->fifo, (void **)&skb,
320 kni_vhost_enqueue_burst(kni, q, skb, va);
323 /* all leftover, do one by one */
324 for (i = 0; i < nb_backlog; ++i) {
325 if (unlikely(1 != kni_fifo_get(
326 kni->rx_q,(void **)&va, 1)))
329 if (unlikely(1 != kni_fifo_get(
330 q->fifo, (void **)&skb, 1)))
333 kni_vhost_enqueue(kni, q, *skb, *va);
336 /* Ondemand wake up */
337 if ((nb_in == RX_BURST_SZ) || (nb_skb == 0) ||
338 ((nb_mbuf < RX_BURST_SZ) && (nb_mbuf != 0))) {
339 wake_up_interruptible_poll(sk_sleep(&q->sk),
340 POLLIN | POLLRDNORM | POLLRDBAND);
341 KNI_DBG_RX("RX CHK KICK nb_mbuf %d, nb_skb %d, nb_in %d\n",
342 nb_mbuf, nb_skb, nb_in);
348 /* Failing should not happen */
349 KNI_ERR("Fail to enqueue fifo, it shouldn't happen \n");
356 #ifdef HAVE_KIOCB_MSG_PARAM
357 kni_sock_sndmsg(struct kiocb *iocb, struct socket *sock,
358 struct msghdr *m, size_t total_len)
360 kni_sock_sndmsg(struct socket *sock,
361 struct msghdr *m, size_t total_len)
362 #endif /* HAVE_KIOCB_MSG_PARAM */
364 struct kni_vhost_queue *q =
365 container_of(sock->sk, struct kni_vhost_queue, sk);
366 int vnet_hdr_len = 0;
367 unsigned long len = total_len;
369 if (unlikely(q == NULL || q->kni == NULL))
372 KNI_DBG_TX("kni_sndmsg len %ld, flags 0x%08x, nb_iov %d\n",
373 #ifdef HAVE_IOV_ITER_MSGHDR
374 len, q->flags, (int)m->msg_iter.iov->iov_len);
376 len, q->flags, (int)m->msg_iovlen);
379 #ifdef RTE_KNI_VHOST_VNET_HDR_EN
380 if (likely(q->flags & IFF_VNET_HDR)) {
381 vnet_hdr_len = q->vnet_hdr_sz;
382 if (unlikely(len < vnet_hdr_len))
388 if (unlikely(len < ETH_HLEN + q->vnet_hdr_sz))
391 return kni_vhost_net_tx(q->kni, m, vnet_hdr_len, len);
395 #ifdef HAVE_KIOCB_MSG_PARAM
396 kni_sock_rcvmsg(struct kiocb *iocb, struct socket *sock,
397 struct msghdr *m, size_t len, int flags)
399 kni_sock_rcvmsg(struct socket *sock,
400 struct msghdr *m, size_t len, int flags)
401 #endif /* HAVE_KIOCB_MSG_PARAM */
403 int vnet_hdr_len = 0;
405 struct kni_vhost_queue *q =
406 container_of(sock->sk, struct kni_vhost_queue, sk);
407 static struct virtio_net_hdr
408 __attribute__ ((unused)) vnet_hdr = {
410 .gso_type = VIRTIO_NET_HDR_GSO_NONE
413 if (unlikely(q == NULL || q->kni == NULL))
416 #ifdef RTE_KNI_VHOST_VNET_HDR_EN
417 if (likely(q->flags & IFF_VNET_HDR)) {
418 vnet_hdr_len = q->vnet_hdr_sz;
419 if ((len -= vnet_hdr_len) < 0)
424 if (unlikely(0 == (pkt_len = kni_vhost_net_rx(q->kni,
425 m, vnet_hdr_len, len))))
428 #ifdef RTE_KNI_VHOST_VNET_HDR_EN
429 /* no need to copy hdr when no pkt received */
430 #ifdef HAVE_IOV_ITER_MSGHDR
431 if (unlikely(copy_to_iter((void *)&vnet_hdr, vnet_hdr_len,
434 if (unlikely(memcpy_toiovecend(m->msg_iov,
435 (void *)&vnet_hdr, 0, vnet_hdr_len)))
436 #endif /* HAVE_IOV_ITER_MSGHDR */
438 #endif /* RTE_KNI_VHOST_VNET_HDR_EN */
439 KNI_DBG_RX("kni_rcvmsg expect_len %ld, flags 0x%08x, pkt_len %d\n",
440 (unsigned long)len, q->flags, pkt_len);
442 return (pkt_len + vnet_hdr_len);
445 /* dummy tap like ioctl */
447 kni_sock_ioctl(struct socket *sock, unsigned int cmd,
450 void __user *argp = (void __user *)arg;
451 struct ifreq __user *ifr = argp;
452 unsigned int __user *up = argp;
453 struct kni_vhost_queue *q =
454 container_of(sock->sk, struct kni_vhost_queue, sk);
457 int __user *sp = argp;
461 KNI_DBG("tap ioctl cmd 0x%08x\n", cmd);
465 KNI_DBG("TUNSETIFF\n");
466 /* ignore the name, just look at flags */
467 if (get_user(u, &ifr->ifr_flags))
471 if ((u & ~IFF_VNET_HDR) != (IFF_NO_PI | IFF_TAP))
479 KNI_DBG("TUNGETIFF\n");
481 kni = rcu_dereference_bh(q->kni);
483 dev_hold(kni->net_dev);
484 rcu_read_unlock_bh();
490 if (copy_to_user(&ifr->ifr_name, kni->net_dev->name, IFNAMSIZ) ||
491 put_user(q->flags, &ifr->ifr_flags))
493 dev_put(kni->net_dev);
497 KNI_DBG("TUNGETFEATURES\n");
498 u = IFF_TAP | IFF_NO_PI;
499 #ifdef RTE_KNI_VHOST_VNET_HDR_EN
507 KNI_DBG("TUNSETSNDBUF\n");
514 case TUNGETVNETHDRSZ:
518 KNI_DBG("TUNGETVNETHDRSZ %d\n", s);
521 case TUNSETVNETHDRSZ:
524 if (s < (int)sizeof(struct virtio_net_hdr))
527 KNI_DBG("TUNSETVNETHDRSZ %d\n", s);
532 KNI_DBG("TUNSETOFFLOAD %lx\n", arg);
533 #ifdef RTE_KNI_VHOST_VNET_HDR_EN
534 /* not support any offload yet */
535 if (!(q->flags & IFF_VNET_HDR))
544 KNI_DBG("NOT SUPPORT\n");
550 kni_sock_compat_ioctl(struct socket *sock, unsigned int cmd,
553 /* 32 bits app on 64 bits OS to be supported later */
554 KNI_PRINT("Not implemented.\n");
559 #define KNI_VHOST_WAIT_WQ_SAFE() \
561 while ((BE_FINISH | BE_STOP) == kni->vq_status) \
567 kni_sock_release(struct socket *sock)
569 struct kni_vhost_queue *q =
570 container_of(sock->sk, struct kni_vhost_queue, sk);
576 if (NULL != (kni = q->kni)) {
577 kni->vq_status = BE_STOP;
578 KNI_VHOST_WAIT_WQ_SAFE();
579 kni->vhost_queue = NULL;
586 sk_set_socket(&q->sk, NULL);
591 KNI_DBG("dummy sock release done\n");
597 kni_sock_getname (struct socket *sock,
598 struct sockaddr *addr,
599 int *sockaddr_len, int peer)
601 KNI_DBG("dummy sock getname\n");
602 ((struct sockaddr_ll*)addr)->sll_family = AF_PACKET;
606 static const struct proto_ops kni_socket_ops = {
607 .getname = kni_sock_getname,
608 .sendmsg = kni_sock_sndmsg,
609 .recvmsg = kni_sock_rcvmsg,
610 .release = kni_sock_release,
611 .poll = kni_sock_poll,
612 .ioctl = kni_sock_ioctl,
613 .compat_ioctl = kni_sock_compat_ioctl,
617 kni_sk_write_space(struct sock *sk)
619 wait_queue_head_t *wqueue;
621 if (!sock_writeable(sk) ||
622 !test_and_clear_bit(SOCK_ASYNC_NOSPACE,
623 &sk->sk_socket->flags))
625 wqueue = sk_sleep(sk);
626 if (wqueue && waitqueue_active(wqueue))
627 wake_up_interruptible_poll(
628 wqueue, POLLOUT | POLLWRNORM | POLLWRBAND);
632 kni_sk_destruct(struct sock *sk)
634 struct kni_vhost_queue *q =
635 container_of(sk, struct kni_vhost_queue, sk);
640 /* make sure there's no packet in buffer */
641 while (skb_dequeue(&sk->sk_receive_queue) != NULL)
646 if (q->fifo != NULL) {
651 if (q->cache != NULL) {
658 kni_vhost_backend_init(struct kni_dev *kni)
660 struct kni_vhost_queue *q;
661 struct net *net = current->nsproxy->net_ns;
663 struct rte_kni_fifo *fifo;
664 struct sk_buff *elem;
666 if (kni->vhost_queue != NULL)
669 if (!(q = (struct kni_vhost_queue *)sk_alloc(
670 net, AF_UNSPEC, GFP_KERNEL, &kni_raw_proto)))
673 err = sock_create_lite(AF_UNSPEC, SOCK_RAW, IPPROTO_RAW, &q->sock);
677 sockfd = kni_sock_map_fd(q->sock);
684 q->cache = kzalloc(RTE_KNI_VHOST_MAX_CACHE_SIZE * sizeof(struct sk_buff),
689 fifo = kzalloc(RTE_KNI_VHOST_MAX_CACHE_SIZE * sizeof(void *)
690 + sizeof(struct rte_kni_fifo), GFP_KERNEL);
694 kni_fifo_init(fifo, RTE_KNI_VHOST_MAX_CACHE_SIZE);
696 for (i = 0; i < RTE_KNI_VHOST_MAX_CACHE_SIZE; i++) {
698 kni_fifo_put(fifo, (void**)&elem, 1);
702 /* store sockfd in vhost_queue */
706 q->sock->type = SOCK_RAW;
707 q->sock->state = SS_CONNECTED;
708 q->sock->ops = &kni_socket_ops;
709 sock_init_data(q->sock, &q->sk);
712 q->sk.sk_write_space = kni_sk_write_space;
713 q->sk.sk_destruct = kni_sk_destruct;
714 q->flags = IFF_NO_PI | IFF_TAP;
715 q->vnet_hdr_sz = sizeof(struct virtio_net_hdr);
716 #ifdef RTE_KNI_VHOST_VNET_HDR_EN
717 q->flags |= IFF_VNET_HDR;
720 /* bind kni_dev with vhost_queue */
722 kni->vhost_queue = q;
726 kni->vq_status = BE_START;
728 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,35)
729 KNI_DBG("backend init sockfd=%d, sock->wq=0x%16llx,"
730 "sk->sk_wq=0x%16llx",
731 q->sockfd, (uint64_t)q->sock->wq,
732 (uint64_t)q->sk.sk_wq);
734 KNI_DBG("backend init sockfd=%d, sock->wait at 0x%16llx,"
735 "sk->sk_sleep=0x%16llx",
736 q->sockfd, (uint64_t)&q->sock->wait,
737 (uint64_t)q->sk.sk_sleep);
747 put_unused_fd(sockfd);
751 kni->vhost_queue = NULL;
752 kni->vq_status |= BE_FINISH;
753 sock_release(q->sock);
758 sk_free((struct sock*)q);
763 /* kni vhost sock sysfs */
765 show_sock_fd(struct device *dev, struct device_attribute *attr,
768 struct net_device *net_dev = container_of(dev, struct net_device, dev);
769 struct kni_dev *kni = netdev_priv(net_dev);
771 if (kni->vhost_queue != NULL)
772 sockfd = kni->vhost_queue->sockfd;
773 return snprintf(buf, 10, "%d\n", sockfd);
777 show_sock_en(struct device *dev, struct device_attribute *attr,
780 struct net_device *net_dev = container_of(dev, struct net_device, dev);
781 struct kni_dev *kni = netdev_priv(net_dev);
782 return snprintf(buf, 10, "%u\n", (kni->vhost_queue == NULL ? 0 : 1));
786 set_sock_en(struct device *dev, struct device_attribute *attr,
787 const char *buf, size_t count)
789 struct net_device *net_dev = container_of(dev, struct net_device, dev);
790 struct kni_dev *kni = netdev_priv(net_dev);
794 if (0 != kstrtoul(buf, 0, &en))
798 err = kni_vhost_backend_init(kni);
800 return err ? err : count;
803 static DEVICE_ATTR(sock_fd, S_IRUGO | S_IRUSR, show_sock_fd, NULL);
804 static DEVICE_ATTR(sock_en, S_IRUGO | S_IWUSR, show_sock_en, set_sock_en);
805 static struct attribute *dev_attrs[] = {
806 &dev_attr_sock_fd.attr,
807 &dev_attr_sock_en.attr,
811 static const struct attribute_group dev_attr_grp = {
816 kni_vhost_backend_release(struct kni_dev *kni)
818 struct kni_vhost_queue *q = kni->vhost_queue;
823 /* dettach from kni */
826 KNI_DBG("release backend done\n");
832 kni_vhost_init(struct kni_dev *kni)
834 struct net_device *dev = kni->net_dev;
836 if (sysfs_create_group(&dev->dev.kobj, &dev_attr_grp))
837 sysfs_remove_group(&dev->dev.kobj, &dev_attr_grp);
839 kni->vq_status = BE_STOP;
841 KNI_DBG("kni_vhost_init done\n");