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>
16 struct s_smx_process_exit_fun_t {
17 int_f_pvoid_pvoid_t fun;
28 std::function<void()> code;
30 s4u::Host* host = nullptr;
31 double kill_time = 0.0;
32 std::shared_ptr<std::map<std::string, std::string>> properties;
33 bool auto_restart = false;
34 ProcessArg() = default;
35 explicit ProcessArg(std::string name, std::function<void()> code, void* data, s4u::Host* host, double kill_time,
36 std::shared_ptr<std::map<std::string, std::string>> properties, bool auto_restart)
38 , code(std::move(code))
41 , kill_time(kill_time)
42 , properties(properties)
43 , auto_restart(auto_restart)
48 class ActorImpl : public simgrid::surf::PropertyHolder {
50 ActorImpl() : piface_(this) {}
53 boost::intrusive::list_member_hook<> host_process_list_hook; /* simgrid::simix::Host::process_list */
54 boost::intrusive::list_member_hook<> smx_destroy_list_hook; /* simix_global->process_to_destroy */
55 boost::intrusive::list_member_hook<> smx_synchro_hook; /* {mutex,cond,sem}->sleeping */
59 simgrid::xbt::string name;
60 const simgrid::xbt::string& get_name() const { return name; }
61 const char* get_cname() const { return name.c_str(); }
62 s4u::Host* host = nullptr; /* the host on which the process is running */
63 smx_context_t context = nullptr; /* the context (uctx/raw/thread) that executes the user function */
65 std::exception_ptr exception;
66 bool finished = false;
68 bool suspended = false;
69 bool auto_restart = false;
71 smx_activity_t waiting_synchro = nullptr; /* the current blocking synchro if any */
72 std::list<smx_activity_t> comms; /* the current non-blocking communication synchros */
73 s_smx_simcall simcall;
74 void* userdata = nullptr; /* kept for compatibility, it should be replaced with moddata */
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;
82 std::atomic_int_fast32_t refcount_{0};
85 friend void intrusive_ptr_add_ref(ActorImpl* process)
87 // std::memory_order_relaxed ought to be enough here instead of std::memory_order_seq_cst
88 // But then, we have a threading issue when an actor commits a suicide:
89 // it seems that in this case, the worker thread kills the last occurrence of the actor
90 // while usually, the maestro does so. FIXME: we should change how actors suicide
91 process->refcount_.fetch_add(1, std::memory_order_seq_cst);
93 friend void intrusive_ptr_release(ActorImpl* process)
95 // inspired from http://www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html
96 if (process->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
97 // Make sure that any changes done on other threads before their acquire are committed before our delete
98 // http://stackoverflow.com/questions/27751025/why-is-an-acquire-barrier-needed-before-deleting-the-data-in-an-atomically-refer
99 std::atomic_thread_fence(std::memory_order_acquire);
104 /* S4U/implem interfaces */
106 simgrid::s4u::Actor piface_; // Our interface is part of ourselves
108 simgrid::s4u::ActorPtr iface() { return s4u::ActorPtr(&piface_); }
109 simgrid::s4u::Actor* ciface() { return &piface_; }
111 /* Daemon actors are automatically killed when the last non-daemon leaves */
116 bool isDaemon() { return daemon; } /** Whether this actor has been daemonized */
117 bool isSuspended() { return suspended; }
118 simgrid::s4u::Actor* restart();
119 smx_activity_t suspend(ActorImpl* issuer);
121 smx_activity_t sleep(double duration);
122 void setUserData(void* data) { userdata = data; }
123 void* getUserData() { return userdata; }
126 /* Used to keep the list of actors blocked on a synchro */
127 typedef boost::intrusive::list<ActorImpl, boost::intrusive::member_hook<ActorImpl, boost::intrusive::list_member_hook<>,
128 &ActorImpl::smx_synchro_hook>>
131 XBT_PUBLIC void create_maestro(std::function<void()> code);
133 } // namespace kernel
134 } // namespace simgrid
136 typedef simgrid::kernel::actor::ActorImpl* smx_actor_t;
140 XBT_PRIVATE smx_actor_t SIMIX_process_create(const char* name, std::function<void()> code, void* data, sg_host_t host,
141 std::map<std::string, std::string>* properties,
142 smx_actor_t parent_process);
144 XBT_PRIVATE void SIMIX_process_runall();
145 XBT_PRIVATE void SIMIX_process_kill(smx_actor_t process, smx_actor_t issuer);
146 XBT_PRIVATE void SIMIX_process_killall(smx_actor_t issuer);
147 XBT_PRIVATE void SIMIX_process_cleanup(smx_actor_t arg);
148 XBT_PRIVATE void SIMIX_process_empty_trash();
149 XBT_PRIVATE void SIMIX_process_yield(smx_actor_t self);
150 XBT_PRIVATE void SIMIX_process_change_host(smx_actor_t process, sg_host_t dest);
152 XBT_PRIVATE void SIMIX_process_auto_restart_set(smx_actor_t process, int auto_restart);
154 extern void (*SMPI_switch_data_segment)(simgrid::s4u::ActorPtr actor);
157 XBT_PRIVATE void SIMIX_process_sleep_destroy(smx_activity_t synchro);
158 XBT_PRIVATE smx_activity_t SIMIX_process_join(smx_actor_t issuer, smx_actor_t process, double timeout);