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