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 */
14 XBT_LOG_EXTERNAL_CATEGORY(simix);
15 XBT_LOG_EXTERNAL_CATEGORY(simix_action);
16 XBT_LOG_EXTERNAL_CATEGORY(simix_deployment);
17 XBT_LOG_EXTERNAL_CATEGORY(simix_environment);
18 XBT_LOG_EXTERNAL_CATEGORY(simix_host);
19 XBT_LOG_EXTERNAL_CATEGORY(simix_process);
20 XBT_LOG_EXTERNAL_CATEGORY(simix_synchro);
21 XBT_LOG_EXTERNAL_CATEGORY(simix_context);
22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_kernel, simix,
23 "Logging specific to SIMIX (kernel)");
25 smx_global_t simix_global = NULL;
26 static xbt_heap_t simix_timers = NULL;
28 /* FIXME: Yeah, I'll do it in a portable maner one day [Mt] */
31 static void _XBT_CALL inthandler(int ignored)
33 INFO0("CTRL-C pressed. Displaying status and bailing out");
34 SIMIX_display_process_status();
38 /********************************* SIMIX **************************************/
40 XBT_INLINE double SIMIX_timer_next(void)
42 return xbt_heap_size(simix_timers) > 0 ? xbt_heap_maxkey(simix_timers) : -1.0;
46 * \brief Initialize SIMIX internal data.
51 void SIMIX_global_init(int *argc, char **argv)
56 /* Connect our log channels: that must be done manually under windows */
57 XBT_LOG_CONNECT(simix_action, simix);
58 XBT_LOG_CONNECT(simix_deployment, simix);
59 XBT_LOG_CONNECT(simix_environment, simix);
60 XBT_LOG_CONNECT(simix_host, simix);
61 XBT_LOG_CONNECT(simix_kernel, simix);
62 XBT_LOG_CONNECT(simix_process, simix);
63 XBT_LOG_CONNECT(simix_synchro, simix);
64 XBT_LOG_CONNECT(simix_context, simix);
66 simix_global = xbt_new0(s_smx_global_t, 1);
68 simix_global->host = xbt_dict_new();
69 simix_global->process_to_run = xbt_dynar_new(sizeof(void *), NULL);
70 simix_global->process_list =
71 xbt_swag_new(xbt_swag_offset(proc, process_hookup));
72 simix_global->process_to_destroy =
73 xbt_swag_new(xbt_swag_offset(proc, destroy_hookup));
75 simix_global->maestro_process = NULL;
76 simix_global->registered_functions = xbt_dict_new();
78 simix_global->create_process_function = NULL;
79 simix_global->kill_process_function = NULL;
80 simix_global->cleanup_process_function = SIMIX_process_cleanup;
82 #ifdef HAVE_LATENCY_BOUND_TRACKING
83 simix_global->latency_limited_dict = xbt_dict_new();
86 surf_init(argc, argv); /* Initialize SURF structures */
87 SIMIX_context_mod_init();
88 SIMIX_create_maestro_process();
90 /* context exception handlers */
91 __xbt_running_ctx_fetch = SIMIX_process_get_running_context;
92 __xbt_ex_terminate = SIMIX_process_exception_terminate;
94 /* Initialize request mechanism */
97 /* Initialize the SIMIX network module */
100 /* Prepare to display some more info when dying on Ctrl-C pressing */
101 signal(SIGINT, inthandler);
104 simix_timers = xbt_heap_new(8, &free);
109 * \brief Clean the SIMIX simulation
111 * This functions remove the memory used by SIMIX
113 void SIMIX_clean(void)
115 /* Kill everyone (except maestro) */
116 SIMIX_process_killall();
118 /* Exit the SIMIX network module */
119 SIMIX_network_exit();
121 /* Exit request mechanism */
122 SIMIX_request_destroy();
124 xbt_heap_free(simix_timers);
125 /* Free the remaining data structures */
126 xbt_dynar_free(&simix_global->process_to_run);
127 xbt_swag_free(simix_global->process_to_destroy);
128 xbt_swag_free(simix_global->process_list);
129 simix_global->process_list = NULL;
130 simix_global->process_to_destroy = NULL;
131 xbt_dict_free(&(simix_global->registered_functions));
132 xbt_dict_free(&(simix_global->host));
134 #ifdef HAVE_LATENCY_BOUND_TRACKING
135 xbt_dict_free(&(simix_global->latency_limited_dict));
138 /* Let's free maestro now */
139 SIMIX_context_free(simix_global->maestro_process->context);
140 xbt_free(simix_global->maestro_process->running_ctx);
141 xbt_free(simix_global->maestro_process);
142 simix_global->maestro_process = NULL;
144 /* Restore the default exception setup */
145 __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
146 __xbt_ex_terminate = &__xbt_ex_terminate_default;
148 /* Finish context module and SURF */
149 SIMIX_context_mod_exit();
153 xbt_free(simix_global);
161 * \brief A clock (in second).
163 * \return Return the clock.
165 XBT_INLINE double SIMIX_get_clock(void)
167 return surf_get_clock();
175 surf_action_t action;
182 DEBUG0("New Schedule Round");
183 SIMIX_context_runall(simix_global->process_to_run);
184 while ((req = SIMIX_request_pop())) {
185 DEBUG1("Handling request %p", req);
186 SIMIX_request_pre(req);
188 } while (xbt_dynar_length(simix_global->process_to_run));
190 time = surf_solve(SIMIX_timer_next());
192 /* Notify all the hosts that have failed */
193 /* FIXME: iterate through the list of failed host and mark each of them */
194 /* as failed. On each host, signal all the running processes with host_fail */
196 /* Handle any pending timer */
197 while (xbt_heap_size(simix_timers) > 0 && SIMIX_get_clock() >= SIMIX_timer_next()) {
198 //FIXME: make the timers being real callbacks
199 // (i.e. provide dispatchers that read and expand the args)
200 timer = xbt_heap_pop(simix_timers);
202 ((void (*)(void*))timer->func)(timer->args);
204 /* Wake up all process waiting for the action finish */
205 xbt_dynar_foreach(model_list, iter, model) {
206 for (set = model->states.failed_action_set;
208 set = (set == model->states.failed_action_set)
209 ? model->states.done_action_set
211 while ((action = xbt_swag_extract(set)))
212 SIMIX_request_post((smx_action_t) action->data);
215 } while (time != -1.0);
217 if (xbt_swag_size(simix_global->process_list) != 0) {
219 WARN0("Oops ! Deadlock or code not perfectly clean.");
220 SIMIX_display_process_status();
226 * \brief Set the date to execute a function
228 * Set the date to execute the function on the surf.
229 * \param date Date to execute function
230 * \param function Function to be executed
231 * \param arg Parameters of the function
234 XBT_INLINE void SIMIX_timer_set(double date, void *function, void *arg)
236 smx_timer_t timer = xbt_new0(s_smx_timer_t, 1);
239 timer->func = function;
241 xbt_heap_push(simix_timers, timer, date);
245 * \brief Registers a function to create a process.
247 * This function registers an user function to be called when a new process is created. The user function have to call the SIMIX_create_process function.
248 * \param function Create process function
251 XBT_INLINE void SIMIX_function_register_process_create(smx_creation_func_t
254 xbt_assert0((simix_global->create_process_function == NULL),
257 simix_global->create_process_function = function;
261 * \brief Registers a function to kill a process.
263 * This function registers an user function to be called when a new process is killed. The user function have to call the SIMIX_kill_process function.
264 * \param function Kill process function
267 XBT_INLINE void SIMIX_function_register_process_kill(void_f_pvoid_t
270 xbt_assert0((simix_global->kill_process_function == NULL),
273 simix_global->kill_process_function = function;
277 * \brief Registers a function to cleanup a process.
279 * This function registers an user function to be called when a new process ends properly.
280 * \param function cleanup process function
283 XBT_INLINE void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t
286 simix_global->cleanup_process_function = function;
290 void SIMIX_display_process_status(void)
292 if (simix_global->process_list == NULL) {
296 smx_process_t process = NULL;
297 int nbprocess = xbt_swag_size(simix_global->process_list);
299 INFO1("%d processes are still running, waiting for something.", nbprocess);
300 /* List the process and their state */
302 ("Legend of the following listing: \"<process> on <host>: <status>.\"");
303 xbt_swag_foreach(process, simix_global->process_list) {
305 if (process->waiting_action) {
307 const char* action_description = "unknown";
308 switch (process->waiting_action->type) {
310 case SIMIX_ACTION_EXECUTE:
311 action_description = "execution";
314 case SIMIX_ACTION_PARALLEL_EXECUTE:
315 action_description = "parallel execution";
318 case SIMIX_ACTION_COMMUNICATE:
319 action_description = "communication";
322 case SIMIX_ACTION_SLEEP:
323 action_description = "sleeping";
326 case SIMIX_ACTION_SYNCHRO:
327 action_description = "synchronization";
330 case SIMIX_ACTION_IO:
331 action_description = "I/O";
334 INFO2("Waiting for %s action %p to finish", action_description, process->waiting_action);