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