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 int _surf_do_verbose_exit = 1;
39 static void _XBT_CALL inthandler(int ignored)
41 if ( _surf_do_verbose_exit ) {
42 XBT_INFO("CTRL-C pressed. Displaying status and bailing out");
43 SIMIX_display_process_status();
46 XBT_INFO("CTRL-C pressed. bailing out without displaying because verbose-exit disabled");
51 /********************************* SIMIX **************************************/
53 XBT_INLINE double SIMIX_timer_next(void)
55 return xbt_heap_size(simix_timers) > 0 ? xbt_heap_maxkey(simix_timers) : -1.0;
59 * \brief Initialize SIMIX internal data.
64 void SIMIX_global_init(int *argc, char **argv)
69 /* Connect our log channels: that must be done manually under windows */
70 XBT_LOG_CONNECT(simix_action, simix);
71 XBT_LOG_CONNECT(simix_deployment, simix);
72 XBT_LOG_CONNECT(simix_environment, simix);
73 XBT_LOG_CONNECT(simix_host, simix);
74 XBT_LOG_CONNECT(simix_kernel, simix);
75 XBT_LOG_CONNECT(simix_process, simix);
76 XBT_LOG_CONNECT(simix_synchro, simix);
77 XBT_LOG_CONNECT(simix_context, simix);
79 simix_global = xbt_new0(s_smx_global_t, 1);
81 simix_global->process_to_run = xbt_dynar_new(sizeof(void *), NULL);
82 simix_global->process_list =
83 xbt_swag_new(xbt_swag_offset(proc, process_hookup));
84 simix_global->process_to_destroy =
85 xbt_swag_new(xbt_swag_offset(proc, destroy_hookup));
87 simix_global->maestro_process = NULL;
88 simix_global->registered_functions = xbt_dict_new();
90 simix_global->create_process_function = SIMIX_process_create;
91 simix_global->kill_process_function = SIMIX_process_kill;
92 simix_global->cleanup_process_function = SIMIX_process_cleanup;
93 simix_global->action_mallocator = xbt_mallocator_new(65536,
94 SIMIX_action_mallocator_new_f, SIMIX_action_mallocator_free_f,
95 SIMIX_action_mallocator_reset_f);
97 surf_init(argc, argv); /* Initialize SURF structures */
98 SIMIX_context_mod_init();
99 SIMIX_create_maestro_process();
101 /* context exception handlers */
102 __xbt_running_ctx_fetch = SIMIX_process_get_running_context;
103 __xbt_ex_terminate = SIMIX_process_exception_terminate;
105 /* Initialize request mechanism */
106 SIMIX_request_init();
108 /* Initialize the SIMIX network module */
109 SIMIX_network_init();
111 /* Prepare to display some more info when dying on Ctrl-C pressing */
112 signal(SIGINT, inthandler);
115 simix_timers = xbt_heap_new(8, &free);
118 XBT_DEBUG("ADD SIMIX LEVELS");
119 SIMIX_HOST_LEVEL = xbt_lib_add_level(host_lib,SIMIX_host_destroy);
123 * \brief Clean the SIMIX simulation
125 * This functions remove the memory used by SIMIX
127 void SIMIX_clean(void)
130 smx_ctx_raw_new_sr();
133 /* Kill everyone (except maestro) */
134 SIMIX_process_killall(simix_global->maestro_process);
136 /* Exit the SIMIX network module */
137 SIMIX_network_exit();
139 /* Exit request mechanism */
140 SIMIX_request_destroy();
142 xbt_heap_free(simix_timers);
143 /* Free the remaining data structures */
144 xbt_dynar_free(&simix_global->process_to_run);
145 xbt_swag_free(simix_global->process_to_destroy);
146 xbt_swag_free(simix_global->process_list);
147 simix_global->process_list = NULL;
148 simix_global->process_to_destroy = NULL;
149 xbt_dict_free(&(simix_global->registered_functions));
151 /* Let's free maestro now */
152 SIMIX_context_free(simix_global->maestro_process->context);
153 xbt_free(simix_global->maestro_process->running_ctx);
154 xbt_free(simix_global->maestro_process);
155 simix_global->maestro_process = NULL;
157 /* Restore the default exception setup */
158 __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
159 __xbt_ex_terminate = &__xbt_ex_terminate_default;
161 /* Finish context module and SURF */
162 SIMIX_context_mod_exit();
166 xbt_mallocator_free(simix_global->action_mallocator);
167 xbt_free(simix_global);
175 * \brief A clock (in second).
177 * \return Return the clock.
179 XBT_INLINE double SIMIX_get_clock(void)
182 return MC_process_clock_get(SIMIX_process_self());
184 return surf_get_clock();
193 surf_action_t action;
199 XBT_DEBUG("New Schedule Round; size(queue)=%lu",
200 xbt_dynar_length(simix_global->process_to_run));
202 smx_ctx_raw_new_sr();
205 XBT_DEBUG("New Sub-Schedule Round; size(queue)=%lu",
206 xbt_dynar_length(simix_global->process_to_run));
207 SIMIX_context_runall(simix_global->process_to_run);
208 while ((req = SIMIX_request_pop())) {
209 XBT_DEBUG("Handling request %p", req);
210 SIMIX_request_pre(req, 0);
212 } while (xbt_dynar_length(simix_global->process_to_run));
214 time = surf_solve(SIMIX_timer_next());
216 /* Notify all the hosts that have failed */
217 /* FIXME: iterate through the list of failed host and mark each of them */
218 /* as failed. On each host, signal all the running processes with host_fail */
220 /* Handle any pending timer */
221 while (xbt_heap_size(simix_timers) > 0 && SIMIX_get_clock() >= SIMIX_timer_next()) {
222 //FIXME: make the timers being real callbacks
223 // (i.e. provide dispatchers that read and expand the args)
224 timer = xbt_heap_pop(simix_timers);
226 ((void (*)(void*))timer->func)(timer->args);
228 /* Wake up all process waiting for the action finish */
229 xbt_dynar_foreach(model_list, iter, model) {
230 for (set = model->states.failed_action_set;
232 set = (set == model->states.failed_action_set)
233 ? model->states.done_action_set
235 while ((action = xbt_swag_extract(set)))
236 SIMIX_request_post((smx_action_t) action->data);
239 } while (time != -1.0);
241 if (xbt_swag_size(simix_global->process_list) != 0) {
243 XBT_WARN("Oops ! Deadlock or code not perfectly clean.");
244 SIMIX_display_process_status();
250 * \brief Set the date to execute a function
252 * Set the date to execute the function on the surf.
253 * \param date Date to execute function
254 * \param function Function to be executed
255 * \param arg Parameters of the function
258 XBT_INLINE void SIMIX_timer_set(double date, void *function, void *arg)
260 smx_timer_t timer = xbt_new0(s_smx_timer_t, 1);
263 timer->func = function;
265 xbt_heap_push(simix_timers, timer, date);
269 * \brief Registers a function to create a process.
271 * This function registers a function to be called
272 * when a new process is created. The function has
273 * to call SIMIX_process_create().
274 * \param function create process function
276 XBT_INLINE void SIMIX_function_register_process_create(smx_creation_func_t
279 simix_global->create_process_function = function;
283 * \brief Registers a function to kill a process.
285 * This function registers a function to be called when a
286 * process is killed. The function has to call the SIMIX_process_kill().
288 * \param function Kill process function
290 XBT_INLINE void SIMIX_function_register_process_kill(void_pfn_smxprocess_t
293 simix_global->kill_process_function = function;
297 * \brief Registers a function to cleanup a process.
299 * This function registers a user function to be called when
300 * a process ends properly.
302 * \param function cleanup process function
304 XBT_INLINE void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t
307 simix_global->cleanup_process_function = function;
311 void SIMIX_display_process_status(void)
313 if (simix_global->process_list == NULL) {
317 smx_process_t process = NULL;
318 int nbprocess = xbt_swag_size(simix_global->process_list);
320 XBT_INFO("%d processes are still running, waiting for something.", nbprocess);
321 /* List the process and their state */
323 ("Legend of the following listing: \"<process> on <host>: <status>.\"");
324 xbt_swag_foreach(process, simix_global->process_list) {
326 if (process->waiting_action) {
328 const char* action_description = "unknown";
329 switch (process->waiting_action->type) {
331 case SIMIX_ACTION_EXECUTE:
332 action_description = "execution";
335 case SIMIX_ACTION_PARALLEL_EXECUTE:
336 action_description = "parallel execution";
339 case SIMIX_ACTION_COMMUNICATE:
340 action_description = "communication";
343 case SIMIX_ACTION_SLEEP:
344 action_description = "sleeping";
347 case SIMIX_ACTION_SYNCHRO:
348 action_description = "synchronization";
351 case SIMIX_ACTION_IO:
352 action_description = "I/O";
355 XBT_INFO("Waiting for %s action %p to finish", action_description, process->waiting_action);
360 static void* SIMIX_action_mallocator_new_f(void) {
361 smx_action_t action = xbt_new(s_smx_action_t, 1);
362 action->request_list = xbt_fifo_new();
366 static void SIMIX_action_mallocator_free_f(void* action) {
367 xbt_fifo_free(((smx_action_t) action)->request_list);
371 static void SIMIX_action_mallocator_reset_f(void* action) {
373 // we also recycle the request list
374 xbt_fifo_t fifo = ((smx_action_t) action)->request_list;
375 xbt_fifo_reset(fifo);
376 memset(action, 0, sizeof(s_smx_action_t));
377 ((smx_action_t) action)->request_list = fifo;