Logo AND Algorithmique Numérique Distribuée

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