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 static struct rte_devargs *pci_devargs_lookup(struct rte_pci_device *dev)
  89 {
  90         struct rte_devargs *devargs;
  91
  92         TAILQ_FOREACH(devargs, &devargs_list, next) {
  93                 if (devargs->type != RTE_DEVTYPE_BLACKLISTED_PCI &&
  94                         devargs->type != RTE_DEVTYPE_WHITELISTED_PCI)
  95                         continue;
  96                 if (!rte_eal_compare_pci_addr(&dev->addr, &devargs->pci.addr))
  97                         return devargs;
  98         }
  99         return NULL;
 100 }
 101
 102 /* map a particular resource from a file */
 103 void *
 104 pci_map_resource(void *requested_addr, int fd, off_t offset, size_t size,
 105                  int additional_flags)
 106 {
 107         void *mapaddr;
 108
 109         /* Map the PCI memory resource of device */
 110         mapaddr = mmap(requested_addr, size, PROT_READ | PROT_WRITE,
 111                         MAP_SHARED | additional_flags, fd, offset);
 112         if (mapaddr == MAP_FAILED) {
 113                 RTE_LOG(ERR, EAL, "%s(): cannot mmap(%d, %p, 0x%lx, 0x%lx): %s (%p)\n",
 114                         __func__, fd, requested_addr,
 115                         (unsigned long)size, (unsigned long)offset,
 116                         strerror(errno), mapaddr);
 117         } else
 118                 RTE_LOG(DEBUG, EAL, "  PCI memory mapped at %p\n", mapaddr);
 119
 120         return mapaddr;
 121 }
 122
 123 /* unmap a particular resource */
 124 void
 125 pci_unmap_resource(void *requested_addr, size_t size)
 126 {
 127         if (requested_addr == NULL)
 128                 return;
 129
 130         /* Unmap the PCI memory resource of device */
 131         if (munmap(requested_addr, size)) {
 132                 RTE_LOG(ERR, EAL, "%s(): cannot munmap(%p, 0x%lx): %s\n",
 133                         __func__, requested_addr, (unsigned long)size,
 134                         strerror(errno));
 135         } else
 136                 RTE_LOG(DEBUG, EAL, "  PCI memory unmapped at %p\n",
 137                                 requested_addr);
 138 }
 139
 140 /*
 141  * If vendor/device ID match, call the devinit() function of the
 142  * driver.
 143  */
 144 static int
 145 rte_eal_pci_probe_one_driver(struct rte_pci_driver *dr, struct rte_pci_device *dev)
 146 {
 147         int ret;
 148         const struct rte_pci_id *id_table;
 149
 150         for (id_table = dr->id_table; id_table->vendor_id != 0; id_table++) {
 151
 152                 /* check if device's identifiers match the driver's ones */
 153                 if (id_table->vendor_id != dev->id.vendor_id &&
 154                                 id_table->vendor_id != PCI_ANY_ID)
 155                         continue;
 156                 if (id_table->device_id != dev->id.device_id &&
 157                                 id_table->device_id != PCI_ANY_ID)
 158                         continue;
 159                 if (id_table->subsystem_vendor_id != dev->id.subsystem_vendor_id &&
 160                                 id_table->subsystem_vendor_id != PCI_ANY_ID)
 161                         continue;
 162                 if (id_table->subsystem_device_id != dev->id.subsystem_device_id &&
 163                                 id_table->subsystem_device_id != PCI_ANY_ID)
 164                         continue;
 165
 166                 struct rte_pci_addr *loc = &dev->addr;
 167
 168                 RTE_LOG(DEBUG, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
 169                                 loc->domain, loc->bus, loc->devid, loc->function,
 170                                 dev->numa_node);
 171
 172                 RTE_LOG(DEBUG, EAL, "  probe driver: %x:%x %s\n", dev->id.vendor_id,
 173                                 dev->id.device_id, dr->name);
 174
 175                 /* no initialization when blacklisted, return without error */
 176                 if (dev->devargs != NULL &&
 177                         dev->devargs->type == RTE_DEVTYPE_BLACKLISTED_PCI) {
 178                         RTE_LOG(DEBUG, EAL, "  Device is blacklisted, not initializing\n");
 179                         return 1;
 180                 }
 181
 182                 if (dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING) {
 183                         /* map resources for devices that use igb_uio */
 184                         ret = rte_eal_pci_map_device(dev);
 185                         if (ret != 0)
 186                                 return ret;
 187                 } else if (dr->drv_flags & RTE_PCI_DRV_FORCE_UNBIND &&
 188                                 rte_eal_process_type() == RTE_PROC_PRIMARY) {
 189                         /* unbind current driver */
 190                         if (pci_unbind_kernel_driver(dev) < 0)
 191                                 return -1;
 192                 }
 193
 194                 /* reference driver structure */
 195                 dev->driver = dr;
 196
 197                 /* call the driver devinit() function */
 198                 return dr->devinit(dr, dev);
 199         }
 200         /* return positive value if driver doesn't support this device */
 201         return 1;
 202 }
 203
 204 /*
 205  * If vendor/device ID match, call the devuninit() function of the
 206  * driver.
 207  */
 208 static int
 209 rte_eal_pci_detach_dev(struct rte_pci_driver *dr,
 210                 struct rte_pci_device *dev)
 211 {
 212         const struct rte_pci_id *id_table;
 213
 214         if ((dr == NULL) || (dev == NULL))
 215                 return -EINVAL;
 216
 217         for (id_table = dr->id_table; id_table->vendor_id != 0; id_table++) {
 218
 219                 /* check if device's identifiers match the driver's ones */
 220                 if (id_table->vendor_id != dev->id.vendor_id &&
 221                                 id_table->vendor_id != PCI_ANY_ID)
 222                         continue;
 223                 if (id_table->device_id != dev->id.device_id &&
 224                                 id_table->device_id != PCI_ANY_ID)
 225                         continue;
 226                 if (id_table->subsystem_vendor_id != dev->id.subsystem_vendor_id &&
 227                                 id_table->subsystem_vendor_id != PCI_ANY_ID)
 228                         continue;
 229                 if (id_table->subsystem_device_id != dev->id.subsystem_device_id &&
 230                                 id_table->subsystem_device_id != PCI_ANY_ID)
 231                         continue;
 232
 233                 struct rte_pci_addr *loc = &dev->addr;
 234
 235                 RTE_LOG(DEBUG, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
 236                                 loc->domain, loc->bus, loc->devid,
 237                                 loc->function, dev->numa_node);
 238
 239                 RTE_LOG(DEBUG, EAL, "  remove driver: %x:%x %s\n", dev->id.vendor_id,
 240                                 dev->id.device_id, dr->name);
 241
 242                 if (dr->devuninit && (dr->devuninit(dev) < 0))
 243                         return -1;      /* negative value is an error */
 244
 245                 /* clear driver structure */
 246                 dev->driver = NULL;
 247
 248                 if (dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING)
 249                         /* unmap resources for devices that use igb_uio */
 250                         rte_eal_pci_unmap_device(dev);
 251
 252                 return 0;
 253         }
 254
 255         /* return positive value if driver doesn't support this device */
 256         return 1;
 257 }
 258
 259 /*
 260  * If vendor/device ID match, call the devinit() function of all
 261  * registered driver for the given device. Return -1 if initialization
 262  * failed, return 1 if no driver is found for this device.
 263  */
 264 static int
 265 pci_probe_all_drivers(struct rte_pci_device *dev)
 266 {
 267         struct rte_pci_driver *dr = NULL;
 268         int rc = 0;
 269
 270         if (dev == NULL)
 271                 return -1;
 272
 273         TAILQ_FOREACH(dr, &pci_driver_list, next) {
 274                 rc = rte_eal_pci_probe_one_driver(dr, dev);
 275                 if (rc < 0)
 276                         /* negative value is an error */
 277                         return -1;
 278                 if (rc > 0)
 279                         /* positive value means driver doesn't support it */
 280                         continue;
 281                 return 0;
 282         }
 283         return 1;
 284 }
 285
 286 /*
 287  * If vendor/device ID match, call the devuninit() function of all
 288  * registered driver for the given device. Return -1 if initialization
 289  * failed, return 1 if no driver is found for this device.
 290  */
 291 static int
 292 pci_detach_all_drivers(struct rte_pci_device *dev)
 293 {
 294         struct rte_pci_driver *dr = NULL;
 295         int rc = 0;
 296
 297         if (dev == NULL)
 298                 return -1;
 299
 300         TAILQ_FOREACH(dr, &pci_driver_list, next) {
 301                 rc = rte_eal_pci_detach_dev(dr, dev);
 302                 if (rc < 0)
 303                         /* negative value is an error */
 304                         return -1;
 305                 if (rc > 0)
 306                         /* positive value means driver doesn't support it */
 307                         continue;
 308                 return 0;
 309         }
 310         return 1;
 311 }
 312
 313 /*
 314  * Find the pci device specified by pci address, then invoke probe function of
 315  * the driver of the devive.
 316  */
 317 int
 318 rte_eal_pci_probe_one(const struct rte_pci_addr *addr)
 319 {
 320         struct rte_pci_device *dev = NULL;
 321         int ret = 0;
 322
 323         if (addr == NULL)
 324                 return -1;
 325
 326         TAILQ_FOREACH(dev, &pci_device_list, next) {
 327                 if (rte_eal_compare_pci_addr(&dev->addr, addr))
 328                         continue;
 329
 330                 ret = pci_probe_all_drivers(dev);
 331                 if (ret < 0)
 332                         goto err_return;
 333                 return 0;
 334         }
 335         return -1;
 336
 337 err_return:
 338         RTE_LOG(WARNING, EAL, "Requested device " PCI_PRI_FMT
 339                         " cannot be used\n", dev->addr.domain, dev->addr.bus,
 340                         dev->addr.devid, dev->addr.function);
 341         return -1;
 342 }
 343
 344 /*
 345  * Detach device specified by its pci address.
 346  */
 347 int
 348 rte_eal_pci_detach(const struct rte_pci_addr *addr)
 349 {
 350         struct rte_pci_device *dev = NULL;
 351         int ret = 0;
 352
 353         if (addr == NULL)
 354                 return -1;
 355
 356         TAILQ_FOREACH(dev, &pci_device_list, next) {
 357                 if (rte_eal_compare_pci_addr(&dev->addr, addr))
 358                         continue;
 359
 360                 ret = pci_detach_all_drivers(dev);
 361                 if (ret < 0)
 362                         goto err_return;
 363
 364                 TAILQ_REMOVE(&pci_device_list, dev, next);
 365                 return 0;
 366         }
 367         return -1;
 368
 369 err_return:
 370         RTE_LOG(WARNING, EAL, "Requested device " PCI_PRI_FMT
 371                         " cannot be used\n", dev->addr.domain, dev->addr.bus,
 372                         dev->addr.devid, dev->addr.function);
 373         return -1;
 374 }
 375
 376 /*
 377  * Scan the content of the PCI bus, and call the devinit() function for
 378  * all registered drivers that have a matching entry in its id_table
 379  * for discovered devices.
 380  */
 381 int
 382 rte_eal_pci_probe(void)
 383 {
 384         struct rte_pci_device *dev = NULL;
 385         struct rte_devargs *devargs;
 386         int probe_all = 0;
 387         int ret = 0;
 388
 389         if (rte_eal_devargs_type_count(RTE_DEVTYPE_WHITELISTED_PCI) == 0)
 390                 probe_all = 1;
 391
 392         TAILQ_FOREACH(dev, &pci_device_list, next) {
 393
 394                 /* set devargs in PCI structure */
 395                 devargs = pci_devargs_lookup(dev);
 396                 if (devargs != NULL)
 397                         dev->devargs = devargs;
 398
 399                 /* probe all or only whitelisted devices */
 400                 if (probe_all)
 401                         ret = pci_probe_all_drivers(dev);
 402                 else if (devargs != NULL &&
 403                         devargs->type == RTE_DEVTYPE_WHITELISTED_PCI)
 404                         ret = pci_probe_all_drivers(dev);
 405                 if (ret < 0)
 406                         rte_exit(EXIT_FAILURE, "Requested device " PCI_PRI_FMT
 407                                  " cannot be used\n", dev->addr.domain, dev->addr.bus,
 408                                  dev->addr.devid, dev->addr.function);
 409         }
 410
 411         return 0;
 412 }
 413
 414 /* dump one device */
 415 static int
 416 pci_dump_one_device(FILE *f, struct rte_pci_device *dev)
 417 {
 418         int i;
 419
 420         fprintf(f, PCI_PRI_FMT, dev->addr.domain, dev->addr.bus,
 421                dev->addr.devid, dev->addr.function);
 422         fprintf(f, " - vendor:%x device:%x\n", dev->id.vendor_id,
 423                dev->id.device_id);
 424
 425         for (i = 0; i != sizeof(dev->mem_resource) /
 426                 sizeof(dev->mem_resource[0]); i++) {
 427                 fprintf(f, "   %16.16"PRIx64" %16.16"PRIx64"\n",
 428                         dev->mem_resource[i].phys_addr,
 429                         dev->mem_resource[i].len);
 430         }
 431         return 0;
 432 }
 433
 434 /* dump devices on the bus */
 435 void
 436 rte_eal_pci_dump(FILE *f)
 437 {
 438         struct rte_pci_device *dev = NULL;
 439
 440         TAILQ_FOREACH(dev, &pci_device_list, next) {
 441                 pci_dump_one_device(f, dev);
 442         }
 443 }
 444
 445 /* register a driver */
 446 void
 447 rte_eal_pci_register(struct rte_pci_driver *driver)
 448 {
 449         TAILQ_INSERT_TAIL(&pci_driver_list, driver, next);
 450 }
 451
 452 /* unregister a driver */
 453 void
 454 rte_eal_pci_unregister(struct rte_pci_driver *driver)
 455 {
 456         TAILQ_REMOVE(&pci_driver_list, driver, next);
 457 }