lib/librte_eal/common/eal_common_pci.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   Copyright 2013-2014 6WIND S.A.
   6  *   All rights reserved.
   7  *
   8  *   Redistribution and use in source and binary forms, with or without
   9  *   modification, are permitted provided that the following conditions
  10  *   are met:
  11  *
  12  *     * Redistributions of source code must retain the above copyright
  13  *       notice, this list of conditions and the following disclaimer.
  14  *     * Redistributions in binary form must reproduce the above copyright
  15  *       notice, this list of conditions and the following disclaimer in
  16  *       the documentation and/or other materials provided with the
  17  *       distribution.
  18  *     * Neither the name of Intel Corporation nor the names of its
  19  *       contributors may be used to endorse or promote products derived
  20  *       from this software without specific prior written permission.
  21  *
  22  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  25  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  26  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  27  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  28  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  30  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  32  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  */
  34
  35 #include <string.h>
  36 #include <inttypes.h>
  37 #include <stdint.h>
  38 #include <stdlib.h>
  39 #include <stdio.h>
  40 #include <sys/queue.h>
  41 #include <sys/mman.h>
  42
  43 #include <rte_errno.h>
  44 #include <rte_interrupts.h>
  45 #include <rte_log.h>
  46 #include <rte_bus.h>
  47 #include <rte_pci.h>
  48 #include <rte_per_lcore.h>
  49 #include <rte_memory.h>
  50 #include <rte_memzone.h>
  51 #include <rte_eal.h>
  52 #include <rte_string_fns.h>
  53 #include <rte_common.h>
  54 #include <rte_devargs.h>
  55
  56 #include "eal_private.h"
  57
  58 extern struct rte_pci_bus rte_pci_bus;
  59
  60 #define SYSFS_PCI_DEVICES "/sys/bus/pci/devices"
  61
  62 const char *pci_get_sysfs_path(void)
  63 {
  64         const char *path = NULL;
  65
  66         path = getenv("SYSFS_PCI_DEVICES");
  67         if (path == NULL)
  68                 return SYSFS_PCI_DEVICES;
  69
  70         return path;
  71 }
  72
  73 static struct rte_devargs *pci_devargs_lookup(struct rte_pci_device *dev)
  74 {
  75         struct rte_devargs *devargs;
  76         struct rte_pci_addr addr;
  77         struct rte_bus *pbus;
  78
  79         pbus = rte_bus_find_by_name("pci");
  80         TAILQ_FOREACH(devargs, &devargs_list, next) {
  81                 if (devargs->bus != pbus)
  82                         continue;
  83                 devargs->bus->parse(devargs->name, &addr);
  84                 if (!rte_eal_compare_pci_addr(&dev->addr, &addr))
  85                         return devargs;
  86         }
  87         return NULL;
  88 }
  89
  90 void
  91 pci_name_set(struct rte_pci_device *dev)
  92 {
  93         struct rte_devargs *devargs;
  94
  95         /* Each device has its internal, canonical name set. */
  96         rte_pci_device_name(&dev->addr,
  97                         dev->name, sizeof(dev->name));
  98         devargs = pci_devargs_lookup(dev);
  99         dev->device.devargs = devargs;
 100         /* In blacklist mode, if the device is not blacklisted, no
 101          * rte_devargs exists for it.
 102          */
 103         if (devargs != NULL)
 104                 /* If an rte_devargs exists, the generic rte_device uses the
 105                  * given name as its namea
 106                  */
 107                 dev->device.name = dev->device.devargs->name;
 108         else
 109                 /* Otherwise, it uses the internal, canonical form. */
 110                 dev->device.name = dev->name;
 111 }
 112
 113 /* map a particular resource from a file */
 114 void *
 115 pci_map_resource(void *requested_addr, int fd, off_t offset, size_t size,
 116                  int additional_flags)
 117 {
 118         void *mapaddr;
 119
 120         /* Map the PCI memory resource of device */
 121         mapaddr = mmap(requested_addr, size, PROT_READ | PROT_WRITE,
 122                         MAP_SHARED | additional_flags, fd, offset);
 123         if (mapaddr == MAP_FAILED) {
 124                 RTE_LOG(ERR, EAL, "%s(): cannot mmap(%d, %p, 0x%lx, 0x%lx): %s (%p)\n",
 125                         __func__, fd, requested_addr,
 126                         (unsigned long)size, (unsigned long)offset,
 127                         strerror(errno), mapaddr);
 128         } else
 129                 RTE_LOG(DEBUG, EAL, "  PCI memory mapped at %p\n", mapaddr);
 130
 131         return mapaddr;
 132 }
 133
 134 /* unmap a particular resource */
 135 void
 136 pci_unmap_resource(void *requested_addr, size_t size)
 137 {
 138         if (requested_addr == NULL)
 139                 return;
 140
 141         /* Unmap the PCI memory resource of device */
 142         if (munmap(requested_addr, size)) {
 143                 RTE_LOG(ERR, EAL, "%s(): cannot munmap(%p, 0x%lx): %s\n",
 144                         __func__, requested_addr, (unsigned long)size,
 145                         strerror(errno));
 146         } else
 147                 RTE_LOG(DEBUG, EAL, "  PCI memory unmapped at %p\n",
 148                                 requested_addr);
 149 }
 150
 151 /*
 152  * Match the PCI Driver and Device using the ID Table
 153  */
 154 int
 155 rte_pci_match(const struct rte_pci_driver *pci_drv,
 156               const struct rte_pci_device *pci_dev)
 157 {
 158         const struct rte_pci_id *id_table;
 159
 160         for (id_table = pci_drv->id_table; id_table->vendor_id != 0;
 161              id_table++) {
 162                 /* check if device's identifiers match the driver's ones */
 163                 if (id_table->vendor_id != pci_dev->id.vendor_id &&
 164                                 id_table->vendor_id != PCI_ANY_ID)
 165                         continue;
 166                 if (id_table->device_id != pci_dev->id.device_id &&
 167                                 id_table->device_id != PCI_ANY_ID)
 168                         continue;
 169                 if (id_table->subsystem_vendor_id !=
 170                     pci_dev->id.subsystem_vendor_id &&
 171                     id_table->subsystem_vendor_id != PCI_ANY_ID)
 172                         continue;
 173                 if (id_table->subsystem_device_id !=
 174                     pci_dev->id.subsystem_device_id &&
 175                     id_table->subsystem_device_id != PCI_ANY_ID)
 176                         continue;
 177                 if (id_table->class_id != pci_dev->id.class_id &&
 178                                 id_table->class_id != RTE_CLASS_ANY_ID)
 179                         continue;
 180
 181                 return 1;
 182         }
 183
 184         return 0;
 185 }
 186
 187 /*
 188  * If vendor/device ID match, call the probe() function of the
 189  * driver.
 190  */
 191 static int
 192 rte_pci_probe_one_driver(struct rte_pci_driver *dr,
 193                          struct rte_pci_device *dev)
 194 {
 195         int ret;
 196         struct rte_pci_addr *loc;
 197
 198         if ((dr == NULL) || (dev == NULL))
 199                 return -EINVAL;
 200
 201         loc = &dev->addr;
 202
 203         /* The device is not blacklisted; Check if driver supports it */
 204         if (!rte_pci_match(dr, dev))
 205                 /* Match of device and driver failed */
 206                 return 1;
 207
 208         RTE_LOG(INFO, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
 209                         loc->domain, loc->bus, loc->devid, loc->function,
 210                         dev->device.numa_node);
 211
 212         /* no initialization when blacklisted, return without error */
 213         if (dev->device.devargs != NULL &&
 214                 dev->device.devargs->policy ==
 215                         RTE_DEV_BLACKLISTED) {
 216                 RTE_LOG(INFO, EAL, "  Device is blacklisted, not"
 217                         " initializing\n");
 218                 return 1;
 219         }
 220
 221         if (dev->device.numa_node < 0) {
 222                 RTE_LOG(WARNING, EAL, "  Invalid NUMA socket, default to 0\n");
 223                 dev->device.numa_node = 0;
 224         }
 225
 226         RTE_LOG(INFO, EAL, "  probe driver: %x:%x %s\n", dev->id.vendor_id,
 227                 dev->id.device_id, dr->driver.name);
 228
 229         if (dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING) {
 230                 /* map resources for devices that use igb_uio */
 231                 ret = rte_pci_map_device(dev);
 232                 if (ret != 0)
 233                         return ret;
 234         }
 235
 236         /* reference driver structure */
 237         dev->driver = dr;
 238         dev->device.driver = &dr->driver;
 239
 240         /* call the driver probe() function */
 241         ret = dr->probe(dr, dev);
 242         if (ret) {
 243                 dev->driver = NULL;
 244                 dev->device.driver = NULL;
 245                 if ((dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING) &&
 246                         /* Don't unmap if device is unsupported and
 247                          * driver needs mapped resources.
 248                          */
 249                         !(ret > 0 &&
 250                                 (dr->drv_flags & RTE_PCI_DRV_KEEP_MAPPED_RES)))
 251                         rte_pci_unmap_device(dev);
 252         }
 253
 254         return ret;
 255 }
 256
 257 /*
 258  * If vendor/device ID match, call the remove() function of the
 259  * driver.
 260  */
 261 static int
 262 rte_pci_detach_dev(struct rte_pci_device *dev)
 263 {
 264         struct rte_pci_addr *loc;
 265         struct rte_pci_driver *dr;
 266
 267         if (dev == NULL)
 268                 return -EINVAL;
 269
 270         dr = dev->driver;
 271         loc = &dev->addr;
 272
 273         RTE_LOG(DEBUG, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
 274                         loc->domain, loc->bus, loc->devid,
 275                         loc->function, dev->device.numa_node);
 276
 277         RTE_LOG(DEBUG, EAL, "  remove driver: %x:%x %s\n", dev->id.vendor_id,
 278                         dev->id.device_id, dr->driver.name);
 279
 280         if (dr->remove && (dr->remove(dev) < 0))
 281                 return -1;      /* negative value is an error */
 282
 283         /* clear driver structure */
 284         dev->driver = NULL;
 285
 286         if (dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING)
 287                 /* unmap resources for devices that use igb_uio */
 288                 rte_pci_unmap_device(dev);
 289
 290         return 0;
 291 }
 292
 293 /*
 294  * If vendor/device ID match, call the probe() function of all
 295  * registered driver for the given device. Return -1 if initialization
 296  * failed, return 1 if no driver is found for this device.
 297  */
 298 static int
 299 pci_probe_all_drivers(struct rte_pci_device *dev)
 300 {
 301         struct rte_pci_driver *dr = NULL;
 302         int rc = 0;
 303
 304         if (dev == NULL)
 305                 return -1;
 306
 307         /* Check if a driver is already loaded */
 308         if (dev->driver != NULL)
 309                 return 0;
 310
 311         FOREACH_DRIVER_ON_PCIBUS(dr) {
 312                 rc = rte_pci_probe_one_driver(dr, dev);
 313                 if (rc < 0)
 314                         /* negative value is an error */
 315                         return -1;
 316                 if (rc > 0)
 317                         /* positive value means driver doesn't support it */
 318                         continue;
 319                 return 0;
 320         }
 321         return 1;
 322 }
 323
 324 /*
 325  * Find the pci device specified by pci address, then invoke probe function of
 326  * the driver of the device.
 327  */
 328 int
 329 rte_pci_probe_one(const struct rte_pci_addr *addr)
 330 {
 331         struct rte_pci_device *dev = NULL;
 332
 333         int ret = 0;
 334
 335         if (addr == NULL)
 336                 return -1;
 337
 338         /* update current pci device in global list, kernel bindings might have
 339          * changed since last time we looked at it.
 340          */
 341         if (pci_update_device(addr) < 0)
 342                 goto err_return;
 343
 344         FOREACH_DEVICE_ON_PCIBUS(dev) {
 345                 if (rte_eal_compare_pci_addr(&dev->addr, addr))
 346                         continue;
 347
 348                 ret = pci_probe_all_drivers(dev);
 349                 if (ret)
 350                         goto err_return;
 351                 return 0;
 352         }
 353         return -1;
 354
 355 err_return:
 356         RTE_LOG(WARNING, EAL,
 357                 "Requested device " PCI_PRI_FMT " cannot be used\n",
 358                 addr->domain, addr->bus, addr->devid, addr->function);
 359         return -1;
 360 }
 361
 362 /*
 363  * Detach device specified by its pci address.
 364  */
 365 int
 366 rte_pci_detach(const struct rte_pci_addr *addr)
 367 {
 368         struct rte_pci_device *dev = NULL;
 369         int ret = 0;
 370
 371         if (addr == NULL)
 372                 return -1;
 373
 374         FOREACH_DEVICE_ON_PCIBUS(dev) {
 375                 if (rte_eal_compare_pci_addr(&dev->addr, addr))
 376                         continue;
 377
 378                 ret = rte_pci_detach_dev(dev);
 379                 if (ret < 0)
 380                         /* negative value is an error */
 381                         goto err_return;
 382                 if (ret > 0)
 383                         /* positive value means driver doesn't support it */
 384                         continue;
 385
 386                 rte_pci_remove_device(dev);
 387                 free(dev);
 388                 return 0;
 389         }
 390         return -1;
 391
 392 err_return:
 393         RTE_LOG(WARNING, EAL, "Requested device " PCI_PRI_FMT
 394                         " cannot be used\n", dev->addr.domain, dev->addr.bus,
 395                         dev->addr.devid, dev->addr.function);
 396         return -1;
 397 }
 398
 399 /*
 400  * Scan the content of the PCI bus, and call the probe() function for
 401  * all registered drivers that have a matching entry in its id_table
 402  * for discovered devices.
 403  */
 404 int
 405 rte_pci_probe(void)
 406 {
 407         struct rte_pci_device *dev = NULL;
 408         size_t probed = 0, failed = 0;
 409         struct rte_devargs *devargs;
 410         int probe_all = 0;
 411         int ret = 0;
 412
 413         if (rte_pci_bus.bus.conf.scan_mode != RTE_BUS_SCAN_WHITELIST)
 414                 probe_all = 1;
 415
 416         FOREACH_DEVICE_ON_PCIBUS(dev) {
 417                 probed++;
 418
 419                 devargs = dev->device.devargs;
 420                 /* probe all or only whitelisted devices */
 421                 if (probe_all)
 422                         ret = pci_probe_all_drivers(dev);
 423                 else if (devargs != NULL &&
 424                         devargs->policy == RTE_DEV_WHITELISTED)
 425                         ret = pci_probe_all_drivers(dev);
 426                 if (ret < 0) {
 427                         RTE_LOG(ERR, EAL, "Requested device " PCI_PRI_FMT
 428                                  " cannot be used\n", dev->addr.domain, dev->addr.bus,
 429                                  dev->addr.devid, dev->addr.function);
 430                         rte_errno = errno;
 431                         failed++;
 432                         ret = 0;
 433                 }
 434         }
 435
 436         return (probed && probed == failed) ? -1 : 0;
 437 }
 438
 439 /* dump one device */
 440 static int
 441 pci_dump_one_device(FILE *f, struct rte_pci_device *dev)
 442 {
 443         int i;
 444
 445         fprintf(f, PCI_PRI_FMT, dev->addr.domain, dev->addr.bus,
 446                dev->addr.devid, dev->addr.function);
 447         fprintf(f, " - vendor:%x device:%x\n", dev->id.vendor_id,
 448                dev->id.device_id);
 449
 450         for (i = 0; i != sizeof(dev->mem_resource) /
 451                 sizeof(dev->mem_resource[0]); i++) {
 452                 fprintf(f, "   %16.16"PRIx64" %16.16"PRIx64"\n",
 453                         dev->mem_resource[i].phys_addr,
 454                         dev->mem_resource[i].len);
 455         }
 456         return 0;
 457 }
 458
 459 /* dump devices on the bus */
 460 void
 461 rte_pci_dump(FILE *f)
 462 {
 463         struct rte_pci_device *dev = NULL;
 464
 465         FOREACH_DEVICE_ON_PCIBUS(dev) {
 466                 pci_dump_one_device(f, dev);
 467         }
 468 }
 469
 470 static int
 471 pci_parse(const char *name, void *addr)
 472 {
 473         struct rte_pci_addr *out = addr;
 474         struct rte_pci_addr pci_addr;
 475         bool parse;
 476
 477         parse = (eal_parse_pci_BDF(name, &pci_addr) == 0 ||
 478                  eal_parse_pci_DomBDF(name, &pci_addr) == 0);
 479         if (parse && addr != NULL)
 480                 *out = pci_addr;
 481         return parse == false;
 482 }
 483
 484 /* register a driver */
 485 void
 486 rte_pci_register(struct rte_pci_driver *driver)
 487 {
 488         TAILQ_INSERT_TAIL(&rte_pci_bus.driver_list, driver, next);
 489         driver->bus = &rte_pci_bus;
 490 }
 491
 492 /* unregister a driver */
 493 void
 494 rte_pci_unregister(struct rte_pci_driver *driver)
 495 {
 496         TAILQ_REMOVE(&rte_pci_bus.driver_list, driver, next);
 497         driver->bus = NULL;
 498 }
 499
 500 /* Add a device to PCI bus */
 501 void
 502 rte_pci_add_device(struct rte_pci_device *pci_dev)
 503 {
 504         TAILQ_INSERT_TAIL(&rte_pci_bus.device_list, pci_dev, next);
 505 }
 506
 507 /* Insert a device into a predefined position in PCI bus */
 508 void
 509 rte_pci_insert_device(struct rte_pci_device *exist_pci_dev,
 510                       struct rte_pci_device *new_pci_dev)
 511 {
 512         TAILQ_INSERT_BEFORE(exist_pci_dev, new_pci_dev, next);
 513 }
 514
 515 /* Remove a device from PCI bus */
 516 void
 517 rte_pci_remove_device(struct rte_pci_device *pci_dev)
 518 {
 519         TAILQ_REMOVE(&rte_pci_bus.device_list, pci_dev, next);
 520 }
 521
 522 static struct rte_device *
 523 pci_find_device(const struct rte_device *start, rte_dev_cmp_t cmp,
 524                 const void *data)
 525 {
 526         struct rte_pci_device *dev;
 527
 528         FOREACH_DEVICE_ON_PCIBUS(dev) {
 529                 if (start && &dev->device == start) {
 530                         start = NULL; /* starting point found */
 531                         continue;
 532                 }
 533                 if (cmp(&dev->device, data) == 0)
 534                         return &dev->device;
 535         }
 536
 537         return NULL;
 538 }
 539
 540 static int
 541 pci_plug(struct rte_device *dev)
 542 {
 543         return pci_probe_all_drivers(RTE_DEV_TO_PCI(dev));
 544 }
 545
 546 static int
 547 pci_unplug(struct rte_device *dev)
 548 {
 549         struct rte_pci_device *pdev;
 550         int ret;
 551
 552         pdev = RTE_DEV_TO_PCI(dev);
 553         ret = rte_pci_detach_dev(pdev);
 554         rte_pci_remove_device(pdev);
 555         free(pdev);
 556         return ret;
 557 }
 558
 559 struct rte_pci_bus rte_pci_bus = {
 560         .bus = {
 561                 .scan = rte_pci_scan,
 562                 .probe = rte_pci_probe,
 563                 .find_device = pci_find_device,
 564                 .plug = pci_plug,
 565                 .unplug = pci_unplug,
 566                 .parse = pci_parse,
 567         },
 568         .device_list = TAILQ_HEAD_INITIALIZER(rte_pci_bus.device_list),
 569         .driver_list = TAILQ_HEAD_INITIALIZER(rte_pci_bus.driver_list),
 570 };
 571
 572 RTE_REGISTER_BUS(pci, rte_pci_bus.bus);