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