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