src/surf/surf.c

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