4 * Copyright 2017 6WIND S.A.
5 * Copyright 2017 Mellanox.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
17 * * Neither the name of 6WIND S.A. 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.
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.
41 #include <rte_debug.h>
42 #include <rte_devargs.h>
43 #include <rte_malloc.h>
44 #include <rte_kvargs.h>
46 #include "failsafe_private.h"
48 /* Callback used when a new device is found in devargs */
49 typedef int (parse_cb)(struct rte_eth_dev *dev, const char *params,
52 uint64_t hotplug_poll = FAILSAFE_HOTPLUG_DEFAULT_TIMEOUT_MS;
55 const char *pmd_failsafe_init_parameters[] = {
56 PMD_FAILSAFE_HOTPLUG_POLL_KVARG,
57 PMD_FAILSAFE_MAC_KVARG,
63 * output: 0: if text[0] != '(',
64 * 0: if there are no corresponding ')'
65 * n: distance to corresponding ')' otherwise
68 closing_paren(const char *text)
73 while (text[i] != '\0') {
86 fs_parse_device(struct sub_device *sdev, char *args)
88 struct rte_devargs *d;
93 ret = rte_eal_devargs_parse(args, d);
95 DEBUG("devargs parsing failed with code %d", ret);
99 sdev->state = DEV_PARSED;
104 fs_sanitize_cmdline(char *args)
108 nl = strrchr(args, '\n');
114 fs_execute_cmd(struct sub_device *sdev, char *cmdline)
117 /* store possible newline as well */
118 char output[DEVARGS_MAXLEN + 1];
122 RTE_ASSERT(cmdline != NULL || sdev->cmdline != NULL);
123 if (sdev->cmdline == NULL) {
126 len = strlen(cmdline) + 1;
127 sdev->cmdline = calloc(1, len);
128 if (sdev->cmdline == NULL) {
129 ERROR("Command line allocation failed");
132 snprintf(sdev->cmdline, len, "%s", cmdline);
133 /* Replace all commas in the command line by spaces */
134 for (i = 0; i < len; i++)
135 if (sdev->cmdline[i] == ',')
136 sdev->cmdline[i] = ' ';
138 DEBUG("'%s'", sdev->cmdline);
139 fp = popen(sdev->cmdline, "r");
142 ERROR("popen: %s", strerror(errno));
145 /* We only read one line */
146 if (fgets(output, sizeof(output) - 1, fp) == NULL) {
147 DEBUG("Could not read command output");
151 fs_sanitize_cmdline(output);
152 if (output[0] == '\0') {
156 ret = fs_parse_device(sdev, output);
158 ERROR("Parsing device '%s' failed", output);
160 if (pclose(fp) == -1)
161 ERROR("pclose: %s", strerror(errno));
166 fs_read_fd(struct sub_device *sdev, char *fd_str)
170 /* store possible newline as well */
171 char output[DEVARGS_MAXLEN + 1];
176 RTE_ASSERT(fd_str != NULL || sdev->fd_str != NULL);
177 if (sdev->fd_str == NULL) {
178 sdev->fd_str = strdup(fd_str);
179 if (sdev->fd_str == NULL) {
180 ERROR("Command line allocation failed");
185 fd = strtol(fd_str, &fd_str, 0);
186 if (errno || *fd_str || fd < 0) {
187 ERROR("Parsing FD number failed");
190 /* Fiddle with copy of file descriptor */
194 oflags = fcntl(fd, F_GETFL);
197 if (fcntl(fd, F_SETFL, oflags | O_NONBLOCK) == -1)
199 fp = fdopen(fd, "r");
203 /* Only take the last line into account */
205 while (fgets(output, sizeof(output), fp))
209 else if (ferror(fp) && errno != EAGAIN)
211 /* Line must end with a newline character */
212 fs_sanitize_cmdline(output);
213 if (output[0] == '\0')
215 err = fs_parse_device(sdev, output);
217 ERROR("Parsing device '%s' failed", output);
227 fs_parse_device_param(struct rte_eth_dev *dev, const char *param,
230 struct fs_priv *priv;
231 struct sub_device *sdev;
240 while (param[b] != '(' &&
244 b += closing_paren(¶m[b]);
246 ERROR("Dangling parenthesis");
250 args = strndup(¶m[a], b - a);
252 ERROR("Not enough memory for parameter parsing");
255 sdev = &priv->subs[head];
256 if (strncmp(param, "dev", 3) == 0) {
257 ret = fs_parse_device(sdev, args);
260 } else if (strncmp(param, "exec", 4) == 0) {
261 ret = fs_execute_cmd(sdev, args);
262 if (ret == -ENODEV) {
263 DEBUG("Reading device info from command line failed");
268 } else if (strncmp(param, "fd(", 3) == 0) {
269 ret = fs_read_fd(sdev, args);
270 if (ret == -ENODEV) {
271 DEBUG("Reading device info from FD failed");
277 ERROR("Unrecognized device type: %.*s", (int)b, param);
286 fs_parse_sub_devices(parse_cb *cb,
287 struct rte_eth_dev *dev, const char *params)
296 while (params[a] != '\0') {
298 while (params[b] != '(' &&
303 ERROR("Invalid parameter");
306 if (params[b] == ',') {
310 if (params[b] == '(') {
313 b += closing_paren(¶ms[b]);
315 ERROR("Dangling parenthesis");
318 ret = (*cb)(dev, ¶ms[a], head);
323 if (params[b] == '\0')
332 fs_remove_sub_devices_definition(char params[DEVARGS_MAXLEN])
334 char buffer[DEVARGS_MAXLEN] = {0};
340 while (params[a] != '\0') {
342 while (params[b] != '(' &&
347 ERROR("Invalid parameter");
350 if (params[b] == ',' || params[b] == '\0') {
355 snprintf(&buffer[i], len + 1, "%s%s",
356 i ? "," : "", ¶ms[a]);
358 } else if (params[b] == '(') {
361 b += closing_paren(¶ms[b]);
365 if (params[b] == '\0')
371 snprintf(params, DEVARGS_MAXLEN, "%s", buffer);
376 fs_get_u64_arg(const char *key __rte_unused,
377 const char *value, void *out)
382 if ((value == NULL) || (out == NULL))
385 *u64 = strtoull(value, &endptr, 0);
394 fs_get_mac_addr_arg(const char *key __rte_unused,
395 const char *value, void *out)
397 struct ether_addr *ea = out;
400 if ((value == NULL) || (out == NULL))
402 ret = sscanf(value, "%hhx:%hhx:%hhx:%hhx:%hhx:%hhx",
403 &ea->addr_bytes[0], &ea->addr_bytes[1],
404 &ea->addr_bytes[2], &ea->addr_bytes[3],
405 &ea->addr_bytes[4], &ea->addr_bytes[5]);
406 return ret != ETHER_ADDR_LEN;
410 failsafe_args_parse(struct rte_eth_dev *dev, const char *params)
412 struct fs_priv *priv;
413 char mut_params[DEVARGS_MAXLEN] = "";
414 struct rte_kvargs *kvlist = NULL;
415 unsigned int arg_count;
421 priv->subs_tx = FAILSAFE_MAX_ETHPORTS;
422 /* default parameters */
423 n = snprintf(mut_params, sizeof(mut_params), "%s", params);
424 if (n >= sizeof(mut_params)) {
425 ERROR("Parameter string too long (>=%zu)",
429 ret = fs_parse_sub_devices(fs_parse_device_param,
433 ret = fs_remove_sub_devices_definition(mut_params);
436 if (strnlen(mut_params, sizeof(mut_params)) > 0) {
437 kvlist = rte_kvargs_parse(mut_params,
438 pmd_failsafe_init_parameters);
439 if (kvlist == NULL) {
440 ERROR("Error parsing parameters, usage:\n"
441 PMD_FAILSAFE_PARAM_STRING);
444 /* PLUG_IN event poll timer */
445 arg_count = rte_kvargs_count(kvlist,
446 PMD_FAILSAFE_HOTPLUG_POLL_KVARG);
447 if (arg_count == 1) {
448 ret = rte_kvargs_process(kvlist,
449 PMD_FAILSAFE_HOTPLUG_POLL_KVARG,
450 &fs_get_u64_arg, &hotplug_poll);
455 arg_count = rte_kvargs_count(kvlist,
456 PMD_FAILSAFE_MAC_KVARG);
458 ret = rte_kvargs_process(kvlist,
459 PMD_FAILSAFE_MAC_KVARG,
460 &fs_get_mac_addr_arg,
461 &dev->data->mac_addrs[0]);
468 PRIV(dev)->state = DEV_PARSED;
470 rte_kvargs_free(kvlist);
475 failsafe_args_free(struct rte_eth_dev *dev)
477 struct sub_device *sdev;
480 FOREACH_SUBDEV(sdev, i, dev) {
482 sdev->cmdline = NULL;
485 free(sdev->devargs.args);
486 sdev->devargs.args = NULL;
491 fs_count_device(struct rte_eth_dev *dev, const char *param,
492 uint8_t head __rte_unused)
496 while (param[b] != '(' &&
499 if (strncmp(param, "dev", b) != 0 &&
500 strncmp(param, "exec", b) != 0 &&
501 strncmp(param, "fd(", b) != 0) {
502 ERROR("Unrecognized device type: %.*s", (int)b, param);
505 PRIV(dev)->subs_tail += 1;
510 failsafe_args_count_subdevice(struct rte_eth_dev *dev,
513 return fs_parse_sub_devices(fs_count_device,
518 fs_parse_sub_device(struct sub_device *sdev)
520 struct rte_devargs *da;
521 char devstr[DEVARGS_MAXLEN] = "";
524 snprintf(devstr, sizeof(devstr), "%s,%s", da->name, da->args);
525 return fs_parse_device(sdev, devstr);
529 failsafe_args_parse_subs(struct rte_eth_dev *dev)
531 struct sub_device *sdev;
535 FOREACH_SUBDEV(sdev, i, dev) {
536 if (sdev->state >= DEV_PARSED)
539 ret = fs_execute_cmd(sdev, sdev->cmdline);
540 else if (sdev->fd_str)
541 ret = fs_read_fd(sdev, sdev->fd_str);
543 ret = fs_parse_sub_device(sdev);
545 sdev->state = DEV_PARSED;