net/failsafe: use SPDX tags in 6WIND copyrighted files
[dpdk.git] / drivers / net / failsafe / failsafe_args.c
index bde8f2d..366dbea 100644 (file)
@@ -1,53 +1,31 @@
-/*-
- *   BSD LICENSE
- *
- *   Copyright 2017 6WIND S.A.
- *   Copyright 2017 Mellanox.
- *
- *   Redistribution and use in source and binary forms, with or without
- *   modification, are permitted provided that the following conditions
- *   are met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in
- *       the documentation and/or other materials provided with the
- *       distribution.
- *     * Neither the name of 6WIND S.A. nor the names of its
- *       contributors may be used to endorse or promote products derived
- *       from this software without specific prior written permission.
- *
- *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright 2017 6WIND S.A.
+ * Copyright 2017 Mellanox.
  */
 
+#include <fcntl.h>
+#include <stdio.h>
+#include <stdlib.h>
 #include <string.h>
+#include <unistd.h>
+#include <errno.h>
 
+#include <rte_debug.h>
 #include <rte_devargs.h>
 #include <rte_malloc.h>
 #include <rte_kvargs.h>
 
 #include "failsafe_private.h"
 
-#define DEVARGS_MAXLEN 4096
-
 /* Callback used when a new device is found in devargs */
 typedef int (parse_cb)(struct rte_eth_dev *dev, const char *params,
                uint8_t head);
 
+uint64_t hotplug_poll = FAILSAFE_HOTPLUG_DEFAULT_TIMEOUT_MS;
 int mac_from_arg = 0;
 
 const char *pmd_failsafe_init_parameters[] = {
+       PMD_FAILSAFE_HOTPLUG_POLL_KVARG,
        PMD_FAILSAFE_MAC_KVARG,
        NULL,
 };
@@ -94,6 +72,129 @@ fs_parse_device(struct sub_device *sdev, char *args)
        return 0;
 }
 
