Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
b19e9665848d6c54f0d55d78d0bec5587d6200b5
[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/function_types.h"
18 #include "xbt/ex_interface.h"
19 #include "instr/instr_private.h"
20 #include "smx_process_private.h"
21 #include "smx_host_private.h"
22 #include "smx_io_private.h"
23 #include "smx_network_private.h"
24 #include "smx_smurf_private.h"
25 #include "smx_synchro_private.h"
26 #include "simix/context.h"
27
28 /* Define only for SimGrid benchmarking purposes */
29 #undef TIME_BENCH
30
31 /********************************** Simix Global ******************************/
32 typedef struct s_smx_global {
33   smx_context_factory_t context_factory;
34   xbt_dynar_t process_to_run;
35   xbt_dynar_t process_that_ran;
36   xbt_swag_t process_list;
37   xbt_swag_t process_to_destroy;
38   smx_process_t maestro_process;
39   xbt_dict_t registered_functions;
40   smx_creation_func_t create_process_function;
41   void_pfn_smxprocess_t kill_process_function;
42   void_pfn_smxprocess_t cleanup_process_function;
43   xbt_mallocator_t action_mallocator;
44 } s_smx_global_t, *smx_global_t;
45
46 extern smx_global_t simix_global;
47 extern unsigned long simix_process_maxpid;
48
49 /******************************** Exceptions *********************************/
50
51 #define SMX_EXCEPTION(issuer, c, v, m)                                  \
52   if (1) {                                                              \
53     smx_process_t _smx_throw_issuer = (issuer);                         \
54     THROW_PREPARE(_smx_throw_issuer->running_ctx, (c), (v), xbt_strdup(m)); \
55     _smx_throw_issuer->doexception = 1;                                 \
56   } else ((void)0)
57
58 #define SMX_THROW() RETHROW
59
60 /* ******************************** File ************************************ */
61 typedef struct s_smx_file {
62   surf_file_t surf_file;
63 } s_smx_file_t;
64
65 typedef struct s_smx_stat {
66   s_file_stat_t surf_stat;
67 } s_smx_stat_t;
68
69 /*********************************** Time ************************************/
70
71 /** @brief Timer datatype */
72 typedef struct s_smx_timer {
73   double date;
74   void* func;
75   void* args;
76 } s_smx_timer_t;
77
78 /********************************* Action *************************************/
79
80 typedef enum {
81   SIMIX_ACTION_EXECUTE,
82   SIMIX_ACTION_PARALLEL_EXECUTE,
83   SIMIX_ACTION_COMMUNICATE,
84   SIMIX_ACTION_SLEEP,
85   SIMIX_ACTION_SYNCHRO,
86   SIMIX_ACTION_IO
87 } e_smx_action_type_t;
88
89 typedef enum {
90   SIMIX_COMM_SEND,
91   SIMIX_COMM_RECEIVE,
92   SIMIX_COMM_READY,
93   SIMIX_COMM_DONE
94 } e_smx_comm_type_t;
95
96 typedef enum {
97   SIMIX_IO_OPEN,
98   SIMIX_IO_WRITE,
99   SIMIX_IO_READ,
100   SIMIX_IO_STAT
101 } e_smx_io_type_t;
102
103 /** @brief Action datatype */
104 typedef struct s_smx_action {
105
106   e_smx_action_type_t type;          /* Type of SIMIX action*/
107   e_smx_state_t state;               /* State of the action */
108   char *name;                        /* Action name if any */
109   xbt_fifo_t simcalls;               /* List of simcalls waiting for this action */
110
111   /* Data specific to each action type */
112   union {
113
114     struct {
115       smx_host_t host;                /* The host where the execution takes place */
116       surf_action_t surf_exec;        /* The Surf execution action encapsulated */
117     } execution; /* Possibly parallel execution */
118
119     struct {
120       e_smx_comm_type_t type;         /* Type of the communication (SIMIX_COMM_SEND or SIMIX_COMM_RECEIVE) */
121       smx_rdv_t rdv;                  /* Rendez-vous where the comm is queued */
122       int refcount;                   /* Number of processes involved in the cond */
123       int detached;                   /* If detached or not */
124
125       void (*clean_fun)(void*);       /* Function to clean the detached src_buf if something goes wrong */
126       int (*match_fun)(void*,void*,smx_action_t);  /* Filter function used by the other side. It is used when
127                                          looking if a given communication matches my needs. For that, myself must match the
128                                          expectations of the other side, too. See  */
129
130       /* Surf action data */
131       surf_action_t surf_comm;        /* The Surf communication action encapsulated */
132       surf_action_t src_timeout;      /* Surf's actions to instrument the timeouts */
133       surf_action_t dst_timeout;      /* Surf's actions to instrument the timeouts */
134       smx_process_t src_proc;
135       smx_process_t dst_proc;
136       double rate;
137       double task_size;
138
139       /* Data to be transfered */
140       void *src_buff;
141       void *dst_buff;
142       size_t src_buff_size;
143       size_t *dst_buff_size;
144       char copied;
145
146       void* src_data;                     /* User data associated to communication */
147       void* dst_data;
148     } comm;    
149
150     struct {
151       smx_host_t host;                /* The host that is sleeping */
152       surf_action_t surf_sleep;       /* The Surf sleeping action encapsulated */
153     } sleep;
154
155     struct {
156       surf_action_t sleep;
157     } synchro;
158
159     struct {
160       smx_host_t host;
161       surf_action_t surf_io;
162     } io;
163   };
164
165 #ifdef HAVE_LATENCY_BOUND_TRACKING
166   int latency_limited;
167 #endif
168
169 #ifdef HAVE_TRACING
170   char *category;                     /* simix action category for instrumentation */
171 #endif
172 } s_smx_action_t;
173
174 /* FIXME: check if we can delete this function */
175 static XBT_INLINE e_smx_state_t SIMIX_action_map_state(e_surf_action_state_t state)
176 {
177   switch (state) {
178     case SURF_ACTION_READY:
179       return SIMIX_READY;
180     case SURF_ACTION_RUNNING:
181       return SIMIX_RUNNING;
182     case SURF_ACTION_FAILED:
183       return SIMIX_FAILED;
184     case SURF_ACTION_DONE:
185       return SIMIX_DONE;
186     default:
187       xbt_die("Unexpected SURF action state");
188   }
189 }
190
191 void SIMIX_context_mod_init(void);
192 void SIMIX_context_mod_exit(void);
193
194 void SIMIX_context_set_current(smx_context_t context);
195 smx_context_t SIMIX_context_get_current(void);
196
197 /* All factories init */
198 void SIMIX_ctx_thread_factory_init(smx_context_factory_t *factory);
199 void SIMIX_ctx_sysv_factory_init(smx_context_factory_t *factory);
200 void SIMIX_ctx_raw_factory_init(smx_context_factory_t *factory);
201
202 /* ****************************** */
203 /* context manipulation functions */
204 /* ****************************** */
205
206 /* Scenario for the end of a context:
207  *
208  * CASE 1: death after end of the main function
209  *   the context_wrapper, called internally by the context module, calls 
210  *   SIMIX_context_stop after user code stops, smx_context_stop calls user 
211  *   cleanup_func if any (in context settings), add current process to trashbin
212  *   and yields back to maestro.
213  *   From time to time, maestro calls SIMIX_context_empty_trash, which destroy
214  *   all the process and context data structures, and frees the memory 
215  *
216  * CASE 2: brutal death
217  *   SIMIX_process_kill (from any process) set process->iwannadie = 1 and then
218  *   schedules the process. Then the process is awaken in the middle of the
219  *   SIMIX_process_yield function, and at the end of it, it checks that
220  *   iwannadie == 1, and call SIMIX_context_stop(same than first case afterward)
221  */
222
223 /**
224  * \brief creates a new context for a user level process
225  * \param code a main function
226  * \param argc the number of arguments of the main function
227  * \param argv the vector of arguments of the main function
228  * \param cleanup_func the function to call when the context stops
229  * \param cleanup_arg the argument of the cleanup_func function
230  */
231 static XBT_INLINE smx_context_t SIMIX_context_new(xbt_main_func_t code,
232                                                   int argc, char **argv,
233                                                   void_pfn_smxprocess_t cleanup_func,
234                                                   smx_process_t simix_process)
235 {
236
237   return simix_global->context_factory->create_context(code,
238                                                        argc, argv,
239                                                        cleanup_func,
240                                                        simix_process);
241 }
242
243 /**
244  * \brief destroy a context 
245  * \param context the context to destroy
246  * Argument must be stopped first -- runs in maestro context
247  */
248 static XBT_INLINE void SIMIX_context_free(smx_context_t context)
249 {
250   simix_global->context_factory->free(context);
251 }
252
253 /**
254  * \brief stops the execution of a context
255  * \param context to stop
256  */
257 static XBT_INLINE void SIMIX_context_stop(smx_context_t context)
258 {
259   simix_global->context_factory->stop(context);
260 }
261
262 /**
263  \brief suspends a context and return the control back to the one which
264         scheduled it
265  \param context the context to be suspended (it must be the running one)
266  */
267 static XBT_INLINE void SIMIX_context_suspend(smx_context_t context)
268 {
269   simix_global->context_factory->suspend(context);
270 }
271
272 /**
273  \brief Executes all the processes to run (in parallel if possible).
274  */
275 static XBT_INLINE void SIMIX_context_runall(void)
276 {
277   simix_global->context_factory->runall();
278 }
279
280 /**
281  \brief returns the current running context 
282  */
283 static XBT_INLINE smx_context_t SIMIX_context_self(void)
284 {
285   if (simix_global && simix_global->context_factory != NULL) {
286     return simix_global->context_factory->self();
287   }
288
289   return NULL;
290 }
291
292 /**
293  \brief returns the data associated to a context
294  \param context The context
295  \return The data
296  */
297 static XBT_INLINE void* SIMIX_context_get_data(smx_context_t context)
298 {
299   return simix_global->context_factory->get_data(context);
300 }
301
302 XBT_PUBLIC(int) SIMIX_process_get_maxpid(void);
303 #endif