Logo AND Algorithmique Numérique Distribuée

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