-/*-
- * BSD LICENSE
- *
- * Copyright 2014 6WIND S.A.
- *
- * 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 (c) 2021 NVIDIA Corporation & Affiliates
*/
-#include <stdio.h>
#include <stdlib.h>
+#include <stdio.h>
#include <string.h>
-#include <sys/queue.h>
-#include <rte_debug.h>
+#include <rte_common.h>
#include <rte_devargs.h>
+#include <rte_kvargs.h>
+#include <rte_bus.h>
+#include <rte_class.h>
#include "test.h"
-/* clear devargs list that was modified by the test */
-static void free_devargs_list(void)
+/* Check layer arguments. */
+static int
+test_args(const char *devargs, const char *layer, const char *args, const int n)
{
- struct rte_devargs *devargs;
+ struct rte_kvargs *kvlist;
- while (!TAILQ_EMPTY(&devargs_list)) {
- devargs = TAILQ_FIRST(&devargs_list);
- TAILQ_REMOVE(&devargs_list, devargs, next);
- free(devargs->args);
- free(devargs);
+ if (n == 0) {
+ if (args != NULL && strlen(args) > 0) {
+ printf("rte_devargs_parse(%s) %s args parsed (not expected)\n",
+ devargs, layer);
+ return -1;
+ } else {
+ return 0;
+ }
+ }
+ if (args == NULL) {
+ printf("rte_devargs_parse(%s) %s args not parsed\n",
+ devargs, layer);
+ return -1;
+ }
+ kvlist = rte_kvargs_parse(args, NULL);
+ if (kvlist == NULL) {
+ printf("rte_devargs_parse(%s) %s_str: %s not parsed\n",
+ devargs, layer, args);
+ return -1;
+ }
+ if ((int)kvlist->count != n) {
+ printf("rte_devargs_parse(%s) %s_str: %s kv number %u, not %d\n",
+ devargs, layer, args, kvlist->count, n);
+ rte_kvargs_free(kvlist);
+ return -1;
}
+ rte_kvargs_free(kvlist);
+ return 0;
}
+struct devargs_case {
+ const char *devargs;
+ int bus_kv;
+ int class_kv;
+ int driver_kv;
+ const char *bus;
+ const char *name;
+ const char *class;
+};
+
static int
-test_devargs(void)
+test_valid_devargs_cases(const struct devargs_case *list, size_t n)
{
- struct rte_devargs_list save_devargs_list;
- struct rte_devargs *devargs;
+ struct rte_devargs da;
+ uint32_t i;
+ int ret;
+ int fail = TEST_SUCCESS;
+ struct rte_bus *pci_bus = rte_bus_find_by_name("pci");
+ struct rte_bus *vdev_bus = rte_bus_find_by_name("vdev");
+ struct rte_class *eth_class = rte_class_find_by_name("eth");
- /* save the real devargs_list, it is restored at the end of the test */
- save_devargs_list = devargs_list;
- TAILQ_INIT(&devargs_list);
+ for (i = 0; i < n; i++) {
+ if (pci_bus == NULL && list[i].bus != NULL &&
+ strcmp(list[i].bus, "pci") == 0)
+ continue;
+ if (vdev_bus == NULL && list[i].bus != NULL &&
+ strcmp(list[i].bus, "vdev") == 0)
+ continue;
+ if (eth_class == NULL && list[i].class != NULL &&
+ strcmp(list[i].class, "eth") == 0)
+ continue;
+ memset(&da, 0, sizeof(da));
+ ret = rte_devargs_parse(&da, list[i].devargs);
+ if (ret < 0) {
+ printf("rte_devargs_parse(%s) returned %d (but should not)\n",
+ list[i].devargs, ret);
+ goto fail;
+ }
+ if ((list[i].bus_kv > 0 || list[i].bus != NULL) &&
+ da.bus == NULL) {
+ printf("rte_devargs_parse(%s) bus not parsed\n",
+ list[i].devargs);
+ goto fail;
+ }
+ if (test_args(list[i].devargs, "bus", da.bus_str,
+ list[i].bus_kv) != 0)
+ goto fail;
+ if (list[i].bus != NULL &&
+ strcmp(da.bus->name, list[i].bus) != 0) {
+ printf("rte_devargs_parse(%s) bus name (%s) not expected (%s)\n",
+ list[i].devargs, da.bus->name, list[i].bus);
+ goto fail;
+ }
+ if ((list[i].class_kv > 0 || list[i].class != NULL) &&
+ da.cls == NULL) {
+ printf("rte_devargs_parse(%s) class not parsed\n",
+ list[i].devargs);
+ goto fail;
+ }
+ if (test_args(list[i].devargs, "class", da.cls_str,
+ list[i].class_kv) != 0)
+ goto fail;
+ if (list[i].class != NULL &&
+ strcmp(da.cls->name, list[i].class) != 0) {
+ printf("rte_devargs_parse(%s) class name (%s) not expected (%s)\n",
+ list[i].devargs, da.cls->name, list[i].class);
+ goto fail;
+ }
+ if (test_args(list[i].devargs, "driver", da.drv_str,
+ list[i].driver_kv) != 0)
+ goto fail;
+ if (list[i].name != NULL &&
+ strcmp(da.name, list[i].name) != 0) {
+ printf("rte_devargs_parse(%s) device name (%s) not expected (%s)\n",
+ list[i].devargs, da.name, list[i].name);
+ goto fail;
+ }
+ goto cleanup;
+fail:
+ fail = TEST_FAILED;
+cleanup:
+ rte_devargs_reset(&da);
+ }
+ return fail;
+}
- /* test valid cases */
- if (rte_eal_devargs_add(RTE_DEVTYPE_WHITELISTED_PCI, "08:00.1") < 0)
- goto fail;
- if (rte_eal_devargs_add(RTE_DEVTYPE_WHITELISTED_PCI, "0000:5:00.0") < 0)
- goto fail;
- if (rte_eal_devargs_add(RTE_DEVTYPE_BLACKLISTED_PCI, "04:00.0,arg=val") < 0)
- goto fail;
- if (rte_eal_devargs_add(RTE_DEVTYPE_BLACKLISTED_PCI, "0000:01:00.1") < 0)
- goto fail;
- if (rte_eal_devargs_type_count(RTE_DEVTYPE_WHITELISTED_PCI) != 2)
- goto fail;
- if (rte_eal_devargs_type_count(RTE_DEVTYPE_BLACKLISTED_PCI) != 2)
- goto fail;
- if (rte_eal_devargs_type_count(RTE_DEVTYPE_VIRTUAL) != 0)
- goto fail;
- if (rte_eal_devargs_add(RTE_DEVTYPE_VIRTUAL, "eth_ring0") < 0)
- goto fail;
- if (rte_eal_devargs_add(RTE_DEVTYPE_VIRTUAL, "eth_ring1,key=val,k2=val2") < 0)
- goto fail;
- if (rte_eal_devargs_type_count(RTE_DEVTYPE_VIRTUAL) != 2)
- goto fail;
- free_devargs_list();
+/* Test several valid cases */
+static int
+test_valid_devargs(void)
+{
+ static const struct devargs_case list[] = {
+ /* Global devargs syntax: */
+ { "bus=pci",
+ 1, 0, 0, "pci", NULL, NULL},
+ { "class=eth",
+ 0, 1, 0, NULL, NULL, "eth" },
+ { "bus=pci,addr=1:2.3/class=eth/driver=abc,k0=v0",
+ 2, 1, 2, "pci", "0000:01:02.3", "eth" },
+ { "bus=vdev,name=/dev/file/name/class=eth",
+ 2, 1, 0, "vdev", "/dev/file/name", "eth" },
+ { "bus=vdev,name=/class/bus/path/class=eth",
+ 2, 1, 0, "vdev", "/class/bus/path", "eth" },
+ { "bus=vdev,name=///dblslsh/class=eth",
+ 2, 1, 0, "vdev", "///dblslsh", "eth" },
+ /* Legacy devargs syntax: */
+ { "1:2.3", 0, 0, 0,
+ "pci", "1:2.3", NULL },
+ { "pci:1:2.3,k0=v0",
+ 0, 0, 1, "pci", "1:2.3", NULL },
+ };
+ static const struct devargs_case legacy_ring_list[] = {
+ { "net_ring0",
+ 0, 0, 0, "vdev", "net_ring0", NULL },
+ { "net_ring0,iface=test,path=/class/bus/,queues=1",
+ 0, 0, 3, "vdev", "net_ring0", NULL },
+ };
+ struct rte_bus *vdev_bus = rte_bus_find_by_name("vdev");
+ int ret;
- /* check virtual device with argument parsing */
- if (rte_eal_devargs_add(RTE_DEVTYPE_VIRTUAL, "eth_ring1,k1=val,k2=val2") < 0)
- goto fail;
- devargs = TAILQ_FIRST(&devargs_list);
- if (strncmp(devargs->virt.drv_name, "eth_ring1",
- sizeof(devargs->virt.drv_name)) != 0)
- goto fail;
- if (!devargs->args || strcmp(devargs->args, "k1=val,k2=val2") != 0)
- goto fail;
- free_devargs_list();
+ ret = test_valid_devargs_cases(list, RTE_DIM(list));
+ if (vdev_bus != NULL && vdev_bus->parse("net_ring0", NULL) == 0)
+ /* Ring vdev driver enabled. */
+ ret |= test_valid_devargs_cases(legacy_ring_list,
+ RTE_DIM(legacy_ring_list));
+ return ret;
+}
- /* check PCI device with empty argument parsing */
- if (rte_eal_devargs_add(RTE_DEVTYPE_WHITELISTED_PCI, "04:00.1") < 0)
- goto fail;
- devargs = TAILQ_FIRST(&devargs_list);
- if (devargs->pci.addr.domain != 0 ||
- devargs->pci.addr.bus != 4 ||
- devargs->pci.addr.devid != 0 ||
- devargs->pci.addr.function != 1)
- goto fail;
- if (!devargs->args || strcmp(devargs->args, "") != 0)
- goto fail;
- free_devargs_list();
+/* Test several invalid cases */
+static int
+test_invalid_devargs(void)
+{
+ static const char * const list[] = {
+ "bus=wrong-bus",
+ "class=wrong-class"};
+ struct rte_devargs da;
+ uint32_t i;
+ int ret;
+ int fail = 0;
- /* test error case: bad PCI address */
- if (rte_eal_devargs_add(RTE_DEVTYPE_WHITELISTED_PCI, "08:1") == 0)
- goto fail;
- if (rte_eal_devargs_add(RTE_DEVTYPE_WHITELISTED_PCI, "00.1") == 0)
- goto fail;
- if (rte_eal_devargs_add(RTE_DEVTYPE_WHITELISTED_PCI, "foo") == 0)
- goto fail;
- if (rte_eal_devargs_add(RTE_DEVTYPE_WHITELISTED_PCI, ",") == 0)
- goto fail;
- if (rte_eal_devargs_add(RTE_DEVTYPE_WHITELISTED_PCI, "000f:0:0") == 0)
- goto fail;
+ for (i = 0; i < RTE_DIM(list); i++) {
+ ret = rte_devargs_parse(&da, list[i]);
+ if (ret >= 0) {
+ printf("rte_devargs_parse(%s) returned %d (but should not)\n",
+ list[i], ret);
+ fail = ret;
+ }
+ rte_devargs_reset(&da);
+ }
+ return fail;
+}
- devargs_list = save_devargs_list;
+static int
+test_devargs(void)
+{
+ printf("== test valid case ==\n");
+ if (test_valid_devargs() < 0)
+ return -1;
+ printf("== test invalid case ==\n");
+ if (test_invalid_devargs() < 0)
+ return -1;
return 0;
-
- fail:
- free_devargs_list();
- devargs_list = save_devargs_list;
- return -1;
}
-static struct test_command devargs_cmd = {
- .command = "devargs_autotest",
- .callback = test_devargs,
-};
-REGISTER_TEST_COMMAND(devargs_cmd);
+REGISTER_TEST_COMMAND(devargs_autotest, test_devargs);