1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright(c) 2010-2014 Intel Corporation.
6 #include <linux/version.h>
7 #include <linux/module.h>
8 #include <linux/miscdevice.h>
9 #include <linux/netdevice.h>
10 #include <linux/etherdevice.h>
11 #include <linux/pci.h>
12 #include <linux/kthread.h>
13 #include <linux/rwsem.h>
14 #include <linux/mutex.h>
15 #include <linux/nsproxy.h>
16 #include <net/net_namespace.h>
17 #include <net/netns/generic.h>
19 #include <rte_kni_common.h>
24 MODULE_LICENSE("Dual BSD/GPL");
25 MODULE_AUTHOR("Intel Corporation");
26 MODULE_DESCRIPTION("Kernel Module for managing kni devices");
28 #define KNI_RX_LOOP_NUM 1000
30 #define KNI_MAX_DEVICES 32
32 extern const struct pci_device_id ixgbe_pci_tbl
[];
33 extern const struct pci_device_id igb_pci_tbl
[];
38 /* Kernel thread mode */
39 static char *kthread_mode
;
40 static uint32_t multiple_kthread_on
;
42 /* Default carrier state for created KNI network interfaces */
44 uint32_t dflt_carrier
;
46 #define KNI_DEV_IN_USE_BIT_NUM 0 /* Bit number for device in use */
48 static int kni_net_id
;
51 unsigned long device_in_use
; /* device in use flag */
52 struct mutex kni_kthread_lock
;
53 struct task_struct
*kni_kthread
;
54 struct rw_semaphore kni_list_lock
;
55 struct list_head kni_list_head
;
59 kni_init_net(struct net
*net
)
61 #ifdef HAVE_SIMPLIFIED_PERNET_OPERATIONS
62 struct kni_net
*knet
= net_generic(net
, kni_net_id
);
64 memset(knet
, 0, sizeof(*knet
));
69 knet
= kzalloc(sizeof(struct kni_net
), GFP_KERNEL
);
76 /* Clear the bit of device in use */
77 clear_bit(KNI_DEV_IN_USE_BIT_NUM
, &knet
->device_in_use
);
79 mutex_init(&knet
->kni_kthread_lock
);
81 init_rwsem(&knet
->kni_list_lock
);
82 INIT_LIST_HEAD(&knet
->kni_list_head
);
84 #ifdef HAVE_SIMPLIFIED_PERNET_OPERATIONS
87 ret
= net_assign_generic(net
, kni_net_id
, knet
);
95 static void __net_exit
96 kni_exit_net(struct net
*net
)
98 struct kni_net
*knet __maybe_unused
;
100 knet
= net_generic(net
, kni_net_id
);
101 mutex_destroy(&knet
->kni_kthread_lock
);
103 #ifndef HAVE_SIMPLIFIED_PERNET_OPERATIONS
108 static struct pernet_operations kni_net_ops
= {
109 .init
= kni_init_net
,
110 .exit
= kni_exit_net
,
111 #ifdef HAVE_SIMPLIFIED_PERNET_OPERATIONS
113 .size
= sizeof(struct kni_net
),
118 kni_thread_single(void *data
)
120 struct kni_net
*knet
= data
;
124 while (!kthread_should_stop()) {
125 down_read(&knet
->kni_list_lock
);
126 for (j
= 0; j
< KNI_RX_LOOP_NUM
; j
++) {
127 list_for_each_entry(dev
, &knet
->kni_list_head
, list
) {
129 kni_net_poll_resp(dev
);
132 up_read(&knet
->kni_list_lock
);
133 #ifdef RTE_KNI_PREEMPT_DEFAULT
134 /* reschedule out for a while */
135 schedule_timeout_interruptible(
136 usecs_to_jiffies(KNI_KTHREAD_RESCHEDULE_INTERVAL
));
144 kni_thread_multiple(void *param
)
147 struct kni_dev
*dev
= param
;
149 while (!kthread_should_stop()) {
150 for (j
= 0; j
< KNI_RX_LOOP_NUM
; j
++) {
152 kni_net_poll_resp(dev
);
154 #ifdef RTE_KNI_PREEMPT_DEFAULT
155 schedule_timeout_interruptible(
156 usecs_to_jiffies(KNI_KTHREAD_RESCHEDULE_INTERVAL
));
164 kni_open(struct inode
*inode
, struct file
*file
)
166 struct net
*net
= current
->nsproxy
->net_ns
;
167 struct kni_net
*knet
= net_generic(net
, kni_net_id
);
169 /* kni device can be opened by one user only per netns */
170 if (test_and_set_bit(KNI_DEV_IN_USE_BIT_NUM
, &knet
->device_in_use
))
173 file
->private_data
= get_net(net
);
174 pr_debug("/dev/kni opened\n");
180 kni_dev_remove(struct kni_dev
*dev
)
185 #ifdef RTE_KNI_KMOD_ETHTOOL
187 if (pci_match_id(ixgbe_pci_tbl
, dev
->pci_dev
))
188 ixgbe_kni_remove(dev
->pci_dev
);
189 else if (pci_match_id(igb_pci_tbl
, dev
->pci_dev
))
190 igb_kni_remove(dev
->pci_dev
);
195 unregister_netdev(dev
->net_dev
);
196 free_netdev(dev
->net_dev
);
199 kni_net_release_fifo_phy(dev
);
205 kni_release(struct inode
*inode
, struct file
*file
)
207 struct net
*net
= file
->private_data
;
208 struct kni_net
*knet
= net_generic(net
, kni_net_id
);
209 struct kni_dev
*dev
, *n
;
211 /* Stop kernel thread for single mode */
212 if (multiple_kthread_on
== 0) {
213 mutex_lock(&knet
->kni_kthread_lock
);
214 /* Stop kernel thread */
215 if (knet
->kni_kthread
!= NULL
) {
216 kthread_stop(knet
->kni_kthread
);
217 knet
->kni_kthread
= NULL
;
219 mutex_unlock(&knet
->kni_kthread_lock
);
222 down_write(&knet
->kni_list_lock
);
223 list_for_each_entry_safe(dev
, n
, &knet
->kni_list_head
, list
) {
224 /* Stop kernel thread for multiple mode */
225 if (multiple_kthread_on
&& dev
->pthread
!= NULL
) {
226 kthread_stop(dev
->pthread
);
231 list_del(&dev
->list
);
233 up_write(&knet
->kni_list_lock
);
235 /* Clear the bit of device in use */
236 clear_bit(KNI_DEV_IN_USE_BIT_NUM
, &knet
->device_in_use
);
239 pr_debug("/dev/kni closed\n");
245 kni_check_param(struct kni_dev
*kni
, struct rte_kni_device_info
*dev
)
250 /* Check if network name has been used */
251 if (!strncmp(kni
->name
, dev
->name
, RTE_KNI_NAMESIZE
)) {
252 pr_err("KNI name %s duplicated\n", dev
->name
);
260 kni_run_thread(struct kni_net
*knet
, struct kni_dev
*kni
, uint8_t force_bind
)
263 * Create a new kernel thread for multiple mode, set its core affinity,
264 * and finally wake it up.
266 if (multiple_kthread_on
) {
267 kni
->pthread
= kthread_create(kni_thread_multiple
,
268 (void *)kni
, "kni_%s", kni
->name
);
269 if (IS_ERR(kni
->pthread
)) {
275 kthread_bind(kni
->pthread
, kni
->core_id
);
276 wake_up_process(kni
->pthread
);
278 mutex_lock(&knet
->kni_kthread_lock
);
280 if (knet
->kni_kthread
== NULL
) {
281 knet
->kni_kthread
= kthread_create(kni_thread_single
,
282 (void *)knet
, "kni_single");
283 if (IS_ERR(knet
->kni_kthread
)) {
284 mutex_unlock(&knet
->kni_kthread_lock
);
290 kthread_bind(knet
->kni_kthread
, kni
->core_id
);
291 wake_up_process(knet
->kni_kthread
);
294 mutex_unlock(&knet
->kni_kthread_lock
);
301 kni_ioctl_create(struct net
*net
, uint32_t ioctl_num
,
302 unsigned long ioctl_param
)
304 struct kni_net
*knet
= net_generic(net
, kni_net_id
);
306 struct rte_kni_device_info dev_info
;
307 struct net_device
*net_dev
= NULL
;
308 struct kni_dev
*kni
, *dev
, *n
;
309 #ifdef RTE_KNI_KMOD_ETHTOOL
310 struct pci_dev
*found_pci
= NULL
;
311 struct net_device
*lad_dev
= NULL
;
312 struct pci_dev
*pci
= NULL
;
315 pr_info("Creating kni...\n");
316 /* Check the buffer size, to avoid warning */
317 if (_IOC_SIZE(ioctl_num
) > sizeof(dev_info
))
320 /* Copy kni info from user space */
321 ret
= copy_from_user(&dev_info
, (void *)ioctl_param
, sizeof(dev_info
));
323 pr_err("copy_from_user in kni_ioctl_create");
327 /* Check if name is zero-ended */
328 if (strnlen(dev_info
.name
, sizeof(dev_info
.name
)) == sizeof(dev_info
.name
)) {
329 pr_err("kni.name not zero-terminated");
334 * Check if the cpu core id is valid for binding.
336 if (dev_info
.force_bind
&& !cpu_online(dev_info
.core_id
)) {
337 pr_err("cpu %u is not online\n", dev_info
.core_id
);
341 /* Check if it has been created */
342 down_read(&knet
->kni_list_lock
);
343 list_for_each_entry_safe(dev
, n
, &knet
->kni_list_head
, list
) {
344 if (kni_check_param(dev
, &dev_info
) < 0) {
345 up_read(&knet
->kni_list_lock
);
349 up_read(&knet
->kni_list_lock
);
351 net_dev
= alloc_netdev(sizeof(struct kni_dev
), dev_info
.name
,
356 if (net_dev
== NULL
) {
357 pr_err("error allocating device \"%s\"\n", dev_info
.name
);
361 dev_net_set(net_dev
, net
);
363 kni
= netdev_priv(net_dev
);
365 kni
->net_dev
= net_dev
;
366 kni
->group_id
= dev_info
.group_id
;
367 kni
->core_id
= dev_info
.core_id
;
368 strncpy(kni
->name
, dev_info
.name
, RTE_KNI_NAMESIZE
);
370 /* Translate user space info into kernel space info */
371 kni
->tx_q
= phys_to_virt(dev_info
.tx_phys
);
372 kni
->rx_q
= phys_to_virt(dev_info
.rx_phys
);
373 kni
->alloc_q
= phys_to_virt(dev_info
.alloc_phys
);
374 kni
->free_q
= phys_to_virt(dev_info
.free_phys
);
376 kni
->req_q
= phys_to_virt(dev_info
.req_phys
);
377 kni
->resp_q
= phys_to_virt(dev_info
.resp_phys
);
378 kni
->sync_va
= dev_info
.sync_va
;
379 kni
->sync_kva
= phys_to_virt(dev_info
.sync_phys
);
381 kni
->mbuf_size
= dev_info
.mbuf_size
;
383 pr_debug("tx_phys: 0x%016llx, tx_q addr: 0x%p\n",
384 (unsigned long long) dev_info
.tx_phys
, kni
->tx_q
);
385 pr_debug("rx_phys: 0x%016llx, rx_q addr: 0x%p\n",
386 (unsigned long long) dev_info
.rx_phys
, kni
->rx_q
);
387 pr_debug("alloc_phys: 0x%016llx, alloc_q addr: 0x%p\n",
388 (unsigned long long) dev_info
.alloc_phys
, kni
->alloc_q
);
389 pr_debug("free_phys: 0x%016llx, free_q addr: 0x%p\n",
390 (unsigned long long) dev_info
.free_phys
, kni
->free_q
);
391 pr_debug("req_phys: 0x%016llx, req_q addr: 0x%p\n",
392 (unsigned long long) dev_info
.req_phys
, kni
->req_q
);
393 pr_debug("resp_phys: 0x%016llx, resp_q addr: 0x%p\n",
394 (unsigned long long) dev_info
.resp_phys
, kni
->resp_q
);
395 pr_debug("mbuf_size: %u\n", kni
->mbuf_size
);
397 pr_debug("PCI: %02x:%02x.%02x %04x:%04x\n",
403 #ifdef RTE_KNI_KMOD_ETHTOOL
404 pci
= pci_get_device(dev_info
.vendor_id
, dev_info
.device_id
, NULL
);
406 /* Support Ethtool */
408 pr_debug("pci_bus: %02x:%02x:%02x\n",
410 PCI_SLOT(pci
->devfn
),
411 PCI_FUNC(pci
->devfn
));
413 if ((pci
->bus
->number
== dev_info
.bus
) &&
414 (PCI_SLOT(pci
->devfn
) == dev_info
.devid
) &&
415 (PCI_FUNC(pci
->devfn
) == dev_info
.function
)) {
418 if (pci_match_id(ixgbe_pci_tbl
, found_pci
))
419 ret
= ixgbe_kni_probe(found_pci
, &lad_dev
);
420 else if (pci_match_id(igb_pci_tbl
, found_pci
))
421 ret
= igb_kni_probe(found_pci
, &lad_dev
);
425 pr_debug("PCI found: pci=0x%p, lad_dev=0x%p\n",
428 kni
->lad_dev
= lad_dev
;
429 kni_set_ethtool_ops(kni
->net_dev
);
431 pr_err("Device not supported by ethtool");
435 kni
->pci_dev
= found_pci
;
436 kni
->device_id
= dev_info
.device_id
;
439 pci
= pci_get_device(dev_info
.vendor_id
,
440 dev_info
.device_id
, pci
);
447 ether_addr_copy(net_dev
->dev_addr
, kni
->lad_dev
->dev_addr
);
449 /* if user has provided a valid mac address */
450 if (is_valid_ether_addr(dev_info
.mac_addr
))
451 memcpy(net_dev
->dev_addr
, dev_info
.mac_addr
, ETH_ALEN
);
454 * Generate random mac address. eth_random_addr() is the
455 * newer version of generating mac address in kernel.
457 random_ether_addr(net_dev
->dev_addr
);
461 net_dev
->mtu
= dev_info
.mtu
;
462 #ifdef HAVE_MAX_MTU_PARAM
463 net_dev
->max_mtu
= net_dev
->mtu
;
466 ret
= register_netdev(net_dev
);
468 pr_err("error %i registering device \"%s\"\n",
472 free_netdev(net_dev
);
476 netif_carrier_off(net_dev
);
478 ret
= kni_run_thread(knet
, kni
, dev_info
.force_bind
);
482 down_write(&knet
->kni_list_lock
);
483 list_add(&kni
->list
, &knet
->kni_list_head
);
484 up_write(&knet
->kni_list_lock
);
490 kni_ioctl_release(struct net
*net
, uint32_t ioctl_num
,
491 unsigned long ioctl_param
)
493 struct kni_net
*knet
= net_generic(net
, kni_net_id
);
495 struct kni_dev
*dev
, *n
;
496 struct rte_kni_device_info dev_info
;
498 if (_IOC_SIZE(ioctl_num
) > sizeof(dev_info
))
501 ret
= copy_from_user(&dev_info
, (void *)ioctl_param
, sizeof(dev_info
));
503 pr_err("copy_from_user in kni_ioctl_release");
507 /* Release the network device according to its name */
508 if (strlen(dev_info
.name
) == 0)
511 down_write(&knet
->kni_list_lock
);
512 list_for_each_entry_safe(dev
, n
, &knet
->kni_list_head
, list
) {
513 if (strncmp(dev
->name
, dev_info
.name
, RTE_KNI_NAMESIZE
) != 0)
516 if (multiple_kthread_on
&& dev
->pthread
!= NULL
) {
517 kthread_stop(dev
->pthread
);
522 list_del(&dev
->list
);
526 up_write(&knet
->kni_list_lock
);
527 pr_info("%s release kni named %s\n",
528 (ret
== 0 ? "Successfully" : "Unsuccessfully"), dev_info
.name
);
534 kni_ioctl(struct inode
*inode
, uint32_t ioctl_num
, unsigned long ioctl_param
)
537 struct net
*net
= current
->nsproxy
->net_ns
;
539 pr_debug("IOCTL num=0x%0x param=0x%0lx\n", ioctl_num
, ioctl_param
);
542 * Switch according to the ioctl called
544 switch (_IOC_NR(ioctl_num
)) {
545 case _IOC_NR(RTE_KNI_IOCTL_TEST
):
546 /* For test only, not used */
548 case _IOC_NR(RTE_KNI_IOCTL_CREATE
):
549 ret
= kni_ioctl_create(net
, ioctl_num
, ioctl_param
);
551 case _IOC_NR(RTE_KNI_IOCTL_RELEASE
):
552 ret
= kni_ioctl_release(net
, ioctl_num
, ioctl_param
);
555 pr_debug("IOCTL default\n");
563 kni_compat_ioctl(struct inode
*inode
, uint32_t ioctl_num
,
564 unsigned long ioctl_param
)
566 /* 32 bits app on 64 bits OS to be supported later */
567 pr_debug("Not implemented.\n");
572 static const struct file_operations kni_fops
= {
573 .owner
= THIS_MODULE
,
575 .release
= kni_release
,
576 .unlocked_ioctl
= (void *)kni_ioctl
,
577 .compat_ioctl
= (void *)kni_compat_ioctl
,
580 static struct miscdevice kni_misc
= {
581 .minor
= MISC_DYNAMIC_MINOR
,
587 kni_parse_kthread_mode(void)
592 if (strcmp(kthread_mode
, "single") == 0)
594 else if (strcmp(kthread_mode
, "multiple") == 0)
595 multiple_kthread_on
= 1;
603 kni_parse_carrier_state(void)
610 if (strcmp(carrier
, "off") == 0)
612 else if (strcmp(carrier
, "on") == 0)
625 if (kni_parse_kthread_mode() < 0) {
626 pr_err("Invalid parameter for kthread_mode\n");
630 if (multiple_kthread_on
== 0)
631 pr_debug("Single kernel thread for all KNI devices\n");
633 pr_debug("Multiple kernel thread mode enabled\n");
635 if (kni_parse_carrier_state() < 0) {
636 pr_err("Invalid parameter for carrier\n");
640 if (dflt_carrier
== 0)
641 pr_debug("Default carrier state set to off.\n");
643 pr_debug("Default carrier state set to on.\n");
645 #ifdef HAVE_SIMPLIFIED_PERNET_OPERATIONS
646 rc
= register_pernet_subsys(&kni_net_ops
);
648 rc
= register_pernet_gen_subsys(&kni_net_id
, &kni_net_ops
);
653 rc
= misc_register(&kni_misc
);
655 pr_err("Misc registration failed\n");
659 /* Configure the lo mode according to the input parameter */
660 kni_net_config_lo_mode(lo_mode
);
665 #ifdef HAVE_SIMPLIFIED_PERNET_OPERATIONS
666 unregister_pernet_subsys(&kni_net_ops
);
668 unregister_pernet_gen_subsys(kni_net_id
, &kni_net_ops
);
676 misc_deregister(&kni_misc
);
677 #ifdef HAVE_SIMPLIFIED_PERNET_OPERATIONS
678 unregister_pernet_subsys(&kni_net_ops
);
680 unregister_pernet_gen_subsys(kni_net_id
, &kni_net_ops
);
684 module_init(kni_init
);
685 module_exit(kni_exit
);
687 module_param(lo_mode
, charp
, 0644);
688 MODULE_PARM_DESC(lo_mode
,
689 "KNI loopback mode (default=lo_mode_none):\n"
690 "\t\tlo_mode_none Kernel loopback disabled\n"
691 "\t\tlo_mode_fifo Enable kernel loopback with fifo\n"
692 "\t\tlo_mode_fifo_skb Enable kernel loopback with fifo and skb buffer\n"
696 module_param(kthread_mode
, charp
, 0644);
697 MODULE_PARM_DESC(kthread_mode
,
698 "Kernel thread mode (default=single):\n"
699 "\t\tsingle Single kernel thread mode enabled.\n"
700 "\t\tmultiple Multiple kernel thread mode enabled.\n"
704 module_param(carrier
, charp
, 0644);
705 MODULE_PARM_DESC(carrier
,
706 "Default carrier state for KNI interface (default=off):\n"
707 "\t\toff Interfaces will be created with carrier state set to off.\n"
708 "\t\ton Interfaces will be created with carrier state set to on.\n"