1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2018, Olivier MATZ <zer0@droids-corp.org>
13 #ifndef EC_COUNT_OF //XXX
14 #define EC_COUNT_OF(x) ((sizeof(x)/sizeof(0[x])) / \
15 ((size_t)(!(sizeof(x) % sizeof(0[x])))))
22 * The type identifier for a config value.
25 EC_CONFIG_TYPE_NONE = 0,
28 EC_CONFIG_TYPE_UINT64,
29 EC_CONFIG_TYPE_STRING,
36 * Structure describing the format of a configuration value.
38 * This structure is used in a const array which is referenced by a
39 * struct ec_config. Each entry of the array represents a key/value
40 * storage of the configuration dictionary.
42 struct ec_config_schema {
43 const char *key; /**< The key string (NULL for list elts). */
44 const char *desc; /**< A description of the value. */
45 enum ec_config_type type; /**< Type of the value */
47 /** If type is dict or list, the schema of the dict or list
48 * elements. Else must be NULL. */
49 const struct ec_config_schema *subschema;
51 /** The subschema array len in case of dict (> 0) or list (set
52 * to 1). Else must be 0. */
57 TAILQ_HEAD(ec_config_list, ec_config);
60 * Structure storing the configuration data.
63 /** type of value stored in the union */
64 enum ec_config_type type;
67 bool boolean; /** Boolean value */
68 int64_t i64; /** Signed integer value */
69 uint64_t u64; /** Unsigned integer value */
70 char *string; /** String value */
71 struct ec_node *node; /** Node value */
72 struct ec_keyval *dict; /** Hash table value */
73 struct ec_config_list list; /** List value */
77 * Next in list, only valid if type is list.
79 TAILQ_ENTRY(ec_config) next;
85 * Validate a configuration schema array.
88 * Pointer to the first element of the schema array.
90 * Length of the schema array.
92 * 0 if the schema is valid, or -1 on error (errno is set).
94 int ec_config_schema_validate(const struct ec_config_schema *schema,
98 * Dump a configuration schema array.
101 * Output stream on which the dump will be sent.
103 * Pointer to the first element of the schema array.
105 * Length of the schema array.
107 void ec_config_schema_dump(FILE *out, const struct ec_config_schema *schema,
114 * Get the type of the configuration.
119 * The configuration type.
121 enum ec_config_type ec_config_get_type(const struct ec_config *config);
124 * Create a boolean configuration value.
127 * The boolean value to be set.
129 * The configuration object, or NULL on error (errno is set).
131 struct ec_config *ec_config_bool(bool boolean);
134 * Create a signed integer configuration value.
137 * The signed integer value to be set.
139 * The configuration object, or NULL on error (errno is set).
141 struct ec_config *ec_config_i64(int64_t i64);
144 * Create an unsigned configuration value.
147 * The unsigned integer value to be set.
149 * The configuration object, or NULL on error (errno is set).
151 struct ec_config *ec_config_u64(uint64_t u64);
154 * Create a string configuration value.
157 * The string value to be set. The string is copied into the
158 * configuration object.
160 * The configuration object, or NULL on error (errno is set).
162 struct ec_config *ec_config_string(const char *string);
165 * Create a node configuration value.
168 * The node pointer to be set. The node is "consumed" by
169 * the function and should not be used by the caller, even
170 * on error. The caller can use ec_node_clone() to keep a
171 * reference on the node.
173 * The configuration object, or NULL on error (errno is set).
175 struct ec_config *ec_config_node(struct ec_node *node);
178 * Create a hash table configuration value.
181 * A configuration object containing an empty hash table, or NULL on
182 * error (errno is set).
184 struct ec_config *ec_config_dict(void);
187 * Create a list configuration value.
190 * The configuration object containing an empty list, or NULL on
191 * error (errno is set).
193 struct ec_config *ec_config_list(void);
196 * Add a config object into a list.
199 * The list configuration in which the value will be added.
201 * The value configuration to add in the list. The value object
202 * will be freed when freeing the list object. On error, the
203 * value object is also freed.
205 * 0 on success, else -1 (errno is set).
207 int ec_config_list_add(struct ec_config *list, struct ec_config *value);
210 * Remove an element from a list.
212 * The element is freed and should not be accessed.
215 * The list configuration.
217 * The element to remove from the list.
219 * 0 on success, -1 on error (errno is set).
221 int ec_config_list_del(struct ec_config *list, struct ec_config *config);
224 * Validate a configuration.
227 * A hash table configuration to validate.
229 * Pointer to the first element of the schema array.
231 * Length of the schema array.
233 * 0 on success, -1 on error (errno is set).
235 int ec_config_validate(const struct ec_config *dict,
236 const struct ec_config_schema *schema,
240 * Set a value in a hash table configuration
243 * A hash table configuration to validate.
247 * The value to set. The value object will be freed when freeing the
248 * dict object. On error, the value object is also freed.
250 * 0 on success, -1 on error (errno is set).
252 int ec_config_dict_set(struct ec_config *dict, const char *key,
253 struct ec_config *value);
256 * Remove an element from a hash table configuration.
258 * The element is freed and should not be accessed.
261 * A hash table configuration to validate.
263 * The key of the configuration to delete.
265 * 0 on success, -1 on error (errno is set).
267 int ec_config_dict_del(struct ec_config *config, const char *key);
270 * Compare two configurations.
272 int ec_config_cmp(const struct ec_config *config1,
273 const struct ec_config *config2);
276 * Get configuration value.
278 struct ec_config *ec_config_dict_get(const struct ec_config *config,
282 * Get the first element of a list.
285 * for (config = ec_config_list_iter(list);
287 * config = ec_config_list_next(list, config)) {
292 * The list configuration to iterate.
294 * The first configuration element, or NULL on error (errno is set).
296 struct ec_config *ec_config_list_first(struct ec_config *list);
299 * Get next element in list.
302 * The list configuration beeing iterated.
304 * The current configuration element.
306 * The next configuration element, or NULL if there is no more element.
309 ec_config_list_next(struct ec_config *list, struct ec_config *config);
312 * Free a configuration.
315 * The element to free.
317 void ec_config_free(struct ec_config *config);
320 * Compare two configurations.
323 * 0 if the configurations are equal, else -1.
325 int ec_config_cmp(const struct ec_config *value1,
326 const struct ec_config *value2);
329 * Duplicate a configuration.
332 * The configuration to duplicate.
334 * The duplicated configuration, or NULL on error (errno is set).
337 ec_config_dup(const struct ec_config *config);
340 * Dump a configuration.
343 * Output stream on which the dump will be sent.
345 * The configuration to dump.
347 void ec_config_dump(FILE *out, const struct ec_config *config);