src/surf/surf_interface.cpp

   1 /* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "surf_interface.hpp"
   7 #include "mc/mc.h"
   8 #include "simgrid/s4u/Engine.hpp"
   9 #include "simgrid/sg_config.h"
  10 #include "src/instr/instr_private.h" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
  11 #include "src/kernel/routing/NetPoint.hpp"
  12 #include "src/surf/HostImpl.hpp"
  13
  14 #include <fstream>
  15 #include <vector>
  16
  17 XBT_LOG_NEW_CATEGORY(surf, "All SURF categories");
  18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf, "Logging specific to SURF (kernel)");
  19
  20 /*********
  21  * Utils *
  22  *********/
  23
  24 std::vector<surf_model_t> * all_existing_models = nullptr; /* to destroy models correctly */
  25
  26 simgrid::trace_mgr::future_evt_set *future_evt_set = nullptr;
  27 std::vector<std::string> surf_path;
  28 std::vector<simgrid::s4u::Host*> host_that_restart;
  29 xbt_dict_t watched_hosts_lib;
  30 extern std::map<std::string, storage_type_t> storage_types;
  31
  32 namespace simgrid {
  33 namespace surf {
  34
  35 simgrid::xbt::signal<void()> surfExitCallbacks;
  36 }
  37 }
  38
  39 #include <simgrid/plugins/energy.h> // FIXME: this plugin should not be linked to the core
  40 #include <simgrid/plugins/load.h>   // FIXME: this plugin should not be linked to the core
  41
  42 s_surf_model_description_t surf_plugin_description[] = {
  43     {"Energy", "Cpu energy consumption.", &sg_host_energy_plugin_init},
  44     {"Load", "Cpu load.", &sg_host_load_plugin_init},
  45     {nullptr, nullptr, nullptr} /* this array must be nullptr terminated */
  46 };
  47
  48 /* Don't forget to update the option description in smx_config when you change this */
  49 s_surf_model_description_t surf_network_model_description[] = {
  50   {"LV08", "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). ",
  51    &surf_network_model_init_LegrandVelho},
  52   {"Constant",
  53    "Simplistic network model where all communication take a constant time (one second). This model provides the lowest realism, but is (marginally) faster.",
  54    &surf_network_model_init_Constant},
  55   {"SMPI", "Realistic network model specifically tailored for HPC settings (accurate modeling of slow start with correction factors on three intervals: < 1KiB, < 64 KiB, >= 64 KiB)",
  56    &surf_network_model_init_SMPI},
  57   {"IB", "Realistic network model specifically tailored for HPC settings, with Infiniband contention model",
  58    &surf_network_model_init_IB},
  59   {"CM02", "Legacy network analytic model (Very similar to LV08, but without corrective factors. The timings of small messages are thus poorly modeled).",
  60    &surf_network_model_init_CM02},
  61   {"NS3", "Network pseudo-model using the NS3 tcp model instead of an analytic model", &surf_network_model_init_NS3},
  62   {"Reno",  "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
  63    &surf_network_model_init_Reno},
  64   {"Reno2", "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
  65    &surf_network_model_init_Reno2},
  66   {"Vegas", "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
  67    &surf_network_model_init_Vegas},
  68   {nullptr, nullptr, nullptr}      /* this array must be nullptr terminated */
  69 };
  70
  71 #if ! HAVE_SMPI
  72 void surf_network_model_init_SMPI() {
  73   xbt_die("Please activate SMPI support in cmake to use the SMPI network model.");
  74 }
  75 void surf_network_model_init_IB() {
  76   xbt_die("Please activate SMPI support in cmake to use the IB network model.");
  77 }
  78 #endif
  79 #if !SIMGRID_HAVE_NS3
  80 void surf_network_model_init_NS3() {
  81   xbt_die("Please activate NS3 support in cmake and install the dependencies to use the NS3 network model.");
  82 }
  83 #endif
  84
  85 s_surf_model_description_t surf_cpu_model_description[] = {
  86   {"Cas01", "Simplistic CPU model (time=size/power).", &surf_cpu_model_init_Cas01},
  87   {nullptr, nullptr,  nullptr}      /* this array must be nullptr terminated */
  88 };
  89
  90 s_surf_model_description_t surf_host_model_description[] = {
  91   {"default",   "Default host model. Currently, CPU:Cas01 and network:LV08 (with cross traffic enabled)", &surf_host_model_init_current_default},
  92   {"compound",  "Host model that is automatically chosen if you change the network and CPU models", &surf_host_model_init_compound},
  93   {"ptask_L07", "Host model somehow similar to Cas01+CM02 but allowing parallel tasks", &surf_host_model_init_ptask_L07},
  94   {nullptr, nullptr, nullptr}      /* this array must be nullptr terminated */
  95 };
  96
  97 s_surf_model_description_t surf_optimization_mode_description[] = {
  98   {"Lazy", "Lazy action management (partial invalidation in lmm + heap in action remaining).", nullptr},
  99   {"TI",   "Trace integration. Highly optimized mode when using availability traces (only available for the Cas01 CPU model for now).", nullptr},
 100   {"Full", "Full update of remaining and variables. Slow but may be useful when debugging.", nullptr},
 101   {nullptr, nullptr, nullptr}      /* this array must be nullptr terminated */
 102 };
 103
 104 s_surf_model_description_t surf_storage_model_description[] = {
 105   {"default", "Simplistic storage model.", &surf_storage_model_init_default},
 106   {nullptr, nullptr,  nullptr}      /* this array must be nullptr terminated */
 107 };
 108
 109 #if HAVE_THREAD_CONTEXTS
 110 static xbt_parmap_t surf_parmap = nullptr; /* parallel map on models */
 111 #endif
 112
 113 double NOW = 0;
 114
 115 double surf_get_clock()
 116 {
 117   return NOW;
 118 }
 119
 120 #ifdef _WIN32
 121 # define FILE_DELIM "\\"
 122 #else
 123 # define FILE_DELIM "/"         /* FIXME: move to better location */
 124 #endif
 125
 126 std::ifstream* surf_ifsopen(const char* name)
 127 {
 128   std::ifstream* fs = new std::ifstream();
 129   xbt_assert(name);
 130   if (__surf_is_absolute_file_path(name)) { /* don't mess with absolute file names */
 131     fs->open(name, std::ifstream::in);
 132   }
 133
 134   /* search relative files in the path */
 135   for (auto path_elm : surf_path) {
 136     std::string buff = path_elm + FILE_DELIM + name;
 137     fs->open(buff.c_str(), std::ifstream::in);
 138
 139     if (not fs->fail()) {
 140       XBT_DEBUG("Found file at %s", buff.c_str());
 141       return fs;
 142     }
 143   }
 144
 145   return fs;
 146 }
 147 FILE *surf_fopen(const char *name, const char *mode)
 148 {
 149   FILE *file = nullptr;
 150
 151   xbt_assert(name);
 152
 153   if (__surf_is_absolute_file_path(name))       /* don't mess with absolute file names */
 154     return fopen(name, mode);
 155
 156   /* search relative files in the path */
 157   for (auto path_elm : surf_path) {
 158     char* buff = bprintf("%s" FILE_DELIM "%s", path_elm.c_str(), name);
 159     file = fopen(buff, mode);
 160     free(buff);
 161
 162     if (file)
 163       return file;
 164   }
 165   return nullptr;
 166 }
 167
 168 #ifdef _WIN32
 169 #include <windows.h>
 170 #define MAX_DRIVE 26
 171 static const char *disk_drives_letter_table[MAX_DRIVE] = {
 172   "A:\\","B:\\","C:\\","D:\\","E:\\","F:\\","G:\\","H:\\","I:\\","J:\\","K:\\","L:\\","M:\\",
 173   "N:\\","O:\\","P:\\","Q:\\","R:\\","S:\\","T:\\","U:\\","V:\\","W:\\","X:\\","Y:\\","Z:\\"
 174 };
 175 #endif
 176
 177 /*
 178  * Returns the initial path. On Windows the initial path is
 179  * the current directory for the current process in the other
 180  * case the function returns "./" that represents the current
 181  * directory on Unix/Linux platforms.
 182  */
 183
 184 const char *__surf_get_initial_path()
 185 {
 186
 187 #ifdef _WIN32
 188   unsigned i;
 189   char current_directory[MAX_PATH + 1] = { 0 };
 190   unsigned int len = GetCurrentDirectory(MAX_PATH + 1, current_directory);
 191   char root[4] = { 0 };
 192
 193   if (not len)
 194     return nullptr;
 195
 196   strncpy(root, current_directory, 3);
 197
 198   for (i = 0; i < MAX_DRIVE; i++) {
 199     if (toupper(root[0]) == disk_drives_letter_table[i][0])
 200       return disk_drives_letter_table[i];
 201   }
 202
 203   return nullptr;
 204 #else
 205   return "./";
 206 #endif
 207 }
 208
 209 /* The __surf_is_absolute_file_path() returns 1 if
 210  * file_path is a absolute file path, in the other
 211  * case the function returns 0.
 212  */
 213 int __surf_is_absolute_file_path(const char *file_path)
 214 {
 215 #ifdef _WIN32
 216   WIN32_FIND_DATA wfd = { 0 };
 217   HANDLE hFile = FindFirstFile(file_path, &wfd);
 218
 219   if (INVALID_HANDLE_VALUE == hFile)
 220     return 0;
 221
 222   FindClose(hFile);
 223   return 1;
 224 #else
 225   return (file_path[0] == '/');
 226 #endif
 227 }
 228
 229 /** Displays the long description of all registered models, and quit */
 230 void model_help(const char *category, s_surf_model_description_t * table)
 231 {
 232   printf("Long description of the %s models accepted by this simulator:\n", category);
 233   for (int i = 0; table[i].name; i++)
 234     printf("  %s: %s\n", table[i].name, table[i].description);
 235 }
 236
 237 int find_model_description(s_surf_model_description_t * table,
 238                            const char *name)
 239 {
 240   int i;
 241   char *name_list = nullptr;
 242
 243   for (i = 0; table[i].name; i++)
 244     if (not strcmp(name, table[i].name)) {
 245       return i;
 246     }
 247   if (not table[0].name)
 248     xbt_die("No model is valid! This is a bug.");
 249   name_list = xbt_strdup(table[0].name);
 250   for (i = 1; table[i].name; i++) {
 251     name_list = (char *) xbt_realloc(name_list, strlen(name_list) + strlen(table[i].name) + 3);
 252     strncat(name_list, ", ", 2);
 253     strncat(name_list, table[i].name, strlen(table[i].name));
 254   }
 255   xbt_die("Model '%s' is invalid! Valid models are: %s.", name, name_list);
 256   return -1;
 257 }
 258
 259 static inline void surf_storage_free(void *r)
 260 {
 261   delete static_cast<simgrid::surf::StorageImpl*>(r);
 262 }
 263
 264 void sg_version_check(int lib_version_major, int lib_version_minor, int lib_version_patch)
 265 {
 266   if ((lib_version_major != SIMGRID_VERSION_MAJOR) || (lib_version_minor != SIMGRID_VERSION_MINOR)) {
 267     fprintf(stderr, "FATAL ERROR: Your program was compiled with SimGrid version %d.%d.%d, "
 268                     "and then linked against SimGrid %d.%d.%d. Please fix this.\n",
 269             lib_version_major, lib_version_minor, lib_version_patch, SIMGRID_VERSION_MAJOR, SIMGRID_VERSION_MINOR,
 270             SIMGRID_VERSION_PATCH);
 271     abort();
 272   }
 273   if (lib_version_patch != SIMGRID_VERSION_PATCH) {
 274     if (SIMGRID_VERSION_PATCH >= 90 || lib_version_patch >= 90) {
 275       fprintf(
 276           stderr,
 277           "FATAL ERROR: Your program was compiled with SimGrid version %d.%d.%d, "
 278           "and then linked against SimGrid %d.%d.%d. \n"
 279           "One of them is a development version, and should not be mixed with the stable release. Please fix this.\n",
 280           lib_version_major, lib_version_minor, lib_version_patch, SIMGRID_VERSION_MAJOR, SIMGRID_VERSION_MINOR,
 281           SIMGRID_VERSION_PATCH);
 282       abort();
 283     }
 284     fprintf(stderr, "Warning: Your program was compiled with SimGrid version %d.%d.%d, "
 285                     "and then linked against SimGrid %d.%d.%d. Proceeding anyway.\n",
 286             lib_version_major, lib_version_minor, lib_version_patch, SIMGRID_VERSION_MAJOR, SIMGRID_VERSION_MINOR,
 287             SIMGRID_VERSION_PATCH);
 288   }
 289 }
 290
 291 void sg_version_get(int* ver_major, int* ver_minor, int* ver_patch)
 292 {
 293   *ver_major = SIMGRID_VERSION_MAJOR;
 294   *ver_minor = SIMGRID_VERSION_MINOR;
 295   *ver_patch = SIMGRID_VERSION_PATCH;
 296 }
 297
 298 void sg_version()
 299 {
 300   std::printf("This program was linked against %s (git: %s), found in %s.\n",
 301               SIMGRID_VERSION_STRING, SIMGRID_GIT_VERSION, SIMGRID_INSTALL_PREFIX);
 302
 303 #if SIMGRID_HAVE_MC
 304   std::printf("   Model-checking support compiled in.\n");
 305 #else
 306   std::printf("   Model-checking support disabled at compilation.\n");
 307 #endif
 308
 309 #if SIMGRID_HAVE_NS3
 310   std::printf("   NS3 support compiled in.\n");
 311 #else
 312   std::printf("   NS3 support disabled at compilation.\n");
 313 #endif
 314
 315 #if SIMGRID_HAVE_JEDULE
 316   std::printf("   Jedule support compiled in.\n");
 317 #else
 318   std::printf("   Jedule support disabled at compilation.\n");
 319 #endif
 320
 321 #if SIMGRID_HAVE_LUA
 322   std::printf("   Lua support compiled in.\n");
 323 #else
 324   std::printf("   Lua support disabled at compilation.\n");
 325 #endif
 326
 327 #if SIMGRID_HAVE_MALLOCATOR
 328   std::printf("   Mallocator support compiled in.\n");
 329 #else
 330   std::printf("   Mallocator support disabled at compilation.\n");
 331 #endif
 332
 333   std::printf("\nTo cite SimGrid in a publication, please use:\n"
 334               "   Henri Casanova, Arnaud Giersch, Arnaud Legrand, Martin Quinson, Frédéric Suter. \n"
 335               "   Versatile, Scalable, and Accurate Simulation of Distributed Applications and Platforms. \n"
 336               "   Journal of Parallel and Distributed Computing, Elsevier, 2014, 74 (10), pp.2899-2917.\n");
 337   std::printf("The pdf file and a BibTeX entry for LaTeX users can be found at http://hal.inria.fr/hal-01017319\n");
 338 }
 339
 340 void surf_init(int *argc, char **argv)
 341 {
 342   if (USER_HOST_LEVEL != -1) // Already initialized
 343     return;
 344
 345   XBT_DEBUG("Create all Libs");
 346   USER_HOST_LEVEL = simgrid::s4u::Host::extension_create(nullptr);
 347
 348   watched_hosts_lib = xbt_dict_new_homogeneous(nullptr);
 349
 350   xbt_init(argc, argv);
 351   if (not all_existing_models)
 352     all_existing_models = new std::vector<simgrid::surf::Model*>();
 353   if (not future_evt_set)
 354     future_evt_set = new simgrid::trace_mgr::future_evt_set();
 355
 356   TRACE_surf_alloc();
 357   simgrid::surf::surfExitCallbacks.connect(TRACE_surf_release);
 358
 359   sg_config_init(argc, argv);
 360
 361   if (MC_is_active())
 362     MC_memory_init();
 363 }
 364
 365 void surf_exit()
 366 {
 367   TRACE_end();                  /* Just in case it was not called by the upper layer (or there is no upper layer) */
 368
 369   sg_host_exit();
 370   sg_link_exit();
 371   xbt_dict_free(&watched_hosts_lib);
 372   for (auto e : storage_types) {
 373     storage_type_t stype = e.second;
 374     free(stype->model);
 375     free(stype->type_id);
 376     free(stype->content);
 377     xbt_dict_free(&(stype->properties));
 378     delete stype->model_properties;
 379     free(stype);
 380   }
 381
 382   for (auto model : *all_existing_models)
 383     delete model;
 384   delete all_existing_models;
 385
 386   simgrid::surf::surfExitCallbacks();
 387
 388   if (future_evt_set) {
 389     delete future_evt_set;
 390     future_evt_set = nullptr;
 391   }
 392
 393 #if HAVE_THREAD_CONTEXTS
 394   xbt_parmap_destroy(surf_parmap);
 395 #endif
 396
 397   tmgr_finalize();
 398   sg_platf_exit();
 399   simgrid::s4u::Engine::shutdown();
 400
 401   NOW = 0;                      /* Just in case the user plans to restart the simulation afterward */
 402 }
 403
 404 /*********
 405  * Model *
 406  *********/
 407
 408 namespace simgrid {
 409 namespace surf {
 410
 411 Model::Model()
 412   : maxminSystem_(nullptr)
 413 {
 414   readyActionSet_ = new ActionList();
 415   runningActionSet_ = new ActionList();
 416   failedActionSet_ = new ActionList();
 417   doneActionSet_ = new ActionList();
 418
 419   modifiedSet_ = nullptr;
 420   actionHeap_ = nullptr;
 421   updateMechanism_ = UM_UNDEFINED;
 422   selectiveUpdate_ = 0;
 423 }
 424
 425 Model::~Model(){
 426   delete readyActionSet_;
 427   delete runningActionSet_;
 428   delete failedActionSet_;
 429   delete doneActionSet_;
 430 }
 431
 432 double Model::nextOccuringEvent(double now)
 433 {
 434   //FIXME: set the good function once and for all
 435   if (updateMechanism_ == UM_LAZY)
 436     return nextOccuringEventLazy(now);
 437   else if (updateMechanism_ == UM_FULL)
 438     return nextOccuringEventFull(now);
 439   else
 440     xbt_die("Invalid cpu update mechanism!");
 441 }
 442
 443 double Model::nextOccuringEventLazy(double now)
 444 {
 445   XBT_DEBUG("Before share resources, the size of modified actions set is %zd", modifiedSet_->size());
 446   lmm_solve(maxminSystem_);
 447   XBT_DEBUG("After share resources, The size of modified actions set is %zd", modifiedSet_->size());
 448
 449   while (not modifiedSet_->empty()) {
 450     Action *action = &(modifiedSet_->front());
 451     modifiedSet_->pop_front();
 452     bool max_dur_flag = false;
 453
 454     if (action->getStateSet() != runningActionSet_)
 455       continue;
 456
 457     /* bogus priority, skip it */
 458     if (action->getPriority() <= 0 || action->getHat()==LATENCY)
 459       continue;
 460
 461     action->updateRemainingLazy(now);
 462
 463     double min = -1;
 464     double share = lmm_variable_getvalue(action->getVariable());
 465
 466     if (share > 0) {
 467       double time_to_completion;
 468       if (action->getRemains() > 0) {
 469         time_to_completion = action->getRemainsNoUpdate() / share;
 470       } else {
 471         time_to_completion = 0.0;
 472       }
 473       min = now + time_to_completion; // when the task will complete if nothing changes
 474     }
 475
 476     if ((action->getMaxDuration() > NO_MAX_DURATION) &&
 477         (min <= -1 || action->getStartTime() + action->getMaxDuration() < min)) {
 478       // when the task will complete anyway because of the deadline if any
 479       min          = action->getStartTime() + action->getMaxDuration();
 480       max_dur_flag = true;
 481     }
 482
 483     XBT_DEBUG("Action(%p) corresponds to variable %d", action, action->getVariable()->id_int);
 484
 485     XBT_DEBUG("Action(%p) Start %f. May finish at %f (got a share of %f). Max_duration %f", action,
 486         action->getStartTime(), min, share,
 487         action->getMaxDuration());
 488
 489     if (min > -1) {
 490       action->heapUpdate(actionHeap_, min, max_dur_flag ? MAX_DURATION : NORMAL);
 491       XBT_DEBUG("Insert at heap action(%p) min %f now %f", action, min, now);
 492     } else
 493       DIE_IMPOSSIBLE;
 494   }
 495
 496   //hereafter must have already the min value for this resource model
 497   if (xbt_heap_size(actionHeap_) > 0) {
 498     double min = xbt_heap_maxkey(actionHeap_) - now;
 499     XBT_DEBUG("minimum with the HEAP %f", min);
 500     return min;
 501   } else {
 502     XBT_DEBUG("The HEAP is empty, thus returning -1");
 503     return -1;
 504   }
 505 }
 506
 507 double Model::nextOccuringEventFull(double /*now*/) {
 508   maxminSystem_->solve_fun(maxminSystem_);
 509
 510   double min = -1;
 511   for (auto it(getRunningActionSet()->begin()), itend(getRunningActionSet()->end()); it != itend ; ++it) {
 512     Action *action = &*it;
 513     double value = lmm_variable_getvalue(action->getVariable());
 514     if (value > 0) {
 515       if (action->getRemains() > 0)
 516         value = action->getRemainsNoUpdate() / value;
 517       else
 518         value = 0.0;
 519       if (min < 0 || value < min) {
 520         min = value;
 521         XBT_DEBUG("Updating min (value) with %p: %f", action, min);
 522       }
 523     }
 524     if ((action->getMaxDuration() >= 0) && (min<0 || action->getMaxDuration() < min)) {
 525       min = action->getMaxDuration();
 526       XBT_DEBUG("Updating min (duration) with %p: %f", action, min);
 527     }
 528   }
 529   XBT_DEBUG("min value : %f", min);
 530
 531   return min;
 532 }
 533
 534 void Model::updateActionsState(double now, double delta)
 535 {
 536   if (updateMechanism_ == UM_FULL)
 537     updateActionsStateFull(now, delta);
 538   else if (updateMechanism_ == UM_LAZY)
 539     updateActionsStateLazy(now, delta);
 540   else
 541     xbt_die("Invalid cpu update mechanism!");
 542 }
 543
 544 void Model::updateActionsStateLazy(double /*now*/, double /*delta*/)
 545 {
 546   THROW_UNIMPLEMENTED;
 547 }
 548
 549 void Model::updateActionsStateFull(double /*now*/, double /*delta*/)
 550 {
 551   THROW_UNIMPLEMENTED;
 552 }
 553
 554 }
 555 }
 556
 557 /************
 558  * Resource *
 559  ************/
 560
 561 namespace simgrid {
 562 namespace surf {
 563
 564 Resource::Resource(Model* model, const char* name, lmm_constraint_t constraint)
 565     : name_(name), model_(model), constraint_(constraint)
 566 {}
 567
 568 Resource::~Resource() = default;
 569
 570 bool Resource::isOn() const {
 571   return isOn_;
 572 }
 573 bool Resource::isOff() const {
 574   return not isOn_;
 575 }
 576
 577 void Resource::turnOn()
 578 {
 579   isOn_ = true;
 580 }
 581
 582 void Resource::turnOff()
 583 {
 584   isOn_ = false;
 585 }
 586
 587 Model* Resource::model() const
 588 {
 589   return model_;
 590 }
 591
 592 const char* Resource::cname() const
 593 {
 594   return name_.c_str();
 595 }
 596
 597 bool Resource::operator==(const Resource &other) const {
 598   return name_ == other.name_;
 599 }
 600
 601 lmm_constraint_t Resource::constraint() const
 602 {
 603   return constraint_;
 604 }
 605
 606 }
 607 }
 608
 609 /**********
 610  * Action *
 611  **********/
 612
 613 const char *surf_action_state_names[6] = {
 614   "SURF_ACTION_READY",
 615   "SURF_ACTION_RUNNING",
 616   "SURF_ACTION_FAILED",
 617   "SURF_ACTION_DONE",
 618   "SURF_ACTION_TO_FREE",
 619   "SURF_ACTION_NOT_IN_THE_SYSTEM"
 620 };
 621
 622 /* added to manage the communication action's heap */
 623 void surf_action_lmm_update_index_heap(void *action, int i) {
 624   static_cast<simgrid::surf::Action*>(action)->updateIndexHeap(i);
 625 }
 626
 627 namespace simgrid {
 628 namespace surf {
 629
 630 Action::Action(simgrid::surf::Model* model, double cost, bool failed) : Action(model, cost, failed, nullptr)
 631 {
 632 }
 633
 634 Action::Action(simgrid::surf::Model* model, double cost, bool failed, lmm_variable_t var)
 635     : remains_(cost), start_(surf_get_clock()), cost_(cost), model_(model), variable_(var)
 636 {
 637   if (failed)
 638     stateSet_ = getModel()->getFailedActionSet();
 639   else
 640     stateSet_ = getModel()->getRunningActionSet();
 641
 642   stateSet_->push_back(*this);
 643 }
 644
 645 Action::~Action() {
 646   xbt_free(category_);
 647 }
 648
 649 void Action::finish() {
 650     finishTime_ = surf_get_clock();
 651 }
 652
 653 Action::State Action::getState()
 654 {
 655   if (stateSet_ == model_->getReadyActionSet())
 656     return Action::State::ready;
 657   if (stateSet_ == model_->getRunningActionSet())
 658     return Action::State::running;
 659   if (stateSet_ == model_->getFailedActionSet())
 660     return Action::State::failed;
 661   if (stateSet_ == model_->getDoneActionSet())
 662     return Action::State::done;
 663   return Action::State::not_in_the_system;
 664 }
 665
 666 void Action::setState(Action::State state)
 667 {
 668   stateSet_->erase(stateSet_->iterator_to(*this));
 669   switch (state) {
 670   case Action::State::ready:
 671     stateSet_ = model_->getReadyActionSet();
 672     break;
 673   case Action::State::running:
 674     stateSet_ = model_->getRunningActionSet();
 675     break;
 676   case Action::State::failed:
 677     stateSet_ = model_->getFailedActionSet();
 678     break;
 679   case Action::State::done:
 680     stateSet_ = model_->getDoneActionSet();
 681     break;
 682   default:
 683     stateSet_ = nullptr;
 684     break;
 685   }
 686   if (stateSet_)
 687     stateSet_->push_back(*this);
 688 }
 689
 690 double Action::getBound()
 691 {
 692   return (variable_) ? lmm_variable_getbound(variable_) : 0;
 693 }
 694
 695 void Action::setBound(double bound)
 696 {
 697   XBT_IN("(%p,%g)", this, bound);
 698   if (variable_)
 699     lmm_update_variable_bound(getModel()->getMaxminSystem(), variable_, bound);
 700
 701   if (getModel()->getUpdateMechanism() == UM_LAZY && getLastUpdate() != surf_get_clock())
 702     heapRemove(getModel()->getActionHeap());
 703   XBT_OUT();
 704 }
 705
 706 double Action::getStartTime()
 707 {
 708   return start_;
 709 }
 710
 711 double Action::getFinishTime()
 712 {
 713   /* keep the function behavior, some models (cpu_ti) change the finish time before the action end */
 714   return remains_ <= 0 ? finishTime_ : -1;
 715 }
 716
 717 void Action::setData(void* data)
 718 {
 719   data_ = data;
 720 }
 721
 722 void Action::setCategory(const char *category)
 723 {
 724   category_ = xbt_strdup(category);
 725 }
 726
 727 void Action::ref(){
 728   refcount_++;
 729 }
 730
 731 void Action::setMaxDuration(double duration)
 732 {
 733   maxDuration_ = duration;
 734   if (getModel()->getUpdateMechanism() == UM_LAZY)      // remove action from the heap
 735     heapRemove(getModel()->getActionHeap());
 736 }
 737
 738 void Action::gapRemove() {}
 739
 740 void Action::setPriority(double priority)
 741 {
 742   XBT_IN("(%p,%g)", this, priority);
 743   priority_ = priority;
 744   lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), priority);
 745
 746   if (getModel()->getUpdateMechanism() == UM_LAZY)
 747     heapRemove(getModel()->getActionHeap());
 748   XBT_OUT();
 749 }
 750
 751 void Action::cancel(){
 752   setState(Action::State::failed);
 753   if (getModel()->getUpdateMechanism() == UM_LAZY) {
 754     if (action_lmm_hook.is_linked())
 755       getModel()->getModifiedSet()->erase(getModel()->getModifiedSet()->iterator_to(*this));
 756     heapRemove(getModel()->getActionHeap());
 757   }
 758 }
 759
 760 int Action::unref(){
 761   refcount_--;
 762   if (not refcount_) {
 763     if (action_hook.is_linked())
 764       stateSet_->erase(stateSet_->iterator_to(*this));
 765     if (getVariable())
 766       lmm_variable_free(getModel()->getMaxminSystem(), getVariable());
 767     if (getModel()->getUpdateMechanism() == UM_LAZY) {
 768       /* remove from heap */
 769       heapRemove(getModel()->getActionHeap());
 770       if (action_lmm_hook.is_linked())
 771         getModel()->getModifiedSet()->erase(getModel()->getModifiedSet()->iterator_to(*this));
 772     }
 773     delete this;
 774     return 1;
 775   }
 776   return 0;
 777 }
 778
 779 void Action::suspend()
 780 {
 781   XBT_IN("(%p)", this);
 782   if (suspended_ != 2) {
 783     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), 0.0);
 784     if (getModel()->getUpdateMechanism() == UM_LAZY){
 785       heapRemove(getModel()->getActionHeap());
 786       if (getModel()->getUpdateMechanism() == UM_LAZY  && stateSet_ == getModel()->getRunningActionSet() && priority_ > 0){
 787         //If we have a lazy model, we need to update the remaining value accordingly
 788         updateRemainingLazy(surf_get_clock());
 789       }
 790     }
 791     suspended_ = 1;
 792   }
 793   XBT_OUT();
 794 }
 795
 796 void Action::resume()
 797 {
 798   XBT_IN("(%p)", this);
 799   if (suspended_ != 2) {
 800     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), priority_);
 801     suspended_ = 0;
 802     if (getModel()->getUpdateMechanism() == UM_LAZY)
 803       heapRemove(getModel()->getActionHeap());
 804   }
 805   XBT_OUT();
 806 }
 807
 808 bool Action::isSuspended()
 809 {
 810   return suspended_ == 1;
 811 }
 812 /* insert action on heap using a given key and a hat (heap_action_type)
 813  * a hat can be of three types for communications:
 814  *
 815  * NORMAL = this is a normal heap entry stating the date to finish transmitting
 816  * LATENCY = this is a heap entry to warn us when the latency is payed
 817  * MAX_DURATION =this is a heap entry to warn us when the max_duration limit is reached
 818  */
 819 void Action::heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat)
 820 {
 821   hat_ = hat;
 822   xbt_heap_push(heap, this, key);
 823 }
 824
 825 void Action::heapRemove(xbt_heap_t heap)
 826 {
 827   hat_ = NOTSET;
 828   if (indexHeap_ >= 0) {
 829     xbt_heap_remove(heap, indexHeap_);
 830   }
 831 }
 832
 833 void Action::heapUpdate(xbt_heap_t heap, double key, enum heap_action_type hat)
 834 {
 835   hat_ = hat;
 836   if (indexHeap_ >= 0) {
 837     xbt_heap_update(heap, indexHeap_, key);
 838   }else{
 839     xbt_heap_push(heap, this, key);
 840   }
 841 }
 842
 843 void Action::updateIndexHeap(int i) {
 844   indexHeap_ = i;
 845 }
 846
 847 double Action::getRemains()
 848 {
 849   XBT_IN("(%p)", this);
 850   /* update remains before return it */
 851   if (getModel()->getUpdateMechanism() == UM_LAZY)      /* update remains before return it */
 852     updateRemainingLazy(surf_get_clock());
 853   XBT_OUT();
 854   return remains_;
 855 }
 856
 857 double Action::getRemainsNoUpdate()
 858 {
 859   return remains_;
 860 }
 861
 862 //FIXME split code in the right places
 863 void Action::updateRemainingLazy(double now)
 864 {
 865   double delta = 0.0;
 866
 867   if(getModel() == surf_network_model)
 868   {
 869     if (suspended_ != 0)
 870       return;
 871   }
 872   else
 873   {
 874     xbt_assert(stateSet_ == getModel()->getRunningActionSet(), "You're updating an action that is not running.");
 875     xbt_assert(priority_ > 0, "You're updating an action that seems suspended.");
 876   }
 877
 878   delta = now - lastUpdate_;
 879
 880   if (remains_ > 0) {
 881     XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, remains_, lastUpdate_);
 882     double_update(&remains_, lastValue_ * delta, sg_surf_precision*sg_maxmin_precision);
 883
 884     if (getModel() == surf_cpu_model_pm && TRACE_is_enabled()) {
 885       simgrid::surf::Resource *cpu = static_cast<simgrid::surf::Resource*>(
 886         lmm_constraint_id(lmm_get_cnst_from_var(getModel()->getMaxminSystem(), getVariable(), 0)));
 887       TRACE_surf_host_set_utilization(cpu->cname(), getCategory(), lastValue_, lastUpdate_, now - lastUpdate_);
 888     }
 889     XBT_DEBUG("Updating action(%p): remains is now %f", this, remains_);
 890   }
 891
 892   if(getModel() == surf_network_model)
 893   {
 894     if (maxDuration_ != NO_MAX_DURATION)
 895       double_update(&maxDuration_, delta, sg_surf_precision);
 896
 897     //FIXME: duplicated code
 898     if ((remains_ <= 0) &&
 899         (lmm_get_variable_weight(getVariable()) > 0)) {
 900       finish();
 901       setState(Action::State::done);
 902       heapRemove(getModel()->getActionHeap());
 903     } else if (((maxDuration_ != NO_MAX_DURATION)
 904         && (maxDuration_ <= 0))) {
 905       finish();
 906       setState(Action::State::done);
 907       heapRemove(getModel()->getActionHeap());
 908     }
 909   }
 910
 911   lastUpdate_ = now;
 912   lastValue_ = lmm_variable_getvalue(getVariable());
 913 }
 914
 915 }
 916 }