1 /* Copyright (c) 2007-2019. 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 SIMIX_ACTORIMPL_H
7 #define SIMIX_ACTORIMPL_H
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>
22 class XBT_PUBLIC ActorImpl : public surf::PropertyHolder {
23 s4u::Host* host_ = nullptr; /* the host on which the actor is running */
24 void* userdata_ = nullptr; /* kept for compatibility, it should be replaced with moddata */
27 bool daemon_ = false; /* Daemon actors are automatically killed when the last non-daemon leaves */
28 bool auto_restart_ = false;
32 ActorImpl(xbt::string name, s4u::Host* host);
33 ActorImpl(const ActorImpl&) = delete;
34 ActorImpl& operator=(const ActorImpl&) = delete;
37 double get_kill_time();
38 void set_kill_time(double kill_time);
39 boost::intrusive::list_member_hook<> host_process_list_hook; /* simgrid::simix::Host::process_list */
40 boost::intrusive::list_member_hook<> smx_destroy_list_hook; /* simix_global->actors_to_destroy */
41 boost::intrusive::list_member_hook<> smx_synchro_hook; /* {mutex,cond,sem}->sleeping */
43 const xbt::string& get_name() const { return name_; }
44 const char* get_cname() const { return name_.c_str(); }
46 // Accessors to private fields
47 s4u::Host* get_host() { return host_; }
48 void set_host(s4u::Host* dest);
49 void* get_user_data() { return userdata_; }
50 void set_user_data(void* data) { userdata_ = data; }
51 aid_t get_pid() const { return pid_; }
52 aid_t get_ppid() const { return ppid_; }
53 void set_ppid(aid_t ppid) { ppid_ = ppid; }
54 bool is_daemon() { return daemon_; } /** Whether this actor has been daemonized */
55 bool has_to_auto_restart() { return auto_restart_; }
56 void set_auto_restart(bool autorestart) { auto_restart_ = autorestart; }
58 std::unique_ptr<context::Context> context_; /* the context (uctx/raw/thread) that executes the user function */
60 std::exception_ptr exception_;
61 bool finished_ = false;
62 bool suspended_ = false;
64 activity::ActivityImplPtr waiting_synchro = nullptr; /* the current blocking synchro if any */
65 std::list<activity::ActivityImplPtr> comms; /* the current non-blocking communication synchros */
66 s_smx_simcall simcall;
67 /* list of functions executed when the process dies */
68 std::shared_ptr<std::vector<std::function<void(bool)>>> on_exit =
69 std::make_shared<std::vector<std::function<void(bool)>>>();
71 std::function<void()> code_;
72 simix::Timer* kill_timer = nullptr;
76 std::atomic_int_fast32_t refcount_{0};
79 int get_refcount() { return refcount_; }
80 friend void intrusive_ptr_add_ref(ActorImpl* actor)
82 // This whole memory consistency semantic drives me nuts.
83 // std::memory_order_relaxed proves to not be enough: There is a threading issue when actors commit suicide.
84 // My guess is that the maestro context wants to propagate changes to the actor's fields after the
85 // actor context frees that memory area or something. But I'm not 100% certain of what's going on.
86 // std::memory_order_seq_cst works but that's rather demanding.
87 // AFAIK, std::memory_order_acq_rel works on all tested platforms, so let's stick to it.
88 // Reducing the requirements to _relaxed would require to fix our suicide procedure, which is a messy piece of code.
89 actor->refcount_.fetch_add(1, std::memory_order_acq_rel);
91 friend void intrusive_ptr_release(ActorImpl* actor)
93 // inspired from http://www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html
94 if (actor->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
95 // Make sure that any changes done on other threads before their acquire are committed before our delete
96 // http://stackoverflow.com/questions/27751025/why-is-an-acquire-barrier-needed-before-deleting-the-data-in-an-atomically-refer
97 std::atomic_thread_fence(std::memory_order_acquire);
102 /* S4U/implem interfaces */
104 s4u::Actor piface_; // Our interface is part of ourselves
109 s4u::ActorPtr iface() { return s4u::ActorPtr(&piface_); }
110 s4u::Actor* ciface() { return &piface_; }
112 ActorImplPtr init(const std::string& name, s4u::Host* host);
113 ActorImpl* start(const simix::ActorCode& code);
115 static ActorImplPtr create(const std::string& name, const simix::ActorCode& code, void* data, s4u::Host* host,
116 const std::unordered_map<std::string, std::string>* properties, ActorImpl* parent_actor);
117 static ActorImplPtr attach(const std::string& name, void* data, s4u::Host* host,
118 const std::unordered_map<std::string, std::string>* properties);
119 static void detach();
122 void kill(ActorImpl* actor);
127 bool is_suspended() { return suspended_; }
128 s4u::Actor* restart();
131 activity::ActivityImplPtr join(ActorImpl* actor, double timeout);
132 activity::ActivityImplPtr sleep(double duration);
133 /** Ask the actor to throw an exception right away */
134 void throw_exception(std::exception_ptr e);
136 /** execute the pending simcall -- must be called from the maestro context */
137 void simcall_handle(int value);
138 /** Terminates a simcall currently executed in maestro context. The actor will be restarted in the next scheduling
140 void simcall_answer();
146 std::function<void()> code;
147 void* data = nullptr;
148 s4u::Host* host = nullptr;
149 double kill_time = 0.0;
150 std::shared_ptr<const std::unordered_map<std::string, std::string>> properties = nullptr;
151 bool auto_restart = false;
152 bool daemon_ = false;
153 /* list of functions executed when the process dies */
154 const std::shared_ptr<std::vector<std::function<void(bool)>>> on_exit;
156 ProcessArg() = default;
158 explicit ProcessArg(const std::string& name, const std::function<void()>& code, void* data, s4u::Host* host,
159 double kill_time, std::shared_ptr<std::unordered_map<std::string, std::string>> properties,
165 , kill_time(kill_time)
166 , properties(properties)
167 , auto_restart(auto_restart)
171 explicit ProcessArg(s4u::Host* host, ActorImpl* actor)
172 : name(actor->get_name())
174 , data(actor->get_user_data())
176 , kill_time(actor->get_kill_time())
177 , auto_restart(actor->has_to_auto_restart())
178 , daemon_(actor->is_daemon())
179 , on_exit(actor->on_exit)
181 properties.reset(actor->get_properties(), [](decltype(actor->get_properties())) {});
185 /* Used to keep the list of actors blocked on a synchro */
186 typedef boost::intrusive::list<ActorImpl, boost::intrusive::member_hook<ActorImpl, boost::intrusive::list_member_hook<>,
187 &ActorImpl::smx_synchro_hook>>
190 XBT_PUBLIC void create_maestro(const std::function<void()>& code);
191 XBT_PUBLIC int get_maxpid();
193 } // namespace kernel
194 } // namespace simgrid
196 extern void (*SMPI_switch_data_segment)(simgrid::s4u::ActorPtr actor);