Logo AND Algorithmique Numérique Distribuée

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