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"
12 #include "xbt/ex.h" /* ex_backtrace_display */
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_kernel, simix,
14 "Logging specific to SIMIX (kernel)");
16 SIMIX_Global_t simix_global = NULL;
18 /********************************* SIMIX **************************************/
21 * \brief Initialize some SIMIX internal data.
26 void SIMIX_global_init(int *argc, char **argv)
31 surf_init(argc, argv); /* Initialize some common structures. Warning, it sets simix_global=NULL */
33 simix_global = xbt_new0(s_SIMIX_Global_t,1);
35 simix_global->host = xbt_fifo_new();
36 simix_global->process_to_run = xbt_swag_new(xbt_swag_offset(proc,synchro_hookup));
37 simix_global->process_list = xbt_swag_new(xbt_swag_offset(proc,process_hookup));
38 simix_global->current_process = NULL;
39 simix_global->registered_functions = xbt_dict_new();
41 simix_global->create_process_function = NULL;
42 simix_global->kill_process_function = NULL;
43 simix_global->cleanup_process_function = NULL;
47 /* Debug purpose, incomplete */
48 void SIMIX_display_process_status(void)
50 smx_process_t process = NULL;
51 xbt_fifo_item_t item = NULL;
53 int nbprocess=xbt_swag_size(simix_global->process_list);
55 INFO1("%d processes are still running, waiting for something.",
57 /* List the process and their state */
58 INFO0("Legend of the following listing: \"<process> on <host>: <status>.\"");
59 xbt_swag_foreach(process, simix_global->process_list) {
60 smx_simdata_process_t p_simdata = (smx_simdata_process_t) process->simdata;
61 // simdata_host_t h_simdata=(simdata_host_t)p_simdata->host->simdata;
64 asprintf(&who,"%s on %s: %s",
66 p_simdata->s_host->name,
67 (process->simdata->blocked)?"[BLOCKED] "
68 :((process->simdata->suspended)?"[SUSPENDED] ":""));
70 if (p_simdata->mutex) {
71 who2=bprintf("%s Blocked on mutex %p",who,p_simdata->mutex);
73 } else if (p_simdata->cond) {
74 who2=bprintf("%s Blocked on condition %p; Waiting for the following actions:",who,p_simdata->cond);
76 xbt_fifo_foreach(p_simdata->cond->actions,item, act, smx_action_t) {
77 who2=bprintf("%s '%s'",who,act->name);
81 who2=bprintf("%s Blocked in an unknown status (please report this bug)",who);
89 /* FIXME: Yeah, I'll do it in a portable maner one day [Mt] */
92 static void _XBT_CALL inthandler(int ignored)
94 INFO0("CTRL-C pressed. Displaying status and bailing out");
95 SIMIX_display_process_status();
100 * \brief Launch the SIMIX simulation, debug purpose
102 void __SIMIX_main(void)
104 smx_process_t process = NULL;
105 smx_cond_t cond = NULL;
106 smx_action_t smx_action;
107 xbt_fifo_t actions_done = xbt_fifo_new();
108 xbt_fifo_t actions_failed = xbt_fifo_new();
110 /* Prepare to display some more info when dying on Ctrl-C pressing */
111 signal(SIGINT,inthandler);
113 /* Clean IO before the run */
117 //surf_solve(); /* Takes traces into account. Returns 0.0 */
118 /* xbt_fifo_size(msg_global->process_to_run) */
120 while (SIMIX_solve(actions_done, actions_failed) != -1.0) {
122 while ( (smx_action = xbt_fifo_pop(actions_failed)) ) {
124 xbt_fifo_item_t _cursor;
126 DEBUG1("** %s failed **",smx_action->name);
127 xbt_fifo_foreach(smx_action->cond_list,_cursor,cond,smx_cond_t) {
128 xbt_swag_foreach(process,cond->sleeping) {
129 DEBUG2("\t preparing to wake up %s on %s",
130 process->name, process->simdata->s_host->name);
132 SIMIX_cond_broadcast(cond);
133 /* remove conditional from action */
134 xbt_fifo_remove(smx_action->cond_list,cond);
138 while ( (smx_action = xbt_fifo_pop(actions_done)) ) {
139 xbt_fifo_item_t _cursor;
141 DEBUG1("** %s done **",smx_action->name);
142 xbt_fifo_foreach(smx_action->cond_list,_cursor,cond,smx_cond_t) {
143 xbt_swag_foreach(process,cond->sleeping) {
144 DEBUG2("\t preparing to wake up %s on %s",
145 process->name, process->simdata->s_host->name);
147 SIMIX_cond_broadcast(cond);
148 /* remove conditional from action */
149 xbt_fifo_remove(smx_action->cond_list,cond);
157 * \brief Kill all running process
160 void SIMIX_process_killall()
162 smx_process_t p = NULL;
163 smx_process_t self = SIMIX_process_self();
165 while((p=xbt_swag_extract(simix_global->process_list))) {
166 if(p!=self) SIMIX_process_kill(p);
169 xbt_context_empty_trash();
179 * \brief Clean the SIMIX simulation
181 * This functions remove all memories needed to the SIMIX execution
183 void SIMIX_clean(void)
185 xbt_fifo_item_t i = NULL;
187 smx_process_t p = NULL;
189 while((p=xbt_swag_extract(simix_global->process_list))) {
190 SIMIX_process_kill(p);
193 xbt_fifo_foreach(simix_global->host,i,h,smx_host_t) {
194 __SIMIX_host_destroy(h);
196 xbt_fifo_free(simix_global->host);
197 xbt_swag_free(simix_global->process_to_run);
198 xbt_swag_free(simix_global->process_list);
199 xbt_dict_free(&(simix_global->registered_functions));
200 simix_config_finalize();
209 * \brief A clock (in second).
211 * \return Return the clock.
213 double SIMIX_get_clock(void)
215 return surf_get_clock();
219 * \brief Does a turn of the simulation
221 * 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.
222 * \param actions_done List of actions done
223 * \param actions_failed List of actions failed
224 * \return The time spent to execute the simulation or -1 if the simulation ended
226 double SIMIX_solve(xbt_fifo_t actions_done, xbt_fifo_t actions_failed)
229 smx_process_t process = NULL;
231 double elapsed_time = 0.0;
232 static int state_modifications = 1;
233 static int first = 1;
235 xbt_context_empty_trash();
236 if(xbt_swag_size(simix_global->process_to_run) && (elapsed_time>0)) {
237 DEBUG0("**************************************************");
240 surf_solve();/* Takes traces into account. Returns 0.0 */
243 while ((process = xbt_swag_extract(simix_global->process_to_run))) {
244 DEBUG2("Scheduling %s on %s",
246 process->simdata->s_host->name);
247 simix_global->current_process = process;
248 xbt_context_schedule(process->simdata->context);
250 simix_global->current_process = NULL;
254 surf_action_t action = NULL;
255 surf_resource_t resource = NULL;
256 smx_action_t smx_action = NULL;
261 xbt_dynar_foreach(resource_list, i, resource) {
262 if(xbt_swag_size(resource->common_public->states.failed_action_set) ||
263 xbt_swag_size(resource->common_public->states.done_action_set)) {
264 state_modifications = 1;
268 if(!state_modifications) {
269 DEBUG1("%f : Calling surf_solve",SIMIX_get_clock());
270 elapsed_time = surf_solve();
271 DEBUG1("Elapsed_time %f",elapsed_time);
274 while (surf_timer_resource->extension_public->get(&fun,(void*)&arg)) {
275 DEBUG2("got %p %p", fun, arg);
276 if(fun==SIMIX_process_create) {
277 smx_process_arg_t args = arg;
278 DEBUG2("Launching %s on %s", args->name, args->hostname);
279 process = SIMIX_process_create(args->name, args->code,
280 args->data, args->hostname,
281 args->argc,args->argv);
282 if(args->kill_time > SIMIX_get_clock()) {
283 surf_timer_resource->extension_public->set(args->kill_time,
284 (void*) &SIMIX_process_kill,
289 if(fun==SIMIX_process_kill) {
291 DEBUG2("Killing %s on %s", process->name,
292 process->simdata->s_host->name);
293 SIMIX_process_kill(process);
297 /* Wake up all process waiting for the action finish */
298 xbt_dynar_foreach(resource_list, i, resource) {
299 while ((action = xbt_swag_extract(resource->common_public->states.failed_action_set))) {
300 smx_action = action->data;
302 xbt_fifo_unshift(actions_failed,smx_action);
305 while ((action =xbt_swag_extract(resource->common_public->states.done_action_set))) {
306 smx_action = action->data;
308 xbt_fifo_unshift(actions_done,smx_action);
313 state_modifications = 0;
315 if (elapsed_time == -1) {
316 if (xbt_swag_size(simix_global->process_list) == 0) {
317 /* INFO0("Congratulations ! Simulation terminated : all processes are over"); */
319 INFO0("Oops ! Deadlock or code not perfectly clean.");
320 SIMIX_display_process_status();
321 if(XBT_LOG_ISENABLED(simix, xbt_log_priority_debug) ||
322 XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_debug)) {
326 INFO0("Return a Warning.");
333 * \brief Set the date to execute a function
335 * Set the date to execute the function on the surf.
336 * \param date Date to execute function
337 * \param function Function to be executed
338 * \param arg Parameters of the function
341 void SIMIX_timer_set (double date, void *function, void *arg)
343 surf_timer_resource->extension_public->set(date, function, arg);
346 int SIMIX_timer_get(void **function, void **arg)
348 return surf_timer_resource->extension_public->get(function, arg);
352 * \brief Registers a function to create a process.
354 * 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.
355 * \param function Create process function
358 void SIMIX_function_register_process_create(smx_creation_func_t* function)
360 xbt_assert0((simix_global->create_process_function == NULL), "Data already set");
362 simix_global->create_process_function = function;
366 * \brief Registers a function to kill a process.
368 * 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.
369 * \param function Kill process function
372 void SIMIX_function_register_process_kill(void_f_pvoid_t* function)
374 xbt_assert0((simix_global->kill_process_function == NULL), "Data already set");
376 simix_global->kill_process_function = function;
380 * \brief Registers a function to cleanup a process.
382 * This function registers an user function to be called when a new process ends properly.
383 * \param function cleanup process function
386 void SIMIX_function_register_process_cleanup(void_f_pvoid_t* function)
388 xbt_assert0((simix_global->cleanup_process_function == NULL), "Data already set");
390 simix_global->cleanup_process_function = function;