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_die("Setting of whether to use coordinate cannot be disabled once set.");
268 xbt_die("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, "cpu/model", description, xbt_cfgelm_string,
314 &default_value, 1, 1, &_surf_cfg_cb__cpu_model, NULL);
317 "The optimization modes to use for the CPU. Possible values: ");
319 while (*(++p) != '\0');
320 for (i = 0; surf_optimization_mode_description[i].name; i++)
321 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
322 surf_optimization_mode_description[i].name);
324 ".\n (use 'help' as a value to see the long description of each optimization mode)");
325 default_value = xbt_strdup("Lazy");
326 xbt_cfg_register(&_surf_cfg_set, "cpu/optim", description, xbt_cfgelm_string,
327 &default_value, 1, 1, &_surf_cfg_cb__optimization_mode, NULL);
330 "The model to use for the network. Possible values: ");
332 while (*(++p) != '\0');
333 for (i = 0; surf_network_model_description[i].name; i++)
334 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
335 surf_network_model_description[i].name);
337 ".\n (use 'help' as a value to see the long description of each model)");
338 default_value = xbt_strdup("LV08");
339 xbt_cfg_register(&_surf_cfg_set, "network/model", description, xbt_cfgelm_string,
340 &default_value, 1, 1, &_surf_cfg_cb__network_model,
344 "The optimization modes to use for the network. Possible values: ");
346 while (*(++p) != '\0');
347 for (i = 0; surf_optimization_mode_description[i].name; i++)
348 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
349 surf_optimization_mode_description[i].name);
351 ".\n (use 'help' as a value to see the long description of each optimization mode)");
352 default_value = xbt_strdup("Lazy");
353 xbt_cfg_register(&_surf_cfg_set, "network/optim", description, xbt_cfgelm_string,
354 &default_value, 1, 1, &_surf_cfg_cb__optimization_mode, NULL);
357 "The model to use for the workstation. Possible values: ");
359 while (*(++p) != '\0');
360 for (i = 0; surf_workstation_model_description[i].name; i++)
361 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
362 surf_workstation_model_description[i].name);
364 ".\n (use 'help' as a value to see the long description of each model)");
365 default_value = xbt_strdup("default");
366 xbt_cfg_register(&_surf_cfg_set, "workstation/model", description, xbt_cfgelm_string,
367 &default_value, 1, 1,
368 &_surf_cfg_cb__workstation_model, NULL);
370 xbt_free(description);
372 xbt_cfg_register(&_surf_cfg_set, "network/TCP_gamma",
373 "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)",
374 xbt_cfgelm_double, NULL, 1, 1,
375 _surf_cfg_cb__tcp_gamma, NULL);
376 xbt_cfg_setdefault_double(_surf_cfg_set, "network/TCP_gamma", 20000.0);
378 xbt_cfg_register(&_surf_cfg_set, "maxmin/precision",
379 "Numerical precision used when updating simulation models (epsilon in double comparisons)",
380 xbt_cfgelm_double, NULL, 1, 1, _surf_cfg_cb__maxmin_precision, NULL);
381 xbt_cfg_setdefault_double(_surf_cfg_set, "maxmin/precision", 0.00001); // FIXME use setdefault everywhere here!
383 /* The parameters of network models */
385 double_default_value = 0.0;
386 xbt_cfg_register(&_surf_cfg_set, "network/sender_gap",
387 "Minimum gap between two overlapping sends",
388 xbt_cfgelm_double, &double_default_value, 1, 1,
389 _surf_cfg_cb__sender_gap, NULL);
391 double_default_value = 1.0;
392 xbt_cfg_register(&_surf_cfg_set, "network/latency_factor",
393 "Correction factor to apply to the provided latency (default value set by network model)",
394 xbt_cfgelm_double, &double_default_value, 1, 1,
395 _surf_cfg_cb__latency_factor, NULL);
396 double_default_value = 1.0;
397 xbt_cfg_register(&_surf_cfg_set, "network/bandwidth_factor",
398 "Correction factor to apply to the provided bandwidth (default value set by network model)",
399 xbt_cfgelm_double, &double_default_value, 1, 1,
400 _surf_cfg_cb__bandwidth_factor, NULL);
401 double_default_value = 0.0;
402 xbt_cfg_register(&_surf_cfg_set, "network/weight_S",
403 "Correction factor to apply to the weight of competing streams(default value set by network model)",
404 xbt_cfgelm_double, &double_default_value, 1, 1,
405 _surf_cfg_cb__weight_S, NULL);
408 xbt_cfg_register(&_surf_cfg_set, "path",
409 "Lookup path for inclusions in platform and deployment XML files",
410 xbt_cfgelm_string, NULL, 0, 0,
411 _surf_cfg_cb__surf_path, NULL);
413 default_value_int = 0;
414 xbt_cfg_register(&_surf_cfg_set, "cpu/maxmin_selective_update",
415 "Update the constraint set propagating recursively to others constraints (1 by default when optim is set to lazy)",
416 xbt_cfgelm_int, &default_value_int, 0, 1,
418 default_value_int = 0;
419 xbt_cfg_register(&_surf_cfg_set, "network/maxmin_selective_update",
420 "Update the constraint set propagating recursively to others constraints (1 by default when optim is set to lazy)",
421 xbt_cfgelm_int, &default_value_int, 0, 1,
425 default_value_int = 0;
426 xbt_cfg_register(&_surf_cfg_set, "model-check",
427 "Activate the model-checking of the \"simulated\" system (EXPERIMENTAL -- msg only for now)",
428 xbt_cfgelm_int, &default_value_int, 0, 1,
429 _surf_cfg_cb_model_check, NULL);
432 FIXME: this function is not setting model-check to it's default value because
433 internally it calls to variable->cb_set that in this case is the function
434 _surf_cfg_cb_model_check which sets it's value to 1 (instead of the default value 0)
435 xbt_cfg_set_int(_surf_cfg_set, "model-check", default_value_int); */
437 /* do verbose-exit */
438 default_value_int = 1;
439 xbt_cfg_register(&_surf_cfg_set, "verbose-exit",
440 "Activate the \"do nothing\" mode in Ctrl-C",
441 xbt_cfgelm_int, &default_value_int, 0, 1,
442 _surf_cfg_cb_verbose_exit, NULL);
445 /* context factory */
446 default_value = xbt_strdup("ucontext");
447 xbt_cfg_register(&_surf_cfg_set, "contexts/factory",
448 "Context factory to use in SIMIX (ucontext, thread or raw)",
449 xbt_cfgelm_string, &default_value, 1, 1, _surf_cfg_cb_context_factory, NULL);
451 /* stack size of contexts in Ko */
452 default_value_int = 128;
453 xbt_cfg_register(&_surf_cfg_set, "contexts/stack_size",
454 "Stack size of contexts in Kib (ucontext or raw only)",
455 xbt_cfgelm_int, &default_value_int, 1, 1,
456 _surf_cfg_cb_context_stack_size, NULL);
458 /* number of parallel threads for user processes */
459 default_value_int = 1;
460 xbt_cfg_register(&_surf_cfg_set, "contexts/nthreads",
461 "Number of parallel threads used to execute user contexts",
462 xbt_cfgelm_int, &default_value_int, 1, 1,
463 _surf_cfg_cb_contexts_nthreads, NULL);
465 /* minimal number of user contexts to be run in parallel */
466 default_value_int = 2;
467 xbt_cfg_register(&_surf_cfg_set, "contexts/parallel_threshold",
468 "Minimal number of user contexts to be run in parallel (raw contexts only)",
469 xbt_cfgelm_int, &default_value_int, 1, 1,
470 _surf_cfg_cb_contexts_parallel_threshold, NULL);
472 /* minimal number of user contexts to be run in parallel */
474 default_value = xbt_strdup("futex");
475 #else //No futex on mac and posix is unimplememted yet
476 default_value = xbt_strdup("busy_wait");
478 xbt_cfg_register(&_surf_cfg_set, "contexts/synchro",
479 "Synchronization mode to use when running contexts in parallel (either futex, posix or busy_wait)",
480 xbt_cfgelm_string, &default_value, 1, 1,
481 _surf_cfg_cb_contexts_parallel_mode, NULL);
483 default_value = xbt_strdup("no");
484 xbt_cfg_register(&_surf_cfg_set, "network/coordinates",
485 "\"yes\" or \"no\", specifying whether we use a coordinate-based routing (as Vivaldi)",
486 xbt_cfgelm_string, &default_value, 1, 1,
487 _surf_cfg_cb__surf_network_coordinates, NULL);
488 xbt_cfg_setdefault_string(_surf_cfg_set, "network/coordinates", default_value);
490 default_value_int = 0;
491 xbt_cfg_register(&_surf_cfg_set, "network/crosstraffic",
492 "Activate the interferences between uploads and downloads for fluid max-min models (LV08, CM02)",
493 xbt_cfgelm_int, &default_value_int, 0, 1,
494 _surf_cfg_cb__surf_network_crosstraffic, NULL);
495 xbt_cfg_setdefault_int(_surf_cfg_set, "network/crosstraffic", default_value_int);
498 xbt_cfg_register(&_surf_cfg_set, "gtnets/jitter",
499 "Double value to oscillate the link latency, uniformly in random interval [-latency*gtnets_jitter,latency*gtnets_jitter)",
500 xbt_cfgelm_double, NULL, 1, 1,
501 _surf_cfg_cb__gtnets_jitter, NULL);
502 xbt_cfg_setdefault_double(_surf_cfg_set, "gtnets_jitter", 0.0);
504 default_value_int = 10;
505 xbt_cfg_register(&_surf_cfg_set, "gtnets/jitter_seed",
506 "Use a positive seed to reproduce jitted results, value must be in [1,1e8], default is 10",
507 xbt_cfgelm_int, &default_value_int, 0, 1,
508 _surf_cfg_cb__gtnets_jitter_seed, NULL);
511 xbt_cfg_register(&_surf_cfg_set, "ns3/TcpModel",
512 "The ns3 tcp model can be : NewReno or Reno or Tahoe",
513 xbt_cfgelm_string, NULL, 1, 1,
515 xbt_cfg_setdefault_string(_surf_cfg_set, "ns3/TcpModel", "default");
518 /* retrieves the current directory of the current process */
519 const char *initial_path = __surf_get_initial_path();
520 xbt_assert((initial_path),
521 "__surf_get_initial_path() failed! Can't resolves current Windows directory");
523 surf_path = xbt_dynar_new(sizeof(char *), NULL);
524 xbt_cfg_setdefault_string(_surf_cfg_set, "path", initial_path);
528 surf_config_cmd_line(argc, argv);
530 XBT_WARN("Call to surf_config_init() after initialization ignored");
534 void surf_config_finalize(void)
536 if (!_surf_init_status)
537 return; /* Not initialized yet. Nothing to do */
539 xbt_cfg_free(&_surf_cfg_set);
540 _surf_init_status = 0;
543 /* Pick the right models for CPU, net and workstation, and call their model_init_preparse */
544 void surf_config_models_setup()
546 char *workstation_model_name;
547 int workstation_id = -1;
548 char *network_model_name = NULL;
549 char *cpu_model_name = NULL;
551 workstation_model_name =
552 xbt_cfg_get_string(_surf_cfg_set, "workstation/model");
553 network_model_name = xbt_cfg_get_string(_surf_cfg_set, "network/model");
554 cpu_model_name = xbt_cfg_get_string(_surf_cfg_set, "cpu/model");
556 /* Check whether we use a net/cpu model differing from the default ones, in which case
557 * we should switch to the "compound" workstation model to correctly dispatch stuff to
558 * the right net/cpu models.
561 if((!xbt_cfg_is_default_value(_surf_cfg_set, "network/model") ||
562 !xbt_cfg_is_default_value(_surf_cfg_set, "cpu/model")) &&
563 xbt_cfg_is_default_value(_surf_cfg_set, "workstation/model"))
565 const char *val = "compound";
567 ("Switching workstation model to compound since you changed the network and/or cpu model(s)");
568 xbt_cfg_set_string(_surf_cfg_set, "workstation/model", val);
569 workstation_model_name = (char *) "compound";
572 XBT_DEBUG("Workstation model: %s", workstation_model_name);
574 find_model_description(surf_workstation_model_description,
575 workstation_model_name);
576 if (!strcmp(workstation_model_name, "compound")) {
580 xbt_assert(cpu_model_name,
581 "Set a cpu model to use with the 'compound' workstation model");
583 xbt_assert(network_model_name,
584 "Set a network model to use with the 'compound' workstation model");
587 find_model_description(surf_network_model_description,
590 find_model_description(surf_cpu_model_description, cpu_model_name);
592 surf_cpu_model_description[cpu_id].model_init_preparse();
593 surf_network_model_description[network_id].model_init_preparse();
596 XBT_DEBUG("Call workstation_model_init");
597 surf_workstation_model_description[workstation_id].model_init_preparse();