1 /* Copyright (c) 2006-2022. 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>
16 #include <xbt/Extendable.hpp>
17 #include <xbt/asserts.h>
18 #include <xbt/signal.hpp>
19 #include <xbt/utility.hpp>
21 XBT_LOG_EXTERNAL_CATEGORY(s4u_activity);
25 extern template class XBT_PUBLIC xbt::Extendable<s4u::Activity>;
31 * This class is the ancestor of every activities that an actor can undertake.
32 * That is, activities are all the things that do take time to the actor in the simulated world.
34 class XBT_PUBLIC Activity : public xbt::Extendable<Activity> {
39 friend std::vector<ActivityPtr> create_DAG_from_dot(const std::string& filename);
40 friend std::vector<ActivityPtr> create_DAG_from_DAX(const std::string& filename);
44 // enum class State { ... }
45 XBT_DECLARE_ENUM_CLASS(State, INITED, STARTING, STARTED, FAILED, CANCELED, FINISHED);
47 virtual bool is_assigned() const = 0;
48 bool dependencies_solved() const { return dependencies_.empty(); }
49 bool has_no_successor() const { return successors_.empty(); }
50 const std::set<ActivityPtr>& get_dependencies() const { return dependencies_; }
51 const std::vector<ActivityPtr>& get_successors() const { return successors_; }
55 virtual ~Activity() = default;
58 void release_dependencies()
60 while (not successors_.empty()) {
61 ActivityPtr b = successors_.back();
62 XBT_CVERB(s4u_activity, "Remove a dependency from '%s' on '%s'", get_cname(), b->get_cname());
63 b->dependencies_.erase(this);
64 if (b->dependencies_solved()) {
67 successors_.pop_back();
71 void add_successor(ActivityPtr a)
74 throw std::invalid_argument("Cannot be its own successor");
75 auto p = std::find_if(successors_.begin(), successors_.end(), [a](ActivityPtr const& i){ return i.get() == a.get(); });
76 if (p != successors_.end())
77 throw std::invalid_argument("Dependency already exists");
79 successors_.push_back(a);
80 a->dependencies_.insert({this});
83 void remove_successor(ActivityPtr a)
86 throw std::invalid_argument("Cannot ask to remove itself from successors list");
88 auto p = std::find_if(successors_.begin(), successors_.end(), [a](ActivityPtr const& i){ return i.get() == a.get(); });
89 if (p != successors_.end()){
91 a->dependencies_.erase({this});
93 throw std::invalid_argument("Dependency does not exist. Can not be removed.");
96 static std::set<Activity*>* vetoed_activities_;
99 static xbt::signal<void(Activity&)> on_veto;
100 static xbt::signal<void(Activity&)> on_completion;
103 /*! Add a callback fired each time that the activity fails to start because of a veto (e.g., unsolved dependency or no
104 * resource assigned) */
105 static void on_veto_cb(const std::function<void(Activity&)>& cb) { on_veto.connect(cb); }
106 /*! Add a callback fired when the activity completes (either normally, cancelled or failed) */
107 static void on_completion_cb(const std::function<void(Activity const&)>& cb) { on_completion.connect(cb); }
109 void vetoable_start()
111 state_ = State::STARTING;
112 if (dependencies_solved() && is_assigned()) {
113 XBT_CVERB(s4u_activity, "'%s' is assigned to a resource and all dependencies are solved. Let's start", get_cname());
116 if (vetoed_activities_ != nullptr)
117 vetoed_activities_->insert(this);
122 void complete(Activity::State state)
125 on_completion(*this);
126 if (state == State::FINISHED)
127 release_dependencies();
130 static std::set<Activity*>* get_vetoed_activities() { return vetoed_activities_; }
131 static void set_vetoed_activities(std::set<Activity*>* whereto) { vetoed_activities_ = whereto; }
134 Activity(Activity const&) = delete;
135 Activity& operator=(Activity const&) = delete;
138 /** Starts a previously created activity.
140 * This function is optional: you can call wait() even if you didn't call start()
142 virtual Activity* start() = 0;
143 /** Blocks the current actor until the activity is terminated */
144 Activity* wait() { return wait_for(-1.0); }
145 /** Blocks the current actor until the activity is terminated, or until the timeout is elapsed\n
146 * Raises: timeout exception.*/
147 Activity* wait_for(double timeout);
148 /** Blocks the current actor until the activity is terminated, or until the time limit is reached\n
149 * Raises: timeout exception. */
150 void wait_until(double time_limit);
152 /** Cancel that activity */
154 /** Retrieve the current state of the activity */
155 Activity::State get_state() const { return state_; }
156 /** Return a string representation of the activity's state (one of INITED, STARTING, STARTED, CANCELED, FINISHED) */
157 const char* get_state_str() const;
158 void set_state(Activity::State state) { state_ = state; }
159 /** Tests whether the given activity is terminated yet. */
162 /** Blocks the progression of this activity until it gets resumed */
163 virtual Activity* suspend();
164 /** Unblock the progression of this activity if it was suspended previously */
165 virtual Activity* resume();
166 /** Whether or not the progression of this activity is blocked */
167 bool is_suspended() const { return suspended_; }
169 virtual const char* get_cname() const = 0;
170 virtual const std::string& get_name() const = 0;
172 /** Get the remaining amount of work that this Activity entails. When it's 0, it's done. */
173 virtual double get_remaining() const;
174 /** Set the [remaining] amount of work that this Activity will entail
176 * It is forbidden to change the amount of work once the Activity is started */
177 Activity* set_remaining(double remains);
179 double get_start_time() const;
180 double get_finish_time() const;
181 void mark() { marked_ = true; }
182 bool is_marked() const { return marked_; }
184 /** Returns the internal implementation of this Activity */
185 kernel::activity::ActivityImpl* get_impl() const { return pimpl_.get(); }
188 friend void intrusive_ptr_release(Activity* a)
190 if (a->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
191 std::atomic_thread_fence(std::memory_order_acquire);
195 friend void intrusive_ptr_add_ref(Activity* a) { a->refcount_.fetch_add(1, std::memory_order_relaxed); }
199 intrusive_ptr_add_ref(this);
202 void unref() { intrusive_ptr_release(this); }
205 kernel::activity::ActivityImplPtr pimpl_ = nullptr;
206 Activity::State state_ = Activity::State::INITED;
208 bool suspended_ = false;
209 bool marked_ = false;
210 std::vector<ActivityPtr> successors_;
211 std::set<ActivityPtr> dependencies_;
212 std::atomic_int_fast32_t refcount_{0};
215 template <class AnyActivity> class Activity_T : public Activity {
216 std::string name_ = "unnamed";
217 std::string tracing_category_ = "";
220 AnyActivity* add_successor(ActivityPtr a)
222 Activity::add_successor(a);
223 return static_cast<AnyActivity*>(this);
225 AnyActivity* remove_successor(ActivityPtr a)
227 Activity::remove_successor(a);
228 return static_cast<AnyActivity*>(this);
230 AnyActivity* set_name(const std::string& name)
232 xbt_assert(get_state() == State::INITED, "Cannot change the name of an activity after its start");
234 return static_cast<AnyActivity*>(this);
236 const std::string& get_name() const override { return name_; }
237 const char* get_cname() const override { return name_.c_str(); }
239 AnyActivity* set_tracing_category(const std::string& category)
241 xbt_assert(get_state() == State::INITED, "Cannot change the tracing category of an activity after its start");
242 tracing_category_ = category;
243 return static_cast<AnyActivity*>(this);
245 const std::string& get_tracing_category() const { return tracing_category_; }
247 XBT_ATTRIB_DEPRECATED_v334("Please use Activity::set_data()") AnyActivity* set_user_data(void* data)
250 return static_cast<AnyActivity*>(this);
253 XBT_ATTRIB_DEPRECATED_v334("Please use Activity::get_data<>()") void* get_user_data() const
255 return get_data<void>();
258 AnyActivity* vetoable_start()
260 Activity::vetoable_start();
261 return static_cast<AnyActivity*>(this);
264 AnyActivity* cancel() { return static_cast<AnyActivity*>(Activity::cancel()); }
265 AnyActivity* wait() { return wait_for(-1.0); }
266 virtual AnyActivity* wait_for(double timeout) { return static_cast<AnyActivity*>(Activity::wait_for(timeout)); }
269 /* The refcounting is done in the ancestor class, Activity, but we want each of the classes benefiting of the CRTP
270 * (Exec, Comm, etc) to have smart pointers too, so we define these methods here, that forward the ptr_release and
271 * add_ref to the Activity class. Hopefully, the "inline" helps to not hinder the perf here.
273 friend void inline intrusive_ptr_release(AnyActivity* a) { intrusive_ptr_release(static_cast<Activity*>(a)); }
274 friend void inline intrusive_ptr_add_ref(AnyActivity* a) { intrusive_ptr_add_ref(static_cast<Activity*>(a)); }
279 } // namespace simgrid
281 #endif /* SIMGRID_S4U_ACTIVITY_HPP */