lib/librte_eal/common/eal_common_whitelist.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2013 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
  35 /**
  36  * This file provides functions for managing a whitelist of devices. An EAL
  37  * command-line parameter should be used for specifying what devices to
  38  * whitelist, and the functions here should be called in handling that
  39  * parameter. Then when scanning the PCI bus, the is_whitelisted() function
  40  * can be used to query the previously set up whitelist.
  41  */
  42 #include <string.h>
  43 #include <rte_string_fns.h>
  44 #include <rte_log.h>
  45 #include <rte_debug.h>
  46 #include <rte_pci.h>
  47 #include <ctype.h>
  48 #include "eal_private.h"
  49
  50 static char dev_list_str[4096];
  51 static size_t dev_list_str_len = 0;
  52
  53 /*
  54  * structure for storing a whitelist entry. Unlike for blacklists, we may
  55  * in future use this for dummy NICs not backed by a physical device, e.g.
  56  * backed by a file-system object instead, so we store the device path/addr
  57  * as a string, rather than as a PCI Bus-Device-Function.
  58  */
  59 static struct whitelist_entry {
  60         const char *device_str;
  61         const char *device_params;
  62 } whitelist[RTE_MAX_ETHPORTS] = { {NULL, NULL} };
  63
  64 static unsigned num_wl_entries = 0;
  65
  66 /* store a whitelist parameter for later parsing */
  67 int
  68 eal_dev_whitelist_add_entry(const char *entry)
  69 {
  70         dev_list_str_len += rte_snprintf(&dev_list_str[dev_list_str_len],
  71                         sizeof(dev_list_str)-dev_list_str_len, "%s,", entry);
  72         /* check for strings that won't fit (snprintf doesn't go beyond buffer) */
  73         if (dev_list_str_len >= sizeof(dev_list_str)) {
  74                 dev_list_str_len = sizeof(dev_list_str) - 1;
  75                 return -1;
  76         }
  77
  78         return 0;
  79 }
  80
  81 /* check if a whitelist has been set up */
  82 int
  83 eal_dev_whitelist_exists(void)
  84 {
  85         return !!dev_list_str_len;
  86 }
  87
  88 /* sanity checks a whitelist entry to ensure device is correct */
  89 static int
  90 is_valid_wl_entry(const char *device_str, size_t dev_buf_len)
  91 {
  92 #define NUM_PREFIXES (sizeof(non_pci_prefixes)/sizeof(non_pci_prefixes[0]))
  93         static const char *non_pci_prefixes[] = {
  94                         "-nodev-" /* dummy value to prevent compiler warnings */
  95         };
  96         static uint8_t prefix_counts[NUM_PREFIXES] = {0};
  97         char buf[16];
  98         unsigned i;
  99         struct rte_pci_addr pci_addr = { .domain = 0 };
 100
 101         if (eal_parse_pci_BDF(device_str, &pci_addr) == 0) {
 102                 size_t n = rte_snprintf(buf, sizeof(buf), PCI_SHORT_PRI_FMT,
 103                                 pci_addr.bus, pci_addr.devid, pci_addr.function);
 104                 return (n == dev_buf_len) && (!strncmp(buf, device_str, dev_buf_len));
 105         }
 106         if (eal_parse_pci_DomBDF(device_str, &pci_addr) == 0) {
 107                 size_t n = rte_snprintf(buf, sizeof(buf), PCI_PRI_FMT, pci_addr.domain,
 108                                 pci_addr.bus, pci_addr.devid, pci_addr.function);
 109                 return (n == dev_buf_len) && (!strncmp(buf, device_str, dev_buf_len));
 110         }
 111         for (i = 0; i < NUM_PREFIXES; i++) {
 112                 size_t n = rte_snprintf(buf, sizeof(buf), "%s%u",
 113                                 non_pci_prefixes[i], prefix_counts[i]);
 114                 if ((n == dev_buf_len) && (!strncmp(buf, device_str, dev_buf_len))) {
 115                         prefix_counts[i]++;
 116                         return 1;
 117                 }
 118         }
 119         return 0;
 120 }
 121
 122 /*
 123  * parse a whitelist string into a set of valid devices. To be called once
 124  * all parameters have been added to the whitelist string.
 125  */
 126 int
 127 eal_dev_whitelist_parse(void)
 128 {
 129         char *devs[RTE_MAX_ETHPORTS + 1] = { NULL };
 130         int i, num_devs;
 131         unsigned dev_name_len, j;
 132
 133         if (!eal_dev_whitelist_exists())
 134                 return -1;
 135
 136         /* strip off any extra commas */
 137         if (dev_list_str[dev_list_str_len - 1] == ',')
 138                 dev_list_str[--dev_list_str_len] = '\0';
 139
 140         /* split on commas into separate device entries */
 141         num_devs = rte_strsplit(dev_list_str, sizeof(dev_list_str), devs,
 142                         RTE_MAX_ETHPORTS+1, ',');
 143         if (num_devs > RTE_MAX_ETHPORTS) {
 144                 RTE_LOG(ERR, EAL, "Error, too many devices specified. "
 145                                 "[RTE_MAX_ETHPORTS = %u]\n", (unsigned)RTE_MAX_ETHPORTS);
 146                 return -1;
 147         }
 148
 149         size_t buf_len_rem = sizeof(dev_list_str); /* for tracking buffer length */
 150         for (i = 0; i < num_devs; i++) {
 151                 char *dev_n_params[2]; /* possibly split device name from params*/
 152
 153                 size_t curr_len = strnlen(devs[i], buf_len_rem);
 154                 buf_len_rem-= (curr_len + 1);
 155
 156                 int split_res = rte_strsplit(devs[i], curr_len, dev_n_params, 2, ';');
 157
 158                 /* device names go lower case, i.e. '00:0A.0' wouldn't work
 159                  * while '00:0a.0' would. */
 160                 dev_name_len = strnlen(dev_n_params[0], curr_len);
 161                 for (j = 0; j < dev_name_len; j++)
 162                         dev_n_params[0][j] = (char)tolower((int)dev_n_params[0][j]);
 163
 164                 switch (split_res) {
 165                 case 2:
 166                         whitelist[i].device_params = dev_n_params[1]; /* fallthrough */
 167                 case 1:
 168                         whitelist[i].device_str = dev_n_params[0];
 169                         break;
 170                 default: /* should never ever occur */
 171                         rte_panic("Fatal error parsing whitelist [--use-device] options\n");
 172                 }
 173
 174                 if (!is_valid_wl_entry(whitelist[i].device_str,
 175                                 strnlen(whitelist[i].device_str, curr_len))) {
 176                         RTE_LOG(ERR, EAL, "Error parsing device identifier: '%s'\n",
 177                                         whitelist[i].device_str);
 178                         return -1;
 179                 }
 180         }
 181         num_wl_entries = num_devs;
 182         return 0;
 183 }
 184
 185 /* check if a device is on the whitelist */
 186 int
 187 eal_dev_is_whitelisted(const char *device_str, const char **params)
 188 {
 189         unsigned i;
 190         if (!eal_dev_whitelist_exists())
 191                 return 0; /* return false if no whitelist set up */
 192
 193         for (i = 0; i < num_wl_entries; i++)
 194                 if (strncmp(device_str, whitelist[i].device_str, 32) == 0) {
 195                         if (params != NULL)
 196                                 *params = whitelist[i].device_params;
 197                         return 1;
 198                 }
 199
 200         return 0;
 201 }
 202
 203 /* clear the whole whitelist */
 204 void
 205 eal_dev_whitelist_clear(void)
 206 {
 207         dev_list_str[0] = '\0';
 208         dev_list_str_len = num_wl_entries = 0;
 209 }