1 /* Copyright (c) 2009-2010, 2012-2014. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 /* sg_config: configuration infrastructure for the simulation world */
10 #include "xbt/config.h"
12 #include "xbt/mallocator.h"
15 #include "xbt/sysdep.h"
16 #include "surf/surf.h"
17 #include "surf/maxmin.h"
18 #include "instr/instr_interface.h"
19 #include "simgrid/simix.h"
20 #include "simgrid/sg_config.h"
21 #include "smpi/smpi_interface.h"
23 #include "instr/instr.h"
25 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_config, surf,
26 "About the configuration of simgrid");
28 xbt_cfg_t _sg_cfg_set = NULL;
30 /* 0: beginning of time (config cannot be changed yet);
31 * 1: initialized: cfg_set created (config can now be changed);
32 * 2: configured: command line parsed and config part of platform file was
33 * integrated also, platform construction ongoing or done.
34 * (Config cannot be changed anymore!)
36 int _sg_cfg_init_status = 0;
38 /* instruct the upper layer (simix or simdag) to exit as soon as possible
40 int _sg_cfg_exit_asap = 0;
42 #define sg_cfg_exit_early() do { _sg_cfg_exit_asap = 1; return; } while (0)
44 /* Parse the command line, looking for options */
45 static void sg_config_cmd_line(int *argc, char **argv)
51 for (j = i = 1; i < *argc; i++) {
52 if (!strncmp(argv[i], "--cfg=", strlen("--cfg="))) {
53 opt = strchr(argv[i], '=');
56 xbt_cfg_set_parse(_sg_cfg_set, opt);
57 XBT_DEBUG("Did apply '%s' as config setting", opt);
58 } else if (!strcmp(argv[i], "--version")) {
59 printf("%s\n", SIMGRID_VERSION_STRING);
61 } else if (!strcmp(argv[i], "--cfg-help") || !strcmp(argv[i], "--help")) {
63 ("Description of the configuration accepted by this simulator:\n");
64 xbt_cfg_help(_sg_cfg_set);
67 "Each of these configurations can be used by adding\n"
68 " --cfg=<option name>:<option value>\n"
69 "to the command line.\n"
71 "You can also use --help-models to see the details of all models known by this simulator.\n"
74 "You can also use --help-tracing to see the details of all tracing options known by this simulator.\n"
77 "You can also use --help-logs and --help-log-categories to see the details of logging output.\n"
79 "You can also use --version to get SimGrid version information.\n"
83 } else if (!strcmp(argv[i], "--help-models")) {
86 model_help("workstation", surf_workstation_model_description);
88 model_help("CPU", surf_cpu_model_description);
90 model_help("network", surf_network_model_description);
91 printf("\nLong description of all optimization levels accepted by the models of this simulator:\n");
92 for (k = 0; surf_optimization_mode_description[k].name; k++)
94 surf_optimization_mode_description[k].name,
95 surf_optimization_mode_description[k].description);
96 printf("Both network and CPU models have 'Lazy' as default optimization level\n\n");
99 } else if (!strcmp(argv[i], "--help-tracing")) {
115 /* callback of the plugin variable */
116 static void _sg_cfg_cb__plugin(const char *name, int pos)
121 xbt_assert(_sg_cfg_init_status < 2,
122 "Cannot load a plugin after the initialization");
124 val = xbt_cfg_get_string(_sg_cfg_set, name);
126 if (!strcmp(val, "help")) {
127 model_help("plugin", surf_plugin_description);
131 /* New Module missing */
132 int plugin_id = find_model_description(surf_plugin_description, val);
133 surf_plugin_description[plugin_id].model_init_preparse();
136 /* callback of the workstation/model variable */
137 static void _sg_cfg_cb__workstation_model(const char *name, int pos)
141 xbt_assert(_sg_cfg_init_status < 2,
142 "Cannot change the model after the initialization");
144 val = xbt_cfg_get_string(_sg_cfg_set, name);
146 if (!strcmp(val, "help")) {
147 model_help("workstation", surf_workstation_model_description);
151 /* Make sure that the model exists */
152 find_model_description(surf_workstation_model_description, val);
155 /* callback of the vm_workstation/model variable */
156 static void _sg_cfg_cb__vm_workstation_model(const char *name, int pos)
160 xbt_assert(_sg_cfg_init_status < 2,
161 "Cannot change the model after the initialization");
163 val = xbt_cfg_get_string(_sg_cfg_set, name);
165 if (!strcmp(val, "help")) {
166 model_help("vm_workstation", surf_vm_workstation_model_description);
170 /* Make sure that the model exists */
171 find_model_description(surf_vm_workstation_model_description, val);
174 /* callback of the cpu/model variable */
175 static void _sg_cfg_cb__cpu_model(const char *name, int pos)
179 xbt_assert(_sg_cfg_init_status < 2,
180 "Cannot change the model after the initialization");
182 val = xbt_cfg_get_string(_sg_cfg_set, name);
184 if (!strcmp(val, "help")) {
185 model_help("CPU", surf_cpu_model_description);
189 /* New Module missing */
190 find_model_description(surf_cpu_model_description, val);
193 /* callback of the cpu/model variable */
194 static void _sg_cfg_cb__optimization_mode(const char *name, int pos)
198 xbt_assert(_sg_cfg_init_status < 2,
199 "Cannot change the model after the initialization");
201 val = xbt_cfg_get_string(_sg_cfg_set, name);
203 if (!strcmp(val, "help")) {
204 model_help("optimization", surf_optimization_mode_description);
208 /* New Module missing */
209 find_model_description(surf_optimization_mode_description, val);
212 /* callback of the cpu/model variable */
213 static void _sg_cfg_cb__storage_mode(const char *name, int pos)
217 xbt_assert(_sg_cfg_init_status < 2,
218 "Cannot change the model after the initialization");
220 val = xbt_cfg_get_string(_sg_cfg_set, name);
222 if (!strcmp(val, "help")) {
223 model_help("storage", surf_storage_model_description);
227 /* New Module missing */
228 find_model_description(surf_storage_model_description, val);
231 /* callback of the workstation_model variable */
232 static void _sg_cfg_cb__network_model(const char *name, int pos)
236 xbt_assert(_sg_cfg_init_status < 2,
237 "Cannot change the model after the initialization");
239 val = xbt_cfg_get_string(_sg_cfg_set, name);
241 if (!strcmp(val, "help")) {
242 model_help("network", surf_network_model_description);
246 /* New Module missing */
247 find_model_description(surf_network_model_description, val);
250 /* callbacks of the network models values */
251 static void _sg_cfg_cb__tcp_gamma(const char *name, int pos)
253 sg_tcp_gamma = xbt_cfg_get_double(_sg_cfg_set, name);
256 static void _sg_cfg_cb__maxmin_precision(const char* name, int pos)
258 sg_maxmin_precision = xbt_cfg_get_double(_sg_cfg_set, name);
261 static void _sg_cfg_cb__surf_precision(const char* name, int pos)
263 sg_surf_precision = xbt_cfg_get_double(_sg_cfg_set, name);
266 static void _sg_cfg_cb__sender_gap(const char* name, int pos)
268 sg_sender_gap = xbt_cfg_get_double(_sg_cfg_set, name);
271 static void _sg_cfg_cb__latency_factor(const char *name, int pos)
273 sg_latency_factor = xbt_cfg_get_double(_sg_cfg_set, name);
276 static void _sg_cfg_cb__bandwidth_factor(const char *name, int pos)
278 sg_bandwidth_factor = xbt_cfg_get_double(_sg_cfg_set, name);
281 static void _sg_cfg_cb__weight_S(const char *name, int pos)
283 sg_weight_S_parameter = xbt_cfg_get_double(_sg_cfg_set, name);
287 /* callback of the mpi collectives */
288 static void _sg_cfg_cb__coll(const char *category,
289 s_mpi_coll_description_t * table,
290 const char *name, int pos)
294 xbt_assert(_sg_cfg_init_status < 2,
295 "Cannot change the model after the initialization");
297 val = xbt_cfg_get_string(_sg_cfg_set, name);
299 if (!strcmp(val, "help")) {
300 coll_help(category, table);
304 /* New Module missing */
305 find_coll_description(table, val);
307 static void _sg_cfg_cb__coll_gather(const char *name, int pos){
308 _sg_cfg_cb__coll("gather", mpi_coll_gather_description, name, pos);
310 static void _sg_cfg_cb__coll_allgather(const char *name, int pos){
311 _sg_cfg_cb__coll("allgather", mpi_coll_allgather_description, name, pos);
313 static void _sg_cfg_cb__coll_allgatherv(const char *name, int pos){
314 _sg_cfg_cb__coll("allgatherv", mpi_coll_allgatherv_description, name, pos);
316 static void _sg_cfg_cb__coll_allreduce(const char *name, int pos)
318 _sg_cfg_cb__coll("allreduce", mpi_coll_allreduce_description, name, pos);
320 static void _sg_cfg_cb__coll_alltoall(const char *name, int pos)
322 _sg_cfg_cb__coll("alltoall", mpi_coll_alltoall_description, name, pos);
324 static void _sg_cfg_cb__coll_alltoallv(const char *name, int pos)
326 _sg_cfg_cb__coll("alltoallv", mpi_coll_alltoallv_description, name, pos);
328 static void _sg_cfg_cb__coll_bcast(const char *name, int pos)
330 _sg_cfg_cb__coll("bcast", mpi_coll_bcast_description, name, pos);
332 static void _sg_cfg_cb__coll_reduce(const char *name, int pos)
334 _sg_cfg_cb__coll("reduce", mpi_coll_reduce_description, name, pos);
336 static void _sg_cfg_cb__coll_reduce_scatter(const char *name, int pos){
337 _sg_cfg_cb__coll("reduce_scatter", mpi_coll_reduce_scatter_description, name, pos);
339 static void _sg_cfg_cb__coll_scatter(const char *name, int pos){
340 _sg_cfg_cb__coll("scatter", mpi_coll_scatter_description, name, pos);
342 static void _sg_cfg_cb__coll_barrier(const char *name, int pos){
343 _sg_cfg_cb__coll("barrier", mpi_coll_barrier_description, name, pos);
347 /* callback of the inclusion path */
348 static void _sg_cfg_cb__surf_path(const char *name, int pos)
350 char *path = xbt_cfg_get_string_at(_sg_cfg_set, name, pos);
351 xbt_dynar_push(surf_path, &path);
354 /* callback to decide if we want to use the model-checking */
355 #include "xbt_modinter.h"
357 extern int _sg_do_model_check; /* this variable lives in xbt_main until I find a right location for it */
360 static void _sg_cfg_cb_model_check(const char *name, int pos)
363 _sg_do_model_check = xbt_cfg_get_boolean(_sg_cfg_set, name);
365 if (xbt_cfg_get_boolean(_sg_cfg_set, name)) {
366 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");
371 extern int _sg_do_verbose_exit;
373 static void _sg_cfg_cb_verbose_exit(const char *name, int pos)
375 _sg_do_verbose_exit = xbt_cfg_get_boolean(_sg_cfg_set, name);
378 extern int _sg_do_clean_atexit;
380 static void _sg_cfg_cb_clean_atexit(const char *name, int pos)
382 _sg_do_clean_atexit = xbt_cfg_get_boolean(_sg_cfg_set, name);
385 static void _sg_cfg_cb_context_factory(const char *name, int pos)
387 smx_context_factory_name = xbt_cfg_get_string(_sg_cfg_set, name);
390 static void _sg_cfg_cb_context_stack_size(const char *name, int pos)
392 smx_context_stack_size_was_set = 1;
393 smx_context_stack_size = xbt_cfg_get_int(_sg_cfg_set, name) * 1024;
396 static void _sg_cfg_cb_context_guard_size(const char *name, int pos)
398 smx_context_guard_size_was_set = 1;
399 smx_context_guard_size = xbt_cfg_get_int(_sg_cfg_set, name) * xbt_pagesize;
402 static void _sg_cfg_cb_contexts_nthreads(const char *name, int pos)
404 SIMIX_context_set_nthreads(xbt_cfg_get_int(_sg_cfg_set, name));
407 static void _sg_cfg_cb_contexts_parallel_threshold(const char *name, int pos)
409 SIMIX_context_set_parallel_threshold(xbt_cfg_get_int(_sg_cfg_set, name));
412 static void _sg_cfg_cb_contexts_parallel_mode(const char *name, int pos)
414 const char* mode_name = xbt_cfg_get_string(_sg_cfg_set, name);
415 if (!strcmp(mode_name, "posix")) {
416 SIMIX_context_set_parallel_mode(XBT_PARMAP_POSIX);
418 else if (!strcmp(mode_name, "futex")) {
419 SIMIX_context_set_parallel_mode(XBT_PARMAP_FUTEX);
421 else if (!strcmp(mode_name, "busy_wait")) {
422 SIMIX_context_set_parallel_mode(XBT_PARMAP_BUSY_WAIT);
425 xbt_die("Command line setting of the parallel synchronization mode should "
426 "be one of \"posix\", \"futex\" or \"busy_wait\"");
430 static void _sg_cfg_cb__surf_network_coordinates(const char *name,
433 int val = xbt_cfg_get_boolean(_sg_cfg_set, name);
435 if (!COORD_HOST_LEVEL) {
436 COORD_HOST_LEVEL = xbt_lib_add_level(host_lib,xbt_dynar_free_voidp);
437 COORD_ASR_LEVEL = xbt_lib_add_level(as_router_lib,xbt_dynar_free_voidp);
440 if (COORD_HOST_LEVEL)
441 xbt_die("Setting of whether to use coordinate cannot be disabled once set.");
444 static void _sg_cfg_cb__surf_network_crosstraffic(const char *name,
447 sg_network_crosstraffic = xbt_cfg_get_boolean(_sg_cfg_set, name);
451 static void _sg_cfg_cb__gtnets_jitter(const char *name, int pos)
453 sg_gtnets_jitter = xbt_cfg_get_double(_sg_cfg_set, name);
456 static void _sg_cfg_cb__gtnets_jitter_seed(const char *name, int pos)
458 sg_gtnets_jitter_seed = xbt_cfg_get_int(_sg_cfg_set, name);
462 /* build description line with possible values */
463 static void describe_model(char *result,
464 const s_surf_model_description_t model_description[],
466 const char *description)
469 sprintf(result, "%s. Possible values: %s", description,
470 model_description[0].name ? model_description[0].name : "n/a");
472 for (i = 1; model_description[i].name; i++)
473 p += sprintf(p, ", %s", model_description[i].name);
475 ".\n (use 'help' as a value to see the long description of each %s)",
479 /* create the config set, register what should be and parse the command line*/
480 void sg_config_init(int *argc, char **argv)
482 char description[1024];
484 /* Create the configuration support */
485 if (_sg_cfg_init_status == 0) { /* Only create stuff if not already inited */
487 /* Plugins configuration */
488 describe_model(description, surf_plugin_description,
489 "plugin", "The plugins");
490 xbt_cfg_register(&_sg_cfg_set, "plugin", description,
491 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__plugin, NULL);
493 describe_model(description, surf_cpu_model_description,
494 "model", "The model to use for the CPU");
495 xbt_cfg_register(&_sg_cfg_set, "cpu/model", description,
496 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__cpu_model, NULL);
497 xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/model", "Cas01");
499 describe_model(description, surf_optimization_mode_description,
501 "The optimization modes to use for the CPU");
502 xbt_cfg_register(&_sg_cfg_set, "cpu/optim", description,
503 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode, NULL);
504 xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/optim", "Lazy");
506 describe_model(description, surf_storage_model_description,
507 "model", "The model to use for the storage");
508 xbt_cfg_register(&_sg_cfg_set, "storage/model", description,
509 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__storage_mode, NULL);
510 xbt_cfg_setdefault_string(_sg_cfg_set, "storage/model", "default");
512 describe_model(description, surf_network_model_description,
513 "model", "The model to use for the network");
514 xbt_cfg_register(&_sg_cfg_set, "network/model", description,
515 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__network_model, NULL);
516 xbt_cfg_setdefault_string(_sg_cfg_set, "network/model", "LV08");
518 describe_model(description, surf_optimization_mode_description,
520 "The optimization modes to use for the network");
521 xbt_cfg_register(&_sg_cfg_set, "network/optim", description,
522 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode, NULL);
523 xbt_cfg_setdefault_string(_sg_cfg_set, "network/optim", "Lazy");
525 describe_model(description, surf_workstation_model_description,
526 "model", "The model to use for the workstation");
527 xbt_cfg_register(&_sg_cfg_set, "workstation/model", description,
528 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__workstation_model, NULL);
529 xbt_cfg_setdefault_string(_sg_cfg_set, "workstation/model", "default");
531 describe_model(description, surf_vm_workstation_model_description,
532 "model", "The model to use for the vm workstation");
533 xbt_cfg_register(&_sg_cfg_set, "vm_workstation/model", description,
534 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__vm_workstation_model, NULL);
535 xbt_cfg_setdefault_string(_sg_cfg_set, "vm_workstation/model", "default");
537 xbt_cfg_register(&_sg_cfg_set, "network/TCP_gamma",
538 "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)",
539 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__tcp_gamma, NULL);
540 xbt_cfg_setdefault_double(_sg_cfg_set, "network/TCP_gamma", 4194304.0);
542 xbt_cfg_register(&_sg_cfg_set, "surf/precision",
543 "Numerical precision used when updating simulation times (hence this value is expressed in seconds)",
544 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__surf_precision, NULL);
545 xbt_cfg_setdefault_double(_sg_cfg_set, "surf/precision", 0.00001);
547 xbt_cfg_register(&_sg_cfg_set, "maxmin/precision",
548 "Numerical precision used when computing resource sharing (hence this value is expressed in ops/sec or bytes/sec)",
549 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__maxmin_precision, NULL);
550 xbt_cfg_setdefault_double(_sg_cfg_set, "maxmin/precision", 0.00001);
552 /* The parameters of network models */
554 xbt_cfg_register(&_sg_cfg_set, "network/sender_gap",
555 "Minimum gap between two overlapping sends",
556 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__sender_gap, NULL);
557 /* real default for "network/sender_gap" is set in network_smpi.cpp */
558 xbt_cfg_setdefault_double(_sg_cfg_set, "network/sender_gap", NAN);
560 xbt_cfg_register(&_sg_cfg_set, "network/latency_factor",
561 "Correction factor to apply to the provided latency (default value set by network model)",
562 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__latency_factor, NULL);
563 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 1.0);
565 xbt_cfg_register(&_sg_cfg_set, "network/bandwidth_factor",
566 "Correction factor to apply to the provided bandwidth (default value set by network model)",
567 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__bandwidth_factor, NULL);
568 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 1.0);
570 xbt_cfg_register(&_sg_cfg_set, "network/weight_S",
571 "Correction factor to apply to the weight of competing streams (default value set by network model)",
572 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__weight_S, NULL);
573 /* real default for "network/weight_S" is set in network_*.cpp */
574 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", NAN);
577 xbt_cfg_register(&_sg_cfg_set, "path",
578 "Lookup path for inclusions in platform and deployment XML files",
579 xbt_cfgelm_string, 1, 0, _sg_cfg_cb__surf_path, NULL);
581 xbt_cfg_register(&_sg_cfg_set, "cpu/maxmin_selective_update",
582 "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
583 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
584 xbt_cfg_setdefault_boolean(_sg_cfg_set, "cpu/maxmin_selective_update", "no");
586 xbt_cfg_register(&_sg_cfg_set, "network/maxmin_selective_update",
587 "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
588 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
589 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/maxmin_selective_update", "no");
592 /* do model-checking */
593 xbt_cfg_register(&_sg_cfg_set, "model-check",
594 "Verify the system through model-checking instead of simulating it (EXPERIMENTAL)",
595 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_model_check, NULL);
596 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check", "no");
598 /* do stateful model-checking */
599 xbt_cfg_register(&_sg_cfg_set, "model-check/checkpoint",
600 "Specify the amount of steps between checkpoints during stateful model-checking (default: 0 => stateless verification). "
601 "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.",
602 xbt_cfgelm_int, 1, 1, _mc_cfg_cb_checkpoint, NULL);
603 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/checkpoint", 0);
605 /* do liveness model-checking */
606 xbt_cfg_register(&_sg_cfg_set, "model-check/property",
607 "Specify the name of the file containing the property. It must be the result of the ltl2ba program.",
608 xbt_cfgelm_string, 1, 1, _mc_cfg_cb_property, NULL);
609 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/property", "");
611 /* do communications determinism model-checking */
612 xbt_cfg_register(&_sg_cfg_set, "model-check/communications_determinism",
613 "Enable/disable the detection of determinism in the communications schemes",
614 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_comms_determinism, NULL);
615 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/communications_determinism", "no");
617 /* do send determinism model-checking */
618 xbt_cfg_register(&_sg_cfg_set, "model-check/send_determinism",
619 "Enable/disable the detection of send-determinism in the communications schemes",
620 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_send_determinism, NULL);
621 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/send_determinism", "no");
623 /* Specify the kind of model-checking reduction */
624 xbt_cfg_register(&_sg_cfg_set, "model-check/reduction",
625 "Specify the kind of exploration reduction (either none or DPOR)",
626 xbt_cfgelm_string, 1, 1, _mc_cfg_cb_reduce, NULL);
627 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/reduction", "dpor");
629 /* Enable/disable timeout for wait requests with model-checking */
630 xbt_cfg_register(&_sg_cfg_set, "model-check/timeout",
631 "Enable/Disable timeout for wait requests",
632 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_timeout, NULL);
633 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/timeout", "no");
635 /* Enable/disable global hash computation with model-checking */
636 xbt_cfg_register(&_sg_cfg_set, "model-check/hash",
637 "Enable/Disable state hash for state comparison (exprimental)",
638 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_hash, NULL);
639 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/hash", "no");
641 /* Set max depth exploration */
642 xbt_cfg_register(&_sg_cfg_set, "model-check/max_depth",
643 "Specify the max depth of exploration (default : 1000)",
644 xbt_cfgelm_int, 1, 1, _mc_cfg_cb_max_depth, NULL);
645 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/max_depth", 1000);
647 /* Set number of visited state stored for state comparison reduction*/
648 xbt_cfg_register(&_sg_cfg_set, "model-check/visited",
649 "Specify the number of visited state stored for state comparison reduction. If value=5, the last 5 visited states are stored",
650 xbt_cfgelm_int, 1, 1, _mc_cfg_cb_visited, NULL);
651 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/visited", 0);
653 /* Set file name for dot output of graph state */
654 xbt_cfg_register(&_sg_cfg_set, "model-check/dot_output",
655 "Specify the name of dot file corresponding to graph state",
656 xbt_cfgelm_string, 1, 1, _mc_cfg_cb_dot_output, NULL);
657 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/dot_output", "");
660 /* do verbose-exit */
661 xbt_cfg_register(&_sg_cfg_set, "verbose-exit",
662 "Activate the \"do nothing\" mode in Ctrl-C",
663 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_verbose_exit, NULL);
664 xbt_cfg_setdefault_boolean(_sg_cfg_set, "verbose-exit", "yes");
666 /* context factory */
667 const char *dflt_ctx_fact = "thread";
669 char *p = description +
671 "Context factory to use in SIMIX. Possible values: %s",
673 #ifdef CONTEXT_UCONTEXT
674 dflt_ctx_fact = "ucontext";
675 p += sprintf(p, ", %s", dflt_ctx_fact);
678 dflt_ctx_fact = "raw";
679 p += sprintf(p, ", %s", dflt_ctx_fact);
683 xbt_cfg_register(&_sg_cfg_set, "contexts/factory", description,
684 xbt_cfgelm_string, 1, 1, _sg_cfg_cb_context_factory, NULL);
685 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/factory", dflt_ctx_fact);
687 /* stack size of contexts in KiB */
688 xbt_cfg_register(&_sg_cfg_set, "contexts/stack_size",
689 "Stack size of contexts in KiB",
690 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_context_stack_size, NULL);
691 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/stack_size", 8*1024);
692 /* No, it was not set yet (the above setdefault() changed this to 1). */
693 smx_context_stack_size_was_set = 0;
695 /* guard size for contexts stacks in memory pages */
696 xbt_cfg_register(&_sg_cfg_set, "contexts/guard_size",
697 "Guard size for contexts stacks in memory pages",
698 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_context_guard_size, NULL);
699 #if defined(_XBT_WIN32) || (PTH_STACKGROWTH != -1)
700 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/guard_size", 0);
702 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/guard_size", 1);
704 /* No, it was not set yet (the above setdefault() changed this to 1). */
705 smx_context_guard_size_was_set = 0;
707 /* number of parallel threads for user processes */
708 xbt_cfg_register(&_sg_cfg_set, "contexts/nthreads",
709 "Number of parallel threads used to execute user contexts",
710 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_nthreads, NULL);
711 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/nthreads", 1);
713 /* minimal number of user contexts to be run in parallel */
714 xbt_cfg_register(&_sg_cfg_set, "contexts/parallel_threshold",
715 "Minimal number of user contexts to be run in parallel (raw contexts only)",
716 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_parallel_threshold, NULL);
717 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/parallel_threshold", 2);
719 /* synchronization mode for parallel user contexts */
720 xbt_cfg_register(&_sg_cfg_set, "contexts/synchro",
721 "Synchronization mode to use when running contexts in parallel (either futex, posix or busy_wait)",
722 xbt_cfgelm_string, 1, 1, _sg_cfg_cb_contexts_parallel_mode, NULL);
724 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "futex");
725 #else //No futex on mac and posix is unimplememted yet
726 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "busy_wait");
729 xbt_cfg_register(&_sg_cfg_set, "network/coordinates",
730 "\"yes\" or \"no\", specifying whether we use a coordinate-based routing (as Vivaldi)",
731 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb__surf_network_coordinates, NULL);
732 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/coordinates", "no");
734 xbt_cfg_register(&_sg_cfg_set, "network/crosstraffic",
735 "Activate the interferences between uploads and downloads for fluid max-min models (LV08, CM02)",
736 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb__surf_network_crosstraffic, NULL);
737 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/crosstraffic", "no");
740 xbt_cfg_register(&_sg_cfg_set, "gtnets/jitter",
741 "Double value to oscillate the link latency, uniformly in random interval [-latency*gtnets_jitter,latency*gtnets_jitter)",
742 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__gtnets_jitter, NULL);
743 xbt_cfg_setdefault_double(_sg_cfg_set, "gtnets/jitter", 0.0);
745 xbt_cfg_register(&_sg_cfg_set, "gtnets/jitter_seed",
746 "Use a positive seed to reproduce jitted results, value must be in [1,1e8], default is 10",
747 xbt_cfgelm_int, 0, 1, _sg_cfg_cb__gtnets_jitter_seed, NULL);
748 xbt_cfg_setdefault_int(_sg_cfg_set, "gtnets/jitter_seed", 10);
751 xbt_cfg_register(&_sg_cfg_set, "ns3/TcpModel",
752 "The ns3 tcp model can be : NewReno or Reno or Tahoe",
753 xbt_cfgelm_string, 1, 1, NULL, NULL);
754 xbt_cfg_setdefault_string(_sg_cfg_set, "ns3/TcpModel", "default");
758 xbt_cfg_register(&_sg_cfg_set, "smpi/running_power",
759 "Power of the host running the simulation (in flop/s). Used to bench the operations.",
760 xbt_cfgelm_double, 1, 1, NULL, NULL);
761 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/running_power", 20000.0);
763 xbt_cfg_register(&_sg_cfg_set, "smpi/display_timing",
764 "Boolean indicating whether we should display the timing after simulation.",
765 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
766 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/display_timing", "no");
768 xbt_cfg_register(&_sg_cfg_set, "smpi/use_shared_malloc",
769 "Boolean indicating whether we should use shared memory when using SMPI_SHARED_MALLOC. Allows user to disable it for debug purposes.",
770 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
771 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/use_shared_malloc", "yes");
773 xbt_cfg_register(&_sg_cfg_set, "smpi/cpu_threshold",
774 "Minimal computation time (in seconds) not discarded, or -1 for infinity.",
775 xbt_cfgelm_double, 1, 1, NULL, NULL);
776 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/cpu_threshold", 1e-6);
778 xbt_cfg_register(&_sg_cfg_set, "smpi/async_small_thres",
779 "Maximal size of messages that are to be sent asynchronously, without waiting for the receiver",
780 xbt_cfgelm_int, 1, 1, NULL, NULL);
781 xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/async_small_thres", 0);
783 xbt_cfg_register(&_sg_cfg_set, "smpi/send_is_detached_thres",
784 "Threshold of message size where MPI_Send stops behaving like MPI_Isend and becomes MPI_Ssend",
785 xbt_cfgelm_int, 1, 1, NULL, NULL);
786 xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/send_is_detached_thres", 65536);
788 xbt_cfg_register(&_sg_cfg_set, "smpi/privatize_global_variables",
789 "Boolean indicating whether we should privatize global variable at runtime.",
790 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
791 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/privatize_global_variables", "no");
793 //For smpi/bw_factor and smpi/lat_factor
794 //Default value have to be "threshold0:value0;threshold1:value1;...;thresholdN:valueN"
795 //test is if( size >= thresholdN ) return valueN;
796 //Values can be modified with command line --cfg=smpi/bw_factor:"threshold0:value0;threshold1:value1;...;thresholdN:valueN"
797 // or with tag config put line <prop id="smpi/bw_factor" value="threshold0:value0;threshold1:value1;...;thresholdN:valueN"></prop>
798 xbt_cfg_register(&_sg_cfg_set, "smpi/bw_factor",
799 "Bandwidth factors for smpi.",
800 xbt_cfgelm_string, 1, 1, NULL, NULL);
801 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");
803 xbt_cfg_register(&_sg_cfg_set, "smpi/lat_factor",
804 "Latency factors for smpi.",
805 xbt_cfgelm_string, 1, 1, NULL, NULL);
806 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");
808 xbt_cfg_register(&_sg_cfg_set, "smpi/os",
809 "Small messages timings (MPI_Send minimum time for small messages)",
810 xbt_cfgelm_string, 1, 1, NULL, NULL);
811 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/os", "1:0:0:0:0");
813 xbt_cfg_register(&_sg_cfg_set, "smpi/ois",
814 "Small messages timings (MPI_Isend minimum time for small messages)",
815 xbt_cfgelm_string, 1, 1, NULL, NULL);
816 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/ois", "1:0:0:0:0");
818 xbt_cfg_register(&_sg_cfg_set, "smpi/or",
819 "Small messages timings (MPI_Recv minimum time for small messages)",
820 xbt_cfgelm_string, 1, 1, NULL, NULL);
821 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/or", "1:0:0:0:0");
822 xbt_cfg_register(&_sg_cfg_set, "smpi/iprobe",
823 "Minimum time to inject inside a call to MPI_Iprobe",
824 xbt_cfgelm_double, 1, 1, NULL, NULL);
825 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/iprobe", 1e-4);
826 xbt_cfg_register(&_sg_cfg_set, "smpi/coll_selector",
827 "Which collective selector to use",
828 xbt_cfgelm_string, 1, 1, NULL, NULL);
829 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/coll_selector", "default");
831 xbt_cfg_register(&_sg_cfg_set, "smpi/gather",
832 "Which collective to use for gather",
833 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_gather, NULL);
835 xbt_cfg_register(&_sg_cfg_set, "smpi/allgather",
836 "Which collective to use for allgather",
837 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allgather, NULL);
839 xbt_cfg_register(&_sg_cfg_set, "smpi/barrier",
840 "Which collective to use for barrier",
841 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_barrier, NULL);
843 xbt_cfg_register(&_sg_cfg_set, "smpi/reduce_scatter",
844 "Which collective to use for reduce_scatter",
845 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_reduce_scatter, NULL);
847 xbt_cfg_register(&_sg_cfg_set, "smpi/scatter",
848 "Which collective to use for scatter",
849 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_scatter, NULL);
851 xbt_cfg_register(&_sg_cfg_set, "smpi/allgatherv",
852 "Which collective to use for allgatherv",
853 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allgatherv, NULL);
855 xbt_cfg_register(&_sg_cfg_set, "smpi/allreduce",
856 "Which collective to use for allreduce",
857 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allreduce, NULL);
859 xbt_cfg_register(&_sg_cfg_set, "smpi/alltoall",
860 "Which collective to use for alltoall",
861 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_alltoall, NULL);
863 xbt_cfg_register(&_sg_cfg_set, "smpi/alltoallv",
864 "Which collective to use for alltoallv",
865 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_alltoallv, NULL);
867 xbt_cfg_register(&_sg_cfg_set, "smpi/bcast",
868 "Which collective to use for bcast",
869 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_bcast, NULL);
871 xbt_cfg_register(&_sg_cfg_set, "smpi/reduce",
872 "Which collective to use for reduce",
873 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_reduce, NULL);
876 xbt_cfg_register(&_sg_cfg_set, "clean_atexit",
877 "\"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.",
878 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_clean_atexit, NULL);
879 xbt_cfg_setdefault_boolean(_sg_cfg_set, "clean_atexit", "yes");
882 /* retrieves the current directory of the current process */
883 const char *initial_path = __surf_get_initial_path();
884 xbt_assert((initial_path),
885 "__surf_get_initial_path() failed! Can't resolves current Windows directory");
887 surf_path = xbt_dynar_new(sizeof(char *), NULL);
888 xbt_cfg_setdefault_string(_sg_cfg_set, "path", initial_path);
891 xbt_cfg_check(_sg_cfg_set);
892 _sg_cfg_init_status = 1;
894 sg_config_cmd_line(argc, argv);
896 xbt_mallocator_initialization_is_done(SIMIX_context_is_parallel());
899 XBT_WARN("Call to sg_config_init() after initialization ignored");
903 void sg_config_finalize(void)
905 if (!_sg_cfg_init_status)
906 return; /* Not initialized yet. Nothing to do */
908 xbt_cfg_free(&_sg_cfg_set);
909 _sg_cfg_init_status = 0;
912 /* Pick the right models for CPU, net and workstation, and call their model_init_preparse */
913 void surf_config_models_setup()
915 const char *workstation_model_name;
916 const char *vm_workstation_model_name;
917 int workstation_id = -1;
918 int vm_workstation_id = -1;
919 char *network_model_name = NULL;
920 char *cpu_model_name = NULL;
922 char *storage_model_name = NULL;
924 workstation_model_name =
925 xbt_cfg_get_string(_sg_cfg_set, "workstation/model");
926 vm_workstation_model_name =
927 xbt_cfg_get_string(_sg_cfg_set, "vm_workstation/model");
928 network_model_name = xbt_cfg_get_string(_sg_cfg_set, "network/model");
929 cpu_model_name = xbt_cfg_get_string(_sg_cfg_set, "cpu/model");
930 storage_model_name = xbt_cfg_get_string(_sg_cfg_set, "storage/model");
932 /* Check whether we use a net/cpu model differing from the default ones, in which case
933 * we should switch to the "compound" workstation model to correctly dispatch stuff to
934 * the right net/cpu models.
937 if ((!xbt_cfg_is_default_value(_sg_cfg_set, "network/model") ||
938 !xbt_cfg_is_default_value(_sg_cfg_set, "cpu/model")) &&
939 xbt_cfg_is_default_value(_sg_cfg_set, "workstation/model")) {
940 XBT_INFO("Switching workstation model to compound since you changed the network and/or cpu model(s)");
941 workstation_model_name = "compound";
942 xbt_cfg_set_string(_sg_cfg_set, "workstation/model", workstation_model_name);
945 XBT_DEBUG("Workstation model: %s", workstation_model_name);
947 find_model_description(surf_workstation_model_description,
948 workstation_model_name);
949 if (!strcmp(workstation_model_name, "compound")) {
953 xbt_assert(cpu_model_name,
954 "Set a cpu model to use with the 'compound' workstation model");
956 xbt_assert(network_model_name,
957 "Set a network model to use with the 'compound' workstation model");
959 if(surf_cpu_model_init_preparse){
960 surf_cpu_model_init_preparse();
963 find_model_description(surf_cpu_model_description, cpu_model_name);
964 surf_cpu_model_description[cpu_id].model_init_preparse();
968 find_model_description(surf_network_model_description,
970 surf_network_model_description[network_id].model_init_preparse();
973 XBT_DEBUG("Call workstation_model_init");
974 surf_workstation_model_description[workstation_id].model_init_preparse();
976 XBT_DEBUG("Call vm_workstation_model_init");
977 vm_workstation_id = find_model_description(surf_vm_workstation_model_description,
978 vm_workstation_model_name);
979 surf_vm_workstation_model_description[vm_workstation_id].model_init_preparse();
981 XBT_DEBUG("Call storage_model_init");
982 storage_id = find_model_description(surf_storage_model_description, storage_model_name);
983 surf_storage_model_description[storage_id].model_init_preparse();
987 int sg_cfg_is_default_value(const char *name)
989 return xbt_cfg_is_default_value(_sg_cfg_set, name);
992 int sg_cfg_get_int(const char* name)
994 return xbt_cfg_get_int(_sg_cfg_set, name);
997 double sg_cfg_get_double(const char* name)
999 return xbt_cfg_get_double(_sg_cfg_set, name);
1002 char* sg_cfg_get_string(const char* name)
1004 return xbt_cfg_get_string(_sg_cfg_set, name);
1007 int sg_cfg_get_boolean(const char* name)
1009 return xbt_cfg_get_boolean(_sg_cfg_set, name);
1012 void sg_cfg_get_peer(const char *name, char **peer, int *port)
1014 xbt_cfg_get_peer(_sg_cfg_set, name, peer, port);
1017 xbt_dynar_t sg_cfg_get_dynar(const char* name)
1019 return xbt_cfg_get_dynar(_sg_cfg_set, name);