1 /* Copyright (c) 2009-2018. The SimGrid Team. All rights reserved. */
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. */
6 /* sg_config: configuration infrastructure for the simulation world */
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"
19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_config, surf, "About the configuration of SimGrid");
21 /* 0: beginning of time (config cannot be changed yet)
22 * 1: initialized: cfg_set created (config can now be changed)
23 * 2: configured: command line parsed and config part of platform file was
24 * integrated also, platform construction ongoing or done.
25 * (Config cannot be changed anymore!)
27 int _sg_cfg_init_status = 0;
29 /* instruct the upper layer (simix or simdag) to exit as soon as possible */
30 bool _sg_cfg_exit_asap = false;
32 #define sg_cfg_exit_early() \
34 _sg_cfg_exit_asap = true; \
38 /* Parse the command line, looking for options */
39 static void sg_config_cmd_line(int *argc, char **argv)
45 for (j = i = 1; i < *argc; i++) {
46 if (not strncmp(argv[i], "--cfg=", strlen("--cfg="))) {
47 char *opt = strchr(argv[i], '=');
50 simgrid::config::set_parse(opt);
51 XBT_DEBUG("Did apply '%s' as config setting", opt);
52 } else if (not strcmp(argv[i], "--version")) {
53 printf("%s\n", SIMGRID_VERSION_STRING);
55 } else if (not strcmp(argv[i], "--cfg-help") || not strcmp(argv[i], "--help")) {
56 printf("Description of the configuration accepted by this simulator:\n");
57 simgrid::config::help();
60 "Each of these configurations can be used by adding\n"
61 " --cfg=<option name>:<option value>\n"
62 "to the command line.\n"
64 "For more information, please refer to:\n"
65 " --help-aliases for the list of all option aliases.\n"
66 " --help-logs and --help-log-categories for the details of logging output.\n"
67 " --help-models for a list of all models known by this simulator.\n"
68 " --help-tracing for the details of all tracing options known by this simulator.\n"
69 " --version to get SimGrid version information.\n"
73 } else if (not strcmp(argv[i], "--help-aliases")) {
74 printf("Here is a list of all deprecated option names, with their replacement.\n");
75 simgrid::config::show_aliases();
76 printf("Please consider using the recent names\n");
78 } else if (not strcmp(argv[i], "--help-models")) {
79 model_help("host", surf_host_model_description);
81 model_help("CPU", surf_cpu_model_description);
83 model_help("network", surf_network_model_description);
84 printf("\nLong description of all optimization levels accepted by the models of this simulator:\n");
85 for (int k = 0; surf_optimization_mode_description[k].name; k++)
87 surf_optimization_mode_description[k].name,
88 surf_optimization_mode_description[k].description);
89 printf("Both network and CPU models have 'Lazy' as default optimization level\n\n");
91 } else if (not strcmp(argv[i], "--help-tracing")) {
106 /* callback of the plugin variable */
107 static void _sg_cfg_cb__plugin(const std::string& value)
109 xbt_assert(_sg_cfg_init_status < 2, "Cannot load a plugin after the initialization");
114 if (value == "help") {
115 model_help("plugin", surf_plugin_description);
119 int plugin_id = find_model_description(surf_plugin_description, value);
120 surf_plugin_description[plugin_id].model_init_preparse();
123 /* callback of the host/model variable */
124 static void _sg_cfg_cb__host_model(const std::string& value)
126 xbt_assert(_sg_cfg_init_status < 2, "Cannot change the model after the initialization");
128 if (value == "help") {
129 model_help("host", surf_host_model_description);
133 /* Make sure that the model exists */
134 find_model_description(surf_host_model_description, value);
137 /* callback of the cpu/model variable */
138 static void _sg_cfg_cb__cpu_model(const std::string& value)
140 xbt_assert(_sg_cfg_init_status < 2, "Cannot change the model after the initialization");
142 if (value == "help") {
143 model_help("CPU", surf_cpu_model_description);
147 /* New Module missing */
148 find_model_description(surf_cpu_model_description, value);
151 /* callback of the cpu/model variable */
152 static void _sg_cfg_cb__optimization_mode(const std::string& value)
154 xbt_assert(_sg_cfg_init_status < 2, "Cannot change the model after the initialization");
156 if (value == "help") {
157 model_help("optimization", surf_optimization_mode_description);
161 /* New Module missing */
162 find_model_description(surf_optimization_mode_description, value);
165 /* callback of the cpu/model variable */
166 static void _sg_cfg_cb__storage_mode(const std::string& value)
168 xbt_assert(_sg_cfg_init_status < 2, "Cannot change the model after the initialization");
170 if (value == "help") {
171 model_help("storage", surf_storage_model_description);
175 find_model_description(surf_storage_model_description, value);
178 /* callback of the network_model variable */
179 static void _sg_cfg_cb__network_model(const std::string& value)
181 xbt_assert(_sg_cfg_init_status < 2, "Cannot change the model after the initialization");
183 if (value == "help") {
184 model_help("network", surf_network_model_description);
188 /* New Module missing */
189 find_model_description(surf_network_model_description, value);
192 static void _sg_cfg_cb_contexts_parallel_mode(const std::string& mode_name)
194 if (mode_name == "posix") {
195 SIMIX_context_set_parallel_mode(XBT_PARMAP_POSIX);
196 } else if (mode_name == "futex") {
197 SIMIX_context_set_parallel_mode(XBT_PARMAP_FUTEX);
198 } else if (mode_name == "busy_wait") {
199 SIMIX_context_set_parallel_mode(XBT_PARMAP_BUSY_WAIT);
201 xbt_die("Command line setting of the parallel synchronization mode should "
202 "be one of \"posix\", \"futex\" or \"busy_wait\"");
206 /* build description line with possible values */
207 static void describe_model(char *result,int resultsize,
208 const s_surf_model_description_t model_description[],
210 const char *description)
214 p += snprintf(result,resultsize-1, "%s. Possible values: %s", description,
215 model_description[0].name ? model_description[0].name : "n/a");
216 for (int i = 1; model_description[i].name; i++)
217 p += snprintf(p,resultsize-(p-result)-1, ", %s", model_description[i].name);
218 p += snprintf(p,resultsize-(p-result)-1, ".\n (use 'help' as a value to see the long description of each %s)", name);
220 xbt_assert(p<result+resultsize-1,"Buffer too small to display the model description of %s",name);
223 /* create the config set, register what should be and parse the command line*/
224 void sg_config_init(int *argc, char **argv)
226 const int descsize = 1024;
227 char description[descsize];
229 /* Create the configuration support */
230 if (_sg_cfg_init_status != 0) { /* Only create stuff if not already inited */
231 XBT_WARN("Call to sg_config_init() after initialization ignored");
235 /* Plugins configuration */
236 describe_model(description, descsize, surf_plugin_description, "plugin", "The plugins");
237 simgrid::config::declare_flag<std::string>("plugin", description, "", &_sg_cfg_cb__plugin);
239 describe_model(description, descsize, surf_cpu_model_description, "model", "The model to use for the CPU");
240 simgrid::config::declare_flag<std::string>("cpu/model", description, "Cas01", &_sg_cfg_cb__cpu_model);
242 describe_model(description, descsize, surf_storage_model_description, "model", "The model to use for the storage");
243 simgrid::config::declare_flag<std::string>("storage/model", description, "default", &_sg_cfg_cb__storage_mode);
245 describe_model(description, descsize, surf_network_model_description, "model", "The model to use for the network");
246 simgrid::config::declare_flag<std::string>("network/model", description, "LV08", &_sg_cfg_cb__network_model);
248 describe_model(description, descsize, surf_optimization_mode_description, "optimization mode",
249 "The optimization modes to use for the network");
250 simgrid::config::declare_flag<std::string>("network/optim", description, "Lazy", &_sg_cfg_cb__optimization_mode);
252 describe_model(description, descsize, surf_host_model_description, "model", "The model to use for the host");
253 simgrid::config::declare_flag<std::string>("host/model", description, "default", &_sg_cfg_cb__host_model);
255 simgrid::config::bind_flag(sg_surf_precision, "surf/precision",
256 "Numerical precision used when updating simulation times (in seconds)");
258 simgrid::config::bind_flag(sg_maxmin_precision, "maxmin/precision",
259 "Numerical precision used when computing resource sharing (in flops/sec or bytes/sec)");
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)");
265 /* The parameters of network models */
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)");
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)");
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)");
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);
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)",
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)",
297 simgrid::config::alias("network/maxmin-selective-update", {"network/maxmin_selective_update"});
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");
302 simgrid::config::declare_flag<int>("contexts/stack-size", "Stack size of contexts in KiB", 8 * 1024,
303 [](int value) { smx_context_stack_size = value * 1024; });
304 simgrid::config::alias("contexts/stack-size", {"contexts/stack_size"});
306 /* guard size for contexts stacks in memory pages */
307 #if defined(_WIN32) || (PTH_STACKGROWTH != -1)
308 int default_guard_size = 0;
310 int default_guard_size = 1;
312 simgrid::config::declare_flag<int>("contexts/guard-size", "Guard size for contexts stacks in memory pages",
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);
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"});
324 /* synchronization mode for parallel user contexts */
326 std::string default_synchro_mode = "futex";
327 #else //No futex on mac and posix is unimplememted yet
328 std::string default_synchro_mode = "busy_wait";
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);
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"});
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)",
352 simgrid::config::alias("smpi/IB-penalty-factors", {"smpi/IB_penalty_factors"});
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.",
358 simgrid::config::alias("smpi/host-speed", {"smpi/running_power", "smpi/running-power"});
360 simgrid::config::declare_flag<bool>("smpi/keep-temps", "Whether we should keep the generated temporary files.",
363 simgrid::config::declare_flag<bool>("smpi/display-timing", "Whether we should display the timing after simulation.",
365 simgrid::config::alias("smpi/display-timing", {"smpi/display_timing"});
367 simgrid::config::declare_flag<bool>(
368 "smpi/simulate-computation", "Whether the computational part of the simulated application should be simulated.",
370 simgrid::config::alias("smpi/simulate-computation", {"smpi/simulate_computation"});
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",
378 simgrid::config::declare_flag<std::string>("smpi/shared-malloc-hugepage",
379 "Path to a mounted hugetlbfs, to use huge pages with shared malloc.", "");
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"});
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"});
390 simgrid::config::declare_flag<bool>("smpi/trace-call-location",
391 "Should filename and linenumber of MPI calls be traced?", false);
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"});
399 const char* default_privatization = std::getenv("SMPI_PRIVATIZATION");
400 if (default_privatization == nullptr)
401 default_privatization = "no";
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"});
408 simgrid::config::declare_flag<bool>("smpi/grow-injected-times",
409 "Whether we want to make the injected time in MPI_Iprobe and MPI_Test grow, to "
410 "allow faster simulation. This can make simulation less precise, though.",
414 simgrid::config::declare_flag<std::string>("smpi/papi-events",
415 "This switch enables tracking the specified counters with PAPI", "");
417 simgrid::config::declare_flag<std::string>("smpi/comp-adjustment-file",
418 "A file containing speedups or slowdowns for some parts of the code.", "");
419 simgrid::config::declare_flag<std::string>(
420 "smpi/os", "Small messages timings (MPI_Send minimum time for small messages)", "0:0:0:0:0");
421 simgrid::config::declare_flag<std::string>(
422 "smpi/ois", "Small messages timings (MPI_Isend minimum time for small messages)", "0:0:0:0:0");
423 simgrid::config::declare_flag<std::string>(
424 "smpi/or", "Small messages timings (MPI_Recv minimum time for small messages)", "0:0:0:0:0");
426 simgrid::config::declare_flag<double>("smpi/iprobe-cpu-usage",
427 "Maximum usage of CPUs by MPI_Iprobe() calls. We've observed that MPI_Iprobes "
428 "consume significantly less power than the maximum of a specific application. "
429 "This value is then (Iprobe_Usage/Max_Application_Usage).",
432 simgrid::config::declare_flag<std::string>("smpi/coll-selector", "Which collective selector to use", "default");
433 simgrid::config::alias("smpi/coll-selector", {"smpi/coll_selector"});
434 simgrid::config::declare_flag<std::string>("smpi/gather", "Which collective to use for gather", "");
435 simgrid::config::declare_flag<std::string>("smpi/allgather", "Which collective to use for allgather", "");
436 simgrid::config::declare_flag<std::string>("smpi/barrier", "Which collective to use for barrier", "");
437 simgrid::config::declare_flag<std::string>("smpi/reduce_scatter", "Which collective to use for reduce_scatter", "");
438 simgrid::config::alias("smpi/reduce_scatter", {"smpi/reduce-scatter"});
439 simgrid::config::declare_flag<std::string>("smpi/scatter", "Which collective to use for scatter", "");
440 simgrid::config::declare_flag<std::string>("smpi/allgatherv", "Which collective to use for allgatherv", "");
441 simgrid::config::declare_flag<std::string>("smpi/allreduce", "Which collective to use for allreduce", "");
442 simgrid::config::declare_flag<std::string>("smpi/alltoall", "Which collective to use for alltoall", "");
443 simgrid::config::declare_flag<std::string>("smpi/alltoallv", "Which collective to use for alltoallv", "");
444 simgrid::config::declare_flag<std::string>("smpi/bcast", "Which collective to use for bcast", "");
445 simgrid::config::declare_flag<std::string>("smpi/reduce", "Which collective to use for reduce", "");
450 simgrid::config::declare_flag<bool>(
451 "exception/cutpath", "Whether to cut all path information from call traces, used e.g. in exceptions.", false);
453 extern bool _sg_do_clean_atexit;
454 simgrid::config::bind_flag(_sg_do_clean_atexit, "clean-atexit", {"clean_atexit"},
455 "Whether to cleanup SimGrid at exit. Disable it if your code segfaults after its end.");
457 if (surf_path.empty())
458 simgrid::config::set_default<std::string>("path", "./");
460 _sg_cfg_init_status = 1;
462 sg_config_cmd_line(argc, argv);
464 xbt_mallocator_initialization_is_done(SIMIX_context_is_parallel());
467 void sg_config_finalize()
469 if (not _sg_cfg_init_status)
470 return; /* Not initialized yet. Nothing to do */
472 simgrid::config::finalize();
473 _sg_cfg_init_status = 0;