Logo AND Algorithmique Numérique Distribuée

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