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->current_process = NULL;
67 simix_global->registered_functions = xbt_dict_new();
69 simix_global->create_process_function = NULL;
70 simix_global->kill_process_function = NULL;
71 simix_global->cleanup_process_function = SIMIX_process_cleanup;
73 /* Prepare to display some more info when dying on Ctrl-C pressing */
74 signal(SIGINT, inthandler);
75 surf_init(argc, argv); /* Initialize SURF structures */
79 /* Debug purpose, incomplete */
80 void SIMIX_display_process_status(void)
82 smx_process_t process = NULL;
83 xbt_fifo_item_t item = NULL;
85 int nbprocess = xbt_swag_size(simix_global->process_list);
87 INFO1("%d processes are still running, waiting for something.", nbprocess);
88 /* List the process and their state */
90 ("Legend of the following listing: \"<process> on <host>: <status>.\"");
91 xbt_swag_foreach(process, simix_global->process_list) {
92 smx_simdata_process_t p_simdata =
93 (smx_simdata_process_t) process->simdata;
94 // simdata_host_t h_simdata=(simdata_host_t)p_simdata->host->simdata;
97 asprintf(&who, "%s on %s: %s",
99 p_simdata->smx_host->name,
100 (process->simdata->blocked) ? "[BLOCKED] "
101 : ((process->simdata->suspended) ? "[SUSPENDED] " : ""));
103 if (p_simdata->mutex) {
105 bprintf("%s Blocked on mutex %p", who,
106 (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_verbose)) ?
107 p_simdata->mutex : (void *) 0xdead);
110 } else if (p_simdata->cond) {
113 ("%s Blocked on condition %p; Waiting for the following actions:",
115 (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_verbose)) ?
116 p_simdata->cond : (void *) 0xdead);
119 xbt_fifo_foreach(p_simdata->cond->actions, item, act, smx_action_t) {
121 bprintf("%s '%s'(%p)", who, act->name,
122 (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_verbose))
123 ? act : (void *) 0xdead);
130 ("%s Blocked in an unknown status (please report this bug)", who);
141 * \brief Launch the SIMIX simulation, debug purpose
143 void __SIMIX_main(void)
145 smx_process_t process = NULL;
146 smx_cond_t cond = NULL;
147 smx_action_t smx_action;
148 xbt_fifo_t actions_done = xbt_fifo_new();
149 xbt_fifo_t actions_failed = xbt_fifo_new();
151 /* Clean IO before the run */
155 //surf_solve(); /* Takes traces into account. Returns 0.0 */
156 /* xbt_fifo_size(msg_global->process_to_run) */
158 while (SIMIX_solve(actions_done, actions_failed) != -1.0) {
160 while ((smx_action = xbt_fifo_pop(actions_failed))) {
162 xbt_fifo_item_t _cursor;
164 DEBUG1("** %s failed **", smx_action->name);
165 xbt_fifo_foreach(smx_action->cond_list, _cursor, cond, smx_cond_t) {
166 xbt_swag_foreach(process, cond->sleeping) {
167 DEBUG2("\t preparing to wake up %s on %s",
168 process->name, process->simdata->smx_host->name);
170 SIMIX_cond_broadcast(cond);
171 /* remove conditional from action */
172 SIMIX_unregister_action_to_condition(smx_action, cond);
176 while ((smx_action = xbt_fifo_pop(actions_done))) {
177 xbt_fifo_item_t _cursor;
179 DEBUG1("** %s done **", smx_action->name);
180 xbt_fifo_foreach(smx_action->cond_list, _cursor, cond, smx_cond_t) {
181 xbt_swag_foreach(process, cond->sleeping) {
182 DEBUG2("\t preparing to wake up %s on %s",
183 process->name, process->simdata->smx_host->name);
185 SIMIX_cond_broadcast(cond);
186 /* remove conditional from action */
187 SIMIX_unregister_action_to_condition(smx_action, cond);
195 * \brief Kill all running process
198 void SIMIX_process_killall()
200 smx_process_t p = NULL;
201 smx_process_t self = SIMIX_process_self();
203 while ((p = xbt_swag_extract(simix_global->process_list))) {
205 SIMIX_process_kill(p);
208 xbt_context_empty_trash();
218 * \brief Clean the SIMIX simulation
220 * This functions remove all memories needed to the SIMIX execution
222 void SIMIX_clean(void)
224 smx_process_t p = NULL;
226 while ((p = xbt_swag_extract(simix_global->process_list))) {
227 SIMIX_process_kill(p);
230 xbt_dict_free(&(simix_global->host));
231 xbt_swag_free(simix_global->process_to_run);
232 xbt_swag_free(simix_global->process_list);
233 xbt_dict_free(&(simix_global->registered_functions));
244 * \brief A clock (in second).
246 * \return Return the clock.
248 double SIMIX_get_clock(void)
250 return surf_get_clock();
254 * \brief Finish the simulation initialization
256 * Must be called before the first call to SIMIX_solve()
258 void SIMIX_init(void)
264 * \brief Does a turn of the simulation
266 * 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.
267 * \param actions_done List of actions done
268 * \param actions_failed List of actions failed
269 * \return The time spent to execute the simulation or -1 if the simulation ended
271 double SIMIX_solve(xbt_fifo_t actions_done, xbt_fifo_t actions_failed)
274 smx_process_t process = NULL;
276 double elapsed_time = 0.0;
277 static int state_modifications = 1;
279 xbt_context_empty_trash();
280 if (xbt_swag_size(simix_global->process_to_run) && (elapsed_time > 0)) {
281 DEBUG0("**************************************************");
284 while ((process = xbt_swag_extract(simix_global->process_to_run))) {
285 DEBUG2("Scheduling %s on %s",
286 process->name, process->simdata->smx_host->name);
287 simix_global->current_process = process;
288 xbt_context_schedule(process->simdata->context);
290 simix_global->current_process = NULL;
294 surf_action_t action = NULL;
295 surf_model_t model = NULL;
296 smx_action_t smx_action = NULL;
301 xbt_dynar_foreach(model_list, iter, model) {
302 if (xbt_swag_size(model->common_public.states.failed_action_set)
303 || xbt_swag_size(model->common_public.states.done_action_set)) {
304 state_modifications = 1;
309 if (!state_modifications) {
310 DEBUG1("%f : Calling surf_solve", SIMIX_get_clock());
311 elapsed_time = surf_solve();
312 DEBUG1("Elapsed_time %f", elapsed_time);
315 while (surf_timer_model->extension.timer.get(&fun, (void *) &arg)) {
316 DEBUG2("got %p %p", fun, arg);
317 if (fun == SIMIX_process_create) {
318 smx_process_arg_t args = arg;
319 DEBUG2("Launching %s on %s", args->name, args->hostname);
320 process = SIMIX_process_create(args->name, args->code,
321 args->data, args->hostname,
322 args->argc, args->argv,
324 if (process && args->kill_time > SIMIX_get_clock()) {
325 surf_timer_model->extension.timer.set(args->kill_time, (void *)
331 if (fun == SIMIX_process_kill) {
333 DEBUG2("Killing %s on %s", process->name,
334 process->simdata->smx_host->name);
335 SIMIX_process_kill(process);
339 /* Wake up all process waiting for the action finish */
340 xbt_dynar_foreach(model_list, iter, model) {
342 xbt_swag_extract(model->common_public.
343 states.failed_action_set))) {
344 smx_action = action->data;
346 xbt_fifo_unshift(actions_failed, smx_action);
350 xbt_swag_extract(model->common_public.
351 states.done_action_set))) {
352 smx_action = action->data;
354 xbt_fifo_unshift(actions_done, smx_action);
359 state_modifications = 0;
361 if (elapsed_time == -1) {
362 if (xbt_swag_size(simix_global->process_list) == 0) {
363 /* INFO0("Congratulations ! Simulation terminated : all processes are over"); */
365 INFO0("Oops ! Deadlock or code not perfectly clean.");
366 SIMIX_display_process_status();
367 if (XBT_LOG_ISENABLED(simix, xbt_log_priority_debug) ||
368 XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_debug)) {
372 INFO0("Return a Warning.");
379 * \brief Set the date to execute a function
381 * Set the date to execute the function on the surf.
382 * \param date Date to execute function
383 * \param function Function to be executed
384 * \param arg Parameters of the function
387 void SIMIX_timer_set(double date, void *function, void *arg)
389 surf_timer_model->extension.timer.set(date, function, arg);
392 int SIMIX_timer_get(void **function, void **arg)
394 return surf_timer_model->extension.timer.get(function, arg);
398 * \brief Registers a function to create a process.
400 * 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.
401 * \param function Create process function
404 void SIMIX_function_register_process_create(smx_creation_func_t function)
406 xbt_assert0((simix_global->create_process_function == NULL),
409 simix_global->create_process_function = function;
413 * \brief Registers a function to kill a process.
415 * 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.
416 * \param function Kill process function
419 void SIMIX_function_register_process_kill(void_f_pvoid_t function)
421 xbt_assert0((simix_global->kill_process_function == NULL),
424 simix_global->kill_process_function = function;
428 * \brief Registers a function to cleanup a process.
430 * This function registers an user function to be called when a new process ends properly.
431 * \param function cleanup process function
434 void SIMIX_function_register_process_cleanup(void_f_pvoid_t function)
436 simix_global->cleanup_process_function = function;