+static void
+fs_sanitize_cmdline(char *args)
+{
+       char *nl;
+
+       nl = strrchr(args, '\n');
+       if (nl)
+               nl[0] = '\0';
+}
+
+static int
+fs_execute_cmd(struct sub_device *sdev, char *cmdline)
+{
+       FILE *fp;
+       /* store possible newline as well */
+       char output[DEVARGS_MAXLEN + 1];
+       size_t len;
+       int ret;
+
+       RTE_ASSERT(cmdline != NULL || sdev->cmdline != NULL);
+       if (sdev->cmdline == NULL) {
+               size_t i;
+
+               len = strlen(cmdline) + 1;
+               sdev->cmdline = calloc(1, len);
+               if (sdev->cmdline == NULL) {
+                       ERROR("Command line allocation failed");
+                       return -ENOMEM;
+               }
+               snprintf(sdev->cmdline, len, "%s", cmdline);
+               /* Replace all commas in the command line by spaces */
+               for (i = 0; i < len; i++)
+                       if (sdev->cmdline[i] == ',')
+                               sdev->cmdline[i] = ' ';
+       }
+       DEBUG("'%s'", sdev->cmdline);
+       fp = popen(sdev->cmdline, "r");
+       if (fp == NULL) {
+               ret = -errno;
+               ERROR("popen: %s", strerror(errno));
+               return ret;
+       }
+       /* We only read one line */
+       if (fgets(output, sizeof(output) - 1, fp) == NULL) {
+               DEBUG("Could not read command output");
+               ret = -ENODEV;
+               goto ret_pclose;
+       }
+       fs_sanitize_cmdline(output);
+       if (output[0] == '\0') {
+               ret = -ENODEV;
+               goto ret_pclose;
+       }
+       ret = fs_parse_device(sdev, output);
+       if (ret)
+               ERROR("Parsing device '%s' failed", output);
+ret_pclose:
+       if (pclose(fp) == -1)
+               ERROR("pclose: %s", strerror(errno));
+       return ret;
+}
+
+static int
+fs_read_fd(struct sub_device *sdev, char *fd_str)
+{
+       FILE *fp = NULL;
+       int fd = -1;
+       /* store possible newline as well */
+       char output[DEVARGS_MAXLEN + 1];
+       int err = -ENODEV;
+       int oflags;
+       int lcount;
+
+       RTE_ASSERT(fd_str != NULL || sdev->fd_str != NULL);
+       if (sdev->fd_str == NULL) {
+               sdev->fd_str = strdup(fd_str);
+               if (sdev->fd_str == NULL) {
+                       ERROR("Command line allocation failed");
+                       return -ENOMEM;
+               }
+       }
+       errno = 0;
+       fd = strtol(fd_str, &fd_str, 0);
+       if (errno || *fd_str || fd < 0) {
+               ERROR("Parsing FD number failed");
+               goto error;
+       }
+       /* Fiddle with copy of file descriptor */
+       fd = dup(fd);
+       if (fd == -1)
+               goto error;
+       oflags = fcntl(fd, F_GETFL);
+       if (oflags == -1)
+               goto error;
+       if (fcntl(fd, F_SETFL, oflags | O_NONBLOCK) == -1)
+               goto error;
+       fp = fdopen(fd, "r");
+       if (fp == NULL)
+               goto error;
+       fd = -1;
+       /* Only take the last line into account */
+       lcount = 0;
+       while (fgets(output, sizeof(output), fp))
+               ++lcount;
+       if (lcount == 0)
+               goto error;
+       else if (ferror(fp) && errno != EAGAIN)
+               goto error;
+       /* Line must end with a newline character */
+       fs_sanitize_cmdline(output);
+       if (output[0] == '\0')
+               goto error;
+       err = fs_parse_device(sdev, output);
+       if (err)
+               ERROR("Parsing device '%s' failed", output);
+error:
+       if (fp)
+               fclose(fp);
+       if (fd != -1)
+               close(fd);
+       return err;
+}
+
 static int
 fs_parse_device_param(struct rte_eth_dev *dev, const char *param,
                uint8_t head)
@@ -128,6 +229,22 @@ fs_parse_device_param(struct rte_eth_dev *dev, const char *param,
                ret = fs_parse_device(sdev, args);
                if (ret)
                        goto free_args;
+       } else if (strncmp(param, "exec", 4) == 0) {
+               ret = fs_execute_cmd(sdev, args);
+               if (ret == -ENODEV) {
+                       DEBUG("Reading device info from command line failed");
+                       ret = 0;
+               }
+               if (ret)
+                       goto free_args;
+       } else if (strncmp(param, "fd(", 3) == 0) {
+               ret = fs_read_fd(sdev, args);
+               if (ret == -ENODEV) {
+                       DEBUG("Reading device info from FD failed");
+                       ret = 0;
+               }
+               if (ret)
+                       goto free_args;
        } else {
                ERROR("Unrecognized device type: %.*s", (int)b, param);
                return -EINVAL;
@@ -202,10 +319,17 @@ fs_remove_sub_devices_definition(char params[DEVARGS_MAXLEN])
                        ERROR("Invalid parameter");
                        return -EINVAL;
                }
-               if (params[b] == ',' || params[b] == '\0')
-                       i += snprintf(&buffer[i], b - a + 1, "%s", &params[a]);
-               if (params[b] == '(') {
+               if (params[b] == ',' || params[b] == '\0') {
+                       size_t len = b - a;
+
+                       if (i > 0)
+                               len += 1;
+                       snprintf(&buffer[i], len + 1, "%s%s",
+                                       i ? "," : "", &params[a]);
+                       i += len;
+               } else if (params[b] == '(') {
                        size_t start = b;
+
                        b += closing_paren(&params[b]);
                        if (b == start)
                                return -EINVAL;
@@ -220,6 +344,24 @@ out:
        return 0;
 }
 
+static int
+fs_get_u64_arg(const char *key __rte_unused,
+               const char *value, void *out)
+{
+       uint64_t *u64 = out;
+       char *endptr = NULL;
+
+       if ((value == NULL) || (out == NULL))
+               return -EINVAL;
+       errno = 0;
+       *u64 = strtoull(value, &endptr, 0);
+       if (errno != 0)
+               return -errno;
+       if (endptr == value)
+               return -1;
+       return 0;
+}
+
 static int
 fs_get_mac_addr_arg(const char *key __rte_unused,
                const char *value, void *out)
@@ -271,6 +413,16 @@ failsafe_args_parse(struct rte_eth_dev *dev, const char *params)
                                PMD_FAILSAFE_PARAM_STRING);
                        return -1;
                }
