src/xbt/config.cpp

   1 /* Copyright (c) 2004-2017. 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 <stdexcept>
  16 #include <string>
  17 #include <string>
  18 #include <type_traits>
  19 #include <typeinfo>
  20 #include <vector>
  21
  22 #include <xbt/ex.hpp>
  23 #include <xbt/config.h>
  24 #include <xbt/config.hpp>
  25 #include "xbt/misc.h"
  26 #include "xbt/sysdep.h"
  27 #include "xbt/log.h"
  28 #include "xbt/dynar.h"
  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 extern "C" {
  34   XBT_PUBLIC(void) sg_config_finalize();
  35 }
  36
  37 namespace simgrid {
  38 namespace config {
  39
  40 missing_key_error::~missing_key_error() = default;
  41
  42 namespace {
  43
  44 const char* true_values[] = {
  45   "yes", "on", "true", "1"
  46 };
  47 const char* false_values[] = {
  48   "no", "off", "false", "0"
  49 };
  50
  51 static bool parseBool(const char* value)
  52 {
  53   for (const char* const& true_value : true_values)
  54     if (std::strcmp(true_value, value) == 0)
  55       return true;
  56   for (const char* const& false_value : false_values)
  57     if (std::strcmp(false_value, value) == 0)
  58       return false;
  59   throw std::range_error("not a boolean");
  60 }
  61
  62 static double parseDouble(const char* value)
  63 {
  64   char* end;
  65   errno = 0;
  66   double res = std::strtod(value, &end);
  67   if (errno == ERANGE)
  68     throw std::range_error("out of range");
  69   else if (errno)
  70     xbt_die("Unexpected errno");
  71   if (end == value || *end != '\0')
  72     throw std::range_error("invalid double");
  73   else
  74     return res;
  75 }
  76
  77 static long int parseLong(const char* value)
  78 {
  79   char* end;
  80   errno = 0;
  81   long int res = std::strtol(value, &end, 0);
  82   if (errno) {
  83     if (res == LONG_MIN && errno == ERANGE)
  84       throw std::range_error("underflow");
  85     else if (res == LONG_MAX && errno == ERANGE)
  86       throw std::range_error("overflow");
  87     xbt_die("Unexpected errno");
  88   }
  89   if (end == value || *end != '\0')
  90     throw std::range_error("invalid integer");
  91   else
  92     return res;
  93 }
  94
  95 // ***** ConfigType *****
  96
  97 /// A trait which define possible options types:
  98 template <class T> class ConfigType;
  99
 100 template <> class ConfigType<int> {
 101 public:
 102   static constexpr const char* type_name = "int";
 103   static inline double parse(const char* value)
 104   {
 105     return parseLong(value);
 106   }
 107 };
 108 template <> class ConfigType<double> {
 109 public:
 110   static constexpr const char* type_name = "double";
 111   static inline double parse(const char* value)
 112   {
 113     return parseDouble(value);
 114   }
 115 };
 116 template <> class ConfigType<std::string> {
 117 public:
 118   static constexpr const char* type_name = "string";
 119   static inline std::string parse(const char* value)
 120   {
 121     return std::string(value);
 122   }
 123 };
 124 template <> class ConfigType<bool> {
 125 public:
 126   static constexpr const char* type_name = "boolean";
 127   static inline bool parse(const char* value)
 128   {
 129     return parseBool(value);
 130   }
 131 };
 132
 133 // **** Forward declarations ****
 134
 135 class ConfigurationElement ;
 136 template<class T> class TypedConfigurationElement;
 137
 138 // **** ConfigurationElement ****
 139
 140 class ConfigurationElement {
 141 private:
 142   std::string key;
 143   std::string desc;
 144   bool isdefault = true;
 145
 146 public:
 147   /* Callback */
 148   xbt_cfg_cb_t old_callback = nullptr;
 149
 150   ConfigurationElement(const char* key, const char* desc) : key(key ? key : ""), desc(desc ? desc : "") {}
 151   ConfigurationElement(const char* key, const char* desc, xbt_cfg_cb_t cb)
 152     : key(key ? key : ""), desc(desc ? desc : ""), old_callback(cb) {}
 153
 154   virtual ~ConfigurationElement()=default;
 155
 156   virtual std::string getStringValue() = 0;
 157   virtual void setStringValue(const char* value) = 0;
 158   virtual const char* getTypeName() = 0;
 159
 160   template<class T>
 161   T const& getValue() const
 162   {
 163     return dynamic_cast<const TypedConfigurationElement<T>&>(*this).getValue();
 164   }
 165   template<class T>
 166   void setValue(T value)
 167   {
 168     dynamic_cast<TypedConfigurationElement<T>&>(*this).setValue(std::move(value));
 169   }
 170   template<class T>
 171   void setDefaultValue(T value)
 172   {
 173     dynamic_cast<TypedConfigurationElement<T>&>(*this).setDefaultValue(std::move(value));
 174   }
 175   void unsetDefault() { isdefault = false; }
 176   bool isDefault() const { return isdefault; }
 177
 178   std::string const& getDescription() const { return desc; }
 179   std::string const& getKey() const { return key; }
 180 };
 181
 182 // **** TypedConfigurationElement<T> ****
 183
 184 // TODO, could we use boost::any with some Type* reference?
 185 template<class T>
 186 class TypedConfigurationElement : public ConfigurationElement {
 187 private:
 188   T content;
 189   std::function<void(T&)> callback;
 190
 191 public:
 192   TypedConfigurationElement(const char* key, const char* desc, T value = T())
 193     : ConfigurationElement(key, desc), content(std::move(value))
 194   {}
 195   TypedConfigurationElement(const char* key, const char* desc, T value, xbt_cfg_cb_t cb)
 196       : ConfigurationElement(key, desc, cb), content(std::move(value))
 197   {}
 198   TypedConfigurationElement(const char* key, const char* desc, T value, std::function<void(T&)> callback)
 199       : ConfigurationElement(key, desc), content(std::move(value)), callback(std::move(callback))
 200   {}
 201   ~TypedConfigurationElement() = default;
 202
 203   std::string getStringValue() override;
 204   const char* getTypeName() override;
 205   void setStringValue(const char* value) override;
 206
 207   void update()
 208   {
 209     if (old_callback)
 210       this->old_callback(getKey().c_str());
 211     if (this->callback)
 212       this->callback(this->content);
 213   }
 214
 215   T const& getValue() const { return content; }
 216
 217   void setValue(T value)
 218   {
 219     this->content = std::move(value);
 220     this->update();
 221   }
 222
 223   void setDefaultValue(T value)
 224   {
 225     if (this->isDefault()) {
 226       this->content = std::move(value);
 227       this->update();
 228     } else {
 229       XBT_DEBUG("Do not override configuration variable '%s' with value '%s' because it was already set.",
 230                 getKey().c_str(), to_string(value).c_str());
 231     }
 232   }
 233 };
 234
 235 template<class T>
 236 std::string TypedConfigurationElement<T>::getStringValue() // override
 237 {
 238   return to_string(content);
 239 }
 240
 241 template<class T>
 242 void TypedConfigurationElement<T>::setStringValue(const char* value) // override
 243 {
 244   this->content = ConfigType<T>::parse(value);
 245   this->unsetDefault();
 246   this->update();
 247 }
 248
 249 template<class T>
 250 const char* TypedConfigurationElement<T>::getTypeName() // override
 251 {
 252   return ConfigType<T>::type_name;
 253 }
 254
 255 } // end of anonymous namespace
 256
 257 // **** Config ****
 258
 259 class Config {
 260 private:
 261   // name -> ConfigElement:
 262   std::map<std::string, simgrid::config::ConfigurationElement*> options;
 263   // alias -> ConfigElement from options:
 264   std::map<std::string, simgrid::config::ConfigurationElement*> aliases;
 265   bool warn_for_aliases = true;
 266
 267 public:
 268   Config() = default;
 269   ~Config();
 270
 271   // No copy:
 272   Config(Config const&) = delete;
 273   Config& operator=(Config const&) = delete;
 274
 275   ConfigurationElement& operator[](const char* name);
 276   template<class T>
 277   TypedConfigurationElement<T>& getTyped(const char* name);
 278   void alias(const char* realname, const char* aliasname);
 279
 280   template<class T, class... A>
 281   simgrid::config::TypedConfigurationElement<T>*
 282     registerOption(const char* name, A&&... a)
 283   {
 284     xbt_assert(options.find(name) == options.end(), "Refusing to register the config element '%s' twice.", name);
 285     TypedConfigurationElement<T>* variable = new TypedConfigurationElement<T>(name, std::forward<A>(a)...);
 286     XBT_DEBUG("Register cfg elm %s (%s) of type %s @%p in set %p)", name, variable->getDescription().c_str(),
 287               variable->getTypeName(), variable, this);
 288     options.insert({name, variable});
 289     variable->update();
 290     return variable;
 291   }
 292
 293   // Debug:
 294   void dump(const char *name, const char *indent);
 295   void showAliases();
 296   void help();
 297
 298 protected:
 299   ConfigurationElement* getDictElement(const char* name);
 300 };
 301
 302 Config::~Config()
 303 {
 304   XBT_DEBUG("Frees cfg set %p", this);
 305   for (auto const& elm : options)
 306     delete elm.second;
 307 }
 308
 309 inline ConfigurationElement* Config::getDictElement(const char* name)
 310 {
 311   auto opt = options.find(name);
 312   if (opt != options.end()) {
 313     return opt->second;
 314   } else {
 315     auto als = aliases.find(name);
 316     if (als != aliases.end()) {
 317       ConfigurationElement* res = als->second;
 318       if (warn_for_aliases)
 319         XBT_INFO("Option %s has been renamed to %s. Consider switching.", name, res->getKey().c_str());
 320       return res;
 321     } else {
 322       throw simgrid::config::missing_key_error(std::string("Bad config key: ") + name);
 323     }
 324   }
 325 }
 326
 327 inline ConfigurationElement& Config::operator[](const char* name)
 328 {
 329   return *(getDictElement(name));
 330 }
 331
 332 void Config::alias(const char* realname, const char* aliasname)
 333 {
 334   xbt_assert(aliases.find(aliasname) == aliases.end(), "Alias '%s' already.", aliasname);
 335   ConfigurationElement* element = this->getDictElement(realname);
 336   xbt_assert(element, "Cannot define an alias to the non-existing option '%s'.", realname);
 337   this->aliases.insert({aliasname, element});
 338 }
 339
 340 /** @brief Dump a config set for debuging purpose
 341  *
 342  * @param name The name to give to this config set
 343  * @param indent what to write at the beginning of each line (right number of spaces)
 344  */
 345 void Config::dump(const char *name, const char *indent)
 346 {
 347   if (name)
 348     printf("%s>> Dumping of the config set '%s':\n", indent, name);
 349
 350   for (auto const& elm : options)
 351     printf("%s  %s: ()%s) %s", indent, elm.first.c_str(), elm.second->getTypeName(),
 352            elm.second->getStringValue().c_str());
 353
 354   if (name)
 355     printf("%s<< End of the config set '%s'\n", indent, name);
 356   fflush(stdout);
 357 }
 358
 359 /** @brief Displays the declared aliases and their description */
 360 void Config::showAliases()
 361 {
 362   bool old_warn_for_aliases = false;
 363   std::swap(warn_for_aliases, old_warn_for_aliases);
 364   for (auto const& elm : aliases)
 365     printf("   %s: %s\n", elm.first.c_str(), (*this)[elm.first.c_str()].getDescription().c_str());
 366   std::swap(warn_for_aliases, old_warn_for_aliases);
 367 }
 368
 369 /** @brief Displays the declared options and their description */
 370 void Config::help()
 371 {
 372   for (auto const& elm : options) {
 373     simgrid::config::ConfigurationElement* variable = this->options.at(elm.first);
 374     printf("   %s: %s\n", elm.first.c_str(), variable->getDescription().c_str());
 375     printf("       Type: %s; ", variable->getTypeName());
 376     printf("Current value: %s\n", variable->getStringValue().c_str());
 377   }
 378 }
 379
 380 // ***** getConfig *****
 381
 382 template<class T>
 383 XBT_PUBLIC(T const&) getConfig(const char* name)
 384 {
 385   return (*simgrid_config)[name].getValue<T>();
 386 }
 387
 388 template XBT_PUBLIC(int const&) getConfig<int>(const char* name);
 389 template XBT_PUBLIC(double const&) getConfig<double>(const char* name);
 390 template XBT_PUBLIC(bool const&) getConfig<bool>(const char* name);
 391 template XBT_PUBLIC(std::string const&) getConfig<std::string>(const char* name);
 392
 393 // ***** alias *****
 394
 395 void alias(const char* realname, const char* aliasname)
 396 {
 397   simgrid_config->alias(realname, aliasname);
 398 }
 399
 400 // ***** declareFlag *****
 401
 402 template<class T>
 403 XBT_PUBLIC(void) declareFlag(const char* name, const char* description,
 404   T value, std::function<void(const T&)> callback)
 405 {
 406   if (simgrid_config == nullptr) {
 407     simgrid_config = xbt_cfg_new();
 408     atexit(sg_config_finalize);
 409   }
 410   simgrid_config->registerOption<T>(
 411     name, description, std::move(value), std::move(callback));
 412 }
 413
 414 template XBT_PUBLIC(void) declareFlag(const char* name,
 415   const char* description, int value, std::function<void(int const &)> callback);
 416 template XBT_PUBLIC(void) declareFlag(const char* name,
 417   const char* description, double value, std::function<void(double const &)> callback);
 418 template XBT_PUBLIC(void) declareFlag(const char* name,
 419   const char* description, bool value, std::function<void(bool const &)> callback);
 420 template XBT_PUBLIC(void) declareFlag(const char* name,
 421   const char* description, std::string value, std::function<void(std::string const &)> callback);
 422
 423 }
 424 }
 425
 426 // ***** C bindings *****
 427
 428 xbt_cfg_t xbt_cfg_new()        { return new simgrid::config::Config(); }
 429 void xbt_cfg_free(xbt_cfg_t * cfg) { delete *cfg; }
 430
 431 void xbt_cfg_dump(const char *name, const char *indent, xbt_cfg_t cfg)
 432 {
 433   cfg->dump(name, indent);
 434 }
 435
 436 /*----[ Registering stuff ]-----------------------------------------------*/
 437
 438 void xbt_cfg_register_double(const char *name, double default_value,
 439   xbt_cfg_cb_t cb_set, const char *desc)
 440 {
 441   if (simgrid_config == nullptr)
 442     simgrid_config = xbt_cfg_new();
 443   simgrid_config->registerOption<double>(name, desc, default_value, cb_set);
 444 }
 445
 446 void xbt_cfg_register_int(const char *name, int default_value,xbt_cfg_cb_t cb_set, const char *desc)
 447 {
 448   if (simgrid_config == nullptr) {
 449     simgrid_config = xbt_cfg_new();
 450     atexit(&sg_config_finalize);
 451   }
 452   simgrid_config->registerOption<int>(name, desc, default_value, cb_set);
 453 }
 454
 455 void xbt_cfg_register_string(const char *name, const char *default_value, xbt_cfg_cb_t cb_set, const char *desc)
 456 {
 457   if (simgrid_config == nullptr) {
 458     simgrid_config = xbt_cfg_new();
 459     atexit(sg_config_finalize);
 460   }
 461   simgrid_config->registerOption<std::string>(name, desc, default_value ? default_value : "", cb_set);
 462 }
 463
 464 void xbt_cfg_register_boolean(const char *name, const char*default_value,xbt_cfg_cb_t cb_set, const char *desc)
 465 {
 466   if (simgrid_config == nullptr) {
 467     simgrid_config = xbt_cfg_new();
 468     atexit(sg_config_finalize);
 469   }
 470   simgrid_config->registerOption<bool>(name, desc, simgrid::config::parseBool(default_value), cb_set);
 471 }
 472
 473 void xbt_cfg_register_alias(const char *realname, const char *aliasname)
 474 {
 475   if (simgrid_config == nullptr) {
 476     simgrid_config = xbt_cfg_new();
 477     atexit(sg_config_finalize);
 478   }
 479   simgrid_config->alias(realname, aliasname);
 480 }
 481
 482 void xbt_cfg_aliases() { simgrid_config->showAliases(); }
 483 void xbt_cfg_help()    { simgrid_config->help(); }
 484
 485 /*----[ Setting ]---------------------------------------------------------*/
 486
 487 /** @brief Add values parsed from a string into a config set
 488  *
 489  * @param options a string containing the content to add to the config set. This is a '\\t',' ' or '\\n' or ','
 490  * separated list of variables. Each individual variable is like "[name]:[value]" where [name] is the name of an
 491  * already registered variable, and [value] conforms to the data type under which this variable was registered.
 492  *
 493  * @todo This is a crude manual parser, it should be a proper lexer.
 494  */
 495 void xbt_cfg_set_parse(const char *options)
 496 {
 497   if (not options || not strlen(options)) { /* nothing to do */
 498     return;
 499   }
 500
 501   XBT_DEBUG("List to parse and set:'%s'", options);
 502   std::string optionlist(options);
 503   while (not optionlist.empty()) {
 504     XBT_DEBUG("Still to parse and set: '%s'", optionlist.c_str());
 505
 506     // skip separators
 507     size_t pos = optionlist.find_first_not_of(" \t\n,");
 508     optionlist.erase(0, pos);
 509     // find option
 510     pos              = optionlist.find_first_of(" \t\n,");
 511     std::string name = optionlist.substr(0, pos);
 512     optionlist.erase(0, pos);
 513     XBT_DEBUG("parse now:'%s'; parse later:'%s'", name.c_str(), optionlist.c_str());
 514
 515     if (name.empty())
 516       continue;
 517
 518     pos = name.find(':');
 519     xbt_assert(pos != std::string::npos, "Option '%s' badly formatted. Should be of the form 'name:value'",
 520                name.c_str());
 521
 522     std::string val = name.substr(pos + 1);
 523     name.erase(pos);
 524
 525     const std::string path("path");
 526     if (name.compare(0, path.length(), path) != 0)
 527       XBT_INFO("Configuration change: Set '%s' to '%s'", name.c_str(), val.c_str());
 528
 529     try {
 530       (*simgrid_config)[name.c_str()].setStringValue(val.c_str());
 531     }
 532     catch (simgrid::config::missing_key_error& e) {
 533       goto on_missing_key;
 534     }
 535     catch (...) {
 536       goto on_exception;
 537     }
 538   }
 539   return;
 540
 541   /* Do not THROWF from a C++ exception catching context, or some cleanups will be missing */
 542 on_missing_key:
 543   THROWF(not_found_error, 0, "Could not set variables %s", options);
 544 on_exception:
 545   THROWF(unknown_error, 0, "Could not set variables %s", options);
 546 }
 547
 548 // Horrible mess to translate C++ exceptions to C exceptions:
 549 // Exit from the catch block (and do the correct exception cleaning) before attempting to THROWF.
 550 #define TRANSLATE_EXCEPTIONS(...) \
 551   catch(simgrid::config::missing_key_error& e) { THROWF(not_found_error, 0, __VA_ARGS__); abort(); } \
 552   catch(...) { THROWF(not_found_error, 0, __VA_ARGS__); abort(); }
 553
 554 /** @brief Set the value of a variable, using the string representation of that value
 555  *
 556  * @param key name of the variable to modify
 557  * @param value string representation of the value to set
 558  */
 559
 560 void xbt_cfg_set_as_string(const char *key, const char *value)
 561 {
 562   try {
 563     (*simgrid_config)[key].setStringValue(value);
 564     return;
 565   }
 566   TRANSLATE_EXCEPTIONS("Could not set variable %s as string %s", key, value);
 567 }
 568
 569 /** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet
 570  *
 571  * This is useful to change the default value of a variable while allowing
 572  * users to override it with command line arguments
 573  */
 574 void xbt_cfg_setdefault_int(const char *key, int value)
 575 {
 576   try {
 577     (*simgrid_config)[key].setDefaultValue<int>(value);
 578     return;
 579   }
 580   TRANSLATE_EXCEPTIONS("Could not set variable %s to default integer %i", key, value);
 581 }
 582
 583 /** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet
 584  *
 585  * This is useful to change the default value of a variable while allowing
 586  * users to override it with command line arguments
 587  */
 588 void xbt_cfg_setdefault_double(const char *key, double value)
 589 {
 590   try {
 591     (*simgrid_config)[key].setDefaultValue<double>(value);
 592     return;
 593   }
 594   TRANSLATE_EXCEPTIONS("Could not set variable %s to default double %f", key, value);
 595 }
 596
 597 /** @brief Set a string value to \a name within \a cfg if it wasn't changed yet
 598  *
 599  * This is useful to change the default value of a variable while allowing
 600  * users to override it with command line arguments
 601  */
 602 void xbt_cfg_setdefault_string(const char *key, const char *value)
 603 {
 604   try {
 605     (*simgrid_config)[key].setDefaultValue<std::string>(value ? value : "");
 606     return;
 607   }
 608   TRANSLATE_EXCEPTIONS("Could not set variable %s to default string %s", key, value);
 609 }
 610
 611 /** @brief Set an boolean value to \a name within \a cfg if it wasn't changed yet
 612  *
 613  * This is useful to change the default value of a variable while allowing
 614  * users to override it with command line arguments
 615  */
 616 void xbt_cfg_setdefault_boolean(const char *key, const char *value)
 617 {
 618   try {
 619     (*simgrid_config)[key].setDefaultValue<bool>(simgrid::config::parseBool(value));
 620     return;
 621   }
 622   TRANSLATE_EXCEPTIONS("Could not set variable %s to default boolean %s", key, value);
 623 }
 624
 625 /** @brief Set an integer value to \a name within \a cfg
 626  *
 627  * @param key the name of the variable
 628  * @param value the value of the variable
 629  */
 630 void xbt_cfg_set_int(const char *key, int value)
 631 {
 632   try {
 633     (*simgrid_config)[key].setValue<int>(value);
 634     return;
 635   }
 636   TRANSLATE_EXCEPTIONS("Could not set variable %s to integer %i", key, value);
 637 }
 638
 639 /** @brief Set or add a double value to \a name within \a cfg
 640  *
 641  * @param key the name of the variable
 642  * @param value the double to set
 643  */
 644 void xbt_cfg_set_double(const char *key, double value)
 645 {
 646   try {
 647     (*simgrid_config)[key].setValue<double>(value);
 648     return;
 649   }
 650   TRANSLATE_EXCEPTIONS("Could not set variable %s to double %f", key, value);
 651 }
 652
 653 /** @brief Set or add a string value to \a name within \a cfg
 654  *
 655  * @param key the name of the variable
 656  * @param value the value to be added
 657  *
 658  */
 659 void xbt_cfg_set_string(const char* key, const char* value)
 660 {
 661   try {
 662     (*simgrid_config)[key].setValue<std::string>(value);
 663     return;
 664   }
 665   TRANSLATE_EXCEPTIONS("Could not set variable %s to string %s", key, value);
 666 }
 667
 668 /** @brief Set or add a boolean value to \a name within \a cfg
 669  *
 670  * @param key the name of the variable
 671  * @param value the value of the variable
 672  */
 673 void xbt_cfg_set_boolean(const char *key, const char *value)
 674 {
 675   try {
 676     (*simgrid_config)[key].setValue<bool>(simgrid::config::parseBool(value));
 677     return;
 678   }
 679   TRANSLATE_EXCEPTIONS("Could not set variable %s to boolean %s", key, value);
 680 }
 681
 682
 683 /* Say if the value is the default value */
 684 int xbt_cfg_is_default_value(const char *key)
 685 {
 686   try {
 687     return (*simgrid_config)[key].isDefault() ? 1 : 0;
 688   }
 689   TRANSLATE_EXCEPTIONS("Could not get variable %s", key);
 690 }
 691
 692 /*----[ Getting ]---------------------------------------------------------*/
 693 /** @brief Retrieve an integer value of a variable (get a warning if not uniq)
 694  *
 695  * @param key the name of the variable
 696  *
 697  * Returns the first value from the config set under the given name.
 698  */
 699 int xbt_cfg_get_int(const char *key)
 700 {
 701   try {
 702     return (*simgrid_config)[key].getValue<int>();
 703   }
 704   TRANSLATE_EXCEPTIONS("Could not get variable %s", key);
 705 }
 706
 707 /** @brief Retrieve a double value of a variable (get a warning if not uniq)
 708  *
 709  * @param key the name of the variable
 710  *
 711  * Returns the first value from the config set under the given name.
 712  */
 713 double xbt_cfg_get_double(const char *key)
 714 {
 715   try {
 716     return (*simgrid_config)[key].getValue<double>();
 717   }
 718   TRANSLATE_EXCEPTIONS("Could not get variable %s", key);
 719 }
 720
 721 /** @brief Retrieve a string value of a variable (get a warning if not uniq)
 722  *
 723  * @param key the name of the variable
 724  *
 725  * Returns the first value from the config set under the given name.
 726  * If there is more than one value, it will issue a warning.
 727  * Returns nullptr if there is no value.
 728  *
 729  * \warning the returned value is the actual content of the config set
 730  */
 731 std::string xbt_cfg_get_string(const char* key)
 732 {
 733   try {
 734     return (*simgrid_config)[key].getValue<std::string>();
 735   }
 736   TRANSLATE_EXCEPTIONS("Could not get variable %s", key);
 737 }
 738
 739 /** @brief Retrieve a boolean value of a variable (get a warning if not uniq)
 740  *
 741  * @param key the name of the variable
 742  *
 743  * Returns the first value from the config set under the given name.
 744  * If there is more than one value, it will issue a warning.
 745  */
 746 int xbt_cfg_get_boolean(const char *key)
 747 {
 748   try {
 749     return (*simgrid_config)[key].getValue<bool>() ? 1 : 0;
 750   }
 751   TRANSLATE_EXCEPTIONS("Could not get variable %s", key);
 752 }
 753
 754 #ifdef SIMGRID_TEST
 755
 756 #include <string>
 757
 758 #include "xbt.h"
 759 #include "xbt/ex.h"
 760 #include <xbt/ex.hpp>
 761
 762 #include <xbt/config.hpp>
 763
 764 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_cfg);
 765
 766 XBT_TEST_SUITE("config", "Configuration support");
 767
 768 XBT_PUBLIC_DATA(xbt_cfg_t) simgrid_config;
 769
 770 static void make_set()
 771 {
 772   simgrid_config = nullptr;
 773   xbt_log_threshold_set(&_XBT_LOGV(xbt_cfg), xbt_log_priority_critical);
 774   xbt_cfg_register_int("speed", 0, nullptr, "");
 775   xbt_cfg_register_string("peername", "", nullptr, "");
 776   xbt_cfg_register_string("user", "", nullptr, "");
 777 }                               /* end_of_make_set */
 778
 779 XBT_TEST_UNIT("memuse", test_config_memuse, "Alloc and free a config set")
 780 {
 781   auto temp = simgrid_config;
 782   make_set();
 783   xbt_test_add("Alloc and free a config set");
 784   xbt_cfg_set_parse("peername:veloce user:bidule");
 785   xbt_cfg_free(&simgrid_config);
 786   simgrid_config = temp;
 787 }
 788
 789 XBT_TEST_UNIT("use", test_config_use, "Data retrieving tests")
 790 {
 791   auto temp = simgrid_config;
 792   make_set();
 793   xbt_test_add("Get a single value");
 794   {
 795     /* get_single_value */
 796     xbt_cfg_set_parse("peername:toto:42 speed:42");
 797     int ival = xbt_cfg_get_int("speed");
 798     if (ival != 42)
 799       xbt_test_fail("Speed value = %d, I expected 42", ival);
 800   }
 801
 802   xbt_test_add("Access to a non-existant entry");
 803   {
 804     try {
 805       xbt_cfg_set_parse("color:blue");
 806     } catch(xbt_ex& e) {
 807       if (e.category != not_found_error)
 808         xbt_test_exception(e);
 809     }
 810   }
 811   xbt_cfg_free(&simgrid_config);
 812   simgrid_config = temp;
 813 }
 814
 815 XBT_TEST_UNIT("c++flags", test_config_cxx_flags, "C++ flags")
 816 {
 817   auto temp = simgrid_config;
 818   make_set();
 819   xbt_test_add("C++ declaration of flags");
 820
 821   simgrid::config::Flag<int> int_flag("int", "", 0);
 822   simgrid::config::Flag<std::string> string_flag("string", "", "foo");
 823   simgrid::config::Flag<double> double_flag("double", "", 0.32);
 824   simgrid::config::Flag<bool> bool_flag1("bool1", "", false);
 825   simgrid::config::Flag<bool> bool_flag2("bool2", "", true);
 826
 827   xbt_test_add("Parse values");
 828   xbt_cfg_set_parse("int:42 string:bar double:8.0 bool1:true bool2:false");
 829   xbt_test_assert(int_flag == 42, "Check int flag");
 830   xbt_test_assert(string_flag == "bar", "Check string flag");
 831   xbt_test_assert(double_flag == 8.0, "Check double flag");
 832   xbt_test_assert(bool_flag1, "Check bool1 flag");
 833   xbt_test_assert(not bool_flag2, "Check bool2 flag");
 834
 835   xbt_cfg_free(&simgrid_config);
 836   simgrid_config = temp;
 837 }
 838
 839 #endif                          /* SIMGRID_TEST */