Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
more debugging message
[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
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_EXTERNAL_CATEGORY(simix_context);
22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_kernel, simix,
23                                 "Logging specific to SIMIX (kernel)");
24
25 smx_global_t simix_global = NULL;
26 static xbt_heap_t simix_timers = NULL;
27
28 /* FIXME: Yeah, I'll do it in a portable maner one day [Mt] */
29 #include <signal.h>
30
31 static void _XBT_CALL inthandler(int ignored)
32 {
33   INFO0("CTRL-C pressed. Displaying status and bailing out");
34   SIMIX_display_process_status();
35   exit(1);
36 }
37
38 /********************************* SIMIX **************************************/
39
40 XBT_INLINE double SIMIX_timer_next(void)
41 {
42   return xbt_heap_size(simix_timers) > 0 ? xbt_heap_maxkey(simix_timers) : -1.0;
43 }
44
45 /**
46  * \brief Initialize SIMIX internal data.
47  *
48  * \param argc Argc
49  * \param argv Argv
50  */
51 void SIMIX_global_init(int *argc, char **argv)
52 {
53   s_smx_process_t proc;
54
55   if (!simix_global) {
56     /* Connect our log channels: that must be done manually under windows */
57     XBT_LOG_CONNECT(simix_action, simix);
58     XBT_LOG_CONNECT(simix_deployment, simix);
59     XBT_LOG_CONNECT(simix_environment, simix);
60     XBT_LOG_CONNECT(simix_host, simix);
61     XBT_LOG_CONNECT(simix_kernel, simix);
62     XBT_LOG_CONNECT(simix_process, simix);
63     XBT_LOG_CONNECT(simix_synchro, simix);
64     XBT_LOG_CONNECT(simix_context, simix);
65
66     simix_global = xbt_new0(s_smx_global_t, 1);
67
68     simix_global->host = xbt_dict_new();
69     simix_global->process_to_run = xbt_dynar_new(sizeof(void *), NULL);
70     simix_global->process_list =
71         xbt_swag_new(xbt_swag_offset(proc, process_hookup));
72     simix_global->process_to_destroy =
73         xbt_swag_new(xbt_swag_offset(proc, destroy_hookup));
74
75     simix_global->maestro_process = NULL;
76     simix_global->registered_functions = xbt_dict_new();
77
78     simix_global->create_process_function = NULL;
79     simix_global->kill_process_function = NULL;
80     simix_global->cleanup_process_function = SIMIX_process_cleanup;
81
82 #ifdef HAVE_LATENCY_BOUND_TRACKING
83     simix_global->latency_limited_dict = xbt_dict_new();
84 #endif
85
86     surf_init(argc, argv);      /* Initialize SURF structures */
87     SIMIX_context_mod_init();
88     SIMIX_create_maestro_process();
89
90     /* context exception handlers */
91     __xbt_running_ctx_fetch = SIMIX_process_get_running_context;
92     __xbt_ex_terminate = SIMIX_process_exception_terminate;
93
94     /* Initialize request mechanism */
95     SIMIX_request_init();
96
97     /* Initialize the SIMIX network module */
98     SIMIX_network_init();
99
100     /* Prepare to display some more info when dying on Ctrl-C pressing */
101     signal(SIGINT, inthandler);
102   }
103   if (!simix_timers) {
104     simix_timers = xbt_heap_new(8, &free);
105   }
106 }
107
108 /**
109  * \brief Clean the SIMIX simulation
110  *
111  * This functions remove the memory used by SIMIX
112  */
113 void SIMIX_clean(void)
114 {
115   /* Kill everyone (except maestro) */
116   SIMIX_process_killall();
117
118   /* Exit the SIMIX network module */
119   SIMIX_network_exit();
120
121   /* Exit request mechanism */
122   SIMIX_request_destroy();
123
124   xbt_heap_free(simix_timers);
125   /* Free the remaining data structures */
126   xbt_dynar_free(&simix_global->process_to_run);
127   xbt_swag_free(simix_global->process_to_destroy);
128   xbt_swag_free(simix_global->process_list);
129   simix_global->process_list = NULL;
130   simix_global->process_to_destroy = NULL;
131   xbt_dict_free(&(simix_global->registered_functions));
132   xbt_dict_free(&(simix_global->host));
133
134 #ifdef HAVE_LATENCY_BOUND_TRACKING
135   xbt_dict_free(&(simix_global->latency_limited_dict));
136 #endif
137
138   /* Let's free maestro now */
139   SIMIX_context_free(simix_global->maestro_process->context);
140   xbt_free(simix_global->maestro_process->running_ctx);
141   xbt_free(simix_global->maestro_process);
142   simix_global->maestro_process = NULL;
143
144   /* Restore the default exception setup */
145   __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
146   __xbt_ex_terminate = &__xbt_ex_terminate_default;
147
148   /* Finish context module and SURF */
149   SIMIX_context_mod_exit();
150
151   surf_exit();
152
153   xbt_free(simix_global);
154   simix_global = NULL;
155
156   return;
157 }
158
159
160 /**
161  * \brief A clock (in second).
162  *
163  * \return Return the clock.
164  */
165 XBT_INLINE double SIMIX_get_clock(void)
166 {
167   return surf_get_clock();
168 }
169
170 void SIMIX_run(void)
171 {
172   double time = 0;
173   smx_req_t req;
174   xbt_swag_t set;
175   surf_action_t action;
176   smx_timer_t timer;
177   surf_model_t model;
178   unsigned int iter;
179
180   do {
181     do {
182       DEBUG1("New Schedule Round; size(queue)=%lu",
183           xbt_dynar_length(simix_global->process_to_run));
184       SIMIX_context_runall(simix_global->process_to_run);
185       while ((req = SIMIX_request_pop())) {
186         DEBUG1("Handling request %p", req);
187         SIMIX_request_pre(req);
188       }
189     } while (xbt_dynar_length(simix_global->process_to_run));
190
191     time = surf_solve(SIMIX_timer_next());
192
193     /* Notify all the hosts that have failed */
194     /* FIXME: iterate through the list of failed host and mark each of them */
195     /* as failed. On each host, signal all the running processes with host_fail */
196
197     /* Handle any pending timer */
198     while (xbt_heap_size(simix_timers) > 0 && SIMIX_get_clock() >= SIMIX_timer_next()) {
199        //FIXME: make the timers being real callbacks
200        // (i.e. provide dispatchers that read and expand the args) 
201        timer = xbt_heap_pop(simix_timers);
202        if (timer->func)
203          ((void (*)(void*))timer->func)(timer->args);
204     }
205     /* Wake up all process waiting for the action finish */
206     xbt_dynar_foreach(model_list, iter, model) {
207       for (set = model->states.failed_action_set;
208            set;
209            set = (set == model->states.failed_action_set)
210                  ? model->states.done_action_set
211                  : NULL) {
212         while ((action = xbt_swag_extract(set)))
213           SIMIX_request_post((smx_action_t) action->data);
214       }
215     }
216   } while (time != -1.0);
217
218   if (xbt_swag_size(simix_global->process_list) != 0) {
219
220     WARN0("Oops ! Deadlock or code not perfectly clean.");
221     SIMIX_display_process_status();
222     xbt_abort();
223   }
224 }
225
226 /**
227  *      \brief Set the date to execute a function
228  *
229  * Set the date to execute the function on the surf.
230  *      \param date Date to execute function
231  *      \param function Function to be executed
232  *      \param arg Parameters of the function
233  *
234  */
235 XBT_INLINE void SIMIX_timer_set(double date, void *function, void *arg)
236 {
237   smx_timer_t timer = xbt_new0(s_smx_timer_t, 1);
238
239   timer->date = date;
240   timer->func = function;
241   timer->args = arg;
242   xbt_heap_push(simix_timers, timer, date);
243 }
244
245 /**
246  *      \brief Registers a function to create a process.
247  *
248  *      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.
249  *      \param function Create process function
250  *
251  */
252 XBT_INLINE void SIMIX_function_register_process_create(smx_creation_func_t
253                                                        function)
254 {
255   xbt_assert0((simix_global->create_process_function == NULL),
256               "Data already set");
257
258   simix_global->create_process_function = function;
259 }
260
261 /**
262  *      \brief Registers a function to kill a process.
263  *
264  *      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.
265  *      \param function Kill process function
266  *
267  */
268 XBT_INLINE void SIMIX_function_register_process_kill(void_f_pvoid_t
269                                                      function)
270 {
271   xbt_assert0((simix_global->kill_process_function == NULL),
272               "Data already set");
273
274   simix_global->kill_process_function = function;
275 }
276
277 /**
278  *      \brief Registers a function to cleanup a process.
279  *
280  *      This function registers an user function to be called when a new process ends properly.
281  *      \param function cleanup process function
282  *
283  */
284 XBT_INLINE void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t
285                                                         function)
286 {
287   simix_global->cleanup_process_function = function;
288 }
289
290
291 void SIMIX_display_process_status(void)
292 {
293   if (simix_global->process_list == NULL) {
294     return;
295   }
296
297   smx_process_t process = NULL;
298   int nbprocess = xbt_swag_size(simix_global->process_list);
299
300   INFO1("%d processes are still running, waiting for something.", nbprocess);
301   /*  List the process and their state */
302   INFO0
303     ("Legend of the following listing: \"<process> on <host>: <status>.\"");
304   xbt_swag_foreach(process, simix_global->process_list) {
305
306     if (process->waiting_action) {
307
308       const char* action_description = "unknown";
309       switch (process->waiting_action->type) {
310
311         case SIMIX_ACTION_EXECUTE:
312           action_description = "execution";
313           break;
314
315         case SIMIX_ACTION_PARALLEL_EXECUTE:
316           action_description = "parallel execution";
317           break;
318
319         case SIMIX_ACTION_COMMUNICATE:
320           action_description = "communication";
321           break;
322
323         case SIMIX_ACTION_SLEEP:
324           action_description = "sleeping";
325           break;
326
327         case SIMIX_ACTION_SYNCHRO:
328           action_description = "synchronization";
329           break;
330
331         case SIMIX_ACTION_IO:
332           action_description = "I/O";
333           break;
334       }
335       INFO2("Waiting for %s action %p to finish", action_description, process->waiting_action);
336     }
337   }
338 }