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
  38   void release_dependencies()
  39   {
  40     while (not successors_.empty()) {
  41       ActivityPtr b = successors_.back();
  42       XBT_CDEBUG(s4u_activity, "Remove a dependency from '%s' on '%s'", get_cname(), b->get_cname());
  43       b->dependencies_.erase(this);
  44       if (b->dependencies_.empty()) {
  45         b->vetoable_start();
  46       }
  47       successors_.pop_back();
  48     }
  49   }
  50
  51   void add_successor(ActivityPtr a)
  52   {
  53     successors_.push_back(a);
  54     a->dependencies_.insert({this});
  55   }
  56
  57 public:
  58   void vetoable_start()
  59   {
  60     state_ = State::STARTING;
  61     if (dependencies_.empty()) {
  62       XBT_CDEBUG(s4u_activity, "All dependencies are solved, let's start '%s'", get_cname());
  63       start();
  64     }
  65   }
  66
  67 #ifndef DOXYGEN
  68   Activity(Activity const&) = delete;
  69   Activity& operator=(Activity const&) = delete;
  70 #endif
  71
  72   enum class State { INITED = 0, STARTING, STARTED, CANCELED,
  73       // ERRORED, // FIXME: state has never been used
  74       FINISHED };
  75
  76   /** Starts a previously created activity.
  77    *
  78    * This function is optional: you can call wait() even if you didn't call start()
  79    */
  80   virtual Activity* start() = 0;
  81   /** Blocks until the activity is terminated */
  82   virtual Activity* wait() = 0;
  83   /** Blocks until the activity is terminated, or until the timeout is elapsed
  84    *  Raises: timeout exception.*/
  85   virtual Activity* wait_for(double timeout) = 0;
  86   /** Blocks until the activity is terminated, or until the time limit is reached
  87    * Raises: timeout exception. */
  88   void wait_until(double time_limit);
  89
  90   /** Cancel that activity */
  91   virtual Activity* cancel() = 0;
  92   /** Retrieve the current state of the activity */
  93   Activity::State get_state() const { return state_; }
  94   void set_state(Activity::State state) { state_ = state; }
  95   /** Tests whether the given activity is terminated yet. */
  96   virtual bool test();
  97
  98   virtual const char* get_cname() const       = 0;
  99   virtual const std::string& get_name() const = 0;
 100
 101   /** Get the remaining amount of work that this Activity entails. When it's 0, it's done. */
 102   virtual double get_remaining() const;
 103   /** Set the [remaining] amount of work that this Activity will entail
 104    *
 105    * It is forbidden to change the amount of work once the Activity is started */
 106   Activity* set_remaining(double remains);
 107
 108   /** Returns the internal implementation of this Activity */
 109   kernel::activity::ActivityImpl* get_impl() const { return pimpl_.get(); }
 110
 111 #ifndef DOXYGEN
 112   friend void intrusive_ptr_release(Activity* a)
 113   {
 114     if (a->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
 115       std::atomic_thread_fence(std::memory_order_acquire);
 116       delete a;
 117     }
 118   }
 119   friend void intrusive_ptr_add_ref(Activity* a) { a->refcount_.fetch_add(1, std::memory_order_relaxed); }
 120 #endif
 121   Activity* add_ref()
 122   {
 123     intrusive_ptr_add_ref(this);
 124     return this;
 125   }
 126   void unref() { intrusive_ptr_release(this); }
 127
 128 private:
 129   kernel::activity::ActivityImplPtr pimpl_ = nullptr;
 130   Activity::State state_                   = Activity::State::INITED;
 131   double remains_                          = 0;
 132   std::vector<ActivityPtr> successors_;
 133   std::set<ActivityPtr> dependencies_;
 134   std::atomic_int_fast32_t refcount_{0};
 135 };
 136
 137 template <class AnyActivity> class Activity_T : public Activity {
 138   std::string name_             = "unnamed";
 139   std::string tracing_category_ = "";
 140   void* user_data_              = nullptr;
 141
 142 public:
 143   AnyActivity* add_successor(ActivityPtr a)
 144   {
 145     Activity::add_successor(a);
 146     return static_cast<AnyActivity*>(this);
 147   }
 148
 149   AnyActivity* set_name(const std::string& name)
 150   {
 151     xbt_assert(get_state() == State::INITED, "Cannot change the name of an activity after its start");
 152     name_ = name;
 153     return static_cast<AnyActivity*>(this);
 154   }
 155   const std::string& get_name() const override { return name_; }
 156   const char* get_cname() const override { return name_.c_str(); }
 157
 158   AnyActivity* set_tracing_category(const std::string& category)
 159   {
 160     xbt_assert(get_state() == State::INITED, "Cannot change the tracing category of an activity after its start");
 161     tracing_category_ = category;
 162     return static_cast<AnyActivity*>(this);
 163   }
 164   const std::string& get_tracing_category() const { return tracing_category_; }
 165
 166   AnyActivity* set_user_data(void* data)
 167   {
 168     user_data_ = data;
 169     return static_cast<AnyActivity*>(this);
 170   }
 171
 172   void* get_user_data() const { return user_data_; }
 173 #ifndef DOXYGEN
 174   /* The refcounting is done in the ancestor class, Activity, but we want each of the classes benefiting of the CRTP
 175    * (Exec, Comm, etc) to have smart pointers too, so we define these methods here, that forward the ptr_release and
 176    * add_ref to the Activity class. Hopefully, the "inline" helps to not hinder the perf here.
 177    */
 178   friend void inline intrusive_ptr_release(AnyActivity* a) { intrusive_ptr_release(static_cast<Activity*>(a)); }
 179   friend void inline intrusive_ptr_add_ref(AnyActivity* a) { intrusive_ptr_add_ref(static_cast<Activity*>(a)); }
 180 #endif
 181 };
 182
 183 } // namespace s4u
 184 } // namespace simgrid
 185
 186 #endif /* SIMGRID_S4U_ACTIVITY_HPP */