X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/67d66b0cf79b9fc02c0450f254584693dbf21d3b..c6d6e5b87aed9c7080c981b11f91f2d0205623c3:/include/simgrid/s4u/Activity.hpp diff --git a/include/simgrid/s4u/Activity.hpp b/include/simgrid/s4u/Activity.hpp index 32357759ac..cbedfaaaf4 100644 --- a/include/simgrid/s4u/Activity.hpp +++ b/include/simgrid/s4u/Activity.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2021. 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. */ @@ -32,12 +32,14 @@ namespace s4u { * That is, activities are all the things that do take time to the actor in the simulated world. */ class XBT_PUBLIC Activity : public xbt::Extendable { +#ifndef DOXYGEN friend Comm; friend Exec; friend Io; -#ifndef DOXYGEN + 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: @@ -45,10 +47,11 @@ public: 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(); } + 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_; } + virtual void fire_this_completion() const = 0; protected: Activity() = default; @@ -62,7 +65,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(); } @@ -95,23 +98,35 @@ protected: 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); + private: static xbt::signal on_veto; - static xbt::signal on_completion; + static xbt::signal on_suspended; + static xbt::signal on_resumed; 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 theactivity 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() + XBT_ATTRIB_DEPRECATED_v334("All start() are vetoable now. Please use start() ") void vetoable_start() + { + 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); @@ -121,8 +136,11 @@ public: 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_this_completion(); if (state == State::FINISHED) release_dependencies(); } @@ -139,7 +157,12 @@ 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); } /** Blocks the current actor until the activity is terminated, or until the timeout is elapsed\n @@ -148,6 +171,11 @@ 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(); @@ -156,8 +184,6 @@ public: /** 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(); @@ -171,10 +197,6 @@ public: /** 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 */ - Activity* set_remaining(double remains); double get_start_time() const; double get_finish_time() const; @@ -215,9 +237,12 @@ private: template class Activity_T : public Activity { std::string name_ = "unnamed"; std::string tracing_category_ = ""; - void* user_data_ = nullptr; public: + static xbt::signal on_completion; + /*! 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); } + AnyActivity* add_successor(ActivityPtr a) { Activity::add_successor(a); @@ -230,7 +255,6 @@ public: } 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); } @@ -239,29 +263,38 @@ public: 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"); + 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* set_user_data(void* data) + XBT_ATTRIB_DEPRECATED_v334("Please use Activity::set_data()") AnyActivity* set_user_data(void* data) { - user_data_ = data; + set_data(data); return static_cast(this); } - void* get_user_data() const { return user_data_; } - - AnyActivity* vetoable_start() + XBT_ATTRIB_DEPRECATED_v334("Please use Activity::get_data<>()") void* get_user_data() const + { + return get_data(); + } + XBT_ATTRIB_DEPRECATED_v334("All start() are vetoable now. Please use start() ") AnyActivity* vetoable_start() { - Activity::vetoable_start(); + return start(); + } + 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)); } + 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