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