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 void_pfn_smxhost_t autorestart;
44 } s_smx_global_t, *smx_global_t;
46 extern smx_global_t simix_global;
47 extern unsigned long simix_process_maxpid;
49 extern xbt_dict_t watched_hosts_lib;
51 /******************************** Exceptions *********************************/
53 #define SMX_EXCEPTION(issuer, c, v, m) \
55 smx_process_t _smx_throw_issuer = (issuer); \
56 THROW_PREPARE(_smx_throw_issuer->running_ctx, (c), (v), xbt_strdup(m)); \
57 _smx_throw_issuer->doexception = 1; \
60 #define SMX_THROW() RETHROW
62 /* ******************************** File ************************************ */
63 typedef struct s_smx_file {
64 surf_file_t surf_file;
67 typedef struct s_smx_stat {
68 s_file_stat_t surf_stat;
71 /*********************************** Time ************************************/
73 /** @brief Timer datatype */
74 typedef struct s_smx_timer {
80 /********************************* Action *************************************/
84 SIMIX_ACTION_PARALLEL_EXECUTE,
85 SIMIX_ACTION_COMMUNICATE,
89 } e_smx_action_type_t;
105 /** @brief Action datatype */
106 typedef struct s_smx_action {
108 e_smx_action_type_t type; /* Type of SIMIX action*/
109 e_smx_state_t state; /* State of the action */
110 char *name; /* Action name if any */
111 xbt_fifo_t simcalls; /* List of simcalls waiting for this action */
113 /* Data specific to each action type */
117 smx_host_t host; /* The host where the execution takes place */
118 surf_action_t surf_exec; /* The Surf execution action encapsulated */
119 } execution; /* Possibly parallel execution */
122 e_smx_comm_type_t type; /* Type of the communication (SIMIX_COMM_SEND or SIMIX_COMM_RECEIVE) */
123 smx_rdv_t rdv; /* Rendez-vous where the comm is queued */
124 int refcount; /* Number of processes involved in the cond */
125 int detached; /* If detached or not */
127 void (*clean_fun)(void*); /* Function to clean the detached src_buf if something goes wrong */
128 int (*match_fun)(void*,void*,smx_action_t); /* Filter function used by the other side. It is used when
129 looking if a given communication matches my needs. For that, myself must match the
130 expectations of the other side, too. See */
132 /* Surf action data */
133 surf_action_t surf_comm; /* The Surf communication action encapsulated */
134 surf_action_t src_timeout; /* Surf's actions to instrument the timeouts */
135 surf_action_t dst_timeout; /* Surf's actions to instrument the timeouts */
136 smx_process_t src_proc;
137 smx_process_t dst_proc;
141 /* Data to be transfered */
144 size_t src_buff_size;
145 size_t *dst_buff_size;
146 unsigned copied:1; /* whether the data were already copied */
148 void* src_data; /* User data associated to communication */
153 smx_host_t host; /* The host that is sleeping */
154 surf_action_t surf_sleep; /* The Surf sleeping action encapsulated */
163 surf_action_t surf_io;
167 #ifdef HAVE_LATENCY_BOUND_TRACKING
172 char *category; /* simix action category for instrumentation */
176 /* FIXME: check if we can delete this function */
177 static XBT_INLINE e_smx_state_t SIMIX_action_map_state(e_surf_action_state_t state)
180 case SURF_ACTION_READY:
182 case SURF_ACTION_RUNNING:
183 return SIMIX_RUNNING;
184 case SURF_ACTION_FAILED:
186 case SURF_ACTION_DONE:
189 xbt_die("Unexpected SURF action state");
193 void SIMIX_context_mod_init(void);
194 void SIMIX_context_mod_exit(void);
196 void SIMIX_context_set_current(smx_context_t context);
197 smx_context_t SIMIX_context_get_current(void);
199 /* All factories init */
200 void SIMIX_ctx_thread_factory_init(smx_context_factory_t *factory);
201 void SIMIX_ctx_sysv_factory_init(smx_context_factory_t *factory);
202 void SIMIX_ctx_raw_factory_init(smx_context_factory_t *factory);
204 /* ****************************** */
205 /* context manipulation functions */
206 /* ****************************** */
208 /* Scenario for the end of a context:
210 * CASE 1: death after end of the main function
211 * the context_wrapper, called internally by the context module, calls
212 * SIMIX_context_stop after user code stops, smx_context_stop calls user
213 * cleanup_func if any (in context settings), add current process to trashbin
214 * and yields back to maestro.
215 * From time to time, maestro calls SIMIX_context_empty_trash, which destroy
216 * all the process and context data structures, and frees the memory
218 * CASE 2: brutal death
219 * SIMIX_process_kill (from any process) set process->iwannadie = 1 and then
220 * schedules the process. Then the process is awaken in the middle of the
221 * SIMIX_process_yield function, and at the end of it, it checks that
222 * iwannadie == 1, and call SIMIX_context_stop(same than first case afterward)
226 * \brief creates a new context for a user level process
227 * \param code a main function
228 * \param argc the number of arguments of the main function
229 * \param argv the vector of arguments of the main function
230 * \param cleanup_func the function to call when the context stops
231 * \param cleanup_arg the argument of the cleanup_func function
233 static XBT_INLINE smx_context_t SIMIX_context_new(xbt_main_func_t code,
234 int argc, char **argv,
235 void_pfn_smxprocess_t cleanup_func,
236 smx_process_t simix_process)
239 return simix_global->context_factory->create_context(code,
246 * \brief destroy a context
247 * \param context the context to destroy
248 * Argument must be stopped first -- runs in maestro context
250 static XBT_INLINE void SIMIX_context_free(smx_context_t context)
252 simix_global->context_factory->free(context);
256 * \brief stops the execution of a context
257 * \param context to stop
259 static XBT_INLINE void SIMIX_context_stop(smx_context_t context)
261 simix_global->context_factory->stop(context);
265 \brief suspends a context and return the control back to the one which
267 \param context the context to be suspended (it must be the running one)
269 static XBT_INLINE void SIMIX_context_suspend(smx_context_t context)
271 simix_global->context_factory->suspend(context);
275 \brief Executes all the processes to run (in parallel if possible).
277 static XBT_INLINE void SIMIX_context_runall(void)
279 simix_global->context_factory->runall();
283 \brief returns the current running context
285 static XBT_INLINE smx_context_t SIMIX_context_self(void)
287 if (simix_global && simix_global->context_factory) {
288 return simix_global->context_factory->self();
295 \brief returns the data associated to a context
296 \param context The context
299 static XBT_INLINE void* SIMIX_context_get_data(smx_context_t context)
301 return simix_global->context_factory->get_data(context);
304 XBT_PUBLIC(int) SIMIX_process_get_maxpid(void);