src/simgrid/sg_config.c

   1 /* Copyright (c) 2009-2010, 2012-2013. 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 /* sg_config: configuration infrastructure for the simulation world       */
   8
   9 #include "xbt/misc.h"
  10 #include "xbt/config.h"
  11 #include "xbt/log.h"
  12 #include "xbt/mallocator.h"
  13 #include "xbt/str.h"
  14 #include "xbt/lib.h"
  15 #include "xbt/sysdep.h"
  16 #include "surf/surf.h"
  17 #include "surf/maxmin.h"
  18 #include "instr/instr_interface.h"
  19 #include "simgrid/simix.h"
  20 #include "simgrid/sg_config.h"
  21 #include "smpi/smpi_interface.h"
  22 #include "mc/mc.h"
  23 #include "instr/instr.h"
  24
  25 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_config, surf,
  26                                 "About the configuration of simgrid");
  27
  28 xbt_cfg_t _sg_cfg_set = NULL;
  29
  30 int _sg_init_status = 0;      /* 0: beginning of time (config cannot be changed yet);
  31                                   1: initialized: cfg_set created (config can now be changed);
  32                                   2: configured: command line parsed and config part of platform file was integrated also, platform construction ongoing or done.
  33                                      (Config cannot be changed anymore!) */
  34
  35 /* Parse the command line, looking for options */
  36 static void sg_config_cmd_line(int *argc, char **argv)
  37 {
  38   int shall_exit = 0;
  39   int i, j;
  40   char *opt;
  41
  42   for (j = i = 1; i < *argc; i++) {
  43     if (!strncmp(argv[i], "--cfg=", strlen("--cfg="))) {
  44       opt = strchr(argv[i], '=');
  45       opt++;
  46
  47       xbt_cfg_set_parse(_sg_cfg_set, opt);
  48       XBT_DEBUG("Did apply '%s' as config setting", opt);
  49     } else if (!strcmp(argv[i], "--cfg-help") || !strcmp(argv[i], "--help")) {
  50       printf
  51           ("Description of the configuration accepted by this simulator:\n");
  52       xbt_cfg_help(_sg_cfg_set);
  53       printf(
  54 "\n"
  55 "Each of these configurations can be used by adding\n"
  56 "    --cfg=<option name>:<option value>\n"
  57 "to the command line.\n"
  58 "You can also use --help-models to see the details of all models known by this simulator.\n"
  59 #ifdef HAVE_TRACING
  60 "\n"
  61 "You can also use --help-tracing to see the details of all tracing options known by this simulator.\n"
  62 #endif
  63 "\n"
  64 "You can also use --help-logs and --help-log-categories to see the details of logging output.\n"
  65 "\n"
  66         );
  67       shall_exit = 1;
  68     } else if (!strcmp(argv[i], "--help-models")) {
  69       int k;
  70
  71       model_help("workstation", surf_workstation_model_description);
  72       printf("\n");
  73       model_help("CPU", surf_cpu_model_description);
  74       printf("\n");
  75       model_help("network", surf_network_model_description);
  76       printf("\nLong description of all optimization levels accepted by the models of this simulator:\n");
  77       for (k = 0; surf_optimization_mode_description[k].name; k++)
  78         printf("  %s: %s\n",
  79                surf_optimization_mode_description[k].name,
  80                surf_optimization_mode_description[k].description);
  81       printf("Both network and CPU models have 'Lazy' as default optimization level\n\n");
  82       shall_exit = 1;
  83 #ifdef HAVE_TRACING
  84     } else if (!strcmp(argv[i], "--help-tracing")) {
  85       TRACE_help (1);
  86       shall_exit = 1;
  87 #endif
  88     } else {
  89       argv[j++] = argv[i];
  90     }
  91   }
  92   if (j < *argc) {
  93     argv[j] = NULL;
  94     *argc = j;
  95   }
  96   if (shall_exit) {
  97     _sg_init_status = 1;        // get everything cleanly cleaned on exit
  98     exit(0);
  99   }
 100 }
 101
 102 /* callback of the workstation/model variable */
 103 static void _sg_cfg_cb__workstation_model(const char *name, int pos)
 104 {
 105   char *val;
 106
 107   xbt_assert(_sg_init_status < 2,
 108               "Cannot change the model after the initialization");
 109
 110   val = xbt_cfg_get_string(_sg_cfg_set, name);
 111
 112   if (!strcmp(val, "help")) {
 113     model_help("workstation", surf_workstation_model_description);
 114     exit(0);
 115   }
 116
 117   /* Make sure that the model exists */
 118   find_model_description(surf_workstation_model_description, val);
 119 }
 120
 121 /* callback of the cpu/model variable */
 122 static void _sg_cfg_cb__cpu_model(const char *name, int pos)
 123 {
 124   char *val;
 125
 126   xbt_assert(_sg_init_status < 2,
 127               "Cannot change the model after the initialization");
 128
 129   val = xbt_cfg_get_string(_sg_cfg_set, name);
 130
 131   if (!strcmp(val, "help")) {
 132     model_help("CPU", surf_cpu_model_description);
 133     exit(0);
 134   }
 135
 136   /* New Module missing */
 137   find_model_description(surf_cpu_model_description, val);
 138 }
 139
 140 /* callback of the cpu/model variable */
 141 static void _sg_cfg_cb__optimization_mode(const char *name, int pos)
 142 {
 143   char *val;
 144
 145   xbt_assert(_sg_init_status < 2,
 146               "Cannot change the model after the initialization");
 147
 148   val = xbt_cfg_get_string(_sg_cfg_set, name);
 149
 150   if (!strcmp(val, "help")) {
 151     model_help("optimization", surf_optimization_mode_description);
 152     exit(0);
 153   }
 154
 155   /* New Module missing */
 156   find_model_description(surf_optimization_mode_description, val);
 157 }
 158
 159 /* callback of the cpu/model variable */
 160 static void _sg_cfg_cb__storage_mode(const char *name, int pos)
 161 {
 162   char *val;
 163
 164   xbt_assert(_sg_init_status < 2,
 165               "Cannot change the model after the initialization");
 166
 167   val = xbt_cfg_get_string(_sg_cfg_set, name);
 168
 169   if (!strcmp(val, "help")) {
 170     model_help("storage", surf_storage_model_description);
 171     exit(0);
 172   }
 173
 174   /* New Module missing */
 175   find_model_description(surf_storage_model_description, val);
 176 }
 177
 178 /* callback of the workstation_model variable */
 179 static void _sg_cfg_cb__network_model(const char *name, int pos)
 180 {
 181   char *val;
 182
 183   xbt_assert(_sg_init_status < 2,
 184               "Cannot change the model after the initialization");
 185
 186   val = xbt_cfg_get_string(_sg_cfg_set, name);
 187
 188   if (!strcmp(val, "help")) {
 189     model_help("network", surf_network_model_description);
 190     exit(0);
 191   }
 192
 193   /* New Module missing */
 194   find_model_description(surf_network_model_description, val);
 195 }
 196
 197 /* callbacks of the network models values */
 198 static void _sg_cfg_cb__tcp_gamma(const char *name, int pos)
 199 {
 200   sg_tcp_gamma = xbt_cfg_get_double(_sg_cfg_set, name);
 201 }
 202
 203 static void _sg_cfg_cb__maxmin_precision(const char* name, int pos)
 204 {
 205   sg_maxmin_precision = xbt_cfg_get_double(_sg_cfg_set, name);
 206 }
 207
 208 static void _sg_cfg_cb__sender_gap(const char* name, int pos)
 209 {
 210   sg_sender_gap = xbt_cfg_get_double(_sg_cfg_set, name);
 211 }
 212
 213 static void _sg_cfg_cb__latency_factor(const char *name, int pos)
 214 {
 215   sg_latency_factor = xbt_cfg_get_double(_sg_cfg_set, name);
 216 }
 217
 218 static void _sg_cfg_cb__bandwidth_factor(const char *name, int pos)
 219 {
 220   sg_bandwidth_factor = xbt_cfg_get_double(_sg_cfg_set, name);
 221 }
 222
 223 static void _sg_cfg_cb__weight_S(const char *name, int pos)
 224 {
 225   sg_weight_S_parameter = xbt_cfg_get_double(_sg_cfg_set, name);
 226 }
 227
 228 #ifdef HAVE_SMPI
 229 /* callback of the mpi collectives */
 230 static void _sg_cfg_cb__coll(const char *category,
 231                              s_mpi_coll_description_t * table,
 232                              const char *name, int pos)
 233 {
 234   char *val;
 235
 236   xbt_assert(_sg_init_status < 2,
 237               "Cannot change the model after the initialization");
 238
 239   val = xbt_cfg_get_string(_sg_cfg_set, name);
 240
 241   if (!strcmp(val, "help")) {
 242     coll_help(category, table);
 243     exit(0);
 244   }
 245
 246   /* New Module missing */
 247   find_coll_description(table, val);
 248 }
 249 static void _sg_cfg_cb__coll_gather(const char *name, int pos){
 250   _sg_cfg_cb__coll("gather", mpi_coll_gather_description, name, pos);
 251 }
 252 static void _sg_cfg_cb__coll_allgather(const char *name, int pos){
 253   _sg_cfg_cb__coll("allgather", mpi_coll_allgather_description, name, pos);
 254 }
 255 static void _sg_cfg_cb__coll_allgatherv(const char *name, int pos){
 256   _sg_cfg_cb__coll("allgatherv", mpi_coll_allgatherv_description, name, pos);
 257 }
 258 static void _sg_cfg_cb__coll_allreduce(const char *name, int pos)
 259 {
 260   _sg_cfg_cb__coll("allreduce", mpi_coll_allreduce_description, name, pos);
 261 }
 262 static void _sg_cfg_cb__coll_alltoall(const char *name, int pos)
 263 {
 264   _sg_cfg_cb__coll("alltoall", mpi_coll_alltoall_description, name, pos);
 265 }
 266 static void _sg_cfg_cb__coll_alltoallv(const char *name, int pos)
 267 {
 268   _sg_cfg_cb__coll("alltoallv", mpi_coll_alltoallv_description, name, pos);
 269 }
 270 static void _sg_cfg_cb__coll_bcast(const char *name, int pos)
 271 {
 272   _sg_cfg_cb__coll("bcast", mpi_coll_bcast_description, name, pos);
 273 }
 274 static void _sg_cfg_cb__coll_reduce(const char *name, int pos)
 275 {
 276   _sg_cfg_cb__coll("reduce", mpi_coll_reduce_description, name, pos);
 277 }
 278 static void _sg_cfg_cb__coll_reduce_scatter(const char *name, int pos){
 279   _sg_cfg_cb__coll("reduce_scatter", mpi_coll_reduce_scatter_description, name, pos);
 280 }
 281 static void _sg_cfg_cb__coll_scatter(const char *name, int pos){
 282   _sg_cfg_cb__coll("scatter", mpi_coll_scatter_description, name, pos);
 283 }
 284 static void _sg_cfg_cb__coll_barrier(const char *name, int pos){
 285   _sg_cfg_cb__coll("barrier", mpi_coll_barrier_description, name, pos);
 286 }
 287 #endif
 288
 289 /* callback of the inclusion path */
 290 static void _sg_cfg_cb__surf_path(const char *name, int pos)
 291 {
 292   char *path = xbt_cfg_get_string_at(_sg_cfg_set, name, pos);
 293   xbt_dynar_push(surf_path, &path);
 294 }
 295
 296 /* callback to decide if we want to use the model-checking */
 297 #include "xbt_modinter.h"
 298 #ifdef HAVE_MC
 299 extern int _sg_do_model_check;   /* this variable lives in xbt_main until I find a right location for it */
 300 #endif
 301
 302 static void _sg_cfg_cb_model_check(const char *name, int pos)
 303 {
 304 #ifdef HAVE_MC
 305   _sg_do_model_check = xbt_cfg_get_boolean(_sg_cfg_set, name);
 306 #else
 307   if (xbt_cfg_get_boolean(_sg_cfg_set, name)) {
 308     xbt_die("You tried to activate the model-checking from the command line, but it was not compiled in. Change your settings in cmake, recompile and try again");
 309   }
 310 #endif
 311 }
 312
 313 extern int _sg_do_verbose_exit;
 314
 315 static void _sg_cfg_cb_verbose_exit(const char *name, int pos)
 316 {
 317   _sg_do_verbose_exit = xbt_cfg_get_boolean(_sg_cfg_set, name);
 318 }
 319
 320 extern int _sg_do_clean_atexit;
 321
 322 static void _sg_cfg_cb_clean_atexit(const char *name, int pos)
 323 {
 324   _sg_do_clean_atexit = xbt_cfg_get_boolean(_sg_cfg_set, name);
 325 }
 326
 327 static void _sg_cfg_cb_context_factory(const char *name, int pos)
 328 {
 329   smx_context_factory_name = xbt_cfg_get_string(_sg_cfg_set, name);
 330 }
 331
 332 static void _sg_cfg_cb_context_stack_size(const char *name, int pos)
 333 {
 334   smx_context_stack_size_was_set = 1;
 335   smx_context_stack_size = xbt_cfg_get_int(_sg_cfg_set, name) * 1024;
 336 }
 337
 338 static void _sg_cfg_cb_contexts_nthreads(const char *name, int pos)
 339 {
 340   SIMIX_context_set_nthreads(xbt_cfg_get_int(_sg_cfg_set, name));
 341 }
 342
 343 static void _sg_cfg_cb_contexts_parallel_threshold(const char *name, int pos)
 344 {
 345   SIMIX_context_set_parallel_threshold(xbt_cfg_get_int(_sg_cfg_set, name));
 346 }
 347
 348 static void _sg_cfg_cb_contexts_parallel_mode(const char *name, int pos)
 349 {
 350   const char* mode_name = xbt_cfg_get_string(_sg_cfg_set, name);
 351   if (!strcmp(mode_name, "posix")) {
 352     SIMIX_context_set_parallel_mode(XBT_PARMAP_POSIX);
 353   }
 354   else if (!strcmp(mode_name, "futex")) {
 355     SIMIX_context_set_parallel_mode(XBT_PARMAP_FUTEX);
 356   }
 357   else if (!strcmp(mode_name, "busy_wait")) {
 358     SIMIX_context_set_parallel_mode(XBT_PARMAP_BUSY_WAIT);
 359   }
 360   else {
 361     xbt_die("Command line setting of the parallel synchronization mode should "
 362             "be one of \"posix\", \"futex\" or \"busy_wait\"");
 363   }
 364 }
 365
 366 static void _sg_cfg_cb__surf_network_coordinates(const char *name,
 367                                                  int pos)
 368 {
 369   int val = xbt_cfg_get_boolean(_sg_cfg_set, name);
 370   if (val) {
 371     if (!COORD_HOST_LEVEL) {
 372       COORD_HOST_LEVEL = xbt_lib_add_level(host_lib,xbt_dynar_free_voidp);
 373       COORD_ASR_LEVEL  = xbt_lib_add_level(as_router_lib,xbt_dynar_free_voidp);
 374     }
 375   } else
 376     if (COORD_HOST_LEVEL)
 377       xbt_die("Setting of whether to use coordinate cannot be disabled once set.");
 378 }
 379
 380 static void _sg_cfg_cb__surf_network_crosstraffic(const char *name,
 381                                                   int pos)
 382 {
 383   sg_network_crosstraffic = xbt_cfg_get_boolean(_sg_cfg_set, name);
 384 }
 385
 386 #ifdef HAVE_GTNETS
 387 static void _sg_cfg_cb__gtnets_jitter(const char *name, int pos)
 388 {
 389   sg_gtnets_jitter = xbt_cfg_get_double(_sg_cfg_set, name);
 390 }
 391
 392 static void _sg_cfg_cb__gtnets_jitter_seed(const char *name, int pos)
 393 {
 394   sg_gtnets_jitter_seed = xbt_cfg_get_int(_sg_cfg_set, name);
 395 }
 396 #endif
 397
 398 /* create the config set, register what should be and parse the command line*/
 399 void sg_config_init(int *argc, char **argv)
 400 {
 401   char *description = xbt_malloc(1024), *p = description;
 402   int i;
 403
 404   /* Create the configuration support */
 405   if (_sg_init_status == 0) { /* Only create stuff if not already inited */
 406     sprintf(description,
 407             "The model to use for the CPU. Possible values: ");
 408     p = description;
 409     while (*(++p) != '\0');
 410     for (i = 0; surf_cpu_model_description[i].name; i++)
 411       p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
 412                    surf_cpu_model_description[i].name);
 413     sprintf(p,
 414             ".\n       (use 'help' as a value to see the long description of each model)");
 415     xbt_cfg_register(&_sg_cfg_set, "cpu/model", description,
 416                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__cpu_model, NULL);
 417     xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/model", "Cas01");
 418
 419     while (*(++p) != '\0');
 420     for (i = 0; surf_optimization_mode_description[i].name; i++)
 421       p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
 422                    surf_optimization_mode_description[i].name);
 423     sprintf(p,
 424             ".\n       (use 'help' as a value to see the long description of each optimization mode)");
 425     xbt_cfg_register(&_sg_cfg_set, "cpu/optim", description,
 426                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode, NULL);
 427     xbt_cfg_setdefault_string(_sg_cfg_set, "cpu/optim", "Lazy");
 428
 429     sprintf(description,
 430             "The model to use for the storage. Possible values: ");
 431     p = description;
 432     while (*(++p) != '\0');
 433     for (i = 0; surf_storage_model_description[i].name; i++)
 434       p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
 435                    surf_storage_model_description[i].name);
 436     sprintf(p,
 437             ".\n       (use 'help' as a value to see the long description of each model)");
 438     xbt_cfg_register(&_sg_cfg_set, "storage/model", description,
 439                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__storage_mode, NULL);
 440     xbt_cfg_setdefault_string(_sg_cfg_set, "storage/model", "default");
 441
 442     /* ********************************************************************* */
 443     /* TUTORIAL: New model                                                   */
 444     sprintf(description,
 445             "The model to use for the New model. Possible values: ");
 446     p = description;
 447     while (*(++p) != '\0');
 448     for (i = 0; surf_new_model_description[i].name; i++)
 449       p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
 450                    surf_new_model_description[i].name);
 451     sprintf(p,
 452             ".\n       (use 'help' as a value to see the long description of each model)");
 453     xbt_cfg_register(&_sg_cfg_set, "new_model/model", description,
 454                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__storage_mode, NULL);
 455     xbt_cfg_setdefault_string(_sg_cfg_set, "new_model/model", "default");
 456     /* ********************************************************************* */
 457
 458     sprintf(description,
 459             "The model to use for the network. Possible values: ");
 460     p = description;
 461     while (*(++p) != '\0');
 462     for (i = 0; surf_network_model_description[i].name; i++)
 463       p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
 464                    surf_network_model_description[i].name);
 465     sprintf(p,
 466             ".\n       (use 'help' as a value to see the long description of each model)");
 467     xbt_cfg_register(&_sg_cfg_set, "network/model", description,
 468                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__network_model, NULL);
 469     xbt_cfg_setdefault_string(_sg_cfg_set, "network/model", "LV08");
 470
 471     sprintf(description,
 472             "The optimization modes to use for the network. Possible values: ");
 473     p = description;
 474     while (*(++p) != '\0');
 475     for (i = 0; surf_optimization_mode_description[i].name; i++)
 476       p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
 477                    surf_optimization_mode_description[i].name);
 478     sprintf(p,
 479             ".\n       (use 'help' as a value to see the long description of each optimization mode)");
 480     xbt_cfg_register(&_sg_cfg_set, "network/optim", description,
 481                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__optimization_mode, NULL);
 482     xbt_cfg_setdefault_string(_sg_cfg_set, "network/optim", "Lazy");
 483
 484     sprintf(description,
 485             "The model to use for the workstation. Possible values: ");
 486     p = description;
 487     while (*(++p) != '\0');
 488     for (i = 0; surf_workstation_model_description[i].name; i++)
 489       p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
 490                    surf_workstation_model_description[i].name);
 491     sprintf(p,
 492             ".\n       (use 'help' as a value to see the long description of each model)");
 493     xbt_cfg_register(&_sg_cfg_set, "workstation/model", description,
 494                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__workstation_model, NULL);
 495     xbt_cfg_setdefault_string(_sg_cfg_set, "workstation/model", "default");
 496
 497     xbt_cfg_register(&_sg_cfg_set, "network/TCP_gamma",
 498                      "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)",
 499                      xbt_cfgelm_double, 1, 1, _sg_cfg_cb__tcp_gamma, NULL);
 500     xbt_cfg_setdefault_double(_sg_cfg_set, "network/TCP_gamma", 4194304.0);
 501
 502     xbt_cfg_register(&_sg_cfg_set, "maxmin/precision",
 503                      "Numerical precision used when updating simulation models (epsilon in double comparisons)",
 504                      xbt_cfgelm_double, 1, 1, _sg_cfg_cb__maxmin_precision, NULL);
 505     xbt_cfg_setdefault_double(_sg_cfg_set, "maxmin/precision", 0.00001);
 506
 507     /* The parameters of network models */
 508
 509     xbt_cfg_register(&_sg_cfg_set, "network/sender_gap",
 510                      "Minimum gap between two overlapping sends",
 511                      xbt_cfgelm_double, 1, 1, _sg_cfg_cb__sender_gap, NULL);
 512     /* default for "network/sender_gap" is set in network.c */
 513
 514     xbt_cfg_register(&_sg_cfg_set, "network/latency_factor",
 515                      "Correction factor to apply to the provided latency (default value set by network model)",
 516                      xbt_cfgelm_double, 1, 1, _sg_cfg_cb__latency_factor, NULL);
 517     xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 1.0);
 518
 519     xbt_cfg_register(&_sg_cfg_set, "network/bandwidth_factor",
 520                      "Correction factor to apply to the provided bandwidth (default value set by network model)",
 521                      xbt_cfgelm_double, 1, 1, _sg_cfg_cb__bandwidth_factor, NULL);
 522     xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 1.0);
 523
 524     xbt_cfg_register(&_sg_cfg_set, "network/weight_S",
 525                      "Correction factor to apply to the weight of competing streams (default value set by network model)",
 526                      xbt_cfgelm_double, 1, 1, _sg_cfg_cb__weight_S, NULL);
 527     /* default for "network/weight_S" is set in network.c */
 528
 529     /* Inclusion path */
 530     xbt_cfg_register(&_sg_cfg_set, "path",
 531                      "Lookup path for inclusions in platform and deployment XML files",
 532                      xbt_cfgelm_string, 0, 0, _sg_cfg_cb__surf_path, NULL);
 533
 534     xbt_cfg_register(&_sg_cfg_set, "cpu/maxmin_selective_update",
 535                      "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
 536                      xbt_cfgelm_boolean, 0, 1, NULL, NULL);
 537     xbt_cfg_setdefault_boolean(_sg_cfg_set, "cpu/maxmin_selective_update", "no");
 538
 539     xbt_cfg_register(&_sg_cfg_set, "network/maxmin_selective_update",
 540                      "Update the constraint set propagating recursively to others constraints (off by default when optim is set to lazy)",
 541                      xbt_cfgelm_boolean, 0, 1, NULL, NULL);
 542     xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/maxmin_selective_update", "no");
 543
 544 #ifdef HAVE_MC
 545     /* do model-checking */
 546     xbt_cfg_register(&_sg_cfg_set, "model-check",
 547                      "Verify the system through model-checking instead of simulating it (EXPERIMENTAL)",
 548                      xbt_cfgelm_boolean, 0, 1, _sg_cfg_cb_model_check, NULL);
 549     xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check", "no");
 550
 551     /* do stateful model-checking */
 552     xbt_cfg_register(&_sg_cfg_set, "model-check/checkpoint",
 553                      "Specify the amount of steps between checkpoints during stateful model-checking (default: 0 => stateless verification). "
 554                      "If value=on, one checkpoint is saved for each step => faster verification, but huge memory consumption; higher values are good compromises between speed and memory consumption.",
 555                      xbt_cfgelm_int, 0, 1, _mc_cfg_cb_checkpoint, NULL);
 556     xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/checkpoint", 0);
 557
 558     /* do liveness model-checking */
 559     xbt_cfg_register(&_sg_cfg_set, "model-check/property",
 560                      "Specify the name of the file containing the property. It must be the result of the ltl2ba program.",
 561                      xbt_cfgelm_string, 0, 1, _mc_cfg_cb_property, NULL);
 562     xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/property", "");
 563
 564     /* Specify the kind of model-checking reduction */
 565     xbt_cfg_register(&_sg_cfg_set, "model-check/reduction",
 566                      "Specify the kind of exploration reduction (either none or DPOR)",
 567                      xbt_cfgelm_string, 0, 1, _mc_cfg_cb_reduce, NULL);
 568     xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/reduction", "dpor");
 569
 570     /* Enable/disable timeout for wait requests with model-checking */
 571     xbt_cfg_register(&_sg_cfg_set, "model-check/timeout",
 572                      "Enable/Disable timeout for wait requests",
 573                      xbt_cfgelm_boolean, 0, 1, _mc_cfg_cb_timeout, NULL);
 574     xbt_cfg_setdefault_boolean(_sg_cfg_set, "model-check/timeout", "no");
 575
 576     /* Set max depth exploration */
 577     xbt_cfg_register(&_sg_cfg_set, "model-check/max_depth",
 578                      "Specify the max depth of exploration (default : 1000)",
 579                      xbt_cfgelm_int, 0, 1, _mc_cfg_cb_max_depth, NULL);
 580     xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/max_depth", 1000);
 581
 582     /* Set number of visited state stored for state comparison reduction*/
 583     xbt_cfg_register(&_sg_cfg_set, "model-check/visited",
 584                      "Specify the number of visited state stored for state comparison reduction. If value=5, the last 5 visited states are stored",
 585                      xbt_cfgelm_int, 0, 1, _mc_cfg_cb_visited, NULL);
 586     xbt_cfg_setdefault_int(_sg_cfg_set, "model-check/visited", 0);
 587
 588     /* Set file name for dot output of graph state */
 589     xbt_cfg_register(&_sg_cfg_set, "model-check/dot_output",
 590                      "Specify the name of dot file corresponding to graph state",
 591                      xbt_cfgelm_string, 0, 1, _mc_cfg_cb_dot_output, NULL);
 592     xbt_cfg_setdefault_string(_sg_cfg_set, "model-check/dot_output", "");
 593 #endif
 594
 595     /* do verbose-exit */
 596     xbt_cfg_register(&_sg_cfg_set, "verbose-exit",
 597                      "Activate the \"do nothing\" mode in Ctrl-C",
 598                      xbt_cfgelm_boolean, 0, 1, _sg_cfg_cb_verbose_exit, NULL);
 599     xbt_cfg_setdefault_boolean(_sg_cfg_set, "verbose-exit", "yes");
 600
 601     /* context factory */
 602     sprintf(description,
 603             "Context factory to use in SIMIX. Possible values: thread");
 604     const char *dflt_ctx_fact = "thread";
 605 #ifdef CONTEXT_UCONTEXT
 606     strcat(description, ", ucontext");
 607     dflt_ctx_fact = "ucontext";
 608 #endif
 609 #ifdef HAVE_RAWCTX
 610     strcat(description, ", raw");
 611     dflt_ctx_fact = "raw";
 612 #endif
 613     strcat(description, ".");
 614     xbt_cfg_register(&_sg_cfg_set, "contexts/factory", description,
 615                      xbt_cfgelm_string, 1, 1, _sg_cfg_cb_context_factory, NULL);
 616     xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/factory", dflt_ctx_fact);
 617
 618     /* stack size of contexts in Ko */
 619     xbt_cfg_register(&_sg_cfg_set, "contexts/stack_size",
 620                      "Stack size of contexts in Kib",
 621                      xbt_cfgelm_int, 1, 1, _sg_cfg_cb_context_stack_size, NULL);
 622     xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/stack_size", 128);
 623
 624     /* number of parallel threads for user processes */
 625     xbt_cfg_register(&_sg_cfg_set, "contexts/nthreads",
 626                      "Number of parallel threads used to execute user contexts",
 627                      xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_nthreads, NULL);
 628     xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/nthreads", 1);
 629
 630     /* minimal number of user contexts to be run in parallel */
 631     xbt_cfg_register(&_sg_cfg_set, "contexts/parallel_threshold",
 632                      "Minimal number of user contexts to be run in parallel (raw contexts only)",
 633                      xbt_cfgelm_int, 1, 1, _sg_cfg_cb_contexts_parallel_threshold, NULL);
 634     xbt_cfg_setdefault_int(_sg_cfg_set, "contexts/parallel_threshold", 2);
 635
 636     /* synchronization mode for parallel user contexts */
 637     xbt_cfg_register(&_sg_cfg_set, "contexts/synchro",
 638                      "Synchronization mode to use when running contexts in parallel (either futex, posix or busy_wait)",
 639                      xbt_cfgelm_string, 1, 1, _sg_cfg_cb_contexts_parallel_mode, NULL);
 640 #ifdef HAVE_FUTEX_H
 641     xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "futex");
 642 #else //No futex on mac and posix is unimplememted yet
 643     xbt_cfg_setdefault_string(_sg_cfg_set, "contexts/synchro", "busy_wait");
 644 #endif
 645
 646     xbt_cfg_register(&_sg_cfg_set, "network/coordinates",
 647                      "\"yes\" or \"no\", specifying whether we use a coordinate-based routing (as Vivaldi)",
 648                      xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb__surf_network_coordinates, NULL);
 649     xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/coordinates", "no");
 650
 651     xbt_cfg_register(&_sg_cfg_set, "network/crosstraffic",
 652                      "Activate the interferences between uploads and downloads for fluid max-min models (LV08, CM02)",
 653                      xbt_cfgelm_boolean, 0, 1, _sg_cfg_cb__surf_network_crosstraffic, NULL);
 654     xbt_cfg_setdefault_boolean(_sg_cfg_set, "network/crosstraffic", "no");
 655
 656 #ifdef HAVE_GTNETS
 657     xbt_cfg_register(&_sg_cfg_set, "gtnets/jitter",
 658                      "Double value to oscillate the link latency, uniformly in random interval [-latency*gtnets_jitter,latency*gtnets_jitter)",
 659                      xbt_cfgelm_double, 1, 1, _sg_cfg_cb__gtnets_jitter, NULL);
 660     xbt_cfg_setdefault_double(_sg_cfg_set, "gtnets/jitter", 0.0);
 661
 662     xbt_cfg_register(&_sg_cfg_set, "gtnets/jitter_seed",
 663                      "Use a positive seed to reproduce jitted results, value must be in [1,1e8], default is 10",
 664                      xbt_cfgelm_int, 0, 1, _sg_cfg_cb__gtnets_jitter_seed, NULL);
 665     xbt_cfg_setdefault_int(_sg_cfg_set, "gtnets/jitter_seed", 10);
 666 #endif
 667 #ifdef HAVE_NS3
 668     xbt_cfg_register(&_sg_cfg_set, "ns3/TcpModel",
 669                      "The ns3 tcp model can be : NewReno or Reno or Tahoe",
 670                      xbt_cfgelm_string, 1, 1, NULL, NULL);
 671     xbt_cfg_setdefault_string(_sg_cfg_set, "ns3/TcpModel", "default");
 672 #endif
 673
 674 #ifdef HAVE_SMPI
 675     xbt_cfg_register(&_sg_cfg_set, "smpi/running_power",
 676                      "Power of the host running the simulation (in flop/s). Used to bench the operations.",
 677                      xbt_cfgelm_double, 1, 1, NULL, NULL);
 678     xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/running_power", 20000.0);
 679
 680     xbt_cfg_register(&_sg_cfg_set, "smpi/display_timing",
 681                      "Boolean indicating whether we should display the timing after simulation.",
 682                      xbt_cfgelm_boolean, 1, 1, NULL, NULL);
 683     xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/display_timing", "no");
 684
 685     xbt_cfg_register(&_sg_cfg_set, "smpi/use_shared_malloc",
 686                      "Boolean indicating whether we should use shared memory when using SMPI_SHARED_MALLOC. Allows user to disable it for debug purposes.",
 687                      xbt_cfgelm_boolean, 1, 1, NULL, NULL);
 688     xbt_cfg_setdefault_boolean(_sg_cfg_set, "smpi/use_shared_malloc", "yes");
 689
 690     xbt_cfg_register(&_sg_cfg_set, "smpi/cpu_threshold",
 691                      "Minimal computation time (in seconds) not discarded.",
 692                      xbt_cfgelm_double, 1, 1, NULL, NULL);
 693     xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/cpu_threshold", 1e-6);
 694
 695     xbt_cfg_register(&_sg_cfg_set, "smpi/async_small_thres",
 696                      "Maximal size of messages that are to be sent asynchronously, without waiting for the receiver",
 697                      xbt_cfgelm_int, 1, 1, NULL, NULL);
 698     xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/async_small_thres", 0);
 699
 700     xbt_cfg_register(&_sg_cfg_set, "smpi/send_is_detached_thres",
 701                      "Threshold of message size where MPI_Send stops behaving like MPI_Isend and becomes MPI_Ssend",
 702                      xbt_cfgelm_int, 1, 1, NULL, NULL);
 703     xbt_cfg_setdefault_int(_sg_cfg_set, "smpi/send_is_detached_thres", 65536);
 704
 705     //For smpi/bw_factor and smpi/lat_factor
 706     //Default value have to be "threshold0:value0;threshold1:value1;...;thresholdN:valueN"
 707     //test is if( size >= thresholdN ) return valueN;
 708     //Values can be modified with command line --cfg=smpi/bw_factor:"threshold0:value0;threshold1:value1;...;thresholdN:valueN"
 709     //  or with tag config put line <prop id="smpi/bw_factor" value="threshold0:value0;threshold1:value1;...;thresholdN:valueN"></prop>
 710     xbt_cfg_register(&_sg_cfg_set, "smpi/bw_factor",
 711                      "Bandwidth factors for smpi.",
 712                      xbt_cfgelm_string, 1, 1, NULL, NULL);
 713     xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/bw_factor", "65472:0.940694;15424:0.697866;9376:0.58729;5776:1.08739;3484:0.77493;1426:0.608902;732:0.341987;257:0.338112;0:0.812084");
 714
 715     xbt_cfg_register(&_sg_cfg_set, "smpi/lat_factor",
 716                      "Latency factors for smpi.",
 717                      xbt_cfgelm_string, 1, 1, NULL, NULL);
 718     xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/lat_factor", "65472:11.6436;15424:3.48845;9376:2.59299;5776:2.18796;3484:1.88101;1426:1.61075;732:1.9503;257:1.95341;0:2.01467");
 719
 720     xbt_cfg_register(&_sg_cfg_set, "smpi/os",
 721                      "Small messages timings (MPI_Send minimum time for small messages)",
 722                      xbt_cfgelm_string, 1, 1, NULL, NULL);
 723     xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/os", "1:0:0:0:0");
 724
 725     xbt_cfg_register(&_sg_cfg_set, "smpi/ois",
 726                      "Small messages timings (MPI_Isend minimum time for small messages)",
 727                      xbt_cfgelm_string, 1, 1, NULL, NULL);
 728     xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/ois", "1:0:0:0:0");
 729
 730     xbt_cfg_register(&_sg_cfg_set, "smpi/or",
 731                      "Small messages timings (MPI_Recv minimum time for small messages)",
 732                      xbt_cfgelm_string, 1, 1, NULL, NULL);
 733     xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/or", "1:0:0:0:0");
 734     xbt_cfg_register(&_sg_cfg_set, "smpi/iprobe",
 735                      "Minimum time to inject inside a call to MPI_Iprobe",
 736                      xbt_cfgelm_double, 1, 1, NULL, NULL);
 737     xbt_cfg_setdefault_double(_sg_cfg_set, "smpi/iprobe", 1e-4);
 738     xbt_cfg_register(&_sg_cfg_set, "smpi/coll_selector",
 739                      "Which collective selector to use",
 740                      xbt_cfgelm_string, 1, 1, NULL, NULL);
 741     xbt_cfg_setdefault_string(_sg_cfg_set, "smpi/coll_selector", "default");
 742
 743     xbt_cfg_register(&_sg_cfg_set, "smpi/gather",
 744                      "Which collective to use for gather",
 745                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_gather, NULL);
 746
 747     xbt_cfg_register(&_sg_cfg_set, "smpi/allgather",
 748                      "Which collective to use for allgather",
 749                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_allgather, NULL);
 750
 751     xbt_cfg_register(&_sg_cfg_set, "smpi/barrier",
 752                      "Which collective to use for barrier",
 753                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_barrier, NULL);
 754
 755     xbt_cfg_register(&_sg_cfg_set, "smpi/reduce_scatter",
 756                      "Which collective to use for reduce_scatter",
 757                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_reduce_scatter, NULL);
 758
 759     xbt_cfg_register(&_sg_cfg_set, "smpi/scatter",
 760                      "Which collective to use for scatter",
 761                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_scatter, NULL);
 762
 763     xbt_cfg_register(&_sg_cfg_set, "smpi/allgatherv",
 764                      "Which collective to use for allgatherv",
 765                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_allgatherv, NULL);
 766
 767     xbt_cfg_register(&_sg_cfg_set, "smpi/allreduce",
 768                      "Which collective to use for allreduce",
 769                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_allreduce, NULL);
 770
 771     xbt_cfg_register(&_sg_cfg_set, "smpi/alltoall",
 772                      "Which collective to use for alltoall",
 773                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_alltoall, NULL);
 774
 775     xbt_cfg_register(&_sg_cfg_set, "smpi/alltoallv",
 776                      "Which collective to use for alltoallv",
 777                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_alltoallv, NULL);
 778
 779     xbt_cfg_register(&_sg_cfg_set, "smpi/bcast",
 780                      "Which collective to use for bcast",
 781                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_bcast, NULL);
 782
 783     xbt_cfg_register(&_sg_cfg_set, "smpi/reduce",
 784                      "Which collective to use for reduce",
 785                      xbt_cfgelm_string, 1, 1, &_sg_cfg_cb__coll_reduce, NULL);
 786 #endif // HAVE_SMPI
 787
 788     xbt_cfg_register(&_sg_cfg_set, "clean_atexit",
 789                      "\"yes\" or \"no\". \"yes\" enables all the cleanups of SimGrid (XBT,SIMIX,MSG) to be registered with atexit. \"no\" may be useful if your code segfaults when calling the exit function.",
 790                      xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_clean_atexit, NULL);
 791     xbt_cfg_setdefault_boolean(_sg_cfg_set, "clean_atexit", "yes");
 792
 793     if (!surf_path) {
 794       /* retrieves the current directory of the current process */
 795       const char *initial_path = __surf_get_initial_path();
 796       xbt_assert((initial_path),
 797                   "__surf_get_initial_path() failed! Can't resolves current Windows directory");
 798
 799       surf_path = xbt_dynar_new(sizeof(char *), NULL);
 800       xbt_cfg_setdefault_string(_sg_cfg_set, "path", initial_path);
 801     }
 802
 803     _sg_init_status = 1;
 804
 805     sg_config_cmd_line(argc, argv);
 806
 807     xbt_mallocator_initialization_is_done(SIMIX_context_is_parallel());
 808
 809   } else {
 810     XBT_WARN("Call to sg_config_init() after initialization ignored");
 811   }
 812
 813   xbt_free(description);
 814 }
 815
 816 void sg_config_finalize(void)
 817 {
 818   if (!_sg_init_status)
 819     return;                     /* Not initialized yet. Nothing to do */
 820
 821   xbt_cfg_free(&_sg_cfg_set);
 822   _sg_init_status = 0;
 823 }
 824
 825 /* Pick the right models for CPU, net and workstation, and call their model_init_preparse */
 826 void surf_config_models_setup()
 827 {
 828   const char *workstation_model_name;
 829   int workstation_id = -1;
 830   char *network_model_name = NULL;
 831   char *cpu_model_name = NULL;
 832   int storage_id = -1;
 833   char *storage_model_name = NULL;
 834
 835   workstation_model_name =
 836       xbt_cfg_get_string(_sg_cfg_set, "workstation/model");
 837   network_model_name = xbt_cfg_get_string(_sg_cfg_set, "network/model");
 838   cpu_model_name = xbt_cfg_get_string(_sg_cfg_set, "cpu/model");
 839   storage_model_name = xbt_cfg_get_string(_sg_cfg_set, "storage/model");
 840
 841   /* Check whether we use a net/cpu model differing from the default ones, in which case
 842    * we should switch to the "compound" workstation model to correctly dispatch stuff to
 843    * the right net/cpu models.
 844    */
 845
 846   if ((!xbt_cfg_is_default_value(_sg_cfg_set, "network/model") ||
 847        !xbt_cfg_is_default_value(_sg_cfg_set, "cpu/model")) &&
 848       xbt_cfg_is_default_value(_sg_cfg_set, "workstation/model")) {
 849     XBT_INFO("Switching workstation model to compound since you changed the network and/or cpu model(s)");
 850     workstation_model_name = "compound";
 851     xbt_cfg_set_string(_sg_cfg_set, "workstation/model", workstation_model_name);
 852   }
 853
 854   XBT_DEBUG("Workstation model: %s", workstation_model_name);
 855   workstation_id =
 856       find_model_description(surf_workstation_model_description,
 857                              workstation_model_name);
 858   if (!strcmp(workstation_model_name, "compound")) {
 859     int network_id = -1;
 860     int cpu_id = -1;
 861
 862     xbt_assert(cpu_model_name,
 863                 "Set a cpu model to use with the 'compound' workstation model");
 864
 865     xbt_assert(network_model_name,
 866                 "Set a network model to use with the 'compound' workstation model");
 867
 868     network_id =
 869         find_model_description(surf_network_model_description,
 870                                network_model_name);
 871     cpu_id =
 872         find_model_description(surf_cpu_model_description, cpu_model_name);
 873
 874     surf_cpu_model_description[cpu_id].model_init_preparse();
 875     surf_network_model_description[network_id].model_init_preparse();
 876   }
 877
 878   XBT_DEBUG("Call workstation_model_init");
 879   surf_workstation_model_description[workstation_id].model_init_preparse();
 880
 881   XBT_DEBUG("Call storage_model_init");
 882   storage_id = find_model_description(surf_storage_model_description, storage_model_name);
 883   surf_storage_model_description[storage_id].model_init_preparse();
 884
 885   /* ********************************************************************* */
 886   /* TUTORIAL: New model                                                   */
 887   int new_model_id = -1;
 888   char *new_model_name = NULL;
 889   new_model_name = xbt_cfg_get_string(_sg_cfg_set, "new_model/model");
 890   XBT_DEBUG("Call new model_init");
 891   new_model_id = find_model_description(surf_new_model_description, new_model_name);
 892   surf_new_model_description[new_model_id].model_init_preparse();
 893   /* ********************************************************************* */
 894 }
 895
 896 int sg_cfg_get_int(const char* name)
 897 {
 898   return xbt_cfg_get_int(_sg_cfg_set,name);
 899 }
 900
 901 double sg_cfg_get_double(const char* name)
 902 {
 903   return xbt_cfg_get_double(_sg_cfg_set,name);
 904 }
 905
 906 char* sg_cfg_get_string(const char* name)
 907 {
 908   return xbt_cfg_get_string(_sg_cfg_set,name);
 909 }
 910
 911 int sg_cfg_get_boolean(const char* name)
 912 {
 913   return xbt_cfg_get_boolean(_sg_cfg_set,name);
 914 }
 915
 916 void sg_cfg_get_peer(const char *name, char **peer, int *port)
 917 {
 918   xbt_cfg_get_peer(_sg_cfg_set,name, peer, port);
 919 }
 920
 921 xbt_dynar_t sg_cfg_get_dynar(const char* name)
 922 {
 923   return xbt_cfg_get_dynar(_sg_cfg_set,name);
 924 }