1 /* Copyright (c) 2004-2023. 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. */
6 #include "simgrid/Exception.hpp"
7 #include "src/simgrid/sg_config.hpp"
11 #include "xbt/sysdep.h"
12 #include <xbt/config.h>
13 #include <xbt/config.hpp>
30 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_cfg, xbt, "configuration support");
32 xbt_cfg_t simgrid_config = nullptr;
34 namespace simgrid::config {
38 bool parse_bool(const char* value)
40 for (const char* true_value : {"yes", "on", "true", "1"})
41 if (std::strcmp(true_value, value) == 0)
43 for (const char* false_value : {"no", "off", "false", "0"})
44 if (std::strcmp(false_value, value) == 0)
46 throw std::range_error("not a boolean");
49 double parse_double(const char* value)
53 double res = std::strtod(value, &end);
55 throw std::range_error("out of range");
56 xbt_assert(errno == 0, "Unexpected errno: %d", errno);
57 if (end == value || *end != '\0')
58 throw std::range_error("invalid double");
62 long int parse_long(const char* value)
66 long int res = std::strtol(value, &end, 0);
68 throw std::range_error(res == LONG_MIN ? "underflow" : "overflow");
69 xbt_assert(errno == 0, "Unexpected errno: %d", errno);
70 if (end == value || *end != '\0')
71 throw std::range_error("invalid integer");
75 // ***** ConfigType *****
77 /// A trait which define possible options types:
78 template <class T> class ConfigType;
80 template <> class ConfigType<int> {
82 static constexpr const char* type_name = "int";
83 static inline int parse(const char* value)
85 long val = parse_long(value);
87 throw std::range_error("underflow");
89 throw std::range_error("overflow");
90 return static_cast<int>(val);
93 template <> class ConfigType<double> {
95 static constexpr const char* type_name = "double";
96 static inline double parse(const char* value)
98 return parse_double(value);
101 template <> class ConfigType<std::string> {
103 static constexpr const char* type_name = "string";
104 static inline std::string parse(const char* value) { return value; }
106 template <> class ConfigType<bool> {
108 static constexpr const char* type_name = "boolean";
109 static inline bool parse(const char* value)
111 return parse_bool(value);
115 // **** Forward declarations ****
117 class ConfigurationElement ;
118 template<class T> class TypedConfigurationElement;
120 // **** ConfigurationElement ****
122 class ConfigurationElement {
126 bool isdefault = true;
129 ConfigurationElement(const std::string& key, const std::string& desc) : key(key), desc(desc) {}
131 virtual ~ConfigurationElement() = default;
133 virtual std::string get_string_value() = 0;
134 virtual void set_string_value(const char* value) = 0;
135 virtual const char* get_type_name() = 0;
137 template <class T> T const& get_value() const
139 return static_cast<const TypedConfigurationElement<T>&>(*this).get_value();
141 template <class T> void set_value(T value)
143 static_cast<TypedConfigurationElement<T>&>(*this).set_value(std::move(value));
145 template <class T> void set_default_value(T value)
147 static_cast<TypedConfigurationElement<T>&>(*this).set_default_value(std::move(value));
149 void unset_default() { isdefault = false; }
150 bool is_default() const { return isdefault; }
152 std::string const& get_description() const { return desc; }
153 std::string const& get_key() const { return key; }
156 // **** TypedConfigurationElement<T> ****
158 // TODO, could we use boost::any with some Type* reference?
160 class TypedConfigurationElement : public ConfigurationElement {
163 std::function<void(T&)> callback;
166 TypedConfigurationElement(const std::string& key, const std::string& desc, T value = T())
167 : ConfigurationElement(key, desc), content(std::move(value))
169 TypedConfigurationElement(const std::string& key, const std::string& desc, T value, std::function<void(T&)> callback)
170 : ConfigurationElement(key, desc), content(std::move(value)), callback(std::move(callback))
173 std::string get_string_value() override;
174 const char* get_type_name() override;
175 void set_string_value(const char* value) override;
180 this->callback(this->content);
183 T const& get_value() const { return content; }
185 void set_value(T value)
187 this->content = std::move(value);
189 this->unset_default();
192 void set_default_value(T value)
194 if (this->is_default()) {
195 this->content = std::move(value);
198 XBT_DEBUG("Do not override configuration variable '%s' with value '%s' because it was already set.",
199 get_key().c_str(), get_string_value().c_str());
204 template <class T> std::string TypedConfigurationElement<T>::get_string_value() // override
206 return to_string(content);
209 template <> std::string TypedConfigurationElement<double>::get_string_value() // override
211 // don't want std::to_string which uses %f, and formats very small values as 0.000000
212 return xbt::string_printf("%g", content);
215 template <class T> void TypedConfigurationElement<T>::set_string_value(const char* value) // override
217 this->content = ConfigType<T>::parse(value);
218 this->unset_default();
222 template <class T> const char* TypedConfigurationElement<T>::get_type_name() // override
224 return ConfigType<T>::type_name;
227 } // end of anonymous namespace
233 // name -> ConfigElement:
234 std::map<std::string, std::unique_ptr<ConfigurationElement>, std::less<>> options;
235 // alias -> ConfigElement from options:
236 std::map<std::string, ConfigurationElement*, std::less<>> aliases;
237 bool warn_for_aliases = true;
243 Config(Config const&) = delete;
244 Config& operator=(Config const&) = delete;
246 ConfigurationElement& operator[](const std::string& name);
247 void alias(const std::string& realname, const std::string& aliasname);
249 template <class T, class... A> TypedConfigurationElement<T>* register_option(const std::string& name, A&&... a)
251 xbt_assert(options.find(name) == options.end(), "Refusing to register the config element '%s' twice.",
253 auto* variable = new TypedConfigurationElement<T>(name, std::forward<A>(a)...);
254 XBT_DEBUG("Register cfg elm %s (%s) of type %s @%p in set %p)", name.c_str(), variable->get_description().c_str(),
255 variable->get_type_name(), variable, this);
256 options[name].reset(variable);
261 void show_aliases() const;
265 ConfigurationElement* get_dict_element(const std::string& name);
270 atexit(&sg_config_finalize);
273 inline ConfigurationElement* Config::get_dict_element(const std::string& name)
275 if (auto opt = options.find(name); opt != options.end())
276 return opt->second.get();
278 if (auto als = aliases.find(name); als != aliases.end()) {
279 ConfigurationElement* res = als->second;
280 if (warn_for_aliases)
281 XBT_INFO("Option %s has been renamed to %s. Consider switching.", name.c_str(), res->get_key().c_str());
285 std::string msg = "Bad config key: " + name + "\n";
286 std::string kebab = name;
287 std::replace(begin(kebab), end(kebab), '_', '-'); // convert from snake_case to kebab-case
288 if (options.count(kebab) > 0)
289 msg += "Did you mean '" + kebab + "'?\n";
290 msg += "Existing config keys:\n";
291 for (auto const& [opt_name, opt] : options)
292 msg += " " + opt_name + ": (" + opt->get_type_name() + ")" + opt->get_string_value() + "\n";
293 throw std::out_of_range(msg);
296 inline ConfigurationElement& Config::operator[](const std::string& name)
298 return *(get_dict_element(name));
301 void Config::alias(const std::string& realname, const std::string& aliasname)
303 xbt_assert(aliases.find(aliasname) == aliases.end(), "Alias '%s' already.", aliasname.c_str());
304 ConfigurationElement* element = this->get_dict_element(realname);
305 xbt_assert(element, "Cannot define an alias to the non-existing option '%s'.", realname.c_str());
306 this->aliases.try_emplace(aliasname, element);
309 /** @brief Displays the declared aliases and their replacement */
310 void Config::show_aliases() const
312 for (auto const& [name, alias] : aliases)
313 XBT_HELP(" %-40s %s", name.c_str(), alias->get_key().c_str());
316 /** @brief Displays the declared options and their description */
317 void Config::help() const
319 for (auto const& [name, opt] : options) {
320 XBT_HELP(" %s: %s", name.c_str(), opt->get_description().c_str());
321 XBT_HELP(" Type: %s; Current value: %s", opt->get_type_name(), opt->get_string_value().c_str());
325 // ***** set_default *****
327 template <class T> XBT_PUBLIC void set_default(const char* name, T value)
329 (*simgrid_config)[name].set_default_value<T>(std::move(value));
332 template XBT_PUBLIC void set_default<int>(const char* name, int value);
333 template XBT_PUBLIC void set_default<double>(const char* name, double value);
334 template XBT_PUBLIC void set_default<bool>(const char* name, bool value);
335 template XBT_PUBLIC void set_default<std::string>(const char* name, std::string value);
337 bool is_default(const char* name)
339 return (*simgrid_config)[name].is_default();
342 // ***** set_value *****
344 template <class T> XBT_PUBLIC void set_value(const char* name, T value)
346 (*simgrid_config)[name].set_value<T>(std::move(value));
349 template XBT_PUBLIC void set_value<int>(const char* name, int value);
350 template XBT_PUBLIC void set_value<double>(const char* name, double value);
351 template XBT_PUBLIC void set_value<bool>(const char* name, bool value);
352 template XBT_PUBLIC void set_value<std::string>(const char* name, std::string value);
354 void set_as_string(const char* name, const std::string& value)
356 (*simgrid_config)[name].set_string_value(value.c_str());
359 void set_parse(const std::string& opt)
361 std::string options(opt);
362 XBT_DEBUG("List to parse and set:'%s'", options.c_str());
363 while (not options.empty()) {
364 XBT_DEBUG("Still to parse and set: '%s'", options.c_str());
367 size_t pos = options.find_first_not_of(" \t\n,");
368 options.erase(0, pos);
370 pos = options.find_first_of(" \t\n,");
371 std::string name = options.substr(0, pos);
372 options.erase(0, pos);
373 XBT_DEBUG("parse now:'%s'; parse later:'%s'", name.c_str(), options.c_str());
378 pos = name.find(':');
379 xbt_assert(pos != std::string::npos, "Option '%s' badly formatted. Should be of the form 'name:value'",
382 std::string val = name.substr(pos + 1);
385 if (name.rfind("path", 0) != 0)
386 XBT_INFO("Configuration change: Set '%s' to '%s'", name.c_str(), val.c_str());
388 set_as_string(name.c_str(), val);
392 // ***** get_value *****
394 template <class T> XBT_PUBLIC T const& get_value(const std::string& name)
396 return (*simgrid_config)[name].get_value<T>();
399 template XBT_PUBLIC int const& get_value<int>(const std::string& name);
400 template XBT_PUBLIC double const& get_value<double>(const std::string& name);
401 template XBT_PUBLIC bool const& get_value<bool>(const std::string& name);
402 template XBT_PUBLIC std::string const& get_value<std::string>(const std::string& name);
406 void alias(const char* realname, std::initializer_list<const char*> aliases)
408 for (auto const& aliasname : aliases)
409 simgrid_config->alias(realname, aliasname);
412 // ***** declare_flag *****
415 XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, T value,
416 std::function<void(const T&)> callback)
418 if (simgrid_config == nullptr)
419 simgrid_config = new simgrid::config::Config();
420 simgrid_config->register_option<T>(name, description, std::move(value), std::move(callback));
423 template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, int value,
424 std::function<void(int const&)> callback);
425 template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, double value,
426 std::function<void(double const&)> callback);
427 template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, bool value,
428 std::function<void(bool const&)> callback);
429 template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, std::string value,
430 std::function<void(std::string const&)> callback);
434 delete simgrid_config;
435 simgrid_config = nullptr;
440 simgrid_config->show_aliases();
445 simgrid_config->help();
447 } // namespace simgrid::config
449 /*----[ Setting ]---------------------------------------------------------*/
451 /** @brief Set an integer value to \a name within \a cfg
453 * @param key the name of the variable
454 * @param value the value of the variable
456 void sg_cfg_set_int(const char* key, int value)
458 (*simgrid_config)[key].set_value<int>(value);
461 /** @brief Set or add a double value to \a name within \a cfg
463 * @param key the name of the variable
464 * @param value the double to set
466 void sg_cfg_set_double(const char* key, double value)
468 (*simgrid_config)[key].set_value<double>(value);
471 /** @brief Set or add a string value to \a name within \a cfg
473 * @param key the name of the variable
474 * @param value the value to be added
477 void sg_cfg_set_string(const char* key, const char* value)
479 (*simgrid_config)[key].set_value<std::string>(value);
482 /** @brief Set or add a boolean value to \a name within \a cfg
484 * @param key the name of the variable
485 * @param value the value of the variable
487 void sg_cfg_set_boolean(const char* key, const char* value)
489 (*simgrid_config)[key].set_value<bool>(simgrid::config::parse_bool(value));
492 /*----[ Getting ]---------------------------------------------------------*/
493 /** @brief Retrieve an integer value of a variable (get a warning if not uniq)
495 * @param key the name of the variable
497 * Returns the first value from the config set under the given name.
499 int sg_cfg_get_int(const char* key)
501 return (*simgrid_config)[key].get_value<int>();
504 /** @brief Retrieve a double value of a variable (get a warning if not uniq)
506 * @param key the name of the variable
508 * Returns the first value from the config set under the given name.
510 double sg_cfg_get_double(const char* key)
512 return (*simgrid_config)[key].get_value<double>();
515 /** @brief Retrieve a boolean value of a variable (get a warning if not uniq)
517 * @param key the name of the variable
519 * Returns the first value from the config set under the given name.
520 * If there is more than one value, it will issue a warning.
522 int sg_cfg_get_boolean(const char* key)
524 return (*simgrid_config)[key].get_value<bool>() ? 1 : 0;