1 /* Copyright (c) 2004-2019. 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 const char* true_values[] = {
42 "yes", "on", "true", "1"
44 const char* false_values[] = {
45 "no", "off", "false", "0"
48 static bool parse_bool(const char* value)
50 for (const char* const& true_value : true_values)
51 if (std::strcmp(true_value, value) == 0)
53 for (const char* const& false_value : false_values)
54 if (std::strcmp(false_value, value) == 0)
56 throw std::range_error("not a boolean");
59 static double parse_double(const char* value)
63 double res = std::strtod(value, &end);
65 throw std::range_error("out of range");
67 xbt_die("Unexpected errno");
68 if (end == value || *end != '\0')
69 throw std::range_error("invalid double");
74 static long int parse_long(const char* value)
78 long int res = std::strtol(value, &end, 0);
80 if (res == LONG_MIN && errno == ERANGE)
81 throw std::range_error("underflow");
82 else if (res == LONG_MAX && errno == ERANGE)
83 throw std::range_error("overflow");
84 xbt_die("Unexpected errno");
86 if (end == value || *end != '\0')
87 throw std::range_error("invalid integer");
92 // ***** ConfigType *****
94 /// A trait which define possible options types:
95 template <class T> class ConfigType;
97 template <> class ConfigType<int> {
99 static constexpr const char* type_name = "int";
100 static inline double parse(const char* value)
102 return parse_long(value);
105 template <> class ConfigType<double> {
107 static constexpr const char* type_name = "double";
108 static inline double parse(const char* value)
110 return parse_double(value);
113 template <> class ConfigType<std::string> {
115 static constexpr const char* type_name = "string";
116 static inline std::string parse(const char* value)
118 return std::string(value);
121 template <> class ConfigType<bool> {
123 static constexpr const char* type_name = "boolean";
124 static inline bool parse(const char* value)
126 return parse_bool(value);
130 // **** Forward declarations ****
132 class ConfigurationElement ;
133 template<class T> class TypedConfigurationElement;
135 // **** ConfigurationElement ****
137 class ConfigurationElement {
141 bool isdefault = true;
145 xbt_cfg_cb_t old_callback = nullptr;
147 ConfigurationElement(const std::string& key, const std::string& desc) : key(key), desc(desc) {}
148 ConfigurationElement(const std::string& key, const std::string& desc, xbt_cfg_cb_t cb)
149 : key(key), desc(desc), old_callback(cb)
153 virtual ~ConfigurationElement() = default;
155 virtual std::string get_string_value() = 0;
156 virtual void set_string_value(const char* value) = 0;
157 virtual const char* get_type_name() = 0;
159 template <class T> T const& get_value() const
161 return static_cast<const TypedConfigurationElement<T>&>(*this).get_value();
163 template <class T> void set_value(T value)
165 static_cast<TypedConfigurationElement<T>&>(*this).set_value(std::move(value));
167 template <class T> void set_default_value(T value)
169 static_cast<TypedConfigurationElement<T>&>(*this).set_default_value(std::move(value));
171 void unset_default() { isdefault = false; }
172 bool is_default() const { return isdefault; }
174 std::string const& get_description() const { return desc; }
175 std::string const& get_key() const { return key; }
178 // **** TypedConfigurationElement<T> ****
180 // TODO, could we use boost::any with some Type* reference?
182 class TypedConfigurationElement : public ConfigurationElement {
185 std::function<void(T&)> callback;
188 TypedConfigurationElement(const std::string& key, const std::string& desc, T value = T())
189 : ConfigurationElement(key, desc), content(std::move(value))
191 TypedConfigurationElement(const std::string& key, const std::string& desc, T value, xbt_cfg_cb_t cb)
192 : ConfigurationElement(key, desc, cb), content(std::move(value))
194 TypedConfigurationElement(const std::string& key, const std::string& desc, T value, std::function<void(T&)> callback)
195 : ConfigurationElement(key, desc), content(std::move(value)), callback(std::move(callback))
197 ~TypedConfigurationElement() = default;
199 std::string get_string_value() override;
200 const char* get_type_name() override;
201 void set_string_value(const char* value) override;
206 this->old_callback(get_key().c_str());
208 this->callback(this->content);
211 T const& get_value() const { return content; }
213 void set_value(T value)
215 this->content = std::move(value);
217 this->unset_default();
220 void set_default_value(T value)
222 if (this->is_default()) {
223 this->content = std::move(value);
226 XBT_DEBUG("Do not override configuration variable '%s' with value '%s' because it was already set.",
227 get_key().c_str(), to_string(value).c_str());
232 template <class T> std::string TypedConfigurationElement<T>::get_string_value() // override
234 return to_string(content);
237 template <class T> void TypedConfigurationElement<T>::set_string_value(const char* value) // override
239 this->content = ConfigType<T>::parse(value);
240 this->unset_default();
244 template <class T> const char* TypedConfigurationElement<T>::get_type_name() // override
246 return ConfigType<T>::type_name;
249 } // end of anonymous namespace
255 // name -> ConfigElement:
256 std::map<std::string, std::unique_ptr<ConfigurationElement>> options;
257 // alias -> ConfigElement from options:
258 std::map<std::string, ConfigurationElement*> aliases;
259 bool warn_for_aliases = true;
265 Config(Config const&) = delete;
266 Config& operator=(Config const&) = delete;
268 ConfigurationElement& operator[](const std::string& name);
269 void alias(const std::string& realname, const std::string& aliasname);
271 template <class T, class... A> TypedConfigurationElement<T>* register_option(const std::string& name, A&&... a)
273 xbt_assert(options.find(name) == options.end(), "Refusing to register the config element '%s' twice.",
275 TypedConfigurationElement<T>* variable = new TypedConfigurationElement<T>(name, std::forward<A>(a)...);
276 XBT_DEBUG("Register cfg elm %s (%s) of type %s @%p in set %p)", name.c_str(), variable->get_description().c_str(),
277 variable->get_type_name(), variable, this);
278 options[name].reset(variable);
284 void dump(const char *name, const char *indent);
289 ConfigurationElement* get_dict_element(const std::string& name);
294 atexit(&sg_config_finalize);
297 inline ConfigurationElement* Config::get_dict_element(const std::string& name)
299 auto opt = options.find(name);
300 if (opt != options.end()) {
301 return opt->second.get();
303 auto als = aliases.find(name);
304 if (als != aliases.end()) {
305 ConfigurationElement* res = als->second;
306 if (warn_for_aliases)
307 XBT_INFO("Option %s has been renamed to %s. Consider switching.", name.c_str(), res->get_key().c_str());
310 std::string msg = "Bad config key: " + name + "\nExisting config keys:\n";
311 for (auto const& elm : options)
312 msg += " " + elm.first + ": (" + elm.second->get_type_name() + ")" + elm.second->get_string_value() + "\n";
313 throw std::out_of_range(msg);
318 inline ConfigurationElement& Config::operator[](const std::string& name)
320 return *(get_dict_element(name));
323 void Config::alias(const std::string& realname, const std::string& aliasname)
325 xbt_assert(aliases.find(aliasname) == aliases.end(), "Alias '%s' already.", aliasname.c_str());
326 ConfigurationElement* element = this->get_dict_element(realname);
327 xbt_assert(element, "Cannot define an alias to the non-existing option '%s'.", realname.c_str());
328 this->aliases.insert({aliasname, element});
331 /** @brief Dump a config set for debuging purpose
333 * @param name The name to give to this config set
334 * @param indent what to write at the beginning of each line (right number of spaces)
336 void Config::dump(const char *name, const char *indent)
338 XBT_LOG_DEFAULT_CATEGORY(xbt_help);
340 XBT_VERB("%s>> Dumping of the config set '%s':", indent, name);
342 for (auto const& elm : options)
343 XBT_VERB("%s %s: ()%s) %s", indent, elm.first.c_str(), elm.second->get_type_name(),
344 elm.second->get_string_value().c_str());
347 XBT_VERB("%s<< End of the config set '%s'", indent, name);
350 /** @brief Displays the declared aliases and their replacement */
351 void Config::show_aliases()
353 for (auto const& elm : aliases)
354 XBT_HELP(" %-40s %s", elm.first.c_str(), elm.second->get_key().c_str());
357 /** @brief Displays the declared options and their description */
360 for (auto const& elm : options) {
361 simgrid::config::ConfigurationElement* variable = elm.second.get();
362 XBT_HELP(" %s: %s", elm.first.c_str(), variable->get_description().c_str());
363 XBT_HELP(" Type: %s; Current value: %s", variable->get_type_name(), variable->get_string_value().c_str());
367 // ***** set_default *****
369 template <class T> XBT_PUBLIC void set_default(const char* name, T value)
371 (*simgrid_config)[name].set_default_value<T>(std::move(value));
374 template XBT_PUBLIC void set_default<int>(const char* name, int value);
375 template XBT_PUBLIC void set_default<double>(const char* name, double value);
376 template XBT_PUBLIC void set_default<bool>(const char* name, bool value);
377 template XBT_PUBLIC void set_default<std::string>(const char* name, std::string value);
379 bool is_default(const char* name)
381 return (*simgrid_config)[name].is_default();
384 // ***** set_value *****
386 template <class T> XBT_PUBLIC void set_value(const char* name, T value)
388 (*simgrid_config)[name].set_value<T>(std::move(value));
391 template XBT_PUBLIC void set_value<int>(const char* name, int value);
392 template XBT_PUBLIC void set_value<double>(const char* name, double value);
393 template XBT_PUBLIC void set_value<bool>(const char* name, bool value);
394 template XBT_PUBLIC void set_value<std::string>(const char* name, std::string value);
396 void set_as_string(const char* name, const std::string& value)
398 (*simgrid_config)[name].set_string_value(value.c_str());
401 void set_parse(const std::string& opt)
403 std::string options(opt);
404 XBT_DEBUG("List to parse and set:'%s'", options.c_str());
405 while (not options.empty()) {
406 XBT_DEBUG("Still to parse and set: '%s'", options.c_str());
409 size_t pos = options.find_first_not_of(" \t\n,");
410 options.erase(0, pos);
412 pos = options.find_first_of(" \t\n,");
413 std::string name = options.substr(0, pos);
414 options.erase(0, pos);
415 XBT_DEBUG("parse now:'%s'; parse later:'%s'", name.c_str(), options.c_str());
420 pos = name.find(':');
421 xbt_assert(pos != std::string::npos, "Option '%s' badly formatted. Should be of the form 'name:value'",
424 std::string val = name.substr(pos + 1);
427 const std::string path("path");
428 if (name.compare(0, path.length(), path) != 0)
429 XBT_INFO("Configuration change: Set '%s' to '%s'", name.c_str(), val.c_str());
431 set_as_string(name.c_str(), val);
435 // ***** get_value *****
437 template <class T> XBT_PUBLIC T const& get_value(const std::string& name)
439 return (*simgrid_config)[name].get_value<T>();
442 template XBT_PUBLIC int const& get_value<int>(const std::string& name);
443 template XBT_PUBLIC double const& get_value<double>(const std::string& name);
444 template XBT_PUBLIC bool const& get_value<bool>(const std::string& name);
445 template XBT_PUBLIC std::string const& get_value<std::string>(const std::string& name);
449 void alias(const char* realname, std::initializer_list<const char*> aliases)
451 for (auto const& aliasname : aliases)
452 simgrid_config->alias(realname, aliasname);
455 // ***** declare_flag *****
458 XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, T value,
459 std::function<void(const T&)> callback)
461 if (simgrid_config == nullptr)
462 simgrid_config = new simgrid::config::Config();
463 simgrid_config->register_option<T>(name, description, std::move(value), std::move(callback));
466 template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, int value,
467 std::function<void(int const&)> callback);
468 template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, double value,
469 std::function<void(double const&)> callback);
470 template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, bool value,
471 std::function<void(bool const&)> callback);
472 template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, std::string value,
473 std::function<void(std::string const&)> callback);
477 delete simgrid_config;
478 simgrid_config = nullptr;
483 simgrid_config->show_aliases();
488 simgrid_config->help();
493 /*----[ Setting ]---------------------------------------------------------*/
495 /** @brief Set an integer value to \a name within \a cfg
497 * @param key the name of the variable
498 * @param value the value of the variable
500 void xbt_cfg_set_int(const char *key, int value)
502 sg_cfg_set_int(key, value);
505 void sg_cfg_set_int(const char* key, int value)
507 (*simgrid_config)[key].set_value<int>(value);
510 /** @brief Set or add a double value to \a name within \a cfg
512 * @param key the name of the variable
513 * @param value the double to set
515 void xbt_cfg_set_double(const char *key, double value)
517 sg_cfg_set_double(key, value);
520 void sg_cfg_set_double(const char* key, double value)
522 (*simgrid_config)[key].set_value<double>(value);
525 /** @brief Set or add a string value to \a name within \a cfg
527 * @param key the name of the variable
528 * @param value the value to be added
531 void xbt_cfg_set_string(const char* key, const char* value)
533 sg_cfg_set_string(key, value);
536 void sg_cfg_set_string(const char* key, const char* value)
538 (*simgrid_config)[key].set_value<std::string>(value);
541 /** @brief Set or add a boolean value to \a name within \a cfg
543 * @param key the name of the variable
544 * @param value the value of the variable
546 void xbt_cfg_set_boolean(const char *key, const char *value)
548 sg_cfg_set_boolean(key, value);
551 void sg_cfg_set_boolean(const char* key, const char* value)
553 (*simgrid_config)[key].set_value<bool>(simgrid::config::parse_bool(value));
556 /*----[ Getting ]---------------------------------------------------------*/
557 /** @brief Retrieve an integer value of a variable (get a warning if not uniq)
559 * @param key the name of the variable
561 * Returns the first value from the config set under the given name.
563 int xbt_cfg_get_int(const char *key)
565 return sg_cfg_get_int(key);
568 int sg_cfg_get_int(const char* key)
570 return (*simgrid_config)[key].get_value<int>();
573 /** @brief Retrieve a double value of a variable (get a warning if not uniq)
575 * @param key the name of the variable
577 * Returns the first value from the config set under the given name.
579 double xbt_cfg_get_double(const char *key)
581 return sg_cfg_get_double(key);
584 double sg_cfg_get_double(const char* key)
586 return (*simgrid_config)[key].get_value<double>();
589 /** @brief Retrieve a boolean value of a variable (get a warning if not uniq)
591 * @param key the name of the variable
593 * Returns the first value from the config set under the given name.
594 * If there is more than one value, it will issue a warning.
596 int xbt_cfg_get_boolean(const char *key)
598 return sg_cfg_get_boolean(key);
601 int sg_cfg_get_boolean(const char* key)
603 return (*simgrid_config)[key].get_value<bool>() ? 1 : 0;