eal: add option usage string

Add a usage string field in rte_option, allowing to display
help to the user and describe which options are currently available.

Signed-off-by: Gaetan Rivet <gaetan.rivet@6wind.com>

diff --git a/lib/librte_eal/common/eal_common_options.c b/lib/librte_eal/common/eal_common_options.c
index a2d862b5f91260f60a4f010a2ee08109fa45b966..3796dbf48f7efd3fdd05636f11060a86e53f4ad1 100644 (file)
--- a/lib/librte_eal/common/eal_common_options.c
+++ b/lib/librte_eal/common/eal_common_options.c
@@ -1515,4 +1515,5 @@ eal_common_usage(void)
               "  --"OPT_NO_HPET"           Disable HPET\n"
               "  --"OPT_NO_SHCONF"         No shared config (mmap'd files)\n"
               "\n", RTE_MAX_LCORE);
+       rte_option_usage();
 }

diff --git a/lib/librte_eal/common/eal_private.h b/lib/librte_eal/common/eal_private.h
index 4f483833db3f731b11c730dd24183d0d10496427..798ede553b2170177c6a381742bce8e79e79fd1c 100644 (file)
--- a/lib/librte_eal/common/eal_private.h
+++ b/lib/librte_eal/common/eal_private.h
@@ -374,4 +374,11 @@ rte_option_parse(const char *opt);
 void
 rte_option_init(void);
 
+/**
+ * Iterate through the registered options and show the associated
+ * usage string.
+ */
+void
+rte_option_usage(void);
+
 #endif /* _EAL_PRIVATE_H_ */

diff --git a/lib/librte_eal/common/include/rte_option.h b/lib/librte_eal/common/include/rte_option.h
index 8957b970cde5b1d1f41311be21f40fb1603bc7c9..bbcc6cec9eb1255023cd6726d620bbf9abcf27db 100644 (file)
--- a/lib/librte_eal/common/include/rte_option.h
+++ b/lib/librte_eal/common/include/rte_option.h
@@ -35,6 +35,7 @@ typedef int (*rte_option_cb)(void);
 struct rte_option {
        TAILQ_ENTRY(rte_option) next; /**< Next entry in the list. */
        char *opt_str;             /**< The option name. */
+       const char *usage; /**< Option summary string. */
        rte_option_cb cb;          /**< Function called when option is used. */
        int enabled;               /**< Set when the option is used. */
 };

diff --git a/lib/librte_eal/common/rte_option.c b/lib/librte_eal/common/rte_option.c
index 9e233f7d2fe23bf99657673a42115f14be9c1e8b..2ed74873b4b0fb9250b3d50bd78b3fb184ca2dfe 100644 (file)
--- a/lib/librte_eal/common/rte_option.c
+++ b/lib/librte_eal/common/rte_option.c
@@ -61,3 +61,20 @@ rte_option_init(void)
                        option->cb();
        }
 }
+
+void
+rte_option_usage(void)
+{
+       struct rte_option *option;
+       int opt_count = 0;
+
+       TAILQ_FOREACH(option, &rte_option_list, next)
+               opt_count += 1;
+       if (opt_count == 0)
+               return;
+
+       printf("EAL dynamic options:\n");
+       TAILQ_FOREACH(option, &rte_option_list, next)
+               printf("  --%-*s %s\n", 17, option->opt_str, option->usage);
+       printf("\n");
+}

diff --git a/lib/librte_telemetry/rte_telemetry.c b/lib/librte_telemetry/rte_telemetry.c
index b2972d73365ef38589d53964a95b509abeeed66e..2e808cd7aad43baa09c9559d78b3759edf32fbe6 100644 (file)
--- a/lib/librte_telemetry/rte_telemetry.c
+++ b/lib/librte_telemetry/rte_telemetry.c
@@ -1821,6 +1821,7 @@ int telemetry_log_level;
 
 static struct rte_option option = {
        .opt_str = "telemetry",
+       .usage = "Enable telemetry backend",
        .cb = &rte_telemetry_init,
        .enabled = 0
 };