src/kernel/actor/ActorImpl.hpp

   1 /* Copyright (c) 2007-2022. 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_KERNEL_ACTOR_ACTORIMPL_HPP
   7 #define SIMGRID_KERNEL_ACTOR_ACTORIMPL_HPP
   8
   9 #include "Simcall.hpp"
  10 #include "simgrid/kernel/Timer.hpp"
  11 #include "simgrid/s4u/Actor.hpp"
  12 #include "xbt/PropertyHolder.hpp"
  13 #include <boost/intrusive/list.hpp>
  14 #include <functional>
  15 #include <list>
  16 #include <map>
  17 #include <memory>
  18
  19 namespace simgrid {
  20 namespace kernel {
  21 namespace actor {
  22 class ProcessArg;
  23
  24 /*------------------------- [ ActorIDTrait ] -------------------------*/
  25 class XBT_PUBLIC ActorIDTrait {
  26   xbt::string name_;
  27   aid_t pid_         = 0;
  28   aid_t ppid_        = -1;
  29
  30 public:
  31   explicit ActorIDTrait(std::string name, aid_t ppid);
  32   const xbt::string& get_name() const { return name_; }
  33   const char* get_cname() const { return name_.c_str(); }
  34   aid_t get_pid() const { return pid_; }
  35   aid_t get_ppid() const { return ppid_; }
  36 };
  37 XBT_PUBLIC unsigned long get_maxpid();
  38 XBT_PUBLIC unsigned long* get_maxpid_addr(); // In MC mode, the application sends this pointers to the MC
  39
  40 /*------------------------- [ ActorRestartingTrait ] -------------------------*/
  41 class XBT_PUBLIC ActorRestartingTrait {
  42   bool auto_restart_ = false;
  43   int restart_count_ = 0;
  44
  45   friend ActorImpl;
  46
  47 public:
  48   bool has_to_auto_restart() const { return auto_restart_; }
  49   void set_auto_restart(bool autorestart) { auto_restart_ = autorestart; }
  50   int get_restart_count() const { return restart_count_; }
  51 };
  52
  53 /*------------------------- [ ActorImpl ] -------------------------*/
  54 class XBT_PUBLIC ActorImpl : public xbt::PropertyHolder, public ActorIDTrait, public ActorRestartingTrait {
  55   s4u::Host* host_   = nullptr; /* the host on which the actor is running */
  56   bool daemon_       = false; /* Daemon actors are automatically killed when the last non-daemon leaves */
  57   unsigned stacksize_; // set to default value in constructor
  58   bool iwannadie_   = false; // True if we need to do some cleanups in actor mode.
  59   bool to_be_freed_ = false; // True if cleanups in actor mode done, but cleanups in kernel mode pending
  60
  61   std::vector<activity::MailboxImpl*> mailboxes_;
  62   friend activity::MailboxImpl;
  63
  64 public:
  65   ActorImpl(xbt::string name, s4u::Host* host, aid_t ppid);
  66   ActorImpl(const ActorImpl&) = delete;
  67   ActorImpl& operator=(const ActorImpl&) = delete;
  68   ~ActorImpl();
  69
  70   static ActorImpl* self();
  71   double get_kill_time() const;
  72   void set_kill_time(double kill_time);
  73   boost::intrusive::list_member_hook<> host_actor_list_hook;     /* resource::HostImpl::actor_list_ */
  74   boost::intrusive::list_member_hook<> kernel_destroy_list_hook; /* EngineImpl actors_to_destroy */
  75   boost::intrusive::list_member_hook<> smx_synchro_hook;       /* {mutex,cond,sem}->sleeping */
  76
  77
  78   // Life-cycle
  79   bool wannadie() const { return iwannadie_; }
  80   void set_wannadie(bool value = true);
  81   bool to_be_freed() const { return to_be_freed_; }
  82   void set_to_be_freed() { to_be_freed_ = true; }
  83
  84   // Accessors to private fields
  85   s4u::Host* get_host() const { return host_; }
  86   void set_host(s4u::Host* dest);
  87   bool is_maestro() const; /** Whether this actor is actually maestro (cheap call but may segfault before actor creation
  88                               / after terminaison) */
  89   void set_stacksize(unsigned stacksize) { stacksize_ = stacksize; }
  90   unsigned get_stacksize() const { return stacksize_; }
  91
  92   // Daemonize
  93   bool is_daemon() const { return daemon_; } /** Whether this actor has been daemonized */
  94   void daemonize();
  95   void undaemonize();
  96
  97   std::unique_ptr<context::Context> context_; /* the context (uctx/raw/thread) that executes the user function */
  98
  99   std::exception_ptr exception_;
 100   bool suspended_ = false;
 101
 102   activity::ActivityImplPtr waiting_synchro_ = nullptr; /* the current blocking synchro if any */
 103   std::list<activity::ActivityImplPtr> activities_;     /* the current non-blocking synchros */
 104   Simcall simcall_;
 105   /* list of functions executed when the actor dies */
 106   std::shared_ptr<std::vector<std::function<void(bool)>>> on_exit =
 107       std::make_shared<std::vector<std::function<void(bool)>>>();
 108
 109   std::function<void()> code_; // to restart the actor on host reboot
 110   timer::Timer* kill_timer_ = nullptr;
 111
 112 private:
 113   /* Refcounting */
 114   std::atomic_int_fast32_t refcount_{0};
 115
 116 public:
 117   int get_refcount() const { return refcount_; }
 118   friend void intrusive_ptr_add_ref(ActorImpl* actor)
 119   {
 120     // This whole memory consistency semantic drives me nuts.
 121     // std::memory_order_relaxed proves to not be enough: There is a threading issue when actors commit suicide.
 122     //   My guess is that the maestro context wants to propagate changes to the actor's fields after the
 123     //   actor context frees that memory area or something. But I'm not 100% certain of what's going on.
 124     // std::memory_order_seq_cst works but that's rather demanding.
 125     // AFAIK, std::memory_order_acq_rel works on all tested platforms, so let's stick to it.
 126     // Reducing the requirements to _relaxed would require to fix our suicide procedure, which is a messy piece of code.
 127     actor->refcount_.fetch_add(1, std::memory_order_acq_rel);
 128   }
 129   friend void intrusive_ptr_release(ActorImpl* actor)
 130   {
 131     // inspired from http://www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html
 132     if (actor->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
 133       // Make sure that any changes done on other threads before their acquire are committed before our delete
 134       // http://stackoverflow.com/questions/27751025/why-is-an-acquire-barrier-needed-before-deleting-the-data-in-an-atomically-refer
 135       std::atomic_thread_fence(std::memory_order_acquire);
 136       delete actor;
 137     }
 138   }
 139
 140   /* S4U/implem interfaces */
 141 private:
 142   s4u::Actor piface_; // Our interface is part of ourselves
 143
 144
 145 public:
 146   s4u::ActorPtr get_iface() { return s4u::ActorPtr(&piface_); }
 147   s4u::Actor* get_ciface() { return &piface_; }
 148
 149   ActorImplPtr init(const std::string& name, s4u::Host* host) const;
 150   ActorImpl* start(const ActorCode& code);
 151
 152   static ActorImplPtr create(const std::string& name, const ActorCode& code, void* data, s4u::Host* host,
 153                              const ActorImpl* parent_actor);
 154   static ActorImplPtr create(ProcessArg* args);
 155   static ActorImplPtr attach(const std::string& name, void* data, s4u::Host* host);
 156   static void detach();
 157   void cleanup_from_self();
 158   void cleanup_from_kernel();
 159   void exit();
 160   void kill(ActorImpl* actor) const;
 161   void kill_all() const;
 162
 163   void yield();
 164   bool is_suspended() const { return suspended_; }
 165   s4u::Actor* restart();
 166   void suspend();
 167   void resume();
 168   activity::ActivityImplPtr join(const ActorImpl* actor, double timeout);
 169   activity::ActivityImplPtr sleep(double duration);
 170   /** Ask the actor to throw an exception right away */
 171   void throw_exception(std::exception_ptr e);
 172
 173   /** execute the pending simcall -- must be called from the maestro context */
 174   void simcall_handle(int value);
 175   /** Terminates a simcall currently executed in maestro context. The actor will be restarted in the next scheduling
 176    * round */
 177   void simcall_answer();
 178 };
 179
 180 class ProcessArg {
 181 public:
 182   std::string name;
 183   std::function<void()> code;
 184   void* data                                                               = nullptr;
 185   s4u::Host* host                                                          = nullptr;
 186   double kill_time                                                         = 0.0;
 187   const std::unordered_map<std::string, std::string> properties{};
 188   bool auto_restart                                                        = false;
 189   bool daemon_;
 190   /* list of functions executed when the actor dies */
 191   const std::shared_ptr<std::vector<std::function<void(bool)>>> on_exit;
 192   int restart_count_ = 0;
 193
 194   ProcessArg()                  = delete;
 195   ProcessArg(const ProcessArg&) = delete;
 196   ProcessArg& operator=(const ProcessArg&) = delete;
 197
 198   explicit ProcessArg(const std::string& name, const std::function<void()>& code, void* data, s4u::Host* host,
 199                       double kill_time, const std::unordered_map<std::string, std::string>& properties,
 200                       bool auto_restart, bool daemon, int restart_count)
 201       : name(name)
 202       , code(code)
 203       , data(data)
 204       , host(host)
 205       , kill_time(kill_time)
 206       , properties(properties)
 207       , auto_restart(auto_restart)
 208       , daemon_(daemon)
 209       , restart_count_(restart_count)
 210   {
 211   }
 212
 213   explicit ProcessArg(s4u::Host* host, ActorImpl* actor)
 214       : name(actor->get_name())
 215       , code(actor->code_)
 216       , data(actor->get_ciface()->get_data<void>())
 217       , host(host)
 218       , kill_time(actor->get_kill_time())
 219       , auto_restart(actor->has_to_auto_restart())
 220       , daemon_(actor->is_daemon())
 221       , on_exit(actor->on_exit)
 222       , restart_count_(actor->get_restart_count() + 1)
 223   {
 224   }
 225 };
 226
 227 /* Used to keep the list of actors blocked on a synchro  */
 228 using SynchroList =
 229     boost::intrusive::list<ActorImpl, boost::intrusive::member_hook<ActorImpl, boost::intrusive::list_member_hook<>,
 230                                                                     &ActorImpl::smx_synchro_hook>>;
 231
 232 XBT_PUBLIC void create_maestro(const std::function<void()>& code);
 233
 234 } // namespace actor
 235 } // namespace kernel
 236 } // namespace simgrid
 237
 238 #endif