Logo AND Algorithmique Numérique Distribuée

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