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"
70 "You can also use --help-models to see the details of all models known by this simulator.\n"
73 "You can also use --help-tracing to see the details of all tracing options known by this simulator.\n"
76 "You can also use --help-logs and --help-log-categories to see the details of logging output.\n"
78 "You can also use --version to get SimGrid version information.\n"
82 } else if (!strcmp(argv[i], "--help-models")) {
85 model_help("workstation", surf_workstation_model_description);
87 model_help("CPU", surf_cpu_model_description);
89 model_help("network", surf_network_model_description);
90 printf("\nLong description of all optimization levels accepted by the models of this simulator:\n");
91 for (k = 0; surf_optimization_mode_description[k].name; k++)
93 surf_optimization_mode_description[k].name,
94 surf_optimization_mode_description[k].description);
95 printf("Both network and CPU models have 'Lazy' as default optimization level\n\n");
98 } else if (!strcmp(argv[i], "--help-tracing")) {
114 /* callback of the plugin variable */
115 static void _sg_cfg_cb__plugin(const char *name, int pos)
120 xbt_assert(_sg_cfg_init_status < 2,
121 "Cannot load a plugin after the initialization");
123 val = xbt_cfg_get_string(_sg_cfg_set, name);
125 if (!strcmp(val, "help")) {
126 model_help("plugin", surf_plugin_description);
130 /* New Module missing */
131 int plugin_id = find_model_description(surf_plugin_description, val);
132 surf_plugin_description[plugin_id].model_init_preparse();
135 /* callback of the workstation/model variable */
136 static void _sg_cfg_cb__workstation_model(const char *name, int pos)
140 xbt_assert(_sg_cfg_init_status < 2,
141 "Cannot change the model after the initialization");
143 val = xbt_cfg_get_string(_sg_cfg_set, name);
145 if (!strcmp(val, "help")) {
146 model_help("workstation", surf_workstation_model_description);
150 /* Make sure that the model exists */
151 find_model_description(surf_workstation_model_description, val);
154 /* callback of the vm_workstation/model variable */
155 static void _sg_cfg_cb__vm_workstation_model(const char *name, int pos)
159 xbt_assert(_sg_cfg_init_status < 2,
160 "Cannot change the model after the initialization");
162 val = xbt_cfg_get_string(_sg_cfg_set, name);
164 if (!strcmp(val, "help")) {
165 model_help("vm_workstation", surf_vm_workstation_model_description);
169 /* Make sure that the model exists */
170 find_model_description(surf_vm_workstation_model_description, val);
173 /* callback of the cpu/model variable */
174 static void _sg_cfg_cb__cpu_model(const char *name, int pos)
178 xbt_assert(_sg_cfg_init_status < 2,
179 "Cannot change the model after the initialization");
181 val = xbt_cfg_get_string(_sg_cfg_set, name);
183 if (!strcmp(val, "help")) {
184 model_help("CPU", surf_cpu_model_description);
188 /* New Module missing */
189 find_model_description(surf_cpu_model_description, val);
192 /* callback of the cpu/model variable */
193 static void _sg_cfg_cb__optimization_mode(const char *name, int pos)
197 xbt_assert(_sg_cfg_init_status < 2,
198 "Cannot change the model after the initialization");
200 val = xbt_cfg_get_string(_sg_cfg_set, name);
202 if (!strcmp(val, "help")) {
203 model_help("optimization", surf_optimization_mode_description);
207 /* New Module missing */
208 find_model_description(surf_optimization_mode_description, val);
211 /* callback of the cpu/model variable */
212 static void _sg_cfg_cb__storage_mode(const char *name, int pos)
216 xbt_assert(_sg_cfg_init_status < 2,
217 "Cannot change the model after the initialization");
219 val = xbt_cfg_get_string(_sg_cfg_set, name);
221 if (!strcmp(val, "help")) {
222 model_help("storage", surf_storage_model_description);
226 /* New Module missing */
227 find_model_description(surf_storage_model_description, val);
230 /* callback of the workstation_model variable */
231 static void _sg_cfg_cb__network_model(const char *name, int pos)
235 xbt_assert(_sg_cfg_init_status < 2,
236 "Cannot change the model after the initialization");
238 val = xbt_cfg_get_string(_sg_cfg_set, name);
240 if (!strcmp(val, "help")) {
241 model_help("network", surf_network_model_description);
245 /* New Module missing */
246 find_model_description(surf_network_model_description, val);
249 /* callbacks of the network models values */
250 static void _sg_cfg_cb__tcp_gamma(const char *name, int pos)
252 sg_tcp_gamma = xbt_cfg_get_double(_sg_cfg_set, name);
255 static void _sg_cfg_cb__maxmin_precision(const char* name, int pos)
257 sg_maxmin_precision = xbt_cfg_get_double(_sg_cfg_set, name);
260 static void _sg_cfg_cb__sender_gap(const char* name, int pos)
262 sg_sender_gap = xbt_cfg_get_double(_sg_cfg_set, name);
265 static void _sg_cfg_cb__latency_factor(const char *name, int pos)
267 sg_latency_factor = xbt_cfg_get_double(_sg_cfg_set, name);
270 static void _sg_cfg_cb__bandwidth_factor(const char *name, int pos)
272 sg_bandwidth_factor = xbt_cfg_get_double(_sg_cfg_set, name);
275 static void _sg_cfg_cb__weight_S(const char *name, int pos)
277 sg_weight_S_parameter = xbt_cfg_get_double(_sg_cfg_set, name);
281 /* callback of the mpi collectives */
282 static void _sg_cfg_cb__coll(const char *category,
283 s_mpi_coll_description_t * table,
284 const char *name, int pos)
288 xbt_assert(_sg_cfg_init_status < 2,
289 "Cannot change the model after the initialization");
291 val = xbt_cfg_get_string(_sg_cfg_set, name);
293 if (!strcmp(val, "help")) {
294 coll_help(category, table);
298 /* New Module missing */
299 find_coll_description(table, val);
301 static void _sg_cfg_cb__coll_gather(const char *name, int pos){
302 _sg_cfg_cb__coll("gather", mpi_coll_gather_description, name, pos);
304 static void _sg_cfg_cb__coll_allgather(const char *name, int pos){
305 _sg_cfg_cb__coll("allgather", mpi_coll_allgather_description, name, pos);
307 static void _sg_cfg_cb__coll_allgatherv(const char *name, int pos){
308 _sg_cfg_cb__coll("allgatherv", mpi_coll_allgatherv_description, name, pos);
310 static void _sg_cfg_cb__coll_allreduce(const char *name, int pos)
312 _sg_cfg_cb__coll("allreduce", mpi_coll_allreduce_description, name, pos);
314 static void _sg_cfg_cb__coll_alltoall(const char *name, int pos)
316 _sg_cfg_cb__coll("alltoall", mpi_coll_alltoall_description, name, pos);
318 static void _sg_cfg_cb__coll_alltoallv(const char *name, int pos)
320 _sg_cfg_cb__coll("alltoallv", mpi_coll_alltoallv_description, name, pos);
322 static void _sg_cfg_cb__coll_bcast(const char *name, int pos)
324 _sg_cfg_cb__coll("bcast", mpi_coll_bcast_description, name, pos);
326 static void _sg_cfg_cb__coll_reduce(const char *name, int pos)
328 _sg_cfg_cb__coll("reduce", mpi_coll_reduce_description, name, pos);
330 static void _sg_cfg_cb__coll_reduce_scatter(const char *name, int pos){
331 _sg_cfg_cb__coll("reduce_scatter", mpi_coll_reduce_scatter_description, name, pos);
333 static void _sg_cfg_cb__coll_scatter(const char *name, int pos){
334 _sg_cfg_cb__coll("scatter", mpi_coll_scatter_description, name, pos);
336 static void _sg_cfg_cb__coll_barrier(const char *name, int pos){
337 _sg_cfg_cb__coll("barrier", mpi_coll_barrier_description, name, pos);
341 /* callback of the inclusion path */
342 static void _sg_cfg_cb__surf_path(const char *name, int pos)
344 char *path = xbt_cfg_get_string_at(_sg_cfg_set, name, pos);
345 xbt_dynar_push(surf_path, &path);
348 /* callback to decide if we want to use the model-checking */
349 #include "xbt_modinter.h"
351 extern int _sg_do_model_check; /* this variable lives in xbt_main until I find a right location for it */
354 static void _sg_cfg_cb_model_check(const char *name, int pos)
357 _sg_do_model_check = xbt_cfg_get_boolean(_sg_cfg_set, name);
359 if (xbt_cfg_get_boolean(_sg_cfg_set, name)) {
360 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");
365 extern int _sg_do_verbose_exit;
367 static void _sg_cfg_cb_verbose_exit(const char *name, int pos)
369 _sg_do_verbose_exit = xbt_cfg_get_boolean(_sg_cfg_set, name);
372 extern int _sg_do_clean_atexit;
374 static void _sg_cfg_cb_clean_atexit(const char *name, int pos)
376 _sg_do_clean_atexit = xbt_cfg_get_boolean(_sg_cfg_set, name);
379 static void _sg_cfg_cb_context_factory(const char *name, int pos)
381 smx_context_factory_name = xbt_cfg_get_string(_sg_cfg_set, name);
384 static void _sg_cfg_cb_context_stack_size(const char *name, int pos)
386 smx_context_stack_size_was_set = 1;
387 smx_context_stack_size = xbt_cfg_get_int(_sg_cfg_set, name) * 1024;
390 static void _sg_cfg_cb_contexts_nthreads(const char *name, int pos)
392 SIMIX_context_set_nthreads(xbt_cfg_get_int(_sg_cfg_set, name));
395 static void _sg_cfg_cb_contexts_parallel_threshold(const char *name, int pos)
397 SIMIX_context_set_parallel_threshold(xbt_cfg_get_int(_sg_cfg_set, name));
400 static void _sg_cfg_cb_contexts_parallel_mode(const char *name, int pos)
402 const char* mode_name = xbt_cfg_get_string(_sg_cfg_set, name);
403 if (!strcmp(mode_name, "posix")) {
404 SIMIX_context_set_parallel_mode(XBT_PARMAP_POSIX);
406 else if (!strcmp(mode_name, "futex")) {
407 SIMIX_context_set_parallel_mode(XBT_PARMAP_FUTEX);
409 else if (!strcmp(mode_name, "busy_wait")) {
410 SIMIX_context_set_parallel_mode(XBT_PARMAP_BUSY_WAIT);
413 xbt_die("Command line setting of the parallel synchronization mode should "
414 "be one of \"posix\", \"futex\" or \"busy_wait\"");
418 static void _sg_cfg_cb__surf_network_coordinates(const char *name,
421 int val = xbt_cfg_get_boolean(_sg_cfg_set, name);
423 if (!COORD_HOST_LEVEL) {
424 COORD_HOST_LEVEL = xbt_lib_add_level(host_lib,xbt_dynar_free_voidp);
425 COORD_ASR_LEVEL = xbt_lib_add_level(as_router_lib,xbt_dynar_free_voidp);
428 if (COORD_HOST_LEVEL)
429 xbt_die("Setting of whether to use coordinate cannot be disabled once set.");
432 static void _sg_cfg_cb__surf_network_crosstraffic(const char *name,
435 sg_network_crosstraffic = xbt_cfg_get_boolean(_sg_cfg_set, name);
439 static void _sg_cfg_cb__gtnets_jitter(const char *name, int pos)
441 sg_gtnets_jitter = xbt_cfg_get_double(_sg_cfg_set, name);
444 static void _sg_cfg_cb__gtnets_jitter_seed(const char *name, int pos)
446 sg_gtnets_jitter_seed = xbt_cfg_get_int(_sg_cfg_set, name);
450 /* create the config set, register what should be and parse the command line*/
451 void sg_config_init(int *argc, char **argv)
453 char *description = xbt_malloc(1024);
457 /* Create the configuration support */
458 if (_sg_cfg_init_status == 0) { /* Only create stuff if not already inited */
460 /* Plugins configuration */
461 p = description + sprintf(description, "The plugins. Possible values: ");
462 for (i = 0; surf_plugin_description[i].name; i++)
463 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
464 surf_plugin_description[i].name);
466 ".\n (use 'help' as a value to see the long description of each plugin)");
467 xbt_cfg_register(&_sg_cfg_set, "plugin", description,
468 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__plugin, NULL);
470 p = description + sprintf(description,
471 "The model to use for the CPU. Possible values: ");
472 for (i = 0; surf_cpu_model_description[i].name; i++)
473 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
474 surf_cpu_model_description[i].name);
476 ".\n (use 'help' as a value to see the long description of each model)");
477 xbt_cfg_register(&_sg_cfg_set, "cpu/model", description,
478 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__cpu_model, NULL);
479 xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/model", "Cas01");
483 "The optimization modes to use for the CPU. Possible values: ");
484 for (i = 0; surf_optimization_mode_description[i].name; i++)
485 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
486 surf_optimization_mode_description[i].name);
488 ".\n (use 'help' as a value to see the long description of each optimization mode)");
489 xbt_cfg_register(&_sg_cfg_set, "cpu/optim", description,
490 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode, NULL);
491 xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/optim", "Lazy");
495 "The model to use for the storage. Possible values: ");
496 for (i = 0; surf_storage_model_description[i].name; i++)
497 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
498 surf_storage_model_description[i].name);
500 ".\n (use 'help' as a value to see the long description of each model)");
501 xbt_cfg_register(&_sg_cfg_set, "storage/model", description,
502 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__storage_mode, NULL);
503 xbt_cfg_setdefault_string(_sg_cfg_set, "storage/model", "default");
507 "The model to use for the network. Possible values: ");
508 for (i = 0; surf_network_model_description[i].name; i++)
509 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
510 surf_network_model_description[i].name);
512 ".\n (use 'help' as a value to see the long description of each model)");
513 xbt_cfg_register(&_sg_cfg_set, "network/model", description,
514 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__network_model, NULL);
515 xbt_cfg_setdefault_string(_sg_cfg_set, "network/model", "LV08");
519 "The optimization modes to use for the network. Possible values: ");
520 for (i = 0; surf_optimization_mode_description[i].name; i++)
521 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
522 surf_optimization_mode_description[i].name);
524 ".\n (use 'help' as a value to see the long description of each optimization mode)");
525 xbt_cfg_register(&_sg_cfg_set, "network/optim", description,
526 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode, NULL);
527 xbt_cfg_setdefault_string(_sg_cfg_set, "network/optim", "Lazy");
531 "The model to use for the workstation. Possible values: ");
532 for (i = 0; surf_workstation_model_description[i].name; i++)
533 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
534 surf_workstation_model_description[i].name);
536 ".\n (use 'help' as a value to see the long description of each model)");
537 xbt_cfg_register(&_sg_cfg_set, "workstation/model", description,
538 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__workstation_model, NULL);
539 xbt_cfg_setdefault_string(_sg_cfg_set, "workstation/model", "default");
541 xbt_cfg_register(&_sg_cfg_set, "vm_workstation/model", description,
542 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__vm_workstation_model, NULL);
543 xbt_cfg_setdefault_string(_sg_cfg_set, "vm_workstation/model", "default");
545 xbt_cfg_register(&_sg_cfg_set, "network/TCP_gamma",
546 "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)",
547 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__tcp_gamma, NULL);
548 xbt_cfg_setdefault_double(_sg_cfg_set, "network/TCP_gamma", 4194304.0);
550 xbt_cfg_register(&_sg_cfg_set, "maxmin/precision",
551 "Numerical precision used when updating simulation models (epsilon in double comparisons)",
552 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__maxmin_precision, NULL);
553 xbt_cfg_setdefault_double(_sg_cfg_set, "maxmin/precision", 0.00001);
555 /* The parameters of network models */
557 xbt_cfg_register(&_sg_cfg_set, "network/sender_gap",
558 "Minimum gap between two overlapping sends",
559 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__sender_gap, NULL);
560 /* default for "network/sender_gap" is set in network.c */
562 xbt_cfg_register(&_sg_cfg_set, "network/latency_factor",
563 "Correction factor to apply to the provided latency (default value set by network model)",
564 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__latency_factor, NULL);
565 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 1.0);
567 xbt_cfg_register(&_sg_cfg_set, "network/bandwidth_factor",
568 "Correction factor to apply to the provided bandwidth (default value set by network model)",
569 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__bandwidth_factor, NULL);
570 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 1.0);
572 xbt_cfg_register(&_sg_cfg_set, "network/weight_S",
573 "Correction factor to apply to the weight of competing streams (default value set by network model)",
574 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__weight_S, NULL);
575 /* default for "network/weight_S" is set in network.c */
578 xbt_cfg_register(&_sg_cfg_set, "path",
579 "Lookup path for inclusions in platform and deployment XML files",
580 xbt_cfgelm_string, 0, 0, _sg_cfg_cb__surf_path, NULL);
582 xbt_cfg_register(&_sg_cfg_set, "cpu/maxmin_selective_update",
583 "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
584 xbt_cfgelm_boolean, 0, 1, NULL, NULL);
585 xbt_cfg_setdefault_boolean(_sg_cfg_set, "cpu/maxmin_selective_update", "no");
587 xbt_cfg_register(&_sg_cfg_set, "network/maxmin_selective_update",
588 "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
589 xbt_cfgelm_boolean, 0, 1, NULL, NULL);
590 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/maxmin_selective_update", "no");
593 /* do model-checking */
594 xbt_cfg_register(&_sg_cfg_set, "model-check",
595 "Verify the system through model-checking instead of simulating it (EXPERIMENTAL)",
596 xbt_cfgelm_boolean, 0, 1, _sg_cfg_cb_model_check, NULL);
597 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check", "no");
599 /* do stateful model-checking */
600 xbt_cfg_register(&_sg_cfg_set, "model-check/checkpoint",
601 "Specify the amount of steps between checkpoints during stateful model-checking (default: 0 => stateless verification). "
602 "If value=on, one checkpoint is saved for each step => faster verification, but huge memory consumption; higher values are good compromises between speed and memory consumption.",
603 xbt_cfgelm_int, 0, 1, _mc_cfg_cb_checkpoint, NULL);
604 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/checkpoint", 0);
606 /* do liveness model-checking */
607 xbt_cfg_register(&_sg_cfg_set, "model-check/property",
608 "Specify the name of the file containing the property. It must be the result of the ltl2ba program.",
609 xbt_cfgelm_string, 0, 1, _mc_cfg_cb_property, NULL);
610 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/property", "");
612 /* Specify the kind of model-checking reduction */
613 xbt_cfg_register(&_sg_cfg_set, "model-check/reduction",
614 "Specify the kind of exploration reduction (either none or DPOR)",
615 xbt_cfgelm_string, 0, 1, _mc_cfg_cb_reduce, NULL);
616 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/reduction", "dpor");
618 /* Enable/disable timeout for wait requests with model-checking */
619 xbt_cfg_register(&_sg_cfg_set, "model-check/timeout",
620 "Enable/Disable timeout for wait requests",
621 xbt_cfgelm_boolean, 0, 1, _mc_cfg_cb_timeout, NULL);
622 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/timeout", "no");
624 /* Set max depth exploration */
625 xbt_cfg_register(&_sg_cfg_set, "model-check/max_depth",
626 "Specify the max depth of exploration (default : 1000)",
627 xbt_cfgelm_int, 0, 1, _mc_cfg_cb_max_depth, NULL);
628 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/max_depth", 1000);
630 /* Set number of visited state stored for state comparison reduction*/
631 xbt_cfg_register(&_sg_cfg_set, "model-check/visited",
632 "Specify the number of visited state stored for state comparison reduction. If value=5, the last 5 visited states are stored",
633 xbt_cfgelm_int, 0, 1, _mc_cfg_cb_visited, NULL);
634 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/visited", 0);
636 /* Set file name for dot output of graph state */
637 xbt_cfg_register(&_sg_cfg_set, "model-check/dot_output",
638 "Specify the name of dot file corresponding to graph state",
639 xbt_cfgelm_string, 0, 1, _mc_cfg_cb_dot_output, NULL);
640 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/dot_output", "");
643 /* do verbose-exit */
644 xbt_cfg_register(&_sg_cfg_set, "verbose-exit",
645 "Activate the \"do nothing\" mode in Ctrl-C",
646 xbt_cfgelm_boolean, 0, 1, _sg_cfg_cb_verbose_exit, NULL);
647 xbt_cfg_setdefault_boolean(_sg_cfg_set, "verbose-exit", "yes");
649 /* context factory */
652 "Context factory to use in SIMIX. Possible values: thread");
653 const char *dflt_ctx_fact = "thread";
654 #ifdef CONTEXT_UCONTEXT
655 dflt_ctx_fact = "ucontext";
656 p += sprintf(p, ", %s", dflt_ctx_fact);
659 dflt_ctx_fact = "raw";
660 p += sprintf(p, ", %s", dflt_ctx_fact);
663 xbt_cfg_register(&_sg_cfg_set, "contexts/factory", description,
664 xbt_cfgelm_string, 1, 1, _sg_cfg_cb_context_factory, NULL);
665 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/factory", dflt_ctx_fact);
667 /* stack size of contexts in Ko */
668 xbt_cfg_register(&_sg_cfg_set, "contexts/stack_size",
669 "Stack size of contexts in Kib",
670 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_context_stack_size, NULL);
671 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/stack_size", 128);
672 /* No, it was not set yet (the above setdefault() changed this to 1). */
673 smx_context_stack_size_was_set = 0;
675 /* number of parallel threads for user processes */
676 xbt_cfg_register(&_sg_cfg_set, "contexts/nthreads",
677 "Number of parallel threads used to execute user contexts",
678 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_nthreads, NULL);
679 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/nthreads", 1);
681 /* minimal number of user contexts to be run in parallel */
682 xbt_cfg_register(&_sg_cfg_set, "contexts/parallel_threshold",
683 "Minimal number of user contexts to be run in parallel (raw contexts only)",
684 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_parallel_threshold, NULL);
685 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/parallel_threshold", 2);
687 /* synchronization mode for parallel user contexts */
688 xbt_cfg_register(&_sg_cfg_set, "contexts/synchro",
689 "Synchronization mode to use when running contexts in parallel (either futex, posix or busy_wait)",
690 xbt_cfgelm_string, 1, 1, _sg_cfg_cb_contexts_parallel_mode, NULL);
692 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "futex");
693 #else //No futex on mac and posix is unimplememted yet
694 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "busy_wait");
697 xbt_cfg_register(&_sg_cfg_set, "network/coordinates",
698 "\"yes\" or \"no\", specifying whether we use a coordinate-based routing (as Vivaldi)",
699 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb__surf_network_coordinates, NULL);
700 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/coordinates", "no");
702 xbt_cfg_register(&_sg_cfg_set, "network/crosstraffic",
703 "Activate the interferences between uploads and downloads for fluid max-min models (LV08, CM02)",
704 xbt_cfgelm_boolean, 0, 1, _sg_cfg_cb__surf_network_crosstraffic, NULL);
705 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/crosstraffic", "no");
708 xbt_cfg_register(&_sg_cfg_set, "gtnets/jitter",
709 "Double value to oscillate the link latency, uniformly in random interval [-latency*gtnets_jitter,latency*gtnets_jitter)",
710 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__gtnets_jitter, NULL);
711 xbt_cfg_setdefault_double(_sg_cfg_set, "gtnets/jitter", 0.0);
713 xbt_cfg_register(&_sg_cfg_set, "gtnets/jitter_seed",
714 "Use a positive seed to reproduce jitted results, value must be in [1,1e8], default is 10",
715 xbt_cfgelm_int, 0, 1, _sg_cfg_cb__gtnets_jitter_seed, NULL);
716 xbt_cfg_setdefault_int(_sg_cfg_set, "gtnets/jitter_seed", 10);
719 xbt_cfg_register(&_sg_cfg_set, "ns3/TcpModel",
720 "The ns3 tcp model can be : NewReno or Reno or Tahoe",
721 xbt_cfgelm_string, 1, 1, NULL, NULL);
722 xbt_cfg_setdefault_string(_sg_cfg_set, "ns3/TcpModel", "default");
726 xbt_cfg_register(&_sg_cfg_set, "smpi/running_power",
727 "Power of the host running the simulation (in flop/s). Used to bench the operations.",
728 xbt_cfgelm_double, 1, 1, NULL, NULL);
729 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/running_power", 20000.0);
731 xbt_cfg_register(&_sg_cfg_set, "smpi/display_timing",
732 "Boolean indicating whether we should display the timing after simulation.",
733 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
734 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/display_timing", "no");
736 xbt_cfg_register(&_sg_cfg_set, "smpi/use_shared_malloc",
737 "Boolean indicating whether we should use shared memory when using SMPI_SHARED_MALLOC. Allows user to disable it for debug purposes.",
738 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
739 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/use_shared_malloc", "yes");
741 xbt_cfg_register(&_sg_cfg_set, "smpi/cpu_threshold",
742 "Minimal computation time (in seconds) not discarded, or -1 for infinity.",
743 xbt_cfgelm_double, 1, 1, NULL, NULL);
744 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/cpu_threshold", 1e-6);
746 xbt_cfg_register(&_sg_cfg_set, "smpi/async_small_thres",
747 "Maximal size of messages that are to be sent asynchronously, without waiting for the receiver",
748 xbt_cfgelm_int, 1, 1, NULL, NULL);
749 xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/async_small_thres", 0);
751 xbt_cfg_register(&_sg_cfg_set, "smpi/send_is_detached_thres",
752 "Threshold of message size where MPI_Send stops behaving like MPI_Isend and becomes MPI_Ssend",
753 xbt_cfgelm_int, 1, 1, NULL, NULL);
754 xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/send_is_detached_thres", 65536);
756 //For smpi/bw_factor and smpi/lat_factor
757 //Default value have to be "threshold0:value0;threshold1:value1;...;thresholdN:valueN"
758 //test is if( size >= thresholdN ) return valueN;
759 //Values can be modified with command line --cfg=smpi/bw_factor:"threshold0:value0;threshold1:value1;...;thresholdN:valueN"
760 // or with tag config put line <prop id="smpi/bw_factor" value="threshold0:value0;threshold1:value1;...;thresholdN:valueN"></prop>
761 xbt_cfg_register(&_sg_cfg_set, "smpi/bw_factor",
762 "Bandwidth factors for smpi.",
763 xbt_cfgelm_string, 1, 1, NULL, NULL);
764 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");
766 xbt_cfg_register(&_sg_cfg_set, "smpi/lat_factor",
767 "Latency factors for smpi.",
768 xbt_cfgelm_string, 1, 1, NULL, NULL);
769 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");
771 xbt_cfg_register(&_sg_cfg_set, "smpi/os",
772 "Small messages timings (MPI_Send minimum time for small messages)",
773 xbt_cfgelm_string, 1, 1, NULL, NULL);
774 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/os", "1:0:0:0:0");
776 xbt_cfg_register(&_sg_cfg_set, "smpi/ois",
777 "Small messages timings (MPI_Isend minimum time for small messages)",
778 xbt_cfgelm_string, 1, 1, NULL, NULL);
779 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/ois", "1:0:0:0:0");
781 xbt_cfg_register(&_sg_cfg_set, "smpi/or",
782 "Small messages timings (MPI_Recv minimum time for small messages)",
783 xbt_cfgelm_string, 1, 1, NULL, NULL);
784 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/or", "1:0:0:0:0");
785 xbt_cfg_register(&_sg_cfg_set, "smpi/iprobe",
786 "Minimum time to inject inside a call to MPI_Iprobe",
787 xbt_cfgelm_double, 1, 1, NULL, NULL);
788 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/iprobe", 1e-4);
789 xbt_cfg_register(&_sg_cfg_set, "smpi/coll_selector",
790 "Which collective selector to use",
791 xbt_cfgelm_string, 1, 1, NULL, NULL);
792 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/coll_selector", "default");
794 xbt_cfg_register(&_sg_cfg_set, "smpi/gather",
795 "Which collective to use for gather",
796 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_gather, NULL);
798 xbt_cfg_register(&_sg_cfg_set, "smpi/allgather",
799 "Which collective to use for allgather",
800 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_allgather, NULL);
802 xbt_cfg_register(&_sg_cfg_set, "smpi/barrier",
803 "Which collective to use for barrier",
804 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_barrier, NULL);
806 xbt_cfg_register(&_sg_cfg_set, "smpi/reduce_scatter",
807 "Which collective to use for reduce_scatter",
808 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_reduce_scatter, NULL);
810 xbt_cfg_register(&_sg_cfg_set, "smpi/scatter",
811 "Which collective to use for scatter",
812 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_scatter, NULL);
814 xbt_cfg_register(&_sg_cfg_set, "smpi/allgatherv",
815 "Which collective to use for allgatherv",
816 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_allgatherv, NULL);
818 xbt_cfg_register(&_sg_cfg_set, "smpi/allreduce",
819 "Which collective to use for allreduce",
820 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_allreduce, NULL);
822 xbt_cfg_register(&_sg_cfg_set, "smpi/alltoall",
823 "Which collective to use for alltoall",
824 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_alltoall, NULL);
826 xbt_cfg_register(&_sg_cfg_set, "smpi/alltoallv",
827 "Which collective to use for alltoallv",
828 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_alltoallv, NULL);
830 xbt_cfg_register(&_sg_cfg_set, "smpi/bcast",
831 "Which collective to use for bcast",
832 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_bcast, NULL);
834 xbt_cfg_register(&_sg_cfg_set, "smpi/reduce",
835 "Which collective to use for reduce",
836 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_reduce, NULL);
839 xbt_cfg_register(&_sg_cfg_set, "clean_atexit",
840 "\"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.",
841 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_clean_atexit, NULL);
842 xbt_cfg_setdefault_boolean(_sg_cfg_set, "clean_atexit", "yes");
845 /* retrieves the current directory of the current process */
846 const char *initial_path = __surf_get_initial_path();
847 xbt_assert((initial_path),
848 "__surf_get_initial_path() failed! Can't resolves current Windows directory");
850 surf_path = xbt_dynar_new(sizeof(char *), NULL);
851 xbt_cfg_setdefault_string(_sg_cfg_set, "path", initial_path);
854 _sg_cfg_init_status = 1;
856 sg_config_cmd_line(argc, argv);
858 xbt_mallocator_initialization_is_done(SIMIX_context_is_parallel());
861 XBT_WARN("Call to sg_config_init() after initialization ignored");
864 xbt_free(description);
867 void sg_config_finalize(void)
869 if (!_sg_cfg_init_status)
870 return; /* Not initialized yet. Nothing to do */
872 xbt_cfg_free(&_sg_cfg_set);
873 _sg_cfg_init_status = 0;
876 /* Pick the right models for CPU, net and workstation, and call their model_init_preparse */
877 void surf_config_models_setup()
879 const char *workstation_model_name;
880 const char *vm_workstation_model_name;
881 int workstation_id = -1;
882 int vm_workstation_id = -1;
883 char *network_model_name = NULL;
884 char *cpu_model_name = NULL;
886 char *storage_model_name = NULL;
888 workstation_model_name =
889 xbt_cfg_get_string(_sg_cfg_set, "workstation/model");
890 vm_workstation_model_name =
891 xbt_cfg_get_string(_sg_cfg_set, "vm_workstation/model");
892 network_model_name = xbt_cfg_get_string(_sg_cfg_set, "network/model");
893 cpu_model_name = xbt_cfg_get_string(_sg_cfg_set, "cpu/model");
894 storage_model_name = xbt_cfg_get_string(_sg_cfg_set, "storage/model");
896 /* Check whether we use a net/cpu model differing from the default ones, in which case
897 * we should switch to the "compound" workstation model to correctly dispatch stuff to
898 * the right net/cpu models.
901 if ((!xbt_cfg_is_default_value(_sg_cfg_set, "network/model") ||
902 !xbt_cfg_is_default_value(_sg_cfg_set, "cpu/model")) &&
903 xbt_cfg_is_default_value(_sg_cfg_set, "workstation/model")) {
904 XBT_INFO("Switching workstation model to compound since you changed the network and/or cpu model(s)");
905 workstation_model_name = "compound";
906 xbt_cfg_set_string(_sg_cfg_set, "workstation/model", workstation_model_name);
909 XBT_DEBUG("Workstation model: %s", workstation_model_name);
911 find_model_description(surf_workstation_model_description,
912 workstation_model_name);
913 if (!strcmp(workstation_model_name, "compound")) {
917 xbt_assert(cpu_model_name,
918 "Set a cpu model to use with the 'compound' workstation model");
920 xbt_assert(network_model_name,
921 "Set a network model to use with the 'compound' workstation model");
924 find_model_description(surf_network_model_description,
927 find_model_description(surf_cpu_model_description, cpu_model_name);
929 surf_cpu_model_description[cpu_id].model_init_preparse();
930 surf_network_model_description[network_id].model_init_preparse();
933 XBT_DEBUG("Call workstation_model_init");
934 surf_workstation_model_description[workstation_id].model_init_preparse();
936 XBT_DEBUG("Call vm_workstation_model_init");
937 vm_workstation_id = find_model_description(surf_vm_workstation_model_description,
938 vm_workstation_model_name);
939 surf_vm_workstation_model_description[vm_workstation_id].model_init_preparse();
941 XBT_DEBUG("Call storage_model_init");
942 storage_id = find_model_description(surf_storage_model_description, storage_model_name);
943 surf_storage_model_description[storage_id].model_init_preparse();
947 int sg_cfg_is_default_value(const char *name)
949 return xbt_cfg_is_default_value(_sg_cfg_set, name);
952 int sg_cfg_get_int(const char* name)
954 return xbt_cfg_get_int(_sg_cfg_set, name);
957 double sg_cfg_get_double(const char* name)
959 return xbt_cfg_get_double(_sg_cfg_set, name);
962 char* sg_cfg_get_string(const char* name)
964 return xbt_cfg_get_string(_sg_cfg_set, name);
967 int sg_cfg_get_boolean(const char* name)
969 return xbt_cfg_get_boolean(_sg_cfg_set, name);
972 void sg_cfg_get_peer(const char *name, char **peer, int *port)
974 xbt_cfg_get_peer(_sg_cfg_set, name, peer, port);
977 xbt_dynar_t sg_cfg_get_dynar(const char* name)
979 return xbt_cfg_get_dynar(_sg_cfg_set, name);