lib/librte_eal/common/eal_common_devargs.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright 2014 6WIND S.A.
   5  *
   6  *   Redistribution and use in source and binary forms, with or without
   7  *   modification, are permitted provided that the following conditions
   8  *   are met:
   9  *
  10  *     * Redistributions of source code must retain the above copyright
  11  *       notice, this list of conditions and the following disclaimer.
  12  *     * Redistributions in binary form must reproduce the above copyright
  13  *       notice, this list of conditions and the following disclaimer in
  14  *       the documentation and/or other materials provided with the
  15  *       distribution.
  16  *     * Neither the name of 6WIND S.A nor the names of its contributors
  17  *       may be used to endorse or promote products derived from this
  18  *       software without specific prior written permission.
  19  *
  20  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  24  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 /* This file manages the list of devices and their arguments, as given
  34  * by the user at startup
  35  *
  36  * Code here should not call rte_log since the EAL environment
  37  * may not be initialized.
  38  */
  39
  40 #include <stdio.h>
  41 #include <string.h>
  42
  43 #include <rte_devargs.h>
  44 #include "eal_private.h"
  45
  46 /** Global list of user devices */
  47 struct rte_devargs_list devargs_list =
  48         TAILQ_HEAD_INITIALIZER(devargs_list);
  49
  50 int
  51 rte_eal_parse_devargs_str(const char *devargs_str,
  52                         char **drvname, char **drvargs)
  53 {
  54         char *sep;
  55
  56         if ((devargs_str) == NULL || (drvname) == NULL || (drvargs == NULL))
  57                 return -1;
  58
  59         *drvname = strdup(devargs_str);
  60         if (*drvname == NULL)
  61                 return -1;
  62
  63         /* set the first ',' to '\0' to split name and arguments */
  64         sep = strchr(*drvname, ',');
  65         if (sep != NULL) {
  66                 sep[0] = '\0';
  67                 *drvargs = strdup(sep + 1);
  68         } else {
  69                 *drvargs = strdup("");
  70         }
  71
  72         if (*drvargs == NULL) {
  73                 free(*drvname);
  74                 *drvname = NULL;
  75                 return -1;
  76         }
  77         return 0;
  78 }
  79
  80 static int
  81 bus_name_cmp(const struct rte_bus *bus, const void *name)
  82 {
  83         return strncmp(bus->name, name, strlen(bus->name));
  84 }
  85
  86 /* store a whitelist parameter for later parsing */
  87 int
  88 rte_eal_devargs_add(enum rte_devtype devtype, const char *devargs_str)
  89 {
  90         struct rte_devargs *devargs = NULL;
  91         struct rte_bus *bus = NULL;
  92         char *dev = NULL;
  93         const char *devname;
  94         int ret;
  95
  96         /* use malloc instead of rte_malloc as it's called early at init */
  97         devargs = malloc(sizeof(*devargs));
  98         if (devargs == NULL)
  99                 goto fail;
 100
 101         memset(devargs, 0, sizeof(*devargs));
 102         devargs->type = devtype;
 103
 104         if (rte_eal_parse_devargs_str(devargs_str, &dev, &devargs->args))
 105                 goto fail;
 106         devname = dev;
 107         do {
 108                 bus = rte_bus_find(bus, bus_name_cmp, dev);
 109                 if (bus == NULL)
 110                         break;
 111                 devname = dev + strlen(bus->name) + 1;
 112                 if (rte_bus_find_by_device_name(devname) == bus)
 113                         break;
 114                 devname = dev;
 115         } while (1);
 116         if (bus == NULL) {
 117                 bus = rte_bus_find_by_device_name(devname);
 118                 if (bus == NULL) {
 119                         fprintf(stderr, "ERROR: failed to parse bus info from device declaration\n");
 120                         goto fail;
 121                 }
 122         }
 123         devargs->bus = bus;
 124
 125         /* save device name. */
 126         ret = snprintf(devargs->name, sizeof(devargs->name), "%s", devname);
 127         if (ret < 0 || ret >= (int)sizeof(devargs->name))
 128                 goto fail;
 129         if (devargs->type == RTE_DEVTYPE_WHITELISTED_PCI) {
 130                 if (bus->conf.scan_mode == RTE_BUS_SCAN_UNDEFINED) {
 131                         bus->conf.scan_mode = RTE_BUS_SCAN_WHITELIST;
 132                 } else if (bus->conf.scan_mode == RTE_BUS_SCAN_BLACKLIST) {
 133                         fprintf(stderr, "ERROR: incompatible device type and bus scan mode\n");
 134                         goto fail;
 135                 }
 136         } else if (devargs->type == RTE_DEVTYPE_BLACKLISTED_PCI) {
 137                 if (bus->conf.scan_mode == RTE_BUS_SCAN_UNDEFINED) {
 138                         bus->conf.scan_mode = RTE_BUS_SCAN_BLACKLIST;
 139                 } else if (bus->conf.scan_mode == RTE_BUS_SCAN_WHITELIST) {
 140                         fprintf(stderr, "ERROR: incompatible device type and bus scan mode\n");
 141                         goto fail;
 142                 }
 143         }
 144
 145         free(dev);
 146         TAILQ_INSERT_TAIL(&devargs_list, devargs, next);
 147         return 0;
 148
 149 fail:
 150         free(dev);
 151         if (devargs) {
 152                 free(devargs->args);
 153                 free(devargs);
 154         }
 155
 156         return -1;
 157 }
 158
 159 /* count the number of devices of a specified type */
 160 unsigned int
 161 rte_eal_devargs_type_count(enum rte_devtype devtype)
 162 {
 163         struct rte_devargs *devargs;
 164         unsigned int count = 0;
 165
 166         TAILQ_FOREACH(devargs, &devargs_list, next) {
 167                 if (devargs->type != devtype)
 168                         continue;
 169                 count++;
 170         }
 171         return count;
 172 }
 173
 174 /* dump the user devices on the console */
 175 void
 176 rte_eal_devargs_dump(FILE *f)
 177 {
 178         struct rte_devargs *devargs;
 179
 180         fprintf(f, "User device list:\n");
 181         TAILQ_FOREACH(devargs, &devargs_list, next) {
 182                 fprintf(f, "  [%s]: %s %s\n",
 183                         (devargs->bus ? devargs->bus->name : "??"),
 184                         devargs->name, devargs->args);
 185         }
 186 }