src/xbt/config.cpp

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