1 /* Copyright (c) 2007-2010, 2012-2014. 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/xbt_os_time.h"
18 #include "xbt/function_types.h"
19 #include "xbt/ex_interface.h"
20 #include "instr/instr_private.h"
21 #include "smx_process_private.h"
22 #include "smx_host_private.h"
23 #include "smx_io_private.h"
24 #include "smx_network_private.h"
25 #include "smx_smurf_private.h"
26 #include "smx_synchro_private.h"
27 /* ****************************************************************************************** */
28 /* TUTORIAL: New API */
29 /* ****************************************************************************************** */
30 #include "smx_new_api_private.h"
32 /* Define only for SimGrid benchmarking purposes */
33 //#define TIME_BENCH_PER_SR /* this aims at measuring the time spent in each scheduling round per each thread. The code is thus run in sequential to bench separately each SSR */
34 //#define TIME_BENCH_AMDAHL /* this aims at measuring the porting of time that could be parallelized at maximum (to get the optimal speedup by applying the amdahl law). */
36 /********************************** Simix Global ******************************/
37 typedef struct s_smx_global {
38 smx_context_factory_t context_factory;
39 xbt_dynar_t process_to_run;
40 xbt_dynar_t process_that_ran;
41 xbt_swag_t process_list;
42 xbt_swag_t process_to_destroy;
43 smx_process_t maestro_process;
44 xbt_dict_t registered_functions;
45 smx_creation_func_t create_process_function;
46 void_pfn_smxprocess_t_smxprocess_t kill_process_function;
47 void_pfn_smxprocess_t cleanup_process_function;
48 xbt_mallocator_t action_mallocator;
49 void_pfn_smxhost_t autorestart;
51 #ifdef TIME_BENCH_AMDAHL
52 xbt_os_timer_t timer_seq; /* used to bench the sequential and parallel parts of the simulation, if requested to */
53 xbt_os_timer_t timer_par;
55 } s_smx_global_t, *smx_global_t;
57 extern smx_global_t simix_global;
58 extern unsigned long simix_process_maxpid;
60 extern xbt_dict_t watched_hosts_lib;
65 XBT_PUBLIC(void) SIMIX_clean(void);
70 /******************************** Exceptions *********************************/
72 #define SMX_EXCEPTION(issuer, c, v, m) \
74 smx_process_t _smx_throw_issuer = (issuer); \
75 THROW_PREPARE(_smx_throw_issuer->running_ctx, (c), (v), xbt_strdup(m)); \
76 _smx_throw_issuer->doexception = 1; \
79 #define SMX_THROW() RETHROW
81 /* ******************************** File ************************************ */
82 typedef struct s_smx_file {
83 surf_file_t surf_file;
84 void* data; /**< @brief user data */
87 /*********************************** Time ************************************/
89 /** @brief Timer datatype */
90 typedef struct s_smx_timer {
96 /********************************* Action *************************************/
100 SIMIX_ACTION_PARALLEL_EXECUTE,
101 SIMIX_ACTION_COMMUNICATE,
103 SIMIX_ACTION_SYNCHRO,
105 /* ****************************************************************************************** */
106 /* TUTORIAL: New API */
107 /* ****************************************************************************************** */
109 } e_smx_action_type_t;
125 /** @brief Action datatype */
126 typedef struct s_smx_action {
128 e_smx_action_type_t type; /* Type of SIMIX action*/
129 e_smx_state_t state; /* State of the action */
130 char *name; /* Action name if any */
131 xbt_fifo_t simcalls; /* List of simcalls waiting for this action */
133 /* Data specific to each action type */
137 smx_host_t host; /* The host where the execution takes place */
138 surf_action_t surf_exec; /* The Surf execution action encapsulated */
139 } execution; /* Possibly parallel execution */
142 e_smx_comm_type_t type; /* Type of the communication (SIMIX_COMM_SEND or SIMIX_COMM_RECEIVE) */
143 smx_rdv_t rdv; /* Rendez-vous where the comm is queued */
146 smx_rdv_t rdv_cpy; /* Copy of the rendez-vous where the comm is queued, MC needs it for DPOR
147 (comm.rdv set to NULL when the communication is removed from the mailbox
148 (used as garbage collector)) */
150 int refcount; /* Number of processes involved in the cond */
151 int detached; /* If detached or not */
153 void (*clean_fun)(void*); /* Function to clean the detached src_buf if something goes wrong */
154 int (*match_fun)(void*,void*,smx_action_t); /* Filter function used by the other side. It is used when
155 looking if a given communication matches my needs. For that, myself must match the
156 expectations of the other side, too. See */
158 /* Surf action data */
159 surf_action_t surf_comm; /* The Surf communication action encapsulated */
160 surf_action_t src_timeout; /* Surf's actions to instrument the timeouts */
161 surf_action_t dst_timeout; /* Surf's actions to instrument the timeouts */
162 smx_process_t src_proc;
163 smx_process_t dst_proc;
167 /* Data to be transfered */
170 size_t src_buff_size;
171 size_t *dst_buff_size;
172 unsigned copied:1; /* whether the data were already copied */
174 void* src_data; /* User data associated to communication */
179 smx_host_t host; /* The host that is sleeping */
180 surf_action_t surf_sleep; /* The Surf sleeping action encapsulated */
189 surf_action_t surf_io;
192 /* ****************************************************************************************** */
193 /* TUTORIAL: New API */
194 /* ****************************************************************************************** */
196 surf_action_t surf_new_api;
200 #ifdef HAVE_LATENCY_BOUND_TRACKING
205 char *category; /* simix action category for instrumentation */
209 void SIMIX_context_mod_init(void);
210 void SIMIX_context_mod_exit(void);
213 XBT_PUBLIC_DATA(char sigsegv_stack[SIGSTKSZ]);
216 /* We are using the bottom of the stack to save some information, like the
217 * valgrind_stack_id. Define smx_context_usable_stack_size to give the remaining
218 * size for the stack. */
219 #ifdef HAVE_VALGRIND_VALGRIND_H
220 # define smx_context_usable_stack_size \
221 (smx_context_stack_size - sizeof(unsigned int)) /* for valgrind_stack_id */
223 # define smx_context_usable_stack_size smx_context_stack_size
226 void *SIMIX_context_stack_new(void);
227 void SIMIX_context_stack_delete(void *stack);
229 void SIMIX_context_set_current(smx_context_t context);
230 smx_context_t SIMIX_context_get_current(void);
232 /* All factories init */
234 void SIMIX_ctx_thread_factory_init(smx_context_factory_t *factory);
235 void SIMIX_ctx_sysv_factory_init(smx_context_factory_t *factory);
236 void SIMIX_ctx_raw_factory_init(smx_context_factory_t *factory);
238 /* ****************************** */
239 /* context manipulation functions */
240 /* ****************************** */
242 /* Scenario for the end of a context:
244 * CASE 1: death after end of the main function
245 * the context_wrapper, called internally by the context module, calls
246 * SIMIX_context_stop after user code stops, smx_context_stop calls user
247 * cleanup_func if any (in context settings), add current process to trashbin
248 * and yields back to maestro.
249 * From time to time, maestro calls SIMIX_context_empty_trash, which destroy
250 * all the process and context data structures, and frees the memory
252 * CASE 2: brutal death
253 * SIMIX_process_kill (from any process) set process->iwannadie = 1 and then
254 * schedules the process. Then the process is awaken in the middle of the
255 * SIMIX_process_yield function, and at the end of it, it checks that
256 * iwannadie == 1, and call SIMIX_context_stop(same than first case afterward)
260 * \brief creates a new context for a user level process
261 * \param code a main function
262 * \param argc the number of arguments of the main function
263 * \param argv the vector of arguments of the main function
264 * \param cleanup_func the function to call when the context stops
265 * \param cleanup_arg the argument of the cleanup_func function
267 static XBT_INLINE smx_context_t SIMIX_context_new(xbt_main_func_t code,
268 int argc, char **argv,
269 void_pfn_smxprocess_t cleanup_func,
270 smx_process_t simix_process)
273 xbt_die("simix is not initialized, please call MSG_init first");
274 return simix_global->context_factory->create_context(code,
281 * \brief destroy a context
282 * \param context the context to destroy
283 * Argument must be stopped first -- runs in maestro context
285 static XBT_INLINE void SIMIX_context_free(smx_context_t context)
287 simix_global->context_factory->free(context);
291 * \brief stops the execution of a context
292 * \param context to stop
294 static XBT_INLINE void SIMIX_context_stop(smx_context_t context)
296 simix_global->context_factory->stop(context);
300 \brief suspends a context and return the control back to the one which
302 \param context the context to be suspended (it must be the running one)
304 static XBT_INLINE void SIMIX_context_suspend(smx_context_t context)
306 simix_global->context_factory->suspend(context);
310 \brief Executes all the processes to run (in parallel if possible).
312 static XBT_INLINE void SIMIX_context_runall(void)
314 if (!xbt_dynar_is_empty(simix_global->process_to_run)) {
315 simix_global->context_factory->runall();
320 \brief returns the current running context
322 static XBT_INLINE smx_context_t SIMIX_context_self(void)
324 if (simix_global && simix_global->context_factory) {
325 return simix_global->context_factory->self();
331 \brief returns the SIMIX process associated to a context
332 \param context The context
333 \return The SIMIX process
335 static XBT_INLINE smx_process_t SIMIX_context_get_process(smx_context_t context)
337 return simix_global->context_factory->get_process(context);
340 XBT_PUBLIC(int) SIMIX_process_get_maxpid(void);
342 void SIMIX_post_create_environment(void);