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