Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add MSG_process_join [#13601]
[simgrid.git] / src / simix / smx_private.h
1 /* Copyright (c) 2007-2010, 2012-2014. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #ifndef _SIMIX_PRIVATE_H
8 #define _SIMIX_PRIVATE_H
9
10 #include "simgrid/simix.h"
11 #include "surf/surf.h"
12 #include "xbt/fifo.h"
13 #include "xbt/swag.h"
14 #include "xbt/dict.h"
15 #include "xbt/mallocator.h"
16 #include "xbt/config.h"
17 #include "xbt/xbt_os_time.h"
18 #include "xbt/function_types.h"
19 #include "xbt/ex_interface.h"
20 #include "instr/instr_private.h"
21 #include "smx_process_private.h"
22 #include "smx_host_private.h"
23 #include "smx_io_private.h"
24 #include "smx_network_private.h"
25 #include "smx_smurf_private.h"
26 #include "smx_synchro_private.h"
27 /* ****************************************************************************************** */
28 /* TUTORIAL: New API                                                                        */
29 /* ****************************************************************************************** */
30 #include "smx_new_api_private.h"
31
32 /* Define only for SimGrid benchmarking purposes */
33 //#define TIME_BENCH_PER_SR /* this aims at measuring the time spent in each scheduling round per each thread. The code is thus run in sequential to bench separately each SSR */
34 //#define TIME_BENCH_AMDAHL /* this aims at measuring the porting of time that could be parallelized at maximum (to get the optimal speedup by applying the amdahl law). */
35
36 /********************************** Simix Global ******************************/
37 typedef struct s_smx_global {
38   smx_context_factory_t context_factory;
39   xbt_dynar_t process_to_run;
40   xbt_dynar_t process_that_ran;
41   xbt_swag_t process_list;
42   xbt_swag_t process_to_destroy;
43   smx_process_t maestro_process;
44   xbt_dict_t registered_functions;
45   smx_creation_func_t create_process_function;
46   void_pfn_smxprocess_t_smxprocess_t kill_process_function;
47   void_pfn_smxprocess_t cleanup_process_function;
48   xbt_mallocator_t action_mallocator;
49   void_pfn_smxhost_t autorestart;
50
51 #ifdef TIME_BENCH_AMDAHL
52   xbt_os_timer_t timer_seq; /* used to bench the sequential and parallel parts of the simulation, if requested to */
53   xbt_os_timer_t timer_par;
54 #endif
55 } s_smx_global_t, *smx_global_t;
56
57 extern smx_global_t simix_global;
58 extern unsigned long simix_process_maxpid;
59
60 extern xbt_dict_t watched_hosts_lib;
61
62 #ifdef __cplusplus
63 extern "C" {
64 #endif
65 XBT_PUBLIC(void) SIMIX_clean(void);
66 #ifdef __cplusplus
67 }
68 #endif
69
70 /******************************** Exceptions *********************************/
71
72 #define SMX_EXCEPTION(issuer, c, v, m)                                  \
73   if (1) {                                                              \
74     smx_process_t _smx_throw_issuer = (issuer);                         \
75     THROW_PREPARE(_smx_throw_issuer->running_ctx, (c), (v), xbt_strdup(m)); \
76     _smx_throw_issuer->doexception = 1;                                 \
77   } else ((void)0)
78
79 #define SMX_THROW() RETHROW
80
81 /* ******************************** File ************************************ */
82 typedef struct s_smx_file {
83   surf_file_t surf_file;
84   void* data;                   /**< @brief user data */
85 } s_smx_file_t;
86
87 /*********************************** Time ************************************/
88
89 /** @brief Timer datatype */
90 typedef struct s_smx_timer {
91   double date;
92   void* func;
93   void* args;
94 } s_smx_timer_t;
95
96 /********************************* Action *************************************/
97
98 typedef enum {
99   SIMIX_ACTION_EXECUTE,
100   SIMIX_ACTION_PARALLEL_EXECUTE,
101   SIMIX_ACTION_COMMUNICATE,
102   SIMIX_ACTION_JOIN,
103   SIMIX_ACTION_SLEEP,
104   SIMIX_ACTION_SYNCHRO,
105   SIMIX_ACTION_IO,
106   /* ****************************************************************************************** */
107   /* TUTORIAL: New API                                                                        */
108   /* ****************************************************************************************** */
109   SIMIX_ACTION_NEW_API
110 } e_smx_action_type_t;
111
112 typedef enum {
113   SIMIX_COMM_SEND,
114   SIMIX_COMM_RECEIVE,
115   SIMIX_COMM_READY,
116   SIMIX_COMM_DONE
117 } e_smx_comm_type_t;
118
119 typedef enum {
120   SIMIX_IO_OPEN,
121   SIMIX_IO_WRITE,
122   SIMIX_IO_READ,
123   SIMIX_IO_STAT
124 } e_smx_io_type_t;
125
126 /** @brief Action datatype */
127 typedef struct s_smx_action {
128
129   e_smx_action_type_t type;          /* Type of SIMIX action*/
130   e_smx_state_t state;               /* State of the action */
131   char *name;                        /* Action name if any */
132   xbt_fifo_t simcalls;               /* List of simcalls waiting for this action */
133
134   /* Data specific to each action type */
135   union {
136
137     struct {
138       smx_host_t host;                /* The host where the execution takes place */
139       surf_action_t surf_exec;        /* The Surf execution action encapsulated */
140     } execution; /* Possibly parallel execution */
141
142     struct {
143       e_smx_comm_type_t type;         /* Type of the communication (SIMIX_COMM_SEND or SIMIX_COMM_RECEIVE) */
144       smx_rdv_t rdv;                  /* Rendez-vous where the comm is queued */
145
146 #ifdef HAVE_MC
147       smx_rdv_t rdv_cpy;              /* Copy of the rendez-vous where the comm is queued, MC needs it for DPOR
148                                          (comm.rdv set to NULL when the communication is removed from the mailbox
149                                          (used as garbage collector)) */
150 #endif
151       int refcount;                   /* Number of processes involved in the cond */
152       int detached;                   /* If detached or not */
153
154       void (*clean_fun)(void*);       /* Function to clean the detached src_buf if something goes wrong */
155       int (*match_fun)(void*,void*,smx_action_t);  /* Filter function used by the other side. It is used when
156                                          looking if a given communication matches my needs. For that, myself must match the
157                                          expectations of the other side, too. See  */
158
159       /* Surf action data */
160       surf_action_t surf_comm;        /* The Surf communication action encapsulated */
161       surf_action_t src_timeout;      /* Surf's actions to instrument the timeouts */
162       surf_action_t dst_timeout;      /* Surf's actions to instrument the timeouts */
163       smx_process_t src_proc;
164       smx_process_t dst_proc;
165       double rate;
166       double task_size;
167
168       /* Data to be transfered */
169       void *src_buff;
170       void *dst_buff;
171       size_t src_buff_size;
172       size_t *dst_buff_size;
173       unsigned copied:1;              /* whether the data were already copied */
174
175       void* src_data;                 /* User data associated to communication */
176       void* dst_data;
177     } comm;
178
179     struct {
180       smx_host_t host;                /* The host that is sleeping */
181       surf_action_t surf_sleep;       /* The Surf sleeping action encapsulated */
182     } sleep;
183
184     struct {
185       surf_action_t sleep;
186     } synchro;
187
188     struct {
189       smx_host_t host;
190       surf_action_t surf_io;
191     } io;
192
193     /* ****************************************************************************************** */
194     /* TUTORIAL: New API                                                                        */
195     /* ****************************************************************************************** */
196     struct {
197       surf_action_t surf_new_api;
198     } new_api;
199   };
200
201 #ifdef HAVE_LATENCY_BOUND_TRACKING
202   int latency_limited;
203 #endif
204
205 #ifdef HAVE_TRACING
206   char *category;                     /* simix action category for instrumentation */
207 #endif
208 } s_smx_action_t;
209
210 void SIMIX_context_mod_init(void);
211 void SIMIX_context_mod_exit(void);
212
213 #ifndef WIN32
214 XBT_PUBLIC_DATA(char sigsegv_stack[SIGSTKSZ]);
215 #endif
216
217 /* We are using the bottom of the stack to save some information, like the
218  * valgrind_stack_id. Define smx_context_usable_stack_size to give the remaining
219  * size for the stack. */
220 #ifdef HAVE_VALGRIND_VALGRIND_H
221 # define smx_context_usable_stack_size                                  \
222   (smx_context_stack_size - sizeof(unsigned int)) /* for valgrind_stack_id */
223 #else
224 # define smx_context_usable_stack_size smx_context_stack_size
225 #endif
226
227 void *SIMIX_context_stack_new(void);
228 void SIMIX_context_stack_delete(void *stack);
229
230 void SIMIX_context_set_current(smx_context_t context);
231 smx_context_t SIMIX_context_get_current(void);
232
233 /* All factories init */
234
235 void SIMIX_ctx_thread_factory_init(smx_context_factory_t *factory);
236 void SIMIX_ctx_sysv_factory_init(smx_context_factory_t *factory);
237 void SIMIX_ctx_raw_factory_init(smx_context_factory_t *factory);
238
239 /* ****************************** */
240 /* context manipulation functions */
241 /* ****************************** */
242
243 /* Scenario for the end of a context:
244  *
245  * CASE 1: death after end of the main function
246  *   the context_wrapper, called internally by the context module, calls
247  *   SIMIX_context_stop after user code stops, smx_context_stop calls user
248  *   cleanup_func if any (in context settings), add current process to trashbin
249  *   and yields back to maestro.
250  *   From time to time, maestro calls SIMIX_context_empty_trash, which destroy
251  *   all the process and context data structures, and frees the memory
252  *
253  * CASE 2: brutal death
254  *   SIMIX_process_kill (from any process) set process->iwannadie = 1 and then
255  *   schedules the process. Then the process is awaken in the middle of the
256  *   SIMIX_process_yield function, and at the end of it, it checks that
257  *   iwannadie == 1, and call SIMIX_context_stop(same than first case afterward)
258  */
259
260 /**
261  * \brief creates a new context for a user level process
262  * \param code a main function
263  * \param argc the number of arguments of the main function
264  * \param argv the vector of arguments of the main function
265  * \param cleanup_func the function to call when the context stops
266  * \param cleanup_arg the argument of the cleanup_func function
267  */
268 static XBT_INLINE smx_context_t SIMIX_context_new(xbt_main_func_t code,
269                                                   int argc, char **argv,
270                                                   void_pfn_smxprocess_t cleanup_func,
271                                                   smx_process_t simix_process)
272 {
273   if (!simix_global)
274     xbt_die("simix is not initialized, please call MSG_init first");
275   return simix_global->context_factory->create_context(code,
276                                                        argc, argv,
277                                                        cleanup_func,
278                                                        simix_process);
279 }
280
281 /**
282  * \brief destroy a context
283  * \param context the context to destroy
284  * Argument must be stopped first -- runs in maestro context
285  */
286 static XBT_INLINE void SIMIX_context_free(smx_context_t context)
287 {
288   simix_global->context_factory->free(context);
289 }
290
291 /**
292  * \brief stops the execution of a context
293  * \param context to stop
294  */
295 static XBT_INLINE void SIMIX_context_stop(smx_context_t context)
296 {
297   simix_global->context_factory->stop(context);
298 }
299
300 /**
301  \brief suspends a context and return the control back to the one which
302         scheduled it
303  \param context the context to be suspended (it must be the running one)
304  */
305 static XBT_INLINE void SIMIX_context_suspend(smx_context_t context)
306 {
307   simix_global->context_factory->suspend(context);
308 }
309
310 /**
311  \brief Executes all the processes to run (in parallel if possible).
312  */
313 static XBT_INLINE void SIMIX_context_runall(void)
314 {
315   if (!xbt_dynar_is_empty(simix_global->process_to_run)) {
316     simix_global->context_factory->runall();
317   }
318 }
319
320 /**
321  \brief returns the current running context
322  */
323 static XBT_INLINE smx_context_t SIMIX_context_self(void)
324 {
325   if (simix_global && simix_global->context_factory) {
326     return simix_global->context_factory->self();
327   }
328   return NULL;
329 }
330
331 /**
332  \brief returns the SIMIX process associated to a context
333  \param context The context
334  \return The SIMIX process
335  */
336 static XBT_INLINE smx_process_t SIMIX_context_get_process(smx_context_t context)
337 {
338   return simix_global->context_factory->get_process(context);
339 }
340
341 XBT_PUBLIC(int) SIMIX_process_get_maxpid(void);
342
343 void SIMIX_post_create_environment(void);
344
345 #endif