#ifndef SIMGRID_S4U_ACTIVITY_HPP
#define SIMGRID_S4U_ACTIVITY_HPP
-#include <xbt/asserts.h>
#include <algorithm>
#include <atomic>
#include <set>
#include <stdexcept>
#include <string>
#include <vector>
+#include <xbt/Extendable.hpp>
+#include <xbt/asserts.h>
#include <xbt/signal.hpp>
#include <xbt/utility.hpp>
XBT_LOG_EXTERNAL_CATEGORY(s4u_activity);
namespace simgrid {
+
+extern template class XBT_PUBLIC xbt::Extendable<s4u::Activity>;
+
namespace s4u {
/** @brief Activities
* This class is the ancestor of every activities that an actor can undertake.
* That is, activities are all the things that do take time to the actor in the simulated world.
*/
-class XBT_PUBLIC Activity {
+class XBT_PUBLIC Activity : public xbt::Extendable<Activity> {
friend Comm;
friend Exec;
friend Io;
+#ifndef DOXYGEN
+ friend std::vector<ActivityPtr> create_DAG_from_dot(const std::string& filename);
+ friend std::vector<ActivityPtr> create_DAG_from_DAX(const std::string& filename);
+#endif
+
+public:
+ // enum class State { ... }
+ XBT_DECLARE_ENUM_CLASS(State, INITED, STARTING, STARTED, FAILED, CANCELED, FINISHED);
+
+ virtual bool is_assigned() const = 0;
+ virtual bool dependencies_solved() const { return dependencies_.empty(); }
+ virtual unsigned long is_waited_by() const { return successors_.size(); }
+ const std::set<ActivityPtr>& get_dependencies() const { return dependencies_; }
+ const std::vector<ActivityPtr>& get_successors() const { return successors_; }
protected:
Activity() = default;
virtual ~Activity() = default;
-
- virtual bool is_assigned() const = 0;
+ void destroy();
void release_dependencies()
{
ActivityPtr b = successors_.back();
XBT_CVERB(s4u_activity, "Remove a dependency from '%s' on '%s'", get_cname(), b->get_cname());
b->dependencies_.erase(this);
- if (b->dependencies_.empty()) {
+ if (b->dependencies_solved()) {
b->vetoable_start();
}
successors_.pop_back();
void remove_successor(ActivityPtr a)
{
if(this == a)
- throw std::invalid_argument("Cannot ask to remove its from successors");
+ throw std::invalid_argument("Cannot ask to remove itself from successors list");
auto p = std::find_if(successors_.begin(), successors_.end(), [a](ActivityPtr const& i){ return i.get() == a.get(); });
if (p != successors_.end()){
throw std::invalid_argument("Dependency does not exist. Can not be removed.");
}
+ static std::set<Activity*>* vetoed_activities_;
+
+private:
+ static xbt::signal<void(Activity&)> on_veto;
+ static xbt::signal<void(Activity&)> on_completion;
+
public:
+ /*! Add a callback fired each time that the activity fails to start because of a veto (e.g., unsolved dependency or no
+ * resource assigned) */
+ static void on_veto_cb(const std::function<void(Activity&)>& cb) { on_veto.connect(cb); }
+ /*! Add a callback fired when theactivity completes (either normally, cancelled or failed) */
+ static void on_completion_cb(const std::function<void(Activity&)> cb) { on_completion.connect(cb); }
+
void vetoable_start()
{
state_ = State::STARTING;
- if (dependencies_.empty() && is_assigned()) {
+ if (dependencies_solved() && is_assigned()) {
XBT_CVERB(s4u_activity, "'%s' is assigned to a resource and all dependencies are solved. Let's start", get_cname());
start();
+ } else {
+ if (vetoed_activities_ != nullptr)
+ vetoed_activities_->insert(this);
+ on_veto(*this);
}
}
+ void complete(Activity::State state)
+ {
+ state_ = state;
+ on_completion(*this);
+ if (state == State::FINISHED)
+ release_dependencies();
+ }
+
+ static std::set<Activity*>* get_vetoed_activities() { return vetoed_activities_; }
+ static void set_vetoed_activities(std::set<Activity*>* whereto) { vetoed_activities_ = whereto; }
+
#ifndef DOXYGEN
Activity(Activity const&) = delete;
Activity& operator=(Activity const&) = delete;
#endif
- // enum class State { ... }
- XBT_DECLARE_ENUM_CLASS(State, INITED, STARTING, STARTED, CANCELED, FINISHED);
-
/** Starts a previously created activity.
*
* This function is optional: you can call wait() even if you didn't call start()
*/
virtual Activity* start() = 0;
/** Blocks the current actor until the activity is terminated */
- virtual Activity* wait() = 0;
+ Activity* wait() { return wait_for(-1.0); }
/** Blocks the current actor until the activity is terminated, or until the timeout is elapsed\n
* Raises: timeout exception.*/
- virtual Activity* wait_for(double timeout) = 0;
+ Activity* wait_for(double timeout);
/** Blocks the current actor until the activity is terminated, or until the time limit is reached\n
* Raises: timeout exception. */
void wait_until(double time_limit);
/** Cancel that activity */
- virtual Activity* cancel() = 0;
+ Activity* cancel();
/** Retrieve the current state of the activity */
Activity::State get_state() const { return state_; }
/** Return a string representation of the activity's state (one of INITED, STARTING, STARTED, CANCELED, FINISHED) */
* It is forbidden to change the amount of work once the Activity is started */
Activity* set_remaining(double remains);
+ double get_start_time() const;
+ double get_finish_time() const;
+ void mark() { marked_ = true; }
+ bool is_marked() const { return marked_; }
+
/** Returns the internal implementation of this Activity */
kernel::activity::ActivityImpl* get_impl() const { return pimpl_.get(); }
Activity::State state_ = Activity::State::INITED;
double remains_ = 0;
bool suspended_ = false;
+ bool marked_ = false;
std::vector<ActivityPtr> successors_;
std::set<ActivityPtr> dependencies_;
std::atomic_int_fast32_t refcount_{0};
Activity::vetoable_start();
return static_cast<AnyActivity*>(this);
}
+
+ AnyActivity* cancel() { return static_cast<AnyActivity*>(Activity::cancel()); }
+ AnyActivity* wait() { return wait_for(-1.0); }
+ virtual AnyActivity* wait_for(double timeout) { return static_cast<AnyActivity*>(Activity::wait_for(timeout)); }
+
#ifndef DOXYGEN
/* The refcounting is done in the ancestor class, Activity, but we want each of the classes benefiting of the CRTP
* (Exec, Comm, etc) to have smart pointers too, so we define these methods here, that forward the ptr_release and