X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/ffb6b3fc6c9b2b1a1032e4de24cb0c9c2aba19b4..66ad9903ba702428fa0ba27d22259bd0dd50c03b:/src/xbt/config.c diff --git a/src/xbt/config.c b/src/xbt/config.c index 39bde111d9..b84c29ec44 100644 --- a/src/xbt/config.c +++ b/src/xbt/config.c @@ -1,10 +1,9 @@ -/* $Id$ */ - -/* config - Dictionnary where the type of each cell is provided. */ +/* config - Dictionnary where the type of each variable is provided. */ /* This is useful to build named structs, like option or property sets. */ -/* Copyright (c) 2001,2002,2003,2004 Martin Quinson. All rights reserved. */ +/* 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. */ @@ -12,1102 +11,1044 @@ #include "xbt/misc.h" #include "xbt/sysdep.h" #include "xbt/log.h" -#include "xbt/error.h" +#include "xbt/ex.h" #include "xbt/dynar.h" #include "xbt/dict.h" -#include "xbt/config.h" /* prototypes of this module */ +#include + +#include "xbt/config.h" /* prototypes of this module */ + +XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_cfg, xbt, "configuration support"); -XBT_LOG_NEW_DEFAULT_SUBCATEGORY(config,xbt,"configuration support"); +xbt_cfg_t simgrid_config = NULL; -/* xbt_cfgelm_t: the typedef corresponding to a config cell. +/* xbt_cfgelm_t: the typedef corresponding to a config variable. - Both data and DTD are mixed, but fixing it now would prevent me to ever - defend my thesis. */ + Both data and DTD are mixed, but fixing it now would prevent me to ever defend my thesis. */ typedef struct { - /* Allowed type of the cell */ + /* Description */ + char *desc; + + /* Allowed type of the variable */ e_xbt_cfgelm_type_t type; - int min,max; + int min; + unsigned isdefault:1; + + /* Callbacks */ + xbt_cfg_cb_t cb_set; - /* actual content - (cannot be an union because type host uses both str and i) */ + /* actual content (could be an union or something) */ xbt_dynar_t content; -} s_xbt_cfgelm_t,*xbt_cfgelm_t; +} s_xbt_cfgelm_t, *xbt_cfgelm_t; -static const char *xbt_cfgelm_type_name[xbt_cfgelm_type_count]= - {"int","double","string","host"}; +static const char *xbt_cfgelm_type_name[xbt_cfgelm_type_count] = { "int", "double", "string", "boolean", "any" }; -/* Internal stuff used in cache to free a cell */ -static void xbt_cfgelm_free(void *data); +const struct xbt_boolean_couple xbt_cfgelm_boolean_values[] = { + { "yes", "no"}, + { "on", "off"}, + {"true", "false"}, + { "1", "0"}, + { NULL, NULL} +}; -/* Retrieve the cell we'll modify */ -static xbt_error_t xbt_cfgelm_get(xbt_cfg_t cfg, const char *name, - e_xbt_cfgelm_type_t type, - /* OUT */ xbt_cfgelm_t *whereto); +/* Internal stuff used in cache to free a variable */ +static void xbt_cfgelm_free(void *data); -void xbt_cfg_str_free(void *d); -void xbt_cfg_host_free(void *d); - -void xbt_cfg_str_free(void *d){ - xbt_free(*(void**)d); -} -void xbt_cfg_host_free(void *d){ - xbt_host_t *h=(xbt_host_t*) *(void**)d; - if (h) { - if (h->name) xbt_free(h->name); - xbt_free(h); - } -} +/* Retrieve the variable we'll modify */ +static xbt_cfgelm_t xbt_cfgelm_get(xbt_cfg_t cfg, const char *name, e_xbt_cfgelm_type_t type); /*----[ Memory management ]-----------------------------------------------*/ - -/** - * xbt_cfg_new: +/** @brief Constructor * - * \return - * - * Initialise an config set + * Initialise a config set */ - - -xbt_cfg_t xbt_cfg_new(void) { - return (xbt_cfg_t)xbt_dict_new(); +xbt_cfg_t xbt_cfg_new(void) +{ + return (xbt_cfg_t) xbt_dict_new_homogeneous(&xbt_cfgelm_free); } -/** - * xbt_cfg_cpy: +/** \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 */ - -void -xbt_cfg_cpy(xbt_cfg_t tocopy,xbt_cfg_t *whereto) { - xbt_dict_cursor_t cursor=NULL; - xbt_cfgelm_t cell=NULL; - char *name=NULL; - - *whereto=NULL; - xbt_assert0(tocopy,"cannot copy NULL config"); - - xbt_dict_foreach((xbt_dict_t)tocopy,cursor,name,cell) { - xbt_cfg_register(*whereto, name, cell->type, cell->min, cell->max); +void xbt_cfg_cpy(xbt_cfg_t tocopy, xbt_cfg_t * whereto) +{ + xbt_dict_cursor_t cursor = NULL; + xbt_cfgelm_t variable = NULL; + char *name = NULL; + + XBT_DEBUG("Copy cfg set %p", tocopy); + *whereto = NULL; + 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, variable->min, variable->cb_set); } } -void xbt_cfg_free(xbt_cfg_t *cfg) { - xbt_dict_free((xbt_dict_t*)cfg); +/** @brief Destructor */ +void xbt_cfg_free(xbt_cfg_t * cfg) +{ + XBT_DEBUG("Frees cfg set %p", cfg); + xbt_dict_free((xbt_dict_t *) cfg); } -/** - * xbt_cfg_dump: - * \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 +/** @brief Dump a config set for debuging purpose * - * Dumps a config set for debuging purpose + * @param name The name to give to this config set + * @param indent what to write at the beginning 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) { +void xbt_cfg_dump(const char *name, const char *indent, xbt_cfg_t cfg) +{ xbt_dict_t dict = (xbt_dict_t) cfg; - xbt_dict_cursor_t cursor=NULL; - xbt_cfgelm_t cell=NULL; - char *key=NULL; - int i; + xbt_dict_cursor_t cursor = NULL; + xbt_cfgelm_t variable = NULL; + char *key = NULL; + int i; int size; int ival; char *sval; double dval; - xbt_host_t *hval; if (name) - printf("%s>> Dumping of the config set '%s':\n",indent,name); - xbt_dict_foreach(dict,cursor,key,cell) { + printf("%s>> Dumping of the config set '%s':\n", indent, name); - printf("%s %s:",indent,key); + xbt_dict_foreach(dict, cursor, key, variable) { + printf("%s %s:", indent, key); - size = xbt_dynar_length(cell->content); - printf("%d_to_%d_%s. Actual size=%d. List of values:\n", - cell->min,cell->max,xbt_cfgelm_type_name[cell->type], - size); + size = xbt_dynar_length(variable->content); + printf ("%d_%s. Actual size=%d. postset=%p, List of values:\n", + variable->min, xbt_cfgelm_type_name[variable->type], size, variable->cb_set); - switch (cell->type) { - + switch (variable->type) { case xbt_cfgelm_int: - for (i=0; icontent,i,int); - printf ("%s %d\n",indent,ival); + for (i = 0; i < size; i++) { + ival = xbt_dynar_get_as(variable->content, i, int); + printf("%s %d\n", indent, ival); } break; - case xbt_cfgelm_double: - for (i=0; icontent,i,double); - printf ("%s %f\n",indent,dval); + for (i = 0; i < size; i++) { + dval = xbt_dynar_get_as(variable->content, i, double); + printf("%s %f\n", indent, dval); } break; - case xbt_cfgelm_string: - for (i=0; icontent,i,char*); - printf ("%s %s\n",indent,sval); + for (i = 0; i < size; i++) { + sval = xbt_dynar_get_as(variable->content, i, char *); + printf("%s %s\n", indent, sval); } break; - - case xbt_cfgelm_host: - for (i=0; icontent,i,xbt_host_t*); - printf ("%s %s:%d\n",indent,hval->name,hval->port); + case xbt_cfgelm_boolean: + for (i = 0; i < size; i++) { + 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); + printf("%s Invalid type!!\n", indent); + break; } - } - if (name) printf("%s<< End of the config set '%s'\n",indent,name); + if (name) + printf("%s<< End of the config set '%s'\n", indent, name); fflush(stdout); xbt_dict_cursor_free(&cursor); - return; } -/** - * xbt_cfgelm_free: - * - * \arg data the data to be freed (typed as void* to be usable as free funct in dict) - * +/* * free an config element */ - -void xbt_cfgelm_free(void *data) { - xbt_cfgelm_t c=(xbt_cfgelm_t)data; - - if (!c) return; - xbt_dynar_free(&(c->content)); - xbt_free(c); +void xbt_cfgelm_free(void *data) +{ + xbt_cfgelm_t c = (xbt_cfgelm_t) data; + + XBT_DEBUG("Frees cfgelm %p", c); + if (!c) + return; + xbt_free(c->desc); + if (c->type != xbt_cfgelm_alias) + xbt_dynar_free(&(c->content)); + free(c); } /*----[ Registering stuff ]-----------------------------------------------*/ - -/** - * xbt_cfg_register: - * \arg cfg the config set - * \arg type the type of the config element - * \arg min the minimum - * \arg max the maximum +/** @brief Register an element within a config set * - * register an element within a config set + * @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 (0 for optional elements) + * @param cb_set callback function called when a value is set */ - -void -xbt_cfg_register(xbt_cfg_t cfg, - const char *name, e_xbt_cfgelm_type_t type, - int min, int max){ - xbt_cfgelm_t res; - xbt_error_t errcode; - - DEBUG4("Register cfg elm %s (%d to %d %s)",name,min,max,xbt_cfgelm_type_name[type]); - errcode = xbt_dict_get((xbt_dict_t)cfg,name,(void**)&res); - - if (errcode == no_error) { - WARN1("Config elem %s registered twice.",name); - /* Will be removed by the insertion of the new one */ - } - xbt_assert_error(mismatch_error); - - res=xbt_new(s_xbt_cfgelm_t,1); - - res->type=type; - res->min=min; - res->max=max; +void xbt_cfg_register(xbt_cfg_t * cfg, const char *name, const char *desc, e_xbt_cfgelm_type_t type, int min, xbt_cfg_cb_t cb_set) +{ + if (*cfg == NULL) + *cfg = xbt_cfg_new(); + xbt_assert(type >= xbt_cfgelm_int && type <= xbt_cfgelm_boolean, + "type of %s not valid (%d should be between %d and %d)", + name, (int)type, xbt_cfgelm_int, xbt_cfgelm_boolean); + + xbt_cfgelm_t res = xbt_dict_get_or_null((xbt_dict_t) * cfg, name); + 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 %s (=%d) @%p in set %p)", + name, desc, min, xbt_cfgelm_type_name[type], (int)type, res, *cfg); + + res->desc = xbt_strdup(desc); + res->type = type; + res->min = min; + res->cb_set = cb_set; + res->isdefault = 1; switch (type) { case xbt_cfgelm_int: res->content = xbt_dynar_new(sizeof(int), NULL); break; - case xbt_cfgelm_double: res->content = xbt_dynar_new(sizeof(double), NULL); break; - case xbt_cfgelm_string: - res->content = xbt_dynar_new(sizeof(char*),&xbt_cfg_str_free); - break; - - case xbt_cfgelm_host: - res->content = xbt_dynar_new(sizeof(xbt_host_t*),&xbt_cfg_host_free); - break; - + res->content = xbt_dynar_new(sizeof(char *), xbt_free_ref); + break; + case xbt_cfgelm_boolean: + res->content = xbt_dynar_new(sizeof(int), NULL); + break; default: - ERROR1("%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); } -/** - * xbt_cfg_unregister: - * - * \arg cfg the config set - * \arg name the name of the elem to be freed - * - * unregister an element from a config set. - * Note that it removes both the DTD and the actual content. - */ +void xbt_cfg_register_double(const char *name, const char *desc, double default_value,xbt_cfg_cb_t cb_set){ + xbt_cfg_register(&simgrid_config,name,desc,xbt_cfgelm_double,1,cb_set); + xbt_cfg_setdefault_double(name, default_value); +} +void xbt_cfg_register_int(const char *name, const char *desc, int default_value,xbt_cfg_cb_t cb_set){ + xbt_cfg_register(&simgrid_config,name,desc,xbt_cfgelm_int,1,cb_set); + xbt_cfg_setdefault_int(name, default_value); +} +void xbt_cfg_register_string(const char *name, const char *desc, const char *default_value, xbt_cfg_cb_t cb_set){ + xbt_cfg_register(&simgrid_config,name,desc,xbt_cfgelm_string,1,cb_set); + xbt_cfg_setdefault_string(name, default_value); +} +void xbt_cfg_register_boolean(const char *name, const char *desc, const char*default_value,xbt_cfg_cb_t cb_set){ + xbt_cfg_register(&simgrid_config,name,desc,xbt_cfgelm_boolean,1,cb_set); + xbt_cfg_setdefault_boolean(name, default_value); +} + +void xbt_cfg_register_alias(const char *newname, const char *oldname) +{ + if (simgrid_config == NULL) + simgrid_config = xbt_cfg_new(); + + xbt_cfgelm_t res = xbt_dict_get_or_null(simgrid_config, oldname); + xbt_assert(NULL == res, "Refusing to register the option '%s' twice.", oldname); -xbt_error_t -xbt_cfg_unregister(xbt_cfg_t cfg,const char *name) { - return xbt_dict_remove((xbt_dict_t)cfg,name); + res = xbt_dict_get_or_null(simgrid_config, 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)",oldname,newname); + + res->desc = bprintf("Deprecated alias for %s",newname); + res->type = xbt_cfgelm_alias; + res->min = 1; + res->isdefault = 1; + res->content = (xbt_dynar_t)newname; + + xbt_dict_set(simgrid_config, oldname, res, NULL); } /** - * xbt_cfg_register_str: + * @brief Parse a string and register the stuff described. + * + * @param cfg the config set + * @param entry a string describing the element to register * - * \arg cfg the config set - * \arg 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' or 'double'. * - * Parse a string and register the stuff described. + * Note that this does not allow to set the description, so you should prefer the other interface */ - -xbt_error_t -xbt_cfg_register_str(xbt_cfg_t cfg,const char *entry) { - char *entrycpy=xbt_strdup(entry); +void xbt_cfg_register_str(xbt_cfg_t * cfg, const char *entry) +{ + char *entrycpy = xbt_strdup(entry); char *tok; - int min,max; + int min; e_xbt_cfgelm_type_t type; + XBT_DEBUG("Register string '%s'", entry); - tok=strchr(entrycpy, ':'); - if (!tok) { - ERROR3("%s%s%s", - "Invalid config element descriptor: ",entry, - "; Should be :_to__"); - xbt_free(entrycpy); - xbt_abort(); - } - *(tok++)='\0'; + tok = strchr(entrycpy, ':'); + xbt_assert(tok, "Invalid config element descriptor: %s%s", entry, "; Should be :_to__"); + *(tok++) = '\0'; - min=strtol(tok, &tok, 10); - if (!tok) { - ERROR1("Invalid minimum in config element descriptor %s",entry); - xbt_free(entrycpy); - xbt_abort(); - } + min = strtol(tok, &tok, 10); + xbt_assert(tok, "Invalid minimum in config element descriptor %s", entry); - if (!strcmp(tok,"_to_")){ - ERROR3("%s%s%s", - "Invalid config element descriptor: ",entry, - "; Should be :_to__"); - xbt_free(entrycpy); - xbt_abort(); - } - tok += strlen("_to_"); + xbt_assert(*tok == '_', "Invalid config element descriptor: %s%s", entry, + "; Should be :_to__"); + tok++; - max=strtol(tok, &tok, 10); - if (!tok) { - ERROR1("Invalid maximum in config element descriptor %s",entry); - xbt_free(entrycpy); - xbt_abort(); - } + 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' or 'double'."); - if (*(tok++)!='_') { - ERROR3("%s%s%s", - "Invalid config element descriptor: ",entry, - "; Should be :_to__"); - xbt_free(entrycpy); - xbt_abort(); - } + xbt_cfg_register(cfg, entrycpy, NULL, type, min, NULL); - for (type=0; - typetype == xbt_cfgelm_alias) + printf(" %s: %s\n", name, variable->desc); + } } -/** - * xbt_cfg_check: - * - * \arg cfg the config set - * - * Check the config set - */ +/** @brief Displays the declared options and their description */ +void xbt_cfg_help(xbt_cfg_t cfg) +{ + 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) { + 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) + printf("Arity: min:%d", variable->min); + size = xbt_dynar_length(variable->content); + printf("Current value%s: ", (size <= 1 ? "" : "s")); + + 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")); + + switch (variable->type) { + case xbt_cfgelm_int: + printf("%d%s", xbt_dynar_get_as(variable->content, i, int), sep); + break; + case xbt_cfgelm_double: + printf("%f%s", xbt_dynar_get_as(variable->content, i, double), sep); + break; + case xbt_cfgelm_string: + printf("'%s'%s", xbt_dynar_get_as(variable->content, i, char *), sep); + break; + 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; + } + default: + printf("Invalid type!!%s", sep); + break; + } + } + } + xbt_dynar_free(&names); +} -xbt_error_t -xbt_cfg_check(xbt_cfg_t cfg) { - xbt_dict_cursor_t cursor; - xbt_cfgelm_t cell; +/** @brief Check that each variable have the right amount of values */ +void xbt_cfg_check(void) +{ + xbt_dict_cursor_t cursor; + xbt_cfgelm_t variable; char *name; - int size; - xbt_assert0(cfg,"NULL config set."); + xbt_dict_foreach((xbt_dict_t) simgrid_config, cursor, name, variable) { + if (variable->type == xbt_cfgelm_alias) + continue; - xbt_dict_foreach((xbt_dict_t)cfg,cursor,name,cell) { - size = xbt_dynar_length(cell->content); - if (cell->min > size) { - ERROR4("Config elem %s needs at least %d %s, but there is only %d values.", - name, - cell->min, - xbt_cfgelm_type_name[cell->type], - size); + int size = xbt_dynar_length(variable->content); + if (variable->min > size) { xbt_dict_cursor_free(&cursor); - return mismatch_error; + THROWF(mismatch_error, 0, "Config elem %s needs at least %d %s, but there is only %d values.", + name, variable->min, xbt_cfgelm_type_name[variable->type], size); } - if (cell->max < size) { - ERROR4("Config elem %s accepts at most %d %s, but there is %d values.", - name, - cell->max, - xbt_cfgelm_type_name[cell->type], - size); + if (variable->isdefault && size > variable->min) { xbt_dict_cursor_free(&cursor); - return mismatch_error; + 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); } - } - xbt_dict_cursor_free(&cursor); - return no_error; } -static xbt_error_t xbt_cfgelm_get(xbt_cfg_t cfg, - const char *name, - e_xbt_cfgelm_type_t type, - /* OUT */ xbt_cfgelm_t *whereto){ - - xbt_error_t errcode = xbt_dict_get((xbt_dict_t)cfg,name, - (void**)whereto); - - if (errcode == mismatch_error) { - ERROR1("No registered cell %s in this config set", - name); - return mismatch_error; +static xbt_cfgelm_t xbt_cfgelm_get(xbt_cfg_t cfg, const char *name, e_xbt_cfgelm_type_t type) +{ + 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); } - if (errcode != no_error) - return errcode; - xbt_assert3((*whereto)->type == type, - "You tried to access to the config element %s as an %s, but its type is %s.", - name, - xbt_cfgelm_type_name[type], - xbt_cfgelm_type_name[(*whereto)->type]); + if (!res) { + xbt_cfg_help(cfg); + fflush(stdout); + THROWF(not_found_error, 0, "No registered variable '%s' in this config set.", name); + } - return no_error; + xbt_assert(type == xbt_cfgelm_any || res->type == type, + "You tried to access to the config element %s as an %s, but its type is %s.", + name, xbt_cfgelm_type_name[type], xbt_cfgelm_type_name[res->type]); + return res; } -/** - * xbt_cfg_get_type: +/** @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 * - * Give the type of the config element + * @return the type of the given element */ +e_xbt_cfgelm_type_t xbt_cfg_get_type(xbt_cfg_t cfg, const char *name) +{ + xbt_cfgelm_t variable = NULL; -xbt_error_t -xbt_cfg_get_type(xbt_cfg_t cfg, const char *name, - /* OUT */e_xbt_cfgelm_type_t *type) { - - xbt_cfgelm_t cell; - xbt_error_t errcode; - - TRYCATCH(mismatch_error,xbt_dict_get((xbt_dict_t)cfg,name,(void**)&cell)); + variable = xbt_dict_get_or_null((xbt_dict_t) cfg, name); + if (!variable) + THROWF(not_found_error, 0, "Can't get the type of '%s' since this variable does not exist", name); - if (errcode == mismatch_error) { - ERROR1("Can't get the type of '%s' since this cell does not exist", - name); - return mismatch_error; - } - - *type=cell->type; - - return no_error; + XBT_DEBUG("type in variable = %d", (int)variable->type); + return variable->type; } /*----[ Setting ]---------------------------------------------------------*/ -/** - * xbt_cfg_set_vargs(): - * \arg cfg config set to fill - * \arg varargs NULL-terminated list of pairs {(const char*)key, value} +/** @brief va_args version of xbt_cfg_set + * + * @param cfg config set to fill + * @param name variable name + * @param pa variable value * * Add some values to the config set. - * \warning if the list isn't NULL terminated, it will segfault. */ -xbt_error_t -xbt_cfg_set_vargs(xbt_cfg_t cfg, va_list pa) { - char *str,*name; +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; + e_xbt_cfgelm_type_t type = xbt_cfgelm_any; /* Set a dummy value to make gcc happy. It cannot get uninitialized */ - xbt_error_t errcode; - - while ((name=va_arg(pa,char *))) { + xbt_ex_t e; - if (!xbt_cfg_get_type(cfg,name,&type)) { - ERROR1("Can't set the property '%s' since it's not registered",name); - return mismatch_error; + TRY { + type = xbt_cfg_get_type(cfg, name); + } + CATCH(e) { + if (e.category == not_found_error) { + xbt_ex_free(e); + THROWF(not_found_error, 0, "Can't set the property '%s' since it's not registered", name); } + RETHROW; + } - switch (type) { - case xbt_cfgelm_host: - str = va_arg(pa, char *); - i=va_arg(pa,int); - TRY(xbt_cfg_set_host(cfg,name,str,i)); - break; - - case xbt_cfgelm_string: - str=va_arg(pa, char *); - TRY(xbt_cfg_set_string(cfg, name, str)); - break; - - case xbt_cfgelm_int: - i=va_arg(pa,int); - TRY(xbt_cfg_set_int(cfg,name,i)); - break; - - case xbt_cfgelm_double: - d=va_arg(pa,double); - TRY(xbt_cfg_set_double(cfg,name,d)); - break; - - default: - RAISE1(unknown_error,"Config element cell %s not valid.",name); - } + switch (type) { + case xbt_cfgelm_string: + str = va_arg(pa, char *); + xbt_cfg_set_string(name, str); + break; + case xbt_cfgelm_int: + i = va_arg(pa, int); + xbt_cfg_set_int(name, i); + break; + case xbt_cfgelm_double: + d = va_arg(pa, double); + xbt_cfg_set_double(name, d); + break; + case xbt_cfgelm_boolean: + str = va_arg(pa, char *); + xbt_cfg_set_boolean(name, str); + break; + default: + xbt_die("Config element variable %s not valid (type=%d)", name, (int)type); } - return no_error; } -/** - * xbt_cfg_set(): - * \arg cfg config set to fill - * \arg varargs NULL-terminated list of pairs {(const char*)key, value} +/** @brief Add a NULL-terminated list of pairs {(char*)key, value} to the set * - * Add some values to the config set. - * \warning if the list isn't NULL terminated, it will segfault. + * @param cfg config set to fill + * @param name variable name + * @param ... variable value */ -xbt_error_t xbt_cfg_set(xbt_cfg_t cfg, ...) { +void xbt_cfg_set(xbt_cfg_t cfg, const char *name, ...) +{ va_list pa; - xbt_error_t errcode; - va_start(pa,cfg); - errcode=xbt_cfg_set_vargs(cfg,pa); + va_start(pa, name); + xbt_cfg_set_vargs(cfg, name, pa); va_end(pa); - return errcode; } -/** - * xbt_cfg_set_parse(): - * \arg cfg config set to fill - * \arg options a string containing the content to add to the config set. This - * is a '\t',' ' or '\n' separated list of cells. Each individual cell is - * like "[name]:[value]" where [name] is the name of an already registred - * cell, and [value] conforms to the data type under which this cell was - * registred. +/** @brief Add values parsed from a string into a config set * - * Add the cells described in a string to a config set. + * @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 registered variable, and [value] conforms to the data type under which this variable was registered. + * + * @todo This is a crude manual parser, it should be a proper lexer. */ - -xbt_error_t -xbt_cfg_set_parse(xbt_cfg_t cfg, const char *options) { - int i; - double d; - char *str; - - xbt_cfgelm_t cell; - char *optionlist_cpy; - char *option, *name,*val; - - int len; - xbt_error_t errcode; - - XBT_IN; - if (!options || !strlen(options)) { /* nothing to do */ - return no_error; +void xbt_cfg_set_parse(const char *options) +{ + if (!options || !strlen(options)) { /* nothing to do */ + return; } - optionlist_cpy=xbt_strdup(options); + char *optionlist_cpy = xbt_strdup(options); - DEBUG1("List to parse and set:'%s'",options); - option=optionlist_cpy; - while (1) { /* breaks in the code */ - - if (!option) + XBT_DEBUG("List to parse and set:'%s'", options); + char *option = optionlist_cpy; + while (1) { /* breaks in the code */ + if (!option) break; - name=option; - len=strlen(name); - DEBUG3("Still to parse and set: '%s'. len=%d; option-name=%ld", - name,len,(long)(option-name)); + char *name = option; + int len = strlen(name); + XBT_DEBUG("Still to parse and set: '%s'. len=%d; option-name=%ld", name, len, (long) (option - name)); /* Pass the value */ - while (option-name<=(len-1) && *option != ' ' && *option != '\n' && *option != '\t') { - /*fprintf(stderr,"Take %c.\n",*option);*/ + while (option - name <= (len - 1) && *option != ' ' && *option != '\n' && *option != '\t' && *option != ',') { + XBT_DEBUG("Take %c.", *option); option++; } - if (option-name == len) { - /*fprintf(stderr,"Boundary=EOL\n");*/ - option=NULL; /* don't do next iteration */ - + if (option - name == len) { + XBT_DEBUG("Boundary=EOL"); + option = NULL; /* don't do next iteration */ } else { - /*fprintf(stderr,"Boundary on '%c'. len=%d;option-name=%d\n",*option,len,option-name);*/ - + XBT_DEBUG("Boundary on '%c'. len=%d;option-name=%ld", *option, len, (long) (option - name)); /* Pass the following blank chars */ - *(option++)='\0'; - while (option-name<(len-1) && (*option == ' ' || *option == '\n' || *option == '\t')) { - /* fprintf(stderr,"Ignore a blank char.\n");*/ - option++; + *(option++) = '\0'; + while (option - name < (len - 1) && (*option == ' ' || *option == '\n' || *option == '\t')) { + /* fprintf(stderr,"Ignore a blank char.\n"); */ + option++; } - if (option-name == len-1) - option=NULL; /* don't do next iteration */ + if (option - name == len - 1) + option = NULL; /* don't do next iteration */ } - DEBUG2("parse now:'%s'; parse later:'%s'",name,option); + XBT_DEBUG("parse now:'%s'; parse later:'%s'", name, option); if (name[0] == ' ' || name[0] == '\n' || name[0] == '\t') continue; if (!strlen(name)) break; - - val=strchr(name,':'); - if (!val) { - xbt_free(optionlist_cpy); - xbt_assert1(FALSE, - "Malformated option: '%s'; Should be of the form 'name:value'", - name); - } - *(val++)='\0'; - - DEBUG2("name='%s';val='%s'",name,val); - - errcode=xbt_dict_get((xbt_dict_t)cfg,name,(void**)&cell); - switch (errcode) { - case no_error: - break; - case mismatch_error: - ERROR1("No registrated cell corresponding to '%s'.",name); - xbt_free(optionlist_cpy); - return mismatch_error; - break; - default: - xbt_free(optionlist_cpy); - return errcode; - } - switch (cell->type) { - case xbt_cfgelm_string: - errcode = xbt_cfg_set_string(cfg, name, val); - if (errcode != no_error) { - xbt_free(optionlist_cpy); - return errcode; - } - break; + char *val = strchr(name, ':'); + xbt_assert(val, "Option '%s' badly formatted. Should be of the form 'name:value'", name); + /* don't free(optionlist_cpy) if the assert fails, 'name' points inside it */ + *(val++) = '\0'; - case xbt_cfgelm_int: - i=strtol(val, &val, 0); - if (val==NULL) { - xbt_free(optionlist_cpy); - xbt_assert1(FALSE, - "Value of option %s not valid. Should be an integer", - name); - } - - errcode = xbt_cfg_set_int(cfg,name,i); - if (errcode != no_error) { - xbt_free(optionlist_cpy); - return errcode; - } - break; + if (strncmp(name, "contexts/", strlen("contexts/")) && strncmp(name, "path", strlen("path"))) + XBT_INFO("Configuration change: Set '%s' to '%s'", name, val); - case xbt_cfgelm_double: - d=strtod(val, &val); - if (val==NULL) { - xbt_free(optionlist_cpy); - xbt_assert1(FALSE, - "Value of option %s not valid. Should be a double", - name); - } + TRY { + xbt_cfg_set_as_string(name,val); + } CATCH_ANONYMOUS { + free(optionlist_cpy); + RETHROW; + } + } + free(optionlist_cpy); +} - errcode = xbt_cfg_set_double(cfg,name,d); - if (errcode != no_error) { - xbt_free(optionlist_cpy); - return errcode; - } - break; +/** @brief Set the value of a variable, using the string representation of that value + * + * @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 + */ - case xbt_cfgelm_host: - str=val; - val=strchr(val,':'); - if (!val) { - xbt_free(optionlist_cpy); - xbt_assert1(FALSE, - "Value of option %s not valid. Should be an host (machine:port)", - name); - } +void *xbt_cfg_set_as_string(const char *key, const char *value) { + xbt_ex_t e; - *(val++)='\0'; - i=strtol(val, &val, 0); - if (val==NULL) { - xbt_free(optionlist_cpy); - xbt_assert1(FALSE, - "Value of option %s not valid. Should be an host (machine:port)", - name); - } + char *ret; + volatile xbt_cfgelm_t variable = NULL; + int i; + double d; - errcode = xbt_cfg_set_host(cfg,name,str,i); - if (errcode != no_error) { - xbt_free(optionlist_cpy); - return errcode; + TRY { + while (variable == NULL) { + variable = xbt_dict_get((xbt_dict_t) simgrid_config, key); + if (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; } - break; + } + } 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; + } - default: - xbt_free(optionlist_cpy); - RAISE1(unknown_error,"Type of config element %s is not valid.",name); + switch (variable->type) { + case xbt_cfgelm_string: + xbt_cfg_set_string(key, value); /* throws */ + break; + 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); } - + xbt_cfg_set_int(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(key, d); /* throws */ + break; + case xbt_cfgelm_boolean: + xbt_cfg_set_boolean(key, value); /* throws */ + ret = (char *)value + strlen(value); + break; + default: + THROWF(unknown_error, 0, "Type of config element %s is not valid.", key); + break; } - xbt_free(optionlist_cpy); - return no_error; + return ret; } -/** - * xbt_cfg_set_int: - * - * \arg cfg the config set - * \arg name the name of the cell - * \arg val the value of the cell +/** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet * - * Set the value of the cell #name in #cfg with the provided value. - */ -xbt_error_t -xbt_cfg_set_int(xbt_cfg_t cfg,const char*name, int val) { - xbt_cfgelm_t cell; - xbt_error_t errcode; - - VERB2("Configuration setting: %s=%d",name,val); - TRY (xbt_cfgelm_get(cfg,name,xbt_cfgelm_int,&cell)); - - if (cell->max > 1) { - xbt_dynar_push(cell->content,&val); - } else { - xbt_dynar_set(cell->content,0,&val); - } - return no_error; + * 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_int(const char *name, int val) +{ + xbt_cfgelm_t variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_int); + + if (variable->isdefault){ + xbt_cfg_set_int(name, val); + variable->isdefault = 1; + } else + XBT_DEBUG("Do not override configuration variable '%s' with value '%d' because it was already set.", name, val); } -/** - * xbt_cfg_set_double: - * \arg cfg the config set - * \arg name the name of the cell - * \arg val the doule to set - * - * Set the value of the cell #name in #cfg with the provided value. - */ - -xbt_error_t -xbt_cfg_set_double(xbt_cfg_t cfg,const char*name, double val) { - xbt_cfgelm_t cell; - xbt_error_t errcode; - - VERB2("Configuration setting: %s=%f",name,val); - TRY (xbt_cfgelm_get(cfg,name,xbt_cfgelm_double,&cell)); - - if (cell->max > 1) { - xbt_dynar_push(cell->content,&val); - } else { - xbt_dynar_set(cell->content,0,&val); - } - return no_error; +/** @brief Set an integer 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_double(const char *name, double val) +{ + xbt_cfgelm_t variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_double); + + if (variable->isdefault) { + xbt_cfg_set_double(name, val); + variable->isdefault = 1; + } else + XBT_DEBUG("Do not override configuration variable '%s' with value '%f' because it was already set.", name, val); } -/** - * xbt_cfg_set_string: - * - * \arg cfg the config set - * \arg name the name of the cell - * \arg val the value to be added +/** @brief Set a string value to \a name within \a cfg if it wasn't changed yet * - * Set the value of the cell #name in #cfg with the provided value. - */ - -xbt_error_t -xbt_cfg_set_string(xbt_cfg_t cfg,const char*name, const char*val) { - xbt_cfgelm_t cell; - xbt_error_t errcode; - char *newval = xbt_strdup(val); + * 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_string(const char *name, const char *val) +{ + xbt_cfgelm_t variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_string); + + if (variable->isdefault){ + xbt_cfg_set_string(name, val); + variable->isdefault = 1; + } else + XBT_DEBUG("Do not override configuration variable '%s' with value '%s' because it was already set.", name, val); +} - VERB2("Configuration setting: %s=%s",name,val); - TRY (xbt_cfgelm_get(cfg,name,xbt_cfgelm_string,&cell)); +/** @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_boolean(const char *name, const char *val) +{ + xbt_cfgelm_t variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_boolean); - if (cell->max > 1) { - xbt_dynar_push(cell->content,&newval); - } else { - xbt_dynar_set(cell->content,0,&newval); + if (variable->isdefault){ + xbt_cfg_set_boolean(name, val); + variable->isdefault = 1; } - return no_error; + else + XBT_DEBUG("Do not override configuration variable '%s' with value '%s' because it was already set.", name, val); } -/** - * xbt_cfg_set_host: - * - * \arg cfg the config set - * \arg name the name of the cell - * \arg host the host - * \arg port the port number +/** @brief Set or add an integer value to \a name within \a cfg * - * Set the value of the cell #name in #cfg with the provided value - * on the given #host to the given #port - */ - -xbt_error_t -xbt_cfg_set_host(xbt_cfg_t cfg,const char*name, - const char *host,int port) { - xbt_cfgelm_t cell; - xbt_error_t errcode; - xbt_host_t *val=xbt_new(xbt_host_t,1); - - VERB3("Configuration setting: %s=%s:%d",name,host,port); - - val->name = xbt_strdup(name); - val->port = port; + * @param cfg the config set + * @param name the name of the variable + * @param val the value of the variable + */ +void xbt_cfg_set_int(const char *name, int val) +{ + xbt_cfgelm_t variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_int); - TRY (xbt_cfgelm_get(cfg,name,xbt_cfgelm_host,&cell)); + xbt_dynar_set(variable->content, 0, &val); - if (cell->max > 1) { - xbt_dynar_push(cell->content,&val); - } else { - xbt_dynar_set(cell->content,0,&val); - } - return no_error; + if (variable->cb_set) + variable->cb_set(name, xbt_dynar_length(variable->content) - 1); + variable->isdefault = 0; } -/* ---- [ Removing ] ---- */ - -/** - * xbt_cfg_rm_int: +/** @brief Set or add a double value to \a name within \a cfg * - * \arg cfg the config set - * \arg name the name of the cell - * \arg val the value to be removed - * - * Remove the provided #val from the cell #name in #cfg. + * @param cfg the config set + * @param name the name of the variable + * @param val the doule to set */ -xbt_error_t xbt_cfg_rm_int(xbt_cfg_t cfg,const char*name, int val) { - - xbt_cfgelm_t cell; - int cpt,seen; - xbt_error_t errcode; - - TRY (xbt_cfgelm_get(cfg,name,xbt_cfgelm_int,&cell)); - - xbt_dynar_foreach(cell->content,cpt,seen) { - if (seen == val) { - xbt_dynar_cursor_rm(cell->content,&cpt); - return no_error; - } - } +void xbt_cfg_set_double(const char *name, double val) +{ + xbt_cfgelm_t variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_double); + + xbt_dynar_set(variable->content, 0, &val); - ERROR2("Can't remove the value %d of config element %s: value not found.", - val,name); - return mismatch_error; + if (variable->cb_set) + variable->cb_set(name, xbt_dynar_length(variable->content) - 1); + variable->isdefault = 0; } -/** - * xbt_cfg_rm_double: +/** @brief Set or add a string value to \a name within \a cfg * - * \arg cfg the config set - * \arg name the name of the cell - * \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 added * - * Remove the provided #val from the cell #name in #cfg. */ +void xbt_cfg_set_string(const char *name, const char *val) +{ + char *newval = xbt_strdup(val); + xbt_cfgelm_t variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_string); -xbt_error_t xbt_cfg_rm_double(xbt_cfg_t cfg,const char*name, double val) { - xbt_cfgelm_t cell; - int cpt; - double seen; - xbt_error_t errcode; - - TRY (xbt_cfgelm_get(cfg,name,xbt_cfgelm_double,&cell)); - - xbt_dynar_foreach(cell->content,cpt,seen) { - if (seen == val) { - xbt_dynar_cursor_rm(cell->content,&cpt); - return no_error; - } + if (!xbt_dynar_is_empty(variable->content)) { + char *sval = xbt_dynar_get_as(variable->content, 0, char *); + free(sval); } - ERROR2("Can't remove the value %f of config element %s: value not found.", - val,name); - return mismatch_error; + xbt_dynar_set(variable->content, 0, &newval); + + if (variable->cb_set) + variable->cb_set(name, xbt_dynar_length(variable->content) - 1); + variable->isdefault = 0; } -/** - * xbt_cfg_rm_string: +/** @brief Set or add a boolean value to \a name within \a cfg * - * \arg cfg the config set - * \arg name the name of the cell - * \arg val the value of the string which will be removed - * - * Remove the provided #val from the cell #name in #cfg. + * @param name the name of the variable + * @param val the value of the variable */ -xbt_error_t -xbt_cfg_rm_string(xbt_cfg_t cfg,const char*name, const char *val) { - xbt_cfgelm_t cell; - int cpt; - char *seen; - xbt_error_t errcode; - - TRY (xbt_cfgelm_get(cfg,name,xbt_cfgelm_string,&cell)); - - xbt_dynar_foreach(cell->content,cpt,seen) { - if (!strcpy(seen,val)) { - xbt_dynar_cursor_rm(cell->content,&cpt); - return no_error; +void xbt_cfg_set_boolean(const char *name, const char *val) +{ + int i, bval; + xbt_cfgelm_t variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_boolean); + + 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); + } + + xbt_dynar_set(variable->content, 0, &bval); - ERROR2("Can't remove the value %s of config element %s: value not found.", - val,name); - return mismatch_error; + if (variable->cb_set) + variable->cb_set(name, xbt_dynar_length(variable->content) - 1); + variable->isdefault = 0; } -/** - * xbt_cfg_rm_host: - * - * \arg cfg the config set - * \arg name the name of the cell - * \arg host the hostname - * \arg port the port number + +/* Say if the value is the default value */ +int xbt_cfg_is_default_value(const char *name) +{ + xbt_cfgelm_t variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_any); + return variable->isdefault; +} + +/*----[ Getting ]---------------------------------------------------------*/ +/** @brief Retrieve an integer value of a variable (get a warning if not uniq) + * + * @param name the name of the variable * - * Remove the provided #host:#port from the cell #name in #cfg. + * 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 xbt_cfg_get_dynar() instead. */ +int xbt_cfg_get_int(const char *name) +{ + xbt_cfgelm_t variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_int); -xbt_error_t -xbt_cfg_rm_host(xbt_cfg_t cfg,const char*name, const char *host,int port) { - xbt_cfgelm_t cell; - int cpt; - xbt_host_t *seen; - xbt_error_t errcode; - - TRY (xbt_cfgelm_get(cfg,name,xbt_cfgelm_host,&cell)); - - xbt_dynar_foreach(cell->content,cpt,seen) { - if (!strcpy(seen->name,host) && seen->port == port) { - xbt_dynar_cursor_rm(cell->content,&cpt); - return no_error; - } + 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", + name, xbt_dynar_length(variable->content)); } - ERROR3("Can't remove the value %s:%d of config element %s: value not found.", - host,port,name); - return mismatch_error; + return xbt_dynar_get_as(variable->content, 0, int); } -/* rm everything */ - -/** - * xbt_cfg_empty: - * - * \arg cfg the config set - * \arg name the name of the cell +/** @brief Retrieve a double value of a variable (get a warning if not uniq) + * + * @param cfg the config set + * @param name the name of the variable * - * rm evenything + * 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 xbt_cfg_get_dynar() instead. */ +double xbt_cfg_get_double(const char *name) +{ + xbt_cfgelm_t variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_double); -xbt_error_t -xbt_cfg_empty(xbt_cfg_t cfg,const char*name) { - xbt_cfgelm_t cell; - - xbt_error_t errcode; - - TRYCATCH(mismatch_error, - xbt_dict_get((xbt_dict_t)cfg,name,(void**)&cell)); - if (errcode == mismatch_error) { - ERROR1("Can't empty '%s' since this config element does not exist", - name); - return mismatch_error; + 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", + name, xbt_dynar_length(variable->content)); } - if (cell) { - xbt_dynar_reset(cell->content); - } - return no_error; + return xbt_dynar_get_as(variable->content, 0, double); } -/*----[ Getting ]---------------------------------------------------------*/ - -/** - * xbt_cfg_get_int: - * \arg cfg the config set - * \arg name the name of the cell - * \arg val the wanted value +/** @brief Retrieve a string value of a variable (get a warning if not uniq) + * + * @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 xbt_cfg_get_dynar() - * instead. + * If there is more than one value, it will issue a warning. Consider using + * xbt_cfg_get_dynar() instead. Returns NULL if there is no value. * * \warning the returned value is the actual content of the config set */ -xbt_error_t -xbt_cfg_get_int (xbt_cfg_t cfg, - const char *name, - int *val) { - xbt_cfgelm_t cell; - xbt_error_t errcode; - - TRY (xbt_cfgelm_get(cfg,name,xbt_cfgelm_int,&cell)); - - if (xbt_dynar_length(cell->content) > 1) { - WARN2("You asked for the first value of the config element '%s', but there is %lu values", - name, xbt_dynar_length(cell->content)); +char *xbt_cfg_get_string(const char *name) +{ + xbt_cfgelm_t variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_string); + + 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", + name, xbt_dynar_length(variable->content)); + } else if (xbt_dynar_is_empty(variable->content)) { + return NULL; } - *val = xbt_dynar_get_as(cell->content, 0, int); - return no_error; + return xbt_dynar_get_as(variable->content, 0, char *); } -/** - * xbt_cfg_get_double: - * \arg cfg the config set - * \arg name the name of the cell - * \arg val the wanted value +/** @brief Retrieve a boolean value of a variable (get a warning if not uniq) * - * 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 xbt_cfg_get_dynar() - * instead. + * @param cfg the config set + * @param name the name of the variable * - * \warning the returned value is the actual content of the config set + * 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 xbt_cfg_get_dynar() instead. */ +int xbt_cfg_get_boolean(const char *name) +{ + xbt_cfgelm_t variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_boolean); -xbt_error_t -xbt_cfg_get_double(xbt_cfg_t cfg, - const char *name, - double *val) { - xbt_cfgelm_t cell; - xbt_error_t errcode; - - TRY (xbt_cfgelm_get(cfg,name,xbt_cfgelm_double,&cell)); - - if (xbt_dynar_length(cell->content) > 1) { - WARN2("You asked for the first value of the config element '%s', but there is %lu values\n", - name, xbt_dynar_length(cell->content)); + 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", + name, xbt_dynar_length(variable->content)); } - *val = xbt_dynar_get_as(cell->content, 0, double); - return no_error; + return xbt_dynar_get_as(variable->content, 0, int); } -/** - * xbt_cfg_get_string: +/** @brief Retrieve the dynar of all the values stored in a variable * - * \arg th the config set - * \arg name the name of the cell - * \arg val the wanted value + * @param cfg where to search in + * @param name what to search for * - * 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 xbt_cfg_get_dynar() - * instead. + * Get the data stored in the config set. * * \warning the returned value is the actual content of the config set */ +xbt_dynar_t xbt_cfg_get_dynar(const char *name) +{ + xbt_cfgelm_t variable = NULL; + xbt_ex_t e; + + TRY { + variable = xbt_dict_get((xbt_dict_t) simgrid_config, name); + } CATCH(e) { + if (e.category == not_found_error) { + xbt_ex_free(e); + THROWF(not_found_error, 0, "No registered variable %s in this config set", name); + } + RETHROW; + } -xbt_error_t xbt_cfg_get_string(xbt_cfg_t cfg, - const char *name, - char **val) { - xbt_cfgelm_t cell; - xbt_error_t errcode; + return variable->content; +} - *val=NULL; +/** @brief Retrieve one of the integer value of a variable */ +int xbt_cfg_get_int_at(xbt_cfg_t cfg, const char *name, int pos) +{ + xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_int); + return xbt_dynar_get_as(variable->content, pos, int); +} - TRY (xbt_cfgelm_get(cfg,name,xbt_cfgelm_string,&cell)); +/** @brief Retrieve one of the double value of a variable */ +double xbt_cfg_get_double_at(xbt_cfg_t cfg, const char *name, int pos) +{ + xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_double); + return xbt_dynar_get_as(variable->content, pos, double); +} - if (xbt_dynar_length(cell->content) > 1) { - WARN2("You asked for the first value of the config element '%s', but there is %lu values\n", - name, xbt_dynar_length(cell->content)); - } +/** @brief Retrieve one of the string value of a variable */ +char *xbt_cfg_get_string_at(xbt_cfg_t cfg, const char *name, int pos) +{ + xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_string); + return xbt_dynar_get_as(variable->content, pos, char *); +} - *val = xbt_dynar_get_as(cell->content, 0, char *); - return no_error; +/** @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_boolean); + return xbt_dynar_get_as(variable->content, pos, int); } -/** - * xbt_cfg_get_host: - * - * \arg cfg the config set - * \arg name the name of the cell - * \arg host the host - * \arg port the port number - * - * 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 xbt_cfg_get_dynar() - * instead. - * - * \warning the returned value is the actual content of the config set - */ +#ifdef SIMGRID_TEST +#include "xbt.h" +#include "xbt/ex.h" -xbt_error_t xbt_cfg_get_host (xbt_cfg_t cfg, - const char *name, - char **host, - int *port) { - xbt_cfgelm_t cell; - xbt_error_t errcode; - xbt_host_t *val; +XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_cfg); - TRY (xbt_cfgelm_get(cfg,name,xbt_cfgelm_host,&cell)); +XBT_TEST_SUITE("config", "Configuration support"); - if (xbt_dynar_length(cell->content) > 1) { - WARN2("You asked for the first value of the config element '%s', but there is %lu values\n", - name, xbt_dynar_length(cell->content)); - } +static xbt_cfg_t make_set() +{ + xbt_cfg_t set = NULL; + + xbt_log_threshold_set(&_XBT_LOGV(xbt_cfg), xbt_log_priority_critical); + xbt_cfg_register_str(&set, "speed:1_int"); + xbt_cfg_register_str(&set, "peername:1_string"); + xbt_cfg_register_str(&set, "user:1_string"); + + return set; +} /* end_of_make_set */ + +extern xbt_cfg_t simgrid_config; - val = xbt_dynar_get_as(cell->content, 0, xbt_host_t*); - *host=val->name; - *port=val->port; - - return no_error; +XBT_TEST_UNIT("memuse", test_config_memuse, "Alloc and free a config set") +{ + simgrid_config = make_set(); + xbt_test_add("Alloc and free a config set"); + xbt_cfg_set_parse("peername:veloce user:bidule"); + xbt_cfg_free(&simgrid_config); } -/** - * xbt_cfg_get_dynar: - * \arg cfg where to search in - * \arg name what to search for - * \arg dynar result - * - * Get the data stored in the config bag. - * - * \warning the returned value is the actual content of the config set - */ -xbt_error_t xbt_cfg_get_dynar (xbt_cfg_t cfg, - const char *name, - xbt_dynar_t *dynar) { - xbt_cfgelm_t cell; - xbt_error_t errcode = xbt_dict_get((xbt_dict_t)cfg,name, - (void**)&cell); - - if (errcode == mismatch_error) { - ERROR1("No registered cell %s in this config set", - name); - return mismatch_error; +XBT_TEST_UNIT("validation", test_config_validation, "Validation tests") +{ + xbt_ex_t e; + + simgrid_config = make_set(); + xbt_test_add("Having too few elements for speed"); + xbt_cfg_set_parse("peername:veloce user:mquinson\nuser:oaumage\tuser:alegrand"); + TRY { + xbt_cfg_check(); + } CATCH(e) { + if (e.category != mismatch_error || strncmp(e.msg, "Config elem speed needs", strlen("Config elem speed needs"))) + xbt_test_fail("Got an exception. msg=%s", e.msg); + xbt_ex_free(e); } - if (errcode != no_error) - return errcode; - *dynar = cell->content; - return no_error; + xbt_test_add("Having too much values of 'speed'"); + xbt_cfg_set_parse("peername:toto:42 user:machin"); + TRY { + xbt_cfg_set_parse("speed:42 speed:24"); + } CATCH(e) { + if (e.category != mismatch_error || + strncmp(e.msg, "Cannot add value 34 to the config elem speed", strlen("Config elem speed needs"))) + xbt_test_fail("Got an exception. msg=%s", e.msg); + xbt_ex_free(e); + } + xbt_cfg_check(); + xbt_cfg_free(&simgrid_config); } +XBT_TEST_UNIT("use", test_config_use, "Data retrieving tests") +{ + simgrid_config = make_set(); + xbt_test_add("Get a single value"); + { + /* get_single_value */ + int ival; + + xbt_cfg_set_parse("peername:toto:42 speed:42"); + ival = xbt_cfg_get_int("speed"); + if (ival != 42) + xbt_test_fail("Speed value = %d, I expected 42", ival); + } + + xbt_test_add("Access to a non-existant entry"); + { + xbt_ex_t e; + + TRY { + xbt_cfg_set_parse("color:blue"); + } CATCH(e) { + if (e.category != not_found_error) + xbt_test_exception(e); + xbt_ex_free(e); + } + } + xbt_cfg_free(&simgrid_config); +} +#endif /* SIMGRID_TEST */