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__sender_gap(const char* name, int pos)
263 sg_sender_gap = xbt_cfg_get_double(_sg_cfg_set, name);
266 static void _sg_cfg_cb__latency_factor(const char *name, int pos)
268 sg_latency_factor = xbt_cfg_get_double(_sg_cfg_set, name);
271 static void _sg_cfg_cb__bandwidth_factor(const char *name, int pos)
273 sg_bandwidth_factor = xbt_cfg_get_double(_sg_cfg_set, name);
276 static void _sg_cfg_cb__weight_S(const char *name, int pos)
278 sg_weight_S_parameter = xbt_cfg_get_double(_sg_cfg_set, name);
282 /* callback of the mpi collectives */
283 static void _sg_cfg_cb__coll(const char *category,
284 s_mpi_coll_description_t * table,
285 const char *name, int pos)
289 xbt_assert(_sg_cfg_init_status < 2,
290 "Cannot change the model after the initialization");
292 val = xbt_cfg_get_string(_sg_cfg_set, name);
294 if (!strcmp(val, "help")) {
295 coll_help(category, table);
299 /* New Module missing */
300 find_coll_description(table, val);
302 static void _sg_cfg_cb__coll_gather(const char *name, int pos){
303 _sg_cfg_cb__coll("gather", mpi_coll_gather_description, name, pos);
305 static void _sg_cfg_cb__coll_allgather(const char *name, int pos){
306 _sg_cfg_cb__coll("allgather", mpi_coll_allgather_description, name, pos);
308 static void _sg_cfg_cb__coll_allgatherv(const char *name, int pos){
309 _sg_cfg_cb__coll("allgatherv", mpi_coll_allgatherv_description, name, pos);
311 static void _sg_cfg_cb__coll_allreduce(const char *name, int pos)
313 _sg_cfg_cb__coll("allreduce", mpi_coll_allreduce_description, name, pos);
315 static void _sg_cfg_cb__coll_alltoall(const char *name, int pos)
317 _sg_cfg_cb__coll("alltoall", mpi_coll_alltoall_description, name, pos);
319 static void _sg_cfg_cb__coll_alltoallv(const char *name, int pos)
321 _sg_cfg_cb__coll("alltoallv", mpi_coll_alltoallv_description, name, pos);
323 static void _sg_cfg_cb__coll_bcast(const char *name, int pos)
325 _sg_cfg_cb__coll("bcast", mpi_coll_bcast_description, name, pos);
327 static void _sg_cfg_cb__coll_reduce(const char *name, int pos)
329 _sg_cfg_cb__coll("reduce", mpi_coll_reduce_description, name, pos);
331 static void _sg_cfg_cb__coll_reduce_scatter(const char *name, int pos){
332 _sg_cfg_cb__coll("reduce_scatter", mpi_coll_reduce_scatter_description, name, pos);
334 static void _sg_cfg_cb__coll_scatter(const char *name, int pos){
335 _sg_cfg_cb__coll("scatter", mpi_coll_scatter_description, name, pos);
337 static void _sg_cfg_cb__coll_barrier(const char *name, int pos){
338 _sg_cfg_cb__coll("barrier", mpi_coll_barrier_description, name, pos);
342 /* callback of the inclusion path */
343 static void _sg_cfg_cb__surf_path(const char *name, int pos)
345 char *path = xbt_cfg_get_string_at(_sg_cfg_set, name, pos);
346 xbt_dynar_push(surf_path, &path);
349 /* callback to decide if we want to use the model-checking */
350 #include "xbt_modinter.h"
352 extern int _sg_do_model_check; /* this variable lives in xbt_main until I find a right location for it */
355 static void _sg_cfg_cb_model_check(const char *name, int pos)
358 _sg_do_model_check = xbt_cfg_get_boolean(_sg_cfg_set, name);
360 if (xbt_cfg_get_boolean(_sg_cfg_set, name)) {
361 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");
366 extern int _sg_do_verbose_exit;
368 static void _sg_cfg_cb_verbose_exit(const char *name, int pos)
370 _sg_do_verbose_exit = xbt_cfg_get_boolean(_sg_cfg_set, name);
373 extern int _sg_do_clean_atexit;
375 static void _sg_cfg_cb_clean_atexit(const char *name, int pos)
377 _sg_do_clean_atexit = xbt_cfg_get_boolean(_sg_cfg_set, name);
380 static void _sg_cfg_cb_context_factory(const char *name, int pos)
382 smx_context_factory_name = xbt_cfg_get_string(_sg_cfg_set, name);
385 static void _sg_cfg_cb_context_stack_size(const char *name, int pos)
387 smx_context_stack_size_was_set = 1;
388 smx_context_stack_size = xbt_cfg_get_int(_sg_cfg_set, name) * 1024;
391 static void _sg_cfg_cb_contexts_nthreads(const char *name, int pos)
393 SIMIX_context_set_nthreads(xbt_cfg_get_int(_sg_cfg_set, name));
396 static void _sg_cfg_cb_contexts_parallel_threshold(const char *name, int pos)
398 SIMIX_context_set_parallel_threshold(xbt_cfg_get_int(_sg_cfg_set, name));
401 static void _sg_cfg_cb_contexts_parallel_mode(const char *name, int pos)
403 const char* mode_name = xbt_cfg_get_string(_sg_cfg_set, name);
404 if (!strcmp(mode_name, "posix")) {
405 SIMIX_context_set_parallel_mode(XBT_PARMAP_POSIX);
407 else if (!strcmp(mode_name, "futex")) {
408 SIMIX_context_set_parallel_mode(XBT_PARMAP_FUTEX);
410 else if (!strcmp(mode_name, "busy_wait")) {
411 SIMIX_context_set_parallel_mode(XBT_PARMAP_BUSY_WAIT);
414 xbt_die("Command line setting of the parallel synchronization mode should "
415 "be one of \"posix\", \"futex\" or \"busy_wait\"");
419 static void _sg_cfg_cb__surf_network_coordinates(const char *name,
422 int val = xbt_cfg_get_boolean(_sg_cfg_set, name);
424 if (!COORD_HOST_LEVEL) {
425 COORD_HOST_LEVEL = xbt_lib_add_level(host_lib,xbt_dynar_free_voidp);
426 COORD_ASR_LEVEL = xbt_lib_add_level(as_router_lib,xbt_dynar_free_voidp);
429 if (COORD_HOST_LEVEL)
430 xbt_die("Setting of whether to use coordinate cannot be disabled once set.");
433 static void _sg_cfg_cb__surf_network_crosstraffic(const char *name,
436 sg_network_crosstraffic = xbt_cfg_get_boolean(_sg_cfg_set, name);
440 static void _sg_cfg_cb__gtnets_jitter(const char *name, int pos)
442 sg_gtnets_jitter = xbt_cfg_get_double(_sg_cfg_set, name);
445 static void _sg_cfg_cb__gtnets_jitter_seed(const char *name, int pos)
447 sg_gtnets_jitter_seed = xbt_cfg_get_int(_sg_cfg_set, name);
451 /* build description line with possible values */
452 static void describe_model(char *result,
453 const s_surf_model_description_t model_description[],
455 const char *description)
458 sprintf(result, "%s. Possible values: %s", description,
459 model_description[0].name ? model_description[0].name : "n/a");
461 for (i = 1; model_description[i].name; i++)
462 p += sprintf(p, ", %s", model_description[i].name);
464 ".\n (use 'help' as a value to see the long description of each %s)",
468 /* create the config set, register what should be and parse the command line*/
469 void sg_config_init(int *argc, char **argv)
471 char description[1024];
473 /* Create the configuration support */
474 if (_sg_cfg_init_status == 0) { /* Only create stuff if not already inited */
476 /* Plugins configuration */
477 describe_model(description, surf_plugin_description,
478 "plugin", "The plugins");
479 xbt_cfg_register(&_sg_cfg_set, "plugin", description,
480 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__plugin, NULL);
482 describe_model(description, surf_cpu_model_description,
483 "model", "The model to use for the CPU");
484 xbt_cfg_register(&_sg_cfg_set, "cpu/model", description,
485 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__cpu_model, NULL);
486 xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/model", "Cas01");
488 describe_model(description, surf_optimization_mode_description,
490 "The optimization modes to use for the CPU");
491 xbt_cfg_register(&_sg_cfg_set, "cpu/optim", description,
492 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode, NULL);
493 xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/optim", "Lazy");
495 describe_model(description, surf_storage_model_description,
496 "model", "The model to use for the storage");
497 xbt_cfg_register(&_sg_cfg_set, "storage/model", description,
498 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__storage_mode, NULL);
499 xbt_cfg_setdefault_string(_sg_cfg_set, "storage/model", "default");
501 describe_model(description, surf_network_model_description,
502 "model", "The model to use for the network");
503 xbt_cfg_register(&_sg_cfg_set, "network/model", description,
504 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__network_model, NULL);
505 xbt_cfg_setdefault_string(_sg_cfg_set, "network/model", "LV08");
507 describe_model(description, surf_optimization_mode_description,
509 "The optimization modes to use for the network");
510 xbt_cfg_register(&_sg_cfg_set, "network/optim", description,
511 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode, NULL);
512 xbt_cfg_setdefault_string(_sg_cfg_set, "network/optim", "Lazy");
514 describe_model(description, surf_workstation_model_description,
515 "model", "The model to use for the workstation");
516 xbt_cfg_register(&_sg_cfg_set, "workstation/model", description,
517 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__workstation_model, NULL);
518 xbt_cfg_setdefault_string(_sg_cfg_set, "workstation/model", "default");
520 describe_model(description, surf_vm_workstation_model_description,
521 "model", "The model to use for the vm workstation");
522 xbt_cfg_register(&_sg_cfg_set, "vm_workstation/model", description,
523 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__vm_workstation_model, NULL);
524 xbt_cfg_setdefault_string(_sg_cfg_set, "vm_workstation/model", "default");
526 xbt_cfg_register(&_sg_cfg_set, "network/TCP_gamma",
527 "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)",
528 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__tcp_gamma, NULL);
529 xbt_cfg_setdefault_double(_sg_cfg_set, "network/TCP_gamma", 4194304.0);
531 xbt_cfg_register(&_sg_cfg_set, "maxmin/precision",
532 "Numerical precision used when updating simulation models (epsilon in double comparisons)",
533 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__maxmin_precision, NULL);
534 xbt_cfg_setdefault_double(_sg_cfg_set, "maxmin/precision", 0.00001);
536 /* The parameters of network models */
538 xbt_cfg_register(&_sg_cfg_set, "network/sender_gap",
539 "Minimum gap between two overlapping sends",
540 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__sender_gap, NULL);
541 /* default for "network/sender_gap" is set in network.c */
543 xbt_cfg_register(&_sg_cfg_set, "network/latency_factor",
544 "Correction factor to apply to the provided latency (default value set by network model)",
545 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__latency_factor, NULL);
546 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 1.0);
548 xbt_cfg_register(&_sg_cfg_set, "network/bandwidth_factor",
549 "Correction factor to apply to the provided bandwidth (default value set by network model)",
550 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__bandwidth_factor, NULL);
551 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 1.0);
553 xbt_cfg_register(&_sg_cfg_set, "network/weight_S",
554 "Correction factor to apply to the weight of competing streams (default value set by network model)",
555 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__weight_S, NULL);
556 /* default for "network/weight_S" is set in network.c */
559 xbt_cfg_register(&_sg_cfg_set, "path",
560 "Lookup path for inclusions in platform and deployment XML files",
561 xbt_cfgelm_string, 0, 0, _sg_cfg_cb__surf_path, NULL);
563 xbt_cfg_register(&_sg_cfg_set, "cpu/maxmin_selective_update",
564 "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
565 xbt_cfgelm_boolean, 0, 1, NULL, NULL);
566 xbt_cfg_setdefault_boolean(_sg_cfg_set, "cpu/maxmin_selective_update", "no");
568 xbt_cfg_register(&_sg_cfg_set, "network/maxmin_selective_update",
569 "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
570 xbt_cfgelm_boolean, 0, 1, NULL, NULL);
571 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/maxmin_selective_update", "no");
574 /* do model-checking */
575 xbt_cfg_register(&_sg_cfg_set, "model-check",
576 "Verify the system through model-checking instead of simulating it (EXPERIMENTAL)",
577 xbt_cfgelm_boolean, 0, 1, _sg_cfg_cb_model_check, NULL);
578 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check", "no");
580 /* do stateful model-checking */
581 xbt_cfg_register(&_sg_cfg_set, "model-check/checkpoint",
582 "Specify the amount of steps between checkpoints during stateful model-checking (default: 0 => stateless verification). "
583 "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.",
584 xbt_cfgelm_int, 0, 1, _mc_cfg_cb_checkpoint, NULL);
585 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/checkpoint", 0);
587 /* do liveness model-checking */
588 xbt_cfg_register(&_sg_cfg_set, "model-check/property",
589 "Specify the name of the file containing the property. It must be the result of the ltl2ba program.",
590 xbt_cfgelm_string, 0, 1, _mc_cfg_cb_property, NULL);
591 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/property", "");
593 /* do communications determinism model-checking */
594 xbt_cfg_register(&_sg_cfg_set, "model-check/communications_determinism",
595 "Enable/disable the detection of determinism in the communications schemes",
596 xbt_cfgelm_boolean, 0, 1, _mc_cfg_cb_comms_determinism, NULL);
597 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/communications_determinism", "no");
599 /* do send determinism model-checking */
600 xbt_cfg_register(&_sg_cfg_set, "model-check/send_determinism",
601 "Enable/disable the detection of send-determinism in the communications schemes",
602 xbt_cfgelm_boolean, 0, 1, _mc_cfg_cb_send_determinism, NULL);
603 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/send_determinism", "no");
605 /* Specify the kind of model-checking reduction */
606 xbt_cfg_register(&_sg_cfg_set, "model-check/reduction",
607 "Specify the kind of exploration reduction (either none or DPOR)",
608 xbt_cfgelm_string, 0, 1, _mc_cfg_cb_reduce, NULL);
609 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/reduction", "dpor");
611 /* Enable/disable timeout for wait requests with model-checking */
612 xbt_cfg_register(&_sg_cfg_set, "model-check/timeout",
613 "Enable/Disable timeout for wait requests",
614 xbt_cfgelm_boolean, 0, 1, _mc_cfg_cb_timeout, NULL);
615 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/timeout", "no");
617 /* Enable/disable global hash computation with model-checking */
618 xbt_cfg_register(&_sg_cfg_set, "model-check/hash",
619 "Enable/Disable state hash for state comparison",
620 xbt_cfgelm_boolean, 0, 1, _mc_cfg_cb_hash, NULL);
621 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/hash", "no");
623 /* Set max depth exploration */
624 xbt_cfg_register(&_sg_cfg_set, "model-check/max_depth",
625 "Specify the max depth of exploration (default : 1000)",
626 xbt_cfgelm_int, 0, 1, _mc_cfg_cb_max_depth, NULL);
627 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/max_depth", 1000);
629 /* Set number of visited state stored for state comparison reduction*/
630 xbt_cfg_register(&_sg_cfg_set, "model-check/visited",
631 "Specify the number of visited state stored for state comparison reduction. If value=5, the last 5 visited states are stored",
632 xbt_cfgelm_int, 0, 1, _mc_cfg_cb_visited, NULL);
633 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/visited", 0);
635 /* Set file name for dot output of graph state */
636 xbt_cfg_register(&_sg_cfg_set, "model-check/dot_output",
637 "Specify the name of dot file corresponding to graph state",
638 xbt_cfgelm_string, 0, 1, _mc_cfg_cb_dot_output, NULL);
639 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/dot_output", "");
642 /* do verbose-exit */
643 xbt_cfg_register(&_sg_cfg_set, "verbose-exit",
644 "Activate the \"do nothing\" mode in Ctrl-C",
645 xbt_cfgelm_boolean, 0, 1, _sg_cfg_cb_verbose_exit, NULL);
646 xbt_cfg_setdefault_boolean(_sg_cfg_set, "verbose-exit", "yes");
648 /* context factory */
649 const char *dflt_ctx_fact = "thread";
651 char *p = description +
653 "Context factory to use in SIMIX. Possible values: %s",
655 #ifdef CONTEXT_UCONTEXT
656 dflt_ctx_fact = "ucontext";
657 p += sprintf(p, ", %s", dflt_ctx_fact);
660 dflt_ctx_fact = "raw";
661 p += sprintf(p, ", %s", dflt_ctx_fact);
665 xbt_cfg_register(&_sg_cfg_set, "contexts/factory", description,
666 xbt_cfgelm_string, 1, 1, _sg_cfg_cb_context_factory, NULL);
667 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/factory", dflt_ctx_fact);
669 /* stack size of contexts in Ko */
670 xbt_cfg_register(&_sg_cfg_set, "contexts/stack_size",
671 "Stack size of contexts in Kib",
672 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_context_stack_size, NULL);
673 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/stack_size", 128);
674 /* No, it was not set yet (the above setdefault() changed this to 1). */
675 smx_context_stack_size_was_set = 0;
677 /* number of parallel threads for user processes */
678 xbt_cfg_register(&_sg_cfg_set, "contexts/nthreads",
679 "Number of parallel threads used to execute user contexts",
680 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_nthreads, NULL);
681 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/nthreads", 1);
683 /* minimal number of user contexts to be run in parallel */
684 xbt_cfg_register(&_sg_cfg_set, "contexts/parallel_threshold",
685 "Minimal number of user contexts to be run in parallel (raw contexts only)",
686 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_parallel_threshold, NULL);
687 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/parallel_threshold", 2);
689 /* synchronization mode for parallel user contexts */
690 xbt_cfg_register(&_sg_cfg_set, "contexts/synchro",
691 "Synchronization mode to use when running contexts in parallel (either futex, posix or busy_wait)",
692 xbt_cfgelm_string, 1, 1, _sg_cfg_cb_contexts_parallel_mode, NULL);
694 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "futex");
695 #else //No futex on mac and posix is unimplememted yet
696 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "busy_wait");
699 xbt_cfg_register(&_sg_cfg_set, "network/coordinates",
700 "\"yes\" or \"no\", specifying whether we use a coordinate-based routing (as Vivaldi)",
701 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb__surf_network_coordinates, NULL);
702 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/coordinates", "no");
704 xbt_cfg_register(&_sg_cfg_set, "network/crosstraffic",
705 "Activate the interferences between uploads and downloads for fluid max-min models (LV08, CM02)",
706 xbt_cfgelm_boolean, 0, 1, _sg_cfg_cb__surf_network_crosstraffic, NULL);
707 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/crosstraffic", "no");
710 xbt_cfg_register(&_sg_cfg_set, "gtnets/jitter",
711 "Double value to oscillate the link latency, uniformly in random interval [-latency*gtnets_jitter,latency*gtnets_jitter)",
712 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__gtnets_jitter, NULL);
713 xbt_cfg_setdefault_double(_sg_cfg_set, "gtnets/jitter", 0.0);
715 xbt_cfg_register(&_sg_cfg_set, "gtnets/jitter_seed",
716 "Use a positive seed to reproduce jitted results, value must be in [1,1e8], default is 10",
717 xbt_cfgelm_int, 0, 1, _sg_cfg_cb__gtnets_jitter_seed, NULL);
718 xbt_cfg_setdefault_int(_sg_cfg_set, "gtnets/jitter_seed", 10);
721 xbt_cfg_register(&_sg_cfg_set, "ns3/TcpModel",
722 "The ns3 tcp model can be : NewReno or Reno or Tahoe",
723 xbt_cfgelm_string, 1, 1, NULL, NULL);
724 xbt_cfg_setdefault_string(_sg_cfg_set, "ns3/TcpModel", "default");
728 xbt_cfg_register(&_sg_cfg_set, "smpi/running_power",
729 "Power of the host running the simulation (in flop/s). Used to bench the operations.",
730 xbt_cfgelm_double, 1, 1, NULL, NULL);
731 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/running_power", 20000.0);
733 xbt_cfg_register(&_sg_cfg_set, "smpi/display_timing",
734 "Boolean indicating whether we should display the timing after simulation.",
735 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
736 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/display_timing", "no");
738 xbt_cfg_register(&_sg_cfg_set, "smpi/use_shared_malloc",
739 "Boolean indicating whether we should use shared memory when using SMPI_SHARED_MALLOC. Allows user to disable it for debug purposes.",
740 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
741 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/use_shared_malloc", "yes");
743 xbt_cfg_register(&_sg_cfg_set, "smpi/cpu_threshold",
744 "Minimal computation time (in seconds) not discarded, or -1 for infinity.",
745 xbt_cfgelm_double, 1, 1, NULL, NULL);
746 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/cpu_threshold", 1e-6);
748 xbt_cfg_register(&_sg_cfg_set, "smpi/async_small_thres",
749 "Maximal size of messages that are to be sent asynchronously, without waiting for the receiver",
750 xbt_cfgelm_int, 1, 1, NULL, NULL);
751 xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/async_small_thres", 0);
753 xbt_cfg_register(&_sg_cfg_set, "smpi/send_is_detached_thres",
754 "Threshold of message size where MPI_Send stops behaving like MPI_Isend and becomes MPI_Ssend",
755 xbt_cfgelm_int, 1, 1, NULL, NULL);
756 xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/send_is_detached_thres", 65536);
758 //For smpi/bw_factor and smpi/lat_factor
759 //Default value have to be "threshold0:value0;threshold1:value1;...;thresholdN:valueN"
760 //test is if( size >= thresholdN ) return valueN;
761 //Values can be modified with command line --cfg=smpi/bw_factor:"threshold0:value0;threshold1:value1;...;thresholdN:valueN"
762 // or with tag config put line <prop id="smpi/bw_factor" value="threshold0:value0;threshold1:value1;...;thresholdN:valueN"></prop>
763 xbt_cfg_register(&_sg_cfg_set, "smpi/bw_factor",
764 "Bandwidth factors for smpi.",
765 xbt_cfgelm_string, 1, 1, NULL, NULL);
766 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");
768 xbt_cfg_register(&_sg_cfg_set, "smpi/lat_factor",
769 "Latency factors for smpi.",
770 xbt_cfgelm_string, 1, 1, NULL, NULL);
771 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");
773 xbt_cfg_register(&_sg_cfg_set, "smpi/os",
774 "Small messages timings (MPI_Send minimum time for small messages)",
775 xbt_cfgelm_string, 1, 1, NULL, NULL);
776 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/os", "1:0:0:0:0");
778 xbt_cfg_register(&_sg_cfg_set, "smpi/ois",
779 "Small messages timings (MPI_Isend minimum time for small messages)",
780 xbt_cfgelm_string, 1, 1, NULL, NULL);
781 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/ois", "1:0:0:0:0");
783 xbt_cfg_register(&_sg_cfg_set, "smpi/or",
784 "Small messages timings (MPI_Recv minimum time for small messages)",
785 xbt_cfgelm_string, 1, 1, NULL, NULL);
786 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/or", "1:0:0:0:0");
787 xbt_cfg_register(&_sg_cfg_set, "smpi/iprobe",
788 "Minimum time to inject inside a call to MPI_Iprobe",
789 xbt_cfgelm_double, 1, 1, NULL, NULL);
790 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/iprobe", 1e-4);
791 xbt_cfg_register(&_sg_cfg_set, "smpi/coll_selector",
792 "Which collective selector to use",
793 xbt_cfgelm_string, 1, 1, NULL, NULL);
794 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/coll_selector", "default");
796 xbt_cfg_register(&_sg_cfg_set, "smpi/gather",
797 "Which collective to use for gather",
798 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_gather, NULL);
800 xbt_cfg_register(&_sg_cfg_set, "smpi/allgather",
801 "Which collective to use for allgather",
802 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_allgather, NULL);
804 xbt_cfg_register(&_sg_cfg_set, "smpi/barrier",
805 "Which collective to use for barrier",
806 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_barrier, NULL);
808 xbt_cfg_register(&_sg_cfg_set, "smpi/reduce_scatter",
809 "Which collective to use for reduce_scatter",
810 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_reduce_scatter, NULL);
812 xbt_cfg_register(&_sg_cfg_set, "smpi/scatter",
813 "Which collective to use for scatter",
814 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_scatter, NULL);
816 xbt_cfg_register(&_sg_cfg_set, "smpi/allgatherv",
817 "Which collective to use for allgatherv",
818 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_allgatherv, NULL);
820 xbt_cfg_register(&_sg_cfg_set, "smpi/allreduce",
821 "Which collective to use for allreduce",
822 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_allreduce, NULL);
824 xbt_cfg_register(&_sg_cfg_set, "smpi/alltoall",
825 "Which collective to use for alltoall",
826 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_alltoall, NULL);
828 xbt_cfg_register(&_sg_cfg_set, "smpi/alltoallv",
829 "Which collective to use for alltoallv",
830 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_alltoallv, NULL);
832 xbt_cfg_register(&_sg_cfg_set, "smpi/bcast",
833 "Which collective to use for bcast",
834 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_bcast, NULL);
836 xbt_cfg_register(&_sg_cfg_set, "smpi/reduce",
837 "Which collective to use for reduce",
838 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_reduce, NULL);
841 xbt_cfg_register(&_sg_cfg_set, "clean_atexit",
842 "\"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.",
843 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_clean_atexit, NULL);
844 xbt_cfg_setdefault_boolean(_sg_cfg_set, "clean_atexit", "yes");
847 /* retrieves the current directory of the current process */
848 const char *initial_path = __surf_get_initial_path();
849 xbt_assert((initial_path),
850 "__surf_get_initial_path() failed! Can't resolves current Windows directory");
852 surf_path = xbt_dynar_new(sizeof(char *), NULL);
853 xbt_cfg_setdefault_string(_sg_cfg_set, "path", initial_path);
856 _sg_cfg_init_status = 1;
858 sg_config_cmd_line(argc, argv);
860 xbt_mallocator_initialization_is_done(SIMIX_context_is_parallel());
863 XBT_WARN("Call to sg_config_init() after initialization ignored");
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);