]> AND Public Git Repository - simgrid.git/blobdiff - include/simgrid/s4u/Activity.hpp
Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Further reduce the amount of errors and warnings when rebuilding the doc
[simgrid.git] / include / simgrid / s4u / Activity.hpp
index de5b14adbad8aa90ad800b89917e19b1b9252342..23438e502289afc2b28c0f912bad1f9a8829ac00 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2019. 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,10 @@
 #ifndef SIMGRID_S4U_ACTIVITY_HPP
 #define SIMGRID_S4U_ACTIVITY_HPP
 
+#include "xbt/asserts.h"
+#include <atomic>
 #include <simgrid/forward.h>
+#include <string>
 #include <xbt/signal.hpp>
 
 namespace simgrid {
@@ -16,16 +19,6 @@ 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;
@@ -83,26 +76,57 @@ 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)
-  {
-    user_data_ = data;
-    return this;
-  }
-  /** Retrieve the user data of the Activity */
-  void* get_user_data() { return user_data_; }
-
+  /** Returns the internal implementation of this Activity */
   kernel::activity::ActivityImpl* get_impl() const { return pimpl_.get(); }
 
-#ifndef DOXYGEN
-  XBT_ATTRIB_DEPRECATED_v324("Please use Activity::wait_for()") virtual void wait(double timeout) = 0;
-#endif
-
 private:
   kernel::activity::ActivityImplPtr pimpl_ = nullptr;
   Activity::State state_                   = Activity::State::INITED;
   double remains_                          = 0;
-  void* user_data_                         = nullptr;
+};
+
+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
+  friend void intrusive_ptr_release(AnyActivity* a)
+  {
+    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(AnyActivity* a) { a->refcount_.fetch_add(1, std::memory_order_relaxed); }
+#endif
+  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<AnyActivity*>(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<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