Logo AND Algorithmique Numérique Distribuée

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