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