use CRTP to factor refcounting across activity types

[simgrid.git] / include / simgrid / s4u / Activity.hpp

diff --git a/include/simgrid/s4u/Activity.hpp b/include/simgrid/s4u/Activity.hpp
index 39570d2..5f3999f 100644 (file)
--- a/include/simgrid/s4u/Activity.hpp
+++ b/include/simgrid/s4u/Activity.hpp
@@ -6,6 +6,8 @@
 #ifndef SIMGRID_S4U_ACTIVITY_HPP
 #define SIMGRID_S4U_ACTIVITY_HPP
 
+#include "xbt/asserts.h"
+#include <atomic>
 #include <simgrid/forward.h>
 #include <xbt/signal.hpp>
 
@@ -28,15 +30,17 @@ namespace s4u {
  * - 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 simgrid::s4u::ExecSeq;
-  friend simgrid::s4u::ExecPar;
+
+  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);
 
@@ -82,36 +86,57 @@ public:
   Activity* set_remaining(double remains);
 
   /** Put some user data onto the Activity */
-  Activity* set_user_data(void* data)
-  {
-    user_data_ = data;
-    return this;
-  }
-  /** Retrieve the user data of the Activity */
-  void* get_user_data() { return user_data_; }
 
-  kernel::activity::ActivityImplPtr get_impl() { return pimpl_; }
+  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 AnyActivity> class Activity_T : public Activity {
+private:
+  std::string name_             = "";
+  std::string tracing_category_ = "";
+  void* user_data_              = nullptr;
+  std::atomic_int_fast32_t refcount_{0};
+
+public:
 #ifndef DOXYGEN
-  XBT_ATTRIB_DEPRECATED_v324("Please use Activity::wait_for()") virtual void wait(double timeout) = 0;
-  XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_state()") Activity::State getState() { return state_; }
-  XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_remaining()") double getRemains() { return get_remaining(); }
-  XBT_ATTRIB_DEPRECATED_v323("Please use Activity::set_remaining()") Activity* setRemains(double remains)
+  friend XBT_PUBLIC void intrusive_ptr_release(AnyActivity* a)
   {
-    return set_remaining(remains);
+    if (a->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
+      std::atomic_thread_fence(std::memory_order_acquire);
+      delete a;
+    }
   }
-  XBT_ATTRIB_DEPRECATED_v323("Please use Activity::set_user_data()") Activity* setUserData(void* data)
+  friend XBT_PUBLIC void intrusive_ptr_add_ref(AnyActivity* a) { a->refcount_.fetch_add(1, std::memory_order_relaxed); }
+#endif
+  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<AnyActivity*>(this);
   }
-  XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_user_data()") void* getUserData() { return user_data_; }
-#endif
+  const std::string& get_name() { return name_; }
+  const char* get_cname() { return name_.c_str(); }
 
-private:
-  kernel::activity::ActivityImplPtr pimpl_ = nullptr;
-  Activity::State state_                   = Activity::State::INITED;
-  double remains_                          = 0;
-  void* user_data_                         = nullptr;
+  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<AnyActivity*>(this);
+  }
+  const std::string& get_tracing_category() { return tracing_category_; }
+
+  AnyActivity* set_user_data(void* data)
+  {
+    user_data_ = data;
+    return static_cast<AnyActivity*>(this);
+  }
+
+  void* get_user_data() { return user_data_; }
 };
 
 } // namespace s4u