rte_argparse.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2024 HiSilicon Limited
 */

#ifndef RTE_ARGPARSE_H
#define RTE_ARGPARSE_H

#include <stdbool.h>
#include <stdint.h>

#include <rte_bitops.h>
#include <rte_compat.h>

#ifdef __cplusplus
extern "C" {
#endif

enum rte_argparse_flag {
    /*
     * Bits 0-1: represent the argument whether has value.
     */

    RTE_ARGPARSE_ARG_NO_VALUE = RTE_SHIFT_VAL64(1, 0),
    RTE_ARGPARSE_ARG_REQUIRED_VALUE = RTE_SHIFT_VAL64(2, 0),
    RTE_ARGPARSE_ARG_OPTIONAL_VALUE = RTE_SHIFT_VAL64(3, 0),


    /*
     * Bits 2-9: represent the value type which used when autosave
     */

    RTE_ARGPARSE_ARG_VALUE_INT = RTE_SHIFT_VAL64(1, 2),
    RTE_ARGPARSE_ARG_VALUE_U8 = RTE_SHIFT_VAL64(2, 2),
    RTE_ARGPARSE_ARG_VALUE_U16 = RTE_SHIFT_VAL64(3, 2),
    RTE_ARGPARSE_ARG_VALUE_U32 = RTE_SHIFT_VAL64(4, 2),
    RTE_ARGPARSE_ARG_VALUE_U64 = RTE_SHIFT_VAL64(5, 2),
    RTE_ARGPARSE_ARG_VALUE_MAX = RTE_SHIFT_VAL64(6, 2),


    RTE_ARGPARSE_ARG_SUPPORT_MULTI = RTE_BIT64(10),

    RTE_ARGPARSE_ARG_RESERVED_FIELD = RTE_GENMASK64(63, 48),
};

struct rte_argparse_arg {
    const char *name_long;
    const char *name_short;

    const char *help;

    void *val_saver;
    void *val_set;

    uint64_t flags;
};

typedef int (*rte_arg_parser_t)(uint32_t index, const char *value, void *opaque);

struct rte_argparse {
    const char *prog_name;
    const char *usage;
    const char *descriptor;
    const char *epilog;
    bool exit_on_error;
    rte_arg_parser_t callback;
    void *opaque;
    void *reserved[16];
    struct rte_argparse_arg args[];
};

#define ARGPARSE_ARG_END() { NULL }

__rte_experimental
int rte_argparse_parse(struct rte_argparse *obj, int argc, char **argv);

__rte_experimental
int rte_argparse_parse_type(const char *str, uint64_t val_type, void *val);

#ifdef __cplusplus
}
#endif

#endif /* RTE_ARGPARSE_H */