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 /* FIXME: Yeah, I'll do it in a portable maner one day [Mt] */
36 static void _XBT_CALL inthandler(int ignored)
38 XBT_INFO("CTRL-C pressed. Displaying status and bailing out");
39 SIMIX_display_process_status();
43 /********************************* SIMIX **************************************/
45 XBT_INLINE double SIMIX_timer_next(void)
47 return xbt_heap_size(simix_timers) > 0 ? xbt_heap_maxkey(simix_timers) : -1.0;
51 * \brief Initialize SIMIX internal data.
56 void SIMIX_global_init(int *argc, char **argv)
61 /* Connect our log channels: that must be done manually under windows */
62 XBT_LOG_CONNECT(simix_action, simix);
63 XBT_LOG_CONNECT(simix_deployment, simix);
64 XBT_LOG_CONNECT(simix_environment, simix);
65 XBT_LOG_CONNECT(simix_host, simix);
66 XBT_LOG_CONNECT(simix_kernel, simix);
67 XBT_LOG_CONNECT(simix_process, simix);
68 XBT_LOG_CONNECT(simix_synchro, simix);
69 XBT_LOG_CONNECT(simix_context, simix);
71 simix_global = xbt_new0(s_smx_global_t, 1);
73 simix_global->host = xbt_dict_new();
74 simix_global->process_to_run = xbt_dynar_new(sizeof(void *), NULL);
75 simix_global->process_list =
76 xbt_swag_new(xbt_swag_offset(proc, process_hookup));
77 simix_global->process_to_destroy =
78 xbt_swag_new(xbt_swag_offset(proc, destroy_hookup));
80 simix_global->maestro_process = NULL;
81 simix_global->registered_functions = xbt_dict_new();
83 simix_global->create_process_function = NULL;
84 simix_global->kill_process_function = NULL;
85 simix_global->cleanup_process_function = SIMIX_process_cleanup;
86 simix_global->action_mallocator = xbt_mallocator_new(65536,
87 SIMIX_action_mallocator_new_f, SIMIX_action_mallocator_free_f,
88 SIMIX_action_mallocator_reset_f);
90 surf_init(argc, argv); /* Initialize SURF structures */
91 SIMIX_context_mod_init();
92 SIMIX_create_maestro_process();
94 /* context exception handlers */
95 __xbt_running_ctx_fetch = SIMIX_process_get_running_context;
96 __xbt_ex_terminate = SIMIX_process_exception_terminate;
98 /* Initialize request mechanism */
101 /* Initialize the SIMIX network module */
102 SIMIX_network_init();
104 /* Prepare to display some more info when dying on Ctrl-C pressing */
105 signal(SIGINT, inthandler);
108 simix_timers = xbt_heap_new(8, &free);
113 * \brief Clean the SIMIX simulation
115 * This functions remove the memory used by SIMIX
117 void SIMIX_clean(void)
119 /* Kill everyone (except maestro) */
120 SIMIX_process_killall();
122 /* Exit the SIMIX network module */
123 SIMIX_network_exit();
125 /* Exit request mechanism */
126 SIMIX_request_destroy();
128 xbt_heap_free(simix_timers);
129 /* Free the remaining data structures */
130 xbt_dynar_free(&simix_global->process_to_run);
131 xbt_swag_free(simix_global->process_to_destroy);
132 xbt_swag_free(simix_global->process_list);
133 simix_global->process_list = NULL;
134 simix_global->process_to_destroy = NULL;
135 xbt_dict_free(&(simix_global->registered_functions));
136 xbt_dict_free(&(simix_global->host));
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_mallocator_free(simix_global->action_mallocator);
154 xbt_free(simix_global);
162 * \brief A clock (in second).
164 * \return Return the clock.
166 XBT_INLINE double SIMIX_get_clock(void)
169 return MC_process_clock_get(SIMIX_process_self());
171 return surf_get_clock();
180 surf_action_t action;
186 XBT_DEBUG("New Schedule Round; size(queue)=%lu",
187 xbt_dynar_length(simix_global->process_to_run));
189 XBT_DEBUG("New Sub-Schedule Round; size(queue)=%lu",
190 xbt_dynar_length(simix_global->process_to_run));
191 SIMIX_context_runall(simix_global->process_to_run);
192 while ((req = SIMIX_request_pop())) {
193 XBT_DEBUG("Handling request %p", req);
194 SIMIX_request_pre(req, 0);
196 } while (xbt_dynar_length(simix_global->process_to_run));
198 time = surf_solve(SIMIX_timer_next());
200 /* Notify all the hosts that have failed */
201 /* FIXME: iterate through the list of failed host and mark each of them */
202 /* as failed. On each host, signal all the running processes with host_fail */
204 /* Handle any pending timer */
205 while (xbt_heap_size(simix_timers) > 0 && SIMIX_get_clock() >= SIMIX_timer_next()) {
206 //FIXME: make the timers being real callbacks
207 // (i.e. provide dispatchers that read and expand the args)
208 timer = xbt_heap_pop(simix_timers);
210 ((void (*)(void*))timer->func)(timer->args);
212 /* Wake up all process waiting for the action finish */
213 xbt_dynar_foreach(model_list, iter, model) {
214 for (set = model->states.failed_action_set;
216 set = (set == model->states.failed_action_set)
217 ? model->states.done_action_set
219 while ((action = xbt_swag_extract(set)))
220 SIMIX_request_post((smx_action_t) action->data);
223 } while (time != -1.0);
225 if (xbt_swag_size(simix_global->process_list) != 0) {
227 XBT_WARN("Oops ! Deadlock or code not perfectly clean.");
228 SIMIX_display_process_status();
234 * \brief Set the date to execute a function
236 * Set the date to execute the function on the surf.
237 * \param date Date to execute function
238 * \param function Function to be executed
239 * \param arg Parameters of the function
242 XBT_INLINE void SIMIX_timer_set(double date, void *function, void *arg)
244 smx_timer_t timer = xbt_new0(s_smx_timer_t, 1);
247 timer->func = function;
249 xbt_heap_push(simix_timers, timer, date);
253 * \brief Registers a function to create a process.
255 * 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.
256 * \param function Create process function
259 XBT_INLINE void SIMIX_function_register_process_create(smx_creation_func_t
262 xbt_assert0((simix_global->create_process_function == NULL),
265 simix_global->create_process_function = function;
269 * \brief Registers a function to kill a process.
271 * 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.
272 * \param function Kill process function
275 XBT_INLINE void SIMIX_function_register_process_kill(void_f_pvoid_t
278 xbt_assert0((simix_global->kill_process_function == NULL),
281 simix_global->kill_process_function = function;
285 * \brief Registers a function to cleanup a process.
287 * This function registers an user function to be called when a new process ends properly.
288 * \param function cleanup process function
291 XBT_INLINE void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t
294 simix_global->cleanup_process_function = function;
298 void SIMIX_display_process_status(void)
300 if (simix_global->process_list == NULL) {
304 smx_process_t process = NULL;
305 int nbprocess = xbt_swag_size(simix_global->process_list);
307 XBT_INFO("%d processes are still running, waiting for something.", nbprocess);
308 /* List the process and their state */
310 ("Legend of the following listing: \"<process> on <host>: <status>.\"");
311 xbt_swag_foreach(process, simix_global->process_list) {
313 if (process->waiting_action) {
315 const char* action_description = "unknown";
316 switch (process->waiting_action->type) {
318 case SIMIX_ACTION_EXECUTE:
319 action_description = "execution";
322 case SIMIX_ACTION_PARALLEL_EXECUTE:
323 action_description = "parallel execution";
326 case SIMIX_ACTION_COMMUNICATE:
327 action_description = "communication";
330 case SIMIX_ACTION_SLEEP:
331 action_description = "sleeping";
334 case SIMIX_ACTION_SYNCHRO:
335 action_description = "synchronization";
338 case SIMIX_ACTION_IO:
339 action_description = "I/O";
342 XBT_INFO("Waiting for %s action %p to finish", action_description, process->waiting_action);
347 static void* SIMIX_action_mallocator_new_f(void) {
348 smx_action_t action = xbt_new(s_smx_action_t, 1);
349 action->request_list = xbt_fifo_new();
353 static void SIMIX_action_mallocator_free_f(void* action) {
354 xbt_fifo_free(((smx_action_t) action)->request_list);
358 static void SIMIX_action_mallocator_reset_f(void* action) {
360 // we also recycle the request list
361 xbt_fifo_t fifo = ((smx_action_t) action)->request_list;
362 xbt_fifo_reset(fifo);
363 memset(action, 0, sizeof(s_smx_action_t));
364 ((smx_action_t) action)->request_list = fifo;