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 "simgrid/simix.h"
11 #include "surf/surf.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"
27 /* Define only for SimGrid benchmarking purposes */
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;
45 extern smx_global_t simix_global;
46 extern unsigned long simix_process_maxpid;
48 /******************************** Exceptions *********************************/
50 #define SMX_EXCEPTION(issuer, c, v, m) \
52 smx_process_t _smx_throw_issuer = (issuer); \
53 THROW_PREPARE(_smx_throw_issuer->running_ctx, (c), (v), xbt_strdup(m)); \
54 _smx_throw_issuer->doexception = 1; \
57 #define SMX_THROW() RETHROW
59 /* ******************************** File ************************************ */
60 typedef struct s_smx_file {
61 surf_file_t surf_file;
64 typedef struct s_smx_stat {
65 s_file_stat_t surf_stat;
68 /*********************************** Time ************************************/
70 /** @brief Timer datatype */
71 typedef struct s_smx_timer {
77 /********************************* Action *************************************/
81 SIMIX_ACTION_PARALLEL_EXECUTE,
82 SIMIX_ACTION_COMMUNICATE,
86 } e_smx_action_type_t;
102 /** @brief Action datatype */
103 typedef struct s_smx_action {
105 e_smx_action_type_t type; /* Type of SIMIX action*/
106 e_smx_state_t state; /* State of the action */
107 char *name; /* Action name if any */
108 xbt_fifo_t simcalls; /* List of simcalls waiting for this action */
110 /* Data specific to each action type */
114 smx_host_t host; /* The host where the execution takes place */
115 surf_action_t surf_exec; /* The Surf execution action encapsulated */
116 } execution; /* Possibly parallel execution */
119 e_smx_comm_type_t type; /* Type of the communication (SIMIX_COMM_SEND or SIMIX_COMM_RECEIVE) */
120 smx_rdv_t rdv; /* Rendez-vous where the comm is queued */
121 int refcount; /* Number of processes involved in the cond */
122 int detached; /* If detached or not */
124 void (*clean_fun)(void*); /* Function to clean the detached src_buf if something goes wrong */
125 int (*match_fun)(void*,void*,smx_action_t); /* Filter function used by the other side. It is used when
126 looking if a given communication matches my needs. For that, myself must match the
127 expectations of the other side, too. See */
129 /* Surf action data */
130 surf_action_t surf_comm; /* The Surf communication action encapsulated */
131 surf_action_t src_timeout; /* Surf's actions to instrument the timeouts */
132 surf_action_t dst_timeout; /* Surf's actions to instrument the timeouts */
133 smx_process_t src_proc;
134 smx_process_t dst_proc;
138 /* Data to be transfered */
141 size_t src_buff_size;
142 size_t *dst_buff_size;
145 void* src_data; /* User data associated to communication */
150 smx_host_t host; /* The host that is sleeping */
151 surf_action_t surf_sleep; /* The Surf sleeping action encapsulated */
160 surf_action_t surf_io;
164 #ifdef HAVE_LATENCY_BOUND_TRACKING
169 char *category; /* simix action category for instrumentation */
173 /* FIXME: check if we can delete this function */
174 static XBT_INLINE e_smx_state_t SIMIX_action_map_state(e_surf_action_state_t state)
177 case SURF_ACTION_READY:
179 case SURF_ACTION_RUNNING:
180 return SIMIX_RUNNING;
181 case SURF_ACTION_FAILED:
183 case SURF_ACTION_DONE:
186 xbt_die("Unexpected SURF action state");
190 void SIMIX_context_mod_init(void);
191 void SIMIX_context_mod_exit(void);
193 void SIMIX_context_set_current(smx_context_t context);
194 smx_context_t SIMIX_context_get_current(void);
196 /* All factories init */
197 void SIMIX_ctx_thread_factory_init(smx_context_factory_t *factory);
198 void SIMIX_ctx_sysv_factory_init(smx_context_factory_t *factory);
199 void SIMIX_ctx_raw_factory_init(smx_context_factory_t *factory);
201 /* ****************************** */
202 /* context manipulation functions */
203 /* ****************************** */
205 /* Scenario for the end of a context:
207 * CASE 1: death after end of the main function
208 * the context_wrapper, called internally by the context module, calls
209 * SIMIX_context_stop after user code stops, smx_context_stop calls user
210 * cleanup_func if any (in context settings), add current process to trashbin
211 * and yields back to maestro.
212 * From time to time, maestro calls SIMIX_context_empty_trash, which destroy
213 * all the process and context data structures, and frees the memory
215 * CASE 2: brutal death
216 * SIMIX_process_kill (from any process) set process->iwannadie = 1 and then
217 * schedules the process. Then the process is awaken in the middle of the
218 * SIMIX_process_yield function, and at the end of it, it checks that
219 * iwannadie == 1, and call SIMIX_context_stop(same than first case afterward)
223 * \brief creates a new context for a user level process
224 * \param code a main function
225 * \param argc the number of arguments of the main function
226 * \param argv the vector of arguments of the main function
227 * \param cleanup_func the function to call when the context stops
228 * \param cleanup_arg the argument of the cleanup_func function
230 static XBT_INLINE smx_context_t SIMIX_context_new(xbt_main_func_t code,
231 int argc, char **argv,
232 void_pfn_smxprocess_t cleanup_func,
233 smx_process_t simix_process)
236 return simix_global->context_factory->create_context(code,
243 * \brief destroy a context
244 * \param context the context to destroy
245 * Argument must be stopped first -- runs in maestro context
247 static XBT_INLINE void SIMIX_context_free(smx_context_t context)
249 simix_global->context_factory->free(context);
253 * \brief stops the execution of a context
254 * \param context to stop
256 static XBT_INLINE void SIMIX_context_stop(smx_context_t context)
258 simix_global->context_factory->stop(context);
262 \brief suspends a context and return the control back to the one which
264 \param context the context to be suspended (it must be the running one)
266 static XBT_INLINE void SIMIX_context_suspend(smx_context_t context)
268 simix_global->context_factory->suspend(context);
272 \brief Executes all the processes to run (in parallel if possible).
274 static XBT_INLINE void SIMIX_context_runall(void)
276 simix_global->context_factory->runall();
280 \brief returns the current running context
282 static XBT_INLINE smx_context_t SIMIX_context_self(void)
284 if (simix_global && simix_global->context_factory) {
285 return simix_global->context_factory->self();
292 \brief returns the data associated to a context
293 \param context The context
296 static XBT_INLINE void* SIMIX_context_get_data(smx_context_t context)
298 return simix_global->context_factory->get_data(context);
301 XBT_PUBLIC(int) SIMIX_process_get_maxpid(void);