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
  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 int _surf_do_model_check = 0;   /* this variable is used accros the lib */
 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 int _surf_parallel_contexts = 0;
 193
 194 static void _surf_cfg_cb_parallel_contexts(const char *name, int pos)
 195 {
 196   _surf_parallel_contexts = 1;
 197 }
 198
 199 static void _surf_cfg_cb__surf_network_fullduplex(const char *name,
 200                                                   int pos)
 201 {
 202   sg_network_fullduplex = xbt_cfg_get_int(_surf_cfg_set, name);
 203 }
 204
 205 #ifdef HAVE_GTNETS
 206 static void _surf_cfg_cb__gtnets_jitter(const char *name, int pos)
 207 {
 208   sg_gtnets_jitter = xbt_cfg_get_double(_surf_cfg_set, name);
 209 }
 210
 211 static void _surf_cfg_cb__gtnets_jitter_seed(const char *name, int pos)
 212 {
 213   sg_gtnets_jitter_seed = xbt_cfg_get_int(_surf_cfg_set, name);
 214 }
 215 #endif
 216
 217 /* create the config set, register what should be and parse the command line*/
 218 void surf_config_init(int *argc, char **argv)
 219 {
 220   char *description = xbt_malloc(1024), *p = description;
 221   char *default_value;
 222   double double_default_value;
 223   int default_value_int;
 224   int i;
 225
 226   /* Create the configuration support */
 227   if (_surf_init_status == 0) { /* Only create stuff if not already inited */
 228     _surf_init_status = 1;
 229
 230     sprintf(description,
 231             "The model to use for the CPU. Possible values: ");
 232     p = description;
 233     while (*(++p) != '\0');
 234     for (i = 0; surf_cpu_model_description[i].name; i++)
 235       p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
 236                    surf_cpu_model_description[i].name);
 237     sprintf(p,
 238             ".\n       (use 'help' as a value to see the long description of each model)");
 239     default_value = xbt_strdup("Cas01");
 240     xbt_cfg_register(&_surf_cfg_set,
 241                      "cpu/model", description, xbt_cfgelm_string,
 242                      &default_value, 1, 1, &_surf_cfg_cb__cpu_model, NULL);
 243
 244     sprintf(description,
 245             "The model to use for the network. Possible values: ");
 246     p = description;
 247     while (*(++p) != '\0');
 248     for (i = 0; surf_network_model_description[i].name; i++)
 249       p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
 250                    surf_network_model_description[i].name);
 251     sprintf(p,
 252             ".\n       (use 'help' as a value to see the long description of each model)");
 253     default_value = xbt_strdup("LV08");
 254     xbt_cfg_register(&_surf_cfg_set,
 255                      "network/model", description, xbt_cfgelm_string,
 256                      &default_value, 1, 1, &_surf_cfg_cb__network_model,
 257                      NULL);
 258
 259     sprintf(description,
 260             "The model to use for the workstation. Possible values: ");
 261     p = description;
 262     while (*(++p) != '\0');
 263     for (i = 0; surf_workstation_model_description[i].name; i++)
 264       p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
 265                    surf_workstation_model_description[i].name);
 266     sprintf(p,
 267             ".\n       (use 'help' as a value to see the long description of each model)");
 268     default_value = xbt_strdup("CLM03");
 269     xbt_cfg_register(&_surf_cfg_set,
 270                      "workstation/model", description, xbt_cfgelm_string,
 271                      &default_value, 1, 1,
 272                      &_surf_cfg_cb__workstation_model, NULL);
 273
 274     xbt_free(description);
 275
 276     default_value = xbt_strdup("Full");
 277     xbt_cfg_register(&_surf_cfg_set, "routing",
 278                      "Model to use to store the routing information",
 279                      xbt_cfgelm_string, &default_value, 1, 1, NULL, NULL);
 280
 281     xbt_cfg_register(&_surf_cfg_set, "TCP_gamma",
 282                      "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)",
 283                      xbt_cfgelm_double, NULL, 1, 1,
 284                      _surf_cfg_cb__tcp_gamma, NULL);
 285     xbt_cfg_set_double(_surf_cfg_set, "TCP_gamma", 20000.0);
 286
 287     xbt_cfg_register(&_surf_cfg_set, "maxmin/precision",
 288                      "Minimum retained action value when updating simulation",
 289                      xbt_cfgelm_double, NULL, 1, 1, _surf_cfg_cb__maxmin_precision, NULL);
 290     xbt_cfg_set_double(_surf_cfg_set, "maxmin/precision", 0.00001);
 291
 292     /* The parameters of network models */
 293
 294     double_default_value = 0.0;
 295     xbt_cfg_register(&_surf_cfg_set, "network/sender_gap",
 296                      "Minimum gap between two overlapping sends",
 297                      xbt_cfgelm_double, &double_default_value, 1, 1,
 298                      _surf_cfg_cb__sender_gap, NULL);
 299
 300     double_default_value = 1.0;
 301     xbt_cfg_register(&_surf_cfg_set, "network/latency_factor",
 302                      "Correction factor to apply to the provided latency (default value set by network model)",
 303                      xbt_cfgelm_double, &double_default_value, 1, 1,
 304                      _surf_cfg_cb__latency_factor, NULL);
 305     double_default_value = 1.0;
 306     xbt_cfg_register(&_surf_cfg_set, "network/bandwidth_factor",
 307                      "Correction factor to apply to the provided bandwidth (default value set by network model)",
 308                      xbt_cfgelm_double, &double_default_value, 1, 1,
 309                      _surf_cfg_cb__bandwidth_factor, NULL);
 310     double_default_value = 0.0;
 311     xbt_cfg_register(&_surf_cfg_set, "network/weight_S",
 312                      "Correction factor to apply to the weight of competing streams(default value set by network model)",
 313                      xbt_cfgelm_double, &double_default_value, 1, 1,
 314                      _surf_cfg_cb__weight_S, NULL);
 315
 316     /* Inclusion path */
 317     xbt_cfg_register(&_surf_cfg_set, "path",
 318                      "Lookup path for inclusions in platform and deployment XML files",
 319                      xbt_cfgelm_string, NULL, 0, 0,
 320                      _surf_cfg_cb__surf_path, NULL);
 321
 322     default_value_int = 0;
 323     xbt_cfg_register(&_surf_cfg_set, "maxmin_selective_update",
 324                      "Update the constraint set propagating recursively to others constraints",
 325                      xbt_cfgelm_int, &default_value_int, 0, 1,
 326                      _surf_cfg_cb__surf_maxmin_selective_update, NULL);
 327
 328     /* do model-check */
 329     default_value_int = 0;
 330     xbt_cfg_register(&_surf_cfg_set, "model-check",
 331                      "Activate the model-checking of the \"simulated\" system (EXPERIMENTAL -- msg only for now)",
 332                      xbt_cfgelm_int, &default_value_int, 0, 1,
 333                      _surf_cfg_cb_model_check, NULL);
 334     /*
 335        FIXME: this function is not setting model-check to it's default value because
 336        internally it calls to variable->cb_set that in this case is the function
 337        _surf_cfg_cb_model_check which sets it's value to 1 (instead of the defalut value 0)
 338        xbt_cfg_set_int(_surf_cfg_set, "model-check", default_value_int); */
 339
 340     /* parallel contexts */
 341     default_value_int = 0;
 342     xbt_cfg_register(&_surf_cfg_set, "parallel-contexts",
 343                      "Activate the parallel execution of user contexts (EXPERIMENTAL -- pthreads only)",
 344                      xbt_cfgelm_int, &default_value_int, 0, 1,
 345                      _surf_cfg_cb_parallel_contexts, NULL);
 346
 347     default_value_int = 0;
 348     xbt_cfg_register(&_surf_cfg_set, "fullduplex",
 349                      "Update the constraint set propagating recursively to others constraints",
 350                      xbt_cfgelm_int, &default_value_int, 0, 1,
 351                      _surf_cfg_cb__surf_network_fullduplex, NULL);
 352     xbt_cfg_set_int(_surf_cfg_set, "fullduplex", default_value_int);
 353
 354 #ifdef HAVE_GTNETS
 355     xbt_cfg_register(&_surf_cfg_set, "gtnets_jitter",
 356                      "Double value to oscillate the link latency, uniformly in random interval [-latency*gtnets_jitter,latency*gtnets_jitter)",
 357                      xbt_cfgelm_double, NULL, 1, 1,
 358                      _surf_cfg_cb__gtnets_jitter, NULL);
 359     xbt_cfg_set_double(_surf_cfg_set, "gtnets_jitter", 0.0);
 360
 361     default_value_int = 10;
 362     xbt_cfg_register(&_surf_cfg_set, "gtnets_jitter_seed",
 363                      "Use a positive seed to reproduce jitted results, value must be in [1,1e8], default is 10",
 364                      xbt_cfgelm_int, &default_value_int, 0, 1,
 365                      _surf_cfg_cb__gtnets_jitter_seed, NULL);
 366 #endif
 367
 368     if (!surf_path) {
 369       /* retrieves the current directory of the        current process */
 370       const char *initial_path = __surf_get_initial_path();
 371       xbt_assert0((initial_path),
 372                   "__surf_get_initial_path() failed! Can't resolves current Windows directory");
 373
 374       surf_path = xbt_dynar_new(sizeof(char *), NULL);
 375       xbt_cfg_set_string(_surf_cfg_set, "path", initial_path);
 376     }
 377
 378
 379     surf_config_cmd_line(argc, argv);
 380   } else {
 381     WARN0("Call to surf_config_init() after initialization ignored");
 382   }
 383 }
 384
 385 void surf_config_finalize(void)
 386 {
 387   if (!_surf_init_status)
 388     return;                     /* Not initialized yet. Nothing to do */
 389
 390   xbt_cfg_free(&_surf_cfg_set);
 391   _surf_init_status = 0;
 392 }
 393
 394 void surf_config_models_setup(const char *platform_file)
 395 {
 396   char *workstation_model_name;
 397   int workstation_id = -1;
 398   char *network_model_name = NULL;
 399   char *cpu_model_name = NULL;
 400
 401   workstation_model_name =
 402       xbt_cfg_get_string(_surf_cfg_set, "workstation/model");
 403   network_model_name = xbt_cfg_get_string(_surf_cfg_set, "network/model");
 404   cpu_model_name = xbt_cfg_get_string(_surf_cfg_set, "cpu/model");
 405
 406   /* Check whether we use a net/cpu model differing from the default ones, in which case
 407    * we should switch to the "compound" workstation model to correctly dispatch stuff to
 408    * the right net/cpu models.
 409    */
 410   if ((strcmp(network_model_name, "LV08")
 411        || strcmp(cpu_model_name, "Cas01"))
 412       && !strcmp(workstation_model_name, "CLM03")) {
 413     const char *val = "compound";
 414     INFO0
 415         ("Switching workstation model to compound since you changed the network and/or cpu model(s)");
 416     xbt_cfg_set_string(_surf_cfg_set, "workstation/model", val);
 417     workstation_model_name = (char *) "compound";
 418   }
 419
 420   DEBUG1("Workstation model: %s", workstation_model_name);
 421   workstation_id =
 422       find_model_description(surf_workstation_model_description,
 423                              workstation_model_name);
 424   if (!strcmp(workstation_model_name, "compound")) {
 425     int network_id = -1;
 426     int cpu_id = -1;
 427
 428     xbt_assert0(cpu_model_name,
 429                 "Set a cpu model to use with the 'compound' workstation model");
 430
 431     xbt_assert0(network_model_name,
 432                 "Set a network model to use with the 'compound' workstation model");
 433
 434     network_id =
 435         find_model_description(surf_network_model_description,
 436                                network_model_name);
 437     cpu_id =
 438         find_model_description(surf_cpu_model_description, cpu_model_name);
 439
 440     surf_cpu_model_description[cpu_id].model_init_preparse(platform_file);
 441     surf_network_model_description[network_id].model_init_preparse
 442         (platform_file);
 443   }
 444
 445   DEBUG0("Call workstation_model_init");
 446   surf_workstation_model_description[workstation_id].model_init_preparse
 447       (platform_file);
 448 }
 449
 450 void surf_config_models_create_elms(void)
 451 {
 452   char *workstation_model_name =
 453       xbt_cfg_get_string(_surf_cfg_set, "workstation/model");
 454   int workstation_id =
 455       find_model_description(surf_workstation_model_description,
 456                              workstation_model_name);
 457   if (surf_workstation_model_description
 458       [workstation_id].model_init_postparse != NULL)
 459     surf_workstation_model_description[workstation_id].model_init_postparse
 460         ();
 461 }