src/surf/surf_interface.cpp

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