1 /* Copyright (c) 2004-2021. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_KERNEL_RESOURCE_ACTION_HPP
7 #define SIMGRID_KERNEL_RESOURCE_ACTION_HPP
9 #include <simgrid/forward.h>
10 #include <xbt/signal.hpp>
11 #include <xbt/utility.hpp>
13 #include <boost/heap/pairing_heap.hpp>
14 #include <boost/optional.hpp>
17 static constexpr int NO_MAX_DURATION = -1.0;
23 using heap_element_type = std::pair<double, Action*>;
25 boost::heap::pairing_heap<heap_element_type, boost::heap::constant_time_size<false>, boost::heap::stable<true>,
26 boost::heap::compare<simgrid::xbt::HeapComparator<heap_element_type>>>;
28 class XBT_PUBLIC ActionHeap : public heap_type {
33 latency = 100, /* this is a heap entry to warn us when the latency is paid */
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 */
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);
46 /** @details An action is a consumption on a resource (e.g.: a communication for the network).
48 * It is related (but still different) from activities, that are the stuff on which an actor can be blocked.
50 * - A sequential execution activity encompasses 2 actions: one for the exec itself,
51 * and a time-limited sleep used as timeout detector.
52 * - A point-to-point communication activity encompasses 3 actions: one for the comm itself
53 * (which spans on all links of the path), and one infinite sleep used as failure detector
54 * on both sender and receiver hosts.
55 * - Synchronization activities may possibly be connected to no action.
58 class XBT_PUBLIC Action {
62 double sharing_penalty_ = 1.0; /**< priority (1.0 by default) */
63 double max_duration_ = NO_MAX_DURATION; /*< max_duration (may fluctuate until the task is completed) */
64 double remains_; /**< How much of that cost remains to be done in the currently running task */
65 double start_time_; /**< start time */
66 double finish_time_ = -1; /**< finish time (may fluctuate until the task is completed) */
67 std::string category_; /**< tracing category for categorized resource utilization monitoring */
71 void* data_ = nullptr; /**< for your convenience */
72 activity::ActivityImpl* activity_ = nullptr;
75 double last_update_ = 0;
76 double last_value_ = 0;
77 lmm::Variable* variable_ = nullptr;
78 double user_bound_ = -1;
80 ActionHeap::Type type_ = ActionHeap::Type::unset;
81 boost::optional<ActionHeap::handle_type> heap_hook_ = boost::none;
82 boost::intrusive::list_member_hook<> modified_set_hook_;
83 boost::intrusive::list_member_hook<> state_set_hook_;
86 /* Lazy update needs this Set hook to maintain a list of the tracked actions */
87 bool is_within_modified_set() const { return modified_set_hook_.is_linked(); }
88 using ModifiedSet = boost::intrusive::list<
89 Action, boost::intrusive::member_hook<Action, boost::intrusive::list_member_hook<>, &Action::modified_set_hook_>>;
91 using StateSet = boost::intrusive::list<
92 Action, boost::intrusive::member_hook<Action, boost::intrusive::list_member_hook<>, &Action::state_set_hook_>>;
95 INITED, /**< Created, but not started yet */
96 STARTED, /**< Currently running */
97 FAILED, /**< either the resource failed, or the action was canceled */
98 FINISHED, /**< Successfully completed */
99 IGNORED /**< e.g. failure detectors: infinite sleep actions that are put on resources which failure should get
103 enum class SuspendStates {
104 RUNNING = 0, /**< Action currently not suspended **/
110 StateSet* state_set_;
111 Action::SuspendStates suspended_ = Action::SuspendStates::RUNNING;
115 * @brief Action constructor
117 * @param model The Model associated to this Action
118 * @param cost The cost of the Action
119 * @param failed If the action is impossible (e.g.: execute something on a switched off host)
121 Action(Model* model, double cost, bool failed);
124 * @brief Action constructor
126 * @param model The Model associated to this Action
127 * @param cost The cost of the Action
128 * @param failed If the action is impossible (e.g.: execute something on a switched off host)
129 * @param var The lmm variable associated to this Action if it is part of a LMM component
131 Action(Model* model, double cost, bool failed, lmm::Variable* var);
132 Action(const Action&) = delete;
133 Action& operator=(const Action&) = delete;
138 * @brief Mark that the action is now finished
140 * @param state the new [state](@ref simgrid::kernel::resource::Action::State) of the current Action
142 void finish(Action::State state);
144 /** @brief Get the [state](@ref simgrid::kernel::resource::Action::State) of the current Action */
145 Action::State get_state() const; /**< get the state*/
146 /** @brief Set the [state](@ref simgrid::kernel::resource::Action::State) of the current Action */
147 virtual void set_state(Action::State state);
149 /** @brief Get the bound of the current Action */
150 double get_bound() const;
151 /** @brief Set the bound of the current Action */
152 void set_bound(double bound);
154 /** @brief Get the start time of the current action */
155 double get_start_time() const { return start_time_; }
156 /** @brief Get the finish time of the current action */
157 double get_finish_time() const { return finish_time_; }
159 /** @brief Get the user data associated to the current action */
160 void* get_data() const { return data_; }
161 /** @brief Set the user data associated to the current action */
162 void set_data(void* data) { data_ = data; }
164 /** @brief Get the user data associated to the current action */
165 activity::ActivityImpl* get_activity() const { return activity_; }
166 /** @brief Set the user data associated to the current action */
167 void set_activity(activity::ActivityImpl* activity) { activity_ = activity; }
169 /** @brief Get the cost of the current action */
170 double get_cost() const { return cost_; }
171 /** @brief Set the cost of the current action */
172 void set_cost(double cost) { cost_ = cost; }
174 /** @brief Update the maximum duration of the current action
175 * @param delta Amount to remove from the MaxDuration */
176 void update_max_duration(double delta);
178 /** @brief Update the remaining time of the current action
179 * @param delta Amount to remove from the remaining time */
180 void update_remains(double delta);
182 virtual void update_remains_lazy(double now) = 0;
184 /** @brief Set the remaining time of the current action */
185 void set_remains(double value) { remains_ = value; }
187 /** @brief Get the remaining time of the current action after updating the resource */
188 virtual double get_remains();
189 /** @brief Get the remaining time of the current action without updating the resource */
190 double get_remains_no_update() const { return remains_; }
192 /** @brief Set the finish time of the current action */
193 void set_finish_time(double value) { finish_time_ = value; }
195 /**@brief Add a reference to the current action (refcounting) */
197 /** @brief Unref that action (and destroy it if refcount reaches 0)
198 * @return true if the action was destroyed and false if someone still has references on it */
201 /** @brief Cancel the current Action if running */
202 virtual void cancel();
204 /** @brief Suspend the current Action */
205 virtual void suspend();
207 /** @brief Resume the current Action */
208 virtual void resume();
210 /** @brief Returns true if the current action is suspended */
211 bool is_suspended() const { return suspended_ == SuspendStates::SUSPENDED; }
212 /** @brief Returns true if the current action is running */
213 bool is_running() const { return suspended_ == SuspendStates::RUNNING; }
215 /** @brief Get the maximum duration of the current action */
216 double get_max_duration() const { return max_duration_; }
217 /** @brief Set the maximum duration of the current Action */
218 virtual void set_max_duration(double duration);
220 /** @brief Get the tracing category associated to the current action */
221 const std::string& get_category() const { return category_; }
222 /** @brief Set the tracing category of the current Action */
223 void set_category(const std::string& category) { category_ = category; }
225 /** @brief Get the sharing_penalty (RTT or 1/thread_count) of the current Action */
226 double get_sharing_penalty() const { return sharing_penalty_; };
227 /** @brief Set the sharing_penalty (RTT or 1/thread_count) of the current Action */
228 virtual void set_sharing_penalty(double sharing_penalty);
229 void set_sharing_penalty_no_update(double sharing_penalty) { sharing_penalty_ = sharing_penalty; }
231 /** @brief Get the state set in which the action is */
232 StateSet* get_state_set() const { return state_set_; };
234 Model* get_model() const { return model_; }
236 ActionHeap::Type get_type() const { return type_; }
238 lmm::Variable* get_variable() const { return variable_; }
239 void set_variable(lmm::Variable* var) { variable_ = var; }
241 double get_user_bound() const { return user_bound_; }
242 void set_user_bound(double bound) { user_bound_ = bound; }
244 double get_last_update() const { return last_update_; }
245 void set_last_update();
247 double get_last_value() const { return last_value_; }
248 void set_last_value(double val) { last_value_ = val; }
249 void set_suspend_state(Action::SuspendStates state) { suspended_ = state; }
252 } // namespace resource
253 } // namespace kernel
254 } // namespace simgrid