src/kernel/actor/ActorImpl.hpp

   1 /* Copyright (c) 2007-2019. 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 SIMIX_ACTORIMPL_H
   7 #define SIMIX_ACTORIMPL_H
   8
   9 #include "simgrid/s4u/Actor.hpp"
  10 #include "src/simix/popping_private.hpp"
  11 #include "src/surf/PropertyHolder.hpp"
  12 #include <boost/intrusive/list.hpp>
  13 #include <functional>
  14 #include <list>
  15 #include <map>
  16 #include <memory>
  17
  18 struct s_smx_process_exit_fun_t {
  19   std::function<void(bool, void*)> fun;
  20   void* arg;
  21 };
  22
  23 namespace simgrid {
  24 namespace kernel {
  25 namespace actor {
  26
  27 class XBT_PUBLIC ActorImpl : public surf::PropertyHolder {
  28   s4u::Host* host_   = nullptr; /* the host on which the actor is running */
  29   void* userdata_    = nullptr; /* kept for compatibility, it should be replaced with moddata */
  30   aid_t pid_         = 0;
  31   aid_t ppid_        = -1;
  32   bool daemon_       = false; /* Daemon actors are automatically killed when the last non-daemon leaves */
  33   bool auto_restart_ = false;
  34
  35 public:
  36   xbt::string name_;
  37   ActorImpl(const xbt::string& name, s4u::Host* host);
  38   ActorImpl(const ActorImpl&) = delete;
  39   ActorImpl& operator=(const ActorImpl&) = delete;
  40   ~ActorImpl();
  41
  42   double get_kill_time();
  43   void set_kill_time(double kill_time);
  44   boost::intrusive::list_member_hook<> host_process_list_hook; /* simgrid::simix::Host::process_list */
  45   boost::intrusive::list_member_hook<> smx_destroy_list_hook;  /* simix_global->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   void* get_user_data() { return userdata_; }
  55   void set_user_data(void* data) { userdata_ = data; }
  56   aid_t get_pid() const { return pid_; }
  57   aid_t get_ppid() const { return ppid_; }
  58   void set_ppid(aid_t ppid) { ppid_ = ppid; }
  59   bool is_daemon() { return daemon_; } /** Whether this actor has been daemonized */
  60   bool has_to_auto_restart() { return auto_restart_; }
  61   void set_auto_restart(bool autorestart) { auto_restart_ = autorestart; }
  62
  63   std::unique_ptr<context::Context> context_; /* the context (uctx/raw/thread) that executes the user function */
  64
  65   std::exception_ptr exception_;
  66   bool finished_  = false;
  67   bool blocked_   = false; /* FIXME this field is never set to true. Either use it or remove it. */
  68   bool suspended_ = false;
  69
  70   activity::ActivityImplPtr waiting_synchro = nullptr; /* the current blocking synchro if any */
  71   std::list<activity::ActivityImplPtr> comms;          /* the current non-blocking communication synchros */
  72   s_smx_simcall simcall;
  73   std::vector<s_smx_process_exit_fun_t> on_exit; /* list of functions executed when the process dies */
  74
  75   std::function<void()> code;
  76   simix::Timer* kill_timer = nullptr;
  77
  78 private:
  79   /* Refcounting */
  80   std::atomic_int_fast32_t refcount_{0};
  81
  82 public:
  83   friend void intrusive_ptr_add_ref(ActorImpl* actor)
  84   {
  85     // std::memory_order_relaxed ought to be enough here instead of std::memory_order_seq_cst
  86     // But then, we have a threading issue when an actor commits a suicide:
  87     //  it seems that in this case, the worker thread kills the last occurrence of the actor
  88     //  while usually, the maestro does so. FIXME: we should change how actors suicide
  89     actor->refcount_.fetch_add(1, std::memory_order_seq_cst);
  90   }
  91   friend void intrusive_ptr_release(ActorImpl* actor)
  92   {
  93     // inspired from http://www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html
  94     if (actor->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
  95       // Make sure that any changes done on other threads before their acquire are committed before our delete
  96       // http://stackoverflow.com/questions/27751025/why-is-an-acquire-barrier-needed-before-deleting-the-data-in-an-atomically-refer
  97       std::atomic_thread_fence(std::memory_order_acquire);
  98       delete actor;
  99     }
 100   }
 101
 102   /* S4U/implem interfaces */
 103 private:
 104   s4u::Actor piface_; // Our interface is part of ourselves
 105 public:
 106   s4u::ActorPtr iface() { return s4u::ActorPtr(&piface_); }
 107   s4u::Actor* ciface() { return &piface_; }
 108
 109   ActorImplPtr init(const std::string& name, s4u::Host* host);
 110   ActorImpl* start(const simix::ActorCode& code);
 111
 112   static ActorImplPtr create(const std::string& name, const simix::ActorCode& code, void* data, s4u::Host* host,
 113                              std::unordered_map<std::string, std::string>* properties, ActorImpl* parent_actor);
 114   static ActorImplPtr attach(const std::string& name, void* data, s4u::Host* host,
 115                              std::unordered_map<std::string, std::string>* properties);
 116   static void detach();
 117   void cleanup();
 118   void exit();
 119   void kill(ActorImpl* actor);
 120   void kill_all();
 121
 122   void yield();
 123   void daemonize();
 124   bool is_suspended() { return suspended_; }
 125   s4u::Actor* restart();
 126   activity::ActivityImplPtr suspend(ActorImpl* issuer);
 127   void resume();
 128   activity::ActivityImplPtr join(ActorImpl* actor, double timeout);
 129   activity::ActivityImplPtr sleep(double duration);
 130   /** Ask the actor to throw an exception right away */
 131   void throw_exception(std::exception_ptr e);
 132 };
 133
 134 class ProcessArg {
 135 public:
 136   std::string name;
 137   std::function<void()> code;
 138   void* data                                                               = nullptr;
 139   s4u::Host* host                                                          = nullptr;
 140   double kill_time                                                         = 0.0;
 141   std::shared_ptr<std::unordered_map<std::string, std::string>> properties = nullptr;
 142   bool auto_restart                                                        = false;
 143   bool daemon_                                                             = false;
 144   ProcessArg()                                                             = default;
 145
 146   explicit ProcessArg(const std::string& name, const std::function<void()>& code, void* data, s4u::Host* host,
 147                       double kill_time, std::shared_ptr<std::unordered_map<std::string, std::string>> properties,
 148                       bool auto_restart)
 149       : name(name)
 150       , code(code)
 151       , data(data)
 152       , host(host)
 153       , kill_time(kill_time)
 154       , properties(properties)
 155       , auto_restart(auto_restart)
 156   {
 157   }
 158
 159   explicit ProcessArg(s4u::Host* host, ActorImpl* actor)
 160       : name(actor->get_name())
 161       , code(actor->code)
 162       , data(actor->get_user_data())
 163       , host(host)
 164       , kill_time(actor->get_kill_time())
 165       , auto_restart(actor->has_to_auto_restart())
 166       , daemon_(actor->is_daemon())
 167   {
 168     properties.reset(actor->get_properties(), [](decltype(actor->get_properties())) {});
 169   }
 170 };
 171
 172 /* Used to keep the list of actors blocked on a synchro  */
 173 typedef boost::intrusive::list<ActorImpl, boost::intrusive::member_hook<ActorImpl, boost::intrusive::list_member_hook<>,
 174                                                                         &ActorImpl::smx_synchro_hook>>
 175     SynchroList;
 176
 177 XBT_PUBLIC void create_maestro(const std::function<void()>& code);
 178 } // namespace actor
 179 } // namespace kernel
 180 } // namespace simgrid
 181
 182 extern void (*SMPI_switch_data_segment)(simgrid::s4u::ActorPtr actor);
 183
 184 XBT_PRIVATE void SIMIX_process_sleep_destroy(simgrid::kernel::activity::SleepImplPtr synchro);
 185
 186 #endif