src/kernel/actor/ActorImpl.hpp

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