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