include/simgrid/s4u/Activity.hpp

   1 /* Copyright (c) 2006-2020. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SIMGRID_S4U_ACTIVITY_HPP
   7 #define SIMGRID_S4U_ACTIVITY_HPP
   8
   9 #include "xbt/asserts.h"
  10 #include <atomic>
  11 #include <set>
  12 #include <simgrid/forward.h>
  13 #include <string>
  14 #include <vector>
  15 #include <xbt/signal.hpp>
  16
  17 XBT_LOG_EXTERNAL_CATEGORY(s4u_activity);
  18
  19 namespace simgrid {
  20 namespace s4u {
  21
  22 /** @brief Activities
  23  *
  24  * This class is the ancestor of every activities that an actor can undertake.
  25  * That is, activities are all the things that do take time to the actor in the simulated world.
  26  */
  27 class XBT_PUBLIC Activity {
  28   friend Comm;
  29   friend Exec;
  30   friend ExecSeq;
  31   friend ExecPar;
  32   friend Io;
  33
  34 protected:
  35   Activity()  = default;
  36   virtual ~Activity() = default;
  37 public:
  38 #ifndef DOXYGEN
  39   Activity(Activity const&) = delete;
  40   Activity& operator=(Activity const&) = delete;
  41 #endif
  42
  43   enum class State { INITED = 0, STARTING, STARTED, CANCELED, ERRORED, FINISHED };
  44
  45   /** Starts a previously created activity.
  46    *
  47    * This function is optional: you can call wait() even if you didn't call start()
  48    */
  49   virtual Activity* start() = 0;
  50   /** Blocks until the activity is terminated */
  51   virtual Activity* wait() = 0;
  52   /** Blocks until the activity is terminated, or until the timeout is elapsed
  53    *  Raises: timeout exception.*/
  54   virtual Activity* wait_for(double timeout) = 0;
  55   /** Blocks until the activity is terminated, or until the time limit is reached
  56    * Raises: timeout exception. */
  57   void wait_until(double time_limit);
  58
  59   /** Cancel that activity */
  60   virtual Activity* cancel() = 0;
  61   /** Retrieve the current state of the activity */
  62   Activity::State get_state() { return state_; }
  63   void set_state(Activity::State state) { state_ = state; }
  64   /** Tests whether the given activity is terminated yet. This is a pure function. */
  65   virtual bool test() = 0;
  66   virtual const char* get_cname()       = 0;
  67   virtual const std::string& get_name() = 0;
  68
  69   /** Get the remaining amount of work that this Activity entails. When it's 0, it's done. */
  70   virtual double get_remaining();
  71   /** Set the [remaining] amount of work that this Activity will entail
  72    *
  73    * It is forbidden to change the amount of work once the Activity is started */
  74   Activity* set_remaining(double remains);
  75
  76   /** Returns the internal implementation of this Activity */
  77   kernel::activity::ActivityImpl* get_impl() const { return pimpl_.get(); }
  78
  79   void add_successor(ActivityPtr a)
  80   {
  81     successors_.push_back(a);
  82     a->add_dependency_on(this);
  83   }
  84   void remove_successor() { successors_.pop_back(); }
  85   ActivityPtr get_successor() { return successors_.back(); }
  86   bool has_successors() { return not successors_.empty(); }
  87
  88   void add_dependency_on(ActivityPtr a) { dependencies_.insert({a}); }
  89   void remove_dependency_on(ActivityPtr a) { dependencies_.erase(a); }
  90   bool has_dependencies() { return not dependencies_.empty(); }
  91   void release_dependencies()
  92   {
  93     while (has_successors()) {
  94       ActivityPtr b = get_successor();
  95       XBT_CDEBUG(s4u_activity, "Remove a dependency from '%s' on '%s'", get_cname(), b->get_cname());
  96       b->remove_dependency_on(this);
  97       if (not b->has_dependencies()) {
  98         b->vetoable_start();
  99       }
 100       remove_successor();
 101     }
 102   }
 103
 104   void vetoable_start()
 105   {
 106     state_ = State::STARTING;
 107     if (not has_dependencies()) {
 108       XBT_CDEBUG(s4u_activity, "All dependencies are solved, let's start '%s'", get_cname());
 109       start();
 110     }
 111   }
 112
 113 #ifndef DOXYGEN
 114   friend void intrusive_ptr_release(Activity* a)
 115   {
 116     if (a->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
 117       std::atomic_thread_fence(std::memory_order_acquire);
 118       delete a;
 119     }
 120   }
 121   friend void intrusive_ptr_add_ref(Activity* a) { a->refcount_.fetch_add(1, std::memory_order_relaxed); }
 122 #endif
 123 private:
 124   kernel::activity::ActivityImplPtr pimpl_ = nullptr;
 125   Activity::State state_                   = Activity::State::INITED;
 126   double remains_                          = 0;
 127   std::vector<ActivityPtr> successors_;
 128   std::set<ActivityPtr> dependencies_;
 129   std::atomic_int_fast32_t refcount_{0};
 130 };
 131
 132 template <class AnyActivity> class Activity_T : public Activity {
 133   std::string name_             = "unnamed";
 134   std::string tracing_category_ = "";
 135   void* user_data_              = nullptr;
 136
 137 public:
 138   AnyActivity* set_name(const std::string& name)
 139   {
 140     xbt_assert(get_state() == State::INITED, "Cannot change the name of an activity after its start");
 141     name_ = name;
 142     return static_cast<AnyActivity*>(this);
 143   }
 144   const std::string& get_name() { return name_; }
 145   const char* get_cname() { return name_.c_str(); }
 146
 147   AnyActivity* set_tracing_category(const std::string& category)
 148   {
 149     xbt_assert(get_state() == State::INITED, "Cannot change the tracing category of an activity after its start");
 150     tracing_category_ = category;
 151     return static_cast<AnyActivity*>(this);
 152   }
 153   const std::string& get_tracing_category() { return tracing_category_; }
 154
 155   AnyActivity* set_user_data(void* data)
 156   {
 157     user_data_ = data;
 158     return static_cast<AnyActivity*>(this);
 159   }
 160
 161   void* get_user_data() { return user_data_; }
 162 #ifndef DOXYGEN
 163   /* The refcounting is done in the ancestor class, Activity, but we want each of the classes benefiting of the CRTP
 164    * (Exec, Comm, etc) to have smart pointers too, so we define these methods here, that forward the ptr_release and
 165    * add_ref to the Activity class. Hopefully, the "inline" helps to not hinder the perf here.
 166    */
 167   friend void inline intrusive_ptr_release(AnyActivity* a) { intrusive_ptr_release(static_cast<Activity*>(a)); }
 168   friend void inline intrusive_ptr_add_ref(AnyActivity* a) { intrusive_ptr_add_ref(static_cast<Activity*>(a)); }
 169 #endif
 170 };
 171
 172 } // namespace s4u
 173 } // namespace simgrid
 174
 175 #endif /* SIMGRID_S4U_ACTIVITY_HPP */