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). */
35 //#define ADAPTIVE_THRESHOLD /* this is to enable the adaptive threshold algorithm in raw contexts*/
36 //#define TIME_BENCH_ENTIRE_SRS /* more general benchmark than TIME_BENCH_PER_SR. It aims to measure the total time spent in a whole scheduling round (including synchro costs)*/
38 #ifdef TIME_BENCH_PER_SR
39 void smx_ctx_raw_new_sr(void);
41 /********************************** Simix Global ******************************/
42 typedef struct s_smx_global {
43 smx_context_factory_t context_factory;
44 xbt_dynar_t process_to_run;
45 xbt_dynar_t process_that_ran;
46 xbt_swag_t process_list;
47 xbt_swag_t process_to_destroy;
48 smx_process_t maestro_process;
49 xbt_dict_t registered_functions;
50 smx_creation_func_t create_process_function;
51 void_pfn_smxprocess_t_smxprocess_t kill_process_function;
52 void_pfn_smxprocess_t cleanup_process_function;
53 xbt_mallocator_t action_mallocator;
54 void_pfn_smxhost_t autorestart;
56 #ifdef TIME_BENCH_AMDAHL
57 xbt_os_timer_t timer_seq; /* used to bench the sequential and parallel parts of the simulation, if requested to */
58 xbt_os_timer_t timer_par;
60 } s_smx_global_t, *smx_global_t;
62 extern smx_global_t simix_global;
63 extern unsigned long simix_process_maxpid;
65 extern xbt_dict_t watched_hosts_lib;
70 XBT_PUBLIC(void) SIMIX_clean(void);
75 /******************************** Exceptions *********************************/
76 /** @brief Ask to the provided simix process to raise the provided exception */
77 #define SMX_EXCEPTION(issuer, cat, val, msg) \
79 smx_process_t _smx_throw_issuer = (issuer); /* evaluate only once */\
80 THROW_PREPARE(_smx_throw_issuer->running_ctx, (cat), (val), xbt_strdup(msg)); \
81 _smx_throw_issuer->doexception = 1; \
84 #define SMX_THROW() RETHROW
86 /* ******************************** File ************************************ */
87 typedef struct s_smx_file {
88 surf_file_t surf_file;
89 void* data; /**< @brief user data */
92 /*********************************** Time ************************************/
94 /** @brief Timer datatype */
95 typedef struct s_smx_timer {
101 /********************************* Action *************************************/
104 SIMIX_ACTION_EXECUTE,
105 SIMIX_ACTION_PARALLEL_EXECUTE,
106 SIMIX_ACTION_COMMUNICATE,
109 SIMIX_ACTION_SYNCHRO,
111 /* ****************************************************************************************** */
112 /* TUTORIAL: New API */
113 /* ****************************************************************************************** */
115 } e_smx_action_type_t;
131 /** @brief Action datatype */
132 typedef struct s_smx_action {
134 e_smx_action_type_t type; /* Type of SIMIX action*/
135 e_smx_state_t state; /* State of the action */
136 char *name; /* Action name if any */
137 xbt_fifo_t simcalls; /* List of simcalls waiting for this action */
139 /* Data specific to each action type */
143 smx_host_t host; /* The host where the execution takes place */
144 surf_action_t surf_exec; /* The Surf execution action encapsulated */
145 } execution; /* Possibly parallel execution */
148 e_smx_comm_type_t type; /* Type of the communication (SIMIX_COMM_SEND or SIMIX_COMM_RECEIVE) */
149 smx_rdv_t rdv; /* Rendez-vous where the comm is queued */
152 smx_rdv_t rdv_cpy; /* Copy of the rendez-vous where the comm is queued, MC needs it for DPOR
153 (comm.rdv set to NULL when the communication is removed from the mailbox
154 (used as garbage collector)) */
156 int refcount; /* Number of processes involved in the cond */
157 int detached; /* If detached or not */
159 void (*clean_fun)(void*); /* Function to clean the detached src_buf if something goes wrong */
160 int (*match_fun)(void*,void*,smx_action_t); /* Filter function used by the other side. It is used when
161 looking if a given communication matches my needs. For that, myself must match the
162 expectations of the other side, too. See */
163 void (*copy_data_fun) (smx_action_t, void*, size_t);
165 /* Surf action data */
166 surf_action_t surf_comm; /* The Surf communication action encapsulated */
167 surf_action_t src_timeout; /* Surf's actions to instrument the timeouts */
168 surf_action_t dst_timeout; /* Surf's actions to instrument the timeouts */
169 smx_process_t src_proc;
170 smx_process_t dst_proc;
174 /* Data to be transfered */
177 size_t src_buff_size;
178 size_t *dst_buff_size;
179 unsigned copied:1; /* whether the data were already copied */
181 void* src_data; /* User data associated to communication */
186 smx_host_t host; /* The host that is sleeping */
187 surf_action_t surf_sleep; /* The Surf sleeping action encapsulated */
196 surf_action_t surf_io;
199 /* ****************************************************************************************** */
200 /* TUTORIAL: New API */
201 /* ****************************************************************************************** */
203 surf_action_t surf_new_api;
207 #ifdef HAVE_LATENCY_BOUND_TRACKING
212 char *category; /* simix action category for instrumentation */
216 void SIMIX_context_mod_init(void);
217 void SIMIX_context_mod_exit(void);
220 XBT_PUBLIC_DATA(char sigsegv_stack[SIGSTKSZ]);
223 /* We are using the bottom of the stack to save some information, like the
224 * valgrind_stack_id. Define smx_context_usable_stack_size to give the remaining
225 * size for the stack. */
226 #ifdef HAVE_VALGRIND_VALGRIND_H
227 # define smx_context_usable_stack_size \
228 (smx_context_stack_size - sizeof(unsigned int)) /* for valgrind_stack_id */
230 # define smx_context_usable_stack_size smx_context_stack_size
233 void *SIMIX_context_stack_new(void);
234 void SIMIX_context_stack_delete(void *stack);
236 void SIMIX_context_set_current(smx_context_t context);
237 smx_context_t SIMIX_context_get_current(void);
239 /* All factories init */
241 void SIMIX_ctx_thread_factory_init(smx_context_factory_t *factory);
242 void SIMIX_ctx_sysv_factory_init(smx_context_factory_t *factory);
243 void SIMIX_ctx_raw_factory_init(smx_context_factory_t *factory);
245 /* ****************************** */
246 /* context manipulation functions */
247 /* ****************************** */
249 /* Scenario for the end of a context:
251 * CASE 1: death after end of the main function
252 * the context_wrapper, called internally by the context module, calls
253 * SIMIX_context_stop after user code stops, smx_context_stop calls user
254 * cleanup_func if any (in context settings), add current process to trashbin
255 * and yields back to maestro.
256 * From time to time, maestro calls SIMIX_context_empty_trash, which destroy
257 * all the process and context data structures, and frees the memory
259 * CASE 2: brutal death
260 * SIMIX_process_kill (from any process) set process->iwannadie = 1 and then
261 * schedules the process. Then the process is awaken in the middle of the
262 * SIMIX_process_yield function, and at the end of it, it checks that
263 * iwannadie == 1, and call SIMIX_context_stop(same than first case afterward)
267 * \brief creates a new context for a user level process
268 * \param code a main function
269 * \param argc the number of arguments of the main function
270 * \param argv the vector of arguments of the main function
271 * \param cleanup_func the function to call when the context stops
272 * \param cleanup_arg the argument of the cleanup_func function
274 static XBT_INLINE smx_context_t SIMIX_context_new(xbt_main_func_t code,
275 int argc, char **argv,
276 void_pfn_smxprocess_t cleanup_func,
277 smx_process_t simix_process)
280 xbt_die("simix is not initialized, please call MSG_init first");
281 return simix_global->context_factory->create_context(code,
288 * \brief destroy a context
289 * \param context the context to destroy
290 * Argument must be stopped first -- runs in maestro context
292 static XBT_INLINE void SIMIX_context_free(smx_context_t context)
294 simix_global->context_factory->free(context);
298 * \brief stops the execution of a context
299 * \param context to stop
301 static XBT_INLINE void SIMIX_context_stop(smx_context_t context)
303 simix_global->context_factory->stop(context);
307 \brief suspends a context and return the control back to the one which
309 \param context the context to be suspended (it must be the running one)
311 static XBT_INLINE void SIMIX_context_suspend(smx_context_t context)
313 simix_global->context_factory->suspend(context);
317 \brief Executes all the processes to run (in parallel if possible).
319 static XBT_INLINE void SIMIX_context_runall(void)
321 if (!xbt_dynar_is_empty(simix_global->process_to_run)) {
322 simix_global->context_factory->runall();
327 \brief returns the current running context
329 static XBT_INLINE smx_context_t SIMIX_context_self(void)
331 if (simix_global && simix_global->context_factory) {
332 return simix_global->context_factory->self();
338 \brief returns the SIMIX process associated to a context
339 \param context The context
340 \return The SIMIX process
342 static XBT_INLINE smx_process_t SIMIX_context_get_process(smx_context_t context)
344 return simix_global->context_factory->get_process(context);
347 XBT_PUBLIC(int) SIMIX_process_get_maxpid(void);
349 void SIMIX_post_create_environment(void);