src/simgrid/sg_config.cpp

   1 /* Copyright (c) 2009-2023. 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 /* sg_config: configuration infrastructure for the simulation world         */
   7
   8 #include <simgrid/instr.h>
   9 #include <simgrid/version.h>
  10 #include <xbt/config.hpp>
  11 #include <xbt/file.hpp>
  12
  13 #include "simgrid/sg_config.hpp"
  14 #include "src/include/xbt/mmalloc.h"
  15 #include "src/instr/instr_private.hpp"
  16 #include "src/internal_config.h"
  17 #include "src/kernel/context/Context.hpp"
  18 #include "src/kernel/lmm/maxmin.hpp"
  19 #include "src/kernel/resource/NetworkModel.hpp"
  20 #include "src/mc/mc_config.hpp"
  21 #include "src/mc/mc_replay.hpp"
  22 #include "src/simgrid/module.hpp"
  23 #include "src/smpi/include/smpi_config.hpp"
  24 #include "src/surf/surf_interface.hpp"
  25
  26 #include <string_view>
  27
  28 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(config, kernel, "About the configuration of SimGrid");
  29
  30 static simgrid::config::Flag<bool> cfg_continue_after_help
  31   {"help-nostop", "Do not stop the execution when --help is found", false};
  32
  33 /** @brief Allow other libraries to react to the --help flag, too
  34  *
  35  * When finding --help on the command line, simgrid usually stops right after displaying its help message.
  36  * If you are writing a library using simgrid, you may want to display your own help message before everything stops.
  37  * If so, just call this function before having simgrid parsing the command line, and you will be given the control
  38  * even if the user is asking for help.
  39  */
  40 void sg_config_continue_after_help()
  41 {
  42   cfg_continue_after_help = true;
  43 }
  44
  45 /* 0: beginning of time (config cannot be changed yet)
  46  * 1: initialized: cfg_set created (config can now be changed)
  47  * 2: configured: command line parsed and config part of platform file was
  48  *    integrated also, platform construction ongoing or done.
  49  *    (Config cannot be changed anymore!)
  50  */
  51 int _sg_cfg_init_status = 0;
  52
  53 /* Parse the command line, looking for options */
  54 static void sg_config_cmd_line(int *argc, char **argv)
  55 {
  56   bool shall_exit = false;
  57   bool parse_args = true; // Stop parsing the parameters once we found '--'
  58
  59   int j = 1;
  60   for (int i = j; i < *argc; i++) {
  61     if (not strcmp("--", argv[i])) {
  62       parse_args = false;
  63       // Remove that '--' from the arguments
  64     } else if (parse_args && not strncmp(argv[i], "--cfg=", strlen("--cfg="))) {
  65       char *opt = strchr(argv[i], '=');
  66       opt++;
  67
  68       simgrid::config::set_parse(opt);
  69       XBT_DEBUG("Did apply '%s' as config setting", opt);
  70     } else if (parse_args && not strcmp(argv[i], "--version")) {
  71       sg_version();
  72       shall_exit = true;
  73     } else if (parse_args && (not strcmp(argv[i], "--cfg-help") || not strcmp(argv[i], "--help"))) {
  74       XBT_HELP("Description of the configuration accepted by this simulator:");
  75       simgrid::config::help();
  76       XBT_HELP("\n"
  77                "Each of these configurations can be used by adding\n"
  78                "    --cfg=<option name>:<option value>\n"
  79                "to the command line. Try passing \"help\" as a value\n"
  80                "to get the list of values accepted by a given option.\n"
  81                "For example, \"--cfg=plugin:help\" gives you the list of\n"
  82                "plugins available in your installation of SimGrid.\n"
  83                "\n"
  84                "For more information, please refer to:\n"
  85                "   --help-aliases for the list of all option aliases.\n"
  86                "   --help-logs and --help-log-categories for the details of logging output.\n"
  87                "   --help-models for a list of all models known by this simulator.\n"
  88                "   --help-tracing for the details of all tracing options known by this simulator.\n"
  89                "   --version to get SimGrid version information.\n");
  90       shall_exit = not cfg_continue_after_help;
  91       argv[j++]  = argv[i]; // Preserve the --help in argv just in case someone else wants to see it
  92     } else if (parse_args && not strcmp(argv[i], "--help-aliases")) {
  93       XBT_HELP("Here is a list of all deprecated option names, with their replacement.");
  94       simgrid::config::show_aliases();
  95       XBT_HELP("Please consider using the recent names");
  96       shall_exit = true;
  97     } else if (parse_args && not strcmp(argv[i], "--help-models")) {
  98       surf_host_model_description.help();
  99       XBT_HELP("%s", "");
 100       simgrid_cpu_models().help();
 101       XBT_HELP("%s", "");
 102       simgrid_network_models().help();
 103       XBT_HELP("\nLong description of all optimization levels accepted by the models of this simulator:");
 104       surf_optimization_mode_description.help();
 105       XBT_HELP("Both network and CPU models have 'Lazy' as default optimization level\n");
 106       shall_exit = true;
 107     } else if (parse_args && not strcmp(argv[i], "--help-tracing")) {
 108       TRACE_help();
 109       shall_exit = true;
 110     } else {
 111       argv[j++] = argv[i];
 112     }
 113   }
 114   if (j < *argc) {
 115     argv[j] = nullptr;
 116     *argc = j;
 117   }
 118   if (shall_exit)
 119     exit(0);
 120 }
 121
 122 /* callback of the host/model variable */
 123 static void _sg_cfg_cb__host_model(const std::string& value)
 124 {
 125   xbt_assert(_sg_cfg_init_status < 2, "Cannot change the model after the initialization");
 126
 127   if (value == "help") {
 128     surf_host_model_description.help();
 129     exit(0);
 130   }
 131
 132   /* Make sure that the model exists */
 133   surf_host_model_description.by_name(value);
 134 }
 135
 136 /* callback of the cpu/model variable */
 137 static void _sg_cfg_cb__optimization_mode(const std::string& value)
 138 {
 139   xbt_assert(_sg_cfg_init_status < 2, "Cannot change the model after the initialization");
 140
 141   if (value == "help") {
 142     surf_optimization_mode_description.help();
 143     exit(0);
 144   }
 145
 146   /* Make sure that the model exists */
 147   surf_optimization_mode_description.by_name(value);
 148 }
 149
 150 static void _sg_cfg_cb__disk_model(const std::string& value)
 151 {
 152   xbt_assert(_sg_cfg_init_status < 2, "Cannot change the model after the initialization");
 153
 154   if (value == "help") {
 155     surf_disk_model_description.help();
 156     exit(0);
 157   }
 158
 159   surf_disk_model_description.by_name(value);
 160 }
 161
 162 static void _sg_cfg_cb_contexts_parallel_mode(std::string_view mode_name)
 163 {
 164   if (mode_name == "posix") {
 165     simgrid::kernel::context::Context::parallel_mode = XBT_PARMAP_POSIX;
 166   } else if (mode_name == "futex") {
 167     simgrid::kernel::context::Context::parallel_mode = XBT_PARMAP_FUTEX;
 168   } else if (mode_name == "busy_wait") {
 169     simgrid::kernel::context::Context::parallel_mode = XBT_PARMAP_BUSY_WAIT;
 170   } else {
 171     xbt_die("Command line setting of the parallel synchronization mode should "
 172             "be one of \"posix\", \"futex\" or \"busy_wait\"");
 173   }
 174 }
 175
 176 /* build description line with possible values */
 177 static void declare_model_flag(const std::string& name, const std::string& value,
 178                                const std::function<void(std::string const&)>& callback,
 179                                const simgrid::ModuleGroup& model_description, const std::string& descr)
 180 {
 181   std::string description = descr + ". Possible values (other compilation flags may activate more " +
 182                             model_description.get_kind() + "s): " + model_description.existing_values();
 183   description += ".\n       (use 'help' as a value to see the long description of each one)";
 184   simgrid::config::declare_flag<std::string>(name, description, value, callback);
 185 }
 186
 187 /* create the config set, register what should be and parse the command line*/
 188 void sg_config_init(int *argc, char **argv)
 189 {
 190   /* Create the configuration support */
 191   if (_sg_cfg_init_status != 0) { /* Only create stuff if not already inited */
 192     XBT_WARN("Call to sg_config_init() after initialization ignored");
 193     return;
 194   }
 195
 196   /* Plugins configuration */
 197   simgrid_plugins().create_flag("plugin", "The plugins", "", true);
 198   simgrid_cpu_models().create_flag("cpu/model", "The model to use for the CPU", "Cas01", false);
 199   simgrid_network_models().create_flag("network/model", "The model to use for the network", "LV08", false);
 200   simgrid_create_models(); // KILL ME
 201
 202   declare_model_flag("disk/model", "S19", &_sg_cfg_cb__disk_model, surf_disk_model_description,
 203                      "The model to use for the disk");
 204
 205   declare_model_flag("network/optim", "Lazy", &_sg_cfg_cb__optimization_mode, surf_optimization_mode_description,
 206                      "The optimization modes to use for the network");
 207
 208   declare_model_flag("host/model", "default", &_sg_cfg_cb__host_model, surf_host_model_description,
 209                      "The model to use for the host");
 210
 211   simgrid::config::bind_flag(sg_surf_precision, "surf/precision",
 212                              "Numerical precision used when updating simulation times (in seconds)");
 213
 214   simgrid::config::bind_flag(sg_maxmin_precision, "maxmin/precision",
 215                              "Numerical precision used when computing resource sharing (in flops/sec or bytes/sec)");
 216
 217   simgrid::config::bind_flag(sg_concurrency_limit, "maxmin/concurrency-limit",
 218                              "Maximum number of concurrent variables in the maxmim system. Also limits the number of "
 219                              "processes on each host, at higher level. (default: -1 means no such limitation)");
 220
 221   /* The parameters of network models */
 222   static simgrid::config::Flag<double> _sg_network_loopback_latency{
 223       "network/loopback-lat",
 224       "For network models with an implicit loopback link (L07, CM02, LV08), "
 225       "latency of the loopback link. 0 by default",
 226       0.0};
 227
 228   static simgrid::config::Flag<double> _sg_network_loopback_bandwidth{
 229       "network/loopback-bw",
 230       "For network models with an implicit loopback link (L07, CM02, LV08), "
 231       "bandwidth of the loopback link. 10GBps by default",
 232       10e9};
 233
 234   /* Inclusion path */
 235   static simgrid::config::Flag<std::string> cfg_path{
 236       "path", "Lookup path for inclusions in platform and deployment XML files", "./", [](std::string const& path) {
 237         if (not path.empty())
 238           simgrid::xbt::path_push(path);
 239       }};
 240
 241   static simgrid::config::Flag<bool> cfg_cpu_maxmin_selective_update{
 242       "cpu/maxmin-selective-update",
 243       "Update the constraint set propagating recursively to others constraints "
 244       "(off by default unless optim is set to lazy)",
 245       false};
 246   static simgrid::config::Flag<bool> cfg_network_maxmin_selective_update{"network/maxmin-selective-update",
 247                                                                          "Update the constraint set propagating "
 248                                                                          "recursively to others constraints (off by "
 249                                                                          "default unless optim is set to lazy)",
 250                                                                          false};
 251
 252   static simgrid::config::Flag<int> cfg_context_stack_size{
 253       "contexts/stack-size", "Stack size of contexts in KiB (not with threads)", 8 * 1024,
 254       [](int value) { simgrid::kernel::context::Context::stack_size = value * 1024; }};
 255
 256   /* guard size for contexts stacks in memory pages */
 257 #if (PTH_STACKGROWTH != -1)
 258   int default_guard_size = 0;
 259 #else
 260   int default_guard_size = 1;
 261 #endif
 262   static simgrid::config::Flag<int> cfg_context_guard_size{
 263       "contexts/guard-size", "Guard size for contexts stacks in memory pages", default_guard_size,
 264       [](int value) { simgrid::kernel::context::Context::guard_size = value * xbt_pagesize; }};
 265
 266   static simgrid::config::Flag<int> cfg_context_nthreads{
 267       "contexts/nthreads", "Number of parallel threads used to execute user contexts", 1, [](int nthreads) {
 268 #if HAVE_MMALLOC
 269         xbt_assert(
 270             nthreads == 1 || not malloc_use_mmalloc(),
 271             "Parallel simulation is forbidden in the verified program, as there is no protection against race "
 272             "conditions in mmalloc itself. Please don't be so greedy and show some mercy for our implementation.");
 273 #endif
 274         simgrid::kernel::context::Context::set_nthreads(nthreads);
 275       }};
 276
 277   /* synchronization mode for parallel user contexts */
 278 #if HAVE_FUTEX_H
 279   std::string default_synchro_mode = "futex";
 280 #else // No futex on mac and posix is unimplemented yet
 281   std::string default_synchro_mode = "busy_wait";
 282 #endif
 283   static simgrid::config::Flag<std::string> cfg_context_synchro{"contexts/synchro",
 284                                                                 "Synchronization mode to use when running contexts in "
 285                                                                 "parallel (either futex, posix or busy_wait)",
 286                                                                 default_synchro_mode,
 287                                                                 &_sg_cfg_cb_contexts_parallel_mode};
 288
 289   // SMPI model can be used without enable_smpi, so keep this out of the ifdef.
 290   static simgrid::config::Flag<std::string> cfg_smpi_IB_penalty_factors{
 291       "smpi/IB-penalty-factors",
 292       "Correction factor to communications using Infiniband model with "
 293       "contention (default value based on Stampede cluster profiling)",
 294       "0.965;0.925;1.35"};
 295   /* Others */
 296
 297   static simgrid::config::Flag<bool> cfg_execution_cutpath{
 298       "exception/cutpath", "Whether to cut all path information from call traces, used e.g. in exceptions.", false};
 299
 300   _sg_cfg_init_status = 1;
 301
 302   sg_config_cmd_line(argc, argv);
 303
 304   xbt_mallocator_initialization_is_done(simgrid::kernel::context::Context::is_parallel());
 305 }
 306
 307 void sg_config_finalize()
 308 {
 309   simgrid::config::finalize();
 310   _sg_cfg_init_status = 0;
 311 }