lib/librte_eal/linuxapp/eal/eal_pci_uio.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 <string.h>
  35 #include <fcntl.h>
  36 #include <dirent.h>
  37 #include <sys/stat.h>
  38
  39 #include <rte_log.h>
  40 #include <rte_pci.h>
  41 #include <rte_common.h>
  42 #include <rte_malloc.h>
  43 #include <rte_tailq.h>
  44
  45 #include "rte_pci_dev_ids.h"
  46 #include "eal_filesystem.h"
  47 #include "eal_pci_init.h"
  48
  49 static int pci_parse_sysfs_value(const char *filename, uint64_t *val);
  50
  51
  52 #define OFF_MAX              ((uint64_t)(off_t)-1)
  53 static int
  54 pci_uio_get_mappings(const char *devname, struct pci_map maps[], int nb_maps)
  55 {
  56         int i;
  57         char dirname[PATH_MAX];
  58         char filename[PATH_MAX];
  59         uint64_t offset, size;
  60
  61         for (i = 0; i != nb_maps; i++) {
  62
  63                 /* check if map directory exists */
  64                 rte_snprintf(dirname, sizeof(dirname),
  65                         "%s/maps/map%u", devname, i);
  66
  67                 if (access(dirname, F_OK) != 0)
  68                         break;
  69
  70                 /* get mapping offset */
  71                 rte_snprintf(filename, sizeof(filename),
  72                         "%s/offset", dirname);
  73                 if (pci_parse_sysfs_value(filename, &offset) < 0) {
  74                         RTE_LOG(ERR, EAL,
  75                                 "%s(): cannot parse offset of %s\n",
  76                                 __func__, dirname);
  77                         return (-1);
  78                 }
  79
  80                 /* get mapping size */
  81                 rte_snprintf(filename, sizeof(filename),
  82                         "%s/size", dirname);
  83                 if (pci_parse_sysfs_value(filename, &size) < 0) {
  84                         RTE_LOG(ERR, EAL,
  85                                 "%s(): cannot parse size of %s\n",
  86                                 __func__, dirname);
  87                         return (-1);
  88                 }
  89
  90                 /* get mapping physical address */
  91                 rte_snprintf(filename, sizeof(filename),
  92                         "%s/addr", dirname);
  93                 if (pci_parse_sysfs_value(filename, &maps[i].phaddr) < 0) {
  94                         RTE_LOG(ERR, EAL,
  95                                 "%s(): cannot parse addr of %s\n",
  96                                 __func__, dirname);
  97                         return (-1);
  98                 }
  99
 100                 if ((offset > OFF_MAX) || (size > SIZE_MAX)) {
 101                         RTE_LOG(ERR, EAL,
 102                                 "%s(): offset/size exceed system max value\n",
 103                                 __func__);
 104                         return (-1);
 105                 }
 106
 107                 maps[i].offset = offset;
 108                 maps[i].size = size;
 109         }
 110         return (i);
 111 }
 112
 113 static int
 114 pci_uio_map_secondary(struct rte_pci_device *dev)
 115 {
 116         int fd, i;
 117         struct mapped_pci_resource *uio_res;
 118
 119         TAILQ_FOREACH(uio_res, pci_res_list, next) {
 120
 121                 /* skip this element if it doesn't match our PCI address */
 122                 if (memcmp(&uio_res->pci_addr, &dev->addr, sizeof(dev->addr)))
 123                         continue;
 124
 125                 for (i = 0; i != uio_res->nb_maps; i++) {
 126                         /*
 127                          * open devname, to mmap it
 128                          */
 129                         fd = open(uio_res->path, O_RDWR);
 130                         if (fd < 0) {
 131                                 RTE_LOG(ERR, EAL, "Cannot open %s: %s\n",
 132                                         uio_res->path, strerror(errno));
 133                                 return -1;
 134                         }
 135
 136                         if (pci_map_resource(uio_res->maps[i].addr, fd,
 137                                              (off_t)uio_res->maps[i].offset,
 138                                              (size_t)uio_res->maps[i].size)
 139                             != uio_res->maps[i].addr) {
 140                                 RTE_LOG(ERR, EAL,
 141                                         "Cannot mmap device resource\n");
 142                                 close(fd);
 143                                 return (-1);
 144                         }
 145                         /* fd is not needed in slave process, close it */
 146                         close(fd);
 147                 }
 148                 return (0);
 149         }
 150
 151         RTE_LOG(ERR, EAL, "Cannot find resource for device\n");
 152         return -1;
 153 }
 154
 155 static int
 156 pci_mknod_uio_dev(const char *sysfs_uio_path, unsigned uio_num)
 157 {
 158         FILE *f;
 159         char filename[PATH_MAX];
 160         int ret;
 161         unsigned major, minor;
 162         dev_t dev;
 163
 164         /* get the name of the sysfs file that contains the major and minor
 165          * of the uio device and read its content */
 166         rte_snprintf(filename, sizeof(filename), "%s/dev", sysfs_uio_path);
 167
 168         f = fopen(filename, "r");
 169         if (f == NULL) {
 170                 RTE_LOG(ERR, EAL, "%s(): cannot open sysfs to get major:minor\n",
 171                         __func__);
 172                 return -1;
 173         }
 174
 175         ret = fscanf(f, "%d:%d", &major, &minor);
 176         if (ret != 2) {
 177                 RTE_LOG(ERR, EAL, "%s(): cannot parse sysfs to get major:minor\n",
 178                         __func__);
 179                 fclose(f);
 180                 return -1;
 181         }
 182         fclose(f);
 183
 184         /* create the char device "mknod /dev/uioX c major minor" */
 185         rte_snprintf(filename, sizeof(filename), "/dev/uio%u", uio_num);
 186         dev = makedev(major, minor);
 187         ret = mknod(filename, S_IFCHR | S_IRUSR | S_IWUSR, dev);
 188         if (f == NULL) {
 189                 RTE_LOG(ERR, EAL, "%s(): mknod() failed %s\n",
 190                         __func__, strerror(errno));
 191                 return -1;
 192         }
 193
 194         return ret;
 195 }
 196
 197 /*
 198  * Return the uioX char device used for a pci device. On success, return
 199  * the UIO number and fill dstbuf string with the path of the device in
 200  * sysfs. On error, return a negative value. In this case dstbuf is
 201  * invalid.
 202  */
 203 static int
 204 pci_get_uio_dev(struct rte_pci_device *dev, char *dstbuf,
 205                            unsigned int buflen)
 206 {
 207         struct rte_pci_addr *loc = &dev->addr;
 208         unsigned int uio_num;
 209         struct dirent *e;
 210         DIR *dir;
 211         char dirname[PATH_MAX];
 212
 213         /* depending on kernel version, uio can be located in uio/uioX
 214          * or uio:uioX */
 215
 216         rte_snprintf(dirname, sizeof(dirname),
 217                  SYSFS_PCI_DEVICES "/" PCI_PRI_FMT "/uio",
 218                  loc->domain, loc->bus, loc->devid, loc->function);
 219
 220         dir = opendir(dirname);
 221         if (dir == NULL) {
 222                 /* retry with the parent directory */
 223                 rte_snprintf(dirname, sizeof(dirname),
 224                          SYSFS_PCI_DEVICES "/" PCI_PRI_FMT,
 225                          loc->domain, loc->bus, loc->devid, loc->function);
 226                 dir = opendir(dirname);
 227
 228                 if (dir == NULL) {
 229                         RTE_LOG(ERR, EAL, "Cannot opendir %s\n", dirname);
 230                         return -1;
 231                 }
 232         }
 233
 234         /* take the first file starting with "uio" */
 235         while ((e = readdir(dir)) != NULL) {
 236                 /* format could be uio%d ...*/
 237                 int shortprefix_len = sizeof("uio") - 1;
 238                 /* ... or uio:uio%d */
 239                 int longprefix_len = sizeof("uio:uio") - 1;
 240                 char *endptr;
 241
 242                 if (strncmp(e->d_name, "uio", 3) != 0)
 243                         continue;
 244
 245                 /* first try uio%d */
 246                 errno = 0;
 247                 uio_num = strtoull(e->d_name + shortprefix_len, &endptr, 10);
 248                 if (errno == 0 && endptr != (e->d_name + shortprefix_len)) {
 249                         rte_snprintf(dstbuf, buflen, "%s/uio%u", dirname, uio_num);
 250                         break;
 251                 }
 252
 253                 /* then try uio:uio%d */
 254                 errno = 0;
 255                 uio_num = strtoull(e->d_name + longprefix_len, &endptr, 10);
 256                 if (errno == 0 && endptr != (e->d_name + longprefix_len)) {
 257                         rte_snprintf(dstbuf, buflen, "%s/uio:uio%u", dirname, uio_num);
 258                         break;
 259                 }
 260         }
 261         closedir(dir);
 262
 263         /* No uio resource found */
 264         if (e == NULL)
 265                 return -1;
 266
 267         /* create uio device if we've been asked to */
 268         if (internal_config.create_uio_dev && pci_mknod_uio_dev(dstbuf, uio_num) < 0)
 269                 RTE_LOG(WARNING, EAL, "Cannot create /dev/uio%u\n", uio_num);
 270
 271         return uio_num;
 272 }
 273
 274 /* map the PCI resource of a PCI device in virtual memory */
 275 int
 276 pci_uio_map_resource(struct rte_pci_device *dev)
 277 {
 278         int i, j;
 279         char dirname[PATH_MAX];
 280         char devname[PATH_MAX]; /* contains the /dev/uioX */
 281         void *mapaddr;
 282         int uio_num;
 283         uint64_t phaddr;
 284         uint64_t offset;
 285         uint64_t pagesz;
 286         int nb_maps;
 287         struct rte_pci_addr *loc = &dev->addr;
 288         struct mapped_pci_resource *uio_res;
 289         struct pci_map *maps;
 290
 291         dev->intr_handle.fd = -1;
 292         dev->intr_handle.type = RTE_INTR_HANDLE_UNKNOWN;
 293
 294         /* secondary processes - use already recorded details */
 295         if (rte_eal_process_type() != RTE_PROC_PRIMARY)
 296                 return (pci_uio_map_secondary(dev));
 297
 298         /* find uio resource */
 299         uio_num = pci_get_uio_dev(dev, dirname, sizeof(dirname));
 300         if (uio_num < 0) {
 301                 RTE_LOG(WARNING, EAL, "  "PCI_PRI_FMT" not managed by UIO driver, "
 302                                 "skipping\n", loc->domain, loc->bus, loc->devid, loc->function);
 303                 return -1;
 304         }
 305         rte_snprintf(devname, sizeof(devname), "/dev/uio%u", uio_num);
 306
 307         /* save fd if in primary process */
 308         dev->intr_handle.fd = open(devname, O_RDWR);
 309         if (dev->intr_handle.fd < 0) {
 310                 RTE_LOG(ERR, EAL, "Cannot open %s: %s\n",
 311                         devname, strerror(errno));
 312                 return -1;
 313         }
 314         dev->intr_handle.type = RTE_INTR_HANDLE_UIO;
 315
 316         /* allocate the mapping details for secondary processes*/
 317         if ((uio_res = rte_zmalloc("UIO_RES", sizeof (*uio_res), 0)) == NULL) {
 318                 RTE_LOG(ERR, EAL,
 319                         "%s(): cannot store uio mmap details\n", __func__);
 320                 return (-1);
 321         }
 322
 323         rte_snprintf(uio_res->path, sizeof(uio_res->path), "%s", devname);
 324         memcpy(&uio_res->pci_addr, &dev->addr, sizeof(uio_res->pci_addr));
 325
 326         /* collect info about device mappings */
 327         nb_maps = pci_uio_get_mappings(dirname, uio_res->maps,
 328                                        RTE_DIM(uio_res->maps));
 329         if (nb_maps < 0) {
 330                 rte_free(uio_res);
 331                 return (nb_maps);
 332         }
 333
 334         uio_res->nb_maps = nb_maps;
 335
 336         /* Map all BARs */
 337         pagesz = sysconf(_SC_PAGESIZE);
 338
 339         maps = uio_res->maps;
 340         for (i = 0; i != PCI_MAX_RESOURCE; i++) {
 341                 int fd;
 342
 343                 /* skip empty BAR */
 344                 if ((phaddr = dev->mem_resource[i].phys_addr) == 0)
 345                         continue;
 346
 347                 for (j = 0; j != nb_maps && (phaddr != maps[j].phaddr ||
 348                                 dev->mem_resource[i].len != maps[j].size);
 349                                 j++)
 350                         ;
 351
 352                 /* if matching map is found, then use it */
 353                 if (j != nb_maps) {
 354                         offset = j * pagesz;
 355
 356                         /*
 357                          * open devname, to mmap it
 358                          */
 359                         fd = open(devname, O_RDWR);
 360                         if (fd < 0) {
 361                                 RTE_LOG(ERR, EAL, "Cannot open %s: %s\n",
 362                                         devname, strerror(errno));
 363                                 return -1;
 364                         }
 365
 366                         if (maps[j].addr != NULL ||
 367                             (mapaddr = pci_map_resource(NULL, fd,
 368                                                         (off_t)offset,
 369                                                         (size_t)maps[j].size)
 370                             ) == NULL) {
 371                                 rte_free(uio_res);
 372                                 close(fd);
 373                                 return (-1);
 374                         }
 375                         close(fd);
 376
 377                         maps[j].addr = mapaddr;
 378                         maps[j].offset = offset;
 379                         dev->mem_resource[i].addr = mapaddr;
 380                 }
 381         }
 382
 383         TAILQ_INSERT_TAIL(pci_res_list, uio_res, next);
 384
 385         return (0);
 386 }
 387
 388 /*
 389  * parse a sysfs file containing one integer value
 390  * different to the eal version, as it needs to work with 64-bit values
 391  */
 392 static int
 393 pci_parse_sysfs_value(const char *filename, uint64_t *val)
 394 {
 395         FILE *f;
 396         char buf[BUFSIZ];
 397         char *end = NULL;
 398
 399         f = fopen(filename, "r");
 400         if (f == NULL) {
 401                 RTE_LOG(ERR, EAL, "%s(): cannot open sysfs value %s\n",
 402                         __func__, filename);
 403                 return -1;
 404         }
 405
 406         if (fgets(buf, sizeof(buf), f) == NULL) {
 407                 RTE_LOG(ERR, EAL, "%s(): cannot read sysfs value %s\n",
 408                         __func__, filename);
 409                 fclose(f);
 410                 return -1;
 411         }
 412         *val = strtoull(buf, &end, 0);
 413         if ((buf[0] == '\0') || (end == NULL) || (*end != '\n')) {
 414                 RTE_LOG(ERR, EAL, "%s(): cannot parse sysfs value %s\n",
 415                                 __func__, filename);
 416                 fclose(f);
 417                 return -1;
 418         }
 419         fclose(f);
 420         return 0;
 421 }