1 /* Copyright (c) 2007-2020. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_KERNEL_ACTOR_ACTORIMPL_HPP
7 #define SIMGRID_KERNEL_ACTOR_ACTORIMPL_HPP
9 #include "simgrid/s4u/Actor.hpp"
10 #include "src/simix/popping_private.hpp"
11 #include "xbt/PropertyHolder.hpp"
12 #include <boost/intrusive/list.hpp>
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 */
28 bool daemon_ = false; /* Daemon actors are automatically killed when the last non-daemon leaves */
29 bool auto_restart_ = false;
33 ActorImpl(xbt::string name, s4u::Host* host);
34 ActorImpl(const ActorImpl&) = delete;
35 ActorImpl& operator=(const ActorImpl&) = delete;
38 static ActorImpl* self();
39 double get_kill_time();
40 void set_kill_time(double kill_time);
41 boost::intrusive::list_member_hook<> host_actor_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 */
45 const xbt::string& get_name() const { return name_; }
46 const char* get_cname() const { return name_.c_str(); }
48 // Accessors to private fields
49 s4u::Host* get_host() { return host_; }
50 void set_host(s4u::Host* dest);
51 // XBT_DEPRECATED_v329
52 void* get_user_data() { return userdata_; }
53 // XBT_DEPRECATED_v329
54 void set_user_data(void* data) { userdata_ = data; }
55 aid_t get_pid() const { return pid_; }
56 aid_t get_ppid() const { return ppid_; }
57 void set_ppid(aid_t ppid) { ppid_ = ppid; }
58 bool is_daemon() { return daemon_; } /** Whether this actor has been daemonized */
59 bool has_to_auto_restart() { return auto_restart_; }
60 void set_auto_restart(bool autorestart) { auto_restart_ = autorestart; }
62 std::unique_ptr<context::Context> context_; /* the context (uctx/raw/thread) that executes the user function */
64 std::exception_ptr exception_;
65 bool finished_ = false;
66 bool suspended_ = false;
68 activity::ActivityImplPtr waiting_synchro = nullptr; /* the current blocking synchro if any */
69 std::list<activity::ActivityImplPtr> comms; /* the current non-blocking communication synchros */
70 s_smx_simcall simcall;
71 /* list of functions executed when the process dies */
72 std::shared_ptr<std::vector<std::function<void(bool)>>> on_exit =
73 std::make_shared<std::vector<std::function<void(bool)>>>();
75 std::function<void()> code_;
76 simix::Timer* kill_timer = nullptr;
80 std::atomic_int_fast32_t refcount_{0};
83 int get_refcount() { return refcount_; }
84 friend void intrusive_ptr_add_ref(ActorImpl* actor)
86 // This whole memory consistency semantic drives me nuts.
87 // std::memory_order_relaxed proves to not be enough: There is a threading issue when actors commit suicide.
88 // My guess is that the maestro context wants to propagate changes to the actor's fields after the
89 // actor context frees that memory area or something. But I'm not 100% certain of what's going on.
90 // std::memory_order_seq_cst works but that's rather demanding.
91 // AFAIK, std::memory_order_acq_rel works on all tested platforms, so let's stick to it.
92 // Reducing the requirements to _relaxed would require to fix our suicide procedure, which is a messy piece of code.
93 actor->refcount_.fetch_add(1, std::memory_order_acq_rel);
95 friend void intrusive_ptr_release(ActorImpl* actor)
97 // inspired from http://www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html
98 if (actor->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
99 // Make sure that any changes done on other threads before their acquire are committed before our delete
100 // http://stackoverflow.com/questions/27751025/why-is-an-acquire-barrier-needed-before-deleting-the-data-in-an-atomically-refer
101 std::atomic_thread_fence(std::memory_order_acquire);
106 /* S4U/implem interfaces */
108 s4u::Actor piface_; // Our interface is part of ourselves
110 void cleanup_from_simix();
114 s4u::ActorPtr iface() { return s4u::ActorPtr(&piface_); }
115 s4u::Actor* ciface() { return &piface_; }
117 ActorImplPtr init(const std::string& name, s4u::Host* host);
118 ActorImpl* start(const ActorCode& code);
120 static ActorImplPtr create(const std::string& name, const ActorCode& code, void* data, s4u::Host* host,
121 const std::unordered_map<std::string, std::string>* properties, ActorImpl* parent_actor);
122 static ActorImplPtr attach(const std::string& name, void* data, s4u::Host* host,
123 const std::unordered_map<std::string, std::string>* properties);
124 static void detach();
127 void kill(ActorImpl* actor);
132 bool is_suspended() { return suspended_; }
133 s4u::Actor* restart();
136 activity::ActivityImplPtr join(const ActorImpl* actor, double timeout);
137 activity::ActivityImplPtr sleep(double duration);
138 /** Ask the actor to throw an exception right away */
139 void throw_exception(std::exception_ptr e);
141 /** execute the pending simcall -- must be called from the maestro context */
142 void simcall_handle(int value);
143 /** Terminates a simcall currently executed in maestro context. The actor will be restarted in the next scheduling
145 void simcall_answer();
151 std::function<void()> code;
152 void* data = nullptr;
153 s4u::Host* host = nullptr;
154 double kill_time = 0.0;
155 std::shared_ptr<const std::unordered_map<std::string, std::string>> properties = nullptr;
156 bool auto_restart = false;
157 bool daemon_ = false;
158 /* list of functions executed when the process dies */
159 const std::shared_ptr<std::vector<std::function<void(bool)>>> on_exit;
161 ProcessArg() = default;
163 explicit ProcessArg(const std::string& name, const std::function<void()>& code, void* data, s4u::Host* host,
164 double kill_time, std::shared_ptr<std::unordered_map<std::string, std::string>> properties,
170 , kill_time(kill_time)
171 , properties(properties)
172 , auto_restart(auto_restart)
176 explicit ProcessArg(s4u::Host* host, ActorImpl* actor)
177 : name(actor->get_name())
179 , data(actor->get_user_data())
181 , kill_time(actor->get_kill_time())
182 , auto_restart(actor->has_to_auto_restart())
183 , daemon_(actor->is_daemon())
184 , on_exit(actor->on_exit)
186 properties.reset(actor->get_properties(), [](decltype(actor->get_properties())) {});
190 /* Used to keep the list of actors blocked on a synchro */
191 typedef boost::intrusive::list<ActorImpl, boost::intrusive::member_hook<ActorImpl, boost::intrusive::list_member_hook<>,
192 &ActorImpl::smx_synchro_hook>>
195 XBT_PUBLIC void create_maestro(const std::function<void()>& code);
196 XBT_PUBLIC int get_maxpid();
198 } // namespace kernel
199 } // namespace simgrid
201 extern void (*SMPI_switch_data_segment)(simgrid::s4u::ActorPtr actor);
203 XBT_PUBLIC smx_actor_t simcall_process_create(const std::string& name, const simgrid::kernel::actor::ActorCode& code,
204 void* data, sg_host_t host,
205 std::unordered_map<std::string, std::string>* properties);