1 /* Copyright (c) 2009-2010, 2012-2014. 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(const char *name, int pos)
383 _sg_do_model_check = 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 from the command line, but it was not compiled in. Change your settings in cmake, recompile and try again");
391 static void _sg_cfg_cb_model_check_record(const char *name, int pos)
394 _sg_do_model_check_record = xbt_cfg_get_boolean(_sg_cfg_set, name);
396 if (xbt_cfg_get_boolean(_sg_cfg_set, name)) {
397 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");
402 extern int _sg_do_verbose_exit;
404 static void _sg_cfg_cb_verbose_exit(const char *name, int pos)
406 _sg_do_verbose_exit = xbt_cfg_get_boolean(_sg_cfg_set, name);
409 extern int _sg_do_clean_atexit;
411 static void _sg_cfg_cb_clean_atexit(const char *name, int pos)
413 _sg_do_clean_atexit = xbt_cfg_get_boolean(_sg_cfg_set, name);
416 static void _sg_cfg_cb_context_factory(const char *name, int pos)
418 smx_context_factory_name = xbt_cfg_get_string(_sg_cfg_set, name);
421 static void _sg_cfg_cb_context_stack_size(const char *name, int pos)
423 smx_context_stack_size_was_set = 1;
424 smx_context_stack_size = xbt_cfg_get_int(_sg_cfg_set, name) * 1024;
427 static void _sg_cfg_cb_context_guard_size(const char *name, int pos)
429 smx_context_guard_size_was_set = 1;
430 smx_context_guard_size = xbt_cfg_get_int(_sg_cfg_set, name) * xbt_pagesize;
433 static void _sg_cfg_cb_contexts_nthreads(const char *name, int pos)
435 SIMIX_context_set_nthreads(xbt_cfg_get_int(_sg_cfg_set, name));
438 static void _sg_cfg_cb_contexts_parallel_threshold(const char *name, int pos)
440 SIMIX_context_set_parallel_threshold(xbt_cfg_get_int(_sg_cfg_set, name));
443 static void _sg_cfg_cb_contexts_parallel_mode(const char *name, int pos)
445 const char* mode_name = xbt_cfg_get_string(_sg_cfg_set, name);
446 if (!strcmp(mode_name, "posix")) {
447 SIMIX_context_set_parallel_mode(XBT_PARMAP_POSIX);
449 else if (!strcmp(mode_name, "futex")) {
450 SIMIX_context_set_parallel_mode(XBT_PARMAP_FUTEX);
452 else if (!strcmp(mode_name, "busy_wait")) {
453 SIMIX_context_set_parallel_mode(XBT_PARMAP_BUSY_WAIT);
456 xbt_die("Command line setting of the parallel synchronization mode should "
457 "be one of \"posix\", \"futex\" or \"busy_wait\"");
461 static void _sg_cfg_cb__surf_network_coordinates(const char *name,
464 static int already_set = 0;
465 int val = xbt_cfg_get_boolean(_sg_cfg_set, name);
468 COORD_HOST_LEVEL = xbt_lib_add_level(host_lib,xbt_dynar_free_voidp);
469 COORD_ASR_LEVEL = xbt_lib_add_level(as_router_lib,xbt_dynar_free_voidp);
474 xbt_die("Setting of whether to use coordinate cannot be disabled once set.");
477 static void _sg_cfg_cb__surf_network_crosstraffic(const char *name,
480 sg_network_crosstraffic = xbt_cfg_get_boolean(_sg_cfg_set, name);
484 static void _sg_cfg_cb__gtnets_jitter(const char *name, int pos)
486 sg_gtnets_jitter = xbt_cfg_get_double(_sg_cfg_set, name);
489 static void _sg_cfg_cb__gtnets_jitter_seed(const char *name, int pos)
491 sg_gtnets_jitter_seed = xbt_cfg_get_int(_sg_cfg_set, name);
495 /* build description line with possible values */
496 static void describe_model(char *result,
497 const s_surf_model_description_t model_description[],
499 const char *description)
502 sprintf(result, "%s. Possible values: %s", description,
503 model_description[0].name ? model_description[0].name : "n/a");
505 for (i = 1; model_description[i].name; i++)
506 p += sprintf(p, ", %s", model_description[i].name);
508 ".\n (use 'help' as a value to see the long description of each %s)",
512 /* create the config set, register what should be and parse the command line*/
513 void sg_config_init(int *argc, char **argv)
515 char description[1024];
517 /* Create the configuration support */
518 if (_sg_cfg_init_status == 0) { /* Only create stuff if not already inited */
520 /* Plugins configuration */
521 describe_model(description, surf_plugin_description,
522 "plugin", "The plugins");
523 xbt_cfg_register(&_sg_cfg_set, "plugin", description,
524 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__plugin, NULL);
526 describe_model(description, surf_cpu_model_description,
527 "model", "The model to use for the CPU");
528 xbt_cfg_register(&_sg_cfg_set, "cpu/model", description,
529 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__cpu_model, NULL);
530 xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/model", "Cas01");
532 describe_model(description, surf_optimization_mode_description,
534 "The optimization modes to use for the CPU");
535 xbt_cfg_register(&_sg_cfg_set, "cpu/optim", description,
536 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode, NULL);
537 xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/optim", "Lazy");
539 describe_model(description, surf_storage_model_description,
540 "model", "The model to use for the storage");
541 xbt_cfg_register(&_sg_cfg_set, "storage/model", description,
542 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__storage_mode, NULL);
543 xbt_cfg_setdefault_string(_sg_cfg_set, "storage/model", "default");
545 describe_model(description, surf_network_model_description,
546 "model", "The model to use for the network");
547 xbt_cfg_register(&_sg_cfg_set, "network/model", description,
548 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__network_model, NULL);
549 xbt_cfg_setdefault_string(_sg_cfg_set, "network/model", "LV08");
551 describe_model(description, surf_optimization_mode_description,
553 "The optimization modes to use for the network");
554 xbt_cfg_register(&_sg_cfg_set, "network/optim", description,
555 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode, NULL);
556 xbt_cfg_setdefault_string(_sg_cfg_set, "network/optim", "Lazy");
558 describe_model(description, surf_host_model_description,
559 "model", "The model to use for the host");
560 xbt_cfg_register(&_sg_cfg_set, "host/model", description,
561 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__host_model, NULL);
562 xbt_cfg_setdefault_string(_sg_cfg_set, "host/model", "default");
564 describe_model(description, surf_vm_model_description,
565 "model", "The model to use for the vm");
566 xbt_cfg_register(&_sg_cfg_set, "vm/model", description,
567 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__vm_model, NULL);
568 xbt_cfg_setdefault_string(_sg_cfg_set, "vm/model", "default");
570 xbt_cfg_register(&_sg_cfg_set, "network/TCP_gamma",
571 "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)",
572 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__tcp_gamma, NULL);
573 xbt_cfg_setdefault_double(_sg_cfg_set, "network/TCP_gamma", 4194304.0);
575 xbt_cfg_register(&_sg_cfg_set, "surf/precision",
576 "Numerical precision used when updating simulation times (hence this value is expressed in seconds)",
577 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__surf_precision, NULL);
578 xbt_cfg_setdefault_double(_sg_cfg_set, "surf/precision", 0.00001);
580 xbt_cfg_register(&_sg_cfg_set, "maxmin/precision",
581 "Numerical precision used when computing resource sharing (hence this value is expressed in ops/sec or bytes/sec)",
582 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__maxmin_precision, NULL);
583 xbt_cfg_setdefault_double(_sg_cfg_set, "maxmin/precision", 0.00001);
585 /* The parameters of network models */
587 xbt_cfg_register(&_sg_cfg_set, "network/sender_gap",
588 "Minimum gap between two overlapping sends",
589 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__sender_gap, NULL);
590 /* real default for "network/sender_gap" is set in network_smpi.cpp */
591 xbt_cfg_setdefault_double(_sg_cfg_set, "network/sender_gap", NAN);
593 xbt_cfg_register(&_sg_cfg_set, "network/latency_factor",
594 "Correction factor to apply to the provided latency (default value set by network model)",
595 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__latency_factor, NULL);
596 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 1.0);
598 xbt_cfg_register(&_sg_cfg_set, "network/bandwidth_factor",
599 "Correction factor to apply to the provided bandwidth (default value set by network model)",
600 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__bandwidth_factor, NULL);
601 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 1.0);
603 xbt_cfg_register(&_sg_cfg_set, "network/weight_S",
604 "Correction factor to apply to the weight of competing streams (default value set by network model)",
605 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__weight_S, NULL);
606 /* real default for "network/weight_S" is set in network_*.cpp */
607 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", NAN);
610 xbt_cfg_register(&_sg_cfg_set, "path",
611 "Lookup path for inclusions in platform and deployment XML files",
612 xbt_cfgelm_string, 1, 0, _sg_cfg_cb__surf_path, NULL);
614 xbt_cfg_register(&_sg_cfg_set, "cpu/maxmin_selective_update",
615 "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
616 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
617 xbt_cfg_setdefault_boolean(_sg_cfg_set, "cpu/maxmin_selective_update", "no");
619 xbt_cfg_register(&_sg_cfg_set, "network/maxmin_selective_update",
620 "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
621 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
622 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/maxmin_selective_update", "no");
624 /* Replay (this part is enabled event if MC it disabled) */
625 xbt_cfg_register(&_sg_cfg_set, "model-check/replay",
626 "Uenable replay mode with the given path",
627 xbt_cfgelm_string, 0, 1, _sg_cfg_cb_model_check_replay, NULL);
630 /* do model-checking */
631 xbt_cfg_register(&_sg_cfg_set, "model-check",
632 "Verify the system through model-checking instead of simulating it (EXPERIMENTAL)",
633 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_model_check, NULL);
634 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check", "no");
636 /* do model-checking-record */
637 xbt_cfg_register(&_sg_cfg_set, "model-check/record",
638 "Record the model-checking paths",
639 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_model_check_record, NULL);
640 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/record", "no");
642 /* do stateful model-checking */
643 xbt_cfg_register(&_sg_cfg_set, "model-check/checkpoint",
644 "Specify the amount of steps between checkpoints during stateful model-checking (default: 0 => stateless verification). "
645 "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.",
646 xbt_cfgelm_int, 1, 1, _mc_cfg_cb_checkpoint, NULL);
647 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/checkpoint", 0);
649 /* do stateful model-checking */
650 xbt_cfg_register(&_sg_cfg_set, "model-check/sparse-checkpoint",
651 "Use sparse per-page snapshots.",
652 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_sparse_checkpoint, NULL);
653 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/sparse-checkpoint", "no");
655 /* do liveness model-checking */
656 xbt_cfg_register(&_sg_cfg_set, "model-check/property",
657 "Specify the name of the file containing the property. It must be the result of the ltl2ba program.",
658 xbt_cfgelm_string, 1, 1, _mc_cfg_cb_property, NULL);
659 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/property", "");
661 /* do communications determinism model-checking */
662 xbt_cfg_register(&_sg_cfg_set, "model-check/communications_determinism",
663 "Enable/disable the detection of determinism in the communications schemes",
664 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_comms_determinism, NULL);
665 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/communications_determinism", "no");
667 /* do send determinism model-checking */
668 xbt_cfg_register(&_sg_cfg_set, "model-check/send_determinism",
669 "Enable/disable the detection of send-determinism in the communications schemes",
670 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_send_determinism, NULL);
671 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/send_determinism", "no");
673 /* Specify the kind of model-checking reduction */
674 xbt_cfg_register(&_sg_cfg_set, "model-check/reduction",
675 "Specify the kind of exploration reduction (either none or DPOR)",
676 xbt_cfgelm_string, 1, 1, _mc_cfg_cb_reduce, NULL);
677 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/reduction", "dpor");
679 /* Enable/disable timeout for wait requests with model-checking */
680 xbt_cfg_register(&_sg_cfg_set, "model-check/timeout",
681 "Enable/Disable timeout for wait requests",
682 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_timeout, NULL);
683 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/timeout", "no");
685 /* Enable/disable global hash computation with model-checking */
686 xbt_cfg_register(&_sg_cfg_set, "model-check/hash",
687 "Enable/Disable state hash for state comparison (exprimental)",
688 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_hash, NULL);
689 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/hash", "no");
691 /* Set max depth exploration */
692 /* Currently, this option cannot be used. */
693 xbt_cfg_register(&_sg_cfg_set, "model-check/snapshot_fds",
694 "Whether file descriptors must be snapshoted",
695 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_snapshot_fds, NULL);
696 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/snapshot_fds", "no");
698 /* Set max depth exploration */
699 xbt_cfg_register(&_sg_cfg_set, "model-check/max_depth",
700 "Specify the max depth of exploration (default : 1000)",
701 xbt_cfgelm_int, 1, 1, _mc_cfg_cb_max_depth, NULL);
702 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/max_depth", 1000);
704 /* Set number of visited state stored for state comparison reduction*/
705 xbt_cfg_register(&_sg_cfg_set, "model-check/visited",
706 "Specify the number of visited state stored for state comparison reduction. If value=5, the last 5 visited states are stored",
707 xbt_cfgelm_int, 1, 1, _mc_cfg_cb_visited, NULL);
708 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/visited", 0);
710 /* Set file name for dot output of graph state */
711 xbt_cfg_register(&_sg_cfg_set, "model-check/dot_output",
712 "Specify the name of dot file corresponding to graph state",
713 xbt_cfgelm_string, 1, 1, _mc_cfg_cb_dot_output, NULL);
714 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/dot_output", "");
716 /* Enable/disable non progressive cycles detection with model-checking */
717 xbt_cfg_register(&_sg_cfg_set, "model-check/termination",
718 "Enable/Disable non progressive cycle detection",
719 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_termination, NULL);
720 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/termination", "no");
723 /* do verbose-exit */
724 xbt_cfg_register(&_sg_cfg_set, "verbose-exit",
725 "Activate the \"do nothing\" mode in Ctrl-C",
726 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_verbose_exit, NULL);
727 xbt_cfg_setdefault_boolean(_sg_cfg_set, "verbose-exit", "yes");
729 /* context factory */
730 const char *dflt_ctx_fact = "thread";
732 char *p = description +
734 "Context factory to use in SIMIX. Possible values: %s",
736 #ifdef CONTEXT_UCONTEXT
737 dflt_ctx_fact = "ucontext";
738 p += sprintf(p, ", %s", dflt_ctx_fact);
741 dflt_ctx_fact = "raw";
742 p += sprintf(p, ", %s", dflt_ctx_fact);
746 xbt_cfg_register(&_sg_cfg_set, "contexts/factory", description,
747 xbt_cfgelm_string, 1, 1, _sg_cfg_cb_context_factory, NULL);
748 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/factory", dflt_ctx_fact);
750 /* stack size of contexts in KiB */
751 xbt_cfg_register(&_sg_cfg_set, "contexts/stack_size",
752 "Stack size of contexts in KiB",
753 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_context_stack_size, NULL);
754 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/stack_size", 8*1024);
755 /* No, it was not set yet (the above setdefault() changed this to 1). */
756 smx_context_stack_size_was_set = 0;
758 /* guard size for contexts stacks in memory pages */
759 xbt_cfg_register(&_sg_cfg_set, "contexts/guard_size",
760 "Guard size for contexts stacks in memory pages",
761 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_context_guard_size, NULL);
762 #if defined(_XBT_WIN32) || (PTH_STACKGROWTH != -1)
763 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/guard_size", 0);
765 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/guard_size", 1);
767 /* No, it was not set yet (the above setdefault() changed this to 1). */
768 smx_context_guard_size_was_set = 0;
770 /* number of parallel threads for user processes */
771 xbt_cfg_register(&_sg_cfg_set, "contexts/nthreads",
772 "Number of parallel threads used to execute user contexts",
773 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_nthreads, NULL);
774 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/nthreads", 1);
776 /* minimal number of user contexts to be run in parallel */
777 xbt_cfg_register(&_sg_cfg_set, "contexts/parallel_threshold",
778 "Minimal number of user contexts to be run in parallel (raw contexts only)",
779 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_parallel_threshold, NULL);
780 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/parallel_threshold", 2);
782 /* synchronization mode for parallel user contexts */
783 xbt_cfg_register(&_sg_cfg_set, "contexts/synchro",
784 "Synchronization mode to use when running contexts in parallel (either futex, posix or busy_wait)",
785 xbt_cfgelm_string, 1, 1, _sg_cfg_cb_contexts_parallel_mode, NULL);
787 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "futex");
788 #else //No futex on mac and posix is unimplememted yet
789 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "busy_wait");
792 xbt_cfg_register(&_sg_cfg_set, "network/coordinates",
793 "\"yes\" or \"no\", specifying whether we use a coordinate-based routing (as Vivaldi)",
794 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb__surf_network_coordinates, NULL);
795 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/coordinates", "no");
797 xbt_cfg_register(&_sg_cfg_set, "network/crosstraffic",
798 "Activate the interferences between uploads and downloads for fluid max-min models (LV08, CM02)",
799 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb__surf_network_crosstraffic, NULL);
800 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/crosstraffic", "no");
803 xbt_cfg_register(&_sg_cfg_set, "gtnets/jitter",
804 "Double value to oscillate the link latency, uniformly in random interval [-latency*gtnets_jitter,latency*gtnets_jitter)",
805 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__gtnets_jitter, NULL);
806 xbt_cfg_setdefault_double(_sg_cfg_set, "gtnets/jitter", 0.0);
808 xbt_cfg_register(&_sg_cfg_set, "gtnets/jitter_seed",
809 "Use a positive seed to reproduce jitted results, value must be in [1,1e8], default is 10",
810 xbt_cfgelm_int, 0, 1, _sg_cfg_cb__gtnets_jitter_seed, NULL);
811 xbt_cfg_setdefault_int(_sg_cfg_set, "gtnets/jitter_seed", 10);
814 xbt_cfg_register(&_sg_cfg_set, "ns3/TcpModel",
815 "The ns3 tcp model can be : NewReno or Reno or Tahoe",
816 xbt_cfgelm_string, 1, 1, NULL, NULL);
817 xbt_cfg_setdefault_string(_sg_cfg_set, "ns3/TcpModel", "default");
820 //For smpi/bw_factor and smpi/lat_factor
821 //Default value have to be "threshold0:value0;threshold1:value1;...;thresholdN:valueN"
822 //test is if( size >= thresholdN ) return valueN;
823 //Values can be modified with command line --cfg=smpi/bw_factor:"threshold0:value0;threshold1:value1;...;thresholdN:valueN"
824 // or with tag config put line <prop id="smpi/bw_factor" value="threshold0:value0;threshold1:value1;...;thresholdN:valueN"></prop>
825 // SMPI model can be used without enable_smpi, so keep this the ifdef.
826 xbt_cfg_register(&_sg_cfg_set, "smpi/bw_factor",
827 "Bandwidth factors for smpi.",
828 xbt_cfgelm_string, 1, 1, NULL, NULL);
829 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");
831 xbt_cfg_register(&_sg_cfg_set, "smpi/lat_factor",
832 "Latency factors for smpi.",
833 xbt_cfgelm_string, 1, 1, NULL, NULL);
834 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");
836 xbt_cfg_register(&_sg_cfg_set, "smpi/IB_penalty_factors",
837 "Correction factor to communications using Infiniband model with contention (default value based on Stampede cluster profiling)",
838 xbt_cfgelm_string, 1, 1, NULL, NULL);
839 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/IB_penalty_factors", "0.965;0.925;1.35");
842 xbt_cfg_register(&_sg_cfg_set, "smpi/running_power",
843 "Power of the host running the simulation (in flop/s). Used to bench the operations.",
844 xbt_cfgelm_double, 1, 1, NULL, NULL);
845 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/running_power", 20000.0);
847 xbt_cfg_register(&_sg_cfg_set, "smpi/display_timing",
848 "Boolean indicating whether we should display the timing after simulation.",
849 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
850 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/display_timing", "no");
852 xbt_cfg_register(&_sg_cfg_set, "smpi/simulate_computation",
853 "Boolean indicating whether the computational part of the simulated application should be simulated.",
854 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
855 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/simulate_computation", "yes");
857 xbt_cfg_register(&_sg_cfg_set, "smpi/use_shared_malloc",
858 "Boolean indicating whether we should use shared memory when using SMPI_SHARED_MALLOC. Allows user to disable it for debug purposes.",
859 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
860 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/use_shared_malloc", "yes");
862 xbt_cfg_register(&_sg_cfg_set, "smpi/cpu_threshold",
863 "Minimal computation time (in seconds) not discarded, or -1 for infinity.",
864 xbt_cfgelm_double, 1, 1, NULL, NULL);
865 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/cpu_threshold", 1e-6);
867 xbt_cfg_register(&_sg_cfg_set, "smpi/async_small_thres",
868 "Maximal size of messages that are to be sent asynchronously, without waiting for the receiver",
869 xbt_cfgelm_int, 1, 1, NULL, NULL);
870 xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/async_small_thres", 0);
872 xbt_cfg_register(&_sg_cfg_set, "smpi/send_is_detached_thres",
873 "Threshold of message size where MPI_Send stops behaving like MPI_Isend and becomes MPI_Ssend",
874 xbt_cfgelm_int, 1, 1, NULL, NULL);
875 xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/send_is_detached_thres", 65536);
877 xbt_cfg_register(&_sg_cfg_set, "smpi/privatize_global_variables",
878 "Boolean indicating whether we should privatize global variable at runtime.",
879 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
880 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/privatize_global_variables", "no");
882 xbt_cfg_register(&_sg_cfg_set, "smpi/os",
883 "Small messages timings (MPI_Send minimum time for small messages)",
884 xbt_cfgelm_string, 1, 1, NULL, NULL);
885 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/os", "1:0:0:0:0");
887 xbt_cfg_register(&_sg_cfg_set, "smpi/ois",
888 "Small messages timings (MPI_Isend minimum time for small messages)",
889 xbt_cfgelm_string, 1, 1, NULL, NULL);
890 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/ois", "1:0:0:0:0");
892 xbt_cfg_register(&_sg_cfg_set, "smpi/or",
893 "Small messages timings (MPI_Recv minimum time for small messages)",
894 xbt_cfgelm_string, 1, 1, NULL, NULL);
895 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/or", "1:0:0:0:0");
897 xbt_cfg_register(&_sg_cfg_set, "smpi/iprobe",
898 "Minimum time to inject inside a call to MPI_Iprobe",
899 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__iprobe_sleep, NULL);
900 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/iprobe", 1e-4);
902 xbt_cfg_register(&_sg_cfg_set, "smpi/test",
903 "Minimum time to inject inside a call to MPI_Test",
904 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__test_sleep, NULL);
905 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/test", 1e-4);
907 xbt_cfg_register(&_sg_cfg_set, "smpi/wtime",
908 "Minimum time to inject inside a call to MPI_Wtime",
909 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__wtime_sleep, NULL);
910 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/wtime", 0.0);
912 xbt_cfg_register(&_sg_cfg_set, "smpi/coll_selector",
913 "Which collective selector to use",
914 xbt_cfgelm_string, 1, 1, NULL, NULL);
915 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/coll_selector", "default");
917 xbt_cfg_register(&_sg_cfg_set, "smpi/gather",
918 "Which collective to use for gather",
919 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_gather, NULL);
921 xbt_cfg_register(&_sg_cfg_set, "smpi/allgather",
922 "Which collective to use for allgather",
923 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allgather, NULL);
925 xbt_cfg_register(&_sg_cfg_set, "smpi/barrier",
926 "Which collective to use for barrier",
927 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_barrier, NULL);
929 xbt_cfg_register(&_sg_cfg_set, "smpi/reduce_scatter",
930 "Which collective to use for reduce_scatter",
931 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_reduce_scatter, NULL);
933 xbt_cfg_register(&_sg_cfg_set, "smpi/scatter",
934 "Which collective to use for scatter",
935 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_scatter, NULL);
937 xbt_cfg_register(&_sg_cfg_set, "smpi/allgatherv",
938 "Which collective to use for allgatherv",
939 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allgatherv, NULL);
941 xbt_cfg_register(&_sg_cfg_set, "smpi/allreduce",
942 "Which collective to use for allreduce",
943 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allreduce, NULL);
945 xbt_cfg_register(&_sg_cfg_set, "smpi/alltoall",
946 "Which collective to use for alltoall",
947 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_alltoall, NULL);
949 xbt_cfg_register(&_sg_cfg_set, "smpi/alltoallv",
950 "Which collective to use for alltoallv",
951 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_alltoallv, NULL);
953 xbt_cfg_register(&_sg_cfg_set, "smpi/bcast",
954 "Which collective to use for bcast",
955 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_bcast, NULL);
957 xbt_cfg_register(&_sg_cfg_set, "smpi/reduce",
958 "Which collective to use for reduce",
959 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_reduce, NULL);
962 xbt_cfg_register(&_sg_cfg_set, "exception/cutpath",
963 "\"yes\" or \"no\". \"yes\" will cut all path information from call traces, used e.g. in exceptions.",
964 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
965 xbt_cfg_setdefault_boolean(_sg_cfg_set, "exception/cutpath", "no");
967 xbt_cfg_register(&_sg_cfg_set, "clean_atexit",
968 "\"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.",
969 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_clean_atexit, NULL);
970 xbt_cfg_setdefault_boolean(_sg_cfg_set, "clean_atexit", "yes");
973 /* retrieves the current directory of the current process */
974 const char *initial_path = __surf_get_initial_path();
975 xbt_assert((initial_path),
976 "__surf_get_initial_path() failed! Can't resolve current Windows directory");
978 surf_path = xbt_dynar_new(sizeof(char *), NULL);
979 xbt_cfg_setdefault_string(_sg_cfg_set, "path", initial_path);
982 xbt_cfg_check(_sg_cfg_set);
983 _sg_cfg_init_status = 1;
985 sg_config_cmd_line(argc, argv);
987 xbt_mallocator_initialization_is_done(SIMIX_context_is_parallel());
990 XBT_WARN("Call to sg_config_init() after initialization ignored");
994 void sg_config_finalize(void)
996 if (!_sg_cfg_init_status)
997 return; /* Not initialized yet. Nothing to do */
999 xbt_cfg_free(&_sg_cfg_set);
1000 _sg_cfg_init_status = 0;
1003 /* Pick the right models for CPU, net and host, and call their model_init_preparse */
1004 void surf_config_models_setup()
1006 const char *host_model_name;
1007 const char *vm_model_name;
1010 char *network_model_name = NULL;
1011 char *cpu_model_name = NULL;
1012 int storage_id = -1;
1013 char *storage_model_name = NULL;
1015 host_model_name = xbt_cfg_get_string(_sg_cfg_set, "host/model");
1016 vm_model_name = xbt_cfg_get_string(_sg_cfg_set, "vm/model");
1017 network_model_name = xbt_cfg_get_string(_sg_cfg_set, "network/model");
1018 cpu_model_name = xbt_cfg_get_string(_sg_cfg_set, "cpu/model");
1019 storage_model_name = xbt_cfg_get_string(_sg_cfg_set, "storage/model");
1021 /* Check whether we use a net/cpu model differing from the default ones, in which case
1022 * we should switch to the "compound" host model to correctly dispatch stuff to
1023 * the right net/cpu models.
1026 if ((!xbt_cfg_is_default_value(_sg_cfg_set, "network/model") ||
1027 !xbt_cfg_is_default_value(_sg_cfg_set, "cpu/model")) &&
1028 xbt_cfg_is_default_value(_sg_cfg_set, "host/model")) {
1029 host_model_name = "compound";
1030 xbt_cfg_set_string(_sg_cfg_set, "host/model", host_model_name);
1033 XBT_DEBUG("host model: %s", host_model_name);
1034 host_id = find_model_description(surf_host_model_description, host_model_name);
1035 if (!strcmp(host_model_name, "compound")) {
1036 int network_id = -1;
1039 xbt_assert(cpu_model_name,
1040 "Set a cpu model to use with the 'compound' host model");
1042 xbt_assert(network_model_name,
1043 "Set a network model to use with the 'compound' host model");
1045 if(surf_cpu_model_init_preparse){
1046 surf_cpu_model_init_preparse();
1049 find_model_description(surf_cpu_model_description, cpu_model_name);
1050 surf_cpu_model_description[cpu_id].model_init_preparse();
1054 find_model_description(surf_network_model_description,
1055 network_model_name);
1056 surf_network_model_description[network_id].model_init_preparse();
1059 XBT_DEBUG("Call host_model_init");
1060 surf_host_model_description[host_id].model_init_preparse();
1062 XBT_DEBUG("Call vm_model_init");
1063 vm_id = find_model_description(surf_vm_model_description, vm_model_name);
1064 surf_vm_model_description[vm_id].model_init_preparse();
1066 XBT_DEBUG("Call storage_model_init");
1067 storage_id = find_model_description(surf_storage_model_description, storage_model_name);
1068 surf_storage_model_description[storage_id].model_init_preparse();
1072 int sg_cfg_is_default_value(const char *name)
1074 return xbt_cfg_is_default_value(_sg_cfg_set, name);
1077 int sg_cfg_get_int(const char* name)
1079 return xbt_cfg_get_int(_sg_cfg_set, name);
1082 double sg_cfg_get_double(const char* name)
1084 return xbt_cfg_get_double(_sg_cfg_set, name);
1087 char* sg_cfg_get_string(const char* name)
1089 return xbt_cfg_get_string(_sg_cfg_set, name);
1092 int sg_cfg_get_boolean(const char* name)
1094 return xbt_cfg_get_boolean(_sg_cfg_set, name);
1097 void sg_cfg_get_peer(const char *name, char **peer, int *port)
1099 xbt_cfg_get_peer(_sg_cfg_set, name, peer, port);
1102 xbt_dynar_t sg_cfg_get_dynar(const char* name)
1104 return xbt_cfg_get_dynar(_sg_cfg_set, name);