Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Simplify the handling of SIMIX requests.
[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 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();
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   /* Free the remaining data structures */
139   xbt_dynar_free(&simix_global->process_to_run);
140   xbt_dynar_free(&simix_global->process_that_ran);
141   xbt_swag_free(simix_global->process_to_destroy);
142   xbt_swag_free(simix_global->process_list);
143   simix_global->process_list = NULL;
144   simix_global->process_to_destroy = NULL;
145   xbt_dict_free(&(simix_global->registered_functions));
146
147   /* Let's free maestro now */
148   SIMIX_context_free(simix_global->maestro_process->context);
149   xbt_free(simix_global->maestro_process->running_ctx);
150   xbt_free(simix_global->maestro_process);
151   simix_global->maestro_process = NULL;
152
153   /* Restore the default exception setup */
154   __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
155   __xbt_ex_terminate = &__xbt_ex_terminate_default;
156
157   /* Finish context module and SURF */
158   SIMIX_context_mod_exit();
159
160   surf_exit();
161
162   xbt_mallocator_free(simix_global->action_mallocator);
163   xbt_free(simix_global);
164   simix_global = NULL;
165
166   return;
167 }
168
169
170 /**
171  * \brief A clock (in second).
172  *
173  * \return Return the clock.
174  */
175 XBT_INLINE double SIMIX_get_clock(void)
176 {
177   if(MC_IS_ENABLED){
178     return MC_process_clock_get(SIMIX_process_self());
179   }else{
180     return surf_get_clock();
181   }
182 }
183
184 void SIMIX_run(void)
185 {
186   double time = 0;
187   smx_process_t process;
188   xbt_swag_t set;
189   surf_action_t action;
190   smx_timer_t timer;
191   surf_model_t model;
192   unsigned int iter;
193
194   do {
195     XBT_DEBUG("New Schedule Round; size(queue)=%lu",
196         xbt_dynar_length(simix_global->process_to_run));
197 #ifdef TIME_BENCH
198     smx_ctx_raw_new_sr();
199 #endif
200     while (xbt_dynar_length(simix_global->process_to_run)) {
201       XBT_DEBUG("New Sub-Schedule Round; size(queue)=%lu",
202               xbt_dynar_length(simix_global->process_to_run));
203       SIMIX_context_runall(simix_global->process_to_run);
204       xbt_dynar_t tmp = simix_global->process_that_ran;
205       simix_global->process_that_ran = simix_global->process_to_run;
206       simix_global->process_to_run = tmp;
207       xbt_dynar_reset(simix_global->process_to_run);
208       xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
209         if (process->request.call != REQ_NO_REQ) {
210           XBT_DEBUG("Handling request %p", &process->request);
211           SIMIX_request_pre(&process->request, 0);
212         }
213       }
214     }
215
216     time = surf_solve(SIMIX_timer_next());
217
218     /* Notify all the hosts that have failed */
219     /* FIXME: iterate through the list of failed host and mark each of them */
220     /* as failed. On each host, signal all the running processes with host_fail */
221
222     /* Handle any pending timer */
223     while (xbt_heap_size(simix_timers) > 0 && SIMIX_get_clock() >= SIMIX_timer_next()) {
224        //FIXME: make the timers being real callbacks
225        // (i.e. provide dispatchers that read and expand the args) 
226        timer = xbt_heap_pop(simix_timers);
227        if (timer->func)
228          ((void (*)(void*))timer->func)(timer->args);
229     }
230     /* Wake up all process waiting for the action finish */
231     xbt_dynar_foreach(model_list, iter, model) {
232       for (set = model->states.failed_action_set;
233            set;
234            set = (set == model->states.failed_action_set)
235                  ? model->states.done_action_set
236                  : NULL) {
237         while ((action = xbt_swag_extract(set)))
238           SIMIX_request_post((smx_action_t) action->data);
239       }
240     }
241   } while (time != -1.0);
242
243   if (xbt_swag_size(simix_global->process_list) != 0) {
244
245 #ifdef HAVE_TRACING
246     TRACE_end();
247 #endif
248
249     XBT_WARN("Oops ! Deadlock or code not perfectly clean.");
250     SIMIX_display_process_status();
251     xbt_abort();
252   }
253 }
254
255 /**
256  *      \brief Set the date to execute a function
257  *
258  * Set the date to execute the function on the surf.
259  *      \param date Date to execute function
260  *      \param function Function to be executed
261  *      \param arg Parameters of the function
262  *
263  */
264 XBT_INLINE void SIMIX_timer_set(double date, void *function, void *arg)
265 {
266   smx_timer_t timer = xbt_new0(s_smx_timer_t, 1);
267
268   timer->date = date;
269   timer->func = function;
270   timer->args = arg;
271   xbt_heap_push(simix_timers, timer, date);
272 }
273
274 /**
275  * \brief Registers a function to create a process.
276  *
277  * This function registers a function to be called
278  * when a new process is created. The function has
279  * to call SIMIX_process_create().
280  * \param function create process function
281  */
282 XBT_INLINE void SIMIX_function_register_process_create(smx_creation_func_t
283                                                        function)
284 {
285   simix_global->create_process_function = function;
286 }
287
288 /**
289  * \brief Registers a function to kill a process.
290  *
291  * This function registers a function to be called when a
292  * process is killed. The function has to call the SIMIX_process_kill().
293  *
294  * \param function Kill process function
295  */
296 XBT_INLINE void SIMIX_function_register_process_kill(void_pfn_smxprocess_t
297                                                      function)
298 {
299   simix_global->kill_process_function = function;
300 }
301
302 /**
303  * \brief Registers a function to cleanup a process.
304  *
305  * This function registers a user function to be called when
306  * a process ends properly.
307  *
308  * \param function cleanup process function
309  */
310 XBT_INLINE void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t
311                                                         function)
312 {
313   simix_global->cleanup_process_function = function;
314 }
315
316
317 void SIMIX_display_process_status(void)
318 {
319   if (simix_global->process_list == NULL) {
320     return;
321   }
322
323   smx_process_t process = NULL;
324   int nbprocess = xbt_swag_size(simix_global->process_list);
325
326   XBT_INFO("%d processes are still running, waiting for something.", nbprocess);
327   /*  List the process and their state */
328   XBT_INFO
329     ("Legend of the following listing: \"<process> on <host>: <status>.\"");
330   xbt_swag_foreach(process, simix_global->process_list) {
331
332     if (process->waiting_action) {
333
334       const char* action_description = "unknown";
335       switch (process->waiting_action->type) {
336
337         case SIMIX_ACTION_EXECUTE:
338           action_description = "execution";
339           break;
340
341         case SIMIX_ACTION_PARALLEL_EXECUTE:
342           action_description = "parallel execution";
343           break;
344
345         case SIMIX_ACTION_COMMUNICATE:
346           action_description = "communication";
347           break;
348
349         case SIMIX_ACTION_SLEEP:
350           action_description = "sleeping";
351           break;
352
353         case SIMIX_ACTION_SYNCHRO:
354           action_description = "synchronization";
355           break;
356
357         case SIMIX_ACTION_IO:
358           action_description = "I/O";
359           break;
360       }
361       XBT_INFO("Waiting for %s action %p to finish", action_description, process->waiting_action);
362     }
363   }
364 }
365
366 static void* SIMIX_action_mallocator_new_f(void) {
367   smx_action_t action = xbt_new(s_smx_action_t, 1);
368   action->request_list = xbt_fifo_new();
369   return action;
370 }
371
372 static void SIMIX_action_mallocator_free_f(void* action) {
373   xbt_fifo_free(((smx_action_t) action)->request_list);
374   xbt_free(action);
375 }
376
377 static void SIMIX_action_mallocator_reset_f(void* action) {
378
379   // we also recycle the request list
380   xbt_fifo_t fifo = ((smx_action_t) action)->request_list;
381   xbt_fifo_reset(fifo);
382   memset(action, 0, sizeof(s_smx_action_t));
383   ((smx_action_t) action)->request_list = fifo;
384 }