X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/c1196ca10d1165bfaadfd66799bff4e0eec459b5..24827726d5bea684114f0b6706ecb9ed0f4ff453:/src/xbt/config.c diff --git a/src/xbt/config.c b/src/xbt/config.c index b0e9ef81d6..a89b62f855 100644 --- a/src/xbt/config.c +++ b/src/xbt/config.c @@ -2,20 +2,20 @@ /* This is useful to build named structs, like option or property sets. */ -/* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team. +/* Copyright (c) 2004-2014. The SimGrid Team. * All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ -#include #include "xbt/misc.h" #include "xbt/sysdep.h" #include "xbt/log.h" #include "xbt/ex.h" #include "xbt/dynar.h" #include "xbt/dict.h" -#include "xbt/peer.h" + +#include #include "xbt/config.h" /* prototypes of this module */ @@ -33,19 +33,27 @@ typedef struct { /* Allowed type of the variable */ e_xbt_cfgelm_type_t type; int min, max; - int isdefault:1; + unsigned isdefault:1; /* Callbacks */ xbt_cfg_cb_t cb_set; xbt_cfg_cb_t cb_rm; /* actual content - (cannot be an union because type peer uses both str and i) */ + (cannot be an union because type peer used to use both str and i, but it could be converted now) */ xbt_dynar_t content; } s_xbt_cfgelm_t, *xbt_cfgelm_t; static const char *xbt_cfgelm_type_name[xbt_cfgelm_type_count] = - { "int", "double", "string", "peer", "any" }; + { "int", "double", "string", "boolean", "any" }; + +const struct xbt_boolean_couple xbt_cfgelm_boolean_values[] = { + { "yes", "no"}, + { "on", "off"}, + {"true", "false"}, + { "1", "0"}, + { NULL, NULL} +}; /* Internal stuff used in cache to free a variable */ static void xbt_cfgelm_free(void *data); @@ -58,19 +66,19 @@ static xbt_cfgelm_t xbt_cfgelm_get(xbt_cfg_t cfg, const char *name, /** @brief Constructor * - * Initialise an config set + * Initialise a config set */ xbt_cfg_t xbt_cfg_new(void) { - return (xbt_cfg_t) xbt_dict_new(); + return (xbt_cfg_t) xbt_dict_new_homogeneous(&xbt_cfgelm_free); } /** \brief Copy an existing configuration set * - * \arg whereto the config set to be created - * \arg tocopy the source data + * @param whereto the config set to be created + * @param tocopy the source data * * This only copy the registrations, not the actual content */ @@ -86,7 +94,7 @@ void xbt_cfg_cpy(xbt_cfg_t tocopy, xbt_cfg_t * whereto) xbt_assert(tocopy, "cannot copy NULL config"); xbt_dict_foreach((xbt_dict_t) tocopy, cursor, name, variable) { - xbt_cfg_register(whereto, name, variable->desc, variable->type, NULL, + xbt_cfg_register(whereto, name, variable->desc, variable->type, variable->min, variable->max, variable->cb_set, variable->cb_rm); } @@ -101,9 +109,9 @@ void xbt_cfg_free(xbt_cfg_t * cfg) /** @brief Dump a config set for debuging purpose * - * \arg name The name to give to this config set - * \arg indent what to write at the begining of each line (right number of spaces) - * \arg cfg the config set + * @param name The name to give to this config set + * @param indent what to write at the begining of each line (right number of spaces) + * @param cfg the config set */ void xbt_cfg_dump(const char *name, const char *indent, xbt_cfg_t cfg) { @@ -116,12 +124,11 @@ void xbt_cfg_dump(const char *name, const char *indent, xbt_cfg_t cfg) int ival; char *sval; double dval; - xbt_peer_t hval; if (name) printf("%s>> Dumping of the config set '%s':\n", indent, name); - xbt_dict_foreach(dict, cursor, key, variable) { + xbt_dict_foreach(dict, cursor, key, variable) { printf("%s %s:", indent, key); size = xbt_dynar_length(variable->content); @@ -154,15 +161,20 @@ void xbt_cfg_dump(const char *name, const char *indent, xbt_cfg_t cfg) } break; - case xbt_cfgelm_peer: + case xbt_cfgelm_boolean: for (i = 0; i < size; i++) { - hval = xbt_dynar_get_as(variable->content, i, xbt_peer_t); - printf("%s %s:%d\n", indent, hval->name, hval->port); + ival = xbt_dynar_get_as(variable->content, i, int); + printf("%s %d\n", indent, ival); } break; + case xbt_cfgelm_alias: + /* no content */ + break; + default: printf("%s Invalid type!!\n", indent); + break; } } @@ -172,7 +184,6 @@ void xbt_cfg_dump(const char *name, const char *indent, xbt_cfg_t cfg) fflush(stdout); xbt_dict_cursor_free(&cursor); - return; } /* @@ -187,7 +198,8 @@ void xbt_cfgelm_free(void *data) if (!c) return; xbt_free(c->desc); - xbt_dynar_free(&(c->content)); + if (c->type != xbt_cfgelm_alias) + xbt_dynar_free(&(c->content)); free(c); } @@ -195,36 +207,34 @@ void xbt_cfgelm_free(void *data) /** @brief Register an element within a config set * - * @arg cfg the config set - * @arg type the type of the config element - * @arg min the minimum - * @arg max the maximum + * @param cfg the config set + * @param name the name of the config element + * @param desc a description for this item (used by xbt_cfg_help()) + * @param type the type of the config element + * @param min the minimum number of values for this config element + * @param max the maximum number of values for this config element + * @param cb_set callback function called when a value is set + * @param cb_rm callback function called when a value is removed */ -void -xbt_cfg_register(xbt_cfg_t * cfg, +void xbt_cfg_register(xbt_cfg_t * cfg, const char *name, const char *desc, - e_xbt_cfgelm_type_t type, void *default_value, int min, + e_xbt_cfgelm_type_t type, int min, int max, xbt_cfg_cb_t cb_set, xbt_cfg_cb_t cb_rm) { xbt_cfgelm_t res; if (*cfg == NULL) *cfg = xbt_cfg_new(); - xbt_assert(type >= xbt_cfgelm_int && type <= xbt_cfgelm_peer, + xbt_assert(type >= xbt_cfgelm_int && type <= xbt_cfgelm_boolean, "type of %s not valid (%d should be between %d and %d)", - name, type, xbt_cfgelm_int, xbt_cfgelm_peer); + name, (int)type, xbt_cfgelm_int, xbt_cfgelm_boolean); res = xbt_dict_get_or_null((xbt_dict_t) * cfg, name); - - if (res) { - XBT_WARN("Config elem %s registered twice.", name); - /* Will be removed by the insertion of the new one */ - } + xbt_assert(NULL == res, "Refusing to register the config element '%s' twice.", name); res = xbt_new(s_xbt_cfgelm_t, 1); XBT_DEBUG("Register cfg elm %s (%s) (%d to %d %s (=%d) @%p in set %p)", - name, desc, min, max, xbt_cfgelm_type_name[type], type, res, - *cfg); + name, desc, min, max, xbt_cfgelm_type_name[type], (int)type, res, *cfg); res->desc = xbt_strdup(desc); res->type = type; @@ -237,39 +247,55 @@ xbt_cfg_register(xbt_cfg_t * cfg, switch (type) { case xbt_cfgelm_int: res->content = xbt_dynar_new(sizeof(int), NULL); - if (default_value) - xbt_dynar_push(res->content, default_value); break; case xbt_cfgelm_double: res->content = xbt_dynar_new(sizeof(double), NULL); - if (default_value) - xbt_dynar_push(res->content, default_value); break; case xbt_cfgelm_string: res->content = xbt_dynar_new(sizeof(char *), xbt_free_ref); - if (default_value) - xbt_dynar_push(res->content, default_value); break; - case xbt_cfgelm_peer: - res->content = xbt_dynar_new(sizeof(xbt_peer_t), xbt_peer_free_voidp); - if (default_value) - xbt_dynar_push(res->content, default_value); + case xbt_cfgelm_boolean: + res->content = xbt_dynar_new(sizeof(int), NULL); break; default: - XBT_ERROR("%d is an invalide type code", type); + XBT_ERROR("%d is an invalid type code", (int)type); + break; } - xbt_dict_set((xbt_dict_t) * cfg, name, res, &xbt_cfgelm_free); + xbt_dict_set((xbt_dict_t) * cfg, name, res, NULL); } +void xbt_cfg_register_alias(xbt_cfg_t * cfg, const char *newname, const char *oldname) +{ + if (*cfg == NULL) + *cfg = xbt_cfg_new(); + + xbt_cfgelm_t res = xbt_dict_get_or_null((xbt_dict_t) * cfg, oldname); + xbt_assert(NULL == res, "Refusing to register the option '%s' twice.", oldname); + + res = xbt_dict_get_or_null((xbt_dict_t) * cfg, newname); + xbt_assert(res, "Cannot define an alias to the non-existing option '%s'.", newname); + + res = xbt_new0(s_xbt_cfgelm_t, 1); + XBT_DEBUG("Register cfg alias %s -> %s in set %p)",oldname,newname, *cfg); + + res->desc = bprintf("Deprecated alias for %s",newname); + res->type = xbt_cfgelm_alias; + res->min = 1; + res->max = 1; + res->isdefault = 1; + res->content = (xbt_dynar_t)newname; + + xbt_dict_set((xbt_dict_t) * cfg, oldname, res, NULL); +} /** @brief Unregister an element from a config set. * - * @arg cfg the config set - * @arg name the name of the elem to be freed + * @param cfg the config set + * @param name the name of the element to be freed * * Note that it removes both the description and the actual content. * Throws not_found when no such element exists. @@ -284,14 +310,14 @@ void xbt_cfg_unregister(xbt_cfg_t cfg, const char *name) /** * @brief Parse a string and register the stuff described. * - * @arg cfg the config set - * @arg entry a string describing the element to register + * @param cfg the config set + * @param entry a string describing the element to register * * The string may consist in several variable descriptions separated by a space. * Each of them must use the following syntax: \:\_to_\_\ - * with type being one of 'string','int', 'peer' or 'double'. + * with type being one of 'string','int' or 'double'. * - * FIXME: this does not allow to set the description + * Note that this does not allow to set the description, so you should prefer the other interface */ void xbt_cfg_register_str(xbt_cfg_t * cfg, const char *entry) @@ -326,23 +352,38 @@ void xbt_cfg_register_str(xbt_cfg_t * cfg, const char *entry) "; Should be :_to__"); tok++; - for (type = 0; + for (type = (e_xbt_cfgelm_type_t)0; type < xbt_cfgelm_type_count && strcmp(tok, xbt_cfgelm_type_name[type]); type++); xbt_assert(type < xbt_cfgelm_type_count, "Invalid type in config element descriptor: %s%s", entry, - "; Should be one of 'string', 'int', 'peer' or 'double'."); + "; Should be one of 'string', 'int' or 'double'."); - xbt_cfg_register(cfg, entrycpy, NULL, type, NULL, min, max, NULL, NULL); + xbt_cfg_register(cfg, entrycpy, NULL, type, min, max, NULL, NULL); free(entrycpy); /* strdup'ed by dict mechanism, but cannot be const */ } -static int strcmp_voidp(const void *pa, const void *pb) +/** @brief Displays the declared aliases and their description */ +void xbt_cfg_aliases(xbt_cfg_t cfg) { - return strcmp(*(const char **)pa, *(const char **)pb); -} + xbt_dict_cursor_t dict_cursor; + unsigned int dynar_cursor; + xbt_cfgelm_t variable; + char *name; + xbt_dynar_t names = xbt_dynar_new(sizeof(char *), NULL); + xbt_dict_foreach((xbt_dict_t )cfg, dict_cursor, name, variable) + xbt_dynar_push(names, &name); + xbt_dynar_sort_strings(names); + + xbt_dynar_foreach(names, dynar_cursor, name) { + variable = xbt_dict_get((xbt_dict_t )cfg, name); + + if (variable->type == xbt_cfgelm_alias) + printf(" %s: %s\n", name, variable->desc); + } +} /** @brief Displays the declared options and their description */ void xbt_cfg_help(xbt_cfg_t cfg) { @@ -352,66 +393,62 @@ void xbt_cfg_help(xbt_cfg_t cfg) char *name; xbt_dynar_t names = xbt_dynar_new(sizeof(char *), NULL); - xbt_dict_foreach((xbt_dict_t )cfg, dict_cursor, name, variable) { + xbt_dict_foreach((xbt_dict_t )cfg, dict_cursor, name, variable) xbt_dynar_push(names, &name); - } - xbt_dynar_sort(names, strcmp_voidp); + xbt_dynar_sort_strings(names); xbt_dynar_foreach(names, dynar_cursor, name) { int i; int size; variable = xbt_dict_get((xbt_dict_t )cfg, name); + if (variable->type == xbt_cfgelm_alias) + continue; printf(" %s: %s\n", name, variable->desc); printf(" Type: %s; ", xbt_cfgelm_type_name[variable->type]); if (variable->min != 1 || variable->max != 1) { - if (variable->min == 0 && variable->max == 0) - printf("Arity: no bound; "); + printf("Arity: min:%d to max:", variable->min); + if (variable->max == 0) + printf("(no bound); "); else - printf("Arity: min:%d to max:%d; ", variable->min, variable->max); + printf("%d; ", variable->max); } - printf("Current value: "); size = xbt_dynar_length(variable->content); + printf("Current value%s: ", (size <= 1 ? "" : "s")); - switch (variable->type) { - int ival; - char *sval; - double dval; - xbt_peer_t hval; + if (size != 1) + printf(size == 0 ? "n/a\n" : "{ "); + for (i = 0; i < size; i++) { + const char *sep = (size == 1 ? "\n" : (i < size - 1 ? ", " : " }\n")); - case xbt_cfgelm_int: - for (i = 0; i < size; i++) { - ival = xbt_dynar_get_as(variable->content, i, int); - printf("%s%d\n", (i == 0 ? "" : " "), ival); - } - break; + switch (variable->type) { + case xbt_cfgelm_int: + printf("%d%s", xbt_dynar_get_as(variable->content, i, int), sep); + break; - case xbt_cfgelm_double: - for (i = 0; i < size; i++) { - dval = xbt_dynar_get_as(variable->content, i, double); - printf("%s%f\n", (i == 0 ? "" : " "), dval); - } - break; + case xbt_cfgelm_double: + printf("%f%s", xbt_dynar_get_as(variable->content, i, double), sep); + break; - case xbt_cfgelm_string: - for (i = 0; i < size; i++) { - sval = xbt_dynar_get_as(variable->content, i, char *); - printf("%s'%s'\n", (i == 0 ? "" : " "), sval); - } - break; + case xbt_cfgelm_string: + printf("'%s'%s", xbt_dynar_get_as(variable->content, i, char *), sep); + break; - case xbt_cfgelm_peer: - for (i = 0; i < size; i++) { - hval = xbt_dynar_get_as(variable->content, i, xbt_peer_t); - printf("%s%s:%d\n", (i == 0 ? "" : " "), hval->name, - hval->port); + case xbt_cfgelm_boolean: { + int b = xbt_dynar_get_as(variable->content, i, int); + const char *bs = b ? xbt_cfgelm_boolean_values[0].true_val + : xbt_cfgelm_boolean_values[0].false_val; + if (b == 0 || b == 1) + printf("'%s'%s", bs, sep); + else + printf("'%s/%d'%s", bs, b, sep); + break; } - break; - default: - printf("Invalid type!!\n"); + default: + printf("Invalid type!!%s", sep); + } } - } xbt_dynar_free(&names); @@ -429,6 +466,9 @@ void xbt_cfg_check(xbt_cfg_t cfg) XBT_DEBUG("Check cfg set %p", cfg); xbt_dict_foreach((xbt_dict_t) cfg, cursor, name, variable) { + if (variable->type == xbt_cfgelm_alias) + continue; + size = xbt_dynar_length(variable->content); if (variable->min > size) { xbt_dict_cursor_free(&cursor); @@ -438,6 +478,13 @@ void xbt_cfg_check(xbt_cfg_t cfg) size); } + if (variable->isdefault && size > variable->min) { + xbt_dict_cursor_free(&cursor); + THROWF(mismatch_error, 0, + "Config elem %s theoretically accepts %d %s, but has a default of %d values.", + name, variable->min, xbt_cfgelm_type_name[variable->type], size); + } + if (variable->max > 0 && variable->max < size) { xbt_dict_cursor_free(&cursor); THROWF(mismatch_error, 0, @@ -450,17 +497,21 @@ void xbt_cfg_check(xbt_cfg_t cfg) xbt_dict_cursor_free(&cursor); } -static xbt_cfgelm_t xbt_cfgelm_get(xbt_cfg_t cfg, - const char *name, - e_xbt_cfgelm_type_t type) +static xbt_cfgelm_t xbt_cfgelm_get(xbt_cfg_t cfg, const char *name, e_xbt_cfgelm_type_t type) { - xbt_cfgelm_t res = NULL; + xbt_cfgelm_t res = xbt_dict_get_or_null((xbt_dict_t) cfg, name); + + // The user used the old name. Switch to the new one after a short warning + while (res && res->type == xbt_cfgelm_alias) { + const char* newname = (const char *)res->content; + XBT_INFO("Option %s has been renamed to %s. Consider switching.", name, newname); + res = xbt_cfgelm_get(cfg, newname, type); + } - res = xbt_dict_get_or_null((xbt_dict_t) cfg, name); if (!res) { xbt_cfg_help(cfg); - THROWF(not_found_error, 0, - "No registered variable '%s' in this config set", name); + fflush(stdout); + THROWF(not_found_error, 0, "No registered variable '%s' in this config set.", name); } xbt_assert(type == xbt_cfgelm_any || res->type == type, @@ -473,10 +524,10 @@ static xbt_cfgelm_t xbt_cfgelm_get(xbt_cfg_t cfg, /** @brief Get the type of this variable in that configuration set * - * \arg cfg the config set - * \arg name the name of the element - * \arg type the result + * @param cfg the config set + * @param name the name of the element * + * @return the type of the given element */ e_xbt_cfgelm_type_t xbt_cfg_get_type(xbt_cfg_t cfg, const char *name) @@ -490,7 +541,7 @@ e_xbt_cfgelm_type_t xbt_cfg_get_type(xbt_cfg_t cfg, const char *name) "Can't get the type of '%s' since this variable does not exist", name); - XBT_INFO("type in variable = %d", variable->type); + XBT_DEBUG("type in variable = %d", (int)variable->type); return variable->type; } @@ -498,9 +549,9 @@ e_xbt_cfgelm_type_t xbt_cfg_get_type(xbt_cfg_t cfg, const char *name) /*----[ Setting ]---------------------------------------------------------*/ /** @brief va_args version of xbt_cfg_set * - * \arg cfg config set to fill - * \arg n variable name - * \arg pa variable value + * @param cfg config set to fill + * @param name variable name + * @param pa variable value * * Add some values to the config set. */ @@ -509,13 +560,14 @@ void xbt_cfg_set_vargs(xbt_cfg_t cfg, const char *name, va_list pa) char *str; int i; double d; - e_xbt_cfgelm_type_t type = 0; /* Set a dummy value to make gcc happy. It cannot get uninitialized */ + e_xbt_cfgelm_type_t type = xbt_cfgelm_any; /* Set a dummy value to make gcc happy. It cannot get uninitialized */ xbt_ex_t e; TRY { type = xbt_cfg_get_type(cfg, name); - } CATCH(e) { + } + CATCH(e) { if (e.category == not_found_error) { xbt_ex_free(e); THROWF(not_found_error, 0, @@ -526,12 +578,6 @@ void xbt_cfg_set_vargs(xbt_cfg_t cfg, const char *name, va_list pa) } switch (type) { - case xbt_cfgelm_peer: - str = va_arg(pa, char *); - i = va_arg(pa, int); - xbt_cfg_set_peer(cfg, name, str, i); - break; - case xbt_cfgelm_string: str = va_arg(pa, char *); xbt_cfg_set_string(cfg, name, str); @@ -547,16 +593,21 @@ void xbt_cfg_set_vargs(xbt_cfg_t cfg, const char *name, va_list pa) xbt_cfg_set_double(cfg, name, d); break; + case xbt_cfgelm_boolean: + str = va_arg(pa, char *); + xbt_cfg_set_boolean(cfg, name, str); + break; + default: - xbt_die("Config element variable %s not valid (type=%d)", name, type); + xbt_die("Config element variable %s not valid (type=%d)", name, (int)type); } } /** @brief Add a NULL-terminated list of pairs {(char*)key, value} to the set * - * \arg cfg config set to fill - * \arg name variable name - * \arg varargs variable value + * @param cfg config set to fill + * @param name variable name + * @param ... variable value * */ void xbt_cfg_set(xbt_cfg_t cfg, const char *name, ...) @@ -570,8 +621,8 @@ void xbt_cfg_set(xbt_cfg_t cfg, const char *name, ...) /** @brief Add values parsed from a string into a config set * - * \arg cfg config set to fill - * \arg options a string containing the content to add to the config set. This + * @param cfg config set to fill + * @param options a string containing the content to add to the config set. This * is a '\\t',' ' or '\\n' or ',' separated list of variables. Each individual variable is * like "[name]:[value]" where [name] is the name of an already registred * variable, and [value] conforms to the data type under which this variable was @@ -580,21 +631,14 @@ void xbt_cfg_set(xbt_cfg_t cfg, const char *name, ...) * @todo This is a crude manual parser, it should be a proper lexer. */ -void xbt_cfg_set_parse(xbt_cfg_t cfg, const char *options) -{ - xbt_ex_t e; - - int i; - double d; - char *str; +void xbt_cfg_set_parse(xbt_cfg_t cfg, const char *options) { - xbt_cfgelm_t variable = NULL; char *optionlist_cpy; char *option, *name, *val; int len; - XBT_IN(""); + XBT_IN(); if (!options || !strlen(options)) { /* nothing to do */ return; } @@ -644,88 +688,95 @@ void xbt_cfg_set_parse(xbt_cfg_t cfg, const char *options) val = strchr(name, ':'); if (!val) { - free(optionlist_cpy); - xbt_die("Option '%s' badly formated. Should be of the form 'name:value'", + /* don't free(optionlist_cpy) here, 'name' points inside it */ + xbt_die("Option '%s' badly formatted. Should be of the form 'name:value'", name); } *(val++) = '\0'; - if (strncmp(name, "contexts/", strlen("contexts/"))) + if (strncmp(name, "contexts/", strlen("contexts/")) && strncmp(name, "path", strlen("path"))) XBT_INFO("Configuration change: Set '%s' to '%s'", name, val); TRY { - variable = xbt_dict_get((xbt_dict_t) cfg, name); - } - CATCH(e) { - if (e.category == not_found_error) { - xbt_ex_free(e); - name = xbt_strdup(name); - free(optionlist_cpy); - THROWF(not_found_error, 0, - "No registered variable corresponding to '%s'.", name); - } + xbt_cfg_set_as_string(cfg,name,val); + } CATCH_ANONYMOUS { free(optionlist_cpy); RETHROW; } + } + free(optionlist_cpy); +} - TRY { - switch (variable->type) { - case xbt_cfgelm_string: - xbt_cfg_set_string(cfg, name, val); /* throws */ - break; - - case xbt_cfgelm_int: - i = strtol(val, &val, 0); - if (val == NULL) { - free(optionlist_cpy); - xbt_die("Value of option %s not valid. Should be an integer", name); - } +/** @brief Set the value of a variable, using the string representation of that value + * + * @param cfg config set to modify + * @param key name of the variable to modify + * @param value string representation of the value to set + * + * @return the first char after the parsed value in val + */ - xbt_cfg_set_int(cfg, name, i); /* throws */ - break; +void *xbt_cfg_set_as_string(xbt_cfg_t cfg, const char *key, const char *value) { + xbt_ex_t e; - case xbt_cfgelm_double: - d = strtod(val, &val); - if (val == NULL) { - free(optionlist_cpy); - xbt_die("Value of option %s not valid. Should be a double", name); - } + char *ret; + volatile xbt_cfgelm_t variable = NULL; + int i; + double d; - xbt_cfg_set_double(cfg, name, d); /* throws */ - break; + TRY { + while (variable == NULL) { + variable = xbt_dict_get((xbt_dict_t) cfg, key); + while (variable->type == xbt_cfgelm_alias) { + const char *newname = (const char*)variable->content; + XBT_INFO("Note: configuration '%s' is deprecated. Please use '%s' instead.", key, newname); + key = newname; + variable = NULL; + } + } + } + CATCH(e) { + if (e.category == not_found_error) { + xbt_ex_free(e); + THROWF(not_found_error, 0, "No registered variable corresponding to '%s'.", key); + } + RETHROW; + } - case xbt_cfgelm_peer: - str = val; - val = strchr(val, ':'); - if (!val) { - free(optionlist_cpy); - xbt_die("Value of option %s not valid. Should be an peer (machine:port)", - name); - } - - *(val++) = '\0'; - i = strtol(val, &val, 0); - if (val == NULL) { - free(optionlist_cpy); - xbt_die("Value of option %s not valid. Should be an peer (machine:port)", - name); - } - - xbt_cfg_set_peer(cfg, name, str, i); /* throws */ - break; + switch (variable->type) { + case xbt_cfgelm_string: + xbt_cfg_set_string(cfg, key, value); /* throws */ + break; - default: - THROWF(unknown_error, 0, "Type of config element %s is not valid.", - name); - } + case xbt_cfgelm_int: + i = strtol(value, &ret, 0); + if (ret == value) { + xbt_die("Value of option %s not valid. Should be an integer", key); } - CATCH_ANONYMOUS { - free(optionlist_cpy); - RETHROW; + + xbt_cfg_set_int(cfg, key, i); /* throws */ + break; + + case xbt_cfgelm_double: + d = strtod(value, &ret); + if (ret == value) { + xbt_die("Value of option %s not valid. Should be a double", key); } + + xbt_cfg_set_double(cfg, key, d); /* throws */ + break; + + case xbt_cfgelm_boolean: + xbt_cfg_set_boolean(cfg, key, value); /* throws */ + ret = (char *)value + strlen(value); + break; + + default: + THROWF(unknown_error, 0, "Type of config element %s is not valid.", key); + break; } - free(optionlist_cpy); + return ret; } /** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet @@ -762,7 +813,7 @@ void xbt_cfg_setdefault_double(xbt_cfg_t cfg, const char *name, double val) } else XBT_DEBUG - ("Do not override configuration variable '%s' with value '%lf' because it was already set.", + ("Do not override configuration variable '%s' with value '%f' because it was already set.", name, val); } @@ -786,42 +837,41 @@ void xbt_cfg_setdefault_string(xbt_cfg_t cfg, const char *name, name, val); } -/** @brief Set a peer value to \a name within \a cfg if it wasn't changed yet + +/** @brief Set an boolean value to \a name within \a cfg if it wasn't changed yet * * This is useful to change the default value of a variable while allowing * users to override it with command line arguments */ -void xbt_cfg_setdefault_peer(xbt_cfg_t cfg, const char *name, - const char *host, int port) +void xbt_cfg_setdefault_boolean(xbt_cfg_t cfg, const char *name, const char *val) { - xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_peer); + xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_boolean); if (variable->isdefault){ - xbt_cfg_set_peer(cfg, name, host, port); + xbt_cfg_set_boolean(cfg, name, val); variable->isdefault = 1; } - else + else XBT_DEBUG - ("Do not override configuration variable '%s' with value '%s:%d' because it was already set.", - name, host, port); + ("Do not override configuration variable '%s' with value '%s' because it was already set.", + name, val); } /** @brief Set or add an integer value to \a name within \a cfg * - * \arg cfg the config set - * \arg name the name of the variable - * \arg val the value of the variable + * @param cfg the config set + * @param name the name of the variable + * @param val the value of the variable */ void xbt_cfg_set_int(xbt_cfg_t cfg, const char *name, int val) { - xbt_cfgelm_t variable; XBT_VERB("Configuration setting: %s=%d", name, val); - variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_int); + xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_int); if (variable->max == 1) { - if (variable->cb_rm && xbt_dynar_length(variable->content)) - (*variable->cb_rm) (name, 0); + if (variable->cb_rm && !xbt_dynar_is_empty(variable->content)) + variable->cb_rm(name, 0); xbt_dynar_set(variable->content, 0, &val); } else { @@ -836,27 +886,26 @@ void xbt_cfg_set_int(xbt_cfg_t cfg, const char *name, int val) } if (variable->cb_set) - (*variable->cb_set) (name, xbt_dynar_length(variable->content) - 1); + variable->cb_set(name, xbt_dynar_length(variable->content) - 1); variable->isdefault = 0; } /** @brief Set or add a double value to \a name within \a cfg * - * \arg cfg the config set - * \arg name the name of the variable - * \arg val the doule to set + * @param cfg the config set + * @param name the name of the variable + * @param val the doule to set */ void xbt_cfg_set_double(xbt_cfg_t cfg, const char *name, double val) { - xbt_cfgelm_t variable; XBT_VERB("Configuration setting: %s=%f", name, val); - variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_double); + xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_double); if (variable->max == 1) { - if (variable->cb_rm && xbt_dynar_length(variable->content)) - (*variable->cb_rm) (name, 0); + if (variable->cb_rm && !xbt_dynar_is_empty(variable->content)) + variable->cb_rm(name, 0); xbt_dynar_set(variable->content, 0, &val); } else { @@ -870,33 +919,32 @@ void xbt_cfg_set_double(xbt_cfg_t cfg, const char *name, double val) } if (variable->cb_set) - (*variable->cb_set) (name, xbt_dynar_length(variable->content) - 1); + variable->cb_set(name, xbt_dynar_length(variable->content) - 1); variable->isdefault = 0; } /** @brief Set or add a string value to \a name within \a cfg * - * \arg cfg the config set - * \arg name the name of the variable - * \arg val the value to be added + * @param cfg the config set + * @param name the name of the variable + * @param val the value to be added * */ void xbt_cfg_set_string(xbt_cfg_t cfg, const char *name, const char *val) { - xbt_cfgelm_t variable; char *newval = xbt_strdup(val); XBT_VERB("Configuration setting: %s=%s", name, val); - variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_string); + xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_string); + XBT_DEBUG("Variable: %d to %d %s (=%d) @%p", - variable->min, variable->max, - xbt_cfgelm_type_name[variable->type], variable->type, variable); + variable->min, variable->max, xbt_cfgelm_type_name[variable->type], (int)variable->type, variable); if (variable->max == 1) { - if (xbt_dynar_length(variable->content)) { + if (!xbt_dynar_is_empty(variable->content)) { if (variable->cb_rm) - (*variable->cb_rm) (name, 0); + variable->cb_rm(name, 0); else if (variable->type == xbt_cfgelm_string) { char *sval = xbt_dynar_get_as(variable->content, 0, char *); free(sval); @@ -915,48 +963,55 @@ void xbt_cfg_set_string(xbt_cfg_t cfg, const char *name, const char *val) } if (variable->cb_set) - (*variable->cb_set) (name, xbt_dynar_length(variable->content) - 1); + variable->cb_set(name, xbt_dynar_length(variable->content) - 1); variable->isdefault = 0; } -/** @brief Set or add an peer value to \a name within \a cfg - * - * \arg cfg the config set - * \arg name the name of the variable - * \arg peer the peer - * \arg port the port number +/** @brief Set or add a boolean value to \a name within \a cfg * - * \e peer values are composed of a string (peername) and an integer (port) + * @param cfg the config set + * @param name the name of the variable + * @param val the value of the variable */ - -void -xbt_cfg_set_peer(xbt_cfg_t cfg, const char *name, const char *peer, - int port) +void xbt_cfg_set_boolean(xbt_cfg_t cfg, const char *name, const char *val) { - xbt_cfgelm_t variable; - xbt_peer_t val = xbt_peer_new(peer, port); + int i, bval; - XBT_VERB("Configuration setting: %s=%s:%d", name, peer, port); + XBT_VERB("Configuration setting: %s=%s", name, val); + xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_boolean); - variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_peer); + for (i = 0; xbt_cfgelm_boolean_values[i].true_val != NULL; i++) { + if (strcmp(val, xbt_cfgelm_boolean_values[i].true_val) == 0){ + bval = 1; + break; + } + if (strcmp(val, xbt_cfgelm_boolean_values[i].false_val) == 0){ + bval = 0; + break; + } + } + if (xbt_cfgelm_boolean_values[i].true_val == NULL) { + xbt_die("Value of option '%s' not valid. Should be a boolean (yes,no,on,off,true,false,0,1)", val); + } if (variable->max == 1) { - if (variable->cb_rm && xbt_dynar_length(variable->content)) - (*variable->cb_rm) (name, 0); + if (variable->cb_rm && !xbt_dynar_is_empty(variable->content)) + variable->cb_rm(name, 0); - xbt_dynar_set(variable->content, 0, &val); + xbt_dynar_set(variable->content, 0, &bval); } else { if (variable->max - && xbt_dynar_length(variable->content) == variable->max) + && xbt_dynar_length(variable->content) == + (unsigned long) variable->max) THROWF(mismatch_error, 0, - "Cannot add value %s:%d to the config element %s since it's already full (size=%d)", - peer, port, name, variable->max); + "Cannot add value %s to the config element %s since it's already full (size=%d)", + val, name, variable->max); - xbt_dynar_push(variable->content, &val); + xbt_dynar_push(variable->content, &bval); } if (variable->cb_set) - (*variable->cb_set) (name, xbt_dynar_length(variable->content) - 1); + variable->cb_set(name, xbt_dynar_length(variable->content) - 1); variable->isdefault = 0; } @@ -964,18 +1019,17 @@ xbt_cfg_set_peer(xbt_cfg_t cfg, const char *name, const char *peer, /** @brief Remove the provided \e val integer value from a variable * - * \arg cfg the config set - * \arg name the name of the variable - * \arg val the value to be removed + * @param cfg the config set + * @param name the name of the variable + * @param val the value to be removed */ void xbt_cfg_rm_int(xbt_cfg_t cfg, const char *name, int val) { - xbt_cfgelm_t variable; unsigned int cpt; int seen; - variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_int); + xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_int); if (xbt_dynar_length(variable->content) == variable->min) THROWF(mismatch_error, 0, @@ -985,7 +1039,7 @@ void xbt_cfg_rm_int(xbt_cfg_t cfg, const char *name, int val) xbt_dynar_foreach(variable->content, cpt, seen) { if (seen == val) { if (variable->cb_rm) - (*variable->cb_rm) (name, cpt); + variable->cb_rm(name, cpt); xbt_dynar_cursor_rm(variable->content, &cpt); return; } @@ -998,18 +1052,17 @@ void xbt_cfg_rm_int(xbt_cfg_t cfg, const char *name, int val) /** @brief Remove the provided \e val double value from a variable * - * \arg cfg the config set - * \arg name the name of the variable - * \arg val the value to be removed + * @param cfg the config set + * @param name the name of the variable + * @param val the value to be removed */ void xbt_cfg_rm_double(xbt_cfg_t cfg, const char *name, double val) { - xbt_cfgelm_t variable; unsigned int cpt; double seen; - variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_double); + xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_double); if (xbt_dynar_length(variable->content) == variable->min) THROWF(mismatch_error, 0, @@ -1020,7 +1073,7 @@ void xbt_cfg_rm_double(xbt_cfg_t cfg, const char *name, double val) if (seen == val) { xbt_dynar_cursor_rm(variable->content, &cpt); if (variable->cb_rm) - (*variable->cb_rm) (name, cpt); + variable->cb_rm(name, cpt); return; } } @@ -1032,17 +1085,15 @@ void xbt_cfg_rm_double(xbt_cfg_t cfg, const char *name, double val) /** @brief Remove the provided \e val string value from a variable * - * \arg cfg the config set - * \arg name the name of the variable - * \arg val the value of the string which will be removed + * @param cfg the config set + * @param name the name of the variable + * @param val the value of the string which will be removed */ void xbt_cfg_rm_string(xbt_cfg_t cfg, const char *name, const char *val) { - xbt_cfgelm_t variable; unsigned int cpt; char *seen; - - variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_string); + xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_string); if (xbt_dynar_length(variable->content) == variable->min) THROWF(mismatch_error, 0, @@ -1052,7 +1103,7 @@ void xbt_cfg_rm_string(xbt_cfg_t cfg, const char *name, const char *val) xbt_dynar_foreach(variable->content, cpt, seen) { if (!strcpy(seen, val)) { if (variable->cb_rm) - (*variable->cb_rm) (name, cpt); + variable->cb_rm(name, cpt); xbt_dynar_cursor_rm(variable->content, &cpt); return; } @@ -1063,41 +1114,36 @@ void xbt_cfg_rm_string(xbt_cfg_t cfg, const char *name, const char *val) val, name); } -/** @brief Remove the provided \e val peer value from a variable +/** @brief Remove the provided \e val boolean value from a variable * - * \arg cfg the config set - * \arg name the name of the variable - * \arg peer the peername - * \arg port the port number + * @param cfg the config set + * @param name the name of the variable + * @param val the value to be removed */ - -void -xbt_cfg_rm_peer(xbt_cfg_t cfg, const char *name, const char *peer, - int port) +void xbt_cfg_rm_boolean(xbt_cfg_t cfg, const char *name, int val) { - xbt_cfgelm_t variable; - unsigned int cpt; - xbt_peer_t seen; - variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_peer); + unsigned int cpt; + int seen; + xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_boolean); if (xbt_dynar_length(variable->content) == variable->min) THROWF(mismatch_error, 0, - "Cannot remove value %s:%d from the config element %s since it's already at its minimal size (=%d)", - peer, port, name, variable->min); + "Cannot remove value %d from the config element %s since it's already at its minimal size (=%d)", + val, name, variable->min); xbt_dynar_foreach(variable->content, cpt, seen) { - if (!strcpy(seen->name, peer) && seen->port == port) { + if (seen == val) { if (variable->cb_rm) - (*variable->cb_rm) (name, cpt); + variable->cb_rm(name, cpt); xbt_dynar_cursor_rm(variable->content, &cpt); return; } } THROWF(not_found_error, 0, - "Can't remove the value %s:%d of config element %s: value not found.", - peer, port, name); + "Can't remove the value %d of config element %s: value not found.", + val, name); } /** @brief Remove the \e pos th value from the provided variable */ @@ -1105,9 +1151,7 @@ xbt_cfg_rm_peer(xbt_cfg_t cfg, const char *name, const char *peer, void xbt_cfg_rm_at(xbt_cfg_t cfg, const char *name, int pos) { - xbt_cfgelm_t variable; - - variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_any); + xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_any); if (xbt_dynar_length(variable->content) == variable->min) THROWF(mismatch_error, 0, @@ -1115,14 +1159,14 @@ void xbt_cfg_rm_at(xbt_cfg_t cfg, const char *name, int pos) pos, name, variable->min); if (variable->cb_rm) - (*variable->cb_rm) (name, pos); + variable->cb_rm(name, pos); xbt_dynar_remove_at(variable->content, pos, NULL); } /** @brief Remove all the values from a variable * - * \arg cfg the config set - * \arg name the name of the variable + * @param cfg the config set + * @param name the name of the variable */ void xbt_cfg_empty(xbt_cfg_t cfg, const char *name) @@ -1132,7 +1176,8 @@ void xbt_cfg_empty(xbt_cfg_t cfg, const char *name) TRY { variable = xbt_dict_get((xbt_dict_t) cfg, name); - } CATCH(e) { + } + CATCH(e) { if (e.category != not_found_error) RETHROW; @@ -1147,7 +1192,7 @@ void xbt_cfg_empty(xbt_cfg_t cfg, const char *name) unsigned int cpt; void *ignored; xbt_dynar_foreach(variable->content, cpt, ignored) { - (*variable->cb_rm) (name, cpt); + variable->cb_rm(name, cpt); } } xbt_dynar_reset(variable->content); @@ -1166,9 +1211,8 @@ int xbt_cfg_is_default_value(xbt_cfg_t cfg, const char *name) /** @brief Retrieve an integer value of a variable (get a warning if not uniq) * - * \arg cfg the config set - * \arg name the name of the variable - * \arg val the wanted value + * @param cfg the config set + * @param name the name of the variable * * Returns the first value from the config set under the given name. * If there is more than one value, it will issue a warning. Consider using @@ -1191,9 +1235,8 @@ int xbt_cfg_get_int(xbt_cfg_t cfg, const char *name) /** @brief Retrieve a double value of a variable (get a warning if not uniq) * - * \arg cfg the config set - * \arg name the name of the variable - * \arg val the wanted value + * @param cfg the config set + * @param name the name of the variable * * Returns the first value from the config set under the given name. * If there is more than one value, it will issue a warning. Consider using @@ -1217,9 +1260,8 @@ double xbt_cfg_get_double(xbt_cfg_t cfg, const char *name) /** @brief Retrieve a string value of a variable (get a warning if not uniq) * - * \arg th the config set - * \arg name the name of the variable - * \arg val the wanted value + * @param cfg the config set + * @param name the name of the variable * * Returns the first value from the config set under the given name. * If there is more than one value, it will issue a warning. Consider using @@ -1236,19 +1278,17 @@ char *xbt_cfg_get_string(xbt_cfg_t cfg, const char *name) XBT_WARN ("You asked for the first value of the config element '%s', but there is %lu values\n", name, xbt_dynar_length(variable->content)); - } else if (xbt_dynar_length(variable->content) == 0) { + } else if (xbt_dynar_is_empty(variable->content)) { return NULL; } return xbt_dynar_get_as(variable->content, 0, char *); } -/** @brief Retrieve an peer value of a variable (get a warning if not uniq) +/** @brief Retrieve a boolean value of a variable (get a warning if not uniq) * - * \arg cfg the config set - * \arg name the name of the variable - * \arg peer the peer - * \arg port the port number + * @param cfg the config set + * @param name the name of the variable * * Returns the first value from the config set under the given name. * If there is more than one value, it will issue a warning. Consider using @@ -1256,31 +1296,23 @@ char *xbt_cfg_get_string(xbt_cfg_t cfg, const char *name) * * \warning the returned value is the actual content of the config set */ - -void xbt_cfg_get_peer(xbt_cfg_t cfg, const char *name, char **peer, - int *port) +int xbt_cfg_get_boolean(xbt_cfg_t cfg, const char *name) { - xbt_cfgelm_t variable; - xbt_peer_t val; - - variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_peer); + xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_boolean); if (xbt_dynar_length(variable->content) > 1) { XBT_WARN - ("You asked for the first value of the config element '%s', but there is %lu values\n", + ("You asked for the first value of the config element '%s', but there is %lu values", name, xbt_dynar_length(variable->content)); } - val = xbt_dynar_get_as(variable->content, 0, xbt_peer_t); - *peer = val->name; - *port = val->port; + return xbt_dynar_get_as(variable->content, 0, int); } /** @brief Retrieve the dynar of all the values stored in a variable * - * \arg cfg where to search in - * \arg name what to search for - * \arg dynar result + * @param cfg where to search in + * @param name what to search for * * Get the data stored in the config set. * @@ -1293,7 +1325,8 @@ xbt_dynar_t xbt_cfg_get_dynar(xbt_cfg_t cfg, const char *name) TRY { variable = xbt_dict_get((xbt_dict_t) cfg, name); - } CATCH(e) { + } + CATCH(e) { if (e.category == not_found_error) { xbt_ex_free(e); THROWF(not_found_error, 0, @@ -1331,17 +1364,12 @@ char *xbt_cfg_get_string_at(xbt_cfg_t cfg, const char *name, int pos) return xbt_dynar_get_as(variable->content, pos, char *); } -/** @brief Retrieve one of the peer value of a variable */ -void -xbt_cfg_get_peer_at(xbt_cfg_t cfg, const char *name, int pos, - char **peer, int *port) +/** @brief Retrieve one of the boolean value of a variable */ +int xbt_cfg_get_boolean_at(xbt_cfg_t cfg, const char *name, int pos) { - xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_int); - xbt_peer_t val = xbt_dynar_get_ptr(variable->content, pos); - - *port = val->port; - *peer = val->name; + xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_boolean); + return xbt_dynar_get_as(variable->content, pos, int); } @@ -1349,8 +1377,7 @@ xbt_cfg_get_peer_at(xbt_cfg_t cfg, const char *name, int pos, #include "xbt.h" #include "xbt/ex.h" -XBT_LOG_EXTERNAL_CATEGORY(xbt_cfg); -XBT_LOG_DEFAULT_CATEGORY(xbt_cfg); +XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_cfg); XBT_TEST_SUITE("config", "Configuration support"); @@ -1472,7 +1499,8 @@ XBT_TEST_UNIT("use", test_config_use, "Data retrieving tests") TRY { xbt_cfg_set_parse(myset, "color:blue"); - } CATCH(e) { + } + CATCH(e) { if (e.category != not_found_error) xbt_test_exception(e); xbt_ex_free(e);