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>
17 struct s_smx_process_exit_fun_t {
18 std::function<void(int, void*)> fun;
26 class XBT_PUBLIC ActorImpl : public surf::PropertyHolder {
27 s4u::Host* host_ = nullptr; /* the host on which the actor is running */
28 void* userdata_ = nullptr; /* kept for compatibility, it should be replaced with moddata */
31 bool daemon_ = false; /* Daemon actors are automatically killed when the last non-daemon leaves */
32 bool auto_restart_ = false;
36 ActorImpl(xbt::string name, s4u::Host* host);
37 ActorImpl(const ActorImpl&) = delete;
38 ActorImpl& operator=(const ActorImpl&) = delete;
41 double get_kill_time();
42 void set_kill_time(double kill_time);
43 boost::intrusive::list_member_hook<> host_process_list_hook; /* simgrid::simix::Host::process_list */
44 boost::intrusive::list_member_hook<> smx_destroy_list_hook; /* simix_global->actors_to_destroy */
45 boost::intrusive::list_member_hook<> smx_synchro_hook; /* {mutex,cond,sem}->sleeping */
47 const xbt::string& get_name() const { return name_; }
48 const char* get_cname() const { return name_.c_str(); }
50 // Accessors to private fields
51 s4u::Host* get_host() { return host_; }
52 void set_host(s4u::Host* dest);
53 void* get_user_data() { return userdata_; }
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 context::Context* context_ = nullptr; /* the context (uctx/raw/thread) that executes the user function */
64 std::exception_ptr exception_;
65 bool finished_ = false;
66 bool blocked_ = false; /* FIXME this field is never set to true. Either use it or remove it. */
67 bool suspended_ = false;
69 activity::ActivityImplPtr waiting_synchro = nullptr; /* the current blocking synchro if any */
70 std::list<activity::ActivityImplPtr> comms; /* the current non-blocking communication synchros */
71 s_smx_simcall simcall;
72 std::vector<s_smx_process_exit_fun_t> on_exit; /* list of functions executed when the process dies */
74 std::function<void()> code;
75 simix::Timer* kill_timer = nullptr;
79 std::atomic_int_fast32_t refcount_{0};
82 friend void intrusive_ptr_add_ref(ActorImpl* actor)
84 // std::memory_order_relaxed ought to be enough here instead of std::memory_order_seq_cst
85 // But then, we have a threading issue when an actor commits a suicide:
86 // it seems that in this case, the worker thread kills the last occurrence of the actor
87 // while usually, the maestro does so. FIXME: we should change how actors suicide
88 actor->refcount_.fetch_add(1, std::memory_order_seq_cst);
90 friend void intrusive_ptr_release(ActorImpl* actor)
92 // inspired from http://www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html
93 if (actor->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
94 // Make sure that any changes done on other threads before their acquire are committed before our delete
95 // http://stackoverflow.com/questions/27751025/why-is-an-acquire-barrier-needed-before-deleting-the-data-in-an-atomically-refer
96 std::atomic_thread_fence(std::memory_order_acquire);
101 /* S4U/implem interfaces */
103 s4u::Actor piface_; // Our interface is part of ourselves
105 s4u::ActorPtr iface() { return s4u::ActorPtr(&piface_); }
106 s4u::Actor* ciface() { return &piface_; }
108 static ActorImplPtr create(std::string name, simix::ActorCode code, void* data, s4u::Host* host,
109 std::unordered_map<std::string, std::string>* properties, ActorImpl* parent_actor);
110 static ActorImplPtr attach(std::string name, void* data, s4u::Host* host,
111 std::unordered_map<std::string, std::string>* properties);
112 static void detach();
115 void kill(ActorImpl* actor);
120 bool is_suspended() { return suspended_; }
121 s4u::Actor* restart();
122 activity::ActivityImplPtr suspend(ActorImpl* issuer);
124 activity::ActivityImplPtr join(ActorImpl* actor, double timeout);
125 activity::ActivityImplPtr sleep(double duration);
126 /** Ask the actor to throw an exception right away */
127 void throw_exception(std::exception_ptr e);
133 std::function<void()> code;
134 void* data = nullptr;
135 s4u::Host* host = nullptr;
136 double kill_time = 0.0;
137 std::shared_ptr<std::unordered_map<std::string, std::string>> properties = nullptr;
138 bool auto_restart = false;
139 bool daemon_ = false;
140 ProcessArg() = default;
142 explicit ProcessArg(std::string name, std::function<void()> code, void* data, s4u::Host* host, double kill_time,
143 std::shared_ptr<std::unordered_map<std::string, std::string>> properties, bool auto_restart)
145 , code(std::move(code))
148 , kill_time(kill_time)
149 , properties(properties)
150 , auto_restart(auto_restart)
154 explicit ProcessArg(s4u::Host* host, ActorImpl* actor)
155 : name(actor->get_name())
156 , code(std::move(actor->code))
157 , data(actor->get_user_data())
159 , kill_time(actor->get_kill_time())
160 , auto_restart(actor->has_to_auto_restart())
161 , daemon_(actor->is_daemon())
163 properties.reset(actor->get_properties(), [](decltype(actor->get_properties())) {});
167 /* Used to keep the list of actors blocked on a synchro */
168 typedef boost::intrusive::list<ActorImpl, boost::intrusive::member_hook<ActorImpl, boost::intrusive::list_member_hook<>,
169 &ActorImpl::smx_synchro_hook>>
172 XBT_PUBLIC void create_maestro(std::function<void()> code);
174 } // namespace kernel
175 } // namespace simgrid
177 extern void (*SMPI_switch_data_segment)(simgrid::s4u::ActorPtr actor);
179 XBT_PRIVATE void SIMIX_process_sleep_destroy(smx_activity_t synchro);