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
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_config, surf,
  14                                 "About the configuration of surf (and the rest of the simulation)");
  15
  16 xbt_cfg_t _surf_cfg_set = NULL;
  17
  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("Description of the configuration accepted by this simulator:\n");
  37       xbt_cfg_help(_surf_cfg_set);
  38       printf("\nYou can also use --help-models to see the details of all models known by this simulator.\n");
  39       exit(0);
  40     } else if (!strncmp(argv[i], "--help-models", strlen("--help-models")+1)) {
  41       model_help("workstation",surf_workstation_model_description);
  42       model_help("CPU",surf_cpu_model_description);
  43       model_help("network",surf_network_model_description);
  44       exit(0);
  45     }
  46     if (remove_it) {            /*remove this from argv */
  47       for (j = i + 1; j < *argc; j++) {
  48         argv[j - 1] = argv[j];
  49       }
  50
  51       argv[j - 1] = NULL;
  52       (*argc)--;
  53       i--;                      /* compensate effect of next loop incrementation */
  54     }
  55   }
  56 }
  57
  58
  59 int _surf_init_status = 0;      /* 0: beginning of time;
  60                                    1: pre-inited (cfg_set created);
  61                                    2: inited (running) */
  62
  63 /* callback of the workstation/model variable */
  64 static void _surf_cfg_cb__workstation_model(const char *name, int pos)
  65 {
  66   char *val;
  67
  68   xbt_assert0(_surf_init_status < 2,
  69               "Cannot change the model after the initialization");
  70
  71   val = xbt_cfg_get_string(_surf_cfg_set, name);
  72
  73   if (!strcmp(val,"help")) {
  74     model_help("workstation",surf_workstation_model_description);
  75     exit(0);
  76   }
  77
  78   /* Make sure that the model exists */
  79   find_model_description(surf_workstation_model_description, val);
  80 }
  81
  82 /* callback of the cpu/model variable */
  83 static void _surf_cfg_cb__cpu_model(const char *name, int pos)
  84 {
  85   char *val;
  86
  87   xbt_assert0(_surf_init_status < 2,
  88               "Cannot change the model after the initialization");
  89
  90   val = xbt_cfg_get_string(_surf_cfg_set, name);
  91
  92   if (!strcmp(val,"help")) {
  93     model_help("CPU",surf_cpu_model_description);
  94     exit(0);
  95   }
  96
  97   /* New Module missing */
  98   find_model_description(surf_cpu_model_description, val);
  99 }
 100
 101 /* callback of the workstation_model variable */
 102 static void _surf_cfg_cb__network_model(const char *name, int pos)
 103 {
 104   char *val;
 105
 106   xbt_assert0(_surf_init_status < 2,
 107               "Cannot change the model after the initialization");
 108
 109   val = xbt_cfg_get_string(_surf_cfg_set, name);
 110
 111   if (!strcmp(val,"help")) {
 112     model_help("network",surf_network_model_description);
 113     exit(0);
 114   }
 115
 116   /* New Module missing */
 117   find_model_description(surf_network_model_description, val);
 118 }
 119
 120
 121 /* callbacks of the network models values */
 122 static void _surf_cfg_cb__tcp_gamma(const char *name, int pos) {
 123   sg_tcp_gamma = xbt_cfg_get_double(_surf_cfg_set, name);
 124 }
 125 static void _surf_cfg_cb__latency_factor(const char *name, int pos) {
 126   sg_latency_factor = xbt_cfg_get_double(_surf_cfg_set, name);
 127 }
 128 static void _surf_cfg_cb__bandwidth_factor(const char *name, int pos) {
 129   sg_bandwidth_factor = xbt_cfg_get_double(_surf_cfg_set, name);
 130 }
 131 static void _surf_cfg_cb__weight_S(const char *name, int pos) {
 132   sg_weight_S_parameter = xbt_cfg_get_double(_surf_cfg_set, name);
 133 }
 134 static void _surf_cfg_cb__surf_maxmin_selective_update(const char *name, int pos) {
 135         sg_maxmin_selective_update = xbt_cfg_get_int(_surf_cfg_set, name);
 136 }
 137
 138 /* callback of the inclusion path */
 139 static void _surf_cfg_cb__surf_path(const char *name, int pos) {
 140   char *path = xbt_cfg_get_string_at(_surf_cfg_set, name, pos);
 141   xbt_dynar_push(surf_path, &path);
 142 }
 143
 144 /* callback to decide if we want to use the model-checking */
 145 int _surf_do_model_check = 0; /* this variable is used accros the lib */
 146
 147 static void _surf_cfg_cb_model_check(const char *name, int pos) {
 148   _surf_do_model_check = 1;
 149 }
 150
 151 #ifdef HAVE_GTNETS
 152 static void _surf_cfg_cb__gtnets_jitter(const char *name, int pos){
 153         sg_gtnets_jitter = xbt_cfg_get_double(_surf_cfg_set, name);
 154 }
 155 static void _surf_cfg_cb__gtnets_jitter_seed(const char *name, int pos){
 156         sg_gtnets_jitter_seed = xbt_cfg_get_int(_surf_cfg_set, name);
 157 }
 158 #endif
 159
 160 /* create the config set, register what should be and parse the command line*/
 161 void surf_config_init(int *argc, char **argv)
 162 {
 163
 164   /* Create the configuration support */
 165   if (_surf_init_status == 0) { /* Only create stuff if not already inited */
 166     _surf_init_status = 1;
 167
 168     char *description = xbt_malloc(1024), *p = description;
 169     char *default_value;
 170     double double_default_value;
 171         int default_value_int;
 172     int i;
 173
 174     sprintf(description, "The model to use for the CPU. Possible values: ");
 175     p = description;
 176     while (*(++p) != '\0');
 177     for (i = 0; surf_cpu_model_description[i].name; i++)
 178       p +=
 179         sprintf(p, "%s%s", (i == 0 ? "" : ", "),
 180                 surf_cpu_model_description[i].name);
 181     sprintf(p,".\n       (use 'help' as a value to see the long description of each model)");
 182     default_value = xbt_strdup("Cas01");
 183     xbt_cfg_register(&_surf_cfg_set,
 184                      "cpu/model", description, xbt_cfgelm_string,
 185                      &default_value, 1, 1, &_surf_cfg_cb__cpu_model, NULL);
 186
 187     sprintf(description,
 188             "The model to use for the network. Possible values: ");
 189     p = description;
 190     while (*(++p) != '\0');
 191     for (i = 0; surf_network_model_description[i].name; i++)
 192       p +=
 193         sprintf(p, "%s%s", (i == 0 ? "" : ", "),
 194                 surf_network_model_description[i].name);
 195     sprintf(p,".\n       (use 'help' as a value to see the long description of each model)");
 196     default_value = xbt_strdup("LV08");
 197     xbt_cfg_register(&_surf_cfg_set,
 198                      "network/model", description, xbt_cfgelm_string,
 199                      &default_value, 1, 1, &_surf_cfg_cb__network_model,
 200                      NULL);
 201
 202     sprintf(description,
 203             "The model to use for the workstation. Possible values: ");
 204     p = description;
 205     while (*(++p) != '\0');
 206     for (i = 0; surf_workstation_model_description[i].name; i++)
 207       p +=
 208         sprintf(p, "%s%s", (i == 0 ? "" : ", "),
 209                 surf_workstation_model_description[i].name);
 210     sprintf(p,".\n       (use 'help' as a value to see the long description of each model)");
 211     default_value = xbt_strdup("CLM03");
 212     xbt_cfg_register(&_surf_cfg_set,
 213                      "workstation/model", description, xbt_cfgelm_string,
 214                      &default_value, 1, 1, &_surf_cfg_cb__workstation_model,
 215                      NULL);
 216
 217     xbt_free(description);
 218
 219     default_value = xbt_strdup("Full");
 220     xbt_cfg_register(&_surf_cfg_set, "routing",
 221                      "Model to use to store the routing information",
 222                      xbt_cfgelm_string, &default_value, 1, 1, NULL, NULL);
 223
 224     xbt_cfg_register(&_surf_cfg_set, "TCP_gamma",
 225                      "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)",
 226                      xbt_cfgelm_double, NULL, 1, 1, _surf_cfg_cb__tcp_gamma, NULL);
 227     xbt_cfg_set_double(_surf_cfg_set, "TCP_gamma", 20000.0);
 228
 229     /* The parameters of network models */
 230     double_default_value = 1.0;
 231     xbt_cfg_register(&_surf_cfg_set, "network/latency_factor",
 232                      "Correction factor to apply to the provided latency (default value set by network model)",
 233                      xbt_cfgelm_double, &double_default_value, 1, 1, _surf_cfg_cb__latency_factor, NULL);
 234     double_default_value = 1.0;
 235     xbt_cfg_register(&_surf_cfg_set, "network/bandwidth_factor",
 236                      "Correction factor to apply to the provided bandwidth (default value set by network model)",
 237                      xbt_cfgelm_double, &double_default_value, 1, 1, _surf_cfg_cb__bandwidth_factor, NULL);
 238     double_default_value = 0.0;
 239     xbt_cfg_register(&_surf_cfg_set, "network/weight_S",
 240                      "Correction factor to apply to the weight of competing streams(default value set by network model)",
 241                      xbt_cfgelm_double, &double_default_value, 1, 1, _surf_cfg_cb__weight_S, NULL);
 242
 243     /* Inclusion path */
 244     xbt_cfg_register(&_surf_cfg_set, "path",
 245                      "Lookup path for inclusions in platform and deployment XML files",
 246                      xbt_cfgelm_string, NULL, 0, 0, _surf_cfg_cb__surf_path,
 247                      NULL);
 248
 249                 default_value_int = 0;
 250     xbt_cfg_register(&_surf_cfg_set, "maxmin_selective_update",
 251                      "Update the constraint set propagating recursively to others constraints",
 252                      xbt_cfgelm_int, &default_value_int, 0, 1, _surf_cfg_cb__surf_maxmin_selective_update, NULL);
 253
 254     /* do model-check */
 255     default_value_int = 0;
 256     xbt_cfg_register(&_surf_cfg_set, "model-check",
 257                      "Activate the model-checking of the \"simulated\" system (EXPERIMENTAL -- msg only for now)",
 258                      xbt_cfgelm_int, &default_value_int, 0, 1, _surf_cfg_cb_model_check, NULL);
 259
 260 #ifdef HAVE_GTNETS
 261     xbt_cfg_register(&_surf_cfg_set, "gtnets_jitter",
 262                      "Double value to oscillate the link latency, uniformly in random interval [-latency*gtnets_jitter,latency*gtnets_jitter)", xbt_cfgelm_double,
 263                      NULL, 1, 1, _surf_cfg_cb__gtnets_jitter, NULL);
 264     xbt_cfg_set_double(_surf_cfg_set, "gtnets_jitter", 0.0);
 265
 266     default_value_int = 10;
 267     xbt_cfg_register(&_surf_cfg_set, "gtnets_jitter_seed",
 268                      "Use a positive seed to reproduce jitted results, value must be in [1,1e8], default is 10",
 269                      xbt_cfgelm_int, &default_value_int, 0, 1, _surf_cfg_cb__gtnets_jitter_seed, NULL);
 270 #endif
 271
 272     if (!surf_path) {
 273       /* retrieves the current directory of the        current process */
 274       const char *initial_path = __surf_get_initial_path();
 275       xbt_assert0((initial_path),
 276                   "__surf_get_initial_path() failed! Can't resolves current Windows directory");
 277
 278       surf_path = xbt_dynar_new(sizeof(char *), NULL);
 279       xbt_cfg_set_string(_surf_cfg_set, "path", initial_path);
 280     }
 281
 282
 283     surf_config_cmd_line(argc, argv);
 284   } else {
 285     WARN0("Call to surf_config_init() after initialization ignored");
 286   }
 287 }
 288
 289 void surf_config_finalize(void)
 290 {
 291   if (!_surf_init_status)
 292     return;                     /* Not initialized yet. Nothing to do */
 293
 294   xbt_cfg_free(&_surf_cfg_set);
 295   _surf_init_status = 0;
 296 }
 297
 298 void surf_config_models_setup(const char *platform_file)
 299 {
 300   char *workstation_model_name;
 301   int workstation_id = -1;
 302
 303   surf_timer_model_init(platform_file);
 304
 305   workstation_model_name =
 306     xbt_cfg_get_string(_surf_cfg_set, "workstation/model");
 307   char *network_model_name = xbt_cfg_get_string(_surf_cfg_set, "network/model");
 308   char *cpu_model_name = xbt_cfg_get_string(_surf_cfg_set, "cpu/model");
 309
 310   if ((strcmp(network_model_name,"LV08") || strcmp(cpu_model_name,"Cas01"))
 311       && !strcmp(workstation_model_name, "CLM03")){
 312     const char *val = "compound";
 313     INFO0("Switching workstation model to compound since you changed the network and/or cpu model(s)");
 314     xbt_cfg_set_string(_surf_cfg_set,"workstation/model",val);
 315     workstation_model_name = (char*)"compound";
 316   }
 317
 318   DEBUG1("Workstation model: %s", workstation_model_name);
 319   workstation_id =
 320     find_model_description(surf_workstation_model_description,
 321                            workstation_model_name);
 322   if (!strcmp(workstation_model_name, "compound")) {
 323     int network_id = -1;
 324     int cpu_id = -1;
 325
 326     xbt_assert0(cpu_model_name,
 327         "Set a cpu model to use with the 'compound' workstation model");
 328
 329     xbt_assert0(network_model_name,
 330         "Set a network model to use with the 'compound' workstation model");
 331
 332     network_id =
 333       find_model_description(surf_network_model_description,
 334                              network_model_name);
 335     cpu_id =
 336       find_model_description(surf_cpu_model_description, cpu_model_name);
 337
 338     surf_cpu_model_description[cpu_id].model_init_preparse(platform_file);
 339     surf_network_model_description[network_id].
 340       model_init_preparse(platform_file);
 341   }
 342
 343   DEBUG0("Call workstation_model_init");
 344   surf_workstation_model_description[workstation_id].model_init_preparse
 345     (platform_file);
 346 }
 347
 348 void surf_config_models_create_elms(void)
 349 {
 350   char *workstation_model_name =
 351     xbt_cfg_get_string(_surf_cfg_set, "workstation/model");
 352   int workstation_id =
 353     find_model_description(surf_workstation_model_description,
 354                            workstation_model_name);
 355   if (surf_workstation_model_description[workstation_id].
 356       model_init_postparse != NULL)
 357     surf_workstation_model_description[workstation_id].model_init_postparse();
 358 }