Sort Actor traits alphabetically + cleanups

[simgrid.git] / src / kernel / actor / ActorImpl.hpp

diff --git a/src/kernel/actor/ActorImpl.hpp b/src/kernel/actor/ActorImpl.hpp
index f0fb5c2..d6c3a36 100644 (file)
--- a/src/kernel/actor/ActorImpl.hpp
+++ b/src/kernel/actor/ActorImpl.hpp
@@ -21,6 +21,23 @@ namespace kernel {
 namespace actor {
 class ProcessArg;
 
+/*------------------------- [ ActorIDTrait ] -------------------------*/
+class XBT_PUBLIC ActorIDTrait {
+  xbt::string name_;
+  aid_t pid_         = 0;
+  aid_t ppid_        = -1;
+
+public:
+  explicit ActorIDTrait(std::string name, aid_t ppid);
+  const xbt::string& get_name() const { return name_; }
+  const char* get_cname() const { return name_.c_str(); }
+  aid_t get_pid() const { return pid_; }
+  aid_t get_ppid() const { return ppid_; }
+};
+XBT_PUBLIC unsigned long get_maxpid();
+XBT_PUBLIC unsigned long* get_maxpid_addr(); // In MC mode, the application sends this pointers to the MC
+
+/*------------------------- [ ActorRestartingTrait ] -------------------------*/
 class XBT_PUBLIC ActorRestartingTrait {
   bool auto_restart_ = false;
   int restart_count_ = 0;
@@ -33,19 +50,19 @@ public:
   int get_restart_count() const { return restart_count_; }
 };
 
-class XBT_PUBLIC ActorImpl : public xbt::PropertyHolder, public ActorRestartingTrait {
+/*------------------------- [ ActorImpl ] -------------------------*/
+class XBT_PUBLIC ActorImpl : public xbt::PropertyHolder, public ActorIDTrait, public ActorRestartingTrait {
   s4u::Host* host_   = nullptr; /* the host on which the actor is running */
-  aid_t pid_         = 0;
-  aid_t ppid_        = -1;
   bool daemon_       = false; /* Daemon actors are automatically killed when the last non-daemon leaves */
   unsigned stacksize_; // set to default value in constructor
+  bool iwannadie_   = false; // True if we need to do some cleanups in actor mode.
+  bool to_be_freed_ = false; // True if cleanups in actor mode done, but cleanups in kernel mode pending
 
-  std::vector<activity::MailboxImpl*> mailboxes;
+  std::vector<activity::MailboxImpl*> mailboxes_;
   friend activity::MailboxImpl;
 
 public:
-  xbt::string name_;
-  ActorImpl(xbt::string name, s4u::Host* host);
+  ActorImpl(xbt::string name, s4u::Host* host, aid_t ppid);
   ActorImpl(const ActorImpl&) = delete;
   ActorImpl& operator=(const ActorImpl&) = delete;
   ~ActorImpl();
@@ -60,21 +77,26 @@ public:
   boost::intrusive::list_member_hook<> kernel_destroy_list_hook; /* EngineImpl actors_to_destroy */
   boost::intrusive::list_member_hook<> smx_synchro_hook;       /* {mutex,cond,sem}->sleeping */
 
-  const xbt::string& get_name() const { return name_; }
-  const char* get_cname() const { return name_.c_str(); }
+
+  // Life-cycle
+  bool wannadie() const { return iwannadie_; }
+  void set_wannadie(bool value = true);
+  bool to_be_freed() const { return to_be_freed_; }
+  void set_to_be_freed() { to_be_freed_ = true; }
 
   // Accessors to private fields
   s4u::Host* get_host() const { return host_; }
   void set_host(s4u::Host* dest);
-  aid_t get_pid() const { return pid_; }
-  aid_t get_ppid() const { return ppid_; }
-  void set_ppid(aid_t ppid) { ppid_ = ppid; }
-  bool is_daemon() const { return daemon_; } /** Whether this actor has been daemonized */
   bool is_maestro() const; /** Whether this actor is actually maestro (cheap call but may segfault before actor creation
                               / after terminaison) */
   void set_stacksize(unsigned stacksize) { stacksize_ = stacksize; }
   unsigned get_stacksize() const { return stacksize_; }
 
+  // Daemonize
+  bool is_daemon() const { return daemon_; } /** Whether this actor has been daemonized */
+  void daemonize();
+  void undaemonize();
+
   std::unique_ptr<context::Context> context_; /* the context (uctx/raw/thread) that executes the user function */
 
   std::exception_ptr exception_;
@@ -87,7 +109,7 @@ public:
   std::shared_ptr<std::vector<std::function<void(bool)>>> on_exit =
       std::make_shared<std::vector<std::function<void(bool)>>>();
 
-  std::function<void()> code_;
+  std::function<void()> code_; // to restart the actor on host reboot
   timer::Timer* kill_timer_ = nullptr;
 
 private:
@@ -122,7 +144,6 @@ public:
 private:
   s4u::Actor piface_; // Our interface is part of ourselves
 
-  void undaemonize();
 
 public:
   s4u::ActorPtr get_iface() { return s4u::ActorPtr(&piface_); }
@@ -143,7 +164,6 @@ public:
   void kill_all() const;
 
   void yield();
-  void daemonize();
   bool is_suspended() const { return suspended_; }
   s4u::Actor* restart();
   void suspend();
@@ -213,8 +233,6 @@ using SynchroList =
                                                                     &ActorImpl::smx_synchro_hook>>;
 
 XBT_PUBLIC void create_maestro(const std::function<void()>& code);
-XBT_PUBLIC unsigned long get_maxpid();
-XBT_PUBLIC unsigned long* get_maxpid_addr(); // In MC mode, the application sends this pointers to the MC
 
 } // namespace actor
 } // namespace kernel