X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/48296e83ce3ba1fa3658a3a74d10a536e33b3849..HEAD:/include/simgrid/s4u/Activity.hpp diff --git a/include/simgrid/s4u/Activity.hpp b/include/simgrid/s4u/Activity.hpp index d5d555aa4f..8b9f48508d 100644 --- a/include/simgrid/s4u/Activity.hpp +++ b/include/simgrid/s4u/Activity.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2022. 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. */ @@ -12,6 +12,7 @@ #include #include #include +#include #include #include #include @@ -33,12 +34,15 @@ namespace s4u { */ class XBT_PUBLIC Activity : public xbt::Extendable { #ifndef DOXYGEN + friend ActivitySet; friend Comm; friend Exec; friend Io; + friend Mess; 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: @@ -63,7 +67,7 @@ protected: 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->vetoable_start(); + b->start(); } successors_.pop_back(); } @@ -73,8 +77,8 @@ protected: { 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()) + + 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); @@ -86,12 +90,13 @@ protected: 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()){ - successors_.erase(p); - a->dependencies_.erase({this}); - } else + 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_; @@ -101,40 +106,40 @@ protected: * It is forbidden to change the amount of work once the Activity is started */ Activity* set_remaining(double remains); -private: - static xbt::signal on_veto; - static xbt::signal on_completion; - static xbt::signal on_suspended; - static xbt::signal on_resumed; + virtual void fire_on_start() const = 0; + virtual void fire_on_this_start() const = 0; + 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() = 0; + virtual void fire_on_this_veto() = 0; 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& cb) { on_veto.connect(cb); } - /*! Add a callback fired when the 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 the activity is suspended */ - static void on_suspended_cb(const std::function& cb) { on_suspended.connect(cb); } - /*! Add a callback fired when the activity is resumed after being suspended */ - static void on_resumed_cb(const std::function& cb) { on_resumed.connect(cb); } - - void vetoable_start() + 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()); - start(); + do_start(); } else { if (vetoed_activities_ != nullptr) vetoed_activities_->insert(this); - on_veto(*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; - on_completion(*this); + fire_on_completion(); + fire_on_this_completion(); if (state == State::FINISHED) release_dependencies(); } @@ -151,11 +156,9 @@ public: * * This function is optional: you can call wait() even if you didn't call start() */ - virtual Activity* start() = 0; + 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); } @@ -165,11 +168,6 @@ public: /** 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 */ Activity* cancel(); @@ -201,6 +199,9 @@ public: kernel::activity::ActivityImpl* get_impl() const { return pimpl_.get(); } #ifndef DOXYGEN + static ssize_t deprecated_wait_any_for(const std::vector& activities, double timeout); // XBT_ATTRIB_DEPRECATED_v339 + XBT_ATTRIB_DEPRECATED_v339("Please use ActivitySet instead") static ssize_t test_any(const std::vector& activities); + friend void intrusive_ptr_release(Activity* a) { if (a->refcount_.fetch_sub(1, std::memory_order_release) == 1) { @@ -232,7 +233,61 @@ template class Activity_T : public Activity { std::string name_ = "unnamed"; std::string tracing_category_ = ""; + inline static xbt::signal on_start; + xbt::signal on_this_start; + 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; + +protected: + void fire_on_start() const override { on_start(static_cast(*this)); } + void fire_on_this_start() const override { on_this_start(static_cast(*this)); } + void fire_on_completion() const override { on_completion(static_cast(*this)); } + void fire_on_this_completion() const override { on_this_completion(static_cast(*this)); } + void fire_on_suspend() const override { on_suspend(static_cast(*this)); } + void fire_on_this_suspend() const override { on_this_suspend(static_cast(*this)); } + void fire_on_resume() const override { on_resume(static_cast(*this)); } + void fire_on_this_resume() const override { on_this_resume(static_cast(*this)); } + void fire_on_veto() override { on_veto(static_cast(*this)); } + void fire_on_this_veto() override { on_this_veto(static_cast(*this)); } + public: + /*! \static Add a callback fired when any activity starts (no veto) */ + static void on_start_cb(const std::function& cb) { on_start.connect(cb); } + /*! Add a callback fired when this specific activity starts (no veto) */ + void on_this_start_cb(const std::function& cb) { on_this_start.connect(cb); } + /*! \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); } + +#ifndef DOXYGEN + 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); } + + XBT_ATTRIB_DEPRECATED_v339("Please use ActivitySet instead") static ssize_t wait_any(const std::vector& activities) { return deprecated_wait_any_for(activities, -1); } + XBT_ATTRIB_DEPRECATED_v339("Please use ActivitySet instead") static ssize_t wait_any_for(const std::vector& activities, double timeout) { return deprecated_wait_any_for(activities, timeout); } +#endif + AnyActivity* add_successor(ActivityPtr a) { Activity::add_successor(a); @@ -243,7 +298,7 @@ public: Activity::remove_successor(a); return static_cast(this); } - AnyActivity* set_name(const std::string& name) + AnyActivity* set_name(std::string_view name) { name_ = name; return static_cast(this); @@ -251,34 +306,26 @@ public: 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) + AnyActivity* set_tracing_category(std::string_view category) { - xbt_assert(get_state() == State::INITED, "Cannot change the tracing category of an activity after its start"); + 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_; } - XBT_ATTRIB_DEPRECATED_v334("Please use Activity::set_data()") AnyActivity* set_user_data(void* data) - { - set_data(data); - return static_cast(this); - } - - XBT_ATTRIB_DEPRECATED_v334("Please use Activity::get_data<>()") void* get_user_data() const + AnyActivity* start() { - return get_data(); - } - - AnyActivity* vetoable_start() - { - Activity::vetoable_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)); } + 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