X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/e9a86ac48ea8d06ddebe18744c40548a9f65956f..46a0ec43a87c2bc479801571da647e2cdd922cbe:/include/simgrid/s4u/Activity.hpp diff --git a/include/simgrid/s4u/Activity.hpp b/include/simgrid/s4u/Activity.hpp index 7e53d03c78..fbf8993242 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-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. */ @@ -6,7 +6,15 @@ #ifndef SIMGRID_S4U_ACTIVITY_HPP #define SIMGRID_S4U_ACTIVITY_HPP +#include "xbt/asserts.h" +#include +#include #include +#include +#include +#include + +XBT_LOG_EXTERNAL_CATEGORY(s4u_activity); namespace simgrid { namespace s4u { @@ -15,93 +23,168 @@ 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. - * - * They are somewhat linked but not identical to simgrid::kernel::resource::Action, - * that are stuff occurring on a resource: - * - * - A sequential execution activity encompasses 2 actions: one for the exec itself, - * and a time-limited sleep used as timeout detector. - * - A point-to-point communication activity encompasses 3 actions: one for the comm itself - * (which spans on all links of the path), and one infinite sleep used as failure detector - * on both sender and receiver hosts. - * - Synchronization activities may possibly be connected to no action. */ 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; 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, 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; - /** Tests whether the given activity is terminated yet. This is a pure function. */ - //virtual bool test()=0; - /** Blocks until the activity is terminated */ + /** Blocks the current actor 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, or until the timeout is elapsed\n * Raises: timeout exception.*/ - virtual Activity* wait(double timeout) = 0; + virtual Activity* wait_for(double timeout) = 0; + /** 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. */ + 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 */ Activity* set_remaining(double remains); - /** Put some user data onto the Activity */ - Activity* set_user_data(void* data) + /** Returns the internal implementation of this Activity */ + kernel::activity::ActivityImpl* get_impl() const { return pimpl_.get(); } + +#ifndef DOXYGEN + friend void intrusive_ptr_release(Activity* a) { - user_data_ = 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* get_user_data() { return user_data_; } - - /** @deprecated See Activity::get_state()*/ - XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_state()") Activity::State getState() { return state_; } - /** @deprecated See Activity::get_remaining() */ - XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_remaining()") double getRemains() { return get_remaining(); } - /** @deprecated See Activity::set_remaining() */ - XBT_ATTRIB_DEPRECATED_v323("Please use Activity::set_remaining()") Activity* setRemains(double remains) + void unref() { intrusive_ptr_release(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; + +public: + AnyActivity* add_successor(ActivityPtr a) { - return set_remaining(remains); + Activity::add_successor(a); + return static_cast(this); } - /** @deprecated See Activity::set_user_data() */ - XBT_ATTRIB_DEPRECATED_v323("Please use Activity::set_user_data()") Activity* setUserData(void* data) + + AnyActivity* set_name(const std::string& name) { - return set_user_data(data); + xbt_assert(get_state() == State::INITED, "Cannot change the name of an activity after its start"); + name_ = name; + return static_cast(this); } - /** @deprecated See Activity::get_user_data() */ - XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_user_data()") void* getUserData() { return user_data_; } + const std::string& get_name() const override { return name_; } + const char* get_cname() const override { return name_.c_str(); } -private: - simgrid::kernel::activity::ActivityImplPtr pimpl_ = nullptr; - Activity::State state_ = Activity::State::INITED; - double remains_ = 0; - void* user_data_ = nullptr; -}; // class + 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_; } +#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 */