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 "simix/simix.h"
11 #include "surf/surf.h"
15 #include "xbt/config.h"
16 #include "xbt/function_types.h"
17 #include "xbt/ex_interface.h"
18 #include "instr/private.h"
19 #include "process_private.h"
20 #include "host_private.h"
21 #include "network_private.h"
22 #include "smurf_private.h"
23 #include "synchro_private.h"
24 #include "simix/context.h"
26 /********************************** Simix Global ******************************/
29 typedef struct s_smx_global {
30 smx_context_factory_t context_factory;
32 xbt_swag_t process_to_run;
33 xbt_swag_t process_list;
34 xbt_swag_t process_to_destroy;
35 smx_process_t maestro_process;
36 xbt_dict_t registered_functions;
37 smx_creation_func_t create_process_function;
38 void_f_pvoid_t kill_process_function;
39 void_pfn_smxprocess_t cleanup_process_function;
40 #ifdef HAVE_LATENCY_BOUND_TRACKING
41 xbt_dict_t latency_limited_dict;
43 } s_smx_global_t, *smx_global_t;
45 extern smx_global_t simix_global;
48 /*********************************** Time ************************************/
50 /** @brief Timer datatype */
51 typedef struct s_smx_timer {
57 /********************************* Action *************************************/
61 SIMIX_ACTION_PARALLEL_EXECUTE,
62 SIMIX_ACTION_COMMUNICATE,
66 } e_smx_action_type_t;
75 /** @brief Action datatype */
76 typedef struct s_smx_action {
78 e_smx_action_type_t type; /* Type of SIMIX action*/
79 e_smx_state_t state; /* State of the action */
80 char *name; /* Action name if any */
81 xbt_fifo_t request_list; /* List of requests on this action */
83 /* Data specific to each action type */
87 smx_host_t host; /* The host where the execution takes place */
88 surf_action_t surf_exec; /* The Surf execution action encapsulated */
89 } execution; /* Possibly parallel execution */
92 e_smx_comm_type_t type; /* Type of the communication (SIMIX_COMM_SEND or SIMIX_COMM_RECEIVE) */
93 smx_rdv_t rdv; /* Rendez-vous where the comm is queued */
94 int refcount; /* Number of processes involved in the cond */
96 /* Surf action data */
97 surf_action_t surf_comm; /* The Surf communication action encapsulated */
98 surf_action_t src_timeout; /* Surf's actions to instrument the timeouts */
99 surf_action_t dst_timeout; /* Surf's actions to instrument the timeouts */
100 smx_process_t src_proc;
101 smx_process_t dst_proc;
105 /* Data to be transfered */
108 size_t src_buff_size;
109 size_t *dst_buff_size;
112 void *data; /* User data associated to communication */
116 smx_host_t host; /* The host that is sleeping */
117 surf_action_t surf_sleep; /* The Surf sleeping action encapsulated */
127 long long int counter; /* simix action unique identifier for instrumentation */
128 char *category; /* simix action category for instrumentation */
132 /* FIXME: check if we can delete this function */
133 static XBT_INLINE e_smx_state_t SIMIX_action_map_state(e_surf_action_state_t state)
136 case SURF_ACTION_READY:
138 case SURF_ACTION_RUNNING:
139 return SIMIX_RUNNING;
140 case SURF_ACTION_FAILED:
142 case SURF_ACTION_DONE:
145 xbt_die("Unexpected SURF action state");
151 void SIMIX_context_mod_init(void);
152 void SIMIX_context_mod_exit(void);
155 /* All factories init */
156 void SIMIX_ctx_thread_factory_init(smx_context_factory_t *factory);
157 void SIMIX_ctx_sysv_factory_init(smx_context_factory_t *factory);
159 /* ****************************** */
160 /* context manipulation functions */
161 /* ****************************** */
163 /* Scenario for the end of a context:
165 * CASE 1: death after end of the main function
166 * the context_wrapper, called internally by the context module, calls
167 * SIMIX_context_stop after user code stops, smx_context_stop calls user
168 * cleanup_func if any (in context settings), add current process to trashbin
169 * and yields back to maestro.
170 * From time to time, maestro calls SIMIX_context_empty_trash, which destroy
171 * all the process and context data structures, and frees the memory
173 * CASE 2: brutal death
174 * SIMIX_process_kill (from any process) set process->iwannadie = 1 and then
175 * schedules the process. Then the process is awaken in the middle of the
176 * SIMIX_process_yield function, and at the end of it, it checks that
177 * iwannadie == 1, and call SIMIX_context_stop(same than first case afterward)
181 * \brief creates a new context for a user level process
182 * \param code a main function
183 * \param argc the number of arguments of the main function
184 * \param argv the vector of arguments of the main function
185 * \param cleanup_func the function to call when the context stops
186 * \param cleanup_arg the argument of the cleanup_func function
188 static XBT_INLINE smx_context_t SIMIX_context_new(xbt_main_func_t code,
189 int argc, char **argv,
190 void_pfn_smxprocess_t cleanup_func,
191 smx_process_t simix_process)
194 return (*(simix_global->context_factory->create_context))
195 (code, argc, argv, cleanup_func, simix_process);
199 * \brief destroy a context
200 * \param context the context to destroy
201 * Argument must be stopped first -- runs in maestro context
203 static XBT_INLINE void SIMIX_context_free(smx_context_t context)
205 (*(simix_global->context_factory->free)) (context);
209 * \brief stops the execution of a context
210 * \param context to stop
212 static XBT_INLINE void SIMIX_context_stop(smx_context_t context)
214 (*(simix_global->context_factory->stop)) (context);
218 \brief suspends a context and return the control back to the one which
220 \param context the context to be suspended (it must be the running one)
222 static XBT_INLINE void SIMIX_context_suspend(smx_context_t context)
224 (*(simix_global->context_factory->suspend)) (context);
228 \brief executes all the processes (in parallel if possible)
229 \param processes the swag of processes to execute
231 static XBT_INLINE void SIMIX_context_runall(xbt_swag_t processes)
233 (*(simix_global->context_factory->runall)) (processes);
237 \brief returns the current running context
239 static XBT_INLINE smx_context_t SIMIX_context_self(void)
241 if (simix_global->context_factory == NULL) {
245 return (*(simix_global->context_factory->self))();
249 \brief returns the data associated to a context
250 \param context The context
253 static XBT_INLINE void* SIMIX_context_get_data(smx_context_t context)
255 return (*(simix_global->context_factory->get_data))(context);