1 /* Copyright (c) 2007-2018. 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;
29 std::function<void()> code;
31 s4u::Host* host = nullptr;
32 double kill_time = 0.0;
33 std::shared_ptr<std::unordered_map<std::string, std::string>> properties;
34 bool auto_restart = false;
35 ProcessArg() = default;
36 explicit ProcessArg(std::string name, std::function<void()> code, void* data, s4u::Host* host, double kill_time,
37 std::shared_ptr<std::unordered_map<std::string, std::string>> properties, bool auto_restart)
39 , code(std::move(code))
42 , kill_time(kill_time)
43 , properties(properties)
44 , auto_restart(auto_restart)
49 class ActorImpl : public simgrid::surf::PropertyHolder {
51 ActorImpl() : piface_(this) {}
54 boost::intrusive::list_member_hook<> host_process_list_hook; /* simgrid::simix::Host::process_list */
55 boost::intrusive::list_member_hook<> smx_destroy_list_hook; /* simix_global->process_to_destroy */
56 boost::intrusive::list_member_hook<> smx_synchro_hook; /* {mutex,cond,sem}->sleeping */
60 simgrid::xbt::string name_;
61 const simgrid::xbt::string& get_name() const { return name_; }
62 const char* get_cname() const { return name_.c_str(); }
63 s4u::Host* host_ = nullptr; /* the host on which the process is running */
64 smx_context_t context_ = nullptr; /* the context (uctx/raw/thread) that executes the user function */
66 std::exception_ptr exception;
67 bool finished_ = false;
68 bool blocked_ = false;
69 bool suspended_ = false;
70 bool auto_restart_ = false;
72 smx_activity_t waiting_synchro = nullptr; /* the current blocking synchro if any */
73 std::list<smx_activity_t> comms; /* the current non-blocking communication synchros */
74 s_smx_simcall simcall;
75 std::vector<s_smx_process_exit_fun_t> on_exit; /* list of functions executed when the process dies */
77 std::function<void()> code;
78 smx_timer_t kill_timer = nullptr;
81 void* userdata_ = nullptr; /* kept for compatibility, it should be replaced with moddata */
83 std::atomic_int_fast32_t refcount_{0};
86 friend void intrusive_ptr_add_ref(ActorImpl* process)
88 // std::memory_order_relaxed ought to be enough here instead of std::memory_order_seq_cst
89 // But then, we have a threading issue when an actor commits a suicide:
90 // it seems that in this case, the worker thread kills the last occurrence of the actor
91 // while usually, the maestro does so. FIXME: we should change how actors suicide
92 process->refcount_.fetch_add(1, std::memory_order_seq_cst);
94 friend void intrusive_ptr_release(ActorImpl* process)
96 // inspired from http://www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html
97 if (process->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
98 // Make sure that any changes done on other threads before their acquire are committed before our delete
99 // http://stackoverflow.com/questions/27751025/why-is-an-acquire-barrier-needed-before-deleting-the-data-in-an-atomically-refer
100 std::atomic_thread_fence(std::memory_order_acquire);
105 /* S4U/implem interfaces */
107 simgrid::s4u::Actor piface_; // Our interface is part of ourselves
109 simgrid::s4u::ActorPtr iface() { return s4u::ActorPtr(&piface_); }
110 simgrid::s4u::Actor* ciface() { return &piface_; }
112 /* Daemon actors are automatically killed when the last non-daemon leaves */
114 bool daemon_ = false;
117 bool is_daemon() { return daemon_; } /** Whether this actor has been daemonized */
118 bool is_suspended() { return suspended_; }
119 simgrid::s4u::Actor* restart();
120 smx_activity_t suspend(ActorImpl* issuer);
122 smx_activity_t sleep(double duration);
123 void set_user_data(void* data) { userdata_ = data; }
124 void* get_user_data() { return userdata_; }
127 /* Used to keep the list of actors blocked on a synchro */
128 typedef boost::intrusive::list<ActorImpl, boost::intrusive::member_hook<ActorImpl, boost::intrusive::list_member_hook<>,
129 &ActorImpl::smx_synchro_hook>>
132 XBT_PUBLIC void create_maestro(std::function<void()> code);
134 } // namespace kernel
135 } // namespace simgrid
137 typedef simgrid::kernel::actor::ActorImpl* smx_actor_t;
139 XBT_PRIVATE smx_actor_t SIMIX_process_create(const char* name, std::function<void()> code, void* data, sg_host_t host,
140 std::unordered_map<std::string, std::string>* properties,
141 smx_actor_t parent_process);
143 XBT_PRIVATE void SIMIX_process_runall();
144 XBT_PRIVATE void SIMIX_process_kill(smx_actor_t process, smx_actor_t issuer);
145 XBT_PRIVATE void SIMIX_process_killall(smx_actor_t issuer);
146 XBT_PRIVATE void SIMIX_process_cleanup(smx_actor_t arg);
147 XBT_PRIVATE void SIMIX_process_empty_trash();
148 XBT_PRIVATE void SIMIX_process_yield(smx_actor_t self);
149 XBT_PRIVATE void SIMIX_process_change_host(smx_actor_t process, sg_host_t dest);
151 XBT_PRIVATE void SIMIX_process_auto_restart_set(smx_actor_t process, int auto_restart);
153 extern void (*SMPI_switch_data_segment)(simgrid::s4u::ActorPtr actor);
155 XBT_PRIVATE void SIMIX_process_sleep_destroy(smx_activity_t synchro);
156 XBT_PRIVATE smx_activity_t SIMIX_process_join(smx_actor_t issuer, smx_actor_t process, double timeout);