Update copyright lines.

[simgrid.git] / src / kernel / activity / ActivityImpl.hpp

diff --git a/src/kernel/activity/ActivityImpl.hpp b/src/kernel/activity/ActivityImpl.hpp
index 0d16180..853d3dc 100644 (file)
--- a/src/kernel/activity/ActivityImpl.hpp
+++ b/src/kernel/activity/ActivityImpl.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2007-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2007-2021. 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. */
@@ -19,25 +19,61 @@
 namespace simgrid {
 namespace kernel {
 namespace activity {
+enum class State {
+  WAITING = 0,
+  READY,
+  RUNNING,
+  DONE,
+  CANCELED,
+  FAILED,
+  SRC_HOST_FAILURE,
+  DST_HOST_FAILURE,
+  TIMEOUT,
+  SRC_TIMEOUT,
+  DST_TIMEOUT,
+  LINK_FAILURE
+};
 
 class XBT_PUBLIC ActivityImpl {
   std::atomic_int_fast32_t refcount_{0};
+  std::string name_ = "";
+
 public:
   virtual ~ActivityImpl();
   ActivityImpl() = default;
-  e_smx_state_t state_ = SIMIX_WAITING; /* State of the activity */
+  State state_   = State::WAITING;      /* State of the activity */
   std::list<smx_simcall_t> simcalls_;   /* List of simcalls waiting for this activity */
   resource::Action* surf_action_ = nullptr;
 
+protected:
+  void inline set_name(const std::string& name)
+  {
+    // This is to keep name_ private while allowing ActivityImpl_T<??> to set it and then return a Ptr to qualified
+    // child type
+    name_ = name;
+  }
+
+public:
+  const std::string& get_name() const { return name_; }
+  const char* get_cname() const { return name_.c_str(); }
+
+  bool test();
+  void wait_for(actor::ActorImpl* issuer, double timeout);
+  virtual ActivityImpl& set_timeout(double) { THROW_UNIMPLEMENTED; }
+
   virtual void suspend();
   virtual void resume();
   virtual void cancel();
-  virtual void post()   = 0; // What to do when a simcall terminates
-  virtual void finish() = 0;
 
-  virtual void clean_action();
+  virtual void post() = 0; // Called by the main loop when the activity is marked as terminated or failed by its model.
+                           // Setups the status, clean things up, and call finish()
+  virtual void finish() = 0; // Unlock all simcalls blocked on that activity, either because it was marked as done by
+                             // the model or because it terminated without waiting for the model
+
+  virtual void register_simcall(smx_simcall_t simcall);
+  void clean_action();
   virtual double get_remaining() const;
-  // boost::intrusive_ptr<ActivityImpl> support:
+  // Support for the boost::intrusive_ptr<ActivityImpl> datatype
   friend XBT_PUBLIC void intrusive_ptr_add_ref(ActivityImpl* activity);
   friend XBT_PUBLIC void intrusive_ptr_release(ActivityImpl* activity);
 
@@ -45,26 +81,26 @@ public:
   static xbt::signal<void(ActivityImpl const&)> on_resumed;
 };
 
+/* This class exists to allow chained setters as in exec->set_name()->set_priority()->set_blah()
+ * The difficulty is that set_name() must return a qualified child class, not the generic ancestor
+ * But the getter is still in the ancestor to be usable on generic activities with no downcast */
 template <class AnyActivityImpl> class ActivityImpl_T : public ActivityImpl {
 private:
-  std::string name_             = "";
   std::string tracing_category_ = "";
 
 public:
-  AnyActivityImpl& set_name(const std::string& name)
+  AnyActivityImpl& set_name(const std::string& name) /* Hides the function in the ancestor class */
   {
-    name_ = name;
+    ActivityImpl::set_name(name);
     return static_cast<AnyActivityImpl&>(*this);
   }
-  const std::string& get_name() { return name_; }
-  const char* get_cname() { return name_.c_str(); }
 
   AnyActivityImpl& set_tracing_category(const std::string& category)
   {
     tracing_category_ = category;
     return static_cast<AnyActivityImpl&>(*this);
   }
-  const std::string& get_tracing_category() { return tracing_category_; }
+  const std::string& get_tracing_category() const { return tracing_category_; }
 };
 
 } // namespace activity