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_context_guard_size(const char *name, int pos)
393 smx_context_guard_size_was_set = 1;
394 smx_context_guard_size = xbt_cfg_get_int(_sg_cfg_set, name) * xbt_pagesize;
397 static void _sg_cfg_cb_contexts_nthreads(const char *name, int pos)
399 SIMIX_context_set_nthreads(xbt_cfg_get_int(_sg_cfg_set, name));
402 static void _sg_cfg_cb_contexts_parallel_threshold(const char *name, int pos)
404 SIMIX_context_set_parallel_threshold(xbt_cfg_get_int(_sg_cfg_set, name));
407 static void _sg_cfg_cb_contexts_parallel_mode(const char *name, int pos)
409 const char* mode_name = xbt_cfg_get_string(_sg_cfg_set, name);
410 if (!strcmp(mode_name, "posix")) {
411 SIMIX_context_set_parallel_mode(XBT_PARMAP_POSIX);
413 else if (!strcmp(mode_name, "futex")) {
414 SIMIX_context_set_parallel_mode(XBT_PARMAP_FUTEX);
416 else if (!strcmp(mode_name, "busy_wait")) {
417 SIMIX_context_set_parallel_mode(XBT_PARMAP_BUSY_WAIT);
420 xbt_die("Command line setting of the parallel synchronization mode should "
421 "be one of \"posix\", \"futex\" or \"busy_wait\"");
425 static void _sg_cfg_cb__surf_network_coordinates(const char *name,
428 int val = xbt_cfg_get_boolean(_sg_cfg_set, name);
430 if (!COORD_HOST_LEVEL) {
431 COORD_HOST_LEVEL = xbt_lib_add_level(host_lib,xbt_dynar_free_voidp);
432 COORD_ASR_LEVEL = xbt_lib_add_level(as_router_lib,xbt_dynar_free_voidp);
435 if (COORD_HOST_LEVEL)
436 xbt_die("Setting of whether to use coordinate cannot be disabled once set.");
439 static void _sg_cfg_cb__surf_network_crosstraffic(const char *name,
442 sg_network_crosstraffic = xbt_cfg_get_boolean(_sg_cfg_set, name);
446 static void _sg_cfg_cb__gtnets_jitter(const char *name, int pos)
448 sg_gtnets_jitter = xbt_cfg_get_double(_sg_cfg_set, name);
451 static void _sg_cfg_cb__gtnets_jitter_seed(const char *name, int pos)
453 sg_gtnets_jitter_seed = xbt_cfg_get_int(_sg_cfg_set, name);
457 /* build description line with possible values */
458 static void describe_model(char *result,
459 const s_surf_model_description_t model_description[],
461 const char *description)
464 sprintf(result, "%s. Possible values: %s", description,
465 model_description[0].name ? model_description[0].name : "n/a");
467 for (i = 1; model_description[i].name; i++)
468 p += sprintf(p, ", %s", model_description[i].name);
470 ".\n (use 'help' as a value to see the long description of each %s)",
474 /* create the config set, register what should be and parse the command line*/
475 void sg_config_init(int *argc, char **argv)
477 char description[1024];
479 /* Create the configuration support */
480 if (_sg_cfg_init_status == 0) { /* Only create stuff if not already inited */
482 /* Plugins configuration */
483 describe_model(description, surf_plugin_description,
484 "plugin", "The plugins");
485 xbt_cfg_register(&_sg_cfg_set, "plugin", description,
486 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__plugin, NULL);
488 describe_model(description, surf_cpu_model_description,
489 "model", "The model to use for the CPU");
490 xbt_cfg_register(&_sg_cfg_set, "cpu/model", description,
491 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__cpu_model, NULL);
492 xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/model", "Cas01");
494 describe_model(description, surf_optimization_mode_description,
496 "The optimization modes to use for the CPU");
497 xbt_cfg_register(&_sg_cfg_set, "cpu/optim", description,
498 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode, NULL);
499 xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/optim", "Lazy");
501 describe_model(description, surf_storage_model_description,
502 "model", "The model to use for the storage");
503 xbt_cfg_register(&_sg_cfg_set, "storage/model", description,
504 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__storage_mode, NULL);
505 xbt_cfg_setdefault_string(_sg_cfg_set, "storage/model", "default");
507 describe_model(description, surf_network_model_description,
508 "model", "The model to use for the network");
509 xbt_cfg_register(&_sg_cfg_set, "network/model", description,
510 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__network_model, NULL);
511 xbt_cfg_setdefault_string(_sg_cfg_set, "network/model", "LV08");
513 describe_model(description, surf_optimization_mode_description,
515 "The optimization modes to use for the network");
516 xbt_cfg_register(&_sg_cfg_set, "network/optim", description,
517 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode, NULL);
518 xbt_cfg_setdefault_string(_sg_cfg_set, "network/optim", "Lazy");
520 describe_model(description, surf_workstation_model_description,
521 "model", "The model to use for the workstation");
522 xbt_cfg_register(&_sg_cfg_set, "workstation/model", description,
523 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__workstation_model, NULL);
524 xbt_cfg_setdefault_string(_sg_cfg_set, "workstation/model", "default");
526 describe_model(description, surf_vm_workstation_model_description,
527 "model", "The model to use for the vm workstation");
528 xbt_cfg_register(&_sg_cfg_set, "vm_workstation/model", description,
529 xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__vm_workstation_model, NULL);
530 xbt_cfg_setdefault_string(_sg_cfg_set, "vm_workstation/model", "default");
532 xbt_cfg_register(&_sg_cfg_set, "network/TCP_gamma",
533 "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)",
534 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__tcp_gamma, NULL);
535 xbt_cfg_setdefault_double(_sg_cfg_set, "network/TCP_gamma", 4194304.0);
537 xbt_cfg_register(&_sg_cfg_set, "maxmin/precision",
538 "Numerical precision used when updating simulation models (epsilon in double comparisons)",
539 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__maxmin_precision, NULL);
540 xbt_cfg_setdefault_double(_sg_cfg_set, "maxmin/precision", 0.00001);
542 /* The parameters of network models */
544 xbt_cfg_register(&_sg_cfg_set, "network/sender_gap",
545 "Minimum gap between two overlapping sends",
546 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__sender_gap, NULL);
547 /* real default for "network/sender_gap" is set in network_smpi.cpp */
548 xbt_cfg_setdefault_double(_sg_cfg_set, "network/sender_gap", NAN);
550 xbt_cfg_register(&_sg_cfg_set, "network/latency_factor",
551 "Correction factor to apply to the provided latency (default value set by network model)",
552 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__latency_factor, NULL);
553 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 1.0);
555 xbt_cfg_register(&_sg_cfg_set, "network/bandwidth_factor",
556 "Correction factor to apply to the provided bandwidth (default value set by network model)",
557 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__bandwidth_factor, NULL);
558 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 1.0);
560 xbt_cfg_register(&_sg_cfg_set, "network/weight_S",
561 "Correction factor to apply to the weight of competing streams (default value set by network model)",
562 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__weight_S, NULL);
563 /* real default for "network/weight_S" is set in network_*.cpp */
564 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", NAN);
567 xbt_cfg_register(&_sg_cfg_set, "path",
568 "Lookup path for inclusions in platform and deployment XML files",
569 xbt_cfgelm_string, 1, 0, _sg_cfg_cb__surf_path, NULL);
571 xbt_cfg_register(&_sg_cfg_set, "cpu/maxmin_selective_update",
572 "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
573 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
574 xbt_cfg_setdefault_boolean(_sg_cfg_set, "cpu/maxmin_selective_update", "no");
576 xbt_cfg_register(&_sg_cfg_set, "network/maxmin_selective_update",
577 "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
578 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
579 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/maxmin_selective_update", "no");
582 /* do model-checking */
583 xbt_cfg_register(&_sg_cfg_set, "model-check",
584 "Verify the system through model-checking instead of simulating it (EXPERIMENTAL)",
585 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_model_check, NULL);
586 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check", "no");
588 /* do stateful model-checking */
589 xbt_cfg_register(&_sg_cfg_set, "model-check/checkpoint",
590 "Specify the amount of steps between checkpoints during stateful model-checking (default: 0 => stateless verification). "
591 "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.",
592 xbt_cfgelm_int, 1, 1, _mc_cfg_cb_checkpoint, NULL);
593 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/checkpoint", 0);
595 /* do liveness model-checking */
596 xbt_cfg_register(&_sg_cfg_set, "model-check/property",
597 "Specify the name of the file containing the property. It must be the result of the ltl2ba program.",
598 xbt_cfgelm_string, 1, 1, _mc_cfg_cb_property, NULL);
599 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/property", "");
601 /* Specify the kind of model-checking reduction */
602 xbt_cfg_register(&_sg_cfg_set, "model-check/reduction",
603 "Specify the kind of exploration reduction (either none or DPOR)",
604 xbt_cfgelm_string, 1, 1, _mc_cfg_cb_reduce, NULL);
605 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/reduction", "dpor");
607 /* Enable/disable timeout for wait requests with model-checking */
608 xbt_cfg_register(&_sg_cfg_set, "model-check/timeout",
609 "Enable/Disable timeout for wait requests",
610 xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_timeout, NULL);
611 xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/timeout", "no");
613 /* Set max depth exploration */
614 xbt_cfg_register(&_sg_cfg_set, "model-check/max_depth",
615 "Specify the max depth of exploration (default : 1000)",
616 xbt_cfgelm_int, 1, 1, _mc_cfg_cb_max_depth, NULL);
617 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/max_depth", 1000);
619 /* Set number of visited state stored for state comparison reduction*/
620 xbt_cfg_register(&_sg_cfg_set, "model-check/visited",
621 "Specify the number of visited state stored for state comparison reduction. If value=5, the last 5 visited states are stored",
622 xbt_cfgelm_int, 1, 1, _mc_cfg_cb_visited, NULL);
623 xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/visited", 0);
625 /* Set file name for dot output of graph state */
626 xbt_cfg_register(&_sg_cfg_set, "model-check/dot_output",
627 "Specify the name of dot file corresponding to graph state",
628 xbt_cfgelm_string, 1, 1, _mc_cfg_cb_dot_output, NULL);
629 xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/dot_output", "");
632 /* do verbose-exit */
633 xbt_cfg_register(&_sg_cfg_set, "verbose-exit",
634 "Activate the \"do nothing\" mode in Ctrl-C",
635 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_verbose_exit, NULL);
636 xbt_cfg_setdefault_boolean(_sg_cfg_set, "verbose-exit", "yes");
638 /* context factory */
639 const char *dflt_ctx_fact = "thread";
641 char *p = description +
643 "Context factory to use in SIMIX. Possible values: %s",
645 #ifdef CONTEXT_UCONTEXT
646 dflt_ctx_fact = "ucontext";
647 p += sprintf(p, ", %s", dflt_ctx_fact);
650 dflt_ctx_fact = "raw";
651 p += sprintf(p, ", %s", dflt_ctx_fact);
655 xbt_cfg_register(&_sg_cfg_set, "contexts/factory", description,
656 xbt_cfgelm_string, 1, 1, _sg_cfg_cb_context_factory, NULL);
657 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/factory", dflt_ctx_fact);
659 /* stack size of contexts in KiB */
660 xbt_cfg_register(&_sg_cfg_set, "contexts/stack_size",
661 "Stack size of contexts in KiB",
662 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_context_stack_size, NULL);
663 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/stack_size", 8*1024);
664 /* No, it was not set yet (the above setdefault() changed this to 1). */
665 smx_context_stack_size_was_set = 0;
667 /* guard size for contexts stacks in memory pages */
668 xbt_cfg_register(&_sg_cfg_set, "contexts/guard_size",
669 "Guard size for contexts stacks in memory pages",
670 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_context_guard_size, NULL);
671 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/guard_size", 1);
672 /* No, it was not set yet (the above setdefault() changed this to 1). */
673 smx_context_guard_size_was_set = 0;
675 /* number of parallel threads for user processes */
676 xbt_cfg_register(&_sg_cfg_set, "contexts/nthreads",
677 "Number of parallel threads used to execute user contexts",
678 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_nthreads, NULL);
679 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/nthreads", 1);
681 /* minimal number of user contexts to be run in parallel */
682 xbt_cfg_register(&_sg_cfg_set, "contexts/parallel_threshold",
683 "Minimal number of user contexts to be run in parallel (raw contexts only)",
684 xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_parallel_threshold, NULL);
685 xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/parallel_threshold", 2);
687 /* synchronization mode for parallel user contexts */
688 xbt_cfg_register(&_sg_cfg_set, "contexts/synchro",
689 "Synchronization mode to use when running contexts in parallel (either futex, posix or busy_wait)",
690 xbt_cfgelm_string, 1, 1, _sg_cfg_cb_contexts_parallel_mode, NULL);
692 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "futex");
693 #else //No futex on mac and posix is unimplememted yet
694 xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "busy_wait");
697 xbt_cfg_register(&_sg_cfg_set, "network/coordinates",
698 "\"yes\" or \"no\", specifying whether we use a coordinate-based routing (as Vivaldi)",
699 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb__surf_network_coordinates, NULL);
700 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/coordinates", "no");
702 xbt_cfg_register(&_sg_cfg_set, "network/crosstraffic",
703 "Activate the interferences between uploads and downloads for fluid max-min models (LV08, CM02)",
704 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb__surf_network_crosstraffic, NULL);
705 xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/crosstraffic", "no");
708 xbt_cfg_register(&_sg_cfg_set, "gtnets/jitter",
709 "Double value to oscillate the link latency, uniformly in random interval [-latency*gtnets_jitter,latency*gtnets_jitter)",
710 xbt_cfgelm_double, 1, 1, _sg_cfg_cb__gtnets_jitter, NULL);
711 xbt_cfg_setdefault_double(_sg_cfg_set, "gtnets/jitter", 0.0);
713 xbt_cfg_register(&_sg_cfg_set, "gtnets/jitter_seed",
714 "Use a positive seed to reproduce jitted results, value must be in [1,1e8], default is 10",
715 xbt_cfgelm_int, 0, 1, _sg_cfg_cb__gtnets_jitter_seed, NULL);
716 xbt_cfg_setdefault_int(_sg_cfg_set, "gtnets/jitter_seed", 10);
719 xbt_cfg_register(&_sg_cfg_set, "ns3/TcpModel",
720 "The ns3 tcp model can be : NewReno or Reno or Tahoe",
721 xbt_cfgelm_string, 1, 1, NULL, NULL);
722 xbt_cfg_setdefault_string(_sg_cfg_set, "ns3/TcpModel", "default");
726 xbt_cfg_register(&_sg_cfg_set, "smpi/running_power",
727 "Power of the host running the simulation (in flop/s). Used to bench the operations.",
728 xbt_cfgelm_double, 1, 1, NULL, NULL);
729 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/running_power", 20000.0);
731 xbt_cfg_register(&_sg_cfg_set, "smpi/display_timing",
732 "Boolean indicating whether we should display the timing after simulation.",
733 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
734 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/display_timing", "no");
736 xbt_cfg_register(&_sg_cfg_set, "smpi/use_shared_malloc",
737 "Boolean indicating whether we should use shared memory when using SMPI_SHARED_MALLOC. Allows user to disable it for debug purposes.",
738 xbt_cfgelm_boolean, 1, 1, NULL, NULL);
739 xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/use_shared_malloc", "yes");
741 xbt_cfg_register(&_sg_cfg_set, "smpi/cpu_threshold",
742 "Minimal computation time (in seconds) not discarded, or -1 for infinity.",
743 xbt_cfgelm_double, 1, 1, NULL, NULL);
744 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/cpu_threshold", 1e-6);
746 xbt_cfg_register(&_sg_cfg_set, "smpi/async_small_thres",
747 "Maximal size of messages that are to be sent asynchronously, without waiting for the receiver",
748 xbt_cfgelm_int, 1, 1, NULL, NULL);
749 xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/async_small_thres", 0);
751 xbt_cfg_register(&_sg_cfg_set, "smpi/send_is_detached_thres",
752 "Threshold of message size where MPI_Send stops behaving like MPI_Isend and becomes MPI_Ssend",
753 xbt_cfgelm_int, 1, 1, NULL, NULL);
754 xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/send_is_detached_thres", 65536);
756 //For smpi/bw_factor and smpi/lat_factor
757 //Default value have to be "threshold0:value0;threshold1:value1;...;thresholdN:valueN"
758 //test is if( size >= thresholdN ) return valueN;
759 //Values can be modified with command line --cfg=smpi/bw_factor:"threshold0:value0;threshold1:value1;...;thresholdN:valueN"
760 // or with tag config put line <prop id="smpi/bw_factor" value="threshold0:value0;threshold1:value1;...;thresholdN:valueN"></prop>
761 xbt_cfg_register(&_sg_cfg_set, "smpi/bw_factor",
762 "Bandwidth factors for smpi.",
763 xbt_cfgelm_string, 1, 1, NULL, NULL);
764 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/bw_factor", "65472:0.940694;15424:0.697866;9376:0.58729;5776:1.08739;3484:0.77493;1426:0.608902;732:0.341987;257:0.338112;0:0.812084");
766 xbt_cfg_register(&_sg_cfg_set, "smpi/lat_factor",
767 "Latency factors for smpi.",
768 xbt_cfgelm_string, 1, 1, NULL, NULL);
769 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/lat_factor", "65472:11.6436;15424:3.48845;9376:2.59299;5776:2.18796;3484:1.88101;1426:1.61075;732:1.9503;257:1.95341;0:2.01467");
771 xbt_cfg_register(&_sg_cfg_set, "smpi/os",
772 "Small messages timings (MPI_Send minimum time for small messages)",
773 xbt_cfgelm_string, 1, 1, NULL, NULL);
774 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/os", "1:0:0:0:0");
776 xbt_cfg_register(&_sg_cfg_set, "smpi/ois",
777 "Small messages timings (MPI_Isend minimum time for small messages)",
778 xbt_cfgelm_string, 1, 1, NULL, NULL);
779 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/ois", "1:0:0:0:0");
781 xbt_cfg_register(&_sg_cfg_set, "smpi/or",
782 "Small messages timings (MPI_Recv minimum time for small messages)",
783 xbt_cfgelm_string, 1, 1, NULL, NULL);
784 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/or", "1:0:0:0:0");
785 xbt_cfg_register(&_sg_cfg_set, "smpi/iprobe",
786 "Minimum time to inject inside a call to MPI_Iprobe",
787 xbt_cfgelm_double, 1, 1, NULL, NULL);
788 xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/iprobe", 1e-4);
789 xbt_cfg_register(&_sg_cfg_set, "smpi/coll_selector",
790 "Which collective selector to use",
791 xbt_cfgelm_string, 1, 1, NULL, NULL);
792 xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/coll_selector", "default");
794 xbt_cfg_register(&_sg_cfg_set, "smpi/gather",
795 "Which collective to use for gather",
796 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_gather, NULL);
798 xbt_cfg_register(&_sg_cfg_set, "smpi/allgather",
799 "Which collective to use for allgather",
800 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allgather, NULL);
802 xbt_cfg_register(&_sg_cfg_set, "smpi/barrier",
803 "Which collective to use for barrier",
804 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_barrier, NULL);
806 xbt_cfg_register(&_sg_cfg_set, "smpi/reduce_scatter",
807 "Which collective to use for reduce_scatter",
808 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_reduce_scatter, NULL);
810 xbt_cfg_register(&_sg_cfg_set, "smpi/scatter",
811 "Which collective to use for scatter",
812 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_scatter, NULL);
814 xbt_cfg_register(&_sg_cfg_set, "smpi/allgatherv",
815 "Which collective to use for allgatherv",
816 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allgatherv, NULL);
818 xbt_cfg_register(&_sg_cfg_set, "smpi/allreduce",
819 "Which collective to use for allreduce",
820 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allreduce, NULL);
822 xbt_cfg_register(&_sg_cfg_set, "smpi/alltoall",
823 "Which collective to use for alltoall",
824 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_alltoall, NULL);
826 xbt_cfg_register(&_sg_cfg_set, "smpi/alltoallv",
827 "Which collective to use for alltoallv",
828 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_alltoallv, NULL);
830 xbt_cfg_register(&_sg_cfg_set, "smpi/bcast",
831 "Which collective to use for bcast",
832 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_bcast, NULL);
834 xbt_cfg_register(&_sg_cfg_set, "smpi/reduce",
835 "Which collective to use for reduce",
836 xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_reduce, NULL);
839 xbt_cfg_register(&_sg_cfg_set, "clean_atexit",
840 "\"yes\" or \"no\". \"yes\" enables all the cleanups of SimGrid (XBT,SIMIX,MSG) to be registered with atexit. \"no\" may be useful if your code segfaults when calling the exit function.",
841 xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_clean_atexit, NULL);
842 xbt_cfg_setdefault_boolean(_sg_cfg_set, "clean_atexit", "yes");
845 /* retrieves the current directory of the current process */
846 const char *initial_path = __surf_get_initial_path();
847 xbt_assert((initial_path),
848 "__surf_get_initial_path() failed! Can't resolves current Windows directory");
850 surf_path = xbt_dynar_new(sizeof(char *), NULL);
851 xbt_cfg_setdefault_string(_sg_cfg_set, "path", initial_path);
854 xbt_cfg_check(_sg_cfg_set);
855 _sg_cfg_init_status = 1;
857 sg_config_cmd_line(argc, argv);
859 xbt_mallocator_initialization_is_done(SIMIX_context_is_parallel());
862 XBT_WARN("Call to sg_config_init() after initialization ignored");
866 void sg_config_finalize(void)
868 if (!_sg_cfg_init_status)
869 return; /* Not initialized yet. Nothing to do */
871 xbt_cfg_free(&_sg_cfg_set);
872 _sg_cfg_init_status = 0;
875 /* Pick the right models for CPU, net and workstation, and call their model_init_preparse */
876 void surf_config_models_setup()
878 const char *workstation_model_name;
879 const char *vm_workstation_model_name;
880 int workstation_id = -1;
881 int vm_workstation_id = -1;
882 char *network_model_name = NULL;
883 char *cpu_model_name = NULL;
885 char *storage_model_name = NULL;
887 workstation_model_name =
888 xbt_cfg_get_string(_sg_cfg_set, "workstation/model");
889 vm_workstation_model_name =
890 xbt_cfg_get_string(_sg_cfg_set, "vm_workstation/model");
891 network_model_name = xbt_cfg_get_string(_sg_cfg_set, "network/model");
892 cpu_model_name = xbt_cfg_get_string(_sg_cfg_set, "cpu/model");
893 storage_model_name = xbt_cfg_get_string(_sg_cfg_set, "storage/model");
895 /* Check whether we use a net/cpu model differing from the default ones, in which case
896 * we should switch to the "compound" workstation model to correctly dispatch stuff to
897 * the right net/cpu models.
900 if ((!xbt_cfg_is_default_value(_sg_cfg_set, "network/model") ||
901 !xbt_cfg_is_default_value(_sg_cfg_set, "cpu/model")) &&
902 xbt_cfg_is_default_value(_sg_cfg_set, "workstation/model")) {
903 XBT_INFO("Switching workstation model to compound since you changed the network and/or cpu model(s)");
904 workstation_model_name = "compound";
905 xbt_cfg_set_string(_sg_cfg_set, "workstation/model", workstation_model_name);
908 XBT_DEBUG("Workstation model: %s", workstation_model_name);
910 find_model_description(surf_workstation_model_description,
911 workstation_model_name);
912 if (!strcmp(workstation_model_name, "compound")) {
916 xbt_assert(cpu_model_name,
917 "Set a cpu model to use with the 'compound' workstation model");
919 xbt_assert(network_model_name,
920 "Set a network model to use with the 'compound' workstation model");
923 find_model_description(surf_network_model_description,
926 find_model_description(surf_cpu_model_description, cpu_model_name);
928 surf_cpu_model_description[cpu_id].model_init_preparse();
929 surf_network_model_description[network_id].model_init_preparse();
932 XBT_DEBUG("Call workstation_model_init");
933 surf_workstation_model_description[workstation_id].model_init_preparse();
935 XBT_DEBUG("Call vm_workstation_model_init");
936 vm_workstation_id = find_model_description(surf_vm_workstation_model_description,
937 vm_workstation_model_name);
938 surf_vm_workstation_model_description[vm_workstation_id].model_init_preparse();
940 XBT_DEBUG("Call storage_model_init");
941 storage_id = find_model_description(surf_storage_model_description, storage_model_name);
942 surf_storage_model_description[storage_id].model_init_preparse();
946 int sg_cfg_is_default_value(const char *name)
948 return xbt_cfg_is_default_value(_sg_cfg_set, name);
951 int sg_cfg_get_int(const char* name)
953 return xbt_cfg_get_int(_sg_cfg_set, name);
956 double sg_cfg_get_double(const char* name)
958 return xbt_cfg_get_double(_sg_cfg_set, name);
961 char* sg_cfg_get_string(const char* name)
963 return xbt_cfg_get_string(_sg_cfg_set, name);
966 int sg_cfg_get_boolean(const char* name)
968 return xbt_cfg_get_boolean(_sg_cfg_set, name);
971 void sg_cfg_get_peer(const char *name, char **peer, int *port)
973 xbt_cfg_get_peer(_sg_cfg_set, name, peer, port);
976 xbt_dynar_t sg_cfg_get_dynar(const char* name)
978 return xbt_cfg_get_dynar(_sg_cfg_set, name);