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 #include "smx_private.h"
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 is 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(smx_process_t), NULL);
82 simix_global->process_that_ran = xbt_dynar_new(sizeof(smx_process_t), NULL);
83 simix_global->process_list =
84 xbt_swag_new(xbt_swag_offset(proc, process_hookup));
85 simix_global->process_to_destroy =
86 xbt_swag_new(xbt_swag_offset(proc, destroy_hookup));
88 simix_global->maestro_process = NULL;
89 simix_global->registered_functions = xbt_dict_new_homogeneous(NULL);
91 simix_global->create_process_function = SIMIX_process_create;
92 simix_global->kill_process_function = SIMIX_process_kill;
93 simix_global->cleanup_process_function = SIMIX_process_cleanup;
94 simix_global->action_mallocator = xbt_mallocator_new(65536,
95 SIMIX_action_mallocator_new_f, SIMIX_action_mallocator_free_f,
96 SIMIX_action_mallocator_reset_f);
98 surf_init(argc, argv); /* Initialize SURF structures */
99 SIMIX_context_mod_init();
100 SIMIX_create_maestro_process();
102 /* context exception handlers */
103 __xbt_running_ctx_fetch = SIMIX_process_get_running_context;
104 __xbt_ex_terminate = SIMIX_process_exception_terminate;
106 /* Initialize the SIMIX network module */
107 SIMIX_network_init();
109 /* Prepare to display some more info when dying on Ctrl-C pressing */
110 signal(SIGINT, inthandler);
113 simix_timers = xbt_heap_new(8, &free);
116 XBT_DEBUG("ADD SIMIX LEVELS");
117 SIMIX_HOST_LEVEL = xbt_lib_add_level(host_lib,SIMIX_host_destroy);
121 * \brief Clean the SIMIX simulation
123 * This functions remove the memory used by SIMIX
125 void SIMIX_clean(void)
128 smx_ctx_raw_new_sr();
131 /* Kill everyone (except maestro) */
132 SIMIX_process_killall(simix_global->maestro_process);
134 /* Exit the SIMIX network module */
135 SIMIX_network_exit();
137 xbt_heap_free(simix_timers);
139 /* Free the remaining data structures */
140 xbt_dynar_free(&simix_global->process_to_run);
141 xbt_dynar_free(&simix_global->process_that_ran);
142 xbt_swag_free(simix_global->process_to_destroy);
143 xbt_swag_free(simix_global->process_list);
144 simix_global->process_list = NULL;
145 simix_global->process_to_destroy = NULL;
146 xbt_dict_free(&(simix_global->registered_functions));
148 /* Let's free maestro now */
149 SIMIX_context_free(simix_global->maestro_process->context);
150 xbt_free(simix_global->maestro_process->running_ctx);
151 xbt_free(simix_global->maestro_process);
152 simix_global->maestro_process = NULL;
154 /* Restore the default exception setup */
155 __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
156 __xbt_ex_terminate = &__xbt_ex_terminate_default;
158 /* Finish context module and SURF */
159 SIMIX_context_mod_exit();
163 xbt_mallocator_free(simix_global->action_mallocator);
164 xbt_free(simix_global);
172 * \brief A clock (in second).
174 * \return Return the clock.
176 XBT_INLINE double SIMIX_get_clock(void)
179 return MC_process_clock_get(SIMIX_process_self());
181 return surf_get_clock();
188 smx_process_t process;
190 surf_action_t action;
196 XBT_DEBUG("New Schedule Round; size(queue)=%lu",
197 xbt_dynar_length(simix_global->process_to_run));
199 smx_ctx_raw_new_sr();
201 while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
202 XBT_DEBUG("New Sub-Schedule Round; size(queue)=%lu",
203 xbt_dynar_length(simix_global->process_to_run));
204 SIMIX_process_runall();
205 xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
206 if (process->simcall.call != SIMCALL_NONE) {
207 SIMIX_simcall_pre(&process->simcall, 0);
212 time = SIMIX_timer_next();
213 if (time != -1.0 || xbt_swag_size(simix_global->process_list) != 0)
214 time = surf_solve(time);
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 processes waiting for a Surf action to finish */
229 xbt_dynar_foreach(model_list, iter, model) {
230 set = model->states.failed_action_set;
231 while ((action = xbt_swag_extract(set)))
232 SIMIX_simcall_post((smx_action_t) action->data);
233 set = model->states.done_action_set;
234 while ((action = xbt_swag_extract(set)))
235 SIMIX_simcall_post((smx_action_t) action->data);
238 /* Clean processes to destroy */
239 SIMIX_process_empty_trash();
241 } while (time != -1.0 || !xbt_dynar_is_empty(simix_global->process_to_run));
243 if (xbt_swag_size(simix_global->process_list) != 0) {
249 XBT_WARN("Oops ! Deadlock or code not perfectly clean.");
250 SIMIX_display_process_status();
256 * \brief Set the date to execute a function
258 * Set the date to execute the function on the surf.
259 * \param date Date to execute function
260 * \param function Function to be executed
261 * \param arg Parameters of the function
264 XBT_INLINE void SIMIX_timer_set(double date, void *function, void *arg)
266 smx_timer_t timer = xbt_new0(s_smx_timer_t, 1);
269 timer->func = function;
271 xbt_heap_push(simix_timers, timer, date);
275 * \brief Registers a function to create a process.
277 * This function registers a function to be called
278 * when a new process is created. The function has
279 * to call SIMIX_process_create().
280 * \param function create process function
282 XBT_INLINE void SIMIX_function_register_process_create(smx_creation_func_t
285 simix_global->create_process_function = function;
289 * \brief Registers a function to kill a process.
291 * This function registers a function to be called when a
292 * process is killed. The function has to call the SIMIX_process_kill().
294 * \param function Kill process function
296 XBT_INLINE void SIMIX_function_register_process_kill(void_pfn_smxprocess_t
299 simix_global->kill_process_function = function;
303 * \brief Registers a function to cleanup a process.
305 * This function registers a user function to be called when
306 * a process ends properly.
308 * \param function cleanup process function
310 XBT_INLINE void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t
313 simix_global->cleanup_process_function = function;
317 void SIMIX_display_process_status(void)
319 if (simix_global->process_list == NULL) {
323 smx_process_t process = NULL;
324 int nbprocess = xbt_swag_size(simix_global->process_list);
326 XBT_INFO("%d processes are still running, waiting for something.", nbprocess);
327 /* List the process and their state */
329 ("Legend of the following listing: \"Process <pid> (<name>@<host>): <status>\"");
330 xbt_swag_foreach(process, simix_global->process_list) {
332 if (process->waiting_action) {
334 const char* action_description = "unknown";
335 switch (process->waiting_action->type) {
337 case SIMIX_ACTION_EXECUTE:
338 action_description = "execution";
341 case SIMIX_ACTION_PARALLEL_EXECUTE:
342 action_description = "parallel execution";
345 case SIMIX_ACTION_COMMUNICATE:
346 action_description = "communication";
349 case SIMIX_ACTION_SLEEP:
350 action_description = "sleeping";
353 case SIMIX_ACTION_SYNCHRO:
354 action_description = "synchronization";
357 case SIMIX_ACTION_IO:
358 action_description = "I/O";
361 XBT_INFO("Process %lu (%s@%s): waiting for %s action %p (%s) in state %d to finish",
362 process->pid, process->name, process->smx_host->name,
363 action_description, process->waiting_action,
364 process->waiting_action->name, (int)process->waiting_action->state);
367 XBT_INFO("Process %lu (%s@%s)", process->pid, process->name, process->smx_host->name);
372 static void* SIMIX_action_mallocator_new_f(void) {
373 smx_action_t action = xbt_new(s_smx_action_t, 1);
374 action->simcalls = xbt_fifo_new();
378 static void SIMIX_action_mallocator_free_f(void* action) {
379 xbt_fifo_free(((smx_action_t) action)->simcalls);
383 static void SIMIX_action_mallocator_reset_f(void* action) {
385 // we also recycle the simcall list
386 xbt_fifo_t fifo = ((smx_action_t) action)->simcalls;
387 xbt_fifo_reset(fifo);
388 memset(action, 0, sizeof(s_smx_action_t));
389 ((smx_action_t) action)->simcalls = fifo;