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