Logo AND Algorithmique Numérique Distribuée

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