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);
483 /* build description line with possible values */
484 static void describe_model(char *result,
485 const s_surf_model_description_t model_description[],
487 const char *description)
490 sprintf(result, "%s. Possible values: %s", description,
491 model_description[0].name ? model_description[0].name : "n/a");
493 for (i = 1; model_description[i].name; i++)
494 p += sprintf(p, ", %s", model_description[i].name);
496 ".\n (use 'help' as a value to see the long description of each %s)",
500 /* create the config set, register what should be and parse the command line*/
501 void sg_config_init(int *argc, char **argv)
503 char description[1024];
505 /* Create the configuration support */
506 if (_sg_cfg_init_status == 0) { /* Only create stuff if not already inited */
508 /* Plugins configuration */
509 describe_model(description, surf_plugin_description,
510 "plugin", "The plugins");
511 xbt_cfg_register(&_sg_cfg_set, "plugin", description,
512 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__plugin, NULL);
514 describe_model(description, surf_cpu_model_description,
515 "model", "The model to use for the CPU");
516 xbt_cfg_register(&_sg_cfg_set, "cpu/model", description,
517 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__cpu_model, NULL);
518 xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/model", "Cas01");
520 describe_model(description, surf_optimization_mode_description,
522 "The optimization modes to use for the CPU");
523 xbt_cfg_register(&_sg_cfg_set, "cpu/optim", description,
524 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode, NULL);
525 xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/optim", "Lazy");
527 describe_model(description, surf_storage_model_description,
528 "model", "The model to use for the storage");
529 xbt_cfg_register(&_sg_cfg_set, "storage/model", description,
530 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__storage_mode, NULL);
531 xbt_cfg_setdefault_string(_sg_cfg_set, "storage/model", "default");
533 describe_model(description, surf_network_model_description,
534 "model", "The model to use for the network");
535 xbt_cfg_register(&_sg_cfg_set, "network/model", description,
536 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__network_model, NULL);
537 xbt_cfg_setdefault_string(_sg_cfg_set, "network/model", "LV08");
539 describe_model(description, surf_optimization_mode_description,
541 "The optimization modes to use for the network");
542 xbt_cfg_register(&_sg_cfg_set, "network/optim", description,
543 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode, NULL);
544 xbt_cfg_setdefault_string(_sg_cfg_set, "network/optim", "Lazy");
546 describe_model(description, surf_host_model_description,
547 "model", "The model to use for the host");
548 xbt_cfg_register(&_sg_cfg_set, "host/model", description,
549 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__host_model, NULL);
550 xbt_cfg_setdefault_string(_sg_cfg_set, "host/model", "default");
552 describe_model(description, surf_vm_model_description,
553 "model", "The model to use for the vm");
554 xbt_cfg_register(&_sg_cfg_set, "vm/model", description,
555 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__vm_model, NULL);
556 xbt_cfg_setdefault_string(_sg_cfg_set, "vm/model", "default");
558 xbt_cfg_register(&_sg_cfg_set, "network/TCP_gamma",
559 "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)",
560 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__tcp_gamma, NULL);
561 xbt_cfg_setdefault_double(_sg_cfg_set, "network/TCP_gamma", 4194304.0);
563 xbt_cfg_register(&_sg_cfg_set, "surf/precision",
564 "Numerical precision used when updating simulation times (hence this value is expressed in seconds)",
565 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__surf_precision, NULL);
566 xbt_cfg_setdefault_double(_sg_cfg_set, "surf/precision", 0.00001);
568 xbt_cfg_register(&_sg_cfg_set, "maxmin/precision",
569 "Numerical precision used when computing resource sharing (hence this value is expressed in ops/sec or bytes/sec)",
570 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__maxmin_precision, NULL);
571 xbt_cfg_setdefault_double(_sg_cfg_set, "maxmin/precision", 0.00001);
573 /* The parameters of network models */
575 xbt_cfg_register(&_sg_cfg_set, "network/sender_gap",
576 "Minimum gap between two overlapping sends",
577 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__sender_gap, NULL);
578 /* real default for "network/sender_gap" is set in network_smpi.cpp */
579 xbt_cfg_setdefault_double(_sg_cfg_set, "network/sender_gap", NAN);
581 xbt_cfg_register(&_sg_cfg_set, "network/latency_factor",
582 "Correction factor to apply to the provided latency (default value set by network model)",
583 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__latency_factor, NULL);
584 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 1.0);
586 xbt_cfg_register(&_sg_cfg_set, "network/bandwidth_factor",
587 "Correction factor to apply to the provided bandwidth (default value set by network model)",
588 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__bandwidth_factor, NULL);
589 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 1.0);
591 xbt_cfg_register(&_sg_cfg_set, "network/weight_S",
592 "Correction factor to apply to the weight of competing streams (default value set by network model)",
593 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__weight_S, NULL);
594 /* real default for "network/weight_S" is set in network_*.cpp */
595 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", NAN);
598 xbt_cfg_register(&_sg_cfg_set, "path",
599 "Lookup path for inclusions in platform and deployment XML files",
600 xbt_cfgelm_string, 1, 0, _sg_cfg_cb__surf_path, NULL);
602 xbt_cfg_register(&_sg_cfg_set, "cpu/maxmin_selective_update",
603 "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
604 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
605 xbt_cfg_setdefault_boolean(_sg_cfg_set, "cpu/maxmin_selective_update", "no");
607 xbt_cfg_register(&_sg_cfg_set, "network/maxmin_selective_update",
608 "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
609 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
610 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/maxmin_selective_update", "no");
612 /* Replay (this part is enabled event if MC it disabled) */
613 xbt_cfg_register(&_sg_cfg_set, "model-check/replay",
614 "Uenable replay mode with the given path",
615 xbt_cfgelm_string, 0, 1, _sg_cfg_cb_model_check_replay, NULL);
618 /* do model-checking */
619 xbt_cfg_register(&_sg_cfg_set, "model-check",
620 "Verify the system through model-checking instead of simulating it (EXPERIMENTAL)",
621 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_model_check, NULL);
622 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check", "no");
624 /* do model-checking-record */
625 xbt_cfg_register(&_sg_cfg_set, "model-check/record",
626 "Record the model-checking paths",
627 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_model_check_record, NULL);
628 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/record", "no");
630 /* do stateful model-checking */
631 xbt_cfg_register(&_sg_cfg_set, "model-check/checkpoint",
632 "Specify the amount of steps between checkpoints during stateful model-checking (default: 0 => stateless verification). "
633 "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.",
634 xbt_cfgelm_int, 1, 1, _mc_cfg_cb_checkpoint, NULL);
635 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/checkpoint", 0);
637 /* do stateful model-checking */
638 xbt_cfg_register(&_sg_cfg_set, "model-check/sparse-checkpoint",
639 "Use sparse per-page snapshots.",
640 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_sparse_checkpoint, NULL);
641 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/sparse-checkpoint", "no");
643 /* do liveness model-checking */
644 xbt_cfg_register(&_sg_cfg_set, "model-check/property",
645 "Specify the name of the file containing the property. It must be the result of the ltl2ba program.",
646 xbt_cfgelm_string, 1, 1, _mc_cfg_cb_property, NULL);
647 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/property", "");
649 /* do communications determinism model-checking */
650 xbt_cfg_register(&_sg_cfg_set, "model-check/communications_determinism",
651 "Enable/disable the detection of determinism in the communications schemes",
652 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_comms_determinism, NULL);
653 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/communications_determinism", "no");
655 /* do send determinism model-checking */
656 xbt_cfg_register(&_sg_cfg_set, "model-check/send_determinism",
657 "Enable/disable the detection of send-determinism in the communications schemes",
658 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_send_determinism, NULL);
659 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/send_determinism", "no");
661 /* Specify the kind of model-checking reduction */
662 xbt_cfg_register(&_sg_cfg_set, "model-check/reduction",
663 "Specify the kind of exploration reduction (either none or DPOR)",
664 xbt_cfgelm_string, 1, 1, _mc_cfg_cb_reduce, NULL);
665 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/reduction", "dpor");
667 /* Enable/disable timeout for wait requests with model-checking */
668 xbt_cfg_register(&_sg_cfg_set, "model-check/timeout",
669 "Enable/Disable timeout for wait requests",
670 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_timeout, NULL);
671 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/timeout", "no");
673 /* Enable/disable global hash computation with model-checking */
674 xbt_cfg_register(&_sg_cfg_set, "model-check/hash",
675 "Enable/Disable state hash for state comparison (exprimental)",
676 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_hash, NULL);
677 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/hash", "no");
679 /* Set max depth exploration */
680 /* Currently, this option cannot be used. */
681 xbt_cfg_register(&_sg_cfg_set, "model-check/snapshot_fds",
682 "Whether file descriptors must be snapshoted",
683 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_snapshot_fds, NULL);
684 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/snapshot_fds", "no");
686 /* Set max depth exploration */
687 xbt_cfg_register(&_sg_cfg_set, "model-check/max_depth",
688 "Specify the max depth of exploration (default : 1000)",
689 xbt_cfgelm_int, 1, 1, _mc_cfg_cb_max_depth, NULL);
690 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/max_depth", 1000);
692 /* Set number of visited state stored for state comparison reduction*/
693 xbt_cfg_register(&_sg_cfg_set, "model-check/visited",
694 "Specify the number of visited state stored for state comparison reduction. If value=5, the last 5 visited states are stored",
695 xbt_cfgelm_int, 1, 1, _mc_cfg_cb_visited, NULL);
696 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/visited", 0);
698 /* Set file name for dot output of graph state */
699 xbt_cfg_register(&_sg_cfg_set, "model-check/dot_output",
700 "Specify the name of dot file corresponding to graph state",
701 xbt_cfgelm_string, 1, 1, _mc_cfg_cb_dot_output, NULL);
702 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/dot_output", "");
704 /* Enable/disable non progressive cycles detection with model-checking */
705 xbt_cfg_register(&_sg_cfg_set, "model-check/termination",
706 "Enable/Disable non progressive cycle detection",
707 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_termination, NULL);
708 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/termination", "no");
711 /* do verbose-exit */
712 xbt_cfg_register(&_sg_cfg_set, "verbose-exit",
713 "Activate the \"do nothing\" mode in Ctrl-C",
714 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_verbose_exit, NULL);
715 xbt_cfg_setdefault_boolean(_sg_cfg_set, "verbose-exit", "yes");
717 /* context factory */
718 const char *dflt_ctx_fact = "thread";
720 char *p = description +
722 "Context factory to use in SIMIX. Possible values: %s",
724 #ifdef CONTEXT_UCONTEXT
725 dflt_ctx_fact = "ucontext";
726 p += sprintf(p, ", %s", dflt_ctx_fact);
729 dflt_ctx_fact = "raw";
730 p += sprintf(p, ", %s", dflt_ctx_fact);
734 xbt_cfg_register(&_sg_cfg_set, "contexts/factory", description,
735 xbt_cfgelm_string, 1, 1, _sg_cfg_cb_context_factory, NULL);
736 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/factory", dflt_ctx_fact);
738 /* stack size of contexts in KiB */
739 xbt_cfg_register(&_sg_cfg_set, "contexts/stack_size",
740 "Stack size of contexts in KiB",
741 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_context_stack_size, NULL);
742 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/stack_size", 8*1024);
743 /* No, it was not set yet (the above setdefault() changed this to 1). */
744 smx_context_stack_size_was_set = 0;
746 /* guard size for contexts stacks in memory pages */
747 xbt_cfg_register(&_sg_cfg_set, "contexts/guard_size",
748 "Guard size for contexts stacks in memory pages",
749 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_context_guard_size, NULL);
750 #if defined(_XBT_WIN32) || (PTH_STACKGROWTH != -1)
751 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/guard_size", 0);
753 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/guard_size", 1);
755 /* No, it was not set yet (the above setdefault() changed this to 1). */
756 smx_context_guard_size_was_set = 0;
758 /* number of parallel threads for user processes */
759 xbt_cfg_register(&_sg_cfg_set, "contexts/nthreads",
760 "Number of parallel threads used to execute user contexts",
761 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_nthreads, NULL);
762 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/nthreads", 1);
764 /* minimal number of user contexts to be run in parallel */
765 xbt_cfg_register(&_sg_cfg_set, "contexts/parallel_threshold",
766 "Minimal number of user contexts to be run in parallel (raw contexts only)",
767 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_parallel_threshold, NULL);
768 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/parallel_threshold", 2);
770 /* synchronization mode for parallel user contexts */
771 xbt_cfg_register(&_sg_cfg_set, "contexts/synchro",
772 "Synchronization mode to use when running contexts in parallel (either futex, posix or busy_wait)",
773 xbt_cfgelm_string, 1, 1, _sg_cfg_cb_contexts_parallel_mode, NULL);
775 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "futex");
776 #else //No futex on mac and posix is unimplememted yet
777 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "busy_wait");
780 xbt_cfg_register(&_sg_cfg_set, "network/coordinates",
781 "\"yes\" or \"no\", specifying whether we use a coordinate-based routing (as Vivaldi)",
782 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb__surf_network_coordinates, NULL);
783 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/coordinates", "no");
785 xbt_cfg_register(&_sg_cfg_set, "network/crosstraffic",
786 "Activate the interferences between uploads and downloads for fluid max-min models (LV08, CM02)",
787 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb__surf_network_crosstraffic, NULL);
788 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/crosstraffic", "no");
791 xbt_cfg_register(&_sg_cfg_set, "ns3/TcpModel",
792 "The ns3 tcp model can be : NewReno or Reno or Tahoe",
793 xbt_cfgelm_string, 1, 1, NULL, NULL);
794 xbt_cfg_setdefault_string(_sg_cfg_set, "ns3/TcpModel", "default");
797 //For smpi/bw_factor and smpi/lat_factor
798 //Default value have to be "threshold0:value0;threshold1:value1;...;thresholdN:valueN"
799 //test is if( size >= thresholdN ) return valueN;
800 //Values can be modified with command line --cfg=smpi/bw_factor:"threshold0:value0;threshold1:value1;...;thresholdN:valueN"
801 // or with tag config put line <prop id="smpi/bw_factor" value="threshold0:value0;threshold1:value1;...;thresholdN:valueN"></prop>
802 // SMPI model can be used without enable_smpi, so keep this the ifdef.
803 xbt_cfg_register(&_sg_cfg_set, "smpi/bw_factor",
804 "Bandwidth factors for smpi.",
805 xbt_cfgelm_string, 1, 1, NULL, NULL);
806 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");
808 xbt_cfg_register(&_sg_cfg_set, "smpi/lat_factor",
809 "Latency factors for smpi.",
810 xbt_cfgelm_string, 1, 1, NULL, NULL);
811 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");
813 xbt_cfg_register(&_sg_cfg_set, "smpi/IB_penalty_factors",
814 "Correction factor to communications using Infiniband model with contention (default value based on Stampede cluster profiling)",
815 xbt_cfgelm_string, 1, 1, NULL, NULL);
816 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/IB_penalty_factors", "0.965;0.925;1.35");
819 xbt_cfg_register(&_sg_cfg_set, "smpi/running_power",
820 "Power of the host running the simulation (in flop/s). Used to bench the operations.",
821 xbt_cfgelm_double, 1, 1, NULL, NULL);
822 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/running_power", 20000.0);
824 xbt_cfg_register(&_sg_cfg_set, "smpi/display_timing",
825 "Boolean indicating whether we should display the timing after simulation.",
826 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
827 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/display_timing", "no");
829 xbt_cfg_register(&_sg_cfg_set, "smpi/simulate_computation",
830 "Boolean indicating whether the computational part of the simulated application should be simulated.",
831 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
832 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/simulate_computation", "yes");
834 xbt_cfg_register(&_sg_cfg_set, "smpi/use_shared_malloc",
835 "Boolean indicating whether we should use shared memory when using SMPI_SHARED_MALLOC. Allows user to disable it for debug purposes.",
836 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
837 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/use_shared_malloc", "yes");
839 xbt_cfg_register(&_sg_cfg_set, "smpi/cpu_threshold",
840 "Minimal computation time (in seconds) not discarded, or -1 for infinity.",
841 xbt_cfgelm_double, 1, 1, NULL, NULL);
842 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/cpu_threshold", 1e-6);
844 xbt_cfg_register(&_sg_cfg_set, "smpi/async_small_thres",
845 "Maximal size of messages that are to be sent asynchronously, without waiting for the receiver",
846 xbt_cfgelm_int, 1, 1, NULL, NULL);
847 xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/async_small_thres", 0);
849 xbt_cfg_register(&_sg_cfg_set, "smpi/send_is_detached_thres",
850 "Threshold of message size where MPI_Send stops behaving like MPI_Isend and becomes MPI_Ssend",
851 xbt_cfgelm_int, 1, 1, NULL, NULL);
852 xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/send_is_detached_thres", 65536);
854 xbt_cfg_register(&_sg_cfg_set, "smpi/privatize_global_variables",
855 "Boolean indicating whether we should privatize global variable at runtime.",
856 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
857 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/privatize_global_variables", "no");
859 xbt_cfg_register(&_sg_cfg_set, "smpi/os",
860 "Small messages timings (MPI_Send minimum time for small messages)",
861 xbt_cfgelm_string, 1, 1, NULL, NULL);
862 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/os", "1:0:0:0:0");
864 xbt_cfg_register(&_sg_cfg_set, "smpi/ois",
865 "Small messages timings (MPI_Isend minimum time for small messages)",
866 xbt_cfgelm_string, 1, 1, NULL, NULL);
867 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/ois", "1:0:0:0:0");
869 xbt_cfg_register(&_sg_cfg_set, "smpi/or",
870 "Small messages timings (MPI_Recv minimum time for small messages)",
871 xbt_cfgelm_string, 1, 1, NULL, NULL);
872 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/or", "1:0:0:0:0");
874 xbt_cfg_register(&_sg_cfg_set, "smpi/iprobe",
875 "Minimum time to inject inside a call to MPI_Iprobe",
876 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__iprobe_sleep, NULL);
877 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/iprobe", 1e-4);
879 xbt_cfg_register(&_sg_cfg_set, "smpi/test",
880 "Minimum time to inject inside a call to MPI_Test",
881 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__test_sleep, NULL);
882 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/test", 1e-4);
884 xbt_cfg_register(&_sg_cfg_set, "smpi/wtime",
885 "Minimum time to inject inside a call to MPI_Wtime",
886 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__wtime_sleep, NULL);
887 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/wtime", 0.0);
889 xbt_cfg_register(&_sg_cfg_set, "smpi/coll_selector",
890 "Which collective selector to use",
891 xbt_cfgelm_string, 1, 1, NULL, NULL);
892 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/coll_selector", "default");
894 xbt_cfg_register(&_sg_cfg_set, "smpi/gather",
895 "Which collective to use for gather",
896 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_gather, NULL);
898 xbt_cfg_register(&_sg_cfg_set, "smpi/allgather",
899 "Which collective to use for allgather",
900 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allgather, NULL);
902 xbt_cfg_register(&_sg_cfg_set, "smpi/barrier",
903 "Which collective to use for barrier",
904 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_barrier, NULL);
906 xbt_cfg_register(&_sg_cfg_set, "smpi/reduce_scatter",
907 "Which collective to use for reduce_scatter",
908 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_reduce_scatter, NULL);
910 xbt_cfg_register(&_sg_cfg_set, "smpi/scatter",
911 "Which collective to use for scatter",
912 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_scatter, NULL);
914 xbt_cfg_register(&_sg_cfg_set, "smpi/allgatherv",
915 "Which collective to use for allgatherv",
916 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allgatherv, NULL);
918 xbt_cfg_register(&_sg_cfg_set, "smpi/allreduce",
919 "Which collective to use for allreduce",
920 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allreduce, NULL);
922 xbt_cfg_register(&_sg_cfg_set, "smpi/alltoall",
923 "Which collective to use for alltoall",
924 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_alltoall, NULL);
926 xbt_cfg_register(&_sg_cfg_set, "smpi/alltoallv",
927 "Which collective to use for alltoallv",
928 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_alltoallv, NULL);
930 xbt_cfg_register(&_sg_cfg_set, "smpi/bcast",
931 "Which collective to use for bcast",
932 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_bcast, NULL);
934 xbt_cfg_register(&_sg_cfg_set, "smpi/reduce",
935 "Which collective to use for reduce",
936 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_reduce, NULL);
939 xbt_cfg_register(&_sg_cfg_set, "exception/cutpath",
940 "\"yes\" or \"no\". \"yes\" will cut all path information from call traces, used e.g. in exceptions.",
941 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
942 xbt_cfg_setdefault_boolean(_sg_cfg_set, "exception/cutpath", "no");
944 xbt_cfg_register(&_sg_cfg_set, "clean_atexit",
945 "\"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.",
946 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_clean_atexit, NULL);
947 xbt_cfg_setdefault_boolean(_sg_cfg_set, "clean_atexit", "yes");
950 /* retrieves the current directory of the current process */
951 const char *initial_path = __surf_get_initial_path();
952 xbt_assert((initial_path),
953 "__surf_get_initial_path() failed! Can't resolve current Windows directory");
955 surf_path = xbt_dynar_new(sizeof(char *), NULL);
956 xbt_cfg_setdefault_string(_sg_cfg_set, "path", initial_path);
959 xbt_cfg_check(_sg_cfg_set);
960 _sg_cfg_init_status = 1;
962 sg_config_cmd_line(argc, argv);
964 xbt_mallocator_initialization_is_done(SIMIX_context_is_parallel());
967 XBT_WARN("Call to sg_config_init() after initialization ignored");
971 void sg_config_finalize(void)
973 if (!_sg_cfg_init_status)
974 return; /* Not initialized yet. Nothing to do */
976 xbt_cfg_free(&_sg_cfg_set);
977 _sg_cfg_init_status = 0;
980 /* Pick the right models for CPU, net and host, and call their model_init_preparse */
981 void surf_config_models_setup()
983 const char *host_model_name;
984 const char *vm_model_name;
987 char *network_model_name = NULL;
988 char *cpu_model_name = NULL;
990 char *storage_model_name = NULL;
992 host_model_name = xbt_cfg_get_string(_sg_cfg_set, "host/model");
993 vm_model_name = xbt_cfg_get_string(_sg_cfg_set, "vm/model");
994 network_model_name = xbt_cfg_get_string(_sg_cfg_set, "network/model");
995 cpu_model_name = xbt_cfg_get_string(_sg_cfg_set, "cpu/model");
996 storage_model_name = xbt_cfg_get_string(_sg_cfg_set, "storage/model");
998 /* Check whether we use a net/cpu model differing from the default ones, in which case
999 * we should switch to the "compound" host model to correctly dispatch stuff to
1000 * the right net/cpu models.
1003 if ((!xbt_cfg_is_default_value(_sg_cfg_set, "network/model") ||
1004 !xbt_cfg_is_default_value(_sg_cfg_set, "cpu/model")) &&
1005 xbt_cfg_is_default_value(_sg_cfg_set, "host/model")) {
1006 host_model_name = "compound";
1007 xbt_cfg_set_string(_sg_cfg_set, "host/model", host_model_name);
1010 XBT_DEBUG("host model: %s", host_model_name);
1011 host_id = find_model_description(surf_host_model_description, host_model_name);
1012 if (!strcmp(host_model_name, "compound")) {
1013 int network_id = -1;
1016 xbt_assert(cpu_model_name,
1017 "Set a cpu model to use with the 'compound' host model");
1019 xbt_assert(network_model_name,
1020 "Set a network model to use with the 'compound' host model");
1022 if(surf_cpu_model_init_preparse){
1023 surf_cpu_model_init_preparse();
1026 find_model_description(surf_cpu_model_description, cpu_model_name);
1027 surf_cpu_model_description[cpu_id].model_init_preparse();
1031 find_model_description(surf_network_model_description,
1032 network_model_name);
1033 surf_network_model_description[network_id].model_init_preparse();
1036 XBT_DEBUG("Call host_model_init");
1037 surf_host_model_description[host_id].model_init_preparse();
1039 XBT_DEBUG("Call vm_model_init");
1040 vm_id = find_model_description(surf_vm_model_description, vm_model_name);
1041 surf_vm_model_description[vm_id].model_init_preparse();
1043 XBT_DEBUG("Call storage_model_init");
1044 storage_id = find_model_description(surf_storage_model_description, storage_model_name);
1045 surf_storage_model_description[storage_id].model_init_preparse();
1049 int sg_cfg_is_default_value(const char *name)
1051 return xbt_cfg_is_default_value(_sg_cfg_set, name);
1054 int sg_cfg_get_int(const char* name)
1056 return xbt_cfg_get_int(_sg_cfg_set, name);
1059 double sg_cfg_get_double(const char* name)
1061 return xbt_cfg_get_double(_sg_cfg_set, name);
1064 char* sg_cfg_get_string(const char* name)
1066 return xbt_cfg_get_string(_sg_cfg_set, name);
1069 int sg_cfg_get_boolean(const char* name)
1071 return xbt_cfg_get_boolean(_sg_cfg_set, name);
1074 void sg_cfg_get_peer(const char *name, char **peer, int *port)
1076 xbt_cfg_get_peer(_sg_cfg_set, name, peer, port);
1079 xbt_dynar_t sg_cfg_get_dynar(const char* name)
1081 return xbt_cfg_get_dynar(_sg_cfg_set, name);