+               /* PLUG_IN event poll timer */
+               arg_count = rte_kvargs_count(kvlist,
+                               PMD_FAILSAFE_HOTPLUG_POLL_KVARG);
+               if (arg_count == 1) {
+                       ret = rte_kvargs_process(kvlist,
+                                       PMD_FAILSAFE_HOTPLUG_POLL_KVARG,
+                                       &fs_get_u64_arg, &hotplug_poll);
+                       if (ret < 0)
+                               goto free_kvlist;
+               }
                /* MAC addr */
                arg_count = rte_kvargs_count(kvlist,
                                PMD_FAILSAFE_MAC_KVARG);
@@ -281,9 +433,11 @@ failsafe_args_parse(struct rte_eth_dev *dev, const char *params)
                                        &dev->data->mac_addrs[0]);
                        if (ret < 0)
                                goto free_kvlist;
+
                        mac_from_arg = 1;
                }
        }
+       PRIV(dev)->state = DEV_PARSED;
 free_kvlist:
        rte_kvargs_free(kvlist);
        return ret;
@@ -296,6 +450,10 @@ failsafe_args_free(struct rte_eth_dev *dev)
        uint8_t i;
 
        FOREACH_SUBDEV(sdev, i, dev) {
+               free(sdev->cmdline);
+               sdev->cmdline = NULL;
+               free(sdev->fd_str);
+               sdev->fd_str = NULL;
                free(sdev->devargs.args);
                sdev->devargs.args = NULL;
        }
@@ -310,7 +468,9 @@ fs_count_device(struct rte_eth_dev *dev, const char *param,
        while  (param[b] != '(' &&
                param[b] != '\0')
                b++;
-       if (strncmp(param, "dev", b) != 0) {
+       if (strncmp(param, "dev", b) != 0 &&
+           strncmp(param, "exec", b) != 0 &&
+           strncmp(param, "fd(", b) != 0) {
                ERROR("Unrecognized device type: %.*s", (int)b, param);
                return -EINVAL;
        }
@@ -325,3 +485,36 @@ failsafe_args_count_subdevice(struct rte_eth_dev *dev,
        return fs_parse_sub_devices(fs_count_device,
                                    dev, params);
 }
+
+static int
+fs_parse_sub_device(struct sub_device *sdev)
+{
+       struct rte_devargs *da;
+       char devstr[DEVARGS_MAXLEN] = "";
+
+       da = &sdev->devargs;
+       snprintf(devstr, sizeof(devstr), "%s,%s", da->name, da->args);
+       return fs_parse_device(sdev, devstr);
+}
+
+int
+failsafe_args_parse_subs(struct rte_eth_dev *dev)
+{
+       struct sub_device *sdev;
+       uint8_t i;
+       int ret = 0;
+
+       FOREACH_SUBDEV(sdev, i, dev) {
+               if (sdev->state >= DEV_PARSED)
+                       continue;
+               if (sdev->cmdline)
+                       ret = fs_execute_cmd(sdev, sdev->cmdline);
+               else if (sdev->fd_str)
+                       ret = fs_read_fd(sdev, sdev->fd_str);
+               else
+                       ret = fs_parse_sub_device(sdev);
+               if (ret == 0)
+                       sdev->state = DEV_PARSED;
+       }
+       return 0;
+}