1 /* Copyright (c) 2009-2010, 2012-2013. 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 */
463 "The plugins. Possible values: ");
465 while (*(++p) != '\0');
466 for (i = 0; surf_plugin_description[i].name; i++)
467 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
468 surf_plugin_description[i].name);
470 ".\n (use 'help' as a value to see the long description of each plugin)");
471 xbt_cfg_register(&_sg_cfg_set, "plugin", description,
472 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__plugin, NULL);
475 "The model to use for the CPU. Possible values: ");
477 while (*(++p) != '\0');
478 for (i = 0; surf_cpu_model_description[i].name; i++)
479 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
480 surf_cpu_model_description[i].name);
482 ".\n (use 'help' as a value to see the long description of each model)");
483 xbt_cfg_register(&_sg_cfg_set, "cpu/model", description,
484 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__cpu_model, NULL);
485 xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/model", "Cas01");
487 while (*(++p) != '\0');
488 for (i = 0; surf_optimization_mode_description[i].name; i++)
489 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
490 surf_optimization_mode_description[i].name);
492 ".\n (use 'help' as a value to see the long description of each optimization mode)");
493 xbt_cfg_register(&_sg_cfg_set, "cpu/optim", description,
494 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode, NULL);
495 xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/optim", "Lazy");
498 "The model to use for the storage. Possible values: ");
500 while (*(++p) != '\0');
501 for (i = 0; surf_storage_model_description[i].name; i++)
502 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
503 surf_storage_model_description[i].name);
505 ".\n (use 'help' as a value to see the long description of each model)");
506 xbt_cfg_register(&_sg_cfg_set, "storage/model", description,
507 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__storage_mode, NULL);
508 xbt_cfg_setdefault_string(_sg_cfg_set, "storage/model", "default");
511 "The model to use for the network. Possible values: ");
513 while (*(++p) != '\0');
514 for (i = 0; surf_network_model_description[i].name; i++)
515 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
516 surf_network_model_description[i].name);
518 ".\n (use 'help' as a value to see the long description of each model)");
519 xbt_cfg_register(&_sg_cfg_set, "network/model", description,
520 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__network_model, NULL);
521 xbt_cfg_setdefault_string(_sg_cfg_set, "network/model", "LV08");
524 "The optimization modes to use for the network. Possible values: ");
526 while (*(++p) != '\0');
527 for (i = 0; surf_optimization_mode_description[i].name; i++)
528 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
529 surf_optimization_mode_description[i].name);
531 ".\n (use 'help' as a value to see the long description of each optimization mode)");
532 xbt_cfg_register(&_sg_cfg_set, "network/optim", description,
533 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode, NULL);
534 xbt_cfg_setdefault_string(_sg_cfg_set, "network/optim", "Lazy");
537 "The model to use for the workstation. Possible values: ");
539 while (*(++p) != '\0');
540 for (i = 0; surf_workstation_model_description[i].name; i++)
541 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
542 surf_workstation_model_description[i].name);
544 ".\n (use 'help' as a value to see the long description of each model)");
545 xbt_cfg_register(&_sg_cfg_set, "workstation/model", description,
546 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__workstation_model, NULL);
547 xbt_cfg_setdefault_string(_sg_cfg_set, "workstation/model", "default");
549 xbt_cfg_register(&_sg_cfg_set, "vm_workstation/model", description,
550 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__vm_workstation_model, NULL);
551 xbt_cfg_setdefault_string(_sg_cfg_set, "vm_workstation/model", "default");
553 xbt_cfg_register(&_sg_cfg_set, "network/TCP_gamma",
554 "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)",
555 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__tcp_gamma, NULL);
556 xbt_cfg_setdefault_double(_sg_cfg_set, "network/TCP_gamma", 4194304.0);
558 xbt_cfg_register(&_sg_cfg_set, "maxmin/precision",
559 "Numerical precision used when updating simulation models (epsilon in double comparisons)",
560 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__maxmin_precision, NULL);
561 xbt_cfg_setdefault_double(_sg_cfg_set, "maxmin/precision", 0.00001);
563 /* The parameters of network models */
565 xbt_cfg_register(&_sg_cfg_set, "network/sender_gap",
566 "Minimum gap between two overlapping sends",
567 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__sender_gap, NULL);
568 /* default for "network/sender_gap" is set in network.c */
570 xbt_cfg_register(&_sg_cfg_set, "network/latency_factor",
571 "Correction factor to apply to the provided latency (default value set by network model)",
572 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__latency_factor, NULL);
573 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 1.0);
575 xbt_cfg_register(&_sg_cfg_set, "network/bandwidth_factor",
576 "Correction factor to apply to the provided bandwidth (default value set by network model)",
577 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__bandwidth_factor, NULL);
578 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 1.0);
580 xbt_cfg_register(&_sg_cfg_set, "network/weight_S",
581 "Correction factor to apply to the weight of competing streams (default value set by network model)",
582 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__weight_S, NULL);
583 /* default for "network/weight_S" is set in network.c */
586 xbt_cfg_register(&_sg_cfg_set, "path",
587 "Lookup path for inclusions in platform and deployment XML files",
588 xbt_cfgelm_string, 0, 0, _sg_cfg_cb__surf_path, NULL);
590 xbt_cfg_register(&_sg_cfg_set, "cpu/maxmin_selective_update",
591 "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
592 xbt_cfgelm_boolean, 0, 1, NULL, NULL);
593 xbt_cfg_setdefault_boolean(_sg_cfg_set, "cpu/maxmin_selective_update", "no");
595 xbt_cfg_register(&_sg_cfg_set, "network/maxmin_selective_update",
596 "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
597 xbt_cfgelm_boolean, 0, 1, NULL, NULL);
598 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/maxmin_selective_update", "no");
601 /* do model-checking */
602 xbt_cfg_register(&_sg_cfg_set, "model-check",
603 "Verify the system through model-checking instead of simulating it (EXPERIMENTAL)",
604 xbt_cfgelm_boolean, 0, 1, _sg_cfg_cb_model_check, NULL);
605 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check", "no");
607 /* do stateful model-checking */
608 xbt_cfg_register(&_sg_cfg_set, "model-check/checkpoint",
609 "Specify the amount of steps between checkpoints during stateful model-checking (default: 0 => stateless verification). "
610 "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.",
611 xbt_cfgelm_int, 0, 1, _mc_cfg_cb_checkpoint, NULL);
612 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/checkpoint", 0);
614 /* do liveness model-checking */
615 xbt_cfg_register(&_sg_cfg_set, "model-check/property",
616 "Specify the name of the file containing the property. It must be the result of the ltl2ba program.",
617 xbt_cfgelm_string, 0, 1, _mc_cfg_cb_property, NULL);
618 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/property", "");
620 /* Specify the kind of model-checking reduction */
621 xbt_cfg_register(&_sg_cfg_set, "model-check/reduction",
622 "Specify the kind of exploration reduction (either none or DPOR)",
623 xbt_cfgelm_string, 0, 1, _mc_cfg_cb_reduce, NULL);
624 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/reduction", "dpor");
626 /* Enable/disable timeout for wait requests with model-checking */
627 xbt_cfg_register(&_sg_cfg_set, "model-check/timeout",
628 "Enable/Disable timeout for wait requests",
629 xbt_cfgelm_boolean, 0, 1, _mc_cfg_cb_timeout, NULL);
630 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/timeout", "no");
632 /* Set max depth exploration */
633 xbt_cfg_register(&_sg_cfg_set, "model-check/max_depth",
634 "Specify the max depth of exploration (default : 1000)",
635 xbt_cfgelm_int, 0, 1, _mc_cfg_cb_max_depth, NULL);
636 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/max_depth", 1000);
638 /* Set number of visited state stored for state comparison reduction*/
639 xbt_cfg_register(&_sg_cfg_set, "model-check/visited",
640 "Specify the number of visited state stored for state comparison reduction. If value=5, the last 5 visited states are stored",
641 xbt_cfgelm_int, 0, 1, _mc_cfg_cb_visited, NULL);
642 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/visited", 0);
644 /* Set file name for dot output of graph state */
645 xbt_cfg_register(&_sg_cfg_set, "model-check/dot_output",
646 "Specify the name of dot file corresponding to graph state",
647 xbt_cfgelm_string, 0, 1, _mc_cfg_cb_dot_output, NULL);
648 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/dot_output", "");
651 /* do verbose-exit */
652 xbt_cfg_register(&_sg_cfg_set, "verbose-exit",
653 "Activate the \"do nothing\" mode in Ctrl-C",
654 xbt_cfgelm_boolean, 0, 1, _sg_cfg_cb_verbose_exit, NULL);
655 xbt_cfg_setdefault_boolean(_sg_cfg_set, "verbose-exit", "yes");
657 /* context factory */
659 "Context factory to use in SIMIX. Possible values: thread");
660 const char *dflt_ctx_fact = "thread";
661 #ifdef CONTEXT_UCONTEXT
662 dflt_ctx_fact = "ucontext";
663 strcat(strcat(description, ", "), dflt_ctx_fact);
666 dflt_ctx_fact = "raw";
667 strcat(strcat(description, ", "), dflt_ctx_fact);
669 strcat(description, ".");
670 xbt_cfg_register(&_sg_cfg_set, "contexts/factory", description,
671 xbt_cfgelm_string, 1, 1, _sg_cfg_cb_context_factory, NULL);
672 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/factory", dflt_ctx_fact);
674 /* stack size of contexts in Ko */
675 xbt_cfg_register(&_sg_cfg_set, "contexts/stack_size",
676 "Stack size of contexts in Kib",
677 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_context_stack_size, NULL);
678 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/stack_size", 128);
679 /* No, it was not set yet (the above setdefault() changed this to 1). */
680 smx_context_stack_size_was_set = 0;
682 /* number of parallel threads for user processes */
683 xbt_cfg_register(&_sg_cfg_set, "contexts/nthreads",
684 "Number of parallel threads used to execute user contexts",
685 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_nthreads, NULL);
686 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/nthreads", 1);
688 /* minimal number of user contexts to be run in parallel */
689 xbt_cfg_register(&_sg_cfg_set, "contexts/parallel_threshold",
690 "Minimal number of user contexts to be run in parallel (raw contexts only)",
691 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_parallel_threshold, NULL);
692 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/parallel_threshold", 2);
694 /* synchronization mode for parallel user contexts */
695 xbt_cfg_register(&_sg_cfg_set, "contexts/synchro",
696 "Synchronization mode to use when running contexts in parallel (either futex, posix or busy_wait)",
697 xbt_cfgelm_string, 1, 1, _sg_cfg_cb_contexts_parallel_mode, NULL);
699 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "futex");
700 #else //No futex on mac and posix is unimplememted yet
701 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "busy_wait");
704 xbt_cfg_register(&_sg_cfg_set, "network/coordinates",
705 "\"yes\" or \"no\", specifying whether we use a coordinate-based routing (as Vivaldi)",
706 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb__surf_network_coordinates, NULL);
707 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/coordinates", "no");
709 xbt_cfg_register(&_sg_cfg_set, "network/crosstraffic",
710 "Activate the interferences between uploads and downloads for fluid max-min models (LV08, CM02)",
711 xbt_cfgelm_boolean, 0, 1, _sg_cfg_cb__surf_network_crosstraffic, NULL);
712 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/crosstraffic", "no");
715 xbt_cfg_register(&_sg_cfg_set, "gtnets/jitter",
716 "Double value to oscillate the link latency, uniformly in random interval [-latency*gtnets_jitter,latency*gtnets_jitter)",
717 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__gtnets_jitter, NULL);
718 xbt_cfg_setdefault_double(_sg_cfg_set, "gtnets/jitter", 0.0);
720 xbt_cfg_register(&_sg_cfg_set, "gtnets/jitter_seed",
721 "Use a positive seed to reproduce jitted results, value must be in [1,1e8], default is 10",
722 xbt_cfgelm_int, 0, 1, _sg_cfg_cb__gtnets_jitter_seed, NULL);
723 xbt_cfg_setdefault_int(_sg_cfg_set, "gtnets/jitter_seed", 10);
726 xbt_cfg_register(&_sg_cfg_set, "ns3/TcpModel",
727 "The ns3 tcp model can be : NewReno or Reno or Tahoe",
728 xbt_cfgelm_string, 1, 1, NULL, NULL);
729 xbt_cfg_setdefault_string(_sg_cfg_set, "ns3/TcpModel", "default");
733 xbt_cfg_register(&_sg_cfg_set, "smpi/running_power",
734 "Power of the host running the simulation (in flop/s). Used to bench the operations.",
735 xbt_cfgelm_double, 1, 1, NULL, NULL);
736 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/running_power", 20000.0);
738 xbt_cfg_register(&_sg_cfg_set, "smpi/display_timing",
739 "Boolean indicating whether we should display the timing after simulation.",
740 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
741 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/display_timing", "no");
743 xbt_cfg_register(&_sg_cfg_set, "smpi/use_shared_malloc",
744 "Boolean indicating whether we should use shared memory when using SMPI_SHARED_MALLOC. Allows user to disable it for debug purposes.",
745 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
746 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/use_shared_malloc", "yes");
748 xbt_cfg_register(&_sg_cfg_set, "smpi/cpu_threshold",
749 "Minimal computation time (in seconds) not discarded, or -1 for infinity.",
750 xbt_cfgelm_double, 1, 1, NULL, NULL);
751 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/cpu_threshold", 1e-6);
753 xbt_cfg_register(&_sg_cfg_set, "smpi/async_small_thres",
754 "Maximal size of messages that are to be sent asynchronously, without waiting for the receiver",
755 xbt_cfgelm_int, 1, 1, NULL, NULL);
756 xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/async_small_thres", 0);
758 xbt_cfg_register(&_sg_cfg_set, "smpi/send_is_detached_thres",
759 "Threshold of message size where MPI_Send stops behaving like MPI_Isend and becomes MPI_Ssend",
760 xbt_cfgelm_int, 1, 1, NULL, NULL);
761 xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/send_is_detached_thres", 65536);
763 //For smpi/bw_factor and smpi/lat_factor
764 //Default value have to be "threshold0:value0;threshold1:value1;...;thresholdN:valueN"
765 //test is if( size >= thresholdN ) return valueN;
766 //Values can be modified with command line --cfg=smpi/bw_factor:"threshold0:value0;threshold1:value1;...;thresholdN:valueN"
767 // or with tag config put line <prop id="smpi/bw_factor" value="threshold0:value0;threshold1:value1;...;thresholdN:valueN"></prop>
768 xbt_cfg_register(&_sg_cfg_set, "smpi/bw_factor",
769 "Bandwidth factors for smpi.",
770 xbt_cfgelm_string, 1, 1, NULL, NULL);
771 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");
773 xbt_cfg_register(&_sg_cfg_set, "smpi/lat_factor",
774 "Latency factors for smpi.",
775 xbt_cfgelm_string, 1, 1, NULL, NULL);
776 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");
778 xbt_cfg_register(&_sg_cfg_set, "smpi/os",
779 "Small messages timings (MPI_Send minimum time for small messages)",
780 xbt_cfgelm_string, 1, 1, NULL, NULL);
781 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/os", "1:0:0:0:0");
783 xbt_cfg_register(&_sg_cfg_set, "smpi/ois",
784 "Small messages timings (MPI_Isend minimum time for small messages)",
785 xbt_cfgelm_string, 1, 1, NULL, NULL);
786 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/ois", "1:0:0:0:0");
788 xbt_cfg_register(&_sg_cfg_set, "smpi/or",
789 "Small messages timings (MPI_Recv minimum time for small messages)",
790 xbt_cfgelm_string, 1, 1, NULL, NULL);
791 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/or", "1:0:0:0:0");
792 xbt_cfg_register(&_sg_cfg_set, "smpi/iprobe",
793 "Minimum time to inject inside a call to MPI_Iprobe",
794 xbt_cfgelm_double, 1, 1, NULL, NULL);
795 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/iprobe", 1e-4);
796 xbt_cfg_register(&_sg_cfg_set, "smpi/coll_selector",
797 "Which collective selector to use",
798 xbt_cfgelm_string, 1, 1, NULL, NULL);
799 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/coll_selector", "default");
801 xbt_cfg_register(&_sg_cfg_set, "smpi/gather",
802 "Which collective to use for gather",
803 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_gather, NULL);
805 xbt_cfg_register(&_sg_cfg_set, "smpi/allgather",
806 "Which collective to use for allgather",
807 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_allgather, NULL);
809 xbt_cfg_register(&_sg_cfg_set, "smpi/barrier",
810 "Which collective to use for barrier",
811 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_barrier, NULL);
813 xbt_cfg_register(&_sg_cfg_set, "smpi/reduce_scatter",
814 "Which collective to use for reduce_scatter",
815 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_reduce_scatter, NULL);
817 xbt_cfg_register(&_sg_cfg_set, "smpi/scatter",
818 "Which collective to use for scatter",
819 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_scatter, NULL);
821 xbt_cfg_register(&_sg_cfg_set, "smpi/allgatherv",
822 "Which collective to use for allgatherv",
823 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_allgatherv, NULL);
825 xbt_cfg_register(&_sg_cfg_set, "smpi/allreduce",
826 "Which collective to use for allreduce",
827 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_allreduce, NULL);
829 xbt_cfg_register(&_sg_cfg_set, "smpi/alltoall",
830 "Which collective to use for alltoall",
831 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_alltoall, NULL);
833 xbt_cfg_register(&_sg_cfg_set, "smpi/alltoallv",
834 "Which collective to use for alltoallv",
835 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_alltoallv, NULL);
837 xbt_cfg_register(&_sg_cfg_set, "smpi/bcast",
838 "Which collective to use for bcast",
839 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_bcast, NULL);
841 xbt_cfg_register(&_sg_cfg_set, "smpi/reduce",
842 "Which collective to use for reduce",
843 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_reduce, NULL);
846 xbt_cfg_register(&_sg_cfg_set, "clean_atexit",
847 "\"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.",
848 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_clean_atexit, NULL);
849 xbt_cfg_setdefault_boolean(_sg_cfg_set, "clean_atexit", "yes");
852 /* retrieves the current directory of the current process */
853 const char *initial_path = __surf_get_initial_path();
854 xbt_assert((initial_path),
855 "__surf_get_initial_path() failed! Can't resolves current Windows directory");
857 surf_path = xbt_dynar_new(sizeof(char *), NULL);
858 xbt_cfg_setdefault_string(_sg_cfg_set, "path", initial_path);
861 _sg_cfg_init_status = 1;
863 sg_config_cmd_line(argc, argv);
865 xbt_mallocator_initialization_is_done(SIMIX_context_is_parallel());
868 XBT_WARN("Call to sg_config_init() after initialization ignored");
871 xbt_free(description);
874 void sg_config_finalize(void)
876 if (!_sg_cfg_init_status)
877 return; /* Not initialized yet. Nothing to do */
879 xbt_cfg_free(&_sg_cfg_set);
880 _sg_cfg_init_status = 0;
883 /* Pick the right models for CPU, net and workstation, and call their model_init_preparse */
884 void surf_config_models_setup()
886 const char *workstation_model_name;
887 const char *vm_workstation_model_name;
888 int workstation_id = -1;
889 int vm_workstation_id = -1;
890 char *network_model_name = NULL;
891 char *cpu_model_name = NULL;
893 char *storage_model_name = NULL;
895 workstation_model_name =
896 xbt_cfg_get_string(_sg_cfg_set, "workstation/model");
897 vm_workstation_model_name =
898 xbt_cfg_get_string(_sg_cfg_set, "vm_workstation/model");
899 network_model_name = xbt_cfg_get_string(_sg_cfg_set, "network/model");
900 cpu_model_name = xbt_cfg_get_string(_sg_cfg_set, "cpu/model");
901 storage_model_name = xbt_cfg_get_string(_sg_cfg_set, "storage/model");
903 /* Check whether we use a net/cpu model differing from the default ones, in which case
904 * we should switch to the "compound" workstation model to correctly dispatch stuff to
905 * the right net/cpu models.
908 if ((!xbt_cfg_is_default_value(_sg_cfg_set, "network/model") ||
909 !xbt_cfg_is_default_value(_sg_cfg_set, "cpu/model")) &&
910 xbt_cfg_is_default_value(_sg_cfg_set, "workstation/model")) {
911 XBT_INFO("Switching workstation model to compound since you changed the network and/or cpu model(s)");
912 workstation_model_name = "compound";
913 xbt_cfg_set_string(_sg_cfg_set, "workstation/model", workstation_model_name);
916 XBT_DEBUG("Workstation model: %s", workstation_model_name);
918 find_model_description(surf_workstation_model_description,
919 workstation_model_name);
920 if (!strcmp(workstation_model_name, "compound")) {
924 xbt_assert(cpu_model_name,
925 "Set a cpu model to use with the 'compound' workstation model");
927 xbt_assert(network_model_name,
928 "Set a network model to use with the 'compound' workstation model");
931 find_model_description(surf_network_model_description,
934 find_model_description(surf_cpu_model_description, cpu_model_name);
936 surf_cpu_model_description[cpu_id].model_init_preparse();
937 surf_network_model_description[network_id].model_init_preparse();
940 XBT_DEBUG("Call workstation_model_init");
941 surf_workstation_model_description[workstation_id].model_init_preparse();
943 XBT_DEBUG("Call vm_workstation_model_init");
944 vm_workstation_id = find_model_description(surf_vm_workstation_model_description,
945 vm_workstation_model_name);
946 surf_vm_workstation_model_description[vm_workstation_id].model_init_preparse();
948 XBT_DEBUG("Call storage_model_init");
949 storage_id = find_model_description(surf_storage_model_description, storage_model_name);
950 surf_storage_model_description[storage_id].model_init_preparse();
954 int sg_cfg_get_int(const char* name)
956 return xbt_cfg_get_int(_sg_cfg_set,name);
959 double sg_cfg_get_double(const char* name)
961 return xbt_cfg_get_double(_sg_cfg_set,name);
964 char* sg_cfg_get_string(const char* name)
966 return xbt_cfg_get_string(_sg_cfg_set,name);
969 int sg_cfg_get_boolean(const char* name)
971 return xbt_cfg_get_boolean(_sg_cfg_set,name);
974 void sg_cfg_get_peer(const char *name, char **peer, int *port)
976 xbt_cfg_get_peer(_sg_cfg_set,name, peer, port);
979 xbt_dynar_t sg_cfg_get_dynar(const char* name)
981 return xbt_cfg_get_dynar(_sg_cfg_set,name);