X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/ccf67464e07c7d37eb7d57cacb69f56881396adf..1363ce9624f4327f3ad5c934b15736a776637dfd:/include/simgrid/s4u/Activity.hpp diff --git a/include/simgrid/s4u/Activity.hpp b/include/simgrid/s4u/Activity.hpp index 06933c1733..46ab38b77e 100644 --- a/include/simgrid/s4u/Activity.hpp +++ b/include/simgrid/s4u/Activity.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2017. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2023. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ @@ -6,70 +6,324 @@ #ifndef SIMGRID_S4U_ACTIVITY_HPP #define SIMGRID_S4U_ACTIVITY_HPP -#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include -enum e_s4u_activity_state_t { inited = 0, started, canceled, errored, finished }; +XBT_LOG_EXTERNAL_CATEGORY(s4u_activity); namespace simgrid { + +extern template class XBT_PUBLIC xbt::Extendable; + namespace s4u { /** @brief Activities * - * This class is the ancestor of every activities that an actor can undertake, that is, of the actions that do take time in the simulated world. + * 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. */ -XBT_PUBLIC_CLASS Activity { +class XBT_PUBLIC Activity : public xbt::Extendable { +#ifndef DOXYGEN friend Comm; - friend void intrusive_ptr_release(Comm * c); - friend void intrusive_ptr_add_ref(Comm * c); friend Exec; - friend void intrusive_ptr_release(Exec * e); - friend void intrusive_ptr_add_ref(Exec * e); + friend Io; + friend kernel::activity::ActivityImpl; + friend std::vector create_DAG_from_dot(const std::string& filename); + friend std::vector create_DAG_from_DAX(const std::string& filename); + friend std::vector create_DAG_from_json(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; + bool dependencies_solved() const { return dependencies_.empty(); } + bool has_no_successor() const { return successors_.empty(); } + const std::set& get_dependencies() const { return dependencies_; } + const std::vector& get_successors() const { return successors_; } protected: Activity() = default; virtual ~Activity() = default; + void destroy(); + + void release_dependencies() + { + while (not successors_.empty()) { + 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_solved()) { + b->start(); + } + successors_.pop_back(); + } + } + + void add_successor(ActivityPtr a) + { + if(this == a) + throw std::invalid_argument("Cannot be its own successor"); + + if (std::any_of(begin(successors_), end(successors_), [a](ActivityPtr const& i) { return i.get() == a.get(); })) + throw std::invalid_argument("Dependency already exists"); + + successors_.push_back(a); + a->dependencies_.insert({this}); + } + + void remove_successor(ActivityPtr a) + { + if(this == a) + 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."); + + successors_.erase(p); + a->dependencies_.erase({this}); + } + + static std::set* vetoed_activities_; + + /** Set the [remaining] amount of work that this Activity will entail + * + * It is forbidden to change the amount of work once the Activity is started */ + Activity* set_remaining(double remains); + + virtual void fire_on_completion() const = 0; + virtual void fire_on_this_completion() const = 0; + virtual void fire_on_suspend() const = 0; + virtual void fire_on_this_suspend() const = 0; + virtual void fire_on_resume() const = 0; + virtual void fire_on_this_resume() const = 0; + virtual void fire_on_veto() const = 0; + virtual void fire_on_this_veto() const = 0; public: + void start() + { + state_ = State::STARTING; + 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()); + do_start(); + } else { + if (vetoed_activities_ != nullptr) + vetoed_activities_->insert(this); + fire_on_veto(); + fire_on_this_veto(); + } + } + + void complete(Activity::State state) + { + // Ensure that the current activity remains alive until the end of the function, even if its last reference is + // released by the on_completion() callbacks. + ActivityPtr keepalive(this); + state_ = state; + fire_on_completion(); + fire_on_this_completion(); + if (state == State::FINISHED) + release_dependencies(); + } + + static std::set* get_vetoed_activities() { return vetoed_activities_; } + static void set_vetoed_activities(std::set* whereto) { vetoed_activities_ = whereto; } + +#ifndef DOXYGEN Activity(Activity const&) = delete; Activity& operator=(Activity const&) = delete; +#endif /** Starts a previously created activity. * * This function is optional: you can call wait() even if you didn't call start() */ - virtual void start()=0; - /** Tests whether the given activity is terminated yet. This is a pure function. */ - //virtual bool test()=0; - /** Blocks until the activity is terminated */ - virtual void wait()=0; - /** Blocks until the activity is terminated, or until the timeout is elapsed + virtual Activity* do_start() = 0; + /** Tests whether the given activity is terminated yet. */ + virtual bool test(); + /*! take a vector s4u::ActivityPtr and return the rank of the first finished one (or -1 if none is done). */ + static ssize_t test_any(const std::vector& activities); + + /** Blocks the current actor until the activity is terminated */ + 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 void wait(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); + /*! take a vector of s4u::ActivityPtr and return when one of them is finished. + * The return value is the rank of the first finished ActivityPtr. */ + static ssize_t wait_any(const std::vector& activities) { return wait_any_for(activities, -1); } + /*! Same as wait_any, but with a timeout. If the timeout occurs, parameter last is returned.*/ + static ssize_t wait_any_for(const std::vector& activities, double timeout); + /** Cancel that activity */ - //virtual void cancel(); + Activity* cancel(); /** Retrieve the current state of the activity */ - e_s4u_activity_state_t getState() {return state_;} + Activity::State get_state() const { return state_; } + /** Return a string representation of the activity's state (one of INITED, STARTING, STARTED, CANCELED, FINISHED) */ + const char* get_state_str() const; + void set_state(Activity::State state) { state_ = state; } + + /** Blocks the progression of this activity until it gets resumed */ + virtual Activity* suspend(); + /** Unblock the progression of this activity if it was suspended previously */ + virtual Activity* resume(); + /** Whether or not the progression of this activity is blocked */ + bool is_suspended() const { return suspended_; } + + virtual const char* get_cname() const = 0; + virtual const std::string& get_name() const = 0; /** Get the remaining amount of work that this Activity entails. When it's 0, it's done. */ - double getRemains(); - /** Set the [remaining] amount of work that this Activity will entail - * - * It is forbidden to change the amount of work once the Activity is started */ - void setRemains(double remains); + virtual double get_remaining() const; + + 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(); } - /** Put some user data onto the Activity */ - void setUserData(void *data) {userData_=data;} - /** Retrieve the user data of the Activity */ - void *getUserData() { return userData_; } +#ifndef DOXYGEN + friend void intrusive_ptr_release(Activity* a) + { + if (a->refcount_.fetch_sub(1, std::memory_order_release) == 1) { + std::atomic_thread_fence(std::memory_order_acquire); + delete a; + } + } + friend void intrusive_ptr_add_ref(Activity* a) { a->refcount_.fetch_add(1, std::memory_order_relaxed); } +#endif + Activity* add_ref() + { + intrusive_ptr_add_ref(this); + return this; + } + void unref() { intrusive_ptr_release(this); } private: - simgrid::kernel::activity::ActivityImplPtr pimpl_ = nullptr; - e_s4u_activity_state_t state_ = inited; - double remains_ = 0; - void *userData_ = nullptr; -}; // class + kernel::activity::ActivityImplPtr pimpl_ = nullptr; + Activity::State state_ = Activity::State::INITED; + double remains_ = 0; + bool suspended_ = false; + bool marked_ = false; + std::vector successors_; + std::set dependencies_; + std::atomic_int_fast32_t refcount_{0}; +}; + +template class Activity_T : public Activity { + std::string name_ = "unnamed"; + std::string tracing_category_ = ""; + +protected: + inline static xbt::signal on_completion; + xbt::signal on_this_completion; + inline static xbt::signal on_suspend; + xbt::signal on_this_suspend; + inline static xbt::signal on_resume; + xbt::signal on_this_resume; + inline static xbt::signal on_veto; + xbt::signal on_this_veto; + +public: + /*! \static Add a callback fired when any activity completes (either normally, cancelled or failed) */ + static void on_completion_cb(const std::function& cb) { on_completion.connect(cb); } + /*! Add a callback fired when this specific activity completes (either normally, cancelled or failed) */ + void on_this_completion_cb(const std::function& cb) { on_this_completion.connect(cb); } + /*! \static Add a callback fired when any activity is suspended */ + static void on_suspend_cb(const std::function& cb) { on_suspend.connect(cb); } + /*! Add a callback fired when this specific activity is suspended */ + void on_this_suspend_cb(const std::function& cb) { on_this_suspend.connect(cb); } + /*! \static Add a callback fired when any activity is resumed after being suspended */ + static void on_resume_cb(const std::function& cb) { on_resume.connect(cb); } + /*! Add a callback fired when this specific activity is resumed after being suspended */ + void on_this_resume_cb(const std::function& cb) { on_this_resume.connect(cb); } + /*! \static Add a callback fired each time that any activity fails to start because of a veto (e.g., unsolved + * dependency or no resource assigned) */ + static void on_veto_cb(const std::function& cb) { on_veto.connect(cb); } + /*! Add a callback fired each time that this specific activity fails to start because of a veto (e.g., unsolved + * dependency or no resource assigned) */ + void on_this_veto_cb(const std::function& cb) { on_this_veto.connect(cb); } + + XBT_ATTRIB_DEPRECATED_v338("Please use on_suspend_cb() instead") static void on_suspended_cb( + const std::function& cb) + { + on_suspend.connect(cb); + } + XBT_ATTRIB_DEPRECATED_v338("Please use on_resume_cb() instead") static void on_resumed_cb( + const std::function& cb) + { + on_resume.connect(cb); + } + + AnyActivity* add_successor(ActivityPtr a) + { + Activity::add_successor(a); + return static_cast(this); + } + AnyActivity* remove_successor(ActivityPtr a) + { + Activity::remove_successor(a); + return static_cast(this); + } + AnyActivity* set_name(std::string_view name) + { + name_ = name; + return static_cast(this); + } + const std::string& get_name() const override { return name_; } + const char* get_cname() const override { return name_.c_str(); } + + AnyActivity* set_tracing_category(std::string_view category) + { + xbt_assert(get_state() == State::INITED || get_state() == State::STARTING, + "Cannot change the tracing category of an activity after its start"); + tracing_category_ = category; + return static_cast(this); + } + const std::string& get_tracing_category() const { return tracing_category_; } + + AnyActivity* start() + { + Activity::start(); + return static_cast(this); + } + + AnyActivity* cancel() { return static_cast(Activity::cancel()); } + AnyActivity* wait() { return wait_for(-1.0); } + virtual AnyActivity* wait_for(double timeout) { + return static_cast(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 + * add_ref to the Activity class. Hopefully, the "inline" helps to not hinder the perf here. + */ + friend void inline intrusive_ptr_release(AnyActivity* a) { intrusive_ptr_release(static_cast(a)); } + friend void inline intrusive_ptr_add_ref(AnyActivity* a) { intrusive_ptr_add_ref(static_cast(a)); } +#endif +}; -}}; // Namespace simgrid::s4u +} // namespace s4u +} // namespace simgrid #endif /* SIMGRID_S4U_ACTIVITY_HPP */