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/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 "process_private.h"
21 #include "host_private.h"
22 #include "network_private.h"
23 #include "smurf_private.h"
24 #include "synchro_private.h"
25 #include "simix/context.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 } s_smx_global_t, *smx_global_t;
45 extern smx_global_t simix_global;
46 extern unsigned long simix_process_maxpid;
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 */
95 int detached; /* If detached or not */
97 void (*clean_fun)(void*); /* Function to clean the detached src_buf if something goes wrong */
99 /* Surf action data */
100 surf_action_t surf_comm; /* The Surf communication action encapsulated */
101 surf_action_t src_timeout; /* Surf's actions to instrument the timeouts */
102 surf_action_t dst_timeout; /* Surf's actions to instrument the timeouts */
103 smx_process_t src_proc;
104 smx_process_t dst_proc;
108 /* Data to be transfered */
111 size_t src_buff_size;
112 size_t *dst_buff_size;
115 void* src_data; /* User data associated to communication */
120 smx_host_t host; /* The host that is sleeping */
121 surf_action_t surf_sleep; /* The Surf sleeping action encapsulated */
130 #ifdef HAVE_LATENCY_BOUND_TRACKING
135 char *category; /* simix action category for instrumentation */
139 /* FIXME: check if we can delete this function */
140 static XBT_INLINE e_smx_state_t SIMIX_action_map_state(e_surf_action_state_t state)
143 case SURF_ACTION_READY:
145 case SURF_ACTION_RUNNING:
146 return SIMIX_RUNNING;
147 case SURF_ACTION_FAILED:
149 case SURF_ACTION_DONE:
152 xbt_die("Unexpected SURF action state");
156 void SIMIX_context_mod_init(void);
157 void SIMIX_context_mod_exit(void);
159 XBT_INLINE void SIMIX_context_set_current(smx_context_t context);
160 XBT_INLINE smx_context_t SIMIX_context_get_current(void);
162 /* All factories init */
163 void SIMIX_ctx_thread_factory_init(smx_context_factory_t *factory);
164 void SIMIX_ctx_sysv_factory_init(smx_context_factory_t *factory);
165 void SIMIX_ctx_raw_factory_init(smx_context_factory_t *factory);
167 /* ****************************** */
168 /* context manipulation functions */
169 /* ****************************** */
171 /* Scenario for the end of a context:
173 * CASE 1: death after end of the main function
174 * the context_wrapper, called internally by the context module, calls
175 * SIMIX_context_stop after user code stops, smx_context_stop calls user
176 * cleanup_func if any (in context settings), add current process to trashbin
177 * and yields back to maestro.
178 * From time to time, maestro calls SIMIX_context_empty_trash, which destroy
179 * all the process and context data structures, and frees the memory
181 * CASE 2: brutal death
182 * SIMIX_process_kill (from any process) set process->iwannadie = 1 and then
183 * schedules the process. Then the process is awaken in the middle of the
184 * SIMIX_process_yield function, and at the end of it, it checks that
185 * iwannadie == 1, and call SIMIX_context_stop(same than first case afterward)
189 * \brief creates a new context for a user level process
190 * \param code a main function
191 * \param argc the number of arguments of the main function
192 * \param argv the vector of arguments of the main function
193 * \param cleanup_func the function to call when the context stops
194 * \param cleanup_arg the argument of the cleanup_func function
196 static XBT_INLINE smx_context_t SIMIX_context_new(xbt_main_func_t code,
197 int argc, char **argv,
198 void_pfn_smxprocess_t cleanup_func,
199 smx_process_t simix_process)
202 return simix_global->context_factory->create_context(code,
209 * \brief destroy a context
210 * \param context the context to destroy
211 * Argument must be stopped first -- runs in maestro context
213 static XBT_INLINE void SIMIX_context_free(smx_context_t context)
215 simix_global->context_factory->free(context);
219 * \brief stops the execution of a context
220 * \param context to stop
222 static XBT_INLINE void SIMIX_context_stop(smx_context_t context)
224 simix_global->context_factory->stop(context);
228 \brief suspends a context and return the control back to the one which
230 \param context the context to be suspended (it must be the running one)
232 static XBT_INLINE void SIMIX_context_suspend(smx_context_t context)
234 simix_global->context_factory->suspend(context);
238 \brief Executes all the processes to run (in parallel if possible).
240 static XBT_INLINE void SIMIX_context_runall()
242 simix_global->context_factory->runall();
246 \brief returns the current running context
248 static XBT_INLINE smx_context_t SIMIX_context_self(void)
250 if (simix_global && simix_global->context_factory != NULL) {
251 return simix_global->context_factory->self();
258 \brief returns the data associated to a context
259 \param context The context
262 static XBT_INLINE void* SIMIX_context_get_data(smx_context_t context)
264 return simix_global->context_factory->get_data(context);
267 XBT_PUBLIC(int) SIMIX_process_get_maxpid(void);