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 "instr/instr.h"
25 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_config, surf,
26 "About the configuration of simgrid");
28 xbt_cfg_t _sg_cfg_set = NULL;
30 /* 0: beginning of time (config cannot be changed yet);
31 * 1: initialized: cfg_set created (config can now be changed);
32 * 2: configured: command line parsed and config part of platform file was
33 * integrated also, platform construction ongoing or done.
34 * (Config cannot be changed anymore!)
36 int _sg_cfg_init_status = 0;
38 /* instruct the upper layer (simix or simdag) to exit as soon as possible
40 int _sg_cfg_exit_asap = 0;
42 #define sg_cfg_exit_early() do { _sg_cfg_exit_asap = 1; return; } while (0)
44 /* Parse the command line, looking for options */
45 static void sg_config_cmd_line(int *argc, char **argv)
51 for (j = i = 1; i < *argc; i++) {
52 if (!strncmp(argv[i], "--cfg=", strlen("--cfg="))) {
53 opt = strchr(argv[i], '=');
56 xbt_cfg_set_parse(_sg_cfg_set, opt);
57 XBT_DEBUG("Did apply '%s' as config setting", opt);
58 } else if (!strcmp(argv[i], "--version")) {
59 printf("%s\n", SIMGRID_VERSION_STRING);
61 } else if (!strcmp(argv[i], "--cfg-help") || !strcmp(argv[i], "--help")) {
63 ("Description of the configuration accepted by this simulator:\n");
64 xbt_cfg_help(_sg_cfg_set);
67 "Each of these configurations can be used by adding\n"
68 " --cfg=<option name>:<option value>\n"
69 "to the command line.\n"
71 "You can also use --help-models to see the details of all models known by this simulator.\n"
74 "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("workstation", surf_workstation_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");
99 } 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 workstation/model variable */
137 static void _sg_cfg_cb__workstation_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("workstation", surf_workstation_model_description);
151 /* Make sure that the model exists */
152 find_model_description(surf_workstation_model_description, val);
155 /* callback of the vm_workstation/model variable */
156 static void _sg_cfg_cb__vm_workstation_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_workstation", surf_vm_workstation_model_description);
170 /* Make sure that the model exists */
171 find_model_description(surf_vm_workstation_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 workstation_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);
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"
372 extern int _sg_do_model_check; /* this variable lives in xbt_main until I find a right location for it */
375 static void _sg_cfg_cb_model_check(const char *name, int pos)
378 _sg_do_model_check = xbt_cfg_get_boolean(_sg_cfg_set, name);
380 if (xbt_cfg_get_boolean(_sg_cfg_set, name)) {
381 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");
386 extern int _sg_do_verbose_exit;
388 static void _sg_cfg_cb_verbose_exit(const char *name, int pos)
390 _sg_do_verbose_exit = xbt_cfg_get_boolean(_sg_cfg_set, name);
393 extern int _sg_do_clean_atexit;
395 static void _sg_cfg_cb_clean_atexit(const char *name, int pos)
397 _sg_do_clean_atexit = xbt_cfg_get_boolean(_sg_cfg_set, name);
400 static void _sg_cfg_cb_context_factory(const char *name, int pos)
402 smx_context_factory_name = xbt_cfg_get_string(_sg_cfg_set, name);
405 static void _sg_cfg_cb_context_stack_size(const char *name, int pos)
407 smx_context_stack_size_was_set = 1;
408 smx_context_stack_size = xbt_cfg_get_int(_sg_cfg_set, name) * 1024;
411 static void _sg_cfg_cb_context_guard_size(const char *name, int pos)
413 smx_context_guard_size_was_set = 1;
414 smx_context_guard_size = xbt_cfg_get_int(_sg_cfg_set, name) * xbt_pagesize;
417 static void _sg_cfg_cb_contexts_nthreads(const char *name, int pos)
419 SIMIX_context_set_nthreads(xbt_cfg_get_int(_sg_cfg_set, name));
422 static void _sg_cfg_cb_contexts_parallel_threshold(const char *name, int pos)
424 SIMIX_context_set_parallel_threshold(xbt_cfg_get_int(_sg_cfg_set, name));
427 static void _sg_cfg_cb_contexts_parallel_mode(const char *name, int pos)
429 const char* mode_name = xbt_cfg_get_string(_sg_cfg_set, name);
430 if (!strcmp(mode_name, "posix")) {
431 SIMIX_context_set_parallel_mode(XBT_PARMAP_POSIX);
433 else if (!strcmp(mode_name, "futex")) {
434 SIMIX_context_set_parallel_mode(XBT_PARMAP_FUTEX);
436 else if (!strcmp(mode_name, "busy_wait")) {
437 SIMIX_context_set_parallel_mode(XBT_PARMAP_BUSY_WAIT);
440 xbt_die("Command line setting of the parallel synchronization mode should "
441 "be one of \"posix\", \"futex\" or \"busy_wait\"");
445 static void _sg_cfg_cb__surf_network_coordinates(const char *name,
448 int val = xbt_cfg_get_boolean(_sg_cfg_set, name);
450 if (!COORD_HOST_LEVEL) {
451 COORD_HOST_LEVEL = xbt_lib_add_level(host_lib,xbt_dynar_free_voidp);
452 COORD_ASR_LEVEL = xbt_lib_add_level(as_router_lib,xbt_dynar_free_voidp);
455 if (COORD_HOST_LEVEL)
456 xbt_die("Setting of whether to use coordinate cannot be disabled once set.");
459 static void _sg_cfg_cb__surf_network_crosstraffic(const char *name,
462 sg_network_crosstraffic = xbt_cfg_get_boolean(_sg_cfg_set, name);
466 static void _sg_cfg_cb__gtnets_jitter(const char *name, int pos)
468 sg_gtnets_jitter = xbt_cfg_get_double(_sg_cfg_set, name);
471 static void _sg_cfg_cb__gtnets_jitter_seed(const char *name, int pos)
473 sg_gtnets_jitter_seed = xbt_cfg_get_int(_sg_cfg_set, name);
477 /* build description line with possible values */
478 static void describe_model(char *result,
479 const s_surf_model_description_t model_description[],
481 const char *description)
484 sprintf(result, "%s. Possible values: %s", description,
485 model_description[0].name ? model_description[0].name : "n/a");
487 for (i = 1; model_description[i].name; i++)
488 p += sprintf(p, ", %s", model_description[i].name);
490 ".\n (use 'help' as a value to see the long description of each %s)",
494 /* create the config set, register what should be and parse the command line*/
495 void sg_config_init(int *argc, char **argv)
497 char description[1024];
499 /* Create the configuration support */
500 if (_sg_cfg_init_status == 0) { /* Only create stuff if not already inited */
502 /* Plugins configuration */
503 describe_model(description, surf_plugin_description,
504 "plugin", "The plugins");
505 xbt_cfg_register(&_sg_cfg_set, "plugin", description,
506 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__plugin, NULL);
508 describe_model(description, surf_cpu_model_description,
509 "model", "The model to use for the CPU");
510 xbt_cfg_register(&_sg_cfg_set, "cpu/model", description,
511 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__cpu_model, NULL);
512 xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/model", "Cas01");
514 describe_model(description, surf_optimization_mode_description,
516 "The optimization modes to use for the CPU");
517 xbt_cfg_register(&_sg_cfg_set, "cpu/optim", description,
518 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode, NULL);
519 xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/optim", "Lazy");
521 describe_model(description, surf_storage_model_description,
522 "model", "The model to use for the storage");
523 xbt_cfg_register(&_sg_cfg_set, "storage/model", description,
524 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__storage_mode, NULL);
525 xbt_cfg_setdefault_string(_sg_cfg_set, "storage/model", "default");
527 describe_model(description, surf_network_model_description,
528 "model", "The model to use for the network");
529 xbt_cfg_register(&_sg_cfg_set, "network/model", description,
530 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__network_model, NULL);
531 xbt_cfg_setdefault_string(_sg_cfg_set, "network/model", "LV08");
533 describe_model(description, surf_optimization_mode_description,
535 "The optimization modes to use for the network");
536 xbt_cfg_register(&_sg_cfg_set, "network/optim", description,
537 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode, NULL);
538 xbt_cfg_setdefault_string(_sg_cfg_set, "network/optim", "Lazy");
540 describe_model(description, surf_workstation_model_description,
541 "model", "The model to use for the workstation");
542 xbt_cfg_register(&_sg_cfg_set, "workstation/model", description,
543 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__workstation_model, NULL);
544 xbt_cfg_setdefault_string(_sg_cfg_set, "workstation/model", "default");
546 describe_model(description, surf_vm_workstation_model_description,
547 "model", "The model to use for the vm workstation");
548 xbt_cfg_register(&_sg_cfg_set, "vm_workstation/model", description,
549 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__vm_workstation_model, NULL);
550 xbt_cfg_setdefault_string(_sg_cfg_set, "vm_workstation/model", "default");
552 xbt_cfg_register(&_sg_cfg_set, "network/TCP_gamma",
553 "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)",
554 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__tcp_gamma, NULL);
555 xbt_cfg_setdefault_double(_sg_cfg_set, "network/TCP_gamma", 4194304.0);
557 xbt_cfg_register(&_sg_cfg_set, "surf/precision",
558 "Numerical precision used when updating simulation times (hence this value is expressed in seconds)",
559 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__surf_precision, NULL);
560 xbt_cfg_setdefault_double(_sg_cfg_set, "surf/precision", 0.00001);
562 xbt_cfg_register(&_sg_cfg_set, "maxmin/precision",
563 "Numerical precision used when computing resource sharing (hence this value is expressed in ops/sec or bytes/sec)",
564 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__maxmin_precision, NULL);
565 xbt_cfg_setdefault_double(_sg_cfg_set, "maxmin/precision", 0.00001);
567 /* The parameters of network models */
569 xbt_cfg_register(&_sg_cfg_set, "network/sender_gap",
570 "Minimum gap between two overlapping sends",
571 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__sender_gap, NULL);
572 /* real default for "network/sender_gap" is set in network_smpi.cpp */
573 xbt_cfg_setdefault_double(_sg_cfg_set, "network/sender_gap", NAN);
575 xbt_cfg_register(&_sg_cfg_set, "network/latency_factor",
576 "Correction factor to apply to the provided latency (default value set by network model)",
577 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__latency_factor, NULL);
578 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 1.0);
580 xbt_cfg_register(&_sg_cfg_set, "network/bandwidth_factor",
581 "Correction factor to apply to the provided bandwidth (default value set by network model)",
582 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__bandwidth_factor, NULL);
583 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 1.0);
585 xbt_cfg_register(&_sg_cfg_set, "network/weight_S",
586 "Correction factor to apply to the weight of competing streams (default value set by network model)",
587 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__weight_S, NULL);
588 /* real default for "network/weight_S" is set in network_*.cpp */
589 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", NAN);
592 xbt_cfg_register(&_sg_cfg_set, "path",
593 "Lookup path for inclusions in platform and deployment XML files",
594 xbt_cfgelm_string, 1, 0, _sg_cfg_cb__surf_path, NULL);
596 xbt_cfg_register(&_sg_cfg_set, "cpu/maxmin_selective_update",
597 "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
598 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
599 xbt_cfg_setdefault_boolean(_sg_cfg_set, "cpu/maxmin_selective_update", "no");
601 xbt_cfg_register(&_sg_cfg_set, "network/maxmin_selective_update",
602 "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
603 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
604 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/maxmin_selective_update", "no");
607 /* do model-checking */
608 xbt_cfg_register(&_sg_cfg_set, "model-check",
609 "Verify the system through model-checking instead of simulating it (EXPERIMENTAL)",
610 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_model_check, NULL);
611 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check", "no");
613 /* do stateful model-checking */
614 xbt_cfg_register(&_sg_cfg_set, "model-check/checkpoint",
615 "Specify the amount of steps between checkpoints during stateful model-checking (default: 0 => stateless verification). "
616 "If value=1, one checkpoint is saved for each step => faster verification, but huge memory consumption; higher values are good compromises between speed and memory consumption.",
617 xbt_cfgelm_int, 1, 1, _mc_cfg_cb_checkpoint, NULL);
618 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/checkpoint", 0);
620 /* do stateful model-checking */
621 xbt_cfg_register(&_sg_cfg_set, "model-check/sparse-checkpoint",
622 "Use sparse per-page snapshots.",
623 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_sparse_checkpoint, NULL);
624 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/sparse-checkpoint", "no");
626 /* do stateful model-checking */
627 xbt_cfg_register(&_sg_cfg_set, "model-check/soft-dirty",
628 "Use sparse per-page snapshots.",
629 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_soft_dirty, NULL);
630 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/soft-dirty", "yes");
632 /* do liveness model-checking */
633 xbt_cfg_register(&_sg_cfg_set, "model-check/property",
634 "Specify the name of the file containing the property. It must be the result of the ltl2ba program.",
635 xbt_cfgelm_string, 1, 1, _mc_cfg_cb_property, NULL);
636 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/property", "");
638 /* do communications determinism model-checking */
639 xbt_cfg_register(&_sg_cfg_set, "model-check/communications_determinism",
640 "Enable/disable the detection of determinism in the communications schemes",
641 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_comms_determinism, NULL);
642 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/communications_determinism", "no");
644 /* do send determinism model-checking */
645 xbt_cfg_register(&_sg_cfg_set, "model-check/send_determinism",
646 "Enable/disable the detection of send-determinism in the communications schemes",
647 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_send_determinism, NULL);
648 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/send_determinism", "no");
650 /* Specify the kind of model-checking reduction */
651 xbt_cfg_register(&_sg_cfg_set, "model-check/reduction",
652 "Specify the kind of exploration reduction (either none or DPOR)",
653 xbt_cfgelm_string, 1, 1, _mc_cfg_cb_reduce, NULL);
654 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/reduction", "dpor");
656 /* Enable/disable timeout for wait requests with model-checking */
657 xbt_cfg_register(&_sg_cfg_set, "model-check/timeout",
658 "Enable/Disable timeout for wait requests",
659 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_timeout, NULL);
660 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/timeout", "no");
662 /* Enable/disable global hash computation with model-checking */
663 xbt_cfg_register(&_sg_cfg_set, "model-check/hash",
664 "Enable/Disable state hash for state comparison (exprimental)",
665 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_hash, NULL);
666 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/hash", "no");
668 /* Set max depth exploration */
669 xbt_cfg_register(&_sg_cfg_set, "model-check/max_depth",
670 "Specify the max depth of exploration (default : 1000)",
671 xbt_cfgelm_int, 1, 1, _mc_cfg_cb_max_depth, NULL);
672 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/max_depth", 1000);
674 /* Set number of visited state stored for state comparison reduction*/
675 xbt_cfg_register(&_sg_cfg_set, "model-check/visited",
676 "Specify the number of visited state stored for state comparison reduction. If value=5, the last 5 visited states are stored",
677 xbt_cfgelm_int, 1, 1, _mc_cfg_cb_visited, NULL);
678 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/visited", 0);
680 /* Set file name for dot output of graph state */
681 xbt_cfg_register(&_sg_cfg_set, "model-check/dot_output",
682 "Specify the name of dot file corresponding to graph state",
683 xbt_cfgelm_string, 1, 1, _mc_cfg_cb_dot_output, NULL);
684 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/dot_output", "");
687 /* do verbose-exit */
688 xbt_cfg_register(&_sg_cfg_set, "verbose-exit",
689 "Activate the \"do nothing\" mode in Ctrl-C",
690 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_verbose_exit, NULL);
691 xbt_cfg_setdefault_boolean(_sg_cfg_set, "verbose-exit", "yes");
693 /* context factory */
694 const char *dflt_ctx_fact = "thread";
696 char *p = description +
698 "Context factory to use in SIMIX. Possible values: %s",
700 #ifdef CONTEXT_UCONTEXT
701 dflt_ctx_fact = "ucontext";
702 p += sprintf(p, ", %s", dflt_ctx_fact);
705 dflt_ctx_fact = "raw";
706 p += sprintf(p, ", %s", dflt_ctx_fact);
710 xbt_cfg_register(&_sg_cfg_set, "contexts/factory", description,
711 xbt_cfgelm_string, 1, 1, _sg_cfg_cb_context_factory, NULL);
712 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/factory", dflt_ctx_fact);
714 /* stack size of contexts in KiB */
715 xbt_cfg_register(&_sg_cfg_set, "contexts/stack_size",
716 "Stack size of contexts in KiB",
717 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_context_stack_size, NULL);
718 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/stack_size", 8*1024);
719 /* No, it was not set yet (the above setdefault() changed this to 1). */
720 smx_context_stack_size_was_set = 0;
722 /* guard size for contexts stacks in memory pages */
723 xbt_cfg_register(&_sg_cfg_set, "contexts/guard_size",
724 "Guard size for contexts stacks in memory pages",
725 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_context_guard_size, NULL);
726 #if defined(_XBT_WIN32) || (PTH_STACKGROWTH != -1)
727 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/guard_size", 0);
729 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/guard_size", 1);
731 /* No, it was not set yet (the above setdefault() changed this to 1). */
732 smx_context_guard_size_was_set = 0;
734 /* number of parallel threads for user processes */
735 xbt_cfg_register(&_sg_cfg_set, "contexts/nthreads",
736 "Number of parallel threads used to execute user contexts",
737 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_nthreads, NULL);
738 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/nthreads", 1);
740 /* minimal number of user contexts to be run in parallel */
741 xbt_cfg_register(&_sg_cfg_set, "contexts/parallel_threshold",
742 "Minimal number of user contexts to be run in parallel (raw contexts only)",
743 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_parallel_threshold, NULL);
744 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/parallel_threshold", 2);
746 /* synchronization mode for parallel user contexts */
747 xbt_cfg_register(&_sg_cfg_set, "contexts/synchro",
748 "Synchronization mode to use when running contexts in parallel (either futex, posix or busy_wait)",
749 xbt_cfgelm_string, 1, 1, _sg_cfg_cb_contexts_parallel_mode, NULL);
751 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "futex");
752 #else //No futex on mac and posix is unimplememted yet
753 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "busy_wait");
756 xbt_cfg_register(&_sg_cfg_set, "network/coordinates",
757 "\"yes\" or \"no\", specifying whether we use a coordinate-based routing (as Vivaldi)",
758 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb__surf_network_coordinates, NULL);
759 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/coordinates", "no");
761 xbt_cfg_register(&_sg_cfg_set, "network/crosstraffic",
762 "Activate the interferences between uploads and downloads for fluid max-min models (LV08, CM02)",
763 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb__surf_network_crosstraffic, NULL);
764 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/crosstraffic", "no");
767 xbt_cfg_register(&_sg_cfg_set, "gtnets/jitter",
768 "Double value to oscillate the link latency, uniformly in random interval [-latency*gtnets_jitter,latency*gtnets_jitter)",
769 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__gtnets_jitter, NULL);
770 xbt_cfg_setdefault_double(_sg_cfg_set, "gtnets/jitter", 0.0);
772 xbt_cfg_register(&_sg_cfg_set, "gtnets/jitter_seed",
773 "Use a positive seed to reproduce jitted results, value must be in [1,1e8], default is 10",
774 xbt_cfgelm_int, 0, 1, _sg_cfg_cb__gtnets_jitter_seed, NULL);
775 xbt_cfg_setdefault_int(_sg_cfg_set, "gtnets/jitter_seed", 10);
778 xbt_cfg_register(&_sg_cfg_set, "ns3/TcpModel",
779 "The ns3 tcp model can be : NewReno or Reno or Tahoe",
780 xbt_cfgelm_string, 1, 1, NULL, NULL);
781 xbt_cfg_setdefault_string(_sg_cfg_set, "ns3/TcpModel", "default");
785 xbt_cfg_register(&_sg_cfg_set, "smpi/running_power",
786 "Power of the host running the simulation (in flop/s). Used to bench the operations.",
787 xbt_cfgelm_double, 1, 1, NULL, NULL);
788 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/running_power", 20000.0);
790 xbt_cfg_register(&_sg_cfg_set, "smpi/display_timing",
791 "Boolean indicating whether we should display the timing after simulation.",
792 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
793 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/display_timing", "no");
795 xbt_cfg_register(&_sg_cfg_set, "smpi/simulate_computation",
796 "Boolean indicating whether the computational part of the simulated application should be simulated.",
797 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
798 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/simulate_computation", "yes");
800 xbt_cfg_register(&_sg_cfg_set, "smpi/use_shared_malloc",
801 "Boolean indicating whether we should use shared memory when using SMPI_SHARED_MALLOC. Allows user to disable it for debug purposes.",
802 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
803 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/use_shared_malloc", "yes");
805 xbt_cfg_register(&_sg_cfg_set, "smpi/cpu_threshold",
806 "Minimal computation time (in seconds) not discarded, or -1 for infinity.",
807 xbt_cfgelm_double, 1, 1, NULL, NULL);
808 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/cpu_threshold", 1e-6);
810 xbt_cfg_register(&_sg_cfg_set, "smpi/async_small_thres",
811 "Maximal size of messages that are to be sent asynchronously, without waiting for the receiver",
812 xbt_cfgelm_int, 1, 1, NULL, NULL);
813 xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/async_small_thres", 0);
815 xbt_cfg_register(&_sg_cfg_set, "smpi/send_is_detached_thres",
816 "Threshold of message size where MPI_Send stops behaving like MPI_Isend and becomes MPI_Ssend",
817 xbt_cfgelm_int, 1, 1, NULL, NULL);
818 xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/send_is_detached_thres", 65536);
820 xbt_cfg_register(&_sg_cfg_set, "smpi/privatize_global_variables",
821 "Boolean indicating whether we should privatize global variable at runtime.",
822 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
823 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/privatize_global_variables", "no");
825 //For smpi/bw_factor and smpi/lat_factor
826 //Default value have to be "threshold0:value0;threshold1:value1;...;thresholdN:valueN"
827 //test is if( size >= thresholdN ) return valueN;
828 //Values can be modified with command line --cfg=smpi/bw_factor:"threshold0:value0;threshold1:value1;...;thresholdN:valueN"
829 // or with tag config put line <prop id="smpi/bw_factor" value="threshold0:value0;threshold1:value1;...;thresholdN:valueN"></prop>
830 xbt_cfg_register(&_sg_cfg_set, "smpi/bw_factor",
831 "Bandwidth factors for smpi.",
832 xbt_cfgelm_string, 1, 1, NULL, NULL);
833 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");
835 xbt_cfg_register(&_sg_cfg_set, "smpi/lat_factor",
836 "Latency factors for smpi.",
837 xbt_cfgelm_string, 1, 1, NULL, NULL);
838 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");
840 xbt_cfg_register(&_sg_cfg_set, "smpi/os",
841 "Small messages timings (MPI_Send minimum time for small messages)",
842 xbt_cfgelm_string, 1, 1, NULL, NULL);
843 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/os", "1:0:0:0:0");
845 xbt_cfg_register(&_sg_cfg_set, "smpi/ois",
846 "Small messages timings (MPI_Isend minimum time for small messages)",
847 xbt_cfgelm_string, 1, 1, NULL, NULL);
848 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/ois", "1:0:0:0:0");
850 xbt_cfg_register(&_sg_cfg_set, "smpi/or",
851 "Small messages timings (MPI_Recv minimum time for small messages)",
852 xbt_cfgelm_string, 1, 1, NULL, NULL);
853 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/or", "1:0:0:0:0");
855 xbt_cfg_register(&_sg_cfg_set, "smpi/iprobe",
856 "Minimum time to inject inside a call to MPI_Iprobe",
857 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__iprobe_sleep, NULL);
858 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/iprobe", 1e-4);
860 xbt_cfg_register(&_sg_cfg_set, "smpi/test",
861 "Minimum time to inject inside a call to MPI_Test",
862 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__test_sleep, NULL);
863 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/test", 1e-4);
865 xbt_cfg_register(&_sg_cfg_set, "smpi/wtime",
866 "Minimum time to inject inside a call to MPI_Wtime",
867 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__wtime_sleep, NULL);
868 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/wtime", 0.0);
870 xbt_cfg_register(&_sg_cfg_set, "smpi/coll_selector",
871 "Which collective selector to use",
872 xbt_cfgelm_string, 1, 1, NULL, NULL);
873 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/coll_selector", "default");
875 xbt_cfg_register(&_sg_cfg_set, "smpi/gather",
876 "Which collective to use for gather",
877 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_gather, NULL);
879 xbt_cfg_register(&_sg_cfg_set, "smpi/allgather",
880 "Which collective to use for allgather",
881 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allgather, NULL);
883 xbt_cfg_register(&_sg_cfg_set, "smpi/barrier",
884 "Which collective to use for barrier",
885 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_barrier, NULL);
887 xbt_cfg_register(&_sg_cfg_set, "smpi/reduce_scatter",
888 "Which collective to use for reduce_scatter",
889 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_reduce_scatter, NULL);
891 xbt_cfg_register(&_sg_cfg_set, "smpi/scatter",
892 "Which collective to use for scatter",
893 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_scatter, NULL);
895 xbt_cfg_register(&_sg_cfg_set, "smpi/allgatherv",
896 "Which collective to use for allgatherv",
897 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allgatherv, NULL);
899 xbt_cfg_register(&_sg_cfg_set, "smpi/allreduce",
900 "Which collective to use for allreduce",
901 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allreduce, NULL);
903 xbt_cfg_register(&_sg_cfg_set, "smpi/alltoall",
904 "Which collective to use for alltoall",
905 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_alltoall, NULL);
907 xbt_cfg_register(&_sg_cfg_set, "smpi/alltoallv",
908 "Which collective to use for alltoallv",
909 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_alltoallv, NULL);
911 xbt_cfg_register(&_sg_cfg_set, "smpi/bcast",
912 "Which collective to use for bcast",
913 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_bcast, NULL);
915 xbt_cfg_register(&_sg_cfg_set, "smpi/reduce",
916 "Which collective to use for reduce",
917 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_reduce, NULL);
920 xbt_cfg_register(&_sg_cfg_set, "clean_atexit",
921 "\"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.",
922 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_clean_atexit, NULL);
923 xbt_cfg_setdefault_boolean(_sg_cfg_set, "clean_atexit", "yes");
926 /* retrieves the current directory of the current process */
927 const char *initial_path = __surf_get_initial_path();
928 xbt_assert((initial_path),
929 "__surf_get_initial_path() failed! Can't resolves current Windows directory");
931 surf_path = xbt_dynar_new(sizeof(char *), NULL);
932 xbt_cfg_setdefault_string(_sg_cfg_set, "path", initial_path);
935 xbt_cfg_check(_sg_cfg_set);
936 _sg_cfg_init_status = 1;
938 sg_config_cmd_line(argc, argv);
940 xbt_mallocator_initialization_is_done(SIMIX_context_is_parallel());
943 XBT_WARN("Call to sg_config_init() after initialization ignored");
947 void sg_config_finalize(void)
949 if (!_sg_cfg_init_status)
950 return; /* Not initialized yet. Nothing to do */
952 xbt_cfg_free(&_sg_cfg_set);
953 _sg_cfg_init_status = 0;
956 /* Pick the right models for CPU, net and workstation, and call their model_init_preparse */
957 void surf_config_models_setup()
959 const char *workstation_model_name;
960 const char *vm_workstation_model_name;
961 int workstation_id = -1;
962 int vm_workstation_id = -1;
963 char *network_model_name = NULL;
964 char *cpu_model_name = NULL;
966 char *storage_model_name = NULL;
968 workstation_model_name =
969 xbt_cfg_get_string(_sg_cfg_set, "workstation/model");
970 vm_workstation_model_name =
971 xbt_cfg_get_string(_sg_cfg_set, "vm_workstation/model");
972 network_model_name = xbt_cfg_get_string(_sg_cfg_set, "network/model");
973 cpu_model_name = xbt_cfg_get_string(_sg_cfg_set, "cpu/model");
974 storage_model_name = xbt_cfg_get_string(_sg_cfg_set, "storage/model");
976 /* Check whether we use a net/cpu model differing from the default ones, in which case
977 * we should switch to the "compound" workstation model to correctly dispatch stuff to
978 * the right net/cpu models.
981 if ((!xbt_cfg_is_default_value(_sg_cfg_set, "network/model") ||
982 !xbt_cfg_is_default_value(_sg_cfg_set, "cpu/model")) &&
983 xbt_cfg_is_default_value(_sg_cfg_set, "workstation/model")) {
984 XBT_INFO("Switching workstation model to compound since you changed the network and/or cpu model(s)");
985 workstation_model_name = "compound";
986 xbt_cfg_set_string(_sg_cfg_set, "workstation/model", workstation_model_name);
989 XBT_DEBUG("Workstation model: %s", workstation_model_name);
991 find_model_description(surf_workstation_model_description,
992 workstation_model_name);
993 if (!strcmp(workstation_model_name, "compound")) {
997 xbt_assert(cpu_model_name,
998 "Set a cpu model to use with the 'compound' workstation model");
1000 xbt_assert(network_model_name,
1001 "Set a network model to use with the 'compound' workstation model");
1003 if(surf_cpu_model_init_preparse){
1004 surf_cpu_model_init_preparse();
1007 find_model_description(surf_cpu_model_description, cpu_model_name);
1008 surf_cpu_model_description[cpu_id].model_init_preparse();
1012 find_model_description(surf_network_model_description,
1013 network_model_name);
1014 surf_network_model_description[network_id].model_init_preparse();
1017 XBT_DEBUG("Call workstation_model_init");
1018 surf_workstation_model_description[workstation_id].model_init_preparse();
1020 XBT_DEBUG("Call vm_workstation_model_init");
1021 vm_workstation_id = find_model_description(surf_vm_workstation_model_description,
1022 vm_workstation_model_name);
1023 surf_vm_workstation_model_description[vm_workstation_id].model_init_preparse();
1025 XBT_DEBUG("Call storage_model_init");
1026 storage_id = find_model_description(surf_storage_model_description, storage_model_name);
1027 surf_storage_model_description[storage_id].model_init_preparse();
1031 int sg_cfg_is_default_value(const char *name)
1033 return xbt_cfg_is_default_value(_sg_cfg_set, name);
1036 int sg_cfg_get_int(const char* name)
1038 return xbt_cfg_get_int(_sg_cfg_set, name);
1041 double sg_cfg_get_double(const char* name)
1043 return xbt_cfg_get_double(_sg_cfg_set, name);
1046 char* sg_cfg_get_string(const char* name)
1048 return xbt_cfg_get_string(_sg_cfg_set, name);
1051 int sg_cfg_get_boolean(const char* name)
1053 return xbt_cfg_get_boolean(_sg_cfg_set, name);
1056 void sg_cfg_get_peer(const char *name, char **peer, int *port)
1058 xbt_cfg_get_peer(_sg_cfg_set, name, peer, port);
1061 xbt_dynar_t sg_cfg_get_dynar(const char* name)
1063 return xbt_cfg_get_dynar(_sg_cfg_set, name);