src/surf/surf.c

   1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 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 #include <ctype.h>
   8
   9 #include "surf_private.h"
  10 #include "xbt/module.h"
  11 #include "mc/mc.h"
  12
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf,
  14                                 "Logging specific to SURF (kernel)");
  15
  16 /* Additional declarations for Windows potability. */
  17
  18 #ifndef MAX_DRIVE
  19 #define MAX_DRIVE 26
  20 #endif
  21
  22 #ifdef _XBT_WIN32
  23 #include <windows.h>
  24 static const char *disk_drives_letter_table[MAX_DRIVE] = {
  25   "A:\\",
  26   "B:\\",
  27   "C:\\",
  28   "D:\\",
  29   "E:\\",
  30   "F:\\",
  31   "G:\\",
  32   "H:\\",
  33   "I:\\",
  34   "J:\\",
  35   "K:\\",
  36   "L:\\",
  37   "M:\\",
  38   "N:\\",
  39   "O:\\",
  40   "P:\\",
  41   "Q:\\",
  42   "R:\\",
  43   "S:\\",
  44   "T:\\",
  45   "U:\\",
  46   "V:\\",
  47   "W:\\",
  48   "X:\\",
  49   "Y:\\",
  50   "Z:\\"
  51 };
  52 #endif                          /* #ifdef _XBT_WIN32 */
  53
  54 /*
  55  * Returns the initial path. On Windows the initial path is
  56  * the current directory for the current process in the other
  57  * case the function returns "./" that represents the current
  58  * directory on Unix/Linux platforms.
  59  */
  60
  61 const char *__surf_get_initial_path(void)
  62 {
  63
  64 #ifdef _XBT_WIN32
  65   unsigned i;
  66   char current_directory[MAX_PATH + 1] = { 0 };
  67   unsigned int len = GetCurrentDirectory(MAX_PATH + 1, current_directory);
  68   char root[4] = { 0 };
  69
  70   if (!len)
  71     return NULL;
  72
  73   strncpy(root, current_directory, 3);
  74
  75   for (i = 0; i < MAX_DRIVE; i++) {
  76     if (toupper(root[0]) == disk_drives_letter_table[i][0])
  77       return disk_drives_letter_table[i];
  78   }
  79
  80   return NULL;
  81 #else
  82   return "./";
  83 #endif
  84 }
  85
  86 /* The __surf_is_absolute_file_path() returns 1 if
  87  * file_path is a absolute file path, in the other
  88  * case the function returns 0.
  89  */
  90 int __surf_is_absolute_file_path(const char *file_path)
  91 {
  92 #ifdef _XBT_WIN32
  93   WIN32_FIND_DATA wfd = { 0 };
  94   HANDLE hFile = FindFirstFile(file_path, &wfd);
  95
  96   if (INVALID_HANDLE_VALUE == hFile)
  97     return 0;
  98
  99   FindClose(hFile);
 100   return 1;
 101 #else
 102   return (file_path[0] == '/');
 103 #endif
 104 }
 105
 106 double NOW = 0;
 107
 108 xbt_dynar_t model_list = NULL;
 109 tmgr_history_t history = NULL;
 110 lmm_system_t maxmin_system = NULL;
 111 xbt_dynar_t surf_path = NULL;
 112
 113 /* Don't forget to update the option description in smx_config when you change this */
 114 s_surf_model_description_t surf_network_model_description[] = {
 115   {"Constant",
 116    "Simplistic network model where all communication take a constant time (one second)",
 117    NULL, surf_network_model_init_Constant},
 118   {"CM02",
 119    "Realistic network model with lmm_solve and no correction factors",
 120    NULL, surf_network_model_init_CM02},
 121   {"LV08",
 122    "Realistic network model with lmm_solve and these correction factors: latency*=10.4, bandwidth*=.92, S=8775",
 123    NULL, surf_network_model_init_LegrandVelho},
 124   {"SMPI",
 125    "Realistic network model with lmm_solve and correction factors on three intervals (< 1KiB, < 64 KiB, >= 64 KiB)",
 126    NULL, surf_network_model_init_SMPI},
 127 #ifdef HAVE_GTNETS
 128   {"GTNets",
 129    "Network Pseudo-model using the GTNets simulator instead of an analytic model",
 130    NULL, surf_network_model_init_GTNETS},
 131 #endif
 132   {"Reno",
 133    "Model using lagrange_solve instead of lmm_solve (experts only)", NULL,
 134    surf_network_model_init_Reno},
 135   {"Reno2",
 136    "Model using lagrange_solve instead of lmm_solve (experts only)", NULL,
 137    surf_network_model_init_Reno2},
 138   {"Vegas",
 139    "Model using lagrange_solve instead of lmm_solve (experts only)", NULL,
 140    surf_network_model_init_Vegas},
 141   {NULL, NULL, NULL, NULL}      /* this array must be NULL terminated */
 142 };
 143
 144 s_surf_model_description_t surf_cpu_model_description[] = {
 145   {"Cas01_fullupdate", "CPU classical model time=size/power", NULL,
 146    surf_cpu_model_init_Cas01},
 147   {"Cas01",
 148    "Variation of Cas01_fullupdate with partial invalidation optimization of lmm system. Should produce the same values, only faster",
 149    NULL, surf_cpu_model_init_Cas01_im},
 150   {"CpuTI",
 151    "Variation of Cas01 with also trace integration. Should produce the same values, only faster if you use availability traces",
 152    NULL, surf_cpu_model_init_ti},
 153   {NULL, NULL, NULL, NULL}      /* this array must be NULL terminated */
 154 };
 155
 156 s_surf_model_description_t surf_workstation_model_description[] = {
 157   {"CLM03",
 158    "Default workstation model, using LV08 and CM02 as network and CPU",
 159    NULL, surf_workstation_model_init_CLM03, create_workstations},
 160   {"compound",
 161    "Workstation model allowing you to use other network and CPU models",
 162    NULL, surf_workstation_model_init_compound, create_workstations},
 163   {"ptask_L07", "Workstation model with better parallel task modeling",
 164    NULL, surf_workstation_model_init_ptask_L07, NULL},
 165   {NULL, NULL, NULL, NULL}      /* this array must be NULL terminated */
 166 };
 167
 168 void update_model_description(s_surf_model_description_t * table,
 169                               const char *name, surf_model_t model)
 170 {
 171   int i = find_model_description(table, name);
 172   table[i].model = model;
 173 }
 174
 175 /** Displays the long description of all registered models, and quit */
 176 void model_help(const char *category, s_surf_model_description_t * table)
 177 {
 178   int i;
 179   printf("Long description of the %s models accepted by this simulator:\n",
 180          category);
 181   for (i = 0; table[i].name; i++)
 182     printf("  %s: %s\n", table[i].name, table[i].description);
 183 }
 184
 185 int find_model_description(s_surf_model_description_t * table,
 186                            const char *name)
 187 {
 188   int i;
 189   char *name_list = NULL;
 190
 191   for (i = 0; table[i].name; i++)
 192     if (!strcmp(name, table[i].name)) {
 193       return i;
 194     }
 195   name_list = strdup(table[0].name);
 196   for (i = 1; table[i].name; i++) {
 197     name_list =
 198         xbt_realloc(name_list,
 199                     strlen(name_list) + strlen(table[i].name) + 2);
 200     strcat(name_list, ", ");
 201     strcat(name_list, table[i].name);
 202   }
 203   xbt_assert2(0, "Model '%s' is invalid! Valid models are: %s.", name,
 204               name_list);
 205 }
 206
 207 double generic_maxmin_share_resources(xbt_swag_t running_actions,
 208                                       size_t offset,
 209                                       lmm_system_t sys,
 210                                       void (*solve) (lmm_system_t))
 211 {
 212   surf_action_t action = NULL;
 213   double min = -1;
 214   double value = -1;
 215 #define VARIABLE(action) (*((lmm_variable_t*)(((char *) (action)) + (offset))))
 216
 217   xbt_assert0(solve, "Give me a real solver function!");
 218   solve(sys);
 219
 220   xbt_swag_foreach(action, running_actions) {
 221     value = lmm_variable_getvalue(VARIABLE(action));
 222     if ((value > 0) || (action->max_duration >= 0))
 223       break;
 224   }
 225
 226   if (!action)
 227     return -1.0;
 228
 229   if (value > 0) {
 230     if (action->remains > 0)
 231       min = action->remains / value;
 232     else
 233       min = 0.0;
 234     if ((action->max_duration >= 0) && (action->max_duration < min))
 235       min = action->max_duration;
 236   } else
 237     min = action->max_duration;
 238
 239
 240   for (action = xbt_swag_getNext(action, running_actions->offset);
 241        action;
 242        action = xbt_swag_getNext(action, running_actions->offset)) {
 243     value = lmm_variable_getvalue(VARIABLE(action));
 244     if (value > 0) {
 245       if (action->remains > 0)
 246         value = action->remains / value;
 247       else
 248         value = 0.0;
 249       if (value < min) {
 250         min = value;
 251         DEBUG2("Updating min (value) with %p: %f", action, min);
 252       }
 253     }
 254     if ((action->max_duration >= 0) && (action->max_duration < min)) {
 255       min = action->max_duration;
 256       DEBUG2("Updating min (duration) with %p: %f", action, min);
 257     }
 258   }
 259   DEBUG1("min value : %f", min);
 260
 261 #undef VARIABLE
 262   return min;
 263 }
 264
 265 XBT_LOG_EXTERNAL_CATEGORY(surf_cpu);
 266 XBT_LOG_EXTERNAL_CATEGORY(surf_kernel);
 267 XBT_LOG_EXTERNAL_CATEGORY(surf_lagrange);
 268 XBT_LOG_EXTERNAL_CATEGORY(surf_lagrange_dichotomy);
 269 XBT_LOG_EXTERNAL_CATEGORY(surf_maxmin);
 270 XBT_LOG_EXTERNAL_CATEGORY(surf_network);
 271 XBT_LOG_EXTERNAL_CATEGORY(surf_trace);
 272 XBT_LOG_EXTERNAL_CATEGORY(surf_parse);
 273 XBT_LOG_EXTERNAL_CATEGORY(surf_timer);
 274 XBT_LOG_EXTERNAL_CATEGORY(surf_workstation);
 275 XBT_LOG_EXTERNAL_CATEGORY(surf_config);
 276 XBT_LOG_EXTERNAL_CATEGORY(surf_route);
 277
 278 #ifdef HAVE_GTNETS
 279 XBT_LOG_EXTERNAL_CATEGORY(surf_network_gtnets);
 280 #endif
 281
 282 void surf_init(int *argc, char **argv)
 283 {
 284   /* Connect our log channels: that must be done manually under windows */
 285   XBT_LOG_CONNECT(surf_cpu, surf);
 286   XBT_LOG_CONNECT(surf_kernel, surf);
 287   XBT_LOG_CONNECT(surf_lagrange, surf);
 288   XBT_LOG_CONNECT(surf_lagrange_dichotomy, surf_lagrange);
 289   XBT_LOG_CONNECT(surf_maxmin, surf);
 290   XBT_LOG_CONNECT(surf_network, surf);
 291   XBT_LOG_CONNECT(surf_trace, surf);
 292   XBT_LOG_CONNECT(surf_parse, surf);
 293   XBT_LOG_CONNECT(surf_timer, surf);
 294   XBT_LOG_CONNECT(surf_workstation, surf);
 295   XBT_LOG_CONNECT(surf_config, surf);
 296   XBT_LOG_CONNECT(surf_route, surf);
 297
 298 #ifdef HAVE_GTNETS
 299   XBT_LOG_CONNECT(surf_network_gtnets, surf);
 300 #endif
 301
 302   xbt_init(argc, argv);
 303   if (!model_list)
 304     model_list = xbt_dynar_new(sizeof(surf_model_private_t), NULL);
 305   if (!history)
 306     history = tmgr_history_new();
 307
 308   surf_config_init(argc, argv);
 309   if (MC_IS_ENABLED)
 310     MC_memory_init();
 311 }
 312
 313 #ifdef _XBT_WIN32
 314 # define FILE_DELIM "\\"
 315 #else
 316 # define FILE_DELIM "/"         /* FIXME: move to better location */
 317 #endif
 318
 319 FILE *surf_fopen(const char *name, const char *mode)
 320 {
 321   unsigned int cpt;
 322   char *path_elm = NULL;
 323   char *buff;
 324   FILE *file = NULL;
 325
 326   xbt_assert(name);
 327
 328   if (__surf_is_absolute_file_path(name))       /* don't mess with absolute file names */
 329     return fopen(name, mode);
 330
 331   /* search relative files in the path */
 332   xbt_dynar_foreach(surf_path, cpt, path_elm) {
 333     buff = bprintf("%s" FILE_DELIM "%s", path_elm, name);
 334     file = fopen(buff, mode);
 335     free(buff);
 336
 337     if (file)
 338       return file;
 339   }
 340   return NULL;
 341 }
 342
 343 void surf_exit(void)
 344 {
 345   unsigned int iter;
 346   surf_model_t model = NULL;
 347
 348   surf_config_finalize();
 349
 350   xbt_dynar_foreach(model_list, iter, model)
 351       model->model_private->finalize();
 352   xbt_dynar_free(&model_list);
 353
 354   if (maxmin_system) {
 355     lmm_system_free(maxmin_system);
 356     maxmin_system = NULL;
 357   }
 358   if (history) {
 359     tmgr_history_free(history);
 360     history = NULL;
 361   }
 362
 363   if (surf_path)
 364     xbt_dynar_free(&surf_path);
 365
 366   tmgr_finalize();
 367   surf_parse_lex_destroy();
 368   surf_parse_free_callbacks();
 369   NOW = 0;                      /* Just in case the user plans to restart the simulation afterward */
 370 }
 371
 372 void surf_presolve(void)
 373 {
 374   double next_event_date = -1.0;
 375   tmgr_trace_event_t event = NULL;
 376   double value = -1.0;
 377   surf_resource_t resource = NULL;
 378   surf_model_t model = NULL;
 379   unsigned int iter;
 380
 381   DEBUG0
 382       ("First Run! Let's \"purge\" events and put models in the right state");
 383   while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
 384     if (next_event_date > NOW)
 385       break;
 386     while ((event =
 387             tmgr_history_get_next_event_leq(history, next_event_date,
 388                                             &value,
 389                                             (void **) &resource))) {
 390       resource->model->model_private->update_resource_state(resource,
 391                                                             event, value,
 392                                                             NOW);
 393     }
 394   }
 395   xbt_dynar_foreach(model_list, iter, model)
 396       model->model_private->update_actions_state(NOW, 0.0);
 397 }
 398
 399 double surf_solve(double max_date)
 400 {
 401   double min = -1.0; /* duration */
 402   double next_event_date = -1.0;
 403   double model_next_action_end = -1.0;
 404   double value = -1.0;
 405   surf_resource_t resource = NULL;
 406   surf_model_t model = NULL;
 407   tmgr_trace_event_t event = NULL;
 408   unsigned int iter;
 409
 410   if (max_date != -1.0 && max_date != NOW) {
 411     min = max_date - NOW;
 412   }
 413
 414   DEBUG0("Looking for next action end");
 415   xbt_dynar_foreach(model_list, iter, model) {
 416     DEBUG1("Running for Resource [%s]", model->name);
 417     model_next_action_end = model->model_private->share_resources(NOW);
 418     DEBUG2("Resource [%s] : next action end = %f",
 419            model->name, model_next_action_end);
 420     if (((min < 0.0) || (model_next_action_end < min))
 421         && (model_next_action_end >= 0.0))
 422       min = model_next_action_end;
 423   }
 424   DEBUG1("Next action end : %f", min);
 425
 426   DEBUG0("Looking for next event");
 427   while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
 428     DEBUG1("Next TRACE event : %f", next_event_date);
 429     if ((min != -1.0) && (next_event_date > NOW + min))
 430       break;
 431     DEBUG0("Updating models");
 432     while ((event =
 433             tmgr_history_get_next_event_leq(history, next_event_date,
 434                                             &value,
 435                                             (void **) &resource))) {
 436       if (resource->model->model_private->resource_used(resource)) {
 437         min = next_event_date - NOW;
 438         DEBUG1
 439             ("This event will modify model state. Next event set to %f",
 440              min);
 441       }
 442       /* update state of model_obj according to new value. Does not touch lmm.
 443          It will be modified if needed when updating actions */
 444       DEBUG2("Calling update_resource_state for resource %s with min %lf",
 445              resource->model->name, min);
 446       resource->model->model_private->update_resource_state(resource,
 447                                                             event, value,
 448                                                             NOW + min);
 449     }
 450   }
 451
 452
 453   /* FIXME: Moved this test to here to avoid stoping simulation if there are actions running on cpus and all cpus are with availability = 0.
 454    * This may cause an infinite loop if one cpu has a trace with periodicity = 0 and the other a trace with periodicity > 0.
 455    * The options are: all traces with same periodicity(0 or >0) or we need to change the way how the events are managed */
 456   if (min < 0.0)
 457     return -1.0;
 458
 459   DEBUG1("Duration set to %f", min);
 460
 461   NOW = NOW + min;
 462
 463   xbt_dynar_foreach(model_list, iter, model)
 464       model->model_private->update_actions_state(NOW, min);
 465
 466   return min;
 467 }
 468
 469 XBT_INLINE double surf_get_clock(void)
 470 {
 471   return NOW;
 472 }