lib/kvargs/rte_kvargs.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2013 Intel Corporation.
   3  * Copyright(c) 2014 6WIND S.A.
   4  */
   5
   6 #ifndef _RTE_KVARGS_H_
   7 #define _RTE_KVARGS_H_
   8
   9 /**
  10  * @file
  11  * RTE Argument parsing
  12  *
  13  * This module can be used to parse arguments whose format is
  14  * key1=value1,key2=value2,key3=value3,...
  15  *
  16  * The same key can appear several times with the same or a different
  17  * value. Indeed, the arguments are stored as a list of key/values
  18  * associations and not as a dictionary.
  19  *
  20  * This file provides some helpers that are especially used by virtual
  21  * ethernet devices at initialization for arguments parsing.
  22  */
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 #include <rte_compat.h>
  29
  30 /** Maximum number of key/value associations */
  31 #define RTE_KVARGS_MAX 32
  32
  33 /** separator character used between each pair */
  34 #define RTE_KVARGS_PAIRS_DELIM  ","
  35
  36 /** separator character used between key and value */
  37 #define RTE_KVARGS_KV_DELIM     "="
  38
  39 /** Type of callback function used by rte_kvargs_process() */
  40 typedef int (*arg_handler_t)(const char *key, const char *value, void *opaque);
  41
  42 /** A key/value association */
  43 struct rte_kvargs_pair {
  44         char *key;      /**< the name (key) of the association  */
  45         char *value;    /**< the value associated to that key */
  46 };
  47
  48 /** Store a list of key/value associations */
  49 struct rte_kvargs {
  50         char *str;      /**< copy of the argument string */
  51         unsigned count; /**< number of entries in the list */
  52         struct rte_kvargs_pair pairs[RTE_KVARGS_MAX]; /**< list of key/values */
  53 };
  54
  55 /**
  56  * Allocate a rte_kvargs and store key/value associations from a string
  57  *
  58  * The function allocates and fills a rte_kvargs structure from a given
  59  * string whose format is key1=value1,key2=value2,...
  60  *
  61  * The structure can be freed with rte_kvargs_free().
  62  *
  63  * @param args
  64  *   The input string containing the key/value associations
  65  * @param valid_keys
  66  *   A list of valid keys (table of const char *, the last must be NULL).
  67  *   This argument is ignored if NULL
  68  *
  69  * @return
  70  *   - A pointer to an allocated rte_kvargs structure on success
  71  *   - NULL on error
  72  */
  73 struct rte_kvargs *rte_kvargs_parse(const char *args,
  74                 const char *const valid_keys[]);
  75
  76 /**
  77  * Allocate a rte_kvargs and store key/value associations from a string.
  78  * This version will consider any byte from valid_ends as a possible
  79  * terminating character, and will not parse beyond any of their occurrence.
  80  *
  81  * The function allocates and fills an rte_kvargs structure from a given
  82  * string whose format is key1=value1,key2=value2,...
  83  *
  84  * The structure can be freed with rte_kvargs_free().
  85  *
  86  * @param args
  87  *   The input string containing the key/value associations
  88  *
  89  * @param valid_keys
  90  *   A list of valid keys (table of const char *, the last must be NULL).
  91  *   This argument is ignored if NULL
  92  *
  93  * @param valid_ends
  94  *   Acceptable terminating characters.
  95  *   If NULL, the behavior is the same as ``rte_kvargs_parse``.
  96  *
  97  * @return
  98  *   - A pointer to an allocated rte_kvargs structure on success
  99  *   - NULL on error
 100  */
 101 struct rte_kvargs *rte_kvargs_parse_delim(const char *args,
 102                 const char *const valid_keys[],
 103                 const char *valid_ends);
 104
 105 /**
 106  * Free a rte_kvargs structure
 107  *
 108  * Free a rte_kvargs structure previously allocated with
 109  * rte_kvargs_parse().
 110  *
 111  * @param kvlist
 112  *   The rte_kvargs structure. No error if NULL.
 113  */
 114 void rte_kvargs_free(struct rte_kvargs *kvlist);
 115
 116 /**
 117  * Get the value associated with a given key.
 118  *
 119  * If multiple key matches, the value of the first one is returned.
 120  *
 121  * The memory returned is allocated as part of the rte_kvargs structure,
 122  * it must never be modified.
 123  *
 124  * @param kvlist
 125  *   A list of rte_kvargs pair of 'key=value'.
 126  * @param key
 127  *   The matching key.
 128  *
 129  * @return
 130  *   NULL if no key matches the input,
 131  *   a value associated with a matching key otherwise.
 132  */
 133 const char *rte_kvargs_get(const struct rte_kvargs *kvlist, const char *key);
 134
 135 /**
 136  * Call a handler function for each key/value matching the key
 137  *
 138  * For each key/value association that matches the given key, calls the
 139  * handler function with the for a given arg_name passing the value on the
 140  * dictionary for that key and a given extra argument.
 141  *
 142  * @param kvlist
 143  *   The rte_kvargs structure. No error if NULL.
 144  * @param key_match
 145  *   The key on which the handler should be called, or NULL to process handler
 146  *   on all associations
 147  * @param handler
 148  *   The function to call for each matching key
 149  * @param opaque_arg
 150  *   A pointer passed unchanged to the handler
 151  *
 152  * @return
 153  *   - 0 on success
 154  *   - Negative on error
 155  */
 156 int rte_kvargs_process(const struct rte_kvargs *kvlist,
 157         const char *key_match, arg_handler_t handler, void *opaque_arg);
 158
 159 /**
 160  * Count the number of associations matching the given key
 161  *
 162  * @param kvlist
 163  *   The rte_kvargs structure
 164  * @param key_match
 165  *   The key that should match, or NULL to count all associations
 166  *
 167  * @return
 168  *   The number of entries
 169  */
 170 unsigned rte_kvargs_count(const struct rte_kvargs *kvlist,
 171         const char *key_match);
 172
 173 /**
 174  * Generic kvarg handler for string comparison.
 175  *
 176  * This function can be used for a generic string comparison processing
 177  * on a list of kvargs.
 178  *
 179  * @param key
 180  *   kvarg pair key.
 181  *
 182  * @param value
 183  *   kvarg pair value.
 184  *
 185  * @param opaque
 186  *   Opaque pointer to a string.
 187  *
 188  * @return
 189  *   0 if the strings match.
 190  *   !0 otherwise or on error.
 191  *
 192  *   Unlike strcmp, comparison ordering is not kept.
 193  *   In order for rte_kvargs_process to stop processing on match error,
 194  *   a negative value is returned even if strcmp had returned a positive one.
 195  */
 196 __rte_experimental
 197 int rte_kvargs_strcmp(const char *key, const char *value, void *opaque);
 198
 199 #ifdef __cplusplus
 200 }
 201 #endif
 202
 203 #endif