X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/31880ce2d4d55bc634cc528493454670a998e5bd..e709643ef0c5b61c6c878016c418bffa2b1b20cd:/include/simgrid/s4u/Activity.hpp diff --git a/include/simgrid/s4u/Activity.hpp b/include/simgrid/s4u/Activity.hpp index a407160e06..fbf8993242 100644 --- a/include/simgrid/s4u/Activity.hpp +++ b/include/simgrid/s4u/Activity.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2019. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2020. 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. */ @@ -7,7 +7,6 @@ #define SIMGRID_S4U_ACTIVITY_HPP #include "xbt/asserts.h" -#include "xbt/log.h" #include #include #include @@ -15,6 +14,8 @@ #include #include +XBT_LOG_EXTERNAL_CATEGORY(s4u_activity); + namespace simgrid { namespace s4u { @@ -25,55 +26,83 @@ namespace s4u { */ 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 ExecSeq; - friend ExecPar; - friend XBT_PUBLIC void intrusive_ptr_release(Exec * e); - friend XBT_PUBLIC void intrusive_ptr_add_ref(Exec * e); - friend Io; - friend XBT_PUBLIC void intrusive_ptr_release(Io* i); - friend XBT_PUBLIC void intrusive_ptr_add_ref(Io* i); protected: Activity() = default; virtual ~Activity() = default; + + 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) + { + successors_.push_back(a); + a->dependencies_.insert({this}); + } + public: + void vetoable_start() + { + state_ = State::STARTING; + if (dependencies_.empty()) { + XBT_CVERB(s4u_activity, "All dependencies are solved, let's start '%s'", get_cname()); + start(); + } + } + #ifndef DOXYGEN Activity(Activity const&) = delete; Activity& operator=(Activity const&) = delete; #endif - enum class State { INITED = 0, STARTING, STARTED, CANCELED, ERRORED, FINISHED }; + enum class State { INITED = 0, 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 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 */ + virtual Activity* wait() = 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; - /** Blocks until the activity is terminated, or until the time limit is reached + /** 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; /** Retrieve the current state of the activity */ - Activity::State get_state() { return state_; } + Activity::State get_state() const { return state_; } void set_state(Activity::State state) { state_ = state; } - /** Tests whether the given activity is terminated yet. This is a pure function. */ - virtual bool test() = 0; + /** Tests whether the given activity is terminated yet. */ + virtual bool test(); - /** Get the remaining amount of work that this Activity entails. When it's 0, it's done. */ - virtual double get_remaining(); + /** 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 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 */ @@ -82,91 +111,42 @@ public: /** Returns the internal implementation of this Activity */ kernel::activity::ActivityImpl* get_impl() const { return pimpl_.get(); } -private: - kernel::activity::ActivityImplPtr pimpl_ = nullptr; - Activity::State state_ = Activity::State::INITED; - double remains_ = 0; -}; - -// template class DependencyGuard { -// public: -// static bool activity_start_vetoer(AnyActivity* a) { return not a->has_dependencies(); } -// static void on_activity_done(AnyActivity* a); -//// { -//// while (a->has_successors()) { -//// AnyActivity* b = a->get_successor(); -//// b->remove_dependency_on(a); -//// if (not b->has_dependencies()) { -//// XBT_INFO("Activity is done and a successor can start"); -//// b->vetoable_start(); -//// } -//// a->remove_successor(); -//// } -//// } -//}; - -template class Activity_T : public Activity { -private: - std::string name_ = ""; - std::string tracing_category_ = ""; - void* user_data_ = nullptr; - std::atomic_int_fast32_t refcount_{0}; - std::vector successors_; - std::set dependencies_; - -public: #ifndef DOXYGEN - friend void intrusive_ptr_release(AnyActivity* a) + 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(AnyActivity* a) { a->refcount_.fetch_add(1, std::memory_order_relaxed); } + friend void intrusive_ptr_add_ref(Activity* a) { a->refcount_.fetch_add(1, std::memory_order_relaxed); } #endif - - void add_successor(AnyActivity* a) + Activity* add_ref() { - // XBT_INFO("Adding %s as a successor of %s", get_name(), a->get_name()); - successors_.push_back(a); - a->add_dependency_on(static_cast(this)); - } - void remove_successor() { successors_.pop_back(); } - AnyActivity* get_successor() { return successors_.back(); } - bool has_successors() { return not successors_.empty(); } - - void add_dependency_on(AnyActivity* a) { dependencies_.insert({a}); } - void remove_dependency_on(AnyActivity* a) { dependencies_.erase(a); } - bool has_dependencies() { return not dependencies_.empty(); } - void on_activity_done() - { - while (has_successors()) { - AnyActivity* b = get_successor(); - b->remove_dependency_on(static_cast(this)); - if (not b->has_dependencies()) { - // XBT_INFO("Activity is done and a successor can start"); - b->vetoable_start(); - } - remove_successor(); - } + intrusive_ptr_add_ref(this); + return this; } + void unref() { intrusive_ptr_release(this); } - AnyActivity* vetoable_start() - { - set_state(State::STARTING); - if (has_dependencies()) - return static_cast(this); - // XBT_INFO("No veto, Activity can start"); - set_state(State::STARTED); - static_cast(this)->start(); - return static_cast(this); - } +private: + 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; - virtual AnyActivity* wait() +public: + AnyActivity* add_successor(ActivityPtr a) { - static_cast(this)->wait(); - on_activity_done(); + Activity::add_successor(a); return static_cast(this); } @@ -176,8 +156,8 @@ public: name_ = name; return static_cast(this); } - const std::string& get_name() { return name_; } - const char* get_cname() { return name_.c_str(); } + 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) { @@ -185,7 +165,7 @@ public: tracing_category_ = category; return static_cast(this); } - const std::string& get_tracing_category() { return tracing_category_; } + const std::string& get_tracing_category() const { return tracing_category_; } AnyActivity* set_user_data(void* data) { @@ -193,7 +173,15 @@ public: return static_cast(this); } - void* get_user_data() { return user_data_; } + void* get_user_data() const { return user_data_; } +#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 s4u