1 /* Copyright (c) 2006-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_S4U_ACTIVITY_HPP
7 #define SIMGRID_S4U_ACTIVITY_HPP
12 #include <simgrid/forward.h>
15 #include <string_view>
17 #include <xbt/Extendable.hpp>
18 #include <xbt/asserts.h>
19 #include <xbt/signal.hpp>
20 #include <xbt/utility.hpp>
22 XBT_LOG_EXTERNAL_CATEGORY(s4u_activity);
26 extern template class XBT_PUBLIC xbt::Extendable<s4u::Activity>;
32 * This class is the ancestor of every activities that an actor can undertake.
33 * That is, activities are all the things that do take time to the actor in the simulated world.
35 class XBT_PUBLIC Activity : public xbt::Extendable<Activity> {
41 friend kernel::activity::ActivityImpl;
42 friend std::vector<ActivityPtr> create_DAG_from_dot(const std::string& filename);
43 friend std::vector<ActivityPtr> create_DAG_from_DAX(const std::string& filename);
44 friend std::vector<ActivityPtr> create_DAG_from_json(const std::string& filename);
48 // enum class State { ... }
49 XBT_DECLARE_ENUM_CLASS(State, INITED, STARTING, STARTED, FAILED, CANCELED, FINISHED);
51 virtual bool is_assigned() const = 0;
52 bool dependencies_solved() const { return dependencies_.empty(); }
53 bool has_no_successor() const { return successors_.empty(); }
54 const std::set<ActivityPtr>& get_dependencies() const { return dependencies_; }
55 const std::vector<ActivityPtr>& get_successors() const { return successors_; }
59 virtual ~Activity() = default;
62 void release_dependencies()
64 while (not successors_.empty()) {
65 ActivityPtr b = successors_.back();
66 XBT_CVERB(s4u_activity, "Remove a dependency from '%s' on '%s'", get_cname(), b->get_cname());
67 b->dependencies_.erase(this);
68 if (b->dependencies_solved()) {
71 successors_.pop_back();
75 void add_successor(ActivityPtr a)
78 throw std::invalid_argument("Cannot be its own successor");
80 if (std::any_of(begin(successors_), end(successors_), [a](ActivityPtr const& i) { return i.get() == a.get(); }))
81 throw std::invalid_argument("Dependency already exists");
83 successors_.push_back(a);
84 a->dependencies_.insert({this});
87 void remove_successor(ActivityPtr a)
90 throw std::invalid_argument("Cannot ask to remove itself from successors list");
93 std::find_if(successors_.begin(), successors_.end(), [a](ActivityPtr const& i) { return i.get() == a.get(); });
94 if (p == successors_.end())
95 throw std::invalid_argument("Dependency does not exist. Can not be removed.");
98 a->dependencies_.erase({this});
101 static std::set<Activity*>* vetoed_activities_;
103 /** Set the [remaining] amount of work that this Activity will entail
105 * It is forbidden to change the amount of work once the Activity is started */
106 Activity* set_remaining(double remains);
108 virtual void fire_on_start() const = 0;
109 virtual void fire_on_this_start() const = 0;
110 virtual void fire_on_completion() const = 0;
111 virtual void fire_on_this_completion() const = 0;
112 virtual void fire_on_suspend() const = 0;
113 virtual void fire_on_this_suspend() const = 0;
114 virtual void fire_on_resume() const = 0;
115 virtual void fire_on_this_resume() const = 0;
116 virtual void fire_on_veto() = 0;
117 virtual void fire_on_this_veto() = 0;
122 state_ = State::STARTING;
123 if (dependencies_solved() && is_assigned()) {
124 XBT_CVERB(s4u_activity, "'%s' is assigned to a resource and all dependencies are solved. Let's start", get_cname());
127 if (vetoed_activities_ != nullptr)
128 vetoed_activities_->insert(this);
134 void complete(Activity::State state)
136 // Ensure that the current activity remains alive until the end of the function, even if its last reference is
137 // released by the on_completion() callbacks.
138 ActivityPtr keepalive(this);
140 fire_on_completion();
141 fire_on_this_completion();
142 if (state == State::FINISHED)
143 release_dependencies();
146 static std::set<Activity*>* get_vetoed_activities() { return vetoed_activities_; }
147 static void set_vetoed_activities(std::set<Activity*>* whereto) { vetoed_activities_ = whereto; }
150 Activity(Activity const&) = delete;
151 Activity& operator=(Activity const&) = delete;
154 /** Starts a previously created activity.
156 * This function is optional: you can call wait() even if you didn't call start()
158 virtual Activity* do_start() = 0;
159 /** Tests whether the given activity is terminated yet. */
161 /*! take a vector s4u::ActivityPtr and return the rank of the first finished one (or -1 if none is done). */
162 static ssize_t test_any(const std::vector<ActivityPtr>& activities);
164 /** Blocks the current actor until the activity is terminated */
165 Activity* wait() { return wait_for(-1.0); }
166 /** Blocks the current actor until the activity is terminated, or until the timeout is elapsed\n
167 * Raises: timeout exception.*/
168 Activity* wait_for(double timeout);
169 /** Blocks the current actor until the activity is terminated, or until the time limit is reached\n
170 * Raises: timeout exception. */
171 void wait_until(double time_limit);
172 /*! take a vector of s4u::ActivityPtr and return when one of them is finished.
173 * The return value is the rank of the first finished ActivityPtr. */
174 static ssize_t wait_any(const std::vector<ActivityPtr>& activities) { return wait_any_for(activities, -1); }
175 /*! Same as wait_any, but with a timeout. If the timeout occurs, parameter last is returned.*/
176 static ssize_t wait_any_for(const std::vector<ActivityPtr>& activities, double timeout);
178 /** Cancel that activity */
180 /** Retrieve the current state of the activity */
181 Activity::State get_state() const { return state_; }
182 /** Return a string representation of the activity's state (one of INITED, STARTING, STARTED, CANCELED, FINISHED) */
183 const char* get_state_str() const;
184 void set_state(Activity::State state) { state_ = state; }
186 /** Blocks the progression of this activity until it gets resumed */
187 virtual Activity* suspend();
188 /** Unblock the progression of this activity if it was suspended previously */
189 virtual Activity* resume();
190 /** Whether or not the progression of this activity is blocked */
191 bool is_suspended() const { return suspended_; }
193 virtual const char* get_cname() const = 0;
194 virtual const std::string& get_name() const = 0;
196 /** Get the remaining amount of work that this Activity entails. When it's 0, it's done. */
197 virtual double get_remaining() const;
199 double get_start_time() const;
200 double get_finish_time() const;
201 void mark() { marked_ = true; }
202 bool is_marked() const { return marked_; }
204 /** Returns the internal implementation of this Activity */
205 kernel::activity::ActivityImpl* get_impl() const { return pimpl_.get(); }
208 friend void intrusive_ptr_release(Activity* a)
210 if (a->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
211 std::atomic_thread_fence(std::memory_order_acquire);
215 friend void intrusive_ptr_add_ref(Activity* a) { a->refcount_.fetch_add(1, std::memory_order_relaxed); }
219 intrusive_ptr_add_ref(this);
222 void unref() { intrusive_ptr_release(this); }
225 kernel::activity::ActivityImplPtr pimpl_ = nullptr;
226 Activity::State state_ = Activity::State::INITED;
228 bool suspended_ = false;
229 bool marked_ = false;
230 std::vector<ActivityPtr> successors_;
231 std::set<ActivityPtr> dependencies_;
232 std::atomic_int_fast32_t refcount_{0};
235 template <class AnyActivity> class Activity_T : public Activity {
236 std::string name_ = "unnamed";
237 std::string tracing_category_ = "";
239 inline static xbt::signal<void(AnyActivity const&)> on_start;
240 xbt::signal<void(AnyActivity const&)> on_this_start;
241 inline static xbt::signal<void(AnyActivity const&)> on_completion;
242 xbt::signal<void(AnyActivity const&)> on_this_completion;
243 inline static xbt::signal<void(AnyActivity const&)> on_suspend;
244 xbt::signal<void(AnyActivity const&)> on_this_suspend;
245 inline static xbt::signal<void(AnyActivity const&)> on_resume;
246 xbt::signal<void(AnyActivity const&)> on_this_resume;
247 inline static xbt::signal<void(AnyActivity&)> on_veto;
248 xbt::signal<void(AnyActivity&)> on_this_veto;
251 void fire_on_start() const override { on_start(static_cast<const AnyActivity&>(*this)); }
252 void fire_on_this_start() const override { on_this_start(static_cast<const AnyActivity&>(*this)); }
253 void fire_on_completion() const override { on_completion(static_cast<const AnyActivity&>(*this)); }
254 void fire_on_this_completion() const override { on_this_completion(static_cast<const AnyActivity&>(*this)); }
255 void fire_on_suspend() const override { on_suspend(static_cast<const AnyActivity&>(*this)); }
256 void fire_on_this_suspend() const override { on_this_suspend(static_cast<const AnyActivity&>(*this)); }
257 void fire_on_resume() const override { on_resume(static_cast<const AnyActivity&>(*this)); }
258 void fire_on_this_resume() const override { on_this_resume(static_cast<const AnyActivity&>(*this)); }
259 void fire_on_veto() override { on_veto(static_cast<AnyActivity&>(*this)); }
260 void fire_on_this_veto() override { on_this_veto(static_cast<AnyActivity&>(*this)); }
263 /*! \static Add a callback fired when any activity starts (no veto) */
264 static void on_start_cb(const std::function<void(AnyActivity const&)>& cb) { on_start.connect(cb); }
265 /*! Add a callback fired when this specific activity starts (no veto) */
266 void on_this_start_cb(const std::function<void(AnyActivity const&)>& cb) { on_this_start.connect(cb); }
267 /*! \static Add a callback fired when any activity completes (either normally, cancelled or failed) */
268 static void on_completion_cb(const std::function<void(AnyActivity const&)>& cb) { on_completion.connect(cb); }
269 /*! Add a callback fired when this specific activity completes (either normally, cancelled or failed) */
270 void on_this_completion_cb(const std::function<void(AnyActivity const&)>& cb) { on_this_completion.connect(cb); }
271 /*! \static Add a callback fired when any activity is suspended */
272 static void on_suspend_cb(const std::function<void(AnyActivity const&)>& cb) { on_suspend.connect(cb); }
273 /*! Add a callback fired when this specific activity is suspended */
274 void on_this_suspend_cb(const std::function<void(AnyActivity const&)>& cb) { on_this_suspend.connect(cb); }
275 /*! \static Add a callback fired when any activity is resumed after being suspended */
276 static void on_resume_cb(const std::function<void(AnyActivity const&)>& cb) { on_resume.connect(cb); }
277 /*! Add a callback fired when this specific activity is resumed after being suspended */
278 void on_this_resume_cb(const std::function<void(AnyActivity const&)>& cb) { on_this_resume.connect(cb); }
279 /*! \static Add a callback fired each time that any activity fails to start because of a veto (e.g., unsolved
280 * dependency or no resource assigned) */
281 static void on_veto_cb(const std::function<void(AnyActivity&)>& cb) { on_veto.connect(cb); }
282 /*! Add a callback fired each time that this specific activity fails to start because of a veto (e.g., unsolved
283 * dependency or no resource assigned) */
284 void on_this_veto_cb(const std::function<void(AnyActivity&)>& cb) { on_this_veto.connect(cb); }
286 XBT_ATTRIB_DEPRECATED_v338("Please use on_suspend_cb() instead") static void on_suspended_cb(
287 const std::function<void(Activity const&)>& cb)
289 on_suspend.connect(cb);
291 XBT_ATTRIB_DEPRECATED_v338("Please use on_resume_cb() instead") static void on_resumed_cb(
292 const std::function<void(Activity const&)>& cb)
294 on_resume.connect(cb);
297 AnyActivity* add_successor(ActivityPtr a)
299 Activity::add_successor(a);
300 return static_cast<AnyActivity*>(this);
302 AnyActivity* remove_successor(ActivityPtr a)
304 Activity::remove_successor(a);
305 return static_cast<AnyActivity*>(this);
307 AnyActivity* set_name(std::string_view name)
310 return static_cast<AnyActivity*>(this);
312 const std::string& get_name() const override { return name_; }
313 const char* get_cname() const override { return name_.c_str(); }
315 AnyActivity* set_tracing_category(std::string_view category)
317 xbt_assert(get_state() == State::INITED || get_state() == State::STARTING,
318 "Cannot change the tracing category of an activity after its start");
319 tracing_category_ = category;
320 return static_cast<AnyActivity*>(this);
322 const std::string& get_tracing_category() const { return tracing_category_; }
327 return static_cast<AnyActivity*>(this);
330 AnyActivity* cancel() { return static_cast<AnyActivity*>(Activity::cancel()); }
331 AnyActivity* wait() { return wait_for(-1.0); }
332 virtual AnyActivity* wait_for(double timeout) {
333 return static_cast<AnyActivity*>(Activity::wait_for(timeout));
337 /* The refcounting is done in the ancestor class, Activity, but we want each of the classes benefiting of the CRTP
338 * (Exec, Comm, etc) to have smart pointers too, so we define these methods here, that forward the ptr_release and
339 * add_ref to the Activity class. Hopefully, the "inline" helps to not hinder the perf here.
341 friend void inline intrusive_ptr_release(AnyActivity* a) { intrusive_ptr_release(static_cast<Activity*>(a)); }
342 friend void inline intrusive_ptr_add_ref(AnyActivity* a) { intrusive_ptr_add_ref(static_cast<Activity*>(a)); }
347 } // namespace simgrid
349 #endif /* SIMGRID_S4U_ACTIVITY_HPP */