src/xbt/config.cpp

   1 /* Copyright (c) 2004-2022. The SimGrid Team. All rights reserved.     */
   2
   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. */
   5
   6 #include <cstdio>
   7
   8 #include <algorithm>
   9 #include <cerrno>
  10 #include <cstring>
  11 #include <climits>
  12
  13 #include <functional>
  14 #include <map>
  15 #include <memory>
  16 #include <stdexcept>
  17 #include <string>
  18 #include <string>
  19 #include <vector>
  20
  21 #include "simgrid/Exception.hpp"
  22 #include "simgrid/sg_config.hpp"
  23 #include "xbt/dynar.h"
  24 #include "xbt/log.h"
  25 #include "xbt/misc.h"
  26 #include "xbt/sysdep.h"
  27 #include <xbt/config.h>
  28 #include <xbt/config.hpp>
  29
  30 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_cfg, xbt, "configuration support");
  31
  32 XBT_EXPORT_NO_IMPORT xbt_cfg_t simgrid_config = nullptr;
  33
  34 namespace simgrid {
  35 namespace config {
  36
  37 namespace {
  38
  39 bool parse_bool(const char* value)
  40 {
  41   for (const char* true_value : {"yes", "on", "true", "1"})
  42     if (std::strcmp(true_value, value) == 0)
  43       return true;
  44   for (const char* false_value : {"no", "off", "false", "0"})
  45     if (std::strcmp(false_value, value) == 0)
  46       return false;
  47   throw std::range_error("not a boolean");
  48 }
  49
  50 double parse_double(const char* value)
  51 {
  52   char* end;
  53   errno = 0;
  54   double res = std::strtod(value, &end);
  55   if (errno == ERANGE)
  56     throw std::range_error("out of range");
  57   xbt_assert(errno == 0, "Unexpected errno: %d", errno);
  58   if (end == value || *end != '\0')
  59     throw std::range_error("invalid double");
  60   return res;
  61 }
  62
  63 long int parse_long(const char* value)
  64 {
  65   char* end;
  66   errno = 0;
  67   long int res = std::strtol(value, &end, 0);
  68   if (errno == ERANGE)
  69     throw std::range_error(res == LONG_MIN ? "underflow" : "overflow");
  70   xbt_assert(errno == 0, "Unexpected errno: %d", errno);
  71   if (end == value || *end != '\0')
  72     throw std::range_error("invalid integer");
  73   return res;
  74 }
  75
  76 // ***** ConfigType *****
  77
  78 /// A trait which define possible options types:
  79 template <class T> class ConfigType;
  80
  81 template <> class ConfigType<int> {
  82 public:
  83   static constexpr const char* type_name = "int";
  84   static inline int parse(const char* value)
  85   {
  86     long val = parse_long(value);
  87     if (val < INT_MIN)
  88       throw std::range_error("underflow");
  89     if (val > INT_MAX)
  90       throw std::range_error("overflow");
  91     return static_cast<int>(val);
  92   }
  93 };
  94 template <> class ConfigType<double> {
  95 public:
  96   static constexpr const char* type_name = "double";
  97   static inline double parse(const char* value)
  98   {
  99     return parse_double(value);
 100   }
 101 };
 102 template <> class ConfigType<std::string> {
 103 public:
 104   static constexpr const char* type_name = "string";
 105   static inline std::string parse(const char* value)
 106   {
 107     return std::string(value);
 108   }
 109 };
 110 template <> class ConfigType<bool> {
 111 public:
 112   static constexpr const char* type_name = "boolean";
 113   static inline bool parse(const char* value)
 114   {
 115     return parse_bool(value);
 116   }
 117 };
 118
 119 // **** Forward declarations ****
 120
 121 class ConfigurationElement ;
 122 template<class T> class TypedConfigurationElement;
 123
 124 // **** ConfigurationElement ****
 125
 126 class ConfigurationElement {
 127 private:
 128   std::string key;
 129   std::string desc;
 130   bool isdefault = true;
 131
 132 public:
 133   ConfigurationElement(const std::string& key, const std::string& desc) : key(key), desc(desc) {}
 134
 135   virtual ~ConfigurationElement() = default;
 136
 137   virtual std::string get_string_value()           = 0;
 138   virtual void set_string_value(const char* value) = 0;
 139   virtual const char* get_type_name()              = 0;
 140
 141   template <class T> T const& get_value() const
 142   {
 143     return static_cast<const TypedConfigurationElement<T>&>(*this).get_value();
 144   }
 145   template <class T> void set_value(T value)
 146   {
 147     static_cast<TypedConfigurationElement<T>&>(*this).set_value(std::move(value));
 148   }
 149   template <class T> void set_default_value(T value)
 150   {
 151     static_cast<TypedConfigurationElement<T>&>(*this).set_default_value(std::move(value));
 152   }
 153   void unset_default() { isdefault = false; }
 154   bool is_default() const { return isdefault; }
 155
 156   std::string const& get_description() const { return desc; }
 157   std::string const& get_key() const { return key; }
 158 };
 159
 160 // **** TypedConfigurationElement<T> ****
 161
 162 // TODO, could we use boost::any with some Type* reference?
 163 template<class T>
 164 class TypedConfigurationElement : public ConfigurationElement {
 165 private:
 166   T content;
 167   std::function<void(T&)> callback;
 168
 169 public:
 170   TypedConfigurationElement(const std::string& key, const std::string& desc, T value = T())
 171       : ConfigurationElement(key, desc), content(std::move(value))
 172   {}
 173   TypedConfigurationElement(const std::string& key, const std::string& desc, T value, std::function<void(T&)> callback)
 174       : ConfigurationElement(key, desc), content(std::move(value)), callback(std::move(callback))
 175   {}
 176
 177   std::string get_string_value() override;
 178   const char* get_type_name() override;
 179   void set_string_value(const char* value) override;
 180
 181   void update()
 182   {
 183     if (this->callback)
 184       this->callback(this->content);
 185   }
 186
 187   T const& get_value() const { return content; }
 188
 189   void set_value(T value)
 190   {
 191     this->content = std::move(value);
 192     this->update();
 193     this->unset_default();
 194   }
 195
 196   void set_default_value(T value)
 197   {
 198     if (this->is_default()) {
 199       this->content = std::move(value);
 200       this->update();
 201     } else {
 202       XBT_DEBUG("Do not override configuration variable '%s' with value '%s' because it was already set.",
 203                 get_key().c_str(), get_string_value().c_str());
 204     }
 205   }
 206 };
 207
 208 template <class T> std::string TypedConfigurationElement<T>::get_string_value() // override
 209 {
 210   return to_string(content);
 211 }
 212
 213 template <> std::string TypedConfigurationElement<double>::get_string_value() // override
 214 {
 215   // don't want std::to_string which uses %f, and formats very small values as 0.000000
 216   return xbt::string_printf("%g", content);
 217 }
 218
 219 template <class T> void TypedConfigurationElement<T>::set_string_value(const char* value) // override
 220 {
 221   this->content = ConfigType<T>::parse(value);
 222   this->unset_default();
 223   this->update();
 224 }
 225
 226 template <class T> const char* TypedConfigurationElement<T>::get_type_name() // override
 227 {
 228   return ConfigType<T>::type_name;
 229 }
 230
 231 } // end of anonymous namespace
 232
 233 // **** Config ****
 234
 235 class Config {
 236 private:
 237   // name -> ConfigElement:
 238   std::map<std::string, std::unique_ptr<ConfigurationElement>, std::less<>> options;
 239   // alias -> ConfigElement from options:
 240   std::map<std::string, ConfigurationElement*, std::less<>> aliases;
 241   bool warn_for_aliases = true;
 242
 243 public:
 244   Config();
 245
 246   // No copy:
 247   Config(Config const&) = delete;
 248   Config& operator=(Config const&) = delete;
 249
 250   ConfigurationElement& operator[](const std::string& name);
 251   void alias(const std::string& realname, const std::string& aliasname);
 252
 253   template <class T, class... A> TypedConfigurationElement<T>* register_option(const std::string& name, A&&... a)
 254   {
 255     xbt_assert(options.find(name) == options.end(), "Refusing to register the config element '%s' twice.",
 256                name.c_str());
 257     auto* variable = new TypedConfigurationElement<T>(name, std::forward<A>(a)...);
 258     XBT_DEBUG("Register cfg elm %s (%s) of type %s @%p in set %p)", name.c_str(), variable->get_description().c_str(),
 259               variable->get_type_name(), variable, this);
 260     options[name].reset(variable);
 261     variable->update();
 262     return variable;
 263   }
 264
 265   void show_aliases() const;
 266   void help() const;
 267
 268 protected:
 269   ConfigurationElement* get_dict_element(const std::string& name);
 270 };
 271
 272 Config::Config()
 273 {
 274   atexit(&sg_config_finalize);
 275 }
 276
 277 inline ConfigurationElement* Config::get_dict_element(const std::string& name)
 278 {
 279   auto opt = options.find(name);
 280   if (opt != options.end()) {
 281     return opt->second.get();
 282   } else {
 283     auto als = aliases.find(name);
 284     if (als != aliases.end()) {
 285       ConfigurationElement* res = als->second;
 286       if (warn_for_aliases)
 287         XBT_INFO("Option %s has been renamed to %s. Consider switching.", name.c_str(), res->get_key().c_str());
 288       return res;
 289     } else {
 290       std::string msg   = "Bad config key: " + name + "\n";
 291       std::string kebab = name;
 292       std::replace(begin(kebab), end(kebab), '_', '-'); // convert from snake_case to kebab-case
 293       if (options.count(kebab) > 0)
 294         msg += "Did you mean '" + kebab + "'?\n";
 295       msg += "Existing config keys:\n";
 296       for (auto const& elm : options)
 297         msg += "  " + elm.first + ": (" + elm.second->get_type_name() + ")" + elm.second->get_string_value() + "\n";
 298       throw std::out_of_range(msg);
 299     }
 300   }
 301 }
 302
 303 inline ConfigurationElement& Config::operator[](const std::string& name)
 304 {
 305   return *(get_dict_element(name));
 306 }
 307
 308 void Config::alias(const std::string& realname, const std::string& aliasname)
 309 {
 310   xbt_assert(aliases.find(aliasname) == aliases.end(), "Alias '%s' already.", aliasname.c_str());
 311   ConfigurationElement* element = this->get_dict_element(realname);
 312   xbt_assert(element, "Cannot define an alias to the non-existing option '%s'.", realname.c_str());
 313   this->aliases.try_emplace(aliasname, element);
 314 }
 315
 316 /** @brief Displays the declared aliases and their replacement */
 317 void Config::show_aliases() const
 318 {
 319   for (auto const& elm : aliases)
 320     XBT_HELP("   %-40s %s", elm.first.c_str(), elm.second->get_key().c_str());
 321 }
 322
 323 /** @brief Displays the declared options and their description */
 324 void Config::help() const
 325 {
 326   for (auto const& elm : options) {
 327     simgrid::config::ConfigurationElement* variable = elm.second.get();
 328     XBT_HELP("   %s: %s", elm.first.c_str(), variable->get_description().c_str());
 329     XBT_HELP("       Type: %s; Current value: %s", variable->get_type_name(), variable->get_string_value().c_str());
 330   }
 331 }
 332
 333 // ***** set_default *****
 334
 335 template <class T> XBT_PUBLIC void set_default(const char* name, T value)
 336 {
 337   (*simgrid_config)[name].set_default_value<T>(std::move(value));
 338 }
 339
 340 template XBT_PUBLIC void set_default<int>(const char* name, int value);
 341 template XBT_PUBLIC void set_default<double>(const char* name, double value);
 342 template XBT_PUBLIC void set_default<bool>(const char* name, bool value);
 343 template XBT_PUBLIC void set_default<std::string>(const char* name, std::string value);
 344
 345 bool is_default(const char* name)
 346 {
 347   return (*simgrid_config)[name].is_default();
 348 }
 349
 350 // ***** set_value *****
 351
 352 template <class T> XBT_PUBLIC void set_value(const char* name, T value)
 353 {
 354   (*simgrid_config)[name].set_value<T>(std::move(value));
 355 }
 356
 357 template XBT_PUBLIC void set_value<int>(const char* name, int value);
 358 template XBT_PUBLIC void set_value<double>(const char* name, double value);
 359 template XBT_PUBLIC void set_value<bool>(const char* name, bool value);
 360 template XBT_PUBLIC void set_value<std::string>(const char* name, std::string value);
 361
 362 void set_as_string(const char* name, const std::string& value)
 363 {
 364   (*simgrid_config)[name].set_string_value(value.c_str());
 365 }
 366
 367 void set_parse(const std::string& opt)
 368 {
 369   std::string options(opt);
 370   XBT_DEBUG("List to parse and set:'%s'", options.c_str());
 371   while (not options.empty()) {
 372     XBT_DEBUG("Still to parse and set: '%s'", options.c_str());
 373
 374     // skip separators
 375     size_t pos = options.find_first_not_of(" \t\n,");
 376     options.erase(0, pos);
 377     // find option
 378     pos              = options.find_first_of(" \t\n,");
 379     std::string name = options.substr(0, pos);
 380     options.erase(0, pos);
 381     XBT_DEBUG("parse now:'%s'; parse later:'%s'", name.c_str(), options.c_str());
 382
 383     if (name.empty())
 384       continue;
 385
 386     pos = name.find(':');
 387     xbt_assert(pos != std::string::npos, "Option '%s' badly formatted. Should be of the form 'name:value'",
 388                name.c_str());
 389
 390     std::string val = name.substr(pos + 1);
 391     name.erase(pos);
 392
 393     const std::string path("path");
 394     if (name.compare(0, path.length(), path) != 0)
 395       XBT_INFO("Configuration change: Set '%s' to '%s'", name.c_str(), val.c_str());
 396
 397     set_as_string(name.c_str(), val);
 398   }
 399 }
 400
 401 // ***** get_value *****
 402
 403 template <class T> XBT_PUBLIC T const& get_value(const std::string& name)
 404 {
 405   return (*simgrid_config)[name].get_value<T>();
 406 }
 407
 408 template XBT_PUBLIC int const& get_value<int>(const std::string& name);
 409 template XBT_PUBLIC double const& get_value<double>(const std::string& name);
 410 template XBT_PUBLIC bool const& get_value<bool>(const std::string& name);
 411 template XBT_PUBLIC std::string const& get_value<std::string>(const std::string& name);
 412
 413 // ***** alias *****
 414
 415 void alias(const char* realname, std::initializer_list<const char*> aliases)
 416 {
 417   for (auto const& aliasname : aliases)
 418     simgrid_config->alias(realname, aliasname);
 419 }
 420
 421 // ***** declare_flag *****
 422
 423 template <class T>
 424 XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, T value,
 425                              std::function<void(const T&)> callback)
 426 {
 427   if (simgrid_config == nullptr)
 428     simgrid_config = new simgrid::config::Config();
 429   simgrid_config->register_option<T>(name, description, std::move(value), std::move(callback));
 430 }
 431
 432 template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, int value,
 433                                       std::function<void(int const&)> callback);
 434 template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, double value,
 435                                       std::function<void(double const&)> callback);
 436 template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, bool value,
 437                                       std::function<void(bool const&)> callback);
 438 template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, std::string value,
 439                                       std::function<void(std::string const&)> callback);
 440
 441 void finalize()
 442 {
 443   delete simgrid_config;
 444   simgrid_config = nullptr;
 445 }
 446
 447 void show_aliases()
 448 {
 449   simgrid_config->show_aliases();
 450 }
 451
 452 void help()
 453 {
 454   simgrid_config->help();
 455 }
 456 }
 457 }
 458
 459 /*----[ Setting ]---------------------------------------------------------*/
 460
 461 /** @brief Set an integer value to \a name within \a cfg
 462  *
 463  * @param key the name of the variable
 464  * @param value the value of the variable
 465  */
 466 void sg_cfg_set_int(const char* key, int value)
 467 {
 468   (*simgrid_config)[key].set_value<int>(value);
 469 }
 470
 471 /** @brief Set or add a double value to \a name within \a cfg
 472  *
 473  * @param key the name of the variable
 474  * @param value the double to set
 475  */
 476 void sg_cfg_set_double(const char* key, double value)
 477 {
 478   (*simgrid_config)[key].set_value<double>(value);
 479 }
 480
 481 /** @brief Set or add a string value to \a name within \a cfg
 482  *
 483  * @param key the name of the variable
 484  * @param value the value to be added
 485  *
 486  */
 487 void sg_cfg_set_string(const char* key, const char* value)
 488 {
 489   (*simgrid_config)[key].set_value<std::string>(value);
 490 }
 491
 492 /** @brief Set or add a boolean value to \a name within \a cfg
 493  *
 494  * @param key the name of the variable
 495  * @param value the value of the variable
 496  */
 497 void sg_cfg_set_boolean(const char* key, const char* value)
 498 {
 499   (*simgrid_config)[key].set_value<bool>(simgrid::config::parse_bool(value));
 500 }
 501
 502 /*----[ Getting ]---------------------------------------------------------*/
 503 /** @brief Retrieve an integer value of a variable (get a warning if not uniq)
 504  *
 505  * @param key the name of the variable
 506  *
 507  * Returns the first value from the config set under the given name.
 508  */
 509 int sg_cfg_get_int(const char* key)
 510 {
 511   return (*simgrid_config)[key].get_value<int>();
 512 }
 513
 514 /** @brief Retrieve a double value of a variable (get a warning if not uniq)
 515  *
 516  * @param key the name of the variable
 517  *
 518  * Returns the first value from the config set under the given name.
 519  */
 520 double sg_cfg_get_double(const char* key)
 521 {
 522   return (*simgrid_config)[key].get_value<double>();
 523 }
 524
 525 /** @brief Retrieve a boolean value of a variable (get a warning if not uniq)
 526  *
 527  * @param key the name of the variable
 528  *
 529  * Returns the first value from the config set under the given name.
 530  * If there is more than one value, it will issue a warning.
 531  */
 532 int sg_cfg_get_boolean(const char* key)
 533 {
 534   return (*simgrid_config)[key].get_value<bool>() ? 1 : 0;
 535 }