Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge 'master' into mc
[simgrid.git] / src / simgrid / sg_config.c
1 /* Copyright (c) 2009-2010, 2012-2014. 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 "smpi/smpi_interface.h"
22 #include "mc/mc.h"
23 #include "instr/instr.h"
24
25 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_config, surf,
26                                 "About the configuration of simgrid");
27
28 xbt_cfg_t _sg_cfg_set = NULL;
29
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!)
35  */
36 int _sg_cfg_init_status = 0;
37
38 /* instruct the upper layer (simix or simdag) to exit as soon as possible
39  */
40 int _sg_cfg_exit_asap = 0;
41
42 #define sg_cfg_exit_early() do { _sg_cfg_exit_asap = 1; return; } while (0)
43
44 /* Parse the command line, looking for options */
45 static void sg_config_cmd_line(int *argc, char **argv)
46 {
47   int shall_exit = 0;
48   int i, j;
49   char *opt;
50
51   for (j = i = 1; i < *argc; i++) {
52     if (!strncmp(argv[i], "--cfg=", strlen("--cfg="))) {
53       opt = strchr(argv[i], '=');
54       opt++;
55
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);
60       shall_exit = 1;
61     } else if (!strcmp(argv[i], "--cfg-help") || !strcmp(argv[i], "--help")) {
62       printf
63           ("Description of the configuration accepted by this simulator:\n");
64       xbt_cfg_help(_sg_cfg_set);
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 "You can also use --help-models to see the details of all models known by this simulator.\n"
72 #ifdef HAVE_TRACING
73 "\n"
74 "You can also use --help-tracing to see the details of all tracing options known by this simulator.\n"
75 #endif
76 "\n"
77 "You can also use --help-logs and --help-log-categories to see the details of logging output.\n"
78 "\n"
79 "You can also use --version to get SimGrid version information.\n"
80 "\n"
81         );
82       shall_exit = 1;
83     } else if (!strcmp(argv[i], "--help-models")) {
84       int k;
85
86       model_help("workstation", surf_workstation_model_description);
87       printf("\n");
88       model_help("CPU", surf_cpu_model_description);
89       printf("\n");
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++)
93         printf("  %s: %s\n",
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");
97       shall_exit = 1;
98 #ifdef HAVE_TRACING
99     } else if (!strcmp(argv[i], "--help-tracing")) {
100       TRACE_help (1);
101       shall_exit = 1;
102 #endif
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   char *val;
119
120   XBT_VERB("PLUGIN");
121   xbt_assert(_sg_cfg_init_status < 2,
122               "Cannot load a plugin after the initialization");
123
124   val = xbt_cfg_get_string(_sg_cfg_set, name);
125
126   if (!strcmp(val, "help")) {
127     model_help("plugin", surf_plugin_description);
128     sg_cfg_exit_early();
129   }
130
131   /* New Module missing */
132   int plugin_id = find_model_description(surf_plugin_description, val);
133   surf_plugin_description[plugin_id].model_init_preparse();
134 }
135
136 /* callback of the workstation/model variable */
137 static void _sg_cfg_cb__workstation_model(const char *name, int pos)
138 {
139   char *val;
140
141   xbt_assert(_sg_cfg_init_status < 2,
142               "Cannot change the model after the initialization");
143
144   val = xbt_cfg_get_string(_sg_cfg_set, name);
145
146   if (!strcmp(val, "help")) {
147     model_help("workstation", surf_workstation_model_description);
148     sg_cfg_exit_early();
149   }
150
151   /* Make sure that the model exists */
152   find_model_description(surf_workstation_model_description, val);
153 }
154
155 /* callback of the vm_workstation/model variable */
156 static void _sg_cfg_cb__vm_workstation_model(const char *name, int pos)
157 {
158   char *val;
159
160   xbt_assert(_sg_cfg_init_status < 2,
161               "Cannot change the model after the initialization");
162
163   val = xbt_cfg_get_string(_sg_cfg_set, name);
164
165   if (!strcmp(val, "help")) {
166     model_help("vm_workstation", surf_vm_workstation_model_description);
167     sg_cfg_exit_early();
168   }
169
170   /* Make sure that the model exists */
171   find_model_description(surf_vm_workstation_model_description, val);
172 }
173
174 /* callback of the cpu/model variable */
175 static void _sg_cfg_cb__cpu_model(const char *name, int pos)
176 {
177   char *val;
178
179   xbt_assert(_sg_cfg_init_status < 2,
180               "Cannot change the model after the initialization");
181
182   val = xbt_cfg_get_string(_sg_cfg_set, name);
183
184   if (!strcmp(val, "help")) {
185     model_help("CPU", surf_cpu_model_description);
186     sg_cfg_exit_early();
187   }
188
189   /* New Module missing */
190   find_model_description(surf_cpu_model_description, val);
191 }
192
193 /* callback of the cpu/model variable */
194 static void _sg_cfg_cb__optimization_mode(const char *name, int pos)
195 {
196   char *val;
197
198   xbt_assert(_sg_cfg_init_status < 2,
199               "Cannot change the model after the initialization");
200
201   val = xbt_cfg_get_string(_sg_cfg_set, name);
202
203   if (!strcmp(val, "help")) {
204     model_help("optimization", surf_optimization_mode_description);
205     sg_cfg_exit_early();
206   }
207
208   /* New Module missing */
209   find_model_description(surf_optimization_mode_description, val);
210 }
211
212 /* callback of the cpu/model variable */
213 static void _sg_cfg_cb__storage_mode(const char *name, int pos)
214 {
215   char *val;
216
217   xbt_assert(_sg_cfg_init_status < 2,
218               "Cannot change the model after the initialization");
219
220   val = xbt_cfg_get_string(_sg_cfg_set, name);
221
222   if (!strcmp(val, "help")) {
223     model_help("storage", surf_storage_model_description);
224     sg_cfg_exit_early();
225   }
226
227   /* New Module missing */
228   find_model_description(surf_storage_model_description, val);
229 }
230
231 /* callback of the workstation_model variable */
232 static void _sg_cfg_cb__network_model(const char *name, int pos)
233 {
234   char *val;
235
236   xbt_assert(_sg_cfg_init_status < 2,
237               "Cannot change the model after the initialization");
238
239   val = xbt_cfg_get_string(_sg_cfg_set, name);
240
241   if (!strcmp(val, "help")) {
242     model_help("network", surf_network_model_description);
243     sg_cfg_exit_early();
244   }
245
246   /* New Module missing */
247   find_model_description(surf_network_model_description, val);
248 }
249
250 /* callbacks of the network models values */
251 static void _sg_cfg_cb__tcp_gamma(const char *name, int pos)
252 {
253   sg_tcp_gamma = xbt_cfg_get_double(_sg_cfg_set, name);
254 }
255
256 static void _sg_cfg_cb__maxmin_precision(const char* name, int pos)
257 {
258   sg_maxmin_precision = xbt_cfg_get_double(_sg_cfg_set, name);
259 }
260
261 static void _sg_cfg_cb__sender_gap(const char* name, int pos)
262 {
263   sg_sender_gap = xbt_cfg_get_double(_sg_cfg_set, name);
264 }
265
266 static void _sg_cfg_cb__latency_factor(const char *name, int pos)
267 {
268   sg_latency_factor = xbt_cfg_get_double(_sg_cfg_set, name);
269 }
270
271 static void _sg_cfg_cb__bandwidth_factor(const char *name, int pos)
272 {
273   sg_bandwidth_factor = xbt_cfg_get_double(_sg_cfg_set, name);
274 }
275
276 static void _sg_cfg_cb__weight_S(const char *name, int pos)
277 {
278   sg_weight_S_parameter = xbt_cfg_get_double(_sg_cfg_set, name);
279 }
280
281 #ifdef HAVE_SMPI
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)
286 {
287   char *val;
288
289   xbt_assert(_sg_cfg_init_status < 2,
290               "Cannot change the model after the initialization");
291
292   val = xbt_cfg_get_string(_sg_cfg_set, name);
293
294   if (!strcmp(val, "help")) {
295     coll_help(category, table);
296     sg_cfg_exit_early();
297   }
298
299   /* New Module missing */
300   find_coll_description(table, val);
301 }
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);
304 }
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);
307 }
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);
310 }
311 static void _sg_cfg_cb__coll_allreduce(const char *name, int pos)
312 {
313   _sg_cfg_cb__coll("allreduce", mpi_coll_allreduce_description, name, pos);
314 }
315 static void _sg_cfg_cb__coll_alltoall(const char *name, int pos)
316 {
317   _sg_cfg_cb__coll("alltoall", mpi_coll_alltoall_description, name, pos);
318 }
319 static void _sg_cfg_cb__coll_alltoallv(const char *name, int pos)
320 {
321   _sg_cfg_cb__coll("alltoallv", mpi_coll_alltoallv_description, name, pos);
322 }
323 static void _sg_cfg_cb__coll_bcast(const char *name, int pos)
324 {
325   _sg_cfg_cb__coll("bcast", mpi_coll_bcast_description, name, pos);
326 }
327 static void _sg_cfg_cb__coll_reduce(const char *name, int pos)
328 {
329   _sg_cfg_cb__coll("reduce", mpi_coll_reduce_description, name, pos);
330 }
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);
333 }
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);
336 }
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);
339 }
340 #endif
341
342 /* callback of the inclusion path */
343 static void _sg_cfg_cb__surf_path(const char *name, int pos)
344 {
345   char *path = xbt_cfg_get_string_at(_sg_cfg_set, name, pos);
346   xbt_dynar_push(surf_path, &path);
347 }
348
349 /* callback to decide if we want to use the model-checking */
350 #include "xbt_modinter.h"
351 #ifdef HAVE_MC
352 extern int _sg_do_model_check;   /* this variable lives in xbt_main until I find a right location for it */
353 #endif
354
355 static void _sg_cfg_cb_model_check(const char *name, int pos)
356 {
357 #ifdef HAVE_MC
358   _sg_do_model_check = xbt_cfg_get_boolean(_sg_cfg_set, name);
359 #else
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");
362   }
363 #endif
364 }
365
366 extern int _sg_do_verbose_exit;
367
368 static void _sg_cfg_cb_verbose_exit(const char *name, int pos)
369 {
370   _sg_do_verbose_exit = xbt_cfg_get_boolean(_sg_cfg_set, name);
371 }
372
373 extern int _sg_do_clean_atexit;
374
375 static void _sg_cfg_cb_clean_atexit(const char *name, int pos)
376 {
377   _sg_do_clean_atexit = xbt_cfg_get_boolean(_sg_cfg_set, name);
378 }
379
380 static void _sg_cfg_cb_context_factory(const char *name, int pos)
381 {
382   smx_context_factory_name = xbt_cfg_get_string(_sg_cfg_set, name);
383 }
384
385 static void _sg_cfg_cb_context_stack_size(const char *name, int pos)
386 {
387   smx_context_stack_size_was_set = 1;
388   smx_context_stack_size = xbt_cfg_get_int(_sg_cfg_set, name) * 1024;
389 }
390
391 static void _sg_cfg_cb_contexts_nthreads(const char *name, int pos)
392 {
393   SIMIX_context_set_nthreads(xbt_cfg_get_int(_sg_cfg_set, name));
394 }
395
396 static void _sg_cfg_cb_contexts_parallel_threshold(const char *name, int pos)
397 {
398   SIMIX_context_set_parallel_threshold(xbt_cfg_get_int(_sg_cfg_set, name));
399 }
400
401 static void _sg_cfg_cb_contexts_parallel_mode(const char *name, int pos)
402 {
403   const char* mode_name = xbt_cfg_get_string(_sg_cfg_set, name);
404   if (!strcmp(mode_name, "posix")) {
405     SIMIX_context_set_parallel_mode(XBT_PARMAP_POSIX);
406   }
407   else if (!strcmp(mode_name, "futex")) {
408     SIMIX_context_set_parallel_mode(XBT_PARMAP_FUTEX);
409   }
410   else if (!strcmp(mode_name, "busy_wait")) {
411     SIMIX_context_set_parallel_mode(XBT_PARMAP_BUSY_WAIT);
412   }
413   else {
414     xbt_die("Command line setting of the parallel synchronization mode should "
415             "be one of \"posix\", \"futex\" or \"busy_wait\"");
416   }
417 }
418
419 static void _sg_cfg_cb__surf_network_coordinates(const char *name,
420                                                  int pos)
421 {
422   int val = xbt_cfg_get_boolean(_sg_cfg_set, name);
423   if (val) {
424     if (!COORD_HOST_LEVEL) {
425       COORD_HOST_LEVEL = xbt_lib_add_level(host_lib,xbt_dynar_free_voidp);
426       COORD_ASR_LEVEL  = xbt_lib_add_level(as_router_lib,xbt_dynar_free_voidp);
427     }
428   } else
429     if (COORD_HOST_LEVEL)
430       xbt_die("Setting of whether to use coordinate cannot be disabled once set.");
431 }
432
433 static void _sg_cfg_cb__surf_network_crosstraffic(const char *name,
434                                                   int pos)
435 {
436   sg_network_crosstraffic = xbt_cfg_get_boolean(_sg_cfg_set, name);
437 }
438
439 #ifdef HAVE_GTNETS
440 static void _sg_cfg_cb__gtnets_jitter(const char *name, int pos)
441 {
442   sg_gtnets_jitter = xbt_cfg_get_double(_sg_cfg_set, name);
443 }
444
445 static void _sg_cfg_cb__gtnets_jitter_seed(const char *name, int pos)
446 {
447   sg_gtnets_jitter_seed = xbt_cfg_get_int(_sg_cfg_set, name);
448 }
449 #endif
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,
478                    "plugin", "The plugins");
479     xbt_cfg_register(&_sg_cfg_set, "plugin", description,
480                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__plugin, NULL);
481
482     describe_model(description, surf_cpu_model_description,
483                    "model", "The model to use for the CPU");
484     xbt_cfg_register(&_sg_cfg_set, "cpu/model", description,
485                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__cpu_model, NULL);
486     xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/model", "Cas01");
487
488     describe_model(description, surf_optimization_mode_description,
489                    "optimization mode",
490                    "The optimization modes to use for the CPU");
491     xbt_cfg_register(&_sg_cfg_set, "cpu/optim", description,
492                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode, NULL);
493     xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/optim", "Lazy");
494
495     describe_model(description, surf_storage_model_description,
496                    "model", "The model to use for the storage");
497     xbt_cfg_register(&_sg_cfg_set, "storage/model", description,
498                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__storage_mode, NULL);
499     xbt_cfg_setdefault_string(_sg_cfg_set, "storage/model", "default");
500
501     describe_model(description, surf_network_model_description,
502                    "model", "The model to use for the network");
503     xbt_cfg_register(&_sg_cfg_set, "network/model", description,
504                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__network_model, NULL);
505     xbt_cfg_setdefault_string(_sg_cfg_set, "network/model", "LV08");
506
507     describe_model(description, surf_optimization_mode_description,
508                    "optimization mode",
509                    "The optimization modes to use for the network");
510     xbt_cfg_register(&_sg_cfg_set, "network/optim", description,
511                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode, NULL);
512     xbt_cfg_setdefault_string(_sg_cfg_set, "network/optim", "Lazy");
513
514     describe_model(description, surf_workstation_model_description,
515                    "model", "The model to use for the workstation");
516     xbt_cfg_register(&_sg_cfg_set, "workstation/model", description,
517                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__workstation_model, NULL);
518     xbt_cfg_setdefault_string(_sg_cfg_set, "workstation/model", "default");
519
520     describe_model(description, surf_vm_workstation_model_description,
521                    "model", "The model to use for the vm workstation");
522     xbt_cfg_register(&_sg_cfg_set, "vm_workstation/model", description,
523                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__vm_workstation_model, NULL);
524     xbt_cfg_setdefault_string(_sg_cfg_set, "vm_workstation/model", "default");
525
526     xbt_cfg_register(&_sg_cfg_set, "network/TCP_gamma",
527                      "Size of the biggest TCP window (cat /proc/sys/net/ipv4/tcp_[rw]mem for recv/send window; Use the last given value, which is the max window size)",
528                      xbt_cfgelm_double, 1, 1, _sg_cfg_cb__tcp_gamma, NULL);
529     xbt_cfg_setdefault_double(_sg_cfg_set, "network/TCP_gamma", 4194304.0);
530
531     xbt_cfg_register(&_sg_cfg_set, "maxmin/precision",
532                      "Numerical precision used when updating simulation models (epsilon in double comparisons)",
533                      xbt_cfgelm_double, 1, 1, _sg_cfg_cb__maxmin_precision, NULL);
534     xbt_cfg_setdefault_double(_sg_cfg_set, "maxmin/precision", 0.00001);
535
536     /* The parameters of network models */
537
538     xbt_cfg_register(&_sg_cfg_set, "network/sender_gap",
539                      "Minimum gap between two overlapping sends",
540                      xbt_cfgelm_double, 1, 1, _sg_cfg_cb__sender_gap, NULL);
541     /* default for "network/sender_gap" is set in network.c */
542
543     xbt_cfg_register(&_sg_cfg_set, "network/latency_factor",
544                      "Correction factor to apply to the provided latency (default value set by network model)",
545                      xbt_cfgelm_double, 1, 1, _sg_cfg_cb__latency_factor, NULL);
546     xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 1.0);
547
548     xbt_cfg_register(&_sg_cfg_set, "network/bandwidth_factor",
549                      "Correction factor to apply to the provided bandwidth (default value set by network model)",
550                      xbt_cfgelm_double, 1, 1, _sg_cfg_cb__bandwidth_factor, NULL);
551     xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 1.0);
552
553     xbt_cfg_register(&_sg_cfg_set, "network/weight_S",
554                      "Correction factor to apply to the weight of competing streams (default value set by network model)",
555                      xbt_cfgelm_double, 1, 1, _sg_cfg_cb__weight_S, NULL);
556     /* default for "network/weight_S" is set in network.c */
557
558     /* Inclusion path */
559     xbt_cfg_register(&_sg_cfg_set, "path",
560                      "Lookup path for inclusions in platform and deployment XML files",
561                      xbt_cfgelm_string, 0, 0, _sg_cfg_cb__surf_path, NULL);
562
563     xbt_cfg_register(&_sg_cfg_set, "cpu/maxmin_selective_update",
564                      "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
565                      xbt_cfgelm_boolean, 0, 1, NULL, NULL);
566     xbt_cfg_setdefault_boolean(_sg_cfg_set, "cpu/maxmin_selective_update", "no");
567
568     xbt_cfg_register(&_sg_cfg_set, "network/maxmin_selective_update",
569                      "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
570                      xbt_cfgelm_boolean, 0, 1, NULL, NULL);
571     xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/maxmin_selective_update", "no");
572
573 #ifdef HAVE_MC
574     /* do model-checking */
575     xbt_cfg_register(&_sg_cfg_set, "model-check",
576                      "Verify the system through model-checking instead of simulating it (EXPERIMENTAL)",
577                      xbt_cfgelm_boolean, 0, 1, _sg_cfg_cb_model_check, NULL);
578     xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check", "no");
579
580     /* do stateful model-checking */
581     xbt_cfg_register(&_sg_cfg_set, "model-check/checkpoint",
582                      "Specify the amount of steps between checkpoints during stateful model-checking (default: 0 => stateless verification). "
583                      "If value=1, one checkpoint is saved for each step => faster verification, but huge memory consumption; higher values are good compromises between speed and memory consumption.",
584                      xbt_cfgelm_int, 0, 1, _mc_cfg_cb_checkpoint, NULL);
585     xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/checkpoint", 0);
586
587     /* do liveness model-checking */
588     xbt_cfg_register(&_sg_cfg_set, "model-check/property",
589                      "Specify the name of the file containing the property. It must be the result of the ltl2ba program.",
590                      xbt_cfgelm_string, 0, 1, _mc_cfg_cb_property, NULL);
591     xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/property", "");
592
593     /* do determinism model-checking */
594         xbt_cfg_register(&_sg_cfg_set, "model-check/communications_determinism",
595                      "Enable/disable the detection of determinism in the communications schemes",
596                      xbt_cfgelm_boolean, 0, 1, _mc_cfg_cb_comms_determinism, NULL);
597     xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/communications_determinism", "no");
598
599     /* Specify the kind of model-checking reduction */
600     xbt_cfg_register(&_sg_cfg_set, "model-check/reduction",
601                      "Specify the kind of exploration reduction (either none or DPOR)",
602                      xbt_cfgelm_string, 0, 1, _mc_cfg_cb_reduce, NULL);
603     xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/reduction", "dpor");
604
605     /* Enable/disable timeout for wait requests with model-checking */
606     xbt_cfg_register(&_sg_cfg_set, "model-check/timeout",
607                      "Enable/Disable timeout for wait requests",
608                      xbt_cfgelm_boolean, 0, 1, _mc_cfg_cb_timeout, NULL);
609     xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/timeout", "no");
610
611     /* Enable/disable global hash computation with model-checking */
612     xbt_cfg_register(&_sg_cfg_set, "model-check/hash",
613                      "Enable/Disable state hash for state comparison",
614                      xbt_cfgelm_boolean, 0, 1, _mc_cfg_cb_hash, NULL);
615     xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/hash", "no");
616
617     /* Set max depth exploration */
618     xbt_cfg_register(&_sg_cfg_set, "model-check/max_depth",
619                      "Specify the max depth of exploration (default : 1000)",
620                      xbt_cfgelm_int, 0, 1, _mc_cfg_cb_max_depth, NULL);
621     xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/max_depth", 1000);
622
623     /* Set number of visited state stored for state comparison reduction*/
624     xbt_cfg_register(&_sg_cfg_set, "model-check/visited",
625                      "Specify the number of visited state stored for state comparison reduction. If value=5, the last 5 visited states are stored",
626                      xbt_cfgelm_int, 0, 1, _mc_cfg_cb_visited, NULL);
627     xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/visited", 0);
628
629     /* Set file name for dot output of graph state */
630     xbt_cfg_register(&_sg_cfg_set, "model-check/dot_output",
631                      "Specify the name of dot file corresponding to graph state",
632                      xbt_cfgelm_string, 0, 1, _mc_cfg_cb_dot_output, NULL);
633     xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/dot_output", "");
634 #endif
635
636     /* do verbose-exit */
637     xbt_cfg_register(&_sg_cfg_set, "verbose-exit",
638                      "Activate the \"do nothing\" mode in Ctrl-C",
639                      xbt_cfgelm_boolean, 0, 1, _sg_cfg_cb_verbose_exit, NULL);
640     xbt_cfg_setdefault_boolean(_sg_cfg_set, "verbose-exit", "yes");
641
642     /* context factory */
643     const char *dflt_ctx_fact = "thread";
644     {
645       char *p = description +
646         sprintf(description,
647                 "Context factory to use in SIMIX. Possible values: %s",
648                 dflt_ctx_fact);
649 #ifdef CONTEXT_UCONTEXT
650       dflt_ctx_fact = "ucontext";
651       p += sprintf(p, ", %s", dflt_ctx_fact);
652 #endif
653 #ifdef HAVE_RAWCTX
654       dflt_ctx_fact = "raw";
655       p += sprintf(p, ", %s", dflt_ctx_fact);
656 #endif
657       sprintf(p, ".");
658     }
659     xbt_cfg_register(&_sg_cfg_set, "contexts/factory", description,
660                      xbt_cfgelm_string, 1, 1, _sg_cfg_cb_context_factory, NULL);
661     xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/factory", dflt_ctx_fact);
662
663     /* stack size of contexts in Ko */
664     xbt_cfg_register(&_sg_cfg_set, "contexts/stack_size",
665                      "Stack size of contexts in Kib",
666                      xbt_cfgelm_int, 1, 1, _sg_cfg_cb_context_stack_size, NULL);
667     xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/stack_size", 128);
668     /* No, it was not set yet (the above setdefault() changed this to 1). */
669     smx_context_stack_size_was_set = 0;
670
671     /* number of parallel threads for user processes */
672     xbt_cfg_register(&_sg_cfg_set, "contexts/nthreads",
673                      "Number of parallel threads used to execute user contexts",
674                      xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_nthreads, NULL);
675     xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/nthreads", 1);
676
677     /* minimal number of user contexts to be run in parallel */
678     xbt_cfg_register(&_sg_cfg_set, "contexts/parallel_threshold",
679                      "Minimal number of user contexts to be run in parallel (raw contexts only)",
680                      xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_parallel_threshold, NULL);
681     xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/parallel_threshold", 2);
682
683     /* synchronization mode for parallel user contexts */
684     xbt_cfg_register(&_sg_cfg_set, "contexts/synchro",
685                      "Synchronization mode to use when running contexts in parallel (either futex, posix or busy_wait)",
686                      xbt_cfgelm_string, 1, 1, _sg_cfg_cb_contexts_parallel_mode, NULL);
687 #ifdef HAVE_FUTEX_H
688     xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "futex");
689 #else //No futex on mac and posix is unimplememted yet
690     xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "busy_wait");
691 #endif
692
693     xbt_cfg_register(&_sg_cfg_set, "network/coordinates",
694                      "\"yes\" or \"no\", specifying whether we use a coordinate-based routing (as Vivaldi)",
695                      xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb__surf_network_coordinates, NULL);
696     xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/coordinates", "no");
697
698     xbt_cfg_register(&_sg_cfg_set, "network/crosstraffic",
699                      "Activate the interferences between uploads and downloads for fluid max-min models (LV08, CM02)",
700                      xbt_cfgelm_boolean, 0, 1, _sg_cfg_cb__surf_network_crosstraffic, NULL);
701     xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/crosstraffic", "no");
702
703 #ifdef HAVE_GTNETS
704     xbt_cfg_register(&_sg_cfg_set, "gtnets/jitter",
705                      "Double value to oscillate the link latency, uniformly in random interval [-latency*gtnets_jitter,latency*gtnets_jitter)",
706                      xbt_cfgelm_double, 1, 1, _sg_cfg_cb__gtnets_jitter, NULL);
707     xbt_cfg_setdefault_double(_sg_cfg_set, "gtnets/jitter", 0.0);
708
709     xbt_cfg_register(&_sg_cfg_set, "gtnets/jitter_seed",
710                      "Use a positive seed to reproduce jitted results, value must be in [1,1e8], default is 10",
711                      xbt_cfgelm_int, 0, 1, _sg_cfg_cb__gtnets_jitter_seed, NULL);
712     xbt_cfg_setdefault_int(_sg_cfg_set, "gtnets/jitter_seed", 10);
713 #endif
714 #ifdef HAVE_NS3
715     xbt_cfg_register(&_sg_cfg_set, "ns3/TcpModel",
716                      "The ns3 tcp model can be : NewReno or Reno or Tahoe",
717                      xbt_cfgelm_string, 1, 1, NULL, NULL);
718     xbt_cfg_setdefault_string(_sg_cfg_set, "ns3/TcpModel", "default");
719 #endif
720
721 #ifdef HAVE_SMPI
722     xbt_cfg_register(&_sg_cfg_set, "smpi/running_power",
723                      "Power of the host running the simulation (in flop/s). Used to bench the operations.",
724                      xbt_cfgelm_double, 1, 1, NULL, NULL);
725     xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/running_power", 20000.0);
726
727     xbt_cfg_register(&_sg_cfg_set, "smpi/display_timing",
728                      "Boolean indicating whether we should display the timing after simulation.",
729                      xbt_cfgelm_boolean, 1, 1, NULL, NULL);
730     xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/display_timing", "no");
731
732     xbt_cfg_register(&_sg_cfg_set, "smpi/use_shared_malloc",
733                      "Boolean indicating whether we should use shared memory when using SMPI_SHARED_MALLOC. Allows user to disable it for debug purposes.",
734                      xbt_cfgelm_boolean, 1, 1, NULL, NULL);
735     xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/use_shared_malloc", "yes");
736
737     xbt_cfg_register(&_sg_cfg_set, "smpi/cpu_threshold",
738                      "Minimal computation time (in seconds) not discarded, or -1 for infinity.",
739                      xbt_cfgelm_double, 1, 1, NULL, NULL);
740     xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/cpu_threshold", 1e-6);
741
742     xbt_cfg_register(&_sg_cfg_set, "smpi/async_small_thres",
743                      "Maximal size of messages that are to be sent asynchronously, without waiting for the receiver",
744                      xbt_cfgelm_int, 1, 1, NULL, NULL);
745     xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/async_small_thres", 0);
746
747     xbt_cfg_register(&_sg_cfg_set, "smpi/send_is_detached_thres",
748                      "Threshold of message size where MPI_Send stops behaving like MPI_Isend and becomes MPI_Ssend",
749                      xbt_cfgelm_int, 1, 1, NULL, NULL);
750     xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/send_is_detached_thres", 65536);
751
752     //For smpi/bw_factor and smpi/lat_factor
753     //Default value have to be "threshold0:value0;threshold1:value1;...;thresholdN:valueN"
754     //test is if( size >= thresholdN ) return valueN;
755     //Values can be modified with command line --cfg=smpi/bw_factor:"threshold0:value0;threshold1:value1;...;thresholdN:valueN"
756     //  or with tag config put line <prop id="smpi/bw_factor" value="threshold0:value0;threshold1:value1;...;thresholdN:valueN"></prop>
757     xbt_cfg_register(&_sg_cfg_set, "smpi/bw_factor",
758                      "Bandwidth factors for smpi.",
759                      xbt_cfgelm_string, 1, 1, NULL, NULL);
760     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");
761
762     xbt_cfg_register(&_sg_cfg_set, "smpi/lat_factor",
763                      "Latency factors for smpi.",
764                      xbt_cfgelm_string, 1, 1, NULL, NULL);
765     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");
766
767     xbt_cfg_register(&_sg_cfg_set, "smpi/os",
768                      "Small messages timings (MPI_Send minimum time for small messages)",
769                      xbt_cfgelm_string, 1, 1, NULL, NULL);
770     xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/os", "1:0:0:0:0");
771
772     xbt_cfg_register(&_sg_cfg_set, "smpi/ois",
773                      "Small messages timings (MPI_Isend minimum time for small messages)",
774                      xbt_cfgelm_string, 1, 1, NULL, NULL);
775     xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/ois", "1:0:0:0:0");
776
777     xbt_cfg_register(&_sg_cfg_set, "smpi/or",
778                      "Small messages timings (MPI_Recv minimum time for small messages)",
779                      xbt_cfgelm_string, 1, 1, NULL, NULL);
780     xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/or", "1:0:0:0:0");
781     xbt_cfg_register(&_sg_cfg_set, "smpi/iprobe",
782                      "Minimum time to inject inside a call to MPI_Iprobe",
783                      xbt_cfgelm_double, 1, 1, NULL, NULL);
784     xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/iprobe", 1e-4);
785     xbt_cfg_register(&_sg_cfg_set, "smpi/coll_selector",
786                      "Which collective selector to use",
787                      xbt_cfgelm_string, 1, 1, NULL, NULL);
788     xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/coll_selector", "default");
789
790     xbt_cfg_register(&_sg_cfg_set, "smpi/gather",
791                      "Which collective to use for gather",
792                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_gather, NULL);
793
794     xbt_cfg_register(&_sg_cfg_set, "smpi/allgather",
795                      "Which collective to use for allgather",
796                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_allgather, NULL);
797
798     xbt_cfg_register(&_sg_cfg_set, "smpi/barrier",
799                      "Which collective to use for barrier",
800                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_barrier, NULL);
801
802     xbt_cfg_register(&_sg_cfg_set, "smpi/reduce_scatter",
803                      "Which collective to use for reduce_scatter",
804                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_reduce_scatter, NULL);
805
806     xbt_cfg_register(&_sg_cfg_set, "smpi/scatter",
807                      "Which collective to use for scatter",
808                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_scatter, NULL);
809
810     xbt_cfg_register(&_sg_cfg_set, "smpi/allgatherv",
811                      "Which collective to use for allgatherv",
812                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_allgatherv, NULL);
813
814     xbt_cfg_register(&_sg_cfg_set, "smpi/allreduce",
815                      "Which collective to use for allreduce",
816                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_allreduce, NULL);
817
818     xbt_cfg_register(&_sg_cfg_set, "smpi/alltoall",
819                      "Which collective to use for alltoall",
820                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_alltoall, NULL);
821
822     xbt_cfg_register(&_sg_cfg_set, "smpi/alltoallv",
823                      "Which collective to use for alltoallv",
824                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_alltoallv, NULL);
825
826     xbt_cfg_register(&_sg_cfg_set, "smpi/bcast",
827                      "Which collective to use for bcast",
828                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_bcast, NULL);
829
830     xbt_cfg_register(&_sg_cfg_set, "smpi/reduce",
831                      "Which collective to use for reduce",
832                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_reduce, NULL);
833 #endif // HAVE_SMPI
834
835     xbt_cfg_register(&_sg_cfg_set, "clean_atexit",
836                      "\"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.",
837                      xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_clean_atexit, NULL);
838     xbt_cfg_setdefault_boolean(_sg_cfg_set, "clean_atexit", "yes");
839
840     if (!surf_path) {
841       /* retrieves the current directory of the current process */
842       const char *initial_path = __surf_get_initial_path();
843       xbt_assert((initial_path),
844                   "__surf_get_initial_path() failed! Can't resolves current Windows directory");
845
846       surf_path = xbt_dynar_new(sizeof(char *), NULL);
847       xbt_cfg_setdefault_string(_sg_cfg_set, "path", initial_path);
848     }
849
850     _sg_cfg_init_status = 1;
851
852     sg_config_cmd_line(argc, argv);
853
854     xbt_mallocator_initialization_is_done(SIMIX_context_is_parallel());
855
856   } else {
857     XBT_WARN("Call to sg_config_init() after initialization ignored");
858   }
859 }
860
861 void sg_config_finalize(void)
862 {
863   if (!_sg_cfg_init_status)
864     return;                     /* Not initialized yet. Nothing to do */
865
866   xbt_cfg_free(&_sg_cfg_set);
867   _sg_cfg_init_status = 0;
868 }
869
870 /* Pick the right models for CPU, net and workstation, and call their model_init_preparse */
871 void surf_config_models_setup()
872 {
873   const char *workstation_model_name;
874   const char *vm_workstation_model_name;
875   int workstation_id = -1;
876   int vm_workstation_id = -1;
877   char *network_model_name = NULL;
878   char *cpu_model_name = NULL;
879   int storage_id = -1;
880   char *storage_model_name = NULL;
881
882   workstation_model_name =
883       xbt_cfg_get_string(_sg_cfg_set, "workstation/model");
884   vm_workstation_model_name =
885       xbt_cfg_get_string(_sg_cfg_set, "vm_workstation/model");
886   network_model_name = xbt_cfg_get_string(_sg_cfg_set, "network/model");
887   cpu_model_name = xbt_cfg_get_string(_sg_cfg_set, "cpu/model");
888   storage_model_name = xbt_cfg_get_string(_sg_cfg_set, "storage/model");
889
890   /* Check whether we use a net/cpu model differing from the default ones, in which case
891    * we should switch to the "compound" workstation model to correctly dispatch stuff to
892    * the right net/cpu models.
893    */
894
895   if ((!xbt_cfg_is_default_value(_sg_cfg_set, "network/model") ||
896        !xbt_cfg_is_default_value(_sg_cfg_set, "cpu/model")) &&
897       xbt_cfg_is_default_value(_sg_cfg_set, "workstation/model")) {
898     XBT_INFO("Switching workstation model to compound since you changed the network and/or cpu model(s)");
899     workstation_model_name = "compound";
900     xbt_cfg_set_string(_sg_cfg_set, "workstation/model", workstation_model_name);
901   }
902
903   XBT_DEBUG("Workstation model: %s", workstation_model_name);
904   workstation_id =
905       find_model_description(surf_workstation_model_description,
906                              workstation_model_name);
907   if (!strcmp(workstation_model_name, "compound")) {
908     int network_id = -1;
909     int cpu_id = -1;
910
911     xbt_assert(cpu_model_name,
912                 "Set a cpu model to use with the 'compound' workstation model");
913
914     xbt_assert(network_model_name,
915                 "Set a network model to use with the 'compound' workstation model");
916
917     network_id =
918         find_model_description(surf_network_model_description,
919                                network_model_name);
920     cpu_id =
921         find_model_description(surf_cpu_model_description, cpu_model_name);
922
923     surf_cpu_model_description[cpu_id].model_init_preparse();
924     surf_network_model_description[network_id].model_init_preparse();
925   }
926
927   XBT_DEBUG("Call workstation_model_init");
928   surf_workstation_model_description[workstation_id].model_init_preparse();
929
930   XBT_DEBUG("Call vm_workstation_model_init");
931   vm_workstation_id = find_model_description(surf_vm_workstation_model_description,
932                                           vm_workstation_model_name);
933   surf_vm_workstation_model_description[vm_workstation_id].model_init_preparse();
934
935   XBT_DEBUG("Call storage_model_init");
936   storage_id = find_model_description(surf_storage_model_description, storage_model_name);
937   surf_storage_model_description[storage_id].model_init_preparse();
938
939 }
940
941 int sg_cfg_is_default_value(const char *name)
942 {
943   return xbt_cfg_is_default_value(_sg_cfg_set, name);
944 }
945
946 int sg_cfg_get_int(const char* name)
947 {
948   return xbt_cfg_get_int(_sg_cfg_set, name);
949 }
950
951 double sg_cfg_get_double(const char* name)
952 {
953   return xbt_cfg_get_double(_sg_cfg_set, name);
954 }
955
956 char* sg_cfg_get_string(const char* name)
957 {
958   return xbt_cfg_get_string(_sg_cfg_set, name);
959 }
960
961 int sg_cfg_get_boolean(const char* name)
962 {
963   return xbt_cfg_get_boolean(_sg_cfg_set, name);
964 }
965
966 void sg_cfg_get_peer(const char *name, char **peer, int *port)
967 {
968   xbt_cfg_get_peer(_sg_cfg_set, name, peer, port);
969 }
970
971 xbt_dynar_t sg_cfg_get_dynar(const char* name)
972 {
973   return xbt_cfg_get_dynar(_sg_cfg_set, name);
974 }