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  * @param pci_drv
 155  *      PCI driver from which ID table would be extracted
 156  * @param pci_dev
 157  *      PCI device to match against the driver
 158  * @return
 159  *      1 for successful match
 160  *      0 for unsuccessful match
 161  */
 162 static int
 163 rte_pci_match(const struct rte_pci_driver *pci_drv,
 164               const struct rte_pci_device *pci_dev)
 165 {
 166         const struct rte_pci_id *id_table;
 167
 168         for (id_table = pci_drv->id_table; id_table->vendor_id != 0;
 169              id_table++) {
 170                 /* check if device's identifiers match the driver's ones */
 171                 if (id_table->vendor_id != pci_dev->id.vendor_id &&
 172                                 id_table->vendor_id != PCI_ANY_ID)
 173                         continue;
 174                 if (id_table->device_id != pci_dev->id.device_id &&
 175                                 id_table->device_id != PCI_ANY_ID)
 176                         continue;
 177                 if (id_table->subsystem_vendor_id !=
 178                     pci_dev->id.subsystem_vendor_id &&
 179                     id_table->subsystem_vendor_id != PCI_ANY_ID)
 180                         continue;
 181                 if (id_table->subsystem_device_id !=
 182                     pci_dev->id.subsystem_device_id &&
 183                     id_table->subsystem_device_id != PCI_ANY_ID)
 184                         continue;
 185                 if (id_table->class_id != pci_dev->id.class_id &&
 186                                 id_table->class_id != RTE_CLASS_ANY_ID)
 187                         continue;
 188
 189                 return 1;
 190         }
 191
 192         return 0;
 193 }
 194
 195 /*
 196  * If vendor/device ID match, call the probe() function of the
 197  * driver.
 198  */
 199 static int
 200 rte_pci_probe_one_driver(struct rte_pci_driver *dr,
 201                          struct rte_pci_device *dev)
 202 {
 203         int ret;
 204         struct rte_pci_addr *loc;
 205
 206         if ((dr == NULL) || (dev == NULL))
 207                 return -EINVAL;
 208
 209         loc = &dev->addr;
 210
 211         /* The device is not blacklisted; Check if driver supports it */
 212         if (!rte_pci_match(dr, dev))
 213                 /* Match of device and driver failed */
 214                 return 1;
 215
 216         RTE_LOG(INFO, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
 217                         loc->domain, loc->bus, loc->devid, loc->function,
 218                         dev->device.numa_node);
 219
 220         /* no initialization when blacklisted, return without error */
 221         if (dev->device.devargs != NULL &&
 222                 dev->device.devargs->policy ==
 223                         RTE_DEV_BLACKLISTED) {
 224                 RTE_LOG(INFO, EAL, "  Device is blacklisted, not"
 225                         " initializing\n");
 226                 return 1;
 227         }
 228
 229         RTE_LOG(INFO, EAL, "  probe driver: %x:%x %s\n", dev->id.vendor_id,
 230                 dev->id.device_id, dr->driver.name);
 231
 232         if (dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING) {
 233                 /* map resources for devices that use igb_uio */
 234                 ret = rte_pci_map_device(dev);
 235                 if (ret != 0)
 236                         return ret;
 237         }
 238
 239         /* reference driver structure */
 240         dev->driver = dr;
 241         dev->device.driver = &dr->driver;
 242
 243         /* call the driver probe() function */
 244         ret = dr->probe(dr, dev);
 245         if (ret) {
 246                 dev->driver = NULL;
 247                 dev->device.driver = NULL;
 248                 if ((dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING) &&
 249                         /* Don't unmap if device is unsupported and
 250                          * driver needs mapped resources.
 251                          */
 252                         !(ret > 0 &&
 253                                 (dr->drv_flags & RTE_PCI_DRV_KEEP_MAPPED_RES)))
 254                         rte_pci_unmap_device(dev);
 255         }
 256
 257         return ret;
 258 }
 259
 260 /*
 261  * If vendor/device ID match, call the remove() function of the
 262  * driver.
 263  */
 264 static int
 265 rte_pci_detach_dev(struct rte_pci_device *dev)
 266 {
 267         struct rte_pci_addr *loc;
 268         struct rte_pci_driver *dr;
 269
 270         if (dev == NULL)
 271                 return -EINVAL;
 272
 273         dr = dev->driver;
 274         loc = &dev->addr;
 275
 276         RTE_LOG(DEBUG, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
 277                         loc->domain, loc->bus, loc->devid,
 278                         loc->function, dev->device.numa_node);
 279
 280         RTE_LOG(DEBUG, EAL, "  remove driver: %x:%x %s\n", dev->id.vendor_id,
 281                         dev->id.device_id, dr->driver.name);
 282
 283         if (dr->remove && (dr->remove(dev) < 0))
 284                 return -1;      /* negative value is an error */
 285
 286         /* clear driver structure */
 287         dev->driver = NULL;
 288
 289         if (dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING)
 290                 /* unmap resources for devices that use igb_uio */
 291                 rte_pci_unmap_device(dev);
 292
 293         return 0;
 294 }
 295
 296 /*
 297  * If vendor/device ID match, call the probe() function of all
 298  * registered driver for the given device. Return -1 if initialization
 299  * failed, return 1 if no driver is found for this device.
 300  */
 301 static int
 302 pci_probe_all_drivers(struct rte_pci_device *dev)
 303 {
 304         struct rte_pci_driver *dr = NULL;
 305         int rc = 0;
 306
 307         if (dev == NULL)
 308                 return -1;
 309
 310         /* Check if a driver is already loaded */
 311         if (dev->driver != NULL)
 312                 return 0;
 313
 314         FOREACH_DRIVER_ON_PCIBUS(dr) {
 315                 rc = rte_pci_probe_one_driver(dr, dev);
 316                 if (rc < 0)
 317                         /* negative value is an error */
 318                         return -1;
 319                 if (rc > 0)
 320                         /* positive value means driver doesn't support it */
 321                         continue;
 322                 return 0;
 323         }
 324         return 1;
 325 }
 326
 327 /*
 328  * Find the pci device specified by pci address, then invoke probe function of
 329  * the driver of the device.
 330  */
 331 int
 332 rte_pci_probe_one(const struct rte_pci_addr *addr)
 333 {
 334         struct rte_pci_device *dev = NULL;
 335
 336         int ret = 0;
 337
 338         if (addr == NULL)
 339                 return -1;
 340
 341         /* update current pci device in global list, kernel bindings might have
 342          * changed since last time we looked at it.
 343          */
 344         if (pci_update_device(addr) < 0)
 345                 goto err_return;
 346
 347         FOREACH_DEVICE_ON_PCIBUS(dev) {
 348                 if (rte_eal_compare_pci_addr(&dev->addr, addr))
 349                         continue;
 350
 351                 ret = pci_probe_all_drivers(dev);
 352                 if (ret)
 353                         goto err_return;
 354                 return 0;
 355         }
 356         return -1;
 357
 358 err_return:
 359         RTE_LOG(WARNING, EAL,
 360                 "Requested device " PCI_PRI_FMT " cannot be used\n",
 361                 addr->domain, addr->bus, addr->devid, addr->function);
 362         return -1;
 363 }
 364
 365 /*
 366  * Detach device specified by its pci address.
 367  */
 368 int
 369 rte_pci_detach(const struct rte_pci_addr *addr)
 370 {
 371         struct rte_pci_device *dev = NULL;
 372         int ret = 0;
 373
 374         if (addr == NULL)
 375                 return -1;
 376
 377         FOREACH_DEVICE_ON_PCIBUS(dev) {
 378                 if (rte_eal_compare_pci_addr(&dev->addr, addr))
 379                         continue;
 380
 381                 ret = rte_pci_detach_dev(dev);
 382                 if (ret < 0)
 383                         /* negative value is an error */
 384                         goto err_return;
 385                 if (ret > 0)
 386                         /* positive value means driver doesn't support it */
 387                         continue;
 388
 389                 rte_pci_remove_device(dev);
 390                 free(dev);
 391                 return 0;
 392         }
 393         return -1;
 394
 395 err_return:
 396         RTE_LOG(WARNING, EAL, "Requested device " PCI_PRI_FMT
 397                         " cannot be used\n", dev->addr.domain, dev->addr.bus,
 398                         dev->addr.devid, dev->addr.function);
 399         return -1;
 400 }
 401
 402 /*
 403  * Scan the content of the PCI bus, and call the probe() function for
 404  * all registered drivers that have a matching entry in its id_table
 405  * for discovered devices.
 406  */
 407 int
 408 rte_pci_probe(void)
 409 {
 410         struct rte_pci_device *dev = NULL;
 411         size_t probed = 0, failed = 0;
 412         struct rte_devargs *devargs;
 413         int probe_all = 0;
 414         int ret = 0;
 415
 416         if (rte_pci_bus.bus.conf.scan_mode != RTE_BUS_SCAN_WHITELIST)
 417                 probe_all = 1;
 418
 419         FOREACH_DEVICE_ON_PCIBUS(dev) {
 420                 probed++;
 421
 422                 devargs = dev->device.devargs;
 423                 /* probe all or only whitelisted devices */
 424                 if (probe_all)
 425                         ret = pci_probe_all_drivers(dev);
 426                 else if (devargs != NULL &&
 427                         devargs->policy == RTE_DEV_WHITELISTED)
 428                         ret = pci_probe_all_drivers(dev);
 429                 if (ret < 0) {
 430                         RTE_LOG(ERR, EAL, "Requested device " PCI_PRI_FMT
 431                                  " cannot be used\n", dev->addr.domain, dev->addr.bus,
 432                                  dev->addr.devid, dev->addr.function);
 433                         rte_errno = errno;
 434                         failed++;
 435                         ret = 0;
 436                 }
 437         }
 438
 439         return (probed && probed == failed) ? -1 : 0;
 440 }
 441
 442 /* dump one device */
 443 static int
 444 pci_dump_one_device(FILE *f, struct rte_pci_device *dev)
 445 {
 446         int i;
 447
 448         fprintf(f, PCI_PRI_FMT, dev->addr.domain, dev->addr.bus,
 449                dev->addr.devid, dev->addr.function);
 450         fprintf(f, " - vendor:%x device:%x\n", dev->id.vendor_id,
 451                dev->id.device_id);
 452
 453         for (i = 0; i != sizeof(dev->mem_resource) /
 454                 sizeof(dev->mem_resource[0]); i++) {
 455                 fprintf(f, "   %16.16"PRIx64" %16.16"PRIx64"\n",
 456                         dev->mem_resource[i].phys_addr,
 457                         dev->mem_resource[i].len);
 458         }
 459         return 0;
 460 }
 461
 462 /* dump devices on the bus */
 463 void
 464 rte_pci_dump(FILE *f)
 465 {
 466         struct rte_pci_device *dev = NULL;
 467
 468         FOREACH_DEVICE_ON_PCIBUS(dev) {
 469                 pci_dump_one_device(f, dev);
 470         }
 471 }
 472
 473 static int
 474 pci_parse(const char *name, void *addr)
 475 {
 476         struct rte_pci_addr *out = addr;
 477         struct rte_pci_addr pci_addr;
 478         bool parse;
 479
 480         parse = (eal_parse_pci_BDF(name, &pci_addr) == 0 ||
 481                  eal_parse_pci_DomBDF(name, &pci_addr) == 0);
 482         if (parse && addr != NULL)
 483                 *out = pci_addr;
 484         return parse == false;
 485 }
 486
 487 /* register a driver */
 488 void
 489 rte_pci_register(struct rte_pci_driver *driver)
 490 {
 491         TAILQ_INSERT_TAIL(&rte_pci_bus.driver_list, driver, next);
 492         driver->bus = &rte_pci_bus;
 493 }
 494
 495 /* unregister a driver */
 496 void
 497 rte_pci_unregister(struct rte_pci_driver *driver)
 498 {
 499         TAILQ_REMOVE(&rte_pci_bus.driver_list, driver, next);
 500         driver->bus = NULL;
 501 }
 502
 503 /* Add a device to PCI bus */
 504 void
 505 rte_pci_add_device(struct rte_pci_device *pci_dev)
 506 {
 507         TAILQ_INSERT_TAIL(&rte_pci_bus.device_list, pci_dev, next);
 508 }
 509
 510 /* Insert a device into a predefined position in PCI bus */
 511 void
 512 rte_pci_insert_device(struct rte_pci_device *exist_pci_dev,
 513                       struct rte_pci_device *new_pci_dev)
 514 {
 515         TAILQ_INSERT_BEFORE(exist_pci_dev, new_pci_dev, next);
 516 }
 517
 518 /* Remove a device from PCI bus */
 519 void
 520 rte_pci_remove_device(struct rte_pci_device *pci_dev)
 521 {
 522         TAILQ_REMOVE(&rte_pci_bus.device_list, pci_dev, next);
 523 }
 524
 525 static struct rte_device *
 526 pci_find_device(const struct rte_device *start, rte_dev_cmp_t cmp,
 527                 const void *data)
 528 {
 529         struct rte_pci_device *dev;
 530
 531         FOREACH_DEVICE_ON_PCIBUS(dev) {
 532                 if (start && &dev->device == start) {
 533                         start = NULL; /* starting point found */
 534                         continue;
 535                 }
 536                 if (cmp(&dev->device, data) == 0)
 537                         return &dev->device;
 538         }
 539
 540         return NULL;
 541 }
 542
 543 static int
 544 pci_plug(struct rte_device *dev)
 545 {
 546         return pci_probe_all_drivers(RTE_DEV_TO_PCI(dev));
 547 }
 548
 549 static int
 550 pci_unplug(struct rte_device *dev)
 551 {
 552         struct rte_pci_device *pdev;
 553         int ret;
 554
 555         pdev = RTE_DEV_TO_PCI(dev);
 556         ret = rte_pci_detach_dev(pdev);
 557         rte_pci_remove_device(pdev);
 558         free(pdev);
 559         return ret;
 560 }
 561
 562 struct rte_pci_bus rte_pci_bus = {
 563         .bus = {
 564                 .scan = rte_pci_scan,
 565                 .probe = rte_pci_probe,
 566                 .find_device = pci_find_device,
 567                 .plug = pci_plug,
 568                 .unplug = pci_unplug,
 569                 .parse = pci_parse,
 570         },
 571         .device_list = TAILQ_HEAD_INITIALIZER(rte_pci_bus.device_list),
 572         .driver_list = TAILQ_HEAD_INITIALIZER(rte_pci_bus.driver_list),
 573 };
 574
 575 RTE_REGISTER_BUS(pci, rte_pci_bus.bus);