1 /* Copyright (c) 2006-2020. 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
9 #include "xbt/asserts.h"
12 #include <simgrid/forward.h>
15 #include <xbt/signal.hpp>
17 XBT_LOG_EXTERNAL_CATEGORY(s4u_activity);
24 * This class is the ancestor of every activities that an actor can undertake.
25 * That is, activities are all the things that do take time to the actor in the simulated world.
27 class XBT_PUBLIC Activity {
36 virtual ~Activity() = default;
38 void release_dependencies()
40 while (not successors_.empty()) {
41 ActivityPtr b = successors_.back();
42 XBT_CDEBUG(s4u_activity, "Remove a dependency from '%s' on '%s'", get_cname(), b->get_cname());
43 b->dependencies_.erase(this);
44 if (b->dependencies_.empty()) {
47 successors_.pop_back();
51 void add_successor(ActivityPtr a)
53 successors_.push_back(a);
54 a->dependencies_.insert({this});
60 state_ = State::STARTING;
61 if (dependencies_.empty()) {
62 XBT_CDEBUG(s4u_activity, "All dependencies are solved, let's start '%s'", get_cname());
68 Activity(Activity const&) = delete;
69 Activity& operator=(Activity const&) = delete;
72 enum class State { INITED = 0, STARTING, STARTED, CANCELED, ERRORED, FINISHED };
74 /** Starts a previously created activity.
76 * This function is optional: you can call wait() even if you didn't call start()
78 virtual Activity* start() = 0;
79 /** Blocks until the activity is terminated */
80 virtual Activity* wait() = 0;
81 /** Blocks until the activity is terminated, or until the timeout is elapsed
82 * Raises: timeout exception.*/
83 virtual Activity* wait_for(double timeout) = 0;
84 /** Blocks until the activity is terminated, or until the time limit is reached
85 * Raises: timeout exception. */
86 void wait_until(double time_limit);
88 /** Cancel that activity */
89 virtual Activity* cancel() = 0;
90 /** Retrieve the current state of the activity */
91 Activity::State get_state() { return state_; }
92 void set_state(Activity::State state) { state_ = state; }
93 /** Tests whether the given activity is terminated yet. This is a pure function. */
94 virtual bool test() = 0;
95 virtual const char* get_cname() = 0;
96 virtual const std::string& get_name() = 0;
98 /** Get the remaining amount of work that this Activity entails. When it's 0, it's done. */
99 virtual double get_remaining();
100 /** Set the [remaining] amount of work that this Activity will entail
102 * It is forbidden to change the amount of work once the Activity is started */
103 Activity* set_remaining(double remains);
105 /** Returns the internal implementation of this Activity */
106 kernel::activity::ActivityImpl* get_impl() const { return pimpl_.get(); }
109 friend void intrusive_ptr_release(Activity* a)
111 if (a->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
112 std::atomic_thread_fence(std::memory_order_acquire);
116 friend void intrusive_ptr_add_ref(Activity* a) { a->refcount_.fetch_add(1, std::memory_order_relaxed); }
120 kernel::activity::ActivityImplPtr pimpl_ = nullptr;
121 Activity::State state_ = Activity::State::INITED;
123 std::vector<ActivityPtr> successors_;
124 std::set<ActivityPtr> dependencies_;
125 std::atomic_int_fast32_t refcount_{0};
128 template <class AnyActivity> class Activity_T : public Activity {
129 std::string name_ = "unnamed";
130 std::string tracing_category_ = "";
131 void* user_data_ = nullptr;
134 AnyActivity* add_successor(ActivityPtr a)
136 Activity::add_successor(a);
137 return static_cast<AnyActivity*>(this);
140 AnyActivity* set_name(const std::string& name)
142 xbt_assert(get_state() == State::INITED, "Cannot change the name of an activity after its start");
144 return static_cast<AnyActivity*>(this);
146 const std::string& get_name() { return name_; }
147 const char* get_cname() { return name_.c_str(); }
149 AnyActivity* set_tracing_category(const std::string& category)
151 xbt_assert(get_state() == State::INITED, "Cannot change the tracing category of an activity after its start");
152 tracing_category_ = category;
153 return static_cast<AnyActivity*>(this);
155 const std::string& get_tracing_category() { return tracing_category_; }
157 AnyActivity* set_user_data(void* data)
160 return static_cast<AnyActivity*>(this);
163 void* get_user_data() { return user_data_; }
165 /* The refcounting is done in the ancestor class, Activity, but we want each of the classes benefiting of the CRTP
166 * (Exec, Comm, etc) to have smart pointers too, so we define these methods here, that forward the ptr_release and
167 * add_ref to the Activity class. Hopefully, the "inline" helps to not hinder the perf here.
169 friend void inline intrusive_ptr_release(AnyActivity* a) { intrusive_ptr_release(static_cast<Activity*>(a)); }
170 friend void inline intrusive_ptr_add_ref(AnyActivity* a) { intrusive_ptr_add_ref(static_cast<Activity*>(a)); }
175 } // namespace simgrid
177 #endif /* SIMGRID_S4U_ACTIVITY_HPP */