X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/9c134fb43e3965db16815a46839ab063e2b05282..83a986331633ba19391ce14e6605a5b423311ad7:/src/xbt/config.cpp diff --git a/src/xbt/config.cpp b/src/xbt/config.cpp index 45c09e8b05..4c3b69eba1 100644 --- a/src/xbt/config.cpp +++ b/src/xbt/config.cpp @@ -1,131 +1,259 @@ -/* Copyright (c) 2004-2014,2016. The SimGrid Team. - * All rights reserved. */ +/* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved. */ -#include +/* 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 +#include "simgrid/sg_config.hpp" +#include "xbt/dynar.h" +#include "xbt/log.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 +#include +#include XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_cfg, xbt, "configuration support"); -XBT_EXPORT_NO_IMPORT(xbt_cfg_t) simgrid_config = NULL; - -/** @brief possible content of each configuration cell */ -typedef enum { - xbt_cfgelm_int = 0, /**< int */ - xbt_cfgelm_double, /**< double */ - xbt_cfgelm_string, /**< char* */ - xbt_cfgelm_boolean, /**< int */ - //! @cond - xbt_cfgelm_any, /* not shown to users to prevent errors */ - xbt_cfgelm_type_count - //! @endcond -} e_xbt_cfgelm_type_t; +XBT_EXPORT_NO_IMPORT xbt_cfg_t simgrid_config = nullptr; +namespace simgrid { +namespace 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 parse_bool(const char* value) { - typedef std::underlying_type::type underlying_type; - type = (e_xbt_cfgelm_type_t) ((underlying_type) type + 1); + for (const char* const& true_value : true_values) + if (std::strcmp(true_value, value) == 0) + return true; + for (const char* const& false_value : false_values) + if (std::strcmp(false_value, value) == 0) + return false; + throw std::range_error("not a boolean"); } +static double parse_double(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; } -static const char *xbt_cfgelm_type_name[xbt_cfgelm_type_count] = { - "int", "double", "string", "boolean", "any" -}; +static long int parse_long(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; +} -/** Boolean possible values **/ -struct xbt_boolean_couple { - const char *true_val; - const char *false_val; -}; +// ***** ConfigType ***** + +/// A trait which define possible options types: +template class ConfigType; -const struct xbt_boolean_couple xbt_cfgelm_boolean_values[] = { - { "yes", "no"}, - { "on", "off"}, - {"true", "false"}, - { "1", "0"}, - { NULL, NULL} +template <> class ConfigType { +public: + static constexpr const char* type_name = "int"; + static inline double parse(const char* value) + { + return parse_long(value); + } +}; +template <> class ConfigType { +public: + static constexpr const char* type_name = "double"; + static inline double parse(const char* value) + { + return parse_double(value); + } +}; +template <> class ConfigType { +public: + static constexpr const char* type_name = "string"; + static inline std::string parse(const char* value) + { + return std::string(value); + } +}; +template <> class ConfigType { +public: + static constexpr const char* type_name = "boolean"; + static inline bool parse(const char* value) + { + return parse_bool(value); + } }; -namespace simgrid { -namespace config { - struct ConfigurationElement ; - class Config; -} -} +// **** Forward declarations **** -/* Retrieve the variable we'll modify */ -static simgrid::config::ConfigurationElement* xbt_cfgelm_get(xbt_cfg_t cfg, const char *name, e_xbt_cfgelm_type_t type); +class ConfigurationElement ; +template class TypedConfigurationElement; -namespace simgrid { -namespace config { +// **** ConfigurationElement **** -// A configuration variable: -struct ConfigurationElement { - /* Description */ +class ConfigurationElement { +private: + std::string key; std::string desc; - - /* Allowed type of the variable */ - e_xbt_cfgelm_type_t type; 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) {} - /* Advanced callback (for xbt_cfgelm_string only) */ - std::function callback; + virtual ~ConfigurationElement() = default; - union { - int int_content; - double double_content; - char* string_content; - bool boolean_content; - }; + virtual std::string get_string_value() = 0; + virtual void set_string_value(const char* value) = 0; + virtual const char* get_type_name() = 0; - ~ConfigurationElement() + template T const& get_value() const { - XBT_DEBUG("Frees cfgelm %p", this); - switch(this->type) { - case xbt_cfgelm_int: - case xbt_cfgelm_double: - case xbt_cfgelm_boolean: - break; - case xbt_cfgelm_string: - free(string_content); - break; - default: - xbt_die("Unexpected config type"); - } + return dynamic_cast&>(*this).get_value(); + } + template void set_value(T value) + { + dynamic_cast&>(*this).set_value(std::move(value)); + } + template void set_default_value(T value) + { + dynamic_cast&>(*this).set_default_value(std::move(value)); } + void unset_default() { isdefault = false; } + bool is_default() const { return isdefault; } + std::string const& get_description() const { return desc; } + std::string const& get_key() const { return key; } }; +// **** 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 get_string_value() override; + const char* get_type_name() override; + void set_string_value(const char* value) override; + + void update() + { + if (old_callback) + this->old_callback(get_key().c_str()); + if (this->callback) + this->callback(this->content); + } + + T const& get_value() const { return content; } + + void set_value(T value) + { + this->content = std::move(value); + this->update(); + this->unset_default(); + } + + void set_default_value(T value) + { + if (this->is_default()) { + this->content = std::move(value); + this->update(); + } else { + XBT_DEBUG("Do not override configuration variable '%s' with value '%s' because it was already set.", + get_key().c_str(), to_string(value).c_str()); + } + } +}; + +template std::string TypedConfigurationElement::get_string_value() // override +{ + return to_string(content); +} + +template void TypedConfigurationElement::set_string_value(const char* value) // override +{ + this->content = ConfigType::parse(value); + this->unset_default(); + this->update(); +} + +template const char* TypedConfigurationElement::get_type_name() // override +{ + return ConfigType::type_name; +} + +} // end of anonymous namespace + +// **** Config **** + class Config { +private: // name -> ConfigElement: - xbt_dict_t options; - // alias -> xbt_dict_elm_t from options: - xbt_dict_t aliases; + std::map options; + // alias -> ConfigElement from options: + std::map aliases; + bool warn_for_aliases = true; public: Config(); @@ -135,69 +263,70 @@ public: Config(Config const&) = delete; Config& operator=(Config const&) = delete; - xbt_dictelm_t getElement(const char* name); - ConfigurationElement* operator[](const char* name); + ConfigurationElement& operator[](const char* name); void alias(const char* realname, const char* aliasname); - simgrid::config::ConfigurationElement* registerOption( - const char *name, const char *desc, e_xbt_cfgelm_type_t type, - xbt_cfg_cb_t cb_set); + template + simgrid::config::TypedConfigurationElement* register_option(const char* name, A&&... a) + { + xbt_assert(options.find(name) == options.end(), "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->get_description().c_str(), + variable->get_type_name(), variable, this); + options.insert({name, variable}); + variable->update(); + return variable; + } // Debug: void dump(const char *name, const char *indent); - void showAliases(); + void show_aliases(); void help(); + +protected: + ConfigurationElement* get_dict_element(const char* name); }; -/* Internal stuff used in cache to free a variable */ -static void xbt_cfgelm_free(void *data) +Config::Config() { - if (data) - delete (simgrid::config::ConfigurationElement*) data; + atexit(&sg_config_finalize); } - -Config::Config() : - options(xbt_dict_new_homogeneous(xbt_cfgelm_free)), - aliases(xbt_dict_new_homogeneous(NULL)) -{} - Config::~Config() { XBT_DEBUG("Frees cfg set %p", this); - xbt_dict_free(&this->options); - xbt_dict_free(&this->aliases); -} - -inline -xbt_dictelm_t Config::getElement(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; + for (auto const& elm : options) + delete elm.second; +} + +inline ConfigurationElement* Config::get_dict_element(const char* name) +{ + auto opt = options.find(name); + if (opt != options.end()) { + return opt->second; + } else { + auto als = aliases.find(name); + if (als != aliases.end()) { + ConfigurationElement* res = als->second; + if (warn_for_aliases) + XBT_INFO("Option %s has been renamed to %s. Consider switching.", name, res->get_key().c_str()); + return res; + } else { + THROWF(not_found_error, 0, "Bad config key: %s", name); + } + } } -inline -ConfigurationElement* Config::operator[](const char* name) +inline ConfigurationElement& Config::operator[](const char* name) { - xbt_dictelm_t elm = getElement(name); - if (elm) - return (ConfigurationElement*) elm->content; - else - return nullptr; + return *(get_dict_element(name)); } void Config::alias(const char* realname, const char* aliasname) { - xbt_assert(this->getElement(aliasname) == nullptr, "Alias '%s' already.", aliasname); - xbt_dictelm_t element = this->getElement(realname); + xbt_assert(aliases.find(aliasname) == aliases.end(), "Alias '%s' already.", aliasname); + ConfigurationElement* element = this->get_dict_element(realname); xbt_assert(element, "Cannot define an alias to the non-existing option '%s'.", realname); - xbt_dict_set(this->aliases, aliasname, element, NULL); + this->aliases.insert({aliasname, element}); } /** @brief Dump a config set for debuging purpose @@ -207,154 +336,166 @@ void Config::alias(const char* realname, const char* aliasname) */ void Config::dump(const char *name, const char *indent) { - xbt_dict_t dict = this->options; - xbt_dict_cursor_t cursor = NULL; - simgrid::config::ConfigurationElement* variable = NULL; - char *key = NULL; - if (name) printf("%s>> Dumping of the config set '%s':\n", indent, name); - xbt_dict_foreach(dict, cursor, key, variable) { - const char* type_name = xbt_cfgelm_type_name[variable->type]; - switch (variable->type) { - case xbt_cfgelm_int: - printf("%s %s: ()%s) %i", indent, key, type_name, variable->int_content); - break; - case xbt_cfgelm_double: - printf("%s %s: ()%s) %f", indent, key, type_name, variable->double_content); - break; - case xbt_cfgelm_string: - printf("%s %s: ()%s) %s", indent, key, type_name, variable->string_content); - break; - case xbt_cfgelm_boolean: - printf("%s %s: ()%s) %s", indent, key, type_name, - variable->boolean_content ? "true" : "false"); - break; - default: - printf("%s Invalid type!!\n", indent); - break; - } - } + for (auto const& elm : options) + printf("%s %s: ()%s) %s", indent, elm.first.c_str(), elm.second->get_type_name(), + elm.second->get_string_value().c_str()); if (name) printf("%s<< End of the config set '%s'\n", indent, name); fflush(stdout); +} - xbt_dict_cursor_free(&cursor); -} - -simgrid::config::ConfigurationElement* Config::registerOption( - const char *name, const char *desc, e_xbt_cfgelm_type_t type, xbt_cfg_cb_t cb_set) -{ - 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); - - simgrid::config::ConfigurationElement* res = (simgrid::config::ConfigurationElement*) xbt_dict_get_or_null(this->options, name); - xbt_assert(NULL == res, "Refusing to register the config element '%s' twice.", name); - - res = new simgrid::config::ConfigurationElement(); - XBT_DEBUG("Register cfg elm %s (%s) (%s (=%d) @%p in set %p)", - name, desc, xbt_cfgelm_type_name[type], (int)type, res, this); - res->type = type; - res->cb_set = cb_set; - if (desc) - res->desc = desc; - - // Set a default default value: - switch (type) { - case xbt_cfgelm_int: - res->int_content = 0; - break; - case xbt_cfgelm_double: - res->double_content = 0.0; - break; - case xbt_cfgelm_string: - res->string_content = nullptr; - break; - case xbt_cfgelm_boolean: - res->boolean_content = false; - break; - default: - XBT_ERROR("%d is an invalid type code", (int)type); - break; +/** @brief Displays the declared aliases and their replacement */ +void Config::show_aliases() +{ + for (auto const& elm : aliases) + printf(" %-40s %s\n", elm.first.c_str(), elm.second->get_key().c_str()); +} + +/** @brief Displays the declared options and their description */ +void Config::help() +{ + for (auto const& elm : options) { + simgrid::config::ConfigurationElement* variable = this->options.at(elm.first); + printf(" %s: %s\n", elm.first.c_str(), variable->get_description().c_str()); + printf(" Type: %s; ", variable->get_type_name()); + printf("Current value: %s\n", variable->get_string_value().c_str()); } +} + +// ***** set_default ***** - xbt_dict_set(this->options, name, res, NULL); - return res; +template XBT_PUBLIC void set_default(const char* name, T value) +{ + (*simgrid_config)[name].set_default_value(std::move(value)); } -/** @brief Displays the declared aliases and their description */ -void Config::showAliases() +template XBT_PUBLIC void set_default(const char* name, int value); +template XBT_PUBLIC void set_default(const char* name, double value); +template XBT_PUBLIC void set_default(const char* name, bool value); +template XBT_PUBLIC void set_default(const char* name, std::string value); + +bool is_default(const char* name) { - xbt_dict_cursor_t dict_cursor; - unsigned int dynar_cursor; - xbt_dictelm_t dictel; - char *name; - xbt_dynar_t names = xbt_dynar_new(sizeof(char *), NULL); + return (*simgrid_config)[name].is_default(); +} - xbt_dict_foreach(this->aliases, dict_cursor, name, dictel) - xbt_dynar_push(names, &name); - xbt_dynar_sort_strings(names); +// ***** set_value ***** - xbt_dynar_foreach(names, dynar_cursor, name) { - simgrid::config::ConfigurationElement* variable = (*this)[name]; - if (variable) - printf(" %s: %s\n", name, variable->desc.c_str()); - } +template XBT_PUBLIC void set_value(const char* name, T value) +{ + (*simgrid_config)[name].set_value(std::move(value)); } -/** @brief Displays the declared options and their description */ -void Config::help() +template XBT_PUBLIC void set_value(const char* name, int value); +template XBT_PUBLIC void set_value(const char* name, double value); +template XBT_PUBLIC void set_value(const char* name, bool value); +template XBT_PUBLIC void set_value(const char* name, std::string value); + +void set_as_string(const char* name, const std::string& value) +{ + (*simgrid_config)[name].set_string_value(value.c_str()); +} + +void set_parse(std::string options) { - xbt_dict_cursor_t dict_cursor; - unsigned int dynar_cursor; - simgrid::config::ConfigurationElement* variable; - char *name; - xbt_dynar_t names = xbt_dynar_new(sizeof(char *), NULL); - - xbt_dict_foreach(this->options, dict_cursor, name, variable) - xbt_dynar_push(names, &name); - xbt_dynar_sort_strings(names); - - xbt_dynar_foreach(names, dynar_cursor, name) { - variable = (simgrid::config::ConfigurationElement*) xbt_dict_get(this->options, name); - - printf(" %s: %s\n", name, variable->desc.c_str()); - printf(" Type: %s; ", xbt_cfgelm_type_name[variable->type]); - printf("Current value: "); - - switch (variable->type) { - case xbt_cfgelm_int: - printf("%d\n", variable->int_content); - break; - case xbt_cfgelm_double: - printf("%f\n", variable->double_content); - break; - case xbt_cfgelm_string: - printf("'%s'\n", variable->string_content); - break; - case xbt_cfgelm_boolean: - printf("'%s'\n", variable->boolean_content ? "true" : "false"); - break; - default: - printf("Invalid type!!\n"); - break; - } + XBT_DEBUG("List to parse and set:'%s'", options.c_str()); + while (not options.empty()) { + XBT_DEBUG("Still to parse and set: '%s'", options.c_str()); + + // skip separators + size_t pos = options.find_first_not_of(" \t\n,"); + options.erase(0, pos); + // find option + pos = options.find_first_of(" \t\n,"); + std::string name = options.substr(0, pos); + options.erase(0, pos); + XBT_DEBUG("parse now:'%s'; parse later:'%s'", name.c_str(), options.c_str()); + + if (name.empty()) + continue; + + pos = name.find(':'); + xbt_assert(pos != std::string::npos, "Option '%s' badly formatted. Should be of the form 'name:value'", + name.c_str()); + std::string val = name.substr(pos + 1); + name.erase(pos); + + const std::string path("path"); + if (name.compare(0, path.length(), path) != 0) + XBT_INFO("Configuration change: Set '%s' to '%s'", name.c_str(), val.c_str()); + + set_as_string(name.c_str(), val); } - xbt_dynar_free(&names); } +// ***** get_value ***** + +template XBT_PUBLIC T const& get_value(const char* name) +{ + return (*simgrid_config)[name].get_value(); } + +template XBT_PUBLIC int const& get_value(const char* name); +template XBT_PUBLIC double const& get_value(const char* name); +template XBT_PUBLIC bool const& get_value(const char* name); +template XBT_PUBLIC std::string const& get_value(const char* name); + +// ***** alias ***** + +void alias(const char* realname, std::initializer_list aliases) +{ + for (auto const& aliasname : aliases) + simgrid_config->alias(realname, aliasname); } -// C bindings: +// ***** declare_flag ***** -/** @brief Constructor */ -xbt_cfg_t xbt_cfg_new(void) { return new simgrid::config::Config(); } -/** @brief Destructor */ +template +XBT_PUBLIC void declare_flag(const char* name, const char* description, T value, std::function callback) +{ + if (simgrid_config == nullptr) + simgrid_config = new simgrid::config::Config(); + simgrid_config->register_option(name, description, std::move(value), std::move(callback)); +} + +template XBT_PUBLIC void declare_flag(const char* name, const char* description, int value, + std::function callback); +template XBT_PUBLIC void declare_flag(const char* name, const char* description, double value, + std::function callback); +template XBT_PUBLIC void declare_flag(const char* name, const char* description, bool value, + std::function callback); +template XBT_PUBLIC void declare_flag(const char* name, const char* description, std::string value, + std::function callback); + +void finalize() +{ + delete simgrid_config; + simgrid_config = nullptr; +} + +void show_aliases() +{ + simgrid_config->show_aliases(); +} + +void help() +{ + simgrid_config->help(); +} +} +} + +// ***** 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) @@ -363,100 +504,50 @@ void xbt_cfg_dump(const char *name, const char *indent, xbt_cfg_t cfg) } /*----[ 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 simgrid::config::ConfigurationElement* 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) -{ - if (*cfg == NULL) - *cfg = xbt_cfg_new(); - return (*cfg)->registerOption(name, desc, type, cb_set); -} -void xbt_cfg_register_double(const char *name, double default_value,xbt_cfg_cb_t cb_set, const char *desc) +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); + if (simgrid_config == nullptr) + simgrid_config = new simgrid::config::Config(); + simgrid_config->register_option(name, desc, default_value, cb_set); } + 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); + if (simgrid_config == nullptr) + simgrid_config = new simgrid::config::Config(); + simgrid_config->register_option(name, desc, default_value, cb_set); } + 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); + if (simgrid_config == nullptr) + simgrid_config = new simgrid::config::Config(); + simgrid_config->register_option(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) { - xbt_cfg_register(&simgrid_config,name,desc,xbt_cfgelm_boolean,cb_set); - xbt_cfg_setdefault_boolean(name, default_value); + if (simgrid_config == nullptr) + simgrid_config = new simgrid::config::Config(); + simgrid_config->register_option(name, desc, simgrid::config::parse_bool(default_value), cb_set); } void xbt_cfg_register_alias(const char *realname, const char *aliasname) { - if (simgrid_config == NULL) - simgrid_config = xbt_cfg_new(); + if (simgrid_config == nullptr) + simgrid_config = new simgrid::config::Config(); simgrid_config->alias(realname, aliasname); } -/** - * @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'. - * - * 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) +void xbt_cfg_aliases() { - 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 :", 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); - - free(entrycpy); /* strdup'ed by dict mechanism, but cannot be const */ + simgrid_config->show_aliases(); } - -void xbt_cfg_aliases(void) { simgrid_config->showAliases(); } -void xbt_cfg_help(void) { simgrid_config->help(); } - -static simgrid::config::ConfigurationElement* xbt_cfgelm_get(xbt_cfg_t cfg, const char *name, e_xbt_cfgelm_type_t type) +void xbt_cfg_help() { - simgrid::config::ConfigurationElement* res = (*cfg)[name]; - - 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; + simgrid_config->help(); } /*----[ Setting ]---------------------------------------------------------*/ @@ -471,109 +562,19 @@ static simgrid::config::ConfigurationElement* xbt_cfgelm_get(xbt_cfg_t cfg, cons */ 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); + if (options && strlen(options) > 0) + simgrid::config::set_parse(std::string(options)); } /** @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) +void xbt_cfg_set_as_string(const char *key, const char *value) { - simgrid::config::ConfigurationElement* variable = (*simgrid_config)[key]; - if (variable == nullptr) - THROWF(not_found_error, 0, "No registered variable corresponding to '%s'.", key); - - char *ret; - int i; - double d; - - 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; + (*simgrid_config)[key].set_string_value(value); } /** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet @@ -581,15 +582,9 @@ 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) { - simgrid::config::ConfigurationElement* 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); + (*simgrid_config)[key].set_default_value(value); } /** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet @@ -597,15 +592,9 @@ 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) { - simgrid::config::ConfigurationElement* 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); + (*simgrid_config)[key].set_default_value(value); } /** @brief Set a string value to \a name within \a cfg if it wasn't changed yet @@ -613,15 +602,9 @@ 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) { - simgrid::config::ConfigurationElement* 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); + (*simgrid_config)[key].set_default_value(value ? value : ""); } /** @brief Set an boolean value to \a name within \a cfg if it wasn't changed yet @@ -629,226 +612,107 @@ 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) { - simgrid::config::ConfigurationElement* 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); + (*simgrid_config)[key].set_default_value(simgrid::config::parse_bool(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) { - simgrid::config::ConfigurationElement* variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_int); - variable->int_content = val; - if (variable->cb_set) - variable->cb_set(name); - variable->isdefault = false; + (*simgrid_config)[key].set_value(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) { - simgrid::config::ConfigurationElement* variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_double); - variable->double_content = val; - if (variable->cb_set) - variable->cb_set(name); - variable->isdefault = false; + (*simgrid_config)[key].set_value(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) { - simgrid::config::ConfigurationElement* variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_string); - free(variable->string_content); - variable->string_content = xbt_strdup(val); - if (variable->cb_set) - variable->cb_set(name); - variable->isdefault = false; - - 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); - } - } + (*simgrid_config)[key].set_value(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; - simgrid::config::ConfigurationElement* 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); - variable->boolean_content = bval; - if (variable->cb_set) - variable->cb_set(name); - variable->isdefault = false; + (*simgrid_config)[key].set_value(simgrid::config::parse_bool(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) { - simgrid::config::ConfigurationElement* variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_any); - return variable->isdefault; + return (*simgrid_config)[key].is_default() ? 1 : 0; } /*----[ 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. */ -int xbt_cfg_get_int(const char *name) +int xbt_cfg_get_int(const char *key) { - simgrid::config::ConfigurationElement* variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_int); - return variable->int_content; + return (*simgrid_config)[key].get_value(); } /** @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. */ -double xbt_cfg_get_double(const char *name) +double xbt_cfg_get_double(const char *key) { - simgrid::config::ConfigurationElement* variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_double); - return variable->double_content; + return (*simgrid_config)[key].get_value(); } /** @brief Retrieve a string value of a variable (get a warning if not uniq) * - * @param cfg the config set - * @param name the name of the variable + * @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. - * Returns NULL if there is no value. + * 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) +std::string xbt_cfg_get_string(const char* key) { - simgrid::config::ConfigurationElement* variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_string); - return variable->string_content; + return (*simgrid_config)[key].get_value(); } /** @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. */ -int xbt_cfg_get_boolean(const char *name) -{ - simgrid::config::ConfigurationElement* variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_boolean); - return variable->boolean_content; -} - -namespace simgrid { -namespace config { - -bool parseBool(const char* value) -{ - 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; - } - 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) +int xbt_cfg_get_boolean(const char *key) { - 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) -{ - simgrid::config::ConfigurationElement* e = xbt_cfg_register( - &simgrid_config, name, description, xbt_cfgelm_string, NULL); - e->callback = std::move(callback); -} - -} + return (*simgrid_config)[key].get_value() ? 1 : 0; } #ifdef SIMGRID_TEST @@ -857,6 +721,7 @@ void declareFlag(const char* name, const char* description, #include "xbt.h" #include "xbt/ex.h" +#include #include @@ -864,60 +729,57 @@ 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 simgrid::config::Config* 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; + simgrid::config::declare_flag("speed", "description", 0); + simgrid::config::declare_flag("peername", "description", ""); + simgrid::config::declare_flag("user", "description", ""); } /* 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::set_parse("peername:veloce user:bidule"); + simgrid::config::finalize(); + 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 */ - int ival; - - xbt_cfg_set_parse("peername:toto:42 speed:42"); - ival = xbt_cfg_get_int("speed"); + simgrid::config::set_parse("peername:toto:42 speed:42"); + int ival = simgrid::config::get_value("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) { + try { + simgrid::config::set_parse("color:blue"); + } 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::finalize(); + 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); @@ -927,14 +789,15 @@ XBT_TEST_UNIT("c++flags", test_config_cxx_flags, "C++ flags") simgrid::config::Flag bool_flag2("bool2", "", true); xbt_test_add("Parse values"); - xbt_cfg_set_parse("int:42 string:bar double:8.0 bool1:true bool2:false"); + simgrid::config::set_parse("int:42 string:bar double:8.0 bool1:true bool2:false"); xbt_test_assert(int_flag == 42, "Check int flag"); xbt_test_assert(string_flag == "bar", "Check string flag"); xbt_test_assert(double_flag == 8.0, "Check double flag"); xbt_test_assert(bool_flag1, "Check bool1 flag"); - xbt_test_assert(!bool_flag2, "Check bool2 flag"); + xbt_test_assert(not bool_flag2, "Check bool2 flag"); - xbt_cfg_free(&simgrid_config); + simgrid::config::finalize(); + simgrid_config = temp; } #endif /* SIMGRID_TEST */