Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add a first draft for automatic privatization of global variables for smpi.
[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_context_guard_size(const char *name, int pos)
392 {
393   smx_context_guard_size_was_set = 1;
394   smx_context_guard_size = xbt_cfg_get_int(_sg_cfg_set, name) * xbt_pagesize;
395 }
396
397 static void _sg_cfg_cb_contexts_nthreads(const char *name, int pos)
398 {
399   SIMIX_context_set_nthreads(xbt_cfg_get_int(_sg_cfg_set, name));
400 }
401
402 static void _sg_cfg_cb_contexts_parallel_threshold(const char *name, int pos)
403 {
404   SIMIX_context_set_parallel_threshold(xbt_cfg_get_int(_sg_cfg_set, name));
405 }
406
407 static void _sg_cfg_cb_contexts_parallel_mode(const char *name, int pos)
408 {
409   const char* mode_name = xbt_cfg_get_string(_sg_cfg_set, name);
410   if (!strcmp(mode_name, "posix")) {
411     SIMIX_context_set_parallel_mode(XBT_PARMAP_POSIX);
412   }
413   else if (!strcmp(mode_name, "futex")) {
414     SIMIX_context_set_parallel_mode(XBT_PARMAP_FUTEX);
415   }
416   else if (!strcmp(mode_name, "busy_wait")) {
417     SIMIX_context_set_parallel_mode(XBT_PARMAP_BUSY_WAIT);
418   }
419   else {
420     xbt_die("Command line setting of the parallel synchronization mode should "
421             "be one of \"posix\", \"futex\" or \"busy_wait\"");
422   }
423 }
424
425 static void _sg_cfg_cb__surf_network_coordinates(const char *name,
426                                                  int pos)
427 {
428   int val = xbt_cfg_get_boolean(_sg_cfg_set, name);
429   if (val) {
430     if (!COORD_HOST_LEVEL) {
431       COORD_HOST_LEVEL = xbt_lib_add_level(host_lib,xbt_dynar_free_voidp);
432       COORD_ASR_LEVEL  = xbt_lib_add_level(as_router_lib,xbt_dynar_free_voidp);
433     }
434   } else
435     if (COORD_HOST_LEVEL)
436       xbt_die("Setting of whether to use coordinate cannot be disabled once set.");
437 }
438
439 static void _sg_cfg_cb__surf_network_crosstraffic(const char *name,
440                                                   int pos)
441 {
442   sg_network_crosstraffic = xbt_cfg_get_boolean(_sg_cfg_set, name);
443 }
444
445 #ifdef HAVE_GTNETS
446 static void _sg_cfg_cb__gtnets_jitter(const char *name, int pos)
447 {
448   sg_gtnets_jitter = xbt_cfg_get_double(_sg_cfg_set, name);
449 }
450
451 static void _sg_cfg_cb__gtnets_jitter_seed(const char *name, int pos)
452 {
453   sg_gtnets_jitter_seed = xbt_cfg_get_int(_sg_cfg_set, name);
454 }
455 #endif
456
457 /* build description line with possible values */
458 static void describe_model(char *result,
459                            const s_surf_model_description_t model_description[],
460                            const char *name,
461                            const char *description)
462 {
463   char *p = result +
464     sprintf(result, "%s. Possible values: %s", description,
465             model_description[0].name ? model_description[0].name : "n/a");
466   int i;
467   for (i = 1; model_description[i].name; i++)
468     p += sprintf(p, ", %s", model_description[i].name);
469   sprintf(p,
470       ".\n       (use 'help' as a value to see the long description of each %s)",
471           name);
472 }
473
474 /* create the config set, register what should be and parse the command line*/
475 void sg_config_init(int *argc, char **argv)
476 {
477   char description[1024];
478
479   /* Create the configuration support */
480   if (_sg_cfg_init_status == 0) { /* Only create stuff if not already inited */
481
482     /* Plugins configuration */
483     describe_model(description, surf_plugin_description,
484                    "plugin", "The plugins");
485     xbt_cfg_register(&_sg_cfg_set, "plugin", description,
486                      xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__plugin, NULL);
487
488     describe_model(description, surf_cpu_model_description,
489                    "model", "The model to use for the CPU");
490     xbt_cfg_register(&_sg_cfg_set, "cpu/model", description,
491                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__cpu_model, NULL);
492     xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/model", "Cas01");
493
494     describe_model(description, surf_optimization_mode_description,
495                    "optimization mode",
496                    "The optimization modes to use for the CPU");
497     xbt_cfg_register(&_sg_cfg_set, "cpu/optim", description,
498                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode, NULL);
499     xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/optim", "Lazy");
500
501     describe_model(description, surf_storage_model_description,
502                    "model", "The model to use for the storage");
503     xbt_cfg_register(&_sg_cfg_set, "storage/model", description,
504                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__storage_mode, NULL);
505     xbt_cfg_setdefault_string(_sg_cfg_set, "storage/model", "default");
506
507     describe_model(description, surf_network_model_description,
508                    "model", "The model to use for the network");
509     xbt_cfg_register(&_sg_cfg_set, "network/model", description,
510                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__network_model, NULL);
511     xbt_cfg_setdefault_string(_sg_cfg_set, "network/model", "LV08");
512
513     describe_model(description, surf_optimization_mode_description,
514                    "optimization mode",
515                    "The optimization modes to use for the network");
516     xbt_cfg_register(&_sg_cfg_set, "network/optim", description,
517                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode, NULL);
518     xbt_cfg_setdefault_string(_sg_cfg_set, "network/optim", "Lazy");
519
520     describe_model(description, surf_workstation_model_description,
521                    "model", "The model to use for the workstation");
522     xbt_cfg_register(&_sg_cfg_set, "workstation/model", description,
523                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__workstation_model, NULL);
524     xbt_cfg_setdefault_string(_sg_cfg_set, "workstation/model", "default");
525
526     describe_model(description, surf_vm_workstation_model_description,
527                    "model", "The model to use for the vm workstation");
528     xbt_cfg_register(&_sg_cfg_set, "vm_workstation/model", description,
529                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__vm_workstation_model, NULL);
530     xbt_cfg_setdefault_string(_sg_cfg_set, "vm_workstation/model", "default");
531
532     xbt_cfg_register(&_sg_cfg_set, "network/TCP_gamma",
533                      "Size of the biggest TCP window (cat /proc/sys/net/ipv4/tcp_[rw]mem for recv/send window; Use the last given value, which is the max window size)",
534                      xbt_cfgelm_double, 1, 1, _sg_cfg_cb__tcp_gamma, NULL);
535     xbt_cfg_setdefault_double(_sg_cfg_set, "network/TCP_gamma", 4194304.0);
536
537     xbt_cfg_register(&_sg_cfg_set, "maxmin/precision",
538                      "Numerical precision used when updating simulation models (epsilon in double comparisons)",
539                      xbt_cfgelm_double, 1, 1, _sg_cfg_cb__maxmin_precision, NULL);
540     xbt_cfg_setdefault_double(_sg_cfg_set, "maxmin/precision", 0.00001);
541
542     /* The parameters of network models */
543
544     xbt_cfg_register(&_sg_cfg_set, "network/sender_gap",
545                      "Minimum gap between two overlapping sends",
546                      xbt_cfgelm_double, 1, 1, _sg_cfg_cb__sender_gap, NULL);
547     /* real default for "network/sender_gap" is set in network_smpi.cpp */
548     xbt_cfg_setdefault_double(_sg_cfg_set, "network/sender_gap", NAN);
549
550     xbt_cfg_register(&_sg_cfg_set, "network/latency_factor",
551                      "Correction factor to apply to the provided latency (default value set by network model)",
552                      xbt_cfgelm_double, 1, 1, _sg_cfg_cb__latency_factor, NULL);
553     xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 1.0);
554
555     xbt_cfg_register(&_sg_cfg_set, "network/bandwidth_factor",
556                      "Correction factor to apply to the provided bandwidth (default value set by network model)",
557                      xbt_cfgelm_double, 1, 1, _sg_cfg_cb__bandwidth_factor, NULL);
558     xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 1.0);
559
560     xbt_cfg_register(&_sg_cfg_set, "network/weight_S",
561                      "Correction factor to apply to the weight of competing streams (default value set by network model)",
562                      xbt_cfgelm_double, 1, 1, _sg_cfg_cb__weight_S, NULL);
563     /* real default for "network/weight_S" is set in network_*.cpp */
564     xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", NAN);
565
566     /* Inclusion path */
567     xbt_cfg_register(&_sg_cfg_set, "path",
568                      "Lookup path for inclusions in platform and deployment XML files",
569                      xbt_cfgelm_string, 1, 0, _sg_cfg_cb__surf_path, NULL);
570
571     xbt_cfg_register(&_sg_cfg_set, "cpu/maxmin_selective_update",
572                      "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
573                      xbt_cfgelm_boolean, 1, 1, NULL, NULL);
574     xbt_cfg_setdefault_boolean(_sg_cfg_set, "cpu/maxmin_selective_update", "no");
575
576     xbt_cfg_register(&_sg_cfg_set, "network/maxmin_selective_update",
577                      "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
578                      xbt_cfgelm_boolean, 1, 1, NULL, NULL);
579     xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/maxmin_selective_update", "no");
580
581 #ifdef HAVE_MC
582     /* do model-checking */
583     xbt_cfg_register(&_sg_cfg_set, "model-check",
584                      "Verify the system through model-checking instead of simulating it (EXPERIMENTAL)",
585                      xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_model_check, NULL);
586     xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check", "no");
587
588     /* do stateful model-checking */
589     xbt_cfg_register(&_sg_cfg_set, "model-check/checkpoint",
590                      "Specify the amount of steps between checkpoints during stateful model-checking (default: 0 => stateless verification). "
591                      "If value=1, one checkpoint is saved for each step => faster verification, but huge memory consumption; higher values are good compromises between speed and memory consumption.",
592                      xbt_cfgelm_int, 1, 1, _mc_cfg_cb_checkpoint, NULL);
593     xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/checkpoint", 0);
594
595     /* do liveness model-checking */
596     xbt_cfg_register(&_sg_cfg_set, "model-check/property",
597                      "Specify the name of the file containing the property. It must be the result of the ltl2ba program.",
598                      xbt_cfgelm_string, 1, 1, _mc_cfg_cb_property, NULL);
599     xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/property", "");
600
601     /* do communications determinism model-checking */
602     xbt_cfg_register(&_sg_cfg_set, "model-check/communications_determinism",
603                      "Enable/disable the detection of determinism in the communications schemes",
604                      xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_comms_determinism, NULL);
605     xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/communications_determinism", "no");
606
607     /* do send determinism model-checking */
608     xbt_cfg_register(&_sg_cfg_set, "model-check/send_determinism",
609                      "Enable/disable the detection of send-determinism in the communications schemes",
610                      xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_send_determinism, NULL);
611     xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/send_determinism", "no");
612
613     /* Specify the kind of model-checking reduction */
614     xbt_cfg_register(&_sg_cfg_set, "model-check/reduction",
615                      "Specify the kind of exploration reduction (either none or DPOR)",
616                      xbt_cfgelm_string, 1, 1, _mc_cfg_cb_reduce, NULL);
617     xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/reduction", "dpor");
618
619     /* Enable/disable timeout for wait requests with model-checking */
620     xbt_cfg_register(&_sg_cfg_set, "model-check/timeout",
621                      "Enable/Disable timeout for wait requests",
622                      xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_timeout, NULL);
623     xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/timeout", "no");
624
625     /* Enable/disable global hash computation with model-checking */
626     xbt_cfg_register(&_sg_cfg_set, "model-check/hash",
627                      "Enable/Disable state hash for state comparison (exprimental)",
628                      xbt_cfgelm_boolean, 1, 1, _mc_cfg_cb_hash, NULL);
629     xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/hash", "no");
630
631     /* Set max depth exploration */
632     xbt_cfg_register(&_sg_cfg_set, "model-check/max_depth",
633                      "Specify the max depth of exploration (default : 1000)",
634                      xbt_cfgelm_int, 1, 1, _mc_cfg_cb_max_depth, NULL);
635     xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/max_depth", 1000);
636
637     /* Set number of visited state stored for state comparison reduction*/
638     xbt_cfg_register(&_sg_cfg_set, "model-check/visited",
639                      "Specify the number of visited state stored for state comparison reduction. If value=5, the last 5 visited states are stored",
640                      xbt_cfgelm_int, 1, 1, _mc_cfg_cb_visited, NULL);
641     xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/visited", 0);
642
643     /* Set file name for dot output of graph state */
644     xbt_cfg_register(&_sg_cfg_set, "model-check/dot_output",
645                      "Specify the name of dot file corresponding to graph state",
646                      xbt_cfgelm_string, 1, 1, _mc_cfg_cb_dot_output, NULL);
647     xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/dot_output", "");
648 #endif
649
650     /* do verbose-exit */
651     xbt_cfg_register(&_sg_cfg_set, "verbose-exit",
652                      "Activate the \"do nothing\" mode in Ctrl-C",
653                      xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_verbose_exit, NULL);
654     xbt_cfg_setdefault_boolean(_sg_cfg_set, "verbose-exit", "yes");
655
656     /* context factory */
657     const char *dflt_ctx_fact = "thread";
658     {
659       char *p = description +
660         sprintf(description,
661                 "Context factory to use in SIMIX. Possible values: %s",
662                 dflt_ctx_fact);
663 #ifdef CONTEXT_UCONTEXT
664       dflt_ctx_fact = "ucontext";
665       p += sprintf(p, ", %s", dflt_ctx_fact);
666 #endif
667 #ifdef HAVE_RAWCTX
668       dflt_ctx_fact = "raw";
669       p += sprintf(p, ", %s", dflt_ctx_fact);
670 #endif
671       sprintf(p, ".");
672     }
673     xbt_cfg_register(&_sg_cfg_set, "contexts/factory", description,
674                      xbt_cfgelm_string, 1, 1, _sg_cfg_cb_context_factory, NULL);
675     xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/factory", dflt_ctx_fact);
676
677     /* stack size of contexts in KiB */
678     xbt_cfg_register(&_sg_cfg_set, "contexts/stack_size",
679                      "Stack size of contexts in KiB",
680                      xbt_cfgelm_int, 1, 1, _sg_cfg_cb_context_stack_size, NULL);
681     xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/stack_size", 8*1024);
682     /* No, it was not set yet (the above setdefault() changed this to 1). */
683     smx_context_stack_size_was_set = 0;
684
685     /* guard size for contexts stacks in memory pages */
686     xbt_cfg_register(&_sg_cfg_set, "contexts/guard_size",
687                      "Guard size for contexts stacks in memory pages",
688                      xbt_cfgelm_int, 1, 1, _sg_cfg_cb_context_guard_size, NULL);
689     xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/guard_size", 1);
690     /* No, it was not set yet (the above setdefault() changed this to 1). */
691     smx_context_guard_size_was_set = 0;
692
693     /* number of parallel threads for user processes */
694     xbt_cfg_register(&_sg_cfg_set, "contexts/nthreads",
695                      "Number of parallel threads used to execute user contexts",
696                      xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_nthreads, NULL);
697     xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/nthreads", 1);
698
699     /* minimal number of user contexts to be run in parallel */
700     xbt_cfg_register(&_sg_cfg_set, "contexts/parallel_threshold",
701                      "Minimal number of user contexts to be run in parallel (raw contexts only)",
702                      xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_parallel_threshold, NULL);
703     xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/parallel_threshold", 2);
704
705     /* synchronization mode for parallel user contexts */
706     xbt_cfg_register(&_sg_cfg_set, "contexts/synchro",
707                      "Synchronization mode to use when running contexts in parallel (either futex, posix or busy_wait)",
708                      xbt_cfgelm_string, 1, 1, _sg_cfg_cb_contexts_parallel_mode, NULL);
709 #ifdef HAVE_FUTEX_H
710     xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "futex");
711 #else //No futex on mac and posix is unimplememted yet
712     xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "busy_wait");
713 #endif
714
715     xbt_cfg_register(&_sg_cfg_set, "network/coordinates",
716                      "\"yes\" or \"no\", specifying whether we use a coordinate-based routing (as Vivaldi)",
717                      xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb__surf_network_coordinates, NULL);
718     xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/coordinates", "no");
719
720     xbt_cfg_register(&_sg_cfg_set, "network/crosstraffic",
721                      "Activate the interferences between uploads and downloads for fluid max-min models (LV08, CM02)",
722                      xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb__surf_network_crosstraffic, NULL);
723     xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/crosstraffic", "no");
724
725 #ifdef HAVE_GTNETS
726     xbt_cfg_register(&_sg_cfg_set, "gtnets/jitter",
727                      "Double value to oscillate the link latency, uniformly in random interval [-latency*gtnets_jitter,latency*gtnets_jitter)",
728                      xbt_cfgelm_double, 1, 1, _sg_cfg_cb__gtnets_jitter, NULL);
729     xbt_cfg_setdefault_double(_sg_cfg_set, "gtnets/jitter", 0.0);
730
731     xbt_cfg_register(&_sg_cfg_set, "gtnets/jitter_seed",
732                      "Use a positive seed to reproduce jitted results, value must be in [1,1e8], default is 10",
733                      xbt_cfgelm_int, 0, 1, _sg_cfg_cb__gtnets_jitter_seed, NULL);
734     xbt_cfg_setdefault_int(_sg_cfg_set, "gtnets/jitter_seed", 10);
735 #endif
736 #ifdef HAVE_NS3
737     xbt_cfg_register(&_sg_cfg_set, "ns3/TcpModel",
738                      "The ns3 tcp model can be : NewReno or Reno or Tahoe",
739                      xbt_cfgelm_string, 1, 1, NULL, NULL);
740     xbt_cfg_setdefault_string(_sg_cfg_set, "ns3/TcpModel", "default");
741 #endif
742
743 #ifdef HAVE_SMPI
744     xbt_cfg_register(&_sg_cfg_set, "smpi/running_power",
745                      "Power of the host running the simulation (in flop/s). Used to bench the operations.",
746                      xbt_cfgelm_double, 1, 1, NULL, NULL);
747     xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/running_power", 20000.0);
748
749     xbt_cfg_register(&_sg_cfg_set, "smpi/display_timing",
750                      "Boolean indicating whether we should display the timing after simulation.",
751                      xbt_cfgelm_boolean, 1, 1, NULL, NULL);
752     xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/display_timing", "no");
753
754     xbt_cfg_register(&_sg_cfg_set, "smpi/use_shared_malloc",
755                      "Boolean indicating whether we should use shared memory when using SMPI_SHARED_MALLOC. Allows user to disable it for debug purposes.",
756                      xbt_cfgelm_boolean, 1, 1, NULL, NULL);
757     xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/use_shared_malloc", "yes");
758
759     xbt_cfg_register(&_sg_cfg_set, "smpi/cpu_threshold",
760                      "Minimal computation time (in seconds) not discarded, or -1 for infinity.",
761                      xbt_cfgelm_double, 1, 1, NULL, NULL);
762     xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/cpu_threshold", 1e-6);
763
764     xbt_cfg_register(&_sg_cfg_set, "smpi/async_small_thres",
765                      "Maximal size of messages that are to be sent asynchronously, without waiting for the receiver",
766                      xbt_cfgelm_int, 1, 1, NULL, NULL);
767     xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/async_small_thres", 0);
768
769     xbt_cfg_register(&_sg_cfg_set, "smpi/send_is_detached_thres",
770                      "Threshold of message size where MPI_Send stops behaving like MPI_Isend and becomes MPI_Ssend",
771                      xbt_cfgelm_int, 1, 1, NULL, NULL);
772     xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/send_is_detached_thres", 65536);
773
774     xbt_cfg_register(&_sg_cfg_set, "smpi/privatize_global_variables",
775                      "Boolean indicating whether we should privatize global variable at runtime.",
776                      xbt_cfgelm_boolean, 1, 1, NULL, NULL);
777     xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/privatize_global_variables", "no");
778
779     //For smpi/bw_factor and smpi/lat_factor
780     //Default value have to be "threshold0:value0;threshold1:value1;...;thresholdN:valueN"
781     //test is if( size >= thresholdN ) return valueN;
782     //Values can be modified with command line --cfg=smpi/bw_factor:"threshold0:value0;threshold1:value1;...;thresholdN:valueN"
783     //  or with tag config put line <prop id="smpi/bw_factor" value="threshold0:value0;threshold1:value1;...;thresholdN:valueN"></prop>
784     xbt_cfg_register(&_sg_cfg_set, "smpi/bw_factor",
785                      "Bandwidth factors for smpi.",
786                      xbt_cfgelm_string, 1, 1, NULL, NULL);
787     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");
788
789     xbt_cfg_register(&_sg_cfg_set, "smpi/lat_factor",
790                      "Latency factors for smpi.",
791                      xbt_cfgelm_string, 1, 1, NULL, NULL);
792     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");
793
794     xbt_cfg_register(&_sg_cfg_set, "smpi/os",
795                      "Small messages timings (MPI_Send minimum time for small messages)",
796                      xbt_cfgelm_string, 1, 1, NULL, NULL);
797     xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/os", "1:0:0:0:0");
798
799     xbt_cfg_register(&_sg_cfg_set, "smpi/ois",
800                      "Small messages timings (MPI_Isend minimum time for small messages)",
801                      xbt_cfgelm_string, 1, 1, NULL, NULL);
802     xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/ois", "1:0:0:0:0");
803
804     xbt_cfg_register(&_sg_cfg_set, "smpi/or",
805                      "Small messages timings (MPI_Recv minimum time for small messages)",
806                      xbt_cfgelm_string, 1, 1, NULL, NULL);
807     xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/or", "1:0:0:0:0");
808     xbt_cfg_register(&_sg_cfg_set, "smpi/iprobe",
809                      "Minimum time to inject inside a call to MPI_Iprobe",
810                      xbt_cfgelm_double, 1, 1, NULL, NULL);
811     xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/iprobe", 1e-4);
812     xbt_cfg_register(&_sg_cfg_set, "smpi/coll_selector",
813                      "Which collective selector to use",
814                      xbt_cfgelm_string, 1, 1, NULL, NULL);
815     xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/coll_selector", "default");
816
817     xbt_cfg_register(&_sg_cfg_set, "smpi/gather",
818                      "Which collective to use for gather",
819                      xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_gather, NULL);
820
821     xbt_cfg_register(&_sg_cfg_set, "smpi/allgather",
822                      "Which collective to use for allgather",
823                      xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allgather, NULL);
824
825     xbt_cfg_register(&_sg_cfg_set, "smpi/barrier",
826                      "Which collective to use for barrier",
827                      xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_barrier, NULL);
828
829     xbt_cfg_register(&_sg_cfg_set, "smpi/reduce_scatter",
830                      "Which collective to use for reduce_scatter",
831                      xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_reduce_scatter, NULL);
832
833     xbt_cfg_register(&_sg_cfg_set, "smpi/scatter",
834                      "Which collective to use for scatter",
835                      xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_scatter, NULL);
836
837     xbt_cfg_register(&_sg_cfg_set, "smpi/allgatherv",
838                      "Which collective to use for allgatherv",
839                      xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allgatherv, NULL);
840
841     xbt_cfg_register(&_sg_cfg_set, "smpi/allreduce",
842                      "Which collective to use for allreduce",
843                      xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_allreduce, NULL);
844
845     xbt_cfg_register(&_sg_cfg_set, "smpi/alltoall",
846                      "Which collective to use for alltoall",
847                      xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_alltoall, NULL);
848
849     xbt_cfg_register(&_sg_cfg_set, "smpi/alltoallv",
850                      "Which collective to use for alltoallv",
851                      xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_alltoallv, NULL);
852
853     xbt_cfg_register(&_sg_cfg_set, "smpi/bcast",
854                      "Which collective to use for bcast",
855                      xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_bcast, NULL);
856
857     xbt_cfg_register(&_sg_cfg_set, "smpi/reduce",
858                      "Which collective to use for reduce",
859                      xbt_cfgelm_string, 0, 1, &_sg_cfg_cb__coll_reduce, NULL);
860 #endif // HAVE_SMPI
861
862     xbt_cfg_register(&_sg_cfg_set, "clean_atexit",
863                      "\"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.",
864                      xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_clean_atexit, NULL);
865     xbt_cfg_setdefault_boolean(_sg_cfg_set, "clean_atexit", "yes");
866
867     if (!surf_path) {
868       /* retrieves the current directory of the current process */
869       const char *initial_path = __surf_get_initial_path();
870       xbt_assert((initial_path),
871                   "__surf_get_initial_path() failed! Can't resolves current Windows directory");
872
873       surf_path = xbt_dynar_new(sizeof(char *), NULL);
874       xbt_cfg_setdefault_string(_sg_cfg_set, "path", initial_path);
875     }
876
877     xbt_cfg_check(_sg_cfg_set);
878     _sg_cfg_init_status = 1;
879
880     sg_config_cmd_line(argc, argv);
881
882     xbt_mallocator_initialization_is_done(SIMIX_context_is_parallel());
883
884   } else {
885     XBT_WARN("Call to sg_config_init() after initialization ignored");
886   }
887 }
888
889 void sg_config_finalize(void)
890 {
891   if (!_sg_cfg_init_status)
892     return;                     /* Not initialized yet. Nothing to do */
893
894   xbt_cfg_free(&_sg_cfg_set);
895   _sg_cfg_init_status = 0;
896 }
897
898 /* Pick the right models for CPU, net and workstation, and call their model_init_preparse */
899 void surf_config_models_setup()
900 {
901   const char *workstation_model_name;
902   const char *vm_workstation_model_name;
903   int workstation_id = -1;
904   int vm_workstation_id = -1;
905   char *network_model_name = NULL;
906   char *cpu_model_name = NULL;
907   int storage_id = -1;
908   char *storage_model_name = NULL;
909
910   workstation_model_name =
911       xbt_cfg_get_string(_sg_cfg_set, "workstation/model");
912   vm_workstation_model_name =
913       xbt_cfg_get_string(_sg_cfg_set, "vm_workstation/model");
914   network_model_name = xbt_cfg_get_string(_sg_cfg_set, "network/model");
915   cpu_model_name = xbt_cfg_get_string(_sg_cfg_set, "cpu/model");
916   storage_model_name = xbt_cfg_get_string(_sg_cfg_set, "storage/model");
917
918   /* Check whether we use a net/cpu model differing from the default ones, in which case
919    * we should switch to the "compound" workstation model to correctly dispatch stuff to
920    * the right net/cpu models.
921    */
922
923   if ((!xbt_cfg_is_default_value(_sg_cfg_set, "network/model") ||
924        !xbt_cfg_is_default_value(_sg_cfg_set, "cpu/model")) &&
925       xbt_cfg_is_default_value(_sg_cfg_set, "workstation/model")) {
926     XBT_INFO("Switching workstation model to compound since you changed the network and/or cpu model(s)");
927     workstation_model_name = "compound";
928     xbt_cfg_set_string(_sg_cfg_set, "workstation/model", workstation_model_name);
929   }
930
931   XBT_DEBUG("Workstation model: %s", workstation_model_name);
932   workstation_id =
933       find_model_description(surf_workstation_model_description,
934                              workstation_model_name);
935   if (!strcmp(workstation_model_name, "compound")) {
936     int network_id = -1;
937     int cpu_id = -1;
938
939     xbt_assert(cpu_model_name,
940                 "Set a cpu model to use with the 'compound' workstation model");
941
942     xbt_assert(network_model_name,
943                 "Set a network model to use with the 'compound' workstation model");
944
945     network_id =
946         find_model_description(surf_network_model_description,
947                                network_model_name);
948     cpu_id =
949         find_model_description(surf_cpu_model_description, cpu_model_name);
950
951     surf_cpu_model_description[cpu_id].model_init_preparse();
952     surf_network_model_description[network_id].model_init_preparse();
953   }
954
955   XBT_DEBUG("Call workstation_model_init");
956   surf_workstation_model_description[workstation_id].model_init_preparse();
957
958   XBT_DEBUG("Call vm_workstation_model_init");
959   vm_workstation_id = find_model_description(surf_vm_workstation_model_description,
960                                           vm_workstation_model_name);
961   surf_vm_workstation_model_description[vm_workstation_id].model_init_preparse();
962
963   XBT_DEBUG("Call storage_model_init");
964   storage_id = find_model_description(surf_storage_model_description, storage_model_name);
965   surf_storage_model_description[storage_id].model_init_preparse();
966
967 }
968
969 int sg_cfg_is_default_value(const char *name)
970 {
971   return xbt_cfg_is_default_value(_sg_cfg_set, name);
972 }
973
974 int sg_cfg_get_int(const char* name)
975 {
976   return xbt_cfg_get_int(_sg_cfg_set, name);
977 }
978
979 double sg_cfg_get_double(const char* name)
980 {
981   return xbt_cfg_get_double(_sg_cfg_set, name);
982 }
983
984 char* sg_cfg_get_string(const char* name)
985 {
986   return xbt_cfg_get_string(_sg_cfg_set, name);
987 }
988
989 int sg_cfg_get_boolean(const char* name)
990 {
991   return xbt_cfg_get_boolean(_sg_cfg_set, name);
992 }
993
994 void sg_cfg_get_peer(const char *name, char **peer, int *port)
995 {
996   xbt_cfg_get_peer(_sg_cfg_set, name, peer, port);
997 }
998
999 xbt_dynar_t sg_cfg_get_dynar(const char* name)
1000 {
1001   return xbt_cfg_get_dynar(_sg_cfg_set, name);
1002 }