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);
47 model_help("CPU", surf_cpu_model_description);
48 model_help("network", surf_network_model_description);
51 } else if (!strncmp(argv[i], "--help-tracing", strlen("--help-tracing") + 1)) {
56 if (remove_it) { /*remove this from argv */
57 for (j = i + 1; j < *argc; j++) {
58 argv[j - 1] = argv[j];
63 i--; /* compensate effect of next loop incrementation */
69 int _surf_init_status = 0; /* 0: beginning of time;
70 1: pre-inited (cfg_set created);
71 2: inited (running) */
73 /* callback of the workstation/model variable */
74 static void _surf_cfg_cb__workstation_model(const char *name, int pos)
78 xbt_assert(_surf_init_status < 2,
79 "Cannot change the model after the initialization");
81 val = xbt_cfg_get_string(_surf_cfg_set, name);
83 if (!strcmp(val, "help")) {
84 model_help("workstation", surf_workstation_model_description);
88 /* Make sure that the model exists */
89 find_model_description(surf_workstation_model_description, val);
92 /* callback of the cpu/model variable */
93 static void _surf_cfg_cb__cpu_model(const char *name, int pos)
97 xbt_assert(_surf_init_status < 2,
98 "Cannot change the model after the initialization");
100 val = xbt_cfg_get_string(_surf_cfg_set, name);
102 if (!strcmp(val, "help")) {
103 model_help("CPU", surf_cpu_model_description);
107 /* New Module missing */
108 find_model_description(surf_cpu_model_description, val);
111 /* callback of the cpu/model variable */
112 static void _surf_cfg_cb__optimization_mode(const char *name, int pos)
116 xbt_assert(_surf_init_status < 2,
117 "Cannot change the model after the initialization");
119 val = xbt_cfg_get_string(_surf_cfg_set, name);
121 if (!strcmp(val, "help")) {
122 model_help("optimization", surf_optimization_mode_description);
126 /* New Module missing */
127 find_model_description(surf_optimization_mode_description, val);
130 /* callback of the workstation_model variable */
131 static void _surf_cfg_cb__network_model(const char *name, int pos)
135 xbt_assert(_surf_init_status < 2,
136 "Cannot change the model after the initialization");
138 val = xbt_cfg_get_string(_surf_cfg_set, name);
140 if (!strcmp(val, "help")) {
141 model_help("network", surf_network_model_description);
145 /* New Module missing */
146 find_model_description(surf_network_model_description, val);
150 /* callbacks of the network models values */
151 static void _surf_cfg_cb__tcp_gamma(const char *name, int pos)
153 sg_tcp_gamma = xbt_cfg_get_double(_surf_cfg_set, name);
156 static void _surf_cfg_cb__maxmin_precision(const char* name, int pos)
158 sg_maxmin_precision = xbt_cfg_get_double(_surf_cfg_set, name);
161 static void _surf_cfg_cb__sender_gap(const char* name, int pos)
163 sg_sender_gap = xbt_cfg_get_double(_surf_cfg_set, name);
166 static void _surf_cfg_cb__latency_factor(const char *name, int pos)
168 sg_latency_factor = xbt_cfg_get_double(_surf_cfg_set, name);
171 static void _surf_cfg_cb__bandwidth_factor(const char *name, int pos)
173 sg_bandwidth_factor = xbt_cfg_get_double(_surf_cfg_set, name);
176 static void _surf_cfg_cb__weight_S(const char *name, int pos)
178 sg_weight_S_parameter = xbt_cfg_get_double(_surf_cfg_set, name);
181 /* callback of the inclusion path */
182 static void _surf_cfg_cb__surf_path(const char *name, int pos)
184 char *path = xbt_cfg_get_string_at(_surf_cfg_set, name, pos);
185 xbt_dynar_push(surf_path, &path);
188 /* callback to decide if we want to use the model-checking */
189 #include "xbt_modinter.h"
190 extern int _surf_do_model_check; /* this variable lives in xbt_main until I find a right location for it */
192 static void _surf_cfg_cb_model_check(const char *name, int pos)
194 _surf_do_model_check = xbt_cfg_get_int(_surf_cfg_set, name);
196 if (_surf_do_model_check) {
197 /* Tell modules using mallocators that they shouldn't. MC don't like them */
203 extern int _surf_do_verbose_exit;
205 static void _surf_cfg_cb_verbose_exit(const char *name, int pos)
207 _surf_do_verbose_exit = xbt_cfg_get_int(_surf_cfg_set, name);
211 static void _surf_cfg_cb_context_factory(const char *name, int pos)
213 smx_context_factory_name = xbt_cfg_get_string(_surf_cfg_set, name);
216 static void _surf_cfg_cb_context_stack_size(const char *name, int pos)
218 smx_context_stack_size = xbt_cfg_get_int(_surf_cfg_set, name) * 1024;
221 static void _surf_cfg_cb_contexts_nthreads(const char *name, int pos)
223 SIMIX_context_set_nthreads(xbt_cfg_get_int(_surf_cfg_set, name));
226 static void _surf_cfg_cb_contexts_parallel_threshold(const char *name, int pos)
228 SIMIX_context_set_parallel_threshold(xbt_cfg_get_int(_surf_cfg_set, name));
231 static void _surf_cfg_cb_contexts_parallel_mode(const char *name, int pos)
233 const char* mode_name = xbt_cfg_get_string(_surf_cfg_set, name);
234 if (!strcmp(mode_name, "posix")) {
235 SIMIX_context_set_parallel_mode(XBT_PARMAP_POSIX);
237 else if (!strcmp(mode_name, "futex")) {
238 SIMIX_context_set_parallel_mode(XBT_PARMAP_FUTEX);
240 else if (!strcmp(mode_name, "busy_wait")) {
241 SIMIX_context_set_parallel_mode(XBT_PARMAP_BUSY_WAIT);
244 XBT_WARN("Command line setting of the parallel synchronization mode should "
245 "be one of \"posix\", \"futex\" or \"busy_wait\"");
249 static void _surf_cfg_cb__surf_network_coordinates(const char *name,
252 char *val = xbt_cfg_get_string(_surf_cfg_set, name);
253 if (!strcmp(val, "yes")) {
254 if (!COORD_HOST_LEVEL) {
255 COORD_HOST_LEVEL = xbt_lib_add_level(host_lib,xbt_dynar_free_voidp);
256 COORD_ASR_LEVEL = xbt_lib_add_level(as_router_lib,xbt_dynar_free_voidp);
258 } else if (!strcmp(val, "no")) {
259 if (COORD_HOST_LEVEL)
260 XBT_WARN("Setting of whether to use coordinate cannot be disabled once set.");
262 XBT_WARN("Command line setting of whether to use coordinates must be either \"yes\" or \"no\"");
266 static void _surf_cfg_cb__surf_network_crosstraffic(const char *name,
269 sg_network_crosstraffic = xbt_cfg_get_int(_surf_cfg_set, name);
273 static void _surf_cfg_cb__gtnets_jitter(const char *name, int pos)
275 sg_gtnets_jitter = xbt_cfg_get_double(_surf_cfg_set, name);
278 static void _surf_cfg_cb__gtnets_jitter_seed(const char *name, int pos)
280 sg_gtnets_jitter_seed = xbt_cfg_get_int(_surf_cfg_set, name);
284 /* create the config set, register what should be and parse the command line*/
285 void surf_config_init(int *argc, char **argv)
287 char *description = xbt_malloc(1024), *p = description;
289 double double_default_value;
290 int default_value_int;
293 /* Create the configuration support */
294 if (_surf_init_status == 0) { /* Only create stuff if not already inited */
295 _surf_init_status = 1;
298 "The model to use for the CPU. Possible values: ");
300 while (*(++p) != '\0');
301 for (i = 0; surf_cpu_model_description[i].name; i++)
302 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
303 surf_cpu_model_description[i].name);
305 ".\n (use 'help' as a value to see the long description of each model)");
306 default_value = xbt_strdup("Cas01");
307 xbt_cfg_register(&_surf_cfg_set,
308 "cpu/model", description, xbt_cfgelm_string,
309 &default_value, 1, 1, &_surf_cfg_cb__cpu_model, NULL);
312 "The optimization modes to use for the CPU. Possible values: ");
314 while (*(++p) != '\0');
315 for (i = 0; surf_optimization_mode_description[i].name; i++)
316 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
317 surf_optimization_mode_description[i].name);
319 ".\n (use 'help' as a value to see the long description of each optimization mode)");
320 default_value = xbt_strdup("Lazy");
321 xbt_cfg_register(&_surf_cfg_set,
322 "cpu/optim", description, xbt_cfgelm_string,
323 &default_value, 1, 1, &_surf_cfg_cb__optimization_mode, NULL);
326 "The model to use for the network. Possible values: ");
328 while (*(++p) != '\0');
329 for (i = 0; surf_network_model_description[i].name; i++)
330 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
331 surf_network_model_description[i].name);
333 ".\n (use 'help' as a value to see the long description of each model)");
334 default_value = xbt_strdup("LV08");
335 xbt_cfg_register(&_surf_cfg_set,
336 "network/model", description, xbt_cfgelm_string,
337 &default_value, 1, 1, &_surf_cfg_cb__network_model,
341 "The optimization modes to use for the network. Possible values: ");
343 while (*(++p) != '\0');
344 for (i = 0; surf_optimization_mode_description[i].name; i++)
345 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
346 surf_optimization_mode_description[i].name);
348 ".\n (use 'help' as a value to see the long description of each optimization mode)");
349 default_value = xbt_strdup("Lazy");
350 xbt_cfg_register(&_surf_cfg_set,
351 "network/optim", description, xbt_cfgelm_string,
352 &default_value, 1, 1, &_surf_cfg_cb__optimization_mode, NULL);
355 "The model to use for the workstation. Possible values: ");
357 while (*(++p) != '\0');
358 for (i = 0; surf_workstation_model_description[i].name; i++)
359 p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
360 surf_workstation_model_description[i].name);
362 ".\n (use 'help' as a value to see the long description of each model)");
363 default_value = xbt_strdup("current_default");
364 xbt_cfg_register(&_surf_cfg_set,
365 "workstation/model", description, xbt_cfgelm_string,
366 &default_value, 1, 1,
367 &_surf_cfg_cb__workstation_model, NULL);
369 xbt_free(description);
371 default_value = xbt_strdup("Full");
372 xbt_cfg_register(&_surf_cfg_set, "routing",
373 "Model to use to store the routing information",
374 xbt_cfgelm_string, &default_value, 1, 1, NULL, NULL);
376 xbt_cfg_register(&_surf_cfg_set, "TCP_gamma",
377 "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)",
378 xbt_cfgelm_double, NULL, 1, 1,
379 _surf_cfg_cb__tcp_gamma, NULL);
380 xbt_cfg_setdefault_double(_surf_cfg_set, "TCP_gamma", 20000.0);
382 xbt_cfg_register(&_surf_cfg_set, "maxmin/precision",
383 "Minimum retained action value when updating simulation",
384 xbt_cfgelm_double, NULL, 1, 1, _surf_cfg_cb__maxmin_precision, NULL);
385 xbt_cfg_setdefault_double(_surf_cfg_set, "maxmin/precision", 0.00001); // FIXME use setdefault everywhere here!
387 /* The parameters of network models */
389 double_default_value = 0.0;
390 xbt_cfg_register(&_surf_cfg_set, "network/sender_gap",
391 "Minimum gap between two overlapping sends",
392 xbt_cfgelm_double, &double_default_value, 1, 1,
393 _surf_cfg_cb__sender_gap, NULL);
395 double_default_value = 1.0;
396 xbt_cfg_register(&_surf_cfg_set, "network/latency_factor",
397 "Correction factor to apply to the provided latency (default value set by network model)",
398 xbt_cfgelm_double, &double_default_value, 1, 1,
399 _surf_cfg_cb__latency_factor, NULL);
400 double_default_value = 1.0;
401 xbt_cfg_register(&_surf_cfg_set, "network/bandwidth_factor",
402 "Correction factor to apply to the provided bandwidth (default value set by network model)",
403 xbt_cfgelm_double, &double_default_value, 1, 1,
404 _surf_cfg_cb__bandwidth_factor, NULL);
405 double_default_value = 0.0;
406 xbt_cfg_register(&_surf_cfg_set, "network/weight_S",
407 "Correction factor to apply to the weight of competing streams(default value set by network model)",
408 xbt_cfgelm_double, &double_default_value, 1, 1,
409 _surf_cfg_cb__weight_S, NULL);
412 xbt_cfg_register(&_surf_cfg_set, "path",
413 "Lookup path for inclusions in platform and deployment XML files",
414 xbt_cfgelm_string, NULL, 0, 0,
415 _surf_cfg_cb__surf_path, NULL);
417 default_value_int = 0;
418 xbt_cfg_register(&_surf_cfg_set, "cpu/maxmin_selective_update",
419 "Update the constraint set propagating recursively to others constraints (1 by default when optim is set to lazy)",
420 xbt_cfgelm_int, &default_value_int, 0, 1,
422 default_value_int = 0;
423 xbt_cfg_register(&_surf_cfg_set, "network/maxmin_selective_update",
424 "Update the constraint set propagating recursively to others constraints (1 by default when optim is set to lazy)",
425 xbt_cfgelm_int, &default_value_int, 0, 1,
429 default_value_int = 0;
430 xbt_cfg_register(&_surf_cfg_set, "model-check",
431 "Activate the model-checking of the \"simulated\" system (EXPERIMENTAL -- msg only for now)",
432 xbt_cfgelm_int, &default_value_int, 0, 1,
433 _surf_cfg_cb_model_check, NULL);
436 FIXME: this function is not setting model-check to it's default value because
437 internally it calls to variable->cb_set that in this case is the function
438 _surf_cfg_cb_model_check which sets it's value to 1 (instead of the default value 0)
439 xbt_cfg_set_int(_surf_cfg_set, "model-check", default_value_int); */
441 /* do verbose-exit */
442 default_value_int = 0;
443 xbt_cfg_register(&_surf_cfg_set, "verbose-exit",
444 "Activate the \"do nothing\" mode in Ctrl-C",
445 xbt_cfgelm_int, &default_value_int, 0, 1,
446 _surf_cfg_cb_verbose_exit, NULL);
449 /* context factory */
450 default_value = xbt_strdup("ucontext");
451 xbt_cfg_register(&_surf_cfg_set, "contexts/factory",
452 "Context factory to use in SIMIX (ucontext, thread or raw)",
453 xbt_cfgelm_string, &default_value, 1, 1, _surf_cfg_cb_context_factory, NULL);
455 /* stack size of contexts in Ko */
456 default_value_int = 128;
457 xbt_cfg_register(&_surf_cfg_set, "contexts/stack_size",
458 "Stack size of contexts in Ko (ucontext or raw only)",
459 xbt_cfgelm_int, &default_value_int, 1, 1,
460 _surf_cfg_cb_context_stack_size, NULL);
462 /* number of parallel threads for user processes */
463 default_value_int = 1;
464 xbt_cfg_register(&_surf_cfg_set, "contexts/nthreads",
465 "Number of parallel threads for user contexts (EXPERIMENTAL)",
466 xbt_cfgelm_int, &default_value_int, 1, 1,
467 _surf_cfg_cb_contexts_nthreads, NULL);
469 /* minimal number of user contexts to be run in parallel */
470 default_value_int = 1;
471 xbt_cfg_register(&_surf_cfg_set, "contexts/parallel_threshold",
472 "Minimal number of user contexts to be run in parallel (raw contexts only)",
473 xbt_cfgelm_int, &default_value_int, 1, 1,
474 _surf_cfg_cb_contexts_parallel_threshold, NULL);
476 /* minimal number of user contexts to be run in parallel */
477 default_value = xbt_strdup("futex");
478 xbt_cfg_register(&_surf_cfg_set, "contexts/parallel_mode",
479 "Synchronization mode to use when running contexts in parallel",
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, "coordinates",
485 "\"yes\" or \"no\" (FIXME: document)",
486 xbt_cfgelm_string, &default_value, 1, 1,
487 _surf_cfg_cb__surf_network_coordinates, NULL);
488 xbt_cfg_setdefault_string(_surf_cfg_set, "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();