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/version.h>
26 #include <linux/module.h>
27 #include <linux/miscdevice.h>
28 #include <linux/netdevice.h>
29 #include <linux/etherdevice.h>
30 #include <linux/pci.h>
31 #include <linux/kthread.h>
32 #include <linux/rwsem.h>
33 #include <linux/mutex.h>
34 #include <linux/nsproxy.h>
35 #include <net/net_namespace.h>
36 #include <net/netns/generic.h>
38 #include <exec-env/rte_kni_common.h>
43 MODULE_LICENSE("Dual BSD/GPL");
44 MODULE_AUTHOR("Intel Corporation");
45 MODULE_DESCRIPTION("Kernel Module for managing kni devices");
47 #define KNI_RX_LOOP_NUM 1000
49 #define KNI_MAX_DEVICES 32
51 extern const struct pci_device_id ixgbe_pci_tbl[];
52 extern const struct pci_device_id igb_pci_tbl[];
54 static int kni_open(struct inode *inode, struct file *file);
55 static int kni_release(struct inode *inode, struct file *file);
56 static int kni_ioctl(struct inode *inode, unsigned int ioctl_num,
57 unsigned long ioctl_param);
58 static int kni_compat_ioctl(struct inode *inode, unsigned int ioctl_num,
59 unsigned long ioctl_param);
60 static int kni_dev_remove(struct kni_dev *dev);
62 static int __init kni_parse_kthread_mode(void);
64 /* KNI processing for single kernel thread mode */
65 static int kni_thread_single(void *unused);
66 /* KNI processing for multiple kernel thread mode */
67 static int kni_thread_multiple(void *param);
69 static const struct file_operations kni_fops = {
72 .release = kni_release,
73 .unlocked_ioctl = (void *)kni_ioctl,
74 .compat_ioctl = (void *)kni_compat_ioctl,
77 static struct miscdevice kni_misc = {
78 .minor = MISC_DYNAMIC_MINOR,
86 /* Kernel thread mode */
87 static char *kthread_mode;
88 static unsigned int multiple_kthread_on;
90 #define KNI_DEV_IN_USE_BIT_NUM 0 /* Bit number for device in use */
92 static int kni_net_id;
95 unsigned long device_in_use; /* device in use flag */
96 struct mutex kni_kthread_lock;
97 struct task_struct *kni_kthread;
98 struct rw_semaphore kni_list_lock;
99 struct list_head kni_list_head;
102 static int __net_init
103 kni_init_net(struct net *net)
105 #ifdef HAVE_SIMPLIFIED_PERNET_OPERATIONS
106 struct kni_net *knet = net_generic(net, kni_net_id);
108 memset(knet, 0, sizeof(*knet));
110 struct kni_net *knet;
113 knet = kzalloc(sizeof(struct kni_net), GFP_KERNEL);
120 /* Clear the bit of device in use */
121 clear_bit(KNI_DEV_IN_USE_BIT_NUM, &knet->device_in_use);
123 mutex_init(&knet->kni_kthread_lock);
125 init_rwsem(&knet->kni_list_lock);
126 INIT_LIST_HEAD(&knet->kni_list_head);
128 #ifdef HAVE_SIMPLIFIED_PERNET_OPERATIONS
131 ret = net_assign_generic(net, kni_net_id, knet);
139 static void __net_exit
140 kni_exit_net(struct net *net)
142 struct kni_net *knet = net_generic(net, kni_net_id);
144 mutex_destroy(&knet->kni_kthread_lock);
145 #ifndef HAVE_SIMPLIFIED_PERNET_OPERATIONS
150 static struct pernet_operations kni_net_ops = {
151 .init = kni_init_net,
152 .exit = kni_exit_net,
153 #ifdef HAVE_SIMPLIFIED_PERNET_OPERATIONS
155 .size = sizeof(struct kni_net),
164 KNI_PRINT("######## DPDK kni module loading ########\n");
166 if (kni_parse_kthread_mode() < 0) {
167 KNI_ERR("Invalid parameter for kthread_mode\n");
171 if (multiple_kthread_on == 0)
172 KNI_PRINT("Single kernel thread for all KNI devices\n");
174 KNI_PRINT("Multiple kernel thread mode enabled\n");
176 #ifdef HAVE_SIMPLIFIED_PERNET_OPERATIONS
177 rc = register_pernet_subsys(&kni_net_ops);
179 rc = register_pernet_gen_subsys(&kni_net_id, &kni_net_ops);
184 rc = misc_register(&kni_misc);
186 KNI_ERR("Misc registration failed\n");
190 /* Configure the lo mode according to the input parameter */
191 kni_net_config_lo_mode(lo_mode);
193 KNI_PRINT("######## DPDK kni module loaded ########\n");
198 #ifdef HAVE_SIMPLIFIED_PERNET_OPERATIONS
199 unregister_pernet_subsys(&kni_net_ops);
201 unregister_pernet_gen_subsys(kni_net_id, &kni_net_ops);
209 misc_deregister(&kni_misc);
210 #ifdef HAVE_SIMPLIFIED_PERNET_OPERATIONS
211 unregister_pernet_subsys(&kni_net_ops);
213 unregister_pernet_gen_subsys(kni_net_id, &kni_net_ops);
215 KNI_PRINT("####### DPDK kni module unloaded #######\n");
219 kni_parse_kthread_mode(void)
224 if (strcmp(kthread_mode, "single") == 0)
226 else if (strcmp(kthread_mode, "multiple") == 0)
227 multiple_kthread_on = 1;
235 kni_open(struct inode *inode, struct file *file)
237 struct net *net = current->nsproxy->net_ns;
238 struct kni_net *knet = net_generic(net, kni_net_id);
240 /* kni device can be opened by one user only per netns */
241 if (test_and_set_bit(KNI_DEV_IN_USE_BIT_NUM, &knet->device_in_use))
244 file->private_data = get_net(net);
245 KNI_PRINT("/dev/kni opened\n");
251 kni_release(struct inode *inode, struct file *file)
253 struct net *net = file->private_data;
254 struct kni_net *knet = net_generic(net, kni_net_id);
255 struct kni_dev *dev, *n;
257 /* Stop kernel thread for single mode */
258 if (multiple_kthread_on == 0) {
259 mutex_lock(&knet->kni_kthread_lock);
260 /* Stop kernel thread */
261 if (knet->kni_kthread != NULL) {
262 kthread_stop(knet->kni_kthread);
263 knet->kni_kthread = NULL;
265 mutex_unlock(&knet->kni_kthread_lock);
268 down_write(&knet->kni_list_lock);
269 list_for_each_entry_safe(dev, n, &knet->kni_list_head, list) {
270 /* Stop kernel thread for multiple mode */
271 if (multiple_kthread_on && dev->pthread != NULL) {
272 kthread_stop(dev->pthread);
277 kni_vhost_backend_release(dev);
280 list_del(&dev->list);
282 up_write(&knet->kni_list_lock);
284 /* Clear the bit of device in use */
285 clear_bit(KNI_DEV_IN_USE_BIT_NUM, &knet->device_in_use);
288 KNI_PRINT("/dev/kni closed\n");
294 kni_thread_single(void *data)
296 struct kni_net *knet = data;
300 while (!kthread_should_stop()) {
301 down_read(&knet->kni_list_lock);
302 for (j = 0; j < KNI_RX_LOOP_NUM; j++) {
303 list_for_each_entry(dev, &knet->kni_list_head, list) {
305 kni_chk_vhost_rx(dev);
309 kni_net_poll_resp(dev);
312 up_read(&knet->kni_list_lock);
313 #ifdef RTE_KNI_PREEMPT_DEFAULT
314 /* reschedule out for a while */
315 schedule_timeout_interruptible(
316 usecs_to_jiffies(KNI_KTHREAD_RESCHEDULE_INTERVAL));
324 kni_thread_multiple(void *param)
327 struct kni_dev *dev = (struct kni_dev *)param;
329 while (!kthread_should_stop()) {
330 for (j = 0; j < KNI_RX_LOOP_NUM; j++) {
332 kni_chk_vhost_rx(dev);
336 kni_net_poll_resp(dev);
338 #ifdef RTE_KNI_PREEMPT_DEFAULT
339 schedule_timeout_interruptible(
340 usecs_to_jiffies(KNI_KTHREAD_RESCHEDULE_INTERVAL));
348 kni_dev_remove(struct kni_dev *dev)
354 if (pci_match_id(ixgbe_pci_tbl, dev->pci_dev))
355 ixgbe_kni_remove(dev->pci_dev);
356 else if (pci_match_id(igb_pci_tbl, dev->pci_dev))
357 igb_kni_remove(dev->pci_dev);
361 unregister_netdev(dev->net_dev);
362 free_netdev(dev->net_dev);
369 kni_check_param(struct kni_dev *kni, struct rte_kni_device_info *dev)
374 /* Check if network name has been used */
375 if (!strncmp(kni->name, dev->name, RTE_KNI_NAMESIZE)) {
376 KNI_ERR("KNI name %s duplicated\n", dev->name);
384 kni_run_thread(struct kni_net *knet, struct kni_dev *kni, uint8_t force_bind)
387 * Create a new kernel thread for multiple mode, set its core affinity,
388 * and finally wake it up.
390 if (multiple_kthread_on) {
391 kni->pthread = kthread_create(kni_thread_multiple,
392 (void *)kni, "kni_%s", kni->name);
393 if (IS_ERR(kni->pthread)) {
399 kthread_bind(kni->pthread, kni->core_id);
400 wake_up_process(kni->pthread);
402 mutex_lock(&knet->kni_kthread_lock);
404 if (knet->kni_kthread == NULL) {
405 knet->kni_kthread = kthread_create(kni_thread_single,
406 (void *)knet, "kni_single");
407 if (IS_ERR(knet->kni_kthread)) {
408 mutex_unlock(&knet->kni_kthread_lock);
414 kthread_bind(knet->kni_kthread, kni->core_id);
415 wake_up_process(knet->kni_kthread);
418 mutex_unlock(&knet->kni_kthread_lock);
425 kni_ioctl_create(struct net *net,
426 unsigned int ioctl_num, unsigned long ioctl_param)
428 struct kni_net *knet = net_generic(net, kni_net_id);
430 struct rte_kni_device_info dev_info;
431 struct pci_dev *pci = NULL;
432 struct pci_dev *found_pci = NULL;
433 struct net_device *net_dev = NULL;
434 struct net_device *lad_dev = NULL;
435 struct kni_dev *kni, *dev, *n;
437 printk(KERN_INFO "KNI: Creating kni...\n");
438 /* Check the buffer size, to avoid warning */
439 if (_IOC_SIZE(ioctl_num) > sizeof(dev_info))
442 /* Copy kni info from user space */
443 ret = copy_from_user(&dev_info, (void *)ioctl_param, sizeof(dev_info));
445 KNI_ERR("copy_from_user in kni_ioctl_create");
450 * Check if the cpu core id is valid for binding.
452 if (dev_info.force_bind && !cpu_online(dev_info.core_id)) {
453 KNI_ERR("cpu %u is not online\n", dev_info.core_id);
457 /* Check if it has been created */
458 down_read(&knet->kni_list_lock);
459 list_for_each_entry_safe(dev, n, &knet->kni_list_head, list) {
460 if (kni_check_param(dev, &dev_info) < 0) {
461 up_read(&knet->kni_list_lock);
465 up_read(&knet->kni_list_lock);
467 net_dev = alloc_netdev(sizeof(struct kni_dev), dev_info.name,
468 #ifdef NET_NAME_UNKNOWN
472 if (net_dev == NULL) {
473 KNI_ERR("error allocating device \"%s\"\n", dev_info.name);
477 dev_net_set(net_dev, net);
479 kni = netdev_priv(net_dev);
481 kni->net_dev = net_dev;
482 kni->group_id = dev_info.group_id;
483 kni->core_id = dev_info.core_id;
484 strncpy(kni->name, dev_info.name, RTE_KNI_NAMESIZE);
486 /* Translate user space info into kernel space info */
487 kni->tx_q = phys_to_virt(dev_info.tx_phys);
488 kni->rx_q = phys_to_virt(dev_info.rx_phys);
489 kni->alloc_q = phys_to_virt(dev_info.alloc_phys);
490 kni->free_q = phys_to_virt(dev_info.free_phys);
492 kni->req_q = phys_to_virt(dev_info.req_phys);
493 kni->resp_q = phys_to_virt(dev_info.resp_phys);
494 kni->sync_va = dev_info.sync_va;
495 kni->sync_kva = phys_to_virt(dev_info.sync_phys);
498 kni->vhost_queue = NULL;
499 kni->vq_status = BE_STOP;
501 kni->mbuf_size = dev_info.mbuf_size;
503 KNI_PRINT("tx_phys: 0x%016llx, tx_q addr: 0x%p\n",
504 (unsigned long long) dev_info.tx_phys, kni->tx_q);
505 KNI_PRINT("rx_phys: 0x%016llx, rx_q addr: 0x%p\n",
506 (unsigned long long) dev_info.rx_phys, kni->rx_q);
507 KNI_PRINT("alloc_phys: 0x%016llx, alloc_q addr: 0x%p\n",
508 (unsigned long long) dev_info.alloc_phys, kni->alloc_q);
509 KNI_PRINT("free_phys: 0x%016llx, free_q addr: 0x%p\n",
510 (unsigned long long) dev_info.free_phys, kni->free_q);
511 KNI_PRINT("req_phys: 0x%016llx, req_q addr: 0x%p\n",
512 (unsigned long long) dev_info.req_phys, kni->req_q);
513 KNI_PRINT("resp_phys: 0x%016llx, resp_q addr: 0x%p\n",
514 (unsigned long long) dev_info.resp_phys, kni->resp_q);
515 KNI_PRINT("mbuf_size: %u\n", kni->mbuf_size);
517 KNI_DBG("PCI: %02x:%02x.%02x %04x:%04x\n",
524 pci = pci_get_device(dev_info.vendor_id, dev_info.device_id, NULL);
526 /* Support Ethtool */
528 KNI_PRINT("pci_bus: %02x:%02x:%02x\n",
530 PCI_SLOT(pci->devfn),
531 PCI_FUNC(pci->devfn));
533 if ((pci->bus->number == dev_info.bus) &&
534 (PCI_SLOT(pci->devfn) == dev_info.devid) &&
535 (PCI_FUNC(pci->devfn) == dev_info.function)) {
538 if (pci_match_id(ixgbe_pci_tbl, found_pci))
539 ret = ixgbe_kni_probe(found_pci, &lad_dev);
540 else if (pci_match_id(igb_pci_tbl, found_pci))
541 ret = igb_kni_probe(found_pci, &lad_dev);
545 KNI_DBG("PCI found: pci=0x%p, lad_dev=0x%p\n",
548 kni->lad_dev = lad_dev;
549 kni_set_ethtool_ops(kni->net_dev);
551 KNI_ERR("Device not supported by ethtool");
555 kni->pci_dev = found_pci;
556 kni->device_id = dev_info.device_id;
559 pci = pci_get_device(dev_info.vendor_id,
560 dev_info.device_id, pci);
566 memcpy(net_dev->dev_addr, kni->lad_dev->dev_addr, ETH_ALEN);
569 * Generate random mac address. eth_random_addr() is the newer
570 * version of generating mac address in linux kernel.
572 random_ether_addr(net_dev->dev_addr);
574 ret = register_netdev(net_dev);
576 KNI_ERR("error %i registering device \"%s\"\n",
580 free_netdev(net_dev);
588 ret = kni_run_thread(knet, kni, dev_info.force_bind);
592 down_write(&knet->kni_list_lock);
593 list_add(&kni->list, &knet->kni_list_head);
594 up_write(&knet->kni_list_lock);
600 kni_ioctl_release(struct net *net,
601 unsigned int ioctl_num, unsigned long ioctl_param)
603 struct kni_net *knet = net_generic(net, kni_net_id);
605 struct kni_dev *dev, *n;
606 struct rte_kni_device_info dev_info;
608 if (_IOC_SIZE(ioctl_num) > sizeof(dev_info))
611 ret = copy_from_user(&dev_info, (void *)ioctl_param, sizeof(dev_info));
613 KNI_ERR("copy_from_user in kni_ioctl_release");
617 /* Release the network device according to its name */
618 if (strlen(dev_info.name) == 0)
621 down_write(&knet->kni_list_lock);
622 list_for_each_entry_safe(dev, n, &knet->kni_list_head, list) {
623 if (strncmp(dev->name, dev_info.name, RTE_KNI_NAMESIZE) != 0)
626 if (multiple_kthread_on && dev->pthread != NULL) {
627 kthread_stop(dev->pthread);
632 kni_vhost_backend_release(dev);
635 list_del(&dev->list);
639 up_write(&knet->kni_list_lock);
640 printk(KERN_INFO "KNI: %s release kni named %s\n",
641 (ret == 0 ? "Successfully" : "Unsuccessfully"), dev_info.name);
647 kni_ioctl(struct inode *inode,
648 unsigned int ioctl_num,
649 unsigned long ioctl_param)
652 struct net *net = current->nsproxy->net_ns;
654 KNI_DBG("IOCTL num=0x%0x param=0x%0lx\n", ioctl_num, ioctl_param);
657 * Switch according to the ioctl called
659 switch (_IOC_NR(ioctl_num)) {
660 case _IOC_NR(RTE_KNI_IOCTL_TEST):
661 /* For test only, not used */
663 case _IOC_NR(RTE_KNI_IOCTL_CREATE):
664 ret = kni_ioctl_create(net, ioctl_num, ioctl_param);
666 case _IOC_NR(RTE_KNI_IOCTL_RELEASE):
667 ret = kni_ioctl_release(net, ioctl_num, ioctl_param);
670 KNI_DBG("IOCTL default\n");
678 kni_compat_ioctl(struct inode *inode,
679 unsigned int ioctl_num,
680 unsigned long ioctl_param)
682 /* 32 bits app on 64 bits OS to be supported later */
683 KNI_PRINT("Not implemented.\n");
688 module_init(kni_init);
689 module_exit(kni_exit);
691 module_param(lo_mode, charp, S_IRUGO | S_IWUSR);
692 MODULE_PARM_DESC(lo_mode,
693 "KNI loopback mode (default=lo_mode_none):\n"
694 " lo_mode_none Kernel loopback disabled\n"
695 " lo_mode_fifo Enable kernel loopback with fifo\n"
696 " lo_mode_fifo_skb Enable kernel loopback with fifo and skb buffer\n"
700 module_param(kthread_mode, charp, S_IRUGO);
701 MODULE_PARM_DESC(kthread_mode,
702 "Kernel thread mode (default=single):\n"
703 " single Single kernel thread mode enabled.\n"
704 " multiple Multiple kernel thread mode enabled.\n"