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 "xbt/xbt_os_thread.h"
  14
  15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf,
  16                                 "Logging specific to SURF (kernel)");
  17
  18 /* Additional declarations for Windows portability. */
  19
  20 #ifndef MAX_DRIVE
  21 #define MAX_DRIVE 26
  22 #endif
  23
  24 #ifdef _XBT_WIN32
  25 #include <windows.h>
  26 static const char *disk_drives_letter_table[MAX_DRIVE] = {
  27   "A:\\",
  28   "B:\\",
  29   "C:\\",
  30   "D:\\",
  31   "E:\\",
  32   "F:\\",
  33   "G:\\",
  34   "H:\\",
  35   "I:\\",
  36   "J:\\",
  37   "K:\\",
  38   "L:\\",
  39   "M:\\",
  40   "N:\\",
  41   "O:\\",
  42   "P:\\",
  43   "Q:\\",
  44   "R:\\",
  45   "S:\\",
  46   "T:\\",
  47   "U:\\",
  48   "V:\\",
  49   "W:\\",
  50   "X:\\",
  51   "Y:\\",
  52   "Z:\\"
  53 };
  54 #endif                          /* #ifdef _XBT_WIN32 */
  55
  56 /*
  57  * Returns the initial path. On Windows the initial path is
  58  * the current directory for the current process in the other
  59  * case the function returns "./" that represents the current
  60  * directory on Unix/Linux platforms.
  61  */
  62
  63 const char *__surf_get_initial_path(void)
  64 {
  65
  66 #ifdef _XBT_WIN32
  67   unsigned i;
  68   char current_directory[MAX_PATH + 1] = { 0 };
  69   unsigned int len = GetCurrentDirectory(MAX_PATH + 1, current_directory);
  70   char root[4] = { 0 };
  71
  72   if (!len)
  73     return NULL;
  74
  75   strncpy(root, current_directory, 3);
  76
  77   for (i = 0; i < MAX_DRIVE; i++) {
  78     if (toupper(root[0]) == disk_drives_letter_table[i][0])
  79       return disk_drives_letter_table[i];
  80   }
  81
  82   return NULL;
  83 #else
  84   return "./";
  85 #endif
  86 }
  87
  88 /* The __surf_is_absolute_file_path() returns 1 if
  89  * file_path is a absolute file path, in the other
  90  * case the function returns 0.
  91  */
  92 int __surf_is_absolute_file_path(const char *file_path)
  93 {
  94 #ifdef _XBT_WIN32
  95   WIN32_FIND_DATA wfd = { 0 };
  96   HANDLE hFile = FindFirstFile(file_path, &wfd);
  97
  98   if (INVALID_HANDLE_VALUE == hFile)
  99     return 0;
 100
 101   FindClose(hFile);
 102   return 1;
 103 #else
 104   return (file_path[0] == '/');
 105 #endif
 106 }
 107
 108 double NOW = 0;
 109
 110 xbt_dynar_t model_list = NULL;
 111 tmgr_history_t history = NULL;
 112 lmm_system_t maxmin_system = NULL;
 113 xbt_dynar_t surf_path = NULL;
 114
 115 /* Don't forget to update the option description in smx_config when you change this */
 116 s_surf_model_description_t surf_network_model_description[] = {
 117   {"LV08",
 118    "Realistic network analytic model (slow-start modeled by multiplying latency by 10.4, bandwidth by .92; bottleneck sharing uses a payload of S=8775 for evaluating RTT). ",
 119    surf_network_model_init_LegrandVelho},
 120   {"Constant",
 121    "Simplistic network model where all communication take a constant time (one second). This model provides the lowest realism, but is (marginally) faster.",
 122    surf_network_model_init_Constant},
 123   {"SMPI",
 124    "Realistic network model specifically tailored for HPC settings (accurate modeling of slow start with correction factors on three intervals: < 1KiB, < 64 KiB, >= 64 KiB)",
 125    surf_network_model_init_SMPI},
 126   {"CM02",
 127    "Legacy network analytic model (Very similar to LV08, but without corrective factors. The timings of small messages are thus poorly modeled).",
 128    surf_network_model_init_CM02},
 129 #ifdef HAVE_GTNETS
 130   {"GTNets",
 131    "Network pseudo-model using the GTNets simulator instead of an analytic model",
 132    surf_network_model_init_GTNETS},
 133 #endif
 134 #ifdef HAVE_NS3
 135   {"NS3",
 136    "Network pseudo-model using the NS3 tcp model instead of an analytic model",
 137         surf_network_model_init_NS3},
 138 #endif
 139   {"Reno",
 140    "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
 141    surf_network_model_init_Reno},
 142   {"Reno2",
 143    "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
 144    surf_network_model_init_Reno2},
 145   {"Vegas",
 146    "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
 147    surf_network_model_init_Vegas},
 148   {NULL, NULL, NULL}      /* this array must be NULL terminated */
 149 };
 150
 151 s_surf_model_description_t surf_cpu_model_description[] = {
 152   {"Cas01",
 153    "Simplistic CPU model (time=size/power).",
 154    surf_cpu_model_init_Cas01},
 155   {NULL, NULL,  NULL}      /* this array must be NULL terminated */
 156 };
 157
 158 s_surf_model_description_t surf_workstation_model_description[] = {
 159   {"default",
 160    "Default workstation model. Currently, CPU:Cas01 and network:LV08 (with cross traffic enabled)",
 161    surf_workstation_model_init_current_default},
 162   {"compound",
 163    "Workstation model that is automatically chosen if you change the network and CPU models",
 164    surf_workstation_model_init_compound},
 165   {"ptask_L07", "Workstation model somehow similar to Cas01+CM02 but allowing parallel tasks",
 166    surf_workstation_model_init_ptask_L07},
 167   {NULL, NULL, NULL}      /* this array must be NULL terminated */
 168 };
 169
 170 s_surf_model_description_t surf_optimization_mode_description[] = {
 171   {"Lazy",
 172    "Lazy action management (partial invalidation in lmm + heap in action remaining).",
 173    NULL},
 174   {"TI",
 175    "Trace integration. Highly optimized mode when using availability traces (only available for the Cas01 CPU model for now).",
 176     NULL},
 177   {"Full",
 178    "Full update of remaining and variables. Slow but may be useful when debugging.",
 179    NULL},
 180   {NULL, NULL, NULL}      /* this array must be NULL terminated */
 181 };
 182
 183 #ifdef CONTEXT_THREADS
 184 static xbt_parmap_t surf_parmap = NULL; /* parallel map on models */
 185 #endif
 186
 187 static int surf_nthreads = 1;    /* number of threads of the parmap (1 means no parallelism) */
 188 static double *surf_mins = NULL; /* return value of share_resources for each model */
 189 static int surf_min_index;       /* current index in surf_mins */
 190 static double min;               /* duration determined by surf_solve */
 191
 192 static void surf_share_resources(surf_model_t model);
 193 static void surf_update_actions_state(surf_model_t model);
 194
 195 /** Displays the long description of all registered models, and quit */
 196 void model_help(const char *category, s_surf_model_description_t * table)
 197 {
 198   int i;
 199   printf("Long description of the %s models accepted by this simulator:\n",
 200          category);
 201   for (i = 0; table[i].name; i++)
 202     printf("  %s: %s\n", table[i].name, table[i].description);
 203 }
 204
 205 int find_model_description(s_surf_model_description_t * table,
 206                            const char *name)
 207 {
 208   int i;
 209   char *name_list = NULL;
 210
 211   for (i = 0; table[i].name; i++)
 212     if (!strcmp(name, table[i].name)) {
 213       return i;
 214     }
 215   name_list = strdup(table[0].name);
 216   for (i = 1; table[i].name; i++) {
 217     name_list =
 218         xbt_realloc(name_list,
 219                     strlen(name_list) + strlen(table[i].name) + 3);
 220     strcat(name_list, ", ");
 221     strcat(name_list, table[i].name);
 222   }
 223   xbt_die("Model '%s' is invalid! Valid models are: %s.", name, name_list);
 224   return -1;
 225 }
 226
 227 double generic_maxmin_share_resources(xbt_swag_t running_actions,
 228                                       size_t offset,
 229                                       lmm_system_t sys,
 230                                       void (*solve) (lmm_system_t))
 231 {
 232   surf_action_t action = NULL;
 233   double min = -1;
 234   double value = -1;
 235 #define VARIABLE(action) (*((lmm_variable_t*)(((char *) (action)) + (offset))))
 236
 237   solve(sys);
 238
 239   xbt_swag_foreach(action, running_actions) {
 240     value = lmm_variable_getvalue(VARIABLE(action));
 241     if ((value > 0) || (action->max_duration >= 0))
 242       break;
 243   }
 244
 245   if (!action)
 246     return -1.0;
 247
 248   if (value > 0) {
 249     if (action->remains > 0)
 250       min = action->remains / value;
 251     else
 252       min = 0.0;
 253     if ((action->max_duration >= 0) && (action->max_duration < min))
 254       min = action->max_duration;
 255   } else
 256     min = action->max_duration;
 257
 258
 259   for (action = xbt_swag_getNext(action, running_actions->offset);
 260        action;
 261        action = xbt_swag_getNext(action, running_actions->offset)) {
 262     value = lmm_variable_getvalue(VARIABLE(action));
 263     if (value > 0) {
 264       if (action->remains > 0)
 265         value = action->remains / value;
 266       else
 267         value = 0.0;
 268       if (value < min) {
 269         min = value;
 270         XBT_DEBUG("Updating min (value) with %p: %f", action, min);
 271       }
 272     }
 273     if ((action->max_duration >= 0) && (action->max_duration < min)) {
 274       min = action->max_duration;
 275       XBT_DEBUG("Updating min (duration) with %p: %f", action, min);
 276     }
 277   }
 278   XBT_DEBUG("min value : %f", min);
 279
 280 #undef VARIABLE
 281   return min;
 282 }
 283
 284 XBT_LOG_EXTERNAL_CATEGORY(surf_cpu);
 285 XBT_LOG_EXTERNAL_CATEGORY(surf_kernel);
 286 XBT_LOG_EXTERNAL_CATEGORY(surf_lagrange);
 287 XBT_LOG_EXTERNAL_CATEGORY(surf_lagrange_dichotomy);
 288 XBT_LOG_EXTERNAL_CATEGORY(surf_maxmin);
 289 XBT_LOG_EXTERNAL_CATEGORY(surf_network);
 290 XBT_LOG_EXTERNAL_CATEGORY(surf_trace);
 291 XBT_LOG_EXTERNAL_CATEGORY(surf_parse);
 292 XBT_LOG_EXTERNAL_CATEGORY(surf_timer);
 293 XBT_LOG_EXTERNAL_CATEGORY(surf_workstation);
 294 XBT_LOG_EXTERNAL_CATEGORY(surf_config);
 295 XBT_LOG_EXTERNAL_CATEGORY(surf_route);
 296
 297 #ifdef HAVE_GTNETS
 298 XBT_LOG_EXTERNAL_CATEGORY(surf_network_gtnets);
 299 #endif
 300
 301 void surf_init(int *argc, char **argv)
 302 {
 303         XBT_DEBUG("Create all Libs");
 304         host_lib = xbt_lib_new();
 305         link_lib = xbt_lib_new();
 306         as_router_lib = xbt_lib_new();
 307
 308         XBT_DEBUG("ADD ROUTING LEVEL");
 309         ROUTING_HOST_LEVEL = xbt_lib_add_level(host_lib,xbt_free);
 310         ROUTING_ASR_LEVEL  = xbt_lib_add_level(as_router_lib,xbt_free);
 311
 312         XBT_DEBUG("ADD SURF LEVELS");
 313         SURF_CPU_LEVEL = xbt_lib_add_level(host_lib,surf_resource_free);
 314         SURF_WKS_LEVEL = xbt_lib_add_level(host_lib,surf_resource_free);
 315         SURF_LINK_LEVEL = xbt_lib_add_level(link_lib,surf_resource_free);
 316
 317   /* Connect our log channels: that must be done manually under windows */
 318   XBT_LOG_CONNECT(surf_cpu, surf);
 319   XBT_LOG_CONNECT(surf_kernel, surf);
 320   XBT_LOG_CONNECT(surf_lagrange, surf);
 321   XBT_LOG_CONNECT(surf_lagrange_dichotomy, surf_lagrange);
 322   XBT_LOG_CONNECT(surf_maxmin, surf);
 323   XBT_LOG_CONNECT(surf_network, surf);
 324   XBT_LOG_CONNECT(surf_trace, surf);
 325   XBT_LOG_CONNECT(surf_parse, surf);
 326   XBT_LOG_CONNECT(surf_timer, surf);
 327   XBT_LOG_CONNECT(surf_workstation, surf);
 328   XBT_LOG_CONNECT(surf_config, surf);
 329   XBT_LOG_CONNECT(surf_route, surf);
 330
 331 #ifdef HAVE_GTNETS
 332   XBT_LOG_CONNECT(surf_network_gtnets, surf);
 333 #endif
 334
 335   xbt_init(argc, argv);
 336   if (!model_list)
 337     model_list = xbt_dynar_new(sizeof(surf_model_private_t), NULL);
 338   if (!history)
 339     history = tmgr_history_new();
 340
 341   surf_config_init(argc, argv);
 342   surf_action_init();
 343   if (MC_IS_ENABLED)
 344     MC_memory_init();
 345 }
 346
 347 #ifdef _XBT_WIN32
 348 # define FILE_DELIM "\\"
 349 #else
 350 # define FILE_DELIM "/"         /* FIXME: move to better location */
 351 #endif
 352
 353 FILE *surf_fopen(const char *name, const char *mode)
 354 {
 355   unsigned int cpt;
 356   char *path_elm = NULL;
 357   char *buff;
 358   FILE *file = NULL;
 359
 360   xbt_assert(name);
 361
 362   if (__surf_is_absolute_file_path(name))       /* don't mess with absolute file names */
 363     return fopen(name, mode);
 364
 365   /* search relative files in the path */
 366   xbt_dynar_foreach(surf_path, cpt, path_elm) {
 367     buff = bprintf("%s" FILE_DELIM "%s", path_elm, name);
 368     file = fopen(buff, mode);
 369     free(buff);
 370
 371     if (file)
 372       return file;
 373   }
 374   return NULL;
 375 }
 376
 377 void surf_exit(void)
 378 {
 379   unsigned int iter;
 380   surf_model_t model = NULL;
 381
 382   surf_config_finalize();
 383
 384   xbt_dynar_foreach(model_list, iter, model)
 385       model->model_private->finalize();
 386   xbt_dynar_free(&model_list);
 387   routing_exit();
 388
 389   if (maxmin_system) {
 390     lmm_system_free(maxmin_system);
 391     maxmin_system = NULL;
 392   }
 393   if (history) {
 394     tmgr_history_free(history);
 395     history = NULL;
 396   }
 397   surf_action_exit();
 398
 399 #ifdef CONTEXT_THREADS
 400   xbt_parmap_destroy(surf_parmap);
 401   xbt_free(surf_mins);
 402   surf_mins = NULL;
 403 #endif
 404
 405   xbt_dynar_free(&surf_path);
 406
 407   xbt_lib_free(&host_lib);
 408   xbt_lib_free(&link_lib);
 409   xbt_lib_free(&as_router_lib);
 410
 411
 412   tmgr_finalize();
 413   surf_parse_lex_destroy();
 414   surf_parse_free_callbacks();
 415
 416   NOW = 0;                      /* Just in case the user plans to restart the simulation afterward */
 417 }
 418
 419 void surf_presolve(void)
 420 {
 421   double next_event_date = -1.0;
 422   tmgr_trace_event_t event = NULL;
 423   double value = -1.0;
 424   surf_resource_t resource = NULL;
 425   surf_model_t model = NULL;
 426   unsigned int iter;
 427
 428   XBT_DEBUG
 429       ("First Run! Let's \"purge\" events and put models in the right state");
 430   while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
 431     if (next_event_date > NOW)
 432       break;
 433     while ((event =
 434             tmgr_history_get_next_event_leq(history, next_event_date,
 435                                             &value,
 436                                             (void **) &resource))) {
 437       resource->model->model_private->update_resource_state(resource,
 438                                                             event, value,
 439                                                             NOW);
 440     }
 441   }
 442   xbt_dynar_foreach(model_list, iter, model)
 443       model->model_private->update_actions_state(NOW, 0.0);
 444 }
 445
 446 double surf_solve(double max_date)
 447 {
 448   min = -1.0; /* duration */
 449   double next_event_date = -1.0;
 450   double model_next_action_end = -1.0;
 451   double value = -1.0;
 452   surf_resource_t resource = NULL;
 453   surf_model_t model = NULL;
 454   tmgr_trace_event_t event = NULL;
 455   unsigned int iter;
 456
 457   if (max_date != -1.0 && max_date != NOW) {
 458     min = max_date - NOW;
 459   }
 460
 461   XBT_DEBUG("Looking for next action end for all models except NS3");
 462
 463   if (surf_mins == NULL) {
 464     surf_mins = xbt_new(double, xbt_dynar_length(model_list));
 465   }
 466   surf_min_index = 0;
 467
 468   if (surf_get_nthreads() > 1) {
 469     /* parallel version */
 470     xbt_parmap_apply(surf_parmap, (void_f_pvoid_t) surf_share_resources, model_list);
 471   }
 472   else {
 473     /* sequential version */
 474     xbt_dynar_foreach(model_list, iter, model) {
 475       surf_share_resources(model);
 476     }
 477   }
 478
 479   unsigned i;
 480   for (i = 0; i < xbt_dynar_length(model_list); i++) {
 481     if ((min < 0.0 || surf_mins[i] < min)
 482         && surf_mins[i] >= 0.0) {
 483       min = surf_mins[i];
 484     }
 485   }
 486
 487   XBT_DEBUG("Min for resources (remember that NS3 dont update that value) : %f", min);
 488
 489   XBT_DEBUG("Looking for next trace event");
 490
 491   do {
 492     XBT_DEBUG("Next TRACE event : %f", next_event_date);
 493
 494     next_event_date = tmgr_history_next_date(history);
 495
 496     if(surf_network_model->name && !strcmp(surf_network_model->name,"network NS3")){
 497       if(next_event_date!=-1.0 && min!=-1.0) {
 498         min = MIN(next_event_date - NOW, min);
 499       } else{
 500         min = MAX(next_event_date - NOW, min);
 501       }
 502
 503       XBT_DEBUG("Run for NS3 at most %f", min);
 504       // run until min or next flow
 505       model_next_action_end = surf_network_model->model_private->share_resources(min);
 506
 507       XBT_DEBUG("Min for NS3 : %f", model_next_action_end);
 508       if(model_next_action_end>=0.0)
 509         min = model_next_action_end;
 510     }
 511
 512     if (next_event_date == -1.0) {
 513         XBT_DEBUG("no next TRACE event. Stop searching for it");
 514         break;
 515     }
 516
 517     if ((min != -1.0) && (next_event_date > NOW + min)) break;
 518
 519     XBT_DEBUG("Updating models");
 520     while ((event =
 521             tmgr_history_get_next_event_leq(history, next_event_date,
 522                                             &value,
 523                                             (void **) &resource))) {
 524       if (resource->model->model_private->resource_used(resource)) {
 525         min = next_event_date - NOW;
 526         XBT_DEBUG
 527             ("This event will modify model state. Next event set to %f",
 528              min);
 529       }
 530       /* update state of model_obj according to new value. Does not touch lmm.
 531          It will be modified if needed when updating actions */
 532       XBT_DEBUG("Calling update_resource_state for resource %s with min %lf",
 533              resource->model->name, min);
 534       resource->model->model_private->update_resource_state(resource,
 535                                                             event, value,
 536                                                             NOW + min);
 537     }
 538   } while (1);
 539
 540   /* FIXME: Moved this test to here to avoid stopping simulation if there are actions running on cpus and all cpus are with availability = 0.
 541    * This may cause an infinite loop if one cpu has a trace with periodicity = 0 and the other a trace with periodicity > 0.
 542    * The options are: all traces with same periodicity(0 or >0) or we need to change the way how the events are managed */
 543   if (min == -1.0) {
 544         XBT_DEBUG("No next event at all. Bail out now.");
 545     return -1.0;
 546   }
 547
 548   XBT_DEBUG("Duration set to %f", min);
 549
 550   NOW = NOW + min;
 551
 552   if (surf_get_nthreads() > 1) {
 553     /* parallel version */
 554     xbt_parmap_apply(surf_parmap, (void_f_pvoid_t) surf_update_actions_state, model_list);
 555   }
 556   else {
 557     /* sequential version */
 558     xbt_dynar_foreach(model_list, iter, model) {
 559       surf_update_actions_state(model);
 560     }
 561   }
 562
 563 #ifdef HAVE_TRACING
 564   TRACE_paje_dump_buffer (0);
 565 #endif
 566
 567   return min;
 568 }
 569
 570 XBT_INLINE double surf_get_clock(void)
 571 {
 572   return NOW;
 573 }
 574
 575 static void surf_share_resources(surf_model_t model)
 576 {
 577   if (strcmp(model->name,"network NS3")) {
 578     XBT_DEBUG("Running for Resource [%s]", model->name);
 579     double next_action_end = model->model_private->share_resources(NOW);
 580     XBT_DEBUG("Resource [%s] : next action end = %f",
 581         model->name, next_action_end);
 582     int i = __sync_fetch_and_add(&surf_min_index, 1);
 583     surf_mins[i] = next_action_end;
 584   }
 585 }
 586
 587 static void surf_update_actions_state(surf_model_t model)
 588 {
 589   model->model_private->update_actions_state(NOW, min);
 590 }
 591
 592 /**
 593  * \brief Returns the number of parallel threads used to update the models.
 594  * \return the number of threads (1 means no parallelism)
 595  */
 596 int surf_get_nthreads(void) {
 597   return surf_nthreads;
 598 }
 599
 600 /**
 601  * \brief Sets the number of parallel threads used to update the models.
 602  *
 603  * A value of 1 means no parallelism.
 604  *
 605  * \param nb_threads the number of threads to use
 606  */
 607 void surf_set_nthreads(int nthreads) {
 608
 609   if (nthreads<=0) {
 610      nthreads = xbt_os_get_numcores();
 611      XBT_INFO("Auto-setting surf/nthreads to %d",nthreads);
 612   }
 613
 614 #ifdef CONTEXT_THREADS
 615   xbt_parmap_destroy(surf_parmap);
 616   surf_parmap = NULL;
 617 #endif
 618
 619   if (nthreads > 1) {
 620 #ifdef CONTEXT_THREADS
 621     surf_parmap = xbt_parmap_new(nthreads, XBT_PARMAP_DEFAULT);
 622 #else
 623     THROWF(arg_error, 0, "Cannot activate parallel threads in Surf: your architecture does not support threads");
 624 #endif
 625   }
 626
 627   surf_nthreads = nthreads;
 628 }