lib/librte_eal/linuxapp/kni/kni_misc.c

   1 /*-
   2  * GPL LICENSE SUMMARY
   3  *
   4  *   Copyright(c) 2010-2013 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                 kni_dev_remove(dev);
 197                 list_del(&dev->list);
 198         }
 199         up_write(&kni_list_lock);
 200
 201         /* Clear the bit of device in use */
 202         clear_bit(KNI_DEV_IN_USE_BIT_NUM, &device_in_use);
 203
 204         KNI_PRINT("/dev/kni closed\n");
 205
 206         return 0;
 207 }
 208
 209 static int
 210 kni_thread_single(void *unused)
 211 {
 212         int j;
 213         struct kni_dev *dev, *n;
 214
 215         while (!kthread_should_stop()) {
 216                 down_read(&kni_list_lock);
 217                 for (j = 0; j < KNI_RX_LOOP_NUM; j++) {
 218                         list_for_each_entry_safe(dev, n,
 219                                         &kni_list_head, list) {
 220                                 kni_net_rx(dev);
 221                                 kni_net_poll_resp(dev);
 222                         }
 223                 }
 224                 up_read(&kni_list_lock);
 225                 /* reschedule out for a while */
 226                 schedule_timeout_interruptible(usecs_to_jiffies( \
 227                                 KNI_KTHREAD_RESCHEDULE_INTERVAL));
 228         }
 229
 230         return 0;
 231 }
 232
 233 static int
 234 kni_thread_multiple(void *param)
 235 {
 236         int j;
 237         struct kni_dev *dev = (struct kni_dev *)param;
 238
 239         while (!kthread_should_stop()) {
 240                 for (j = 0; j < KNI_RX_LOOP_NUM; j++) {
 241                         kni_net_rx(dev);
 242                         kni_net_poll_resp(dev);
 243                 }
 244                 schedule_timeout_interruptible(usecs_to_jiffies( \
 245                                 KNI_KTHREAD_RESCHEDULE_INTERVAL));
 246         }
 247
 248         return 0;
 249 }
 250
 251 static int
 252 kni_dev_remove(struct kni_dev *dev)
 253 {
 254         if (!dev)
 255                 return -ENODEV;
 256
 257         switch (dev->device_id) {
 258         #define RTE_PCI_DEV_ID_DECL_IGB(vend, dev) case (dev):
 259         #include <rte_pci_dev_ids.h>
 260                 igb_kni_remove(dev->pci_dev);
 261                 break;
 262         #define RTE_PCI_DEV_ID_DECL_IXGBE(vend, dev) case (dev):
 263         #include <rte_pci_dev_ids.h>
 264                 ixgbe_kni_remove(dev->pci_dev);
 265                 break;
 266         default:
 267                 break;
 268         }
 269
 270         if (dev->net_dev) {
 271                 unregister_netdev(dev->net_dev);
 272                 free_netdev(dev->net_dev);
 273         }
 274
 275         return 0;
 276 }
 277
 278 static int
 279 kni_check_param(struct kni_dev *kni, struct rte_kni_device_info *dev)
 280 {
 281         if (!kni || !dev)
 282                 return -1;
 283
 284         /* Check if network name has been used */
 285         if (!strncmp(kni->name, dev->name, RTE_KNI_NAMESIZE)) {
 286                 KNI_ERR("KNI name %s duplicated\n", dev->name);
 287                 return -1;
 288         }
 289
 290         return 0;
 291 }
 292
 293 static int
 294 kni_ioctl_create(unsigned int ioctl_num, unsigned long ioctl_param)
 295 {
 296         int ret;
 297         struct rte_kni_device_info dev_info;
 298         struct pci_dev *pci = NULL;
 299         struct pci_dev *found_pci = NULL;
 300         struct net_device *net_dev = NULL;
 301         struct net_device *lad_dev = NULL;
 302         struct kni_dev *kni, *dev, *n;
 303
 304         printk(KERN_INFO "KNI: Creating kni...\n");
 305         /* Check the buffer size, to avoid warning */
 306         if (_IOC_SIZE(ioctl_num) > sizeof(dev_info))
 307                 return -EINVAL;
 308
 309         /* Copy kni info from user space */
 310         ret = copy_from_user(&dev_info, (void *)ioctl_param, sizeof(dev_info));
 311         if (ret) {
 312                 KNI_ERR("copy_from_user in kni_ioctl_create");
 313                 return -EIO;
 314         }
 315
 316         /**
 317          * Check if the cpu core id is valid for binding,
 318          * for multiple kernel thread mode.
 319          */
 320         if (multiple_kthread_on && dev_info.force_bind &&
 321                                 !cpu_online(dev_info.core_id)) {
 322                 KNI_ERR("cpu %u is not online\n", dev_info.core_id);
 323                 return -EINVAL;
 324         }
 325
 326         /* Check if it has been created */
 327         down_read(&kni_list_lock);
 328         list_for_each_entry_safe(dev, n, &kni_list_head, list) {
 329                 if (kni_check_param(dev, &dev_info) < 0) {
 330                         up_read(&kni_list_lock);
 331                         return -EINVAL;
 332                 }
 333         }
 334         up_read(&kni_list_lock);
 335
 336         net_dev = alloc_netdev(sizeof(struct kni_dev), dev_info.name,
 337                                                         kni_net_init);
 338         if (net_dev == NULL) {
 339                 KNI_ERR("error allocating device \"%s\"\n", dev_info.name);
 340                 return -EBUSY;
 341         }
 342
 343         kni = netdev_priv(net_dev);
 344
 345         kni->net_dev = net_dev;
 346         kni->group_id = dev_info.group_id;
 347         kni->core_id = dev_info.core_id;
 348         strncpy(kni->name, dev_info.name, RTE_KNI_NAMESIZE);
 349
 350         /* Translate user space info into kernel space info */
 351         kni->tx_q = phys_to_virt(dev_info.tx_phys);
 352         kni->rx_q = phys_to_virt(dev_info.rx_phys);
 353         kni->alloc_q = phys_to_virt(dev_info.alloc_phys);
 354         kni->free_q = phys_to_virt(dev_info.free_phys);
 355
 356         kni->req_q = phys_to_virt(dev_info.req_phys);
 357         kni->resp_q = phys_to_virt(dev_info.resp_phys);
 358         kni->sync_va = dev_info.sync_va;
 359         kni->sync_kva = phys_to_virt(dev_info.sync_phys);
 360
 361         kni->mbuf_kva = phys_to_virt(dev_info.mbuf_phys);
 362         kni->mbuf_va = dev_info.mbuf_va;
 363
 364         kni->mbuf_size = dev_info.mbuf_size;
 365
 366         KNI_PRINT("tx_phys:      0x%016llx, tx_q addr:      0x%p\n",
 367                 (unsigned long long) dev_info.tx_phys, kni->tx_q);
 368         KNI_PRINT("rx_phys:      0x%016llx, rx_q addr:      0x%p\n",
 369                 (unsigned long long) dev_info.rx_phys, kni->rx_q);
 370         KNI_PRINT("alloc_phys:   0x%016llx, alloc_q addr:   0x%p\n",
 371                 (unsigned long long) dev_info.alloc_phys, kni->alloc_q);
 372         KNI_PRINT("free_phys:    0x%016llx, free_q addr:    0x%p\n",
 373                 (unsigned long long) dev_info.free_phys, kni->free_q);
 374         KNI_PRINT("req_phys:     0x%016llx, req_q addr:     0x%p\n",
 375                 (unsigned long long) dev_info.req_phys, kni->req_q);
 376         KNI_PRINT("resp_phys:    0x%016llx, resp_q addr:    0x%p\n",
 377                 (unsigned long long) dev_info.resp_phys, kni->resp_q);
 378         KNI_PRINT("mbuf_phys:    0x%016llx, mbuf_kva:       0x%p\n",
 379                 (unsigned long long) dev_info.mbuf_phys, kni->mbuf_kva);
 380         KNI_PRINT("mbuf_va:      0x%p\n", dev_info.mbuf_va);
 381         KNI_PRINT("mbuf_size:    %u\n", kni->mbuf_size);
 382
 383         KNI_DBG("PCI: %02x:%02x.%02x %04x:%04x\n",
 384                                         dev_info.bus,
 385                                         dev_info.devid,
 386                                         dev_info.function,
 387                                         dev_info.vendor_id,
 388                                         dev_info.device_id);
 389
 390         pci = pci_get_device(dev_info.vendor_id, dev_info.device_id, NULL);
 391
 392         /* Support Ethtool */
 393         while (pci) {
 394                 KNI_PRINT("pci_bus: %02x:%02x:%02x \n",
 395                                         pci->bus->number,
 396                                         PCI_SLOT(pci->devfn),
 397                                         PCI_FUNC(pci->devfn));
 398
 399                 if ((pci->bus->number == dev_info.bus) &&
 400                         (PCI_SLOT(pci->devfn) == dev_info.devid) &&
 401                         (PCI_FUNC(pci->devfn) == dev_info.function)) {
 402                         found_pci = pci;
 403                         switch (dev_info.device_id) {
 404                         #define RTE_PCI_DEV_ID_DECL_IGB(vend, dev) case (dev):
 405                         #include <rte_pci_dev_ids.h>
 406                                 ret = igb_kni_probe(found_pci, &lad_dev);
 407                                 break;
 408                         #define RTE_PCI_DEV_ID_DECL_IXGBE(vend, dev) \
 409                                                         case (dev):
 410                         #include <rte_pci_dev_ids.h>
 411                                 ret = ixgbe_kni_probe(found_pci, &lad_dev);
 412                                 break;
 413                         default:
 414                                 ret = -1;
 415                                 break;
 416                         }
 417
 418                         KNI_DBG("PCI found: pci=0x%p, lad_dev=0x%p\n",
 419                                                         pci, lad_dev);
 420                         if (ret == 0) {
 421                                 kni->lad_dev = lad_dev;
 422                                 kni_set_ethtool_ops(kni->net_dev);
 423                         } else {
 424                                 KNI_ERR("Device not supported by ethtool");
 425                                 kni->lad_dev = NULL;
 426                         }
 427
 428                         kni->pci_dev = found_pci;
 429                         kni->device_id = dev_info.device_id;
 430                         break;
 431                 }
 432                 pci = pci_get_device(dev_info.vendor_id,
 433                                 dev_info.device_id, pci);
 434         }
 435         if (pci)
 436                 pci_dev_put(pci);
 437
 438         ret = register_netdev(net_dev);
 439         if (ret) {
 440                 KNI_ERR("error %i registering device \"%s\"\n",
 441                                         ret, dev_info.name);
 442                 kni_dev_remove(kni);
 443                 return -ENODEV;
 444         }
 445
 446         /**
 447          * Create a new kernel thread for multiple mode, set its core affinity,
 448          * and finally wake it up.
 449          */
 450         if (multiple_kthread_on) {
 451                 kni->pthread = kthread_create(kni_thread_multiple,
 452                                               (void *)kni,
 453                                               "kni_%s", kni->name);
 454                 if (IS_ERR(kni->pthread)) {
 455                         kni_dev_remove(kni);
 456                         return -ECANCELED;
 457                 }
 458                 if (dev_info.force_bind)
 459                         kthread_bind(kni->pthread, kni->core_id);
 460                 wake_up_process(kni->pthread);
 461         }
 462
 463         down_write(&kni_list_lock);
 464         list_add(&kni->list, &kni_list_head);
 465         up_write(&kni_list_lock);
 466
 467         return 0;
 468 }
 469
 470 static int
 471 kni_ioctl_release(unsigned int ioctl_num, unsigned long ioctl_param)
 472 {
 473         int ret = -EINVAL;
 474         struct kni_dev *dev, *n;
 475         struct rte_kni_device_info dev_info;
 476
 477         if (_IOC_SIZE(ioctl_num) > sizeof(dev_info))
 478                         return -EINVAL;
 479
 480         ret = copy_from_user(&dev_info, (void *)ioctl_param, sizeof(dev_info));
 481         if (ret) {
 482                 KNI_ERR("copy_from_user in kni_ioctl_release");
 483                 return -EIO;
 484         }
 485
 486         /* Release the network device according to its name */
 487         if (strlen(dev_info.name) == 0)
 488                 return ret;
 489
 490         down_write(&kni_list_lock);
 491         list_for_each_entry_safe(dev, n, &kni_list_head, list) {
 492                 if (strncmp(dev->name, dev_info.name, RTE_KNI_NAMESIZE) != 0)
 493                         continue;
 494
 495                 if (multiple_kthread_on && dev->pthread != NULL) {
 496                         kthread_stop(dev->pthread);
 497                         dev->pthread = NULL;
 498                 }
 499
 500                 kni_dev_remove(dev);
 501                 list_del(&dev->list);
 502                 ret = 0;
 503                 break;
 504         }
 505         up_write(&kni_list_lock);
 506         printk(KERN_INFO "KNI: %s release kni named %s\n",
 507                 (ret == 0 ? "Successfully" : "Unsuccessfully"), dev_info.name);
 508
 509         return ret;
 510 }
 511
 512 static int
 513 kni_ioctl(struct inode *inode,
 514         unsigned int ioctl_num,
 515         unsigned long ioctl_param)
 516 {
 517         int ret = -EINVAL;
 518
 519         KNI_DBG("IOCTL num=0x%0x param=0x%0lx \n", ioctl_num, ioctl_param);
 520
 521         /*
 522          * Switch according to the ioctl called
 523          */
 524         switch (_IOC_NR(ioctl_num)) {
 525         case _IOC_NR(RTE_KNI_IOCTL_TEST):
 526                 /* For test only, not used */
 527                 break;
 528         case _IOC_NR(RTE_KNI_IOCTL_CREATE):
 529                 ret = kni_ioctl_create(ioctl_num, ioctl_param);
 530                 break;
 531         case _IOC_NR(RTE_KNI_IOCTL_RELEASE):
 532                 ret = kni_ioctl_release(ioctl_num, ioctl_param);
 533                 break;
 534         default:
 535                 KNI_DBG("IOCTL default \n");
 536                 break;
 537         }
 538
 539         return ret;
 540 }
 541
 542 static int
 543 kni_compat_ioctl(struct inode *inode,
 544                 unsigned int ioctl_num,
 545                 unsigned long ioctl_param)
 546 {
 547         /* 32 bits app on 64 bits OS to be supported later */
 548         KNI_PRINT("Not implemented.\n");
 549
 550         return -EINVAL;
 551 }
 552
 553 module_init(kni_init);
 554 module_exit(kni_exit);
 555
 556 module_param(lo_mode, charp, S_IRUGO | S_IWUSR);
 557 MODULE_PARM_DESC(lo_mode,
 558 "KNI loopback mode (default=lo_mode_none):\n"
 559 "    lo_mode_none        Kernel loopback disabled\n"
 560 "    lo_mode_fifo        Enable kernel loopback with fifo\n"
 561 "    lo_mode_fifo_skb    Enable kernel loopback with fifo and skb buffer\n"
 562 "\n"
 563 );
 564
 565 module_param(kthread_mode, charp, S_IRUGO);
 566 MODULE_PARM_DESC(kthread_mode,
 567 "Kernel thread mode (default=single):\n"
 568 "    single    Single kernel thread mode enabled.\n"
 569 "    multiple  Multiple kernel thread mode enabled.\n"
 570 "\n"
 571 );
 572