Logo AND Algorithmique Numérique Distribuée

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