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"
20 /******************************** Datatypes ***********************************/
23 /*********************************** Host *************************************/
25 /** @brief Host datatype
26 @ingroup m_datatypes_management_details */
27 typedef struct s_smx_host {
28 char *name; /**< @brief host name if any */
29 void *host; /* SURF modeling */
30 xbt_swag_t process_list;
31 void *data; /**< @brief user data */
34 /********************************** Simix Global ******************************/
36 typedef struct s_smx_context_factory *smx_context_factory_t;
38 typedef struct SIMIX_Global {
39 smx_context_factory_t context_factory;
41 xbt_swag_t process_to_run;
42 xbt_swag_t process_list;
43 xbt_swag_t process_to_destroy;
44 smx_process_t current_process;
45 smx_process_t maestro_process;
46 xbt_dict_t registered_functions;
47 smx_creation_func_t create_process_function;
48 void_f_pvoid_t kill_process_function;
49 void_f_pvoid_t cleanup_process_function;
50 } s_SIMIX_Global_t, *SIMIX_Global_t;
52 extern SIMIX_Global_t simix_global;
54 /******************************** Process *************************************/
56 /** @brief Process datatype
57 @ingroup m_datatypes_management_details @{ */
58 typedef struct s_smx_process {
59 s_xbt_swag_hookup_t process_hookup;
60 s_xbt_swag_hookup_t synchro_hookup; /* process_to_run or mutex->sleeping and co */
61 s_xbt_swag_hookup_t host_proc_hookup;
62 s_xbt_swag_hookup_t destroy_hookup;
64 char *name; /**< @brief process name if any */
65 smx_host_t smx_host; /* the host on which the process is running */
66 smx_context_t context; /* the context that executes the scheduler function */
71 smx_mutex_t mutex; /* mutex on which the process is blocked */
72 smx_cond_t cond; /* cond on which the process is blocked */
73 smx_sem_t sem; /* semaphore on which the process is blocked */
74 smx_action_t waiting_action;
75 xbt_dict_t properties;
76 void *data; /* kept for compatibility, it should be replaced with moddata */
81 typedef struct s_smx_process_arg {
89 xbt_dict_t properties;
90 } s_smx_process_arg_t, *smx_process_arg_t;
92 void SIMIX_create_maestro_process(void);
93 void SIMIX_process_empty_trash(void);
94 void SIMIX_process_schedule(smx_process_t process);
95 ex_ctx_t *SIMIX_process_get_exception(void);
96 void SIMIX_process_exception_terminate(xbt_ex_t * e);
98 /******************************* Networking ***********************************/
100 /** @brief Rendez-vous point datatype */
101 typedef struct s_smx_rvpoint {
105 xbt_fifo_t comm_fifo;
109 typedef struct s_smx_comm {
112 smx_comm_type_t type; /* Type of the communication (comm_send,comm_recv) */
113 smx_rdv_t rdv; /* Rendez-vous where the comm is queued */
114 smx_sem_t sem; /* Semaphore associated to the surf simulation */
115 int refcount; /* Number of processes involved in the cond */
117 /* Surf action data */
118 smx_process_t src_proc;
119 smx_process_t dst_proc;
120 smx_action_t src_timeout;
121 smx_action_t dst_timeout;
126 /* Data to be transfered */
129 size_t src_buff_size;
130 size_t *dst_buff_size;
133 void *data; /* User data associated to communication */
136 void SIMIX_network_copy_data(smx_comm_t comm);
137 smx_comm_t SIMIX_communication_new(smx_comm_type_t type);
138 static XBT_INLINE void SIMIX_communication_use(smx_comm_t comm);
139 static XBT_INLINE void SIMIX_communication_wait_for_completion(smx_comm_t comm, double timeout);
140 static XBT_INLINE void SIMIX_rdv_push(smx_rdv_t rdv, smx_comm_t comm);
141 static XBT_INLINE void SIMIX_rdv_remove(smx_rdv_t rdv, smx_comm_t comm);
143 /********************************* Action *************************************/
145 typedef enum {ready, ongoing, done, failed} smx_action_state_t;
147 /** @brief Action datatype
148 @ingroup m_datatypes_management_details */
149 typedef struct s_smx_action {
150 char *name; /**< @brief action name if any */
151 xbt_fifo_t cond_list; /*< conditional variables that must be signaled when the action finish. */
152 xbt_fifo_t sem_list; /*< semaphores that must be signaled when the action finish. */
153 void *data; /**< @brief user data */
154 int refcount; /**< @brief reference counter */
155 surf_action_t surf_action; /* SURF modeling of computation */
158 long long int counter; /* simix action unique identifier for instrumentation */
159 char *category; /* simix action category for instrumentation */
163 /************************** Configuration support *****************************/
165 extern int _simix_init_status; /* 0: beginning of time; FIXME: KILLME ?
166 1: pre-inited (cfg_set created);
167 2: inited (running) */
169 #define SIMIX_CHECK_HOST() xbt_assert0(surf_workstation_model->extension.workstation. \
170 get_state(SIMIX_host_self()->host)==SURF_RESOURCE_ON,\
171 "Host failed, you cannot call this function.")
173 smx_host_t __SIMIX_host_create(const char *name, void *workstation, void *data);
174 void __SIMIX_host_destroy(void *host);
175 void __SIMIX_cond_wait(smx_cond_t cond);
176 void __SIMIX_cond_display_actions(smx_cond_t cond);
177 void __SIMIX_action_display_conditions(smx_action_t action);
179 /******************************** Context *************************************/
181 /* The following function pointer types describe the interface that any context
182 factory should implement */
184 typedef smx_context_t (*smx_pfn_context_factory_create_context_t)
185 (xbt_main_func_t, int, char**, void_f_pvoid_t, void*);
186 typedef int (*smx_pfn_context_factory_finalize_t) (smx_context_factory_t*);
187 typedef void (*smx_pfn_context_free_t) (smx_context_t);
188 typedef void (*smx_pfn_context_start_t) (smx_context_t);
189 typedef void (*smx_pfn_context_stop_t) (smx_context_t);
190 typedef void (*smx_pfn_context_suspend_t) (smx_context_t context);
191 typedef void (*smx_pfn_context_resume_t) (smx_context_t new_context);
193 /* interface of the context factories */
194 typedef struct s_smx_context_factory {
195 smx_pfn_context_factory_create_context_t create_context;
196 smx_pfn_context_factory_finalize_t finalize;
197 smx_pfn_context_free_t free;
198 smx_pfn_context_stop_t stop;
199 smx_pfn_context_suspend_t suspend;
200 smx_pfn_context_resume_t resume;
202 } s_smx_context_factory_t;
205 void SIMIX_context_mod_init(void);
207 void SIMIX_context_mod_exit(void);
209 /* Selects a context factory associated with the name specified by the parameter name.
210 * If successful the function returns 0. Otherwise the function returns the error code.
212 int SIMIX_context_select_factory(const char *name);
214 /* Initializes a context factory from the name specified by the parameter name.
215 * If the factory cannot be found, an exception is raised.
217 void SIMIX_context_init_factory_by_name(smx_context_factory_t * factory, const char *name);
219 /* All factories init */
220 void SIMIX_ctx_thread_factory_init(smx_context_factory_t * factory);
222 void SIMIX_ctx_sysv_factory_init(smx_context_factory_t * factory);
223 void SIMIX_ctx_lua_factory_init(smx_context_factory_t * factory);
226 void SIMIX_ctx_java_factory_init(smx_context_factory_t * factory);
228 /* ****************************** */
229 /* context manipulation functions */
230 /* ****************************** */
232 /* Scenario for the end of a context:
234 * CASE 1: death after end of the main function
235 * the context_wrapper, called internally by the context module, calls
236 * SIMIX_context_stop after user code stops, smx_context_stop calls user
237 * cleanup_func if any (in context settings), add current process to trashbin
238 * and yields back to maestro.
239 * From time to time, maestro calls SIMIX_context_empty_trash, which destroy
240 * all the process and context data structures, and frees the memory
242 * CASE 2: brutal death
243 * SIMIX_process_kill (from any process) set process->iwannadie = 1 and then
244 * schedules the process. Then the process is awaken in the middle of the
245 * SIMIX_process_yield function, and at the end of it, it checks that
246 * iwannadie == 1, and call SIMIX_context_stop(same than first case afterward)
250 * \brief creates a new context for a user level process
251 * \param code a main function
252 * \param argc the number of arguments of the main function
253 * \param argv the vector of arguments of the main function
254 * \param cleanup_func the function to call when the context stops
255 * \param cleanup_arg the argument of the cleanup_func function
257 static XBT_INLINE smx_context_t SIMIX_context_new(xbt_main_func_t code, int argc,
259 void_f_pvoid_t cleanup_func,
262 return (*(simix_global->context_factory->create_context))
263 (code, argc, argv, cleanup_func, cleanup_arg);
267 * \brief destroy a context
268 * \param context the context to destroy
269 * Argument must be stopped first -- runs in maestro context
271 static XBT_INLINE void SIMIX_context_free(smx_context_t context) {
272 (*(simix_global->context_factory->free)) (context);
276 * \brief stops the execution of a context
277 * \param context to stop
279 static XBT_INLINE void SIMIX_context_stop(smx_context_t context) {
280 (*(simix_global->context_factory->stop)) (context);
284 \brief resumes the execution of a context
285 \param old_context the actual context from which is resuming
286 \param new_context the context to resume
288 static XBT_INLINE void SIMIX_context_resume(smx_context_t new_context)
290 (*(simix_global->context_factory->resume)) (new_context);
294 \brief suspends a context and return the control back to the one which
296 \param context the context to be suspended (it must be the running one)
298 static XBT_INLINE void SIMIX_context_suspend(smx_context_t context)
300 (*(simix_global->context_factory->suspend)) (context);