Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
further cleanups to the config stuff
[simgrid.git] / src / simgrid / sg_config.cpp
1 /* Copyright (c) 2009-2010, 2012-2015. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
7 /* sg_config: configuration infrastructure for the simulation world       */
8
9 #include "xbt/misc.h"
10 #include "xbt/config.h"
11 #include "xbt/log.h"
12 #include "xbt/mallocator.h"
13 #include "xbt/str.h"
14 #include "xbt/lib.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 "simgrid_config.h" /* what was compiled in? */
22 #if HAVE_SMPI
23 #include "smpi/smpi_interface.h"
24 #endif
25 #include "mc/mc.h"
26 #include "simgrid/instr.h"
27 #include "src/mc/mc_replay.h"
28
29 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_config, surf, "About the configuration of SimGrid");
30
31
32 /* 0: beginning of time (config cannot be changed yet);
33  * 1: initialized: cfg_set created (config can now be changed);
34  * 2: configured: command line parsed and config part of platform file was
35  *    integrated also, platform construction ongoing or done.
36  *    (Config cannot be changed anymore!)
37  */
38 int _sg_cfg_init_status = 0;
39
40 /* instruct the upper layer (simix or simdag) to exit as soon as possible */
41 int _sg_cfg_exit_asap = 0;
42
43 #define sg_cfg_exit_early() do { _sg_cfg_exit_asap = 1; return; } while (0)
44
45 /* Parse the command line, looking for options */
46 static void sg_config_cmd_line(int *argc, char **argv)
47 {
48   int shall_exit = 0;
49   int i, j;
50   char *opt;
51
52   for (j = i = 1; i < *argc; i++) {
53     if (!strncmp(argv[i], "--cfg=", strlen("--cfg="))) {
54       opt = strchr(argv[i], '=');
55       opt++;
56
57       xbt_cfg_set_parse(opt);
58       XBT_DEBUG("Did apply '%s' as config setting", opt);
59     } else if (!strcmp(argv[i], "--version")) {
60       printf("%s\n", SIMGRID_VERSION_STRING);
61       shall_exit = 1;
62     } else if (!strcmp(argv[i], "--cfg-help") || !strcmp(argv[i], "--help")) {
63       printf("Description of the configuration accepted by this simulator:\n");
64       xbt_cfg_help();
65       printf(
66           "\n"
67           "Each of these configurations can be used by adding\n"
68           "    --cfg=<option name>:<option value>\n"
69           "to the command line.\n"
70           "\n"
71           "For more information, please refer to:\n"
72           "   --help-aliases for the list of all option aliases.\n"
73           "   --help-logs and --help-log-categories for the details of logging output.\n"
74           "   --help-models for a list of all models known by this simulator.\n"
75           "   --help-tracing for the details of all tracing options known by this simulator.\n"
76           "   --version to get SimGrid version information.\n"
77           "\n"
78         );
79       shall_exit = 1;
80     } else if (!strcmp(argv[i], "--help-aliases")) {
81       printf("Here is a list of all deprecated option names, with their replacement.\n");
82       xbt_cfg_aliases();
83       printf("Please consider using the recent names\n");
84       shall_exit = 1;
85     } else if (!strcmp(argv[i], "--help-models")) {
86       int k;
87
88       model_help("host", surf_host_model_description);
89       printf("\n");
90       model_help("CPU", surf_cpu_model_description);
91       printf("\n");
92       model_help("network", surf_network_model_description);
93       printf("\nLong description of all optimization levels accepted by the models of this simulator:\n");
94       for (k = 0; surf_optimization_mode_description[k].name; k++)
95         printf("  %s: %s\n",
96                surf_optimization_mode_description[k].name,
97                surf_optimization_mode_description[k].description);
98       printf("Both network and CPU models have 'Lazy' as default optimization level\n\n");
99       shall_exit = 1;
100     } else if (!strcmp(argv[i], "--help-tracing")) {
101       TRACE_help (1);
102       shall_exit = 1;
103     } else {
104       argv[j++] = argv[i];
105     }
106   }
107   if (j < *argc) {
108     argv[j] = NULL;
109     *argc = j;
110   }
111   if (shall_exit)
112     sg_cfg_exit_early();
113 }
114
115 /* callback of the plugin variable */
116 static void _sg_cfg_cb__plugin(const char *name, int pos)
117 {
118   xbt_assert(_sg_cfg_init_status < 2, "Cannot load a plugin after the initialization");
119
120   char *val = xbt_cfg_get_string(name);
121   if (val==nullptr)
122     return;
123
124   if (!strcmp(val, "help")) {
125     model_help("plugin", surf_plugin_description);
126     sg_cfg_exit_early();
127   }
128
129   /* New Module missing */
130   int plugin_id = find_model_description(surf_plugin_description, val);
131   surf_plugin_description[plugin_id].model_init_preparse();
132 }
133
134 /* callback of the host/model variable */
135 static void _sg_cfg_cb__host_model(const char *name, int pos)
136 {
137   xbt_assert(_sg_cfg_init_status < 2, "Cannot change the model after the initialization");
138
139   char *val = xbt_cfg_get_string(name);
140   if (!strcmp(val, "help")) {
141     model_help("host", surf_host_model_description);
142     sg_cfg_exit_early();
143   }
144
145   /* Make sure that the model exists */
146   find_model_description(surf_host_model_description, val);
147 }
148
149 /* callback of the vm/model variable */
150 static void _sg_cfg_cb__vm_model(const char *name, int pos)
151 {
152   xbt_assert(_sg_cfg_init_status < 2, "Cannot change the model after the initialization");
153
154   char *val = xbt_cfg_get_string(name);
155   if (!strcmp(val, "help")) {
156     model_help("vm", surf_vm_model_description);
157     sg_cfg_exit_early();
158   }
159
160   /* Make sure that the model exists */
161   find_model_description(surf_vm_model_description, val);
162 }
163
164 /* callback of the cpu/model variable */
165 static void _sg_cfg_cb__cpu_model(const char *name, int pos)
166 {
167   xbt_assert(_sg_cfg_init_status < 2, "Cannot change the model after the initialization");
168
169   char *val = xbt_cfg_get_string(name);
170   if (!strcmp(val, "help")) {
171     model_help("CPU", surf_cpu_model_description);
172     sg_cfg_exit_early();
173   }
174
175   /* New Module missing */
176   find_model_description(surf_cpu_model_description, val);
177 }
178
179 /* callback of the cpu/model variable */
180 static void _sg_cfg_cb__optimization_mode(const char *name, int pos)
181 {
182   char *val;
183
184   xbt_assert(_sg_cfg_init_status < 2,
185               "Cannot change the model after the initialization");
186
187   val = xbt_cfg_get_string(name);
188
189   if (!strcmp(val, "help")) {
190     model_help("optimization", surf_optimization_mode_description);
191     sg_cfg_exit_early();
192   }
193
194   /* New Module missing */
195   find_model_description(surf_optimization_mode_description, val);
196 }
197
198 /* callback of the cpu/model variable */
199 static void _sg_cfg_cb__storage_mode(const char *name, int pos)
200 {
201   char *val;
202
203   xbt_assert(_sg_cfg_init_status < 2,
204               "Cannot change the model after the initialization");
205
206   val = xbt_cfg_get_string(name);
207
208   if (!strcmp(val, "help")) {
209     model_help("storage", surf_storage_model_description);
210     sg_cfg_exit_early();
211   }
212
213   /* New Module missing */
214   find_model_description(surf_storage_model_description, val);
215 }
216
217 /* callback of the network_model variable */
218 static void _sg_cfg_cb__network_model(const char *name, int pos)
219 {
220   char *val;
221
222   xbt_assert(_sg_cfg_init_status < 2,
223               "Cannot change the model after the initialization");
224
225   val = xbt_cfg_get_string(name);
226
227   if (!strcmp(val, "help")) {
228     model_help("network", surf_network_model_description);
229     sg_cfg_exit_early();
230   }
231
232   /* New Module missing */
233   find_model_description(surf_network_model_description, val);
234 }
235
236 /* callbacks of the network models values */
237 static void _sg_cfg_cb__tcp_gamma(const char *name, int pos)
238 {
239   sg_tcp_gamma = xbt_cfg_get_double(name);
240 }
241
242 static void _sg_cfg_cb__maxmin_precision(const char* name, int pos)
243 {
244   sg_maxmin_precision = xbt_cfg_get_double(name);
245 }
246
247 static void _sg_cfg_cb__surf_precision(const char* name, int pos)
248 {
249   sg_surf_precision = xbt_cfg_get_double(name);
250 }
251
252 static void _sg_cfg_cb__sender_gap(const char* name, int pos)
253 {
254   sg_sender_gap = xbt_cfg_get_double(name);
255 }
256
257 static void _sg_cfg_cb__latency_factor(const char *name, int pos)
258 {
259   sg_latency_factor = xbt_cfg_get_double(name);
260 }
261
262 static void _sg_cfg_cb__bandwidth_factor(const char *name, int pos)
263 {
264   sg_bandwidth_factor = xbt_cfg_get_double(name);
265 }
266
267 static void _sg_cfg_cb__weight_S(const char *name, int pos)
268 {
269   sg_weight_S_parameter = xbt_cfg_get_double(name);
270 }
271
272 #if HAVE_SMPI
273 /* callback of the mpi collectives: simply check that this is a valid name. It will be picked up in smpi_global.cpp */
274 static void _check_coll(const char *category,
275                              s_mpi_coll_description_t * table,
276                              const char *name)
277 {
278   xbt_assert(_sg_cfg_init_status < 2, "Cannot change the collective algorithm after the initialization");
279
280   char *val = xbt_cfg_get_string(name);
281
282   if (val && !strcmp(val, "help")) {
283     coll_help(category, table);
284     sg_cfg_exit_early();
285   }
286
287   find_coll_description(table, val, category);
288 }
289 static void _check_coll_gather(const char *name, int pos){
290   _check_coll("gather", mpi_coll_gather_description, name);
291 }
292 static void _check_coll_allgather(const char *name, int pos){
293   _check_coll("allgather", mpi_coll_allgather_description, name);
294 }
295 static void _check_coll_allgatherv(const char *name, int pos){
296   _check_coll("allgatherv", mpi_coll_allgatherv_description, name);
297 }
298 static void _check_coll_allreduce(const char *name, int pos)
299 {
300   _check_coll("allreduce", mpi_coll_allreduce_description, name);
301 }
302 static void _check_coll_alltoall(const char *name, int pos)
303 {
304   _check_coll("alltoall", mpi_coll_alltoall_description, name);
305 }
306 static void _check_coll_alltoallv(const char *name, int pos)
307 {
308   _check_coll("alltoallv", mpi_coll_alltoallv_description, name);
309 }
310 static void _check_coll_bcast(const char *name, int pos)
311 {
312   _check_coll("bcast", mpi_coll_bcast_description, name);
313 }
314 static void _check_coll_reduce(const char *name, int pos)
315 {
316   _check_coll("reduce", mpi_coll_reduce_description, name);
317 }
318 static void _check_coll_reduce_scatter(const char *name, int pos){
319   _check_coll("reduce_scatter", mpi_coll_reduce_scatter_description, name);
320 }
321 static void _check_coll_scatter(const char *name, int pos){
322   _check_coll("scatter", mpi_coll_scatter_description, name);
323 }
324 static void _check_coll_barrier(const char *name, int pos){
325   _check_coll("barrier", mpi_coll_barrier_description, name);
326 }
327
328 static void _sg_cfg_cb__wtime_sleep(const char *name, int pos){
329   smpi_wtime_sleep = xbt_cfg_get_double(name);
330 }
331
332 static void _sg_cfg_cb__iprobe_sleep(const char *name, int pos){
333   smpi_iprobe_sleep = xbt_cfg_get_double(name);
334 }
335
336 static void _sg_cfg_cb__test_sleep(const char *name, int pos){
337   smpi_test_sleep = xbt_cfg_get_double(name);
338 }
339
340
341
342 #endif
343
344 /* callback of the inclusion path */
345 static void _sg_cfg_cb__surf_path(const char *name, int pos)
346 {
347   char *path = xbt_strdup(xbt_cfg_get_string_at(simgrid_config, name, pos));
348   if (path[0]) // ignore ""
349     xbt_dynar_push(surf_path, &path);
350 }
351
352 /* callback to decide if we want to use the model-checking */
353 #include "src/xbt_modinter.h"
354
355 #if HAVE_MC
356 extern int _sg_do_model_check;   /* this variable lives in xbt_main until I find a right location for it */
357 extern int _sg_do_model_check_record;
358 #endif
359
360 static void _sg_cfg_cb_model_check_replay(const char *name, int pos) {
361   MC_record_path = xbt_cfg_get_string(name);
362 }
363
364 #if HAVE_MC
365 static void _sg_cfg_cb_model_check_record(const char *name, int pos) {
366   _sg_do_model_check_record = xbt_cfg_get_boolean(name);
367 }
368 #endif
369
370 extern int _sg_do_verbose_exit;
371
372 static void _sg_cfg_cb_verbose_exit(const char *name, int pos)
373 {
374   _sg_do_verbose_exit = xbt_cfg_get_boolean(name);
375 }
376
377 extern int _sg_do_clean_atexit;
378
379 static void _sg_cfg_cb_clean_atexit(const char *name, int pos)
380 {
381   _sg_do_clean_atexit = xbt_cfg_get_boolean(name);
382 }
383
384 static void _sg_cfg_cb_context_factory(const char *name, int pos)
385 {
386   smx_context_factory_name = xbt_cfg_get_string(name);
387 }
388
389 static void _sg_cfg_cb_context_stack_size(const char *name, int pos)
390 {
391   smx_context_stack_size_was_set = 1;
392   smx_context_stack_size = xbt_cfg_get_int(name) * 1024;
393 }
394
395 static void _sg_cfg_cb_context_guard_size(const char *name, int pos)
396 {
397   smx_context_guard_size_was_set = 1;
398   smx_context_guard_size = xbt_cfg_get_int(name) * xbt_pagesize;
399 }
400
401 static void _sg_cfg_cb_contexts_nthreads(const char *name, int pos)
402 {
403   SIMIX_context_set_nthreads(xbt_cfg_get_int(name));
404 }
405
406 static void _sg_cfg_cb_contexts_parallel_threshold(const char *name, int pos)
407 {
408   SIMIX_context_set_parallel_threshold(xbt_cfg_get_int(name));
409 }
410
411 static void _sg_cfg_cb_contexts_parallel_mode(const char *name, int pos)
412 {
413   const char* mode_name = xbt_cfg_get_string(name);
414   if (!strcmp(mode_name, "posix")) {
415     SIMIX_context_set_parallel_mode(XBT_PARMAP_POSIX);
416   }
417   else if (!strcmp(mode_name, "futex")) {
418     SIMIX_context_set_parallel_mode(XBT_PARMAP_FUTEX);
419   }
420   else if (!strcmp(mode_name, "busy_wait")) {
421     SIMIX_context_set_parallel_mode(XBT_PARMAP_BUSY_WAIT);
422   }
423   else {
424     xbt_die("Command line setting of the parallel synchronization mode should "
425             "be one of \"posix\", \"futex\" or \"busy_wait\"");
426   }
427 }
428
429 static void _sg_cfg_cb__surf_network_coordinates(const char *name,
430                                                  int pos)
431 {
432   static int already_set = 0;
433   int val = xbt_cfg_get_boolean(name);
434   if (val) {
435     if (!already_set) {
436       COORD_HOST_LEVEL = sg_host_extension_create(xbt_dynar_free_voidp);
437       COORD_ASR_LEVEL  = xbt_lib_add_level(as_router_lib,xbt_dynar_free_voidp);
438     }
439     already_set = 1;
440   } else
441     if (already_set)
442       xbt_die("Setting of whether to use coordinate cannot be disabled once set.");
443 }
444
445 static void _sg_cfg_cb__surf_network_crosstraffic(const char *name,
446                                                   int pos)
447 {
448   sg_network_crosstraffic = xbt_cfg_get_boolean(name);
449 }
450
451 /* build description line with possible values */
452 static void describe_model(char *result,
453                            const s_surf_model_description_t model_description[],
454                            const char *name,
455                            const char *description)
456 {
457   char *p = result +
458     sprintf(result, "%s. Possible values: %s", description,
459             model_description[0].name ? model_description[0].name : "n/a");
460   int i;
461   for (i = 1; model_description[i].name; i++)
462     p += sprintf(p, ", %s", model_description[i].name);
463   sprintf(p,
464       ".\n       (use 'help' as a value to see the long description of each %s)",
465           name);
466 }
467
468 /* create the config set, register what should be and parse the command line*/
469 void sg_config_init(int *argc, char **argv)
470 {
471   char description[1024];
472
473   /* Create the configuration support */
474   if (_sg_cfg_init_status == 0) { /* Only create stuff if not already inited */
475
476     /* Plugins configuration */
477     describe_model(description, surf_plugin_description, "plugin", "The plugins");
478     xbt_cfg_register_string("plugin", description, nullptr, &_sg_cfg_cb__plugin);
479
480     describe_model(description, surf_cpu_model_description, "model", "The model to use for the CPU");
481     xbt_cfg_register_string("cpu/model", description, "Cas01", &_sg_cfg_cb__cpu_model);
482
483     describe_model(description, surf_optimization_mode_description, "optimization mode", "The optimization modes to use for the CPU");
484     xbt_cfg_register_string("cpu/optim", description, "Lazy", &_sg_cfg_cb__optimization_mode);
485
486     describe_model(description, surf_storage_model_description, "model", "The model to use for the storage");
487     xbt_cfg_register_string("storage/model", description, "default", &_sg_cfg_cb__storage_mode);
488
489     describe_model(description, surf_network_model_description, "model", "The model to use for the network");
490     xbt_cfg_register_string("network/model", description, "LV08", &_sg_cfg_cb__network_model);
491
492     describe_model(description, surf_optimization_mode_description, "optimization mode", "The optimization modes to use for the network");
493     xbt_cfg_register_string("network/optim", description, "Lazy", &_sg_cfg_cb__optimization_mode);
494
495     describe_model(description, surf_host_model_description, "model", "The model to use for the host");
496     xbt_cfg_register_string("host/model", description, "default", &_sg_cfg_cb__host_model);
497
498     describe_model(description, surf_vm_model_description, "model", "The model to use for the vm");
499     xbt_cfg_register_string("vm/model", description, "default", &_sg_cfg_cb__vm_model);
500
501     xbt_cfg_register_double("network/TCP_gamma",
502         "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)",
503         4194304.0, _sg_cfg_cb__tcp_gamma);
504
505     xbt_cfg_register_double("surf/precision", "Numerical precision used when updating simulation times (in seconds)",
506         0.00001, _sg_cfg_cb__surf_precision);
507
508     xbt_cfg_register_double("maxmin/precision",
509         "Numerical precision used when computing resource sharing (in ops/sec or bytes/sec)",
510         0.00001, _sg_cfg_cb__maxmin_precision);
511
512     /* The parameters of network models */
513
514     xbt_cfg_register_double("network/sender_gap", "Minimum gap between two overlapping sends", NAN, _sg_cfg_cb__sender_gap); /* real default for "network/sender_gap" is set in network_smpi.cpp */
515     xbt_cfg_register_double("network/latency_factor", "Correction factor to apply to the provided latency (default value set by network model)",
516         1.0, _sg_cfg_cb__latency_factor);
517     xbt_cfg_register_double("network/bandwidth_factor", "Correction factor to apply to the provided bandwidth (default value set by network model)",
518         1.0, _sg_cfg_cb__bandwidth_factor);
519     xbt_cfg_register_double("network/weight_S",
520         "Correction factor to apply to the weight of competing streams (default value set by network model)",
521         NAN, _sg_cfg_cb__weight_S); /* real default for "network/weight_S" is set in network_*.cpp */
522
523     /* Inclusion path */
524     xbt_cfg_register_string("path", "Lookup path for inclusions in platform and deployment XML files", "", _sg_cfg_cb__surf_path);
525
526     xbt_cfg_register_boolean("cpu/maxmin_selective_update",
527         "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
528         "no", NULL);
529     xbt_cfg_register_boolean("network/maxmin_selective_update",
530         "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
531         "no", NULL);
532     /* Replay (this part is enabled even if MC it disabled) */
533     xbt_cfg_register_string("model-check/replay", "Enable replay mode with the given path", nullptr, _sg_cfg_cb_model_check_replay);
534
535 #if HAVE_MC
536     /* do model-checking-record */
537     xbt_cfg_register_boolean("model-check/record", "Record the model-checking paths", "no", _sg_cfg_cb_model_check_record);
538
539     xbt_cfg_register_int("model-check/checkpoint",
540                      "Specify the amount of steps between checkpoints during stateful model-checking (default: 0 => stateless verification). "
541                      "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.",
542                      0, _mc_cfg_cb_checkpoint);
543
544     xbt_cfg_register_boolean("model-check/sparse_checkpoint", "Use sparse per-page snapshots.", "no", _mc_cfg_cb_sparse_checkpoint);
545     xbt_cfg_register_boolean("model-check/soft-dirty", "Use sparse per-page snapshots.", "no", _mc_cfg_cb_soft_dirty);
546     xbt_cfg_register_boolean("model-check/ksm", "Kernel same-page merging", "no", _mc_cfg_cb_ksm);
547
548     xbt_cfg_register_string("model-check/property", "Name of the file containing the property, as formated by the ltl2ba program.",
549         "", _mc_cfg_cb_property);
550
551     xbt_cfg_register_boolean("model-check/communications_determinism",
552         "Whether to enable the detection of communication determinism", "no", _mc_cfg_cb_comms_determinism);
553
554     xbt_cfg_register_boolean("model-check/send_determinism",
555         "Enable/disable the detection of send-determinism in the communications schemes", "no", _mc_cfg_cb_send_determinism);
556
557     /* Specify the kind of model-checking reduction */
558     xbt_cfg_register_string("model-check/reduction", "Specify the kind of exploration reduction (either none or DPOR)", "dpor", _mc_cfg_cb_reduce);
559     xbt_cfg_register_boolean("model-check/timeout", "Whether to enable timeouts for wait requests", "no",  _mc_cfg_cb_timeout);
560
561     xbt_cfg_register_boolean("model-check/hash", "Whether to enable state hash for state comparison (experimental)", "no", _mc_cfg_cb_hash);
562     xbt_cfg_register_boolean("model-check/snapshot_fds", "Whether file descriptors must be snapshoted (currently unusable)", "no",  _mc_cfg_cb_snapshot_fds);
563     xbt_cfg_register_int("model-check/max_depth", "Maximal exploration depth (default: 1000)", 1000, _mc_cfg_cb_max_depth);
564     xbt_cfg_register_int("model-check/visited",
565         "Specify the number of visited state stored for state comparison reduction. If value=5, the last 5 visited states are stored. If value=0 (the default), all states are stored.",
566         0, _mc_cfg_cb_visited);
567
568     xbt_cfg_register_string("model-check/dot_output", "Name of dot output file corresponding to graph state", "", _mc_cfg_cb_dot_output);
569     xbt_cfg_register_boolean("model-check/termination", "Whether to enable non progressive cycle detection", "no", _mc_cfg_cb_termination);
570 #endif
571
572     xbt_cfg_register_boolean("verbose-exit", "Activate the \"do nothing\" mode in Ctrl-C", "yes", _sg_cfg_cb_verbose_exit);
573
574     /* context factory */
575     const char *dflt_ctx_fact = "thread";
576     {
577       char *p = description +
578         sprintf(description,
579                 "Context factory to use in SIMIX. Possible values: %s",
580                 dflt_ctx_fact);
581 #if HAVE_UCONTEXT_CONTEXTS
582       dflt_ctx_fact = "ucontext";
583       p += sprintf(p, ", %s", dflt_ctx_fact);
584 #endif
585 #if HAVE_RAW_CONTEXTS
586       dflt_ctx_fact = "raw";
587       p += sprintf(p, ", %s", dflt_ctx_fact);
588 #endif
589       sprintf(p, ".");
590     }
591     xbt_cfg_register_string("contexts/factory", description, dflt_ctx_fact, _sg_cfg_cb_context_factory);
592
593     xbt_cfg_register_int("contexts/stack_size", "Stack size of contexts in KiB", 8*1024, _sg_cfg_cb_context_stack_size);
594     /* (FIXME: this is unpleasant) Reset this static variable that was altered when setting the default value. */
595     smx_context_stack_size_was_set = 0;
596
597     /* guard size for contexts stacks in memory pages */
598     xbt_cfg_register_int("contexts/guard_size", "Guard size for contexts stacks in memory pages",
599 #if defined(_WIN32) || (PTH_STACKGROWTH != -1)
600         0, _sg_cfg_cb_context_guard_size);
601 #else
602         1, _sg_cfg_cb_context_guard_size);
603 #endif
604     /* No, it was not set yet (the above setdefault() changed this to 1). */
605     smx_context_guard_size_was_set = 0;
606
607     xbt_cfg_register_int("contexts/nthreads", "Number of parallel threads used to execute user contexts", 1, _sg_cfg_cb_contexts_nthreads);
608
609     xbt_cfg_register_int("contexts/parallel_threshold", "Minimal number of user contexts to be run in parallel (raw contexts only)",
610         2, _sg_cfg_cb_contexts_parallel_threshold);
611
612     /* synchronization mode for parallel user contexts */
613     xbt_cfg_register_string("contexts/synchro", "Synchronization mode to use when running contexts in parallel (either futex, posix or busy_wait)",
614 #if HAVE_FUTEX_H
615     "futex",     _sg_cfg_cb_contexts_parallel_mode);
616 #else //No futex on mac and posix is unimplememted yet
617     "busy_wait", _sg_cfg_cb_contexts_parallel_mode);
618 #endif
619
620     xbt_cfg_register_boolean("network/coordinates", "Whether we use a coordinate-based routing (as Vivaldi)",
621         "no", _sg_cfg_cb__surf_network_coordinates);
622
623     xbt_cfg_register_boolean("network/crosstraffic", "Activate the interferences between uploads and downloads for fluid max-min models (LV08, CM02)",
624         "yes", _sg_cfg_cb__surf_network_crosstraffic);
625
626 #if HAVE_NS3
627     xbt_cfg_register_string("ns3/TcpModel", "The ns3 tcp model can be : NewReno or Reno or Tahoe", "default", NULL);
628 #endif
629
630     //For smpi/bw_factor and smpi/lat_factor
631     //Default value have to be "threshold0:value0;threshold1:value1;...;thresholdN:valueN"
632     //test is if( size >= thresholdN ) return valueN;
633     //Values can be modified with command line --cfg=smpi/bw_factor:"threshold0:value0;threshold1:value1;...;thresholdN:valueN"
634     //  or with tag config put line <prop id="smpi/bw_factor" value="threshold0:value0;threshold1:value1;...;thresholdN:valueN"></prop>
635     // SMPI model can be used without enable_smpi, so keep this out of the ifdef.
636     xbt_cfg_register_string("smpi/bw_factor", "Bandwidth factors for smpi.",
637         "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", NULL);
638
639     xbt_cfg_register_string("smpi/lat_factor", "Latency factors for smpi.",
640         "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", NULL);
641     
642     xbt_cfg_register_string("smpi/IB_penalty_factors",
643         "Correction factor to communications using Infiniband model with contention (default value based on Stampede cluster profiling)",
644         "0.965;0.925;1.35", NULL);
645     
646 #if HAVE_SMPI
647     xbt_cfg_register_double("smpi/running_power", "Power of the host running the simulation (in flop/s). Used to bench the operations.", 20000.0, NULL);
648     xbt_cfg_register_boolean("smpi/display_timing", "Whether we should display the timing after simulation.", "no", NULL);
649     xbt_cfg_register_boolean("smpi/simulate_computation", "Whether the computational part of the simulated application should be simulated.", "yes", NULL);
650     xbt_cfg_register_boolean("smpi/use_shared_malloc", "Whether SMPI_SHARED_MALLOC is enabled. Disable it for debugging purposes.", "yes", NULL);
651     xbt_cfg_register_double("smpi/cpu_threshold", "Minimal computation time (in seconds) not discarded, or -1 for infinity.", 1e-6, NULL);
652     xbt_cfg_register_int("smpi/async_small_thresh", "Maximal size of messages that are to be sent asynchronously, without waiting for the receiver",
653         0, NULL);
654     xbt_cfg_register_int("smpi/send_is_detached_thresh", "Threshold of message size where MPI_Send stops behaving like MPI_Isend and becomes MPI_Ssend",
655         65536, NULL);
656
657     xbt_cfg_register_boolean("smpi/privatize_global_variables", "Whether we should privatize global variable at runtime.", "no", NULL);
658     xbt_cfg_register_string("smpi/os",  "Small messages timings (MPI_Send minimum time for small messages)", "1:0:0:0:0", NULL);
659     xbt_cfg_register_string("smpi/ois", "Small messages timings (MPI_Isend minimum time for small messages)", "1:0:0:0:0", NULL);
660     xbt_cfg_register_string("smpi/or",  "Small messages timings (MPI_Recv minimum time for small messages)", "1:0:0:0:0", NULL);
661     xbt_cfg_register_double("smpi/iprobe", "Minimum time to inject inside a call to MPI_Iprobe", 1e-4, _sg_cfg_cb__iprobe_sleep);
662     xbt_cfg_register_double("smpi/test", "Minimum time to inject inside a call to MPI_Test", 1e-4, _sg_cfg_cb__test_sleep);
663     xbt_cfg_register_double("smpi/wtime", "Minimum time to inject inside a call to MPI_Wtime", 0.0, _sg_cfg_cb__wtime_sleep);
664
665     xbt_cfg_register_string("smpi/coll_selector",  "Which collective selector to use", "default", NULL);
666     xbt_cfg_register_string("smpi/gather",         "Which collective to use for gather", nullptr, &_check_coll_gather);
667     xbt_cfg_register_string("smpi/allgather",      "Which collective to use for allgather", nullptr, &_check_coll_allgather);
668     xbt_cfg_register_string("smpi/barrier",        "Which collective to use for barrier", nullptr, &_check_coll_barrier);
669     xbt_cfg_register_string("smpi/reduce_scatter", "Which collective to use for reduce_scatter", nullptr, &_check_coll_reduce_scatter);
670     xbt_cfg_register_string("smpi/scatter",        "Which collective to use for scatter", nullptr, &_check_coll_scatter);
671     xbt_cfg_register_string("smpi/allgatherv",     "Which collective to use for allgatherv", nullptr, &_check_coll_allgatherv);
672     xbt_cfg_register_string("smpi/allreduce",      "Which collective to use for allreduce", nullptr, &_check_coll_allreduce);
673     xbt_cfg_register_string("smpi/alltoall",       "Which collective to use for alltoall", nullptr, &_check_coll_alltoall);
674     xbt_cfg_register_string("smpi/alltoallv",      "Which collective to use for alltoallv", nullptr, &_check_coll_alltoallv);
675     xbt_cfg_register_string("smpi/bcast",          "Which collective to use for bcast", nullptr, &_check_coll_bcast);
676     xbt_cfg_register_string("smpi/reduce",         "Which collective to use for reduce", nullptr, &_check_coll_reduce);
677 #endif // HAVE_SMPI
678
679     xbt_cfg_register_boolean("exception/cutpath", "Whether to cut all path information from call traces, used e.g. in exceptions.", "no", NULL);
680
681     xbt_cfg_register_boolean("clean_atexit", "Whether to cleanup SimGrid at exit. Disable it if your code segfaults at ending.",
682                      "yes", _sg_cfg_cb_clean_atexit);
683
684     if (!surf_path) {
685       /* retrieves the current directory of the current process */
686       const char *initial_path = __surf_get_initial_path();
687       xbt_assert((initial_path), "__surf_get_initial_path() failed! Can't resolve current Windows directory");
688
689       surf_path = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
690       xbt_cfg_setdefault_string("path", initial_path);
691     }
692
693     _sg_cfg_init_status = 1;
694
695     sg_config_cmd_line(argc, argv);
696
697     xbt_mallocator_initialization_is_done(SIMIX_context_is_parallel());
698   } else {
699     XBT_WARN("Call to sg_config_init() after initialization ignored");
700   }
701 }
702
703 void sg_config_finalize(void)
704 {
705   if (!_sg_cfg_init_status)
706     return;                     /* Not initialized yet. Nothing to do */
707
708   xbt_cfg_free(&simgrid_config);
709   _sg_cfg_init_status = 0;
710 }
711
712 int sg_cfg_is_default_value(const char *name)
713 {
714   return xbt_cfg_is_default_value(name);
715 }
716
717 int sg_cfg_get_int(const char* name)
718 {
719   return xbt_cfg_get_int(name);
720 }
721
722 double sg_cfg_get_double(const char* name)
723 {
724   return xbt_cfg_get_double(name);
725 }
726
727 char* sg_cfg_get_string(const char* name)
728 {
729   return xbt_cfg_get_string(name);
730 }
731
732 int sg_cfg_get_boolean(const char* name)
733 {
734   return xbt_cfg_get_boolean(name);
735 }
736
737 xbt_dynar_t sg_cfg_get_dynar(const char* name)
738 {
739   return xbt_cfg_get_dynar(name);
740 }