X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/7a3a100990355eb757dc81106b5aac6daed0b8e1..36fccba5f4f2b4c32e97c4e56911eb5bd804f7c9:/include/simgrid/s4u/Activity.hpp diff --git a/include/simgrid/s4u/Activity.hpp b/include/simgrid/s4u/Activity.hpp index b5ef0b4cd7..3e31a941ff 100644 --- a/include/simgrid/s4u/Activity.hpp +++ b/include/simgrid/s4u/Activity.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2021. 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,74 +6,235 @@ #ifndef SIMGRID_S4U_ACTIVITY_HPP #define SIMGRID_S4U_ACTIVITY_HPP -#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 { 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. */ class XBT_PUBLIC Activity { friend Comm; - friend XBT_PUBLIC void intrusive_ptr_release(Comm * c); - friend XBT_PUBLIC void intrusive_ptr_add_ref(Comm * c); friend Exec; - friend XBT_PUBLIC void intrusive_ptr_release(Exec * e); - friend XBT_PUBLIC void intrusive_ptr_add_ref(Exec * e); + friend Io; + +public: + // enum class State { ... } + XBT_DECLARE_ENUM_CLASS(State, INITED, STARTING, STARTED, CANCELED, FINISHED); protected: Activity() = default; virtual ~Activity() = default; + virtual bool is_assigned() const = 0; + + virtual void complete(Activity::State state) + { + state_ = state; + if (state == State::FINISHED) + release_dependencies(); + } + + 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_.empty()) { + b->vetoable_start(); + } + successors_.pop_back(); + } + } + + void add_successor(ActivityPtr a) + { + if(this == a) + throw std::invalid_argument("Cannot be its own successor"); + 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 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 its from successors"); + + auto p = std::find_if(successors_.begin(), successors_.end(), [a](ActivityPtr const& i){ return i.get() == a.get(); }); + if (p != successors_.end()){ + successors_.erase(p); + a->dependencies_.erase({this}); + } else + throw std::invalid_argument("Dependency does not exist. Can not be removed."); + } + public: + void vetoable_start() + { + state_ = State::STARTING; + if (dependencies_.empty() && is_assigned()) { + XBT_CVERB(s4u_activity, "'%s' is assigned to a resource and all dependencies are solved. Let's start", get_cname()); + start(); + } + } + +#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 Activity* 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 Activity* wait() = 0; - /** Blocks until the activity is terminated, or until the timeout is elapsed + /** 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 Activity* 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); + /** 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; } + /** Tests whether the given activity is terminated yet. */ + virtual bool test(); + + /** 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. */ - virtual double getRemains(); + virtual double get_remaining() const; /** 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* setRemains(double remains); + Activity* set_remaining(double remains); + + /** Returns the internal implementation of this Activity */ + kernel::activity::ActivityImpl* get_impl() const { return pimpl_.get(); } - /** Put some user data onto the Activity */ - Activity* setUserData(void* data) +#ifndef DOXYGEN + friend void intrusive_ptr_release(Activity* a) { - userData_ = data; + 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; } - /** Retrieve the user data of the Activity */ - void *getUserData() { return userData_; } + 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; + 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_ = ""; + void* user_data_ = nullptr; + +public: + 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(const std::string& name) + { + xbt_assert(get_state() == State::INITED, "Cannot change the name of an activity after its start"); + 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(const std::string& category) + { + xbt_assert(get_state() == State::INITED, "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* set_user_data(void* data) + { + user_data_ = data; + return static_cast(this); + } + + void* get_user_data() const { return user_data_; } + + AnyActivity* vetoable_start() + { + Activity::vetoable_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 */