1 /* Copyright (c) 2007-2016. 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.h"
14 typedef struct s_smx_process_exit_fun {
15 int_f_pvoid_pvoid_t fun;
17 } s_smx_process_exit_fun_t;
18 typedef s_smx_process_exit_fun_t* smx_process_exit_fun_t;
26 std::function<void()> code;
28 sg_host_t host = nullptr;
29 double kill_time = 0.0;
30 xbt_dict_t properties = nullptr;
31 bool auto_restart = false;
36 ActorImpl() : piface_(this) {}
39 // TODO, replace with boost intrusive container hooks
40 s_xbt_swag_hookup_t process_hookup = { nullptr, nullptr }; /* simix_global->process_list */
41 s_xbt_swag_hookup_t synchro_hookup = { nullptr, nullptr }; /* {mutex,cond,sem}->sleeping */
42 s_xbt_swag_hookup_t host_proc_hookup = { nullptr, nullptr }; /* smx_host->process_lis */
43 s_xbt_swag_hookup_t destroy_hookup = { nullptr, nullptr }; /* simix_global->process_to_destroy */
47 simgrid::xbt::string name;
48 const char* cname() { return name.c_str(); }
49 s4u::Host* host = nullptr; /* the host on which the process is running */
50 smx_context_t context = nullptr; /* the context (uctx/raw/thread) that executes the user function */
53 std::exception_ptr exception;
54 bool finished = false;
56 bool suspended = false;
57 bool auto_restart = false;
59 sg_host_t new_host = nullptr; /* if not null, the host on which the process must migrate to */
60 smx_activity_t waiting_synchro = nullptr; /* the current blocking synchro if any */
61 std::list<smx_activity_t> comms; /* the current non-blocking communication synchros */
62 xbt_dict_t properties = nullptr;
63 s_smx_simcall_t simcall;
64 void *data = nullptr; /* kept for compatibility, it should be replaced with moddata */
65 std::vector<s_smx_process_exit_fun_t> on_exit; /* list of functions executed when the process dies */
67 std::function<void()> code;
68 smx_timer_t kill_timer = nullptr;
69 int segment_index = -1; /* Reference to an SMPI process' data segment. Default value is -1 if not in SMPI context*/
73 std::atomic_int_fast32_t refcount_{1};
75 friend void intrusive_ptr_add_ref(ActorImpl* process)
77 // std::memory_order_relaxed ought to be enough here instead of std::memory_order_seq_cst
78 // But then, we have a threading issue when an actor commits a suicide:
79 // it seems that in this case, the worker thread kills the last occurrence of the actor
80 // while usually, the maestro does so. FIXME: we should change how actors suicide
81 process->refcount_.fetch_add(1, std::memory_order_seq_cst);
83 friend void intrusive_ptr_release(ActorImpl* process)
85 // inspired from http://www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html
86 if (process->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
87 // Make sure that any changes done on other threads before their acquire are committed before our delete
88 // http://stackoverflow.com/questions/27751025/why-is-an-acquire-barrier-needed-before-deleting-the-data-in-an-atomically-refer
89 std::atomic_thread_fence(std::memory_order_acquire);
94 /* S4U/implem interfaces */
96 simgrid::s4u::Actor piface_; // Our interface is part of ourselves
98 simgrid::s4u::ActorPtr iface() { return s4u::ActorPtr(&piface_); }
99 simgrid::s4u::Actor* ciface() { return &piface_; }
101 /* Daemon actors are automatically killed when the last non-daemon leaves */
112 typedef simgrid::simix::ProcessArg *smx_process_arg_t;
114 typedef simgrid::simix::ActorImpl* smx_actor_t;
118 XBT_PRIVATE smx_actor_t SIMIX_process_create(
120 std::function<void()> code,
123 xbt_dict_t properties,
124 smx_actor_t parent_process);
126 XBT_PRIVATE void SIMIX_process_runall();
127 XBT_PRIVATE void SIMIX_process_kill(smx_actor_t process, smx_actor_t issuer);
128 XBT_PRIVATE void SIMIX_process_killall(smx_actor_t issuer, int reset_pid);
129 XBT_PRIVATE void SIMIX_process_cleanup(smx_actor_t arg);
130 XBT_PRIVATE void SIMIX_process_empty_trash();
131 XBT_PRIVATE void SIMIX_process_yield(smx_actor_t self);
132 XBT_PRIVATE void SIMIX_process_exception_terminate(xbt_ex_t * e);
133 XBT_PRIVATE void SIMIX_process_change_host(smx_actor_t process, sg_host_t dest);
134 XBT_PRIVATE smx_activity_t SIMIX_process_suspend(smx_actor_t process, smx_actor_t issuer);
135 XBT_PRIVATE void SIMIX_process_resume(smx_actor_t process);
136 XBT_PRIVATE int SIMIX_process_get_PID(smx_actor_t self);
137 XBT_PRIVATE void SIMIX_process_set_data(smx_actor_t process, void *data);
138 XBT_PRIVATE smx_actor_t SIMIX_process_get_by_name(const char* name);
139 XBT_PRIVATE int SIMIX_process_is_suspended(smx_actor_t process);
140 XBT_PRIVATE xbt_dict_t SIMIX_process_get_properties(smx_actor_t process);
141 XBT_PRIVATE smx_activity_t SIMIX_process_join(smx_actor_t issuer, smx_actor_t process, double timeout);
142 XBT_PRIVATE smx_activity_t SIMIX_process_sleep(smx_actor_t process, double duration);
144 XBT_PRIVATE void SIMIX_process_sleep_destroy(smx_activity_t synchro);
145 XBT_PRIVATE void SIMIX_process_auto_restart_set(smx_actor_t process, int auto_restart);
146 XBT_PRIVATE smx_actor_t SIMIX_process_restart(smx_actor_t process, smx_actor_t issuer);
148 void SIMIX_segment_index_set(smx_actor_t process, int segment_index);
149 extern void (*SMPI_switch_data_segment)(int dest);