Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
5c33f5ba209d8f53492d1575b8362c7f8a89bea2
[simgrid.git] / include / simgrid / kernel / resource / Action.hpp
1 /* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved.          */
2
3 /* This program is free software; you can redistribute it and/or modify it
4  * under the terms of the license (GNU LGPL) which comes with this package. */
5
6 #ifndef SIMGRID_KERNEL_RESOURCE_ACTION_HPP
7 #define SIMGRID_KERNEL_RESOURCE_ACTION_HPP
8
9 #include <simgrid/forward.h>
10 #include <xbt/signal.hpp>
11 #include <xbt/utility.hpp>
12
13 #include <boost/heap/pairing_heap.hpp>
14 #include <boost/optional.hpp>
15
16 static constexpr int NO_MAX_DURATION = -1.0;
17
18 namespace simgrid {
19 namespace kernel {
20 namespace resource {
21
22 typedef std::pair<double, simgrid::kernel::resource::Action*> heap_element_type;
23 typedef boost::heap::pairing_heap<heap_element_type, boost::heap::constant_time_size<false>, boost::heap::stable<true>,
24                                   boost::heap::compare<simgrid::xbt::HeapComparator<heap_element_type>>>
25     heap_type;
26
27 typedef std::pair<double, simgrid::kernel::resource::Action*> heap_element_type;
28 class XBT_PUBLIC ActionHeap : public heap_type {
29   friend Action;
30
31 public:
32   enum class Type {
33     latency = 100, /* this is a heap entry to warn us when the latency is payed */
34     max_duration,  /* this is a heap entry to warn us when the max_duration limit (timeout) is reached */
35     normal,        /* this is a normal heap entry stating the date to finish transmitting */
36     unset
37   };
38
39   double top_date() const;
40   void insert(Action* action, double date, ActionHeap::Type type);
41   void update(Action* action, double date, ActionHeap::Type type);
42   void remove(Action* action);
43   Action* pop();
44   bool empty() const { return heap_type::empty(); }
45 };
46
47 /** @details An action is a consumption on a resource (e.g.: a communication for the network).
48  *
49  * It is related (but still different) from activities, that are the stuff on which an actor can be blocked.
50  * See simgrid::s4u::Activity for more details.
51  */
52 class XBT_PUBLIC Action {
53   friend ActionHeap;
54
55 public:
56   /* Lazy update needs this Set hook to maintain a list of the tracked actions */
57   boost::intrusive::list_member_hook<> modified_set_hook_;
58   bool is_within_modified_set() const { return modified_set_hook_.is_linked(); }
59   typedef boost::intrusive::list<
60       Action, boost::intrusive::member_hook<Action, boost::intrusive::list_member_hook<>, &Action::modified_set_hook_>>
61       ModifiedSet;
62
63   boost::intrusive::list_member_hook<> state_set_hook_;
64   typedef boost::intrusive::list<
65       Action, boost::intrusive::member_hook<Action, boost::intrusive::list_member_hook<>, &Action::state_set_hook_>>
66       StateSet;
67
68   enum class State {
69     INITED,   /**< Created, but not started yet */
70     STARTED,  /**< Currently running */
71     FAILED,   /**< either the resource failed, or the action was canceled */
72     FINISHED, /**< Successfully completed  */
73     IGNORED   /**< e.g. failure detectors: infinite sleep actions that are put on resources which failure should get
74                  noticed  */
75   };
76
77   enum class SuspendStates {
78     not_suspended = 0, /**< Action currently not suspended **/
79     suspended,
80     sleeping
81   };
82
83   /**
84    * @brief Action constructor
85    *
86    * @param model The Model associated to this Action
87    * @param cost The cost of the Action
88    * @param failed If the action is impossible (e.g.: execute something on a switched off host)
89    */
90   Action(Model* model, double cost, bool failed);
91
92   /**
93    * @brief Action constructor
94    *
95    * @param model The Model associated to this Action
96    * @param cost The cost of the Action
97    * @param failed If the action is impossible (e.g.: execute something on a switched off host)
98    * @param var The lmm variable associated to this Action if it is part of a LMM component
99    */
100   Action(Model* model, double cost, bool failed, lmm::Variable* var);
101
102   virtual ~Action();
103
104   /**
105    * @brief Mark that the action is now finished
106    *
107    * @param state the new [state](\ref simgrid::kernel::resource::Action::State) of the current Action
108    */
109   void finish(Action::State state);
110
111   /** @brief Get the [state](\ref simgrid::kernel::resource::Action::State) of the current Action */
112   Action::State get_state() const; /**< get the state*/
113   /** @brief Set the [state](\ref simgrid::kernel::resource::Action::State) of the current Action */
114   virtual void set_state(Action::State state);
115
116   /** @brief Get the bound of the current Action */
117   double get_bound() const;
118   /** @brief Set the bound of the current Action */
119   void set_bound(double bound);
120
121   /** @brief Get the start time of the current action */
122   double get_start_time() const { return start_time_; }
123   /** @brief Get the finish time of the current action */
124   double get_finish_time() const { return finish_time_; }
125
126   /** @brief Get the user data associated to the current action */
127   void* get_data() const { return data_; }
128   /** @brief Set the user data associated to the current action */
129   void set_data(void* data) { data_ = data; }
130
131   /** @brief Get the cost of the current action */
132   double get_cost() const { return cost_; }
133   /** @brief Set the cost of the current action */
134   void set_cost(double cost) { cost_ = cost; }
135
136   /** @brief Update the maximum duration of the current action
137    *  @param delta Amount to remove from the MaxDuration */
138   void update_max_duration(double delta);
139
140   /** @brief Update the remaining time of the current action
141    *  @param delta Amount to remove from the remaining time */
142   void update_remains(double delta);
143
144   virtual void update_remains_lazy(double now) = 0;
145
146   /** @brief Set the remaining time of the current action */
147   void set_remains(double value) { remains_ = value; }
148
149   /** @brief Get the remaining time of the current action after updating the resource */
150   virtual double get_remains();
151   /** @brief Get the remaining time of the current action without updating the resource */
152   double get_remains_no_update() const { return remains_; }
153
154   /** @brief Set the finish time of the current action */
155   void set_finish_time(double value) { finish_time_ = value; }
156
157   /**@brief Add a reference to the current action (refcounting) */
158   void ref();
159   /** @brief Unref that action (and destroy it if refcount reaches 0)
160    *  @return true if the action was destroyed and false if someone still has references on it */
161   int unref();
162
163   /** @brief Cancel the current Action if running */
164   virtual void cancel();
165
166   /** @brief Suspend the current Action */
167   virtual void suspend();
168
169   /** @brief Resume the current Action */
170   virtual void resume();
171
172   /** @brief Returns true if the current action is running */
173   bool is_suspended();
174
175   /** @brief Get the maximum duration of the current action */
176   double get_max_duration() const { return max_duration_; }
177   /** @brief Set the maximum duration of the current Action */
178   virtual void set_max_duration(double duration);
179
180   /** @brief Get the tracing category associated to the current action */
181   char* get_category() const { return category_; }
182   /** @brief Set the tracing category of the current Action */
183   void set_category(const char* category);
184
185   /** @brief Get the priority of the current Action */
186   double get_priority() const { return sharing_priority_; };
187   /** @brief Set the priority of the current Action */
188   virtual void set_priority(double priority);
189   void set_priority_no_update(double priority) { sharing_priority_ = priority; }
190
191   /** @brief Get the state set in which the action is */
192   StateSet* get_state_set() const { return state_set_; };
193
194   simgrid::kernel::resource::Model* get_model() const { return model_; }
195
196 protected:
197   StateSet* state_set_;
198
199 private:
200   int refcount_            = 1;
201   double sharing_priority_ = 1.0;             /**< priority (1.0 by default) */
202   double max_duration_   = NO_MAX_DURATION; /*< max_duration (may fluctuate until the task is completed) */
203   double remains_;           /**< How much of that cost remains to be done in the currently running task */
204   double start_time_;        /**< start time  */
205   double finish_time_ = -1;  /**< finish time (may fluctuate until the task is completed) */
206   char* category_     = nullptr; /**< tracing category for categorized resource utilization monitoring */
207
208   double cost_;
209   simgrid::kernel::resource::Model* model_;
210   void* data_ = nullptr; /**< for your convenience */
211
212   /* LMM */
213   double last_update_                                = 0;
214   double last_value_                                 = 0;
215   kernel::lmm::Variable* variable_                   = nullptr;
216
217   ActionHeap::Type type_                              = ActionHeap::Type::unset;
218   boost::optional<ActionHeap::handle_type> heap_hook_ = boost::none;
219
220 public:
221   ActionHeap::Type get_type() const { return type_; }
222
223   lmm::Variable* get_variable() const { return variable_; }
224   void set_variable(lmm::Variable* var) { variable_ = var; }
225
226   double get_last_update() const { return last_update_; }
227   void set_last_update();
228
229   double get_last_value() const { return last_value_; }
230   void set_last_value(double val) { last_value_ = val; }
231
232 protected:
233   Action::SuspendStates suspended_ = Action::SuspendStates::not_suspended;
234 };
235
236 } // namespace resource
237 } // namespace kernel
238 } // namespace simgrid
239 #endif