-/* $Id$ */
-
/* 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, 2005, 2006, 2007, 2008, 2009, 2010. 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. */
/* Allowed type of the variable */
e_xbt_cfgelm_type_t type;
int min, max;
+ int isdefault:1;
/* Callbacks */
xbt_cfg_cb_t cb_set;
} 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", "peer", "any" };
/* Internal stuff used in cache to free a variable */
static void xbt_cfgelm_free(void *data);
xbt_cfgelm_t variable = NULL;
char *name = NULL;
- DEBUG1("Copy cfg set %p", tocopy);
+ XBT_DEBUG("Copy cfg set %p", tocopy);
*whereto = NULL;
xbt_assert0(tocopy, "cannot copy NULL config");
/** @brief Destructor */
void xbt_cfg_free(xbt_cfg_t * cfg)
{
- DEBUG1("Frees cfg set %p", cfg);
+ XBT_DEBUG("Frees cfg set %p", cfg);
xbt_dict_free((xbt_dict_t *) cfg);
}
size = xbt_dynar_length(variable->content);
printf
- ("%d_to_%d_%s. Actual size=%d. prerm=%p,postset=%p, List of values:\n",
- variable->min, variable->max, xbt_cfgelm_type_name[variable->type],
- size, variable->cb_rm, variable->cb_set);
+ ("%d_to_%d_%s. Actual size=%d. prerm=%p,postset=%p, List of values:\n",
+ variable->min, variable->max,
+ xbt_cfgelm_type_name[variable->type], size, variable->cb_rm,
+ variable->cb_set);
switch (variable->type) {
{
xbt_cfgelm_t c = (xbt_cfgelm_t) data;
- DEBUG1("Frees cfgelm %p", c);
+ XBT_DEBUG("Frees cfgelm %p", c);
if (!c)
return;
xbt_free(c->desc);
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, int max, xbt_cfg_cb_t cb_set,
- xbt_cfg_cb_t cb_rm)
+ const char *name, const char *desc,
+ e_xbt_cfgelm_type_t type, void *default_value, int min,
+ int max, xbt_cfg_cb_t cb_set, xbt_cfg_cb_t cb_rm)
{
xbt_cfgelm_t res;
res = xbt_dict_get_or_null((xbt_dict_t) * cfg, name);
if (res) {
- WARN1("Config elem %s registered twice.", name);
+ XBT_WARN("Config elem %s registered twice.", name);
/* Will be removed by the insertion of the new one */
}
res = xbt_new(s_xbt_cfgelm_t, 1);
- DEBUG8("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);
+ 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);
res->desc = xbt_strdup(desc);
res->type = type;
res->max = max;
res->cb_set = cb_set;
res->cb_rm = cb_rm;
+ res->isdefault = 1;
switch (type) {
case xbt_cfgelm_int:
break;
default:
- ERROR1("%d is an invalide type code", type);
+ XBT_ERROR("%d is an invalide type code", type);
}
xbt_dict_set((xbt_dict_t) * cfg, name, res, &xbt_cfgelm_free);
void xbt_cfg_unregister(xbt_cfg_t cfg, const char *name)
{
- DEBUG2("Unregister elm '%s' from set %p", name, cfg);
+ XBT_DEBUG("Unregister elm '%s' from set %p", name, cfg);
xbt_dict_remove((xbt_dict_t) cfg, name);
}
int min, max;
e_xbt_cfgelm_type_t type;
- DEBUG1("Register string '%s'", entry);
+ XBT_DEBUG("Register string '%s'", entry);
tok = strchr(entrycpy, ':');
xbt_assert2(tok, "Invalid config element descriptor: %s%s",
*(tok++) = '\0';
min = strtol(tok, &tok, 10);
- xbt_assert1(tok, "Invalid minimum in config element descriptor %s", entry);
+ xbt_assert1(tok, "Invalid minimum in config element descriptor %s",
+ entry);
xbt_assert2(strcmp(tok, "_to_"),
"Invalid config element descriptor : %s%s",
tok += strlen("_to_");
max = strtol(tok, &tok, 10);
- xbt_assert1(tok, "Invalid maximum in config element descriptor %s", entry);
+ xbt_assert1(tok, "Invalid maximum in config element descriptor %s",
+ entry);
xbt_assert2(*(tok++) == '_',
"Invalid config element descriptor: %s%s", entry,
free(entrycpy); /* strdup'ed by dict mechanism, but cannot be const */
}
+static int strcmp_voidp(const void *pa, const void *pb)
+{
+ return strcmp(*(const char **)pa, *(const char **)pb);
+}
+
/** @brief Displays the declared options and their description */
void xbt_cfg_help(xbt_cfg_t cfg)
{
- xbt_dict_cursor_t cursor;
+ 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);
- int i;
- int size;
+ xbt_dict_foreach((xbt_dict_t )cfg, dict_cursor, name, variable) {
+ xbt_dynar_push(names, &name);
+ }
+ xbt_dynar_sort(names, strcmp_voidp);
+
+ xbt_dynar_foreach(names, dynar_cursor, name) {
+ int i;
+ int size;
+ variable = xbt_dict_get((xbt_dict_t )cfg, name);
- xbt_dict_foreach((xbt_dict_t) cfg, cursor, name, variable) {
printf(" %s: %s\n", name, variable->desc);
printf(" Type: %s; ", xbt_cfgelm_type_name[variable->type]);
- if (variable->min != 1 || variable->max != 1)
- printf("Arrity: min:%d to max:%d; ", variable->min, variable->max);
+ if (variable->min != 1 || variable->max != 1) {
+ if (variable->min == 0 && variable->max == 0)
+ printf("Arity: no bound; ");
+ else
+ printf("Arity: min:%d to max:%d; ", variable->min, variable->max);
+ }
printf("Current value: ");
size = xbt_dynar_length(variable->content);
}
}
+
+ xbt_dynar_free(&names);
}
/** @brief Check that each variable have the right amount of values */
int size;
xbt_assert0(cfg, "NULL config set.");
- DEBUG1("Check cfg set %p", cfg);
+ XBT_DEBUG("Check cfg set %p", cfg);
xbt_dict_foreach((xbt_dict_t) cfg, cursor, name, variable) {
size = xbt_dynar_length(variable->content);
xbt_dict_cursor_free(&cursor);
THROW4(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);
+ name, variable->min, xbt_cfgelm_type_name[variable->type],
+ size);
}
if (variable->max > 0 && variable->max < size) {
xbt_dict_cursor_free(&cursor);
THROW4(mismatch_error, 0,
"Config elem %s accepts at most %d %s, but there is %d values.",
- name, variable->max, xbt_cfgelm_type_name[variable->type], size);
+ name, variable->max, xbt_cfgelm_type_name[variable->type],
+ size);
}
}
}
static xbt_cfgelm_t xbt_cfgelm_get(xbt_cfg_t cfg,
- const char *name, e_xbt_cfgelm_type_t type)
+ const char *name,
+ e_xbt_cfgelm_type_t type)
{
xbt_cfgelm_t res = NULL;
"Can't get the type of '%s' since this variable does not exist",
name);
- INFO1("type in variable = %d", variable->type);
+ XBT_INFO("type in variable = %d", variable->type);
return variable->type;
}
if (e.category == not_found_error) {
xbt_ex_free(e);
THROW1(not_found_error, 0,
- "Can't set the property '%s' since it's not registered", name);
+ "Can't set the property '%s' since it's not registered",
+ name);
}
RETHROW;
}
int len;
- XBT_IN;
+ XBT_IN("");
if (!options || !strlen(options)) { /* nothing to do */
return;
}
optionlist_cpy = xbt_strdup(options);
- DEBUG1("List to parse and set:'%s'", options);
+ XBT_DEBUG("List to parse and set:'%s'", options);
option = optionlist_cpy;
while (1) { /* breaks in the code */
break;
name = option;
len = strlen(name);
- DEBUG3("Still to parse and set: '%s'. len=%d; option-name=%ld",
+ 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' && *option != ',') {
- DEBUG1("Take %c.", *option);
+ XBT_DEBUG("Take %c.", *option);
option++;
}
if (option - name == len) {
- DEBUG0("Boundary=EOL");
+ XBT_DEBUG("Boundary=EOL");
option = NULL; /* don't do next iteration */
} else {
- DEBUG3("Boundary on '%c'. len=%d;option-name=%ld",
+ XBT_DEBUG("Boundary on '%c'. len=%d;option-name=%ld",
*option, len, (long) (option - name));
/* Pass the following blank chars */
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;
}
*(val++) = '\0';
- INFO2("Configuration change: Set '%s' to '%s'", name, val);
+ if (strcmp(name,"contexts/factory"))
+ XBT_INFO("Configuration change: Set '%s' to '%s'", name, val);
TRY {
variable = xbt_dict_get((xbt_dict_t) cfg, name);
if (e.category == not_found_error) {
xbt_ex_free(e);
THROW1(not_found_error, 0,
- "No registrated variable corresponding to '%s'.", name);
+ "No registered variable corresponding to '%s'.", name);
}
RETHROW;
}
}
+/** @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_int(xbt_cfg_t cfg, const char *name, int val)
+{
+ xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_int);
+
+ if (variable->isdefault){
+ xbt_cfg_set_int(cfg, name, val);
+ variable->isdefault = 1;
+ }
+ else
+ XBT_DEBUG
+ ("Do not override configuration variable '%s' with value '%d' because it was already set.",
+ name, val);
+}
+
+/** @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(xbt_cfg_t cfg, const char *name, double val)
+{
+ xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_double);
+
+ if (variable->isdefault) {
+ xbt_cfg_set_double(cfg, name, val);
+ variable->isdefault = 1;
+ }
+ else
+ XBT_DEBUG
+ ("Do not override configuration variable '%s' with value '%lf' because it was already set.",
+ name, val);
+}
+
+/** @brief Set a string 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_string(xbt_cfg_t cfg, const char *name,
+ const char *val)
+{
+ xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_string);
+
+ if (variable->isdefault){
+ xbt_cfg_set_string(cfg, name, val);
+ variable->isdefault = 1;
+ }
+ else
+ XBT_DEBUG
+ ("Do not override configuration variable '%s' with value '%s' because it was already set.",
+ name, val);
+}
+
+/** @brief Set a peer 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)
+{
+ xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_peer);
+
+ if (variable->isdefault){
+ xbt_cfg_set_peer(cfg, name, host, port);
+ variable->isdefault = 1;
+ }
+ else
+ XBT_DEBUG
+ ("Do not override configuration variable '%s' with value '%s:%d' because it was already set.",
+ name, host, port);
+}
+
/** @brief Set or add an integer value to \a name within \a cfg
*
* \arg cfg the config set
{
xbt_cfgelm_t variable;
- VERB2("Configuration setting: %s=%d", name, val);
+ XBT_VERB("Configuration setting: %s=%d", name, val);
variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_int);
if (variable->max == 1) {
if (variable->cb_set)
(*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
{
xbt_cfgelm_t variable;
- VERB2("Configuration setting: %s=%f", name, val);
+ XBT_VERB("Configuration setting: %s=%f", name, val);
variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_double);
if (variable->max == 1) {
xbt_dynar_set(variable->content, 0, &val);
} else {
- if (variable->max && xbt_dynar_length(variable->content) == variable->max)
+ if (variable->max
+ && xbt_dynar_length(variable->content) == variable->max)
THROW3(mismatch_error, 0,
"Cannot add value %f to the config element %s since it's already full (size=%d)",
val, name, variable->max);
if (variable->cb_set)
(*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
xbt_cfgelm_t variable;
char *newval = xbt_strdup(val);
- VERB2("Configuration setting: %s=%s", name, val);
+ XBT_VERB("Configuration setting: %s=%s", name, val);
variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_string);
- DEBUG5("Variable: %d to %d %s (=%d) @%p",
- variable->min, variable->max, xbt_cfgelm_type_name[variable->type],
- variable->type, variable);
+ XBT_DEBUG("Variable: %d to %d %s (=%d) @%p",
+ variable->min, variable->max,
+ xbt_cfgelm_type_name[variable->type], variable->type, variable);
if (variable->max == 1) {
if (xbt_dynar_length(variable->content)) {
xbt_dynar_set(variable->content, 0, &newval);
} else {
- if (variable->max && xbt_dynar_length(variable->content) == variable->max)
+ if (variable->max
+ && xbt_dynar_length(variable->content) == variable->max)
THROW3(mismatch_error, 0,
"Cannot add value %s to the config element %s since it's already full (size=%d)",
name, val, variable->max);
if (variable->cb_set)
(*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
*/
void
-xbt_cfg_set_peer(xbt_cfg_t cfg, const char *name, const char *peer, int port)
+xbt_cfg_set_peer(xbt_cfg_t cfg, const char *name, const char *peer,
+ int port)
{
xbt_cfgelm_t variable;
xbt_peer_t val = xbt_peer_new(peer, port);
- VERB3("Configuration setting: %s=%s:%d", name, peer, port);
+ XBT_VERB("Configuration setting: %s=%s:%d", name, peer, port);
variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_peer);
xbt_dynar_set(variable->content, 0, &val);
} else {
- if (variable->max && xbt_dynar_length(variable->content) == variable->max)
+ if (variable->max
+ && xbt_dynar_length(variable->content) == variable->max)
THROW4(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);
if (variable->cb_set)
(*variable->cb_set) (name, xbt_dynar_length(variable->content) - 1);
+ variable->isdefault = 0;
}
/* ---- [ Removing ] ---- */
*/
void
-xbt_cfg_rm_peer(xbt_cfg_t cfg, const char *name, const char *peer, int port)
+xbt_cfg_rm_peer(xbt_cfg_t cfg, const char *name, const char *peer,
+ int port)
{
xbt_cfgelm_t variable;
unsigned int cpt;
xbt_dynar_reset(variable->content);
}
}
+/*
+ * Say if the value is the default value
+ */
+int xbt_cfg_is_default_value(xbt_cfg_t cfg, const char *name)
+{
+ xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_any);
+ return variable->isdefault;
+}
/*----[ Getting ]---------------------------------------------------------*/
xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_int);
if (xbt_dynar_length(variable->content) > 1) {
- WARN2
- ("You asked for the first value of the config element '%s', but there is %lu values",
- name, xbt_dynar_length(variable->content));
+ XBT_WARN
+ ("You asked for the first value of the config element '%s', but there is %lu values",
+ name, xbt_dynar_length(variable->content));
}
return xbt_dynar_get_as(variable->content, 0, int);
xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_double);
if (xbt_dynar_length(variable->content) > 1) {
- WARN2
- ("You asked for the first value of the config element '%s', but there is %lu values\n",
- name, xbt_dynar_length(variable->content));
+ 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));
}
return xbt_dynar_get_as(variable->content, 0, double);
xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_string);
if (xbt_dynar_length(variable->content) > 1) {
- WARN2
- ("You asked for the first value of the config element '%s', but there is %lu values\n",
- name, xbt_dynar_length(variable->content));
+ 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) {
return NULL;
}
* \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)
+void xbt_cfg_get_peer(xbt_cfg_t cfg, const char *name, char **peer,
+ int *port)
{
xbt_cfgelm_t variable;
xbt_peer_t val;
variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_peer);
if (xbt_dynar_length(variable->content) > 1) {
- WARN2
- ("You asked for the first value of the config element '%s', but there is %lu values\n",
- name, xbt_dynar_length(variable->content));
+ 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));
}
val = xbt_dynar_get_as(variable->content, 0, xbt_peer_t);
#include "xbt/ex.h"
XBT_LOG_EXTERNAL_CATEGORY(xbt_cfg);
+XBT_LOG_DEFAULT_CATEGORY(xbt_cfg);
XBT_TEST_SUITE("config", "Configuration support");
xbt_dynar_t dyn;
xbt_cfg_t myset = make_set();
- xbt_cfg_set_parse(myset, "peername:veloce user:foo\nuser:bar\tuser:toto");
+ xbt_cfg_set_parse(myset,
+ "peername:veloce user:foo\nuser:bar\tuser:toto");
xbt_cfg_set_parse(myset, "speed:42");
xbt_cfg_check(myset);
dyn = xbt_cfg_get_dynar(myset, "user");
xbt_dynar_length(dyn));
if (strcmp(xbt_dynar_get_as(dyn, 0, char *), "foo"))
- xbt_test_fail1("Dynar[0] = %s, I expected foo",
- xbt_dynar_get_as(dyn, 0, char *));
+ xbt_test_fail1("Dynar[0] = %s, I expected foo",
+ xbt_dynar_get_as(dyn, 0, char *));
if (strcmp(xbt_dynar_get_as(dyn, 1, char *), "bar"))
- xbt_test_fail1("Dynar[1] = %s, I expected bar",
- xbt_dynar_get_as(dyn, 1, char *));
+ xbt_test_fail1("Dynar[1] = %s, I expected bar",
+ xbt_dynar_get_as(dyn, 1, char *));
if (strcmp(xbt_dynar_get_as(dyn, 2, char *), "toto"))
- xbt_test_fail1("Dynar[2] = %s, I expected toto",
- xbt_dynar_get_as(dyn, 2, char *));
+ xbt_test_fail1("Dynar[2] = %s, I expected toto",
+ xbt_dynar_get_as(dyn, 2, char *));
xbt_cfg_free(&myset);
}
xbt_cfg_free(&myset);
}
}
-#endif /* SIMGRID_TEST */
+#endif /* SIMGRID_TEST */
