src/simgrid/sg_config.cpp

   1 /* Copyright (c) 2009-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 /* sg_config: configuration infrastructure for the simulation world         */
   7
   8 #include "simgrid/sg_config.hpp"
   9 #include "simgrid/instr.h"
  10 #include "src/instr/instr_private.hpp"
  11 #include "src/internal_config.h"
  12 #include "src/kernel/lmm/maxmin.hpp"
  13 #include "src/mc/mc_config.hpp"
  14 #include "src/mc/mc_replay.hpp"
  15 #include "src/surf/surf_interface.hpp"
  16 #include "surf/surf.hpp"
  17 #include "xbt/config.hpp"
  18
  19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_config, surf, "About the configuration of SimGrid");
  20
  21 static simgrid::config::Flag<bool> cfg_continue_after_help
  22   {"help-nostop", "Do not stop the execution when --help is found", false};
  23
  24 /** @brief Allow other libraries to react to the --help flag, too
  25  *
  26  * When finding --help on the command line, simgrid usually stops right after displaying its help message.
  27  * If you are writing a library using simgrid, you may want to display your own help message before everything stops.
  28  * If so, just call this function before having simgrid parsing the command line, and you will be given the control
  29  * even if the user is asking for help.
  30  */
  31 void sg_config_continue_after_help()
  32 {
  33   cfg_continue_after_help = true;
  34 }
  35
  36 /* 0: beginning of time (config cannot be changed yet)
  37  * 1: initialized: cfg_set created (config can now be changed)
  38  * 2: configured: command line parsed and config part of platform file was
  39  *    integrated also, platform construction ongoing or done.
  40  *    (Config cannot be changed anymore!)
  41  */
  42 int _sg_cfg_init_status = 0;
  43
  44 /* Parse the command line, looking for options */
  45 static void sg_config_cmd_line(int *argc, char **argv)
  46 {
  47   bool shall_exit = false;
  48   int i;
  49   int j;
  50   bool parse_args = true; // Stop parsing the parameters once we found '--'
  51
  52   for (j = i = 1; i < *argc; i++) {
  53     if (not strcmp("--", argv[i])) {
  54       parse_args = false;
  55       // Remove that '--' from the arguments
  56     } else if (parse_args && not strncmp(argv[i], "--cfg=", strlen("--cfg="))) {
  57       char *opt = strchr(argv[i], '=');
  58       opt++;
  59
  60       simgrid::config::set_parse(opt);
  61       XBT_DEBUG("Did apply '%s' as config setting", opt);
  62     } else if (parse_args && not strcmp(argv[i], "--version")) {
  63       sg_version();
  64       shall_exit = true;
  65     } else if (parse_args && (not strcmp(argv[i], "--cfg-help") || not strcmp(argv[i], "--help"))) {
  66       XBT_HELP("Description of the configuration accepted by this simulator:");
  67       simgrid::config::help();
  68       XBT_HELP("\n"
  69                "Each of these configurations can be used by adding\n"
  70                "    --cfg=<option name>:<option value>\n"
  71                "to the command line.\n"
  72                "\n"
  73                "For more information, please refer to:\n"
  74                "   --help-aliases for the list of all option aliases.\n"
  75                "   --help-logs and --help-log-categories for the details of logging output.\n"
  76                "   --help-models for a list of all models known by this simulator.\n"
  77                "   --help-tracing for the details of all tracing options known by this simulator.\n"
  78                "   --version to get SimGrid version information.\n");
  79       shall_exit = not cfg_continue_after_help;
  80       argv[j++]  = argv[i]; // Preserve the --help in argv just in case someone else wants to see it
  81     } else if (parse_args && not strcmp(argv[i], "--help-aliases")) {
  82       XBT_HELP("Here is a list of all deprecated option names, with their replacement.");
  83       simgrid::config::show_aliases();
  84       XBT_HELP("Please consider using the recent names");
  85       shall_exit = true;
  86     } else if (parse_args && not strcmp(argv[i], "--help-models")) {
  87       model_help("host", surf_host_model_description);
  88       XBT_HELP("%s", "");
  89       model_help("CPU", surf_cpu_model_description);
  90       XBT_HELP("%s", "");
  91       model_help("network", surf_network_model_description);
  92       XBT_HELP("\nLong description of all optimization levels accepted by the models of this simulator:");
  93       for (auto const& item : surf_optimization_mode_description)
  94         XBT_HELP("  %s: %s", item.name, item.description);
  95       XBT_HELP("Both network and CPU models have 'Lazy' as default optimization level\n");
  96       shall_exit = true;
  97     } else if (parse_args && not strcmp(argv[i], "--help-tracing")) {
  98       TRACE_help();
  99       shall_exit = true;
 100     } else {
 101       argv[j++] = argv[i];
 102     }
 103   }
 104   if (j < *argc) {
 105     argv[j] = nullptr;
 106     *argc = j;
 107   }
 108   if (shall_exit)
 109     exit(0);
 110 }
 111
 112 /* callback of the plugin variable */
 113 static void _sg_cfg_cb__plugin(const std::string& value)
 114 {
 115   xbt_assert(_sg_cfg_init_status < 2, "Cannot load a plugin after the initialization");
 116
 117   if (value.empty())
 118     return;
 119
 120   if (value == "help") {
 121     model_help("plugin", *surf_plugin_description);
 122     exit(0);
 123   }
 124
 125   int plugin_id = find_model_description(*surf_plugin_description, value);
 126   (*surf_plugin_description)[plugin_id].model_init_preparse();
 127 }
 128
 129 /* callback of the host/model variable */
 130 static void _sg_cfg_cb__host_model(const std::string& value)
 131 {
 132   xbt_assert(_sg_cfg_init_status < 2, "Cannot change the model after the initialization");
 133
 134   if (value == "help") {
 135     model_help("host", surf_host_model_description);
 136     exit(0);
 137   }
 138
 139   /* Make sure that the model exists */
 140   find_model_description(surf_host_model_description, value);
 141 }
 142
 143 /* callback of the cpu/model variable */
 144 static void _sg_cfg_cb__cpu_model(const std::string& value)
 145 {
 146   xbt_assert(_sg_cfg_init_status < 2, "Cannot change the model after the initialization");
 147
 148   if (value == "help") {
 149     model_help("CPU", surf_cpu_model_description);
 150     exit(0);
 151   }
 152
 153   /* New Module missing */
 154   find_model_description(surf_cpu_model_description, value);
 155 }
 156
 157 /* callback of the cpu/model variable */
 158 static void _sg_cfg_cb__optimization_mode(const std::string& value)
 159 {
 160   xbt_assert(_sg_cfg_init_status < 2, "Cannot change the model after the initialization");
 161
 162   if (value == "help") {
 163     model_help("optimization", surf_optimization_mode_description);
 164     exit(0);
 165   }
 166
 167   /* New Module missing */
 168   find_model_description(surf_optimization_mode_description, value);
 169 }
 170
 171 /* callback of the cpu/model variable */
 172 static void _sg_cfg_cb__storage_mode(const std::string& value)
 173 {
 174   xbt_assert(_sg_cfg_init_status < 2, "Cannot change the model after the initialization");
 175
 176   if (value == "help") {
 177     model_help("storage", surf_storage_model_description);
 178     exit(0);
 179   }
 180
 181   find_model_description(surf_storage_model_description, value);
 182 }
 183
 184 /* callback of the network_model variable */
 185 static void _sg_cfg_cb__network_model(const std::string& value)
 186 {
 187   xbt_assert(_sg_cfg_init_status < 2, "Cannot change the model after the initialization");
 188
 189   if (value == "help") {
 190     model_help("network", surf_network_model_description);
 191     exit(0);
 192   }
 193
 194   /* New Module missing */
 195   find_model_description(surf_network_model_description, value);
 196 }
 197
 198 static void _sg_cfg_cb_contexts_parallel_mode(const std::string& mode_name)
 199 {
 200   if (mode_name == "posix") {
 201     SIMIX_context_set_parallel_mode(XBT_PARMAP_POSIX);
 202   } else if (mode_name == "futex") {
 203     SIMIX_context_set_parallel_mode(XBT_PARMAP_FUTEX);
 204   } else if (mode_name == "busy_wait") {
 205     SIMIX_context_set_parallel_mode(XBT_PARMAP_BUSY_WAIT);
 206   } else {
 207     xbt_die("Command line setting of the parallel synchronization mode should "
 208             "be one of \"posix\", \"futex\" or \"busy_wait\"");
 209   }
 210 }
 211
 212 /* build description line with possible values */
 213 static void declare_model_flag(const std::string& name, const std::string& value,
 214                                const std::function<void(std::string const&)>& callback,
 215                                const std::vector<surf_model_description_t>& model_description, const std::string& type,
 216                                const std::string& descr)
 217 {
 218   std::string description = descr + ". Possible values: ";
 219   std::string sep         = "";
 220   for (auto const& item : model_description) {
 221     description += sep + item.name;
 222     sep = ", ";
 223   }
 224   description += ".\n       (use 'help' as a value to see the long description of each " + type + ")";
 225   simgrid::config::declare_flag<std::string>(name, description, value, callback);
 226 }
 227
 228 /* create the config set, register what should be and parse the command line*/
 229 void sg_config_init(int *argc, char **argv)
 230 {
 231   /* Create the configuration support */
 232   if (_sg_cfg_init_status != 0) { /* Only create stuff if not already inited */
 233     XBT_WARN("Call to sg_config_init() after initialization ignored");
 234     return;
 235   }
 236
 237   /* Plugins configuration */
 238   declare_model_flag("plugin", "", &_sg_cfg_cb__plugin, *surf_plugin_description, "plugin", "The plugins");
 239
 240   declare_model_flag("cpu/model", "Cas01", &_sg_cfg_cb__cpu_model, surf_cpu_model_description, "model",
 241                      "The model to use for the CPU");
 242
 243   declare_model_flag("storage/model", "default", &_sg_cfg_cb__storage_mode, surf_storage_model_description, "model",
 244                      "The model to use for the storage");
 245
 246   declare_model_flag("network/model", "LV08", &_sg_cfg_cb__network_model, surf_network_model_description, "model",
 247                      "The model to use for the network");
 248
 249   declare_model_flag("network/optim", "Lazy", &_sg_cfg_cb__optimization_mode, surf_optimization_mode_description,
 250                      "optimization mode", "The optimization modes to use for the network");
 251
 252   declare_model_flag("host/model", "default", &_sg_cfg_cb__host_model, surf_host_model_description, "model",
 253                      "The model to use for the host");
 254
 255   simgrid::config::bind_flag(sg_surf_precision, "surf/precision",
 256                              "Numerical precision used when updating simulation times (in seconds)");
 257
 258   simgrid::config::bind_flag(sg_maxmin_precision, "maxmin/precision",
 259                              "Numerical precision used when computing resource sharing (in flops/sec or bytes/sec)");
 260
 261   simgrid::config::bind_flag(sg_concurrency_limit, "maxmin/concurrency-limit", {"maxmin/concurrency_limit"},
 262                              "Maximum number of concurrent variables in the maxmim system. Also limits the number of "
 263                              "processes on each host, at higher level. (default: -1 means no such limitation)");
 264
 265   /* The parameters of network models */
 266
 267   sg_latency_factor = 13.01; // comes from the default LV08 network model
 268   simgrid::config::bind_flag(sg_latency_factor, "network/latency-factor", {"network/latency_factor"},
 269                              "Correction factor to apply to the provided latency (default value set by network model)");
 270
 271   sg_bandwidth_factor = 0.97; // comes from the default LV08 network model
 272   simgrid::config::bind_flag(
 273       sg_bandwidth_factor, "network/bandwidth-factor", {"network/bandwidth_factor"},
 274       "Correction factor to apply to the provided bandwidth (default value set by network model)");
 275
 276   sg_weight_S_parameter = 20537; // comes from the default LV08 network model
 277   simgrid::config::bind_flag(
 278       sg_weight_S_parameter, "network/weight-S", {"network/weight_S"},
 279       "Correction factor to apply to the weight of competing streams (default value set by network model)");
 280
 281   /* Inclusion path */
 282   simgrid::config::declare_flag<std::string>("path", "Lookup path for inclusions in platform and deployment XML files",
 283                                              "", [](std::string const& path) {
 284                                                if (not path.empty())
 285                                                  surf_path.push_back(path);
 286                                              });
 287
 288   simgrid::config::declare_flag<bool>("cpu/maxmin-selective-update",
 289                                       "Update the constraint set propagating recursively to others constraints "
 290                                       "(off by default unless optim is set to lazy)",
 291                                       "no");
 292   simgrid::config::alias("cpu/maxmin-selective-update", {"cpu/maxmin_selective_update"});
 293   simgrid::config::declare_flag<bool>("network/maxmin-selective-update", "Update the constraint set propagating "
 294                                                                          "recursively to others constraints (off by "
 295                                                                          "default unless optim is set to lazy)",
 296                                       "no");
 297   simgrid::config::alias("network/maxmin-selective-update", {"network/maxmin_selective_update"});
 298
 299   extern bool _sg_do_verbose_exit;
 300   simgrid::config::bind_flag(_sg_do_verbose_exit, "verbose-exit", "Activate the \"do nothing\" mode in Ctrl-C");
 301
 302   simgrid::config::declare_flag<int>("contexts/stack-size", "Stack size of contexts in KiB (not with threads)",
 303                                      8 * 1024, [](int value) { smx_context_stack_size = value * 1024; });
 304   simgrid::config::alias("contexts/stack-size", {"contexts/stack_size"});
 305
 306   /* guard size for contexts stacks in memory pages */
 307 #if defined(_WIN32) || (PTH_STACKGROWTH != -1)
 308   int default_guard_size = 0;
 309 #else
 310   int default_guard_size = 1;
 311 #endif
 312   simgrid::config::declare_flag<int>("contexts/guard-size", "Guard size for contexts stacks in memory pages",
 313                                      default_guard_size,
 314                                      [](int value) { smx_context_guard_size = value * xbt_pagesize; });
 315   simgrid::config::alias("contexts/guard-size", {"contexts/guard_size"});
 316   simgrid::config::declare_flag<int>("contexts/nthreads", "Number of parallel threads used to execute user contexts", 1,
 317                                      &SIMIX_context_set_nthreads);
 318
 319   simgrid::config::declare_flag<int>("contexts/parallel-threshold",
 320                                      "Minimal number of user contexts to be run in parallel (raw contexts only)", 2,
 321                                      &SIMIX_context_set_parallel_threshold);
 322   simgrid::config::alias("contexts/parallel-threshold", {"contexts/parallel_threshold"});
 323
 324   /* synchronization mode for parallel user contexts */
 325 #if HAVE_FUTEX_H
 326   std::string default_synchro_mode = "futex";
 327 #else // No futex on mac and posix is unimplemented yet
 328   std::string default_synchro_mode = "busy_wait";
 329 #endif
 330   simgrid::config::declare_flag<std::string>("contexts/synchro", "Synchronization mode to use when running contexts in "
 331                                                                  "parallel (either futex, posix or busy_wait)",
 332                                              default_synchro_mode, &_sg_cfg_cb_contexts_parallel_mode);
 333
 334   // For smpi/bw-factor and smpi/lat-factor
 335   // SMPI model can be used without enable_smpi, so keep this out of the ifdef.
 336   simgrid::config::declare_flag<std::string>("smpi/bw-factor",
 337                                              "Bandwidth factors for smpi. Format: "
 338                                              "'threshold0:value0;threshold1:value1;...;thresholdN:valueN', "
 339                                              "meaning if(size >=thresholdN ) return valueN.",
 340                                              "65472:0.940694;15424:0.697866;9376:0.58729;5776:1.08739;3484:0.77493;"
 341                                              "1426:0.608902;732:0.341987;257:0.338112;0:0.812084");
 342   simgrid::config::alias("smpi/bw-factor", {"smpi/bw_factor"});
 343
 344   simgrid::config::declare_flag<std::string>("smpi/lat-factor", "Latency factors for smpi.",
 345                                              "65472:11.6436;15424:3.48845;9376:2.59299;5776:2.18796;3484:1.88101;"
 346                                              "1426:1.61075;732:1.9503;257:1.95341;0:2.01467");
 347   simgrid::config::alias("smpi/lat-factor", {"smpi/lat_factor"});
 348   simgrid::config::declare_flag<std::string>("smpi/IB-penalty-factors",
 349                                              "Correction factor to communications using Infiniband model with "
 350                                              "contention (default value based on Stampede cluster profiling)",
 351                                              "0.965;0.925;1.35");
 352   simgrid::config::alias("smpi/IB-penalty-factors", {"smpi/IB_penalty_factors"});
 353
 354 #if HAVE_SMPI
 355   simgrid::config::declare_flag<double>("smpi/host-speed", "Speed of the host running the simulation (in flop/s). "
 356                                                            "Used to bench the operations.",
 357                                         20000.0);
 358   simgrid::config::alias("smpi/host-speed", {"smpi/running_power", "smpi/running-power"});
 359
 360   simgrid::config::declare_flag<bool>("smpi/keep-temps", "Whether we should keep the generated temporary files.",
 361                                       false);
 362
 363   simgrid::config::declare_flag<bool>("smpi/display-timing", "Whether we should display the timing after simulation.",
 364                                       false);
 365   simgrid::config::alias("smpi/display-timing", {"smpi/display_timing"});
 366
 367   simgrid::config::declare_flag<bool>(
 368       "smpi/simulate-computation", "Whether the computational part of the simulated application should be simulated.",
 369       true);
 370   simgrid::config::alias("smpi/simulate-computation", {"smpi/simulate_computation"});
 371
 372   simgrid::config::declare_flag<std::string>(
 373       "smpi/shared-malloc", "Whether SMPI_SHARED_MALLOC is enabled. Disable it for debugging purposes.", "global");
 374   simgrid::config::alias("smpi/shared-malloc", {"smpi/use_shared_malloc", "smpi/use-shared-malloc"});
 375   simgrid::config::declare_flag<double>("smpi/shared-malloc-blocksize",
 376                                         "Size of the bogus file which will be created for global shared allocations",
 377                                         1UL << 20);
 378   simgrid::config::declare_flag<std::string>("smpi/shared-malloc-hugepage",
 379                                              "Path to a mounted hugetlbfs, to use huge pages with shared malloc.", "");
 380
 381   simgrid::config::declare_flag<double>(
 382       "smpi/cpu-threshold", "Minimal computation time (in seconds) not discarded, or -1 for infinity.", 1e-6);
 383   simgrid::config::alias("smpi/cpu-threshold", {"smpi/cpu_threshold"});
 384
 385   simgrid::config::declare_flag<int>(
 386       "smpi/async-small-thresh",
 387       "Maximal size of messages that are to be sent asynchronously, without waiting for the receiver", 0);
 388   simgrid::config::alias("smpi/async-small-thresh", {"smpi/async_small_thres", "smpi/async_small_thresh"});
 389
 390   simgrid::config::declare_flag<bool>("smpi/trace-call-location",
 391                                       "Should filename and linenumber of MPI calls be traced?", false);
 392
 393   simgrid::config::declare_flag<int>(
 394       "smpi/send-is-detached-thresh",
 395       "Threshold of message size where MPI_Send stops behaving like MPI_Isend and becomes MPI_Ssend", 65536);
 396   simgrid::config::alias("smpi/send-is-detached-thresh",
 397                          {"smpi/send_is_detached_thres", "smpi/send_is_detached_thresh"});
 398
 399   const char* default_privatization = std::getenv("SMPI_PRIVATIZATION");
 400   if (default_privatization == nullptr)
 401     default_privatization = "no";
 402
 403   simgrid::config::declare_flag<std::string>(
 404       "smpi/privatization", "How we should privatize global variable at runtime (no, yes, mmap, dlopen).",
 405       default_privatization);
 406   simgrid::config::alias("smpi/privatization", {"smpi/privatize_global_variables", "smpi/privatize-global-variables"});
 407
 408   simgrid::config::declare_flag<std::string>(
 409       "smpi/privatize-libs", "Add libraries (; separated) to privatize (libgfortran for example). You need to provide the full names of the files (libgfortran.so.4), or its full path", "");
 410
 411   simgrid::config::declare_flag<bool>("smpi/grow-injected-times",
 412                                       "Whether we want to make the injected time in MPI_Iprobe and MPI_Test grow, to "
 413                                       "allow faster simulation. This can make simulation less precise, though.",
 414                                       true);
 415
 416 #if HAVE_PAPI
 417   simgrid::config::declare_flag<std::string>("smpi/papi-events",
 418                                              "This switch enables tracking the specified counters with PAPI", "");
 419 #endif
 420   simgrid::config::declare_flag<std::string>("smpi/comp-adjustment-file",
 421                                              "A file containing speedups or slowdowns for some parts of the code.", "");
 422   simgrid::config::declare_flag<std::string>(
 423       "smpi/os", "Small messages timings (MPI_Send minimum time for small messages)", "0:0:0:0:0");
 424   simgrid::config::declare_flag<std::string>(
 425       "smpi/ois", "Small messages timings (MPI_Isend minimum time for small messages)", "0:0:0:0:0");
 426   simgrid::config::declare_flag<std::string>(
 427       "smpi/or", "Small messages timings (MPI_Recv minimum time for small messages)", "0:0:0:0:0");
 428
 429   simgrid::config::declare_flag<double>("smpi/iprobe-cpu-usage",
 430                                         "Maximum usage of CPUs by MPI_Iprobe() calls. We've observed that MPI_Iprobes "
 431                                         "consume significantly less power than the maximum of a specific application. "
 432                                         "This value is then (Iprobe_Usage/Max_Application_Usage).",
 433                                         1.0);
 434
 435   simgrid::config::declare_flag<std::string>("smpi/coll-selector", "Which collective selector to use", "default");
 436   simgrid::config::alias("smpi/coll-selector", {"smpi/coll_selector"});
 437   simgrid::config::declare_flag<std::string>("smpi/gather", "Which collective to use for gather", "");
 438   simgrid::config::declare_flag<std::string>("smpi/allgather", "Which collective to use for allgather", "");
 439   simgrid::config::declare_flag<std::string>("smpi/barrier", "Which collective to use for barrier", "");
 440   simgrid::config::declare_flag<std::string>("smpi/reduce_scatter", "Which collective to use for reduce_scatter", "");
 441   simgrid::config::alias("smpi/reduce_scatter", {"smpi/reduce-scatter"});
 442   simgrid::config::declare_flag<std::string>("smpi/scatter", "Which collective to use for scatter", "");
 443   simgrid::config::declare_flag<std::string>("smpi/allgatherv", "Which collective to use for allgatherv", "");
 444   simgrid::config::declare_flag<std::string>("smpi/allreduce", "Which collective to use for allreduce", "");
 445   simgrid::config::declare_flag<std::string>("smpi/alltoall", "Which collective to use for alltoall", "");
 446   simgrid::config::declare_flag<std::string>("smpi/alltoallv", "Which collective to use for alltoallv", "");
 447   simgrid::config::declare_flag<std::string>("smpi/bcast", "Which collective to use for bcast", "");
 448   simgrid::config::declare_flag<std::string>("smpi/reduce", "Which collective to use for reduce", "");
 449 #endif // HAVE_SMPI
 450
 451   /* Others */
 452
 453   simgrid::config::declare_flag<bool>(
 454       "exception/cutpath", "Whether to cut all path information from call traces, used e.g. in exceptions.", false);
 455
 456   extern bool _sg_do_clean_atexit;
 457   simgrid::config::bind_flag(_sg_do_clean_atexit, "clean-atexit", {"clean_atexit"},
 458                              "Whether to cleanup SimGrid at exit. Disable it if your code segfaults after its end.");
 459
 460   if (surf_path.empty())
 461     simgrid::config::set_default<std::string>("path", "./");
 462
 463   _sg_cfg_init_status = 1;
 464
 465   sg_config_cmd_line(argc, argv);
 466
 467   xbt_mallocator_initialization_is_done(SIMIX_context_is_parallel());
 468 }
 469
 470 void sg_config_finalize()
 471 {
 472   simgrid::config::finalize();
 473   _sg_cfg_init_status = 0;
 474 }