Logo AND Algorithmique Numérique Distribuée

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