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 "smpi/smpi_interface.h"
23 #include "mc/mc_record.h"
24 #include "simgrid/instr.h"
25 #include "mc/mc_replay.h"
27 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_config, surf,
28 "About the configuration of simgrid");
30 xbt_cfg_t _sg_cfg_set = NULL;
32 /* 0: beginning of time (config cannot be changed yet);
33 * 1: initialized: cfg_set created (config can now be changed);
34 * 2: configured: command line parsed and config part of platform file was
35 * integrated also, platform construction ongoing or done.
36 * (Config cannot be changed anymore!)
38 int _sg_cfg_init_status = 0;
40 /* 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")) {
65 ("Description of the configuration accepted by this simulator:\n");
66 xbt_cfg_help(_sg_cfg_set);
69 "Each of these configurations can be used by adding\n"
70 " --cfg=<option name>:<option value>\n"
71 "to the command line.\n"
73 "You can also use --help-models to see the details of all models known by this simulator.\n"
75 "You can also use --help-tracing to see the details of all tracing options known by this simulator.\n"
77 "You can also use --help-logs and --help-log-categories to see the details of logging output.\n"
79 "You can also use --version to get SimGrid version information.\n"
83 } else if (!strcmp(argv[i], "--help-models")) {
86 model_help("host", surf_host_model_description);
88 model_help("CPU", surf_cpu_model_description);
90 model_help("network", surf_network_model_description);
91 printf("\nLong description of all optimization levels accepted by the models of this simulator:\n");
92 for (k = 0; surf_optimization_mode_description[k].name; k++)
94 surf_optimization_mode_description[k].name,
95 surf_optimization_mode_description[k].description);
96 printf("Both network and CPU models have 'Lazy' as default optimization level\n\n");
98 } else if (!strcmp(argv[i], "--help-tracing")) {
113 /* callback of the plugin variable */
114 static void _sg_cfg_cb__plugin(const char *name, int pos)
119 xbt_assert(_sg_cfg_init_status < 2,
120 "Cannot load a plugin after the initialization");
122 val = xbt_cfg_get_string(_sg_cfg_set, name);
124 if (!strcmp(val, "help")) {
125 model_help("plugin", surf_plugin_description);
129 /* New Module missing */
130 int plugin_id = find_model_description(surf_plugin_description, val);
131 surf_plugin_description[plugin_id].model_init_preparse();
134 /* callback of the host/model variable */
135 static void _sg_cfg_cb__host_model(const char *name, int pos)
139 xbt_assert(_sg_cfg_init_status < 2,
140 "Cannot change the model after the initialization");
142 val = xbt_cfg_get_string(_sg_cfg_set, name);
144 if (!strcmp(val, "help")) {
145 model_help("host", surf_host_model_description);
149 /* Make sure that the model exists */
150 find_model_description(surf_host_model_description, val);
153 /* callback of the vm/model variable */
154 static void _sg_cfg_cb__vm_model(const char *name, int pos)
158 xbt_assert(_sg_cfg_init_status < 2,
159 "Cannot change the model after the initialization");
161 val = xbt_cfg_get_string(_sg_cfg_set, name);
163 if (!strcmp(val, "help")) {
164 model_help("vm", surf_vm_model_description);
168 /* Make sure that the model exists */
169 find_model_description(surf_vm_model_description, val);
172 /* callback of the cpu/model variable */
173 static void _sg_cfg_cb__cpu_model(const char *name, int pos)
177 xbt_assert(_sg_cfg_init_status < 2,
178 "Cannot change the model after the initialization");
180 val = xbt_cfg_get_string(_sg_cfg_set, name);
182 if (!strcmp(val, "help")) {
183 model_help("CPU", surf_cpu_model_description);
187 /* New Module missing */
188 find_model_description(surf_cpu_model_description, val);
191 /* callback of the cpu/model variable */
192 static void _sg_cfg_cb__optimization_mode(const char *name, int pos)
196 xbt_assert(_sg_cfg_init_status < 2,
197 "Cannot change the model after the initialization");
199 val = xbt_cfg_get_string(_sg_cfg_set, name);
201 if (!strcmp(val, "help")) {
202 model_help("optimization", surf_optimization_mode_description);
206 /* New Module missing */
207 find_model_description(surf_optimization_mode_description, val);
210 /* callback of the cpu/model variable */
211 static void _sg_cfg_cb__storage_mode(const char *name, int pos)
215 xbt_assert(_sg_cfg_init_status < 2,
216 "Cannot change the model after the initialization");
218 val = xbt_cfg_get_string(_sg_cfg_set, name);
220 if (!strcmp(val, "help")) {
221 model_help("storage", surf_storage_model_description);
225 /* New Module missing */
226 find_model_description(surf_storage_model_description, val);
229 /* callback of the network_model variable */
230 static void _sg_cfg_cb__network_model(const char *name, int pos)
234 xbt_assert(_sg_cfg_init_status < 2,
235 "Cannot change the model after the initialization");
237 val = xbt_cfg_get_string(_sg_cfg_set, name);
239 if (!strcmp(val, "help")) {
240 model_help("network", surf_network_model_description);
244 /* New Module missing */
245 find_model_description(surf_network_model_description, val);
248 /* callbacks of the network models values */
249 static void _sg_cfg_cb__tcp_gamma(const char *name, int pos)
251 sg_tcp_gamma = xbt_cfg_get_double(_sg_cfg_set, name);
254 static void _sg_cfg_cb__maxmin_precision(const char* name, int pos)
256 sg_maxmin_precision = xbt_cfg_get_double(_sg_cfg_set, name);
259 static void _sg_cfg_cb__surf_precision(const char* name, int pos)
261 sg_surf_precision = xbt_cfg_get_double(_sg_cfg_set, name);
264 static void _sg_cfg_cb__sender_gap(const char* name, int pos)
266 sg_sender_gap = xbt_cfg_get_double(_sg_cfg_set, name);
269 static void _sg_cfg_cb__latency_factor(const char *name, int pos)
271 sg_latency_factor = xbt_cfg_get_double(_sg_cfg_set, name);
274 static void _sg_cfg_cb__bandwidth_factor(const char *name, int pos)
276 sg_bandwidth_factor = xbt_cfg_get_double(_sg_cfg_set, name);
279 static void _sg_cfg_cb__weight_S(const char *name, int pos)
281 sg_weight_S_parameter = xbt_cfg_get_double(_sg_cfg_set, name);
285 /* callback of the mpi collectives */
286 static void _sg_cfg_cb__coll(const char *category,
287 s_mpi_coll_description_t * table,
288 const char *name, int pos)
292 xbt_assert(_sg_cfg_init_status < 2,
293 "Cannot change the model after the initialization");
295 val = xbt_cfg_get_string(_sg_cfg_set, name);
297 if (!strcmp(val, "help")) {
298 coll_help(category, table);
302 /* New Module missing */
303 find_coll_description(table, val, category);
305 static void _sg_cfg_cb__coll_gather(const char *name, int pos){
306 _sg_cfg_cb__coll("gather", mpi_coll_gather_description, name, pos);
308 static void _sg_cfg_cb__coll_allgather(const char *name, int pos){
309 _sg_cfg_cb__coll("allgather", mpi_coll_allgather_description, name, pos);
311 static void _sg_cfg_cb__coll_allgatherv(const char *name, int pos){
312 _sg_cfg_cb__coll("allgatherv", mpi_coll_allgatherv_description, name, pos);
314 static void _sg_cfg_cb__coll_allreduce(const char *name, int pos)
316 _sg_cfg_cb__coll("allreduce", mpi_coll_allreduce_description, name, pos);
318 static void _sg_cfg_cb__coll_alltoall(const char *name, int pos)
320 _sg_cfg_cb__coll("alltoall", mpi_coll_alltoall_description, name, pos);
322 static void _sg_cfg_cb__coll_alltoallv(const char *name, int pos)
324 _sg_cfg_cb__coll("alltoallv", mpi_coll_alltoallv_description, name, pos);
326 static void _sg_cfg_cb__coll_bcast(const char *name, int pos)
328 _sg_cfg_cb__coll("bcast", mpi_coll_bcast_description, name, pos);
330 static void _sg_cfg_cb__coll_reduce(const char *name, int pos)
332 _sg_cfg_cb__coll("reduce", mpi_coll_reduce_description, name, pos);
334 static void _sg_cfg_cb__coll_reduce_scatter(const char *name, int pos){
335 _sg_cfg_cb__coll("reduce_scatter", mpi_coll_reduce_scatter_description, name, pos);
337 static void _sg_cfg_cb__coll_scatter(const char *name, int pos){
338 _sg_cfg_cb__coll("scatter", mpi_coll_scatter_description, name, pos);
340 static void _sg_cfg_cb__coll_barrier(const char *name, int pos){
341 _sg_cfg_cb__coll("barrier", mpi_coll_barrier_description, name, pos);
344 static void _sg_cfg_cb__wtime_sleep(const char *name, int pos){
345 smpi_wtime_sleep = xbt_cfg_get_double(_sg_cfg_set, name);
348 static void _sg_cfg_cb__iprobe_sleep(const char *name, int pos){
349 smpi_iprobe_sleep = xbt_cfg_get_double(_sg_cfg_set, name);
352 static void _sg_cfg_cb__test_sleep(const char *name, int pos){
353 smpi_test_sleep = xbt_cfg_get_double(_sg_cfg_set, name);
360 /* callback of the inclusion path */
361 static void _sg_cfg_cb__surf_path(const char *name, int pos)
363 char *path = xbt_cfg_get_string_at(_sg_cfg_set, name, pos);
364 xbt_dynar_push(surf_path, &path);
367 /* callback to decide if we want to use the model-checking */
368 #include "xbt_modinter.h"
371 extern int _sg_do_model_check; /* this variable lives in xbt_main until I find a right location for it */
372 extern int _sg_do_model_check_record;
375 static void _sg_cfg_cb_model_check_replay(const char *name, int pos)
377 MC_record_path = xbt_cfg_get_string(_sg_cfg_set, name);
380 static void _sg_cfg_cb_model_check_record(const char *name, int pos)
383 _sg_do_model_check_record = xbt_cfg_get_boolean(_sg_cfg_set, name);
385 if (xbt_cfg_get_boolean(_sg_cfg_set, name)) {
386 xbt_die("You tried to activate the model-checking record from the command line, but it was not compiled in. Change your settings in cmake, recompile and try again");
391 extern int _sg_do_verbose_exit;
393 static void _sg_cfg_cb_verbose_exit(const char *name, int pos)
395 _sg_do_verbose_exit = xbt_cfg_get_boolean(_sg_cfg_set, name);
398 extern int _sg_do_clean_atexit;
400 static void _sg_cfg_cb_clean_atexit(const char *name, int pos)
402 _sg_do_clean_atexit = xbt_cfg_get_boolean(_sg_cfg_set, name);
405 static void _sg_cfg_cb_context_factory(const char *name, int pos)
407 smx_context_factory_name = xbt_cfg_get_string(_sg_cfg_set, name);
410 static void _sg_cfg_cb_context_stack_size(const char *name, int pos)
412 smx_context_stack_size_was_set = 1;
413 smx_context_stack_size = xbt_cfg_get_int(_sg_cfg_set, name) * 1024;
416 static void _sg_cfg_cb_context_guard_size(const char *name, int pos)
418 smx_context_guard_size_was_set = 1;
419 smx_context_guard_size = xbt_cfg_get_int(_sg_cfg_set, name) * xbt_pagesize;
422 static void _sg_cfg_cb_contexts_nthreads(const char *name, int pos)
424 SIMIX_context_set_nthreads(xbt_cfg_get_int(_sg_cfg_set, name));
427 static void _sg_cfg_cb_contexts_parallel_threshold(const char *name, int pos)
429 SIMIX_context_set_parallel_threshold(xbt_cfg_get_int(_sg_cfg_set, name));
432 static void _sg_cfg_cb_contexts_parallel_mode(const char *name, int pos)
434 const char* mode_name = xbt_cfg_get_string(_sg_cfg_set, name);
435 if (!strcmp(mode_name, "posix")) {
436 SIMIX_context_set_parallel_mode(XBT_PARMAP_POSIX);
438 else if (!strcmp(mode_name, "futex")) {
439 SIMIX_context_set_parallel_mode(XBT_PARMAP_FUTEX);
441 else if (!strcmp(mode_name, "busy_wait")) {
442 SIMIX_context_set_parallel_mode(XBT_PARMAP_BUSY_WAIT);
445 xbt_die("Command line setting of the parallel synchronization mode should "
446 "be one of \"posix\", \"futex\" or \"busy_wait\"");
450 static void _sg_cfg_cb__surf_network_coordinates(const char *name,
453 static int already_set = 0;
454 int val = xbt_cfg_get_boolean(_sg_cfg_set, name);
457 COORD_HOST_LEVEL = xbt_lib_add_level(host_lib,xbt_dynar_free_voidp);
458 COORD_ASR_LEVEL = xbt_lib_add_level(as_router_lib,xbt_dynar_free_voidp);
463 xbt_die("Setting of whether to use coordinate cannot be disabled once set.");
466 static void _sg_cfg_cb__surf_network_crosstraffic(const char *name,
469 sg_network_crosstraffic = xbt_cfg_get_boolean(_sg_cfg_set, name);
472 /* build description line with possible values */
473 static void describe_model(char *result,
474 const s_surf_model_description_t model_description[],
476 const char *description)
479 sprintf(result, "%s. Possible values: %s", description,
480 model_description[0].name ? model_description[0].name : "n/a");
482 for (i = 1; model_description[i].name; i++)
483 p += sprintf(p, ", %s", model_description[i].name);
485 ".\n (use 'help' as a value to see the long description of each %s)",
489 /* create the config set, register what should be and parse the command line*/
490 void sg_config_init(int *argc, char **argv)
492 char description[1024];
494 /* Create the configuration support */
495 if (_sg_cfg_init_status == 0) { /* Only create stuff if not already inited */
497 /* Plugins configuration */
498 describe_model(description, surf_plugin_description,
499 "plugin", "The plugins");
500 xbt_cfg_register(&_sg_cfg_set, "plugin", description,
501 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__plugin, NULL);
503 describe_model(description, surf_cpu_model_description,
504 "model", "The model to use for the CPU");
505 xbt_cfg_register(&_sg_cfg_set, "cpu/model", description,
506 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__cpu_model, NULL);
507 xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/model", "Cas01");
509 describe_model(description, surf_optimization_mode_description,
511 "The optimization modes to use for the CPU");
512 xbt_cfg_register(&_sg_cfg_set, "cpu/optim", description,
513 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode, NULL);
514 xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/optim", "Lazy");
516 describe_model(description, surf_storage_model_description,
517 "model", "The model to use for the storage");
518 xbt_cfg_register(&_sg_cfg_set, "storage/model", description,
519 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__storage_mode, NULL);
520 xbt_cfg_setdefault_string(_sg_cfg_set, "storage/model", "default");
522 describe_model(description, surf_network_model_description,
523 "model", "The model to use for the network");
524 xbt_cfg_register(&_sg_cfg_set, "network/model", description,
525 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__network_model, NULL);
526 xbt_cfg_setdefault_string(_sg_cfg_set, "network/model", "LV08");
528 describe_model(description, surf_optimization_mode_description,
530 "The optimization modes to use for the network");
531 xbt_cfg_register(&_sg_cfg_set, "network/optim", description,
532 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode, NULL);
533 xbt_cfg_setdefault_string(_sg_cfg_set, "network/optim", "Lazy");
535 describe_model(description, surf_host_model_description,
536 "model", "The model to use for the host");
537 xbt_cfg_register(&_sg_cfg_set, "host/model", description,
538 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__host_model, NULL);
539 xbt_cfg_setdefault_string(_sg_cfg_set, "host/model", "default");
541 describe_model(description, surf_vm_model_description,
542 "model", "The model to use for the vm");
543 xbt_cfg_register(&_sg_cfg_set, "vm/model", description,
544 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__vm_model, NULL);
545 xbt_cfg_setdefault_string(_sg_cfg_set, "vm/model", "default");
547 xbt_cfg_register(&_sg_cfg_set, "network/TCP_gamma",
548 "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)",
549 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__tcp_gamma, NULL);
550 xbt_cfg_setdefault_double(_sg_cfg_set, "network/TCP_gamma", 4194304.0);
552 xbt_cfg_register(&_sg_cfg_set, "surf/precision",
553 "Numerical precision used when updating simulation times (hence this value is expressed in seconds)",
554 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__surf_precision, NULL);
555 xbt_cfg_setdefault_double(_sg_cfg_set, "surf/precision", 0.00001);
557 xbt_cfg_register(&_sg_cfg_set, "maxmin/precision",
558 "Numerical precision used when computing resource sharing (hence this value is expressed in ops/sec or bytes/sec)",
559 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__maxmin_precision, NULL);
560 xbt_cfg_setdefault_double(_sg_cfg_set, "maxmin/precision", 0.00001);
562 /* The parameters of network models */
564 xbt_cfg_register(&_sg_cfg_set, "network/sender_gap",
565 "Minimum gap between two overlapping sends",
566 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__sender_gap, NULL);
567 /* real default for "network/sender_gap" is set in network_smpi.cpp */
568 xbt_cfg_setdefault_double(_sg_cfg_set, "network/sender_gap", NAN);
570 xbt_cfg_register(&_sg_cfg_set, "network/latency_factor",
571 "Correction factor to apply to the provided latency (default value set by network model)",
572 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__latency_factor, NULL);
573 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 1.0);
575 xbt_cfg_register(&_sg_cfg_set, "network/bandwidth_factor",
576 "Correction factor to apply to the provided bandwidth (default value set by network model)",
577 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__bandwidth_factor, NULL);
578 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 1.0);
580 xbt_cfg_register(&_sg_cfg_set, "network/weight_S",
581 "Correction factor to apply to the weight of competing streams (default value set by network model)",
582 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__weight_S, NULL);
583 /* real default for "network/weight_S" is set in network_*.cpp */
584 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", NAN);
587 xbt_cfg_register(&_sg_cfg_set, "path",
588 "Lookup path for inclusions in platform and deployment XML files",
589 xbt_cfgelm_string, 1, 0, _sg_cfg_cb__surf_path, NULL);
591 xbt_cfg_register(&_sg_cfg_set, "cpu/maxmin_selective_update",
592 "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
593 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
594 xbt_cfg_setdefault_boolean(_sg_cfg_set, "cpu/maxmin_selective_update", "no");
596 xbt_cfg_register(&_sg_cfg_set, "network/maxmin_selective_update",
597 "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
598 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
599 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/maxmin_selective_update", "no");
601 /* Replay (this part is enabled event if MC it disabled) */
602 xbt_cfg_register(&_sg_cfg_set, "model-check/replay",
603 "Uenable replay mode with the given path",
604 xbt_cfgelm_string, 0, 1, _sg_cfg_cb_model_check_replay, NULL);
607 /* do model-checking-record */
608 xbt_cfg_register(&_sg_cfg_set, "model-check/record",
609 "Record the model-checking paths",
610 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_model_check_record, NULL);
611 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/record", "no");
613 /* do stateful model-checking */
614 xbt_cfg_register(&_sg_cfg_set, "model-check/checkpoint",
615 "Specify the amount of steps between checkpoints during stateful model-checking (default: 0 => stateless verification). "
616 "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.",
617 xbt_cfgelm_int, 1, 1, _mc_cfg_cb_checkpoint, NULL);
618 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/checkpoint", 0);
620 /* do stateful model-checking */
621 xbt_cfg_register(&_sg_cfg_set, "model-check/sparse-checkpoint",
622 "Use sparse per-page snapshots.",
623 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_sparse_checkpoint, NULL);
624 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/sparse-checkpoint", "no");
626 /* do liveness model-checking */
627 xbt_cfg_register(&_sg_cfg_set, "model-check/property",
628 "Specify the name of the file containing the property. It must be the result of the ltl2ba program.",
629 xbt_cfgelm_string, 1, 1, _mc_cfg_cb_property, NULL);
630 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/property", "");
632 /* do communications determinism model-checking */
633 xbt_cfg_register(&_sg_cfg_set, "model-check/communications_determinism",
634 "Enable/disable the detection of determinism in the communications schemes",
635 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_comms_determinism, NULL);
636 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/communications_determinism", "no");
638 /* do send determinism model-checking */
639 xbt_cfg_register(&_sg_cfg_set, "model-check/send_determinism",
640 "Enable/disable the detection of send-determinism in the communications schemes",
641 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_send_determinism, NULL);
642 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/send_determinism", "no");
644 /* Specify the kind of model-checking reduction */
645 xbt_cfg_register(&_sg_cfg_set, "model-check/reduction",
646 "Specify the kind of exploration reduction (either none or DPOR)",
647 xbt_cfgelm_string, 1, 1, _mc_cfg_cb_reduce, NULL);
648 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/reduction", "dpor");
650 /* Enable/disable timeout for wait requests with model-checking */
651 xbt_cfg_register(&_sg_cfg_set, "model-check/timeout",
652 "Enable/Disable timeout for wait requests",
653 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_timeout, NULL);
654 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/timeout", "no");
656 /* Enable/disable global hash computation with model-checking */
657 xbt_cfg_register(&_sg_cfg_set, "model-check/hash",
658 "Enable/Disable state hash for state comparison (exprimental)",
659 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_hash, NULL);
660 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/hash", "no");
662 /* Set max depth exploration */
663 /* Currently, this option cannot be used. */
664 xbt_cfg_register(&_sg_cfg_set, "model-check/snapshot_fds",
665 "Whether file descriptors must be snapshoted",
666 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_snapshot_fds, NULL);
667 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/snapshot_fds", "no");
669 /* Set max depth exploration */
670 xbt_cfg_register(&_sg_cfg_set, "model-check/max_depth",
671 "Specify the max depth of exploration (default : 1000)",
672 xbt_cfgelm_int, 1, 1, _mc_cfg_cb_max_depth, NULL);
673 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/max_depth", 1000);
675 /* Set number of visited state stored for state comparison reduction*/
676 xbt_cfg_register(&_sg_cfg_set, "model-check/visited",
677 "Specify the number of visited state stored for state comparison reduction. If value=5, the last 5 visited states are stored",
678 xbt_cfgelm_int, 1, 1, _mc_cfg_cb_visited, NULL);
679 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/visited", 0);
681 /* Set file name for dot output of graph state */
682 xbt_cfg_register(&_sg_cfg_set, "model-check/dot_output",
683 "Specify the name of dot file corresponding to graph state",
684 xbt_cfgelm_string, 1, 1, _mc_cfg_cb_dot_output, NULL);
685 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/dot_output", "");
687 /* Enable/disable non progressive cycles detection with model-checking */
688 xbt_cfg_register(&_sg_cfg_set, "model-check/termination",
689 "Enable/Disable non progressive cycle detection",
690 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_termination, NULL);
691 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/termination", "no");
694 /* do verbose-exit */
695 xbt_cfg_register(&_sg_cfg_set, "verbose-exit",
696 "Activate the \"do nothing\" mode in Ctrl-C",
697 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_verbose_exit, NULL);
698 xbt_cfg_setdefault_boolean(_sg_cfg_set, "verbose-exit", "yes");
700 /* context factory */
701 const char *dflt_ctx_fact = "thread";
703 char *p = description +
705 "Context factory to use in SIMIX. Possible values: %s",
707 #ifdef CONTEXT_UCONTEXT
708 dflt_ctx_fact = "ucontext";
709 p += sprintf(p, ", %s", dflt_ctx_fact);
712 dflt_ctx_fact = "raw";
713 p += sprintf(p, ", %s", dflt_ctx_fact);
717 xbt_cfg_register(&_sg_cfg_set, "contexts/factory", description,
718 xbt_cfgelm_string, 1, 1, _sg_cfg_cb_context_factory, NULL);
719 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/factory", dflt_ctx_fact);
721 /* stack size of contexts in KiB */
722 xbt_cfg_register(&_sg_cfg_set, "contexts/stack_size",
723 "Stack size of contexts in KiB",
724 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_context_stack_size, NULL);
725 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/stack_size", 8*1024);
726 /* No, it was not set yet (the above setdefault() changed this to 1). */
727 smx_context_stack_size_was_set = 0;
729 /* guard size for contexts stacks in memory pages */
730 xbt_cfg_register(&_sg_cfg_set, "contexts/guard_size",
731 "Guard size for contexts stacks in memory pages",
732 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_context_guard_size, NULL);
733 #if defined(_XBT_WIN32) || (PTH_STACKGROWTH != -1)
734 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/guard_size", 0);
736 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/guard_size", 1);
738 /* No, it was not set yet (the above setdefault() changed this to 1). */
739 smx_context_guard_size_was_set = 0;
741 /* number of parallel threads for user processes */
742 xbt_cfg_register(&_sg_cfg_set, "contexts/nthreads",
743 "Number of parallel threads used to execute user contexts",
744 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_nthreads, NULL);
745 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/nthreads", 1);
747 /* minimal number of user contexts to be run in parallel */
748 xbt_cfg_register(&_sg_cfg_set, "contexts/parallel_threshold",
749 "Minimal number of user contexts to be run in parallel (raw contexts only)",
750 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_parallel_threshold, NULL);
751 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/parallel_threshold", 2);
753 /* synchronization mode for parallel user contexts */
754 xbt_cfg_register(&_sg_cfg_set, "contexts/synchro",
755 "Synchronization mode to use when running contexts in parallel (either futex, posix or busy_wait)",
756 xbt_cfgelm_string, 1, 1, _sg_cfg_cb_contexts_parallel_mode, NULL);
758 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "futex");
759 #else //No futex on mac and posix is unimplememted yet
760 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "busy_wait");
763 xbt_cfg_register(&_sg_cfg_set, "network/coordinates",
764 "\"yes\" or \"no\", specifying whether we use a coordinate-based routing (as Vivaldi)",
765 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb__surf_network_coordinates, NULL);
766 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/coordinates", "no");
768 xbt_cfg_register(&_sg_cfg_set, "network/crosstraffic",
769 "Activate the interferences between uploads and downloads for fluid max-min models (LV08, CM02)",
770 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb__surf_network_crosstraffic, NULL);
771 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/crosstraffic", "no");
774 xbt_cfg_register(&_sg_cfg_set, "ns3/TcpModel",
775 "The ns3 tcp model can be : NewReno or Reno or Tahoe",
776 xbt_cfgelm_string, 1, 1, NULL, NULL);
777 xbt_cfg_setdefault_string(_sg_cfg_set, "ns3/TcpModel", "default");
780 //For smpi/bw_factor and smpi/lat_factor
781 //Default value have to be "threshold0:value0;threshold1:value1;...;thresholdN:valueN"
782 //test is if( size >= thresholdN ) return valueN;
783 //Values can be modified with command line --cfg=smpi/bw_factor:"threshold0:value0;threshold1:value1;...;thresholdN:valueN"
784 // or with tag config put line <prop id="smpi/bw_factor" value="threshold0:value0;threshold1:value1;...;thresholdN:valueN"></prop>
785 // SMPI model can be used without enable_smpi, so keep this the ifdef.
786 xbt_cfg_register(&_sg_cfg_set, "smpi/bw_factor",
787 "Bandwidth factors for smpi.",
788 xbt_cfgelm_string, 1, 1, NULL, NULL);
789 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");
791 xbt_cfg_register(&_sg_cfg_set, "smpi/lat_factor",
792 "Latency factors for smpi.",
793 xbt_cfgelm_string, 1, 1, NULL, NULL);
794 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");
796 xbt_cfg_register(&_sg_cfg_set, "smpi/IB_penalty_factors",
797 "Correction factor to communications using Infiniband model with contention (default value based on Stampede cluster profiling)",
798 xbt_cfgelm_string, 1, 1, NULL, NULL);
799 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/IB_penalty_factors", "0.965;0.925;1.35");
802 xbt_cfg_register(&_sg_cfg_set, "smpi/running_power",
803 "Power of the host running the simulation (in flop/s). Used to bench the operations.",
804 xbt_cfgelm_double, 1, 1, NULL, NULL);
805 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/running_power", 20000.0);
807 xbt_cfg_register(&_sg_cfg_set, "smpi/display_timing",
808 "Boolean indicating whether we should display the timing after simulation.",
809 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
810 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/display_timing", "no");
812 xbt_cfg_register(&_sg_cfg_set, "smpi/simulate_computation",
813 "Boolean indicating whether the computational part of the simulated application should be simulated.",
814 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
815 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/simulate_computation", "yes");
817 xbt_cfg_register(&_sg_cfg_set, "smpi/use_shared_malloc",
818 "Boolean indicating whether we should use shared memory when using SMPI_SHARED_MALLOC. Allows user to disable it for debug purposes.",
819 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
820 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/use_shared_malloc", "yes");
822 xbt_cfg_register(&_sg_cfg_set, "smpi/cpu_threshold",
823 "Minimal computation time (in seconds) not discarded, or -1 for infinity.",
824 xbt_cfgelm_double, 1, 1, NULL, NULL);
825 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/cpu_threshold", 1e-6);
827 xbt_cfg_register(&_sg_cfg_set, "smpi/async_small_thres",
828 "Maximal size of messages that are to be sent asynchronously, without waiting for the receiver",
829 xbt_cfgelm_int, 1, 1, NULL, NULL);
830 xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/async_small_thres", 0);
832 xbt_cfg_register(&_sg_cfg_set, "smpi/send_is_detached_thres",
833 "Threshold of message size where MPI_Send stops behaving like MPI_Isend and becomes MPI_Ssend",
834 xbt_cfgelm_int, 1, 1, NULL, NULL);
835 xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/send_is_detached_thres", 65536);
837 xbt_cfg_register(&_sg_cfg_set, "smpi/privatize_global_variables",
838 "Boolean indicating whether we should privatize global variable at runtime.",
839 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
840 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/privatize_global_variables", "no");
842 xbt_cfg_register(&_sg_cfg_set, "smpi/os",
843 "Small messages timings (MPI_Send minimum time for small messages)",
844 xbt_cfgelm_string, 1, 1, NULL, NULL);
845 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/os", "1:0:0:0:0");
847 xbt_cfg_register(&_sg_cfg_set, "smpi/ois",
848 "Small messages timings (MPI_Isend minimum time for small messages)",
849 xbt_cfgelm_string, 1, 1, NULL, NULL);
850 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/ois", "1:0:0:0:0");
852 xbt_cfg_register(&_sg_cfg_set, "smpi/or",
853 "Small messages timings (MPI_Recv minimum time for small messages)",
854 xbt_cfgelm_string, 1, 1, NULL, NULL);
855 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/or", "1:0:0:0:0");
857 xbt_cfg_register(&_sg_cfg_set, "smpi/iprobe",
858 "Minimum time to inject inside a call to MPI_Iprobe",
859 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__iprobe_sleep, NULL);
860 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/iprobe", 1e-4);
862 xbt_cfg_register(&_sg_cfg_set, "smpi/test",
863 "Minimum time to inject inside a call to MPI_Test",
864 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__test_sleep, NULL);
865 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/test", 1e-4);
867 xbt_cfg_register(&_sg_cfg_set, "smpi/wtime",
868 "Minimum time to inject inside a call to MPI_Wtime",
869 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__wtime_sleep, NULL);
870 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/wtime", 0.0);
872 xbt_cfg_register(&_sg_cfg_set, "smpi/coll_selector",
873 "Which collective selector to use",
874 xbt_cfgelm_string, 1, 1, NULL, NULL);
875 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/coll_selector", "default");
877 xbt_cfg_register(&_sg_cfg_set, "smpi/gather",
878 "Which collective to use for gather",
879 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_gather, NULL);
881 xbt_cfg_register(&_sg_cfg_set, "smpi/allgather",
882 "Which collective to use for allgather",
883 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allgather, NULL);
885 xbt_cfg_register(&_sg_cfg_set, "smpi/barrier",
886 "Which collective to use for barrier",
887 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_barrier, NULL);
889 xbt_cfg_register(&_sg_cfg_set, "smpi/reduce_scatter",
890 "Which collective to use for reduce_scatter",
891 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_reduce_scatter, NULL);
893 xbt_cfg_register(&_sg_cfg_set, "smpi/scatter",
894 "Which collective to use for scatter",
895 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_scatter, NULL);
897 xbt_cfg_register(&_sg_cfg_set, "smpi/allgatherv",
898 "Which collective to use for allgatherv",
899 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allgatherv, NULL);
901 xbt_cfg_register(&_sg_cfg_set, "smpi/allreduce",
902 "Which collective to use for allreduce",
903 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allreduce, NULL);
905 xbt_cfg_register(&_sg_cfg_set, "smpi/alltoall",
906 "Which collective to use for alltoall",
907 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_alltoall, NULL);
909 xbt_cfg_register(&_sg_cfg_set, "smpi/alltoallv",
910 "Which collective to use for alltoallv",
911 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_alltoallv, NULL);
913 xbt_cfg_register(&_sg_cfg_set, "smpi/bcast",
914 "Which collective to use for bcast",
915 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_bcast, NULL);
917 xbt_cfg_register(&_sg_cfg_set, "smpi/reduce",
918 "Which collective to use for reduce",
919 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_reduce, NULL);
922 xbt_cfg_register(&_sg_cfg_set, "exception/cutpath",
923 "\"yes\" or \"no\". \"yes\" will cut all path information from call traces, used e.g. in exceptions.",
924 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
925 xbt_cfg_setdefault_boolean(_sg_cfg_set, "exception/cutpath", "no");
927 xbt_cfg_register(&_sg_cfg_set, "clean_atexit",
928 "\"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.",
929 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_clean_atexit, NULL);
930 xbt_cfg_setdefault_boolean(_sg_cfg_set, "clean_atexit", "yes");
933 /* retrieves the current directory of the current process */
934 const char *initial_path = __surf_get_initial_path();
935 xbt_assert((initial_path),
936 "__surf_get_initial_path() failed! Can't resolve current Windows directory");
938 surf_path = xbt_dynar_new(sizeof(char *), NULL);
939 xbt_cfg_setdefault_string(_sg_cfg_set, "path", initial_path);
942 xbt_cfg_check(_sg_cfg_set);
943 _sg_cfg_init_status = 1;
945 sg_config_cmd_line(argc, argv);
947 xbt_mallocator_initialization_is_done(SIMIX_context_is_parallel());
950 XBT_WARN("Call to sg_config_init() after initialization ignored");
954 void sg_config_finalize(void)
956 if (!_sg_cfg_init_status)
957 return; /* Not initialized yet. Nothing to do */
959 xbt_cfg_free(&_sg_cfg_set);
960 _sg_cfg_init_status = 0;
963 /* Pick the right models for CPU, net and host, and call their model_init_preparse */
964 void surf_config_models_setup()
966 const char *host_model_name;
967 const char *vm_model_name;
970 char *network_model_name = NULL;
971 char *cpu_model_name = NULL;
973 char *storage_model_name = NULL;
975 host_model_name = xbt_cfg_get_string(_sg_cfg_set, "host/model");
976 vm_model_name = xbt_cfg_get_string(_sg_cfg_set, "vm/model");
977 network_model_name = xbt_cfg_get_string(_sg_cfg_set, "network/model");
978 cpu_model_name = xbt_cfg_get_string(_sg_cfg_set, "cpu/model");
979 storage_model_name = xbt_cfg_get_string(_sg_cfg_set, "storage/model");
981 /* Check whether we use a net/cpu model differing from the default ones, in which case
982 * we should switch to the "compound" host model to correctly dispatch stuff to
983 * the right net/cpu models.
986 if ((!xbt_cfg_is_default_value(_sg_cfg_set, "network/model") ||
987 !xbt_cfg_is_default_value(_sg_cfg_set, "cpu/model")) &&
988 xbt_cfg_is_default_value(_sg_cfg_set, "host/model")) {
989 host_model_name = "compound";
990 xbt_cfg_set_string(_sg_cfg_set, "host/model", host_model_name);
993 XBT_DEBUG("host model: %s", host_model_name);
994 host_id = find_model_description(surf_host_model_description, host_model_name);
995 if (!strcmp(host_model_name, "compound")) {
999 xbt_assert(cpu_model_name,
1000 "Set a cpu model to use with the 'compound' host model");
1002 xbt_assert(network_model_name,
1003 "Set a network model to use with the 'compound' host model");
1005 if(surf_cpu_model_init_preparse){
1006 surf_cpu_model_init_preparse();
1009 find_model_description(surf_cpu_model_description, cpu_model_name);
1010 surf_cpu_model_description[cpu_id].model_init_preparse();
1014 find_model_description(surf_network_model_description,
1015 network_model_name);
1016 surf_network_model_description[network_id].model_init_preparse();
1019 XBT_DEBUG("Call host_model_init");
1020 surf_host_model_description[host_id].model_init_preparse();
1022 XBT_DEBUG("Call vm_model_init");
1023 vm_id = find_model_description(surf_vm_model_description, vm_model_name);
1024 surf_vm_model_description[vm_id].model_init_preparse();
1026 XBT_DEBUG("Call storage_model_init");
1027 storage_id = find_model_description(surf_storage_model_description, storage_model_name);
1028 surf_storage_model_description[storage_id].model_init_preparse();
1032 int sg_cfg_is_default_value(const char *name)
1034 return xbt_cfg_is_default_value(_sg_cfg_set, name);
1037 int sg_cfg_get_int(const char* name)
1039 return xbt_cfg_get_int(_sg_cfg_set, name);
1042 double sg_cfg_get_double(const char* name)
1044 return xbt_cfg_get_double(_sg_cfg_set, name);
1047 char* sg_cfg_get_string(const char* name)
1049 return xbt_cfg_get_string(_sg_cfg_set, name);
1052 int sg_cfg_get_boolean(const char* name)
1054 return xbt_cfg_get_boolean(_sg_cfg_set, name);
1057 void sg_cfg_get_peer(const char *name, char **peer, int *port)
1059 xbt_cfg_get_peer(_sg_cfg_set, name, peer, port);
1062 xbt_dynar_t sg_cfg_get_dynar(const char* name)
1064 return xbt_cfg_get_dynar(_sg_cfg_set, name);