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 s_surf_model_description_t surf_storage_model_description[] = {
 184   {"default",
 185    "Simplistic storage model.",
 186    surf_storage_model_init_default},
 187   {NULL, NULL,  NULL}      /* this array must be NULL terminated */
 188 };
 189
 190 #ifdef CONTEXT_THREADS
 191 static xbt_parmap_t surf_parmap = NULL; /* parallel map on models */
 192 #endif
 193
 194 static int surf_nthreads = 1;    /* number of threads of the parmap (1 means no parallelism) */
 195 static double *surf_mins = NULL; /* return value of share_resources for each model */
 196 static int surf_min_index;       /* current index in surf_mins */
 197 static double min;               /* duration determined by surf_solve */
 198
 199 static void surf_share_resources(surf_model_t model);
 200 static void surf_update_actions_state(surf_model_t model);
 201
 202 /** Displays the long description of all registered models, and quit */
 203 void model_help(const char *category, s_surf_model_description_t * table)
 204 {
 205   int i;
 206   printf("Long description of the %s models accepted by this simulator:\n",
 207          category);
 208   for (i = 0; table[i].name; i++)
 209     printf("  %s: %s\n", table[i].name, table[i].description);
 210 }
 211
 212 int find_model_description(s_surf_model_description_t * table,
 213                            const char *name)
 214 {
 215   int i;
 216   char *name_list = NULL;
 217
 218   for (i = 0; table[i].name; i++)
 219     if (!strcmp(name, table[i].name)) {
 220       return i;
 221     }
 222   name_list = strdup(table[0].name);
 223   for (i = 1; table[i].name; i++) {
 224     name_list =
 225         xbt_realloc(name_list,
 226                     strlen(name_list) + strlen(table[i].name) + 3);
 227     strcat(name_list, ", ");
 228     strcat(name_list, table[i].name);
 229   }
 230   xbt_die("Model '%s' is invalid! Valid models are: %s.", name, name_list);
 231   return -1;
 232 }
 233
 234 double generic_maxmin_share_resources(xbt_swag_t running_actions,
 235                                       size_t offset,
 236                                       lmm_system_t sys,
 237                                       void (*solve) (lmm_system_t))
 238 {
 239   surf_action_t action = NULL;
 240   double min = -1;
 241   double value = -1;
 242 #define VARIABLE(action) (*((lmm_variable_t*)(((char *) (action)) + (offset))))
 243
 244   solve(sys);
 245
 246   xbt_swag_foreach(action, running_actions) {
 247     value = lmm_variable_getvalue(VARIABLE(action));
 248     if ((value > 0) || (action->max_duration >= 0))
 249       break;
 250   }
 251
 252   if (!action)
 253     return -1.0;
 254
 255   if (value > 0) {
 256     if (action->remains > 0)
 257       min = action->remains / value;
 258     else
 259       min = 0.0;
 260     if ((action->max_duration >= 0) && (action->max_duration < min))
 261       min = action->max_duration;
 262   } else
 263     min = action->max_duration;
 264
 265
 266   for (action = xbt_swag_getNext(action, running_actions->offset);
 267        action;
 268        action = xbt_swag_getNext(action, running_actions->offset)) {
 269     value = lmm_variable_getvalue(VARIABLE(action));
 270     if (value > 0) {
 271       if (action->remains > 0)
 272         value = action->remains / value;
 273       else
 274         value = 0.0;
 275       if (value < min) {
 276         min = value;
 277         XBT_DEBUG("Updating min (value) with %p: %f", action, min);
 278       }
 279     }
 280     if ((action->max_duration >= 0) && (action->max_duration < min)) {
 281       min = action->max_duration;
 282       XBT_DEBUG("Updating min (duration) with %p: %f", action, min);
 283     }
 284   }
 285   XBT_DEBUG("min value : %f", min);
 286
 287 #undef VARIABLE
 288   return min;
 289 }
 290
 291 static XBT_INLINE void routing_asr_host_free(void *p)
 292 {
 293   network_element_t elm = p;
 294   free(elm->name);
 295   xbt_free(elm);
 296 }
 297
 298 void surf_init(int *argc, char **argv)
 299 {
 300   XBT_DEBUG("Create all Libs");
 301   host_lib = xbt_lib_new();
 302   link_lib = xbt_lib_new();
 303   as_router_lib = xbt_lib_new();
 304   storage_lib = xbt_lib_new();
 305   storage_type_lib = xbt_lib_new();
 306
 307   XBT_DEBUG("ADD ROUTING LEVEL");
 308   ROUTING_HOST_LEVEL = xbt_lib_add_level(host_lib,routing_asr_host_free);
 309   ROUTING_ASR_LEVEL  = xbt_lib_add_level(as_router_lib,routing_asr_host_free);
 310   ROUTING_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,xbt_free);
 311   ROUTING_STORAGE_HOST_LEVEL = xbt_lib_add_level(storage_lib,routing_storage_host_free);
 312   ROUTING_STORAGE_TYPE_LEVEL = xbt_lib_add_level(storage_type_lib,routing_storage_type_free);
 313
 314   XBT_DEBUG("ADD SURF LEVELS");
 315   SURF_CPU_LEVEL = xbt_lib_add_level(host_lib,surf_resource_free);
 316   SURF_WKS_LEVEL = xbt_lib_add_level(host_lib,surf_resource_free);
 317   SURF_LINK_LEVEL = xbt_lib_add_level(link_lib,surf_resource_free);
 318   SURF_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,surf_resource_free);
 319
 320   xbt_init(argc, argv);
 321   if (!model_list)
 322     model_list = xbt_dynar_new(sizeof(surf_model_private_t), NULL);
 323   if (!history)
 324     history = tmgr_history_new();
 325
 326   surf_config_init(argc, argv);
 327   surf_action_init();
 328   if (MC_IS_ENABLED)
 329     MC_memory_init();
 330 }
 331
 332 #ifdef _XBT_WIN32
 333 # define FILE_DELIM "\\"
 334 #else
 335 # define FILE_DELIM "/"         /* FIXME: move to better location */
 336 #endif
 337
 338 FILE *surf_fopen(const char *name, const char *mode)
 339 {
 340   unsigned int cpt;
 341   char *path_elm = NULL;
 342   char *buff;
 343   FILE *file = NULL;
 344
 345   xbt_assert(name);
 346
 347   if (__surf_is_absolute_file_path(name))       /* don't mess with absolute file names */
 348     return fopen(name, mode);
 349
 350   /* search relative files in the path */
 351   xbt_dynar_foreach(surf_path, cpt, path_elm) {
 352     buff = bprintf("%s" FILE_DELIM "%s", path_elm, name);
 353     file = fopen(buff, mode);
 354     free(buff);
 355
 356     if (file)
 357       return file;
 358   }
 359   return NULL;
 360 }
 361
 362 void surf_exit(void)
 363 {
 364   unsigned int iter;
 365   surf_model_t model = NULL;
 366
 367   surf_config_finalize();
 368
 369   xbt_dynar_foreach(model_list, iter, model)
 370       model->model_private->finalize();
 371   xbt_dynar_free(&model_list);
 372   routing_exit();
 373
 374   if (maxmin_system) {
 375     lmm_system_free(maxmin_system);
 376     maxmin_system = NULL;
 377   }
 378   if (history) {
 379     tmgr_history_free(history);
 380     history = NULL;
 381   }
 382   surf_action_exit();
 383
 384 #ifdef CONTEXT_THREADS
 385   xbt_parmap_destroy(surf_parmap);
 386   xbt_free(surf_mins);
 387   surf_mins = NULL;
 388 #endif
 389
 390   xbt_dynar_free(&surf_path);
 391
 392   xbt_lib_free(&host_lib);
 393   xbt_lib_free(&link_lib);
 394   xbt_lib_free(&as_router_lib);
 395   xbt_lib_free(&storage_lib);
 396   xbt_lib_free(&storage_type_lib);
 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   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
 449   if (surf_mins == NULL) {
 450     surf_mins = xbt_new(double, xbt_dynar_length(model_list));
 451   }
 452   surf_min_index = 0;
 453
 454
 455   if (surf_get_nthreads() > 1) {
 456     /* parallel version */
 457 #ifdef CONTEXT_THREADS
 458     xbt_parmap_apply(surf_parmap, (void_f_pvoid_t) surf_share_resources, model_list);
 459 #endif
 460   }
 461   else {
 462     /* sequential version */
 463     xbt_dynar_foreach(model_list, iter, model) {
 464       surf_share_resources(model);
 465     }
 466   }
 467
 468   unsigned i;
 469   for (i = 0; i < xbt_dynar_length(model_list); i++) {
 470     if ((min < 0.0 || surf_mins[i] < min)
 471         && surf_mins[i] >= 0.0) {
 472       min = surf_mins[i];
 473     }
 474   }
 475
 476   XBT_DEBUG("Min for resources (remember that NS3 dont update that value) : %f", min);
 477
 478   XBT_DEBUG("Looking for next trace event");
 479
 480   do {
 481     XBT_DEBUG("Next TRACE event : %f", next_event_date);
 482
 483     next_event_date = tmgr_history_next_date(history);
 484
 485     if(surf_network_model->name && !strcmp(surf_network_model->name,"network NS3")){
 486       if(next_event_date!=-1.0 && min!=-1.0) {
 487         min = MIN(next_event_date - NOW, min);
 488       } else{
 489         min = MAX(next_event_date - NOW, min);
 490       }
 491
 492       XBT_DEBUG("Run for NS3 at most %f", min);
 493       // run until min or next flow
 494       model_next_action_end = surf_network_model->model_private->share_resources(min);
 495
 496       XBT_DEBUG("Min for NS3 : %f", model_next_action_end);
 497       if(model_next_action_end>=0.0)
 498         min = model_next_action_end;
 499     }
 500
 501     if (next_event_date == -1.0) {
 502         XBT_DEBUG("no next TRACE event. Stop searching for it");
 503         break;
 504     }
 505
 506     if ((min != -1.0) && (next_event_date > NOW + min)) break;
 507
 508     XBT_DEBUG("Updating models");
 509     while ((event =
 510             tmgr_history_get_next_event_leq(history, next_event_date,
 511                                             &value,
 512                                             (void **) &resource))) {
 513       if (resource->model->model_private->resource_used(resource)) {
 514         min = next_event_date - NOW;
 515         XBT_DEBUG
 516             ("This event will modify model state. Next event set to %f",
 517              min);
 518       }
 519       /* update state of model_obj according to new value. Does not touch lmm.
 520          It will be modified if needed when updating actions */
 521       XBT_DEBUG("Calling update_resource_state for resource %s with min %lf",
 522              resource->model->name, min);
 523       resource->model->model_private->update_resource_state(resource,
 524                                                             event, value,
 525                                                             NOW + min);
 526     }
 527   } while (1);
 528
 529   /* FIXME: Moved this test to here to avoid stopping simulation if there are actions running on cpus and all cpus are with availability = 0.
 530    * This may cause an infinite loop if one cpu has a trace with periodicity = 0 and the other a trace with periodicity > 0.
 531    * The options are: all traces with same periodicity(0 or >0) or we need to change the way how the events are managed */
 532   if (min == -1.0) {
 533         XBT_DEBUG("No next event at all. Bail out now.");
 534     return -1.0;
 535   }
 536
 537   XBT_DEBUG("Duration set to %f", min);
 538
 539   NOW = NOW + min;
 540
 541   if (surf_get_nthreads() > 1) {
 542     /* parallel version */
 543 #ifdef CONTEXT_THREADS
 544     xbt_parmap_apply(surf_parmap, (void_f_pvoid_t) surf_update_actions_state, model_list);
 545 #endif
 546   }
 547   else {
 548     /* sequential version */
 549     xbt_dynar_foreach(model_list, iter, model) {
 550       surf_update_actions_state(model);
 551     }
 552   }
 553
 554 #ifdef HAVE_TRACING
 555   TRACE_paje_dump_buffer (0);
 556 #endif
 557
 558   return min;
 559 }
 560
 561 XBT_INLINE double surf_get_clock(void)
 562 {
 563   return NOW;
 564 }
 565
 566 static void surf_share_resources(surf_model_t model)
 567 {
 568   double next_action_end = -1.0;
 569   int i = __sync_fetch_and_add(&surf_min_index, 1);
 570   if (strcmp(model->name,"network NS3")) {
 571     XBT_DEBUG("Running for Resource [%s]", model->name);
 572     next_action_end = model->model_private->share_resources(NOW);
 573     XBT_DEBUG("Resource [%s] : next action end = %f",
 574         model->name, next_action_end);
 575   }
 576   surf_mins[i] = next_action_end;
 577 }
 578
 579 static void surf_update_actions_state(surf_model_t model)
 580 {
 581   model->model_private->update_actions_state(NOW, min);
 582 }
 583
 584 /**
 585  * \brief Returns the number of parallel threads used to update the models.
 586  * \return the number of threads (1 means no parallelism)
 587  */
 588 int surf_get_nthreads(void) {
 589   return surf_nthreads;
 590 }
 591
 592 /**
 593  * \brief Sets the number of parallel threads used to update the models.
 594  *
 595  * A value of 1 means no parallelism.
 596  *
 597  * \param nb_threads the number of threads to use
 598  */
 599 void surf_set_nthreads(int nthreads) {
 600
 601   if (nthreads<=0) {
 602      nthreads = xbt_os_get_numcores();
 603      XBT_INFO("Auto-setting surf/nthreads to %d",nthreads);
 604   }
 605
 606 #ifdef CONTEXT_THREADS
 607   xbt_parmap_destroy(surf_parmap);
 608   surf_parmap = NULL;
 609 #endif
 610
 611   if (nthreads > 1) {
 612 #ifdef CONTEXT_THREADS
 613     surf_parmap = xbt_parmap_new(nthreads, XBT_PARMAP_DEFAULT);
 614 #else
 615     THROWF(arg_error, 0, "Cannot activate parallel threads in Surf: your architecture does not support threads");
 616 #endif
 617   }
 618
 619   surf_nthreads = nthreads;
 620 }