Provide a script for application developers to quickly generate the
boilerplate code necessary for using the cmdline library.
This initial version works only with commands using simple strings and
numbers, but this is sufficient for many use-cases. Future extensions
could, no doubt, expand support to expose more capabilities of the
library.
Example of use:
The script takes an input file with a list of commands the user wants in
the app, where the parameter variables are tagged with the type.
For example:
$ cat commands.list
list
add <UINT16>x <UINT16>y
echo <STRING>message
add socket <STRING>path
quit
When run through the script as "./dpdk-cmdline-gen.py commands.list",
the output will be the contents of a header file with all the
boilerplate necessary for a commandline instance with those commands.
If the flag --stubs is passed, an output header filename must also be
passed, in which case both a header file with the definitions and a C
file with function stubs in it is written to disk. The separation is so
that the header file can be rewritten at any future point to add more
commands, while the C file can be kept as-is and extended by the user
with any additional functions needed.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
buildtools/dpdk-cmdline-gen.py | 146 +++++++++++++++++++++++++++++++++
buildtools/meson.build | 7 ++
2 files changed, 153 insertions(+)
create mode 100755 buildtools/dpdk-cmdline-gen.py
new file mode 100755
@@ -0,0 +1,146 @@
+#!/usr/bin/env python3
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright(c) 2023 Intel Corporation
+#
+
+import sys
+import os
+import argparse
+
+PARSE_FN_PARAMS = "void *parsed_result, struct cmdline *cl, void *data"
+PARSE_FN_BODY = """
+ /* TODO: command action */
+ RTE_SET_USED(parsed_result);
+ RTE_SET_USED(cl);
+ RTE_SET_USED(data);
+"""
+
+def process_command(tokens, cfile):
+ name = []
+
+ if tokens[0].startswith('<'):
+ print("Error: each command must start with at least one literal string",
+ file=sys.stderr)
+ sys.exit(1)
+ for t in tokens:
+ if t.startswith('<'):
+ break;
+ name.append(t)
+ name = "_".join(name)
+
+ result_struct = []
+ initializers = []
+ token_list = []
+ for t in tokens:
+ if t.startswith('<'):
+ t_type, t_name = t[1:].split('>')
+ t_val = "NULL"
+ else:
+ t_type = "STRING"
+ t_name = t
+ t_val = f'"{t}"'
+
+ if t_type == "STRING":
+ result_struct.append(f"\tcmdline_fixed_string_t {t_name};")
+ initializers.append(f"static cmdline_parse_token_string_t cmd_{name}_{t_name}_tok =\n"
+ + f"\tTOKEN_STRING_INITIALIZER(struct cmd_{name}_result, {t_name}, {t_val});")
+ elif t_type in ['UINT8', 'UINT16', 'UINT32', 'UINT64',
+ 'INT8', 'INT16', 'INT32', 'INT64']:
+ result_struct.append(f"\t{t_type.lower()}_t {t_name};")
+ initializers.append(f"static cmdline_parse_token_num_t cmd_{name}_{t_name}_tok =\n"
+ + f"\tTOKEN_NUM_INITIALIZER(struct cmd_{name}_result, {t_name}, RTE_{t_type});")
+ else:
+ print(f"Error: unknown token-type {t}", file=sys.stderr)
+ sys.exit(1)
+ token_list.append(f"cmd_{name}_{t_name}_tok")
+
+ print(f"/* Auto-generated handling for command '{' '.join(tokens)}' */")
+ # output function prototype
+ func_sig = f"void\ncmd_{name}_parsed({PARSE_FN_PARAMS})"
+ print(f"extern {func_sig};\n")
+ # output function template if C file being written
+ if (cfile):
+ print(f"{func_sig}\n{{{PARSE_FN_BODY}}}\n", file=cfile)
+ # output result data structure
+ print(f"struct cmd_{name}_result {{\n"
+ + '\n'.join(result_struct)
+ + "\n};\n")
+ # output the initializer tokens
+ print("\n".join(initializers) + '\n')
+ # output the instance structure
+ print(f"static cmdline_parse_inst_t cmd_{name} = {{\n"
+ + f'\t.f = cmd_{name}_parsed,\n'
+ + f'\t.data = NULL,\n'
+ + f'\t.help_str = "",\n'
+ + f'\t.tokens = {{')
+ for t in token_list:
+ print(f"\t\t(void *)&{t},")
+ print("\t\tNULL\n"
+ + "\t}\n"
+ + "};\n")
+
+ # return the instance structure name
+ return f"cmd_{name}"
+
+def process_commands(infile, hfile, cfile, ctxname):
+ instances = []
+
+ # redirect stdout to output the header, to save passing file= each print
+ old_sys_stdout = sys.stdout
+ sys.stdout = hfile
+
+ print(f"/* File autogenerated by {sys.argv[0]} */")
+ print('#ifndef GENERATED_COMMANDS_H')
+ print('#define GENERATED_COMMANDS_H')
+ print("#include <rte_common.h>")
+ print("#include <cmdline.h>")
+ print("#include <cmdline_parse_string.h>")
+ print("#include <cmdline_parse_num.h>")
+ print("")
+
+ for line in infile.readlines():
+ if line.lstrip().startswith('#'):
+ continue
+ instances.append(process_command(line.strip().split(), cfile))
+
+ print(f'static __rte_used cmdline_parse_ctx_t {ctxname}[] = {{')
+ for inst in instances:
+ print(f'\t&{inst},')
+ print('\tNULL')
+ print('};\n')
+ print('#endif /* GENERATED_COMMANDS_H */')
+
+ sys.stdout = old_sys_stdout
+
+def main():
+ ap = argparse.ArgumentParser()
+ ap.add_argument("--stubs", action="store_true",
+ help="Produce C file with empty function stubs for each command")
+ ap.add_argument("--output-file", "-o", default="-",
+ help="Output header filename [default to stdout]")
+ ap.add_argument("--context-name", default="ctx",
+ help="Name given to the cmdline context variable in the output header [default=ctx]")
+ ap.add_argument("infile", type=argparse.FileType('r'),
+ help="File with list of commands")
+ args = ap.parse_args()
+
+ if not args.stubs:
+ if args.output_file == '-':
+ process_commands(args.infile, sys.stdout, None, args.context_name)
+ else:
+ with open(args.output_file, "w") as hfile:
+ process_commands(args.infile, hfile, None, args.context_name)
+ else:
+ if not args.output_file.endswith('.h'):
+ print("Error: output filename must end with '.h' extension when creating stubs",
+ file=sys.stderr)
+ sys.exit(1)
+
+ cfilename = args.output_file[:-2] + '.c'
+ with open(args.output_file, "w") as hfile:
+ with open(cfilename, "w") as cfile:
+ print(f"#include \"{args.output_file}\"\n", file=cfile)
+ process_commands(args.infile, hfile, cfile, args.context_name)
+
+if __name__ == "__main__":
+ main()
@@ -19,6 +19,13 @@ get_cpu_count_cmd = py3 + files('get-cpu-count.py')
get_numa_count_cmd = py3 + files('get-numa-count.py')
get_test_suites_cmd = py3 + files('get-test-suites.py')
has_hugepages_cmd = py3 + files('has-hugepages.py')
+cmdline_gen_cmd = py3 + files('dpdk-cmdline-gen.py')
+
+# install any build tools that end-users might want also
+install_data([
+ 'dpdk-cmdline-gen.py',
+ ],
+ install_dir: 'bin')
# select library and object file format
pmdinfo = py3 + files('gen-pmdinfo-cfile.py') + [meson.current_build_dir()]