1 /* config - Dictionnary where the type of each variable is provided. */
3 /* This is useful to build named structs, like option or property sets. */
5 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
6 * All rights reserved. */
8 /* This program is free software; you can redistribute it and/or modify it
9 * under the terms of the license (GNU LGPL) which comes with this package. */
13 #include "xbt/sysdep.h"
16 #include "xbt/dynar.h"
20 #include "xbt/config.h" /* prototypes of this module */
22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_cfg, xbt, "configuration support");
24 /* xbt_cfgelm_t: the typedef corresponding to a config variable.
26 Both data and DTD are mixed, but fixing it now would prevent me to ever
33 /* Allowed type of the variable */
34 e_xbt_cfgelm_type_t type;
43 (cannot be an union because type peer uses both str and i) */
45 } s_xbt_cfgelm_t, *xbt_cfgelm_t;
47 static const char *xbt_cfgelm_type_name[xbt_cfgelm_type_count] =
48 { "int", "double", "string", "peer", "any" };
50 /* Internal stuff used in cache to free a variable */
51 static void xbt_cfgelm_free(void *data);
53 /* Retrieve the variable we'll modify */
54 static xbt_cfgelm_t xbt_cfgelm_get(xbt_cfg_t cfg, const char *name,
55 e_xbt_cfgelm_type_t type);
57 /*----[ Memory management ]-----------------------------------------------*/
59 /** @brief Constructor
61 * Initialise an config set
65 xbt_cfg_t xbt_cfg_new(void)
67 return (xbt_cfg_t) xbt_dict_new_homogeneous(&xbt_cfgelm_free);
70 /** \brief Copy an existing configuration set
72 * \arg whereto the config set to be created
73 * \arg tocopy the source data
75 * This only copy the registrations, not the actual content
78 void xbt_cfg_cpy(xbt_cfg_t tocopy, xbt_cfg_t * whereto)
80 xbt_dict_cursor_t cursor = NULL;
81 xbt_cfgelm_t variable = NULL;
84 XBT_DEBUG("Copy cfg set %p", tocopy);
86 xbt_assert(tocopy, "cannot copy NULL config");
88 xbt_dict_foreach((xbt_dict_t) tocopy, cursor, name, variable) {
89 xbt_cfg_register(whereto, name, variable->desc, variable->type, NULL,
90 variable->min, variable->max, variable->cb_set,
95 /** @brief Destructor */
96 void xbt_cfg_free(xbt_cfg_t * cfg)
98 XBT_DEBUG("Frees cfg set %p", cfg);
99 xbt_dict_free((xbt_dict_t *) cfg);
102 /** @brief Dump a config set for debuging purpose
104 * \arg name The name to give to this config set
105 * \arg indent what to write at the begining of each line (right number of spaces)
106 * \arg cfg the config set
108 void xbt_cfg_dump(const char *name, const char *indent, xbt_cfg_t cfg)
110 xbt_dict_t dict = (xbt_dict_t) cfg;
111 xbt_dict_cursor_t cursor = NULL;
112 xbt_cfgelm_t variable = NULL;
122 printf("%s>> Dumping of the config set '%s':\n", indent, name);
123 xbt_dict_foreach(dict, cursor, key, variable) {
125 printf("%s %s:", indent, key);
127 size = xbt_dynar_length(variable->content);
129 ("%d_to_%d_%s. Actual size=%d. prerm=%p,postset=%p, List of values:\n",
130 variable->min, variable->max,
131 xbt_cfgelm_type_name[variable->type], size, variable->cb_rm,
134 switch (variable->type) {
137 for (i = 0; i < size; i++) {
138 ival = xbt_dynar_get_as(variable->content, i, int);
139 printf("%s %d\n", indent, ival);
143 case xbt_cfgelm_double:
144 for (i = 0; i < size; i++) {
145 dval = xbt_dynar_get_as(variable->content, i, double);
146 printf("%s %f\n", indent, dval);
150 case xbt_cfgelm_string:
151 for (i = 0; i < size; i++) {
152 sval = xbt_dynar_get_as(variable->content, i, char *);
153 printf("%s %s\n", indent, sval);
157 case xbt_cfgelm_peer:
158 for (i = 0; i < size; i++) {
159 hval = xbt_dynar_get_as(variable->content, i, xbt_peer_t);
160 printf("%s %s:%d\n", indent, hval->name, hval->port);
165 printf("%s Invalid type!!\n", indent);
171 printf("%s<< End of the config set '%s'\n", indent, name);
174 xbt_dict_cursor_free(&cursor);
179 * free an config element
182 void xbt_cfgelm_free(void *data)
184 xbt_cfgelm_t c = (xbt_cfgelm_t) data;
186 XBT_DEBUG("Frees cfgelm %p", c);
190 xbt_dynar_free(&(c->content));
194 /*----[ Registering stuff ]-----------------------------------------------*/
196 /** @brief Register an element within a config set
198 * @arg cfg the config set
199 * @arg type the type of the config element
200 * @arg min the minimum
201 * @arg max the maximum
205 xbt_cfg_register(xbt_cfg_t * cfg,
206 const char *name, const char *desc,
207 e_xbt_cfgelm_type_t type, void *default_value, int min,
208 int max, xbt_cfg_cb_t cb_set, xbt_cfg_cb_t cb_rm)
213 *cfg = xbt_cfg_new();
214 xbt_assert(type >= xbt_cfgelm_int && type <= xbt_cfgelm_peer,
215 "type of %s not valid (%d should be between %d and %d)",
216 name, (int)type, xbt_cfgelm_int, xbt_cfgelm_peer);
217 res = xbt_dict_get_or_null((xbt_dict_t) * cfg, name);
220 XBT_WARN("Config elem %s registered twice.", name);
221 /* Will be removed by the insertion of the new one */
224 res = xbt_new(s_xbt_cfgelm_t, 1);
225 XBT_DEBUG("Register cfg elm %s (%s) (%d to %d %s (=%d) @%p in set %p)",
226 name, desc, min, max, xbt_cfgelm_type_name[type], (int)type, res,
229 res->desc = xbt_strdup(desc);
233 res->cb_set = cb_set;
239 res->content = xbt_dynar_new(sizeof(int), NULL);
241 xbt_dynar_push(res->content, default_value);
244 case xbt_cfgelm_double:
245 res->content = xbt_dynar_new(sizeof(double), NULL);
247 xbt_dynar_push(res->content, default_value);
250 case xbt_cfgelm_string:
251 res->content = xbt_dynar_new(sizeof(char *), xbt_free_ref);
253 xbt_dynar_push(res->content, default_value);
256 case xbt_cfgelm_peer:
257 res->content = xbt_dynar_new(sizeof(xbt_peer_t), xbt_peer_free_voidp);
259 xbt_dynar_push(res->content, default_value);
263 XBT_ERROR("%d is an invalide type code", (int)type);
266 xbt_dict_set((xbt_dict_t) * cfg, name, res, NULL);
269 /** @brief Unregister an element from a config set.
271 * @arg cfg the config set
272 * @arg name the name of the elem to be freed
274 * Note that it removes both the description and the actual content.
275 * Throws not_found when no such element exists.
278 void xbt_cfg_unregister(xbt_cfg_t cfg, const char *name)
280 XBT_DEBUG("Unregister elm '%s' from set %p", name, cfg);
281 xbt_dict_remove((xbt_dict_t) cfg, name);
285 * @brief Parse a string and register the stuff described.
287 * @arg cfg the config set
288 * @arg entry a string describing the element to register
290 * The string may consist in several variable descriptions separated by a space.
291 * Each of them must use the following syntax: \<name\>:\<min nb\>_to_\<max nb\>_\<type\>
292 * with type being one of 'string','int', 'peer' or 'double'.
294 * FIXME: this does not allow to set the description
297 void xbt_cfg_register_str(xbt_cfg_t * cfg, const char *entry)
299 char *entrycpy = xbt_strdup(entry);
303 e_xbt_cfgelm_type_t type;
304 XBT_DEBUG("Register string '%s'", entry);
306 tok = strchr(entrycpy, ':');
307 xbt_assert(tok, "Invalid config element descriptor: %s%s",
308 entry, "; Should be <name>:<min nb>_to_<max nb>_<type>");
311 min = strtol(tok, &tok, 10);
312 xbt_assert(tok, "Invalid minimum in config element descriptor %s",
315 xbt_assert(strcmp(tok, "_to_"),
316 "Invalid config element descriptor : %s%s",
317 entry, "; Should be <name>:<min nb>_to_<max nb>_<type>");
318 tok += strlen("_to_");
320 max = strtol(tok, &tok, 10);
321 xbt_assert(tok, "Invalid maximum in config element descriptor %s",
324 xbt_assert(*tok == '_',
325 "Invalid config element descriptor: %s%s", entry,
326 "; Should be <name>:<min nb>_to_<max nb>_<type>");
329 for (type = (e_xbt_cfgelm_type_t)0;
330 type < xbt_cfgelm_type_count
331 && strcmp(tok, xbt_cfgelm_type_name[type]); type++);
332 xbt_assert(type < xbt_cfgelm_type_count,
333 "Invalid type in config element descriptor: %s%s", entry,
334 "; Should be one of 'string', 'int', 'peer' or 'double'.");
336 xbt_cfg_register(cfg, entrycpy, NULL, type, NULL, min, max, NULL, NULL);
338 free(entrycpy); /* strdup'ed by dict mechanism, but cannot be const */
341 static int strcmp_voidp(const void *pa, const void *pb)
343 return strcmp(*(const char **)pa, *(const char **)pb);
346 /** @brief Displays the declared options and their description */
347 void xbt_cfg_help(xbt_cfg_t cfg)
349 xbt_dict_cursor_t dict_cursor;
350 unsigned int dynar_cursor;
351 xbt_cfgelm_t variable;
353 xbt_dynar_t names = xbt_dynar_new(sizeof(char *), NULL);
355 xbt_dict_foreach((xbt_dict_t )cfg, dict_cursor, name, variable) {
356 xbt_dynar_push(names, &name);
358 xbt_dynar_sort(names, strcmp_voidp);
360 xbt_dynar_foreach(names, dynar_cursor, name) {
363 variable = xbt_dict_get((xbt_dict_t )cfg, name);
365 printf(" %s: %s\n", name, variable->desc);
366 printf(" Type: %s; ", xbt_cfgelm_type_name[variable->type]);
367 if (variable->min != 1 || variable->max != 1) {
368 if (variable->min == 0 && variable->max == 0)
369 printf("Arity: no bound; ");
371 printf("Arity: min:%d to max:%d; ", variable->min, variable->max);
373 printf("Current value: ");
374 size = xbt_dynar_length(variable->content);
376 switch (variable->type) {
383 for (i = 0; i < size; i++) {
384 ival = xbt_dynar_get_as(variable->content, i, int);
385 printf("%s%d\n", (i == 0 ? "" : " "), ival);
389 case xbt_cfgelm_double:
390 for (i = 0; i < size; i++) {
391 dval = xbt_dynar_get_as(variable->content, i, double);
392 printf("%s%f\n", (i == 0 ? "" : " "), dval);
396 case xbt_cfgelm_string:
397 for (i = 0; i < size; i++) {
398 sval = xbt_dynar_get_as(variable->content, i, char *);
399 printf("%s'%s'\n", (i == 0 ? "" : " "), sval);
403 case xbt_cfgelm_peer:
404 for (i = 0; i < size; i++) {
405 hval = xbt_dynar_get_as(variable->content, i, xbt_peer_t);
406 printf("%s%s:%d\n", (i == 0 ? "" : " "), hval->name,
412 printf("Invalid type!!\n");
417 xbt_dynar_free(&names);
420 /** @brief Check that each variable have the right amount of values */
421 void xbt_cfg_check(xbt_cfg_t cfg)
423 xbt_dict_cursor_t cursor;
424 xbt_cfgelm_t variable;
428 xbt_assert(cfg, "NULL config set.");
429 XBT_DEBUG("Check cfg set %p", cfg);
431 xbt_dict_foreach((xbt_dict_t) cfg, cursor, name, variable) {
432 size = xbt_dynar_length(variable->content);
433 if (variable->min > size) {
434 xbt_dict_cursor_free(&cursor);
435 THROWF(mismatch_error, 0,
436 "Config elem %s needs at least %d %s, but there is only %d values.",
437 name, variable->min, xbt_cfgelm_type_name[variable->type],
441 if (variable->max > 0 && variable->max < size) {
442 xbt_dict_cursor_free(&cursor);
443 THROWF(mismatch_error, 0,
444 "Config elem %s accepts at most %d %s, but there is %d values.",
445 name, variable->max, xbt_cfgelm_type_name[variable->type],
450 xbt_dict_cursor_free(&cursor);
453 static xbt_cfgelm_t xbt_cfgelm_get(xbt_cfg_t cfg,
455 e_xbt_cfgelm_type_t type)
457 xbt_cfgelm_t res = NULL;
459 res = xbt_dict_get_or_null((xbt_dict_t) cfg, name);
462 THROWF(not_found_error, 0,
463 "No registered variable '%s' in this config set", name);
466 xbt_assert(type == xbt_cfgelm_any || res->type == type,
467 "You tried to access to the config element %s as an %s, but its type is %s.",
469 xbt_cfgelm_type_name[type], xbt_cfgelm_type_name[res->type]);
474 /** @brief Get the type of this variable in that configuration set
476 * \arg cfg the config set
477 * \arg name the name of the element
478 * \arg type the result
482 e_xbt_cfgelm_type_t xbt_cfg_get_type(xbt_cfg_t cfg, const char *name)
485 xbt_cfgelm_t variable = NULL;
487 variable = xbt_dict_get_or_null((xbt_dict_t) cfg, name);
489 THROWF(not_found_error, 0,
490 "Can't get the type of '%s' since this variable does not exist",
493 XBT_INFO("type in variable = %d", (int)variable->type);
495 return variable->type;
498 /*----[ Setting ]---------------------------------------------------------*/
499 /** @brief va_args version of xbt_cfg_set
501 * \arg cfg config set to fill
502 * \arg n variable name
503 * \arg pa variable value
505 * Add some values to the config set.
507 void xbt_cfg_set_vargs(xbt_cfg_t cfg, const char *name, va_list pa)
512 e_xbt_cfgelm_type_t type = xbt_cfgelm_any; /* Set a dummy value to make gcc happy. It cannot get uninitialized */
517 type = xbt_cfg_get_type(cfg, name);
520 if (e.category == not_found_error) {
522 THROWF(not_found_error, 0,
523 "Can't set the property '%s' since it's not registered",
530 case xbt_cfgelm_peer:
531 str = va_arg(pa, char *);
533 xbt_cfg_set_peer(cfg, name, str, i);
536 case xbt_cfgelm_string:
537 str = va_arg(pa, char *);
538 xbt_cfg_set_string(cfg, name, str);
543 xbt_cfg_set_int(cfg, name, i);
546 case xbt_cfgelm_double:
547 d = va_arg(pa, double);
548 xbt_cfg_set_double(cfg, name, d);
552 xbt_die("Config element variable %s not valid (type=%d)", name, (int)type);
556 /** @brief Add a NULL-terminated list of pairs {(char*)key, value} to the set
558 * \arg cfg config set to fill
559 * \arg name variable name
560 * \arg varargs variable value
563 void xbt_cfg_set(xbt_cfg_t cfg, const char *name, ...)
568 xbt_cfg_set_vargs(cfg, name, pa);
572 /** @brief Add values parsed from a string into a config set
574 * \arg cfg config set to fill
575 * \arg options a string containing the content to add to the config set. This
576 * is a '\\t',' ' or '\\n' or ',' separated list of variables. Each individual variable is
577 * like "[name]:[value]" where [name] is the name of an already registred
578 * variable, and [value] conforms to the data type under which this variable was
581 * @todo This is a crude manual parser, it should be a proper lexer.
584 void xbt_cfg_set_parse(xbt_cfg_t cfg, const char *options)
592 volatile xbt_cfgelm_t variable = NULL;
593 char *optionlist_cpy;
594 char *option, *name, *val;
599 if (!options || !strlen(options)) { /* nothing to do */
602 optionlist_cpy = xbt_strdup(options);
604 XBT_DEBUG("List to parse and set:'%s'", options);
605 option = optionlist_cpy;
606 while (1) { /* breaks in the code */
612 XBT_DEBUG("Still to parse and set: '%s'. len=%d; option-name=%ld",
613 name, len, (long) (option - name));
616 while (option - name <= (len - 1) && *option != ' ' && *option != '\n'
617 && *option != '\t' && *option != ',') {
618 XBT_DEBUG("Take %c.", *option);
621 if (option - name == len) {
622 XBT_DEBUG("Boundary=EOL");
623 option = NULL; /* don't do next iteration */
626 XBT_DEBUG("Boundary on '%c'. len=%d;option-name=%ld",
627 *option, len, (long) (option - name));
629 /* Pass the following blank chars */
631 while (option - name < (len - 1) &&
632 (*option == ' ' || *option == '\n' || *option == '\t')) {
633 /* fprintf(stderr,"Ignore a blank char.\n"); */
636 if (option - name == len - 1)
637 option = NULL; /* don't do next iteration */
639 XBT_DEBUG("parse now:'%s'; parse later:'%s'", name, option);
641 if (name[0] == ' ' || name[0] == '\n' || name[0] == '\t')
646 val = strchr(name, ':');
648 free(optionlist_cpy);
649 xbt_die("Option '%s' badly formated. Should be of the form 'name:value'",
654 if (strncmp(name, "contexts/", strlen("contexts/")))
655 XBT_INFO("Configuration change: Set '%s' to '%s'", name, val);
658 variable = xbt_dict_get((xbt_dict_t) cfg, name);
661 if (e.category == not_found_error) {
664 THROWF(not_found_error, 0,
665 "No registered variable corresponding to '%s'.", name);
668 /* name points into optionlist_cpy, it cannot be freed before */
669 free(optionlist_cpy);
675 free(optionlist_cpy);
680 switch (variable->type) {
681 case xbt_cfgelm_string:
682 xbt_cfg_set_string(cfg, name, val); /* throws */
686 i = strtol(val, &val, 0);
688 free(optionlist_cpy);
689 xbt_die("Value of option %s not valid. Should be an integer", name);
692 xbt_cfg_set_int(cfg, name, i); /* throws */
695 case xbt_cfgelm_double:
696 d = strtod(val, &val);
698 free(optionlist_cpy);
699 xbt_die("Value of option %s not valid. Should be a double", name);
702 xbt_cfg_set_double(cfg, name, d); /* throws */
705 case xbt_cfgelm_peer:
707 val = strchr(val, ':');
709 free(optionlist_cpy);
710 xbt_die("Value of option %s not valid. Should be an peer (machine:port)",
715 i = strtol(val, &val, 0);
717 free(optionlist_cpy);
718 xbt_die("Value of option %s not valid. Should be an peer (machine:port)",
722 xbt_cfg_set_peer(cfg, name, str, i); /* throws */
726 THROWF(unknown_error, 0, "Type of config element %s is not valid.",
731 free(optionlist_cpy);
735 free(optionlist_cpy);
739 /** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet
741 * This is useful to change the default value of a variable while allowing
742 * users to override it with command line arguments
744 void xbt_cfg_setdefault_int(xbt_cfg_t cfg, const char *name, int val)
746 xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_int);
748 if (variable->isdefault){
749 xbt_cfg_set_int(cfg, name, val);
750 variable->isdefault = 1;
754 ("Do not override configuration variable '%s' with value '%d' because it was already set.",
758 /** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet
760 * This is useful to change the default value of a variable while allowing
761 * users to override it with command line arguments
763 void xbt_cfg_setdefault_double(xbt_cfg_t cfg, const char *name, double val)
765 xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_double);
767 if (variable->isdefault) {
768 xbt_cfg_set_double(cfg, name, val);
769 variable->isdefault = 1;
773 ("Do not override configuration variable '%s' with value '%lf' because it was already set.",
777 /** @brief Set a string value to \a name within \a cfg if it wasn't changed yet
779 * This is useful to change the default value of a variable while allowing
780 * users to override it with command line arguments
782 void xbt_cfg_setdefault_string(xbt_cfg_t cfg, const char *name,
785 xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_string);
787 if (variable->isdefault){
788 xbt_cfg_set_string(cfg, name, val);
789 variable->isdefault = 1;
793 ("Do not override configuration variable '%s' with value '%s' because it was already set.",
797 /** @brief Set a peer value to \a name within \a cfg if it wasn't changed yet
799 * This is useful to change the default value of a variable while allowing
800 * users to override it with command line arguments
802 void xbt_cfg_setdefault_peer(xbt_cfg_t cfg, const char *name,
803 const char *host, int port)
805 xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_peer);
807 if (variable->isdefault){
808 xbt_cfg_set_peer(cfg, name, host, port);
809 variable->isdefault = 1;
813 ("Do not override configuration variable '%s' with value '%s:%d' because it was already set.",
817 /** @brief Set or add an integer value to \a name within \a cfg
819 * \arg cfg the config set
820 * \arg name the name of the variable
821 * \arg val the value of the variable
823 void xbt_cfg_set_int(xbt_cfg_t cfg, const char *name, int val)
825 xbt_cfgelm_t variable;
827 XBT_VERB("Configuration setting: %s=%d", name, val);
828 variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_int);
830 if (variable->max == 1) {
831 if (variable->cb_rm && !xbt_dynar_is_empty(variable->content))
832 variable->cb_rm(name, 0);
834 xbt_dynar_set(variable->content, 0, &val);
837 && xbt_dynar_length(variable->content) ==
838 (unsigned long) variable->max)
839 THROWF(mismatch_error, 0,
840 "Cannot add value %d to the config element %s since it's already full (size=%d)",
841 val, name, variable->max);
843 xbt_dynar_push(variable->content, &val);
846 if (variable->cb_set)
847 variable->cb_set(name, xbt_dynar_length(variable->content) - 1);
848 variable->isdefault = 0;
851 /** @brief Set or add a double value to \a name within \a cfg
853 * \arg cfg the config set
854 * \arg name the name of the variable
855 * \arg val the doule to set
858 void xbt_cfg_set_double(xbt_cfg_t cfg, const char *name, double val)
860 xbt_cfgelm_t variable;
862 XBT_VERB("Configuration setting: %s=%f", name, val);
863 variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_double);
865 if (variable->max == 1) {
866 if (variable->cb_rm && !xbt_dynar_is_empty(variable->content))
867 variable->cb_rm(name, 0);
869 xbt_dynar_set(variable->content, 0, &val);
872 && xbt_dynar_length(variable->content) == variable->max)
873 THROWF(mismatch_error, 0,
874 "Cannot add value %f to the config element %s since it's already full (size=%d)",
875 val, name, variable->max);
877 xbt_dynar_push(variable->content, &val);
880 if (variable->cb_set)
881 variable->cb_set(name, xbt_dynar_length(variable->content) - 1);
882 variable->isdefault = 0;
885 /** @brief Set or add a string value to \a name within \a cfg
887 * \arg cfg the config set
888 * \arg name the name of the variable
889 * \arg val the value to be added
893 void xbt_cfg_set_string(xbt_cfg_t cfg, const char *name, const char *val)
895 xbt_cfgelm_t variable;
896 char *newval = xbt_strdup(val);
898 XBT_VERB("Configuration setting: %s=%s", name, val);
899 variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_string);
900 XBT_DEBUG("Variable: %d to %d %s (=%d) @%p",
901 variable->min, variable->max,
902 xbt_cfgelm_type_name[variable->type], (int)variable->type, variable);
904 if (variable->max == 1) {
905 if (!xbt_dynar_is_empty(variable->content)) {
907 variable->cb_rm(name, 0);
908 else if (variable->type == xbt_cfgelm_string) {
909 char *sval = xbt_dynar_get_as(variable->content, 0, char *);
914 xbt_dynar_set(variable->content, 0, &newval);
917 && xbt_dynar_length(variable->content) == variable->max)
918 THROWF(mismatch_error, 0,
919 "Cannot add value %s to the config element %s since it's already full (size=%d)",
920 name, val, variable->max);
922 xbt_dynar_push(variable->content, &newval);
925 if (variable->cb_set)
926 variable->cb_set(name, xbt_dynar_length(variable->content) - 1);
927 variable->isdefault = 0;
930 /** @brief Set or add an peer value to \a name within \a cfg
932 * \arg cfg the config set
933 * \arg name the name of the variable
935 * \arg port the port number
937 * \e peer values are composed of a string (peername) and an integer (port)
941 xbt_cfg_set_peer(xbt_cfg_t cfg, const char *name, const char *peer,
944 xbt_cfgelm_t variable;
945 xbt_peer_t val = xbt_peer_new(peer, port);
947 XBT_VERB("Configuration setting: %s=%s:%d", name, peer, port);
949 variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_peer);
951 if (variable->max == 1) {
952 if (variable->cb_rm && !xbt_dynar_is_empty(variable->content))
953 variable->cb_rm(name, 0);
955 xbt_dynar_set(variable->content, 0, &val);
958 && xbt_dynar_length(variable->content) == variable->max)
959 THROWF(mismatch_error, 0,
960 "Cannot add value %s:%d to the config element %s since it's already full (size=%d)",
961 peer, port, name, variable->max);
963 xbt_dynar_push(variable->content, &val);
966 if (variable->cb_set)
967 variable->cb_set(name, xbt_dynar_length(variable->content) - 1);
968 variable->isdefault = 0;
971 /* ---- [ Removing ] ---- */
973 /** @brief Remove the provided \e val integer value from a variable
975 * \arg cfg the config set
976 * \arg name the name of the variable
977 * \arg val the value to be removed
979 void xbt_cfg_rm_int(xbt_cfg_t cfg, const char *name, int val)
982 xbt_cfgelm_t variable;
986 variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_int);
988 if (xbt_dynar_length(variable->content) == variable->min)
989 THROWF(mismatch_error, 0,
990 "Cannot remove value %d from the config element %s since it's already at its minimal size (=%d)",
991 val, name, variable->min);
993 xbt_dynar_foreach(variable->content, cpt, seen) {
996 variable->cb_rm(name, cpt);
997 xbt_dynar_cursor_rm(variable->content, &cpt);
1002 THROWF(not_found_error, 0,
1003 "Can't remove the value %d of config element %s: value not found.",
1007 /** @brief Remove the provided \e val double value from a variable
1009 * \arg cfg the config set
1010 * \arg name the name of the variable
1011 * \arg val the value to be removed
1014 void xbt_cfg_rm_double(xbt_cfg_t cfg, const char *name, double val)
1016 xbt_cfgelm_t variable;
1020 variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_double);
1022 if (xbt_dynar_length(variable->content) == variable->min)
1023 THROWF(mismatch_error, 0,
1024 "Cannot remove value %f from the config element %s since it's already at its minimal size (=%d)",
1025 val, name, variable->min);
1027 xbt_dynar_foreach(variable->content, cpt, seen) {
1029 xbt_dynar_cursor_rm(variable->content, &cpt);
1030 if (variable->cb_rm)
1031 variable->cb_rm(name, cpt);
1036 THROWF(not_found_error, 0,
1037 "Can't remove the value %f of config element %s: value not found.",
1041 /** @brief Remove the provided \e val string value from a variable
1043 * \arg cfg the config set
1044 * \arg name the name of the variable
1045 * \arg val the value of the string which will be removed
1047 void xbt_cfg_rm_string(xbt_cfg_t cfg, const char *name, const char *val)
1049 xbt_cfgelm_t variable;
1053 variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_string);
1055 if (xbt_dynar_length(variable->content) == variable->min)
1056 THROWF(mismatch_error, 0,
1057 "Cannot remove value %s from the config element %s since it's already at its minimal size (=%d)",
1058 name, val, variable->min);
1060 xbt_dynar_foreach(variable->content, cpt, seen) {
1061 if (!strcpy(seen, val)) {
1062 if (variable->cb_rm)
1063 variable->cb_rm(name, cpt);
1064 xbt_dynar_cursor_rm(variable->content, &cpt);
1069 THROWF(not_found_error, 0,
1070 "Can't remove the value %s of config element %s: value not found.",
1074 /** @brief Remove the provided \e val peer value from a variable
1076 * \arg cfg the config set
1077 * \arg name the name of the variable
1078 * \arg peer the peername
1079 * \arg port the port number
1083 xbt_cfg_rm_peer(xbt_cfg_t cfg, const char *name, const char *peer,
1086 xbt_cfgelm_t variable;
1090 variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_peer);
1092 if (xbt_dynar_length(variable->content) == variable->min)
1093 THROWF(mismatch_error, 0,
1094 "Cannot remove value %s:%d from the config element %s since it's already at its minimal size (=%d)",
1095 peer, port, name, variable->min);
1097 xbt_dynar_foreach(variable->content, cpt, seen) {
1098 if (!strcpy(seen->name, peer) && seen->port == port) {
1099 if (variable->cb_rm)
1100 variable->cb_rm(name, cpt);
1101 xbt_dynar_cursor_rm(variable->content, &cpt);
1106 THROWF(not_found_error, 0,
1107 "Can't remove the value %s:%d of config element %s: value not found.",
1111 /** @brief Remove the \e pos th value from the provided variable */
1113 void xbt_cfg_rm_at(xbt_cfg_t cfg, const char *name, int pos)
1116 xbt_cfgelm_t variable;
1118 variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_any);
1120 if (xbt_dynar_length(variable->content) == variable->min)
1121 THROWF(mismatch_error, 0,
1122 "Cannot remove %dth value from the config element %s since it's already at its minimal size (=%d)",
1123 pos, name, variable->min);
1125 if (variable->cb_rm)
1126 variable->cb_rm(name, pos);
1127 xbt_dynar_remove_at(variable->content, pos, NULL);
1130 /** @brief Remove all the values from a variable
1132 * \arg cfg the config set
1133 * \arg name the name of the variable
1136 void xbt_cfg_empty(xbt_cfg_t cfg, const char *name)
1138 xbt_cfgelm_t variable = NULL;
1142 variable = xbt_dict_get((xbt_dict_t) cfg, name);
1145 if (e.category != not_found_error)
1149 THROWF(not_found_error, 0,
1150 "Can't empty '%s' since this config element does not exist",
1155 if (variable->cb_rm) {
1158 xbt_dynar_foreach(variable->content, cpt, ignored) {
1159 variable->cb_rm(name, cpt);
1162 xbt_dynar_reset(variable->content);
1166 * Say if the value is the default value
1168 int xbt_cfg_is_default_value(xbt_cfg_t cfg, const char *name)
1170 xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_any);
1171 return variable->isdefault;
1174 /*----[ Getting ]---------------------------------------------------------*/
1176 /** @brief Retrieve an integer value of a variable (get a warning if not uniq)
1178 * \arg cfg the config set
1179 * \arg name the name of the variable
1180 * \arg val the wanted value
1182 * Returns the first value from the config set under the given name.
1183 * If there is more than one value, it will issue a warning. Consider using
1184 * xbt_cfg_get_dynar() instead.
1186 * \warning the returned value is the actual content of the config set
1188 int xbt_cfg_get_int(xbt_cfg_t cfg, const char *name)
1190 xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_int);
1192 if (xbt_dynar_length(variable->content) > 1) {
1194 ("You asked for the first value of the config element '%s', but there is %lu values",
1195 name, xbt_dynar_length(variable->content));
1198 return xbt_dynar_get_as(variable->content, 0, int);
1201 /** @brief Retrieve a double value of a variable (get a warning if not uniq)
1203 * \arg cfg the config set
1204 * \arg name the name of the variable
1205 * \arg val the wanted value
1207 * Returns the first value from the config set under the given name.
1208 * If there is more than one value, it will issue a warning. Consider using
1209 * xbt_cfg_get_dynar() instead.
1211 * \warning the returned value is the actual content of the config set
1214 double xbt_cfg_get_double(xbt_cfg_t cfg, const char *name)
1216 xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_double);
1218 if (xbt_dynar_length(variable->content) > 1) {
1220 ("You asked for the first value of the config element '%s', but there is %lu values\n",
1221 name, xbt_dynar_length(variable->content));
1224 return xbt_dynar_get_as(variable->content, 0, double);
1227 /** @brief Retrieve a string value of a variable (get a warning if not uniq)
1229 * \arg th the config set
1230 * \arg name the name of the variable
1231 * \arg val the wanted value
1233 * Returns the first value from the config set under the given name.
1234 * If there is more than one value, it will issue a warning. Consider using
1235 * xbt_cfg_get_dynar() instead. Returns NULL if there is no value.
1237 * \warning the returned value is the actual content of the config set
1240 char *xbt_cfg_get_string(xbt_cfg_t cfg, const char *name)
1242 xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_string);
1244 if (xbt_dynar_length(variable->content) > 1) {
1246 ("You asked for the first value of the config element '%s', but there is %lu values\n",
1247 name, xbt_dynar_length(variable->content));
1248 } else if (xbt_dynar_is_empty(variable->content)) {
1252 return xbt_dynar_get_as(variable->content, 0, char *);
1255 /** @brief Retrieve an peer value of a variable (get a warning if not uniq)
1257 * \arg cfg the config set
1258 * \arg name the name of the variable
1259 * \arg peer the peer
1260 * \arg port the port number
1262 * Returns the first value from the config set under the given name.
1263 * If there is more than one value, it will issue a warning. Consider using
1264 * xbt_cfg_get_dynar() instead.
1266 * \warning the returned value is the actual content of the config set
1269 void xbt_cfg_get_peer(xbt_cfg_t cfg, const char *name, char **peer,
1272 xbt_cfgelm_t variable;
1275 variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_peer);
1277 if (xbt_dynar_length(variable->content) > 1) {
1279 ("You asked for the first value of the config element '%s', but there is %lu values\n",
1280 name, xbt_dynar_length(variable->content));
1283 val = xbt_dynar_get_as(variable->content, 0, xbt_peer_t);
1288 /** @brief Retrieve the dynar of all the values stored in a variable
1290 * \arg cfg where to search in
1291 * \arg name what to search for
1294 * Get the data stored in the config set.
1296 * \warning the returned value is the actual content of the config set
1298 xbt_dynar_t xbt_cfg_get_dynar(xbt_cfg_t cfg, const char *name)
1300 xbt_cfgelm_t variable = NULL;
1304 variable = xbt_dict_get((xbt_dict_t) cfg, name);
1307 if (e.category == not_found_error) {
1309 THROWF(not_found_error, 0,
1310 "No registered variable %s in this config set", name);
1315 return variable->content;
1319 /** @brief Retrieve one of the integer value of a variable */
1320 int xbt_cfg_get_int_at(xbt_cfg_t cfg, const char *name, int pos)
1323 xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_int);
1324 return xbt_dynar_get_as(variable->content, pos, int);
1327 /** @brief Retrieve one of the double value of a variable */
1328 double xbt_cfg_get_double_at(xbt_cfg_t cfg, const char *name, int pos)
1331 xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_double);
1332 return xbt_dynar_get_as(variable->content, pos, double);
1336 /** @brief Retrieve one of the string value of a variable */
1337 char *xbt_cfg_get_string_at(xbt_cfg_t cfg, const char *name, int pos)
1340 xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_string);
1341 return xbt_dynar_get_as(variable->content, pos, char *);
1344 /** @brief Retrieve one of the peer value of a variable */
1346 xbt_cfg_get_peer_at(xbt_cfg_t cfg, const char *name, int pos,
1347 char **peer, int *port)
1350 xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_int);
1351 xbt_peer_t val = xbt_dynar_get_ptr(variable->content, pos);
1362 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_cfg);
1364 XBT_TEST_SUITE("config", "Configuration support");
1366 static xbt_cfg_t make_set()
1368 xbt_cfg_t set = NULL;
1370 xbt_log_threshold_set(&_XBT_LOGV(xbt_cfg), xbt_log_priority_critical);
1371 xbt_cfg_register_str(&set, "speed:1_to_2_int");
1372 xbt_cfg_register_str(&set, "peername:1_to_1_string");
1373 xbt_cfg_register_str(&set, "user:1_to_10_string");
1376 } /* end_of_make_set */
1378 XBT_TEST_UNIT("memuse", test_config_memuse, "Alloc and free a config set")
1380 xbt_cfg_t set = make_set();
1381 xbt_test_add("Alloc and free a config set");
1382 xbt_cfg_set_parse(set,
1383 "peername:veloce user:mquinson\nuser:oaumage\tuser:alegrand");
1388 XBT_TEST_UNIT("validation", test_config_validation, "Validation tests")
1390 xbt_cfg_t set = set = make_set();
1393 xbt_test_add("Having too few elements for speed");
1394 xbt_cfg_set_parse(set,
1395 "peername:veloce user:mquinson\nuser:oaumage\tuser:alegrand");
1400 if (e.category != mismatch_error ||
1401 strncmp(e.msg, "Config elem speed needs",
1402 strlen("Config elem speed needs")))
1403 xbt_test_fail("Got an exception. msg=%s", e.msg);
1411 xbt_test_add("Having too much values of 'speed'");
1413 xbt_cfg_set_parse(set, "peername:toto:42 user:alegrand");
1415 xbt_cfg_set_parse(set, "speed:42 speed:24 speed:34");
1418 if (e.category != mismatch_error ||
1419 strncmp(e.msg, "Cannot add value 34 to the config elem speed",
1420 strlen("Config elem speed needs")))
1421 xbt_test_fail("Got an exception. msg=%s", e.msg);
1430 XBT_TEST_UNIT("use", test_config_use, "Data retrieving tests")
1433 xbt_test_add("Get a single value");
1435 /* get_single_value */
1437 xbt_cfg_t myset = make_set();
1439 xbt_cfg_set_parse(myset, "peername:toto:42 speed:42");
1440 ival = xbt_cfg_get_int(myset, "speed");
1442 xbt_test_fail("Speed value = %d, I expected 42", ival);
1443 xbt_cfg_free(&myset);
1446 xbt_test_add("Get multiple values");
1448 /* get_multiple_value */
1450 xbt_cfg_t myset = make_set();
1452 xbt_cfg_set_parse(myset,
1453 "peername:veloce user:foo\nuser:bar\tuser:toto");
1454 xbt_cfg_set_parse(myset, "speed:42");
1455 xbt_cfg_check(myset);
1456 dyn = xbt_cfg_get_dynar(myset, "user");
1458 if (xbt_dynar_length(dyn) != 3)
1459 xbt_test_fail("Dynar length = %lu, I expected 3",
1460 xbt_dynar_length(dyn));
1462 if (strcmp(xbt_dynar_get_as(dyn, 0, char *), "foo"))
1463 xbt_test_fail("Dynar[0] = %s, I expected foo",
1464 xbt_dynar_get_as(dyn, 0, char *));
1466 if (strcmp(xbt_dynar_get_as(dyn, 1, char *), "bar"))
1467 xbt_test_fail("Dynar[1] = %s, I expected bar",
1468 xbt_dynar_get_as(dyn, 1, char *));
1470 if (strcmp(xbt_dynar_get_as(dyn, 2, char *), "toto"))
1471 xbt_test_fail("Dynar[2] = %s, I expected toto",
1472 xbt_dynar_get_as(dyn, 2, char *));
1473 xbt_cfg_free(&myset);
1476 xbt_test_add("Access to a non-existant entry");
1478 /* non-existant_entry */
1479 xbt_cfg_t myset = make_set();
1483 xbt_cfg_set_parse(myset, "color:blue");
1486 if (e.category != not_found_error)
1487 xbt_test_exception(e);
1490 xbt_cfg_free(&myset);
1493 #endif /* SIMGRID_TEST */