src/xbt/config.cpp

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