1 /* Copyright (c) 2009, 2010. The SimGrid Team.
2 * All rights reserved. */
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. */
7 /* surf_config: configuration infrastructure for the simulation world */
9 #include "xbt/config.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"
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_config, surf,
16 "About the configuration of surf (and the rest of the simulation)");
18 xbt_cfg_t _surf_cfg_set = NULL;
20 /* Parse the command line, looking for options */
21 static void surf_config_cmd_line(int *argc, char **argv)
26 for (i = 1; i < *argc; i++) {
28 if (!strncmp(argv[i], "--cfg=", strlen("--cfg="))) {
29 opt = strchr(argv[i], '=');
32 xbt_cfg_set_parse(_surf_cfg_set, opt);
33 XBT_DEBUG("Did apply '%s' as config setting", opt);
35 } else if (!strncmp(argv[i], "--cfg-help", strlen("--cfg-help") + 1) ||
36 !strncmp(argv[i], "--help", strlen("--help") + 1)) {
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");
42 printf("\nYou can also use --help-tracing to see the details of all tracing options known by this simulator.\n");
45 } else if (!strncmp(argv[i], "--help-models", strlen("--help-models") + 1)) {
46 model_help("workstation", surf_workstation_model_description);
48 model_help("CPU", surf_cpu_model_description);
50 model_help("network", surf_network_model_description);
51 printf("\nLong description of all optimization levels accepted by the models of this simulator:\n");
52 for (i = 0; surf_optimization_mode_description[i].name; i++)
53 printf(" %s: %s\n", surf_optimization_mode_description[i].name, surf_optimization_mode_description[i].description);
54 printf("Both network and CPU models have 'Lazy' as default optimization level\n");
57 } else if (!strncmp(argv[i], "--help-tracing", strlen("--help-tracing") + 1)) {
62 if (remove_it) { /*remove this from argv */
63 for (j = i + 1; j < *argc; j++) {
64 argv[j - 1] = argv[j];
69 i--; /* compensate effect of next loop incrementation */
75 int _surf_init_status = 0; /* 0: beginning of time;
76 1: pre-inited (cfg_set created);
77 2: inited (running) */
79 /* callback of the workstation/model variable */
80 static void _surf_cfg_cb__workstation_model(const char *name, int pos)
84 xbt_assert(_surf_init_status < 2,
85 "Cannot change the model after the initialization");
87 val = xbt_cfg_get_string(_surf_cfg_set, name);
89 if (!strcmp(val, "help")) {
90 model_help("workstation", surf_workstation_model_description);
94 /* Make sure that the model exists */
95 find_model_description(surf_workstation_model_description, val);
98 /* callback of the cpu/model variable */
99 static void _surf_cfg_cb__cpu_model(const char *name, int pos)
103 xbt_assert(_surf_init_status < 2,
104 "Cannot change the model after the initialization");
106 val = xbt_cfg_get_string(_surf_cfg_set, name);
108 if (!strcmp(val, "help")) {
109 model_help("CPU", surf_cpu_model_description);
113 /* New Module missing */
114 find_model_description(surf_cpu_model_description, val);
117 /* callback of the cpu/model variable */
118 static void _surf_cfg_cb__optimization_mode(const char *name, int pos)
122 xbt_assert(_surf_init_status < 2,
123 "Cannot change the model after the initialization");
125 val = xbt_cfg_get_string(_surf_cfg_set, name);
127 if (!strcmp(val, "help")) {
128 model_help("optimization", surf_optimization_mode_description);
132 /* New Module missing */
133 find_model_description(surf_optimization_mode_description, val);
136 /* callback of the workstation_model variable */
137 static void _surf_cfg_cb__network_model(const char *name, int pos)
141 xbt_assert(_surf_init_status < 2,
142 "Cannot change the model after the initialization");
144 val = xbt_cfg_get_string(_surf_cfg_set, name);
146 if (!strcmp(val, "help")) {
147 model_help("network", surf_network_model_description);
151 /* New Module missing */
152 find_model_description(surf_network_model_description, val);
156 /* callbacks of the network models values */
157 static void _surf_cfg_cb__tcp_gamma(const char *name, int pos)
159 sg_tcp_gamma = xbt_cfg_get_double(_surf_cfg_set, name);
162 static void _surf_cfg_cb__maxmin_precision(const char* name, int pos)
164 sg_maxmin_precision = xbt_cfg_get_double(_surf_cfg_set, name);
167 static void _surf_cfg_cb__sender_gap(const char* name, int pos)
169 sg_sender_gap = xbt_cfg_get_double(_surf_cfg_set, name);
172 static void _surf_cfg_cb__latency_factor(const char *name, int pos)
174 sg_latency_factor = xbt_cfg_get_double(_surf_cfg_set, name);
177 static void _surf_cfg_cb__bandwidth_factor(const char *name, int pos)
179 sg_bandwidth_factor = xbt_cfg_get_double(_surf_cfg_set, name);
182 static void _surf_cfg_cb__weight_S(const char *name, int pos)
184 sg_weight_S_parameter = xbt_cfg_get_double(_surf_cfg_set, name);
187 /* callback of the inclusion path */
188 static void _surf_cfg_cb__surf_path(const char *name, int pos)
190 char *path = xbt_cfg_get_string_at(_surf_cfg_set, name, pos);
191 xbt_dynar_push(surf_path, &path);
194 /* callback to decide if we want to use the model-checking */
195 #include "xbt_modinter.h"
196 extern int _surf_do_model_check; /* this variable lives in xbt_main until I find a right location for it */
198 static void _surf_cfg_cb_model_check(const char *name, int pos)
200 _surf_do_model_check = xbt_cfg_get_int(_surf_cfg_set, name);
202 if (_surf_do_model_check) {
203 /* Tell modules using mallocators that they shouldn't. MC don't like them */
209 extern int _surf_do_verbose_exit;
211 static void _surf_cfg_cb_verbose_exit(const char *name, int pos)
213 _surf_do_verbose_exit = xbt_cfg_get_int(_surf_cfg_set, name);
217 static void _surf_cfg_cb_context_factory(const char *name, int pos)
219 smx_context_factory_name = xbt_cfg_get_string(_surf_cfg_set, name);
222 static void _surf_cfg_cb_context_stack_size(const char *name, int pos)
224 smx_context_stack_size = xbt_cfg_get_int(_surf_cfg_set, name) * 1024;
227 static void _surf_cfg_cb_contexts_nthreads(const char *name, int pos)
229 SIMIX_context_set_nthreads(xbt_cfg_get_int(_surf_cfg_set, name));
232 static void _surf_cfg_cb_contexts_parallel_threshold(const char *name, int pos)
234 SIMIX_context_set_parallel_threshold(xbt_cfg_get_int(_surf_cfg_set, name));
237 static void _surf_cfg_cb_contexts_parallel_mode(const char *name, int pos)
239 const char* mode_name = xbt_cfg_get_string(_surf_cfg_set, name);
240 if (!strcmp(mode_name, "posix")) {
241 SIMIX_context_set_parallel_mode(XBT_PARMAP_POSIX);
243 else if (!strcmp(mode_name, "futex")) {
244 SIMIX_context_set_parallel_mode(XBT_PARMAP_FUTEX);
246 else if (!strcmp(mode_name, "busy_wait")) {
247 SIMIX_context_set_parallel_mode(XBT_PARMAP_BUSY_WAIT);
250 XBT_WARN("Command line setting of the parallel synchronization mode should "
251 "be one of \"posix\", \"futex\" or \"busy_wait\"");
255 static void _surf_cfg_cb__surf_network_coordinates(const char *name,
258 char *val = xbt_cfg_get_string(_surf_cfg_set, name);
259 if (!strcmp(val, "yes")) {
260 if (!COORD_HOST_LEVEL) {
261 COORD_HOST_LEVEL = xbt_lib_add_level(host_lib,xbt_dynar_free_voidp);
262 COORD_ASR_LEVEL = xbt_lib_add_level(as_router_lib,xbt_dynar_free_voidp);
264 } else if (!strcmp(val, "no")) {
265 if (COORD_HOST_LEVEL)
266 XBT_WARN("Setting of whether to use coordinate cannot be disabled once set.");
268 XBT_WARN("Command line setting of whether to use coordinates must be either \"yes\" or \"no\"");
272 static void _surf_cfg_cb__surf_network_crosstraffic(const char *name,
275 sg_network_crosstraffic = xbt_cfg_get_int(_surf_cfg_set, name);
279 static void _surf_cfg_cb__gtnets_jitter(const char *name, int pos)
281 sg_gtnets_jitter = xbt_cfg_get_double(_surf_cfg_set, name);
284 static void _surf_cfg_cb__gtnets_jitter_seed(const char *name, int pos)
286 sg_gtnets_jitter_seed = xbt_cfg_get_int(_surf_cfg_set, name);
290 /* create the config set, register what should be and parse the command line*/
291 void surf_config_init(int *argc, char **argv)
293 char *description = xbt_malloc(1024), *p = description;
295 double double_default_value;
296 int default_value_int;
299 /* Create the configuration support */
300 if (_surf_init_status == 0) { /* Only create stuff if not already inited */
301 _surf_init_status = 1;
304 "The model to use for the CPU. Possible values: ");
306 while (*(++p) != '\0');
307 for (i = 0; surf_cpu_model_description[i].name; i++)
308 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
309 surf_cpu_model_description[i].name);
311 ".\n (use 'help' as a value to see the long description of each model)");
312 default_value = xbt_strdup("Cas01");
313 xbt_cfg_register(&_surf_cfg_set,
314 "cpu/model", description, xbt_cfgelm_string,
315 &default_value, 1, 1, &_surf_cfg_cb__cpu_model, NULL);
318 "The optimization modes to use for the CPU. Possible values: ");
320 while (*(++p) != '\0');
321 for (i = 0; surf_optimization_mode_description[i].name; i++)
322 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
323 surf_optimization_mode_description[i].name);
325 ".\n (use 'help' as a value to see the long description of each optimization mode)");
326 default_value = xbt_strdup("Lazy");
327 xbt_cfg_register(&_surf_cfg_set,
328 "cpu/optim", description, xbt_cfgelm_string,
329 &default_value, 1, 1, &_surf_cfg_cb__optimization_mode, NULL);
332 "The model to use for the network. Possible values: ");
334 while (*(++p) != '\0');
335 for (i = 0; surf_network_model_description[i].name; i++)
336 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
337 surf_network_model_description[i].name);
339 ".\n (use 'help' as a value to see the long description of each model)");
340 default_value = xbt_strdup("LV08");
341 xbt_cfg_register(&_surf_cfg_set,
342 "network/model", description, xbt_cfgelm_string,
343 &default_value, 1, 1, &_surf_cfg_cb__network_model,
347 "The optimization modes to use for the network. Possible values: ");
349 while (*(++p) != '\0');
350 for (i = 0; surf_optimization_mode_description[i].name; i++)
351 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
352 surf_optimization_mode_description[i].name);
354 ".\n (use 'help' as a value to see the long description of each optimization mode)");
355 default_value = xbt_strdup("Lazy");
356 xbt_cfg_register(&_surf_cfg_set,
357 "network/optim", description, xbt_cfgelm_string,
358 &default_value, 1, 1, &_surf_cfg_cb__optimization_mode, NULL);
361 "The model to use for the workstation. Possible values: ");
363 while (*(++p) != '\0');
364 for (i = 0; surf_workstation_model_description[i].name; i++)
365 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
366 surf_workstation_model_description[i].name);
368 ".\n (use 'help' as a value to see the long description of each model)");
369 default_value = xbt_strdup("current_default");
370 xbt_cfg_register(&_surf_cfg_set,
371 "workstation/model", description, xbt_cfgelm_string,
372 &default_value, 1, 1,
373 &_surf_cfg_cb__workstation_model, NULL);
375 xbt_free(description);
377 default_value = xbt_strdup("Full");
378 xbt_cfg_register(&_surf_cfg_set, "routing",
379 "Model to use to store the routing information",
380 xbt_cfgelm_string, &default_value, 1, 1, NULL, NULL);
382 xbt_cfg_register(&_surf_cfg_set, "network/TCP_gamma",
383 "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)",
384 xbt_cfgelm_double, NULL, 1, 1,
385 _surf_cfg_cb__tcp_gamma, NULL);
386 xbt_cfg_setdefault_double(_surf_cfg_set, "network/TCP_gamma", 20000.0);
388 xbt_cfg_register(&_surf_cfg_set, "maxmin/precision",
389 "Numerical precision used when updating simulation models (epsilon in double comparisons)",
390 xbt_cfgelm_double, NULL, 1, 1, _surf_cfg_cb__maxmin_precision, NULL);
391 xbt_cfg_setdefault_double(_surf_cfg_set, "maxmin/precision", 0.00001); // FIXME use setdefault everywhere here!
393 /* The parameters of network models */
395 double_default_value = 0.0;
396 xbt_cfg_register(&_surf_cfg_set, "network/sender_gap",
397 "Minimum gap between two overlapping sends",
398 xbt_cfgelm_double, &double_default_value, 1, 1,
399 _surf_cfg_cb__sender_gap, NULL);
401 double_default_value = 1.0;
402 xbt_cfg_register(&_surf_cfg_set, "network/latency_factor",
403 "Correction factor to apply to the provided latency (default value set by network model)",
404 xbt_cfgelm_double, &double_default_value, 1, 1,
405 _surf_cfg_cb__latency_factor, NULL);
406 double_default_value = 1.0;
407 xbt_cfg_register(&_surf_cfg_set, "network/bandwidth_factor",
408 "Correction factor to apply to the provided bandwidth (default value set by network model)",
409 xbt_cfgelm_double, &double_default_value, 1, 1,
410 _surf_cfg_cb__bandwidth_factor, NULL);
411 double_default_value = 0.0;
412 xbt_cfg_register(&_surf_cfg_set, "network/weight_S",
413 "Correction factor to apply to the weight of competing streams(default value set by network model)",
414 xbt_cfgelm_double, &double_default_value, 1, 1,
415 _surf_cfg_cb__weight_S, NULL);
418 xbt_cfg_register(&_surf_cfg_set, "path",
419 "Lookup path for inclusions in platform and deployment XML files",
420 xbt_cfgelm_string, NULL, 0, 0,
421 _surf_cfg_cb__surf_path, NULL);
423 default_value_int = 0;
424 xbt_cfg_register(&_surf_cfg_set, "cpu/maxmin_selective_update",
425 "Update the constraint set propagating recursively to others constraints (1 by default when optim is set to lazy)",
426 xbt_cfgelm_int, &default_value_int, 0, 1,
428 default_value_int = 0;
429 xbt_cfg_register(&_surf_cfg_set, "network/maxmin_selective_update",
430 "Update the constraint set propagating recursively to others constraints (1 by default when optim is set to lazy)",
431 xbt_cfgelm_int, &default_value_int, 0, 1,
435 default_value_int = 0;
436 xbt_cfg_register(&_surf_cfg_set, "model-check",
437 "Activate the model-checking of the \"simulated\" system (EXPERIMENTAL -- msg only for now)",
438 xbt_cfgelm_int, &default_value_int, 0, 1,
439 _surf_cfg_cb_model_check, NULL);
442 FIXME: this function is not setting model-check to it's default value because
443 internally it calls to variable->cb_set that in this case is the function
444 _surf_cfg_cb_model_check which sets it's value to 1 (instead of the default value 0)
445 xbt_cfg_set_int(_surf_cfg_set, "model-check", default_value_int); */
447 /* do verbose-exit */
448 default_value_int = 0;
449 xbt_cfg_register(&_surf_cfg_set, "verbose-exit",
450 "Activate the \"do nothing\" mode in Ctrl-C",
451 xbt_cfgelm_int, &default_value_int, 0, 1,
452 _surf_cfg_cb_verbose_exit, NULL);
455 /* context factory */
456 default_value = xbt_strdup("ucontext");
457 xbt_cfg_register(&_surf_cfg_set, "contexts/factory",
458 "Context factory to use in SIMIX (ucontext, thread or raw)",
459 xbt_cfgelm_string, &default_value, 1, 1, _surf_cfg_cb_context_factory, NULL);
461 /* stack size of contexts in Ko */
462 default_value_int = 128;
463 xbt_cfg_register(&_surf_cfg_set, "contexts/stack_size",
464 "Stack size of contexts in Ko (ucontext or raw only)",
465 xbt_cfgelm_int, &default_value_int, 1, 1,
466 _surf_cfg_cb_context_stack_size, NULL);
468 /* number of parallel threads for user processes */
469 default_value_int = 1;
470 xbt_cfg_register(&_surf_cfg_set, "contexts/nthreads",
471 "Number of parallel threads for user contexts (EXPERIMENTAL)",
472 xbt_cfgelm_int, &default_value_int, 1, 1,
473 _surf_cfg_cb_contexts_nthreads, NULL);
475 /* minimal number of user contexts to be run in parallel */
476 default_value_int = 1;
477 xbt_cfg_register(&_surf_cfg_set, "contexts/parallel_threshold",
478 "Minimal number of user contexts to be run in parallel (raw contexts only)",
479 xbt_cfgelm_int, &default_value_int, 1, 1,
480 _surf_cfg_cb_contexts_parallel_threshold, NULL);
482 /* minimal number of user contexts to be run in parallel */
483 default_value = xbt_strdup("futex");
484 xbt_cfg_register(&_surf_cfg_set, "contexts/parallel_mode",
485 "Synchronization mode to use when running contexts in parallel",
486 xbt_cfgelm_string, &default_value, 1, 1,
487 _surf_cfg_cb_contexts_parallel_mode, NULL);
489 default_value = xbt_strdup("no");
490 xbt_cfg_register(&_surf_cfg_set, "coordinates",
491 "\"yes\" or \"no\" (FIXME: document)",
492 xbt_cfgelm_string, &default_value, 1, 1,
493 _surf_cfg_cb__surf_network_coordinates, NULL);
494 xbt_cfg_setdefault_string(_surf_cfg_set, "coordinates", default_value);
496 default_value_int = 0;
497 xbt_cfg_register(&_surf_cfg_set, "network/crosstraffic",
498 "Activate the interferences between uploads and downloads for fluid max-min models (LV08, CM02)",
499 xbt_cfgelm_int, &default_value_int, 0, 1,
500 _surf_cfg_cb__surf_network_crosstraffic, NULL);
501 xbt_cfg_setdefault_int(_surf_cfg_set, "network/crosstraffic", default_value_int);
504 xbt_cfg_register(&_surf_cfg_set, "gtnets_jitter",
505 "Double value to oscillate the link latency, uniformly in random interval [-latency*gtnets_jitter,latency*gtnets_jitter)",
506 xbt_cfgelm_double, NULL, 1, 1,
507 _surf_cfg_cb__gtnets_jitter, NULL);
508 xbt_cfg_setdefault_double(_surf_cfg_set, "gtnets_jitter", 0.0);
510 default_value_int = 10;
511 xbt_cfg_register(&_surf_cfg_set, "gtnets_jitter_seed",
512 "Use a positive seed to reproduce jitted results, value must be in [1,1e8], default is 10",
513 xbt_cfgelm_int, &default_value_int, 0, 1,
514 _surf_cfg_cb__gtnets_jitter_seed, NULL);
517 xbt_cfg_register(&_surf_cfg_set, "ns3/TcpModel",
518 "The ns3 tcp model can be : NewReno or Reno or Tahoe",
519 xbt_cfgelm_string, NULL, 1, 1,
521 xbt_cfg_setdefault_string(_surf_cfg_set, "ns3/TcpModel", "default");
524 /* retrieves the current directory of the current process */
525 const char *initial_path = __surf_get_initial_path();
526 xbt_assert((initial_path),
527 "__surf_get_initial_path() failed! Can't resolves current Windows directory");
529 surf_path = xbt_dynar_new(sizeof(char *), NULL);
530 xbt_cfg_setdefault_string(_surf_cfg_set, "path", initial_path);
534 surf_config_cmd_line(argc, argv);
536 XBT_WARN("Call to surf_config_init() after initialization ignored");
540 void surf_config_finalize(void)
542 if (!_surf_init_status)
543 return; /* Not initialized yet. Nothing to do */
545 xbt_cfg_free(&_surf_cfg_set);
546 _surf_init_status = 0;
549 /* Pick the right models for CPU, net and workstation, and call their model_init_preparse */
550 void surf_config_models_setup()
552 char *workstation_model_name;
553 int workstation_id = -1;
554 char *network_model_name = NULL;
555 char *cpu_model_name = NULL;
557 workstation_model_name =
558 xbt_cfg_get_string(_surf_cfg_set, "workstation/model");
559 network_model_name = xbt_cfg_get_string(_surf_cfg_set, "network/model");
560 cpu_model_name = xbt_cfg_get_string(_surf_cfg_set, "cpu/model");
562 /* Check whether we use a net/cpu model differing from the default ones, in which case
563 * we should switch to the "compound" workstation model to correctly dispatch stuff to
564 * the right net/cpu models.
567 if((!xbt_cfg_is_default_value(_surf_cfg_set, "network/model") ||
568 !xbt_cfg_is_default_value(_surf_cfg_set, "cpu/model")) &&
569 xbt_cfg_is_default_value(_surf_cfg_set, "workstation/model"))
571 const char *val = "compound";
573 ("Switching workstation model to compound since you changed the network and/or cpu model(s)");
574 xbt_cfg_set_string(_surf_cfg_set, "workstation/model", val);
575 workstation_model_name = (char *) "compound";
578 XBT_DEBUG("Workstation model: %s", workstation_model_name);
580 find_model_description(surf_workstation_model_description,
581 workstation_model_name);
582 if (!strcmp(workstation_model_name, "compound")) {
586 xbt_assert(cpu_model_name,
587 "Set a cpu model to use with the 'compound' workstation model");
589 xbt_assert(network_model_name,
590 "Set a network model to use with the 'compound' workstation model");
593 find_model_description(surf_network_model_description,
596 find_model_description(surf_cpu_model_description, cpu_model_name);
598 surf_cpu_model_description[cpu_id].model_init_preparse();
599 surf_network_model_description[network_id].model_init_preparse();
602 XBT_DEBUG("Call workstation_model_init");
603 surf_workstation_model_description[workstation_id].model_init_preparse();