/* 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 <stdio.h>
#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 <stdio.h>
#include "xbt/config.h" /* prototypes of this module */
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", "boolean", "peer", "any" };
+ { "int", "double", "string", "boolean", "any" };
const struct xbt_boolean_couple xbt_cfgelm_boolean_values[] = {
{ "yes", "no"},
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);
}
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", indent, hval->name, hval->port);
- }
+ case xbt_cfgelm_alias:
+ /* no content */
break;
default:
printf("%s Invalid type!!\n", indent);
+ break;
}
}
fflush(stdout);
xbt_dict_cursor_free(&cursor);
- return;
}
/*
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);
}
* @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, int min,
int max, xbt_cfg_cb_t cb_set, xbt_cfg_cb_t cb_rm)
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, (int)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], (int)type, res,
- *cfg);
+ name, desc, min, max, xbt_cfgelm_type_name[type], (int)type, res, *cfg);
res->desc = xbt_strdup(desc);
res->type = type;
res->content = xbt_dynar_new(sizeof(int), NULL);
break;
- case xbt_cfgelm_peer:
- res->content = xbt_dynar_new(sizeof(xbt_peer_t), xbt_peer_free_voidp);
- break;
-
default:
- XBT_ERROR("%d is an invalide type code", (int)type);
+ XBT_ERROR("%d is an invalid type code", (int)type);
+ break;
}
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.
*
* @param cfg the config set
- * @param name the name of the elem to be freed
+ * @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.
*
* The string may consist in several variable descriptions separated by a space.
* Each of them must use the following syntax: \<name\>:\<min nb\>_to_\<max nb\>_\<type\>
- * 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)
&& 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, 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)
{
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);
}
size = xbt_dynar_length(variable->content);
printf("Current value%s: ", (size <= 1 ? "" : "s"));
break;
}
- case xbt_cfgelm_peer: {
- xbt_peer_t hval = xbt_dynar_get_as(variable->content, i, xbt_peer_t);
- printf("%s:%d%s", hval->name, hval->port, sep);
- break;
- }
-
default:
printf("Invalid type!!%s", sep);
}
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);
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,
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,
}
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);
val = strchr(name, ':');
if (!val) {
/* don't free(optionlist_cpy) here, 'name' points inside it */
- xbt_die("Option '%s' badly formated. Should be of the form 'name:value'",
+ xbt_die("Option '%s' badly formatted. Should be of the form 'name:value'",
name);
}
*(val++) = '\0';
volatile xbt_cfgelm_t variable = NULL;
int i;
double d;
- char *str, *val;
-
TRY {
- variable = xbt_dict_get((xbt_dict_t) cfg, key);
+ 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);
+ THROWF(not_found_error, 0, "No registered variable corresponding to '%s'.", key);
}
RETHROW;
}
case xbt_cfgelm_boolean:
xbt_cfg_set_boolean(cfg, key, value); /* throws */
- break;
-
- case xbt_cfgelm_peer:
- val = xbt_strdup(value);
- str = val;
- val = strchr(val, ':');
- if (!val) {
- xbt_die("Value of option %s not valid. Should be an peer (machine:port)", key);
- }
-
- *(val++) = '\0';
- i = strtol(val, &ret, 0);
- if (ret == val) {
- xbt_die("Value of option %s not valid. Should be an peer (machine:port)", key);
- }
-
- xbt_cfg_set_peer(cfg, key, str, i); /* throws */
- free(val);
+ ret = (char *)value + strlen(value);
break;
default:
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
*
* @param cfg the config set
*/
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_is_empty(variable->content))
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_is_empty(variable->content))
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], (int)variable->type, variable);
+ variable->min, variable->max, xbt_cfgelm_type_name[variable->type], (int)variable->type, variable);
if (variable->max == 1) {
if (!xbt_dynar_is_empty(variable->content)) {
*/
void xbt_cfg_set_boolean(xbt_cfg_t cfg, const char *name, const char *val)
{
- xbt_cfgelm_t variable;
int i, bval;
XBT_VERB("Configuration setting: %s=%s", name, val);
- variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_boolean);
+ xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, 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 (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);
variable->isdefault = 0;
}
-/** @brief Set or add an peer value to \a name within \a cfg
- *
- * @param cfg the config set
- * @param name the name of the variable
- * @param peer the peer
- * @param port the port number
- *
- * \e peer values are composed of a string (peername) and an integer (port)
- */
-
-void
-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);
-
- XBT_VERB("Configuration setting: %s=%s:%d", name, peer, port);
-
- variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_peer);
-
- if (variable->max == 1) {
- if (variable->cb_rm && !xbt_dynar_is_empty(variable->content))
- variable->cb_rm(name, 0);
-
- xbt_dynar_set(variable->content, 0, &val);
- } else {
- if (variable->max
- && xbt_dynar_length(variable->content) == 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);
-
- xbt_dynar_push(variable->content, &val);
- }
-
- if (variable->cb_set)
- variable->cb_set(name, xbt_dynar_length(variable->content) - 1);
- variable->isdefault = 0;
-}
-
/* ---- [ Removing ] ---- */
/** @brief Remove the provided \e val integer value from a variable
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,
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,
*/
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,
void xbt_cfg_rm_boolean(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_boolean);
+ xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_boolean);
if (xbt_dynar_length(variable->content) == variable->min)
THROWF(mismatch_error, 0,
val, name);
}
-/** @brief Remove the provided \e val peer value from a variable
- *
- * @param cfg the config set
- * @param name the name of the variable
- * @param peer the peername
- * @param port the port number
- */
-
-void
-xbt_cfg_rm_peer(xbt_cfg_t cfg, const char *name, const char *peer,
- int port)
-{
- xbt_cfgelm_t variable;
- unsigned int cpt;
- xbt_peer_t seen;
-
- variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_peer);
-
- 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);
-
- xbt_dynar_foreach(variable->content, cpt, seen) {
- if (!strcpy(seen->name, peer) && seen->port == port) {
- if (variable->cb_rm)
- 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);
-}
-
/** @brief Remove the \e pos th value from the provided variable */
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,
return xbt_dynar_get_as(variable->content, 0, int);
}
-/** @brief Retrieve an peer value of a variable (get a warning if not uniq)
- *
- * @param cfg the config set
- * @param name the name of the variable
- * @param peer the peer
- * @param 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
- */
-
-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) {
- 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);
- *peer = val->name;
- *port = val->port;
-}
-
/** @brief Retrieve the dynar of all the values stored in a variable
*
* @param cfg where to search in
return xbt_dynar_get_as(variable->content, pos, int);
}
-/** @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)
-{
-
- 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;
-}
-
#ifdef SIMGRID_TEST
#include "xbt.h"
