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
  77         TAILQ_FOREACH(devargs, &devargs_list, next) {
  78                 if (devargs->type != RTE_DEVTYPE_BLACKLISTED_PCI &&
  79                         devargs->type != RTE_DEVTYPE_WHITELISTED_PCI)
  80                         continue;
  81                 if (!rte_eal_compare_pci_addr(&dev->addr, &devargs->pci.addr))
  82                         return devargs;
  83         }
  84         return NULL;
  85 }
  86
  87 /* map a particular resource from a file */
  88 void *
  89 pci_map_resource(void *requested_addr, int fd, off_t offset, size_t size,
  90                  int additional_flags)
  91 {
  92         void *mapaddr;
  93
  94         /* Map the PCI memory resource of device */
  95         mapaddr = mmap(requested_addr, size, PROT_READ | PROT_WRITE,
  96                         MAP_SHARED | additional_flags, fd, offset);
  97         if (mapaddr == MAP_FAILED) {
  98                 RTE_LOG(ERR, EAL, "%s(): cannot mmap(%d, %p, 0x%lx, 0x%lx): %s (%p)\n",
  99                         __func__, fd, requested_addr,
 100                         (unsigned long)size, (unsigned long)offset,
 101                         strerror(errno), mapaddr);
 102         } else
 103                 RTE_LOG(DEBUG, EAL, "  PCI memory mapped at %p\n", mapaddr);
 104
 105         return mapaddr;
 106 }
 107
 108 /* unmap a particular resource */
 109 void
 110 pci_unmap_resource(void *requested_addr, size_t size)
 111 {
 112         if (requested_addr == NULL)
 113                 return;
 114
 115         /* Unmap the PCI memory resource of device */
 116         if (munmap(requested_addr, size)) {
 117                 RTE_LOG(ERR, EAL, "%s(): cannot munmap(%p, 0x%lx): %s\n",
 118                         __func__, requested_addr, (unsigned long)size,
 119                         strerror(errno));
 120         } else
 121                 RTE_LOG(DEBUG, EAL, "  PCI memory unmapped at %p\n",
 122                                 requested_addr);
 123 }
 124
 125 /*
 126  * Match the PCI Driver and Device using the ID Table
 127  *
 128  * @param pci_drv
 129  *      PCI driver from which ID table would be extracted
 130  * @param pci_dev
 131  *      PCI device to match against the driver
 132  * @return
 133  *      1 for successful match
 134  *      0 for unsuccessful match
 135  */
 136 static int
 137 rte_pci_match(const struct rte_pci_driver *pci_drv,
 138               const struct rte_pci_device *pci_dev)
 139 {
 140         const struct rte_pci_id *id_table;
 141
 142         for (id_table = pci_drv->id_table; id_table->vendor_id != 0;
 143              id_table++) {
 144                 /* check if device's identifiers match the driver's ones */
 145                 if (id_table->vendor_id != pci_dev->id.vendor_id &&
 146                                 id_table->vendor_id != PCI_ANY_ID)
 147                         continue;
 148                 if (id_table->device_id != pci_dev->id.device_id &&
 149                                 id_table->device_id != PCI_ANY_ID)
 150                         continue;
 151                 if (id_table->subsystem_vendor_id !=
 152                     pci_dev->id.subsystem_vendor_id &&
 153                     id_table->subsystem_vendor_id != PCI_ANY_ID)
 154                         continue;
 155                 if (id_table->subsystem_device_id !=
 156                     pci_dev->id.subsystem_device_id &&
 157                     id_table->subsystem_device_id != PCI_ANY_ID)
 158                         continue;
 159                 if (id_table->class_id != pci_dev->id.class_id &&
 160                                 id_table->class_id != RTE_CLASS_ANY_ID)
 161                         continue;
 162
 163                 return 1;
 164         }
 165
 166         return 0;
 167 }
 168
 169 /*
 170  * If vendor/device ID match, call the probe() function of the
 171  * driver.
 172  */
 173 static int
 174 rte_pci_probe_one_driver(struct rte_pci_driver *dr,
 175                          struct rte_pci_device *dev)
 176 {
 177         int ret;
 178         struct rte_pci_addr *loc;
 179
 180         if ((dr == NULL) || (dev == NULL))
 181                 return -EINVAL;
 182
 183         loc = &dev->addr;
 184
 185         /* The device is not blacklisted; Check if driver supports it */
 186         if (!rte_pci_match(dr, dev))
 187                 /* Match of device and driver failed */
 188                 return 1;
 189
 190         RTE_LOG(INFO, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
 191                         loc->domain, loc->bus, loc->devid, loc->function,
 192                         dev->device.numa_node);
 193
 194         /* no initialization when blacklisted, return without error */
 195         if (dev->device.devargs != NULL &&
 196                 dev->device.devargs->type ==
 197                         RTE_DEVTYPE_BLACKLISTED_PCI) {
 198                 RTE_LOG(INFO, EAL, "  Device is blacklisted, not"
 199                         " initializing\n");
 200                 return 1;
 201         }
 202
 203         RTE_LOG(INFO, EAL, "  probe driver: %x:%x %s\n", dev->id.vendor_id,
 204                 dev->id.device_id, dr->driver.name);
 205
 206         if (dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING) {
 207                 /* map resources for devices that use igb_uio */
 208                 ret = rte_pci_map_device(dev);
 209                 if (ret != 0)
 210                         return ret;
 211         }
 212
 213         /* reference driver structure */
 214         dev->driver = dr;
 215         dev->device.driver = &dr->driver;
 216
 217         /* call the driver probe() function */
 218         ret = dr->probe(dr, dev);
 219         if (ret) {
 220                 dev->driver = NULL;
 221                 if ((dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING) &&
 222                         /* Don't unmap if device is unsupported and
 223                          * driver needs mapped resources.
 224                          */
 225                         !(ret > 0 &&
 226                                 (dr->drv_flags & RTE_PCI_DRV_KEEP_MAPPED_RES)))
 227                         rte_pci_unmap_device(dev);
 228         }
 229
 230         return ret;
 231 }
 232
 233 /*
 234  * If vendor/device ID match, call the remove() function of the
 235  * driver.
 236  */
 237 static int
 238 rte_pci_detach_dev(struct rte_pci_device *dev)
 239 {
 240         struct rte_pci_addr *loc;
 241         struct rte_pci_driver *dr;
 242
 243         if (dev == NULL)
 244                 return -EINVAL;
 245
 246         dr = dev->driver;
 247         loc = &dev->addr;
 248
 249         RTE_LOG(DEBUG, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
 250                         loc->domain, loc->bus, loc->devid,
 251                         loc->function, dev->device.numa_node);
 252
 253         RTE_LOG(DEBUG, EAL, "  remove driver: %x:%x %s\n", dev->id.vendor_id,
 254                         dev->id.device_id, dr->driver.name);
 255
 256         if (dr->remove && (dr->remove(dev) < 0))
 257                 return -1;      /* negative value is an error */
 258
 259         /* clear driver structure */
 260         dev->driver = NULL;
 261
 262         if (dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING)
 263                 /* unmap resources for devices that use igb_uio */
 264                 rte_pci_unmap_device(dev);
 265
 266         return 0;
 267 }
 268
 269 /*
 270  * If vendor/device ID match, call the probe() function of all
 271  * registered driver for the given device. Return -1 if initialization
 272  * failed, return 1 if no driver is found for this device.
 273  */
 274 static int
 275 pci_probe_all_drivers(struct rte_pci_device *dev)
 276 {
 277         struct rte_pci_driver *dr = NULL;
 278         int rc = 0;
 279
 280         if (dev == NULL)
 281                 return -1;
 282
 283         /* Check if a driver is already loaded */
 284         if (dev->driver != NULL)
 285                 return 0;
 286
 287         FOREACH_DRIVER_ON_PCIBUS(dr) {
 288                 rc = rte_pci_probe_one_driver(dr, dev);
 289                 if (rc < 0)
 290                         /* negative value is an error */
 291                         return -1;
 292                 if (rc > 0)
 293                         /* positive value means driver doesn't support it */
 294                         continue;
 295                 return 0;
 296         }
 297         return 1;
 298 }
 299
 300 /*
 301  * Find the pci device specified by pci address, then invoke probe function of
 302  * the driver of the devive.
 303  */
 304 int
 305 rte_pci_probe_one(const struct rte_pci_addr *addr)
 306 {
 307         struct rte_pci_device *dev = NULL;
 308
 309         int ret = 0;
 310
 311         if (addr == NULL)
 312                 return -1;
 313
 314         /* update current pci device in global list, kernel bindings might have
 315          * changed since last time we looked at it.
 316          */
 317         if (pci_update_device(addr) < 0)
 318                 goto err_return;
 319
 320         FOREACH_DEVICE_ON_PCIBUS(dev) {
 321                 if (rte_eal_compare_pci_addr(&dev->addr, addr))
 322                         continue;
 323
 324                 ret = pci_probe_all_drivers(dev);
 325                 if (ret)
 326                         goto err_return;
 327                 return 0;
 328         }
 329         return -1;
 330
 331 err_return:
 332         RTE_LOG(WARNING, EAL,
 333                 "Requested device " PCI_PRI_FMT " cannot be used\n",
 334                 addr->domain, addr->bus, addr->devid, addr->function);
 335         return -1;
 336 }
 337
 338 /*
 339  * Detach device specified by its pci address.
 340  */
 341 int
 342 rte_pci_detach(const struct rte_pci_addr *addr)
 343 {
 344         struct rte_pci_device *dev = NULL;
 345         int ret = 0;
 346
 347         if (addr == NULL)
 348                 return -1;
 349
 350         FOREACH_DEVICE_ON_PCIBUS(dev) {
 351                 if (rte_eal_compare_pci_addr(&dev->addr, addr))
 352                         continue;
 353
 354                 ret = rte_pci_detach_dev(dev);
 355                 if (ret < 0)
 356                         /* negative value is an error */
 357                         goto err_return;
 358                 if (ret > 0)
 359                         /* positive value means driver doesn't support it */
 360                         continue;
 361
 362                 rte_pci_remove_device(dev);
 363                 free(dev);
 364                 return 0;
 365         }
 366         return -1;
 367
 368 err_return:
 369         RTE_LOG(WARNING, EAL, "Requested device " PCI_PRI_FMT
 370                         " cannot be used\n", dev->addr.domain, dev->addr.bus,
 371                         dev->addr.devid, dev->addr.function);
 372         return -1;
 373 }
 374
 375 /*
 376  * Scan the content of the PCI bus, and call the probe() function for
 377  * all registered drivers that have a matching entry in its id_table
 378  * for discovered devices.
 379  */
 380 int
 381 rte_pci_probe(void)
 382 {
 383         struct rte_pci_device *dev = NULL;
 384         size_t probed = 0, failed = 0;
 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         FOREACH_DEVICE_ON_PCIBUS(dev) {
 393                 probed++;
 394
 395                 /* set devargs in PCI structure */
 396                 devargs = pci_devargs_lookup(dev);
 397                 if (devargs != NULL)
 398                         dev->device.devargs = devargs;
 399
 400                 /* probe all or only whitelisted devices */
 401                 if (probe_all)
 402                         ret = pci_probe_all_drivers(dev);
 403                 else if (devargs != NULL &&
 404                         devargs->type == RTE_DEVTYPE_WHITELISTED_PCI)
 405                         ret = pci_probe_all_drivers(dev);
 406                 if (ret < 0) {
 407                         RTE_LOG(ERR, EAL, "Requested device " PCI_PRI_FMT
 408                                  " cannot be used\n", dev->addr.domain, dev->addr.bus,
 409                                  dev->addr.devid, dev->addr.function);
 410                         rte_errno = errno;
 411                         failed++;
 412                         ret = 0;
 413                 }
 414         }
 415
 416         return (probed && probed == failed) ? -1 : 0;
 417 }
 418
 419 /* dump one device */
 420 static int
 421 pci_dump_one_device(FILE *f, struct rte_pci_device *dev)
 422 {
 423         int i;
 424
 425         fprintf(f, PCI_PRI_FMT, dev->addr.domain, dev->addr.bus,
 426                dev->addr.devid, dev->addr.function);
 427         fprintf(f, " - vendor:%x device:%x\n", dev->id.vendor_id,
 428                dev->id.device_id);
 429
 430         for (i = 0; i != sizeof(dev->mem_resource) /
 431                 sizeof(dev->mem_resource[0]); i++) {
 432                 fprintf(f, "   %16.16"PRIx64" %16.16"PRIx64"\n",
 433                         dev->mem_resource[i].phys_addr,
 434                         dev->mem_resource[i].len);
 435         }
 436         return 0;
 437 }
 438
 439 /* dump devices on the bus */
 440 void
 441 rte_pci_dump(FILE *f)
 442 {
 443         struct rte_pci_device *dev = NULL;
 444
 445         FOREACH_DEVICE_ON_PCIBUS(dev) {
 446                 pci_dump_one_device(f, dev);
 447         }
 448 }
 449
 450 /* register a driver */
 451 void
 452 rte_pci_register(struct rte_pci_driver *driver)
 453 {
 454         TAILQ_INSERT_TAIL(&rte_pci_bus.driver_list, driver, next);
 455         driver->bus = &rte_pci_bus;
 456 }
 457
 458 /* unregister a driver */
 459 void
 460 rte_pci_unregister(struct rte_pci_driver *driver)
 461 {
 462         TAILQ_REMOVE(&rte_pci_bus.driver_list, driver, next);
 463         driver->bus = NULL;
 464 }
 465
 466 /* Add a device to PCI bus */
 467 void
 468 rte_pci_add_device(struct rte_pci_device *pci_dev)
 469 {
 470         TAILQ_INSERT_TAIL(&rte_pci_bus.device_list, pci_dev, next);
 471 }
 472
 473 /* Insert a device into a predefined position in PCI bus */
 474 void
 475 rte_pci_insert_device(struct rte_pci_device *exist_pci_dev,
 476                       struct rte_pci_device *new_pci_dev)
 477 {
 478         TAILQ_INSERT_BEFORE(exist_pci_dev, new_pci_dev, next);
 479 }
 480
 481 /* Remove a device from PCI bus */
 482 void
 483 rte_pci_remove_device(struct rte_pci_device *pci_dev)
 484 {
 485         TAILQ_REMOVE(&rte_pci_bus.device_list, pci_dev, next);
 486 }
 487
 488 static struct rte_device *
 489 pci_find_device(const struct rte_device *start, rte_dev_cmp_t cmp,
 490                 const void *data)
 491 {
 492         struct rte_pci_device *dev;
 493         bool start_found = !start;
 494
 495         FOREACH_DEVICE_ON_PCIBUS(dev) {
 496                 if (!start_found) {
 497                         if (&dev->device == start)
 498                                 start_found = 1;
 499                         continue;
 500                 }
 501                 if (cmp(&dev->device, data) == 0)
 502                         return &dev->device;
 503         }
 504
 505         return NULL;
 506 }
 507
 508 struct rte_pci_bus rte_pci_bus = {
 509         .bus = {
 510                 .scan = rte_pci_scan,
 511                 .probe = rte_pci_probe,
 512                 .find_device = pci_find_device,
 513         },
 514         .device_list = TAILQ_HEAD_INITIALIZER(rte_pci_bus.device_list),
 515         .driver_list = TAILQ_HEAD_INITIALIZER(rte_pci_bus.driver_list),
 516 };
 517
 518 RTE_REGISTER_BUS(PCI_BUS_NAME, rte_pci_bus.bus);