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