From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 0541F46BCF; Mon, 21 Jul 2025 17:09:36 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 3805C40661; Mon, 21 Jul 2025 17:09:21 +0200 (CEST) Received: from mgamail.intel.com (mgamail.intel.com [198.175.65.19]) by mails.dpdk.org (Postfix) with ESMTP id 4CD2440696 for ; Mon, 21 Jul 2025 17:09:18 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1753110559; x=1784646559; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=qPXB61FOSd/j4VuAbAhcfbfCOmpN0MRF1eKA6+l0txg=; b=eUnCJqwvef/zdkdYQFCDiDPIre63HG2STbcxdI3FrK30ZN78NYoJku37 V1FqgpO0wbjXAoY9TtdTxfDEwDcq26c2j0se2wA3UzTW/D2Ziqi+VPsAU de3lM328lMKY55bi40b7sknBAjMq3EuOvXtcgA8YUxGNGuOe6cxjuaf5y b0xCRu9UimOOrswmCNOQd+L7S62CLBltUScm19GRBii9TbRshoyFPXK6h txdmDUXhE9ZGh/bk0PJIU5mIScAq+lbYMZDXsIsm4/VVuoF4Gwce0U3+P d5cEy49iYEh0K4GehsjXUl3oYxhahbVNwQAF0SShAVZp2W4Knz5n63AJf g==; X-CSE-ConnectionGUID: TYUnaGmvS3+vWjidGUjfmA== X-CSE-MsgGUID: jmkhD+KeQW6jvkYdt/fEPA== X-IronPort-AV: E=McAfee;i="6800,10657,11499"; a="55179792" X-IronPort-AV: E=Sophos;i="6.16,329,1744095600"; d="scan'208";a="55179792" Received: from orviesa008.jf.intel.com ([10.64.159.148]) by orvoesa111.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Jul 2025 08:09:18 -0700 X-CSE-ConnectionGUID: 1/0tuWzQS6Gx/g6F6Nhr0g== X-CSE-MsgGUID: axgVHIsVS9abj2mwnvHQBg== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.16,329,1744095600"; d="scan'208";a="159291193" Received: from silpixa00401385.ir.intel.com ([10.237.214.33]) by orviesa008.jf.intel.com with ESMTP; 21 Jul 2025 08:09:17 -0700 From: Bruce Richardson To: dev@dpdk.org Cc: david.marchand@redhat.com, Bruce Richardson , Tyler Retzlaff Subject: [PATCH v4 5/9] eal: define the EAL parameters in argparse format Date: Mon, 21 Jul 2025 16:08:38 +0100 Message-ID: <20250721150843.2737763-7-bruce.richardson@intel.com> X-Mailer: git-send-email 2.48.1 In-Reply-To: <20250520164025.2055721-1-bruce.richardson@intel.com> References: <20250520164025.2055721-1-bruce.richardson@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Create eal_option_list.h, containing all the possible EAL parameters, and basic info about them, such as type, whether they take a parameter or not. Each entry is defined using a macro, which will be then interpreted when the file is included. First time this header in included in the eal_common_options.c file, the macros are defined in such a way as to define field elements for an "eal_init_args" structure, where each value is either a string type, if it takes a parameter, or boolean type if it doesn't. For those elements that take multiple values, i.e. are passed multiple times, we put them in a TAILQ. The second time of inclusion, the macros are defined so as to define the arguments in an rte_argparse structure for EAL. For the basic string and boolean types, we just store the values in the appropriate field in the previous defined "eal_init_args" structure. For the list elements, we use the argparse callback to process those elements, adding them to the TAILQ as they are encountered. Signed-off-by: Bruce Richardson --- lib/eal/common/eal_common_options.c | 135 +++++++++++++++++++++++++++- lib/eal/common/eal_option_list.h | 90 +++++++++++++++++++ lib/eal/meson.build | 2 +- lib/meson.build | 1 + 4 files changed, 224 insertions(+), 4 deletions(-) create mode 100644 lib/eal/common/eal_option_list.h diff --git a/lib/eal/common/eal_common_options.c b/lib/eal/common/eal_common_options.c index cafae9d9d7..197aa33590 100644 --- a/lib/eal/common/eal_common_options.c +++ b/lib/eal/common/eal_common_options.c @@ -28,11 +28,13 @@ #include #include #include +#include #ifndef RTE_EXEC_ENV_WINDOWS #include #endif #include +#include #include #include "eal_internal_cfg.h" #include "eal_options.h" @@ -47,6 +49,136 @@ #define LCORE_OPT_LST 1 #define LCORE_OPT_MSK 2 +/* Allow the application to print its usage message too if set */ +static rte_usage_hook_t rte_application_usage_hook; + +struct arg_list_elem { + TAILQ_ENTRY(arg_list_elem) next; + char *arg; +}; +TAILQ_HEAD(arg_list, arg_list_elem); + +struct eal_init_args { + /* define a struct member for each EAL option, member name is the same as option name. + * Parameters that take an argument e.g. -l, are char *, + * parameters that take no options e.g. --no-huge, are bool. + * parameters that can be given multiple times e.g. -a, are arg_lists, + * parameters that are optional e.g. --huge-unlink, + * are char * but are set to (void *)1 if the parameter is not given. + * for aliases, i.e. options under different names, no field needs to be output + */ +#define LIST_ARG(long, short, help_str, fieldname) struct arg_list fieldname; +#define STR_ARG(long, short, help_str, fieldname) char *fieldname; +#define OPT_STR_ARG(long, short, help_str, fieldname) char *fieldname; +#define BOOL_ARG(long, short, help_str, fieldname) bool fieldname; +#define STR_ALIAS(long, short, help_str, fieldname) + +#define INCLUDE_ALL_ARG 1 /* for struct definition, include even unsupported values */ +#include "eal_option_list.h" +#undef INCLUDE_ALL_ARG +}; +struct eal_init_args args; + +/* an rte_argparse callback to append the argument to an arg_list + * in args. The index is the offset into the struct of the list. + */ +static int +arg_list_callback(uint32_t index, const char *arg, void *init_args) +{ + struct arg_list *list = RTE_PTR_ADD(init_args, index); + struct arg_list_elem *elem; + + elem = malloc(sizeof(*elem)); + if (elem == NULL) + return -1; + + elem->arg = strdup(arg); + if (elem->arg == NULL) { + free(elem); + return -1; + } + + TAILQ_INSERT_TAIL(list, elem, next); + return 0; +} + +static void +eal_usage(const struct rte_argparse *obj) +{ + rte_argparse_print_help(stdout, obj); + if (rte_application_usage_hook != NULL) + rte_application_usage_hook(obj->prog_name); +} + +/* undef the *_ARG macros before redefining to generate the argparse arg list */ +#undef LIST_ARG +#undef STR_ARG +#undef OPT_STR_ARG +#undef BOOL_ARG +#undef STR_ALIAS + +/* For arguments which have an arg_list type, they use callback (no val_saver), + * require a value, and have the SUPPORT_MULTI flag. + */ +#define LIST_ARG(long, short, help_str, fieldname) { \ + .name_long = long, \ + .name_short = short, \ + .help = help_str, \ + .val_set = (void *)offsetof(struct eal_init_args, fieldname), \ + .value_required = RTE_ARGPARSE_VALUE_REQUIRED, \ + .flags = RTE_ARGPARSE_FLAG_SUPPORT_MULTI, \ +}, +/* For arguments which have a string type, they use val_saver (no callback), + * and normally REQUIRED_VALUE. + */ +#define STR_ARG(long, short, help_str, fieldname) { \ + .name_long = long, \ + .name_short = short, \ + .help = help_str, \ + .val_saver = &args.fieldname, \ + .value_required = RTE_ARGPARSE_VALUE_REQUIRED, \ + .value_type = RTE_ARGPARSE_VALUE_TYPE_STR, \ +}, +/* For flags which have optional arguments, they use both val_saver and val_set, + * but still have a string type. + */ +#define OPT_STR_ARG(long, short, help_str, fieldname) { \ + .name_long = long, \ + .name_short = short, \ + .help = help_str, \ + .val_saver = &args.fieldname, \ + .val_set = (void *)1, \ + .value_required = RTE_ARGPARSE_VALUE_OPTIONAL, \ + .value_type = RTE_ARGPARSE_VALUE_TYPE_STR, \ +}, +/* For boolean arguments, they use val_saver and val_set, with NO_VALUE flag. + */ +#define BOOL_ARG(long, short, help_str, fieldname) { \ + .name_long = long, \ + .name_short = short, \ + .help = help_str, \ + .val_saver = &args.fieldname, \ + .val_set = (void *)1, \ + .value_required = RTE_ARGPARSE_VALUE_NONE, \ + .value_type = RTE_ARGPARSE_VALUE_TYPE_BOOL, \ +}, +#define STR_ALIAS STR_ARG + +struct rte_argparse eal_argparse = { + .prog_name = "", + .usage = " -- ", + .epilog = "For more information on EAL options, see the DPDK documentation at: \n" + "\thttps://doc.dpdk.org/guides/" RTE_EXEC_ENV_NAME "_gsg/", + .exit_on_error = true, + .callback = arg_list_callback, + .print_help = eal_usage, + .opaque = &args, + .args = { + #include "eal_option_list.h" + ARGPARSE_ARG_END(), + } +}; + const char eal_short_options[] = "a:" /* allow */ @@ -165,9 +297,6 @@ static int main_lcore_parsed; static int mem_parsed; static int core_parsed; -/* Allow the application to print its usage message too if set */ -static rte_usage_hook_t rte_application_usage_hook; - /* Returns rte_usage_hook_t */ rte_usage_hook_t eal_get_application_usage_hook(void) diff --git a/lib/eal/common/eal_option_list.h b/lib/eal/common/eal_option_list.h new file mode 100644 index 0000000000..dd148b7fed --- /dev/null +++ b/lib/eal/common/eal_option_list.h @@ -0,0 +1,90 @@ +/* SPDX-License-Identifier: BSD-3-Clause + * Copyright(c) 2025 Intel Corporation. + */ + +/** This file contains a list of EAL commandline arguments. + * + * It's designed to be included multiple times in the codebase to + * generate both argument structure and the argument definitions + * for argparse. + */ + +/* check that all ARG macros are defined */ + #ifndef LIST_ARG +#error "LIST_ARG macro must be defined before including " __FILE__ +#endif +#ifndef STR_ARG +#error "STR_ARG macro must be defined before including " __FILE__ +#endif +#ifndef OPT_STR_ARG +#error "OPT_STR_ARG macro must be defined before including " __FILE__ +#endif +#ifndef BOOL_ARG +#error "BOOL_ARG macro must be defined before including " __FILE__ +#endif +#ifndef STR_ALIAS +#error "STR_ALIAS macro must be defined before including " __FILE__ +#endif + + +/* + * list of EAL arguments as struct rte_argparse_arg. + * Format of each entry: long name, short name, help string, struct member name. + */ +/* (Alphabetical) List of common options first */ +LIST_ARG("--allow", "-a", "Add device to allow-list, causing DPDK to only use specified devices", allow) +STR_ARG("--base-virtaddr", NULL, "Base virtual address to reserve memory", base_virtaddr) +LIST_ARG("--block", "-b", "Add device to block-list, preventing DPDK from using the device", block) +STR_ARG("--coremask", "-c", "Hexadecimal bitmask of cores to use", coremask) +LIST_ARG("--driver-path", "-d", "Path to external driver shared object, or directory of drivers", driver_path) +STR_ARG("--force-max-simd-bitwidth", NULL, "Set max SIMD bitwidth to use in vector code paths", force_max_simd_bitwidth) +OPT_STR_ARG("--huge-unlink", NULL, "Unlink hugetlbfs files on exit (existing|always|never)", huge_unlink) +BOOL_ARG("--in-memory", NULL, "DPDK should not create shared mmap files in filesystem (disables secondary process support)", in_memory) +STR_ARG("--iova-mode", NULL, "IOVA mapping mode, physical (pa)/virtual (va)", iova_mode) +STR_ARG("--lcores", "-l", "List of CPU cores to use", lcores) +BOOL_ARG("--legacy-mem", NULL, "Enable legacy memory behavior", legacy_mem) +OPT_STR_ARG("--log-color", NULL, "Enable/disable color in log output", log_color) +STR_ARG("--log-level", NULL, "Log level for loggers; use log-level=help for list of log types and levels", log_level) +OPT_STR_ARG("--log-timestamp", NULL, "Enable/disable timestamp in log output", log_timestamp) +STR_ARG("--main-lcore", NULL, "Select which core to use for the main thread", main_lcore) +STR_ARG("--mbuf-pool-ops-name", NULL, "User defined mbuf default pool ops name", mbuf_pool_ops_name) +STR_ARG("--memory-channels", "-n", "Number of memory channels per socket", memory_channels) +STR_ARG("--memory-ranks", "-r", "Force number of memory ranks (don't detect)", memory_ranks) +STR_ARG("--memory-size", "-m", "Total size of memory to allocate initially", memory_size) +BOOL_ARG("--no-hpet", NULL, "Disable HPET timer", no_hpet) +BOOL_ARG("--no-huge", NULL, "Disable hugetlbfs support", no_huge) +BOOL_ARG("--no-pci", NULL, "Disable all PCI devices", no_pci) +BOOL_ARG("--no-shconf", NULL, "Disable shared config file generation", no_shconf) +BOOL_ARG("--no-telemetry", NULL, "Disable telemetry", no_telemetry) +STR_ARG("--proc-type", NULL, "Type of process (primary|secondary|auto)", proc_type) +STR_ARG("--service-corelist", "-S", "List of cores to use for service threads", service_corelist) +STR_ARG("--service-coremask", "-s", "Hexadecimal bitmask of cores to use for service threads", service_coremask) +BOOL_ARG("--single-file-segments", NULL, "Store all pages within single files (per-page-size, per-node)", single_file_segments) +BOOL_ARG("--telemetry", NULL, "Enable telemetry", telemetry) +LIST_ARG("--vdev", NULL, "Add a virtual device to the system; format=[,key=val,...]", vdev) +BOOL_ARG("--vmware-tsc-map", NULL, "Use VMware TSC mapping instead of native RDTSC", vmware_tsc_map) +BOOL_ARG("--version", "-v", "Show version", version) + +#if defined(INCLUDE_ALL_ARG) || !defined(RTE_EXEC_ENV_WINDOWS) +/* Linux and FreeBSD options*/ +OPT_STR_ARG("--syslog", NULL, "Log to syslog (and optionally set facility)", syslog) +STR_ARG("--trace", NULL, "Enable trace based on regular expression trace name", trace) +STR_ARG("--trace-bufsz", NULL, "Trace buffer size", trace_bufsz) +STR_ARG("--trace-dir", NULL, "Trace directory", trace_dir) +STR_ARG("--trace-mode", NULL, "Trace mode", trace_mode) +#endif + +#if defined(INCLUDE_ALL_ARG) || defined(RTE_EXEC_ENV_LINUX) +/* Linux-only options */ +BOOL_ARG("--create-uio-dev", NULL, "Create /dev/uioX devices", create_uio_dev) +STR_ARG("--file-prefix", NULL, "Base filename of hugetlbfs files", file_prefix) +STR_ARG("--huge-dir", NULL, "Directory for hugepage files", huge_dir) +OPT_STR_ARG("--huge-worker-stack", NULL, "Allocate worker thread stacks from hugepage memory, with optional size (kB)", huge_worker_stack) +BOOL_ARG("--match-allocations", NULL, "Free hugepages exactly as allocated", match_allocations) +STR_ARG("--numa-mem", NULL, "Memory to allocate on NUMA nodes (comma separated values)", numa_mem) +STR_ARG("--numa-limit", NULL, "Limit memory allocation on NUMA nodes (comma separated values)", numa_limit) +STR_ALIAS("--socket-mem", NULL, "Alias for --numa-mem", numa_mem) +STR_ALIAS("--socket-limit", NULL, "Alias for --numa-limit", numa_limit) +STR_ARG("--vfio-intr", NULL, "VFIO interrupt mode (legacy|msi|msix)", vfio_intr) +STR_ARG("--vfio-vf-token", NULL, "VF token (UUID) shared between SR-IOV PF and VFs", vfio_vf_token) +#endif diff --git a/lib/eal/meson.build b/lib/eal/meson.build index e1d6c4cf17..f9fcee24ee 100644 --- a/lib/eal/meson.build +++ b/lib/eal/meson.build @@ -14,7 +14,7 @@ subdir(exec_env) subdir(arch_subdir) -deps += ['log', 'kvargs'] +deps += ['argparse', 'kvargs'] if not is_windows deps += ['telemetry'] endif diff --git a/lib/meson.build b/lib/meson.build index 0d56b2083b..dec90059e1 100644 --- a/lib/meson.build +++ b/lib/meson.build @@ -71,6 +71,7 @@ libraries = [ ] always_enable = [ + 'argparse', 'cmdline', 'eal', 'ethdev', -- 2.48.1