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