Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Delete ProcessArg.properties.
[simgrid.git] / src / simix / ActorImpl.hpp
1 /* Copyright (c) 2007-2016. The SimGrid Team. All rights reserved.          */
2
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. */
5
6 #ifndef SIMIX_ACTORIMPL_H
7 #define SIMIX_ACTORIMPL_H
8
9 #include "simgrid/s4u/Actor.hpp"
10 #include "src/simix/popping_private.h"
11 #include "src/surf/PropertyHolder.hpp"
12 #include "xbt/swag.h"
13 #include <list>
14 #include <map>
15
16 typedef struct s_smx_process_exit_fun {
17   int_f_pvoid_pvoid_t fun;
18   void *arg;
19 } s_smx_process_exit_fun_t;
20 typedef s_smx_process_exit_fun_t* smx_process_exit_fun_t;
21
22 namespace simgrid {
23 namespace simix {
24
25 class ProcessArg {
26 public:
27   std::string name;
28   std::function<void()> code;
29   void *data            = nullptr;
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;
34 };
35
36 class ActorImpl : public simgrid::surf::PropertyHolder {
37 public:
38   ActorImpl() : piface_(this) {}
39   ~ActorImpl();
40
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 */
46
47   aid_t pid  = 0;
48   aid_t ppid = -1;
49   simgrid::xbt::string name;
50   const char* cname() { return name.c_str(); }
51   s4u::Host* host       = nullptr; /* the host on which the process is running */
52   smx_context_t context = nullptr; /* the context (uctx/raw/thread) that executes the user function */
53
54   // TODO, pack them
55   std::exception_ptr exception;
56   bool finished     = false;
57   bool blocked      = false;
58   bool suspended    = false;
59   bool auto_restart = false;
60
61   sg_host_t new_host             = nullptr; /* if not null, the host on which the process must migrate to */
62   smx_activity_t waiting_synchro = nullptr; /* the current blocking synchro if any */
63   std::list<smx_activity_t> comms;          /* the current non-blocking communication synchros */
64   s_smx_simcall_t simcall;
65   void* userdata = nullptr;                      /* kept for compatibility, it should be replaced with moddata */
66   std::vector<s_smx_process_exit_fun_t> on_exit; /* list of functions executed when the process dies */
67
68   std::function<void()> code;
69   smx_timer_t kill_timer = nullptr;
70   int segment_index = -1; /* Reference to an SMPI process' data segment. Default value is -1 if not in SMPI context*/
71
72   /* Refcounting */
73 private:
74   std::atomic_int_fast32_t refcount_{0};
75
76 public:
77   friend void intrusive_ptr_add_ref(ActorImpl* process)
78   {
79     // std::memory_order_relaxed ought to be enough here instead of std::memory_order_seq_cst
80     // But then, we have a threading issue when an actor commits a suicide:
81     //  it seems that in this case, the worker thread kills the last occurrence of the actor
82     //  while usually, the maestro does so. FIXME: we should change how actors suicide
83     process->refcount_.fetch_add(1, std::memory_order_seq_cst);
84   }
85   friend void intrusive_ptr_release(ActorImpl* process)
86   {
87     // inspired from http://www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html
88     if (process->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
89       // Make sure that any changes done on other threads before their acquire are committed before our delete
90       // http://stackoverflow.com/questions/27751025/why-is-an-acquire-barrier-needed-before-deleting-the-data-in-an-atomically-refer
91       std::atomic_thread_fence(std::memory_order_acquire);
92       delete process;
93     }
94   }
95
96   /* S4U/implem interfaces */
97 private:
98   simgrid::s4u::Actor piface_; // Our interface is part of ourselves
99 public:
100   simgrid::s4u::ActorPtr iface() { return s4u::ActorPtr(&piface_); }
101   simgrid::s4u::Actor* ciface() { return &piface_; }
102
103   /* Daemon actors are automatically killed when the last non-daemon leaves */
104 private:
105   bool daemon = false;
106 public:
107   void daemonize();
108   bool isDaemon() { return daemon; } /** Whether this actor has been daemonized */
109   bool isSuspended() { return suspended; }
110   simgrid::s4u::Actor* restart();
111   smx_activity_t suspend(ActorImpl* issuer);
112   void resume();
113   smx_activity_t sleep(double duration);
114   void setUserData(void* data) { userdata = data; }
115   void* getUserData() { return userdata; }
116 };
117
118 }
119 }
120
121 typedef simgrid::simix::ProcessArg *smx_process_arg_t;
122
123 typedef simgrid::simix::ActorImpl* smx_actor_t;
124
125 SG_BEGIN_DECL()
126
127 XBT_PRIVATE smx_actor_t SIMIX_process_create(const char* name, std::function<void()> code, void* data, sg_host_t host,
128                                              std::map<std::string, std::string>* properties,
129                                              smx_actor_t parent_process);
130
131 XBT_PRIVATE void SIMIX_process_runall();
132 XBT_PRIVATE void SIMIX_process_kill(smx_actor_t process, smx_actor_t issuer);
133 XBT_PRIVATE void SIMIX_process_killall(smx_actor_t issuer, int reset_pid);
134 XBT_PRIVATE void SIMIX_process_cleanup(smx_actor_t arg);
135 XBT_PRIVATE void SIMIX_process_empty_trash();
136 XBT_PRIVATE void SIMIX_process_yield(smx_actor_t self);
137 XBT_PRIVATE void SIMIX_process_exception_terminate(xbt_ex_t * e);
138 XBT_PRIVATE void SIMIX_process_change_host(smx_actor_t process, sg_host_t dest);
139 XBT_PRIVATE void SIMIX_process_set_data(smx_actor_t process, void *data);
140 XBT_PRIVATE smx_actor_t SIMIX_process_get_by_name(const char* name);
141
142 XBT_PRIVATE void SIMIX_process_auto_restart_set(smx_actor_t process, int auto_restart);
143
144 extern void (*SMPI_switch_data_segment)(int dest);
145
146 SG_END_DECL()
147
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);
150
151 #endif