1 /* Copyright (c) 2004-2020. 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. */
19 #include <type_traits>
23 #include "simgrid/Exception.hpp"
24 #include "simgrid/sg_config.hpp"
25 #include "xbt/dynar.h"
28 #include "xbt/sysdep.h"
29 #include <xbt/config.h>
30 #include <xbt/config.hpp>
32 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_cfg, xbt, "configuration support");
34 XBT_EXPORT_NO_IMPORT xbt_cfg_t simgrid_config = nullptr;
41 static bool parse_bool(const char* value)
43 for (const char* true_value : {"yes", "on", "true", "1"})
44 if (std::strcmp(true_value, value) == 0)
46 for (const char* false_value : {"no", "off", "false", "0"})
47 if (std::strcmp(false_value, value) == 0)
49 throw std::range_error("not a boolean");
52 static double parse_double(const char* value)
56 double res = std::strtod(value, &end);
58 throw std::range_error("out of range");
60 xbt_die("Unexpected errno");
61 if (end == value || *end != '\0')
62 throw std::range_error("invalid double");
67 static long int parse_long(const char* value)
71 long int res = std::strtol(value, &end, 0);
73 if (res == LONG_MIN && errno == ERANGE)
74 throw std::range_error("underflow");
75 else if (res == LONG_MAX && errno == ERANGE)
76 throw std::range_error("overflow");
77 xbt_die("Unexpected errno");
79 if (end == value || *end != '\0')
80 throw std::range_error("invalid integer");
85 // ***** ConfigType *****
87 /// A trait which define possible options types:
88 template <class T> class ConfigType;
90 template <> class ConfigType<int> {
92 static constexpr const char* type_name = "int";
93 static inline int parse(const char* value)
95 long val = parse_long(value);
97 throw std::range_error("underflow");
99 throw std::range_error("overflow");
100 return static_cast<int>(val);
103 template <> class ConfigType<double> {
105 static constexpr const char* type_name = "double";
106 static inline double parse(const char* value)
108 return parse_double(value);
111 template <> class ConfigType<std::string> {
113 static constexpr const char* type_name = "string";
114 static inline std::string parse(const char* value)
116 return std::string(value);
119 template <> class ConfigType<bool> {
121 static constexpr const char* type_name = "boolean";
122 static inline bool parse(const char* value)
124 return parse_bool(value);
128 // **** Forward declarations ****
130 class ConfigurationElement ;
131 template<class T> class TypedConfigurationElement;
133 // **** ConfigurationElement ****
135 class ConfigurationElement {
139 bool isdefault = true;
142 ConfigurationElement(const std::string& key, const std::string& desc) : key(key), desc(desc) {}
144 virtual ~ConfigurationElement() = default;
146 virtual std::string get_string_value() = 0;
147 virtual void set_string_value(const char* value) = 0;
148 virtual const char* get_type_name() = 0;
150 template <class T> T const& get_value() const
152 return static_cast<const TypedConfigurationElement<T>&>(*this).get_value();
154 template <class T> void set_value(T value)
156 static_cast<TypedConfigurationElement<T>&>(*this).set_value(std::move(value));
158 template <class T> void set_default_value(T value)
160 static_cast<TypedConfigurationElement<T>&>(*this).set_default_value(std::move(value));
162 void unset_default() { isdefault = false; }
163 bool is_default() const { return isdefault; }
165 std::string const& get_description() const { return desc; }
166 std::string const& get_key() const { return key; }
169 // **** TypedConfigurationElement<T> ****
171 // TODO, could we use boost::any with some Type* reference?
173 class TypedConfigurationElement : public ConfigurationElement {
176 std::function<void(T&)> callback;
179 TypedConfigurationElement(const std::string& key, const std::string& desc, T value = T())
180 : ConfigurationElement(key, desc), content(std::move(value))
182 TypedConfigurationElement(const std::string& key, const std::string& desc, T value, std::function<void(T&)> callback)
183 : ConfigurationElement(key, desc), content(std::move(value)), callback(std::move(callback))
185 ~TypedConfigurationElement() override = default;
187 std::string get_string_value() override;
188 const char* get_type_name() override;
189 void set_string_value(const char* value) override;
194 this->callback(this->content);
197 T const& get_value() const { return content; }
199 void set_value(T value)
201 this->content = std::move(value);
203 this->unset_default();
206 void set_default_value(T value)
208 if (this->is_default()) {
209 this->content = std::move(value);
212 XBT_DEBUG("Do not override configuration variable '%s' with value '%s' because it was already set.",
213 get_key().c_str(), get_string_value().c_str());
218 template <class T> std::string TypedConfigurationElement<T>::get_string_value() // override
220 return to_string(content);
223 template <> std::string TypedConfigurationElement<double>::get_string_value() // override
225 // don't want std::to_string which uses %f, and formats very small values as 0.000000
226 return xbt::string_printf("%g", content);
229 template <class T> void TypedConfigurationElement<T>::set_string_value(const char* value) // override
231 this->content = ConfigType<T>::parse(value);
232 this->unset_default();
236 template <class T> const char* TypedConfigurationElement<T>::get_type_name() // override
238 return ConfigType<T>::type_name;
241 } // end of anonymous namespace
247 // name -> ConfigElement:
248 std::map<std::string, std::unique_ptr<ConfigurationElement>> options;
249 // alias -> ConfigElement from options:
250 std::map<std::string, ConfigurationElement*> aliases;
251 bool warn_for_aliases = true;
257 Config(Config const&) = delete;
258 Config& operator=(Config const&) = delete;
260 ConfigurationElement& operator[](const std::string& name);
261 void alias(const std::string& realname, const std::string& aliasname);
263 template <class T, class... A> TypedConfigurationElement<T>* register_option(const std::string& name, A&&... a)
265 xbt_assert(options.find(name) == options.end(), "Refusing to register the config element '%s' twice.",
267 auto* variable = new TypedConfigurationElement<T>(name, std::forward<A>(a)...);
268 XBT_DEBUG("Register cfg elm %s (%s) of type %s @%p in set %p)", name.c_str(), variable->get_description().c_str(),
269 variable->get_type_name(), variable, this);
270 options[name].reset(variable);
276 void dump(const char* name, const char* indent) const;
277 void show_aliases() const;
281 ConfigurationElement* get_dict_element(const std::string& name);
286 atexit(&sg_config_finalize);
289 inline ConfigurationElement* Config::get_dict_element(const std::string& name)
291 auto opt = options.find(name);
292 if (opt != options.end()) {
293 return opt->second.get();
295 auto als = aliases.find(name);
296 if (als != aliases.end()) {
297 ConfigurationElement* res = als->second;
298 if (warn_for_aliases)
299 XBT_INFO("Option %s has been renamed to %s. Consider switching.", name.c_str(), res->get_key().c_str());
302 std::string msg = "Bad config key: " + name + "\nExisting config keys:\n";
303 for (auto const& elm : options)
304 msg += " " + elm.first + ": (" + elm.second->get_type_name() + ")" + elm.second->get_string_value() + "\n";
305 throw std::out_of_range(msg);
310 inline ConfigurationElement& Config::operator[](const std::string& name)
312 return *(get_dict_element(name));
315 void Config::alias(const std::string& realname, const std::string& aliasname)
317 xbt_assert(aliases.find(aliasname) == aliases.end(), "Alias '%s' already.", aliasname.c_str());
318 ConfigurationElement* element = this->get_dict_element(realname);
319 xbt_assert(element, "Cannot define an alias to the non-existing option '%s'.", realname.c_str());
320 this->aliases.insert({aliasname, element});
323 /** @brief Dump a config set for debugging purpose
325 * @param name The name to give to this config set
326 * @param indent what to write at the beginning of each line (right number of spaces)
328 void Config::dump(const char* name, const char* indent) const
331 XBT_CVERB(xbt_help, "%s>> Dumping of the config set '%s':", indent, name);
333 for (auto const& elm : options)
334 XBT_CVERB(xbt_help, "%s %s: ()%s) %s", indent, elm.first.c_str(), elm.second->get_type_name(),
335 elm.second->get_string_value().c_str());
338 XBT_CVERB(xbt_help, "%s<< End of the config set '%s'", indent, name);
341 /** @brief Displays the declared aliases and their replacement */
342 void Config::show_aliases() const
344 for (auto const& elm : aliases)
345 XBT_HELP(" %-40s %s", elm.first.c_str(), elm.second->get_key().c_str());
348 /** @brief Displays the declared options and their description */
349 void Config::help() const
351 for (auto const& elm : options) {
352 simgrid::config::ConfigurationElement* variable = elm.second.get();
353 XBT_HELP(" %s: %s", elm.first.c_str(), variable->get_description().c_str());
354 XBT_HELP(" Type: %s; Current value: %s", variable->get_type_name(), variable->get_string_value().c_str());
358 // ***** set_default *****
360 template <class T> XBT_PUBLIC void set_default(const char* name, T value)
362 (*simgrid_config)[name].set_default_value<T>(std::move(value));
365 template XBT_PUBLIC void set_default<int>(const char* name, int value);
366 template XBT_PUBLIC void set_default<double>(const char* name, double value);
367 template XBT_PUBLIC void set_default<bool>(const char* name, bool value);
368 template XBT_PUBLIC void set_default<std::string>(const char* name, std::string value);
370 bool is_default(const char* name)
372 return (*simgrid_config)[name].is_default();
375 // ***** set_value *****
377 template <class T> XBT_PUBLIC void set_value(const char* name, T value)
379 (*simgrid_config)[name].set_value<T>(std::move(value));
382 template XBT_PUBLIC void set_value<int>(const char* name, int value);
383 template XBT_PUBLIC void set_value<double>(const char* name, double value);
384 template XBT_PUBLIC void set_value<bool>(const char* name, bool value);
385 template XBT_PUBLIC void set_value<std::string>(const char* name, std::string value);
387 void set_as_string(const char* name, const std::string& value)
389 (*simgrid_config)[name].set_string_value(value.c_str());
392 void set_parse(const std::string& opt)
394 std::string options(opt);
395 XBT_DEBUG("List to parse and set:'%s'", options.c_str());
396 while (not options.empty()) {
397 XBT_DEBUG("Still to parse and set: '%s'", options.c_str());
400 size_t pos = options.find_first_not_of(" \t\n,");
401 options.erase(0, pos);
403 pos = options.find_first_of(" \t\n,");
404 std::string name = options.substr(0, pos);
405 options.erase(0, pos);
406 XBT_DEBUG("parse now:'%s'; parse later:'%s'", name.c_str(), options.c_str());
411 pos = name.find(':');
412 xbt_assert(pos != std::string::npos, "Option '%s' badly formatted. Should be of the form 'name:value'",
415 std::string val = name.substr(pos + 1);
418 const std::string path("path");
419 if (name.compare(0, path.length(), path) != 0)
420 XBT_INFO("Configuration change: Set '%s' to '%s'", name.c_str(), val.c_str());
422 set_as_string(name.c_str(), val);
426 // ***** get_value *****
428 template <class T> XBT_PUBLIC T const& get_value(const std::string& name)
430 return (*simgrid_config)[name].get_value<T>();
433 template XBT_PUBLIC int const& get_value<int>(const std::string& name);
434 template XBT_PUBLIC double const& get_value<double>(const std::string& name);
435 template XBT_PUBLIC bool const& get_value<bool>(const std::string& name);
436 template XBT_PUBLIC std::string const& get_value<std::string>(const std::string& name);
440 void alias(const char* realname, std::initializer_list<const char*> aliases)
442 for (auto const& aliasname : aliases)
443 simgrid_config->alias(realname, aliasname);
446 // ***** declare_flag *****
449 XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, T value,
450 std::function<void(const T&)> callback)
452 if (simgrid_config == nullptr)
453 simgrid_config = new simgrid::config::Config();
454 simgrid_config->register_option<T>(name, description, std::move(value), std::move(callback));
457 template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, int value,
458 std::function<void(int const&)> callback);
459 template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, double value,
460 std::function<void(double const&)> callback);
461 template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, bool value,
462 std::function<void(bool const&)> callback);
463 template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, std::string value,
464 std::function<void(std::string const&)> callback);
468 delete simgrid_config;
469 simgrid_config = nullptr;
474 simgrid_config->show_aliases();
479 simgrid_config->help();
484 /*----[ Setting ]---------------------------------------------------------*/
486 /** @brief Set an integer value to \a name within \a cfg
488 * @param key the name of the variable
489 * @param value the value of the variable
491 void sg_cfg_set_int(const char* key, int value)
493 (*simgrid_config)[key].set_value<int>(value);
496 /** @brief Set or add a double value to \a name within \a cfg
498 * @param key the name of the variable
499 * @param value the double to set
501 void sg_cfg_set_double(const char* key, double value)
503 (*simgrid_config)[key].set_value<double>(value);
506 /** @brief Set or add a string value to \a name within \a cfg
508 * @param key the name of the variable
509 * @param value the value to be added
512 void sg_cfg_set_string(const char* key, const char* value)
514 (*simgrid_config)[key].set_value<std::string>(value);
517 /** @brief Set or add a boolean value to \a name within \a cfg
519 * @param key the name of the variable
520 * @param value the value of the variable
522 void sg_cfg_set_boolean(const char* key, const char* value)
524 (*simgrid_config)[key].set_value<bool>(simgrid::config::parse_bool(value));
527 /*----[ Getting ]---------------------------------------------------------*/
528 /** @brief Retrieve an integer value of a variable (get a warning if not uniq)
530 * @param key the name of the variable
532 * Returns the first value from the config set under the given name.
534 int sg_cfg_get_int(const char* key)
536 return (*simgrid_config)[key].get_value<int>();
539 /** @brief Retrieve a double value of a variable (get a warning if not uniq)
541 * @param key the name of the variable
543 * Returns the first value from the config set under the given name.
545 double sg_cfg_get_double(const char* key)
547 return (*simgrid_config)[key].get_value<double>();
550 /** @brief Retrieve a boolean value of a variable (get a warning if not uniq)
552 * @param key the name of the variable
554 * Returns the first value from the config set under the given name.
555 * If there is more than one value, it will issue a warning.
557 int sg_cfg_get_boolean(const char* key)
559 return (*simgrid_config)[key].get_value<bool>() ? 1 : 0;