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();
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_assert0(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_assert4(type >= xbt_cfgelm_int && type <= xbt_cfgelm_peer,
215 "type of %s not valid (%d should be between %d and %d)",
216 name, 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], 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", type);
266 xbt_dict_set((xbt_dict_t) * cfg, name, res, &xbt_cfgelm_free);
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_assert2(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_assert1(tok, "Invalid minimum in config element descriptor %s",
315 xbt_assert2(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_assert1(tok, "Invalid maximum in config element descriptor %s",
324 xbt_assert2(*tok == '_',
325 "Invalid config element descriptor: %s%s", entry,
326 "; Should be <name>:<min nb>_to_<max nb>_<type>");
330 type < xbt_cfgelm_type_count
331 && strcmp(tok, xbt_cfgelm_type_name[type]); type++);
332 xbt_assert2(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_assert0(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 THROW4(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 THROW4(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 THROW1(not_found_error, 0,
463 "No registered variable '%s' in this config set", name);
466 xbt_assert3(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 THROW1(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", 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 = 0; /* Set a dummy value to make gcc happy. It cannot get uninitialized */
517 type = xbt_cfg_get_type(cfg, name);
519 if (e.category == not_found_error) {
521 THROW1(not_found_error, 0,
522 "Can't set the property '%s' since it's not registered",
529 case xbt_cfgelm_peer:
530 str = va_arg(pa, char *);
532 xbt_cfg_set_peer(cfg, name, str, i);
535 case xbt_cfgelm_string:
536 str = va_arg(pa, char *);
537 xbt_cfg_set_string(cfg, name, str);
542 xbt_cfg_set_int(cfg, name, i);
545 case xbt_cfgelm_double:
546 d = va_arg(pa, double);
547 xbt_cfg_set_double(cfg, name, d);
551 xbt_die("Config element variable %s not valid (type=%d)", name, type);
555 /** @brief Add a NULL-terminated list of pairs {(char*)key, value} to the set
557 * \arg cfg config set to fill
558 * \arg name variable name
559 * \arg varargs variable value
562 void xbt_cfg_set(xbt_cfg_t cfg, const char *name, ...)
567 xbt_cfg_set_vargs(cfg, name, pa);
571 /** @brief Add values parsed from a string into a config set
573 * \arg cfg config set to fill
574 * \arg options a string containing the content to add to the config set. This
575 * is a '\\t',' ' or '\\n' or ',' separated list of variables. Each individual variable is
576 * like "[name]:[value]" where [name] is the name of an already registred
577 * variable, and [value] conforms to the data type under which this variable was
580 * @todo This is a crude manual parser, it should be a proper lexer.
583 void xbt_cfg_set_parse(xbt_cfg_t cfg, const char *options)
591 xbt_cfgelm_t variable = NULL;
592 char *optionlist_cpy;
593 char *option, *name, *val;
598 if (!options || !strlen(options)) { /* nothing to do */
601 optionlist_cpy = xbt_strdup(options);
603 XBT_DEBUG("List to parse and set:'%s'", options);
604 option = optionlist_cpy;
605 while (1) { /* breaks in the code */
611 XBT_DEBUG("Still to parse and set: '%s'. len=%d; option-name=%ld",
612 name, len, (long) (option - name));
615 while (option - name <= (len - 1) && *option != ' ' && *option != '\n'
616 && *option != '\t' && *option != ',') {
617 XBT_DEBUG("Take %c.", *option);
620 if (option - name == len) {
621 XBT_DEBUG("Boundary=EOL");
622 option = NULL; /* don't do next iteration */
625 XBT_DEBUG("Boundary on '%c'. len=%d;option-name=%ld",
626 *option, len, (long) (option - name));
628 /* Pass the following blank chars */
630 while (option - name < (len - 1) &&
631 (*option == ' ' || *option == '\n' || *option == '\t')) {
632 /* fprintf(stderr,"Ignore a blank char.\n"); */
635 if (option - name == len - 1)
636 option = NULL; /* don't do next iteration */
638 XBT_DEBUG("parse now:'%s'; parse later:'%s'", name, option);
640 if (name[0] == ' ' || name[0] == '\n' || name[0] == '\t')
645 val = strchr(name, ':');
647 free(optionlist_cpy);
648 xbt_die("Option '%s' badly formated. Should be of the form 'name:value'",
653 if (strcmp(name,"contexts/factory"))
654 XBT_INFO("Configuration change: Set '%s' to '%s'", name, val);
657 variable = xbt_dict_get((xbt_dict_t) cfg, name);
660 /* put it back on what won't get freed, ie within "options" and out of "optionlist_cpy" */
661 name = (char *) (optionlist_cpy - name + options);
662 free(optionlist_cpy);
663 if (e.category == not_found_error) {
665 THROW1(not_found_error, 0,
666 "No registered variable corresponding to '%s'.", name);
672 switch (variable->type) {
673 case xbt_cfgelm_string:
674 xbt_cfg_set_string(cfg, name, val); /* throws */
678 i = strtol(val, &val, 0);
680 free(optionlist_cpy);
681 xbt_die("Value of option %s not valid. Should be an integer", name);
684 xbt_cfg_set_int(cfg, name, i); /* throws */
687 case xbt_cfgelm_double:
688 d = strtod(val, &val);
690 free(optionlist_cpy);
691 xbt_die("Value of option %s not valid. Should be a double", name);
694 xbt_cfg_set_double(cfg, name, d); /* throws */
697 case xbt_cfgelm_peer:
699 val = strchr(val, ':');
701 free(optionlist_cpy);
702 xbt_die("Value of option %s not valid. Should be an peer (machine:port)",
707 i = strtol(val, &val, 0);
709 free(optionlist_cpy);
710 xbt_die("Value of option %s not valid. Should be an peer (machine:port)",
714 xbt_cfg_set_peer(cfg, name, str, i); /* throws */
718 THROW1(unknown_error, 0, "Type of config element %s is not valid.",
723 free(optionlist_cpy);
727 free(optionlist_cpy);
731 /** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet
733 * This is useful to change the default value of a variable while allowing
734 * users to override it with command line arguments
736 void xbt_cfg_setdefault_int(xbt_cfg_t cfg, const char *name, int val)
738 xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_int);
740 if (variable->isdefault){
741 xbt_cfg_set_int(cfg, name, val);
742 variable->isdefault = 1;
746 ("Do not override configuration variable '%s' with value '%d' because it was already set.",
750 /** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet
752 * This is useful to change the default value of a variable while allowing
753 * users to override it with command line arguments
755 void xbt_cfg_setdefault_double(xbt_cfg_t cfg, const char *name, double val)
757 xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_double);
759 if (variable->isdefault) {
760 xbt_cfg_set_double(cfg, name, val);
761 variable->isdefault = 1;
765 ("Do not override configuration variable '%s' with value '%lf' because it was already set.",
769 /** @brief Set a string value to \a name within \a cfg if it wasn't changed yet
771 * This is useful to change the default value of a variable while allowing
772 * users to override it with command line arguments
774 void xbt_cfg_setdefault_string(xbt_cfg_t cfg, const char *name,
777 xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_string);
779 if (variable->isdefault){
780 xbt_cfg_set_string(cfg, name, val);
781 variable->isdefault = 1;
785 ("Do not override configuration variable '%s' with value '%s' because it was already set.",
789 /** @brief Set a peer value to \a name within \a cfg if it wasn't changed yet
791 * This is useful to change the default value of a variable while allowing
792 * users to override it with command line arguments
794 void xbt_cfg_setdefault_peer(xbt_cfg_t cfg, const char *name,
795 const char *host, int port)
797 xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_peer);
799 if (variable->isdefault){
800 xbt_cfg_set_peer(cfg, name, host, port);
801 variable->isdefault = 1;
805 ("Do not override configuration variable '%s' with value '%s:%d' because it was already set.",
809 /** @brief Set or add an integer value to \a name within \a cfg
811 * \arg cfg the config set
812 * \arg name the name of the variable
813 * \arg val the value of the variable
815 void xbt_cfg_set_int(xbt_cfg_t cfg, const char *name, int val)
817 xbt_cfgelm_t variable;
819 XBT_VERB("Configuration setting: %s=%d", name, val);
820 variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_int);
822 if (variable->max == 1) {
823 if (variable->cb_rm && xbt_dynar_length(variable->content))
824 (*variable->cb_rm) (name, 0);
826 xbt_dynar_set(variable->content, 0, &val);
829 && xbt_dynar_length(variable->content) ==
830 (unsigned long) variable->max)
831 THROW3(mismatch_error, 0,
832 "Cannot add value %d to the config element %s since it's already full (size=%d)",
833 val, name, variable->max);
835 xbt_dynar_push(variable->content, &val);
838 if (variable->cb_set)
839 (*variable->cb_set) (name, xbt_dynar_length(variable->content) - 1);
840 variable->isdefault = 0;
843 /** @brief Set or add a double value to \a name within \a cfg
845 * \arg cfg the config set
846 * \arg name the name of the variable
847 * \arg val the doule to set
850 void xbt_cfg_set_double(xbt_cfg_t cfg, const char *name, double val)
852 xbt_cfgelm_t variable;
854 XBT_VERB("Configuration setting: %s=%f", name, val);
855 variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_double);
857 if (variable->max == 1) {
858 if (variable->cb_rm && xbt_dynar_length(variable->content))
859 (*variable->cb_rm) (name, 0);
861 xbt_dynar_set(variable->content, 0, &val);
864 && xbt_dynar_length(variable->content) == variable->max)
865 THROW3(mismatch_error, 0,
866 "Cannot add value %f to the config element %s since it's already full (size=%d)",
867 val, name, variable->max);
869 xbt_dynar_push(variable->content, &val);
872 if (variable->cb_set)
873 (*variable->cb_set) (name, xbt_dynar_length(variable->content) - 1);
874 variable->isdefault = 0;
877 /** @brief Set or add a string value to \a name within \a cfg
879 * \arg cfg the config set
880 * \arg name the name of the variable
881 * \arg val the value to be added
885 void xbt_cfg_set_string(xbt_cfg_t cfg, const char *name, const char *val)
887 xbt_cfgelm_t variable;
888 char *newval = xbt_strdup(val);
890 XBT_VERB("Configuration setting: %s=%s", name, val);
891 variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_string);
892 XBT_DEBUG("Variable: %d to %d %s (=%d) @%p",
893 variable->min, variable->max,
894 xbt_cfgelm_type_name[variable->type], variable->type, variable);
896 if (variable->max == 1) {
897 if (xbt_dynar_length(variable->content)) {
899 (*variable->cb_rm) (name, 0);
900 else if (variable->type == xbt_cfgelm_string) {
901 char *sval = xbt_dynar_get_as(variable->content, 0, char *);
906 xbt_dynar_set(variable->content, 0, &newval);
909 && xbt_dynar_length(variable->content) == variable->max)
910 THROW3(mismatch_error, 0,
911 "Cannot add value %s to the config element %s since it's already full (size=%d)",
912 name, val, variable->max);
914 xbt_dynar_push(variable->content, &newval);
917 if (variable->cb_set)
918 (*variable->cb_set) (name, xbt_dynar_length(variable->content) - 1);
919 variable->isdefault = 0;
922 /** @brief Set or add an peer value to \a name within \a cfg
924 * \arg cfg the config set
925 * \arg name the name of the variable
927 * \arg port the port number
929 * \e peer values are composed of a string (peername) and an integer (port)
933 xbt_cfg_set_peer(xbt_cfg_t cfg, const char *name, const char *peer,
936 xbt_cfgelm_t variable;
937 xbt_peer_t val = xbt_peer_new(peer, port);
939 XBT_VERB("Configuration setting: %s=%s:%d", name, peer, port);
941 variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_peer);
943 if (variable->max == 1) {
944 if (variable->cb_rm && xbt_dynar_length(variable->content))
945 (*variable->cb_rm) (name, 0);
947 xbt_dynar_set(variable->content, 0, &val);
950 && xbt_dynar_length(variable->content) == variable->max)
951 THROW4(mismatch_error, 0,
952 "Cannot add value %s:%d to the config element %s since it's already full (size=%d)",
953 peer, port, name, variable->max);
955 xbt_dynar_push(variable->content, &val);
958 if (variable->cb_set)
959 (*variable->cb_set) (name, xbt_dynar_length(variable->content) - 1);
960 variable->isdefault = 0;
963 /* ---- [ Removing ] ---- */
965 /** @brief Remove the provided \e val integer value from a variable
967 * \arg cfg the config set
968 * \arg name the name of the variable
969 * \arg val the value to be removed
971 void xbt_cfg_rm_int(xbt_cfg_t cfg, const char *name, int val)
974 xbt_cfgelm_t variable;
978 variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_int);
980 if (xbt_dynar_length(variable->content) == variable->min)
981 THROW3(mismatch_error, 0,
982 "Cannot remove value %d from the config element %s since it's already at its minimal size (=%d)",
983 val, name, variable->min);
985 xbt_dynar_foreach(variable->content, cpt, seen) {
988 (*variable->cb_rm) (name, cpt);
989 xbt_dynar_cursor_rm(variable->content, &cpt);
994 THROW2(not_found_error, 0,
995 "Can't remove the value %d of config element %s: value not found.",
999 /** @brief Remove the provided \e val double value from a variable
1001 * \arg cfg the config set
1002 * \arg name the name of the variable
1003 * \arg val the value to be removed
1006 void xbt_cfg_rm_double(xbt_cfg_t cfg, const char *name, double val)
1008 xbt_cfgelm_t variable;
1012 variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_double);
1014 if (xbt_dynar_length(variable->content) == variable->min)
1015 THROW3(mismatch_error, 0,
1016 "Cannot remove value %f from the config element %s since it's already at its minimal size (=%d)",
1017 val, name, variable->min);
1019 xbt_dynar_foreach(variable->content, cpt, seen) {
1021 xbt_dynar_cursor_rm(variable->content, &cpt);
1022 if (variable->cb_rm)
1023 (*variable->cb_rm) (name, cpt);
1028 THROW2(not_found_error, 0,
1029 "Can't remove the value %f of config element %s: value not found.",
1033 /** @brief Remove the provided \e val string value from a variable
1035 * \arg cfg the config set
1036 * \arg name the name of the variable
1037 * \arg val the value of the string which will be removed
1039 void xbt_cfg_rm_string(xbt_cfg_t cfg, const char *name, const char *val)
1041 xbt_cfgelm_t variable;
1045 variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_string);
1047 if (xbt_dynar_length(variable->content) == variable->min)
1048 THROW3(mismatch_error, 0,
1049 "Cannot remove value %s from the config element %s since it's already at its minimal size (=%d)",
1050 name, val, variable->min);
1052 xbt_dynar_foreach(variable->content, cpt, seen) {
1053 if (!strcpy(seen, val)) {
1054 if (variable->cb_rm)
1055 (*variable->cb_rm) (name, cpt);
1056 xbt_dynar_cursor_rm(variable->content, &cpt);
1061 THROW2(not_found_error, 0,
1062 "Can't remove the value %s of config element %s: value not found.",
1066 /** @brief Remove the provided \e val peer value from a variable
1068 * \arg cfg the config set
1069 * \arg name the name of the variable
1070 * \arg peer the peername
1071 * \arg port the port number
1075 xbt_cfg_rm_peer(xbt_cfg_t cfg, const char *name, const char *peer,
1078 xbt_cfgelm_t variable;
1082 variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_peer);
1084 if (xbt_dynar_length(variable->content) == variable->min)
1085 THROW4(mismatch_error, 0,
1086 "Cannot remove value %s:%d from the config element %s since it's already at its minimal size (=%d)",
1087 peer, port, name, variable->min);
1089 xbt_dynar_foreach(variable->content, cpt, seen) {
1090 if (!strcpy(seen->name, peer) && seen->port == port) {
1091 if (variable->cb_rm)
1092 (*variable->cb_rm) (name, cpt);
1093 xbt_dynar_cursor_rm(variable->content, &cpt);
1098 THROW3(not_found_error, 0,
1099 "Can't remove the value %s:%d of config element %s: value not found.",
1103 /** @brief Remove the \e pos th value from the provided variable */
1105 void xbt_cfg_rm_at(xbt_cfg_t cfg, const char *name, int pos)
1108 xbt_cfgelm_t variable;
1110 variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_any);
1112 if (xbt_dynar_length(variable->content) == variable->min)
1113 THROW3(mismatch_error, 0,
1114 "Cannot remove %dth value from the config element %s since it's already at its minimal size (=%d)",
1115 pos, name, variable->min);
1117 if (variable->cb_rm)
1118 (*variable->cb_rm) (name, pos);
1119 xbt_dynar_remove_at(variable->content, pos, NULL);
1122 /** @brief Remove all the values from a variable
1124 * \arg cfg the config set
1125 * \arg name the name of the variable
1128 void xbt_cfg_empty(xbt_cfg_t cfg, const char *name)
1130 xbt_cfgelm_t variable = NULL;
1134 variable = xbt_dict_get((xbt_dict_t) cfg, name);
1136 if (e.category != not_found_error)
1140 THROW1(not_found_error, 0,
1141 "Can't empty '%s' since this config element does not exist",
1146 if (variable->cb_rm) {
1149 xbt_dynar_foreach(variable->content, cpt, ignored) {
1150 (*variable->cb_rm) (name, cpt);
1153 xbt_dynar_reset(variable->content);
1157 * Say if the value is the default value
1159 int xbt_cfg_is_default_value(xbt_cfg_t cfg, const char *name)
1161 xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_any);
1162 return variable->isdefault;
1165 /*----[ Getting ]---------------------------------------------------------*/
1167 /** @brief Retrieve an integer value of a variable (get a warning if not uniq)
1169 * \arg cfg the config set
1170 * \arg name the name of the variable
1171 * \arg val the wanted value
1173 * Returns the first value from the config set under the given name.
1174 * If there is more than one value, it will issue a warning. Consider using
1175 * xbt_cfg_get_dynar() instead.
1177 * \warning the returned value is the actual content of the config set
1179 int xbt_cfg_get_int(xbt_cfg_t cfg, const char *name)
1181 xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_int);
1183 if (xbt_dynar_length(variable->content) > 1) {
1185 ("You asked for the first value of the config element '%s', but there is %lu values",
1186 name, xbt_dynar_length(variable->content));
1189 return xbt_dynar_get_as(variable->content, 0, int);
1192 /** @brief Retrieve a double value of a variable (get a warning if not uniq)
1194 * \arg cfg the config set
1195 * \arg name the name of the variable
1196 * \arg val the wanted value
1198 * Returns the first value from the config set under the given name.
1199 * If there is more than one value, it will issue a warning. Consider using
1200 * xbt_cfg_get_dynar() instead.
1202 * \warning the returned value is the actual content of the config set
1205 double xbt_cfg_get_double(xbt_cfg_t cfg, const char *name)
1207 xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_double);
1209 if (xbt_dynar_length(variable->content) > 1) {
1211 ("You asked for the first value of the config element '%s', but there is %lu values\n",
1212 name, xbt_dynar_length(variable->content));
1215 return xbt_dynar_get_as(variable->content, 0, double);
1218 /** @brief Retrieve a string value of a variable (get a warning if not uniq)
1220 * \arg th the config set
1221 * \arg name the name of the variable
1222 * \arg val the wanted value
1224 * Returns the first value from the config set under the given name.
1225 * If there is more than one value, it will issue a warning. Consider using
1226 * xbt_cfg_get_dynar() instead. Returns NULL if there is no value.
1228 * \warning the returned value is the actual content of the config set
1231 char *xbt_cfg_get_string(xbt_cfg_t cfg, const char *name)
1233 xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_string);
1235 if (xbt_dynar_length(variable->content) > 1) {
1237 ("You asked for the first value of the config element '%s', but there is %lu values\n",
1238 name, xbt_dynar_length(variable->content));
1239 } else if (xbt_dynar_length(variable->content) == 0) {
1243 return xbt_dynar_get_as(variable->content, 0, char *);
1246 /** @brief Retrieve an peer value of a variable (get a warning if not uniq)
1248 * \arg cfg the config set
1249 * \arg name the name of the variable
1250 * \arg peer the peer
1251 * \arg port the port number
1253 * Returns the first value from the config set under the given name.
1254 * If there is more than one value, it will issue a warning. Consider using
1255 * xbt_cfg_get_dynar() instead.
1257 * \warning the returned value is the actual content of the config set
1260 void xbt_cfg_get_peer(xbt_cfg_t cfg, const char *name, char **peer,
1263 xbt_cfgelm_t variable;
1266 variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_peer);
1268 if (xbt_dynar_length(variable->content) > 1) {
1270 ("You asked for the first value of the config element '%s', but there is %lu values\n",
1271 name, xbt_dynar_length(variable->content));
1274 val = xbt_dynar_get_as(variable->content, 0, xbt_peer_t);
1279 /** @brief Retrieve the dynar of all the values stored in a variable
1281 * \arg cfg where to search in
1282 * \arg name what to search for
1285 * Get the data stored in the config set.
1287 * \warning the returned value is the actual content of the config set
1289 xbt_dynar_t xbt_cfg_get_dynar(xbt_cfg_t cfg, const char *name)
1291 xbt_cfgelm_t variable = NULL;
1295 variable = xbt_dict_get((xbt_dict_t) cfg, name);
1297 if (e.category == not_found_error) {
1299 THROW1(not_found_error, 0,
1300 "No registered variable %s in this config set", name);
1305 return variable->content;
1309 /** @brief Retrieve one of the integer value of a variable */
1310 int xbt_cfg_get_int_at(xbt_cfg_t cfg, const char *name, int pos)
1313 xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_int);
1314 return xbt_dynar_get_as(variable->content, pos, int);
1317 /** @brief Retrieve one of the double value of a variable */
1318 double xbt_cfg_get_double_at(xbt_cfg_t cfg, const char *name, int pos)
1321 xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_double);
1322 return xbt_dynar_get_as(variable->content, pos, double);
1326 /** @brief Retrieve one of the string value of a variable */
1327 char *xbt_cfg_get_string_at(xbt_cfg_t cfg, const char *name, int pos)
1330 xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_string);
1331 return xbt_dynar_get_as(variable->content, pos, char *);
1334 /** @brief Retrieve one of the peer value of a variable */
1336 xbt_cfg_get_peer_at(xbt_cfg_t cfg, const char *name, int pos,
1337 char **peer, int *port)
1340 xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_int);
1341 xbt_peer_t val = xbt_dynar_get_ptr(variable->content, pos);
1352 XBT_LOG_EXTERNAL_CATEGORY(xbt_cfg);
1353 XBT_LOG_DEFAULT_CATEGORY(xbt_cfg);
1355 XBT_TEST_SUITE("config", "Configuration support");
1357 static xbt_cfg_t make_set()
1359 xbt_cfg_t set = NULL;
1361 xbt_log_threshold_set(&_XBT_LOGV(xbt_cfg), xbt_log_priority_critical);
1362 xbt_cfg_register_str(&set, "speed:1_to_2_int");
1363 xbt_cfg_register_str(&set, "peername:1_to_1_string");
1364 xbt_cfg_register_str(&set, "user:1_to_10_string");
1367 } /* end_of_make_set */
1369 XBT_TEST_UNIT("memuse", test_config_memuse, "Alloc and free a config set")
1371 xbt_cfg_t set = make_set();
1372 xbt_test_add("Alloc and free a config set");
1373 xbt_cfg_set_parse(set,
1374 "peername:veloce user:mquinson\nuser:oaumage\tuser:alegrand");
1379 XBT_TEST_UNIT("validation", test_config_validation, "Validation tests")
1381 xbt_cfg_t set = set = make_set();
1384 xbt_test_add("Having too few elements for speed");
1385 xbt_cfg_set_parse(set,
1386 "peername:veloce user:mquinson\nuser:oaumage\tuser:alegrand");
1391 if (e.category != mismatch_error ||
1392 strncmp(e.msg, "Config elem speed needs",
1393 strlen("Config elem speed needs")))
1394 xbt_test_fail("Got an exception. msg=%s", e.msg);
1402 xbt_test_add("Having too much values of 'speed'");
1404 xbt_cfg_set_parse(set, "peername:toto:42 user:alegrand");
1406 xbt_cfg_set_parse(set, "speed:42 speed:24 speed:34");
1409 if (e.category != mismatch_error ||
1410 strncmp(e.msg, "Cannot add value 34 to the config elem speed",
1411 strlen("Config elem speed needs")))
1412 xbt_test_fail("Got an exception. msg=%s", e.msg);
1421 XBT_TEST_UNIT("use", test_config_use, "Data retrieving tests")
1424 xbt_test_add("Get a single value");
1426 /* get_single_value */
1428 xbt_cfg_t myset = make_set();
1430 xbt_cfg_set_parse(myset, "peername:toto:42 speed:42");
1431 ival = xbt_cfg_get_int(myset, "speed");
1433 xbt_test_fail("Speed value = %d, I expected 42", ival);
1434 xbt_cfg_free(&myset);
1437 xbt_test_add("Get multiple values");
1439 /* get_multiple_value */
1441 xbt_cfg_t myset = make_set();
1443 xbt_cfg_set_parse(myset,
1444 "peername:veloce user:foo\nuser:bar\tuser:toto");
1445 xbt_cfg_set_parse(myset, "speed:42");
1446 xbt_cfg_check(myset);
1447 dyn = xbt_cfg_get_dynar(myset, "user");
1449 if (xbt_dynar_length(dyn) != 3)
1450 xbt_test_fail("Dynar length = %lu, I expected 3",
1451 xbt_dynar_length(dyn));
1453 if (strcmp(xbt_dynar_get_as(dyn, 0, char *), "foo"))
1454 xbt_test_fail("Dynar[0] = %s, I expected foo",
1455 xbt_dynar_get_as(dyn, 0, char *));
1457 if (strcmp(xbt_dynar_get_as(dyn, 1, char *), "bar"))
1458 xbt_test_fail("Dynar[1] = %s, I expected bar",
1459 xbt_dynar_get_as(dyn, 1, char *));
1461 if (strcmp(xbt_dynar_get_as(dyn, 2, char *), "toto"))
1462 xbt_test_fail("Dynar[2] = %s, I expected toto",
1463 xbt_dynar_get_as(dyn, 2, char *));
1464 xbt_cfg_free(&myset);
1467 xbt_test_add("Access to a non-existant entry");
1469 /* non-existant_entry */
1470 xbt_cfg_t myset = make_set();
1474 xbt_cfg_set_parse(myset, "color:blue");
1476 if (e.category != not_found_error)
1477 xbt_test_exception(e);
1480 xbt_cfg_free(&myset);
1483 #endif /* SIMGRID_TEST */