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 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 int parse(const char* value)
102 long val = parse_long(value);
104 throw std::range_error("underflow");
106 throw std::range_error("overflow");
107 return static_cast<int>(val);
110 template <> class ConfigType<double> {
112 static constexpr const char* type_name = "double";
113 static inline double parse(const char* value)
115 return parse_double(value);
118 template <> class ConfigType<std::string> {
120 static constexpr const char* type_name = "string";
121 static inline std::string parse(const char* value)
123 return std::string(value);
126 template <> class ConfigType<bool> {
128 static constexpr const char* type_name = "boolean";
129 static inline bool parse(const char* value)
131 return parse_bool(value);
135 // **** Forward declarations ****
137 class ConfigurationElement ;
138 template<class T> class TypedConfigurationElement;
140 // **** ConfigurationElement ****
142 class ConfigurationElement {
146 bool isdefault = true;
149 ConfigurationElement(const std::string& key, const std::string& desc) : key(key), desc(desc) {}
151 virtual ~ConfigurationElement() = default;
153 virtual std::string get_string_value() = 0;
154 virtual void set_string_value(const char* value) = 0;
155 virtual const char* get_type_name() = 0;
157 template <class T> T const& get_value() const
159 return static_cast<const TypedConfigurationElement<T>&>(*this).get_value();
161 template <class T> void set_value(T value)
163 static_cast<TypedConfigurationElement<T>&>(*this).set_value(std::move(value));
165 template <class T> void set_default_value(T value)
167 static_cast<TypedConfigurationElement<T>&>(*this).set_default_value(std::move(value));
169 void unset_default() { isdefault = false; }
170 bool is_default() const { return isdefault; }
172 std::string const& get_description() const { return desc; }
173 std::string const& get_key() const { return key; }
176 // **** TypedConfigurationElement<T> ****
178 // TODO, could we use boost::any with some Type* reference?
180 class TypedConfigurationElement : public ConfigurationElement {
183 std::function<void(T&)> callback;
186 TypedConfigurationElement(const std::string& key, const std::string& desc, T value = T())
187 : ConfigurationElement(key, desc), content(std::move(value))
189 TypedConfigurationElement(const std::string& key, const std::string& desc, T value, std::function<void(T&)> callback)
190 : ConfigurationElement(key, desc), content(std::move(value)), callback(std::move(callback))
192 ~TypedConfigurationElement() = default;
194 std::string get_string_value() override;
195 const char* get_type_name() override;
196 void set_string_value(const char* value) override;
201 this->callback(this->content);
204 T const& get_value() const { return content; }
206 void set_value(T value)
208 this->content = std::move(value);
210 this->unset_default();
213 void set_default_value(T value)
215 if (this->is_default()) {
216 this->content = std::move(value);
219 XBT_DEBUG("Do not override configuration variable '%s' with value '%s' because it was already set.",
220 get_key().c_str(), to_string(value).c_str());
225 template <class T> std::string TypedConfigurationElement<T>::get_string_value() // override
227 return to_string(content);
230 template <class T> void TypedConfigurationElement<T>::set_string_value(const char* value) // override
232 this->content = ConfigType<T>::parse(value);
233 this->unset_default();
237 template <class T> const char* TypedConfigurationElement<T>::get_type_name() // override
239 return ConfigType<T>::type_name;
242 } // end of anonymous namespace
248 // name -> ConfigElement:
249 std::map<std::string, std::unique_ptr<ConfigurationElement>> options;
250 // alias -> ConfigElement from options:
251 std::map<std::string, ConfigurationElement*> aliases;
252 bool warn_for_aliases = true;
258 Config(Config const&) = delete;
259 Config& operator=(Config const&) = delete;
261 ConfigurationElement& operator[](const std::string& name);
262 void alias(const std::string& realname, const std::string& aliasname);
264 template <class T, class... A> TypedConfigurationElement<T>* register_option(const std::string& name, A&&... a)
266 xbt_assert(options.find(name) == options.end(), "Refusing to register the config element '%s' twice.",
268 auto* variable = new TypedConfigurationElement<T>(name, std::forward<A>(a)...);
269 XBT_DEBUG("Register cfg elm %s (%s) of type %s @%p in set %p)", name.c_str(), variable->get_description().c_str(),
270 variable->get_type_name(), variable, this);
271 options[name].reset(variable);
277 void dump(const char* name, const char* indent) const;
278 void show_aliases() const;
282 ConfigurationElement* get_dict_element(const std::string& name);
287 atexit(&sg_config_finalize);
290 inline ConfigurationElement* Config::get_dict_element(const std::string& name)
292 auto opt = options.find(name);
293 if (opt != options.end()) {
294 return opt->second.get();
296 auto als = aliases.find(name);
297 if (als != aliases.end()) {
298 ConfigurationElement* res = als->second;
299 if (warn_for_aliases)
300 XBT_INFO("Option %s has been renamed to %s. Consider switching.", name.c_str(), res->get_key().c_str());
303 std::string msg = "Bad config key: " + name + "\nExisting config keys:\n";
304 for (auto const& elm : options)
305 msg += " " + elm.first + ": (" + elm.second->get_type_name() + ")" + elm.second->get_string_value() + "\n";
306 throw std::out_of_range(msg);
311 inline ConfigurationElement& Config::operator[](const std::string& name)
313 return *(get_dict_element(name));
316 void Config::alias(const std::string& realname, const std::string& aliasname)
318 xbt_assert(aliases.find(aliasname) == aliases.end(), "Alias '%s' already.", aliasname.c_str());
319 ConfigurationElement* element = this->get_dict_element(realname);
320 xbt_assert(element, "Cannot define an alias to the non-existing option '%s'.", realname.c_str());
321 this->aliases.insert({aliasname, element});
324 /** @brief Dump a config set for debugging purpose
326 * @param name The name to give to this config set
327 * @param indent what to write at the beginning of each line (right number of spaces)
329 void Config::dump(const char* name, const char* indent) const
332 XBT_CVERB(xbt_help, "%s>> Dumping of the config set '%s':", indent, name);
334 for (auto const& elm : options)
335 XBT_CVERB(xbt_help, "%s %s: ()%s) %s", indent, elm.first.c_str(), elm.second->get_type_name(),
336 elm.second->get_string_value().c_str());
339 XBT_CVERB(xbt_help, "%s<< End of the config set '%s'", indent, name);
342 /** @brief Displays the declared aliases and their replacement */
343 void Config::show_aliases() const
345 for (auto const& elm : aliases)
346 XBT_HELP(" %-40s %s", elm.first.c_str(), elm.second->get_key().c_str());
349 /** @brief Displays the declared options and their description */
350 void Config::help() const
352 for (auto const& elm : options) {
353 simgrid::config::ConfigurationElement* variable = elm.second.get();
354 XBT_HELP(" %s: %s", elm.first.c_str(), variable->get_description().c_str());
355 XBT_HELP(" Type: %s; Current value: %s", variable->get_type_name(), variable->get_string_value().c_str());
359 // ***** set_default *****
361 template <class T> XBT_PUBLIC void set_default(const char* name, T value)
363 (*simgrid_config)[name].set_default_value<T>(std::move(value));
366 template XBT_PUBLIC void set_default<int>(const char* name, int value);
367 template XBT_PUBLIC void set_default<double>(const char* name, double value);
368 template XBT_PUBLIC void set_default<bool>(const char* name, bool value);
369 template XBT_PUBLIC void set_default<std::string>(const char* name, std::string value);
371 bool is_default(const char* name)
373 return (*simgrid_config)[name].is_default();
376 // ***** set_value *****
378 template <class T> XBT_PUBLIC void set_value(const char* name, T value)
380 (*simgrid_config)[name].set_value<T>(std::move(value));
383 template XBT_PUBLIC void set_value<int>(const char* name, int value);
384 template XBT_PUBLIC void set_value<double>(const char* name, double value);
385 template XBT_PUBLIC void set_value<bool>(const char* name, bool value);
386 template XBT_PUBLIC void set_value<std::string>(const char* name, std::string value);
388 void set_as_string(const char* name, const std::string& value)
390 (*simgrid_config)[name].set_string_value(value.c_str());
393 void set_parse(const std::string& opt)
395 std::string options(opt);
396 XBT_DEBUG("List to parse and set:'%s'", options.c_str());
397 while (not options.empty()) {
398 XBT_DEBUG("Still to parse and set: '%s'", options.c_str());
401 size_t pos = options.find_first_not_of(" \t\n,");
402 options.erase(0, pos);
404 pos = options.find_first_of(" \t\n,");
405 std::string name = options.substr(0, pos);
406 options.erase(0, pos);
407 XBT_DEBUG("parse now:'%s'; parse later:'%s'", name.c_str(), options.c_str());
412 pos = name.find(':');
413 xbt_assert(pos != std::string::npos, "Option '%s' badly formatted. Should be of the form 'name:value'",
416 std::string val = name.substr(pos + 1);
419 const std::string path("path");
420 if (name.compare(0, path.length(), path) != 0)
421 XBT_INFO("Configuration change: Set '%s' to '%s'", name.c_str(), val.c_str());
423 set_as_string(name.c_str(), val);
427 // ***** get_value *****
429 template <class T> XBT_PUBLIC T const& get_value(const std::string& name)
431 return (*simgrid_config)[name].get_value<T>();
434 template XBT_PUBLIC int const& get_value<int>(const std::string& name);
435 template XBT_PUBLIC double const& get_value<double>(const std::string& name);
436 template XBT_PUBLIC bool const& get_value<bool>(const std::string& name);
437 template XBT_PUBLIC std::string const& get_value<std::string>(const std::string& name);
441 void alias(const char* realname, std::initializer_list<const char*> aliases)
443 for (auto const& aliasname : aliases)
444 simgrid_config->alias(realname, aliasname);
447 // ***** declare_flag *****
450 XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, T value,
451 std::function<void(const T&)> callback)
453 if (simgrid_config == nullptr)
454 simgrid_config = new simgrid::config::Config();
455 simgrid_config->register_option<T>(name, description, std::move(value), std::move(callback));
458 template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, int value,
459 std::function<void(int const&)> callback);
460 template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, double value,
461 std::function<void(double const&)> callback);
462 template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, bool value,
463 std::function<void(bool const&)> callback);
464 template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, std::string value,
465 std::function<void(std::string const&)> callback);
469 delete simgrid_config;
470 simgrid_config = nullptr;
475 simgrid_config->show_aliases();
480 simgrid_config->help();
485 /*----[ Setting ]---------------------------------------------------------*/
487 /** @brief Set an integer value to \a name within \a cfg
489 * @param key the name of the variable
490 * @param value the value of the variable
492 void sg_cfg_set_int(const char* key, int value)
494 (*simgrid_config)[key].set_value<int>(value);
497 /** @brief Set or add a double value to \a name within \a cfg
499 * @param key the name of the variable
500 * @param value the double to set
502 void sg_cfg_set_double(const char* key, double value)
504 (*simgrid_config)[key].set_value<double>(value);
507 /** @brief Set or add a string value to \a name within \a cfg
509 * @param key the name of the variable
510 * @param value the value to be added
513 void sg_cfg_set_string(const char* key, const char* value)
515 (*simgrid_config)[key].set_value<std::string>(value);
518 /** @brief Set or add a boolean value to \a name within \a cfg
520 * @param key the name of the variable
521 * @param value the value of the variable
523 void sg_cfg_set_boolean(const char* key, const char* value)
525 (*simgrid_config)[key].set_value<bool>(simgrid::config::parse_bool(value));
528 /*----[ Getting ]---------------------------------------------------------*/
529 /** @brief Retrieve an integer value of a variable (get a warning if not uniq)
531 * @param key the name of the variable
533 * Returns the first value from the config set under the given name.
535 int sg_cfg_get_int(const char* key)
537 return (*simgrid_config)[key].get_value<int>();
540 /** @brief Retrieve a double value of a variable (get a warning if not uniq)
542 * @param key the name of the variable
544 * Returns the first value from the config set under the given name.
546 double sg_cfg_get_double(const char* key)
548 return (*simgrid_config)[key].get_value<double>();
551 /** @brief Retrieve a boolean value of a variable (get a warning if not uniq)
553 * @param key the name of the variable
555 * Returns the first value from the config set under the given name.
556 * If there is more than one value, it will issue a warning.
558 int sg_cfg_get_boolean(const char* key)
560 return (*simgrid_config)[key].get_value<bool>() ? 1 : 0;