Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Use a dynar instead of a swag to implement the process_to_run list.
[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/config.h"
16 #include "xbt/function_types.h"
17 #include "xbt/ex_interface.h"
18 #include "instr/instr_private.h"
19 #include "process_private.h"
20 #include "host_private.h"
21 #include "network_private.h"
22 #include "smurf_private.h"
23 #include "synchro_private.h"
24 #include "simix/context.h"
25
26 /********************************** Simix Global ******************************/
27
28
29 typedef struct s_smx_global {
30   smx_context_factory_t context_factory;
31   xbt_dict_t host;
32   xbt_dynar_t process_to_run;
33   xbt_swag_t process_list;
34   xbt_swag_t process_to_destroy;
35   smx_process_t maestro_process;
36   xbt_dict_t registered_functions;
37   smx_creation_func_t create_process_function;
38   void_f_pvoid_t kill_process_function;
39   void_pfn_smxprocess_t cleanup_process_function;
40 #ifdef HAVE_LATENCY_BOUND_TRACKING
41   xbt_dict_t latency_limited_dict;
42 #endif
43 } s_smx_global_t, *smx_global_t;
44
45 extern smx_global_t simix_global;
46
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
96       /* Surf action data */
97       surf_action_t surf_comm;        /* The Surf communication action encapsulated */
98       surf_action_t src_timeout;      /* Surf's actions to instrument the timeouts */
99       surf_action_t dst_timeout;      /* Surf's actions to instrument the timeouts */
100       smx_process_t src_proc;
101       smx_process_t dst_proc;
102       double rate;
103       double task_size;
104
105       /* Data to be transfered */
106       void *src_buff;
107       void *dst_buff;
108       size_t src_buff_size;
109       size_t *dst_buff_size;
110       char copied;
111
112       void* src_data;                     /* User data associated to communication */
113       void* dst_data;
114     } comm;    
115
116     struct {
117       smx_host_t host;                /* The host that is sleeping */
118       surf_action_t surf_sleep;       /* The Surf sleeping action encapsulated */
119     } sleep;
120
121     struct {
122       surf_action_t sleep;
123     } synchro;
124
125   };
126
127 #ifdef HAVE_TRACING
128   char *category;                     /* simix action category for instrumentation */
129 #endif
130 } s_smx_action_t;
131
132 /* FIXME: check if we can delete this function */
133 static XBT_INLINE e_smx_state_t SIMIX_action_map_state(e_surf_action_state_t state)
134 {
135   switch (state) {
136     case SURF_ACTION_READY:
137       return SIMIX_READY;
138     case SURF_ACTION_RUNNING:
139       return SIMIX_RUNNING;
140     case SURF_ACTION_FAILED:
141       return SIMIX_FAILED;
142     case SURF_ACTION_DONE:
143       return SIMIX_DONE;
144     default:
145       xbt_die("Unexpected SURF action state");
146   }
147 }
148
149
150
151 void SIMIX_context_mod_init(void);
152 void SIMIX_context_mod_exit(void);
153
154
155 /* All factories init */
156 void SIMIX_ctx_thread_factory_init(smx_context_factory_t *factory);
157 void SIMIX_ctx_sysv_factory_init(smx_context_factory_t *factory);
158 void SIMIX_ctx_raw_factory_init(smx_context_factory_t *factory);
159
160 /* ****************************** */
161 /* context manipulation functions */
162 /* ****************************** */
163
164 /* Scenario for the end of a context:
165  *
166  * CASE 1: death after end of the main function
167  *   the context_wrapper, called internally by the context module, calls 
168  *   SIMIX_context_stop after user code stops, smx_context_stop calls user 
169  *   cleanup_func if any (in context settings), add current process to trashbin
170  *   and yields back to maestro.
171  *   From time to time, maestro calls SIMIX_context_empty_trash, which destroy
172  *   all the process and context data structures, and frees the memory 
173  *
174  * CASE 2: brutal death
175  *   SIMIX_process_kill (from any process) set process->iwannadie = 1 and then
176  *   schedules the process. Then the process is awaken in the middle of the
177  *   SIMIX_process_yield function, and at the end of it, it checks that
178  *   iwannadie == 1, and call SIMIX_context_stop(same than first case afterward)
179  */
180
181 /**
182  * \brief creates a new context for a user level process
183  * \param code a main function
184  * \param argc the number of arguments of the main function
185  * \param argv the vector of arguments of the main function
186  * \param cleanup_func the function to call when the context stops
187  * \param cleanup_arg the argument of the cleanup_func function
188  */
189 static XBT_INLINE smx_context_t SIMIX_context_new(xbt_main_func_t code,
190                                                   int argc, char **argv,
191                                                   void_pfn_smxprocess_t cleanup_func,
192                                                   smx_process_t simix_process)
193 {
194
195   return (*(simix_global->context_factory->create_context))
196       (code, argc, argv, cleanup_func, simix_process);
197 }
198
199 /**
200  * \brief destroy a context 
201  * \param context the context to destroy
202  * Argument must be stopped first -- runs in maestro context
203  */
204 static XBT_INLINE void SIMIX_context_free(smx_context_t context)
205 {
206   (*(simix_global->context_factory->free)) (context);
207 }
208
209 /**
210  * \brief stops the execution of a context
211  * \param context to stop
212  */
213 static XBT_INLINE void SIMIX_context_stop(smx_context_t context)
214 {
215   (*(simix_global->context_factory->stop)) (context);
216 }
217
218 /**
219  \brief suspends a context and return the control back to the one which
220         scheduled it
221  \param context the context to be suspended (it must be the running one)
222  */
223 static XBT_INLINE void SIMIX_context_suspend(smx_context_t context)
224 {
225   (*(simix_global->context_factory->suspend)) (context);
226 }
227
228 /**
229  \brief executes all the processes (in parallel if possible)
230  \param processes the dynar of processes to execute
231  */
232 static XBT_INLINE void SIMIX_context_runall(xbt_dynar_t processes)
233 {
234   (*(simix_global->context_factory->runall)) (processes);
235 }
236
237 /**
238  \brief returns the current running context 
239  */
240 static XBT_INLINE smx_context_t SIMIX_context_self(void)
241 {
242   if (simix_global && simix_global->context_factory != NULL) {
243     return (*(simix_global->context_factory->self))();
244   }
245
246   return NULL;
247 }
248
249 /**
250  \brief returns the data associated to a context
251  \param context The context
252  \return The data
253  */
254 static XBT_INLINE void* SIMIX_context_get_data(smx_context_t context)
255 {
256   return (*(simix_global->context_factory->get_data))(context);
257 }
258
259 XBT_PUBLIC(int) SIMIX_process_get_maxpid(void);
260 #endif