lib/librte_eal/bsdapp/eal/eal_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
  34 #include <ctype.h>
  35 #include <stdio.h>
  36 #include <stdlib.h>
  37 #include <string.h>
  38 #include <stdarg.h>
  39 #include <unistd.h>
  40 #include <inttypes.h>
  41 #include <sys/types.h>
  42 #include <sys/stat.h>
  43 #include <fcntl.h>
  44 #include <stdarg.h>
  45 #include <errno.h>
  46 #include <dirent.h>
  47 #include <limits.h>
  48 #include <sys/queue.h>
  49 #include <sys/mman.h>
  50 #include <sys/ioctl.h>
  51 #include <sys/pciio.h>
  52 #include <dev/pci/pcireg.h>
  53
  54 #include <rte_interrupts.h>
  55 #include <rte_log.h>
  56 #include <rte_pci.h>
  57 #include <rte_common.h>
  58 #include <rte_launch.h>
  59 #include <rte_memory.h>
  60 #include <rte_memzone.h>
  61 #include <rte_tailq.h>
  62 #include <rte_eal.h>
  63 #include <rte_eal_memconfig.h>
  64 #include <rte_per_lcore.h>
  65 #include <rte_lcore.h>
  66 #include <rte_malloc.h>
  67 #include <rte_string_fns.h>
  68 #include <rte_debug.h>
  69 #include <rte_devargs.h>
  70
  71 #include "rte_pci_dev_ids.h"
  72 #include "eal_filesystem.h"
  73 #include "eal_private.h"
  74
  75 /**
  76  * @file
  77  * PCI probing under linux
  78  *
  79  * This code is used to simulate a PCI probe by parsing information in
  80  * sysfs. Moreover, when a registered driver matches a device, the
  81  * kernel driver currently using it is unloaded and replaced by
  82  * igb_uio module, which is a very minimal userland driver for Intel
  83  * network card, only providing access to PCI BAR to applications, and
  84  * enabling bus master.
  85  */
  86
  87 struct uio_map {
  88         void *addr;
  89         uint64_t offset;
  90         uint64_t size;
  91         uint64_t phaddr;
  92 };
  93
  94 /*
  95  * For multi-process we need to reproduce all PCI mappings in secondary
  96  * processes, so save them in a tailq.
  97  */
  98 struct uio_resource {
  99         TAILQ_ENTRY(uio_resource) next;
 100
 101         struct rte_pci_addr pci_addr;
 102         char path[PATH_MAX];
 103         size_t nb_maps;
 104         struct uio_map maps[PCI_MAX_RESOURCE];
 105 };
 106
 107 TAILQ_HEAD(uio_res_list, uio_resource);
 108
 109 static struct uio_res_list *uio_res_list = NULL;
 110
 111 /* unbind kernel driver for this device */
 112 static int
 113 pci_unbind_kernel_driver(struct rte_pci_device *dev)
 114 {
 115         RTE_LOG(ERR, EAL, "RTE_PCI_DRV_FORCE_UNBIND flag is not implemented "
 116                 "for BSD\n");
 117         return -ENOTSUP;
 118 }
 119
 120 /* map a particular resource from a file */
 121 static void *
 122 pci_map_resource(struct rte_pci_device *dev, void *requested_addr,
 123                 const char *devname, off_t offset, size_t size)
 124 {
 125         int fd;
 126         void *mapaddr;
 127
 128         /*
 129          * open devname, to mmap it
 130          */
 131         fd = open(devname, O_RDWR);
 132         if (fd < 0) {
 133                 RTE_LOG(ERR, EAL, "Cannot open %s: %s\n",
 134                         devname, strerror(errno));
 135                 goto fail;
 136         }
 137
 138         /* Map the PCI memory resource of device */
 139         mapaddr = mmap(requested_addr, size, PROT_READ | PROT_WRITE,
 140                         MAP_SHARED, fd, offset);
 141         if (mapaddr == MAP_FAILED ||
 142                         (requested_addr != NULL && mapaddr != requested_addr)) {
 143                 RTE_LOG(ERR, EAL, "%s(): cannot mmap(%s(%d), %p, 0x%lx, 0x%lx):"
 144                         " %s (%p)\n", __func__, devname, fd, requested_addr,
 145                         (unsigned long)size, (unsigned long)offset,
 146                         strerror(errno), mapaddr);
 147                 close(fd);
 148                 goto fail;
 149         }
 150
 151         if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
 152                 /* save fd if in primary process */
 153                 dev->intr_handle.fd = fd;
 154                 dev->intr_handle.type = RTE_INTR_HANDLE_UIO;
 155         } else {
 156                 /* fd is not needed in slave process, close it */
 157                 dev->intr_handle.fd = -1;
 158                 dev->intr_handle.type = RTE_INTR_HANDLE_UNKNOWN;
 159                 close(fd);
 160         }
 161
 162         RTE_LOG(DEBUG, EAL, "  PCI memory mapped at %p\n", mapaddr);
 163
 164         return mapaddr;
 165
 166 fail:
 167         dev->intr_handle.fd = -1;
 168         dev->intr_handle.type = RTE_INTR_HANDLE_UNKNOWN;
 169
 170         return NULL;
 171 }
 172
 173 #ifndef OFF_MAX
 174 #define OFF_MAX              ((uint64_t)(off_t)-1)
 175 #endif
 176
 177 static int
 178 pci_uio_map_secondary(struct rte_pci_device *dev)
 179 {
 180         size_t i;
 181         struct uio_resource *uio_res;
 182
 183         TAILQ_FOREACH(uio_res, uio_res_list, next) {
 184
 185                 /* skip this element if it doesn't match our PCI address */
 186                 if (memcmp(&uio_res->pci_addr, &dev->addr, sizeof(dev->addr)))
 187                         continue;
 188
 189                 for (i = 0; i != uio_res->nb_maps; i++) {
 190                         if (pci_map_resource(dev, uio_res->maps[i].addr,
 191                                         uio_res->path,
 192                                         (off_t)uio_res->maps[i].offset,
 193                                         (size_t)uio_res->maps[i].size) !=
 194                                         uio_res->maps[i].addr) {
 195                                 RTE_LOG(ERR, EAL,
 196                                         "Cannot mmap device resource\n");
 197                                 return (-1);
 198                         }
 199                 }
 200                 return (0);
 201         }
 202
 203         RTE_LOG(ERR, EAL, "Cannot find resource for device\n");
 204         return -1;
 205 }
 206
 207 /* map the PCI resource of a PCI device in virtual memory */
 208 static int
 209 pci_uio_map_resource(struct rte_pci_device *dev)
 210 {
 211         int i, j;
 212         char devname[PATH_MAX]; /* contains the /dev/uioX */
 213         void *mapaddr;
 214         uint64_t phaddr;
 215         uint64_t offset;
 216         uint64_t pagesz;
 217         struct rte_pci_addr *loc = &dev->addr;
 218         struct uio_resource *uio_res;
 219         struct uio_map *maps;
 220
 221         dev->intr_handle.fd = -1;
 222
 223         /* secondary processes - use already recorded details */
 224         if (rte_eal_process_type() != RTE_PROC_PRIMARY)
 225                 return (pci_uio_map_secondary(dev));
 226
 227         rte_snprintf(devname, sizeof(devname), "/dev/uio@pci:%u:%u:%u",
 228                         dev->addr.bus, dev->addr.devid, dev->addr.function);
 229
 230         if (access(devname, O_RDWR) < 0) {
 231                 RTE_LOG(WARNING, EAL, "  "PCI_PRI_FMT" not managed by UIO driver, "
 232                                 "skipping\n", loc->domain, loc->bus, loc->devid, loc->function);
 233                 return -1;
 234         }
 235
 236         /* allocate the mapping details for secondary processes*/
 237         if ((uio_res = rte_zmalloc("UIO_RES", sizeof (*uio_res), 0)) == NULL) {
 238                 RTE_LOG(ERR, EAL,
 239                         "%s(): cannot store uio mmap details\n", __func__);
 240                 return (-1);
 241         }
 242
 243         rte_snprintf(uio_res->path, sizeof(uio_res->path), "%s", devname);
 244         memcpy(&uio_res->pci_addr, &dev->addr, sizeof(uio_res->pci_addr));
 245
 246
 247         /* Map all BARs */
 248         pagesz = sysconf(_SC_PAGESIZE);
 249
 250         maps = uio_res->maps;
 251         for (i = uio_res->nb_maps = 0; i != PCI_MAX_RESOURCE; i++) {
 252
 253                 j = uio_res->nb_maps;
 254                 /* skip empty BAR */
 255                 if ((phaddr = dev->mem_resource[i].phys_addr) == 0)
 256                         continue;
 257
 258                 /* if matching map is found, then use it */
 259                 offset = i * pagesz;
 260                 maps[j].offset = offset;
 261                 maps[j].phaddr = dev->mem_resource[i].phys_addr;
 262                 maps[j].size = dev->mem_resource[i].len;
 263                 if (maps[j].addr != NULL ||
 264                                 (mapaddr = pci_map_resource(dev,
 265                                 NULL, devname, (off_t)offset,
 266                                 (size_t)maps[j].size)) == NULL) {
 267                         rte_free(uio_res);
 268                         return (-1);
 269                 }
 270
 271                 maps[j].addr = mapaddr;
 272                 uio_res->nb_maps++;
 273                 dev->mem_resource[i].addr = mapaddr;
 274         }
 275
 276         TAILQ_INSERT_TAIL(uio_res_list, uio_res, next);
 277
 278         return (0);
 279 }
 280
 281 /* parse the "resource" sysfs file */
 282 #define IORESOURCE_MEM  0x00000200
 283
 284 /* Compare two PCI device addresses. */
 285 static int
 286 pci_addr_comparison(struct rte_pci_addr *addr, struct rte_pci_addr *addr2)
 287 {
 288         uint64_t dev_addr = (addr->domain << 24) + (addr->bus << 16) + (addr->devid << 8) + addr->function;
 289         uint64_t dev_addr2 = (addr2->domain << 24) + (addr2->bus << 16) + (addr2->devid << 8) + addr2->function;
 290
 291         if (dev_addr > dev_addr2)
 292                 return 1;
 293         else
 294                 return 0;
 295 }
 296
 297
 298 /* Scan one pci sysfs entry, and fill the devices list from it. */
 299 static int
 300 pci_scan_one(int dev_pci_fd, struct pci_conf *conf)
 301 {
 302         struct rte_pci_device *dev;
 303         struct pci_bar_io bar;
 304         unsigned i, max;
 305
 306         dev = malloc(sizeof(*dev));
 307         if (dev == NULL) {
 308                 return -1;
 309         }
 310
 311         memset(dev, 0, sizeof(*dev));
 312         dev->addr.domain = conf->pc_sel.pc_domain;
 313         dev->addr.bus = conf->pc_sel.pc_bus;
 314         dev->addr.devid = conf->pc_sel.pc_dev;
 315         dev->addr.function = conf->pc_sel.pc_func;
 316
 317         /* get vendor id */
 318         dev->id.vendor_id = conf->pc_vendor;
 319
 320         /* get device id */
 321         dev->id.device_id = conf->pc_device;
 322
 323         /* get subsystem_vendor id */
 324         dev->id.subsystem_vendor_id = conf->pc_subvendor;
 325
 326         /* get subsystem_device id */
 327         dev->id.subsystem_device_id = conf->pc_subdevice;
 328
 329         /* TODO: get max_vfs */
 330         dev->max_vfs = 0;
 331
 332         /* FreeBSD has no NUMA support (yet) */
 333         dev->numa_node = 0;
 334
 335 /* parse resources */
 336         switch (conf->pc_hdr & PCIM_HDRTYPE) {
 337         case PCIM_HDRTYPE_NORMAL:
 338                 max = PCIR_MAX_BAR_0;
 339                 break;
 340         case PCIM_HDRTYPE_BRIDGE:
 341                 max = PCIR_MAX_BAR_1;
 342                 break;
 343         case PCIM_HDRTYPE_CARDBUS:
 344                 max = PCIR_MAX_BAR_2;
 345                 break;
 346         default:
 347                 goto skipdev;
 348         }
 349
 350         for (i = 0; i <= max; i++) {
 351                 bar.pbi_sel = conf->pc_sel;
 352                 bar.pbi_reg = PCIR_BAR(i);
 353                 if (ioctl(dev_pci_fd, PCIOCGETBAR, &bar) < 0)
 354                         continue;
 355
 356                 dev->mem_resource[i].len = bar.pbi_length;
 357                 if (PCI_BAR_IO(bar.pbi_base)) {
 358                         dev->mem_resource[i].addr = (void *)(bar.pbi_base & ~((uint64_t)0xf));
 359                         continue;
 360                 }
 361                 dev->mem_resource[i].phys_addr = bar.pbi_base & ~((uint64_t)0xf);
 362         }
 363
 364         /* device is valid, add in list (sorted) */
 365         if (TAILQ_EMPTY(&pci_device_list)) {
 366                 TAILQ_INSERT_TAIL(&pci_device_list, dev, next);
 367         }
 368         else {
 369                 struct rte_pci_device *dev2 = NULL;
 370
 371                 TAILQ_FOREACH(dev2, &pci_device_list, next) {
 372                         if (pci_addr_comparison(&dev->addr, &dev2->addr))
 373                                 continue;
 374                         else {
 375                                 TAILQ_INSERT_BEFORE(dev2, dev, next);
 376                                 return 0;
 377                         }
 378                 }
 379                 TAILQ_INSERT_TAIL(&pci_device_list, dev, next);
 380         }
 381
 382         return 0;
 383
 384 skipdev:
 385         free(dev);
 386         return 0;
 387 }
 388
 389 /*
 390  * Scan the content of the PCI bus, and add the devices in the devices
 391  * list. Call pci_scan_one() for each pci entry found.
 392  */
 393 static int
 394 pci_scan(void)
 395 {
 396         int fd = -1;
 397         unsigned dev_count = 0;
 398         struct pci_conf matches[16];
 399         struct pci_conf_io conf_io = {
 400                         .pat_buf_len = 0,
 401                         .num_patterns = 0,
 402                         .patterns = NULL,
 403                         .match_buf_len = sizeof(matches),
 404                         .matches = &matches[0],
 405         };
 406
 407         fd = open("/dev/pci", O_RDONLY);
 408         if (fd < 0) {
 409                 RTE_LOG(ERR, EAL, "%s(): error opening /dev/pci\n", __func__);
 410                 goto error;
 411         }
 412
 413         do {
 414                 unsigned i;
 415                 if (ioctl(fd, PCIOCGETCONF, &conf_io) < 0) {
 416                         RTE_LOG(ERR, EAL, "%s(): error with ioctl on /dev/pci: %s\n",
 417                                         __func__, strerror(errno));
 418                         goto error;
 419                 }
 420
 421                 for (i = 0; i < conf_io.num_matches; i++)
 422                         if (pci_scan_one(fd, &matches[i]) < 0)
 423                                 goto error;
 424
 425                 dev_count += conf_io.num_matches;
 426         } while(conf_io.status == PCI_GETCONF_MORE_DEVS);
 427
 428         close(fd);
 429
 430         RTE_LOG(ERR, EAL, "PCI scan found %u devices\n", dev_count);
 431         return 0;
 432
 433 error:
 434         if (fd >= 0)
 435                 close(fd);
 436         return -1;
 437 }
 438
 439 /*
 440  * If vendor/device ID match, call the devinit() function of the
 441  * driver.
 442  */
 443 int
 444 rte_eal_pci_probe_one_driver(struct rte_pci_driver *dr, struct rte_pci_device *dev)
 445 {
 446         struct rte_pci_id *id_table;
 447
 448         for (id_table = dr->id_table ; id_table->vendor_id != 0; id_table++) {
 449
 450                 /* check if device's identifiers match the driver's ones */
 451                 if (id_table->vendor_id != dev->id.vendor_id &&
 452                                 id_table->vendor_id != PCI_ANY_ID)
 453                         continue;
 454                 if (id_table->device_id != dev->id.device_id &&
 455                                 id_table->device_id != PCI_ANY_ID)
 456                         continue;
 457                 if (id_table->subsystem_vendor_id != dev->id.subsystem_vendor_id &&
 458                                 id_table->subsystem_vendor_id != PCI_ANY_ID)
 459                         continue;
 460                 if (id_table->subsystem_device_id != dev->id.subsystem_device_id &&
 461                                 id_table->subsystem_device_id != PCI_ANY_ID)
 462                         continue;
 463
 464                 struct rte_pci_addr *loc = &dev->addr;
 465
 466                 RTE_LOG(DEBUG, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
 467                                 loc->domain, loc->bus, loc->devid, loc->function,
 468                                 dev->numa_node);
 469
 470                 RTE_LOG(DEBUG, EAL, "  probe driver: %x:%x %s\n", dev->id.vendor_id,
 471                                 dev->id.device_id, dr->name);
 472
 473                 /* no initialization when blacklisted, return without error */
 474                 if (dev->devargs != NULL &&
 475                         dev->devargs->type == RTE_DEVTYPE_BLACKLISTED_PCI) {
 476
 477                         RTE_LOG(DEBUG, EAL, "  Device is blacklisted, not initializing\n");
 478                         return 0;
 479                 }
 480
 481                 if (dr->drv_flags & RTE_PCI_DRV_NEED_IGB_UIO) {
 482                         /* map resources for devices that use igb_uio */
 483                         if (pci_uio_map_resource(dev) < 0)
 484                                 return -1;
 485                 } else if (dr->drv_flags & RTE_PCI_DRV_FORCE_UNBIND &&
 486                            rte_eal_process_type() == RTE_PROC_PRIMARY) {
 487                         /* unbind current driver */
 488                         if (pci_unbind_kernel_driver(dev) < 0)
 489                                 return -1;
 490                 }
 491
 492                 /* reference driver structure */
 493                 dev->driver = dr;
 494
 495                 /* call the driver devinit() function */
 496                 return dr->devinit(dr, dev);
 497         }
 498         /* return positive value if driver is not found */
 499         return 1;
 500 }
 501
 502 /* Init the PCI EAL subsystem */
 503 int
 504 rte_eal_pci_init(void)
 505 {
 506         TAILQ_INIT(&pci_driver_list);
 507         TAILQ_INIT(&pci_device_list);
 508         uio_res_list = RTE_TAILQ_RESERVE_BY_IDX(RTE_TAILQ_PCI, uio_res_list);
 509
 510         /* for debug purposes, PCI can be disabled */
 511         if (internal_config.no_pci)
 512                 return 0;
 513
 514         if (pci_scan() < 0) {
 515                 RTE_LOG(ERR, EAL, "%s(): Cannot scan PCI bus\n", __func__);
 516                 return -1;
 517         }
 518         return 0;
 519 }