Logo AND Algorithmique Numérique Distribuée

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