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"
22 #include "smpi/smpi_interface.h"
25 #include "mc/mc_record.h"
26 #include "simgrid/instr.h"
27 #include "mc/mc_replay.h"
29 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_config, surf,
30 "About the configuration of simgrid");
32 xbt_cfg_t _sg_cfg_set = NULL;
34 /* 0: beginning of time (config cannot be changed yet);
35 * 1: initialized: cfg_set created (config can now be changed);
36 * 2: configured: command line parsed and config part of platform file was
37 * integrated also, platform construction ongoing or done.
38 * (Config cannot be changed anymore!)
40 int _sg_cfg_init_status = 0;
42 /* instruct the upper layer (simix or simdag) to exit as soon as possible
44 int _sg_cfg_exit_asap = 0;
46 #define sg_cfg_exit_early() do { _sg_cfg_exit_asap = 1; return; } while (0)
48 /* Parse the command line, looking for options */
49 static void sg_config_cmd_line(int *argc, char **argv)
55 for (j = i = 1; i < *argc; i++) {
56 if (!strncmp(argv[i], "--cfg=", strlen("--cfg="))) {
57 opt = strchr(argv[i], '=');
60 xbt_cfg_set_parse(_sg_cfg_set, opt);
61 XBT_DEBUG("Did apply '%s' as config setting", opt);
62 } else if (!strcmp(argv[i], "--version")) {
63 printf("%s\n", SIMGRID_VERSION_STRING);
65 } else if (!strcmp(argv[i], "--cfg-help") || !strcmp(argv[i], "--help")) {
67 ("Description of the configuration accepted by this simulator:\n");
68 xbt_cfg_help(_sg_cfg_set);
71 "Each of these configurations can be used by adding\n"
72 " --cfg=<option name>:<option value>\n"
73 "to the command line.\n"
75 "You can also use --help-models to see the details of all models known by this simulator.\n"
77 "You can also use --help-tracing to see the details of all tracing options known by this simulator.\n"
79 "You can also use --help-logs and --help-log-categories to see the details of logging output.\n"
81 "You can also use --version to get SimGrid version information.\n"
85 } else if (!strcmp(argv[i], "--help-models")) {
88 model_help("host", surf_host_model_description);
90 model_help("CPU", surf_cpu_model_description);
92 model_help("network", surf_network_model_description);
93 printf("\nLong description of all optimization levels accepted by the models of this simulator:\n");
94 for (k = 0; surf_optimization_mode_description[k].name; k++)
96 surf_optimization_mode_description[k].name,
97 surf_optimization_mode_description[k].description);
98 printf("Both network and CPU models have 'Lazy' as default optimization level\n\n");
100 } else if (!strcmp(argv[i], "--help-tracing")) {
115 /* callback of the plugin variable */
116 static void _sg_cfg_cb__plugin(const char *name, int pos)
121 xbt_assert(_sg_cfg_init_status < 2,
122 "Cannot load a plugin after the initialization");
124 val = xbt_cfg_get_string(_sg_cfg_set, name);
126 if (!strcmp(val, "help")) {
127 model_help("plugin", surf_plugin_description);
131 /* New Module missing */
132 int plugin_id = find_model_description(surf_plugin_description, val);
133 surf_plugin_description[plugin_id].model_init_preparse();
136 /* callback of the host/model variable */
137 static void _sg_cfg_cb__host_model(const char *name, int pos)
141 xbt_assert(_sg_cfg_init_status < 2,
142 "Cannot change the model after the initialization");
144 val = xbt_cfg_get_string(_sg_cfg_set, name);
146 if (!strcmp(val, "help")) {
147 model_help("host", surf_host_model_description);
151 /* Make sure that the model exists */
152 find_model_description(surf_host_model_description, val);
155 /* callback of the vm/model variable */
156 static void _sg_cfg_cb__vm_model(const char *name, int pos)
160 xbt_assert(_sg_cfg_init_status < 2,
161 "Cannot change the model after the initialization");
163 val = xbt_cfg_get_string(_sg_cfg_set, name);
165 if (!strcmp(val, "help")) {
166 model_help("vm", surf_vm_model_description);
170 /* Make sure that the model exists */
171 find_model_description(surf_vm_model_description, val);
174 /* callback of the cpu/model variable */
175 static void _sg_cfg_cb__cpu_model(const char *name, int pos)
179 xbt_assert(_sg_cfg_init_status < 2,
180 "Cannot change the model after the initialization");
182 val = xbt_cfg_get_string(_sg_cfg_set, name);
184 if (!strcmp(val, "help")) {
185 model_help("CPU", surf_cpu_model_description);
189 /* New Module missing */
190 find_model_description(surf_cpu_model_description, val);
193 /* callback of the cpu/model variable */
194 static void _sg_cfg_cb__optimization_mode(const char *name, int pos)
198 xbt_assert(_sg_cfg_init_status < 2,
199 "Cannot change the model after the initialization");
201 val = xbt_cfg_get_string(_sg_cfg_set, name);
203 if (!strcmp(val, "help")) {
204 model_help("optimization", surf_optimization_mode_description);
208 /* New Module missing */
209 find_model_description(surf_optimization_mode_description, val);
212 /* callback of the cpu/model variable */
213 static void _sg_cfg_cb__storage_mode(const char *name, int pos)
217 xbt_assert(_sg_cfg_init_status < 2,
218 "Cannot change the model after the initialization");
220 val = xbt_cfg_get_string(_sg_cfg_set, name);
222 if (!strcmp(val, "help")) {
223 model_help("storage", surf_storage_model_description);
227 /* New Module missing */
228 find_model_description(surf_storage_model_description, val);
231 /* callback of the network_model variable */
232 static void _sg_cfg_cb__network_model(const char *name, int pos)
236 xbt_assert(_sg_cfg_init_status < 2,
237 "Cannot change the model after the initialization");
239 val = xbt_cfg_get_string(_sg_cfg_set, name);
241 if (!strcmp(val, "help")) {
242 model_help("network", surf_network_model_description);
246 /* New Module missing */
247 find_model_description(surf_network_model_description, val);
250 /* callbacks of the network models values */
251 static void _sg_cfg_cb__tcp_gamma(const char *name, int pos)
253 sg_tcp_gamma = xbt_cfg_get_double(_sg_cfg_set, name);
256 static void _sg_cfg_cb__maxmin_precision(const char* name, int pos)
258 sg_maxmin_precision = xbt_cfg_get_double(_sg_cfg_set, name);
261 static void _sg_cfg_cb__surf_precision(const char* name, int pos)
263 sg_surf_precision = xbt_cfg_get_double(_sg_cfg_set, name);
266 static void _sg_cfg_cb__sender_gap(const char* name, int pos)
268 sg_sender_gap = xbt_cfg_get_double(_sg_cfg_set, name);
271 static void _sg_cfg_cb__latency_factor(const char *name, int pos)
273 sg_latency_factor = xbt_cfg_get_double(_sg_cfg_set, name);
276 static void _sg_cfg_cb__bandwidth_factor(const char *name, int pos)
278 sg_bandwidth_factor = xbt_cfg_get_double(_sg_cfg_set, name);
281 static void _sg_cfg_cb__weight_S(const char *name, int pos)
283 sg_weight_S_parameter = xbt_cfg_get_double(_sg_cfg_set, name);
287 /* callback of the mpi collectives */
288 static void _sg_cfg_cb__coll(const char *category,
289 s_mpi_coll_description_t * table,
290 const char *name, int pos)
294 xbt_assert(_sg_cfg_init_status < 2,
295 "Cannot change the model after the initialization");
297 val = xbt_cfg_get_string(_sg_cfg_set, name);
299 if (!strcmp(val, "help")) {
300 coll_help(category, table);
304 /* New Module missing */
305 find_coll_description(table, val, category);
307 static void _sg_cfg_cb__coll_gather(const char *name, int pos){
308 _sg_cfg_cb__coll("gather", mpi_coll_gather_description, name, pos);
310 static void _sg_cfg_cb__coll_allgather(const char *name, int pos){
311 _sg_cfg_cb__coll("allgather", mpi_coll_allgather_description, name, pos);
313 static void _sg_cfg_cb__coll_allgatherv(const char *name, int pos){
314 _sg_cfg_cb__coll("allgatherv", mpi_coll_allgatherv_description, name, pos);
316 static void _sg_cfg_cb__coll_allreduce(const char *name, int pos)
318 _sg_cfg_cb__coll("allreduce", mpi_coll_allreduce_description, name, pos);
320 static void _sg_cfg_cb__coll_alltoall(const char *name, int pos)
322 _sg_cfg_cb__coll("alltoall", mpi_coll_alltoall_description, name, pos);
324 static void _sg_cfg_cb__coll_alltoallv(const char *name, int pos)
326 _sg_cfg_cb__coll("alltoallv", mpi_coll_alltoallv_description, name, pos);
328 static void _sg_cfg_cb__coll_bcast(const char *name, int pos)
330 _sg_cfg_cb__coll("bcast", mpi_coll_bcast_description, name, pos);
332 static void _sg_cfg_cb__coll_reduce(const char *name, int pos)
334 _sg_cfg_cb__coll("reduce", mpi_coll_reduce_description, name, pos);
336 static void _sg_cfg_cb__coll_reduce_scatter(const char *name, int pos){
337 _sg_cfg_cb__coll("reduce_scatter", mpi_coll_reduce_scatter_description, name, pos);
339 static void _sg_cfg_cb__coll_scatter(const char *name, int pos){
340 _sg_cfg_cb__coll("scatter", mpi_coll_scatter_description, name, pos);
342 static void _sg_cfg_cb__coll_barrier(const char *name, int pos){
343 _sg_cfg_cb__coll("barrier", mpi_coll_barrier_description, name, pos);
346 static void _sg_cfg_cb__wtime_sleep(const char *name, int pos){
347 smpi_wtime_sleep = xbt_cfg_get_double(_sg_cfg_set, name);
350 static void _sg_cfg_cb__iprobe_sleep(const char *name, int pos){
351 smpi_iprobe_sleep = xbt_cfg_get_double(_sg_cfg_set, name);
354 static void _sg_cfg_cb__test_sleep(const char *name, int pos){
355 smpi_test_sleep = xbt_cfg_get_double(_sg_cfg_set, name);
362 /* callback of the inclusion path */
363 static void _sg_cfg_cb__surf_path(const char *name, int pos)
365 char *path = xbt_cfg_get_string_at(_sg_cfg_set, name, pos);
366 xbt_dynar_push(surf_path, &path);
369 /* callback to decide if we want to use the model-checking */
370 #include "xbt_modinter.h"
373 extern int _sg_do_model_check; /* this variable lives in xbt_main until I find a right location for it */
374 extern int _sg_do_model_check_record;
377 static void _sg_cfg_cb_model_check_replay(const char *name, int pos)
379 MC_record_path = xbt_cfg_get_string(_sg_cfg_set, name);
382 static void _sg_cfg_cb_model_check_record(const char *name, int pos)
385 _sg_do_model_check_record = xbt_cfg_get_boolean(_sg_cfg_set, name);
387 if (xbt_cfg_get_boolean(_sg_cfg_set, name)) {
388 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");
393 extern int _sg_do_verbose_exit;
395 static void _sg_cfg_cb_verbose_exit(const char *name, int pos)
397 _sg_do_verbose_exit = xbt_cfg_get_boolean(_sg_cfg_set, name);
400 extern int _sg_do_clean_atexit;
402 static void _sg_cfg_cb_clean_atexit(const char *name, int pos)
404 _sg_do_clean_atexit = xbt_cfg_get_boolean(_sg_cfg_set, name);
407 static void _sg_cfg_cb_context_factory(const char *name, int pos)
409 smx_context_factory_name = xbt_cfg_get_string(_sg_cfg_set, name);
412 static void _sg_cfg_cb_context_stack_size(const char *name, int pos)
414 smx_context_stack_size_was_set = 1;
415 smx_context_stack_size = xbt_cfg_get_int(_sg_cfg_set, name) * 1024;
418 static void _sg_cfg_cb_context_guard_size(const char *name, int pos)
420 smx_context_guard_size_was_set = 1;
421 smx_context_guard_size = xbt_cfg_get_int(_sg_cfg_set, name) * xbt_pagesize;
424 static void _sg_cfg_cb_contexts_nthreads(const char *name, int pos)
426 SIMIX_context_set_nthreads(xbt_cfg_get_int(_sg_cfg_set, name));
429 static void _sg_cfg_cb_contexts_parallel_threshold(const char *name, int pos)
431 SIMIX_context_set_parallel_threshold(xbt_cfg_get_int(_sg_cfg_set, name));
434 static void _sg_cfg_cb_contexts_parallel_mode(const char *name, int pos)
436 const char* mode_name = xbt_cfg_get_string(_sg_cfg_set, name);
437 if (!strcmp(mode_name, "posix")) {
438 SIMIX_context_set_parallel_mode(XBT_PARMAP_POSIX);
440 else if (!strcmp(mode_name, "futex")) {
441 SIMIX_context_set_parallel_mode(XBT_PARMAP_FUTEX);
443 else if (!strcmp(mode_name, "busy_wait")) {
444 SIMIX_context_set_parallel_mode(XBT_PARMAP_BUSY_WAIT);
447 xbt_die("Command line setting of the parallel synchronization mode should "
448 "be one of \"posix\", \"futex\" or \"busy_wait\"");
452 static void _sg_cfg_cb__surf_network_coordinates(const char *name,
455 static int already_set = 0;
456 int val = xbt_cfg_get_boolean(_sg_cfg_set, name);
459 COORD_HOST_LEVEL = xbt_lib_add_level(host_lib,xbt_dynar_free_voidp);
460 COORD_ASR_LEVEL = xbt_lib_add_level(as_router_lib,xbt_dynar_free_voidp);
465 xbt_die("Setting of whether to use coordinate cannot be disabled once set.");
468 static void _sg_cfg_cb__surf_network_crosstraffic(const char *name,
471 sg_network_crosstraffic = xbt_cfg_get_boolean(_sg_cfg_set, name);
474 /* build description line with possible values */
475 static void describe_model(char *result,
476 const s_surf_model_description_t model_description[],
478 const char *description)
481 sprintf(result, "%s. Possible values: %s", description,
482 model_description[0].name ? model_description[0].name : "n/a");
484 for (i = 1; model_description[i].name; i++)
485 p += sprintf(p, ", %s", model_description[i].name);
487 ".\n (use 'help' as a value to see the long description of each %s)",
491 /* create the config set, register what should be and parse the command line*/
492 void sg_config_init(int *argc, char **argv)
494 char description[1024];
496 /* Create the configuration support */
497 if (_sg_cfg_init_status == 0) { /* Only create stuff if not already inited */
499 /* Plugins configuration */
500 describe_model(description, surf_plugin_description,
501 "plugin", "The plugins");
502 xbt_cfg_register(&_sg_cfg_set, "plugin", description,
503 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__plugin, NULL);
505 describe_model(description, surf_cpu_model_description,
506 "model", "The model to use for the CPU");
507 xbt_cfg_register(&_sg_cfg_set, "cpu/model", description,
508 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__cpu_model, NULL);
509 xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/model", "Cas01");
511 describe_model(description, surf_optimization_mode_description,
513 "The optimization modes to use for the CPU");
514 xbt_cfg_register(&_sg_cfg_set, "cpu/optim", description,
515 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode, NULL);
516 xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/optim", "Lazy");
518 describe_model(description, surf_storage_model_description,
519 "model", "The model to use for the storage");
520 xbt_cfg_register(&_sg_cfg_set, "storage/model", description,
521 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__storage_mode, NULL);
522 xbt_cfg_setdefault_string(_sg_cfg_set, "storage/model", "default");
524 describe_model(description, surf_network_model_description,
525 "model", "The model to use for the network");
526 xbt_cfg_register(&_sg_cfg_set, "network/model", description,
527 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__network_model, NULL);
528 xbt_cfg_setdefault_string(_sg_cfg_set, "network/model", "LV08");
530 describe_model(description, surf_optimization_mode_description,
532 "The optimization modes to use for the network");
533 xbt_cfg_register(&_sg_cfg_set, "network/optim", description,
534 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode, NULL);
535 xbt_cfg_setdefault_string(_sg_cfg_set, "network/optim", "Lazy");
537 describe_model(description, surf_host_model_description,
538 "model", "The model to use for the host");
539 xbt_cfg_register(&_sg_cfg_set, "host/model", description,
540 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__host_model, NULL);
541 xbt_cfg_setdefault_string(_sg_cfg_set, "host/model", "default");
543 describe_model(description, surf_vm_model_description,
544 "model", "The model to use for the vm");
545 xbt_cfg_register(&_sg_cfg_set, "vm/model", description,
546 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__vm_model, NULL);
547 xbt_cfg_setdefault_string(_sg_cfg_set, "vm/model", "default");
549 xbt_cfg_register(&_sg_cfg_set, "network/TCP_gamma",
550 "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)",
551 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__tcp_gamma, NULL);
552 xbt_cfg_setdefault_double(_sg_cfg_set, "network/TCP_gamma", 4194304.0);
554 xbt_cfg_register(&_sg_cfg_set, "surf/precision",
555 "Numerical precision used when updating simulation times (hence this value is expressed in seconds)",
556 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__surf_precision, NULL);
557 xbt_cfg_setdefault_double(_sg_cfg_set, "surf/precision", 0.00001);
559 xbt_cfg_register(&_sg_cfg_set, "maxmin/precision",
560 "Numerical precision used when computing resource sharing (hence this value is expressed in ops/sec or bytes/sec)",
561 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__maxmin_precision, NULL);
562 xbt_cfg_setdefault_double(_sg_cfg_set, "maxmin/precision", 0.00001);
564 /* The parameters of network models */
566 xbt_cfg_register(&_sg_cfg_set, "network/sender_gap",
567 "Minimum gap between two overlapping sends",
568 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__sender_gap, NULL);
569 /* real default for "network/sender_gap" is set in network_smpi.cpp */
570 xbt_cfg_setdefault_double(_sg_cfg_set, "network/sender_gap", NAN);
572 xbt_cfg_register(&_sg_cfg_set, "network/latency_factor",
573 "Correction factor to apply to the provided latency (default value set by network model)",
574 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__latency_factor, NULL);
575 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 1.0);
577 xbt_cfg_register(&_sg_cfg_set, "network/bandwidth_factor",
578 "Correction factor to apply to the provided bandwidth (default value set by network model)",
579 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__bandwidth_factor, NULL);
580 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 1.0);
582 xbt_cfg_register(&_sg_cfg_set, "network/weight_S",
583 "Correction factor to apply to the weight of competing streams (default value set by network model)",
584 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__weight_S, NULL);
585 /* real default for "network/weight_S" is set in network_*.cpp */
586 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", NAN);
589 xbt_cfg_register(&_sg_cfg_set, "path",
590 "Lookup path for inclusions in platform and deployment XML files",
591 xbt_cfgelm_string, 1, 0, _sg_cfg_cb__surf_path, NULL);
593 xbt_cfg_register(&_sg_cfg_set, "cpu/maxmin_selective_update",
594 "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
595 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
596 xbt_cfg_setdefault_boolean(_sg_cfg_set, "cpu/maxmin_selective_update", "no");
598 xbt_cfg_register(&_sg_cfg_set, "network/maxmin_selective_update",
599 "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
600 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
601 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/maxmin_selective_update", "no");
603 /* Replay (this part is enabled event if MC it disabled) */
604 xbt_cfg_register(&_sg_cfg_set, "model-check/replay",
605 "Uenable replay mode with the given path",
606 xbt_cfgelm_string, 0, 1, _sg_cfg_cb_model_check_replay, NULL);
609 /* do model-checking-record */
610 xbt_cfg_register(&_sg_cfg_set, "model-check/record",
611 "Record the model-checking paths",
612 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_model_check_record, NULL);
613 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/record", "no");
615 /* do stateful model-checking */
616 xbt_cfg_register(&_sg_cfg_set, "model-check/checkpoint",
617 "Specify the amount of steps between checkpoints during stateful model-checking (default: 0 => stateless verification). "
618 "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.",
619 xbt_cfgelm_int, 1, 1, _mc_cfg_cb_checkpoint, NULL);
620 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/checkpoint", 0);
622 /* do stateful model-checking */
623 xbt_cfg_register(&_sg_cfg_set, "model-check/sparse-checkpoint",
624 "Use sparse per-page snapshots.",
625 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_sparse_checkpoint, NULL);
626 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/sparse-checkpoint", "no");
628 /* do stateful model-checking */
629 xbt_cfg_register(&_sg_cfg_set, "model-check/soft-dirty",
630 "Use sparse per-page snapshots.",
631 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_soft_dirty, NULL);
632 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/soft-dirty", "no");
634 xbt_cfg_register(&_sg_cfg_set, "model-check/ksm",
635 "Kernel same-page merging",
636 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_ksm, NULL);
637 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/ksm", "no");
639 /* do liveness model-checking */
640 xbt_cfg_register(&_sg_cfg_set, "model-check/property",
641 "Specify the name of the file containing the property. It must be the result of the ltl2ba program.",
642 xbt_cfgelm_string, 1, 1, _mc_cfg_cb_property, NULL);
643 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/property", "");
645 /* do communications determinism model-checking */
646 xbt_cfg_register(&_sg_cfg_set, "model-check/communications_determinism",
647 "Enable/disable the detection of determinism in the communications schemes",
648 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_comms_determinism, NULL);
649 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/communications_determinism", "no");
651 /* do send determinism model-checking */
652 xbt_cfg_register(&_sg_cfg_set, "model-check/send_determinism",
653 "Enable/disable the detection of send-determinism in the communications schemes",
654 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_send_determinism, NULL);
655 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/send_determinism", "no");
657 /* Specify the kind of model-checking reduction */
658 xbt_cfg_register(&_sg_cfg_set, "model-check/reduction",
659 "Specify the kind of exploration reduction (either none or DPOR)",
660 xbt_cfgelm_string, 1, 1, _mc_cfg_cb_reduce, NULL);
661 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/reduction", "dpor");
663 /* Enable/disable timeout for wait requests with model-checking */
664 xbt_cfg_register(&_sg_cfg_set, "model-check/timeout",
665 "Enable/Disable timeout for wait requests",
666 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_timeout, NULL);
667 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/timeout", "no");
669 /* Enable/disable global hash computation with model-checking */
670 xbt_cfg_register(&_sg_cfg_set, "model-check/hash",
671 "Enable/Disable state hash for state comparison (exprimental)",
672 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_hash, NULL);
673 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/hash", "no");
675 /* Set max depth exploration */
676 /* Currently, this option cannot be used. */
677 xbt_cfg_register(&_sg_cfg_set, "model-check/snapshot_fds",
678 "Whether file descriptors must be snapshoted",
679 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_snapshot_fds, NULL);
680 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/snapshot_fds", "no");
682 /* Set max depth exploration */
683 xbt_cfg_register(&_sg_cfg_set, "model-check/max_depth",
684 "Specify the max depth of exploration (default : 1000)",
685 xbt_cfgelm_int, 1, 1, _mc_cfg_cb_max_depth, NULL);
686 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/max_depth", 1000);
688 /* Set number of visited state stored for state comparison reduction*/
689 xbt_cfg_register(&_sg_cfg_set, "model-check/visited",
690 "Specify the number of visited state stored for state comparison reduction. If value=5, the last 5 visited states are stored",
691 xbt_cfgelm_int, 1, 1, _mc_cfg_cb_visited, NULL);
692 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/visited", 0);
694 /* Set file name for dot output of graph state */
695 xbt_cfg_register(&_sg_cfg_set, "model-check/dot_output",
696 "Specify the name of dot file corresponding to graph state",
697 xbt_cfgelm_string, 1, 1, _mc_cfg_cb_dot_output, NULL);
698 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/dot_output", "");
700 /* Enable/disable non progressive cycles detection with model-checking */
701 xbt_cfg_register(&_sg_cfg_set, "model-check/termination",
702 "Enable/Disable non progressive cycle detection",
703 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_termination, NULL);
704 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/termination", "no");
707 /* do verbose-exit */
708 xbt_cfg_register(&_sg_cfg_set, "verbose-exit",
709 "Activate the \"do nothing\" mode in Ctrl-C",
710 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_verbose_exit, NULL);
711 xbt_cfg_setdefault_boolean(_sg_cfg_set, "verbose-exit", "yes");
713 /* context factory */
714 const char *dflt_ctx_fact = "thread";
716 char *p = description +
718 "Context factory to use in SIMIX. Possible values: %s",
720 #ifdef CONTEXT_UCONTEXT
721 dflt_ctx_fact = "ucontext";
722 p += sprintf(p, ", %s", dflt_ctx_fact);
725 dflt_ctx_fact = "raw";
726 p += sprintf(p, ", %s", dflt_ctx_fact);
730 xbt_cfg_register(&_sg_cfg_set, "contexts/factory", description,
731 xbt_cfgelm_string, 1, 1, _sg_cfg_cb_context_factory, NULL);
732 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/factory", dflt_ctx_fact);
734 /* stack size of contexts in KiB */
735 xbt_cfg_register(&_sg_cfg_set, "contexts/stack_size",
736 "Stack size of contexts in KiB",
737 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_context_stack_size, NULL);
738 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/stack_size", 8*1024);
739 /* No, it was not set yet (the above setdefault() changed this to 1). */
740 smx_context_stack_size_was_set = 0;
742 /* guard size for contexts stacks in memory pages */
743 xbt_cfg_register(&_sg_cfg_set, "contexts/guard_size",
744 "Guard size for contexts stacks in memory pages",
745 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_context_guard_size, NULL);
746 #if defined(_XBT_WIN32) || (PTH_STACKGROWTH != -1)
747 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/guard_size", 0);
749 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/guard_size", 1);
751 /* No, it was not set yet (the above setdefault() changed this to 1). */
752 smx_context_guard_size_was_set = 0;
754 /* number of parallel threads for user processes */
755 xbt_cfg_register(&_sg_cfg_set, "contexts/nthreads",
756 "Number of parallel threads used to execute user contexts",
757 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_nthreads, NULL);
758 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/nthreads", 1);
760 /* minimal number of user contexts to be run in parallel */
761 xbt_cfg_register(&_sg_cfg_set, "contexts/parallel_threshold",
762 "Minimal number of user contexts to be run in parallel (raw contexts only)",
763 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_parallel_threshold, NULL);
764 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/parallel_threshold", 2);
766 /* synchronization mode for parallel user contexts */
767 xbt_cfg_register(&_sg_cfg_set, "contexts/synchro",
768 "Synchronization mode to use when running contexts in parallel (either futex, posix or busy_wait)",
769 xbt_cfgelm_string, 1, 1, _sg_cfg_cb_contexts_parallel_mode, NULL);
771 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "futex");
772 #else //No futex on mac and posix is unimplememted yet
773 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "busy_wait");
776 xbt_cfg_register(&_sg_cfg_set, "network/coordinates",
777 "\"yes\" or \"no\", specifying whether we use a coordinate-based routing (as Vivaldi)",
778 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb__surf_network_coordinates, NULL);
779 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/coordinates", "no");
781 xbt_cfg_register(&_sg_cfg_set, "network/crosstraffic",
782 "Activate the interferences between uploads and downloads for fluid max-min models (LV08, CM02)",
783 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb__surf_network_crosstraffic, NULL);
784 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/crosstraffic", "no");
787 xbt_cfg_register(&_sg_cfg_set, "ns3/TcpModel",
788 "The ns3 tcp model can be : NewReno or Reno or Tahoe",
789 xbt_cfgelm_string, 1, 1, NULL, NULL);
790 xbt_cfg_setdefault_string(_sg_cfg_set, "ns3/TcpModel", "default");
793 //For smpi/bw_factor and smpi/lat_factor
794 //Default value have to be "threshold0:value0;threshold1:value1;...;thresholdN:valueN"
795 //test is if( size >= thresholdN ) return valueN;
796 //Values can be modified with command line --cfg=smpi/bw_factor:"threshold0:value0;threshold1:value1;...;thresholdN:valueN"
797 // or with tag config put line <prop id="smpi/bw_factor" value="threshold0:value0;threshold1:value1;...;thresholdN:valueN"></prop>
798 // SMPI model can be used without enable_smpi, so keep this the ifdef.
799 xbt_cfg_register(&_sg_cfg_set, "smpi/bw_factor",
800 "Bandwidth factors for smpi.",
801 xbt_cfgelm_string, 1, 1, NULL, NULL);
802 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");
804 xbt_cfg_register(&_sg_cfg_set, "smpi/lat_factor",
805 "Latency factors for smpi.",
806 xbt_cfgelm_string, 1, 1, NULL, NULL);
807 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");
809 xbt_cfg_register(&_sg_cfg_set, "smpi/IB_penalty_factors",
810 "Correction factor to communications using Infiniband model with contention (default value based on Stampede cluster profiling)",
811 xbt_cfgelm_string, 1, 1, NULL, NULL);
812 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/IB_penalty_factors", "0.965;0.925;1.35");
815 xbt_cfg_register(&_sg_cfg_set, "smpi/running_power",
816 "Power of the host running the simulation (in flop/s). Used to bench the operations.",
817 xbt_cfgelm_double, 1, 1, NULL, NULL);
818 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/running_power", 20000.0);
820 xbt_cfg_register(&_sg_cfg_set, "smpi/display_timing",
821 "Boolean indicating whether we should display the timing after simulation.",
822 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
823 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/display_timing", "no");
825 xbt_cfg_register(&_sg_cfg_set, "smpi/simulate_computation",
826 "Boolean indicating whether the computational part of the simulated application should be simulated.",
827 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
828 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/simulate_computation", "yes");
830 xbt_cfg_register(&_sg_cfg_set, "smpi/use_shared_malloc",
831 "Boolean indicating whether we should use shared memory when using SMPI_SHARED_MALLOC. Allows user to disable it for debug purposes.",
832 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
833 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/use_shared_malloc", "yes");
835 xbt_cfg_register(&_sg_cfg_set, "smpi/cpu_threshold",
836 "Minimal computation time (in seconds) not discarded, or -1 for infinity.",
837 xbt_cfgelm_double, 1, 1, NULL, NULL);
838 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/cpu_threshold", 1e-6);
840 xbt_cfg_register(&_sg_cfg_set, "smpi/async_small_thres",
841 "Maximal size of messages that are to be sent asynchronously, without waiting for the receiver",
842 xbt_cfgelm_int, 1, 1, NULL, NULL);
843 xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/async_small_thres", 0);
845 xbt_cfg_register(&_sg_cfg_set, "smpi/send_is_detached_thres",
846 "Threshold of message size where MPI_Send stops behaving like MPI_Isend and becomes MPI_Ssend",
847 xbt_cfgelm_int, 1, 1, NULL, NULL);
848 xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/send_is_detached_thres", 65536);
850 xbt_cfg_register(&_sg_cfg_set, "smpi/privatize_global_variables",
851 "Boolean indicating whether we should privatize global variable at runtime.",
852 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
853 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/privatize_global_variables", "no");
855 xbt_cfg_register(&_sg_cfg_set, "smpi/os",
856 "Small messages timings (MPI_Send minimum time for small messages)",
857 xbt_cfgelm_string, 1, 1, NULL, NULL);
858 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/os", "1:0:0:0:0");
860 xbt_cfg_register(&_sg_cfg_set, "smpi/ois",
861 "Small messages timings (MPI_Isend minimum time for small messages)",
862 xbt_cfgelm_string, 1, 1, NULL, NULL);
863 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/ois", "1:0:0:0:0");
865 xbt_cfg_register(&_sg_cfg_set, "smpi/or",
866 "Small messages timings (MPI_Recv minimum time for small messages)",
867 xbt_cfgelm_string, 1, 1, NULL, NULL);
868 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/or", "1:0:0:0:0");
870 xbt_cfg_register(&_sg_cfg_set, "smpi/iprobe",
871 "Minimum time to inject inside a call to MPI_Iprobe",
872 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__iprobe_sleep, NULL);
873 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/iprobe", 1e-4);
875 xbt_cfg_register(&_sg_cfg_set, "smpi/test",
876 "Minimum time to inject inside a call to MPI_Test",
877 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__test_sleep, NULL);
878 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/test", 1e-4);
880 xbt_cfg_register(&_sg_cfg_set, "smpi/wtime",
881 "Minimum time to inject inside a call to MPI_Wtime",
882 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__wtime_sleep, NULL);
883 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/wtime", 0.0);
885 xbt_cfg_register(&_sg_cfg_set, "smpi/coll_selector",
886 "Which collective selector to use",
887 xbt_cfgelm_string, 1, 1, NULL, NULL);
888 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/coll_selector", "default");
890 xbt_cfg_register(&_sg_cfg_set, "smpi/gather",
891 "Which collective to use for gather",
892 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_gather, NULL);
894 xbt_cfg_register(&_sg_cfg_set, "smpi/allgather",
895 "Which collective to use for allgather",
896 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allgather, NULL);
898 xbt_cfg_register(&_sg_cfg_set, "smpi/barrier",
899 "Which collective to use for barrier",
900 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_barrier, NULL);
902 xbt_cfg_register(&_sg_cfg_set, "smpi/reduce_scatter",
903 "Which collective to use for reduce_scatter",
904 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_reduce_scatter, NULL);
906 xbt_cfg_register(&_sg_cfg_set, "smpi/scatter",
907 "Which collective to use for scatter",
908 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_scatter, NULL);
910 xbt_cfg_register(&_sg_cfg_set, "smpi/allgatherv",
911 "Which collective to use for allgatherv",
912 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allgatherv, NULL);
914 xbt_cfg_register(&_sg_cfg_set, "smpi/allreduce",
915 "Which collective to use for allreduce",
916 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allreduce, NULL);
918 xbt_cfg_register(&_sg_cfg_set, "smpi/alltoall",
919 "Which collective to use for alltoall",
920 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_alltoall, NULL);
922 xbt_cfg_register(&_sg_cfg_set, "smpi/alltoallv",
923 "Which collective to use for alltoallv",
924 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_alltoallv, NULL);
926 xbt_cfg_register(&_sg_cfg_set, "smpi/bcast",
927 "Which collective to use for bcast",
928 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_bcast, NULL);
930 xbt_cfg_register(&_sg_cfg_set, "smpi/reduce",
931 "Which collective to use for reduce",
932 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_reduce, NULL);
935 xbt_cfg_register(&_sg_cfg_set, "exception/cutpath",
936 "\"yes\" or \"no\". \"yes\" will cut all path information from call traces, used e.g. in exceptions.",
937 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
938 xbt_cfg_setdefault_boolean(_sg_cfg_set, "exception/cutpath", "no");
940 xbt_cfg_register(&_sg_cfg_set, "clean_atexit",
941 "\"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.",
942 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_clean_atexit, NULL);
943 xbt_cfg_setdefault_boolean(_sg_cfg_set, "clean_atexit", "yes");
946 /* retrieves the current directory of the current process */
947 const char *initial_path = __surf_get_initial_path();
948 xbt_assert((initial_path),
949 "__surf_get_initial_path() failed! Can't resolve current Windows directory");
951 surf_path = xbt_dynar_new(sizeof(char *), NULL);
952 xbt_cfg_setdefault_string(_sg_cfg_set, "path", initial_path);
955 xbt_cfg_check(_sg_cfg_set);
956 _sg_cfg_init_status = 1;
958 sg_config_cmd_line(argc, argv);
960 xbt_mallocator_initialization_is_done(SIMIX_context_is_parallel());
963 XBT_WARN("Call to sg_config_init() after initialization ignored");
967 void sg_config_finalize(void)
969 if (!_sg_cfg_init_status)
970 return; /* Not initialized yet. Nothing to do */
972 xbt_cfg_free(&_sg_cfg_set);
973 _sg_cfg_init_status = 0;
976 /* Pick the right models for CPU, net and host, and call their model_init_preparse */
977 void surf_config_models_setup()
979 const char *host_model_name;
980 const char *vm_model_name;
983 char *network_model_name = NULL;
984 char *cpu_model_name = NULL;
986 char *storage_model_name = NULL;
988 host_model_name = xbt_cfg_get_string(_sg_cfg_set, "host/model");
989 vm_model_name = xbt_cfg_get_string(_sg_cfg_set, "vm/model");
990 network_model_name = xbt_cfg_get_string(_sg_cfg_set, "network/model");
991 cpu_model_name = xbt_cfg_get_string(_sg_cfg_set, "cpu/model");
992 storage_model_name = xbt_cfg_get_string(_sg_cfg_set, "storage/model");
994 /* Check whether we use a net/cpu model differing from the default ones, in which case
995 * we should switch to the "compound" host model to correctly dispatch stuff to
996 * the right net/cpu models.
999 if ((!xbt_cfg_is_default_value(_sg_cfg_set, "network/model") ||
1000 !xbt_cfg_is_default_value(_sg_cfg_set, "cpu/model")) &&
1001 xbt_cfg_is_default_value(_sg_cfg_set, "host/model")) {
1002 host_model_name = "compound";
1003 xbt_cfg_set_string(_sg_cfg_set, "host/model", host_model_name);
1006 XBT_DEBUG("host model: %s", host_model_name);
1007 host_id = find_model_description(surf_host_model_description, host_model_name);
1008 if (!strcmp(host_model_name, "compound")) {
1009 int network_id = -1;
1012 xbt_assert(cpu_model_name,
1013 "Set a cpu model to use with the 'compound' host model");
1015 xbt_assert(network_model_name,
1016 "Set a network model to use with the 'compound' host model");
1018 if(surf_cpu_model_init_preparse){
1019 surf_cpu_model_init_preparse();
1022 find_model_description(surf_cpu_model_description, cpu_model_name);
1023 surf_cpu_model_description[cpu_id].model_init_preparse();
1027 find_model_description(surf_network_model_description,
1028 network_model_name);
1029 surf_network_model_description[network_id].model_init_preparse();
1032 XBT_DEBUG("Call host_model_init");
1033 surf_host_model_description[host_id].model_init_preparse();
1035 XBT_DEBUG("Call vm_model_init");
1036 vm_id = find_model_description(surf_vm_model_description, vm_model_name);
1037 surf_vm_model_description[vm_id].model_init_preparse();
1039 XBT_DEBUG("Call storage_model_init");
1040 storage_id = find_model_description(surf_storage_model_description, storage_model_name);
1041 surf_storage_model_description[storage_id].model_init_preparse();
1045 int sg_cfg_is_default_value(const char *name)
1047 return xbt_cfg_is_default_value(_sg_cfg_set, name);
1050 int sg_cfg_get_int(const char* name)
1052 return xbt_cfg_get_int(_sg_cfg_set, name);
1055 double sg_cfg_get_double(const char* name)
1057 return xbt_cfg_get_double(_sg_cfg_set, name);
1060 char* sg_cfg_get_string(const char* name)
1062 return xbt_cfg_get_string(_sg_cfg_set, name);
1065 int sg_cfg_get_boolean(const char* name)
1067 return xbt_cfg_get_boolean(_sg_cfg_set, name);
1070 void sg_cfg_get_peer(const char *name, char **peer, int *port)
1072 xbt_cfg_get_peer(_sg_cfg_set, name, peer, port);
1075 xbt_dynar_t sg_cfg_get_dynar(const char* name)
1077 return xbt_cfg_get_dynar(_sg_cfg_set, name);