3 /* Copyright (c) 2007 Arnaud Legrand, Bruno Donassolo.
4 All rights reserved. */
6 /* This program is free software; you can redistribute it and/or modify it
7 * under the terms of the license (GNU LGPL) which comes with this package. */
10 #include "xbt/sysdep.h"
13 #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_NEW_DEFAULT_SUBCATEGORY(simix_kernel, simix,
22 "Logging specific to SIMIX (kernel)");
24 SIMIX_Global_t simix_global = NULL;
27 /* FIXME: Yeah, I'll do it in a portable maner one day [Mt] */
30 static void _XBT_CALL inthandler(int ignored)
32 INFO0("CTRL-C pressed. Displaying status and bailing out");
33 SIMIX_display_process_status();
37 /********************************* SIMIX **************************************/
40 * \brief Initialize SIMIX internal data.
45 void SIMIX_global_init(int *argc, char **argv)
50 /* Connect our log channels: that must be done manually under windows */
51 XBT_LOG_CONNECT(simix_action, simix);
52 XBT_LOG_CONNECT(simix_deployment, simix);
53 XBT_LOG_CONNECT(simix_environment, simix);
54 XBT_LOG_CONNECT(simix_host, simix);
55 XBT_LOG_CONNECT(simix_kernel, simix);
56 XBT_LOG_CONNECT(simix_process, simix);
57 XBT_LOG_CONNECT(simix_synchro, simix);
59 simix_global = xbt_new0(s_SIMIX_Global_t, 1);
61 simix_global->host = xbt_dict_new();
62 simix_global->process_to_run =
63 xbt_swag_new(xbt_swag_offset(proc, synchro_hookup));
64 simix_global->process_list =
65 xbt_swag_new(xbt_swag_offset(proc, process_hookup));
66 simix_global->process_to_destroy =
67 xbt_swag_new(xbt_swag_offset(proc, destroy_hookup));
69 simix_global->current_process = NULL;
70 simix_global->maestro_process = NULL;
71 simix_global->registered_functions = xbt_dict_new();
73 simix_global->create_process_function = NULL;
74 simix_global->kill_process_function = NULL;
75 simix_global->cleanup_process_function = SIMIX_process_cleanup;
77 SIMIX_context_mod_init();
78 __SIMIX_create_maestro_process();
80 /* Prepare to display some more info when dying on Ctrl-C pressing */
81 signal(SIGINT, inthandler);
82 surf_init(argc, argv); /* Initialize SURF structures */
86 /* Debug purpose, incomplete */
87 void SIMIX_display_process_status(void)
89 smx_process_t process = NULL;
90 xbt_fifo_item_t item = NULL;
92 int nbprocess = xbt_swag_size(simix_global->process_list);
94 INFO1("%d processes are still running, waiting for something.", nbprocess);
95 /* List the process and their state */
97 ("Legend of the following listing: \"<process> on <host>: <status>.\"");
98 xbt_swag_foreach(process, simix_global->process_list) {
101 asprintf(&who, "%s on %s: %s",
103 process->smx_host->name,
104 (process->blocked) ? "[BLOCKED] "
105 : ((process->suspended) ? "[SUSPENDED] " : ""));
107 if (process->mutex) {
109 bprintf("%s Blocked on mutex %p", who,
110 (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_verbose)) ?
111 process->mutex : (void *) 0xdead);
114 } else if (process->cond) {
117 ("%s Blocked on condition %p; Waiting for the following actions:",
119 (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_verbose)) ?
120 process->cond : (void *) 0xdead);
123 xbt_fifo_foreach(process->cond->actions, item, act, smx_action_t) {
125 bprintf("%s '%s'(%p)", who, act->name,
126 (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_verbose))
127 ? act : (void *) 0xdead);
134 ("%s Blocked in an unknown status (please report this bug)", who);
145 * \brief Launch the SIMIX simulation, debug purpose
147 void __SIMIX_main(void)
149 smx_process_t process = NULL;
150 smx_cond_t cond = NULL;
151 smx_action_t smx_action;
152 xbt_fifo_t actions_done = xbt_fifo_new();
153 xbt_fifo_t actions_failed = xbt_fifo_new();
155 /* Clean IO before the run */
159 //surf_solve(); /* Takes traces into account. Returns 0.0 */
160 /* xbt_fifo_size(msg_global->process_to_run) */
162 while (SIMIX_solve(actions_done, actions_failed) != -1.0) {
164 while ((smx_action = xbt_fifo_pop(actions_failed))) {
166 xbt_fifo_item_t _cursor;
168 DEBUG1("** %s failed **", smx_action->name);
169 xbt_fifo_foreach(smx_action->cond_list, _cursor, cond, smx_cond_t) {
170 xbt_swag_foreach(process, cond->sleeping) {
171 DEBUG2("\t preparing to wake up %s on %s",
172 process->name, process->smx_host->name);
174 SIMIX_cond_broadcast(cond);
175 /* remove conditional from action */
176 SIMIX_unregister_action_to_condition(smx_action, cond);
180 while ((smx_action = xbt_fifo_pop(actions_done))) {
181 xbt_fifo_item_t _cursor;
183 DEBUG1("** %s done **", smx_action->name);
184 xbt_fifo_foreach(smx_action->cond_list, _cursor, cond, smx_cond_t) {
185 xbt_swag_foreach(process, cond->sleeping) {
186 DEBUG2("\t preparing to wake up %s on %s",
187 process->name, process->smx_host->name);
189 SIMIX_cond_broadcast(cond);
190 /* remove conditional from action */
191 SIMIX_unregister_action_to_condition(smx_action, cond);
199 * \brief Kill all running process
202 void SIMIX_process_killall()
204 smx_process_t p = NULL;
205 smx_process_t self = SIMIX_process_self();
207 while ((p = xbt_swag_extract(simix_global->process_list))) {
209 SIMIX_process_kill(p);
212 SIMIX_context_empty_trash();
214 if (self != simix_global->maestro_process) {
215 SIMIX_context_yield();
222 * \brief Clean the SIMIX simulation
224 * This functions remove the memory used by SIMIX
226 void SIMIX_clean(void)
228 /* Kill everyone (except maestro) */
229 SIMIX_process_killall();
231 /* Free the remaining data structures*/
232 xbt_swag_free(simix_global->process_to_run);
233 xbt_swag_free(simix_global->process_to_destroy);
234 xbt_swag_free(simix_global->process_list);
235 simix_global->process_list = NULL;
236 xbt_dict_free(&(simix_global->registered_functions));
237 xbt_dict_free(&(simix_global->host));
239 /* Let's free maestro now */
240 SIMIX_context_free(simix_global->maestro_process);
241 free(simix_global->maestro_process);
243 /* Finish context module and SURF */
244 SIMIX_context_mod_exit();
255 * \brief A clock (in second).
257 * \return Return the clock.
259 double SIMIX_get_clock(void)
261 return surf_get_clock();
265 * \brief Finish the simulation initialization
267 * Must be called before the first call to SIMIX_solve()
269 void SIMIX_init(void)
275 * \brief Does a turn of the simulation
277 * Executes a step in the surf simulation, adding to the two lists all the actions that finished on this turn. Schedules all processus in the process_to_run list.
278 * \param actions_done List of actions done
279 * \param actions_failed List of actions failed
280 * \return The time spent to execute the simulation or -1 if the simulation ended
282 double SIMIX_solve(xbt_fifo_t actions_done, xbt_fifo_t actions_failed)
285 smx_process_t process = NULL;
287 double elapsed_time = 0.0;
288 static int state_modifications = 1;
290 SIMIX_context_empty_trash();
291 if (xbt_swag_size(simix_global->process_to_run) && (elapsed_time > 0)) {
292 DEBUG0("**************************************************");
295 while ((process = xbt_swag_extract(simix_global->process_to_run))) {
296 DEBUG2("Scheduling %s on %s", process->name, process->smx_host->name);
297 SIMIX_context_schedule(process);
301 surf_action_t action = NULL;
302 surf_model_t model = NULL;
303 smx_action_t smx_action = NULL;
308 xbt_dynar_foreach(model_list, iter, model) {
309 if (xbt_swag_size(model->states.failed_action_set)
310 || xbt_swag_size(model->states.done_action_set)) {
311 state_modifications = 1;
316 if (!state_modifications) {
317 DEBUG1("%f : Calling surf_solve", SIMIX_get_clock());
318 elapsed_time = surf_solve();
319 DEBUG1("Elapsed_time %f", elapsed_time);
322 while (surf_timer_model->extension.timer.get(&fun, (void *) &arg)) {
323 DEBUG2("got %p %p", fun, arg);
324 if (fun == SIMIX_process_create) {
325 smx_process_arg_t args = arg;
326 DEBUG2("Launching %s on %s", args->name, args->hostname);
327 process = SIMIX_process_create(args->name, args->code,
328 args->data, args->hostname,
329 args->argc, args->argv,
331 if (process && args->kill_time > SIMIX_get_clock()) {
332 surf_timer_model->extension.timer.set(args->kill_time, (void *)
338 if (fun == SIMIX_process_kill) {
340 DEBUG2("Killing %s on %s", process->name,
341 process->smx_host->name);
342 SIMIX_process_kill(process);
346 /* Wake up all process waiting for the action finish */
347 xbt_dynar_foreach(model_list, iter, model) {
348 while ((action = xbt_swag_extract(model->states.failed_action_set))) {
349 smx_action = action->data;
351 xbt_fifo_unshift(actions_failed, smx_action);
354 while ((action = xbt_swag_extract(model->states.done_action_set))) {
355 smx_action = action->data;
357 xbt_fifo_unshift(actions_done, smx_action);
362 state_modifications = 0;
364 if (elapsed_time == -1) {
365 if (xbt_swag_size(simix_global->process_list) == 0) {
366 /* INFO0("Congratulations ! Simulation terminated : all processes are over"); */
368 INFO0("Oops ! Deadlock or code not perfectly clean.");
369 SIMIX_display_process_status();
370 if (XBT_LOG_ISENABLED(simix, xbt_log_priority_debug) ||
371 XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_debug)) {
375 INFO0("Return a Warning.");
382 * \brief Set the date to execute a function
384 * Set the date to execute the function on the surf.
385 * \param date Date to execute function
386 * \param function Function to be executed
387 * \param arg Parameters of the function
390 void SIMIX_timer_set(double date, void *function, void *arg)
392 surf_timer_model->extension.timer.set(date, function, arg);
395 int SIMIX_timer_get(void **function, void **arg)
397 return surf_timer_model->extension.timer.get(function, arg);
401 * \brief Registers a function to create a process.
403 * 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.
404 * \param function Create process function
407 void SIMIX_function_register_process_create(smx_creation_func_t function)
409 xbt_assert0((simix_global->create_process_function == NULL),
412 simix_global->create_process_function = function;
416 * \brief Registers a function to kill a process.
418 * 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.
419 * \param function Kill process function
422 void SIMIX_function_register_process_kill(void_f_pvoid_t function)
424 xbt_assert0((simix_global->kill_process_function == NULL),
427 simix_global->kill_process_function = function;
431 * \brief Registers a function to cleanup a process.
433 * This function registers an user function to be called when a new process ends properly.
434 * \param function cleanup process function
437 void SIMIX_function_register_process_cleanup(void_f_pvoid_t function)
439 simix_global->cleanup_process_function = function;