X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/1f606358fff6ef994cd58570e7c77ee6259d6a4e..4a69abcc786d029bd2962537f767d12a0f808d11:/src/xbt/config.cpp diff --git a/src/xbt/config.cpp b/src/xbt/config.cpp index 7578fbdfa5..bbbbf29399 100644 --- a/src/xbt/config.cpp +++ b/src/xbt/config.cpp @@ -1,16 +1,23 @@ -/* Copyright (c) 2004-2014,2016. The SimGrid Team. - * All rights reserved. */ +/* 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 +#include #include #include #include + #include #include #include +#include #include +#include +#include #include #include #include "xbt/misc.h" @@ -24,463 +31,501 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_cfg, xbt, "configuration support"); -XBT_EXPORT_NO_IMPORT(xbt_cfg_t) simgrid_config = NULL; +XBT_EXPORT_NO_IMPORT(xbt_cfg_t) simgrid_config = nullptr; +extern "C" { + XBT_PUBLIC(void) sg_config_finalize(); +} + +namespace simgrid { +namespace config { + +missing_key_error::~missing_key_error() = default; + +class Config; namespace { -static inline -void increment(e_xbt_cfgelm_type_t& type) +const char* true_values[] = { + "yes", "on", "true", "1" +}; +const char* false_values[] = { + "no", "off", "false", "0" +}; + +static bool parseBool(const char* value) +{ + for (const char* true_value : true_values) + if (std::strcmp(true_value, value) == 0) + return true; + for (const char* false_value : false_values) + if (std::strcmp(false_value, value) == 0) + return false; + throw std::range_error("not a boolean"); +} + +static double parseDouble(const char* value) { - typedef std::underlying_type::type underlying_type; - type = (e_xbt_cfgelm_type_t) ((underlying_type) type + 1); + char* end; + errno = 0; + double res = std::strtod(value, &end); + if (errno == ERANGE) + throw std::range_error("out of range"); + else if (errno) + xbt_die("Unexpected errno"); + if (end == value || *end != '\0') + throw std::range_error("invalid double"); + else + return res; } +static long int parseLong(const char* value) +{ + char* end; + errno = 0; + long int res = std::strtol(value, &end, 0); + if (errno) { + if (res == LONG_MIN && errno == ERANGE) + throw std::range_error("underflow"); + else if (res == LONG_MAX && errno == ERANGE) + throw std::range_error("overflow"); + xbt_die("Unexpected errno"); + } + if (end == value || *end != '\0') + throw std::range_error("invalid integer"); + else + return res; } -/* xbt_cfgelm_t: the typedef corresponding to a config variable. */ +// ***** ConfigType ***** -typedef struct s_xbt_cfgelm_t { - /* Description */ - std::string desc; +/// A trait which define possible options types: +template struct ConfigType; + +template<> struct ConfigType { + static constexpr const char* type_name = "int"; + static inline double parse(const char* value) + { + return parseLong(value); + } +}; +template<> struct ConfigType { + static constexpr const char* type_name = "double"; + static inline double parse(const char* value) + { + return parseDouble(value); + } +}; +template<> struct ConfigType { + static constexpr const char* type_name = "string"; + static inline std::string parse(const char* value) + { + return std::string(value); + } +}; +template<> struct ConfigType { + static constexpr const char* type_name = "boolean"; + static inline bool parse(const char* value) + { + return parseBool(value); + } +}; + +// **** Forward declarations **** + +class ConfigurationElement ; +template class TypedConfigurationElement; + +// **** ConfigurationElement **** - /* Allowed type of the variable */ - e_xbt_cfgelm_type_t type; +class ConfigurationElement { +protected: + std::string key; + std::string desc; bool isdefault = true; +public: + /* Callback */ - xbt_cfg_cb_t cb_set = nullptr; + xbt_cfg_cb_t old_callback = nullptr; + + ConfigurationElement(const char* key, const char* desc) + : key(key ? key : ""), desc(desc ? desc : "") {} + ConfigurationElement(const char* key, const char* desc, xbt_cfg_cb_t cb) + : key(key ? key : ""), desc(desc ? desc : ""), old_callback(cb) {} + + virtual ~ConfigurationElement()=default; + + virtual std::string getStringValue() = 0; + virtual void setStringValue(const char* value) = 0; + virtual const char* getTypeName() = 0; - /* Advanced callback (for xbt_cfgelm_string only) */ - std::function callback; + template + T const& getValue() const + { + return dynamic_cast&>(*this).getValue(); + } + template + void setValue(T value) + { + dynamic_cast&>(*this).setValue(std::move(value)); + } + template + void setDefaultValue(T value) + { + dynamic_cast&>(*this).setDefaultValue(std::move(value)); + } + bool isDefault() const { return isdefault; } - /* actual content (could be an union or something) */ - xbt_dynar_t content = nullptr; + std::string const& getDescription() const { return desc; } +}; - ~s_xbt_cfgelm_t() +// **** TypedConfigurationElement **** + +// TODO, could we use boost::any with some Type* reference? +template +class TypedConfigurationElement : public ConfigurationElement { +private: + T content; + std::function callback; + +public: + TypedConfigurationElement(const char* key, const char* desc, T value = T()) + : ConfigurationElement(key, desc), content(std::move(value)) + {} + TypedConfigurationElement(const char* key, const char* desc, T value, + xbt_cfg_cb_t cb) + : ConfigurationElement(key, desc, cb), content(std::move(value)) + {} + TypedConfigurationElement(const char* key, const char* desc, T value, + std::function callback) + : ConfigurationElement(key, desc), content(std::move(value)), + callback(std::move(callback)) + {} + ~TypedConfigurationElement()=default; + + std::string getStringValue() override; + const char* getTypeName() override; + void setStringValue(const char* value) override; + + void update() { - XBT_DEBUG("Frees cfgelm %p", this); - if (this->type != xbt_cfgelm_alias) - xbt_dynar_free(&(this->content)); + if (old_callback) + this->old_callback(key.c_str()); + if (this->callback) + this->callback(this->content); } -} s_xbt_cfgelm_t, *xbt_cfgelm_t; + T const& getValue() const { return content; } -static const char *xbt_cfgelm_type_name[xbt_cfgelm_type_count] = { "int", "double", "string", "boolean", "any", "outofbound" }; + void setValue(T value) + { + this->content = std::move(value); + this->update(); + } -const struct xbt_boolean_couple xbt_cfgelm_boolean_values[] = { - { "yes", "no"}, - { "on", "off"}, - {"true", "false"}, - { "1", "0"}, - { NULL, NULL} + void setDefaultValue(T value) + { + if (this->isdefault) { + this->content = std::move(value); + this->update(); + } else { + XBT_DEBUG("Do not override configuration variable '%s' with value '%s'" + " because it was already set.", key.c_str(), to_string(value).c_str()); + } + } }; -/* Internal stuff used in cache to free a variable */ -static void xbt_cfgelm_free(void *data) +template +std::string TypedConfigurationElement::getStringValue() // override { - if (data) - delete (xbt_cfgelm_t) data; + return to_string(content); } -/* 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) +template +void TypedConfigurationElement::setStringValue(const char* value) // override { - return (xbt_cfg_t) xbt_dict_new_homogeneous(&xbt_cfgelm_free); + this->content = ConfigType::parse(value); + this->isdefault = false; + this->update(); } -/** @brief Destructor */ -void xbt_cfg_free(xbt_cfg_t * cfg) +template +const char* TypedConfigurationElement::getTypeName() // override { - XBT_DEBUG("Frees cfg set %p", cfg); - xbt_dict_free((xbt_dict_t *) cfg); + return ConfigType::type_name; } -/** @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; +} // end of anonymous namespace - if (name) - printf("%s>> Dumping of the config set '%s':\n", indent, name); +// **** Config **** - xbt_dict_foreach(dict, cursor, key, variable) { - printf("%s %s:", indent, key); +class Config { +private: + // name -> ConfigElement: + xbt_dict_t options; + // alias -> xbt_dict_elm_t from options: + xbt_dict_t aliases; - size = xbt_dynar_length(variable->content); - printf ("%s. Actual size=%d. postset=%p\n", - xbt_cfgelm_type_name[variable->type], size, variable->cb_set); +public: + Config(); + ~Config(); - 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; - } + // No copy: + Config(Config const&) = delete; + Config& operator=(Config const&) = delete; + + ConfigurationElement& operator[](const char* name); + template + TypedConfigurationElement& getTyped(const char* name); + void alias(const char* realname, const char* aliasname); + + template + simgrid::config::TypedConfigurationElement* + registerOption(const char* name, A&&... a) + { + xbt_assert(xbt_dict_get_or_null(this->options, name) == nullptr, + "Refusing to register the config element '%s' twice.", name); + TypedConfigurationElement* variable = + new TypedConfigurationElement(name, std::forward(a)...); + XBT_DEBUG("Register cfg elm %s (%s) of type %s @%p in set %p)", + name, + variable->getDescription().c_str(), + variable->getTypeName(), variable, this); + xbt_dict_set(this->options, name, variable, nullptr); + variable->update(); + return variable; } - if (name) - printf("%s<< End of the config set '%s'\n", indent, name); - fflush(stdout); + // Debug: + void dump(const char *name, const char *indent); + void showAliases(); + void help(); - xbt_dict_cursor_free(&cursor); -} +protected: + xbt_dictelm_t getDictElement(const char* name); +}; -/*----[ 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, - std::function callback = std::function()) -{ - 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; - if (desc) - res->desc = desc; - res->cb_set = cb_set; - res->callback = std::move(callback); - - 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); - 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); - 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); - 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); - 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(); +/* Internal stuff used in cache to free a variable */ +static void xbt_cfgelm_free(void *data) +{ + if (data) + delete (simgrid::config::ConfigurationElement*) data; +} - 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); +Config::Config() : + options(xbt_dict_new_homogeneous(xbt_cfgelm_free)), + aliases(xbt_dict_new_homogeneous(nullptr)) +{} - 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); +Config::~Config() +{ + XBT_DEBUG("Frees cfg set %p", this); + xbt_dict_free(&this->options); + xbt_dict_free(&this->aliases); +} - res = new s_xbt_cfgelm_t(); - XBT_DEBUG("Register cfg alias %s -> %s)",oldname,newname); +inline +xbt_dictelm_t Config::getDictElement(const char* name) +{ + // We are interested in the options dictelm: + xbt_dictelm_t res = xbt_dict_get_elm_or_null(options, name); + if (res) + return res; + // The aliases dict stores pointers to the options dictelm: + res = (xbt_dictelm_t) xbt_dict_get_or_null(aliases, name); + if (res) + XBT_INFO("Option %s has been renamed to %s. Consider switching.", name, res->key); + return res; +} - res->desc = bprintf("Deprecated alias for %s",newname); - res->type = xbt_cfgelm_alias; - res->content = (xbt_dynar_t)newname; +inline +ConfigurationElement& Config::operator[](const char* name) +{ + xbt_dictelm_t elm = getDictElement(name); + if (elm == nullptr) + throw simgrid::config::missing_key_error(std::string("Bad config key, ") + name); + return *(ConfigurationElement*)elm->content; +} - xbt_dict_set((xbt_dict_t) simgrid_config, oldname, res, NULL); +void Config::alias(const char* realname, const char* aliasname) +{ + xbt_assert(this->getDictElement(aliasname) == nullptr, "Alias '%s' already.", aliasname); + xbt_dictelm_t element = this->getDictElement(realname); + xbt_assert(element, "Cannot define an alias to the non-existing option '%s'.", realname); + xbt_dict_set(this->aliases, aliasname, element, nullptr); } -/** - * @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: \:\ - * with type being one of 'string','int','bool' or 'double'. +/** @brief Dump a config set for debuging purpose * - * Note that this does not allow to set the description, so you should prefer the other interface + * @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) */ -void xbt_cfg_register_str(xbt_cfg_t * cfg, const char *entry) +void Config::dump(const char *name, const char *indent) { - char *entrycpy = xbt_strdup(entry); - char *tok; - - e_xbt_cfgelm_type_t type; - XBT_DEBUG("Register string '%s'", entry); + xbt_dict_t dict = this->options; + xbt_dict_cursor_t cursor = nullptr; + simgrid::config::ConfigurationElement* variable = nullptr; + char *key = nullptr; - tok = strchr(entrycpy, ':'); - xbt_assert(tok, "Invalid config element descriptor: %s; Should be :", entry); - *(tok++) = '\0'; + if (name) + printf("%s>> Dumping of the config set '%s':\n", indent, name); - 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_dict_foreach(dict, cursor, key, variable) + printf("%s %s: ()%s) %s", indent, key, + variable->getTypeName(), + variable->getStringValue().c_str()); - xbt_cfg_register(cfg, entrycpy, NULL, type, NULL); + if (name) + printf("%s<< End of the config set '%s'\n", indent, name); + fflush(stdout); - free(entrycpy); /* strdup'ed by dict mechanism, but cannot be const */ + xbt_dict_cursor_free(&cursor); } /** @brief Displays the declared aliases and their description */ -void xbt_cfg_aliases(void) +void Config::showAliases() { xbt_dict_cursor_t dict_cursor; - unsigned int dynar_cursor; - xbt_cfgelm_t variable; + xbt_dictelm_t dictel; char *name; - xbt_dynar_t names = xbt_dynar_new(sizeof(char *), NULL); + std::vector names; - xbt_dict_foreach((xbt_dict_t )simgrid_config, dict_cursor, name, variable) - xbt_dynar_push(names, &name); - xbt_dynar_sort_strings(names); + xbt_dict_foreach(this->aliases, dict_cursor, name, dictel) + names.push_back(name); + std::sort(names.begin(), names.end()); - 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()); - } + for (auto name : names) + printf(" %s: %s\n", name, (*this)[name].getDescription().c_str()); } /** @brief Displays the declared options and their description */ -void xbt_cfg_help(void) +void Config::help() { xbt_dict_cursor_t dict_cursor; - unsigned int dynar_cursor; - xbt_cfgelm_t variable; + simgrid::config::ConfigurationElement* variable; char *name; - xbt_dynar_t names = xbt_dynar_new(sizeof(char *), NULL); + std::vector names; - xbt_dict_foreach((xbt_dict_t )simgrid_config, dict_cursor, name, variable) - xbt_dynar_push(names, &name); - xbt_dynar_sort_strings(names); + xbt_dict_foreach(this->options, dict_cursor, name, variable) + names.push_back(name); + std::sort(names.begin(), names.end()); - 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; - } - } + for (auto name : names) { + variable = (simgrid::config::ConfigurationElement*) xbt_dict_get(this->options, name); + printf(" %s: %s\n", name, variable->getDescription().c_str()); + printf(" Type: %s; ", variable->getTypeName()); + printf("Current value: %s\n", variable->getStringValue().c_str()); } - xbt_dynar_free(&names); } -static xbt_cfgelm_t xbt_cfgelm_get(xbt_cfg_t cfg, const char *name, e_xbt_cfgelm_type_t type) +// ***** getConfig ***** + +template +XBT_PUBLIC(T const&) getConfig(const char* name) { - xbt_cfgelm_t res = (xbt_cfgelm_t) xbt_dict_get_or_null((xbt_dict_t) cfg, name); + return (*simgrid_config)[name].getValue(); +} - // 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); - } +template XBT_PUBLIC(int const&) getConfig(const char* name); +template XBT_PUBLIC(double const&) getConfig(const char* name); +template XBT_PUBLIC(bool const&) getConfig(const char* name); +template XBT_PUBLIC(std::string const&) getConfig(const char* name); - if (!res) { - xbt_cfg_help(); - fflush(stdout); - THROWF(not_found_error, 0, "No registered variable '%s' in this config set.", name); - } +// ***** alias ***** - 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; +void alias(const char* realname, const char* aliasname) +{ + simgrid_config->alias(realname, aliasname); } -/** @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) +// ***** declareFlag ***** + +template +XBT_PUBLIC(void) declareFlag(const char* name, const char* description, + T value, std::function callback) { - xbt_cfgelm_t variable = NULL; + if (simgrid_config == nullptr) { + simgrid_config = xbt_cfg_new(); + atexit(sg_config_finalize); + } + simgrid_config->registerOption( + name, description, std::move(value), std::move(callback)); +} - 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); +template XBT_PUBLIC(void) declareFlag(const char* name, + const char* description, int value, std::function callback); +template XBT_PUBLIC(void) declareFlag(const char* name, + const char* description, double value, std::function callback); +template XBT_PUBLIC(void) declareFlag(const char* name, + const char* description, bool value, std::function callback); +template XBT_PUBLIC(void) declareFlag(const char* name, + const char* description, std::string value, std::function callback); - 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) +// ***** C bindings ***** + +xbt_cfg_t xbt_cfg_new() { return new simgrid::config::Config(); } +void xbt_cfg_free(xbt_cfg_t * cfg) { delete *cfg; } + +void xbt_cfg_dump(const char *name, const char *indent, xbt_cfg_t cfg) +{ + cfg->dump(name, indent); +} + +/*----[ Registering stuff ]-----------------------------------------------*/ + +void xbt_cfg_register_double(const char *name, double default_value, + xbt_cfg_cb_t cb_set, const char *desc) { - 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 */ + if (simgrid_config == nullptr) + simgrid_config = xbt_cfg_new(); + simgrid_config->registerOption(name, desc, default_value, cb_set); +} - xbt_ex_t e; +void xbt_cfg_register_int(const char *name, int default_value,xbt_cfg_cb_t cb_set, const char *desc) +{ + if (simgrid_config == nullptr) { + simgrid_config = xbt_cfg_new(); + atexit(&sg_config_finalize); + } + simgrid_config->registerOption(name, desc, default_value, cb_set); +} - TRY { - type = xbt_cfg_get_type(cfg, name); +void xbt_cfg_register_string(const char *name, const char *default_value, xbt_cfg_cb_t cb_set, const char *desc) +{ + if (simgrid_config == nullptr) { + simgrid_config = xbt_cfg_new(); + atexit(sg_config_finalize); } - 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, ...) + simgrid_config->registerOption(name, desc, + default_value ? default_value : "", cb_set); +} + +void xbt_cfg_register_boolean(const char *name, const char*default_value,xbt_cfg_cb_t cb_set, const char *desc) { - va_list pa; + if (simgrid_config == nullptr) { + simgrid_config = xbt_cfg_new(); + atexit(sg_config_finalize); + } + simgrid_config->registerOption(name, desc, simgrid::config::parseBool(default_value), cb_set); +} - va_start(pa, name); - xbt_cfg_set_vargs(cfg, name, pa); - va_end(pa); +void xbt_cfg_register_alias(const char *realname, const char *aliasname) +{ + if (simgrid_config == nullptr) { + simgrid_config = xbt_cfg_new(); + atexit(sg_config_finalize); + } + simgrid_config->alias(realname, aliasname); } +void xbt_cfg_aliases() { simgrid_config->showAliases(); } +void xbt_cfg_help() { simgrid_config->help(); } + +/*----[ Setting ]---------------------------------------------------------*/ + /** @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 ',' @@ -512,7 +557,7 @@ void xbt_cfg_set_parse(const char *options) } if (option - name == len) { XBT_DEBUG("Boundary=EOL"); - option = NULL; /* don't do next iteration */ + option = nullptr; /* 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 */ @@ -522,7 +567,7 @@ void xbt_cfg_set_parse(const char *options) option++; } if (option - name == len - 1) - option = NULL; /* don't do next iteration */ + option = nullptr; /* don't do next iteration */ } XBT_DEBUG("parse now:'%s'; parse later:'%s'", name, option); @@ -536,80 +581,53 @@ void xbt_cfg_set_parse(const char *options) /* 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"))) + if (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; + try { + (*simgrid_config)[name].setStringValue(val); + } + catch (simgrid::config::missing_key_error& e) { + goto on_missing_key; + } + catch (...) { + goto on_exception; } } + + free(optionlist_cpy); + return; + + /* Do not THROWF from a C++ exception catching context, or some cleanups will be missing */ +on_missing_key: free(optionlist_cpy); + THROWF(not_found_error, 0, "Could not set variables %s", options); + return; +on_exception: + free(optionlist_cpy); + THROWF(unknown_error, 0, "Could not set variables %s", options); } +// Horrible mess to translate C++ exceptions to C exceptions: +// Exit from the catch blog (and do the correct exceptio cleaning) +// before attempting to THROWF. +#define TRANSLATE_EXCEPTIONS(...) \ + catch(simgrid::config::missing_key_error& e) { THROWF(not_found_error, 0, __VA_ARGS__); abort(); } \ + catch(...) { THROWF(not_found_error, 0, __VA_ARGS__); abort(); } + /** @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; +void xbt_cfg_set_as_string(const char *key, const char *value) +{ + try { + (*simgrid_config)[key].setStringValue(value); + return; } - return ret; + TRANSLATE_EXCEPTIONS("Could not set variable %s as string %s", key, value); } /** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet @@ -617,15 +635,14 @@ void *xbt_cfg_set_as_string(const char *key, const char *value) { * 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) +void xbt_cfg_setdefault_int(const char *key, int value) { - 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); + try { + (*simgrid_config)[key].setDefaultValue(value); + return; + } + TRANSLATE_EXCEPTIONS("Could not set variable %s to default integer %i", + key, value); } /** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet @@ -633,15 +650,14 @@ void xbt_cfg_setdefault_int(const char *name, int 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_double(const char *name, double val) +void xbt_cfg_setdefault_double(const char *key, double value) { - 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); + try { + (*simgrid_config)[key].setDefaultValue(value); + return; + } + TRANSLATE_EXCEPTIONS("Could not set variable %s to default double %f", + key, value); } /** @brief Set a string value to \a name within \a cfg if it wasn't changed yet @@ -649,15 +665,14 @@ void xbt_cfg_setdefault_double(const char *name, double 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) +void xbt_cfg_setdefault_string(const char *key, const char *value) { - 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); + try { + (*simgrid_config)[key].setDefaultValue(value ? value : ""); + return; + } + TRANSLATE_EXCEPTIONS("Could not set variable %s to default string %s", + key, value); } /** @brief Set an boolean value to \a name within \a cfg if it wasn't changed yet @@ -665,266 +680,147 @@ void xbt_cfg_setdefault_string(const char *name, const char *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_boolean(const char *name, const char *val) +void xbt_cfg_setdefault_boolean(const char *key, const char *value) { - 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; + try { + (*simgrid_config)[key].setDefaultValue(simgrid::config::parseBool(value)); + return; } - else - XBT_DEBUG("Do not override configuration variable '%s' with value '%s' because it was already set.", name, val); + TRANSLATE_EXCEPTIONS("Could not set variable %s to default boolean %s", + key, value); } /** @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 + * @param key the name of the variable + * @param value the value of the variable */ -void xbt_cfg_set_int(const char *name, int val) +void xbt_cfg_set_int(const char *key, int value) { - 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); - variable->isdefault = false; + try { + (*simgrid_config)[key].setValue(value); + return; + } + TRANSLATE_EXCEPTIONS("Could not set variable %s to integer %i", + key, value); } /** @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 + * @param key the name of the variable + * @param value the double to set */ -void xbt_cfg_set_double(const char *name, double val) +void xbt_cfg_set_double(const char *key, double value) { - 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); - variable->isdefault = false; + try { + (*simgrid_config)[key].setValue(value); + return; + } + TRANSLATE_EXCEPTIONS("Could not set variable %s to double %f", + key, value); } /** @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 + * @param key the name of the variable + * @param value the value to be added * */ -void xbt_cfg_set_string(const char *name, const char *val) +void xbt_cfg_set_string(const char *key, const char *value) { - 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->callback) { - try { - variable->callback(val); - } - catch(std::range_error& e) { - xbt_die("Invalid flag %s=%s: %s", val, name, e.what()); - } - catch(std::exception& e) { - xbt_die("Error for flag %s=%s: %s", val, name, e.what()); - } - catch(...) { - xbt_die("Error for flag %s=%s", val, name); - } + try { + (*simgrid_config)[key].setValue(value ? value : ""); + return; } - - variable->isdefault = false; + TRANSLATE_EXCEPTIONS("Could not set variable %s to string %s", + key, value); } /** @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 + * @param key the name of the variable + * @param value the value of the variable */ -void xbt_cfg_set_boolean(const char *name, const char *val) +void xbt_cfg_set_boolean(const char *key, const char *value) { - 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; - } + try { + (*simgrid_config)[key].setValue(simgrid::config::parseBool(value)); + return; } - 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); - variable->isdefault = false; + TRANSLATE_EXCEPTIONS("Could not set variable %s to boolean %s", + key, value); } /* Say if the value is the default value */ -int xbt_cfg_is_default_value(const char *name) +int xbt_cfg_is_default_value(const char *key) { - xbt_cfgelm_t variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_any); - return variable->isdefault; + try { + return (*simgrid_config)[key].isDefault() ? 1 : 0; + } + TRANSLATE_EXCEPTIONS("Could not get variable %s", key); } /*----[ Getting ]---------------------------------------------------------*/ /** @brief Retrieve an integer value of a variable (get a warning if not uniq) * - * @param name the name of the variable + * @param key 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) +int xbt_cfg_get_int(const char *key) { - 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)); + try { + return (*simgrid_config)[key].getValue(); } - - return xbt_dynar_get_as(variable->content, 0, int); + TRANSLATE_EXCEPTIONS("Could not get variable %s", key); } /** @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 + * @param key 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) +double xbt_cfg_get_double(const char *key) { - 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)); + try { + return (*simgrid_config)[key].getValue(); } - - return xbt_dynar_get_as(variable->content, 0, double); + TRANSLATE_EXCEPTIONS("Could not get variable %s", key); } /** @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 + * @param key 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. + * If there is more than one value, it will issue a warning. + * Returns nullptr 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) +char *xbt_cfg_get_string(const char *key) { - 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; + try { + return (char*) (*simgrid_config)[key].getValue().c_str(); } - - return xbt_dynar_get_as(variable->content, 0, char *); + TRANSLATE_EXCEPTIONS("Could not get variable %s", key); } /** @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 + * @param key 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. */ -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 { - -bool parseBool(const char* value) +int xbt_cfg_get_boolean(const char *key) { - for (int i = 0; xbt_cfgelm_boolean_values[i].true_val != NULL; i++) { - if (std::strcmp(value, xbt_cfgelm_boolean_values[i].true_val) == 0) - return true; - if (std::strcmp(value, xbt_cfgelm_boolean_values[i].false_val) == 0) - return false; + try { + return (*simgrid_config)[key].getValue() ? 1 : 0; } - throw std::range_error("not a boolean"); -} - -double parseDouble(const char* value) -{ - char* end; - errno = 0; - double res = std::strtod(value, &end); - if (errno == ERANGE) - throw std::range_error("out of range"); - else if (errno) - xbt_die("Unexpected errno"); - if (end == value || *end != '\0') - throw std::range_error("invalid double"); - else - return res; -} - -long int parseLong(const char* value) -{ - char* end; - errno = 0; - long int res = std::strtol(value, &end, 0); - if (errno) { - if (res == LONG_MIN && errno == ERANGE) - throw std::range_error("underflow"); - else if (res == LONG_MAX && errno == ERANGE) - throw std::range_error("overflow"); - xbt_die("Unexpected errno"); - } - if (end == value || *end != '\0') - throw std::range_error("invalid integer"); - else - return res; -} - -void declareFlag(const char* name, const char* description, - std::function callback) -{ - xbt_cfg_register(&simgrid_config, name, description, xbt_cfgelm_string, NULL, - std::move(callback)); -} - -} + TRANSLATE_EXCEPTIONS("Could not get variable %s", key); } #ifdef SIMGRID_TEST @@ -933,6 +829,7 @@ void declareFlag(const char* name, const char* description, #include "xbt.h" #include "xbt/ex.h" +#include #include @@ -940,31 +837,31 @@ 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_PUBLIC_DATA(xbt_cfg_t) simgrid_config; +static void make_set() +{ + simgrid_config = nullptr; 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; + xbt_cfg_register_int("speed", 0, nullptr, ""); + xbt_cfg_register_string("peername", "", nullptr, ""); + xbt_cfg_register_string("user", "", nullptr, ""); } /* 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(); + auto temp = 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); + simgrid_config = temp; } XBT_TEST_UNIT("use", test_config_use, "Data retrieving tests") { - simgrid_config = make_set(); + auto temp = simgrid_config; + make_set(); xbt_test_add("Get a single value"); { /* get_single_value */ @@ -978,22 +875,21 @@ XBT_TEST_UNIT("use", test_config_use, "Data retrieving tests") xbt_test_add("Access to a non-existant entry"); { - xbt_ex_t e; - - TRY { + try { xbt_cfg_set_parse("color:blue"); - } CATCH(e) { + } catch(xbt_ex& e) { if (e.category != not_found_error) xbt_test_exception(e); - xbt_ex_free(e); } } xbt_cfg_free(&simgrid_config); + simgrid_config = temp; } XBT_TEST_UNIT("c++flags", test_config_cxx_flags, "C++ flags") { - simgrid_config = make_set(); + auto temp = simgrid_config; + make_set(); xbt_test_add("C++ declaration of flags"); simgrid::config::Flag int_flag("int", "", 0); @@ -1011,6 +907,7 @@ XBT_TEST_UNIT("c++flags", test_config_cxx_flags, "C++ flags") xbt_test_assert(!bool_flag2, "Check bool2 flag"); xbt_cfg_free(&simgrid_config); + simgrid_config = temp; } #endif /* SIMGRID_TEST */