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. */
18 #include <type_traits>
22 #include "simgrid/Exception.hpp"
23 #include "simgrid/sg_config.hpp"
24 #include "xbt/dynar.h"
27 #include "xbt/sysdep.h"
28 #include <xbt/config.h>
29 #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;
40 const char* true_values[] = {
41 "yes", "on", "true", "1"
43 const char* false_values[] = {
44 "no", "off", "false", "0"
47 static bool parse_bool(const char* value)
49 for (const char* const& true_value : true_values)
50 if (std::strcmp(true_value, value) == 0)
52 for (const char* const& false_value : false_values)
53 if (std::strcmp(false_value, value) == 0)
55 throw std::range_error("not a boolean");
58 static double parse_double(const char* value)
62 double res = std::strtod(value, &end);
64 throw std::range_error("out of range");
66 xbt_die("Unexpected errno");
67 if (end == value || *end != '\0')
68 throw std::range_error("invalid double");
73 static long int parse_long(const char* value)
77 long int res = std::strtol(value, &end, 0);
79 if (res == LONG_MIN && errno == ERANGE)
80 throw std::range_error("underflow");
81 else if (res == LONG_MAX && errno == ERANGE)
82 throw std::range_error("overflow");
83 xbt_die("Unexpected errno");
85 if (end == value || *end != '\0')
86 throw std::range_error("invalid integer");
91 // ***** ConfigType *****
93 /// A trait which define possible options types:
94 template <class T> class ConfigType;
96 template <> class ConfigType<int> {
98 static constexpr const char* type_name = "int";
99 static inline double parse(const char* value)
101 return parse_long(value);
104 template <> class ConfigType<double> {
106 static constexpr const char* type_name = "double";
107 static inline double parse(const char* value)
109 return parse_double(value);
112 template <> class ConfigType<std::string> {
114 static constexpr const char* type_name = "string";
115 static inline std::string parse(const char* value)
117 return std::string(value);
120 template <> class ConfigType<bool> {
122 static constexpr const char* type_name = "boolean";
123 static inline bool parse(const char* value)
125 return parse_bool(value);
129 // **** Forward declarations ****
131 class ConfigurationElement ;
132 template<class T> class TypedConfigurationElement;
134 // **** ConfigurationElement ****
136 class ConfigurationElement {
140 bool isdefault = true;
144 xbt_cfg_cb_t old_callback = nullptr;
146 ConfigurationElement(std::string key, std::string desc) : key(key), desc(desc) {}
147 ConfigurationElement(std::string key, std::string desc, xbt_cfg_cb_t cb) : key(key), desc(desc), old_callback(cb) {}
149 virtual ~ConfigurationElement() = default;
151 virtual std::string get_string_value() = 0;
152 virtual void set_string_value(const char* value) = 0;
153 virtual const char* get_type_name() = 0;
155 template <class T> T const& get_value() const
157 return dynamic_cast<const TypedConfigurationElement<T>&>(*this).get_value();
159 template <class T> void set_value(T value)
161 dynamic_cast<TypedConfigurationElement<T>&>(*this).set_value(std::move(value));
163 template <class T> void set_default_value(T value)
165 dynamic_cast<TypedConfigurationElement<T>&>(*this).set_default_value(std::move(value));
167 void unset_default() { isdefault = false; }
168 bool is_default() const { return isdefault; }
170 std::string const& get_description() const { return desc; }
171 std::string const& get_key() const { return key; }
174 // **** TypedConfigurationElement<T> ****
176 // TODO, could we use boost::any with some Type* reference?
178 class TypedConfigurationElement : public ConfigurationElement {
181 std::function<void(T&)> callback;
184 TypedConfigurationElement(std::string key, std::string desc, T value = T())
185 : ConfigurationElement(key, desc), content(std::move(value))
187 TypedConfigurationElement(std::string key, std::string desc, T value, xbt_cfg_cb_t cb)
188 : ConfigurationElement(key, desc, cb), content(std::move(value))
190 TypedConfigurationElement(std::string key, std::string desc, T value, std::function<void(T&)> callback)
191 : ConfigurationElement(key, desc), content(std::move(value)), callback(std::move(callback))
193 ~TypedConfigurationElement() = default;
195 std::string get_string_value() override;
196 const char* get_type_name() override;
197 void set_string_value(const char* value) override;
202 this->old_callback(get_key().c_str());
204 this->callback(this->content);
207 T const& get_value() const { return content; }
209 void set_value(T value)
211 this->content = std::move(value);
213 this->unset_default();
216 void set_default_value(T value)
218 if (this->is_default()) {
219 this->content = std::move(value);
222 XBT_DEBUG("Do not override configuration variable '%s' with value '%s' because it was already set.",
223 get_key().c_str(), to_string(value).c_str());
228 template <class T> std::string TypedConfigurationElement<T>::get_string_value() // override
230 return to_string(content);
233 template <class T> void TypedConfigurationElement<T>::set_string_value(const char* value) // override
235 this->content = ConfigType<T>::parse(value);
236 this->unset_default();
240 template <class T> const char* TypedConfigurationElement<T>::get_type_name() // override
242 return ConfigType<T>::type_name;
245 } // end of anonymous namespace
251 // name -> ConfigElement:
252 std::map<std::string, simgrid::config::ConfigurationElement*> options;
253 // alias -> ConfigElement from options:
254 std::map<std::string, simgrid::config::ConfigurationElement*> aliases;
255 bool warn_for_aliases = true;
262 Config(Config const&) = delete;
263 Config& operator=(Config const&) = delete;
265 ConfigurationElement& operator[](std::string name);
266 void alias(std::string realname, std::string aliasname);
268 template <class T, class... A>
269 simgrid::config::TypedConfigurationElement<T>* register_option(const std::string& name, A&&... a)
271 xbt_assert(options.find(name) == options.end(), "Refusing to register the config element '%s' twice.",
273 TypedConfigurationElement<T>* variable = new TypedConfigurationElement<T>(name, std::forward<A>(a)...);
274 XBT_DEBUG("Register cfg elm %s (%s) of type %s @%p in set %p)", name.c_str(), variable->get_description().c_str(),
275 variable->get_type_name(), variable, this);
276 options.insert({name, variable});
282 void dump(const char *name, const char *indent);
287 ConfigurationElement* get_dict_element(std::string name);
292 atexit(&sg_config_finalize);
296 XBT_DEBUG("Frees cfg set %p", this);
297 for (auto const& elm : options)
301 inline ConfigurationElement* Config::get_dict_element(std::string name)
303 auto opt = options.find(name);
304 if (opt != options.end()) {
307 auto als = aliases.find(name);
308 if (als != aliases.end()) {
309 ConfigurationElement* res = als->second;
310 if (warn_for_aliases)
311 XBT_INFO("Option %s has been renamed to %s. Consider switching.", name.c_str(), res->get_key().c_str());
314 THROWF(not_found_error, 0, "Bad config key: %s", name.c_str());
319 inline ConfigurationElement& Config::operator[](std::string name)
321 return *(get_dict_element(name));
324 void Config::alias(std::string realname, std::string aliasname)
326 xbt_assert(aliases.find(aliasname) == aliases.end(), "Alias '%s' already.", aliasname.c_str());
327 ConfigurationElement* element = this->get_dict_element(realname);
328 xbt_assert(element, "Cannot define an alias to the non-existing option '%s'.", realname.c_str());
329 this->aliases.insert({aliasname, element});
332 /** @brief Dump a config set for debuging purpose
334 * @param name The name to give to this config set
335 * @param indent what to write at the beginning of each line (right number of spaces)
337 void Config::dump(const char *name, const char *indent)
340 printf("%s>> Dumping of the config set '%s':\n", indent, name);
342 for (auto const& elm : options)
343 printf("%s %s: ()%s) %s", indent, elm.first.c_str(), elm.second->get_type_name(),
344 elm.second->get_string_value().c_str());
347 printf("%s<< End of the config set '%s'\n", indent, name);
351 /** @brief Displays the declared aliases and their replacement */
352 void Config::show_aliases()
354 for (auto const& elm : aliases)
355 printf(" %-40s %s\n", elm.first.c_str(), elm.second->get_key().c_str());
358 /** @brief Displays the declared options and their description */
361 for (auto const& elm : options) {
362 simgrid::config::ConfigurationElement* variable = this->options.at(elm.first);
363 printf(" %s: %s\n", elm.first.c_str(), variable->get_description().c_str());
364 printf(" Type: %s; ", variable->get_type_name());
365 printf("Current value: %s\n", variable->get_string_value().c_str());
369 // ***** set_default *****
371 template <class T> XBT_PUBLIC void set_default(const char* name, T value)
373 (*simgrid_config)[name].set_default_value<T>(std::move(value));
376 template XBT_PUBLIC void set_default<int>(const char* name, int value);
377 template XBT_PUBLIC void set_default<double>(const char* name, double value);
378 template XBT_PUBLIC void set_default<bool>(const char* name, bool value);
379 template XBT_PUBLIC void set_default<std::string>(const char* name, std::string value);
381 bool is_default(const char* name)
383 return (*simgrid_config)[name].is_default();
386 // ***** set_value *****
388 template <class T> XBT_PUBLIC void set_value(const char* name, T value)
390 (*simgrid_config)[name].set_value<T>(std::move(value));
393 template XBT_PUBLIC void set_value<int>(const char* name, int value);
394 template XBT_PUBLIC void set_value<double>(const char* name, double value);
395 template XBT_PUBLIC void set_value<bool>(const char* name, bool value);
396 template XBT_PUBLIC void set_value<std::string>(const char* name, std::string value);
398 void set_as_string(const char* name, const std::string& value)
400 (*simgrid_config)[name].set_string_value(value.c_str());
403 void set_parse(std::string options)
405 XBT_DEBUG("List to parse and set:'%s'", options.c_str());
406 while (not options.empty()) {
407 XBT_DEBUG("Still to parse and set: '%s'", options.c_str());
410 size_t pos = options.find_first_not_of(" \t\n,");
411 options.erase(0, pos);
413 pos = options.find_first_of(" \t\n,");
414 std::string name = options.substr(0, pos);
415 options.erase(0, pos);
416 XBT_DEBUG("parse now:'%s'; parse later:'%s'", name.c_str(), options.c_str());
421 pos = name.find(':');
422 xbt_assert(pos != std::string::npos, "Option '%s' badly formatted. Should be of the form 'name:value'",
425 std::string val = name.substr(pos + 1);
428 const std::string path("path");
429 if (name.compare(0, path.length(), path) != 0)
430 XBT_INFO("Configuration change: Set '%s' to '%s'", name.c_str(), val.c_str());
432 set_as_string(name.c_str(), val);
436 // ***** get_value *****
438 template <class T> XBT_PUBLIC T const& get_value(const std::string& name)
440 return (*simgrid_config)[name].get_value<T>();
443 template XBT_PUBLIC int const& get_value<int>(const std::string& name);
444 template XBT_PUBLIC double const& get_value<double>(const std::string& name);
445 template XBT_PUBLIC bool const& get_value<bool>(const std::string& name);
446 template XBT_PUBLIC std::string const& get_value<std::string>(const std::string& name);
450 void alias(const char* realname, std::initializer_list<const char*> aliases)
452 for (auto const& aliasname : aliases)
453 simgrid_config->alias(realname, aliasname);
456 // ***** declare_flag *****
459 XBT_PUBLIC void declare_flag(const std::string& name, std::string description, T value,
460 std::function<void(const T&)> callback)
462 if (simgrid_config == nullptr)
463 simgrid_config = new simgrid::config::Config();
464 simgrid_config->register_option<T>(name, std::move(description), std::move(value), std::move(callback));
467 template XBT_PUBLIC void declare_flag(const std::string& name, std::string description, int value,
468 std::function<void(int const&)> callback);
469 template XBT_PUBLIC void declare_flag(const std::string& name, std::string description, double value,
470 std::function<void(double const&)> callback);
471 template XBT_PUBLIC void declare_flag(const std::string& name, std::string description, bool value,
472 std::function<void(bool const&)> callback);
473 template XBT_PUBLIC void declare_flag(const std::string& name, std::string description, std::string value,
474 std::function<void(std::string const&)> callback);
478 delete simgrid_config;
479 simgrid_config = nullptr;
484 simgrid_config->show_aliases();
489 simgrid_config->help();
494 // ***** C bindings *****
496 xbt_cfg_t xbt_cfg_new()
498 return new simgrid::config::Config();
500 void xbt_cfg_free(xbt_cfg_t * cfg) { delete *cfg; }
502 void xbt_cfg_dump(const char *name, const char *indent, xbt_cfg_t cfg)
504 cfg->dump(name, indent);
507 /*----[ Registering stuff ]-----------------------------------------------*/
509 void xbt_cfg_register_double(const char *name, double default_value,
510 xbt_cfg_cb_t cb_set, const char *desc)
512 if (simgrid_config == nullptr)
513 simgrid_config = new simgrid::config::Config();
514 simgrid_config->register_option<double>(name, desc, default_value, cb_set);
517 void xbt_cfg_register_int(const char *name, int default_value,xbt_cfg_cb_t cb_set, const char *desc)
519 if (simgrid_config == nullptr)
520 simgrid_config = new simgrid::config::Config();
521 simgrid_config->register_option<int>(name, desc, default_value, cb_set);
524 void xbt_cfg_register_string(const char *name, const char *default_value, xbt_cfg_cb_t cb_set, const char *desc)
526 if (simgrid_config == nullptr)
527 simgrid_config = new simgrid::config::Config();
528 simgrid_config->register_option<std::string>(name, desc, default_value ? default_value : "", cb_set);
531 void xbt_cfg_register_boolean(const char *name, const char*default_value,xbt_cfg_cb_t cb_set, const char *desc)
533 if (simgrid_config == nullptr)
534 simgrid_config = new simgrid::config::Config();
535 simgrid_config->register_option<bool>(name, desc, simgrid::config::parse_bool(default_value), cb_set);
538 void xbt_cfg_register_alias(const char *realname, const char *aliasname)
540 if (simgrid_config == nullptr)
541 simgrid_config = new simgrid::config::Config();
542 simgrid_config->alias(realname, aliasname);
545 void xbt_cfg_aliases()
547 simgrid_config->show_aliases();
551 simgrid_config->help();
554 /*----[ Setting ]---------------------------------------------------------*/
556 /** @brief Add values parsed from a string into a config set
558 * @param options a string containing the content to add to the config set. This is a '\\t',' ' or '\\n' or ','
559 * separated list of variables. Each individual variable is like "[name]:[value]" where [name] is the name of an
560 * already registered variable, and [value] conforms to the data type under which this variable was registered.
562 * @todo This is a crude manual parser, it should be a proper lexer.
564 void xbt_cfg_set_parse(const char *options)
566 if (options && strlen(options) > 0)
567 simgrid::config::set_parse(std::string(options));
570 /** @brief Set the value of a variable, using the string representation of that value
572 * @param key name of the variable to modify
573 * @param value string representation of the value to set
576 void xbt_cfg_set_as_string(const char *key, const char *value)
578 (*simgrid_config)[key].set_string_value(value);
581 /** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet
583 * This is useful to change the default value of a variable while allowing
584 * users to override it with command line arguments
586 void xbt_cfg_setdefault_int(const char *key, int value)
588 (*simgrid_config)[key].set_default_value<int>(value);
591 /** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet
593 * This is useful to change the default value of a variable while allowing
594 * users to override it with command line arguments
596 void xbt_cfg_setdefault_double(const char *key, double value)
598 (*simgrid_config)[key].set_default_value<double>(value);
601 /** @brief Set a string value to \a name within \a cfg if it wasn't changed yet
603 * This is useful to change the default value of a variable while allowing
604 * users to override it with command line arguments
606 void xbt_cfg_setdefault_string(const char *key, const char *value)
608 (*simgrid_config)[key].set_default_value<std::string>(value ? value : "");
611 /** @brief Set an boolean value to \a name within \a cfg if it wasn't changed yet
613 * This is useful to change the default value of a variable while allowing
614 * users to override it with command line arguments
616 void xbt_cfg_setdefault_boolean(const char *key, const char *value)
618 (*simgrid_config)[key].set_default_value<bool>(simgrid::config::parse_bool(value));
621 /** @brief Set an integer value to \a name within \a cfg
623 * @param key the name of the variable
624 * @param value the value of the variable
626 void xbt_cfg_set_int(const char *key, int value)
628 (*simgrid_config)[key].set_value<int>(value);
631 /** @brief Set or add a double value to \a name within \a cfg
633 * @param key the name of the variable
634 * @param value the double to set
636 void xbt_cfg_set_double(const char *key, double value)
638 (*simgrid_config)[key].set_value<double>(value);
641 /** @brief Set or add a string value to \a name within \a cfg
643 * @param key the name of the variable
644 * @param value the value to be added
647 void xbt_cfg_set_string(const char* key, const char* value)
649 (*simgrid_config)[key].set_value<std::string>(value);
652 /** @brief Set or add a boolean value to \a name within \a cfg
654 * @param key the name of the variable
655 * @param value the value of the variable
657 void xbt_cfg_set_boolean(const char *key, const char *value)
659 (*simgrid_config)[key].set_value<bool>(simgrid::config::parse_bool(value));
663 /* Say if the value is the default value */
664 int xbt_cfg_is_default_value(const char *key)
666 return (*simgrid_config)[key].is_default() ? 1 : 0;
669 /*----[ Getting ]---------------------------------------------------------*/
670 /** @brief Retrieve an integer value of a variable (get a warning if not uniq)
672 * @param key the name of the variable
674 * Returns the first value from the config set under the given name.
676 int xbt_cfg_get_int(const char *key)
678 return (*simgrid_config)[key].get_value<int>();
681 /** @brief Retrieve a double value of a variable (get a warning if not uniq)
683 * @param key the name of the variable
685 * Returns the first value from the config set under the given name.
687 double xbt_cfg_get_double(const char *key)
689 return (*simgrid_config)[key].get_value<double>();
692 /** @brief Retrieve a string value of a variable (get a warning if not uniq)
694 * @param key the name of the variable
696 * Returns the first value from the config set under the given name.
697 * If there is more than one value, it will issue a warning.
698 * Returns nullptr if there is no value.
700 * \warning the returned value is the actual content of the config set
702 std::string xbt_cfg_get_string(const char* key)
704 return (*simgrid_config)[key].get_value<std::string>();
707 /** @brief Retrieve a boolean value of a variable (get a warning if not uniq)
709 * @param key the name of the variable
711 * Returns the first value from the config set under the given name.
712 * If there is more than one value, it will issue a warning.
714 int xbt_cfg_get_boolean(const char *key)
716 return (*simgrid_config)[key].get_value<bool>() ? 1 : 0;