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
  62 /* kni kernel thread for rx */
  63 static int kni_thread(void *unused);
  64
  65 static struct file_operations kni_fops = {
  66         .owner = THIS_MODULE,
  67         .open = kni_open,
  68         .release = kni_release,
  69         .unlocked_ioctl = (void *)kni_ioctl,
  70         .compat_ioctl = (void *)kni_compat_ioctl,
  71 };
  72
  73 static struct miscdevice kni_misc = {
  74         .minor = MISC_DYNAMIC_MINOR,
  75         .name = KNI_DEVICE,
  76         .fops = &kni_fops,
  77 };
  78
  79 /* loopback mode */
  80 static char *lo_mode = NULL;
  81
  82 #define KNI_DEV_IN_USE_BIT_NUM 0 /* Bit number for device in use */
  83
  84 static volatile unsigned long device_in_use; /* device in use flag */
  85 static struct task_struct *kni_kthread;
  86
  87 /* kni list lock */
  88 static DECLARE_RWSEM(kni_list_lock);
  89
  90 /* kni list */
  91 static struct list_head kni_list_head = LIST_HEAD_INIT(kni_list_head);
  92
  93 static int __init
  94 kni_init(void)
  95 {
  96         KNI_PRINT("######## DPDK kni module loading ########\n");
  97
  98         if (misc_register(&kni_misc) != 0) {
  99                 KNI_ERR("Misc registration failed\n");
 100                 return 1;
 101         }
 102
 103         /* Clear the bit of device in use */
 104         clear_bit(KNI_DEV_IN_USE_BIT_NUM, &device_in_use);
 105
 106         /* Configure the lo mode according to the input parameter */
 107         kni_net_config_lo_mode(lo_mode);
 108
 109         KNI_PRINT("######## DPDK kni module loaded  ########\n");
 110
 111         return 0;
 112 }
 113
 114 static void __exit
 115 kni_exit(void)
 116 {
 117         misc_deregister(&kni_misc);
 118         KNI_PRINT("####### DPDK kni module unloaded  #######\n");
 119 }
 120
 121 static int
 122 kni_open(struct inode *inode, struct file *file)
 123 {
 124         /* kni device can be opened by one user only, test and set bit */
 125         if (test_and_set_bit(KNI_DEV_IN_USE_BIT_NUM, &device_in_use))
 126                 return -EBUSY;
 127
 128         /* Create kernel thread for RX */
 129         kni_kthread = kthread_run(kni_thread, NULL, "kni_thread");
 130         if (IS_ERR(kni_kthread)) {
 131                 KNI_ERR("Unable to create kernel threaed\n");
 132                 return PTR_ERR(kni_kthread);
 133         }
 134
 135         KNI_PRINT("/dev/kni opened\n");
 136
 137         return 0;
 138 }
 139
 140 static int
 141 kni_release(struct inode *inode, struct file *file)
 142 {
 143         struct kni_dev *dev, *n;
 144
 145         KNI_PRINT("Stopping KNI thread...");
 146
 147         /* Stop kernel thread */
 148         kthread_stop(kni_kthread);
 149         kni_kthread = NULL;
 150
 151         down_write(&kni_list_lock);
 152         list_for_each_entry_safe(dev, n, &kni_list_head, list) {
 153                 /* Call the remove part to restore pci dev */
 154                 switch (dev->device_id) {
 155                 #define RTE_PCI_DEV_ID_DECL_IGB(vend, dev) case (dev):
 156                 #include <rte_pci_dev_ids.h>
 157                         igb_kni_remove(dev->pci_dev);
 158                         break;
 159                 #define RTE_PCI_DEV_ID_DECL_IXGBE(vend, dev) case (dev):
 160                 #include <rte_pci_dev_ids.h>
 161                         ixgbe_kni_remove(dev->pci_dev);
 162                         break;
 163                 default:
 164                         break;
 165                 }
 166                 unregister_netdev(dev->net_dev);
 167                 free_netdev(dev->net_dev);
 168                 list_del(&dev->list);
 169         }
 170         up_write(&kni_list_lock);
 171
 172         /* Clear the bit of device in use */
 173         clear_bit(KNI_DEV_IN_USE_BIT_NUM, &device_in_use);
 174
 175         KNI_PRINT("/dev/kni closed\n");
 176
 177         return 0;
 178 }
 179
 180 static int
 181 kni_thread(void *unused)
 182 {
 183         int j;
 184         struct kni_dev *dev, *n;
 185
 186         KNI_PRINT("Kernel thread for KNI started\n");
 187         while (!kthread_should_stop()) {
 188                 down_read(&kni_list_lock);
 189                 for (j = 0; j < KNI_RX_LOOP_NUM; j++) {
 190                         list_for_each_entry_safe(dev, n,
 191                                         &kni_list_head, list) {
 192                                 kni_net_rx(dev);
 193                                 kni_net_poll_resp(dev);
 194                         }
 195                 }
 196                 up_read(&kni_list_lock);
 197                 /* reschedule out for a while */
 198                 schedule_timeout_interruptible(usecs_to_jiffies( \
 199                                 KNI_KTHREAD_RESCHEDULE_INTERVAL));
 200         }
 201         KNI_PRINT("Kernel thread for KNI stopped\n");
 202
 203         return 0;
 204 }
 205
 206 static int
 207 kni_ioctl_create(unsigned int ioctl_num, unsigned long ioctl_param)
 208 {
 209         int ret;
 210         struct rte_kni_device_info dev_info;
 211         struct pci_dev *pci = NULL;
 212         struct pci_dev *found_pci = NULL;
 213         struct net_device *net_dev = NULL;
 214         struct net_device *lad_dev = NULL;
 215         struct kni_dev *kni, *dev, *n;
 216
 217         printk(KERN_INFO "KNI: Creating kni...\n");
 218         /* Check the buffer size, to avoid warning */
 219         if (_IOC_SIZE(ioctl_num) > sizeof(dev_info))
 220                 return -EINVAL;
 221
 222         /* Copy kni info from user space */
 223         ret = copy_from_user(&dev_info, (void *)ioctl_param, sizeof(dev_info));
 224         if (ret) {
 225                 KNI_ERR("copy_from_user in kni_ioctl_create");
 226                 return -EIO;
 227         }
 228
 229         /* Check if it has been created */
 230         down_read(&kni_list_lock);
 231         list_for_each_entry_safe(dev, n, &kni_list_head, list) {
 232                 if (dev->port_id == dev_info.port_id) {
 233                         up_read(&kni_list_lock);
 234                         KNI_ERR("Port %d has already been created\n",
 235                                                 dev_info.port_id);
 236                         return -EINVAL;
 237                 }
 238         }
 239         up_read(&kni_list_lock);
 240
 241         net_dev = alloc_netdev(sizeof(struct kni_dev), dev_info.name,
 242                                                         kni_net_init);
 243         if (net_dev == NULL) {
 244                 KNI_ERR("error allocating device \"%s\"\n", dev_info.name);
 245                 return -EBUSY;
 246         }
 247
 248         kni = netdev_priv(net_dev);
 249
 250         kni->net_dev = net_dev;
 251         kni->port_id = dev_info.port_id;
 252
 253         /* Translate user space info into kernel space info */
 254         kni->tx_q = phys_to_virt(dev_info.tx_phys);
 255         kni->rx_q = phys_to_virt(dev_info.rx_phys);
 256         kni->alloc_q = phys_to_virt(dev_info.alloc_phys);
 257         kni->free_q = phys_to_virt(dev_info.free_phys);
 258
 259         kni->req_q = phys_to_virt(dev_info.req_phys);
 260         kni->resp_q = phys_to_virt(dev_info.resp_phys);
 261
 262         kni->sync_va = dev_info.sync_va;
 263         kni->sync_kva = phys_to_virt(dev_info.sync_phys);
 264
 265         kni->mbuf_kva = phys_to_virt(dev_info.mbuf_phys);
 266         kni->mbuf_va = dev_info.mbuf_va;
 267
 268         kni->mbuf_size = dev_info.mbuf_size;
 269
 270         KNI_PRINT("tx_phys:          0x%016llx, tx_q addr:          0x%p\n",
 271                                                 (unsigned long long) dev_info.tx_phys, kni->tx_q);
 272         KNI_PRINT("rx_phys:          0x%016llx, rx_q addr:          0x%p\n",
 273                                                 (unsigned long long) dev_info.rx_phys, kni->rx_q);
 274         KNI_PRINT("alloc_phys:       0x%016llx, alloc_q addr:       0x%p\n",
 275                                         (unsigned long long) dev_info.alloc_phys, kni->alloc_q);
 276         KNI_PRINT("free_phys:        0x%016llx, free_q addr:        0x%p\n",
 277                                         (unsigned long long) dev_info.free_phys, kni->free_q);
 278         KNI_PRINT("req_phys:         0x%016llx, req_q addr:         0x%p\n",
 279                                         (unsigned long long) dev_info.req_phys, kni->req_q);
 280         KNI_PRINT("resp_phys:        0x%016llx, resp_q addr:        0x%p\n",
 281                                         (unsigned long long) dev_info.resp_phys, kni->resp_q);
 282         KNI_PRINT("mbuf_phys:        0x%016llx, mbuf_kva:           0x%p\n",
 283                                         (unsigned long long) dev_info.mbuf_phys, kni->mbuf_kva);
 284         KNI_PRINT("mbuf_va:          0x%p\n", dev_info.mbuf_va);
 285         KNI_PRINT("mbuf_size:        %u\n", kni->mbuf_size);
 286
 287         KNI_DBG("PCI: %02x:%02x.%02x %04x:%04x\n", dev_info.bus, dev_info.devid,
 288                         dev_info.function, dev_info.vendor_id, dev_info.device_id);
 289
 290         pci = pci_get_device(dev_info.vendor_id, dev_info.device_id, NULL);
 291
 292         /* Support Ethtool */
 293         while (pci) {
 294                 KNI_PRINT("pci_bus: %02x:%02x:%02x \n", pci->bus->number,
 295                                 PCI_SLOT(pci->devfn), PCI_FUNC(pci->devfn));
 296
 297                 if ((pci->bus->number == dev_info.bus) &&
 298                         (PCI_SLOT(pci->devfn) == dev_info.devid) &&
 299                         (PCI_FUNC(pci->devfn) == dev_info.function)) {
 300                         found_pci = pci;
 301
 302                         switch (dev_info.device_id) {
 303                         #define RTE_PCI_DEV_ID_DECL_IGB(vend, dev) case (dev):
 304                         #include <rte_pci_dev_ids.h>
 305                                 ret = igb_kni_probe(found_pci, &lad_dev);
 306                                 break;
 307                         #define RTE_PCI_DEV_ID_DECL_IXGBE(vend, dev) case (dev):
 308                         #include <rte_pci_dev_ids.h>
 309                                 ret = ixgbe_kni_probe(found_pci, &lad_dev);
 310                                 break;
 311                         default:
 312                                 ret = -1;
 313                                 break;
 314                         }
 315
 316                         KNI_DBG("PCI found: pci=0x%p, lad_dev=0x%p\n", pci, lad_dev);
 317                         if (ret == 0) {
 318                                 kni->lad_dev = lad_dev;
 319                                 kni_set_ethtool_ops(kni->net_dev);
 320                         }
 321                         else {
 322                                 KNI_ERR("Device not supported by ethtool");
 323                                 kni->lad_dev = NULL;
 324                         }
 325
 326                         kni->pci_dev = found_pci;
 327                         kni->device_id = dev_info.device_id;
 328                         break;
 329                 }
 330                 pci = pci_get_device(dev_info.vendor_id, dev_info.device_id,
 331                                                                         pci);
 332         }
 333
 334         if (pci)
 335                 pci_dev_put(pci);
 336
 337         ret = register_netdev(net_dev);
 338         if (ret) {
 339                 KNI_ERR("error %i registering device \"%s\"\n", ret,
 340                                                         dev_info.name);
 341                 free_netdev(net_dev);
 342                 return -ENODEV;
 343         }
 344
 345         down_write(&kni_list_lock);
 346         list_add(&kni->list, &kni_list_head);
 347         up_write(&kni_list_lock);
 348         printk(KERN_INFO "KNI: Successfully create kni for port %d\n",
 349                                                 dev_info.port_id);
 350
 351         return 0;
 352 }
 353
 354 static int
 355 kni_ioctl_release(unsigned int ioctl_num, unsigned long ioctl_param)
 356 {
 357         int ret = -EINVAL;
 358         uint8_t port_id;
 359         struct kni_dev *dev, *n;
 360
 361         if (_IOC_SIZE(ioctl_num) > sizeof(port_id))
 362                         return -EINVAL;
 363
 364         ret = copy_from_user(&port_id, (void *)ioctl_param, sizeof(port_id));
 365         if (ret) {
 366                 KNI_ERR("copy_from_user in kni_ioctl_release");
 367                 return -EIO;
 368         }
 369
 370         down_write(&kni_list_lock);
 371         list_for_each_entry_safe(dev, n, &kni_list_head, list) {
 372                 if (dev->port_id != port_id)
 373                         continue;
 374
 375                 switch (dev->device_id) {
 376                 #define RTE_PCI_DEV_ID_DECL_IGB(vend, dev) case (dev):
 377                 #include <rte_pci_dev_ids.h>
 378                         igb_kni_remove(dev->pci_dev);
 379                         break;
 380                 #define RTE_PCI_DEV_ID_DECL_IXGBE(vend, dev) case (dev):
 381                 #include <rte_pci_dev_ids.h>
 382                         ixgbe_kni_remove(dev->pci_dev);
 383                         break;
 384                 default:
 385                         break;
 386                 }
 387                 unregister_netdev(dev->net_dev);
 388                 free_netdev(dev->net_dev);
 389                 list_del(&dev->list);
 390                 ret = 0;
 391                 break;
 392         }
 393         up_write(&kni_list_lock);
 394         printk(KERN_INFO "KNI: %s release kni for port %d\n",
 395                 (ret == 0 ? "Successfully" : "Unsuccessfully"), port_id);
 396
 397         return ret;
 398 }
 399
 400 static int
 401 kni_ioctl(struct inode *inode,
 402         unsigned int ioctl_num,
 403         unsigned long ioctl_param)
 404 {
 405         int ret = -EINVAL;
 406
 407         KNI_DBG("IOCTL num=0x%0x param=0x%0lx \n", ioctl_num, ioctl_param);
 408
 409         /*
 410          * Switch according to the ioctl called
 411          */
 412         switch (_IOC_NR(ioctl_num)) {
 413         case _IOC_NR(RTE_KNI_IOCTL_TEST):
 414                 /* For test only, not used */
 415                 break;
 416         case _IOC_NR(RTE_KNI_IOCTL_CREATE):
 417                 ret = kni_ioctl_create(ioctl_num, ioctl_param);
 418                 break;
 419         case _IOC_NR(RTE_KNI_IOCTL_RELEASE):
 420                 ret = kni_ioctl_release(ioctl_num, ioctl_param);
 421                 break;
 422         default:
 423                 KNI_DBG("IOCTL default \n");
 424                 break;
 425         }
 426
 427         return ret;
 428 }
 429
 430 static int
 431 kni_compat_ioctl(struct inode *inode,
 432                 unsigned int ioctl_num,
 433                 unsigned long ioctl_param)
 434 {
 435         /* 32 bits app on 64 bits OS to be supported later */
 436         KNI_PRINT("Not implemented.\n");
 437
 438         return -EINVAL;
 439 }
 440
 441 module_init(kni_init);
 442 module_exit(kni_exit);
 443
 444 module_param(lo_mode, charp, S_IRUGO | S_IWUSR);
 445 MODULE_PARM_DESC(lo_mode,
 446 "KNI loopback mode (default=lo_mode_none):\n"
 447 "    lo_mode_none        Kernel loopback disabled\n"
 448 "    lo_mode_fifo        Enable kernel loopback with fifo\n"
 449 "    lo_mode_fifo_skb    Enable kernel loopback with fifo and skb buffer\n"
 450 "\n"
 451 );
 452