X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/c6251977c7530cd73bc7a90175a36ea7e5c95e4d..b5858ae65676a0304a843e25d13d11df789106b6:/src/xbt/config.cpp diff --git a/src/xbt/config.cpp b/src/xbt/config.cpp index 521d32cb63..9b3fedbf55 100644 --- a/src/xbt/config.cpp +++ b/src/xbt/config.cpp @@ -1,8 +1,11 @@ -/* 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 @@ -12,7 +15,9 @@ #include #include #include +#include +#include #include #include #include "xbt/misc.h" @@ -26,11 +31,16 @@ 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 { @@ -50,7 +60,7 @@ static bool parseBool(const char* value) for (const char* false_value : false_values) if (std::strcmp(false_value, value) == 0) return false; - throw std::domain_error("not a boolean"); + throw std::range_error("not a boolean"); } static double parseDouble(const char* value) @@ -143,7 +153,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; @@ -169,8 +179,6 @@ public: std::string const& getDescription() const { return desc; } }; -ConfigurationElement::~ConfigurationElement() {} - // **** TypedConfigurationElement **** // TODO, could we use boost::any with some Type* reference? @@ -193,7 +201,7 @@ public: : ConfigurationElement(key, desc), content(std::move(value)), callback(std::move(callback)) {} - ~TypedConfigurationElement() override; + ~TypedConfigurationElement()=default; std::string getStringValue() override; const char* getTypeName() override; @@ -247,10 +255,6 @@ const char* TypedConfigurationElement::getTypeName() // override return ConfigType::type_name; } -template -TypedConfigurationElement::~TypedConfigurationElement() -{} - } // end of anonymous namespace // **** Config **** @@ -287,7 +291,7 @@ public: name, variable->getDescription().c_str(), variable->getTypeName(), variable, this); - xbt_dict_set(this->options, name, variable, NULL); + xbt_dict_set(this->options, name, variable, nullptr); variable->update(); return variable; } @@ -310,7 +314,7 @@ static void xbt_cfgelm_free(void *data) Config::Config() : options(xbt_dict_new_homogeneous(xbt_cfgelm_free)), - aliases(xbt_dict_new_homogeneous(NULL)) + aliases(xbt_dict_new_homogeneous(nullptr)) {} Config::~Config() @@ -339,7 +343,7 @@ ConfigurationElement& Config::operator[](const char* name) { xbt_dictelm_t elm = getDictElement(name); if (elm == nullptr) - throw std::invalid_argument(std::string("Bad config key, ") + name); + throw simgrid::config::missing_key_error(std::string("Bad config key, ") + name); return *(ConfigurationElement*)elm->content; } @@ -348,7 +352,7 @@ 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, NULL); + xbt_dict_set(this->aliases, aliasname, element, nullptr); } /** @brief Dump a config set for debuging purpose @@ -359,9 +363,9 @@ 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; + 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); @@ -382,16 +386,15 @@ void Config::dump(const char *name, const char *indent) 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 *), NULL); + std::vector names; xbt_dict_foreach(this->aliases, dict_cursor, name, dictel) - xbt_dynar_push(names, &name); - xbt_dynar_sort_strings(names); + names.push_back(name); + std::sort(names.begin(), names.end()); - xbt_dynar_foreach(names, dynar_cursor, name) + for (auto name : names) printf(" %s: %s\n", name, (*this)[name].getDescription().c_str()); } @@ -399,22 +402,20 @@ void Config::showAliases() 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 *), NULL); + std::vector names; xbt_dict_foreach(this->options, dict_cursor, name, variable) - xbt_dynar_push(names, &name); - xbt_dynar_sort_strings(names); + names.push_back(name); + std::sort(names.begin(), names.end()); - xbt_dynar_foreach(names, dynar_cursor, name) { + 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); } // ***** getConfig ***** @@ -443,8 +444,10 @@ template XBT_PUBLIC(void) declareFlag(const char* name, const char* description, T value, std::function callback) { - if (simgrid_config == 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)); } @@ -463,7 +466,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) @@ -476,42 +479,50 @@ void xbt_cfg_dump(const char *name, const char *indent, xbt_cfg_t cfg) void xbt_cfg_register_double(const char *name, double default_value, xbt_cfg_cb_t cb_set, const char *desc) { - if (simgrid_config == NULL) + if (simgrid_config == nullptr) simgrid_config = xbt_cfg_new(); simgrid_config->registerOption(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) { - if (simgrid_config == NULL) + 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 == NULL) + 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 == NULL) + 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 == NULL) + 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 ]---------------------------------------------------------*/ @@ -525,7 +536,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); @@ -533,7 +544,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); @@ -546,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 */ @@ -556,13 +567,13 @@ 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); if (name[0] == ' ' || name[0] == '\n' || name[0] == '\t') continue; - if (!strlen(name)) + if (not strlen(name)) break; char *val = strchr(name, ':'); @@ -570,20 +581,40 @@ 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 { (*simgrid_config)[name].setStringValue(val); } + catch (simgrid::config::missing_key_error& e) { + goto on_missing_key; + } catch (...) { - THROWF(not_found_error, 0, "Could not set the value %s for %s", val, name); + 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 @@ -594,10 +625,9 @@ void xbt_cfg_set_as_string(const char *key, const char *value) { try { (*simgrid_config)[key].setStringValue(value); + return; } - catch (std::exception const& e) { - THROWF(unknown_error, 0, "%s", e.what()); - } + 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 @@ -605,14 +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) { try { - (*simgrid_config)[name].setDefaultValue(val); - } - catch (std::exception const& e) { - THROWF(unknown_error, 0, "%s", e.what()); + (*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 @@ -620,14 +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) { try { - (*simgrid_config)[name].setDefaultValue(val); - } - catch (std::exception const& e) { - THROWF(unknown_error, 0, "%s", e.what()); + (*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 @@ -635,14 +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) { try { - (*simgrid_config)[name].setDefaultValue(val ? val : ""); - } - catch (std::exception const& e) { - THROWF(unknown_error, 0, "%s", e.what()); + (*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 @@ -650,161 +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) { try { - (*simgrid_config)[name].setDefaultValue(simgrid::config::parseBool(val)); - } - catch (std::exception const& e) { - THROWF(unknown_error, 0, "%s", e.what()); + (*simgrid_config)[key].setDefaultValue(simgrid::config::parseBool(value)); + return; } + 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) { try { - (*simgrid_config)[name].setValue(val); - } - catch (std::exception const& e) { - THROWF(unknown_error, 0, "%s", e.what()); + (*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) { try { - (*simgrid_config)[name].setValue(val); - } - catch (std::exception const& e) { - THROWF(unknown_error, 0, "%s", e.what()); + (*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) { try { - (*simgrid_config)[name].setValue(val ? val : ""); - } - catch (std::exception const& e) { - THROWF(unknown_error, 0, "%s", e.what()); + (*simgrid_config)[key].setValue(value ? value : ""); + return; } + 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) { try { - (*simgrid_config)[name].setValue(simgrid::config::parseBool(val)); - } - catch (std::exception const& e) { - THROWF(unknown_error, 0, "%s", e.what()); + (*simgrid_config)[key].setValue(simgrid::config::parseBool(value)); + return; } + 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) { try { - return (*simgrid_config)[name].isDefault() ? 1 : 0; - } - catch (std::exception const& e) { - THROWF(unknown_error, 0, "%s", e.what()); + 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. */ -int xbt_cfg_get_int(const char *name) +int xbt_cfg_get_int(const char *key) { try { - return (*simgrid_config)[name].getValue(); - } - catch (std::exception const& e) { - THROWF(unknown_error, 0, "%s", e.what()); + return (*simgrid_config)[key].getValue(); } + 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. */ -double xbt_cfg_get_double(const char *name) +double xbt_cfg_get_double(const char *key) { try { - return (*simgrid_config)[name].getValue(); - } - catch (std::exception const& e) { - THROWF(unknown_error, 0, "%s", e.what()); + return (*simgrid_config)[key].getValue(); } + 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. - * 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) +char *xbt_cfg_get_string(const char *key) { try { - return (char*) (*simgrid_config)[name].getValue().c_str(); - } - catch (std::exception const& e) { - THROWF(unknown_error, 0, "%s", e.what()); + return (char*) (*simgrid_config)[key].getValue().c_str(); } + 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. */ -int xbt_cfg_get_boolean(const char *name) +int xbt_cfg_get_boolean(const char *key) { try { - return (*simgrid_config)[name].getValue() ? 1 : 0; - } - catch (std::exception const& e) { - THROWF(unknown_error, 0, "%s", e.what()); + return (*simgrid_config)[key].getValue() ? 1 : 0; } + TRANSLATE_EXCEPTIONS("Could not get variable %s", key); } #ifdef SIMGRID_TEST @@ -813,6 +829,7 @@ int xbt_cfg_get_boolean(const char *name) #include "xbt.h" #include "xbt/ex.h" +#include #include @@ -824,11 +841,11 @@ XBT_PUBLIC_DATA(xbt_cfg_t) simgrid_config; static void make_set() { - simgrid_config = NULL; + simgrid_config = nullptr; xbt_log_threshold_set(&_XBT_LOGV(xbt_cfg), xbt_log_priority_critical); - xbt_cfg_register_int("speed", 0, NULL, ""); - xbt_cfg_register_string("peername", "", NULL, ""); - xbt_cfg_register_string("user", "", NULL, ""); + xbt_cfg_register_int("speed", 0, nullptr, ""); + xbt_cfg_register_string("peername", "", nullptr, ""); + xbt_cfg_register_string("user", "", nullptr, ""); } /* end_of_make_set */ XBT_TEST_UNIT("memuse", test_config_memuse, "Alloc and free a config set") @@ -858,14 +875,11 @@ 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); @@ -890,7 +904,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;