1 /* Copyright (c) 2004-2023. 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>
16 #include <string_view>
18 static constexpr double NO_MAX_DURATION = -1.0;
20 namespace simgrid::kernel::resource {
22 using heap_element_type = std::pair<double, Action*>;
24 boost::heap::pairing_heap<heap_element_type, boost::heap::constant_time_size<false>, boost::heap::stable<true>,
25 boost::heap::compare<simgrid::xbt::HeapComparator<heap_element_type>>>;
27 class XBT_PUBLIC ActionHeap : public heap_type {
32 latency = 100, /* this is a heap entry to warn us when the latency is paid */
33 max_duration, /* this is a heap entry to warn us when the max_duration limit (timeout) is reached */
34 normal, /* this is a normal heap entry stating the date to finish transmitting */
38 double top_date() const;
39 void insert(Action* action, double date, ActionHeap::Type type);
40 void update(Action* action, double date, ActionHeap::Type type);
41 void remove(Action* action);
45 /** @details An action is a consumption on a resource (e.g.: a communication for the network).
47 * It is related (but still different) from activities, that are the stuff on which an actor can be blocked.
49 * - A sequential execution activity encompasses 2 actions: one for the exec itself,
50 * and a time-limited sleep used as timeout detector.
51 * - A point-to-point communication activity encompasses 3 actions: one for the comm itself
52 * (which spans on all links of the path), and one infinite sleep used as failure detector
53 * on both sender and receiver hosts.
54 * - Synchronization activities may possibly be connected to no action.
57 class XBT_PUBLIC Action {
61 double sharing_penalty_ = 1.0; /**< priority (1.0 by default) */
62 double max_duration_ = NO_MAX_DURATION; /*< max_duration (may fluctuate until the task is completed) */
63 double remains_; /**< How much of that cost remains to be done in the currently running task */
64 double start_time_; /**< start time */
65 double finish_time_ = -1; /**< finish time (may fluctuate until the task is completed) */
66 std::string category_; /**< tracing category for categorized resource utilization monitoring */
70 activity::ActivityImpl* activity_ = nullptr;
73 double factor_ = 1.0; /**< Factor for effective rate = var->get_value() * factor_ */
74 double last_update_ = 0;
75 double last_value_ = 0;
76 lmm::Variable* variable_ = nullptr;
77 double user_bound_ = -1;
79 ActionHeap::Type type_ = ActionHeap::Type::unset;
80 boost::optional<ActionHeap::handle_type> heap_hook_ = boost::none;
81 boost::intrusive::list_member_hook<> modified_set_hook_;
82 boost::intrusive::list_member_hook<> state_set_hook_;
85 /* Lazy update needs this Set hook to maintain a list of the tracked actions */
86 bool is_within_modified_set() const { return modified_set_hook_.is_linked(); }
87 using ModifiedSet = boost::intrusive::list<
88 Action, boost::intrusive::member_hook<Action, boost::intrusive::list_member_hook<>, &Action::modified_set_hook_>>;
90 using StateSet = boost::intrusive::list<
91 Action, boost::intrusive::member_hook<Action, boost::intrusive::list_member_hook<>, &Action::state_set_hook_>>;
94 INITED, /**< Created, but not started yet */
95 STARTED, /**< Currently running */
96 FAILED, /**< either the resource failed, or the action was canceled */
97 FINISHED, /**< Successfully completed */
98 IGNORED /**< e.g. failure detectors: infinite sleep actions that are put on resources which failure should get
102 enum class SuspendStates {
103 RUNNING = 0, /**< Action currently not suspended **/
109 StateSet* state_set_;
110 Action::SuspendStates suspended_ = Action::SuspendStates::RUNNING;
114 * @brief Action constructor
116 * @param model The Model associated to this Action
117 * @param cost The cost of the Action
118 * @param failed If the action is impossible (e.g.: execute something on a switched off host)
120 Action(Model* model, double cost, bool failed);
123 * @brief Action constructor
125 * @param model The Model associated to this Action
126 * @param cost The cost of the Action
127 * @param failed If the action is impossible (e.g.: execute something on a switched off host)
128 * @param var The lmm variable associated to this Action if it is part of a LMM component
130 Action(Model* model, double cost, bool failed, lmm::Variable* var);
131 Action(const Action&) = delete;
132 Action& operator=(const Action&) = delete;
137 * @brief Mark that the action is now finished
139 * @param state the new [state](@ref simgrid::kernel::resource::Action::State) of the current Action
141 void finish(Action::State state);
143 /** @brief Get the [state](@ref simgrid::kernel::resource::Action::State) of the current Action */
144 Action::State get_state() const; /**< get the state*/
145 /** @brief Set the [state](@ref simgrid::kernel::resource::Action::State) of the current Action */
146 virtual void set_state(Action::State state);
148 /** @brief Get the bound of the current Action */
149 double get_bound() const;
150 /** @brief Set the bound of the current Action */
151 void set_bound(double bound);
153 /** @brief Get the start time of the current action */
154 double get_start_time() const { return start_time_; }
155 /** @brief Get the finish time of the current action */
156 double get_finish_time() const { return finish_time_; }
158 /** @brief Get the user data associated to the current action */
159 activity::ActivityImpl* get_activity() const { return activity_; }
160 /** @brief Set the user data associated to the current action */
161 void set_activity(activity::ActivityImpl* activity) { activity_ = activity; }
163 /** @brief Get the cost of the current action */
164 double get_cost() const { return cost_; }
165 /** @brief Set the cost of the current action */
166 void set_cost(double cost) { cost_ = cost; }
168 /** @brief Update the maximum duration of the current action
169 * @param delta Amount to remove from the MaxDuration */
170 void update_max_duration(double delta);
172 /** @brief Update the remaining time of the current action
173 * @param delta Amount to remove from the remaining time */
174 void update_remains(double delta);
176 virtual void update_remains_lazy(double now) = 0;
178 /** @brief Set the remaining time of the current action */
179 void set_remains(double value) { remains_ = value; }
181 /** @brief Get the remaining time of the current action after updating the resource */
182 virtual double get_remains();
183 /** @brief Get the remaining time of the current action without updating the resource */
184 double get_remains_no_update() const { return remains_; }
186 /** @brief Set the finish time of the current action */
187 void set_finish_time(double value) { finish_time_ = value; }
189 /**@brief Add a reference to the current action (refcounting) */
191 /** @brief Unref that action (and destroy it if refcount reaches 0)
192 * @return true if the action was destroyed and false if someone still has references on it */
195 /** @brief Cancel the current Action if running */
196 virtual void cancel();
198 /** @brief Suspend the current Action */
199 virtual void suspend();
201 /** @brief Resume the current Action */
202 virtual void resume();
204 /** @brief Returns true if the current action is suspended */
205 bool is_suspended() const { return suspended_ == SuspendStates::SUSPENDED; }
206 /** @brief Returns true if the current action is running */
207 bool is_running() const { return suspended_ == SuspendStates::RUNNING; }
209 /** @brief Get the maximum duration of the current action */
210 double get_max_duration() const { return max_duration_; }
211 /** @brief Set the maximum duration of the current Action */
212 virtual void set_max_duration(double duration);
214 /** @brief Get the tracing category associated to the current action */
215 const std::string& get_category() const { return category_; }
216 /** @brief Set the tracing category of the current Action */
217 void set_category(std::string_view category) { category_ = category; }
219 /** @brief Get the sharing_penalty (RTT or 1/thread_count) of the current Action */
220 double get_sharing_penalty() const { return sharing_penalty_; };
221 /** @brief Set the sharing_penalty (RTT or 1/thread_count) of the current Action */
222 virtual void set_sharing_penalty(double sharing_penalty);
223 void set_sharing_penalty_no_update(double sharing_penalty) { sharing_penalty_ = sharing_penalty; }
225 /** @brief Get the state set in which the action is */
226 StateSet* get_state_set() const { return state_set_; };
228 Model* get_model() const { return model_; }
230 ActionHeap::Type get_type() const { return type_; }
232 lmm::Variable* get_variable() const { return variable_; }
233 void set_variable(lmm::Variable* var) { variable_ = var; }
235 double get_user_bound() const { return user_bound_; }
236 void set_user_bound(double bound) { user_bound_ = bound; }
238 double get_last_update() const { return last_update_; }
239 void set_last_update();
242 * @brief Set a factor for this action
244 * Defines a multiplicative factor for the consumption of the underlying resource.
246 * @param factor Multiplicative factor for this action (e.g. 0.97)
248 void set_rate_factor(double factor) { factor_ = factor; }
250 * @brief Get the effective consumption rate of the resource
252 * The rate is based on the sharing given by the maxmin system underneath.
253 * However, it depends on the factor defined for this action.
255 * So, the effective rate is equal to var->get_value() * factor_
257 double get_rate() const;
258 double get_last_value() const { return last_value_; }
259 void set_last_value(double val) { last_value_ = val; }
260 void set_suspend_state(Action::SuspendStates state) { suspended_ = state; }
263 } // namespace simgrid::kernel::resource