Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
87a76e437913f83d65730dbbc2f1af747257d8db
[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 /******************************** Exceptions *********************************/
63
64 #define SMX_EXCEPTION(issuer, c, v, m)                                  \
65   if (1) {                                                              \
66     smx_process_t _smx_throw_issuer = (issuer);                         \
67     THROW_PREPARE(_smx_throw_issuer->running_ctx, (c), (v), xbt_strdup(m)); \
68     _smx_throw_issuer->doexception = 1;                                 \
69   } else ((void)0)
70
71 #define SMX_THROW() RETHROW
72
73 /* ******************************** File ************************************ */
74 typedef struct s_smx_file {
75   surf_file_t surf_file;
76   void* data;                   /**< @brief user data */
77 } s_smx_file_t;
78
79 /*********************************** Time ************************************/
80
81 /** @brief Timer datatype */
82 typedef struct s_smx_timer {
83   double date;
84   void* func;
85   void* args;
86 } s_smx_timer_t;
87
88 /********************************* Action *************************************/
89
90 typedef enum {
91   SIMIX_ACTION_EXECUTE,
92   SIMIX_ACTION_PARALLEL_EXECUTE,
93   SIMIX_ACTION_COMMUNICATE,
94   SIMIX_ACTION_SLEEP,
95   SIMIX_ACTION_SYNCHRO,
96   SIMIX_ACTION_IO,
97   /* ****************************************************************************************** */
98   /* TUTORIAL: New API                                                                        */
99   /* ****************************************************************************************** */
100   SIMIX_ACTION_NEW_API
101 } e_smx_action_type_t;
102
103 typedef enum {
104   SIMIX_COMM_SEND,
105   SIMIX_COMM_RECEIVE,
106   SIMIX_COMM_READY,
107   SIMIX_COMM_DONE
108 } e_smx_comm_type_t;
109
110 typedef enum {
111   SIMIX_IO_OPEN,
112   SIMIX_IO_WRITE,
113   SIMIX_IO_READ,
114   SIMIX_IO_STAT
115 } e_smx_io_type_t;
116
117 /** @brief Action datatype */
118 typedef struct s_smx_action {
119
120   e_smx_action_type_t type;          /* Type of SIMIX action*/
121   e_smx_state_t state;               /* State of the action */
122   char *name;                        /* Action name if any */
123   xbt_fifo_t simcalls;               /* List of simcalls waiting for this action */
124
125   /* Data specific to each action type */
126   union {
127
128     struct {
129       smx_host_t host;                /* The host where the execution takes place */
130       surf_action_t surf_exec;        /* The Surf execution action encapsulated */
131     } execution; /* Possibly parallel execution */
132
133     struct {
134       e_smx_comm_type_t type;         /* Type of the communication (SIMIX_COMM_SEND or SIMIX_COMM_RECEIVE) */
135       smx_rdv_t rdv;                  /* Rendez-vous where the comm is queued */
136
137 #ifdef HAVE_MC
138       smx_rdv_t rdv_cpy;              /* Copy of the rendez-vous where the comm is queued, MC needs it for DPOR 
139                                          (comm.rdv set to NULL when the communication is removed from the mailbox 
140                                          (used as garbage collector)) */
141 #endif
142       int refcount;                   /* Number of processes involved in the cond */
143       int detached;                   /* If detached or not */
144
145       void (*clean_fun)(void*);       /* Function to clean the detached src_buf if something goes wrong */
146       int (*match_fun)(void*,void*,smx_action_t);  /* Filter function used by the other side. It is used when
147                                          looking if a given communication matches my needs. For that, myself must match the
148                                          expectations of the other side, too. See  */
149
150       /* Surf action data */
151       surf_action_t surf_comm;        /* The Surf communication action encapsulated */
152       surf_action_t src_timeout;      /* Surf's actions to instrument the timeouts */
153       surf_action_t dst_timeout;      /* Surf's actions to instrument the timeouts */
154       smx_process_t src_proc;
155       smx_process_t dst_proc;
156       double rate;
157       double task_size;
158
159       /* Data to be transfered */
160       void *src_buff;
161       void *dst_buff;
162       size_t src_buff_size;
163       size_t *dst_buff_size;
164       unsigned copied:1;              /* whether the data were already copied */
165
166       void* src_data;                 /* User data associated to communication */
167       void* dst_data;
168     } comm;    
169
170     struct {
171       smx_host_t host;                /* The host that is sleeping */
172       surf_action_t surf_sleep;       /* The Surf sleeping action encapsulated */
173     } sleep;
174
175     struct {
176       surf_action_t sleep;
177     } synchro;
178
179     struct {
180       smx_host_t host;
181       surf_action_t surf_io;
182     } io;
183
184     /* ****************************************************************************************** */
185     /* TUTORIAL: New API                                                                        */
186     /* ****************************************************************************************** */
187     struct {
188       surf_action_t surf_new_api;
189     } new_api;
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 void *SIMIX_context_stack_new(void);
205 void SIMIX_context_stack_delete(void *stack);
206
207 void SIMIX_context_set_current(smx_context_t context);
208 smx_context_t SIMIX_context_get_current(void);
209
210 /* All factories init */
211
212 void SIMIX_ctx_thread_factory_init(smx_context_factory_t *factory);
213 void SIMIX_ctx_sysv_factory_init(smx_context_factory_t *factory);
214 void SIMIX_ctx_raw_factory_init(smx_context_factory_t *factory);
215
216 /* ****************************** */
217 /* context manipulation functions */
218 /* ****************************** */
219
220 /* Scenario for the end of a context:
221  *
222  * CASE 1: death after end of the main function
223  *   the context_wrapper, called internally by the context module, calls 
224  *   SIMIX_context_stop after user code stops, smx_context_stop calls user 
225  *   cleanup_func if any (in context settings), add current process to trashbin
226  *   and yields back to maestro.
227  *   From time to time, maestro calls SIMIX_context_empty_trash, which destroy
228  *   all the process and context data structures, and frees the memory 
229  *
230  * CASE 2: brutal death
231  *   SIMIX_process_kill (from any process) set process->iwannadie = 1 and then
232  *   schedules the process. Then the process is awaken in the middle of the
233  *   SIMIX_process_yield function, and at the end of it, it checks that
234  *   iwannadie == 1, and call SIMIX_context_stop(same than first case afterward)
235  */
236
237 /**
238  * \brief creates a new context for a user level process
239  * \param code a main function
240  * \param argc the number of arguments of the main function
241  * \param argv the vector of arguments of the main function
242  * \param cleanup_func the function to call when the context stops
243  * \param cleanup_arg the argument of the cleanup_func function
244  */
245 static XBT_INLINE smx_context_t SIMIX_context_new(xbt_main_func_t code,
246                                                   int argc, char **argv,
247                                                   void_pfn_smxprocess_t cleanup_func,
248                                                   smx_process_t simix_process)
249 {
250   if (!simix_global)
251     xbt_die("simix is not initialized, please call MSG_init first");
252   return simix_global->context_factory->create_context(code,
253                                                        argc, argv,
254                                                        cleanup_func,
255                                                        simix_process);
256 }
257
258 /**
259  * \brief destroy a context 
260  * \param context the context to destroy
261  * Argument must be stopped first -- runs in maestro context
262  */
263 static XBT_INLINE void SIMIX_context_free(smx_context_t context)
264 {
265   simix_global->context_factory->free(context);
266 }
267
268 /**
269  * \brief stops the execution of a context
270  * \param context to stop
271  */
272 static XBT_INLINE void SIMIX_context_stop(smx_context_t context)
273 {
274   simix_global->context_factory->stop(context);
275 }
276
277 /**
278  \brief suspends a context and return the control back to the one which
279         scheduled it
280  \param context the context to be suspended (it must be the running one)
281  */
282 static XBT_INLINE void SIMIX_context_suspend(smx_context_t context)
283 {
284   simix_global->context_factory->suspend(context);
285 }
286
287 /**
288  \brief Executes all the processes to run (in parallel if possible).
289  */
290 static XBT_INLINE void SIMIX_context_runall(void)
291 {
292   if (!xbt_dynar_is_empty(simix_global->process_to_run)) {
293     simix_global->context_factory->runall();
294   }
295 }
296
297 /**
298  \brief returns the current running context 
299  */
300 static XBT_INLINE smx_context_t SIMIX_context_self(void)
301 {
302   if (simix_global && simix_global->context_factory) {
303     return simix_global->context_factory->self();
304   }
305   return NULL;
306 }
307
308 /**
309  \brief returns the SIMIX process associated to a context
310  \param context The context
311  \return The SIMIX process
312  */
313 static XBT_INLINE smx_process_t SIMIX_context_get_process(smx_context_t context)
314 {
315   return simix_global->context_factory->get_process(context);
316 }
317
318 XBT_PUBLIC(int) SIMIX_process_get_maxpid(void);
319
320 void SIMIX_post_create_environment(void);
321
322 #endif