src/xbt/config.cpp

   1 /* Copyright (c) 2004-2020. 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   ConfigurationElement(const std::string& key, const std::string& desc) : key(key), desc(desc) {}
 145
 146   virtual ~ConfigurationElement() = default;
 147
 148   virtual std::string get_string_value()           = 0;
 149   virtual void set_string_value(const char* value) = 0;
 150   virtual const char* get_type_name()              = 0;
 151
 152   template <class T> T const& get_value() const
 153   {
 154     return static_cast<const TypedConfigurationElement<T>&>(*this).get_value();
 155   }
 156   template <class T> void set_value(T value)
 157   {
 158     static_cast<TypedConfigurationElement<T>&>(*this).set_value(std::move(value));
 159   }
 160   template <class T> void set_default_value(T value)
 161   {
 162     static_cast<TypedConfigurationElement<T>&>(*this).set_default_value(std::move(value));
 163   }
 164   void unset_default() { isdefault = false; }
 165   bool is_default() const { return isdefault; }
 166
 167   std::string const& get_description() const { return desc; }
 168   std::string const& get_key() const { return key; }
 169 };
 170
 171 // **** TypedConfigurationElement<T> ****
 172
 173 // TODO, could we use boost::any with some Type* reference?
 174 template<class T>
 175 class TypedConfigurationElement : public ConfigurationElement {
 176 private:
 177   T content;
 178   std::function<void(T&)> callback;
 179
 180 public:
 181   TypedConfigurationElement(const std::string& key, const std::string& desc, T value = T())
 182       : ConfigurationElement(key, desc), content(std::move(value))
 183   {}
 184   TypedConfigurationElement(const std::string& key, const std::string& desc, T value, std::function<void(T&)> callback)
 185       : ConfigurationElement(key, desc), content(std::move(value)), callback(std::move(callback))
 186   {}
 187   ~TypedConfigurationElement() = default;
 188
 189   std::string get_string_value() override;
 190   const char* get_type_name() override;
 191   void set_string_value(const char* value) override;
 192
 193   void update()
 194   {
 195     if (this->callback)
 196       this->callback(this->content);
 197   }
 198
 199   T const& get_value() const { return content; }
 200
 201   void set_value(T value)
 202   {
 203     this->content = std::move(value);
 204     this->update();
 205     this->unset_default();
 206   }
 207
 208   void set_default_value(T value)
 209   {
 210     if (this->is_default()) {
 211       this->content = std::move(value);
 212       this->update();
 213     } else {
 214       XBT_DEBUG("Do not override configuration variable '%s' with value '%s' because it was already set.",
 215                 get_key().c_str(), to_string(value).c_str());
 216     }
 217   }
 218 };
 219
 220 template <class T> std::string TypedConfigurationElement<T>::get_string_value() // override
 221 {
 222   return to_string(content);
 223 }
 224
 225 template <class T> void TypedConfigurationElement<T>::set_string_value(const char* value) // override
 226 {
 227   this->content = ConfigType<T>::parse(value);
 228   this->unset_default();
 229   this->update();
 230 }
 231
 232 template <class T> const char* TypedConfigurationElement<T>::get_type_name() // override
 233 {
 234   return ConfigType<T>::type_name;
 235 }
 236
 237 } // end of anonymous namespace
 238
 239 // **** Config ****
 240
 241 class Config {
 242 private:
 243   // name -> ConfigElement:
 244   std::map<std::string, std::unique_ptr<ConfigurationElement>> options;
 245   // alias -> ConfigElement from options:
 246   std::map<std::string, ConfigurationElement*> aliases;
 247   bool warn_for_aliases = true;
 248
 249 public:
 250   Config();
 251
 252   // No copy:
 253   Config(Config const&) = delete;
 254   Config& operator=(Config const&) = delete;
 255
 256   ConfigurationElement& operator[](const std::string& name);
 257   void alias(const std::string& realname, const std::string& aliasname);
 258
 259   template <class T, class... A> TypedConfigurationElement<T>* register_option(const std::string& name, A&&... a)
 260   {
 261     xbt_assert(options.find(name) == options.end(), "Refusing to register the config element '%s' twice.",
 262                name.c_str());
 263     TypedConfigurationElement<T>* variable = new TypedConfigurationElement<T>(name, std::forward<A>(a)...);
 264     XBT_DEBUG("Register cfg elm %s (%s) of type %s @%p in set %p)", name.c_str(), variable->get_description().c_str(),
 265               variable->get_type_name(), variable, this);
 266     options[name].reset(variable);
 267     variable->update();
 268     return variable;
 269   }
 270
 271   // Debug:
 272   void dump(const char *name, const char *indent);
 273   void show_aliases();
 274   void help();
 275
 276 protected:
 277   ConfigurationElement* get_dict_element(const std::string& name);
 278 };
 279
 280 Config::Config()
 281 {
 282   atexit(&sg_config_finalize);
 283 }
 284
 285 inline ConfigurationElement* Config::get_dict_element(const std::string& name)
 286 {
 287   auto opt = options.find(name);
 288   if (opt != options.end()) {
 289     return opt->second.get();
 290   } else {
 291     auto als = aliases.find(name);
 292     if (als != aliases.end()) {
 293       ConfigurationElement* res = als->second;
 294       if (warn_for_aliases)
 295         XBT_INFO("Option %s has been renamed to %s. Consider switching.", name.c_str(), res->get_key().c_str());
 296       return res;
 297     } else {
 298       std::string msg = "Bad config key: " + name + "\nExisting config keys:\n";
 299       for (auto const& elm : options)
 300         msg += "  " + elm.first + ": (" + elm.second->get_type_name() + ")" + elm.second->get_string_value() + "\n";
 301       throw std::out_of_range(msg);
 302     }
 303   }
 304 }
 305
 306 inline ConfigurationElement& Config::operator[](const std::string& name)
 307 {
 308   return *(get_dict_element(name));
 309 }
 310
 311 void Config::alias(const std::string& realname, const std::string& aliasname)
 312 {
 313   xbt_assert(aliases.find(aliasname) == aliases.end(), "Alias '%s' already.", aliasname.c_str());
 314   ConfigurationElement* element = this->get_dict_element(realname);
 315   xbt_assert(element, "Cannot define an alias to the non-existing option '%s'.", realname.c_str());
 316   this->aliases.insert({aliasname, element});
 317 }
 318
 319 /** @brief Dump a config set for debugging purpose
 320  *
 321  * @param name The name to give to this config set
 322  * @param indent what to write at the beginning of each line (right number of spaces)
 323  */
 324 void Config::dump(const char *name, const char *indent)
 325 {
 326   XBT_LOG_DEFAULT_CATEGORY(xbt_help);
 327   if (name)
 328     XBT_VERB("%s>> Dumping of the config set '%s':", indent, name);
 329
 330   for (auto const& elm : options)
 331     XBT_VERB("%s  %s: ()%s) %s", indent, elm.first.c_str(), elm.second->get_type_name(),
 332              elm.second->get_string_value().c_str());
 333
 334   if (name)
 335     XBT_VERB("%s<< End of the config set '%s'", indent, name);
 336 }
 337
 338 /** @brief Displays the declared aliases and their replacement */
 339 void Config::show_aliases()
 340 {
 341   for (auto const& elm : aliases)
 342     XBT_HELP("   %-40s %s", elm.first.c_str(), elm.second->get_key().c_str());
 343 }
 344
 345 /** @brief Displays the declared options and their description */
 346 void Config::help()
 347 {
 348   for (auto const& elm : options) {
 349     simgrid::config::ConfigurationElement* variable = elm.second.get();
 350     XBT_HELP("   %s: %s", elm.first.c_str(), variable->get_description().c_str());
 351     XBT_HELP("       Type: %s; Current value: %s", variable->get_type_name(), variable->get_string_value().c_str());
 352   }
 353 }
 354
 355 // ***** set_default *****
 356
 357 template <class T> XBT_PUBLIC void set_default(const char* name, T value)
 358 {
 359   (*simgrid_config)[name].set_default_value<T>(std::move(value));
 360 }
 361
 362 template XBT_PUBLIC void set_default<int>(const char* name, int value);
 363 template XBT_PUBLIC void set_default<double>(const char* name, double value);
 364 template XBT_PUBLIC void set_default<bool>(const char* name, bool value);
 365 template XBT_PUBLIC void set_default<std::string>(const char* name, std::string value);
 366
 367 bool is_default(const char* name)
 368 {
 369   return (*simgrid_config)[name].is_default();
 370 }
 371
 372 // ***** set_value *****
 373
 374 template <class T> XBT_PUBLIC void set_value(const char* name, T value)
 375 {
 376   (*simgrid_config)[name].set_value<T>(std::move(value));
 377 }
 378
 379 template XBT_PUBLIC void set_value<int>(const char* name, int value);
 380 template XBT_PUBLIC void set_value<double>(const char* name, double value);
 381 template XBT_PUBLIC void set_value<bool>(const char* name, bool value);
 382 template XBT_PUBLIC void set_value<std::string>(const char* name, std::string value);
 383
 384 void set_as_string(const char* name, const std::string& value)
 385 {
 386   (*simgrid_config)[name].set_string_value(value.c_str());
 387 }
 388
 389 void set_parse(const std::string& opt)
 390 {
 391   std::string options(opt);
 392   XBT_DEBUG("List to parse and set:'%s'", options.c_str());
 393   while (not options.empty()) {
 394     XBT_DEBUG("Still to parse and set: '%s'", options.c_str());
 395
 396     // skip separators
 397     size_t pos = options.find_first_not_of(" \t\n,");
 398     options.erase(0, pos);
 399     // find option
 400     pos              = options.find_first_of(" \t\n,");
 401     std::string name = options.substr(0, pos);
 402     options.erase(0, pos);
 403     XBT_DEBUG("parse now:'%s'; parse later:'%s'", name.c_str(), options.c_str());
 404
 405     if (name.empty())
 406       continue;
 407
 408     pos = name.find(':');
 409     xbt_assert(pos != std::string::npos, "Option '%s' badly formatted. Should be of the form 'name:value'",
 410                name.c_str());
 411
 412     std::string val = name.substr(pos + 1);
 413     name.erase(pos);
 414
 415     const std::string path("path");
 416     if (name.compare(0, path.length(), path) != 0)
 417       XBT_INFO("Configuration change: Set '%s' to '%s'", name.c_str(), val.c_str());
 418
 419     set_as_string(name.c_str(), val);
 420   }
 421 }
 422
 423 // ***** get_value *****
 424
 425 template <class T> XBT_PUBLIC T const& get_value(const std::string& name)
 426 {
 427   return (*simgrid_config)[name].get_value<T>();
 428 }
 429
 430 template XBT_PUBLIC int const& get_value<int>(const std::string& name);
 431 template XBT_PUBLIC double const& get_value<double>(const std::string& name);
 432 template XBT_PUBLIC bool const& get_value<bool>(const std::string& name);
 433 template XBT_PUBLIC std::string const& get_value<std::string>(const std::string& name);
 434
 435 // ***** alias *****
 436
 437 void alias(const char* realname, std::initializer_list<const char*> aliases)
 438 {
 439   for (auto const& aliasname : aliases)
 440     simgrid_config->alias(realname, aliasname);
 441 }
 442
 443 // ***** declare_flag *****
 444
 445 template <class T>
 446 XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, T value,
 447                              std::function<void(const T&)> callback)
 448 {
 449   if (simgrid_config == nullptr)
 450     simgrid_config = new simgrid::config::Config();
 451   simgrid_config->register_option<T>(name, description, std::move(value), std::move(callback));
 452 }
 453
 454 template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, int value,
 455                                       std::function<void(int const&)> callback);
 456 template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, double value,
 457                                       std::function<void(double const&)> callback);
 458 template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, bool value,
 459                                       std::function<void(bool const&)> callback);
 460 template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, std::string value,
 461                                       std::function<void(std::string const&)> callback);
 462
 463 void finalize()
 464 {
 465   delete simgrid_config;
 466   simgrid_config = nullptr;
 467 }
 468
 469 void show_aliases()
 470 {
 471   simgrid_config->show_aliases();
 472 }
 473
 474 void help()
 475 {
 476   simgrid_config->help();
 477 }
 478 }
 479 }
 480
 481 /*----[ Setting ]---------------------------------------------------------*/
 482
 483 /** @brief Set an integer value to \a name within \a cfg
 484  *
 485  * @param key the name of the variable
 486  * @param value the value of the variable
 487  */
 488 void sg_cfg_set_int(const char* key, int value)
 489 {
 490   (*simgrid_config)[key].set_value<int>(value);
 491 }
 492
 493 /** @brief Set or add a double value to \a name within \a cfg
 494  *
 495  * @param key the name of the variable
 496  * @param value the double to set
 497  */
 498 void sg_cfg_set_double(const char* key, double value)
 499 {
 500   (*simgrid_config)[key].set_value<double>(value);
 501 }
 502
 503 /** @brief Set or add a string value to \a name within \a cfg
 504  *
 505  * @param key the name of the variable
 506  * @param value the value to be added
 507  *
 508  */
 509 void sg_cfg_set_string(const char* key, const char* value)
 510 {
 511   (*simgrid_config)[key].set_value<std::string>(value);
 512 }
 513
 514 /** @brief Set or add a boolean value to \a name within \a cfg
 515  *
 516  * @param key the name of the variable
 517  * @param value the value of the variable
 518  */
 519 void sg_cfg_set_boolean(const char* key, const char* value)
 520 {
 521   (*simgrid_config)[key].set_value<bool>(simgrid::config::parse_bool(value));
 522 }
 523
 524 /*----[ Getting ]---------------------------------------------------------*/
 525 /** @brief Retrieve an integer 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  */
 531 int sg_cfg_get_int(const char* key)
 532 {
 533   return (*simgrid_config)[key].get_value<int>();
 534 }
 535
 536 /** @brief Retrieve a double value of a variable (get a warning if not uniq)
 537  *
 538  * @param key the name of the variable
 539  *
 540  * Returns the first value from the config set under the given name.
 541  */
 542 double sg_cfg_get_double(const char* key)
 543 {
 544   return (*simgrid_config)[key].get_value<double>();
 545 }
 546
 547 /** @brief Retrieve a boolean value of a variable (get a warning if not uniq)
 548  *
 549  * @param key the name of the variable
 550  *
 551  * Returns the first value from the config set under the given name.
 552  * If there is more than one value, it will issue a warning.
 553  */
 554 int sg_cfg_get_boolean(const char* key)
 555 {
 556   return (*simgrid_config)[key].get_value<bool>() ? 1 : 0;
 557 }