-/* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2004-2018. 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 <typeinfo>
#include <vector>
-#include <xbt/ex.hpp>
-#include <xbt/config.h>
-#include <xbt/config.hpp>
+#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/dynar.h"
+#include <xbt/config.h>
+#include <xbt/config.hpp>
+#include <xbt/ex.hpp>
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();
-}
+XBT_EXPORT_NO_IMPORT xbt_cfg_t simgrid_config = nullptr;
namespace simgrid {
namespace config {
-missing_key_error::~missing_key_error() = default;
-
namespace {
const char* true_values[] = {
"no", "off", "false", "0"
};
-static bool parseBool(const char* value)
+static bool parse_bool(const char* value)
{
for (const char* const& true_value : true_values)
if (std::strcmp(true_value, value) == 0)
throw std::range_error("not a boolean");
}
-static double parseDouble(const char* value)
+static double parse_double(const char* value)
{
char* end;
errno = 0;
return res;
}
-static long int parseLong(const char* value)
+static long int parse_long(const char* value)
{
char* end;
errno = 0;
static constexpr const char* type_name = "int";
static inline double parse(const char* value)
{
- return parseLong(value);
+ return parse_long(value);
}
};
template <> class ConfigType<double> {
static constexpr const char* type_name = "double";
static inline double parse(const char* value)
{
- return parseDouble(value);
+ return parse_double(value);
}
};
template <> class ConfigType<std::string> {
static constexpr const char* type_name = "boolean";
static inline bool parse(const char* value)
{
- return parseBool(value);
+ return parse_bool(value);
}
};
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 ~ConfigurationElement() = default;
- virtual std::string getStringValue() = 0;
- virtual void setStringValue(const char* value) = 0;
- virtual const char* getTypeName() = 0;
+ virtual std::string get_string_value() = 0;
+ virtual void set_string_value(const char* value) = 0;
+ virtual const char* get_type_name() = 0;
- template<class T>
- T const& getValue() const
+ template <class T> T const& get_value() const
{
- return dynamic_cast<const TypedConfigurationElement<T>&>(*this).getValue();
+ return dynamic_cast<const TypedConfigurationElement<T>&>(*this).get_value();
}
- template<class T>
- void setValue(T value)
+ template <class T> void set_value(T value)
{
- dynamic_cast<TypedConfigurationElement<T>&>(*this).setValue(std::move(value));
+ dynamic_cast<TypedConfigurationElement<T>&>(*this).set_value(std::move(value));
}
- template<class T>
- void setDefaultValue(T value)
+ template <class T> void set_default_value(T value)
{
- dynamic_cast<TypedConfigurationElement<T>&>(*this).setDefaultValue(std::move(value));
+ dynamic_cast<TypedConfigurationElement<T>&>(*this).set_default_value(std::move(value));
}
- void unsetDefault() { isdefault = false; }
- bool isDefault() const { return isdefault; }
+ void unset_default() { isdefault = false; }
+ bool is_default() const { return isdefault; }
- std::string const& getDescription() const { return desc; }
- std::string const& getKey() const { return key; }
+ std::string const& get_description() const { return desc; }
+ std::string const& get_key() const { return key; }
};
// **** TypedConfigurationElement<T> ****
{}
~TypedConfigurationElement() = default;
- std::string getStringValue() override;
- const char* getTypeName() override;
- void setStringValue(const char* value) override;
+ 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(getKey().c_str());
+ this->old_callback(get_key().c_str());
if (this->callback)
this->callback(this->content);
}
- T const& getValue() const { return content; }
+ T const& get_value() const { return content; }
- void setValue(T value)
+ void set_value(T value)
{
this->content = std::move(value);
this->update();
+ this->unset_default();
}
- void setDefaultValue(T value)
+ void set_default_value(T value)
{
- if (this->isDefault()) {
+ 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.",
- getKey().c_str(), to_string(value).c_str());
+ get_key().c_str(), to_string(value).c_str());
}
}
};
-template<class T>
-std::string TypedConfigurationElement<T>::getStringValue() // override
+template <class T> std::string TypedConfigurationElement<T>::get_string_value() // override
{
return to_string(content);
}
-template<class T>
-void TypedConfigurationElement<T>::setStringValue(const char* value) // override
+template <class T> void TypedConfigurationElement<T>::set_string_value(const char* value) // override
{
this->content = ConfigType<T>::parse(value);
- this->unsetDefault();
+ this->unset_default();
this->update();
}
-template<class T>
-const char* TypedConfigurationElement<T>::getTypeName() // override
+template <class T> const char* TypedConfigurationElement<T>::get_type_name() // override
{
return ConfigType<T>::type_name;
}
bool warn_for_aliases = true;
public:
- Config() = default;
+ Config();
~Config();
// No copy:
Config& operator=(Config const&) = delete;
ConfigurationElement& operator[](const char* name);
- template<class T>
- TypedConfigurationElement<T>& getTyped(const char* name);
void alias(const char* realname, const char* aliasname);
- template<class T, class... A>
- simgrid::config::TypedConfigurationElement<T>*
- registerOption(const char* name, A&&... a)
+ template <class T, class... A>
+ simgrid::config::TypedConfigurationElement<T>* register_option(const char* name, A&&... a)
{
xbt_assert(options.find(name) == options.end(), "Refusing to register the config element '%s' twice.", name);
TypedConfigurationElement<T>* variable = new TypedConfigurationElement<T>(name, std::forward<A>(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_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* getDictElement(const char* name);
+ ConfigurationElement* get_dict_element(const char* name);
};
+Config::Config()
+{
+ atexit(&sg_config_finalize);
+}
Config::~Config()
{
XBT_DEBUG("Frees cfg set %p", this);
delete elm.second;
}
-inline ConfigurationElement* Config::getDictElement(const char* name)
+inline ConfigurationElement* Config::get_dict_element(const char* name)
{
auto opt = options.find(name);
if (opt != options.end()) {
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());
+ XBT_INFO("Option %s has been renamed to %s. Consider switching.", name, res->get_key().c_str());
return res;
} else {
- throw simgrid::config::missing_key_error(std::string("Bad config key: ") + name);
+ THROWF(not_found_error, 0, "Bad config key: %s", name);
}
}
}
inline ConfigurationElement& Config::operator[](const char* name)
{
- return *(getDictElement(name));
+ return *(get_dict_element(name));
}
void Config::alias(const char* realname, const char* aliasname)
{
xbt_assert(aliases.find(aliasname) == aliases.end(), "Alias '%s' already.", aliasname);
- ConfigurationElement* element = this->getDictElement(realname);
+ ConfigurationElement* element = this->get_dict_element(realname);
xbt_assert(element, "Cannot define an alias to the non-existing option '%s'.", realname);
this->aliases.insert({aliasname, element});
}
printf("%s>> Dumping of the config set '%s':\n", indent, name);
for (auto const& elm : options)
- printf("%s %s: ()%s) %s", indent, elm.first.c_str(), elm.second->getTypeName(),
- elm.second->getStringValue().c_str());
+ 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);
}
-/** @brief Displays the declared aliases and their description */
-void Config::showAliases()
+/** @brief Displays the declared aliases and their replacement */
+void Config::show_aliases()
{
- 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);
+ printf(" %-40s %s\n", elm.first.c_str(), elm.second->get_key().c_str());
}
/** @brief Displays the declared options and their description */
{
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());
+ 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());
}
}
-// ***** getConfig *****
+// ***** get_config *****
-template<class T>
-XBT_PUBLIC(T const&) getConfig(const char* name)
+template <class T> XBT_PUBLIC T const& get_config(const char* name)
{
- return (*simgrid_config)[name].getValue<T>();
+ return (*simgrid_config)[name].get_value<T>();
}
-template XBT_PUBLIC(int const&) getConfig<int>(const char* name);
-template XBT_PUBLIC(double const&) getConfig<double>(const char* name);
-template XBT_PUBLIC(bool const&) getConfig<bool>(const char* name);
-template XBT_PUBLIC(std::string const&) getConfig<std::string>(const char* name);
+template XBT_PUBLIC int const& get_config<int>(const char* name);
+template XBT_PUBLIC double const& get_config<double>(const char* name);
+template XBT_PUBLIC bool const& get_config<bool>(const char* name);
+template XBT_PUBLIC std::string const& get_config<std::string>(const char* name);
// ***** alias *****
-void alias(const char* realname, const char* aliasname)
+void alias(const char* realname, std::initializer_list<const char*> aliases)
{
- simgrid_config->alias(realname, aliasname);
+ for (auto const& aliasname : aliases)
+ simgrid_config->alias(realname, aliasname);
}
-// ***** declareFlag *****
+// ***** declare_flag *****
-template<class T>
-XBT_PUBLIC(void) declareFlag(const char* name, const char* description,
- T value, std::function<void(const T&)> callback)
+template <class T>
+XBT_PUBLIC void declare_flag(const char* name, const char* description, T value, std::function<void(const T&)> callback)
{
- if (simgrid_config == nullptr) {
+ if (simgrid_config == nullptr)
simgrid_config = xbt_cfg_new();
- atexit(sg_config_finalize);
- }
- simgrid_config->registerOption<T>(
- name, description, std::move(value), std::move(callback));
+ simgrid_config->register_option<T>(name, description, std::move(value), std::move(callback));
}
-template XBT_PUBLIC(void) declareFlag(const char* name,
- const char* description, int value, std::function<void(int const &)> callback);
-template XBT_PUBLIC(void) declareFlag(const char* name,
- const char* description, double value, std::function<void(double const &)> callback);
-template XBT_PUBLIC(void) declareFlag(const char* name,
- const char* description, bool value, std::function<void(bool const &)> callback);
-template XBT_PUBLIC(void) declareFlag(const char* name,
- const char* description, std::string value, std::function<void(std::string const &)> callback);
-
+template XBT_PUBLIC void declare_flag(const char* name, const char* description, int value,
+ std::function<void(int const&)> callback);
+template XBT_PUBLIC void declare_flag(const char* name, const char* description, double value,
+ std::function<void(double const&)> callback);
+template XBT_PUBLIC void declare_flag(const char* name, const char* description, bool value,
+ std::function<void(bool const&)> callback);
+template XBT_PUBLIC void declare_flag(const char* name, const char* description, std::string value,
+ std::function<void(std::string const&)> callback);
}
}
// ***** C bindings *****
-xbt_cfg_t xbt_cfg_new() { 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)
{
if (simgrid_config == nullptr)
simgrid_config = xbt_cfg_new();
- simgrid_config->registerOption<double>(name, desc, default_value, cb_set);
+ simgrid_config->register_option<double>(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 == nullptr) {
+ if (simgrid_config == nullptr)
simgrid_config = xbt_cfg_new();
- atexit(&sg_config_finalize);
- }
- simgrid_config->registerOption<int>(name, desc, default_value, cb_set);
+ simgrid_config->register_option<int>(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<std::string>(name, desc, default_value ? default_value : "", cb_set);
+ simgrid_config->register_option<std::string>(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<bool>(name, desc, simgrid::config::parseBool(default_value), cb_set);
+ simgrid_config->register_option<bool>(name, desc, simgrid::config::parse_bool(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() { simgrid_config->showAliases(); }
-void xbt_cfg_help() { simgrid_config->help(); }
+void xbt_cfg_aliases()
+{
+ simgrid_config->show_aliases();
+}
+void xbt_cfg_help()
+{
+ simgrid_config->help();
+}
/*----[ Setting ]---------------------------------------------------------*/
if (name.compare(0, path.length(), path) != 0)
XBT_INFO("Configuration change: Set '%s' to '%s'", name.c_str(), val.c_str());
- try {
- (*simgrid_config)[name.c_str()].setStringValue(val.c_str());
- }
- catch (simgrid::config::missing_key_error& e) {
- goto on_missing_key;
- }
- catch (...) {
- goto on_exception;
- }
+ (*simgrid_config)[name.c_str()].set_string_value(val.c_str());
}
- return;
-
- /* Do not THROWF from a C++ exception catching context, or some cleanups will be missing */
-on_missing_key:
- THROWF(not_found_error, 0, "Could not set variables %s", options);
-on_exception:
- THROWF(unknown_error, 0, "Could not set variables %s", options);
}
-// Horrible mess to translate C++ exceptions to C exceptions:
-// 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(); }
-
/** @brief Set the value of a variable, using the string representation of that value
*
* @param key name of the variable to modify
void xbt_cfg_set_as_string(const char *key, const char *value)
{
- try {
- (*simgrid_config)[key].setStringValue(value);
- return;
- }
- TRANSLATE_EXCEPTIONS("Could not set variable %s as string %s", key, value);
+ (*simgrid_config)[key].set_string_value(value);
}
/** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet
*/
void xbt_cfg_setdefault_int(const char *key, int value)
{
- try {
- (*simgrid_config)[key].setDefaultValue<int>(value);
- return;
- }
- TRANSLATE_EXCEPTIONS("Could not set variable %s to default integer %i", key, value);
+ (*simgrid_config)[key].set_default_value<int>(value);
}
/** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet
*/
void xbt_cfg_setdefault_double(const char *key, double value)
{
- try {
- (*simgrid_config)[key].setDefaultValue<double>(value);
- return;
- }
- TRANSLATE_EXCEPTIONS("Could not set variable %s to default double %f", key, value);
+ (*simgrid_config)[key].set_default_value<double>(value);
}
/** @brief Set a string value to \a name within \a cfg if it wasn't changed yet
*/
void xbt_cfg_setdefault_string(const char *key, const char *value)
{
- try {
- (*simgrid_config)[key].setDefaultValue<std::string>(value ? value : "");
- return;
- }
- TRANSLATE_EXCEPTIONS("Could not set variable %s to default string %s", key, value);
+ (*simgrid_config)[key].set_default_value<std::string>(value ? value : "");
}
/** @brief Set an boolean value to \a name within \a cfg if it wasn't changed yet
*/
void xbt_cfg_setdefault_boolean(const char *key, const char *value)
{
- try {
- (*simgrid_config)[key].setDefaultValue<bool>(simgrid::config::parseBool(value));
- return;
- }
- TRANSLATE_EXCEPTIONS("Could not set variable %s to default boolean %s", key, value);
+ (*simgrid_config)[key].set_default_value<bool>(simgrid::config::parse_bool(value));
}
/** @brief Set an integer value to \a name within \a cfg
*/
void xbt_cfg_set_int(const char *key, int value)
{
- try {
- (*simgrid_config)[key].setValue<int>(value);
- return;
- }
- TRANSLATE_EXCEPTIONS("Could not set variable %s to integer %i", key, value);
+ (*simgrid_config)[key].set_value<int>(value);
}
/** @brief Set or add a double value to \a name within \a cfg
*/
void xbt_cfg_set_double(const char *key, double value)
{
- try {
- (*simgrid_config)[key].setValue<double>(value);
- return;
- }
- TRANSLATE_EXCEPTIONS("Could not set variable %s to double %f", key, value);
+ (*simgrid_config)[key].set_value<double>(value);
}
/** @brief Set or add a string value to \a name within \a cfg
*/
void xbt_cfg_set_string(const char* key, const char* value)
{
- try {
- (*simgrid_config)[key].setValue<std::string>(value);
- return;
- }
- TRANSLATE_EXCEPTIONS("Could not set variable %s to string %s", key, value);
+ (*simgrid_config)[key].set_value<std::string>(value);
}
/** @brief Set or add a boolean value to \a name within \a cfg
*/
void xbt_cfg_set_boolean(const char *key, const char *value)
{
- try {
- (*simgrid_config)[key].setValue<bool>(simgrid::config::parseBool(value));
- return;
- }
- TRANSLATE_EXCEPTIONS("Could not set variable %s to boolean %s", key, value);
+ (*simgrid_config)[key].set_value<bool>(simgrid::config::parse_bool(value));
}
/* Say if the value is the default value */
int xbt_cfg_is_default_value(const char *key)
{
- try {
- return (*simgrid_config)[key].isDefault() ? 1 : 0;
- }
- TRANSLATE_EXCEPTIONS("Could not get variable %s", key);
+ return (*simgrid_config)[key].is_default() ? 1 : 0;
}
/*----[ Getting ]---------------------------------------------------------*/
*/
int xbt_cfg_get_int(const char *key)
{
- try {
- return (*simgrid_config)[key].getValue<int>();
- }
- TRANSLATE_EXCEPTIONS("Could not get variable %s", key);
+ return (*simgrid_config)[key].get_value<int>();
}
/** @brief Retrieve a double value of a variable (get a warning if not uniq)
*/
double xbt_cfg_get_double(const char *key)
{
- try {
- return (*simgrid_config)[key].getValue<double>();
- }
- TRANSLATE_EXCEPTIONS("Could not get variable %s", key);
+ return (*simgrid_config)[key].get_value<double>();
}
/** @brief Retrieve a string value of a variable (get a warning if not uniq)
*/
std::string xbt_cfg_get_string(const char* key)
{
- try {
- return (*simgrid_config)[key].getValue<std::string>();
- }
- TRANSLATE_EXCEPTIONS("Could not get variable %s", key);
+ return (*simgrid_config)[key].get_value<std::string>();
}
/** @brief Retrieve a boolean value of a variable (get a warning if not uniq)
*/
int xbt_cfg_get_boolean(const char *key)
{
- try {
- return (*simgrid_config)[key].getValue<bool>() ? 1 : 0;
- }
- TRANSLATE_EXCEPTIONS("Could not get variable %s", key);
+ return (*simgrid_config)[key].get_value<bool>() ? 1 : 0;
}
#ifdef SIMGRID_TEST
XBT_TEST_SUITE("config", "Configuration support");
-XBT_PUBLIC_DATA(xbt_cfg_t) simgrid_config;
+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_int("speed", 0, nullptr, "");
- xbt_cfg_register_string("peername", "", nullptr, "");
- xbt_cfg_register_string("user", "", nullptr, "");
+ simgrid::config::declare_flag<int>("speed", "description", 0);
+ simgrid::config::declare_flag<std::string>("peername", "description", "");
+ simgrid::config::declare_flag<std::string>("user", "description", "");
} /* end_of_make_set */
XBT_TEST_UNIT("memuse", test_config_memuse, "Alloc and free a config set")
{
/* get_single_value */
xbt_cfg_set_parse("peername:toto:42 speed:42");
- int ival = xbt_cfg_get_int("speed");
+ int ival = simgrid::config::get_config<int>("speed");
if (ival != 42)
xbt_test_fail("Speed value = %d, I expected 42", ival);
}
