Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
model-checker : break forgotten in switch
[simgrid.git] / src / simix / smx_global.c
1 /* Copyright (c) 2007, 2008, 2009, 2010. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
7 #include "private.h"
8 #include "xbt/heap.h"
9 #include "xbt/sysdep.h"
10 #include "xbt/log.h"
11 #include "xbt/str.h"
12 #include "xbt/ex.h"             /* ex_backtrace_display */
13 #include "mc/mc.h"
14
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)");
25
26 smx_global_t simix_global = NULL;
27 static xbt_heap_t simix_timers = NULL;
28
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);
32
33 extern void smx_ctx_raw_new_sr(void);
34
35 /* FIXME: Yeah, I'll do it in a portable maner one day [Mt] */
36 #include <signal.h>
37
38 int _surf_do_verbose_exit = 1;
39 static void _XBT_CALL inthandler(int ignored)
40 {
41   if ( _surf_do_verbose_exit ) {
42      XBT_INFO("CTRL-C pressed. Displaying status and bailing out");
43      SIMIX_display_process_status();
44   }
45   else {
46      XBT_INFO("CTRL-C pressed. bailing out without displaying because verbose-exit is disabled");
47   }
48   exit(1);
49 }
50
51 /********************************* SIMIX **************************************/
52
53 XBT_INLINE double SIMIX_timer_next(void)
54 {
55   return xbt_heap_size(simix_timers) > 0 ? xbt_heap_maxkey(simix_timers) : -1.0;
56 }
57
58 /**
59  * \brief Initialize SIMIX internal data.
60  *
61  * \param argc Argc
62  * \param argv Argv
63  */
64 void SIMIX_global_init(int *argc, char **argv)
65 {
66   s_smx_process_t proc;
67
68   if (!simix_global) {
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);
78
79     simix_global = xbt_new0(s_smx_global_t, 1);
80
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));
87
88     simix_global->maestro_process = NULL;
89     simix_global->registered_functions = xbt_dict_new_homogeneous(NULL);
90
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);
97
98     surf_init(argc, argv);      /* Initialize SURF structures */
99     SIMIX_context_mod_init();
100     SIMIX_create_maestro_process();
101
102     /* context exception handlers */
103     __xbt_running_ctx_fetch = SIMIX_process_get_running_context;
104     __xbt_ex_terminate = SIMIX_process_exception_terminate;
105
106     /* Initialize the SIMIX network module */
107     SIMIX_network_init();
108
109     /* Prepare to display some more info when dying on Ctrl-C pressing */
110     signal(SIGINT, inthandler);
111   }
112   if (!simix_timers) {
113     simix_timers = xbt_heap_new(8, &free);
114   }
115
116   XBT_DEBUG("ADD SIMIX LEVELS");
117   SIMIX_HOST_LEVEL = xbt_lib_add_level(host_lib,SIMIX_host_destroy);
118 }
119
120 /**
121  * \brief Clean the SIMIX simulation
122  *
123  * This functions remove the memory used by SIMIX
124  */
125 void SIMIX_clean(void)
126 {
127 #ifdef TIME_BENCH
128   smx_ctx_raw_new_sr();
129 #endif
130
131   /* Kill everyone (except maestro) */
132   SIMIX_process_killall(simix_global->maestro_process);
133
134   /* Exit the SIMIX network module */
135   SIMIX_network_exit();
136
137   xbt_heap_free(simix_timers);
138   simix_timers = NULL;
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));
147
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;
153
154   /* Restore the default exception setup */
155   __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
156   __xbt_ex_terminate = &__xbt_ex_terminate_default;
157
158   /* Finish context module and SURF */
159   SIMIX_context_mod_exit();
160
161   surf_exit();
162
163   xbt_mallocator_free(simix_global->action_mallocator);
164   xbt_free(simix_global);
165   simix_global = NULL;
166
167   return;
168 }
169
170
171 /**
172  * \brief A clock (in second).
173  *
174  * \return Return the clock.
175  */
176 XBT_INLINE double SIMIX_get_clock(void)
177 {
178   if(MC_IS_ENABLED){
179     return MC_process_clock_get(SIMIX_process_self());
180   }else{
181     return surf_get_clock();
182   }
183 }
184
185 void SIMIX_run(void)
186 {
187   double time = 0;
188   smx_process_t process;
189   xbt_swag_t set;
190   surf_action_t action;
191   smx_timer_t timer;
192   surf_model_t model;
193   unsigned int iter;
194
195   do {
196     XBT_DEBUG("New Schedule Round; size(queue)=%lu",
197         xbt_dynar_length(simix_global->process_to_run));
198 #ifdef TIME_BENCH
199     smx_ctx_raw_new_sr();
200 #endif
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->request.call != REQ_NO_REQ) {
207           SIMIX_request_pre(&process->request, 0);
208         }
209       }
210     }
211
212     time = SIMIX_timer_next();
213     if (time != -1.0 || xbt_swag_size(simix_global->process_list) != 0)
214       time = surf_solve(time);
215
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 */
219
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);
225        if (timer->func)
226          ((void (*)(void*))timer->func)(timer->args);
227     }
228     /* Wake up all process waiting for the action finish */
229     xbt_dynar_foreach(model_list, iter, model) {
230       for (set = model->states.failed_action_set;
231            set;
232            set = (set == model->states.failed_action_set)
233                  ? model->states.done_action_set
234                  : NULL) {
235         while ((action = xbt_swag_extract(set)))
236           SIMIX_request_post((smx_action_t) action->data);
237       }
238     }
239
240     /* Clean processes to destroy */
241     SIMIX_process_empty_trash();
242
243   } while (time != -1.0 || !xbt_dynar_is_empty(simix_global->process_to_run));
244
245   if (xbt_swag_size(simix_global->process_list) != 0) {
246
247 #ifdef HAVE_TRACING
248     TRACE_end();
249 #endif
250
251     XBT_WARN("Oops ! Deadlock or code not perfectly clean.");
252     SIMIX_display_process_status();
253     xbt_abort();
254   }
255 }
256
257 /**
258  *      \brief Set the date to execute a function
259  *
260  * Set the date to execute the function on the surf.
261  *      \param date Date to execute function
262  *      \param function Function to be executed
263  *      \param arg Parameters of the function
264  *
265  */
266 XBT_INLINE void SIMIX_timer_set(double date, void *function, void *arg)
267 {
268   smx_timer_t timer = xbt_new0(s_smx_timer_t, 1);
269
270   timer->date = date;
271   timer->func = function;
272   timer->args = arg;
273   xbt_heap_push(simix_timers, timer, date);
274 }
275
276 /**
277  * \brief Registers a function to create a process.
278  *
279  * This function registers a function to be called
280  * when a new process is created. The function has
281  * to call SIMIX_process_create().
282  * \param function create process function
283  */
284 XBT_INLINE void SIMIX_function_register_process_create(smx_creation_func_t
285                                                        function)
286 {
287   simix_global->create_process_function = function;
288 }
289
290 /**
291  * \brief Registers a function to kill a process.
292  *
293  * This function registers a function to be called when a
294  * process is killed. The function has to call the SIMIX_process_kill().
295  *
296  * \param function Kill process function
297  */
298 XBT_INLINE void SIMIX_function_register_process_kill(void_pfn_smxprocess_t
299                                                      function)
300 {
301   simix_global->kill_process_function = function;
302 }
303
304 /**
305  * \brief Registers a function to cleanup a process.
306  *
307  * This function registers a user function to be called when
308  * a process ends properly.
309  *
310  * \param function cleanup process function
311  */
312 XBT_INLINE void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t
313                                                         function)
314 {
315   simix_global->cleanup_process_function = function;
316 }
317
318
319 void SIMIX_display_process_status(void)
320 {
321   if (simix_global->process_list == NULL) {
322     return;
323   }
324
325   smx_process_t process = NULL;
326   int nbprocess = xbt_swag_size(simix_global->process_list);
327
328   XBT_INFO("%d processes are still running, waiting for something.", nbprocess);
329   /*  List the process and their state */
330   XBT_INFO
331     ("Legend of the following listing: \"Process <pid> (<name>@<host>): <status>\"");
332   xbt_swag_foreach(process, simix_global->process_list) {
333
334     if (process->waiting_action) {
335
336       const char* action_description = "unknown";
337       switch (process->waiting_action->type) {
338
339         case SIMIX_ACTION_EXECUTE:
340           action_description = "execution";
341           break;
342
343         case SIMIX_ACTION_PARALLEL_EXECUTE:
344           action_description = "parallel execution";
345           break;
346
347         case SIMIX_ACTION_COMMUNICATE:
348           action_description = "communication";
349           break;
350
351         case SIMIX_ACTION_SLEEP:
352           action_description = "sleeping";
353           break;
354
355         case SIMIX_ACTION_SYNCHRO:
356           action_description = "synchronization";
357           break;
358
359         case SIMIX_ACTION_IO:
360           action_description = "I/O";
361           break;
362       }
363       XBT_INFO("Process %ld (%s@%s): waiting for %s action %p (%s) in state %d to finish",
364           process->pid, process->name, process->smx_host->name,
365           action_description, process->waiting_action,
366           process->waiting_action->name, process->waiting_action->state);
367     }
368     else {
369       XBT_INFO("Process %ld (%s@%s)", process->pid, process->name, process->smx_host->name);
370     }
371   }
372 }
373
374 static void* SIMIX_action_mallocator_new_f(void) {
375   smx_action_t action = xbt_new(s_smx_action_t, 1);
376   action->request_list = xbt_fifo_new();
377   return action;
378 }
379
380 static void SIMIX_action_mallocator_free_f(void* action) {
381   xbt_fifo_free(((smx_action_t) action)->request_list);
382   xbt_free(action);
383 }
384
385 static void SIMIX_action_mallocator_reset_f(void* action) {
386
387   // we also recycle the request list
388   xbt_fifo_t fifo = ((smx_action_t) action)->request_list;
389   xbt_fifo_reset(fifo);
390   memset(action, 0, sizeof(s_smx_action_t));
391   ((smx_action_t) action)->request_list = fifo;
392 }