1 /* Copyright (c) 2007, 2008, 2009, 2010. The SimGrid Team.
2 * All rights reserved. */
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. */
7 #ifndef _SIMIX_PRIVATE_H
8 #define _SIMIX_PRIVATE_H
10 #include "simix/simix.h"
11 #include "surf/surf.h"
15 #include "xbt/config.h"
16 #include "xbt/function_types.h"
17 #include "xbt/ex_interface.h"
18 #include "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"
25 extern int _surf_do_model_check;
27 /********************************** Simix Global ******************************/
29 typedef struct s_smx_context_factory *smx_context_factory_t;
31 typedef struct SIMIX_Global {
32 smx_context_factory_t context_factory;
34 xbt_swag_t process_to_run;
35 xbt_swag_t process_list;
36 xbt_swag_t process_to_destroy;
37 smx_process_t current_process;
38 smx_process_t maestro_process;
39 xbt_dict_t registered_functions;
40 smx_creation_func_t create_process_function;
41 void_f_pvoid_t kill_process_function;
42 void_pfn_smxprocess_t cleanup_process_function;
43 #ifdef HAVE_LATENCY_BOUND_TRACKING
44 xbt_dict_t latency_limited_dict;
46 } s_SIMIX_Global_t, *SIMIX_Global_t;
48 extern SIMIX_Global_t simix_global;
51 /*********************************** Time ************************************/
53 /** @brief Timer datatype */
54 typedef struct s_smx_timer {
60 /********************************* Action *************************************/
64 SIMIX_ACTION_PARALLEL_EXECUTE,
65 SIMIX_ACTION_COMMUNICATE,
69 } e_smx_action_type_t;
78 /** @brief Action datatype */
79 typedef struct s_smx_action {
81 e_smx_action_type_t type; /* Type of SIMIX action*/
82 e_smx_state_t state; /* State of the action */
83 char *name; /* Action name if any */
84 xbt_fifo_t request_list; /* List of requests on this action */
86 /* Data specific to each action type */
90 smx_host_t host; /* The host where the execution takes place */
91 surf_action_t surf_exec; /* The Surf execution action encapsulated */
92 } execution; /* Possibly parallel execution */
95 e_smx_comm_type_t type; /* Type of the communication (SIMIX_COMM_SEND or SIMIX_COMM_RECEIVE) */
96 smx_rdv_t rdv; /* Rendez-vous where the comm is queued */
97 int refcount; /* Number of processes involved in the cond */
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;
108 /* Data to be transfered */
111 size_t src_buff_size;
112 size_t *dst_buff_size;
115 void *data; /* User data associated to communication */
119 smx_host_t host; /* The host that is sleeping */
120 surf_action_t surf_sleep; /* The Surf sleeping action encapsulated */
130 long long int counter; /* simix action unique identifier for instrumentation */
131 char *category; /* simix action category for instrumentation */
135 /* FIXME: check if we can delete this function */
136 static XBT_INLINE e_smx_state_t SIMIX_action_map_state(e_surf_action_state_t state)
139 case SURF_ACTION_READY:
141 case SURF_ACTION_RUNNING:
142 return SIMIX_RUNNING;
143 case SURF_ACTION_FAILED:
145 case SURF_ACTION_DONE:
148 xbt_die("Unexpected SURF action state");
152 /******************************** Context *************************************/
154 /* The following function pointer types describe the interface that any context
155 factory should implement */
158 typedef smx_context_t(*smx_pfn_context_factory_create_context_t)
159 (xbt_main_func_t, int, char **, void_pfn_smxprocess_t, smx_process_t);
160 typedef int (*smx_pfn_context_factory_finalize_t) (smx_context_factory_t
162 typedef void (*smx_pfn_context_free_t) (smx_context_t);
163 typedef void (*smx_pfn_context_start_t) (smx_context_t);
164 typedef void (*smx_pfn_context_stop_t) (smx_context_t);
165 typedef void (*smx_pfn_context_suspend_t) (smx_context_t context);
166 typedef void (*smx_pfn_context_runall_t) (xbt_swag_t processes);
167 typedef smx_process_t (*smx_pfn_context_self_t) (void);
169 /* interface of the context factories */
170 typedef struct s_smx_context_factory {
171 smx_pfn_context_factory_create_context_t create_context;
172 smx_pfn_context_factory_finalize_t finalize;
173 smx_pfn_context_free_t free;
174 smx_pfn_context_stop_t stop;
175 smx_pfn_context_suspend_t suspend;
176 smx_pfn_context_runall_t runall;
177 smx_pfn_context_self_t self;
179 } s_smx_context_factory_t;
182 void SIMIX_context_mod_init(void);
184 void SIMIX_context_mod_exit(void);
187 /* All factories init */
188 void SIMIX_ctx_thread_factory_init(smx_context_factory_t * factory);
189 void SIMIX_ctx_sysv_factory_init(smx_context_factory_t * factory);
191 /* ****************************** */
192 /* context manipulation functions */
193 /* ****************************** */
195 /* Scenario for the end of a context:
197 * CASE 1: death after end of the main function
198 * the context_wrapper, called internally by the context module, calls
199 * SIMIX_context_stop after user code stops, smx_context_stop calls user
200 * cleanup_func if any (in context settings), add current process to trashbin
201 * and yields back to maestro.
202 * From time to time, maestro calls SIMIX_context_empty_trash, which destroy
203 * all the process and context data structures, and frees the memory
205 * CASE 2: brutal death
206 * SIMIX_process_kill (from any process) set process->iwannadie = 1 and then
207 * schedules the process. Then the process is awaken in the middle of the
208 * SIMIX_process_yield function, and at the end of it, it checks that
209 * iwannadie == 1, and call SIMIX_context_stop(same than first case afterward)
213 * \brief creates a new context for a user level process
214 * \param code a main function
215 * \param argc the number of arguments of the main function
216 * \param argv the vector of arguments of the main function
217 * \param cleanup_func the function to call when the context stops
218 * \param cleanup_arg the argument of the cleanup_func function
220 static XBT_INLINE smx_context_t SIMIX_context_new(xbt_main_func_t code,
221 int argc, char **argv,
222 void_pfn_smxprocess_t cleanup_func,
223 smx_process_t simix_process)
226 return (*(simix_global->context_factory->create_context))
227 (code, argc, argv, cleanup_func, simix_process);
231 * \brief destroy a context
232 * \param context the context to destroy
233 * Argument must be stopped first -- runs in maestro context
235 static XBT_INLINE void SIMIX_context_free(smx_context_t context)
237 (*(simix_global->context_factory->free)) (context);
241 * \brief stops the execution of a context
242 * \param context to stop
244 static XBT_INLINE void SIMIX_context_stop(smx_context_t context)
246 (*(simix_global->context_factory->stop)) (context);
250 \brief suspends a context and return the control back to the one which
252 \param context the context to be suspended (it must be the running one)
254 static XBT_INLINE void SIMIX_context_suspend(smx_context_t context)
256 (*(simix_global->context_factory->suspend)) (context);
260 \brief executes all the processes (in parallel if possible)
261 \param processes the swag of processes to execute
263 static XBT_INLINE void SIMIX_context_runall(xbt_swag_t processes)
265 (*(simix_global->context_factory->runall)) (processes);
269 \brief returns the current running process
271 static XBT_INLINE smx_process_t SIMIX_context_self(void)
273 if (simix_global->context_factory == NULL) {
277 return (*(simix_global->context_factory->self))();