Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Replace swag by boost::intrusive::list in surf
[simgrid.git] / src / surf / surf_interface.cpp
1 #include "surf_private.h"
2 #include "surf_interface.hpp"
3 #include "network_interface.hpp"
4 #include "cpu_interface.hpp"
5 #include "workstation_interface.hpp"
6 #include "vm_workstation_interface.hpp"
7 #include "simix/smx_host_private.h"
8 #include "surf_routing.hpp"
9 #include "simgrid/sg_config.h"
10 #include "mc/mc.h"
11
12 XBT_LOG_NEW_CATEGORY(surf, "All SURF categories");
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf,
14                                 "Logging specific to SURF (kernel)");
15
16 /*********
17  * Utils *
18  *********/
19
20 /* This function is a pimple that we ought to fix. But it won't be easy.
21  *
22  * The surf_solve() function does properly return the set of actions that changed.
23  * Instead, each model change a global data, and then the caller of surf_solve must
24  * pick into these sets of action_failed and action_done.
25  *
26  * This was not clean but ok as long as we didn't had to restart the processes when the resource comes back up.
27  * We worked by putting sentinel actions on every resources we are interested in,
28  * so that surf informs us if/when the corresponding resource fails.
29  *
30  * But this does not work to get Simix informed of when a resource comes back up, and this is where this pimple comes.
31  * We have a set of resources that are currently down and for which simix needs to know when it comes back up.
32  * And the current function is called *at every simulation step* to sweep over that set, searching for a resource
33  * that was turned back up in the meanwhile. This is UGLY and slow.
34  *
35  * The proper solution would be to not rely on globals for the action_failed and action_done swags.
36  * They must be passed as parameter by the caller (the handling of these actions in simix may let you
37  * think that these two sets can be merged, but their handling in SimDag induce the contrary unless this
38  * simdag code can check by itself whether the action is done of failed -- seems very doable, but yet more
39  * cleanup to do).
40  *
41  * Once surf_solve() is passed the set of actions that changed, you want to add a new set of resources back up
42  * as parameter to this function. You also want to add a boolean field "restart_watched" to each resource, and
43  * make sure that whenever a resource with this field enabled comes back up, it's added to that set so that Simix
44  * sees it and react accordingly. This would kill that need for surf to call simix.
45  *
46  */
47
48 /*static void remove_watched_host(void *key)
49 {
50   xbt_dict_remove(watched_hosts_lib, *(char**)key);
51 }*/
52
53 /*void surf_watched_hosts(void)
54 {
55   char *key;
56   void *host;
57   xbt_dict_cursor_t cursor;
58   xbt_dynar_t hosts = xbt_dynar_new(sizeof(char*), NULL);
59
60   XBT_DEBUG("Check for host SURF_RESOURCE_ON on watched_hosts_lib");
61   xbt_dict_foreach(watched_hosts_lib, cursor, key, host)
62   {
63     if(SIMIX_host_get_state((smx_host_t)host) == SURF_RESOURCE_ON){
64       XBT_INFO("Restart processes on host: %s", SIMIX_host_get_name((smx_host_t)host));
65       SIMIX_host_autorestart((smx_host_t)host);
66       xbt_dynar_push_as(hosts, char*, key);
67     }
68     else
69       XBT_DEBUG("See SURF_RESOURCE_OFF on host: %s",key);
70   }
71   xbt_dynar_map(hosts, remove_watched_host);
72   xbt_dynar_free(&hosts);
73 }*/
74
75 /* model_list_invoke contains only surf_workstation and surf_vm_workstation.
76  * The callback functions of cpu_model and network_model will be called from
77  * those of these workstation models. */
78 xbt_dynar_t model_list = NULL; /* for destroying all models correctly */
79 xbt_dynar_t model_list_invoke = NULL;  /* for invoking callbacks */
80
81 tmgr_history_t history = NULL;
82 lmm_system_t maxmin_system = NULL;
83 xbt_dynar_t surf_path = NULL;
84 xbt_dynar_t host_that_restart = NULL;
85 xbt_dict_t watched_hosts_lib;
86
87 /* Don't forget to update the option description in smx_config when you change this */
88 s_surf_model_description_t surf_network_model_description[] = {
89   {"LV08",
90    "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). ",
91    surf_network_model_init_LegrandVelho},
92   {"Constant",
93    "Simplistic network model where all communication take a constant time (one second). This model provides the lowest realism, but is (marginally) faster.",
94    surf_network_model_init_Constant},
95   {"SMPI",
96    "Realistic network model specifically tailored for HPC settings (accurate modeling of slow start with correction factors on three intervals: < 1KiB, < 64 KiB, >= 64 KiB)",
97    surf_network_model_init_SMPI},
98   {"CM02",
99    "Legacy network analytic model (Very similar to LV08, but without corrective factors. The timings of small messages are thus poorly modeled).",
100    surf_network_model_init_CM02},
101 #ifdef HAVE_GTNETS
102   {"GTNets",
103    "Network pseudo-model using the GTNets simulator instead of an analytic model",
104    surf_network_model_init_GTNETS},
105 #endif
106 #ifdef HAVE_NS3
107   {"NS3",
108    "Network pseudo-model using the NS3 tcp model instead of an analytic model",
109   surf_network_model_init_NS3},
110 #endif
111   {"Reno",
112    "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
113    surf_network_model_init_Reno},
114   {"Reno2",
115    "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
116    surf_network_model_init_Reno2},
117   {"Vegas",
118    "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
119    surf_network_model_init_Vegas},
120   {NULL, NULL, NULL}      /* this array must be NULL terminated */
121 };
122
123 s_surf_model_description_t surf_cpu_model_description[] = {
124   {"Cas01",
125    "Simplistic CPU model (time=size/power).",
126    surf_cpu_model_init_Cas01},
127   {NULL, NULL,  NULL}      /* this array must be NULL terminated */
128 };
129
130 s_surf_model_description_t surf_workstation_model_description[] = {
131   {"default",
132    "Default workstation model. Currently, CPU:Cas01 and network:LV08 (with cross traffic enabled)",
133    surf_workstation_model_init_current_default},
134   {"compound",
135    "Workstation model that is automatically chosen if you change the network and CPU models",
136    surf_workstation_model_init_compound},
137   {"ptask_L07", "Workstation model somehow similar to Cas01+CM02 but allowing parallel tasks",
138    surf_workstation_model_init_ptask_L07},
139   {NULL, NULL, NULL}      /* this array must be NULL terminated */
140 };
141
142 s_surf_model_description_t surf_vm_workstation_model_description[] = {
143   {"default",
144    "Default vm workstation model.)",
145    surf_vm_workstation_model_init_current_default},
146   {NULL, NULL, NULL}      /* this array must be NULL terminated */
147 };
148
149 s_surf_model_description_t surf_optimization_mode_description[] = {
150   {"Lazy",
151    "Lazy action management (partial invalidation in lmm + heap in action remaining).",
152    NULL},
153   {"TI",
154    "Trace integration. Highly optimized mode when using availability traces (only available for the Cas01 CPU model for now).",
155     NULL},
156   {"Full",
157    "Full update of remaining and variables. Slow but may be useful when debugging.",
158    NULL},
159   {NULL, NULL, NULL}      /* this array must be NULL terminated */
160 };
161
162 s_surf_model_description_t surf_storage_model_description[] = {
163   {"default",
164    "Simplistic storage model.",
165    surf_storage_model_init_default},
166   {NULL, NULL,  NULL}      /* this array must be NULL terminated */
167 };
168
169 #ifdef CONTEXT_THREADS
170 static xbt_parmap_t surf_parmap = NULL; /* parallel map on models */
171 #endif
172
173 double NOW = 0;
174 double *surf_mins = NULL; /* return value of share_resources for each model */
175 int surf_min_index;       /* current index in surf_mins */
176 double surf_min;               /* duration determined by surf_solve */
177
178 double surf_get_clock(void)
179 {
180   return NOW;
181 }
182
183 #ifdef _XBT_WIN32
184 # define FILE_DELIM "\\"
185 #else
186 # define FILE_DELIM "/"         /* FIXME: move to better location */
187 #endif
188
189 FILE *surf_fopen(const char *name, const char *mode)
190 {
191   unsigned int cpt;
192   char *path_elm = NULL;
193   char *buff;
194   FILE *file = NULL;
195
196   xbt_assert(name);
197
198   if (__surf_is_absolute_file_path(name))       /* don't mess with absolute file names */
199     return fopen(name, mode);
200
201   /* search relative files in the path */
202   xbt_dynar_foreach(surf_path, cpt, path_elm) {
203     buff = bprintf("%s" FILE_DELIM "%s", path_elm, name);
204     file = fopen(buff, mode);
205     free(buff);
206
207     if (file)
208       return file;
209   }
210   return NULL;
211 }
212
213
214 #ifndef MAX_DRIVE
215 #define MAX_DRIVE 26
216 #endif
217
218 #ifdef _XBT_WIN32
219 #include <windows.h>
220 static const char *disk_drives_letter_table[MAX_DRIVE] = {
221   "A:\\",
222   "B:\\",
223   "C:\\",
224   "D:\\",
225   "E:\\",
226   "F:\\",
227   "G:\\",
228   "H:\\",
229   "I:\\",
230   "J:\\",
231   "K:\\",
232   "L:\\",
233   "M:\\",
234   "N:\\",
235   "O:\\",
236   "P:\\",
237   "Q:\\",
238   "R:\\",
239   "S:\\",
240   "T:\\",
241   "U:\\",
242   "V:\\",
243   "W:\\",
244   "X:\\",
245   "Y:\\",
246   "Z:\\"
247 };
248 #endif  
249
250 /*
251  * Returns the initial path. On Windows the initial path is
252  * the current directory for the current process in the other
253  * case the function returns "./" that represents the current
254  * directory on Unix/Linux platforms.
255  */
256
257 const char *__surf_get_initial_path(void)
258 {
259
260 #ifdef _XBT_WIN32
261   unsigned i;
262   char current_directory[MAX_PATH + 1] = { 0 };
263   unsigned int len = GetCurrentDirectory(MAX_PATH + 1, current_directory);
264   char root[4] = { 0 };
265
266   if (!len)
267     return NULL;
268
269   strncpy(root, current_directory, 3);
270
271   for (i = 0; i < MAX_DRIVE; i++) {
272     if (toupper(root[0]) == disk_drives_letter_table[i][0])
273       return disk_drives_letter_table[i];
274   }
275
276   return NULL;
277 #else
278   return "./";
279 #endif
280 }
281
282 /* The __surf_is_absolute_file_path() returns 1 if
283  * file_path is a absolute file path, in the other
284  * case the function returns 0.
285  */
286 int __surf_is_absolute_file_path(const char *file_path)
287 {
288 #ifdef _XBT_WIN32
289   WIN32_FIND_DATA wfd = { 0 };
290   HANDLE hFile = FindFirstFile(file_path, &wfd);
291
292   if (INVALID_HANDLE_VALUE == hFile)
293     return 0;
294
295   FindClose(hFile);
296   return 1;
297 #else
298   return (file_path[0] == '/');
299 #endif
300 }
301
302 /** Displays the long description of all registered models, and quit */
303 void model_help(const char *category, s_surf_model_description_t * table)
304 {
305   int i;
306   printf("Long description of the %s models accepted by this simulator:\n",
307          category);
308   for (i = 0; table[i].name; i++)
309     printf("  %s: %s\n", table[i].name, table[i].description);
310 }
311
312 int find_model_description(s_surf_model_description_t * table,
313                            const char *name)
314 {
315   int i;
316   char *name_list = NULL;
317
318   for (i = 0; table[i].name; i++)
319     if (!strcmp(name, table[i].name)) {
320       return i;
321     }
322   name_list = strdup(table[0].name);
323   for (i = 1; table[i].name; i++) {
324     name_list = (char *) xbt_realloc(name_list, strlen(name_list) + strlen(table[i].name) + 3);
325     strcat(name_list, ", ");
326     strcat(name_list, table[i].name);
327   }
328   xbt_die("Model '%s' is invalid! Valid models are: %s.", name, name_list);
329   return -1;
330 }
331
332 static XBT_INLINE void routing_asr_host_free(void *p)
333 {
334   delete ((RoutingEdgePtr) p);
335 }
336
337 static XBT_INLINE void routing_asr_prop_free(void *p)
338 {
339   xbt_dict_t elm = (xbt_dict_t) p;
340   xbt_dict_free(&elm);
341 }
342
343 static XBT_INLINE void surf_cpu_free(void *r)
344 {
345   delete dynamic_cast<CpuPtr>(static_cast<ResourcePtr>(r));
346 }
347
348 static XBT_INLINE void surf_link_free(void *r)
349 {
350   delete dynamic_cast<NetworkLinkPtr>(static_cast<ResourcePtr>(r));
351 }
352
353 static XBT_INLINE void surf_workstation_free(void *r)
354 {
355   delete dynamic_cast<WorkstationPtr>(static_cast<ResourcePtr>(r));
356 }
357
358
359 void sg_version(int *ver_major,int *ver_minor,int *ver_patch) {
360   *ver_major = SIMGRID_VERSION_MAJOR;
361   *ver_minor = SIMGRID_VERSION_MINOR;
362   *ver_patch = SIMGRID_VERSION_PATCH;
363 }
364
365 void surf_init(int *argc, char **argv)
366 {
367   XBT_DEBUG("Create all Libs");
368   host_lib = xbt_lib_new();
369   link_lib = xbt_lib_new();
370   as_router_lib = xbt_lib_new();
371   storage_lib = xbt_lib_new();
372   storage_type_lib = xbt_lib_new();
373   watched_hosts_lib = xbt_dict_new_homogeneous(NULL);
374
375   XBT_DEBUG("Add routing levels");
376   ROUTING_HOST_LEVEL = xbt_lib_add_level(host_lib,routing_asr_host_free);
377   ROUTING_ASR_LEVEL  = xbt_lib_add_level(as_router_lib,routing_asr_host_free);
378   ROUTING_PROP_ASR_LEVEL = xbt_lib_add_level(as_router_lib,routing_asr_prop_free);
379
380   XBT_DEBUG("Add SURF levels");
381   SURF_CPU_LEVEL = xbt_lib_add_level(host_lib,surf_cpu_free);
382   SURF_WKS_LEVEL = xbt_lib_add_level(host_lib,surf_workstation_free);
383   SURF_LINK_LEVEL = xbt_lib_add_level(link_lib,surf_link_free);
384
385   xbt_init(argc, argv);
386   if (!model_list)
387     model_list = xbt_dynar_new(sizeof(ModelPtr), NULL);
388   if (!model_list_invoke)
389     model_list_invoke = xbt_dynar_new(sizeof(ModelPtr), NULL);
390   if (!history)
391     history = tmgr_history_new();
392
393 #ifdef HAVE_TRACING
394   TRACE_add_start_function(TRACE_surf_alloc);
395   TRACE_add_end_function(TRACE_surf_release);
396 #endif
397
398   sg_config_init(argc, argv);
399
400   if (MC_is_active())
401     MC_memory_init();
402 }
403
404 void surf_exit(void)
405 {
406   unsigned int iter;
407   ModelPtr model = NULL;
408
409 #ifdef HAVE_TRACING
410   TRACE_end();                  /* Just in case it was not called by the upper
411                                  * layer (or there is no upper layer) */
412 #endif
413
414   sg_config_finalize();
415
416   xbt_dynar_foreach(model_list, iter, model)
417     delete model;
418   xbt_dynar_free(&model_list);
419   xbt_dynar_free(&model_list_invoke);
420   routing_exit();
421
422   if (maxmin_system) {
423     lmm_system_free(maxmin_system);
424     maxmin_system = NULL;
425   }
426   if (history) {
427     tmgr_history_free(history);
428     history = NULL;
429   }
430
431 #ifdef CONTEXT_THREADS
432   xbt_parmap_destroy(surf_parmap);
433 #endif
434
435   xbt_free(surf_mins);
436   surf_mins = NULL;
437
438   xbt_dynar_free(&host_that_restart);
439   xbt_dynar_free(&surf_path);
440
441   xbt_lib_free(&host_lib);
442   xbt_lib_free(&link_lib);
443   xbt_lib_free(&as_router_lib);
444   xbt_lib_free(&storage_lib);
445   xbt_lib_free(&storage_type_lib);
446
447   xbt_dict_free(&watched_hosts_lib);
448
449   tmgr_finalize();
450   surf_parse_lex_destroy();
451   surf_parse_free_callbacks();
452
453   NOW = 0;                      /* Just in case the user plans to restart the simulation afterward */
454 }
455 /*********
456  * Model *
457  *********/
458
459 Model::Model(const char *name)
460   : p_name(name), p_maxminSystem(0),
461     m_resOnCB(0), m_resOffCB(0),
462     m_actCancelCB(0), m_actSuspendCB(0), m_actResumeCB(0)
463 {
464   p_readyActionSet = new ActionList();
465   p_runningActionSet = new ActionList();
466   p_failedActionSet = new ActionList();
467   p_doneActionSet = new ActionList();
468
469   p_modifiedSet = NULL;
470   p_actionHeap = NULL;
471   p_updateMechanism = UM_UNDEFINED;
472   m_selectiveUpdate = 0;
473 }
474
475 Model::~Model(){
476   delete p_readyActionSet;
477   delete p_runningActionSet;
478   delete p_failedActionSet;
479   delete p_doneActionSet;
480 }
481
482 double Model::shareResources(double now)
483 {
484   //FIXME: set the good function once and for all
485   if (p_updateMechanism == UM_LAZY)
486         return shareResourcesLazy(now);
487   else if (p_updateMechanism == UM_FULL)
488         return shareResourcesFull(now);
489   else
490         xbt_die("Invalid cpu update mechanism!");
491 }
492
493 double Model::shareResourcesLazy(double now)
494 {
495   ActionLmmPtr action = NULL;
496   double min = -1;
497   double value;
498
499   XBT_DEBUG
500       ("Before share resources, the size of modified actions set is %d",
501        p_modifiedSet->size());
502
503   lmm_solve(p_maxminSystem);
504
505   XBT_DEBUG
506       ("After share resources, The size of modified actions set is %d",
507        p_modifiedSet->size());
508
509   while(!p_modifiedSet->empty()) {
510         action = dynamic_cast<ActionLmmPtr>(&(p_modifiedSet->front()));
511         p_modifiedSet->pop_front();
512     int max_dur_flag = 0;
513
514     if (action->getStateSet() != p_runningActionSet)
515       continue;
516
517     /* bogus priority, skip it */
518     if (action->getPriority() <= 0)
519       continue;
520
521     action->updateRemainingLazy(now);
522
523     min = -1;
524     value = lmm_variable_getvalue(action->getVariable());
525     if (value > 0) {
526       if (action->getRemains() > 0) {
527         value = action->getRemains() / value;
528         min = now + value;
529       } else {
530         value = 0.0;
531         min = now;
532       }
533     }
534
535     if ((action->getMaxDuration() != NO_MAX_DURATION)
536         && (min == -1
537             || action->getStartTime() +
538             action->getMaxDuration() < min)) {
539       min = action->getStartTime() +
540           action->getMaxDuration();
541       max_dur_flag = 1;
542     }
543
544     XBT_DEBUG("Action(%p) Start %lf Finish %lf Max_duration %lf", action,
545         action->getStartTime(), now + value,
546         action->getMaxDuration());
547
548     if (min != -1) {
549       action->heapRemove(p_actionHeap);
550       action->heapInsert(p_actionHeap, min, max_dur_flag ? MAX_DURATION : NORMAL);
551       XBT_DEBUG("Insert at heap action(%p) min %lf now %lf", action, min,
552                 now);
553     } else DIE_IMPOSSIBLE;
554   }
555
556   //hereafter must have already the min value for this resource model
557   if (xbt_heap_size(p_actionHeap) > 0)
558     min = xbt_heap_maxkey(p_actionHeap) - now;
559   else
560     min = -1;
561
562   XBT_DEBUG("The minimum with the HEAP %lf", min);
563
564   return min;
565 }
566
567 double Model::shareResourcesFull(double /*now*/) {
568   THROW_UNIMPLEMENTED;
569 }
570
571
572 double Model::shareResourcesMaxMin(ActionListPtr running_actions,
573                           lmm_system_t sys,
574                           void (*solve) (lmm_system_t))
575 {
576   void *_action = NULL;
577   ActionLmmPtr action = NULL;
578   double min = -1;
579   double value = -1;
580
581   solve(sys);
582
583   ActionList::iterator it(running_actions->begin()), itend(running_actions->end());
584   for(; it != itend ; ++it) {
585           action = dynamic_cast<ActionLmmPtr>(&*it);
586     value = lmm_variable_getvalue(action->getVariable());
587     if ((value > 0) || (action->getMaxDuration() >= 0))
588       break;
589   }
590
591   if (!action)
592     return -1.0;
593
594   if (value > 0) {
595     if (action->getRemains() > 0)
596       min = action->getRemains() / value;
597     else
598       min = 0.0;
599     if ((action->getMaxDuration() >= 0) && (action->getMaxDuration() < min))
600       min = action->getMaxDuration();
601   } else
602     min = action->getMaxDuration();
603
604
605   for (++it; it != itend; ++it) {
606         action = dynamic_cast<ActionLmmPtr>(&*it);
607     value = lmm_variable_getvalue(action->getVariable());
608     if (value > 0) {
609       if (action->getRemains() > 0)
610         value = action->getRemains() / value;
611       else
612         value = 0.0;
613       if (value < min) {
614         min = value;
615         XBT_DEBUG("Updating min (value) with %p: %f", action, min);
616       }
617     }
618     if ((action->getMaxDuration() >= 0) && (action->getMaxDuration() < min)) {
619       min = action->getMaxDuration();
620       XBT_DEBUG("Updating min (duration) with %p: %f", action, min);
621     }
622   }
623   XBT_DEBUG("min value : %f", min);
624
625   return min;
626 }
627
628 void Model::updateActionsState(double now, double delta)
629 {
630   if (p_updateMechanism == UM_FULL)
631         updateActionsStateFull(now, delta);
632   else if (p_updateMechanism == UM_LAZY)
633         updateActionsStateLazy(now, delta);
634   else
635         xbt_die("Invalid cpu update mechanism!");
636 }
637
638 void Model::updateActionsStateLazy(double /*now*/, double /*delta*/)
639 {
640
641 }
642
643 void Model::updateActionsStateFull(double /*now*/, double /*delta*/)
644 {
645
646 }
647
648
649 void Model::addTurnedOnCallback(ResourceCallback rc)
650 {
651   m_resOnCB = rc;
652 }
653
654 void Model::notifyResourceTurnedOn(ResourcePtr r)
655 {
656   m_resOnCB(r);
657 }
658
659 void Model::addTurnedOffCallback(ResourceCallback rc)
660 {
661   m_resOffCB = rc;
662 }
663
664 void Model::notifyResourceTurnedOff(ResourcePtr r)
665 {
666   m_resOffCB(r);
667 }
668
669 void Model::addActionCancelCallback(ActionCallback ac)
670 {
671   m_actCancelCB = ac;
672 }
673
674 void Model::notifyActionCancel(ActionPtr a)
675 {
676   m_actCancelCB(a);
677 }
678
679 void Model::addActionResumeCallback(ActionCallback ac)
680 {
681   m_actResumeCB = ac;
682 }
683
684 void Model::notifyActionResume(ActionPtr a)
685 {
686   m_actResumeCB(a);
687 }
688
689 void Model::addActionSuspendCallback(ActionCallback ac)
690 {
691   m_actSuspendCB = ac;
692 }
693
694 void Model::notifyActionSuspend(ActionPtr a)
695 {
696   m_actSuspendCB(a);
697 }
698
699
700 /************
701  * Resource *
702  ************/
703
704 Resource::Resource()
705 : p_name(NULL), p_properties(NULL), p_model(NULL)
706 {}
707
708 Resource::Resource(surf_model_t model, const char *name, xbt_dict_t props)
709  : p_name(xbt_strdup(name)), p_properties(props), p_model(model)
710  , m_running(true), m_stateCurrent(SURF_RESOURCE_ON)
711 {}
712
713 Resource::Resource(surf_model_t model, const char *name, xbt_dict_t props, e_surf_resource_state_t stateInit)
714  : p_name(xbt_strdup(name)), p_properties(props), p_model(model)
715  , m_running(true), m_stateCurrent(stateInit)
716 {}
717
718 e_surf_resource_state_t Resource::getState()
719 {
720   return m_stateCurrent;
721 }
722
723 void Resource::setState(e_surf_resource_state_t state)
724 {
725   m_stateCurrent = state;
726 }
727
728 bool Resource::isOn()
729 {
730   return m_running;
731 }
732
733 void Resource::turnOn()
734 {
735   if (!m_running) {
736     m_running = true;
737     getModel()->notifyResourceTurnedOn(this);
738   }
739 }
740
741 void Resource::turnOff()
742 {
743   if (m_running) {
744     m_running = false;
745     getModel()->notifyResourceTurnedOff(this);
746   }
747 }
748
749 ResourceLmm::ResourceLmm()
750  : p_constraint(NULL)
751 {}
752
753 ResourceLmm::ResourceLmm(lmm_constraint_t constraint)
754  : p_constraint(constraint)
755 {}
756
757 /**********
758  * Action *
759  **********/
760
761 const char *surf_action_state_names[6] = {
762   "SURF_ACTION_READY",
763   "SURF_ACTION_RUNNING",
764   "SURF_ACTION_FAILED",
765   "SURF_ACTION_DONE",
766   "SURF_ACTION_TO_FREE",
767   "SURF_ACTION_NOT_IN_THE_SYSTEM"
768 };
769
770 Action::Action()
771 : m_refcount(1)
772 {}
773
774 Action::Action(ModelPtr model, double cost, bool failed)
775  : m_priority(1.0)
776  , m_failed(failed)
777  , m_start(surf_get_clock()), m_finish(-1.0)
778  , m_remains(cost)
779  , m_maxDuration(NO_MAX_DURATION)
780  , m_cost(cost)
781  , p_data(NULL)
782  , p_model(model)
783  , m_refcount(1)
784 {
785   #ifdef HAVE_TRACING
786     p_category = NULL;
787   #endif
788   p_stateHookup.prev = 0;
789   p_stateHookup.next = 0;
790   if (failed)
791     p_stateSet = getModel()->getFailedActionSet();
792   else
793     p_stateSet = getModel()->getRunningActionSet();
794
795   p_stateSet->push_back(*this);
796 }
797
798 Action::~Action() {
799 #ifdef HAVE_TRACING
800   xbt_free(p_category);
801 #endif
802 }
803
804 void Action::finish() {
805     m_finish = surf_get_clock();
806 }
807
808 int Action::unref(){
809   DIE_IMPOSSIBLE;
810 }
811
812 void Action::cancel(){
813   DIE_IMPOSSIBLE;
814 }
815
816 void Action::recycle(){
817   DIE_IMPOSSIBLE;
818 }
819
820 e_surf_action_state_t Action::getState()
821 {
822   if (p_stateSet ==  getModel()->getReadyActionSet())
823     return SURF_ACTION_READY;
824   if (p_stateSet ==  getModel()->getRunningActionSet())
825     return SURF_ACTION_RUNNING;
826   if (p_stateSet ==  getModel()->getFailedActionSet())
827     return SURF_ACTION_FAILED;
828   if (p_stateSet ==  getModel()->getDoneActionSet())
829     return SURF_ACTION_DONE;
830   return SURF_ACTION_NOT_IN_THE_SYSTEM;
831 }
832
833 void Action::setState(e_surf_action_state_t state)
834 {
835   //surf_action_state_t action_state = &(action->model_type->states);
836   XBT_IN("(%p,%s)", this, surf_action_state_names[state]);
837   p_stateSet->erase(p_stateSet->iterator_to(*this));
838   if (state == SURF_ACTION_READY)
839     p_stateSet = getModel()->getReadyActionSet();
840   else if (state == SURF_ACTION_RUNNING)
841     p_stateSet = getModel()->getRunningActionSet();
842   else if (state == SURF_ACTION_FAILED)
843     p_stateSet = getModel()->getFailedActionSet();
844   else if (state == SURF_ACTION_DONE)
845     p_stateSet = getModel()->getDoneActionSet();
846   else
847     p_stateSet = NULL;
848
849   if (p_stateSet)
850         p_stateSet->push_back(*this);
851   XBT_OUT();
852 }
853
854 double Action::getStartTime()
855 {
856   return m_start;
857 }
858
859 double Action::getFinishTime()
860 {
861   /* keep the function behavior, some models (cpu_ti) change the finish time before the action end */
862   return m_remains == 0 ? m_finish : -1;
863 }
864
865 double Action::getRemains()
866 {
867   XBT_IN("(%p)", this);
868   XBT_OUT();
869   return m_remains;
870 }
871
872 void Action::setData(void* data)
873 {
874   p_data = data;
875 }
876
877 #ifdef HAVE_TRACING
878 void Action::setCategory(const char *category)
879 {
880   XBT_IN("(%p,%s)", this, category);
881   p_category = xbt_strdup(category);
882   XBT_OUT();
883 }
884 #endif
885
886 void Action::ref(){
887   m_refcount++;
888 }
889
890 void ActionLmm::setMaxDuration(double duration)
891 {
892   XBT_IN("(%p,%g)", this, duration);
893   m_maxDuration = duration;
894   if (getModel()->getUpdateMechanism() == UM_LAZY)      // remove action from the heap
895     heapRemove(getModel()->getActionHeap());
896   XBT_OUT();
897 }
898
899 void ActionLmm::gapRemove() {}
900
901 void ActionLmm::setPriority(double priority)
902 {
903   XBT_IN("(%p,%g)", this, priority);
904   m_priority = priority;
905   lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), priority);
906
907   if (getModel()->getUpdateMechanism() == UM_LAZY)
908         heapRemove(getModel()->getActionHeap());
909   XBT_OUT();
910 }
911
912 void ActionLmm::cancel(){
913   setState(SURF_ACTION_FAILED);
914   if (getModel()->getUpdateMechanism() == UM_LAZY) {
915         getModel()->getModifiedSet()->erase(getModel()->getModifiedSet()->iterator_to(*this));
916     heapRemove(getModel()->getActionHeap());
917   }
918 }
919
920 int ActionLmm::unref(){
921   m_refcount--;
922   if (!m_refcount) {
923         if (actionHook::is_linked())
924           p_stateSet->erase(p_stateSet->iterator_to(*this));
925         if (getVariable())
926           lmm_variable_free(getModel()->getMaxminSystem(), getVariable());
927         if (getModel()->getUpdateMechanism() == UM_LAZY) {
928           /* remove from heap */
929           heapRemove(getModel()->getActionHeap());
930       if (actionLmmHook::is_linked())
931             getModel()->getModifiedSet()->erase(getModel()->getModifiedSet()->iterator_to(*this));
932     }
933         delete this;
934         return 1;
935   }
936   return 0;
937 }
938
939 void ActionLmm::suspend()
940 {
941   XBT_IN("(%p)", this);
942   if (m_suspended != 2) {
943     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), 0.0);
944     m_suspended = 1;
945     if (getModel()->getUpdateMechanism() == UM_LAZY)
946       heapRemove(getModel()->getActionHeap());
947   }
948   XBT_OUT();
949 }
950
951 void ActionLmm::resume()
952 {
953   XBT_IN("(%p)", this);
954   if (m_suspended != 2) {
955     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), m_priority);
956     m_suspended = 0;
957     if (getModel()->getUpdateMechanism() == UM_LAZY)
958       heapRemove(getModel()->getActionHeap());
959   }
960   XBT_OUT();
961 }
962
963 bool ActionLmm::isSuspended()
964 {
965   return m_suspended == 1;
966 }
967 /* insert action on heap using a given key and a hat (heap_action_type)
968  * a hat can be of three types for communications:
969  *
970  * NORMAL = this is a normal heap entry stating the date to finish transmitting
971  * LATENCY = this is a heap entry to warn us when the latency is payed
972  * MAX_DURATION =this is a heap entry to warn us when the max_duration limit is reached
973  */
974 void ActionLmm::heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat)
975 {
976   m_hat = hat;
977   xbt_heap_push(heap, this, key);
978 }
979
980 void ActionLmm::heapRemove(xbt_heap_t heap)
981 {
982   m_hat = NOTSET;
983   if (m_indexHeap >= 0) {
984     xbt_heap_remove(heap, m_indexHeap);
985   }
986 }
987
988 /* added to manage the communication action's heap */
989 void surf_action_lmm_update_index_heap(void *action, int i) {
990   ((ActionLmmPtr)action)->updateIndexHeap(i);
991 }
992
993 void ActionLmm::updateIndexHeap(int i) {
994   m_indexHeap = i;
995 }
996
997 double ActionLmm::getRemains()
998 {
999   XBT_IN("(%p)", this);
1000   /* update remains before return it */
1001   if (getModel()->getUpdateMechanism() == UM_LAZY)      /* update remains before return it */
1002     updateRemainingLazy(surf_get_clock());
1003   XBT_OUT();
1004   return m_remains;
1005 }
1006
1007 //FIXME split code in the right places
1008 void ActionLmm::updateRemainingLazy(double now)
1009 {
1010   double delta = 0.0;
1011
1012   if(getModel() == static_cast<ModelPtr>(surf_network_model))
1013   {
1014     if (m_suspended != 0)
1015       return;
1016   }
1017   else
1018   {
1019     xbt_assert(p_stateSet == getModel()->getRunningActionSet(),
1020         "You're updating an action that is not running.");
1021
1022       /* bogus priority, skip it */
1023     xbt_assert(m_priority > 0,
1024         "You're updating an action that seems suspended.");
1025   }
1026
1027   delta = now - m_lastUpdate;
1028
1029   if (m_remains > 0) {
1030     XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, m_remains, m_lastUpdate);
1031     double_update(&m_remains, m_lastValue * delta);
1032
1033 #ifdef HAVE_TRACING
1034     if (getModel() == static_cast<ModelPtr>(surf_cpu_model_pm) && TRACE_is_enabled()) {
1035       ResourcePtr cpu = static_cast<ResourcePtr>(lmm_constraint_id(lmm_get_cnst_from_var(getModel()->getMaxminSystem(), getVariable(), 0)));
1036       TRACE_surf_host_set_utilization(cpu->getName(), getCategory(), m_lastValue, m_lastUpdate, now - m_lastUpdate);
1037     }
1038 #endif
1039     XBT_DEBUG("Updating action(%p): remains is now %f", this, m_remains);
1040   }
1041
1042   if(getModel() == static_cast<ModelPtr>(surf_network_model))
1043   {
1044     if (m_maxDuration != NO_MAX_DURATION)
1045       double_update(&m_maxDuration, delta);
1046
1047     //FIXME: duplicated code
1048     if ((m_remains <= 0) &&
1049         (lmm_get_variable_weight(getVariable()) > 0)) {
1050       finish();
1051       setState(SURF_ACTION_DONE);
1052       heapRemove(getModel()->getActionHeap());
1053     } else if (((m_maxDuration != NO_MAX_DURATION)
1054         && (m_maxDuration <= 0))) {
1055       finish();
1056       setState(SURF_ACTION_DONE);
1057       heapRemove(getModel()->getActionHeap());
1058     }
1059   }
1060
1061   m_lastUpdate = now;
1062   m_lastValue = lmm_variable_getvalue(getVariable());
1063 }
1064
1065 /*void Action::cancel()
1066 {
1067   p_model->notifyActionCancel(this);
1068 }
1069
1070 void Action::suspend()
1071 {
1072   p_model->notifyActionSuspend(this);
1073 }
1074
1075 void Action::resume()
1076 {
1077   p_model->notifyActionResume(this);
1078 }
1079
1080 bool Action::isSuspended()
1081 {
1082   return false;
1083 }*/
1084