Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
no need for a lib to store the netcards. A dict is easier
[simgrid.git] / src / surf / surf_interface.cpp
1 /* Copyright (c) 2004-2015. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #include "surf_interface.hpp"
8 #include "cpu_interface.hpp"
9 #include "mc/mc.h"
10 #include "network_interface.hpp"
11 #include "simgrid/s4u/engine.hpp"
12 #include "simgrid/sg_config.h"
13 #include "src/instr/instr_private.h" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
14 #include "src/internal_config.h"
15 #include "src/kernel/routing/NetCard.hpp"
16 #include "src/simix/smx_host_private.h"
17 #include "src/surf/HostImpl.hpp"
18 #include "surf_private.h"
19 #include <vector>
20
21 XBT_LOG_NEW_CATEGORY(surf, "All SURF categories");
22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf, "Logging specific to SURF (kernel)");
23
24 /*********
25  * Utils *
26  *********/
27
28 /* model_list_invoke contains only surf_host and surf_vm.
29  * The callback functions of cpu_model and network_model will be called from those of these host models. */
30 std::vector<surf_model_t> * all_existing_models = nullptr; /* to destroy models correctly */
31 xbt_dynar_t model_list_invoke = nullptr;  /* to invoke callbacks */
32
33 simgrid::trace_mgr::future_evt_set *future_evt_set = nullptr;
34 xbt_dynar_t surf_path = nullptr;
35 std::vector<simgrid::s4u::Host*> host_that_restart;
36 xbt_dict_t watched_hosts_lib;
37
38 namespace simgrid {
39 namespace surf {
40
41 simgrid::xbt::signal<void(void)> surfExitCallbacks;
42
43 }
44 }
45
46 #include <simgrid/plugins/energy.h> // FIXME: this plugin should not be linked to the core
47
48 s_surf_model_description_t surf_plugin_description[] = {
49     {"Energy", "Cpu energy consumption.", &sg_energy_plugin_init},
50      {nullptr, nullptr,  nullptr}      /* this array must be nullptr terminated */
51 };
52
53 /* Don't forget to update the option description in smx_config when you change this */
54 s_surf_model_description_t surf_network_model_description[] = {
55   {"LV08", "Realistic network analytic model (slow-start modeled by multiplying latency by 10.4, bandwidth by .92; bottleneck sharing uses a payload of S=8775 for evaluating RTT). ",
56    &surf_network_model_init_LegrandVelho},
57   {"Constant",
58    "Simplistic network model where all communication take a constant time (one second). This model provides the lowest realism, but is (marginally) faster.",
59    &surf_network_model_init_Constant},
60   {"SMPI", "Realistic network model specifically tailored for HPC settings (accurate modeling of slow start with 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 small messages are thus poorly modeled).",
65    &surf_network_model_init_CM02},
66   {"NS3", "Network pseudo-model using the NS3 tcp model instead of an analytic model", &surf_network_model_init_NS3},
67   {"Reno",  "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
68    &surf_network_model_init_Reno},
69   {"Reno2", "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_Reno2},
71   {"Vegas", "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
72    &surf_network_model_init_Vegas},
73   {nullptr, nullptr, nullptr}      /* this array must be nullptr terminated */
74 };
75
76 #if ! HAVE_SMPI
77 void surf_network_model_init_SMPI() {
78   xbt_die("Please activate SMPI support in cmake to use the SMPI network model.");
79 }
80 void surf_network_model_init_IB() {
81   xbt_die("Please activate SMPI support in cmake to use the IB network model.");
82 }
83 #endif
84 #if !HAVE_NS3
85 void surf_network_model_init_NS3() {
86   xbt_die("Please activate NS3 support in cmake and install the dependencies to use the NS3 network model.");
87 }
88 #endif
89
90 s_surf_model_description_t surf_cpu_model_description[] = {
91   {"Cas01", "Simplistic CPU model (time=size/power).", &surf_cpu_model_init_Cas01},
92   {nullptr, nullptr,  nullptr}      /* this array must be nullptr terminated */
93 };
94
95 s_surf_model_description_t surf_host_model_description[] = {
96   {"default",   "Default host model. Currently, CPU:Cas01 and network:LV08 (with cross traffic enabled)", &surf_host_model_init_current_default},
97   {"compound",  "Host model that is automatically chosen if you change the network and CPU models", &surf_host_model_init_compound},
98   {"ptask_L07", "Host model somehow similar to Cas01+CM02 but allowing parallel tasks", &surf_host_model_init_ptask_L07},
99   {nullptr, nullptr, nullptr}      /* this array must be nullptr terminated */
100 };
101
102 s_surf_model_description_t surf_optimization_mode_description[] = {
103   {"Lazy", "Lazy action management (partial invalidation in lmm + heap in action remaining).", nullptr},
104   {"TI",   "Trace integration. Highly optimized mode when using availability traces (only available for the Cas01 CPU model for now).", nullptr},
105   {"Full", "Full update of remaining and variables. Slow but may be useful when debugging.", nullptr},
106   {nullptr, nullptr, nullptr}      /* this array must be nullptr terminated */
107 };
108
109 s_surf_model_description_t surf_storage_model_description[] = {
110   {"default", "Simplistic storage model.", &surf_storage_model_init_default},
111   {nullptr, nullptr,  nullptr}      /* this array must be nullptr terminated */
112 };
113
114 #if HAVE_THREAD_CONTEXTS
115 static xbt_parmap_t surf_parmap = nullptr; /* parallel map on models */
116 #endif
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 FILE *surf_fopen(const char *name, const char *mode)
132 {
133   unsigned int cpt;
134   char *path_elm = nullptr;
135   char *buff;
136   FILE *file = nullptr;
137
138   xbt_assert(name);
139
140   if (__surf_is_absolute_file_path(name))       /* don't mess with absolute file names */
141     return fopen(name, mode);
142
143   /* search relative files in the path */
144   xbt_dynar_foreach(surf_path, cpt, path_elm) {
145     buff = bprintf("%s" FILE_DELIM "%s", path_elm, name);
146     file = fopen(buff, mode);
147     free(buff);
148
149     if (file)
150       return file;
151   }
152   return nullptr;
153 }
154
155 #ifdef _WIN32
156 #include <windows.h>
157 #define MAX_DRIVE 26
158 static const char *disk_drives_letter_table[MAX_DRIVE] = {
159   "A:\\","B:\\","C:\\","D:\\","E:\\","F:\\","G:\\","H:\\","I:\\","J:\\","K:\\","L:\\","M:\\",
160   "N:\\","O:\\","P:\\","Q:\\","R:\\","S:\\","T:\\","U:\\","V:\\","W:\\","X:\\","Y:\\","Z:\\"
161 };
162 #endif
163
164 /*
165  * Returns the initial path. On Windows the initial path is
166  * the current directory for the current process in the other
167  * case the function returns "./" that represents the current
168  * directory on Unix/Linux platforms.
169  */
170
171 const char *__surf_get_initial_path()
172 {
173
174 #ifdef _WIN32
175   unsigned i;
176   char current_directory[MAX_PATH + 1] = { 0 };
177   unsigned int len = GetCurrentDirectory(MAX_PATH + 1, current_directory);
178   char root[4] = { 0 };
179
180   if (!len)
181     return nullptr;
182
183   strncpy(root, current_directory, 3);
184
185   for (i = 0; i < MAX_DRIVE; i++) {
186     if (toupper(root[0]) == disk_drives_letter_table[i][0])
187       return disk_drives_letter_table[i];
188   }
189
190   return nullptr;
191 #else
192   return "./";
193 #endif
194 }
195
196 /* The __surf_is_absolute_file_path() returns 1 if
197  * file_path is a absolute file path, in the other
198  * case the function returns 0.
199  */
200 int __surf_is_absolute_file_path(const char *file_path)
201 {
202 #ifdef _WIN32
203   WIN32_FIND_DATA wfd = { 0 };
204   HANDLE hFile = FindFirstFile(file_path, &wfd);
205
206   if (INVALID_HANDLE_VALUE == hFile)
207     return 0;
208
209   FindClose(hFile);
210   return 1;
211 #else
212   return (file_path[0] == '/');
213 #endif
214 }
215
216 /** Displays the long description of all registered models, and quit */
217 void model_help(const char *category, s_surf_model_description_t * table)
218 {
219   printf("Long description of the %s models accepted by this simulator:\n", category);
220   for (int i = 0; table[i].name; i++)
221     printf("  %s: %s\n", table[i].name, table[i].description);
222 }
223
224 int find_model_description(s_surf_model_description_t * table,
225                            const char *name)
226 {
227   int i;
228   char *name_list = nullptr;
229
230   for (i = 0; table[i].name; i++)
231     if (!strcmp(name, table[i].name)) {
232       return i;
233     }
234   if (!table[0].name)
235     xbt_die("No model is valid! This is a bug.");
236   name_list = xbt_strdup(table[0].name);
237   for (i = 1; table[i].name; i++) {
238     name_list = (char *) xbt_realloc(name_list, strlen(name_list) + strlen(table[i].name) + 3);
239     strncat(name_list, ", ", 2);
240     strncat(name_list, table[i].name, strlen(table[i].name));
241   }
242   xbt_die("Model '%s' is invalid! Valid models are: %s.", name, name_list);
243   return -1;
244 }
245
246 static inline void surf_storage_free(void *r)
247 {
248   delete static_cast<simgrid::surf::Storage*>(r);
249 }
250
251 void sg_version_check(int lib_version_major,int lib_version_minor,int lib_version_patch) {
252     if ((lib_version_major != SIMGRID_VERSION_MAJOR) || (lib_version_minor != SIMGRID_VERSION_MINOR)) {
253       fprintf(stderr,
254           "FATAL ERROR: Your program was compiled with SimGrid version %d.%d.%d, "
255           "and then linked against SimGrid %d.%d.%d. Please fix this.\n",
256           lib_version_major,lib_version_minor,lib_version_patch,
257           SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH);
258       abort();
259     }
260     if (lib_version_patch != SIMGRID_VERSION_PATCH) {
261       if(SIMGRID_VERSION_PATCH >= 90 || lib_version_patch >=90){
262         fprintf(stderr,
263         "FATAL ERROR: Your program was compiled with SimGrid version %d.%d.%d, "
264         "and then linked against SimGrid %d.%d.%d. \n"
265         "One of them is a development version, and should not be mixed with the stable release. Please fix this.\n",
266         lib_version_major,lib_version_minor,lib_version_patch,
267         SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH);
268         abort();
269       }
270         fprintf(stderr,
271             "Warning: Your program was compiled with SimGrid version %d.%d.%d, "
272             "and then linked against SimGrid %d.%d.%d. Proceeding anyway.\n",
273             lib_version_major,lib_version_minor,lib_version_patch,
274             SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH);
275     }
276 }
277
278 void sg_version(int *ver_major,int *ver_minor,int *ver_patch) {
279   *ver_major = SIMGRID_VERSION_MAJOR;
280   *ver_minor = SIMGRID_VERSION_MINOR;
281   *ver_patch = SIMGRID_VERSION_PATCH;
282 }
283
284 void surf_init(int *argc, char **argv)
285 {
286   if (USER_HOST_LEVEL != -1) // Already initialized
287     return;
288
289   XBT_DEBUG("Create all Libs");
290   USER_HOST_LEVEL = simgrid::s4u::Host::extension_create(nullptr);
291
292   netcards_dict = xbt_dict_new_homogeneous([](void* p) {
293     delete static_cast<simgrid::kernel::routing::NetCard*>(p);
294   });
295   storage_lib = xbt_lib_new();
296   storage_type_lib = xbt_lib_new();
297   file_lib = xbt_lib_new();
298   watched_hosts_lib = xbt_dict_new_homogeneous(nullptr);
299
300   XBT_DEBUG("Add SURF levels");
301   SURF_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,surf_storage_free);
302
303   xbt_init(argc, argv);
304   if (!all_existing_models)
305     all_existing_models = new std::vector<simgrid::surf::Model*>();
306   if (!model_list_invoke)
307     model_list_invoke = xbt_dynar_new(sizeof(simgrid::surf::Model*), nullptr);
308   if (!future_evt_set)
309     future_evt_set = new simgrid::trace_mgr::future_evt_set();
310
311   TRACE_add_start_function(TRACE_surf_alloc);
312   TRACE_add_end_function(TRACE_surf_release);
313
314   sg_config_init(argc, argv);
315
316   if (MC_is_active())
317     MC_memory_init();
318 }
319
320 void surf_exit()
321 {
322   TRACE_end();                  /* Just in case it was not called by the upper layer (or there is no upper layer) */
323
324   xbt_dynar_free(&surf_path);
325
326   sg_host_exit();
327   xbt_dict_free(&netcards_dict);
328   xbt_lib_free(&storage_lib);
329   sg_link_exit();
330   xbt_lib_free(&storage_type_lib);
331   xbt_lib_free(&file_lib);
332   xbt_dict_free(&watched_hosts_lib);
333
334   for (auto model : *all_existing_models)
335     delete model;
336   delete all_existing_models;
337   xbt_dynar_free(&model_list_invoke);
338
339   simgrid::surf::surfExitCallbacks();
340
341   if (future_evt_set) {
342     delete future_evt_set;
343     future_evt_set = nullptr;
344   }
345
346 #if HAVE_THREAD_CONTEXTS
347   xbt_parmap_destroy(surf_parmap);
348 #endif
349
350   tmgr_finalize();
351   sg_platf_exit();
352   simgrid::s4u::Engine::shutdown();
353
354   NOW = 0;                      /* Just in case the user plans to restart the simulation afterward */
355 }
356
357 /*********
358  * Model *
359  *********/
360
361 namespace simgrid {
362 namespace surf {
363
364 Model::Model()
365   : maxminSystem_(nullptr)
366 {
367   readyActionSet_ = new ActionList();
368   runningActionSet_ = new ActionList();
369   failedActionSet_ = new ActionList();
370   doneActionSet_ = new ActionList();
371
372   modifiedSet_ = nullptr;
373   actionHeap_ = nullptr;
374   updateMechanism_ = UM_UNDEFINED;
375   selectiveUpdate_ = 0;
376 }
377
378 Model::~Model(){
379   delete readyActionSet_;
380   delete runningActionSet_;
381   delete failedActionSet_;
382   delete doneActionSet_;
383 }
384
385 double Model::nextOccuringEvent(double now)
386 {
387   //FIXME: set the good function once and for all
388   if (updateMechanism_ == UM_LAZY)
389     return nextOccuringEventLazy(now);
390   else if (updateMechanism_ == UM_FULL)
391     return nextOccuringEventFull(now);
392   else
393     xbt_die("Invalid cpu update mechanism!");
394 }
395
396 double Model::nextOccuringEventLazy(double now)
397 {
398   XBT_DEBUG("Before share resources, the size of modified actions set is %zd", modifiedSet_->size());
399   lmm_solve(maxminSystem_);
400   XBT_DEBUG("After share resources, The size of modified actions set is %zd", modifiedSet_->size());
401
402   while(!modifiedSet_->empty()) {
403     Action *action = &(modifiedSet_->front());
404     modifiedSet_->pop_front();
405     int max_dur_flag = 0;
406
407     if (action->getStateSet() != runningActionSet_)
408       continue;
409
410     /* bogus priority, skip it */
411     if (action->getPriority() <= 0 || action->getHat()==LATENCY)
412       continue;
413
414     action->updateRemainingLazy(now);
415
416     double min = -1;
417     double share = lmm_variable_getvalue(action->getVariable());
418
419     if (share > 0) {
420       double time_to_completion;
421       if (action->getRemains() > 0) {
422         time_to_completion = action->getRemainsNoUpdate() / share;
423       } else {
424         time_to_completion = 0.0;
425       }
426       min = now + time_to_completion; // when the task will complete if nothing changes
427     }
428
429     if ((action->getMaxDuration() != NO_MAX_DURATION)
430         && (min == -1
431             || action->getStartTime() +
432             action->getMaxDuration() < min)) {
433       min = action->getStartTime() +
434           action->getMaxDuration();  // when the task will complete anyway because of the deadline if any
435       max_dur_flag = 1;
436     }
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,
448                 now);
449     } else DIE_IMPOSSIBLE;
450   }
451
452   //hereafter must have already the min value for this resource model
453   if (xbt_heap_size(actionHeap_) > 0) {
454     double min = xbt_heap_maxkey(actionHeap_) - 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   for (auto it(getRunningActionSet()->begin()), itend(getRunningActionSet()->end()); it != itend ; ++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 char* 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 ! 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::getModel() const {
544   return model_;
545 }
546
547 const char *Resource::getName() const {
548   return name_.c_str();
549 }
550
551 bool Resource::operator==(const Resource &other) const {
552   return name_ == other.name_;
553 }
554
555 lmm_constraint_t Resource::getConstraint() const {
556   return constraint_;
557 }
558
559 }
560 }
561
562 /**********
563  * Action *
564  **********/
565
566 const char *surf_action_state_names[6] = {
567   "SURF_ACTION_READY",
568   "SURF_ACTION_RUNNING",
569   "SURF_ACTION_FAILED",
570   "SURF_ACTION_DONE",
571   "SURF_ACTION_TO_FREE",
572   "SURF_ACTION_NOT_IN_THE_SYSTEM"
573 };
574
575 /* added to manage the communication action's heap */
576 void surf_action_lmm_update_index_heap(void *action, int i) {
577   static_cast<simgrid::surf::Action*>(action)->updateIndexHeap(i);
578 }
579
580 namespace simgrid {
581 namespace surf {
582
583 Action::Action(simgrid::surf::Model* model, double cost, bool failed) : Action(model, cost, failed, nullptr)
584 {
585 }
586
587 Action::Action(simgrid::surf::Model* model, double cost, bool failed, lmm_variable_t var)
588     : remains_(cost), start_(surf_get_clock()), cost_(cost), model_(model), variable_(var)
589 {
590   if (failed)
591     stateSet_ = getModel()->getFailedActionSet();
592   else
593     stateSet_ = getModel()->getRunningActionSet();
594
595   stateSet_->push_back(*this);
596 }
597
598 Action::~Action() {
599   xbt_free(category_);
600 }
601
602 void Action::finish() {
603     finishTime_ = surf_get_clock();
604 }
605
606 Action::State Action::getState()
607 {
608   if (stateSet_ ==  getModel()->getReadyActionSet())
609     return Action::State::ready;
610   if (stateSet_ ==  getModel()->getRunningActionSet())
611     return Action::State::running;
612   if (stateSet_ ==  getModel()->getFailedActionSet())
613     return Action::State::failed;
614   if (stateSet_ ==  getModel()->getDoneActionSet())
615     return Action::State::done;
616   return Action::State::not_in_the_system;
617 }
618
619 void Action::setState(Action::State state)
620 {
621   stateSet_->erase(stateSet_->iterator_to(*this));
622   switch (state) {
623   case Action::State::ready:
624     stateSet_ = getModel()->getReadyActionSet();
625     break;
626   case Action::State::running:
627     stateSet_ = getModel()->getRunningActionSet();
628     break;
629   case Action::State::failed:
630     stateSet_ = getModel()->getFailedActionSet();
631     break;
632   case Action::State::done:
633     stateSet_ = getModel()->getDoneActionSet();
634     break;
635   default:
636     stateSet_ = nullptr;
637     break;
638   }
639   if (stateSet_)
640     stateSet_->push_back(*this);
641 }
642
643 double Action::getBound()
644 {
645   return (variable_) ? lmm_variable_getbound(variable_) : 0;
646 }
647
648 void Action::setBound(double bound)
649 {
650   XBT_IN("(%p,%g)", this, bound);
651   if (variable_)
652     lmm_update_variable_bound(getModel()->getMaxminSystem(), variable_, bound);
653
654   if (getModel()->getUpdateMechanism() == UM_LAZY && getLastUpdate()!=surf_get_clock())
655     heapRemove(getModel()->getActionHeap());
656   XBT_OUT();
657 }
658
659 double Action::getStartTime()
660 {
661   return start_;
662 }
663
664 double Action::getFinishTime()
665 {
666   /* keep the function behavior, some models (cpu_ti) change the finish time before the action end */
667   return remains_ == 0 ? finishTime_ : -1;
668 }
669
670 void Action::setData(void* data)
671 {
672   data_ = data;
673 }
674
675 void Action::setCategory(const char *category)
676 {
677   category_ = xbt_strdup(category);
678 }
679
680 void Action::ref(){
681   refcount_++;
682 }
683
684 void Action::setMaxDuration(double duration)
685 {
686   maxDuration_ = duration;
687   if (getModel()->getUpdateMechanism() == UM_LAZY)      // remove action from the heap
688     heapRemove(getModel()->getActionHeap());
689 }
690
691 void Action::gapRemove() {}
692
693 void Action::setPriority(double priority)
694 {
695   XBT_IN("(%p,%g)", this, priority);
696   priority_ = priority;
697   lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), priority);
698
699   if (getModel()->getUpdateMechanism() == UM_LAZY)
700     heapRemove(getModel()->getActionHeap());
701   XBT_OUT();
702 }
703
704 void Action::cancel(){
705   setState(Action::State::failed);
706   if (getModel()->getUpdateMechanism() == UM_LAZY) {
707     if (action_lmm_hook.is_linked())
708       getModel()->getModifiedSet()->erase(getModel()->getModifiedSet()->iterator_to(*this));
709     heapRemove(getModel()->getActionHeap());
710   }
711 }
712
713 int Action::unref(){
714   refcount_--;
715   if (!refcount_) {
716     if (action_hook.is_linked())
717       stateSet_->erase(stateSet_->iterator_to(*this));
718     if (getVariable())
719       lmm_variable_free(getModel()->getMaxminSystem(), getVariable());
720     if (getModel()->getUpdateMechanism() == UM_LAZY) {
721       /* remove from heap */
722       heapRemove(getModel()->getActionHeap());
723       if (action_lmm_hook.is_linked())
724         getModel()->getModifiedSet()->erase(getModel()->getModifiedSet()->iterator_to(*this));
725     }
726     delete this;
727     return 1;
728   }
729   return 0;
730 }
731
732 void Action::suspend()
733 {
734   XBT_IN("(%p)", this);
735   if (suspended_ != 2) {
736     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), 0.0);
737     if (getModel()->getUpdateMechanism() == UM_LAZY){
738       heapRemove(getModel()->getActionHeap());
739       if (getModel()->getUpdateMechanism() == UM_LAZY  && stateSet_ == getModel()->getRunningActionSet() && priority_ > 0){
740         //If we have a lazy model, we need to update the remaining value accordingly
741         updateRemainingLazy(surf_get_clock());
742       }
743     }
744     suspended_ = 1;
745   }
746   XBT_OUT();
747 }
748
749 void Action::resume()
750 {
751   XBT_IN("(%p)", this);
752   if (suspended_ != 2) {
753     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), priority_);
754     suspended_ = 0;
755     if (getModel()->getUpdateMechanism() == UM_LAZY)
756       heapRemove(getModel()->getActionHeap());
757   }
758   XBT_OUT();
759 }
760
761 bool Action::isSuspended()
762 {
763   return suspended_ == 1;
764 }
765 /* insert action on heap using a given key and a hat (heap_action_type)
766  * a hat can be of three types for communications:
767  *
768  * NORMAL = this is a normal heap entry stating the date to finish transmitting
769  * LATENCY = this is a heap entry to warn us when the latency is payed
770  * MAX_DURATION =this is a heap entry to warn us when the max_duration limit is reached
771  */
772 void Action::heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat)
773 {
774   hat_ = hat;
775   xbt_heap_push(heap, this, key);
776 }
777
778 void Action::heapRemove(xbt_heap_t heap)
779 {
780   hat_ = NOTSET;
781   if (indexHeap_ >= 0) {
782     xbt_heap_remove(heap, indexHeap_);
783   }
784 }
785
786 void Action::heapUpdate(xbt_heap_t heap, double key, enum heap_action_type hat)
787 {
788   hat_ = hat;
789   if (indexHeap_ >= 0) {
790     xbt_heap_update(heap, indexHeap_, key);
791   }else{
792     xbt_heap_push(heap, this, key);
793   }
794 }
795
796 void Action::updateIndexHeap(int i) {
797   indexHeap_ = i;
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 //FIXME split code in the right places
816 void Action::updateRemainingLazy(double now)
817 {
818   double delta = 0.0;
819
820   if(getModel() == surf_network_model)
821   {
822     if (suspended_ != 0)
823       return;
824   }
825   else
826   {
827     xbt_assert(stateSet_ == getModel()->getRunningActionSet(), "You're updating an action that is not running.");
828     xbt_assert(priority_ > 0, "You're updating an action that seems suspended.");
829   }
830
831   delta = now - lastUpdate_;
832
833   if (remains_ > 0) {
834     XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, remains_, lastUpdate_);
835     double_update(&remains_, lastValue_ * delta, sg_surf_precision*sg_maxmin_precision);
836
837     if (getModel() == surf_cpu_model_pm && TRACE_is_enabled()) {
838       simgrid::surf::Resource *cpu = static_cast<simgrid::surf::Resource*>(
839         lmm_constraint_id(lmm_get_cnst_from_var(getModel()->getMaxminSystem(), getVariable(), 0)));
840       TRACE_surf_host_set_utilization(cpu->getName(), getCategory(), lastValue_, lastUpdate_, now - lastUpdate_);
841     }
842     XBT_DEBUG("Updating action(%p): remains is now %f", this, remains_);
843   }
844
845   if(getModel() == surf_network_model)
846   {
847     if (maxDuration_ != NO_MAX_DURATION)
848       double_update(&maxDuration_, delta, sg_surf_precision);
849
850     //FIXME: duplicated code
851     if ((remains_ <= 0) &&
852         (lmm_get_variable_weight(getVariable()) > 0)) {
853       finish();
854       setState(Action::State::done);
855       heapRemove(getModel()->getActionHeap());
856     } else if (((maxDuration_ != NO_MAX_DURATION)
857         && (maxDuration_ <= 0))) {
858       finish();
859       setState(Action::State::done);
860       heapRemove(getModel()->getActionHeap());
861     }
862   }
863
864   lastUpdate_ = now;
865   lastValue_ = lmm_variable_getvalue(getVariable());
866 }
867
868 }
869 }