src/simix/ActorImpl.hpp

   1 /* Copyright (c) 2007-2018. 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 simgrid::surf::PropertyHolder {
  27 public:
  28   ActorImpl() : piface_(this) {}
  29   ~ActorImpl();
  30
  31   void set_auto_restart(bool autorestart) { auto_restart_ = autorestart; }
  32
  33   boost::intrusive::list_member_hook<> host_process_list_hook; /* simgrid::simix::Host::process_list */
  34   boost::intrusive::list_member_hook<> smx_destroy_list_hook;  /* simix_global->process_to_destroy */
  35   boost::intrusive::list_member_hook<> smx_synchro_hook;       /* {mutex,cond,sem}->sleeping */
  36
  37   aid_t pid_  = 0;
  38   aid_t ppid_ = -1;
  39   simgrid::xbt::string name_;
  40   const simgrid::xbt::string& get_name() const { return name_; }
  41   const char* get_cname() const { return name_.c_str(); }
  42   s4u::Host* host_       = nullptr; /* the host on which the process is running */
  43   smx_context_t context_ = nullptr; /* the context (uctx/raw/thread) that executes the user function */
  44
  45   std::exception_ptr exception;
  46   bool finished_    = false;
  47   bool blocked_     = false;
  48   bool suspended_   = false;
  49   bool auto_restart_ = false;
  50
  51   smx_activity_t waiting_synchro = nullptr; /* the current blocking synchro if any */
  52   std::list<smx_activity_t> comms;          /* the current non-blocking communication synchros */
  53   s_smx_simcall simcall;
  54   std::vector<s_smx_process_exit_fun_t> on_exit; /* list of functions executed when the process dies */
  55
  56   std::function<void()> code;
  57   smx_timer_t kill_timer = nullptr;
  58
  59 private:
  60   void* userdata_ = nullptr; /* kept for compatibility, it should be replaced with moddata */
  61   /* Refcounting */
  62   std::atomic_int_fast32_t refcount_{0};
  63
  64 public:
  65   friend void intrusive_ptr_add_ref(ActorImpl* process)
  66   {
  67     // std::memory_order_relaxed ought to be enough here instead of std::memory_order_seq_cst
  68     // But then, we have a threading issue when an actor commits a suicide:
  69     //  it seems that in this case, the worker thread kills the last occurrence of the actor
  70     //  while usually, the maestro does so. FIXME: we should change how actors suicide
  71     process->refcount_.fetch_add(1, std::memory_order_seq_cst);
  72   }
  73   friend void intrusive_ptr_release(ActorImpl* process)
  74   {
  75     // inspired from http://www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html
  76     if (process->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
  77       // Make sure that any changes done on other threads before their acquire are committed before our delete
  78       // http://stackoverflow.com/questions/27751025/why-is-an-acquire-barrier-needed-before-deleting-the-data-in-an-atomically-refer
  79       std::atomic_thread_fence(std::memory_order_acquire);
  80       delete process;
  81     }
  82   }
  83
  84   /* S4U/implem interfaces */
  85 private:
  86   simgrid::s4u::Actor piface_; // Our interface is part of ourselves
  87 public:
  88   simgrid::s4u::ActorPtr iface() { return s4u::ActorPtr(&piface_); }
  89   simgrid::s4u::Actor* ciface() { return &piface_; }
  90
  91   /* Daemon actors are automatically killed when the last non-daemon leaves */
  92 private:
  93   bool daemon_ = false;
  94 public:
  95   void daemonize();
  96   bool is_daemon() { return daemon_; } /** Whether this actor has been daemonized */
  97   bool is_suspended() { return suspended_; }
  98   simgrid::s4u::Actor* restart();
  99   smx_activity_t suspend(ActorImpl* issuer);
 100   void resume();
 101   smx_activity_t sleep(double duration);
 102   void set_user_data(void* data) { userdata_ = data; }
 103   void* get_user_data() { return userdata_; }
 104 };
 105
 106 class ProcessArg {
 107 public:
 108   std::string name;
 109   std::function<void()> code;
 110   void* data                                                               = nullptr;
 111   s4u::Host* host                                                          = nullptr;
 112   double kill_time                                                         = 0.0;
 113   std::shared_ptr<std::unordered_map<std::string, std::string>> properties = nullptr;
 114   bool auto_restart                                                        = false;
 115   ProcessArg()                                                             = default;
 116
 117   explicit ProcessArg(std::string name, std::function<void()> code, void* data, s4u::Host* host, double kill_time,
 118                       std::shared_ptr<std::unordered_map<std::string, std::string>> properties, bool auto_restart)
 119       : name(name)
 120       , code(std::move(code))
 121       , data(data)
 122       , host(host)
 123       , kill_time(kill_time)
 124       , properties(properties)
 125       , auto_restart(auto_restart)
 126   {
 127   }
 128
 129   explicit ProcessArg(s4u::Host* host, ActorImpl* actor)
 130       : name(actor->get_name())
 131       , code(std::move(actor->code))
 132       , data(actor->get_user_data())
 133       , host(host)
 134       , kill_time(SIMIX_timer_get_date(actor->kill_timer))
 135       , auto_restart(actor->auto_restart_)
 136   {
 137     properties.reset(actor->get_properties(), [](decltype(actor->get_properties())) {});
 138   }
 139 };
 140
 141 /* Used to keep the list of actors blocked on a synchro  */
 142 typedef boost::intrusive::list<ActorImpl, boost::intrusive::member_hook<ActorImpl, boost::intrusive::list_member_hook<>,
 143                                                                         &ActorImpl::smx_synchro_hook>>
 144     SynchroList;
 145
 146 XBT_PUBLIC void create_maestro(std::function<void()> code);
 147 }
 148 } // namespace kernel
 149 } // namespace simgrid
 150
 151 typedef simgrid::kernel::actor::ActorImpl* smx_actor_t;
 152
 153 XBT_PRIVATE smx_actor_t SIMIX_process_create(std::string name, std::function<void()> code, void* data, sg_host_t host,
 154                                              std::unordered_map<std::string, std::string>* properties,
 155                                              smx_actor_t parent_process);
 156
 157 XBT_PRIVATE void SIMIX_process_runall();
 158 XBT_PRIVATE void SIMIX_process_kill(smx_actor_t process, smx_actor_t issuer);
 159 XBT_PRIVATE void SIMIX_process_killall(smx_actor_t issuer);
 160 XBT_PRIVATE void SIMIX_process_cleanup(smx_actor_t arg);
 161 XBT_PRIVATE void SIMIX_process_empty_trash();
 162 XBT_PRIVATE void SIMIX_process_yield(smx_actor_t self);
 163 XBT_PRIVATE void SIMIX_process_change_host(smx_actor_t process, sg_host_t dest);
 164
 165 extern void (*SMPI_switch_data_segment)(simgrid::s4u::ActorPtr actor);
 166
 167 XBT_PRIVATE void SIMIX_process_sleep_destroy(smx_activity_t synchro);
 168 XBT_PRIVATE smx_activity_t SIMIX_process_join(smx_actor_t issuer, smx_actor_t process, double timeout);
 169
 170 #endif