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);
102 * Check if a key name is reserved in a config dict.
104 * Some key names are reserved and should not be used in configs.
107 * The name of the key to test.
109 * True if the key name is reserved and must not be used, else false.
111 bool ec_config_key_is_reserved(const char *name);
114 * Array of reserved key names.
116 extern const char *ec_config_reserved_keys[];
122 * Get the type of the configuration.
127 * The configuration type.
129 enum ec_config_type ec_config_get_type(const struct ec_config *config);
132 * Create a boolean configuration value.
135 * The boolean value to be set.
137 * The configuration object, or NULL on error (errno is set).
139 struct ec_config *ec_config_bool(bool boolean);
142 * Create a signed integer configuration value.
145 * The signed integer value to be set.
147 * The configuration object, or NULL on error (errno is set).
149 struct ec_config *ec_config_i64(int64_t i64);
152 * Create an unsigned configuration value.
155 * The unsigned integer value to be set.
157 * The configuration object, or NULL on error (errno is set).
159 struct ec_config *ec_config_u64(uint64_t u64);
162 * Create a string configuration value.
165 * The string value to be set. The string is copied into the
166 * configuration object.
168 * The configuration object, or NULL on error (errno is set).
170 struct ec_config *ec_config_string(const char *string);
173 * Create a node configuration value.
176 * The node pointer to be set. The node is "consumed" by
177 * the function and should not be used by the caller, even
178 * on error. The caller can use ec_node_clone() to keep a
179 * reference on the node.
181 * The configuration object, or NULL on error (errno is set).
183 struct ec_config *ec_config_node(struct ec_node *node);
186 * Create a hash table configuration value.
189 * A configuration object containing an empty hash table, or NULL on
190 * error (errno is set).
192 struct ec_config *ec_config_dict(void);
195 * Create a list configuration value.
198 * The configuration object containing an empty list, or NULL on
199 * error (errno is set).
201 struct ec_config *ec_config_list(void);
204 * Add a config object into a list.
207 * The list configuration in which the value will be added.
209 * The value configuration to add in the list. The value object
210 * will be freed when freeing the list object. On error, the
211 * value object is also freed.
213 * 0 on success, else -1 (errno is set).
215 int ec_config_list_add(struct ec_config *list, struct ec_config *value);
218 * Remove an element from a list.
220 * The element is freed and should not be accessed.
223 * The list configuration.
225 * The element to remove from the list.
227 * 0 on success, -1 on error (errno is set).
229 int ec_config_list_del(struct ec_config *list, struct ec_config *config);
232 * Validate a configuration.
235 * A hash table configuration to validate.
237 * Pointer to the first element of the schema array. The array
238 * must be terminated by a sentinel entry (type == EC_CONFIG_TYPE_NONE).
240 * 0 on success, -1 on error (errno is set).
242 int ec_config_validate(const struct ec_config *dict,
243 const struct ec_config_schema *schema);
246 * Set a value in a hash table configuration
249 * A hash table configuration to validate.
253 * The value to set. The value object will be freed when freeing the
254 * dict object. On error, the value object is also freed.
256 * 0 on success, -1 on error (errno is set).
258 int ec_config_dict_set(struct ec_config *dict, const char *key,
259 struct ec_config *value);
262 * Remove an element from a hash table configuration.
264 * The element is freed and should not be accessed.
267 * A hash table configuration to validate.
269 * The key of the configuration to delete.
271 * 0 on success, -1 on error (errno is set).
273 int ec_config_dict_del(struct ec_config *config, const char *key);
276 * Compare two configurations.
278 int ec_config_cmp(const struct ec_config *config1,
279 const struct ec_config *config2);
282 * Get configuration value.
284 struct ec_config *ec_config_dict_get(const struct ec_config *config,
288 * Get the first element of a list.
291 * for (config = ec_config_list_iter(list);
293 * config = ec_config_list_next(list, config)) {
298 * The list configuration to iterate.
300 * The first configuration element, or NULL on error (errno is set).
302 struct ec_config *ec_config_list_first(struct ec_config *list);
305 * Get next element in list.
308 * The list configuration beeing iterated.
310 * The current configuration element.
312 * The next configuration element, or NULL if there is no more element.
315 ec_config_list_next(struct ec_config *list, struct ec_config *config);
318 * Free a configuration.
321 * The element to free.
323 void ec_config_free(struct ec_config *config);
326 * Compare two configurations.
329 * 0 if the configurations are equal, else -1.
331 int ec_config_cmp(const struct ec_config *value1,
332 const struct ec_config *value2);
335 * Duplicate a configuration.
338 * The configuration to duplicate.
340 * The duplicated configuration, or NULL on error (errno is set).
343 ec_config_dup(const struct ec_config *config);
346 * Dump a configuration.
349 * Output stream on which the dump will be sent.
351 * The configuration to dump.
353 void ec_config_dump(FILE *out, const struct ec_config *config);