lib/librte_eal/common/eal_common_pci.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33 /*   BSD LICENSE
  34  *
  35  *   Copyright 2013-2014 6WIND S.A.
  36  *
  37  *   Redistribution and use in source and binary forms, with or without
  38  *   modification, are permitted provided that the following conditions
  39  *   are met:
  40  *
  41  *     * Redistributions of source code must retain the above copyright
  42  *       notice, this list of conditions and the following disclaimer.
  43  *     * Redistributions in binary form must reproduce the above copyright
  44  *       notice, this list of conditions and the following disclaimer in
  45  *       the documentation and/or other materials provided with the
  46  *       distribution.
  47  *     * Neither the name of 6WIND S.A. nor the names of its
  48  *       contributors may be used to endorse or promote products derived
  49  *       from this software without specific prior written permission.
  50  *
  51  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  52  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  53  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  54  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  55  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  56  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  57  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  58  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  59  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  60  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  61  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  62  */
  63
  64 #include <string.h>
  65 #include <inttypes.h>
  66 #include <stdint.h>
  67 #include <stdlib.h>
  68 #include <stdio.h>
  69 #include <sys/queue.h>
  70 #include <sys/mman.h>
  71
  72 #include <rte_interrupts.h>
  73 #include <rte_log.h>
  74 #include <rte_pci.h>
  75 #include <rte_per_lcore.h>
  76 #include <rte_memory.h>
  77 #include <rte_memzone.h>
  78 #include <rte_eal.h>
  79 #include <rte_string_fns.h>
  80 #include <rte_common.h>
  81 #include <rte_devargs.h>
  82
  83 #include "eal_private.h"
  84
  85 struct pci_driver_list pci_driver_list;
  86 struct pci_device_list pci_device_list;
  87
  88 #define SYSFS_PCI_DEVICES "/sys/bus/pci/devices"
  89
  90 const char *pci_get_sysfs_path(void)
  91 {
  92         const char *path = NULL;
  93
  94         path = getenv("SYSFS_PCI_DEVICES");
  95         if (path == NULL)
  96                 return SYSFS_PCI_DEVICES;
  97
  98         return path;
  99 }
 100
 101 static struct rte_devargs *pci_devargs_lookup(struct rte_pci_device *dev)
 102 {
 103         struct rte_devargs *devargs;
 104
 105         TAILQ_FOREACH(devargs, &devargs_list, next) {
 106                 if (devargs->type != RTE_DEVTYPE_BLACKLISTED_PCI &&
 107                         devargs->type != RTE_DEVTYPE_WHITELISTED_PCI)
 108                         continue;
 109                 if (!rte_eal_compare_pci_addr(&dev->addr, &devargs->pci.addr))
 110                         return devargs;
 111         }
 112         return NULL;
 113 }
 114
 115 /* map a particular resource from a file */
 116 void *
 117 pci_map_resource(void *requested_addr, int fd, off_t offset, size_t size,
 118                  int additional_flags)
 119 {
 120         void *mapaddr;
 121
 122         /* Map the PCI memory resource of device */
 123         mapaddr = mmap(requested_addr, size, PROT_READ | PROT_WRITE,
 124                         MAP_SHARED | additional_flags, fd, offset);
 125         if (mapaddr == MAP_FAILED) {
 126                 RTE_LOG(ERR, EAL, "%s(): cannot mmap(%d, %p, 0x%lx, 0x%lx): %s (%p)\n",
 127                         __func__, fd, requested_addr,
 128                         (unsigned long)size, (unsigned long)offset,
 129                         strerror(errno), mapaddr);
 130         } else
 131                 RTE_LOG(DEBUG, EAL, "  PCI memory mapped at %p\n", mapaddr);
 132
 133         return mapaddr;
 134 }
 135
 136 /* unmap a particular resource */
 137 void
 138 pci_unmap_resource(void *requested_addr, size_t size)
 139 {
 140         if (requested_addr == NULL)
 141                 return;
 142
 143         /* Unmap the PCI memory resource of device */
 144         if (munmap(requested_addr, size)) {
 145                 RTE_LOG(ERR, EAL, "%s(): cannot munmap(%p, 0x%lx): %s\n",
 146                         __func__, requested_addr, (unsigned long)size,
 147                         strerror(errno));
 148         } else
 149                 RTE_LOG(DEBUG, EAL, "  PCI memory unmapped at %p\n",
 150                                 requested_addr);
 151 }
 152
 153 /*
 154  * If vendor/device ID match, call the devinit() function of the
 155  * driver.
 156  */
 157 static int
 158 rte_eal_pci_probe_one_driver(struct rte_pci_driver *dr, struct rte_pci_device *dev)
 159 {
 160         int ret;
 161         const struct rte_pci_id *id_table;
 162
 163         for (id_table = dr->id_table; id_table->vendor_id != 0; id_table++) {
 164
 165                 /* check if device's identifiers match the driver's ones */
 166                 if (id_table->vendor_id != dev->id.vendor_id &&
 167                                 id_table->vendor_id != PCI_ANY_ID)
 168                         continue;
 169                 if (id_table->device_id != dev->id.device_id &&
 170                                 id_table->device_id != PCI_ANY_ID)
 171                         continue;
 172                 if (id_table->subsystem_vendor_id != dev->id.subsystem_vendor_id &&
 173                                 id_table->subsystem_vendor_id != PCI_ANY_ID)
 174                         continue;
 175                 if (id_table->subsystem_device_id != dev->id.subsystem_device_id &&
 176                                 id_table->subsystem_device_id != PCI_ANY_ID)
 177                         continue;
 178
 179                 struct rte_pci_addr *loc = &dev->addr;
 180
 181                 RTE_LOG(INFO, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
 182                                 loc->domain, loc->bus, loc->devid, loc->function,
 183                                 dev->numa_node);
 184
 185                 /* no initialization when blacklisted, return without error */
 186                 if (dev->devargs != NULL &&
 187                         dev->devargs->type == RTE_DEVTYPE_BLACKLISTED_PCI) {
 188                         RTE_LOG(DEBUG, EAL, "  Device is blacklisted, not initializing\n");
 189                         return 1;
 190                 }
 191
 192                 RTE_LOG(INFO, EAL, "  probe driver: %x:%x %s\n", dev->id.vendor_id,
 193                                 dev->id.device_id, dr->name);
 194
 195                 if (dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING) {
 196                         /* map resources for devices that use igb_uio */
 197                         ret = rte_eal_pci_map_device(dev);
 198                         if (ret != 0)
 199                                 return ret;
 200                 } else if (dr->drv_flags & RTE_PCI_DRV_FORCE_UNBIND &&
 201                                 rte_eal_process_type() == RTE_PROC_PRIMARY) {
 202                         /* unbind current driver */
 203                         if (pci_unbind_kernel_driver(dev) < 0)
 204                                 return -1;
 205                 }
 206
 207                 /* reference driver structure */
 208                 dev->driver = dr;
 209
 210                 /* call the driver devinit() function */
 211                 return dr->devinit(dr, dev);
 212         }
 213         /* return positive value if driver doesn't support this device */
 214         return 1;
 215 }
 216
 217 /*
 218  * If vendor/device ID match, call the devuninit() function of the
 219  * driver.
 220  */
 221 static int
 222 rte_eal_pci_detach_dev(struct rte_pci_driver *dr,
 223                 struct rte_pci_device *dev)
 224 {
 225         const struct rte_pci_id *id_table;
 226
 227         if ((dr == NULL) || (dev == NULL))
 228                 return -EINVAL;
 229
 230         for (id_table = dr->id_table; id_table->vendor_id != 0; id_table++) {
 231
 232                 /* check if device's identifiers match the driver's ones */
 233                 if (id_table->vendor_id != dev->id.vendor_id &&
 234                                 id_table->vendor_id != PCI_ANY_ID)
 235                         continue;
 236                 if (id_table->device_id != dev->id.device_id &&
 237                                 id_table->device_id != PCI_ANY_ID)
 238                         continue;
 239                 if (id_table->subsystem_vendor_id != dev->id.subsystem_vendor_id &&
 240                                 id_table->subsystem_vendor_id != PCI_ANY_ID)
 241                         continue;
 242                 if (id_table->subsystem_device_id != dev->id.subsystem_device_id &&
 243                                 id_table->subsystem_device_id != PCI_ANY_ID)
 244                         continue;
 245
 246                 struct rte_pci_addr *loc = &dev->addr;
 247
 248                 RTE_LOG(DEBUG, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
 249                                 loc->domain, loc->bus, loc->devid,
 250                                 loc->function, dev->numa_node);
 251
 252                 RTE_LOG(DEBUG, EAL, "  remove driver: %x:%x %s\n", dev->id.vendor_id,
 253                                 dev->id.device_id, dr->name);
 254
 255                 if (dr->devuninit && (dr->devuninit(dev) < 0))
 256                         return -1;      /* negative value is an error */
 257
 258                 /* clear driver structure */
 259                 dev->driver = NULL;
 260
 261                 if (dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING)
 262                         /* unmap resources for devices that use igb_uio */
 263                         rte_eal_pci_unmap_device(dev);
 264
 265                 return 0;
 266         }
 267
 268         /* return positive value if driver doesn't support this device */
 269         return 1;
 270 }
 271
 272 /*
 273  * If vendor/device ID match, call the devinit() function of all
 274  * registered driver for the given device. Return -1 if initialization
 275  * failed, return 1 if no driver is found for this device.
 276  */
 277 static int
 278 pci_probe_all_drivers(struct rte_pci_device *dev)
 279 {
 280         struct rte_pci_driver *dr = NULL;
 281         int rc = 0;
 282
 283         if (dev == NULL)
 284                 return -1;
 285
 286         TAILQ_FOREACH(dr, &pci_driver_list, next) {
 287                 rc = rte_eal_pci_probe_one_driver(dr, dev);
 288                 if (rc < 0)
 289                         /* negative value is an error */
 290                         return -1;
 291                 if (rc > 0)
 292                         /* positive value means driver doesn't support it */
 293                         continue;
 294                 return 0;
 295         }
 296         return 1;
 297 }
 298
 299 /*
 300  * If vendor/device ID match, call the devuninit() function of all
 301  * registered driver for the given device. Return -1 if initialization
 302  * failed, return 1 if no driver is found for this device.
 303  */
 304 static int
 305 pci_detach_all_drivers(struct rte_pci_device *dev)
 306 {
 307         struct rte_pci_driver *dr = NULL;
 308         int rc = 0;
 309
 310         if (dev == NULL)
 311                 return -1;
 312
 313         TAILQ_FOREACH(dr, &pci_driver_list, next) {
 314                 rc = rte_eal_pci_detach_dev(dr, dev);
 315                 if (rc < 0)
 316                         /* negative value is an error */
 317                         return -1;
 318                 if (rc > 0)
 319                         /* positive value means driver doesn't support it */
 320                         continue;
 321                 return 0;
 322         }
 323         return 1;
 324 }
 325
 326 /*
 327  * Find the pci device specified by pci address, then invoke probe function of
 328  * the driver of the devive.
 329  */
 330 int
 331 rte_eal_pci_probe_one(const struct rte_pci_addr *addr)
 332 {
 333         struct rte_pci_device *dev = NULL;
 334         int ret = 0;
 335
 336         if (addr == NULL)
 337                 return -1;
 338
 339         TAILQ_FOREACH(dev, &pci_device_list, next) {
 340                 if (rte_eal_compare_pci_addr(&dev->addr, addr))
 341                         continue;
 342
 343                 ret = pci_probe_all_drivers(dev);
 344                 if (ret < 0)
 345                         goto err_return;
 346                 return 0;
 347         }
 348         return -1;
 349
 350 err_return:
 351         RTE_LOG(WARNING, EAL, "Requested device " PCI_PRI_FMT
 352                         " cannot be used\n", dev->addr.domain, dev->addr.bus,
 353                         dev->addr.devid, dev->addr.function);
 354         return -1;
 355 }
 356
 357 /*
 358  * Detach device specified by its pci address.
 359  */
 360 int
 361 rte_eal_pci_detach(const struct rte_pci_addr *addr)
 362 {
 363         struct rte_pci_device *dev = NULL;
 364         int ret = 0;
 365
 366         if (addr == NULL)
 367                 return -1;
 368
 369         TAILQ_FOREACH(dev, &pci_device_list, next) {
 370                 if (rte_eal_compare_pci_addr(&dev->addr, addr))
 371                         continue;
 372
 373                 ret = pci_detach_all_drivers(dev);
 374                 if (ret < 0)
 375                         goto err_return;
 376
 377                 TAILQ_REMOVE(&pci_device_list, dev, next);
 378                 return 0;
 379         }
 380         return -1;
 381
 382 err_return:
 383         RTE_LOG(WARNING, EAL, "Requested device " PCI_PRI_FMT
 384                         " cannot be used\n", dev->addr.domain, dev->addr.bus,
 385                         dev->addr.devid, dev->addr.function);
 386         return -1;
 387 }
 388
 389 /*
 390  * Scan the content of the PCI bus, and call the devinit() function for
 391  * all registered drivers that have a matching entry in its id_table
 392  * for discovered devices.
 393  */
 394 int
 395 rte_eal_pci_probe(void)
 396 {
 397         struct rte_pci_device *dev = NULL;
 398         struct rte_devargs *devargs;
 399         int probe_all = 0;
 400         int ret = 0;
 401
 402         if (rte_eal_devargs_type_count(RTE_DEVTYPE_WHITELISTED_PCI) == 0)
 403                 probe_all = 1;
 404
 405         TAILQ_FOREACH(dev, &pci_device_list, next) {
 406
 407                 /* set devargs in PCI structure */
 408                 devargs = pci_devargs_lookup(dev);
 409                 if (devargs != NULL)
 410                         dev->devargs = devargs;
 411
 412                 /* probe all or only whitelisted devices */
 413                 if (probe_all)
 414                         ret = pci_probe_all_drivers(dev);
 415                 else if (devargs != NULL &&
 416                         devargs->type == RTE_DEVTYPE_WHITELISTED_PCI)
 417                         ret = pci_probe_all_drivers(dev);
 418                 if (ret < 0)
 419                         rte_exit(EXIT_FAILURE, "Requested device " PCI_PRI_FMT
 420                                  " cannot be used\n", dev->addr.domain, dev->addr.bus,
 421                                  dev->addr.devid, dev->addr.function);
 422         }
 423
 424         return 0;
 425 }
 426
 427 /* dump one device */
 428 static int
 429 pci_dump_one_device(FILE *f, struct rte_pci_device *dev)
 430 {
 431         int i;
 432
 433         fprintf(f, PCI_PRI_FMT, dev->addr.domain, dev->addr.bus,
 434                dev->addr.devid, dev->addr.function);
 435         fprintf(f, " - vendor:%x device:%x\n", dev->id.vendor_id,
 436                dev->id.device_id);
 437
 438         for (i = 0; i != sizeof(dev->mem_resource) /
 439                 sizeof(dev->mem_resource[0]); i++) {
 440                 fprintf(f, "   %16.16"PRIx64" %16.16"PRIx64"\n",
 441                         dev->mem_resource[i].phys_addr,
 442                         dev->mem_resource[i].len);
 443         }
 444         return 0;
 445 }
 446
 447 /* dump devices on the bus */
 448 void
 449 rte_eal_pci_dump(FILE *f)
 450 {
 451         struct rte_pci_device *dev = NULL;
 452
 453         TAILQ_FOREACH(dev, &pci_device_list, next) {
 454                 pci_dump_one_device(f, dev);
 455         }
 456 }
 457
 458 /* register a driver */
 459 void
 460 rte_eal_pci_register(struct rte_pci_driver *driver)
 461 {
 462         TAILQ_INSERT_TAIL(&pci_driver_list, driver, next);
 463 }
 464
 465 /* unregister a driver */
 466 void
 467 rte_eal_pci_unregister(struct rte_pci_driver *driver)
 468 {
 469         TAILQ_REMOVE(&pci_driver_list, driver, next);
 470 }