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