1 /* Copyright (c) 2009-2010, 2012-2015. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 /* sg_config: configuration infrastructure for the simulation world */
10 #include "xbt/config.h"
12 #include "xbt/mallocator.h"
15 #include "xbt/sysdep.h"
16 #include "surf/surf.h"
17 #include "surf/maxmin.h"
18 #include "instr/instr_interface.h"
19 #include "simgrid/simix.h"
20 #include "simgrid/sg_config.h"
21 #include "simgrid_config.h" /* what was compiled in? */
23 #include "smpi/smpi_interface.h"
26 #include "simgrid/instr.h"
27 #include "src/mc/mc_replay.h"
29 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_config, surf, "About the configuration of SimGrid");
31 xbt_cfg_t _sg_cfg_set = NULL;
33 /* 0: beginning of time (config cannot be changed yet);
34 * 1: initialized: cfg_set created (config can now be changed);
35 * 2: configured: command line parsed and config part of platform file was
36 * integrated also, platform construction ongoing or done.
37 * (Config cannot be changed anymore!)
39 int _sg_cfg_init_status = 0;
41 /* instruct the upper layer (simix or simdag) to exit as soon as possible */
42 int _sg_cfg_exit_asap = 0;
44 #define sg_cfg_exit_early() do { _sg_cfg_exit_asap = 1; return; } while (0)
46 /* Parse the command line, looking for options */
47 static void sg_config_cmd_line(int *argc, char **argv)
53 for (j = i = 1; i < *argc; i++) {
54 if (!strncmp(argv[i], "--cfg=", strlen("--cfg="))) {
55 opt = strchr(argv[i], '=');
58 xbt_cfg_set_parse(_sg_cfg_set, opt);
59 XBT_DEBUG("Did apply '%s' as config setting", opt);
60 } else if (!strcmp(argv[i], "--version")) {
61 printf("%s\n", SIMGRID_VERSION_STRING);
63 } else if (!strcmp(argv[i], "--cfg-help") || !strcmp(argv[i], "--help")) {
64 printf("Description of the configuration accepted by this simulator:\n");
65 xbt_cfg_help(_sg_cfg_set);
68 "Each of these configurations can be used by adding\n"
69 " --cfg=<option name>:<option value>\n"
70 "to the command line.\n"
72 "For more information, please refer to:\n"
73 " --help-aliases for the list of all option aliases.\n"
74 " --help-logs and --help-log-categories for the details of logging output.\n"
75 " --help-models for a list of all models known by this simulator.\n"
76 " --help-tracing for the details of all tracing options known by this simulator.\n"
77 " --version to get SimGrid version information.\n"
81 } else if (!strcmp(argv[i], "--help-aliases")) {
82 printf("Here is a list of all deprecated option names, with their replacement.\n");
83 xbt_cfg_aliases(_sg_cfg_set);
84 printf("Please consider using the recent names\n");
86 } else if (!strcmp(argv[i], "--help-models")) {
89 model_help("host", surf_host_model_description);
91 model_help("CPU", surf_cpu_model_description);
93 model_help("network", surf_network_model_description);
94 printf("\nLong description of all optimization levels accepted by the models of this simulator:\n");
95 for (k = 0; surf_optimization_mode_description[k].name; k++)
97 surf_optimization_mode_description[k].name,
98 surf_optimization_mode_description[k].description);
99 printf("Both network and CPU models have 'Lazy' as default optimization level\n\n");
101 } else if (!strcmp(argv[i], "--help-tracing")) {
116 /* callback of the plugin variable */
117 static void _sg_cfg_cb__plugin(const char *name, int pos)
122 xbt_assert(_sg_cfg_init_status < 2,
123 "Cannot load a plugin after the initialization");
125 val = xbt_cfg_get_string(_sg_cfg_set, name);
127 if (!strcmp(val, "help")) {
128 model_help("plugin", surf_plugin_description);
132 /* New Module missing */
133 int plugin_id = find_model_description(surf_plugin_description, val);
134 surf_plugin_description[plugin_id].model_init_preparse();
137 /* callback of the host/model variable */
138 static void _sg_cfg_cb__host_model(const char *name, int pos)
142 xbt_assert(_sg_cfg_init_status < 2,
143 "Cannot change the model after the initialization");
145 val = xbt_cfg_get_string(_sg_cfg_set, name);
147 if (!strcmp(val, "help")) {
148 model_help("host", surf_host_model_description);
152 /* Make sure that the model exists */
153 find_model_description(surf_host_model_description, val);
156 /* callback of the vm/model variable */
157 static void _sg_cfg_cb__vm_model(const char *name, int pos)
161 xbt_assert(_sg_cfg_init_status < 2,
162 "Cannot change the model after the initialization");
164 val = xbt_cfg_get_string(_sg_cfg_set, name);
166 if (!strcmp(val, "help")) {
167 model_help("vm", surf_vm_model_description);
171 /* Make sure that the model exists */
172 find_model_description(surf_vm_model_description, val);
175 /* callback of the cpu/model variable */
176 static void _sg_cfg_cb__cpu_model(const char *name, int pos)
180 xbt_assert(_sg_cfg_init_status < 2,
181 "Cannot change the model after the initialization");
183 val = xbt_cfg_get_string(_sg_cfg_set, name);
185 if (!strcmp(val, "help")) {
186 model_help("CPU", surf_cpu_model_description);
190 /* New Module missing */
191 find_model_description(surf_cpu_model_description, val);
194 /* callback of the cpu/model variable */
195 static void _sg_cfg_cb__optimization_mode(const char *name, int pos)
199 xbt_assert(_sg_cfg_init_status < 2,
200 "Cannot change the model after the initialization");
202 val = xbt_cfg_get_string(_sg_cfg_set, name);
204 if (!strcmp(val, "help")) {
205 model_help("optimization", surf_optimization_mode_description);
209 /* New Module missing */
210 find_model_description(surf_optimization_mode_description, val);
213 /* callback of the cpu/model variable */
214 static void _sg_cfg_cb__storage_mode(const char *name, int pos)
218 xbt_assert(_sg_cfg_init_status < 2,
219 "Cannot change the model after the initialization");
221 val = xbt_cfg_get_string(_sg_cfg_set, name);
223 if (!strcmp(val, "help")) {
224 model_help("storage", surf_storage_model_description);
228 /* New Module missing */
229 find_model_description(surf_storage_model_description, val);
232 /* callback of the network_model variable */
233 static void _sg_cfg_cb__network_model(const char *name, int pos)
237 xbt_assert(_sg_cfg_init_status < 2,
238 "Cannot change the model after the initialization");
240 val = xbt_cfg_get_string(_sg_cfg_set, name);
242 if (!strcmp(val, "help")) {
243 model_help("network", surf_network_model_description);
247 /* New Module missing */
248 find_model_description(surf_network_model_description, val);
251 /* callbacks of the network models values */
252 static void _sg_cfg_cb__tcp_gamma(const char *name, int pos)
254 sg_tcp_gamma = xbt_cfg_get_double(_sg_cfg_set, name);
257 static void _sg_cfg_cb__maxmin_precision(const char* name, int pos)
259 sg_maxmin_precision = xbt_cfg_get_double(_sg_cfg_set, name);
262 static void _sg_cfg_cb__surf_precision(const char* name, int pos)
264 sg_surf_precision = xbt_cfg_get_double(_sg_cfg_set, name);
267 static void _sg_cfg_cb__sender_gap(const char* name, int pos)
269 sg_sender_gap = xbt_cfg_get_double(_sg_cfg_set, name);
272 static void _sg_cfg_cb__latency_factor(const char *name, int pos)
274 sg_latency_factor = xbt_cfg_get_double(_sg_cfg_set, name);
277 static void _sg_cfg_cb__bandwidth_factor(const char *name, int pos)
279 sg_bandwidth_factor = xbt_cfg_get_double(_sg_cfg_set, name);
282 static void _sg_cfg_cb__weight_S(const char *name, int pos)
284 sg_weight_S_parameter = xbt_cfg_get_double(_sg_cfg_set, name);
288 /* callback of the mpi collectives */
289 static void _sg_cfg_cb__coll(const char *category,
290 s_mpi_coll_description_t * table,
291 const char *name, int pos)
295 xbt_assert(_sg_cfg_init_status < 2,
296 "Cannot change the model after the initialization");
298 val = xbt_cfg_get_string(_sg_cfg_set, name);
300 if (!strcmp(val, "help")) {
301 coll_help(category, table);
305 /* New Module missing */
306 find_coll_description(table, val, category);
308 static void _sg_cfg_cb__coll_gather(const char *name, int pos){
309 _sg_cfg_cb__coll("gather", mpi_coll_gather_description, name, pos);
311 static void _sg_cfg_cb__coll_allgather(const char *name, int pos){
312 _sg_cfg_cb__coll("allgather", mpi_coll_allgather_description, name, pos);
314 static void _sg_cfg_cb__coll_allgatherv(const char *name, int pos){
315 _sg_cfg_cb__coll("allgatherv", mpi_coll_allgatherv_description, name, pos);
317 static void _sg_cfg_cb__coll_allreduce(const char *name, int pos)
319 _sg_cfg_cb__coll("allreduce", mpi_coll_allreduce_description, name, pos);
321 static void _sg_cfg_cb__coll_alltoall(const char *name, int pos)
323 _sg_cfg_cb__coll("alltoall", mpi_coll_alltoall_description, name, pos);
325 static void _sg_cfg_cb__coll_alltoallv(const char *name, int pos)
327 _sg_cfg_cb__coll("alltoallv", mpi_coll_alltoallv_description, name, pos);
329 static void _sg_cfg_cb__coll_bcast(const char *name, int pos)
331 _sg_cfg_cb__coll("bcast", mpi_coll_bcast_description, name, pos);
333 static void _sg_cfg_cb__coll_reduce(const char *name, int pos)
335 _sg_cfg_cb__coll("reduce", mpi_coll_reduce_description, name, pos);
337 static void _sg_cfg_cb__coll_reduce_scatter(const char *name, int pos){
338 _sg_cfg_cb__coll("reduce_scatter", mpi_coll_reduce_scatter_description, name, pos);
340 static void _sg_cfg_cb__coll_scatter(const char *name, int pos){
341 _sg_cfg_cb__coll("scatter", mpi_coll_scatter_description, name, pos);
343 static void _sg_cfg_cb__coll_barrier(const char *name, int pos){
344 _sg_cfg_cb__coll("barrier", mpi_coll_barrier_description, name, pos);
347 static void _sg_cfg_cb__wtime_sleep(const char *name, int pos){
348 smpi_wtime_sleep = xbt_cfg_get_double(_sg_cfg_set, name);
351 static void _sg_cfg_cb__iprobe_sleep(const char *name, int pos){
352 smpi_iprobe_sleep = xbt_cfg_get_double(_sg_cfg_set, name);
355 static void _sg_cfg_cb__test_sleep(const char *name, int pos){
356 smpi_test_sleep = xbt_cfg_get_double(_sg_cfg_set, name);
363 /* callback of the inclusion path */
364 static void _sg_cfg_cb__surf_path(const char *name, int pos)
366 char *path = xbt_strdup(xbt_cfg_get_string_at(_sg_cfg_set, name, pos));
367 xbt_dynar_push(surf_path, &path);
370 /* callback to decide if we want to use the model-checking */
371 #include "src/xbt_modinter.h"
374 extern int _sg_do_model_check; /* this variable lives in xbt_main until I find a right location for it */
375 extern int _sg_do_model_check_record;
378 static void _sg_cfg_cb_model_check_replay(const char *name, int pos) {
379 MC_record_path = xbt_cfg_get_string(_sg_cfg_set, name);
383 static void _sg_cfg_cb_model_check_record(const char *name, int pos) {
384 _sg_do_model_check_record = xbt_cfg_get_boolean(_sg_cfg_set, name);
388 extern int _sg_do_verbose_exit;
390 static void _sg_cfg_cb_verbose_exit(const char *name, int pos)
392 _sg_do_verbose_exit = xbt_cfg_get_boolean(_sg_cfg_set, name);
395 extern int _sg_do_clean_atexit;
397 static void _sg_cfg_cb_clean_atexit(const char *name, int pos)
399 _sg_do_clean_atexit = xbt_cfg_get_boolean(_sg_cfg_set, name);
402 static void _sg_cfg_cb_context_factory(const char *name, int pos)
404 smx_context_factory_name = xbt_cfg_get_string(_sg_cfg_set, name);
407 static void _sg_cfg_cb_context_stack_size(const char *name, int pos)
409 smx_context_stack_size_was_set = 1;
410 smx_context_stack_size = xbt_cfg_get_int(_sg_cfg_set, name) * 1024;
413 static void _sg_cfg_cb_context_guard_size(const char *name, int pos)
415 smx_context_guard_size_was_set = 1;
416 smx_context_guard_size = xbt_cfg_get_int(_sg_cfg_set, name) * xbt_pagesize;
419 static void _sg_cfg_cb_contexts_nthreads(const char *name, int pos)
421 SIMIX_context_set_nthreads(xbt_cfg_get_int(_sg_cfg_set, name));
424 static void _sg_cfg_cb_contexts_parallel_threshold(const char *name, int pos)
426 SIMIX_context_set_parallel_threshold(xbt_cfg_get_int(_sg_cfg_set, name));
429 static void _sg_cfg_cb_contexts_parallel_mode(const char *name, int pos)
431 const char* mode_name = xbt_cfg_get_string(_sg_cfg_set, name);
432 if (!strcmp(mode_name, "posix")) {
433 SIMIX_context_set_parallel_mode(XBT_PARMAP_POSIX);
435 else if (!strcmp(mode_name, "futex")) {
436 SIMIX_context_set_parallel_mode(XBT_PARMAP_FUTEX);
438 else if (!strcmp(mode_name, "busy_wait")) {
439 SIMIX_context_set_parallel_mode(XBT_PARMAP_BUSY_WAIT);
442 xbt_die("Command line setting of the parallel synchronization mode should "
443 "be one of \"posix\", \"futex\" or \"busy_wait\"");
447 static void _sg_cfg_cb__surf_network_coordinates(const char *name,
450 static int already_set = 0;
451 int val = xbt_cfg_get_boolean(_sg_cfg_set, name);
454 COORD_HOST_LEVEL = sg_host_extension_create(xbt_dynar_free_voidp);
455 COORD_ASR_LEVEL = xbt_lib_add_level(as_router_lib,xbt_dynar_free_voidp);
460 xbt_die("Setting of whether to use coordinate cannot be disabled once set.");
463 static void _sg_cfg_cb__surf_network_crosstraffic(const char *name,
466 sg_network_crosstraffic = xbt_cfg_get_boolean(_sg_cfg_set, name);
469 /* build description line with possible values */
470 static void describe_model(char *result,
471 const s_surf_model_description_t model_description[],
473 const char *description)
476 sprintf(result, "%s. Possible values: %s", description,
477 model_description[0].name ? model_description[0].name : "n/a");
479 for (i = 1; model_description[i].name; i++)
480 p += sprintf(p, ", %s", model_description[i].name);
482 ".\n (use 'help' as a value to see the long description of each %s)",
486 /* create the config set, register what should be and parse the command line*/
487 void sg_config_init(int *argc, char **argv)
489 char description[1024];
491 /* Create the configuration support */
492 if (_sg_cfg_init_status == 0) { /* Only create stuff if not already inited */
494 /* Plugins configuration */
495 describe_model(description, surf_plugin_description,
496 "plugin", "The plugins");
497 xbt_cfg_register(&_sg_cfg_set, "plugin", description,
498 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__plugin);
500 describe_model(description, surf_cpu_model_description, "model", "The model to use for the CPU");
501 xbt_cfg_register(&_sg_cfg_set, "cpu/model", description, xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__cpu_model);
502 xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/model", "Cas01");
504 describe_model(description, surf_optimization_mode_description, "optimization mode", "The optimization modes to use for the CPU");
505 xbt_cfg_register(&_sg_cfg_set, "cpu/optim", description, xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode);
506 xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/optim", "Lazy");
508 describe_model(description, surf_storage_model_description, "model", "The model to use for the storage");
509 xbt_cfg_register(&_sg_cfg_set, "storage/model", description, xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__storage_mode);
510 xbt_cfg_setdefault_string(_sg_cfg_set, "storage/model", "default");
512 describe_model(description, surf_network_model_description, "model", "The model to use for the network");
513 xbt_cfg_register(&_sg_cfg_set, "network/model", description, xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__network_model);
514 xbt_cfg_setdefault_string(_sg_cfg_set, "network/model", "LV08");
516 describe_model(description, surf_optimization_mode_description, "optimization mode", "The optimization modes to use for the network");
517 xbt_cfg_register(&_sg_cfg_set, "network/optim", description, xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode);
518 xbt_cfg_setdefault_string(_sg_cfg_set, "network/optim", "Lazy");
520 describe_model(description, surf_host_model_description, "model", "The model to use for the host");
521 xbt_cfg_register(&_sg_cfg_set, "host/model", description, xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__host_model);
522 xbt_cfg_setdefault_string(_sg_cfg_set, "host/model", "default");
524 describe_model(description, surf_vm_model_description, "model", "The model to use for the vm");
525 xbt_cfg_register(&_sg_cfg_set, "vm/model", description, xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__vm_model);
526 xbt_cfg_setdefault_string(_sg_cfg_set, "vm/model", "default");
528 xbt_cfg_register(&_sg_cfg_set, "network/TCP_gamma",
529 "Size of the biggest TCP window (cat /proc/sys/net/ipv4/tcp_[rw]mem for recv/send window; Use the last given value, which is the max window size)",
530 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__tcp_gamma);
531 xbt_cfg_setdefault_double(_sg_cfg_set, "network/TCP_gamma", 4194304.0);
533 xbt_cfg_register(&_sg_cfg_set, "surf/precision", "Numerical precision used when updating simulation times (in seconds)",
534 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__surf_precision);
535 xbt_cfg_setdefault_double(_sg_cfg_set, "surf/precision", 0.00001);
537 xbt_cfg_register(&_sg_cfg_set, "maxmin/precision",
538 "Numerical precision used when computing resource sharing (in ops/sec or bytes/sec)",
539 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__maxmin_precision);
540 xbt_cfg_setdefault_double(_sg_cfg_set, "maxmin/precision", 0.00001);
542 /* The parameters of network models */
544 xbt_cfg_register(&_sg_cfg_set, "network/sender_gap", "Minimum gap between two overlapping sends",
545 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__sender_gap);
546 /* real default for "network/sender_gap" is set in network_smpi.cpp */
547 xbt_cfg_setdefault_double(_sg_cfg_set, "network/sender_gap", NAN);
549 xbt_cfg_register(&_sg_cfg_set, "network/latency_factor",
550 "Correction factor to apply to the provided latency (default value set by network model)",
551 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__latency_factor);
552 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 1.0);
554 xbt_cfg_register(&_sg_cfg_set, "network/bandwidth_factor",
555 "Correction factor to apply to the provided bandwidth (default value set by network model)",
556 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__bandwidth_factor);
557 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 1.0);
559 xbt_cfg_register(&_sg_cfg_set, "network/weight_S",
560 "Correction factor to apply to the weight of competing streams (default value set by network model)",
561 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__weight_S);
562 /* real default for "network/weight_S" is set in network_*.cpp */
563 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", NAN);
566 xbt_cfg_register(&_sg_cfg_set, "path",
567 "Lookup path for inclusions in platform and deployment XML files",
568 xbt_cfgelm_string, 1, 0, _sg_cfg_cb__surf_path);
570 xbt_cfg_register(&_sg_cfg_set, "cpu/maxmin_selective_update",
571 "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
572 xbt_cfgelm_boolean, 1, 1, NULL);
573 xbt_cfg_setdefault_boolean(_sg_cfg_set, "cpu/maxmin_selective_update", "no");
575 xbt_cfg_register(&_sg_cfg_set, "network/maxmin_selective_update",
576 "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
577 xbt_cfgelm_boolean, 1, 1, NULL);
578 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/maxmin_selective_update", "no");
580 /* Replay (this part is enabled even if MC it disabled) */
581 xbt_cfg_register(&_sg_cfg_set, "model-check/replay",
582 "Enable replay mode with the given path", xbt_cfgelm_string, 0, 1, _sg_cfg_cb_model_check_replay);
585 /* do model-checking-record */
586 xbt_cfg_register(&_sg_cfg_set, "model-check/record",
587 "Record the model-checking paths",
588 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_model_check_record);
589 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/record", "no");
591 /* do stateful model-checking */
592 xbt_cfg_register(&_sg_cfg_set, "model-check/checkpoint",
593 "Specify the amount of steps between checkpoints during stateful model-checking (default: 0 => stateless verification). "
594 "If value=1, one checkpoint is saved for each step => faster verification, but huge memory consumption; higher values are good compromises between speed and memory consumption.",
595 xbt_cfgelm_int, 1, 1, _mc_cfg_cb_checkpoint);
596 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/checkpoint", 0);
598 /* do stateful model-checking */
599 xbt_cfg_register(&_sg_cfg_set, "model-check/sparse_checkpoint",
600 "Use sparse per-page snapshots.",
601 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_sparse_checkpoint);
602 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/sparse_checkpoint", "no");
604 /* do stateful model-checking */
605 xbt_cfg_register(&_sg_cfg_set, "model-check/soft-dirty",
606 "Use sparse per-page snapshots.",
607 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_soft_dirty);
608 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/soft-dirty", "no");
610 xbt_cfg_register(&_sg_cfg_set, "model-check/ksm",
611 "Kernel same-page merging",
612 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_ksm);
613 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/ksm", "no");
615 /* do liveness model-checking */
616 xbt_cfg_register(&_sg_cfg_set, "model-check/property",
617 "Specify the name of the file containing the property. It must be the result of the ltl2ba program.",
618 xbt_cfgelm_string, 1, 1, _mc_cfg_cb_property);
619 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/property", "");
621 /* do communications determinism model-checking */
622 xbt_cfg_register(&_sg_cfg_set, "model-check/communications_determinism",
623 "Enable/disable the detection of determinism in the communications schemes",
624 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_comms_determinism);
625 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/communications_determinism", "no");
627 /* do send determinism model-checking */
628 xbt_cfg_register(&_sg_cfg_set, "model-check/send_determinism",
629 "Enable/disable the detection of send-determinism in the communications schemes",
630 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_send_determinism);
631 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/send_determinism", "no");
633 /* Specify the kind of model-checking reduction */
634 xbt_cfg_register(&_sg_cfg_set, "model-check/reduction",
635 "Specify the kind of exploration reduction (either none or DPOR)",
636 xbt_cfgelm_string, 1, 1, _mc_cfg_cb_reduce);
637 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/reduction", "dpor");
639 /* Enable/disable timeout for wait requests with model-checking */
640 xbt_cfg_register(&_sg_cfg_set, "model-check/timeout",
641 "Enable/Disable timeout for wait requests",
642 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_timeout);
643 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/timeout", "no");
645 /* Enable/disable global hash computation with model-checking */
646 xbt_cfg_register(&_sg_cfg_set, "model-check/hash",
647 "Enable/Disable state hash for state comparison (experimental)",
648 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_hash);
649 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/hash", "no");
651 /* Set max depth exploration */
652 /* Currently, this option cannot be used. */
653 xbt_cfg_register(&_sg_cfg_set, "model-check/snapshot_fds",
654 "Whether file descriptors must be snapshoted",
655 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_snapshot_fds);
656 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/snapshot_fds", "no");
658 /* Set max depth exploration */
659 xbt_cfg_register(&_sg_cfg_set, "model-check/max_depth",
660 "Specify the max depth of exploration (default : 1000)",
661 xbt_cfgelm_int, 1, 1, _mc_cfg_cb_max_depth);
662 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/max_depth", 1000);
664 /* Set number of visited state stored for state comparison reduction*/
665 xbt_cfg_register(&_sg_cfg_set, "model-check/visited",
666 "Specify the number of visited state stored for state comparison reduction. If value=5, the last 5 visited states are stored",
667 xbt_cfgelm_int, 1, 1, _mc_cfg_cb_visited);
668 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/visited", 0);
670 /* Set file name for dot output of graph state */
671 xbt_cfg_register(&_sg_cfg_set, "model-check/dot_output",
672 "Specify the name of dot file corresponding to graph state",
673 xbt_cfgelm_string, 1, 1, _mc_cfg_cb_dot_output);
674 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/dot_output", "");
676 /* Enable/disable non progressive cycles detection with model-checking */
677 xbt_cfg_register(&_sg_cfg_set, "model-check/termination",
678 "Enable/Disable non progressive cycle detection",
679 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_termination);
680 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/termination", "no");
683 /* do verbose-exit */
684 xbt_cfg_register(&_sg_cfg_set, "verbose-exit",
685 "Activate the \"do nothing\" mode in Ctrl-C",
686 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_verbose_exit);
687 xbt_cfg_setdefault_boolean(_sg_cfg_set, "verbose-exit", "yes");
689 /* context factory */
690 const char *dflt_ctx_fact = "thread";
692 char *p = description +
694 "Context factory to use in SIMIX. Possible values: %s",
696 #if HAVE_UCONTEXT_CONTEXTS
697 dflt_ctx_fact = "ucontext";
698 p += sprintf(p, ", %s", dflt_ctx_fact);
700 #if HAVE_RAW_CONTEXTS
701 dflt_ctx_fact = "raw";
702 p += sprintf(p, ", %s", dflt_ctx_fact);
706 xbt_cfg_register(&_sg_cfg_set, "contexts/factory", description,
707 xbt_cfgelm_string, 1, 1, _sg_cfg_cb_context_factory);
708 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/factory", dflt_ctx_fact);
710 /* stack size of contexts in KiB */
711 xbt_cfg_register(&_sg_cfg_set, "contexts/stack_size",
712 "Stack size of contexts in KiB",
713 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_context_stack_size);
714 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/stack_size", 8*1024);
715 /* No, it was not set yet (the above setdefault() changed this to 1). */
716 smx_context_stack_size_was_set = 0;
718 /* guard size for contexts stacks in memory pages */
719 xbt_cfg_register(&_sg_cfg_set, "contexts/guard_size",
720 "Guard size for contexts stacks in memory pages",
721 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_context_guard_size);
722 #if defined(_WIN32) || (PTH_STACKGROWTH != -1)
723 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/guard_size", 0);
725 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/guard_size", 1);
727 /* No, it was not set yet (the above setdefault() changed this to 1). */
728 smx_context_guard_size_was_set = 0;
730 /* number of parallel threads for user processes */
731 xbt_cfg_register(&_sg_cfg_set, "contexts/nthreads",
732 "Number of parallel threads used to execute user contexts",
733 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_nthreads);
734 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/nthreads", 1);
736 /* minimal number of user contexts to be run in parallel */
737 xbt_cfg_register(&_sg_cfg_set, "contexts/parallel_threshold",
738 "Minimal number of user contexts to be run in parallel (raw contexts only)",
739 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_parallel_threshold);
740 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/parallel_threshold", 2);
742 /* synchronization mode for parallel user contexts */
743 xbt_cfg_register(&_sg_cfg_set, "contexts/synchro",
744 "Synchronization mode to use when running contexts in parallel (either futex, posix or busy_wait)",
745 xbt_cfgelm_string, 1, 1, _sg_cfg_cb_contexts_parallel_mode);
747 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "futex");
748 #else //No futex on mac and posix is unimplememted yet
749 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "busy_wait");
752 xbt_cfg_register(&_sg_cfg_set, "network/coordinates",
753 "\"yes\" or \"no\", specifying whether we use a coordinate-based routing (as Vivaldi)",
754 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb__surf_network_coordinates);
755 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/coordinates", "no");
757 xbt_cfg_register(&_sg_cfg_set, "network/crosstraffic",
758 "Activate the interferences between uploads and downloads for fluid max-min models (LV08, CM02)",
759 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb__surf_network_crosstraffic);
760 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/crosstraffic", "yes");
763 xbt_cfg_register(&_sg_cfg_set, "ns3/TcpModel",
764 "The ns3 tcp model can be : NewReno or Reno or Tahoe",
765 xbt_cfgelm_string, 1, 1, NULL);
766 xbt_cfg_setdefault_string(_sg_cfg_set, "ns3/TcpModel", "default");
769 //For smpi/bw_factor and smpi/lat_factor
770 //Default value have to be "threshold0:value0;threshold1:value1;...;thresholdN:valueN"
771 //test is if( size >= thresholdN ) return valueN;
772 //Values can be modified with command line --cfg=smpi/bw_factor:"threshold0:value0;threshold1:value1;...;thresholdN:valueN"
773 // or with tag config put line <prop id="smpi/bw_factor" value="threshold0:value0;threshold1:value1;...;thresholdN:valueN"></prop>
774 // SMPI model can be used without enable_smpi, so keep this out of the ifdef.
775 xbt_cfg_register(&_sg_cfg_set, "smpi/bw_factor",
776 "Bandwidth factors for smpi.",
777 xbt_cfgelm_string, 1, 1, NULL);
778 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/bw_factor", "65472:0.940694;15424:0.697866;9376:0.58729;5776:1.08739;3484:0.77493;1426:0.608902;732:0.341987;257:0.338112;0:0.812084");
780 xbt_cfg_register(&_sg_cfg_set, "smpi/lat_factor",
781 "Latency factors for smpi.",
782 xbt_cfgelm_string, 1, 1, NULL);
783 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/lat_factor", "65472:11.6436;15424:3.48845;9376:2.59299;5776:2.18796;3484:1.88101;1426:1.61075;732:1.9503;257:1.95341;0:2.01467");
785 xbt_cfg_register(&_sg_cfg_set, "smpi/IB_penalty_factors",
786 "Correction factor to communications using Infiniband model with contention (default value based on Stampede cluster profiling)",
787 xbt_cfgelm_string, 1, 1, NULL);
788 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/IB_penalty_factors", "0.965;0.925;1.35");
791 xbt_cfg_register(&_sg_cfg_set, "smpi/running_power",
792 "Power of the host running the simulation (in flop/s). Used to bench the operations.",
793 xbt_cfgelm_double, 1, 1, NULL);
794 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/running_power", 20000.0);
796 xbt_cfg_register(&_sg_cfg_set, "smpi/display_timing",
797 "Boolean indicating whether we should display the timing after simulation.",
798 xbt_cfgelm_boolean, 1, 1, NULL);
799 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/display_timing", "no");
801 xbt_cfg_register(&_sg_cfg_set, "smpi/simulate_computation",
802 "Boolean indicating whether the computational part of the simulated application should be simulated.",
803 xbt_cfgelm_boolean, 1, 1, NULL);
804 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/simulate_computation", "yes");
806 xbt_cfg_register(&_sg_cfg_set, "smpi/use_shared_malloc",
807 "Boolean indicating whether we should use shared memory when using SMPI_SHARED_MALLOC. Allows user to disable it for debug purposes.",
808 xbt_cfgelm_boolean, 1, 1, NULL);
809 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/use_shared_malloc", "yes");
811 xbt_cfg_register(&_sg_cfg_set, "smpi/cpu_threshold",
812 "Minimal computation time (in seconds) not discarded, or -1 for infinity.",
813 xbt_cfgelm_double, 1, 1, NULL);
814 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/cpu_threshold", 1e-6);
816 xbt_cfg_register(&_sg_cfg_set, "smpi/async_small_thresh",
817 "Maximal size of messages that are to be sent asynchronously, without waiting for the receiver",
818 xbt_cfgelm_int, 1, 1, NULL);
819 xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/async_small_thresh", 0);
821 xbt_cfg_register(&_sg_cfg_set, "smpi/send_is_detached_thresh",
822 "Threshold of message size where MPI_Send stops behaving like MPI_Isend and becomes MPI_Ssend",
823 xbt_cfgelm_int, 1, 1, NULL);
824 xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/send_is_detached_thresh", 65536);
826 xbt_cfg_register(&_sg_cfg_set, "smpi/privatize_global_variables",
827 "Boolean indicating whether we should privatize global variable at runtime.",
828 xbt_cfgelm_boolean, 1, 1, NULL);
829 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/privatize_global_variables", "no");
831 xbt_cfg_register(&_sg_cfg_set, "smpi/os",
832 "Small messages timings (MPI_Send minimum time for small messages)",
833 xbt_cfgelm_string, 1, 1, NULL);
834 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/os", "1:0:0:0:0");
836 xbt_cfg_register(&_sg_cfg_set, "smpi/ois",
837 "Small messages timings (MPI_Isend minimum time for small messages)",
838 xbt_cfgelm_string, 1, 1, NULL);
839 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/ois", "1:0:0:0:0");
841 xbt_cfg_register(&_sg_cfg_set, "smpi/or",
842 "Small messages timings (MPI_Recv minimum time for small messages)",
843 xbt_cfgelm_string, 1, 1, NULL);
844 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/or", "1:0:0:0:0");
846 xbt_cfg_register(&_sg_cfg_set, "smpi/iprobe",
847 "Minimum time to inject inside a call to MPI_Iprobe",
848 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__iprobe_sleep);
849 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/iprobe", 1e-4);
851 xbt_cfg_register(&_sg_cfg_set, "smpi/test",
852 "Minimum time to inject inside a call to MPI_Test",
853 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__test_sleep);
854 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/test", 1e-4);
856 xbt_cfg_register(&_sg_cfg_set, "smpi/wtime",
857 "Minimum time to inject inside a call to MPI_Wtime",
858 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__wtime_sleep);
859 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/wtime", 0.0);
861 xbt_cfg_register(&_sg_cfg_set, "smpi/coll_selector",
862 "Which collective selector to use",
863 xbt_cfgelm_string, 1, 1, NULL);
864 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/coll_selector", "default");
866 xbt_cfg_register(&_sg_cfg_set, "smpi/gather",
867 "Which collective to use for gather",
868 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_gather);
870 xbt_cfg_register(&_sg_cfg_set, "smpi/allgather",
871 "Which collective to use for allgather",
872 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allgather);
874 xbt_cfg_register(&_sg_cfg_set, "smpi/barrier",
875 "Which collective to use for barrier",
876 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_barrier);
878 xbt_cfg_register(&_sg_cfg_set, "smpi/reduce_scatter",
879 "Which collective to use for reduce_scatter",
880 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_reduce_scatter);
882 xbt_cfg_register(&_sg_cfg_set, "smpi/scatter",
883 "Which collective to use for scatter",
884 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_scatter);
886 xbt_cfg_register(&_sg_cfg_set, "smpi/allgatherv",
887 "Which collective to use for allgatherv",
888 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allgatherv);
890 xbt_cfg_register(&_sg_cfg_set, "smpi/allreduce",
891 "Which collective to use for allreduce",
892 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allreduce);
894 xbt_cfg_register(&_sg_cfg_set, "smpi/alltoall",
895 "Which collective to use for alltoall",
896 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_alltoall);
898 xbt_cfg_register(&_sg_cfg_set, "smpi/alltoallv",
899 "Which collective to use for alltoallv",
900 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_alltoallv);
902 xbt_cfg_register(&_sg_cfg_set, "smpi/bcast",
903 "Which collective to use for bcast",
904 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_bcast);
906 xbt_cfg_register(&_sg_cfg_set, "smpi/reduce",
907 "Which collective to use for reduce",
908 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_reduce);
911 xbt_cfg_register(&_sg_cfg_set, "exception/cutpath",
912 "\"yes\" or \"no\". \"yes\" will cut all path information from call traces, used e.g. in exceptions.",
913 xbt_cfgelm_boolean, 1, 1, NULL);
914 xbt_cfg_setdefault_boolean(_sg_cfg_set, "exception/cutpath", "no");
916 xbt_cfg_register(&_sg_cfg_set, "clean_atexit",
917 "\"yes\" or \"no\". \"yes\" enables all the cleanups of SimGrid (XBT,SIMIX,MSG) to be registered with atexit. \"no\" may be useful if your code segfaults when calling the exit function.",
918 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_clean_atexit);
919 xbt_cfg_setdefault_boolean(_sg_cfg_set, "clean_atexit", "yes");
922 /* retrieves the current directory of the current process */
923 const char *initial_path = __surf_get_initial_path();
924 xbt_assert((initial_path), "__surf_get_initial_path() failed! Can't resolve current Windows directory");
926 surf_path = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
927 xbt_cfg_setdefault_string(_sg_cfg_set, "path", initial_path);
930 xbt_cfg_check(_sg_cfg_set);
931 _sg_cfg_init_status = 1;
933 sg_config_cmd_line(argc, argv);
935 xbt_mallocator_initialization_is_done(SIMIX_context_is_parallel());
937 XBT_WARN("Call to sg_config_init() after initialization ignored");
941 void sg_config_finalize(void)
943 if (!_sg_cfg_init_status)
944 return; /* Not initialized yet. Nothing to do */
946 xbt_cfg_free(&_sg_cfg_set);
947 _sg_cfg_init_status = 0;
950 int sg_cfg_is_default_value(const char *name)
952 return xbt_cfg_is_default_value(_sg_cfg_set, name);
955 int sg_cfg_get_int(const char* name)
957 return xbt_cfg_get_int(_sg_cfg_set, name);
960 double sg_cfg_get_double(const char* name)
962 return xbt_cfg_get_double(_sg_cfg_set, name);
965 char* sg_cfg_get_string(const char* name)
967 return xbt_cfg_get_string(_sg_cfg_set, name);
970 int sg_cfg_get_boolean(const char* name)
972 return xbt_cfg_get_boolean(_sg_cfg_set, name);
975 xbt_dynar_t sg_cfg_get_dynar(const char* name)
977 return xbt_cfg_get_dynar(_sg_cfg_set, name);