1 /* Copyright (c) 2007-2017. 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"
16 struct s_smx_process_exit_fun_t {
17 int_f_pvoid_pvoid_t fun;
20 typedef s_smx_process_exit_fun_t* smx_process_exit_fun_t;
28 std::function<void()> code;
30 sg_host_t host = nullptr;
31 double kill_time = 0.0;
32 std::shared_ptr<std::map<std::string, std::string>> properties;
33 bool auto_restart = false;
36 class ActorImpl : public simgrid::surf::PropertyHolder {
38 ActorImpl() : piface_(this) {}
41 // TODO, replace with boost intrusive container hooks
42 s_xbt_swag_hookup_t process_hookup = { nullptr, nullptr }; /* simix_global->process_list */
43 s_xbt_swag_hookup_t synchro_hookup = { nullptr, nullptr }; /* {mutex,cond,sem}->sleeping */
44 s_xbt_swag_hookup_t host_proc_hookup = { nullptr, nullptr }; /* smx_host->process_lis */
45 s_xbt_swag_hookup_t destroy_hookup = { nullptr, nullptr }; /* simix_global->process_to_destroy */
49 simgrid::xbt::string name;
50 const simgrid::xbt::string& getName() const { return name; }
51 const char* getCname() const { return name.c_str(); }
52 s4u::Host* host = nullptr; /* the host on which the process is running */
53 smx_context_t context = nullptr; /* the context (uctx/raw/thread) that executes the user function */
56 std::exception_ptr exception;
57 bool finished = false;
59 bool suspended = false;
60 bool auto_restart = false;
62 sg_host_t new_host = nullptr; /* if not null, the host on which the process must migrate to */
63 smx_activity_t waiting_synchro = nullptr; /* the current blocking synchro if any */
64 std::list<smx_activity_t> comms; /* the current non-blocking communication synchros */
65 s_smx_simcall_t simcall;
66 void* userdata = nullptr; /* kept for compatibility, it should be replaced with moddata */
67 std::vector<s_smx_process_exit_fun_t> on_exit; /* list of functions executed when the process dies */
69 std::function<void()> code;
70 smx_timer_t kill_timer = nullptr;
71 int segment_index = -1; /* Reference to an SMPI process' data segment. Default value is -1 if not in SMPI context*/
75 std::atomic_int_fast32_t refcount_{0};
78 friend void intrusive_ptr_add_ref(ActorImpl* process)
80 // std::memory_order_relaxed ought to be enough here instead of std::memory_order_seq_cst
81 // But then, we have a threading issue when an actor commits a suicide:
82 // it seems that in this case, the worker thread kills the last occurrence of the actor
83 // while usually, the maestro does so. FIXME: we should change how actors suicide
84 process->refcount_.fetch_add(1, std::memory_order_seq_cst);
86 friend void intrusive_ptr_release(ActorImpl* process)
88 // inspired from http://www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html
89 if (process->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
90 // Make sure that any changes done on other threads before their acquire are committed before our delete
91 // http://stackoverflow.com/questions/27751025/why-is-an-acquire-barrier-needed-before-deleting-the-data-in-an-atomically-refer
92 std::atomic_thread_fence(std::memory_order_acquire);
97 /* S4U/implem interfaces */
99 simgrid::s4u::Actor piface_; // Our interface is part of ourselves
101 simgrid::s4u::ActorPtr iface() { return s4u::ActorPtr(&piface_); }
102 simgrid::s4u::Actor* ciface() { return &piface_; }
104 /* Daemon actors are automatically killed when the last non-daemon leaves */
109 bool isDaemon() { return daemon; } /** Whether this actor has been daemonized */
110 bool isSuspended() { return suspended; }
111 simgrid::s4u::Actor* restart();
112 smx_activity_t suspend(ActorImpl* issuer);
114 smx_activity_t sleep(double duration);
115 void setUserData(void* data) { userdata = data; }
116 void* getUserData() { return userdata; }
122 typedef simgrid::simix::ProcessArg *smx_process_arg_t;
124 typedef simgrid::simix::ActorImpl* smx_actor_t;
128 XBT_PRIVATE smx_actor_t SIMIX_process_create(const char* name, std::function<void()> code, void* data, sg_host_t host,
129 std::map<std::string, std::string>* properties,
130 smx_actor_t parent_process);
132 XBT_PRIVATE void SIMIX_process_runall();
133 XBT_PRIVATE void SIMIX_process_kill(smx_actor_t process, smx_actor_t issuer);
134 XBT_PRIVATE void SIMIX_process_killall(smx_actor_t issuer, int reset_pid);
135 XBT_PRIVATE void SIMIX_process_cleanup(smx_actor_t arg);
136 XBT_PRIVATE void SIMIX_process_empty_trash();
137 XBT_PRIVATE void SIMIX_process_yield(smx_actor_t self);
138 XBT_PRIVATE void SIMIX_process_exception_terminate(xbt_ex_t * e);
139 XBT_PRIVATE void SIMIX_process_change_host(smx_actor_t process, sg_host_t dest);
140 XBT_PRIVATE void SIMIX_process_set_data(smx_actor_t process, void *data);
141 XBT_PRIVATE smx_actor_t SIMIX_process_get_by_name(const char* name);
143 XBT_PRIVATE void SIMIX_process_auto_restart_set(smx_actor_t process, int auto_restart);
145 extern void (*SMPI_switch_data_segment)(int dest);
148 XBT_PRIVATE void SIMIX_process_sleep_destroy(smx_activity_t synchro);
149 XBT_PRIVATE smx_activity_t SIMIX_process_join(smx_actor_t issuer, smx_actor_t process, double timeout);