lib/librte_eal/linuxapp/kni/kni_misc.c

   1 /*-
   2  * GPL LICENSE SUMMARY
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *
   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.
   9  *
  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.
  14  *
  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.
  20  *
  21  *   Contact Information:
  22  *   Intel Corporation
  23  */
  24
  25 #include <linux/module.h>
  26 #include <linux/miscdevice.h>
  27 #include <linux/netdevice.h>
  28 #include <linux/pci.h>
  29 #include <linux/kthread.h>
  30 #include <linux/rwsem.h>
  31
  32 #include <exec-env/rte_kni_common.h>
  33 #include "kni_dev.h"
  34 #include <rte_config.h>
  35
  36 MODULE_LICENSE("Dual BSD/GPL");
  37 MODULE_AUTHOR("Intel Corporation");
  38 MODULE_DESCRIPTION("Kernel Module for managing kni devices");
  39
  40 #define KNI_RX_LOOP_NUM 1000
  41
  42 #define KNI_MAX_DEVICES 32
  43
  44 extern void kni_net_rx(struct kni_dev *kni);
  45 extern void kni_net_init(struct net_device *dev);
  46 extern void kni_net_config_lo_mode(char *lo_str);
  47 extern void kni_net_poll_resp(struct kni_dev *kni);
  48 extern void kni_set_ethtool_ops(struct net_device *netdev);
  49
  50 extern int ixgbe_kni_probe(struct pci_dev *pdev, struct net_device **lad_dev);
  51 extern void ixgbe_kni_remove(struct pci_dev *pdev);
  52 extern int igb_kni_probe(struct pci_dev *pdev, struct net_device **lad_dev);
  53 extern void igb_kni_remove(struct pci_dev *pdev);
  54
  55 static int kni_open(struct inode *inode, struct file *file);
  56 static int kni_release(struct inode *inode, struct file *file);
  57 static int kni_ioctl(struct inode *inode, unsigned int ioctl_num,
  58                                         unsigned long ioctl_param);
  59 static int kni_compat_ioctl(struct inode *inode, unsigned int ioctl_num,
  60                                                 unsigned long ioctl_param);
  61 static int kni_dev_remove(struct kni_dev *dev);
  62
  63 static int __init kni_parse_kthread_mode(void);
  64
  65 /* KNI processing for single kernel thread mode */
  66 static int kni_thread_single(void *unused);
  67 /* KNI processing for multiple kernel thread mode */
  68 static int kni_thread_multiple(void *param);
  69
  70 static struct file_operations kni_fops = {
  71         .owner = THIS_MODULE,
  72         .open = kni_open,
  73         .release = kni_release,
  74         .unlocked_ioctl = (void *)kni_ioctl,
  75         .compat_ioctl = (void *)kni_compat_ioctl,
  76 };
  77
  78 static struct miscdevice kni_misc = {
  79         .minor = MISC_DYNAMIC_MINOR,
  80         .name = KNI_DEVICE,
  81         .fops = &kni_fops,
  82 };
  83
  84 /* loopback mode */
  85 static char *lo_mode = NULL;
  86
  87 /* Kernel thread mode */
  88 static char *kthread_mode = NULL;
  89 static unsigned multiple_kthread_on = 0;
  90
  91 #define KNI_DEV_IN_USE_BIT_NUM 0 /* Bit number for device in use */
  92
  93 static volatile unsigned long device_in_use; /* device in use flag */
  94 static struct task_struct *kni_kthread;
  95
  96 /* kni list lock */
  97 static DECLARE_RWSEM(kni_list_lock);
  98
  99 /* kni list */
 100 static struct list_head kni_list_head = LIST_HEAD_INIT(kni_list_head);
 101
 102 static int __init
 103 kni_init(void)
 104 {
 105         KNI_PRINT("######## DPDK kni module loading ########\n");
 106
 107         if (kni_parse_kthread_mode() < 0) {
 108                 KNI_ERR("Invalid parameter for kthread_mode\n");
 109                 return -EINVAL;
 110         }
 111
 112         if (misc_register(&kni_misc) != 0) {
 113                 KNI_ERR("Misc registration failed\n");
 114                 return -EPERM;
 115         }
 116
 117         /* Clear the bit of device in use */
 118         clear_bit(KNI_DEV_IN_USE_BIT_NUM, &device_in_use);
 119
 120         /* Configure the lo mode according to the input parameter */
 121         kni_net_config_lo_mode(lo_mode);
 122
 123         KNI_PRINT("######## DPDK kni module loaded  ########\n");
 124
 125         return 0;
 126 }
 127
 128 static void __exit
 129 kni_exit(void)
 130 {
 131         misc_deregister(&kni_misc);
 132         KNI_PRINT("####### DPDK kni module unloaded  #######\n");
 133 }
 134
 135 static int __init
 136 kni_parse_kthread_mode(void)
 137 {
 138         if (!kthread_mode)
 139                 return 0;
 140
 141         if (strcmp(kthread_mode, "single") == 0)
 142                 return 0;
 143         else if (strcmp(kthread_mode, "multiple") == 0)
 144                 multiple_kthread_on = 1;
 145         else
 146                 return -1;
 147
 148         return 0;
 149 }
 150
 151 static int
 152 kni_open(struct inode *inode, struct file *file)
 153 {
 154         /* kni device can be opened by one user only, test and set bit */
 155         if (test_and_set_bit(KNI_DEV_IN_USE_BIT_NUM, &device_in_use))
 156                 return -EBUSY;
 157
 158         /* Create kernel thread for single mode */
 159         if (multiple_kthread_on == 0) {
 160                 KNI_PRINT("Single kernel thread for all KNI devices\n");
 161                 /* Create kernel thread for RX */
 162                 kni_kthread = kthread_run(kni_thread_single, NULL,
 163                                                 "kni_single");
 164                 if (IS_ERR(kni_kthread)) {
 165                         KNI_ERR("Unable to create kernel threaed\n");
 166                         return PTR_ERR(kni_kthread);
 167                 }
 168         } else
 169                 KNI_PRINT("Multiple kernel thread mode enabled\n");
 170
 171         KNI_PRINT("/dev/kni opened\n");
 172
 173         return 0;
 174 }
 175
 176 static int
 177 kni_release(struct inode *inode, struct file *file)
 178 {
 179         struct kni_dev *dev, *n;
 180
 181         /* Stop kernel thread for single mode */
 182         if (multiple_kthread_on == 0) {
 183                 /* Stop kernel thread */
 184                 kthread_stop(kni_kthread);
 185                 kni_kthread = NULL;
 186         }
 187
 188         down_write(&kni_list_lock);
 189         list_for_each_entry_safe(dev, n, &kni_list_head, list) {
 190                 /* Stop kernel thread for multiple mode */
 191                 if (multiple_kthread_on && dev->pthread != NULL) {
 192                         kthread_stop(dev->pthread);
 193                         dev->pthread = NULL;
 194                 }
 195
 196 #ifdef RTE_KNI_VHOST
 197                 kni_vhost_backend_release(dev);
 198 #endif
 199                 kni_dev_remove(dev);
 200                 list_del(&dev->list);
 201         }
 202         up_write(&kni_list_lock);
 203
 204         /* Clear the bit of device in use */
 205         clear_bit(KNI_DEV_IN_USE_BIT_NUM, &device_in_use);
 206
 207         KNI_PRINT("/dev/kni closed\n");
 208
 209         return 0;
 210 }
 211
 212 static int
 213 kni_thread_single(void *unused)
 214 {
 215         int j;
 216         struct kni_dev *dev, *n;
 217
 218         while (!kthread_should_stop()) {
 219                 down_read(&kni_list_lock);
 220                 for (j = 0; j < KNI_RX_LOOP_NUM; j++) {
 221                         list_for_each_entry_safe(dev, n,
 222                                         &kni_list_head, list) {
 223 #ifdef RTE_KNI_VHOST
 224                                 kni_chk_vhost_rx(dev);
 225 #else
 226                                 kni_net_rx(dev);
 227 #endif
 228                                 kni_net_poll_resp(dev);
 229                         }
 230                 }
 231                 up_read(&kni_list_lock);
 232                 /* reschedule out for a while */
 233                 schedule_timeout_interruptible(usecs_to_jiffies( \
 234                                 KNI_KTHREAD_RESCHEDULE_INTERVAL));
 235         }
 236
 237         return 0;
 238 }
 239
 240 static int
 241 kni_thread_multiple(void *param)
 242 {
 243         int j;
 244         struct kni_dev *dev = (struct kni_dev *)param;
 245
 246         while (!kthread_should_stop()) {
 247                 for (j = 0; j < KNI_RX_LOOP_NUM; j++) {
 248 #ifdef RTE_KNI_VHOST
 249                         kni_chk_vhost_rx(dev);
 250 #else
 251                         kni_net_rx(dev);
 252 #endif
 253                         kni_net_poll_resp(dev);
 254                 }
 255                 schedule_timeout_interruptible(usecs_to_jiffies( \
 256                                 KNI_KTHREAD_RESCHEDULE_INTERVAL));
 257         }
 258
 259         return 0;
 260 }
 261
 262 static int
 263 kni_dev_remove(struct kni_dev *dev)
 264 {
 265         if (!dev)
 266                 return -ENODEV;
 267
 268         switch (dev->device_id) {
 269         #define RTE_PCI_DEV_ID_DECL_IGB(vend, dev) case (dev):
 270         #include <rte_pci_dev_ids.h>
 271                 igb_kni_remove(dev->pci_dev);
 272                 break;
 273         #define RTE_PCI_DEV_ID_DECL_IXGBE(vend, dev) case (dev):
 274         #include <rte_pci_dev_ids.h>
 275                 ixgbe_kni_remove(dev->pci_dev);
 276                 break;
 277         default:
 278                 break;
 279         }
 280
 281         if (dev->net_dev) {
 282                 unregister_netdev(dev->net_dev);
 283                 free_netdev(dev->net_dev);
 284         }
 285
 286         return 0;
 287 }
 288
 289 static int
 290 kni_check_param(struct kni_dev *kni, struct rte_kni_device_info *dev)
 291 {
 292         if (!kni || !dev)
 293                 return -1;
 294
 295         /* Check if network name has been used */
 296         if (!strncmp(kni->name, dev->name, RTE_KNI_NAMESIZE)) {
 297                 KNI_ERR("KNI name %s duplicated\n", dev->name);
 298                 return -1;
 299         }
 300
 301         return 0;
 302 }
 303
 304 static int
 305 kni_ioctl_create(unsigned int ioctl_num, unsigned long ioctl_param)
 306 {
 307         int ret;
 308         struct rte_kni_device_info dev_info;
 309         struct pci_dev *pci = NULL;
 310         struct pci_dev *found_pci = NULL;
 311         struct net_device *net_dev = NULL;
 312         struct net_device *lad_dev = NULL;
 313         struct kni_dev *kni, *dev, *n;
 314
 315         printk(KERN_INFO "KNI: Creating kni...\n");
 316         /* Check the buffer size, to avoid warning */
 317         if (_IOC_SIZE(ioctl_num) > sizeof(dev_info))
 318                 return -EINVAL;
 319
 320         /* Copy kni info from user space */
 321         ret = copy_from_user(&dev_info, (void *)ioctl_param, sizeof(dev_info));
 322         if (ret) {
 323                 KNI_ERR("copy_from_user in kni_ioctl_create");
 324                 return -EIO;
 325         }
 326
 327         /**
 328          * Check if the cpu core id is valid for binding,
 329          * for multiple kernel thread mode.
 330          */
 331         if (multiple_kthread_on && dev_info.force_bind &&
 332                                 !cpu_online(dev_info.core_id)) {
 333                 KNI_ERR("cpu %u is not online\n", dev_info.core_id);
 334                 return -EINVAL;
 335         }
 336
 337         /* Check if it has been created */
 338         down_read(&kni_list_lock);
 339         list_for_each_entry_safe(dev, n, &kni_list_head, list) {
 340                 if (kni_check_param(dev, &dev_info) < 0) {
 341                         up_read(&kni_list_lock);
 342                         return -EINVAL;
 343                 }
 344         }
 345         up_read(&kni_list_lock);
 346
 347         net_dev = alloc_netdev(sizeof(struct kni_dev), dev_info.name,
 348 #ifdef NET_NAME_UNKNOWN
 349                                                         NET_NAME_UNKNOWN,
 350 #endif
 351                                                         kni_net_init);
 352         if (net_dev == NULL) {
 353                 KNI_ERR("error allocating device \"%s\"\n", dev_info.name);
 354                 return -EBUSY;
 355         }
 356
 357         kni = netdev_priv(net_dev);
 358
 359         kni->net_dev = net_dev;
 360         kni->group_id = dev_info.group_id;
 361         kni->core_id = dev_info.core_id;
 362         strncpy(kni->name, dev_info.name, RTE_KNI_NAMESIZE);
 363
 364         /* Translate user space info into kernel space info */
 365         kni->tx_q = phys_to_virt(dev_info.tx_phys);
 366         kni->rx_q = phys_to_virt(dev_info.rx_phys);
 367         kni->alloc_q = phys_to_virt(dev_info.alloc_phys);
 368         kni->free_q = phys_to_virt(dev_info.free_phys);
 369
 370         kni->req_q = phys_to_virt(dev_info.req_phys);
 371         kni->resp_q = phys_to_virt(dev_info.resp_phys);
 372         kni->sync_va = dev_info.sync_va;
 373         kni->sync_kva = phys_to_virt(dev_info.sync_phys);
 374
 375         kni->mbuf_kva = phys_to_virt(dev_info.mbuf_phys);
 376         kni->mbuf_va = dev_info.mbuf_va;
 377
 378 #ifdef RTE_KNI_VHOST
 379         kni->vhost_queue = NULL;
 380         kni->vq_status = BE_STOP;
 381 #endif
 382         kni->mbuf_size = dev_info.mbuf_size;
 383
 384         KNI_PRINT("tx_phys:      0x%016llx, tx_q addr:      0x%p\n",
 385                 (unsigned long long) dev_info.tx_phys, kni->tx_q);
 386         KNI_PRINT("rx_phys:      0x%016llx, rx_q addr:      0x%p\n",
 387                 (unsigned long long) dev_info.rx_phys, kni->rx_q);
 388         KNI_PRINT("alloc_phys:   0x%016llx, alloc_q addr:   0x%p\n",
 389                 (unsigned long long) dev_info.alloc_phys, kni->alloc_q);
 390         KNI_PRINT("free_phys:    0x%016llx, free_q addr:    0x%p\n",
 391                 (unsigned long long) dev_info.free_phys, kni->free_q);
 392         KNI_PRINT("req_phys:     0x%016llx, req_q addr:     0x%p\n",
 393                 (unsigned long long) dev_info.req_phys, kni->req_q);
 394         KNI_PRINT("resp_phys:    0x%016llx, resp_q addr:    0x%p\n",
 395                 (unsigned long long) dev_info.resp_phys, kni->resp_q);
 396         KNI_PRINT("mbuf_phys:    0x%016llx, mbuf_kva:       0x%p\n",
 397                 (unsigned long long) dev_info.mbuf_phys, kni->mbuf_kva);
 398         KNI_PRINT("mbuf_va:      0x%p\n", dev_info.mbuf_va);
 399         KNI_PRINT("mbuf_size:    %u\n", kni->mbuf_size);
 400
 401         KNI_DBG("PCI: %02x:%02x.%02x %04x:%04x\n",
 402                                         dev_info.bus,
 403                                         dev_info.devid,
 404                                         dev_info.function,
 405                                         dev_info.vendor_id,
 406                                         dev_info.device_id);
 407
 408         pci = pci_get_device(dev_info.vendor_id, dev_info.device_id, NULL);
 409
 410         /* Support Ethtool */
 411         while (pci) {
 412                 KNI_PRINT("pci_bus: %02x:%02x:%02x \n",
 413                                         pci->bus->number,
 414                                         PCI_SLOT(pci->devfn),
 415                                         PCI_FUNC(pci->devfn));
 416
 417                 if ((pci->bus->number == dev_info.bus) &&
 418                         (PCI_SLOT(pci->devfn) == dev_info.devid) &&
 419                         (PCI_FUNC(pci->devfn) == dev_info.function)) {
 420                         found_pci = pci;
 421                         switch (dev_info.device_id) {
 422                         #define RTE_PCI_DEV_ID_DECL_IGB(vend, dev) case (dev):
 423                         #include <rte_pci_dev_ids.h>
 424                                 ret = igb_kni_probe(found_pci, &lad_dev);
 425                                 break;
 426                         #define RTE_PCI_DEV_ID_DECL_IXGBE(vend, dev) \
 427                                                         case (dev):
 428                         #include <rte_pci_dev_ids.h>
 429                                 ret = ixgbe_kni_probe(found_pci, &lad_dev);
 430                                 break;
 431                         default:
 432                                 ret = -1;
 433                                 break;
 434                         }
 435
 436                         KNI_DBG("PCI found: pci=0x%p, lad_dev=0x%p\n",
 437                                                         pci, lad_dev);
 438                         if (ret == 0) {
 439                                 kni->lad_dev = lad_dev;
 440                                 kni_set_ethtool_ops(kni->net_dev);
 441                         } else {
 442                                 KNI_ERR("Device not supported by ethtool");
 443                                 kni->lad_dev = NULL;
 444                         }
 445
 446                         kni->pci_dev = found_pci;
 447                         kni->device_id = dev_info.device_id;
 448                         break;
 449                 }
 450                 pci = pci_get_device(dev_info.vendor_id,
 451                                 dev_info.device_id, pci);
 452         }
 453         if (pci)
 454                 pci_dev_put(pci);
 455
 456         ret = register_netdev(net_dev);
 457         if (ret) {
 458                 KNI_ERR("error %i registering device \"%s\"\n",
 459                                         ret, dev_info.name);
 460                 kni_dev_remove(kni);
 461                 return -ENODEV;
 462         }
 463
 464 #ifdef RTE_KNI_VHOST
 465         kni_vhost_init(kni);
 466 #endif
 467
 468         /**
 469          * Create a new kernel thread for multiple mode, set its core affinity,
 470          * and finally wake it up.
 471          */
 472         if (multiple_kthread_on) {
 473                 kni->pthread = kthread_create(kni_thread_multiple,
 474                                               (void *)kni,
 475                                               "kni_%s", kni->name);
 476                 if (IS_ERR(kni->pthread)) {
 477                         kni_dev_remove(kni);
 478                         return -ECANCELED;
 479                 }
 480                 if (dev_info.force_bind)
 481                         kthread_bind(kni->pthread, kni->core_id);
 482                 wake_up_process(kni->pthread);
 483         }
 484
 485         down_write(&kni_list_lock);
 486         list_add(&kni->list, &kni_list_head);
 487         up_write(&kni_list_lock);
 488
 489         return 0;
 490 }
 491
 492 static int
 493 kni_ioctl_release(unsigned int ioctl_num, unsigned long ioctl_param)
 494 {
 495         int ret = -EINVAL;
 496         struct kni_dev *dev, *n;
 497         struct rte_kni_device_info dev_info;
 498
 499         if (_IOC_SIZE(ioctl_num) > sizeof(dev_info))
 500                         return -EINVAL;
 501
 502         ret = copy_from_user(&dev_info, (void *)ioctl_param, sizeof(dev_info));
 503         if (ret) {
 504                 KNI_ERR("copy_from_user in kni_ioctl_release");
 505                 return -EIO;
 506         }
 507
 508         /* Release the network device according to its name */
 509         if (strlen(dev_info.name) == 0)
 510                 return ret;
 511
 512         down_write(&kni_list_lock);
 513         list_for_each_entry_safe(dev, n, &kni_list_head, list) {
 514                 if (strncmp(dev->name, dev_info.name, RTE_KNI_NAMESIZE) != 0)
 515                         continue;
 516
 517                 if (multiple_kthread_on && dev->pthread != NULL) {
 518                         kthread_stop(dev->pthread);
 519                         dev->pthread = NULL;
 520                 }
 521
 522 #ifdef RTE_KNI_VHOST
 523                 kni_vhost_backend_release(dev);
 524 #endif
 525                 kni_dev_remove(dev);
 526                 list_del(&dev->list);
 527                 ret = 0;
 528                 break;
 529         }
 530         up_write(&kni_list_lock);
 531         printk(KERN_INFO "KNI: %s release kni named %s\n",
 532                 (ret == 0 ? "Successfully" : "Unsuccessfully"), dev_info.name);
 533
 534         return ret;
 535 }
 536
 537 static int
 538 kni_ioctl(struct inode *inode,
 539         unsigned int ioctl_num,
 540         unsigned long ioctl_param)
 541 {
 542         int ret = -EINVAL;
 543
 544         KNI_DBG("IOCTL num=0x%0x param=0x%0lx \n", ioctl_num, ioctl_param);
 545
 546         /*
 547          * Switch according to the ioctl called
 548          */
 549         switch (_IOC_NR(ioctl_num)) {
 550         case _IOC_NR(RTE_KNI_IOCTL_TEST):
 551                 /* For test only, not used */
 552                 break;
 553         case _IOC_NR(RTE_KNI_IOCTL_CREATE):
 554                 ret = kni_ioctl_create(ioctl_num, ioctl_param);
 555                 break;
 556         case _IOC_NR(RTE_KNI_IOCTL_RELEASE):
 557                 ret = kni_ioctl_release(ioctl_num, ioctl_param);
 558                 break;
 559         default:
 560                 KNI_DBG("IOCTL default \n");
 561                 break;
 562         }
 563
 564         return ret;
 565 }
 566
 567 static int
 568 kni_compat_ioctl(struct inode *inode,
 569                 unsigned int ioctl_num,
 570                 unsigned long ioctl_param)
 571 {
 572         /* 32 bits app on 64 bits OS to be supported later */
 573         KNI_PRINT("Not implemented.\n");
 574
 575         return -EINVAL;
 576 }
 577
 578 module_init(kni_init);
 579 module_exit(kni_exit);
 580
 581 module_param(lo_mode, charp, S_IRUGO | S_IWUSR);
 582 MODULE_PARM_DESC(lo_mode,
 583 "KNI loopback mode (default=lo_mode_none):\n"
 584 "    lo_mode_none        Kernel loopback disabled\n"
 585 "    lo_mode_fifo        Enable kernel loopback with fifo\n"
 586 "    lo_mode_fifo_skb    Enable kernel loopback with fifo and skb buffer\n"
 587 "\n"
 588 );
 589
 590 module_param(kthread_mode, charp, S_IRUGO);
 591 MODULE_PARM_DESC(kthread_mode,
 592 "Kernel thread mode (default=single):\n"
 593 "    single    Single kernel thread mode enabled.\n"
 594 "    multiple  Multiple kernel thread mode enabled.\n"
 595 "\n"
 596 );
 597