Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
moved a line for comprehension
[simgrid.git] / src / kernel / actor / ActorImpl.hpp
1 /* Copyright (c) 2007-2020. 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 SIMGRID_KERNEL_ACTOR_ACTORIMPL_HPP
7 #define SIMGRID_KERNEL_ACTOR_ACTORIMPL_HPP
8
9 #include "simgrid/s4u/Actor.hpp"
10 #include "src/simix/popping_private.hpp"
11 #include "xbt/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 xbt::PropertyHolder {
23   s4u::Host* host_   = nullptr; /* the host on which the actor is running */
24   // XBT_DEPRECATED_v329
25   void* userdata_    = nullptr; /* kept for compatibility, it should be replaced with moddata */
26   aid_t pid_         = 0;
27   aid_t ppid_        = -1;
28   bool daemon_       = false; /* Daemon actors are automatically killed when the last non-daemon leaves */
29   bool auto_restart_ = false;
30   unsigned stacksize_; // set to default value in constructor
31
32 public:
33   xbt::string name_;
34   ActorImpl(xbt::string name, s4u::Host* host);
35   ActorImpl(const ActorImpl&) = delete;
36   ActorImpl& operator=(const ActorImpl&) = delete;
37   ~ActorImpl();
38
39   static ActorImpl* self();
40   double get_kill_time();
41   void set_kill_time(double kill_time);
42   boost::intrusive::list_member_hook<> host_actor_list_hook;   /* simgrid::simix::Host::process_list */
43   boost::intrusive::list_member_hook<> smx_destroy_list_hook;  /* simix_global->actors_to_destroy */
44   boost::intrusive::list_member_hook<> smx_synchro_hook;       /* {mutex,cond,sem}->sleeping */
45
46   const xbt::string& get_name() const { return name_; }
47   const char* get_cname() const { return name_.c_str(); }
48
49   // Accessors to private fields
50   s4u::Host* get_host() { return host_; }
51   void set_host(s4u::Host* dest);
52   // XBT_DEPRECATED_v329
53   void* get_user_data() { return userdata_; }
54   // XBT_DEPRECATED_v329
55   void set_user_data(void* data) { userdata_ = data; }
56   aid_t get_pid() const { return pid_; }
57   aid_t get_ppid() const { return ppid_; }
58   void set_ppid(aid_t ppid) { ppid_ = ppid; }
59   bool is_daemon() { return daemon_; } /** Whether this actor has been daemonized */
60   bool has_to_auto_restart() { return auto_restart_; }
61   void set_auto_restart(bool autorestart) { auto_restart_ = autorestart; }
62   void set_stacksize(unsigned stacksize) { stacksize_ = stacksize; }
63   unsigned get_stacksize() { return stacksize_; }
64
65   std::unique_ptr<context::Context> context_; /* the context (uctx/raw/thread) that executes the user function */
66
67   std::exception_ptr exception_;
68   bool finished_  = false;
69   bool suspended_ = false;
70
71   activity::ActivityImplPtr waiting_synchro_ = nullptr; /* the current blocking synchro if any */
72   std::list<activity::ActivityImplPtr> activities_;     /* the current non-blocking synchros */
73   s_smx_simcall simcall_;
74   /* list of functions executed when the process dies */
75   std::shared_ptr<std::vector<std::function<void(bool)>>> on_exit =
76       std::make_shared<std::vector<std::function<void(bool)>>>();
77
78   std::function<void()> code_;
79   simix::Timer* kill_timer_ = nullptr;
80
81 private:
82   /* Refcounting */
83   std::atomic_int_fast32_t refcount_{0};
84
85 public:
86   int get_refcount() { return refcount_; }
87   friend void intrusive_ptr_add_ref(ActorImpl* actor)
88   {
89     // This whole memory consistency semantic drives me nuts.
90     // std::memory_order_relaxed proves to not be enough: There is a threading issue when actors commit suicide.
91     //   My guess is that the maestro context wants to propagate changes to the actor's fields after the
92     //   actor context frees that memory area or something. But I'm not 100% certain of what's going on.
93     // std::memory_order_seq_cst works but that's rather demanding.
94     // AFAIK, std::memory_order_acq_rel works on all tested platforms, so let's stick to it.
95     // Reducing the requirements to _relaxed would require to fix our suicide procedure, which is a messy piece of code.
96     actor->refcount_.fetch_add(1, std::memory_order_acq_rel);
97   }
98   friend void intrusive_ptr_release(ActorImpl* actor)
99   {
100     // inspired from http://www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html
101     if (actor->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
102       // Make sure that any changes done on other threads before their acquire are committed before our delete
103       // http://stackoverflow.com/questions/27751025/why-is-an-acquire-barrier-needed-before-deleting-the-data-in-an-atomically-refer
104       std::atomic_thread_fence(std::memory_order_acquire);
105       delete actor;
106     }
107   }
108
109   /* S4U/implem interfaces */
110 private:
111   s4u::Actor piface_; // Our interface is part of ourselves
112
113   void cleanup_from_simix();
114   void undaemonize();
115
116 public:
117   s4u::ActorPtr iface() { return s4u::ActorPtr(&piface_); }
118   s4u::Actor* ciface() { return &piface_; }
119
120   ActorImplPtr init(const std::string& name, s4u::Host* host);
121   ActorImpl* start(const ActorCode& code);
122
123   static ActorImplPtr create(const std::string& name, const ActorCode& code, void* data, s4u::Host* host,
124                              const std::unordered_map<std::string, std::string>* properties, ActorImpl* parent_actor);
125   static ActorImplPtr attach(const std::string& name, void* data, s4u::Host* host,
126                              const std::unordered_map<std::string, std::string>* properties);
127   static void detach();
128   void cleanup();
129   void exit();
130   void kill(ActorImpl* actor);
131   void kill_all();
132
133   void yield();
134   void daemonize();
135   bool is_suspended() { return suspended_; }
136   s4u::Actor* restart();
137   void suspend();
138   void resume();
139   activity::ActivityImplPtr join(const ActorImpl* actor, double timeout);
140   activity::ActivityImplPtr sleep(double duration);
141   /** Ask the actor to throw an exception right away */
142   void throw_exception(std::exception_ptr e);
143
144   /** execute the pending simcall -- must be called from the maestro context */
145   void simcall_handle(int value);
146   /** Terminates a simcall currently executed in maestro context. The actor will be restarted in the next scheduling
147    * round */
148   void simcall_answer();
149 };
150
151 class ProcessArg {
152 public:
153   std::string name;
154   std::function<void()> code;
155   void* data                                                               = nullptr;
156   s4u::Host* host                                                          = nullptr;
157   double kill_time                                                         = 0.0;
158   std::shared_ptr<const std::unordered_map<std::string, std::string>> properties = nullptr;
159   bool auto_restart                                                        = false;
160   bool daemon_                                                             = false;
161   /* list of functions executed when the process dies */
162   const std::shared_ptr<std::vector<std::function<void(bool)>>> on_exit;
163
164   ProcessArg()                                                             = default;
165
166   explicit ProcessArg(const std::string& name, const std::function<void()>& code, void* data, s4u::Host* host,
167                       double kill_time, std::shared_ptr<std::unordered_map<std::string, std::string>> properties,
168                       bool auto_restart)
169       : name(name)
170       , code(code)
171       , data(data)
172       , host(host)
173       , kill_time(kill_time)
174       , properties(properties)
175       , auto_restart(auto_restart)
176   {
177   }
178
179   explicit ProcessArg(s4u::Host* host, ActorImpl* actor)
180       : name(actor->get_name())
181       , code(actor->code_)
182       , data(actor->get_user_data())
183       , host(host)
184       , kill_time(actor->get_kill_time())
185       , auto_restart(actor->has_to_auto_restart())
186       , daemon_(actor->is_daemon())
187       , on_exit(actor->on_exit)
188   {
189     properties.reset(actor->get_properties(), [](decltype(actor->get_properties())) {});
190   }
191 };
192
193 /* Used to keep the list of actors blocked on a synchro  */
194 typedef boost::intrusive::list<ActorImpl, boost::intrusive::member_hook<ActorImpl, boost::intrusive::list_member_hook<>,
195                                                                         &ActorImpl::smx_synchro_hook>>
196     SynchroList;
197
198 XBT_PUBLIC void create_maestro(const std::function<void()>& code);
199 XBT_PUBLIC int get_maxpid();
200 } // namespace actor
201 } // namespace kernel
202 } // namespace simgrid
203
204 extern void (*SMPI_switch_data_segment)(simgrid::s4u::ActorPtr actor);
205
206 XBT_PUBLIC smx_actor_t simcall_process_create(const std::string& name, const simgrid::kernel::actor::ActorCode& code,
207                                               void* data, sg_host_t host,
208                                               std::unordered_map<std::string, std::string>* properties);
209
210 #endif