Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
try to use more standard, less obscure synchro for refcounting
[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 "xbt/swag.h"
12 #include<list>
13
14 typedef struct s_smx_process_exit_fun {
15   int_f_pvoid_pvoid_t fun;
16   void *arg;
17 } s_smx_process_exit_fun_t, *smx_process_exit_fun_t;
18
19 namespace simgrid {
20 namespace simix {
21
22 class ProcessArg {
23 public:
24   std::string name;
25   std::function<void()> code;
26   void *data            = nullptr;
27   sg_host_t host        = nullptr;
28   double kill_time      = 0.0;
29   xbt_dict_t properties = nullptr;
30   bool auto_restart     = false;
31 };
32
33 class ActorImpl {
34 public:
35   ActorImpl() : piface_(this) {}
36
37   // TODO, replace with boost intrusive container hooks
38   s_xbt_swag_hookup_t process_hookup   = { nullptr, nullptr }; /* simix_global->process_list */
39   s_xbt_swag_hookup_t synchro_hookup   = { nullptr, nullptr }; /* {mutex,cond,sem}->sleeping */
40   s_xbt_swag_hookup_t host_proc_hookup = { nullptr, nullptr }; /* smx_host->process_lis */
41   s_xbt_swag_hookup_t destroy_hookup   = { nullptr, nullptr }; /* simix_global->process_to_destroy */
42
43   unsigned long pid  = 0;
44   unsigned long ppid = -1;
45   simgrid::xbt::string name;
46   const char* cname() { return name.c_str(); }
47   s4u::Host* host       = nullptr; /* the host on which the process is running */
48   smx_context_t context = nullptr; /* the context (uctx/raw/thread) that executes the user function */
49
50   // TODO, pack them
51   std::exception_ptr exception;
52   bool finished     = false;
53   bool blocked      = false;
54   bool suspended    = false;
55   bool auto_restart = false;
56
57   sg_host_t new_host            = nullptr; /* if not null, the host on which the process must migrate to */
58   smx_activity_t waiting_synchro = nullptr; /* the current blocking synchro if any */
59   std::list<smx_activity_t> comms               ;           /* the current non-blocking communication synchros */
60   xbt_dict_t properties         = nullptr;
61   s_smx_simcall_t simcall;
62   void *data          = nullptr; /* kept for compatibility, it should be replaced with moddata */
63   std::vector<s_smx_process_exit_fun_t> on_exit; /* list of functions executed when the process dies */
64
65   std::function<void()> code;
66   smx_timer_t kill_timer = nullptr;
67   int segment_index = -1; /* Reference to an SMPI process' data segment. Default value is -1 if not in SMPI context*/
68
69   friend void intrusive_ptr_add_ref(ActorImpl* process)
70   {
71     process->refcount_.fetch_add(1, std::memory_order_relaxed);
72   }
73   friend void intrusive_ptr_release(ActorImpl* process)
74   {
75     // inspired from http://www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html
76     if (process->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
77       std::atomic_thread_fence(std::memory_order_acquire);
78       delete process;
79     }
80   }
81
82   ~ActorImpl();
83
84   simgrid::s4u::ActorPtr iface() { return s4u::ActorPtr(&piface_); }
85   simgrid::s4u::Actor* ciface() { return &piface_; }
86
87   void daemonize();
88   bool isDaemon();
89
90 private:
91   bool daemon = false;
92   std::atomic_int_fast32_t refcount_ { 1 };
93   simgrid::s4u::Actor piface_; // Our interface is part of ourselves
94 };
95
96 }
97 }
98
99 typedef simgrid::simix::ProcessArg *smx_process_arg_t;
100
101 typedef simgrid::simix::ActorImpl* smx_actor_t;
102
103 SG_BEGIN_DECL()
104
105 XBT_PRIVATE smx_actor_t SIMIX_process_create(
106                           const char *name,
107                           std::function<void()> code,
108                           void *data,
109                           sg_host_t host,
110                           xbt_dict_t properties,
111                           smx_actor_t parent_process);
112
113 XBT_PRIVATE void SIMIX_process_runall();
114 XBT_PRIVATE void SIMIX_process_kill(smx_actor_t process, smx_actor_t issuer);
115 XBT_PRIVATE void SIMIX_process_killall(smx_actor_t issuer, int reset_pid);
116 XBT_PRIVATE void SIMIX_process_cleanup(smx_actor_t arg);
117 XBT_PRIVATE void SIMIX_process_empty_trash();
118 XBT_PRIVATE void SIMIX_process_yield(smx_actor_t self);
119 XBT_PRIVATE void SIMIX_process_exception_terminate(xbt_ex_t * e);
120 XBT_PRIVATE void SIMIX_process_change_host(smx_actor_t process, sg_host_t dest);
121 XBT_PRIVATE smx_activity_t SIMIX_process_suspend(smx_actor_t process, smx_actor_t issuer);
122 XBT_PRIVATE void SIMIX_process_resume(smx_actor_t process);
123 XBT_PRIVATE int SIMIX_process_get_PID(smx_actor_t self);
124 XBT_PRIVATE void SIMIX_process_set_data(smx_actor_t process, void *data);
125 XBT_PRIVATE smx_actor_t SIMIX_process_get_by_name(const char* name);
126 XBT_PRIVATE int SIMIX_process_is_suspended(smx_actor_t process);
127 XBT_PRIVATE xbt_dict_t SIMIX_process_get_properties(smx_actor_t process);
128 XBT_PRIVATE smx_activity_t SIMIX_process_join(smx_actor_t issuer, smx_actor_t process, double timeout);
129 XBT_PRIVATE smx_activity_t SIMIX_process_sleep(smx_actor_t process, double duration);
130
131 XBT_PRIVATE void SIMIX_process_sleep_destroy(smx_activity_t synchro);
132 XBT_PRIVATE void SIMIX_process_auto_restart_set(smx_actor_t process, int auto_restart);
133 XBT_PRIVATE smx_actor_t SIMIX_process_restart(smx_actor_t process, smx_actor_t issuer);
134
135 void SIMIX_segment_index_set(smx_actor_t process, int segment_index);
136 extern void (*SMPI_switch_data_segment)(int dest);
137
138 SG_END_DECL()
139
140 #endif