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. */
9 #include "xbt/sysdep.h"
12 #include "xbt/ex.h" /* ex_backtrace_display */
15 XBT_LOG_EXTERNAL_CATEGORY(simix);
16 XBT_LOG_EXTERNAL_CATEGORY(simix_action);
17 XBT_LOG_EXTERNAL_CATEGORY(simix_deployment);
18 XBT_LOG_EXTERNAL_CATEGORY(simix_environment);
19 XBT_LOG_EXTERNAL_CATEGORY(simix_host);
20 XBT_LOG_EXTERNAL_CATEGORY(simix_process);
21 XBT_LOG_EXTERNAL_CATEGORY(simix_synchro);
22 XBT_LOG_EXTERNAL_CATEGORY(simix_context);
23 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_kernel, simix,
24 "Logging specific to SIMIX (kernel)");
26 smx_global_t simix_global = NULL;
27 static xbt_heap_t simix_timers = NULL;
29 static void* SIMIX_action_mallocator_new_f(void);
30 static void SIMIX_action_mallocator_free_f(void* action);
31 static void SIMIX_action_mallocator_reset_f(void* action);
33 extern void smx_ctx_raw_new_sr(void);
35 /* FIXME: Yeah, I'll do it in a portable maner one day [Mt] */
38 static void _XBT_CALL inthandler(int ignored)
40 XBT_INFO("CTRL-C pressed. Displaying status and bailing out");
41 SIMIX_display_process_status();
45 /********************************* SIMIX **************************************/
47 XBT_INLINE double SIMIX_timer_next(void)
49 return xbt_heap_size(simix_timers) > 0 ? xbt_heap_maxkey(simix_timers) : -1.0;
53 * \brief Initialize SIMIX internal data.
58 void SIMIX_global_init(int *argc, char **argv)
63 /* Connect our log channels: that must be done manually under windows */
64 XBT_LOG_CONNECT(simix_action, simix);
65 XBT_LOG_CONNECT(simix_deployment, simix);
66 XBT_LOG_CONNECT(simix_environment, simix);
67 XBT_LOG_CONNECT(simix_host, simix);
68 XBT_LOG_CONNECT(simix_kernel, simix);
69 XBT_LOG_CONNECT(simix_process, simix);
70 XBT_LOG_CONNECT(simix_synchro, simix);
71 XBT_LOG_CONNECT(simix_context, simix);
73 simix_global = xbt_new0(s_smx_global_t, 1);
75 simix_global->process_to_run = xbt_dynar_new(sizeof(void *), NULL);
76 simix_global->process_list =
77 xbt_swag_new(xbt_swag_offset(proc, process_hookup));
78 simix_global->process_to_destroy =
79 xbt_swag_new(xbt_swag_offset(proc, destroy_hookup));
81 simix_global->maestro_process = NULL;
82 simix_global->registered_functions = xbt_dict_new();
84 simix_global->create_process_function = SIMIX_process_create;
85 simix_global->kill_process_function = SIMIX_process_kill;
86 simix_global->cleanup_process_function = SIMIX_process_cleanup;
87 simix_global->action_mallocator = xbt_mallocator_new(65536,
88 SIMIX_action_mallocator_new_f, SIMIX_action_mallocator_free_f,
89 SIMIX_action_mallocator_reset_f);
91 surf_init(argc, argv); /* Initialize SURF structures */
92 SIMIX_context_mod_init();
93 SIMIX_create_maestro_process();
95 /* context exception handlers */
96 __xbt_running_ctx_fetch = SIMIX_process_get_running_context;
97 __xbt_ex_terminate = SIMIX_process_exception_terminate;
99 /* Initialize request mechanism */
100 SIMIX_request_init();
102 /* Initialize the SIMIX network module */
103 SIMIX_network_init();
105 /* Prepare to display some more info when dying on Ctrl-C pressing */
106 signal(SIGINT, inthandler);
109 simix_timers = xbt_heap_new(8, &free);
112 XBT_DEBUG("ADD SIMIX LEVELS");
113 SIMIX_HOST_LEVEL = xbt_lib_add_level(host_lib,free);
117 * \brief Clean the SIMIX simulation
119 * This functions remove the memory used by SIMIX
121 void SIMIX_clean(void)
124 smx_ctx_raw_new_sr();
127 /* Kill everyone (except maestro) */
128 SIMIX_process_killall(simix_global->maestro_process);
130 /* Exit the SIMIX network module */
131 SIMIX_network_exit();
133 /* Exit request mechanism */
134 SIMIX_request_destroy();
136 xbt_heap_free(simix_timers);
137 /* Free the remaining data structures */
138 xbt_dynar_free(&simix_global->process_to_run);
139 xbt_swag_free(simix_global->process_to_destroy);
140 xbt_swag_free(simix_global->process_list);
141 simix_global->process_list = NULL;
142 simix_global->process_to_destroy = NULL;
143 xbt_dict_free(&(simix_global->registered_functions));
145 /* Let's free maestro now */
146 SIMIX_context_free(simix_global->maestro_process->context);
147 xbt_free(simix_global->maestro_process->running_ctx);
148 xbt_free(simix_global->maestro_process);
149 simix_global->maestro_process = NULL;
151 /* Restore the default exception setup */
152 __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
153 __xbt_ex_terminate = &__xbt_ex_terminate_default;
155 /* Finish context module and SURF */
156 SIMIX_context_mod_exit();
160 xbt_mallocator_free(simix_global->action_mallocator);
161 xbt_free(simix_global);
169 * \brief A clock (in second).
171 * \return Return the clock.
173 XBT_INLINE double SIMIX_get_clock(void)
176 return MC_process_clock_get(SIMIX_process_self());
178 return surf_get_clock();
187 surf_action_t action;
193 XBT_DEBUG("New Schedule Round; size(queue)=%lu",
194 xbt_dynar_length(simix_global->process_to_run));
196 smx_ctx_raw_new_sr();
199 XBT_DEBUG("New Sub-Schedule Round; size(queue)=%lu",
200 xbt_dynar_length(simix_global->process_to_run));
201 SIMIX_context_runall(simix_global->process_to_run);
202 while ((req = SIMIX_request_pop())) {
203 XBT_DEBUG("Handling request %p", req);
204 SIMIX_request_pre(req, 0);
206 } while (xbt_dynar_length(simix_global->process_to_run));
208 time = surf_solve(SIMIX_timer_next());
210 /* Notify all the hosts that have failed */
211 /* FIXME: iterate through the list of failed host and mark each of them */
212 /* as failed. On each host, signal all the running processes with host_fail */
214 /* Handle any pending timer */
215 while (xbt_heap_size(simix_timers) > 0 && SIMIX_get_clock() >= SIMIX_timer_next()) {
216 //FIXME: make the timers being real callbacks
217 // (i.e. provide dispatchers that read and expand the args)
218 timer = xbt_heap_pop(simix_timers);
220 ((void (*)(void*))timer->func)(timer->args);
222 /* Wake up all process waiting for the action finish */
223 xbt_dynar_foreach(model_list, iter, model) {
224 for (set = model->states.failed_action_set;
226 set = (set == model->states.failed_action_set)
227 ? model->states.done_action_set
229 while ((action = xbt_swag_extract(set)))
230 SIMIX_request_post((smx_action_t) action->data);
233 } while (time != -1.0);
235 if (xbt_swag_size(simix_global->process_list) != 0) {
237 XBT_WARN("Oops ! Deadlock or code not perfectly clean.");
238 SIMIX_display_process_status();
244 * \brief Set the date to execute a function
246 * Set the date to execute the function on the surf.
247 * \param date Date to execute function
248 * \param function Function to be executed
249 * \param arg Parameters of the function
252 XBT_INLINE void SIMIX_timer_set(double date, void *function, void *arg)
254 smx_timer_t timer = xbt_new0(s_smx_timer_t, 1);
257 timer->func = function;
259 xbt_heap_push(simix_timers, timer, date);
263 * \brief Registers a function to create a process.
265 * This function registers a function to be called
266 * when a new process is created. The function has
267 * to call SIMIX_process_create().
268 * \param function create process function
270 XBT_INLINE void SIMIX_function_register_process_create(smx_creation_func_t
273 simix_global->create_process_function = function;
277 * \brief Registers a function to kill a process.
279 * This function registers a function to be called when a
280 * process is killed. The function has to call the SIMIX_process_kill().
282 * \param function Kill process function
284 XBT_INLINE void SIMIX_function_register_process_kill(void_pfn_smxprocess_t
287 simix_global->kill_process_function = function;
291 * \brief Registers a function to cleanup a process.
293 * This function registers a user function to be called when
294 * a process ends properly.
296 * \param function cleanup process function
298 XBT_INLINE void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t
301 simix_global->cleanup_process_function = function;
305 void SIMIX_display_process_status(void)
307 if (simix_global->process_list == NULL) {
311 smx_process_t process = NULL;
312 int nbprocess = xbt_swag_size(simix_global->process_list);
314 XBT_INFO("%d processes are still running, waiting for something.", nbprocess);
315 /* List the process and their state */
317 ("Legend of the following listing: \"<process> on <host>: <status>.\"");
318 xbt_swag_foreach(process, simix_global->process_list) {
320 if (process->waiting_action) {
322 const char* action_description = "unknown";
323 switch (process->waiting_action->type) {
325 case SIMIX_ACTION_EXECUTE:
326 action_description = "execution";
329 case SIMIX_ACTION_PARALLEL_EXECUTE:
330 action_description = "parallel execution";
333 case SIMIX_ACTION_COMMUNICATE:
334 action_description = "communication";
337 case SIMIX_ACTION_SLEEP:
338 action_description = "sleeping";
341 case SIMIX_ACTION_SYNCHRO:
342 action_description = "synchronization";
345 case SIMIX_ACTION_IO:
346 action_description = "I/O";
349 XBT_INFO("Waiting for %s action %p to finish", action_description, process->waiting_action);
354 static void* SIMIX_action_mallocator_new_f(void) {
355 smx_action_t action = xbt_new(s_smx_action_t, 1);
356 action->request_list = xbt_fifo_new();
360 static void SIMIX_action_mallocator_free_f(void* action) {
361 xbt_fifo_free(((smx_action_t) action)->request_list);
365 static void SIMIX_action_mallocator_reset_f(void* action) {
367 // we also recycle the request list
368 xbt_fifo_t fifo = ((smx_action_t) action)->request_list;
369 xbt_fifo_reset(fifo);
370 memset(action, 0, sizeof(s_smx_action_t));
371 ((smx_action_t) action)->request_list = fifo;