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;
52 TAILQ_HEAD(ec_config_list, ec_config);
55 * Structure storing the configuration data.
58 /** type of value stored in the union */
59 enum ec_config_type type;
62 bool boolean; /** Boolean value */
63 int64_t i64; /** Signed integer value */
64 uint64_t u64; /** Unsigned integer value */
65 char *string; /** String value */
66 struct ec_node *node; /** Node value */
67 struct ec_keyval *dict; /** Hash table value */
68 struct ec_config_list list; /** List value */
72 * Next in list, only valid if type is list.
74 TAILQ_ENTRY(ec_config) next;
80 * Validate a configuration schema array.
83 * Pointer to the first element of the schema array. The array
84 * must be terminated by a sentinel entry (type == EC_CONFIG_TYPE_NONE).
86 * 0 if the schema is valid, or -1 on error (errno is set).
88 int ec_config_schema_validate(const struct ec_config_schema *schema);
91 * Dump a configuration schema array.
94 * Output stream on which the dump will be sent.
96 * Pointer to the first element of the schema array. The array
97 * must be terminated by a sentinel entry (type == EC_CONFIG_TYPE_NONE).
99 void ec_config_schema_dump(FILE *out, const struct ec_config_schema *schema);
105 * Get the type of the configuration.
110 * The configuration type.
112 enum ec_config_type ec_config_get_type(const struct ec_config *config);
115 * Create a boolean configuration value.
118 * The boolean value to be set.
120 * The configuration object, or NULL on error (errno is set).
122 struct ec_config *ec_config_bool(bool boolean);
125 * Create a signed integer configuration value.
128 * The signed integer value to be set.
130 * The configuration object, or NULL on error (errno is set).
132 struct ec_config *ec_config_i64(int64_t i64);
135 * Create an unsigned configuration value.
138 * The unsigned integer value to be set.
140 * The configuration object, or NULL on error (errno is set).
142 struct ec_config *ec_config_u64(uint64_t u64);
145 * Create a string configuration value.
148 * The string value to be set. The string is copied into the
149 * configuration object.
151 * The configuration object, or NULL on error (errno is set).
153 struct ec_config *ec_config_string(const char *string);
156 * Create a node configuration value.
159 * The node pointer to be set. The node is "consumed" by
160 * the function and should not be used by the caller, even
161 * on error. The caller can use ec_node_clone() to keep a
162 * reference on the node.
164 * The configuration object, or NULL on error (errno is set).
166 struct ec_config *ec_config_node(struct ec_node *node);
169 * Create a hash table configuration value.
172 * A configuration object containing an empty hash table, or NULL on
173 * error (errno is set).
175 struct ec_config *ec_config_dict(void);
178 * Create a list configuration value.
181 * The configuration object containing an empty list, or NULL on
182 * error (errno is set).
184 struct ec_config *ec_config_list(void);
187 * Add a config object into a list.
190 * The list configuration in which the value will be added.
192 * The value configuration to add in the list. The value object
193 * will be freed when freeing the list object. On error, the
194 * value object is also freed.
196 * 0 on success, else -1 (errno is set).
198 int ec_config_list_add(struct ec_config *list, struct ec_config *value);
201 * Remove an element from a list.
203 * The element is freed and should not be accessed.
206 * The list configuration.
208 * The element to remove from the list.
210 * 0 on success, -1 on error (errno is set).
212 int ec_config_list_del(struct ec_config *list, struct ec_config *config);
215 * Validate a configuration.
218 * A hash table configuration to validate.
220 * Pointer to the first element of the schema array. The array
221 * must be terminated by a sentinel entry (type == EC_CONFIG_TYPE_NONE).
223 * 0 on success, -1 on error (errno is set).
225 int ec_config_validate(const struct ec_config *dict,
226 const struct ec_config_schema *schema);
229 * Set a value in a hash table configuration
232 * A hash table configuration to validate.
236 * The value to set. The value object will be freed when freeing the
237 * dict object. On error, the value object is also freed.
239 * 0 on success, -1 on error (errno is set).
241 int ec_config_dict_set(struct ec_config *dict, const char *key,
242 struct ec_config *value);
245 * Remove an element from a hash table configuration.
247 * The element is freed and should not be accessed.
250 * A hash table configuration to validate.
252 * The key of the configuration to delete.
254 * 0 on success, -1 on error (errno is set).
256 int ec_config_dict_del(struct ec_config *config, const char *key);
259 * Compare two configurations.
261 int ec_config_cmp(const struct ec_config *config1,
262 const struct ec_config *config2);
265 * Get configuration value.
267 struct ec_config *ec_config_dict_get(const struct ec_config *config,
271 * Get the first element of a list.
274 * for (config = ec_config_list_iter(list);
276 * config = ec_config_list_next(list, config)) {
281 * The list configuration to iterate.
283 * The first configuration element, or NULL on error (errno is set).
285 struct ec_config *ec_config_list_first(struct ec_config *list);
288 * Get next element in list.
291 * The list configuration beeing iterated.
293 * The current configuration element.
295 * The next configuration element, or NULL if there is no more element.
298 ec_config_list_next(struct ec_config *list, struct ec_config *config);
301 * Free a configuration.
304 * The element to free.
306 void ec_config_free(struct ec_config *config);
309 * Compare two configurations.
312 * 0 if the configurations are equal, else -1.
314 int ec_config_cmp(const struct ec_config *value1,
315 const struct ec_config *value2);
318 * Duplicate a configuration.
321 * The configuration to duplicate.
323 * The duplicated configuration, or NULL on error (errno is set).
326 ec_config_dup(const struct ec_config *config);
329 * Dump a configuration.
332 * Output stream on which the dump will be sent.
334 * The configuration to dump.
336 void ec_config_dump(FILE *out, const struct ec_config *config);