NVIDIA DOCA SDK Data Center on a Chip Framework Documentation
doca_argp.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2021-2024 NVIDIA CORPORATION & AFFILIATES, ALL RIGHTS RESERVED.
3  *
4  * This software product is a proprietary product of NVIDIA CORPORATION &
5  * AFFILIATES (the "Company") and all right, title, and interest in and to the
6  * software product, including all associated intellectual property rights, are
7  * and shall remain exclusively with the Company.
8  *
9  * This software product is governed by the End User License Agreement
10  * provided with the software product.
11  *
12  */
13 
23 #ifndef DOCA_ARGP_H_
24 #define DOCA_ARGP_H_
25 
26 #include <stdarg.h>
27 
28 #include <doca_compat.h>
29 #include <doca_error.h>
30 #include <doca_log.h>
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
37 typedef doca_error_t (*doca_argp_param_cb_t)(void *, void *);
38 
40 typedef doca_error_t (*doca_argp_cmd_cb_t)(void *);
41 
43 typedef doca_error_t (*doca_argp_dpdk_cb_t)(int argc, char **argv);
44 
46 typedef doca_error_t (*doca_argp_validation_cb_t)(void *);
47 
49 typedef doca_error_t (*doca_argp_logger_cb_t)(enum doca_log_level level, const char *format, va_list args);
50 
54 enum doca_argp_type {
55  DOCA_ARGP_TYPE_UNKNOWN = 0,
56  DOCA_ARGP_TYPE_STRING,
57  DOCA_ARGP_TYPE_INT,
58  DOCA_ARGP_TYPE_BOOLEAN,
59  DOCA_ARGP_TYPE_JSON_OBJ,
61 };
62 
69 struct doca_argp_param;
70 
74 struct doca_argp_cmd;
75 
79 DOCA_EXPERIMENTAL
80 void doca_argp_usage(void);
81 
99 DOCA_EXPERIMENTAL
100 doca_error_t doca_argp_init(const char *program_name, void *program_config);
101 
117 DOCA_EXPERIMENTAL
118 doca_error_t doca_argp_register_param(struct doca_argp_param *input_param);
119 
134 DOCA_EXPERIMENTAL
135 doca_error_t doca_argp_register_cmd(struct doca_argp_cmd *input_cmd);
136 
151 DOCA_EXPERIMENTAL
152 doca_error_t doca_argp_register_version_callback(doca_argp_param_cb_t callback);
153 
167 DOCA_EXPERIMENTAL
168 doca_error_t doca_argp_register_validation_callback(doca_argp_validation_cb_t callback);
169 
181 DOCA_EXPERIMENTAL
182 doca_error_t doca_argp_register_logger_callback(doca_argp_logger_cb_t callback);
183 
192 DOCA_EXPERIMENTAL
193 doca_error_t doca_argp_disable_logger_callback(void);
194 
214 DOCA_EXPERIMENTAL
215 doca_error_t doca_argp_start(int argc, char **argv);
216 
228 DOCA_EXPERIMENTAL
229 doca_error_t doca_argp_destroy(void);
230 
241 DOCA_EXPERIMENTAL
242 void doca_argp_set_dpdk_program(doca_argp_dpdk_cb_t callback);
243 
259 DOCA_EXPERIMENTAL
260 doca_error_t doca_argp_param_create(struct doca_argp_param **param);
261 
273 DOCA_EXPERIMENTAL
274 void doca_argp_param_set_short_name(struct doca_argp_param *param, const char *name);
275 
287 DOCA_EXPERIMENTAL
288 void doca_argp_param_set_long_name(struct doca_argp_param *param, const char *name);
289 
299 DOCA_EXPERIMENTAL
300 void doca_argp_param_set_arguments(struct doca_argp_param *param, const char *arguments);
301 
313 DOCA_EXPERIMENTAL
314 void doca_argp_param_set_description(struct doca_argp_param *param, const char *description);
315 
330 DOCA_EXPERIMENTAL
331 void doca_argp_param_set_callback(struct doca_argp_param *param, doca_argp_param_cb_t callback);
332 
344 DOCA_EXPERIMENTAL
345 void doca_argp_param_set_type(struct doca_argp_param *param, enum doca_argp_type type);
346 
356 DOCA_EXPERIMENTAL
357 void doca_argp_param_set_mandatory(struct doca_argp_param *param);
358 
368 DOCA_EXPERIMENTAL
369 void doca_argp_param_set_cli_only(struct doca_argp_param *param);
370 
382 DOCA_EXPERIMENTAL
383 void doca_argp_param_set_multiplicity(struct doca_argp_param *param);
384 
395 DOCA_EXPERIMENTAL
396 void doca_argp_param_set_singular(struct doca_argp_param *param);
397 
407 DOCA_EXPERIMENTAL
408 void doca_argp_param_set_inherited(struct doca_argp_param *param);
409 
419 DOCA_EXPERIMENTAL
420 void doca_argp_param_set_hidden(struct doca_argp_param *param);
421 
434 DOCA_EXPERIMENTAL
435 doca_error_t doca_argp_param_destroy(struct doca_argp_param *param);
436 
452 DOCA_EXPERIMENTAL
453 doca_error_t doca_argp_cmd_create(struct doca_argp_cmd **cmd);
454 
466 DOCA_EXPERIMENTAL
467 void doca_argp_cmd_set_name(struct doca_argp_cmd *cmd, const char *name);
468 
480 DOCA_EXPERIMENTAL
481 void doca_argp_cmd_set_description(struct doca_argp_cmd *cmd, const char *description);
482 
496 DOCA_EXPERIMENTAL
497 void doca_argp_cmd_set_callback(struct doca_argp_cmd *cmd, doca_argp_cmd_cb_t callback);
498 
507 DOCA_EXPERIMENTAL
508 void doca_argp_cmd_set_hidden(struct doca_argp_cmd *cmd);
509 
527 DOCA_EXPERIMENTAL
528 doca_error_t doca_argp_cmd_register_param(struct doca_argp_cmd *cmd, struct doca_argp_param *input_param);
529 
546 DOCA_EXPERIMENTAL
547 doca_error_t doca_argp_cmd_register_cmd(struct doca_argp_cmd *cmd, struct doca_argp_cmd *input_cmd);
548 
561 DOCA_EXPERIMENTAL
562 doca_error_t doca_argp_cmd_destroy(struct doca_argp_cmd *cmd);
563 
575 DOCA_EXPERIMENTAL
576 doca_error_t doca_argp_get_log_level(int *log_level);
577 
588 DOCA_EXPERIMENTAL
589 doca_error_t doca_argp_get_sdk_log_level(int *log_level);
590 
591 #ifdef __cplusplus
592 } /* extern "C" */
593 #endif
594 
597 #endif /* DOCA_ARGP_H_ */
va_list
__builtin_va_list va_list
Definition: __stdarg_va_list.h:12
doca_compat.h
doca_error.h
doca_log.h
doca_argp_cmd_set_callback
DOCA_EXPERIMENTAL void doca_argp_cmd_set_callback(struct doca_argp_cmd *cmd, doca_argp_cmd_cb_t callback)
Set the callback function of the program command.
doca_argp_param_destroy
DOCA_EXPERIMENTAL doca_error_t doca_argp_param_destroy(struct doca_argp_param *param)
Destroy a program param.
doca_argp_param_set_singular
DOCA_EXPERIMENTAL void doca_argp_param_set_singular(struct doca_argp_param *param)
Mark the program param as singular.
doca_argp_register_validation_callback
DOCA_EXPERIMENTAL doca_error_t doca_argp_register_validation_callback(doca_argp_validation_cb_t callback)
Register program validation callback function.
doca_argp_register_cmd
DOCA_EXPERIMENTAL doca_error_t doca_argp_register_cmd(struct doca_argp_cmd *input_cmd)
Register a program command.
doca_argp_get_sdk_log_level
DOCA_EXPERIMENTAL doca_error_t doca_argp_get_sdk_log_level(int *log_level)
Get the SDK log level as passed by the user.
doca_argp_param_set_description
DOCA_EXPERIMENTAL void doca_argp_param_set_description(struct doca_argp_param *param, const char *description)
Set the description of the program param, used during program usage.
doca_argp_cmd_set_description
DOCA_EXPERIMENTAL void doca_argp_cmd_set_description(struct doca_argp_cmd *cmd, const char *description)
Set the description of the program command, used during the program usage.
doca_argp_register_logger_callback
DOCA_EXPERIMENTAL doca_error_t doca_argp_register_logger_callback(doca_argp_logger_cb_t callback)
Register a logger callback to be used for user-facing events.
doca_argp_logger_cb_t
doca_error_t(* doca_argp_logger_cb_t)(enum doca_log_level level, const char *format, va_list args)
(Operational) Logger callback function type
Definition: doca_argp.h:49
doca_argp_cmd_destroy
DOCA_EXPERIMENTAL doca_error_t doca_argp_cmd_destroy(struct doca_argp_cmd *cmd)
Destroy a program command.
doca_argp_param_set_long_name
DOCA_EXPERIMENTAL void doca_argp_param_set_long_name(struct doca_argp_param *param, const char *name)
Set the long name of the program param.
doca_argp_type
doca_argp_type
Flag input type.
Definition: doca_argp.h:54
doca_argp_cmd_register_param
DOCA_EXPERIMENTAL doca_error_t doca_argp_cmd_register_param(struct doca_argp_cmd *cmd, struct doca_argp_param *input_param)
Register a program flag for the given program command.
doca_argp_validation_cb_t
doca_error_t(* doca_argp_validation_cb_t)(void *)
Program validation callback function type.
Definition: doca_argp.h:46
doca_argp_dpdk_cb_t
doca_error_t(* doca_argp_dpdk_cb_t)(int argc, char **argv)
DPDK flags callback function type.
Definition: doca_argp.h:43
doca_argp_start
DOCA_EXPERIMENTAL doca_error_t doca_argp_start(int argc, char **argv)
Parse incoming arguments (cmd line/json).
doca_argp_param_set_arguments
DOCA_EXPERIMENTAL void doca_argp_param_set_arguments(struct doca_argp_param *param, const char *arguments)
Set the description of the expected arguments of the program param, used during program usage.
doca_argp_param_set_cli_only
DOCA_EXPERIMENTAL void doca_argp_param_set_cli_only(struct doca_argp_param *param)
Mark the program param as supported only in CLI mode and unavailable through a JSON file.
doca_argp_init
DOCA_EXPERIMENTAL doca_error_t doca_argp_init(const char *program_name, void *program_config)
Initialize the parser interface.
doca_argp_set_dpdk_program
DOCA_EXPERIMENTAL void doca_argp_set_dpdk_program(doca_argp_dpdk_cb_t callback)
Mark the program as based on DPDK API.
doca_argp_get_log_level
DOCA_EXPERIMENTAL doca_error_t doca_argp_get_log_level(int *log_level)
Get the log level the user inserted it.
doca_argp_usage
DOCA_EXPERIMENTAL void doca_argp_usage(void)
Print usage instructions.
doca_argp_cmd_set_hidden
DOCA_EXPERIMENTAL void doca_argp_cmd_set_hidden(struct doca_argp_cmd *cmd)
Mark the program command as hidden.
doca_argp_param_set_hidden
DOCA_EXPERIMENTAL void doca_argp_param_set_hidden(struct doca_argp_param *param)
Mark the program param as hidden.
doca_argp_param_set_inherited
DOCA_EXPERIMENTAL void doca_argp_param_set_inherited(struct doca_argp_param *param)
Mark the program param as inherited through the command chain.
doca_argp_param_cb_t
doca_error_t(* doca_argp_param_cb_t)(void *, void *)
Flag callback function type.
Definition: doca_argp.h:37
doca_argp_param_set_callback
DOCA_EXPERIMENTAL void doca_argp_param_set_callback(struct doca_argp_param *param, doca_argp_param_cb_t callback)
Set the callback function of the program param.
doca_argp_param_set_mandatory
DOCA_EXPERIMENTAL void doca_argp_param_set_mandatory(struct doca_argp_param *param)
Mark the program param as mandatory.
doca_argp_param_create
DOCA_EXPERIMENTAL doca_error_t doca_argp_param_create(struct doca_argp_param **param)
Create new program param.
doca_argp_param_set_type
DOCA_EXPERIMENTAL void doca_argp_param_set_type(struct doca_argp_param *param, enum doca_argp_type type)
Set the type of the param arguments.
doca_argp_register_version_callback
DOCA_EXPERIMENTAL doca_error_t doca_argp_register_version_callback(doca_argp_param_cb_t callback)
Register an alternative version callback.
doca_argp_param_set_short_name
DOCA_EXPERIMENTAL void doca_argp_param_set_short_name(struct doca_argp_param *param, const char *name)
Set the short name of the program param.
doca_argp_cmd_register_cmd
DOCA_EXPERIMENTAL doca_error_t doca_argp_cmd_register_cmd(struct doca_argp_cmd *cmd, struct doca_argp_cmd *input_cmd)
Register an inner program command for the given program command.
doca_argp_cmd_cb_t
doca_error_t(* doca_argp_cmd_cb_t)(void *)
Cmd callback function type.
Definition: doca_argp.h:40
doca_argp_destroy
DOCA_EXPERIMENTAL doca_error_t doca_argp_destroy(void)
ARG Parser destroy.
doca_argp_register_param
DOCA_EXPERIMENTAL doca_error_t doca_argp_register_param(struct doca_argp_param *input_param)
Register a program flag.
doca_argp_cmd_create
DOCA_EXPERIMENTAL doca_error_t doca_argp_cmd_create(struct doca_argp_cmd **cmd)
Create new program command.
doca_argp_param_set_multiplicity
DOCA_EXPERIMENTAL void doca_argp_param_set_multiplicity(struct doca_argp_param *param)
Mark the program param as supporting multiple appearances.
doca_argp_cmd_set_name
DOCA_EXPERIMENTAL void doca_argp_cmd_set_name(struct doca_argp_cmd *cmd, const char *name)
Set the name of the program command.
doca_argp_disable_logger_callback
DOCA_EXPERIMENTAL doca_error_t doca_argp_disable_logger_callback(void)
Disable a previously registered logger callback, reverting back to default stderr backend.
DOCA_ARGP_TYPE_STRING
@ DOCA_ARGP_TYPE_STRING
Definition: doca_argp.h:56
DOCA_ARGP_TYPE_BOOLEAN
@ DOCA_ARGP_TYPE_BOOLEAN
Definition: doca_argp.h:58
DOCA_ARGP_TYPE_INT
@ DOCA_ARGP_TYPE_INT
Definition: doca_argp.h:57
DOCA_ARGP_TYPE_JSON_OBJ
@ DOCA_ARGP_TYPE_JSON_OBJ
Definition: doca_argp.h:59
DOCA_ARGP_TYPE_UNKNOWN
@ DOCA_ARGP_TYPE_UNKNOWN
Definition: doca_argp.h:55
DOCA_EXPERIMENTAL
#define DOCA_EXPERIMENTAL
To set a Symbol (or specifically a function) as experimental.
Definition: doca_compat.h:103
doca_error_t
enum doca_error doca_error_t
DOCA API return codes.
doca_log_level
doca_log_level
log levels, sorted by verbosity level from high to low
Definition: doca_log.h:43
description
type description
Definition: meson_options.txt:31
type
uint8_t type
Definition: packets.h:0
log_level
int log_level
Definition: pcc.c:40