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