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   updateMechanism_ = UM_UNDEFINED;
 369   selectiveUpdate_ = 0;
 370 }
 371
 372 Model::~Model(){
 373   delete readyActionSet_;
 374   delete runningActionSet_;
 375   delete failedActionSet_;
 376   delete doneActionSet_;
 377 }
 378
 379 Action* Model::actionHeapPop()
 380 {
 381   Action* action = actionHeap_.top().second;
 382   actionHeap_.pop();
 383   action->clearHeapHandle();
 384   return action;
 385 }
 386
 387 double Model::nextOccuringEvent(double now)
 388 {
 389   //FIXME: set the good function once and for all
 390   if (updateMechanism_ == UM_LAZY)
 391     return nextOccuringEventLazy(now);
 392   else if (updateMechanism_ == UM_FULL)
 393     return nextOccuringEventFull(now);
 394   else
 395     xbt_die("Invalid cpu update mechanism!");
 396 }
 397
 398 double Model::nextOccuringEventLazy(double now)
 399 {
 400   XBT_DEBUG("Before share resources, the size of modified actions set is %zu", modifiedSet_->size());
 401   lmm_solve(maxminSystem_);
 402   XBT_DEBUG("After share resources, The size of modified actions set is %zu", modifiedSet_->size());
 403
 404   while (not modifiedSet_->empty()) {
 405     Action *action = &(modifiedSet_->front());
 406     modifiedSet_->pop_front();
 407     bool max_dur_flag = false;
 408
 409     if (action->getStateSet() != runningActionSet_)
 410       continue;
 411
 412     /* bogus priority, skip it */
 413     if (action->getPriority() <= 0 || action->getHat()==LATENCY)
 414       continue;
 415
 416     action->updateRemainingLazy(now);
 417
 418     double min = -1;
 419     double share = lmm_variable_getvalue(action->getVariable());
 420
 421     if (share > 0) {
 422       double time_to_completion;
 423       if (action->getRemains() > 0) {
 424         time_to_completion = action->getRemainsNoUpdate() / share;
 425       } else {
 426         time_to_completion = 0.0;
 427       }
 428       min = now + time_to_completion; // when the task will complete if nothing changes
 429     }
 430
 431     if ((action->getMaxDuration() > NO_MAX_DURATION) &&
 432         (min <= -1 || action->getStartTime() + action->getMaxDuration() < min)) {
 433       // when the task will complete anyway because of the deadline if any
 434       min          = action->getStartTime() + action->getMaxDuration();
 435       max_dur_flag = true;
 436     }
 437
 438     XBT_DEBUG("Action(%p) corresponds to variable %d", action, action->getVariable()->id_int);
 439
 440     XBT_DEBUG("Action(%p) Start %f. May finish at %f (got a share of %f). Max_duration %f", action,
 441         action->getStartTime(), min, share,
 442         action->getMaxDuration());
 443
 444     if (min > -1) {
 445       action->heapUpdate(actionHeap_, min, max_dur_flag ? MAX_DURATION : NORMAL);
 446       XBT_DEBUG("Insert at heap action(%p) min %f now %f", action, min, now);
 447     } else
 448       DIE_IMPOSSIBLE;
 449   }
 450
 451   //hereafter must have already the min value for this resource model
 452   if (not actionHeapIsEmpty()) {
 453     double min = actionHeapTopDate() - now;
 454     XBT_DEBUG("minimum with the HEAP %f", min);
 455     return min;
 456   } else {
 457     XBT_DEBUG("The HEAP is empty, thus returning -1");
 458     return -1;
 459   }
 460 }
 461
 462 double Model::nextOccuringEventFull(double /*now*/) {
 463   maxminSystem_->solve_fun(maxminSystem_);
 464
 465   double min = -1;
 466
 467   for (auto it(getRunningActionSet()->begin()); it != getRunningActionSet()->end(); ++it) {
 468     Action *action = &*it;
 469     double value = lmm_variable_getvalue(action->getVariable());
 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()
 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   stateSet_->erase(stateSet_->iterator_to(*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()
 649 {
 650   return (variable_) ? lmm_variable_getbound(variable_) : 0;
 651 }
 652
 653 void Action::setBound(double bound)
 654 {
 655   XBT_IN("(%p,%g)", this, bound);
 656   if (variable_)
 657     lmm_update_variable_bound(getModel()->getMaxminSystem(), variable_, bound);
 658
 659   if (getModel()->getUpdateMechanism() == UM_LAZY && getLastUpdate() != surf_get_clock())
 660     heapRemove(getModel()->getActionHeap());
 661   XBT_OUT();
 662 }
 663
 664 double Action::getStartTime()
 665 {
 666   return start_;
 667 }
 668
 669 double Action::getFinishTime()
 670 {
 671   return finishTime_;
 672 }
 673
 674 void Action::setData(void* data)
 675 {
 676   data_ = data;
 677 }
 678
 679 void Action::setCategory(const char *category)
 680 {
 681   category_ = xbt_strdup(category);
 682 }
 683
 684 void Action::ref(){
 685   refcount_++;
 686 }
 687
 688 void Action::setMaxDuration(double duration)
 689 {
 690   maxDuration_ = duration;
 691   if (getModel()->getUpdateMechanism() == UM_LAZY)      // remove action from the heap
 692     heapRemove(getModel()->getActionHeap());
 693 }
 694
 695 void Action::setSharingWeight(double weight)
 696 {
 697   XBT_IN("(%p,%g)", this, weight);
 698   sharingWeight_ = weight;
 699   lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), weight);
 700
 701   if (getModel()->getUpdateMechanism() == UM_LAZY)
 702     heapRemove(getModel()->getActionHeap());
 703   XBT_OUT();
 704 }
 705
 706 void Action::cancel(){
 707   setState(Action::State::failed);
 708   if (getModel()->getUpdateMechanism() == UM_LAZY) {
 709     if (action_lmm_hook.is_linked())
 710       getModel()->getModifiedSet()->erase(getModel()->getModifiedSet()->iterator_to(*this));
 711     heapRemove(getModel()->getActionHeap());
 712   }
 713 }
 714
 715 int Action::unref(){
 716   refcount_--;
 717   if (not refcount_) {
 718     if (action_hook.is_linked())
 719       stateSet_->erase(stateSet_->iterator_to(*this));
 720     if (getVariable())
 721       lmm_variable_free(getModel()->getMaxminSystem(), getVariable());
 722     if (getModel()->getUpdateMechanism() == UM_LAZY) {
 723       /* remove from heap */
 724       heapRemove(getModel()->getActionHeap());
 725       if (action_lmm_hook.is_linked())
 726         getModel()->getModifiedSet()->erase(getModel()->getModifiedSet()->iterator_to(*this));
 727     }
 728     delete this;
 729     return 1;
 730   }
 731   return 0;
 732 }
 733
 734 void Action::suspend()
 735 {
 736   XBT_IN("(%p)", this);
 737   if (suspended_ != 2) {
 738     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), 0.0);
 739     if (getModel()->getUpdateMechanism() == UM_LAZY){
 740       heapRemove(getModel()->getActionHeap());
 741       if (getModel()->getUpdateMechanism() == UM_LAZY && stateSet_ == getModel()->getRunningActionSet() &&
 742           sharingWeight_ > 0) {
 743         //If we have a lazy model, we need to update the remaining value accordingly
 744         updateRemainingLazy(surf_get_clock());
 745       }
 746     }
 747     suspended_ = 1;
 748   }
 749   XBT_OUT();
 750 }
 751
 752 void Action::resume()
 753 {
 754   XBT_IN("(%p)", this);
 755   if (suspended_ != 2) {
 756     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), getPriority());
 757     suspended_ = 0;
 758     if (getModel()->getUpdateMechanism() == UM_LAZY)
 759       heapRemove(getModel()->getActionHeap());
 760   }
 761   XBT_OUT();
 762 }
 763
 764 bool Action::isSuspended()
 765 {
 766   return suspended_ == 1;
 767 }
 768 /* insert action on heap using a given key and a hat (heap_action_type)
 769  * a hat can be of three types for communications:
 770  *
 771  * NORMAL = this is a normal heap entry stating the date to finish transmitting
 772  * LATENCY = this is a heap entry to warn us when the latency is payed
 773  * MAX_DURATION =this is a heap entry to warn us when the max_duration limit is reached
 774  */
 775 void Action::heapInsert(heap_type& heap, double key, enum heap_action_type hat)
 776 {
 777   hat_ = hat;
 778   heapHandle_ = heap.emplace(std::make_pair(key, this));
 779 }
 780
 781 void Action::heapRemove(heap_type& heap)
 782 {
 783   hat_ = NOTSET;
 784   if (heapHandle_) {
 785     heap.erase(*heapHandle_);
 786     clearHeapHandle();
 787   }
 788 }
 789
 790 void Action::heapUpdate(heap_type& heap, double key, enum heap_action_type hat)
 791 {
 792   hat_ = hat;
 793   if (heapHandle_) {
 794     heap.update(*heapHandle_, std::make_pair(key, this));
 795   } else {
 796     heapHandle_ = heap.emplace(std::make_pair(key, this));
 797   }
 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 }