Logo AND Algorithmique Numérique Distribuée

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