1 /* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
18 #include <type_traits>
22 #include "simgrid/sg_config.hpp"
23 #include "xbt/dynar.h"
26 #include "xbt/sysdep.h"
27 #include <xbt/config.h>
28 #include <xbt/config.hpp>
31 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_cfg, xbt, "configuration support");
33 XBT_EXPORT_NO_IMPORT xbt_cfg_t simgrid_config = nullptr;
38 missing_key_error::~missing_key_error() = default;
42 const char* true_values[] = {
43 "yes", "on", "true", "1"
45 const char* false_values[] = {
46 "no", "off", "false", "0"
49 static bool parseBool(const char* value)
51 for (const char* const& true_value : true_values)
52 if (std::strcmp(true_value, value) == 0)
54 for (const char* const& false_value : false_values)
55 if (std::strcmp(false_value, value) == 0)
57 throw std::range_error("not a boolean");
60 static double parseDouble(const char* value)
64 double res = std::strtod(value, &end);
66 throw std::range_error("out of range");
68 xbt_die("Unexpected errno");
69 if (end == value || *end != '\0')
70 throw std::range_error("invalid double");
75 static long int parseLong(const char* value)
79 long int res = std::strtol(value, &end, 0);
81 if (res == LONG_MIN && errno == ERANGE)
82 throw std::range_error("underflow");
83 else if (res == LONG_MAX && errno == ERANGE)
84 throw std::range_error("overflow");
85 xbt_die("Unexpected errno");
87 if (end == value || *end != '\0')
88 throw std::range_error("invalid integer");
93 // ***** ConfigType *****
95 /// A trait which define possible options types:
96 template <class T> class ConfigType;
98 template <> class ConfigType<int> {
100 static constexpr const char* type_name = "int";
101 static inline double parse(const char* value)
103 return parseLong(value);
106 template <> class ConfigType<double> {
108 static constexpr const char* type_name = "double";
109 static inline double parse(const char* value)
111 return parseDouble(value);
114 template <> class ConfigType<std::string> {
116 static constexpr const char* type_name = "string";
117 static inline std::string parse(const char* value)
119 return std::string(value);
122 template <> class ConfigType<bool> {
124 static constexpr const char* type_name = "boolean";
125 static inline bool parse(const char* value)
127 return parseBool(value);
131 // **** Forward declarations ****
133 class ConfigurationElement ;
134 template<class T> class TypedConfigurationElement;
136 // **** ConfigurationElement ****
138 class ConfigurationElement {
142 bool isdefault = true;
146 xbt_cfg_cb_t old_callback = nullptr;
148 ConfigurationElement(const char* key, const char* desc) : key(key ? key : ""), desc(desc ? desc : "") {}
149 ConfigurationElement(const char* key, const char* desc, xbt_cfg_cb_t cb)
150 : key(key ? key : ""), desc(desc ? desc : ""), old_callback(cb) {}
152 virtual ~ConfigurationElement()=default;
154 virtual std::string getStringValue() = 0;
155 virtual void setStringValue(const char* value) = 0;
156 virtual const char* getTypeName() = 0;
159 T const& getValue() const
161 return dynamic_cast<const TypedConfigurationElement<T>&>(*this).getValue();
164 void setValue(T value)
166 dynamic_cast<TypedConfigurationElement<T>&>(*this).setValue(std::move(value));
169 void setDefaultValue(T value)
171 dynamic_cast<TypedConfigurationElement<T>&>(*this).setDefaultValue(std::move(value));
173 void unsetDefault() { isdefault = false; }
174 bool isDefault() const { return isdefault; }
176 std::string const& getDescription() const { return desc; }
177 std::string const& getKey() const { return key; }
180 // **** TypedConfigurationElement<T> ****
182 // TODO, could we use boost::any with some Type* reference?
184 class TypedConfigurationElement : public ConfigurationElement {
187 std::function<void(T&)> callback;
190 TypedConfigurationElement(const char* key, const char* desc, T value = T())
191 : ConfigurationElement(key, desc), content(std::move(value))
193 TypedConfigurationElement(const char* key, const char* desc, T value, xbt_cfg_cb_t cb)
194 : ConfigurationElement(key, desc, cb), content(std::move(value))
196 TypedConfigurationElement(const char* key, const char* desc, T value, std::function<void(T&)> callback)
197 : ConfigurationElement(key, desc), content(std::move(value)), callback(std::move(callback))
199 ~TypedConfigurationElement() = default;
201 std::string getStringValue() override;
202 const char* getTypeName() override;
203 void setStringValue(const char* value) override;
208 this->old_callback(getKey().c_str());
210 this->callback(this->content);
213 T const& getValue() const { return content; }
215 void setValue(T value)
217 this->content = std::move(value);
219 this->unsetDefault();
222 void setDefaultValue(T value)
224 if (this->isDefault()) {
225 this->content = std::move(value);
228 XBT_DEBUG("Do not override configuration variable '%s' with value '%s' because it was already set.",
229 getKey().c_str(), to_string(value).c_str());
235 std::string TypedConfigurationElement<T>::getStringValue() // override
237 return to_string(content);
241 void TypedConfigurationElement<T>::setStringValue(const char* value) // override
243 this->content = ConfigType<T>::parse(value);
244 this->unsetDefault();
249 const char* TypedConfigurationElement<T>::getTypeName() // override
251 return ConfigType<T>::type_name;
254 } // end of anonymous namespace
260 // name -> ConfigElement:
261 std::map<std::string, simgrid::config::ConfigurationElement*> options;
262 // alias -> ConfigElement from options:
263 std::map<std::string, simgrid::config::ConfigurationElement*> aliases;
264 bool warn_for_aliases = true;
271 Config(Config const&) = delete;
272 Config& operator=(Config const&) = delete;
274 ConfigurationElement& operator[](const char* name);
276 TypedConfigurationElement<T>& getTyped(const char* name);
277 void alias(const char* realname, const char* aliasname);
279 template<class T, class... A>
280 simgrid::config::TypedConfigurationElement<T>*
281 registerOption(const char* name, A&&... a)
283 xbt_assert(options.find(name) == options.end(), "Refusing to register the config element '%s' twice.", name);
284 TypedConfigurationElement<T>* variable = new TypedConfigurationElement<T>(name, std::forward<A>(a)...);
285 XBT_DEBUG("Register cfg elm %s (%s) of type %s @%p in set %p)", name, variable->getDescription().c_str(),
286 variable->getTypeName(), variable, this);
287 options.insert({name, variable});
293 void dump(const char *name, const char *indent);
298 ConfigurationElement* getDictElement(const char* name);
303 atexit(&sg_config_finalize);
307 XBT_DEBUG("Frees cfg set %p", this);
308 for (auto const& elm : options)
312 inline ConfigurationElement* Config::getDictElement(const char* name)
314 auto opt = options.find(name);
315 if (opt != options.end()) {
318 auto als = aliases.find(name);
319 if (als != aliases.end()) {
320 ConfigurationElement* res = als->second;
321 if (warn_for_aliases)
322 XBT_INFO("Option %s has been renamed to %s. Consider switching.", name, res->getKey().c_str());
325 throw simgrid::config::missing_key_error(std::string("Bad config key: ") + name);
330 inline ConfigurationElement& Config::operator[](const char* name)
332 return *(getDictElement(name));
335 void Config::alias(const char* realname, const char* aliasname)
337 xbt_assert(aliases.find(aliasname) == aliases.end(), "Alias '%s' already.", aliasname);
338 ConfigurationElement* element = this->getDictElement(realname);
339 xbt_assert(element, "Cannot define an alias to the non-existing option '%s'.", realname);
340 this->aliases.insert({aliasname, element});
343 /** @brief Dump a config set for debuging purpose
345 * @param name The name to give to this config set
346 * @param indent what to write at the beginning of each line (right number of spaces)
348 void Config::dump(const char *name, const char *indent)
351 printf("%s>> Dumping of the config set '%s':\n", indent, name);
353 for (auto const& elm : options)
354 printf("%s %s: ()%s) %s", indent, elm.first.c_str(), elm.second->getTypeName(),
355 elm.second->getStringValue().c_str());
358 printf("%s<< End of the config set '%s'\n", indent, name);
362 /** @brief Displays the declared aliases and their description */
363 void Config::showAliases()
365 bool old_warn_for_aliases = false;
366 std::swap(warn_for_aliases, old_warn_for_aliases);
367 for (auto const& elm : aliases)
368 printf(" %s: %s\n", elm.first.c_str(), (*this)[elm.first.c_str()].getDescription().c_str());
369 std::swap(warn_for_aliases, old_warn_for_aliases);
372 /** @brief Displays the declared options and their description */
375 for (auto const& elm : options) {
376 simgrid::config::ConfigurationElement* variable = this->options.at(elm.first);
377 printf(" %s: %s\n", elm.first.c_str(), variable->getDescription().c_str());
378 printf(" Type: %s; ", variable->getTypeName());
379 printf("Current value: %s\n", variable->getStringValue().c_str());
383 // ***** getConfig *****
385 template <class T> XBT_PUBLIC T const& getConfig(const char* name)
387 return (*simgrid_config)[name].getValue<T>();
390 template XBT_PUBLIC int const& getConfig<int>(const char* name);
391 template XBT_PUBLIC double const& getConfig<double>(const char* name);
392 template XBT_PUBLIC bool const& getConfig<bool>(const char* name);
393 template XBT_PUBLIC std::string const& getConfig<std::string>(const char* name);
397 void alias(const char* realname, const char* aliasname)
399 simgrid_config->alias(realname, aliasname);
402 // ***** declareFlag *****
405 XBT_PUBLIC void declareFlag(const char* name, const char* description, T value, std::function<void(const T&)> callback)
407 if (simgrid_config == nullptr)
408 simgrid_config = xbt_cfg_new();
409 simgrid_config->registerOption<T>(
410 name, description, std::move(value), std::move(callback));
413 template XBT_PUBLIC void declareFlag(const char* name, const char* description, int value,
414 std::function<void(int const&)> callback);
415 template XBT_PUBLIC void declareFlag(const char* name, const char* description, double value,
416 std::function<void(double const&)> callback);
417 template XBT_PUBLIC void declareFlag(const char* name, const char* description, bool value,
418 std::function<void(bool const&)> callback);
419 template XBT_PUBLIC void declareFlag(const char* name, const char* description, std::string value,
420 std::function<void(std::string const&)> callback);
424 // ***** C bindings *****
426 xbt_cfg_t xbt_cfg_new()
428 return new simgrid::config::Config();
430 void xbt_cfg_free(xbt_cfg_t * cfg) { delete *cfg; }
432 void xbt_cfg_dump(const char *name, const char *indent, xbt_cfg_t cfg)
434 cfg->dump(name, indent);
437 /*----[ Registering stuff ]-----------------------------------------------*/
439 void xbt_cfg_register_double(const char *name, double default_value,
440 xbt_cfg_cb_t cb_set, const char *desc)
442 if (simgrid_config == nullptr)
443 simgrid_config = xbt_cfg_new();
444 simgrid_config->registerOption<double>(name, desc, default_value, cb_set);
447 void xbt_cfg_register_int(const char *name, int default_value,xbt_cfg_cb_t cb_set, const char *desc)
449 if (simgrid_config == nullptr)
450 simgrid_config = xbt_cfg_new();
451 simgrid_config->registerOption<int>(name, desc, default_value, cb_set);
454 void xbt_cfg_register_string(const char *name, const char *default_value, xbt_cfg_cb_t cb_set, const char *desc)
456 if (simgrid_config == nullptr)
457 simgrid_config = xbt_cfg_new();
458 simgrid_config->registerOption<std::string>(name, desc, default_value ? default_value : "", cb_set);
461 void xbt_cfg_register_boolean(const char *name, const char*default_value,xbt_cfg_cb_t cb_set, const char *desc)
463 if (simgrid_config == nullptr)
464 simgrid_config = xbt_cfg_new();
465 simgrid_config->registerOption<bool>(name, desc, simgrid::config::parseBool(default_value), cb_set);
468 void xbt_cfg_register_alias(const char *realname, const char *aliasname)
470 if (simgrid_config == nullptr)
471 simgrid_config = xbt_cfg_new();
472 simgrid_config->alias(realname, aliasname);
475 void xbt_cfg_aliases() { simgrid_config->showAliases(); }
476 void xbt_cfg_help() { simgrid_config->help(); }
478 /*----[ Setting ]---------------------------------------------------------*/
480 /** @brief Add values parsed from a string into a config set
482 * @param options a string containing the content to add to the config set. This is a '\\t',' ' or '\\n' or ','
483 * separated list of variables. Each individual variable is like "[name]:[value]" where [name] is the name of an
484 * already registered variable, and [value] conforms to the data type under which this variable was registered.
486 * @todo This is a crude manual parser, it should be a proper lexer.
488 void xbt_cfg_set_parse(const char *options)
490 if (not options || not strlen(options)) { /* nothing to do */
494 XBT_DEBUG("List to parse and set:'%s'", options);
495 std::string optionlist(options);
496 while (not optionlist.empty()) {
497 XBT_DEBUG("Still to parse and set: '%s'", optionlist.c_str());
500 size_t pos = optionlist.find_first_not_of(" \t\n,");
501 optionlist.erase(0, pos);
503 pos = optionlist.find_first_of(" \t\n,");
504 std::string name = optionlist.substr(0, pos);
505 optionlist.erase(0, pos);
506 XBT_DEBUG("parse now:'%s'; parse later:'%s'", name.c_str(), optionlist.c_str());
511 pos = name.find(':');
512 xbt_assert(pos != std::string::npos, "Option '%s' badly formatted. Should be of the form 'name:value'",
515 std::string val = name.substr(pos + 1);
518 const std::string path("path");
519 if (name.compare(0, path.length(), path) != 0)
520 XBT_INFO("Configuration change: Set '%s' to '%s'", name.c_str(), val.c_str());
523 (*simgrid_config)[name.c_str()].setStringValue(val.c_str());
525 catch (simgrid::config::missing_key_error& e) {
534 /* Do not THROWF from a C++ exception catching context, or some cleanups will be missing */
536 THROWF(not_found_error, 0, "Could not set variables %s", options);
538 THROWF(unknown_error, 0, "Could not set variables %s", options);
541 // Horrible mess to translate C++ exceptions to C exceptions:
542 // Exit from the catch block (and do the correct exception cleaning) before attempting to THROWF.
543 #define TRANSLATE_EXCEPTIONS(...) \
544 catch(simgrid::config::missing_key_error& e) { THROWF(not_found_error, 0, __VA_ARGS__); abort(); } \
545 catch(...) { THROWF(not_found_error, 0, __VA_ARGS__); abort(); }
547 /** @brief Set the value of a variable, using the string representation of that value
549 * @param key name of the variable to modify
550 * @param value string representation of the value to set
553 void xbt_cfg_set_as_string(const char *key, const char *value)
556 (*simgrid_config)[key].setStringValue(value);
559 TRANSLATE_EXCEPTIONS("Could not set variable %s as string %s", key, value);
562 /** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet
564 * This is useful to change the default value of a variable while allowing
565 * users to override it with command line arguments
567 void xbt_cfg_setdefault_int(const char *key, int value)
570 (*simgrid_config)[key].setDefaultValue<int>(value);
573 TRANSLATE_EXCEPTIONS("Could not set variable %s to default integer %i", key, value);
576 /** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet
578 * This is useful to change the default value of a variable while allowing
579 * users to override it with command line arguments
581 void xbt_cfg_setdefault_double(const char *key, double value)
584 (*simgrid_config)[key].setDefaultValue<double>(value);
587 TRANSLATE_EXCEPTIONS("Could not set variable %s to default double %f", key, value);
590 /** @brief Set a string value to \a name within \a cfg if it wasn't changed yet
592 * This is useful to change the default value of a variable while allowing
593 * users to override it with command line arguments
595 void xbt_cfg_setdefault_string(const char *key, const char *value)
598 (*simgrid_config)[key].setDefaultValue<std::string>(value ? value : "");
601 TRANSLATE_EXCEPTIONS("Could not set variable %s to default string %s", key, value);
604 /** @brief Set an boolean value to \a name within \a cfg if it wasn't changed yet
606 * This is useful to change the default value of a variable while allowing
607 * users to override it with command line arguments
609 void xbt_cfg_setdefault_boolean(const char *key, const char *value)
612 (*simgrid_config)[key].setDefaultValue<bool>(simgrid::config::parseBool(value));
615 TRANSLATE_EXCEPTIONS("Could not set variable %s to default boolean %s", key, value);
618 /** @brief Set an integer value to \a name within \a cfg
620 * @param key the name of the variable
621 * @param value the value of the variable
623 void xbt_cfg_set_int(const char *key, int value)
626 (*simgrid_config)[key].setValue<int>(value);
629 TRANSLATE_EXCEPTIONS("Could not set variable %s to integer %i", key, value);
632 /** @brief Set or add a double value to \a name within \a cfg
634 * @param key the name of the variable
635 * @param value the double to set
637 void xbt_cfg_set_double(const char *key, double value)
640 (*simgrid_config)[key].setValue<double>(value);
643 TRANSLATE_EXCEPTIONS("Could not set variable %s to double %f", key, value);
646 /** @brief Set or add a string value to \a name within \a cfg
648 * @param key the name of the variable
649 * @param value the value to be added
652 void xbt_cfg_set_string(const char* key, const char* value)
655 (*simgrid_config)[key].setValue<std::string>(value);
658 TRANSLATE_EXCEPTIONS("Could not set variable %s to string %s", key, value);
661 /** @brief Set or add a boolean value to \a name within \a cfg
663 * @param key the name of the variable
664 * @param value the value of the variable
666 void xbt_cfg_set_boolean(const char *key, const char *value)
669 (*simgrid_config)[key].setValue<bool>(simgrid::config::parseBool(value));
672 TRANSLATE_EXCEPTIONS("Could not set variable %s to boolean %s", key, value);
676 /* Say if the value is the default value */
677 int xbt_cfg_is_default_value(const char *key)
680 return (*simgrid_config)[key].isDefault() ? 1 : 0;
682 TRANSLATE_EXCEPTIONS("Could not get variable %s", key);
685 /*----[ Getting ]---------------------------------------------------------*/
686 /** @brief Retrieve an integer value of a variable (get a warning if not uniq)
688 * @param key the name of the variable
690 * Returns the first value from the config set under the given name.
692 int xbt_cfg_get_int(const char *key)
695 return (*simgrid_config)[key].getValue<int>();
697 TRANSLATE_EXCEPTIONS("Could not get variable %s", key);
700 /** @brief Retrieve a double value of a variable (get a warning if not uniq)
702 * @param key the name of the variable
704 * Returns the first value from the config set under the given name.
706 double xbt_cfg_get_double(const char *key)
709 return (*simgrid_config)[key].getValue<double>();
711 TRANSLATE_EXCEPTIONS("Could not get variable %s", key);
714 /** @brief Retrieve a string value of a variable (get a warning if not uniq)
716 * @param key the name of the variable
718 * Returns the first value from the config set under the given name.
719 * If there is more than one value, it will issue a warning.
720 * Returns nullptr if there is no value.
722 * \warning the returned value is the actual content of the config set
724 std::string xbt_cfg_get_string(const char* key)
727 return (*simgrid_config)[key].getValue<std::string>();
729 TRANSLATE_EXCEPTIONS("Could not get variable %s", key);
732 /** @brief Retrieve a boolean value of a variable (get a warning if not uniq)
734 * @param key the name of the variable
736 * Returns the first value from the config set under the given name.
737 * If there is more than one value, it will issue a warning.
739 int xbt_cfg_get_boolean(const char *key)
742 return (*simgrid_config)[key].getValue<bool>() ? 1 : 0;
744 TRANSLATE_EXCEPTIONS("Could not get variable %s", key);
753 #include <xbt/ex.hpp>
755 #include <xbt/config.hpp>
757 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_cfg);
759 XBT_TEST_SUITE("config", "Configuration support");
761 XBT_PUBLIC_DATA xbt_cfg_t simgrid_config;
763 static void make_set()
765 simgrid_config = nullptr;
766 xbt_log_threshold_set(&_XBT_LOGV(xbt_cfg), xbt_log_priority_critical);
767 xbt_cfg_register_int("speed", 0, nullptr, "");
768 xbt_cfg_register_string("peername", "", nullptr, "");
769 xbt_cfg_register_string("user", "", nullptr, "");
770 } /* end_of_make_set */
772 XBT_TEST_UNIT("memuse", test_config_memuse, "Alloc and free a config set")
774 auto temp = simgrid_config;
776 xbt_test_add("Alloc and free a config set");
777 xbt_cfg_set_parse("peername:veloce user:bidule");
778 xbt_cfg_free(&simgrid_config);
779 simgrid_config = temp;
782 XBT_TEST_UNIT("use", test_config_use, "Data retrieving tests")
784 auto temp = simgrid_config;
786 xbt_test_add("Get a single value");
788 /* get_single_value */
789 xbt_cfg_set_parse("peername:toto:42 speed:42");
790 int ival = xbt_cfg_get_int("speed");
792 xbt_test_fail("Speed value = %d, I expected 42", ival);
795 xbt_test_add("Access to a non-existant entry");
798 xbt_cfg_set_parse("color:blue");
800 if (e.category != not_found_error)
801 xbt_test_exception(e);
804 xbt_cfg_free(&simgrid_config);
805 simgrid_config = temp;
808 XBT_TEST_UNIT("c++flags", test_config_cxx_flags, "C++ flags")
810 auto temp = simgrid_config;
812 xbt_test_add("C++ declaration of flags");
814 simgrid::config::Flag<int> int_flag("int", "", 0);
815 simgrid::config::Flag<std::string> string_flag("string", "", "foo");
816 simgrid::config::Flag<double> double_flag("double", "", 0.32);
817 simgrid::config::Flag<bool> bool_flag1("bool1", "", false);
818 simgrid::config::Flag<bool> bool_flag2("bool2", "", true);
820 xbt_test_add("Parse values");
821 xbt_cfg_set_parse("int:42 string:bar double:8.0 bool1:true bool2:false");
822 xbt_test_assert(int_flag == 42, "Check int flag");
823 xbt_test_assert(string_flag == "bar", "Check string flag");
824 xbt_test_assert(double_flag == 8.0, "Check double flag");
825 xbt_test_assert(bool_flag1, "Check bool1 flag");
826 xbt_test_assert(not bool_flag2, "Check bool2 flag");
828 xbt_cfg_free(&simgrid_config);
829 simgrid_config = temp;
832 #endif /* SIMGRID_TEST */