1 /* Copyright (c) 2007-2010, 2012-2015. 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 "popping_private.h"
26 #include "smx_synchro_private.h"
30 /* Define only for SimGrid benchmarking purposes */
31 //#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 */
32 //#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). */
33 //#define ADAPTIVE_THRESHOLD /* this is to enable the adaptive threshold algorithm in raw contexts*/
34 //#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)*/
36 #ifdef TIME_BENCH_PER_SR
37 void smx_ctx_raw_new_sr(void);
39 /********************************** Simix Global ******************************/
40 typedef struct s_smx_global {
41 smx_context_factory_t context_factory;
42 xbt_dynar_t process_to_run;
43 xbt_dynar_t process_that_ran;
44 xbt_swag_t process_list;
45 xbt_swag_t process_to_destroy;
46 smx_process_t maestro_process;
47 xbt_dict_t registered_functions;
48 smx_creation_func_t create_process_function;
49 void_pfn_smxprocess_t_smxprocess_t kill_process_function;
50 void_pfn_smxprocess_t cleanup_process_function;
51 xbt_mallocator_t synchro_mallocator;
52 void_pfn_smxhost_t autorestart;
54 #ifdef TIME_BENCH_AMDAHL
55 xbt_os_timer_t timer_seq; /* used to bench the sequential and parallel parts of the simulation, if requested to */
56 xbt_os_timer_t timer_par;
58 } s_smx_global_t, *smx_global_t;
60 XBT_PUBLIC_DATA(smx_global_t) simix_global;
61 extern unsigned long simix_process_maxpid;
63 extern xbt_dict_t watched_hosts_lib;
65 XBT_PUBLIC(void) SIMIX_clean(void);
67 /******************************** Exceptions *********************************/
68 /** @brief Ask to the provided simix process to raise the provided exception */
69 #define SMX_EXCEPTION(issuer, cat, val, msg) \
71 smx_process_t _smx_throw_issuer = (issuer); /* evaluate only once */\
72 THROW_PREPARE(_smx_throw_issuer->running_ctx, (cat), (val), xbt_strdup(msg)); \
73 _smx_throw_issuer->doexception = 1; \
76 #define SMX_THROW() RETHROW
78 /* ******************************** File ************************************ */
79 typedef struct s_smx_file {
80 surf_file_t surf_file;
81 void* data; /**< @brief user data */
84 /*********************************** Time ************************************/
86 /** @brief Timer datatype */
87 typedef struct s_smx_timer {
93 /********************************* synchro *************************************/
97 SIMIX_SYNC_PARALLEL_EXECUTE,
98 SIMIX_SYNC_COMMUNICATE,
103 } e_smx_synchro_type_t;
119 /** @brief synchro datatype */
120 typedef struct s_smx_synchro {
122 e_smx_synchro_type_t type; /* Type of SIMIX synchro */
123 e_smx_state_t state; /* State of the synchro */
124 char *name; /* synchro name if any */
125 xbt_fifo_t simcalls; /* List of simcalls waiting for this synchro */
127 /* Data specific to each synchro type */
131 smx_host_t host; /* The host where the execution takes place */
132 surf_action_t surf_exec; /* The Surf execution action encapsulated */
133 } execution; /* Possibly parallel execution */
136 e_smx_comm_type_t type; /* Type of the communication (SIMIX_COMM_SEND or SIMIX_COMM_RECEIVE) */
137 smx_rdv_t rdv; /* Rendez-vous where the comm is queued */
140 smx_rdv_t rdv_cpy; /* Copy of the rendez-vous where the comm is queued, MC needs it for DPOR
141 (comm.rdv set to NULL when the communication is removed from the mailbox
142 (used as garbage collector)) */
144 int refcount; /* Number of processes involved in the cond */
145 int detached; /* If detached or not */
147 void (*clean_fun)(void*); /* Function to clean the detached src_buf if something goes wrong */
148 int (*match_fun)(void*,void*,smx_synchro_t); /* Filter function used by the other side. It is used when
149 looking if a given communication matches my needs. For that, myself must match the
150 expectations of the other side, too. See */
151 void (*copy_data_fun) (smx_synchro_t, void*, size_t);
153 /* Surf action data */
154 surf_action_t surf_comm; /* The Surf communication action encapsulated */
155 surf_action_t src_timeout; /* Surf's actions to instrument the timeouts */
156 surf_action_t dst_timeout; /* Surf's actions to instrument the timeouts */
157 smx_process_t src_proc;
158 smx_process_t dst_proc;
162 /* Data to be transfered */
165 size_t src_buff_size;
166 size_t *dst_buff_size;
167 unsigned copied:1; /* whether the data were already copied */
169 void* src_data; /* User data associated to communication */
174 smx_host_t host; /* The host that is sleeping */
175 surf_action_t surf_sleep; /* The Surf sleeping action encapsulated */
184 surf_action_t surf_io;
188 #ifdef HAVE_LATENCY_BOUND_TRACKING
192 char *category; /* simix action category for instrumentation */
195 void SIMIX_context_mod_init(void);
196 void SIMIX_context_mod_exit(void);
199 XBT_PUBLIC_DATA(char sigsegv_stack[SIGSTKSZ]);
202 /* We are using the bottom of the stack to save some information, like the
203 * valgrind_stack_id. Define smx_context_usable_stack_size to give the remaining
204 * size for the stack. */
205 #ifdef HAVE_VALGRIND_VALGRIND_H
206 # define smx_context_usable_stack_size \
207 (smx_context_stack_size - sizeof(unsigned int)) /* for valgrind_stack_id */
209 # define smx_context_usable_stack_size smx_context_stack_size
212 void *SIMIX_context_stack_new(void);
213 void SIMIX_context_stack_delete(void *stack);
215 void SIMIX_context_set_current(smx_context_t context);
216 smx_context_t SIMIX_context_get_current(void);
218 /* All factories init */
220 void SIMIX_ctx_thread_factory_init(smx_context_factory_t *factory);
221 void SIMIX_ctx_sysv_factory_init(smx_context_factory_t *factory);
222 void SIMIX_ctx_raw_factory_init(smx_context_factory_t *factory);
223 void SIMIX_ctx_boost_factory_init(smx_context_factory_t *factory);
225 /* ****************************** */
226 /* context manipulation functions */
227 /* ****************************** */
229 /* Scenario for the end of a context:
231 * CASE 1: death after end of the main function
232 * the context_wrapper, called internally by the context module, calls
233 * SIMIX_context_stop after user code stops, smx_context_stop calls user
234 * cleanup_func if any (in context settings), add current process to trashbin
235 * and yields back to maestro.
236 * From time to time, maestro calls SIMIX_context_empty_trash, which destroy
237 * all the process and context data structures, and frees the memory
239 * CASE 2: brutal death
240 * SIMIX_process_kill (from any process) set process->iwannadie = 1 and then
241 * schedules the process. Then the process is awaken in the middle of the
242 * SIMIX_process_yield function, and at the end of it, it checks that
243 * iwannadie == 1, and call SIMIX_context_stop(same than first case afterward)
247 * \brief creates a new context for a user level process
248 * \param code a main function
249 * \param argc the number of arguments of the main function
250 * \param argv the vector of arguments of the main function
251 * \param cleanup_func the function to call when the context stops
252 * \param cleanup_arg the argument of the cleanup_func function
254 static XBT_INLINE smx_context_t SIMIX_context_new(xbt_main_func_t code,
255 int argc, char **argv,
256 void_pfn_smxprocess_t cleanup_func,
257 smx_process_t simix_process)
260 xbt_die("simix is not initialized, please call MSG_init first");
261 return simix_global->context_factory->create_context(code,
268 * \brief destroy a context
269 * \param context the context to destroy
270 * Argument must be stopped first -- runs in maestro context
272 static XBT_INLINE void SIMIX_context_free(smx_context_t context)
274 simix_global->context_factory->free(context);
278 * \brief stops the execution of a context
279 * \param context to stop
281 static XBT_INLINE void SIMIX_context_stop(smx_context_t context)
283 simix_global->context_factory->stop(context);
287 \brief suspends a context and return the control back to the one which
289 \param context the context to be suspended (it must be the running one)
291 static XBT_INLINE void SIMIX_context_suspend(smx_context_t context)
293 simix_global->context_factory->suspend(context);
297 \brief Executes all the processes to run (in parallel if possible).
299 static XBT_INLINE void SIMIX_context_runall(void)
301 if (!xbt_dynar_is_empty(simix_global->process_to_run)) {
302 simix_global->context_factory->runall();
307 \brief returns the current running context
309 static XBT_INLINE smx_context_t SIMIX_context_self(void)
311 if (simix_global && simix_global->context_factory) {
312 return simix_global->context_factory->self();
318 \brief returns the SIMIX process associated to a context
319 \param context The context
320 \return The SIMIX process
322 static XBT_INLINE smx_process_t SIMIX_context_get_process(smx_context_t context)
324 return simix_global->context_factory->get_process(context);
327 XBT_PUBLIC(int) SIMIX_process_get_maxpid(void);
329 void SIMIX_post_create_environment(void);