X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/b9a12f8c05aaeba102c5074c21ecaea078db560e..1873a02acdc52506c010f43b4c78a8b8400dc0de:/src/xbt/config.cpp diff --git a/src/xbt/config.cpp b/src/xbt/config.cpp index b2210e3923..d2f380be0c 100644 --- a/src/xbt/config.cpp +++ b/src/xbt/config.cpp @@ -1,39 +1,42 @@ -/* Copyright (c) 2004-2014,2016. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2004-2017. 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 #include #include #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 = nullptr; +extern "C" { + XBT_PUBLIC(void) sg_config_finalize(); +} namespace simgrid { namespace config { -missing_key_error::~missing_key_error() {} +missing_key_error::~missing_key_error() = default; class Config; @@ -48,10 +51,10 @@ const char* false_values[] = { static bool parseBool(const char* value) { - for (const char* true_value : true_values) + for (const char* const& true_value : true_values) if (std::strcmp(true_value, value) == 0) return true; - for (const char* false_value : false_values) + for (const char* const& false_value : false_values) if (std::strcmp(false_value, value) == 0) return false; throw std::range_error("not a boolean"); @@ -138,7 +141,6 @@ protected: bool isdefault = true; public: - /* Callback */ xbt_cfg_cb_t old_callback = nullptr; @@ -147,7 +149,7 @@ public: ConfigurationElement(const char* key, const char* desc, xbt_cfg_cb_t cb) : key(key ? key : ""), desc(desc ? desc : ""), old_callback(cb) {} - virtual ~ConfigurationElement(); + virtual ~ConfigurationElement()=default; virtual std::string getStringValue() = 0; virtual void setStringValue(const char* value) = 0; @@ -171,10 +173,9 @@ public: bool isDefault() const { return isdefault; } std::string const& getDescription() const { return desc; } + std::string const& getKey() const { return key; } }; -ConfigurationElement::~ConfigurationElement() {} - // **** TypedConfigurationElement **** // TODO, could we use boost::any with some Type* reference? @@ -188,16 +189,13 @@ 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, 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(const char* key, const char* desc, T value, std::function callback) + : ConfigurationElement(key, desc), content(std::move(value)), callback(std::move(callback)) {} - ~TypedConfigurationElement() override; + ~TypedConfigurationElement() = default; std::string getStringValue() override; const char* getTypeName() override; @@ -225,8 +223,8 @@ public: 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()); + XBT_DEBUG("Do not override configuration variable '%s' with value '%s' because it was already set.", key.c_str(), + to_string(value).c_str()); } } }; @@ -251,10 +249,6 @@ const char* TypedConfigurationElement::getTypeName() // override return ConfigType::type_name; } -template -TypedConfigurationElement::~TypedConfigurationElement() -{} - } // end of anonymous namespace // **** Config **** @@ -262,12 +256,13 @@ TypedConfigurationElement::~TypedConfigurationElement() class Config { private: // name -> ConfigElement: - xbt_dict_t options; + std::map options; // alias -> xbt_dict_elm_t from options: - xbt_dict_t aliases; + std::map aliases; + bool warn_for_aliases = true; public: - Config(); + Config() = default; ~Config(); // No copy: @@ -283,15 +278,11 @@ public: 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(), + 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->getDescription().c_str(), variable->getTypeName(), variable, this); - xbt_dict_set(this->options, name, variable, nullptr); + options.insert({name, variable}); variable->update(); return variable; } @@ -302,57 +293,45 @@ public: void help(); protected: - xbt_dictelm_t getDictElement(const char* name); + ConfigurationElement* getDictElement(const char* name); }; -/* Internal stuff used in cache to free a variable */ -static void xbt_cfgelm_free(void *data) -{ - if (data) - delete (simgrid::config::ConfigurationElement*) data; -} - -Config::Config() : - options(xbt_dict_new_homogeneous(xbt_cfgelm_free)), - aliases(xbt_dict_new_homogeneous(nullptr)) -{} - Config::~Config() { XBT_DEBUG("Frees cfg set %p", this); - xbt_dict_free(&this->options); - xbt_dict_free(&this->aliases); -} - -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; + for (auto const& elm : options) + delete elm.second; +} + +inline ConfigurationElement* Config::getDictElement(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->getKey().c_str()); + return res; + } else { + throw simgrid::config::missing_key_error(std::string("Bad config key: ") + name); + } + } } -inline -ConfigurationElement& Config::operator[](const char* name) +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; + return *(getDictElement(name)); } 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(aliases.find(aliasname) == aliases.end(), "Alias '%s' already.", aliasname); + ConfigurationElement* 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); + this->aliases.insert({aliasname, element}); } /** @brief Dump a config set for debuging purpose @@ -362,63 +341,37 @@ 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 = nullptr; - simgrid::config::ConfigurationElement* variable = nullptr; - char *key = nullptr; - if (name) printf("%s>> Dumping of the config set '%s':\n", indent, name); - xbt_dict_foreach(dict, cursor, key, variable) - printf("%s %s: ()%s) %s", indent, key, - variable->getTypeName(), - variable->getStringValue().c_str()); + for (auto const& elm : options) + printf("%s %s: ()%s) %s", indent, elm.first.c_str(), elm.second->getTypeName(), + elm.second->getStringValue().c_str()); if (name) printf("%s<< End of the config set '%s'\n", indent, name); fflush(stdout); - - xbt_dict_cursor_free(&cursor); } /** @brief Displays the declared aliases and their description */ void Config::showAliases() { - 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 *), nullptr); - - xbt_dict_foreach(this->aliases, dict_cursor, name, dictel) - xbt_dynar_push(names, &name); - xbt_dynar_sort_strings(names); - - xbt_dynar_foreach(names, dynar_cursor, name) - printf(" %s: %s\n", name, (*this)[name].getDescription().c_str()); + bool old_warn_for_aliases = false; + std::swap(warn_for_aliases, old_warn_for_aliases); + for (auto const& elm : aliases) + printf(" %s: %s\n", elm.first.c_str(), (*this)[elm.first.c_str()].getDescription().c_str()); + std::swap(warn_for_aliases, old_warn_for_aliases); } /** @brief Displays the declared options and their description */ void Config::help() { - 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 *), nullptr); - - 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->getDescription().c_str()); + for (auto const& elm : options) { + simgrid::config::ConfigurationElement* variable = this->options.at(elm.first); + printf(" %s: %s\n", elm.first.c_str(), variable->getDescription().c_str()); printf(" Type: %s; ", variable->getTypeName()); printf("Current value: %s\n", variable->getStringValue().c_str()); } - xbt_dynar_free(&names); } // ***** getConfig ***** @@ -447,8 +400,10 @@ template XBT_PUBLIC(void) declareFlag(const char* name, const char* description, T value, std::function callback) { - if (simgrid_config == nullptr) + if (simgrid_config == nullptr) { simgrid_config = xbt_cfg_new(); + atexit(sg_config_finalize); + } simgrid_config->registerOption( name, description, std::move(value), std::move(callback)); } @@ -467,7 +422,7 @@ template XBT_PUBLIC(void) declareFlag(const char* name, // ***** C bindings ***** -xbt_cfg_t xbt_cfg_new(void) { return new simgrid::config::Config(); } +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) @@ -487,35 +442,43 @@ void xbt_cfg_register_double(const char *name, double default_value, void xbt_cfg_register_int(const char *name, int default_value,xbt_cfg_cb_t cb_set, const char *desc) { - if (simgrid_config == nullptr) + if (simgrid_config == nullptr) { simgrid_config = xbt_cfg_new(); + atexit(&sg_config_finalize); + } simgrid_config->registerOption(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) { - if (simgrid_config == nullptr) + if (simgrid_config == nullptr) { simgrid_config = xbt_cfg_new(); + atexit(sg_config_finalize); + } 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) { - if (simgrid_config == nullptr) + 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); } void xbt_cfg_register_alias(const char *realname, const char *aliasname) { - if (simgrid_config == nullptr) + if (simgrid_config == nullptr) { simgrid_config = xbt_cfg_new(); + atexit(sg_config_finalize); + } simgrid_config->alias(realname, aliasname); } -void xbt_cfg_aliases(void) { simgrid_config->showAliases(); } -void xbt_cfg_help(void) { simgrid_config->help(); } +void xbt_cfg_aliases() { simgrid_config->showAliases(); } +void xbt_cfg_help() { simgrid_config->help(); } /*----[ Setting ]---------------------------------------------------------*/ @@ -529,7 +492,7 @@ void xbt_cfg_help(void) { simgrid_config->help(); } */ void xbt_cfg_set_parse(const char *options) { - if (!options || !strlen(options)) { /* nothing to do */ + if (not options || not strlen(options)) { /* nothing to do */ return; } char *optionlist_cpy = xbt_strdup(options); @@ -537,7 +500,7 @@ void xbt_cfg_set_parse(const char *options) XBT_DEBUG("List to parse and set:'%s'", options); char *option = optionlist_cpy; while (1) { /* breaks in the code */ - if (!option) + if (not option) break; char *name = option; int len = strlen(name); @@ -566,7 +529,7 @@ void xbt_cfg_set_parse(const char *options) if (name[0] == ' ' || name[0] == '\n' || name[0] == '\t') continue; - if (!strlen(name)) + if (not strlen(name)) break; char *val = strchr(name, ':'); @@ -574,7 +537,7 @@ 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 { @@ -591,6 +554,7 @@ void xbt_cfg_set_parse(const char *options) 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); @@ -598,12 +562,10 @@ on_missing_key: on_exception: free(optionlist_cpy); THROWF(unknown_error, 0, "Could not set variables %s", options); - return; } // Horrible mess to translate C++ exceptions to C exceptions: -// Exit from the catch blog (and do the correct exceptio cleaning) -// before attempting to THROWF. +// Exit from the catch block (and do the correct exception 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(); } @@ -634,8 +596,7 @@ void xbt_cfg_setdefault_int(const char *key, int value) (*simgrid_config)[key].setDefaultValue(value); return; } - TRANSLATE_EXCEPTIONS("Could not set variable %s to default integer %i", - key, value); + 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 @@ -649,8 +610,7 @@ void xbt_cfg_setdefault_double(const char *key, double value) (*simgrid_config)[key].setDefaultValue(value); return; } - TRANSLATE_EXCEPTIONS("Could not set variable %s to default double %f", - key, value); + 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 @@ -664,8 +624,7 @@ void xbt_cfg_setdefault_string(const char *key, const char *value) (*simgrid_config)[key].setDefaultValue(value ? value : ""); return; } - TRANSLATE_EXCEPTIONS("Could not set variable %s to default string %s", - key, value); + 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 @@ -679,8 +638,7 @@ void xbt_cfg_setdefault_boolean(const char *key, const char *value) (*simgrid_config)[key].setDefaultValue(simgrid::config::parseBool(value)); return; } - TRANSLATE_EXCEPTIONS("Could not set variable %s to default boolean %s", - key, value); + TRANSLATE_EXCEPTIONS("Could not set variable %s to default boolean %s", key, value); } /** @brief Set an integer value to \a name within \a cfg @@ -694,8 +652,7 @@ void xbt_cfg_set_int(const char *key, int value) (*simgrid_config)[key].setValue(value); return; } - TRANSLATE_EXCEPTIONS("Could not set variable %s to integer %i", - key, value); + 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 @@ -709,8 +666,7 @@ void xbt_cfg_set_double(const char *key, double value) (*simgrid_config)[key].setValue(value); return; } - TRANSLATE_EXCEPTIONS("Could not set variable %s to double %f", - key, value); + 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 @@ -725,8 +681,7 @@ void xbt_cfg_set_string(const char *key, const char *value) (*simgrid_config)[key].setValue(value ? value : ""); return; } - TRANSLATE_EXCEPTIONS("Could not set variable %s to string %s", - key, value); + 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 @@ -740,8 +695,7 @@ void xbt_cfg_set_boolean(const char *key, const char *value) (*simgrid_config)[key].setValue(simgrid::config::parseBool(value)); return; } - TRANSLATE_EXCEPTIONS("Could not set variable %s to boolean %s", - key, value); + TRANSLATE_EXCEPTIONS("Could not set variable %s to boolean %s", key, value); } @@ -822,6 +776,7 @@ int xbt_cfg_get_boolean(const char *key) #include "xbt.h" #include "xbt/ex.h" +#include #include @@ -857,10 +812,8 @@ XBT_TEST_UNIT("use", test_config_use, "Data retrieving tests") 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"); + int ival = xbt_cfg_get_int("speed"); if (ival != 42) xbt_test_fail("Speed value = %d, I expected 42", ival); } @@ -896,7 +849,7 @@ XBT_TEST_UNIT("c++flags", test_config_cxx_flags, "C++ flags") 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 = temp;