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(int, void*)> fun;
  19   void *arg;
  20 };
  21
  22 namespace simgrid {
  23 namespace kernel {
  24 namespace actor {
  25
  26 class 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();
  38
  39   double get_kill_time();
  40   void set_kill_time(double kill_time);
  41   boost::intrusive::list_member_hook<> host_process_list_hook; /* simgrid::simix::Host::process_list */
  42   boost::intrusive::list_member_hook<> smx_destroy_list_hook;  /* simix_global->actors_to_destroy */
  43   boost::intrusive::list_member_hook<> smx_synchro_hook;       /* {mutex,cond,sem}->sleeping */
  44
  45   const xbt::string& get_name() const { return name_; }
  46   const char* get_cname() const { return name_.c_str(); }
  47
  48   // Accessors to private fields
  49   s4u::Host* get_host() { return host_; }
  50   void set_host(s4u::Host* dest);
  51   void* get_user_data() { return userdata_; }
  52   void set_user_data(void* data) { userdata_ = data; }
  53   aid_t get_pid() const { return pid_; }
  54   aid_t get_ppid() const { return ppid_; }
  55   void set_ppid(aid_t ppid) { ppid_ = ppid; }
  56   bool is_daemon() { return daemon_; } /** Whether this actor has been daemonized */
  57   bool has_to_auto_restart() { return auto_restart_; }
  58   void set_auto_restart(bool autorestart) { auto_restart_ = autorestart; }
  59
  60   context::Context* context_ = nullptr; /* the context (uctx/raw/thread) that executes the user function */
  61
  62   std::exception_ptr exception_;
  63   bool finished_  = false;
  64   bool blocked_   = false; /* FIXME this field is never set to true. Either use it or remove it. */
  65   bool suspended_ = false;
  66
  67   activity::ActivityImplPtr waiting_synchro = nullptr; /* the current blocking synchro if any */
  68   std::list<activity::ActivityImplPtr> comms;          /* the current non-blocking communication synchros */
  69   s_smx_simcall simcall;
  70   std::vector<s_smx_process_exit_fun_t> on_exit; /* list of functions executed when the process dies */
  71
  72   std::function<void()> code;
  73   smx_timer_t 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   static ActorImplPtr create(std::string name, simix::ActorCode code, void* data, s4u::Host* host,
 107                              std::unordered_map<std::string, std::string>* properties, ActorImpl* parent_actor);
 108   void exit();
 109   void kill(ActorImpl* actor);
 110   void kill_all();
 111
 112   void yield();
 113   void daemonize();
 114   bool is_suspended() { return suspended_; }
 115   s4u::Actor* restart();
 116   activity::ActivityImplPtr suspend(ActorImpl* issuer);
 117   void resume();
 118   activity::ActivityImplPtr join(ActorImpl* actor, double timeout);
 119   activity::ActivityImplPtr sleep(double duration);
 120   /** Ask the actor to throw an exception right away */
 121   void throw_exception(std::exception_ptr e);
 122 };
 123
 124 class ProcessArg {
 125 public:
 126   std::string name;
 127   std::function<void()> code;
 128   void* data                                                               = nullptr;
 129   s4u::Host* host                                                          = nullptr;
 130   double kill_time                                                         = 0.0;
 131   std::shared_ptr<std::unordered_map<std::string, std::string>> properties = nullptr;
 132   bool auto_restart                                                        = false;
 133   bool daemon_                                                             = false;
 134   ProcessArg()                                                             = default;
 135
 136   explicit ProcessArg(std::string name, std::function<void()> code, void* data, s4u::Host* host, double kill_time,
 137                       std::shared_ptr<std::unordered_map<std::string, std::string>> properties, bool auto_restart)
 138       : name(name)
 139       , code(std::move(code))
 140       , data(data)
 141       , host(host)
 142       , kill_time(kill_time)
 143       , properties(properties)
 144       , auto_restart(auto_restart)
 145   {
 146   }
 147
 148   explicit ProcessArg(s4u::Host* host, ActorImpl* actor)
 149       : name(actor->get_name())
 150       , code(std::move(actor->code))
 151       , data(actor->get_user_data())
 152       , host(host)
 153       , kill_time(actor->get_kill_time())
 154       , auto_restart(actor->has_to_auto_restart())
 155       , daemon_(actor->is_daemon())
 156   {
 157     properties.reset(actor->get_properties(), [](decltype(actor->get_properties())) {});
 158   }
 159 };
 160
 161 /* Used to keep the list of actors blocked on a synchro  */
 162 typedef boost::intrusive::list<ActorImpl, boost::intrusive::member_hook<ActorImpl, boost::intrusive::list_member_hook<>,
 163                                                                         &ActorImpl::smx_synchro_hook>>
 164     SynchroList;
 165
 166 XBT_PUBLIC void create_maestro(std::function<void()> code);
 167 } // namespace actor
 168 } // namespace kernel
 169 } // namespace simgrid
 170
 171 XBT_PRIVATE void SIMIX_process_cleanup(smx_actor_t arg);
 172
 173 extern void (*SMPI_switch_data_segment)(simgrid::s4u::ActorPtr actor);
 174
 175 XBT_PRIVATE void SIMIX_process_sleep_destroy(smx_activity_t synchro);
 176
 177 #endif