Logo AND Algorithmique Numérique Distribuée

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