X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/de5a447f3119a2a684e540f61aecac5d9036b072..d15bf067af0638a80644b1e8fe77fac3eae69982:/include/simgrid/s4u/Activity.hpp diff --git a/include/simgrid/s4u/Activity.hpp b/include/simgrid/s4u/Activity.hpp index 0e165e7187..d1d8ab4e1f 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-2022. 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,7 +6,6 @@ #ifndef SIMGRID_S4U_ACTIVITY_HPP #define SIMGRID_S4U_ACTIVITY_HPP -#include #include #include #include @@ -14,12 +13,17 @@ #include #include #include +#include +#include #include #include XBT_LOG_EXTERNAL_CATEGORY(s4u_activity); namespace simgrid { + +extern template class XBT_PUBLIC xbt::Extendable; + namespace s4u { /** @brief Activities @@ -27,27 +31,29 @@ namespace s4u { * 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 { +class XBT_PUBLIC Activity : public xbt::Extendable { friend Comm; friend Exec; friend Io; +#ifndef DOXYGEN + friend std::vector create_DAG_from_dot(const std::string& filename); + friend std::vector create_DAG_from_DAX(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; - - virtual bool is_assigned() const = 0; - virtual bool dependencies_solved() { return dependencies_.empty(); } - virtual void complete(Activity::State state) - { - state_ = state; - if (state == State::FINISHED) - release_dependencies(); - } + void destroy(); void release_dependencies() { @@ -77,7 +83,7 @@ protected: void remove_successor(ActivityPtr a) { if(this == a) - throw std::invalid_argument("Cannot ask to remove its from successors"); + 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()){ @@ -87,16 +93,43 @@ protected: throw std::invalid_argument("Dependency does not exist. Can not be removed."); } + static std::set* vetoed_activities_; + +private: + static xbt::signal on_veto; + static xbt::signal on_completion; + 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); } + void vetoable_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(); + } else { + if (vetoed_activities_ != nullptr) + vetoed_activities_->insert(this); + on_veto(*this); } } + void complete(Activity::State state) + { + state_ = state; + on_completion(*this); + 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; @@ -107,6 +140,11 @@ public: * 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. */ + 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 @@ -115,6 +153,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(); @@ -123,8 +166,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(); @@ -143,6 +184,11 @@ public: * 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; + 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(); } @@ -168,6 +214,7 @@ private: 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}; @@ -176,7 +223,6 @@ private: template class Activity_T : public Activity { std::string name_ = "unnamed"; std::string tracing_category_ = ""; - void* user_data_ = nullptr; public: AnyActivity* add_successor(ActivityPtr a) @@ -191,7 +237,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); } @@ -206,13 +251,16 @@ public: } 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_; } + XBT_ATTRIB_DEPRECATED_v334("Please use Activity::get_data<>()") void* get_user_data() const + { + return get_data(); + } AnyActivity* vetoable_start() {