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