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