-/* Copyright (c) 2016. The SimGrid Team.
+/* Copyright (c) 2004-2014,2016. 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 <stdio.h>
#include <functional>
#include <string>
+#include <type_traits>
#include <xbt/config.h>
#include <xbt/config.hpp>
+#include "xbt/misc.h"
+#include "xbt/sysdep.h"
+#include "xbt/log.h"
+#include "xbt/ex.h"
+#include "xbt/dynar.h"
+#include "xbt/dict.h"
+
+// *****
+
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_cfg, xbt, "configuration support");
+
+XBT_EXPORT_NO_IMPORT(xbt_cfg_t) simgrid_config = NULL;
+
+namespace {
+
+// We could define some range/iterator for the num values.
+static inline
+void increment(e_xbt_cfgelm_type_t& type)
+{
+ typedef std::underlying_type<e_xbt_cfgelm_type_t>::type underlying_type;
+ type = (e_xbt_cfgelm_type_t) ((underlying_type) type + 1);
+}
+
+}
+
+/* xbt_cfgelm_t: the typedef corresponding to a config variable. */
+
+typedef struct s_xbt_cfgelm_t {
+ /* Description */
+ std::string desc;
+
+ /* Allowed type of the variable */
+ e_xbt_cfgelm_type_t type;
+ bool isdefault = true;
+
+ /* Callbacks */
+ xbt_cfg_cb_t cb_set = nullptr;
+
+ /* Advanced callbacks */
+ xbt_cfg_cb_ext_t cb_set_ext = nullptr;
+ void* cb_set_data = nullptr;
+ xbt_cfg_cb_free_t cb_set_free = nullptr;
+
+ /* actual content (could be an union or something) */
+ xbt_dynar_t content = nullptr;
+
+ ~s_xbt_cfgelm_t()
+ {
+ XBT_DEBUG("Frees cfgelm %p", this);
+ if (!this)
+ return;
+ if (this->cb_set_free)
+ this->cb_set_free(this->cb_set_data);
+ if (this->type != xbt_cfgelm_alias)
+ xbt_dynar_free(&(this->content));
+ }
+
+} s_xbt_cfgelm_t, *xbt_cfgelm_t;
+
+static const char *xbt_cfgelm_type_name[xbt_cfgelm_type_count] = { "int", "double", "string", "boolean", "any", "outofbound" };
+
+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)
+{
+ delete (xbt_cfgelm_t) data;
+}
+
+/* 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 ]-----------------------------------------------*/
+/** @brief Constructor
+ *
+ * Initialise a config set
+ */
+xbt_cfg_t xbt_cfg_new(void)
+{
+ return (xbt_cfg_t) xbt_dict_new_homogeneous(&xbt_cfgelm_free);
+}
+
+/** @brief Destructor */
+void xbt_cfg_free(xbt_cfg_t * cfg)
+{
+ XBT_DEBUG("Frees cfg set %p", cfg);
+ xbt_dict_free((xbt_dict_t *) cfg);
+}
+
+/** @brief Dump 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)
+{
+ xbt_dict_t dict = (xbt_dict_t) cfg;
+ xbt_dict_cursor_t cursor = NULL;
+ xbt_cfgelm_t variable = NULL;
+ char *key = NULL;
+ int i;
+ int size;
+ int ival;
+ char *sval;
+ double dval;
+
+ if (name)
+ printf("%s>> Dumping of the config set '%s':\n", indent, name);
+
+ xbt_dict_foreach(dict, cursor, key, variable) {
+ printf("%s %s:", indent, key);
+
+ size = xbt_dynar_length(variable->content);
+ printf ("%s. Actual size=%d. postset=%p\n",
+ xbt_cfgelm_type_name[variable->type], size, variable->cb_set);
+
+ switch (variable->type) {
+ case xbt_cfgelm_int:
+ 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; 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; i < size; i++) {
+ sval = xbt_dynar_get_as(variable->content, i, char *);
+ printf("%s %s\n", indent, sval);
+ }
+ break;
+ 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);
+ break;
+ }
+ }
+
+ if (name)
+ printf("%s<< End of the config set '%s'\n", indent, name);
+ fflush(stdout);
+
+ xbt_dict_cursor_free(&cursor);
+}
+
+/*----[ Registering stuff ]-----------------------------------------------*/
+/** @brief 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 cb_set callback function called when a value is set
+ */
+static void xbt_cfg_register(
+ xbt_cfg_t * cfg, const char *name, const char *desc, e_xbt_cfgelm_type_t type,
+ xbt_cfg_cb_t cb_set,
+ xbt_cfg_cb_ext_t cb_set_ext, void* cb_set_data, xbt_cfg_cb_free_t cb_set_free)
+{
+ 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_cfgelm_t) xbt_dict_get_or_null((xbt_dict_t) * cfg, name);
+ xbt_assert(NULL == res, "Refusing to register the config element '%s' twice.", name);
+
+ res = new s_xbt_cfgelm_t();
+ XBT_DEBUG("Register cfg elm %s (%s) (%s (=%d) @%p in set %p)",
+ name, desc, xbt_cfgelm_type_name[type], (int)type, res, *cfg);
+ res->type = type;
+ res->desc = desc;
+ res->cb_set = cb_set;
+ res->cb_set_ext = cb_set_ext;
+ res->cb_set_data = cb_set_data;
+ res->cb_set_free = cb_set_free;
+
+ 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_free_ref);
+ break;
+ case xbt_cfgelm_boolean:
+ res->content = xbt_dynar_new(sizeof(int), NULL);
+ break;
+ default:
+ 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_double(const char *name, double default_value,xbt_cfg_cb_t cb_set, const char *desc){
+ xbt_cfg_register(&simgrid_config,name,desc,xbt_cfgelm_double,cb_set, NULL, NULL, NULL);
+ xbt_cfg_setdefault_double(name, default_value);
+}
+void xbt_cfg_register_int(const char *name, int default_value,xbt_cfg_cb_t cb_set, const char *desc) {
+ xbt_cfg_register(&simgrid_config,name,desc,xbt_cfgelm_int,cb_set, NULL, NULL, NULL);
+ xbt_cfg_setdefault_int(name, default_value);
+}
+void xbt_cfg_register_string(const char *name, const char *default_value, xbt_cfg_cb_t cb_set, const char *desc){
+ xbt_cfg_register(&simgrid_config,name,desc,xbt_cfgelm_string,cb_set, NULL, NULL, NULL);
+ xbt_cfg_setdefault_string(name, default_value);
+}
+void xbt_cfg_register_boolean(const char *name, const char*default_value,xbt_cfg_cb_t cb_set, const char *desc){
+ xbt_cfg_register(&simgrid_config,name,desc,xbt_cfgelm_boolean,cb_set, NULL, NULL, NULL);
+ xbt_cfg_setdefault_boolean(name, default_value);
+}
+
+/** Register a config with an extended callback
+ *
+ * @param name Name of the flag
+ * @param desc Description of the flag
+ * @param type Type of the flag
+ * @param cb Extended callback
+ * @param data Data associated with the callback
+ * @param data_free Function used to free the callback data (or NULL)
+ */
+void xbt_cfg_register_ext(const char *name, const char *desc, e_xbt_cfgelm_type_t type,
+ xbt_cfg_cb_ext_t cb, void* data, xbt_cfg_cb_free_t data_free)
+{
+ xbt_cfg_register(&simgrid_config, name, desc, type, NULL, cb, data, data_free);
+}
+
+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_cfgelm_t) xbt_dict_get_or_null((xbt_dict_t) simgrid_config, oldname);
+ xbt_assert(NULL == res, "Refusing to register the option '%s' twice.", oldname);
+
+ res = (xbt_cfgelm_t) xbt_dict_get_or_null((xbt_dict_t) simgrid_config, newname);
+ xbt_assert(res, "Cannot define an alias to the non-existing option '%s'.", newname);
+
+ res = new s_xbt_cfgelm_t();
+ XBT_DEBUG("Register cfg alias %s -> %s)",oldname,newname);
+
+ res->desc = bprintf("Deprecated alias for %s",newname);
+ res->type = xbt_cfgelm_alias;
+ res->content = (xbt_dynar_t)newname;
+
+ xbt_dict_set((xbt_dict_t) simgrid_config, oldname, res, NULL);
+}
+
+/**
+ * @brief Parse a string and register the stuff described.
+ *
+ * @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: \<name\>:\<type\>
+ * with type being one of 'string','int','bool' or 'double'.
+ *
+ * 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)
+{
+ char *entrycpy = xbt_strdup(entry);
+ char *tok;
+
+ e_xbt_cfgelm_type_t type;
+ XBT_DEBUG("Register string '%s'", entry);
+
+ tok = strchr(entrycpy, ':');
+ xbt_assert(tok, "Invalid config element descriptor: %s; Should be <name>:<type>", entry);
+ *(tok++) = '\0';
+
+ for (type = (e_xbt_cfgelm_type_t)0; type < xbt_cfgelm_type_count && strcmp(tok, xbt_cfgelm_type_name[type]); increment(type));
+ xbt_assert(type < xbt_cfgelm_type_count,
+ "Invalid type in config element descriptor: %s; Should be one of 'string', 'int' or 'double'.", entry);
+
+ xbt_cfg_register(cfg, entrycpy, NULL, type, NULL, NULL, NULL, NULL);
+
+ free(entrycpy); /* strdup'ed by dict mechanism, but cannot be const */
+}
+
+/** @brief Displays the declared aliases and their description */
+void xbt_cfg_aliases(void)
+{
+ 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 )simgrid_config, dict_cursor, name, variable)
+ xbt_dynar_push(names, &name);
+ xbt_dynar_sort_strings(names);
+
+ xbt_dynar_foreach(names, dynar_cursor, name) {
+ variable = (xbt_cfgelm_t) xbt_dict_get((xbt_dict_t )simgrid_config, name);
+
+ if (variable->type == xbt_cfgelm_alias)
+ printf(" %s: %s\n", name, variable->desc.c_str());
+ }
+}
+
+/** @brief Displays the declared options and their description */
+void xbt_cfg_help(void)
+{
+ 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 )simgrid_config, dict_cursor, name, variable)
+ xbt_dynar_push(names, &name);
+ xbt_dynar_sort_strings(names);
+
+ xbt_dynar_foreach(names, dynar_cursor, name) {
+ int size;
+ variable = (xbt_cfgelm_t) xbt_dict_get((xbt_dict_t )simgrid_config, name);
+ if (variable->type == xbt_cfgelm_alias)
+ continue;
+
+ printf(" %s: %s\n", name, variable->desc.c_str());
+ printf(" Type: %s; ", xbt_cfgelm_type_name[variable->type]);
+ size = xbt_dynar_length(variable->content);
+ printf("Current value: ");
+
+ if (size != 1)
+ printf(size == 0 ? "n/a\n" : "{ ");
+ for (int 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);
+}
+
+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_cfgelm_t) 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 (!res) {
+ xbt_cfg_help();
+ 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,
+ "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;
+}
+
+/** @brief Get the type of this variable in that configuration set
+ *
+ * @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)
+{
+ xbt_cfgelm_t variable = NULL;
+
+ variable = (xbt_cfgelm_t) 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);
+
+ XBT_DEBUG("type in variable = %d", (int)variable->type);
+ return variable->type;
+}
+
+/*----[ Setting ]---------------------------------------------------------*/
+/** @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.
+ */
+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 = xbt_cfgelm_type_count; /* 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) {
+ 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_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);
+ }
+}
+
+/** @brief Add a NULL-terminated list of pairs {(char*)key, value} to the set
+ *
+ * @param cfg config set to fill
+ * @param name variable name
+ * @param ... variable value
+ */
+void xbt_cfg_set(xbt_cfg_t cfg, const char *name, ...)
+{
+ va_list pa;
+
+ va_start(pa, name);
+ xbt_cfg_set_vargs(cfg, name, pa);
+ va_end(pa);
+}
+
+/** @brief Add values parsed from a string into 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.
+ */
+void xbt_cfg_set_parse(const char *options)
+{
+ if (!options || !strlen(options)) { /* nothing to do */
+ return;
+ }
+ char *optionlist_cpy = xbt_strdup(options);
+
+ XBT_DEBUG("List to parse and set:'%s'", options);
+ char *option = optionlist_cpy;
+ while (1) { /* breaks in the code */
+ if (!option)
+ break;
+ 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' && *option != ',') {
+ XBT_DEBUG("Take %c.", *option);
+ option++;
+ }
+ if (option - name == len) {
+ XBT_DEBUG("Boundary=EOL");
+ option = NULL; /* don't do next iteration */
+ } else {
+ 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++;
+ }
+ if (option - name == len - 1)
+ option = NULL; /* don't do next iteration */
+ }
+ XBT_DEBUG("parse now:'%s'; parse later:'%s'", name, option);
+
+ if (name[0] == ' ' || name[0] == '\n' || name[0] == '\t')
+ continue;
+ if (!strlen(name))
+ 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';
+
+ if (strncmp(name, "contexts/", strlen("contexts/")) && strncmp(name, "path", strlen("path")))
+ XBT_INFO("Configuration change: Set '%s' to '%s'", name, val);
+
+ TRY {
+ xbt_cfg_set_as_string(name,val);
+ } CATCH_ANONYMOUS {
+ free(optionlist_cpy);
+ RETHROW;
+ }
+ }
+ free(optionlist_cpy);
+}
+
+/** @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
+ */
+
+void *xbt_cfg_set_as_string(const char *key, const char *value) {
+ xbt_ex_t e;
+
+ char *ret;
+ volatile xbt_cfgelm_t variable = NULL;
+ int i;
+ double d;
+
+ TRY {
+ while (variable == NULL) {
+ variable = (xbt_cfgelm_t) 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;
+ }
+ }
+ } 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;
+ }
+
+ 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;
+ }
+ return ret;
+}
+
+/** @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(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 = true;
+ } 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(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 = true;
+ } else
+ XBT_DEBUG("Do not override configuration variable '%s' with value '%f' 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(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 = true;
+ } else
+ XBT_DEBUG("Do not override configuration variable '%s' with value '%s' because it was already set.", name, val);
+}
+
+/** @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 (variable->isdefault){
+ xbt_cfg_set_boolean(name, val);
+ variable->isdefault = true;
+ }
+ else
+ XBT_DEBUG("Do not override configuration variable '%s' with value '%s' because it was already set.", name, val);
+}
+
+/** @brief Set an integer value to \a name within \a cfg
+ *
+ * @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);
+
+ xbt_dynar_set(variable->content, 0, &val);
+
+ if (variable->cb_set)
+ variable->cb_set(name);
+ if (variable->cb_set_ext)
+ variable->cb_set_ext(name, variable->cb_set_data);
+ variable->isdefault = false;
+}
+
+/** @brief Set or add a double value to \a name within \a cfg
+ *
+ * @param name the name of the variable
+ * @param val the double to set
+ */
+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);
+
+ if (variable->cb_set)
+ variable->cb_set(name);
+ if (variable->cb_set_ext)
+ variable->cb_set_ext(name, variable->cb_set_data);
+ variable->isdefault = false;
+}
+
+/** @brief Set or add a string value to \a name within \a cfg
+ *
+ * @param cfg the config set
+ * @param name the name of the variable
+ * @param val the value to be added
+ *
+ */
+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);
+
+ if (!xbt_dynar_is_empty(variable->content)) {
+ char *sval = xbt_dynar_get_as(variable->content, 0, char *);
+ free(sval);
+ }
+
+ xbt_dynar_set(variable->content, 0, &newval);
+
+ if (variable->cb_set)
+ variable->cb_set(name);
+ if (variable->cb_set_ext)
+ variable->cb_set_ext(name, variable->cb_set_data);
+ variable->isdefault = false;
+}
+
+/** @brief Set or add a boolean value to \a name within \a cfg
+ *
+ * @param name the name of the variable
+ * @param val the value of the variable
+ */
+void xbt_cfg_set_boolean(const char *name, const char *val)
+{
+ int bval=-1;
+ xbt_cfgelm_t variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_boolean);
+
+ for (int 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;
+ }
+ }
+ xbt_assert(bval != -1, "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);
+
+ if (variable->cb_set)
+ variable->cb_set(name);
+ if (variable->cb_set_ext)
+ variable->cb_set_ext(name, variable->cb_set_data);
+ variable->isdefault = false;
+}
+
+
+/* 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
+ *
+ * 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);
+
+ 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));
+ }
+
+ return xbt_dynar_get_as(variable->content, 0, int);
+}
+
+/** @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
+ *
+ * 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);
+
+ 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));
+ }
+
+ return xbt_dynar_get_as(variable->content, 0, double);
+}
+
+/** @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. Returns NULL if there is no value.
+ *
+ * \warning the returned value is the actual content of the config set
+ */
+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;
+ }
+
+ return xbt_dynar_get_as(variable->content, 0, char *);
+}
+
+/** @brief Retrieve a boolean 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.
+ */
+int xbt_cfg_get_boolean(const char *name)
+{
+ xbt_cfgelm_t variable = xbt_cfgelm_get(simgrid_config, 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",
+ name, xbt_dynar_length(variable->content));
+ }
+
+ return xbt_dynar_get_as(variable->content, 0, int);
+}
namespace simgrid {
namespace config {
}
}
-}
\ No newline at end of file
+}
+
+#ifdef SIMGRID_TEST
+#include "xbt.h"
+#include "xbt/ex.h"
+
+XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_cfg);
+
+XBT_TEST_SUITE("config", "Configuration support");
+
+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:int");
+ xbt_cfg_register_str(&set, "peername:string");
+ xbt_cfg_register_str(&set, "user:string");
+
+ return set;
+} /* end_of_make_set */
+
+XBT_PUBLIC_DATA(xbt_cfg_t) simgrid_config;
+
+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_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 */