Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
use a sane way to declare postparse callbacks, now that this way exists
[simgrid.git] / src / surf / surf_config.c
1 /* Copyright (c) 2009, 2010. 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 /* surf_config: configuration infrastructure for the simulation world       */
8
9 #include "xbt/config.h"
10 #include "xbt/str.h"
11 #include "surf/surf_private.h"
12 #include "surf/surf_routing.h"  /* COORD_HOST_LEVEL and COORD_ASR_LEVEL */
13 #include "simix/context.h"
14
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_config, surf,
16                                 "About the configuration of surf (and the rest of the simulation)");
17
18 xbt_cfg_t _surf_cfg_set = NULL;
19
20 /* Parse the command line, looking for options */
21 static void surf_config_cmd_line(int *argc, char **argv)
22 {
23   int i, j;
24   char *opt;
25
26   for (i = 1; i < *argc; i++) {
27     int remove_it = 0;
28     if (!strncmp(argv[i], "--cfg=", strlen("--cfg="))) {
29       opt = strchr(argv[i], '=');
30       opt++;
31
32       xbt_cfg_set_parse(_surf_cfg_set, opt);
33       XBT_DEBUG("Did apply '%s' as config setting", opt);
34       remove_it = 1;
35     } else if (!strncmp(argv[i], "--cfg-help", strlen("--cfg-help") + 1) ||
36                !strncmp(argv[i], "--help", strlen("--help") + 1)) {
37       printf
38           ("Description of the configuration accepted by this simulator:\n");
39       xbt_cfg_help(_surf_cfg_set);
40       printf("\nYou can also use --help-models to see the details of all models known by this simulator.\n");
41 #ifdef HAVE_TRACING
42       printf("\nYou can also use --help-tracing to see the details of all tracing options known by this simulator.\n");
43 #endif
44       exit(0);
45     } else if (!strncmp(argv[i], "--help-models", strlen("--help-models") + 1)) {
46       model_help("workstation", surf_workstation_model_description);
47       model_help("CPU", surf_cpu_model_description);
48       model_help("network", surf_network_model_description);
49       exit(0);
50 #ifdef HAVE_TRACING
51     } else if (!strncmp(argv[i], "--help-tracing", strlen("--help-tracing") + 1)) {
52       TRACE_help (1);
53       exit(0);
54 #endif
55     }
56     if (remove_it) {            /*remove this from argv */
57       for (j = i + 1; j < *argc; j++) {
58         argv[j - 1] = argv[j];
59       }
60
61       argv[j - 1] = NULL;
62       (*argc)--;
63       i--;                      /* compensate effect of next loop incrementation */
64     }
65   }
66 }
67
68
69 int _surf_init_status = 0;      /* 0: beginning of time;
70                                    1: pre-inited (cfg_set created);
71                                    2: inited (running) */
72
73 /* callback of the workstation/model variable */
74 static void _surf_cfg_cb__workstation_model(const char *name, int pos)
75 {
76   char *val;
77
78   xbt_assert(_surf_init_status < 2,
79               "Cannot change the model after the initialization");
80
81   val = xbt_cfg_get_string(_surf_cfg_set, name);
82
83   if (!strcmp(val, "help")) {
84     model_help("workstation", surf_workstation_model_description);
85     exit(0);
86   }
87
88   /* Make sure that the model exists */
89   find_model_description(surf_workstation_model_description, val);
90 }
91
92 /* callback of the cpu/model variable */
93 static void _surf_cfg_cb__cpu_model(const char *name, int pos)
94 {
95   char *val;
96
97   xbt_assert(_surf_init_status < 2,
98               "Cannot change the model after the initialization");
99
100   val = xbt_cfg_get_string(_surf_cfg_set, name);
101
102   if (!strcmp(val, "help")) {
103     model_help("CPU", surf_cpu_model_description);
104     exit(0);
105   }
106
107   /* New Module missing */
108   find_model_description(surf_cpu_model_description, val);
109 }
110
111 /* callback of the workstation_model variable */
112 static void _surf_cfg_cb__network_model(const char *name, int pos)
113 {
114   char *val;
115
116   xbt_assert(_surf_init_status < 2,
117               "Cannot change the model after the initialization");
118
119   val = xbt_cfg_get_string(_surf_cfg_set, name);
120
121   if (!strcmp(val, "help")) {
122     model_help("network", surf_network_model_description);
123     exit(0);
124   }
125
126   /* New Module missing */
127   find_model_description(surf_network_model_description, val);
128 }
129
130
131 /* callbacks of the network models values */
132 static void _surf_cfg_cb__tcp_gamma(const char *name, int pos)
133 {
134   sg_tcp_gamma = xbt_cfg_get_double(_surf_cfg_set, name);
135 }
136
137 static void _surf_cfg_cb__maxmin_precision(const char* name, int pos)
138 {
139   sg_maxmin_precision = xbt_cfg_get_double(_surf_cfg_set, name);
140 }
141
142 static void _surf_cfg_cb__sender_gap(const char* name, int pos)
143 {
144   sg_sender_gap = xbt_cfg_get_double(_surf_cfg_set, name);
145 }
146
147 static void _surf_cfg_cb__latency_factor(const char *name, int pos)
148 {
149   sg_latency_factor = xbt_cfg_get_double(_surf_cfg_set, name);
150 }
151
152 static void _surf_cfg_cb__bandwidth_factor(const char *name, int pos)
153 {
154   sg_bandwidth_factor = xbt_cfg_get_double(_surf_cfg_set, name);
155 }
156
157 static void _surf_cfg_cb__weight_S(const char *name, int pos)
158 {
159   sg_weight_S_parameter = xbt_cfg_get_double(_surf_cfg_set, name);
160 }
161
162 static void _surf_cfg_cb__surf_maxmin_selective_update(const char *name,
163                                                        int pos)
164 {
165   sg_maxmin_selective_update = xbt_cfg_get_int(_surf_cfg_set, name);
166 }
167
168 /* callback of the inclusion path */
169 static void _surf_cfg_cb__surf_path(const char *name, int pos)
170 {
171   char *path = xbt_cfg_get_string_at(_surf_cfg_set, name, pos);
172   xbt_dynar_push(surf_path, &path);
173 }
174
175 /* callback to decide if we want to use the model-checking */
176 #include "xbt_modinter.h"
177 extern int _surf_do_model_check;   /* this variable lives in xbt_main until I find a right location for it */
178
179 static void _surf_cfg_cb_model_check(const char *name, int pos)
180 {
181   _surf_do_model_check = xbt_cfg_get_int(_surf_cfg_set, name);
182
183   if (_surf_do_model_check) {
184     /* Tell modules using mallocators that they shouldn't. MC don't like them */
185     xbt_fifo_preinit();
186     xbt_dict_preinit();
187   }
188 }
189
190 extern int _surf_do_verbose_exit;
191
192 static void _surf_cfg_cb_verbose_exit(const char *name, int pos)
193 {
194   _surf_do_verbose_exit = xbt_cfg_get_int(_surf_cfg_set, name);
195 }
196
197
198 static void _surf_cfg_cb_context_factory(const char *name, int pos)
199 {
200   smx_context_factory_name = xbt_cfg_get_string(_surf_cfg_set, name);
201 }
202
203 static void _surf_cfg_cb_context_stack_size(const char *name, int pos)
204 {
205   smx_context_stack_size = xbt_cfg_get_int(_surf_cfg_set, name) * 1024;
206 }
207
208 static void _surf_cfg_cb_contexts_nthreads(const char *name, int pos)
209 {
210   SIMIX_context_set_nthreads(xbt_cfg_get_int(_surf_cfg_set, name));
211 }
212
213 static void _surf_cfg_cb_contexts_parallel_threshold(const char *name, int pos)
214 {
215   SIMIX_context_set_parallel_threshold(xbt_cfg_get_int(_surf_cfg_set, name));
216 }
217
218 static void _surf_cfg_cb__surf_network_coordinates(const char *name,
219                                                    int pos)
220 {
221   char *val = xbt_cfg_get_string(_surf_cfg_set, name);
222   if (!strcmp(val, "yes")) {
223     if (!COORD_HOST_LEVEL) {
224       COORD_HOST_LEVEL = xbt_lib_add_level(host_lib,xbt_dynar_free_voidp);
225       COORD_ASR_LEVEL  = xbt_lib_add_level(as_router_lib,xbt_dynar_free_voidp);
226     }
227   } else if (!strcmp(val, "no")) {
228     if (COORD_HOST_LEVEL)
229       XBT_WARN("Cannot disable CMD prop coordinates, once set.");
230   } else {
231     XBT_WARN("Setting CMD prop coordinates must be \"yes\" or \"no\"");
232   }
233 }
234
235 static void _surf_cfg_cb__surf_network_fullduplex(const char *name,
236                                                   int pos)
237 {
238   sg_network_fullduplex = xbt_cfg_get_int(_surf_cfg_set, name);
239 }
240
241 #ifdef HAVE_GTNETS
242 static void _surf_cfg_cb__gtnets_jitter(const char *name, int pos)
243 {
244   sg_gtnets_jitter = xbt_cfg_get_double(_surf_cfg_set, name);
245 }
246
247 static void _surf_cfg_cb__gtnets_jitter_seed(const char *name, int pos)
248 {
249   sg_gtnets_jitter_seed = xbt_cfg_get_int(_surf_cfg_set, name);
250 }
251 #endif
252
253 /* create the config set, register what should be and parse the command line*/
254 void surf_config_init(int *argc, char **argv)
255 {
256   char *description = xbt_malloc(1024), *p = description;
257   char *default_value;
258   double double_default_value;
259   int default_value_int;
260   int i;
261
262   /* Create the configuration support */
263   if (_surf_init_status == 0) { /* Only create stuff if not already inited */
264     _surf_init_status = 1;
265
266     sprintf(description,
267             "The model to use for the CPU. Possible values: ");
268     p = description;
269     while (*(++p) != '\0');
270     for (i = 0; surf_cpu_model_description[i].name; i++)
271       p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
272                    surf_cpu_model_description[i].name);
273     sprintf(p,
274             ".\n       (use 'help' as a value to see the long description of each model)");
275     default_value = xbt_strdup("Cas01");
276     xbt_cfg_register(&_surf_cfg_set,
277                      "cpu/model", description, xbt_cfgelm_string,
278                      &default_value, 1, 1, &_surf_cfg_cb__cpu_model, NULL);
279
280     sprintf(description,
281             "The model to use for the network. Possible values: ");
282     p = description;
283     while (*(++p) != '\0');
284     for (i = 0; surf_network_model_description[i].name; i++)
285       p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
286                    surf_network_model_description[i].name);
287     sprintf(p,
288             ".\n       (use 'help' as a value to see the long description of each model)");
289     default_value = xbt_strdup("LV08");
290     xbt_cfg_register(&_surf_cfg_set,
291                      "network/model", description, xbt_cfgelm_string,
292                      &default_value, 1, 1, &_surf_cfg_cb__network_model,
293                      NULL);
294
295     sprintf(description,
296             "The model to use for the workstation. Possible values: ");
297     p = description;
298     while (*(++p) != '\0');
299     for (i = 0; surf_workstation_model_description[i].name; i++)
300       p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
301                    surf_workstation_model_description[i].name);
302     sprintf(p,
303             ".\n       (use 'help' as a value to see the long description of each model)");
304     default_value = xbt_strdup("CLM03");
305     xbt_cfg_register(&_surf_cfg_set,
306                      "workstation/model", description, xbt_cfgelm_string,
307                      &default_value, 1, 1,
308                      &_surf_cfg_cb__workstation_model, NULL);
309
310     xbt_free(description);
311
312     default_value = xbt_strdup("Full");
313     xbt_cfg_register(&_surf_cfg_set, "routing",
314                      "Model to use to store the routing information",
315                      xbt_cfgelm_string, &default_value, 1, 1, NULL, NULL);
316
317     xbt_cfg_register(&_surf_cfg_set, "TCP_gamma",
318                      "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)",
319                      xbt_cfgelm_double, NULL, 1, 1,
320                      _surf_cfg_cb__tcp_gamma, NULL);
321     xbt_cfg_setdefault_double(_surf_cfg_set, "TCP_gamma", 20000.0);
322
323     xbt_cfg_register(&_surf_cfg_set, "maxmin/precision",
324                      "Minimum retained action value when updating simulation",
325                      xbt_cfgelm_double, NULL, 1, 1, _surf_cfg_cb__maxmin_precision, NULL);
326     xbt_cfg_setdefault_double(_surf_cfg_set, "maxmin/precision", 0.00001); // FIXME use setdefault everywhere here!
327
328     /* The parameters of network models */
329
330     double_default_value = 0.0;
331     xbt_cfg_register(&_surf_cfg_set, "network/sender_gap",
332                      "Minimum gap between two overlapping sends",
333                      xbt_cfgelm_double, &double_default_value, 1, 1,
334                      _surf_cfg_cb__sender_gap, NULL);
335
336     double_default_value = 1.0;
337     xbt_cfg_register(&_surf_cfg_set, "network/latency_factor",
338                      "Correction factor to apply to the provided latency (default value set by network model)",
339                      xbt_cfgelm_double, &double_default_value, 1, 1,
340                      _surf_cfg_cb__latency_factor, NULL);
341     double_default_value = 1.0;
342     xbt_cfg_register(&_surf_cfg_set, "network/bandwidth_factor",
343                      "Correction factor to apply to the provided bandwidth (default value set by network model)",
344                      xbt_cfgelm_double, &double_default_value, 1, 1,
345                      _surf_cfg_cb__bandwidth_factor, NULL);
346     double_default_value = 0.0;
347     xbt_cfg_register(&_surf_cfg_set, "network/weight_S",
348                      "Correction factor to apply to the weight of competing streams(default value set by network model)",
349                      xbt_cfgelm_double, &double_default_value, 1, 1,
350                      _surf_cfg_cb__weight_S, NULL);
351
352     /* Inclusion path */
353     xbt_cfg_register(&_surf_cfg_set, "path",
354                      "Lookup path for inclusions in platform and deployment XML files",
355                      xbt_cfgelm_string, NULL, 0, 0,
356                      _surf_cfg_cb__surf_path, NULL);
357
358     default_value_int = 0;
359     xbt_cfg_register(&_surf_cfg_set, "maxmin_selective_update",
360                      "Update the constraint set propagating recursively to others constraints",
361                      xbt_cfgelm_int, &default_value_int, 0, 1,
362                      _surf_cfg_cb__surf_maxmin_selective_update, NULL);
363
364     /* do model-check */
365     default_value_int = 0;
366     xbt_cfg_register(&_surf_cfg_set, "model-check",
367                      "Activate the model-checking of the \"simulated\" system (EXPERIMENTAL -- msg only for now)",
368                      xbt_cfgelm_int, &default_value_int, 0, 1,
369                      _surf_cfg_cb_model_check, NULL);
370     
371     /*
372        FIXME: this function is not setting model-check to it's default value because
373        internally it calls to variable->cb_set that in this case is the function 
374        _surf_cfg_cb_model_check which sets it's value to 1 (instead of the default value 0)
375        xbt_cfg_set_int(_surf_cfg_set, "model-check", default_value_int); */
376
377     /* do verbose-exit */
378     default_value_int = 0;
379     xbt_cfg_register(&_surf_cfg_set, "verbose-exit",
380                      "Activate the \"do nothing\" mode in Ctrl-C",
381                      xbt_cfgelm_int, &default_value_int, 0, 1,
382                      _surf_cfg_cb_verbose_exit, NULL);
383     
384     
385     /* context factory */
386     default_value = xbt_strdup("ucontext");
387     xbt_cfg_register(&_surf_cfg_set, "contexts/factory",
388                      "Context factory to use in SIMIX (ucontext, thread or raw)",
389                      xbt_cfgelm_string, &default_value, 1, 1, _surf_cfg_cb_context_factory, NULL);
390
391     /* stack size of contexts in Ko */
392     default_value_int = 128;
393     xbt_cfg_register(&_surf_cfg_set, "contexts/stack_size",
394                      "Stack size of contexts in Ko (ucontext or raw only)",
395                      xbt_cfgelm_int, &default_value_int, 1, 1,
396                      _surf_cfg_cb_context_stack_size, NULL);
397
398     /* number of parallel threads for user processes */
399     default_value_int = 1;
400     xbt_cfg_register(&_surf_cfg_set, "contexts/nthreads",
401                      "Number of parallel threads for user contexts (EXPERIMENTAL)",
402                      xbt_cfgelm_int, &default_value_int, 1, 1,
403                      _surf_cfg_cb_contexts_nthreads, NULL);
404
405     /* minimal number of user contexts to be run in parallel */
406     default_value_int = 1;
407     xbt_cfg_register(&_surf_cfg_set, "contexts/parallel_threshold",
408         "Minimal number of user contexts to be run in parallel (raw contexts only)",
409         xbt_cfgelm_int, &default_value_int, 1, 1,
410         _surf_cfg_cb_contexts_parallel_threshold, NULL);
411
412     default_value = xbt_strdup("no");
413     xbt_cfg_register(&_surf_cfg_set, "coordinates",
414                      "\"yes\" or \"no\" (FIXME: document)",
415                      xbt_cfgelm_string, &default_value, 1, 1,
416                      _surf_cfg_cb__surf_network_coordinates, NULL);
417     xbt_cfg_setdefault_string(_surf_cfg_set, "coordinates", default_value);
418
419     default_value_int = 0;
420     xbt_cfg_register(&_surf_cfg_set, "fullduplex",
421                      "Activate the interferences between uploads and downloads for fluid max-min models (LV08, CM02)",
422                      xbt_cfgelm_int, &default_value_int, 0, 1,
423                      _surf_cfg_cb__surf_network_fullduplex, NULL);
424     xbt_cfg_setdefault_int(_surf_cfg_set, "fullduplex", default_value_int);
425
426 #ifdef HAVE_GTNETS
427     xbt_cfg_register(&_surf_cfg_set, "gtnets_jitter",
428                      "Double value to oscillate the link latency, uniformly in random interval [-latency*gtnets_jitter,latency*gtnets_jitter)",
429                      xbt_cfgelm_double, NULL, 1, 1,
430                      _surf_cfg_cb__gtnets_jitter, NULL);
431     xbt_cfg_setdefault_double(_surf_cfg_set, "gtnets_jitter", 0.0);
432
433     default_value_int = 10;
434     xbt_cfg_register(&_surf_cfg_set, "gtnets_jitter_seed",
435                      "Use a positive seed to reproduce jitted results, value must be in [1,1e8], default is 10",
436                      xbt_cfgelm_int, &default_value_int, 0, 1,
437                      _surf_cfg_cb__gtnets_jitter_seed, NULL);
438 #endif
439 #ifdef HAVE_NS3
440     xbt_cfg_register(&_surf_cfg_set, "ns3/TcpModel",
441                      "The ns3 tcp model can be : NewReno or Reno or Tahoe",
442                      xbt_cfgelm_string, NULL, 1, 1,
443                      NULL, NULL);
444     xbt_cfg_setdefault_string(_surf_cfg_set, "ns3/TcpModel", "default");
445 #endif
446     if (!surf_path) {
447       /* retrieves the current directory of the        current process */
448       const char *initial_path = __surf_get_initial_path();
449       xbt_assert((initial_path),
450                   "__surf_get_initial_path() failed! Can't resolves current Windows directory");
451
452       surf_path = xbt_dynar_new(sizeof(char *), NULL);
453       xbt_cfg_setdefault_string(_surf_cfg_set, "path", initial_path);
454     }
455
456
457     surf_config_cmd_line(argc, argv);
458   } else {
459     XBT_WARN("Call to surf_config_init() after initialization ignored");
460   }
461 }
462
463 void surf_config_finalize(void)
464 {
465   if (!_surf_init_status)
466     return;                     /* Not initialized yet. Nothing to do */
467
468   xbt_cfg_free(&_surf_cfg_set);
469   _surf_init_status = 0;
470 }
471
472 /* Pick the right models for CPU, net and workstation, and call their model_init_preparse */
473 void surf_config_models_setup()
474 {
475   char *workstation_model_name;
476   int workstation_id = -1;
477   char *network_model_name = NULL;
478   char *cpu_model_name = NULL;
479
480   workstation_model_name =
481       xbt_cfg_get_string(_surf_cfg_set, "workstation/model");
482   network_model_name = xbt_cfg_get_string(_surf_cfg_set, "network/model");
483   cpu_model_name = xbt_cfg_get_string(_surf_cfg_set, "cpu/model");
484
485   /* Check whether we use a net/cpu model differing from the default ones, in which case
486    * we should switch to the "compound" workstation model to correctly dispatch stuff to
487    * the right net/cpu models.
488    */
489
490   if((!xbt_cfg_is_default_value(_surf_cfg_set, "network/model") ||
491           !xbt_cfg_is_default_value(_surf_cfg_set, "cpu/model")) &&
492           xbt_cfg_is_default_value(_surf_cfg_set, "workstation/model"))
493   {
494             const char *val = "compound";
495             XBT_INFO
496                 ("Switching workstation model to compound since you changed the network and/or cpu model(s)");
497             xbt_cfg_set_string(_surf_cfg_set, "workstation/model", val);
498             workstation_model_name = (char *) "compound";
499   }
500
501   XBT_DEBUG("Workstation model: %s", workstation_model_name);
502   workstation_id =
503       find_model_description(surf_workstation_model_description,
504                              workstation_model_name);
505   if (!strcmp(workstation_model_name, "compound")) {
506     int network_id = -1;
507     int cpu_id = -1;
508
509     xbt_assert(cpu_model_name,
510                 "Set a cpu model to use with the 'compound' workstation model");
511
512     xbt_assert(network_model_name,
513                 "Set a network model to use with the 'compound' workstation model");
514
515     network_id =
516         find_model_description(surf_network_model_description,
517                                network_model_name);
518     cpu_id =
519         find_model_description(surf_cpu_model_description, cpu_model_name);
520
521     surf_cpu_model_description[cpu_id].model_init_preparse();
522     surf_network_model_description[network_id].model_init_preparse();
523   }
524
525   XBT_DEBUG("Call workstation_model_init");
526   surf_workstation_model_description[workstation_id].model_init_preparse();
527 }