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 ActorImpl : public simgrid::surf::PropertyHolder {
28 ActorImpl(simgrid::xbt::string name, simgrid::s4u::Host* host);
31 void set_auto_restart(bool autorestart) { auto_restart_ = autorestart; }
32 void set_kill_time(double kill_time);
33 boost::intrusive::list_member_hook<> host_process_list_hook; /* simgrid::simix::Host::process_list */
34 boost::intrusive::list_member_hook<> smx_destroy_list_hook; /* simix_global->process_to_destroy */
35 boost::intrusive::list_member_hook<> smx_synchro_hook; /* {mutex,cond,sem}->sleeping */
39 simgrid::xbt::string name_;
40 const simgrid::xbt::string& get_name() const { return name_; }
41 const char* get_cname() const { return name_.c_str(); }
42 s4u::Host* host_ = nullptr; /* the host on which the process is running */
43 smx_context_t context_ = nullptr; /* the context (uctx/raw/thread) that executes the user function */
45 std::exception_ptr exception;
46 bool finished_ = false;
47 bool blocked_ = false;
48 bool suspended_ = false;
49 bool auto_restart_ = false;
51 smx_activity_t waiting_synchro = nullptr; /* the current blocking synchro if any */
52 std::list<smx_activity_t> comms; /* the current non-blocking communication synchros */
53 s_smx_simcall simcall;
54 std::vector<s_smx_process_exit_fun_t> on_exit; /* list of functions executed when the process dies */
56 std::function<void()> code;
57 smx_timer_t kill_timer = nullptr;
60 void* userdata_ = nullptr; /* kept for compatibility, it should be replaced with moddata */
62 std::atomic_int_fast32_t refcount_{0};
65 friend void intrusive_ptr_add_ref(ActorImpl* process)
67 // std::memory_order_relaxed ought to be enough here instead of std::memory_order_seq_cst
68 // But then, we have a threading issue when an actor commits a suicide:
69 // it seems that in this case, the worker thread kills the last occurrence of the actor
70 // while usually, the maestro does so. FIXME: we should change how actors suicide
71 process->refcount_.fetch_add(1, std::memory_order_seq_cst);
73 friend void intrusive_ptr_release(ActorImpl* process)
75 // inspired from http://www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html
76 if (process->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
77 // Make sure that any changes done on other threads before their acquire are committed before our delete
78 // http://stackoverflow.com/questions/27751025/why-is-an-acquire-barrier-needed-before-deleting-the-data-in-an-atomically-refer
79 std::atomic_thread_fence(std::memory_order_acquire);
84 /* S4U/implem interfaces */
86 simgrid::s4u::Actor piface_; // Our interface is part of ourselves
88 simgrid::s4u::ActorPtr iface() { return s4u::ActorPtr(&piface_); }
89 simgrid::s4u::Actor* ciface() { return &piface_; }
91 /* Daemon actors are automatically killed when the last non-daemon leaves */
95 static ActorImplPtr create(std::string name, simix::ActorCode code, void* data, s4u::Host* host,
96 std::unordered_map<std::string, std::string>* properties, smx_actor_t parent_actor);
98 void kill(smx_actor_t actor);
101 bool is_daemon() { return daemon_; } /** Whether this actor has been daemonized */
102 bool is_suspended() { return suspended_; }
103 simgrid::s4u::Actor* restart();
104 smx_activity_t suspend(ActorImpl* issuer);
106 smx_activity_t sleep(double duration);
107 void set_user_data(void* data) { userdata_ = data; }
108 void* get_user_data() { return userdata_; }
109 /** Ask the actor to throw an exception right away */
110 void throw_exception(std::exception_ptr e);
111 void set_host(sg_host_t dest);
117 std::function<void()> code;
118 void* data = nullptr;
119 s4u::Host* host = nullptr;
120 double kill_time = 0.0;
121 std::shared_ptr<std::unordered_map<std::string, std::string>> properties = nullptr;
122 bool auto_restart = false;
123 bool daemon_ = false;
124 ProcessArg() = default;
126 explicit ProcessArg(std::string name, std::function<void()> code, void* data, s4u::Host* host, double kill_time,
127 std::shared_ptr<std::unordered_map<std::string, std::string>> properties, bool auto_restart)
129 , code(std::move(code))
132 , kill_time(kill_time)
133 , properties(properties)
134 , auto_restart(auto_restart)
138 explicit ProcessArg(s4u::Host* host, ActorImpl* actor)
139 : name(actor->get_name())
140 , code(std::move(actor->code))
141 , data(actor->get_user_data())
143 , kill_time(SIMIX_timer_get_date(actor->kill_timer))
144 , auto_restart(actor->auto_restart_)
145 , daemon_(actor->is_daemon())
147 properties.reset(actor->get_properties(), [](decltype(actor->get_properties())) {});
151 /* Used to keep the list of actors blocked on a synchro */
152 typedef boost::intrusive::list<ActorImpl, boost::intrusive::member_hook<ActorImpl, boost::intrusive::list_member_hook<>,
153 &ActorImpl::smx_synchro_hook>>
156 XBT_PUBLIC void create_maestro(std::function<void()> code);
158 } // namespace kernel
159 } // namespace simgrid
161 typedef simgrid::kernel::actor::ActorImpl* smx_actor_t;
163 XBT_PRIVATE void SIMIX_process_runall();
164 XBT_PRIVATE void SIMIX_process_killall(smx_actor_t issuer);
165 XBT_PRIVATE void SIMIX_process_cleanup(smx_actor_t arg);
166 XBT_PRIVATE void SIMIX_process_empty_trash();
167 XBT_PRIVATE void SIMIX_process_yield(smx_actor_t self);
169 extern void (*SMPI_switch_data_segment)(simgrid::s4u::ActorPtr actor);
171 XBT_PRIVATE void SIMIX_process_sleep_destroy(smx_activity_t synchro);
172 XBT_PRIVATE smx_activity_t SIMIX_process_join(smx_actor_t issuer, smx_actor_t process, double timeout);