X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/7e9f2171250125a29ef5cedc0fd69328cb819f91..242530a43236d91a6522c6f3768776aca9f04508:/include/simgrid/s4u/Activity.hpp?ds=sidebyside diff --git a/include/simgrid/s4u/Activity.hpp b/include/simgrid/s4u/Activity.hpp index 3a374a40ca..0680700c84 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,9 +6,16 @@ #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 { @@ -16,57 +23,53 @@ 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 simgrid::s4u::Comm; + friend Comm; friend XBT_PUBLIC void intrusive_ptr_release(Comm * c); friend XBT_PUBLIC void intrusive_ptr_add_ref(Comm * c); - friend simgrid::s4u::Exec; + + 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 simgrid::s4u::Io; + + 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; - public: #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, ERRORED, 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 */ virtual Activity* wait() = 0; /** Blocks until the activity is terminated, or until the timeout is elapsed * Raises: timeout exception.*/ - virtual Activity* wait(double timeout) = 0; + virtual Activity* wait_for(double timeout) = 0; + /** Blocks until the activity is terminated, or until the time limit is reached + * 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_; } - /** Returns whether this activity is completed */ + 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; /** Get the remaining amount of work that this Activity entails. When it's 0, it's done. */ @@ -77,41 +80,101 @@ public: * 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(); } + +private: + kernel::activity::ActivityImplPtr pimpl_ = nullptr; + Activity::State state_ = Activity::State::INITED; + double remains_ = 0; +}; + +template class Activity_T : public Activity { +private: + std::string name_ = "unnamed"; + 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) { - user_data_ = data; - return this; + if (a->refcount_.fetch_sub(1, std::memory_order_release) == 1) { + std::atomic_thread_fence(std::memory_order_acquire); + delete a; + } } - /** Retrieve the user data of the Activity */ - void* get_user_data() { return user_data_; } + friend void intrusive_ptr_add_ref(AnyActivity* a) { a->refcount_.fetch_add(1, std::memory_order_relaxed); } +#endif -#ifndef DOXYGEN - /** @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 add_successor(Activity* a) { - return set_remaining(remains); + successors_.push_back(a); + static_cast(a)->add_dependency_on(static_cast(this)); } - /** @deprecated See Activity::set_user_data() */ - XBT_ATTRIB_DEPRECATED_v323("Please use Activity::set_user_data()") Activity* setUserData(void* data) + void remove_successor() { successors_.pop_back(); } + Activity* get_successor() { return successors_.back(); } + bool has_successors() { return not successors_.empty(); } + + void add_dependency_on(Activity* a) { dependencies_.insert({a}); } + void remove_dependency_on(Activity* a) { dependencies_.erase(a); } + bool has_dependencies() { return not dependencies_.empty(); } + void release_dependencies() { - return set_user_data(data); + while (has_successors()) { + AnyActivity* b = static_cast(get_successor()); + XBT_CDEBUG(s4u_activity, "Remove a dependency from '%s' on '%s'", static_cast(this)->get_cname(), + b->get_cname()); + b->remove_dependency_on(static_cast(this)); + if (not b->has_dependencies()) { + b->vetoable_start(); + } + remove_successor(); + } } - /** @deprecated See Activity::get_user_data() */ - XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_user_data()") void* getUserData() { return user_data_; } -#endif -private: - simgrid::kernel::activity::ActivityImplPtr pimpl_ = nullptr; - Activity::State state_ = Activity::State::INITED; - double remains_ = 0; - void* user_data_ = nullptr; -}; // class + AnyActivity* vetoable_start() + { + set_state(State::STARTING); + if (has_dependencies()) + return static_cast(this); + set_state(State::STARTED); + XBT_CDEBUG(s4u_activity, "All dependencies are solved, let's start '%s'", + static_cast(this)->get_cname()); + static_cast(this)->start(); + return static_cast(this); + } + + 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); + } + const std::string& get_name() { return name_; } + const char* get_cname() { return name_.c_str(); } + + 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() { return tracing_category_; } + + AnyActivity* set_user_data(void* data) + { + user_data_ = data; + return static_cast(this); + } + + void* get_user_data() { return user_data_; } +}; -}}; // Namespace simgrid::s4u +} // namespace s4u +} // namespace simgrid #endif /* SIMGRID_S4U_ACTIVITY_HPP */