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", "Simplistic network model where all communication take a constant time (one second)", NULL, surf_network_model_init_Constant},
 116   {"Vivaldi", "Scalable network model using the Vivaldi coordinate ideas", NULL, surf_network_model_init_Vivaldi},
 117   {"CM02", "Realistic network model with lmm_solve and no correction factors", NULL, surf_network_model_init_CM02},
 118   {"LV08", "Realistic network model with lmm_solve and these correction factors: latency*=10.4, bandwidth*=.92, S=8775" , NULL, surf_network_model_init_LegrandVelho},
 119   {"SMPI", "Realistic network model with lmm_solve and correction factors on three intervals (< 1KiB, < 64 KiB, >= 64 KiB)", NULL, surf_network_model_init_SMPI},
 120 #ifdef HAVE_GTNETS
 121   {"GTNets", "Network Pseudo-model using the GTNets simulator instead of an analytic model", NULL, surf_network_model_init_GTNETS},
 122 #endif
 123   {"Reno", "Model using lagrange_solve instead of lmm_solve (experts only)", NULL, surf_network_model_init_Reno},
 124   {"Reno2", "Model using lagrange_solve instead of lmm_solve (experts only)", NULL, surf_network_model_init_Reno2},
 125   {"Vegas", "Model using lagrange_solve instead of lmm_solve (experts only)", NULL, surf_network_model_init_Vegas},
 126   {NULL, NULL, NULL, NULL}            /* this array must be NULL terminated */
 127 };
 128
 129 s_surf_model_description_t surf_cpu_model_description[] = {
 130   {"Cas01_fullupdate", "CPU classical model time=size/power", NULL, surf_cpu_model_init_Cas01},
 131   {"Cas01", "Variation of Cas01_fullupdate with partial invalidation optimization of lmm system. Should produce the same values, only faster", NULL, surf_cpu_model_init_Cas01_im},
 132   {"CpuTI", "Variation of Cas01 with also trace integration. Should produce the same values, only faster if you use availability traces", NULL, surf_cpu_model_init_ti},
 133   {NULL, NULL, NULL, NULL}            /* this array must be NULL terminated */
 134 };
 135
 136 s_surf_model_description_t surf_workstation_model_description[] = {
 137   {"CLM03", "Default workstation model, using LV08 and CM02 as network and CPU", NULL, surf_workstation_model_init_CLM03, create_workstations},
 138   {"compound", "Workstation model allowing you to use other network and CPU models", NULL, surf_workstation_model_init_compound, create_workstations},
 139   {"ptask_L07", "Workstation model with better parallel task modeling", NULL, surf_workstation_model_init_ptask_L07, NULL},
 140   {NULL, NULL, NULL, NULL}            /* this array must be NULL terminated */
 141 };
 142
 143 void update_model_description(s_surf_model_description_t * table,
 144                               const char *name, surf_model_t model)
 145 {
 146   int i = find_model_description(table, name);
 147   table[i].model = model;
 148 }
 149
 150 /** Displays the long description of all registered models, and quit */
 151 void model_help(const char* category, s_surf_model_description_t * table) {
 152   int i;
 153   printf("Long description of the %s models accepted by this simulator:\n",category);
 154   for (i = 0; table[i].name; i++)
 155     printf("  %s: %s\n", table[i].name, table[i].description);
 156 }
 157
 158 int find_model_description(s_surf_model_description_t * table,
 159                            const char *name)
 160 {
 161   int i;
 162   char *name_list = NULL;
 163
 164   for (i = 0; table[i].name; i++)
 165     if (!strcmp(name, table[i].name)) {
 166       return i;
 167     }
 168   name_list = strdup(table[0].name);
 169   for (i = 1; table[i].name; i++) {
 170     name_list =
 171       xbt_realloc(name_list, strlen(name_list) + strlen(table[i].name) + 2);
 172     strcat(name_list, ", ");
 173     strcat(name_list, table[i].name);
 174   }
 175   xbt_assert2(0, "Model '%s' is invalid! Valid models are: %s.", name,
 176               name_list);
 177 }
 178
 179 double generic_maxmin_share_resources(xbt_swag_t running_actions,
 180                                       size_t offset,
 181                                       lmm_system_t sys,
 182                                       void (*solve) (lmm_system_t))
 183 {
 184   surf_action_t action = NULL;
 185   double min = -1;
 186   double value = -1;
 187 #define VARIABLE(action) (*((lmm_variable_t*)(((char *) (action)) + (offset))))
 188
 189   xbt_assert0(solve, "Give me a real solver function!");
 190   solve(sys);
 191
 192   xbt_swag_foreach(action, running_actions) {
 193     value = lmm_variable_getvalue(VARIABLE(action));
 194     if ((value > 0) || (action->max_duration >= 0))
 195       break;
 196   }
 197
 198   if (!action)
 199     return -1.0;
 200
 201   if (value > 0) {
 202     if (action->remains > 0)
 203       min = action->remains / value;
 204     else
 205       min = 0.0;
 206     if ((action->max_duration >= 0) && (action->max_duration < min))
 207       min = action->max_duration;
 208   } else
 209     min = action->max_duration;
 210
 211
 212   for (action = xbt_swag_getNext(action, running_actions->offset);
 213        action; action = xbt_swag_getNext(action, running_actions->offset)) {
 214     value = lmm_variable_getvalue(VARIABLE(action));
 215     if (value > 0) {
 216       if (action->remains > 0)
 217         value = action->remains / value;
 218       else
 219         value = 0.0;
 220       if (value < min) {
 221         min = value;
 222         DEBUG2("Updating min (value) with %p: %f", action, min);
 223       }
 224     }
 225     if ((action->max_duration >= 0) && (action->max_duration < min)) {
 226       min = action->max_duration;
 227       DEBUG2("Updating min (duration) with %p: %f", action, min);
 228     }
 229   }
 230   DEBUG1("min value : %f", min);
 231
 232 #undef VARIABLE
 233   return min;
 234 }
 235
 236 XBT_LOG_EXTERNAL_CATEGORY(surf_cpu);
 237 XBT_LOG_EXTERNAL_CATEGORY(surf_kernel);
 238 XBT_LOG_EXTERNAL_CATEGORY(surf_lagrange);
 239 XBT_LOG_EXTERNAL_CATEGORY(surf_lagrange_dichotomy);
 240 XBT_LOG_EXTERNAL_CATEGORY(surf_maxmin);
 241 XBT_LOG_EXTERNAL_CATEGORY(surf_network);
 242 XBT_LOG_EXTERNAL_CATEGORY(surf_trace);
 243 XBT_LOG_EXTERNAL_CATEGORY(surf_parse);
 244 XBT_LOG_EXTERNAL_CATEGORY(surf_timer);
 245 XBT_LOG_EXTERNAL_CATEGORY(surf_workstation);
 246 XBT_LOG_EXTERNAL_CATEGORY(surf_config);
 247 XBT_LOG_EXTERNAL_CATEGORY(surf_route);
 248
 249 #ifdef HAVE_GTNETS
 250 XBT_LOG_EXTERNAL_CATEGORY(surf_network_gtnets);
 251 #endif
 252
 253 void surf_init(int *argc, char **argv)
 254 {
 255   /* Connect our log channels: that must be done manually under windows */
 256   XBT_LOG_CONNECT(surf_cpu, surf);
 257   XBT_LOG_CONNECT(surf_kernel, surf);
 258   XBT_LOG_CONNECT(surf_lagrange, surf);
 259   XBT_LOG_CONNECT(surf_lagrange_dichotomy, surf_lagrange);
 260   XBT_LOG_CONNECT(surf_maxmin, surf);
 261   XBT_LOG_CONNECT(surf_network, surf);
 262   XBT_LOG_CONNECT(surf_trace, surf);
 263   XBT_LOG_CONNECT(surf_parse, surf);
 264   XBT_LOG_CONNECT(surf_timer, surf);
 265   XBT_LOG_CONNECT(surf_workstation, surf);
 266   XBT_LOG_CONNECT(surf_config, surf);
 267   XBT_LOG_CONNECT(surf_route, surf);
 268
 269 #ifdef HAVE_GTNETS
 270   XBT_LOG_CONNECT(surf_network_gtnets, surf);
 271 #endif
 272
 273   xbt_init(argc, argv);
 274   if (!model_list)
 275     model_list = xbt_dynar_new(sizeof(surf_model_private_t), NULL);
 276   if (!history)
 277     history = tmgr_history_new();
 278
 279   surf_config_init(argc, argv);
 280 #ifdef HAVE_MC
 281   if (_surf_do_model_check)
 282     MC_memory_init();
 283 #endif
 284 }
 285
 286 #ifdef _XBT_WIN32
 287 # define FILE_DELIM "\\"
 288 #else
 289 # define FILE_DELIM "/"         /* FIXME: move to better location */
 290 #endif
 291
 292 FILE *surf_fopen(const char *name, const char *mode)
 293 {
 294   unsigned int cpt;
 295   char *path_elm = NULL;
 296   char *buff;
 297   FILE *file = NULL;
 298
 299   xbt_assert(name);
 300
 301   if (__surf_is_absolute_file_path(name))       /* don't mess with absolute file names */
 302     return fopen(name, mode);
 303
 304   /* search relative files in the path */
 305   xbt_dynar_foreach(surf_path, cpt, path_elm) {
 306     buff = bprintf("%s" FILE_DELIM "%s", path_elm, name);
 307     file = fopen(buff, mode);
 308     free(buff);
 309
 310     if (file)
 311       return file;
 312   }
 313   return NULL;
 314 }
 315
 316 void surf_exit(void)
 317 {
 318   unsigned int iter;
 319   surf_model_t model = NULL;
 320
 321   surf_config_finalize();
 322
 323   xbt_dynar_foreach(model_list, iter, model)
 324     model->model_private->finalize();
 325   xbt_dynar_free(&model_list);
 326
 327   if (maxmin_system) {
 328     lmm_system_free(maxmin_system);
 329     maxmin_system = NULL;
 330   }
 331   if (history) {
 332     tmgr_history_free(history);
 333     history = NULL;
 334   }
 335
 336   if (surf_path)
 337     xbt_dynar_free(&surf_path);
 338
 339   tmgr_finalize();
 340   surf_parse_lex_destroy();
 341   surf_parse_free_callbacks();
 342 //   xbt_dict_free(&route_table); // COMMENTED BY DAVID
 343   NOW = 0;                      /* Just in case the user plans to restart the simulation afterward */
 344 }
 345
 346 void surf_presolve(void)
 347 {
 348   double next_event_date = -1.0;
 349   tmgr_trace_event_t event = NULL;
 350   double value = -1.0;
 351   surf_resource_t resource = NULL;
 352   surf_model_t model = NULL;
 353   unsigned int iter;
 354
 355   DEBUG0
 356     ("First Run! Let's \"purge\" events and put models in the right state");
 357   while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
 358     if (next_event_date > NOW)
 359       break;
 360     while ((event =
 361             tmgr_history_get_next_event_leq(history, next_event_date,
 362                                             &value, (void **) &resource))) {
 363       resource->model->model_private->update_resource_state(resource,
 364                                                             event, value,
 365                                                             NOW);
 366     }
 367   }
 368   xbt_dynar_foreach(model_list, iter, model)
 369     model->model_private->update_actions_state(NOW, 0.0);
 370 }
 371
 372 double surf_solve(void)
 373 {
 374   double min = -1.0;
 375   double next_event_date = -1.0;
 376   double model_next_action_end = -1.0;
 377   double value = -1.0;
 378   surf_resource_t resource = NULL;
 379   surf_model_t model = NULL;
 380   tmgr_trace_event_t event = NULL;
 381   unsigned int iter;
 382
 383   min = -1.0;
 384
 385   DEBUG0("Looking for next action end");
 386   xbt_dynar_foreach(model_list, iter, model) {
 387     DEBUG1("Running for Resource [%s]", model->name);
 388     model_next_action_end = model->model_private->share_resources(NOW);
 389     DEBUG2("Resource [%s] : next action end = %f",
 390            model->name, model_next_action_end);
 391     if (((min < 0.0) || (model_next_action_end < min))
 392         && (model_next_action_end >= 0.0))
 393       min = model_next_action_end;
 394   }
 395   DEBUG1("Next action end : %f", min);
 396
 397   DEBUG0("Looking for next event");
 398   while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
 399     DEBUG1("Next TRACE event : %f", next_event_date);
 400     if ((min != -1.0) && (next_event_date > NOW + min))
 401       break;
 402     DEBUG0("Updating models");
 403     while ((event =
 404             tmgr_history_get_next_event_leq(history, next_event_date,
 405                                             &value, (void **) &resource))) {
 406       if (resource->model->model_private->resource_used(resource)) {
 407         min = next_event_date - NOW;
 408         DEBUG1
 409           ("This event will modify model state. Next event set to %f", min);
 410       }
 411       /* update state of model_obj according to new value. Does not touch lmm.
 412          It will be modified if needed when updating actions */
 413       DEBUG2("Calling update_resource_state for resource %s with min %lf",
 414              resource->model->name, min);
 415       resource->model->model_private->update_resource_state(resource, event,
 416                                                             value, NOW + min);
 417     }
 418   }
 419
 420   /* FIXME: Moved this test to here to avoid stoping simulation if there are actions running on cpus and all cpus are with availability = 0.
 421    * This may cause an infinite loop if one cpu has a trace with periodicity = 0 and the other a trace with periodicity > 0.
 422    * The options are: all traces with same periodicity(0 or >0) or we need to change the way how the events are managed */
 423   if (min < 0.0)
 424     return -1.0;
 425
 426   DEBUG1("Duration set to %f", min);
 427
 428   NOW = NOW + min;
 429
 430   xbt_dynar_foreach(model_list, iter, model)
 431     model->model_private->update_actions_state(NOW, min);
 432
 433   return min;
 434 }
 435
 436 double surf_get_clock(void)
 437 {
 438   return NOW;
 439 }