Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
don't destroy synchro in a simcall, this drives the JVM nuts
[simgrid.git] / src / simix / smx_global.cpp
1 /* Copyright (c) 2007-2015. 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 <stdlib.h>
8 #include "src/portable.h"
9 #ifdef HAVE_SYS_PTRACE_H
10 # include <sys/types.h>
11 # include <sys/ptrace.h>
12 #endif
13
14 #include "src/surf/surf_interface.hpp"
15 #include "smx_private.h"
16 #include "smx_private.hpp"
17 #include "xbt/heap.h"
18 #include "xbt/sysdep.h"
19 #include "xbt/log.h"
20 #include "xbt/str.h"
21 #include "xbt/ex.h"             /* ex_backtrace_display */
22 #include "mc/mc.h"
23 #include "src/mc/mc_replay.h"
24 #include "simgrid/sg_config.h"
25
26 #include "src/surf/callbacks.h"
27
28 #ifdef HAVE_MC
29 #include "src/mc/mc_private.h"
30 #include "src/mc/mc_protocol.h"
31 #include "src/mc/mc_client.h"
32 #endif
33
34 #ifdef HAVE_MC
35 #include <stdlib.h>
36 #include "src/mc/mc_protocol.h"
37 #endif 
38
39 #include "src/mc/mc_record.h"
40 #include "src/surf/platform.hpp"
41
42 #ifdef HAVE_SMPI
43 #include "src/smpi/private.h"
44 #endif
45
46 XBT_LOG_NEW_CATEGORY(simix, "All SIMIX categories");
47 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_kernel, simix,
48                                 "Logging specific to SIMIX (kernel)");
49
50 smx_global_t simix_global = NULL;
51 static xbt_heap_t simix_timers = NULL;
52
53 /** @brief Timer datatype */
54 typedef struct s_smx_timer {
55   double date;
56   void(* func)(void*);
57   void* args;
58 } s_smx_timer_t;
59
60 void (*SMPI_switch_data_segment)(int) = NULL;
61
62 static void* SIMIX_synchro_mallocator_new_f(void);
63 static void SIMIX_synchro_mallocator_free_f(void* synchro);
64 static void SIMIX_synchro_mallocator_reset_f(void* synchro);
65
66 /* FIXME: Yeah, I'll do it in a portable maner one day [Mt] */
67 #include <signal.h>
68
69 int _sg_do_verbose_exit = 1;
70 static void _XBT_CALL inthandler(int ignored)
71 {
72   if ( _sg_do_verbose_exit ) {
73      XBT_INFO("CTRL-C pressed. The current status will be displayed before exit (disable that behavior with option 'verbose-exit').");
74      SIMIX_display_process_status();
75   }
76   else {
77      XBT_INFO("CTRL-C pressed, exiting. Hiding the current process status since 'verbose-exit' is set to false.");
78   }
79   exit(1);
80 }
81
82 #ifndef WIN32
83 static void _XBT_CALL segvhandler(int signum, siginfo_t *siginfo, void *context)
84 {
85   if (siginfo->si_signo == SIGSEGV && siginfo->si_code == SEGV_ACCERR) {
86     fprintf(stderr,
87             "Access violation detected.\n"
88             "This can result from a programming error in your code or, although less likely,\n"
89             "from a bug in SimGrid itself.  This can also be the sign of a bug in the OS or\n"
90             "in third-party libraries.  Failing hardware can sometimes generate such errors\n"
91             "too.\n"
92             "Finally, if nothing of the above applies, this can result from a stack overflow.\n"
93             "Try to increase stack size with --cfg=contexts/stack_size (current size is %d KiB).\n",
94             smx_context_stack_size / 1024);
95     if (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_debug)) {
96       fprintf(stderr,
97               "siginfo = {si_signo = %d, si_errno = %d, si_code = %d, si_addr = %p}\n",
98               siginfo->si_signo, siginfo->si_errno, siginfo->si_code, siginfo->si_addr);
99     }
100   } else  if (siginfo->si_signo == SIGSEGV) {
101     fprintf(stderr, "Segmentation fault.\n");
102 #ifdef HAVE_SMPI
103     if (smpi_enabled() && !smpi_privatize_global_variables) {
104 #ifdef HAVE_PRIVATIZATION
105       fprintf(stderr,
106         "Try to enable SMPI variable privatization with --cfg=smpi/privatize_global_variables:yes.\n");
107 #else
108       fprintf(stderr,
109         "Sadly, your system does not support --cfg=smpi/privatize_global_variables:yes (yet).\n");
110 #endif
111     }
112 #endif
113   }
114   raise(signum);
115 }
116
117 char sigsegv_stack[SIGSTKSZ];   /* alternate stack for SIGSEGV handler */
118
119 /**
120  * Install signal handler for SIGSEGV.  Check that nobody has already installed
121  * its own handler.  For example, the Java VM does this.
122  */
123 static void install_segvhandler(void)
124 {
125   stack_t stack, old_stack;
126   stack.ss_sp = sigsegv_stack;
127   stack.ss_size = sizeof sigsegv_stack;
128   stack.ss_flags = 0;
129
130   if (sigaltstack(&stack, &old_stack) == -1) {
131     XBT_WARN("Failed to register alternate signal stack: %s",
132              strerror(errno));
133     return;
134   }
135   if (!(old_stack.ss_flags & SS_DISABLE)) {
136     XBT_DEBUG("An alternate stack was already installed (sp=%p, size=%zd, flags=%x). Restore it.",
137               old_stack.ss_sp, old_stack.ss_size, old_stack.ss_flags);
138     sigaltstack(&old_stack, NULL);
139   }
140
141   struct sigaction action, old_action;
142   action.sa_sigaction = segvhandler;
143   action.sa_flags = SA_ONSTACK | SA_RESETHAND | SA_SIGINFO;
144   sigemptyset(&action.sa_mask);
145
146   if (sigaction(SIGSEGV, &action, &old_action) == -1) {
147     XBT_WARN("Failed to register signal handler for SIGSEGV: %s",
148              strerror(errno));
149     return;
150   }
151   if ((old_action.sa_flags & SA_SIGINFO) || old_action.sa_handler != SIG_DFL) {
152     XBT_DEBUG("A signal handler was already installed for SIGSEGV (%p). Restore it.",
153              (old_action.sa_flags & SA_SIGINFO) ?
154              (void*)old_action.sa_sigaction : (void*)old_action.sa_handler);
155     sigaction(SIGSEGV, &old_action, NULL);
156   }
157 }
158
159 #endif
160 /********************************* SIMIX **************************************/
161
162 double SIMIX_timer_next(void)
163 {
164   return xbt_heap_size(simix_timers) > 0 ? xbt_heap_maxkey(simix_timers) : -1.0;
165 }
166
167 static void kill_process(smx_process_t process)
168 {
169   SIMIX_process_kill(process, NULL);
170 }
171
172 static void SIMIX_storage_create_(smx_storage_t storage)
173 {
174   const char* key = xbt_dict_get_elm_key(storage);
175   SIMIX_storage_create(key, storage, NULL);
176 }
177
178 /**
179  * \ingroup SIMIX_API
180  * \brief Initialize SIMIX internal data.
181  *
182  * \param argc Argc
183  * \param argv Argv
184  */
185 void SIMIX_global_init(int *argc, char **argv)
186 {
187 #ifdef HAVE_MC
188   _sg_do_model_check = getenv(MC_ENV_VARIABLE) != NULL;
189 #endif
190
191   s_smx_process_t proc;
192
193   if (!simix_global) {
194     simix_global = xbt_new0(s_smx_global_t, 1);
195
196 #ifdef TIME_BENCH_AMDAHL
197     simix_global->timer_seq = xbt_os_timer_new();
198     simix_global->timer_par = xbt_os_timer_new();
199     xbt_os_cputimer_start(simix_global->timer_seq);
200 #endif
201     simix_global->process_to_run = xbt_dynar_new(sizeof(smx_process_t), NULL);
202     simix_global->process_that_ran = xbt_dynar_new(sizeof(smx_process_t), NULL);
203     simix_global->process_list =
204         xbt_swag_new(xbt_swag_offset(proc, process_hookup));
205     simix_global->process_to_destroy =
206         xbt_swag_new(xbt_swag_offset(proc, destroy_hookup));
207
208     simix_global->maestro_process = NULL;
209     simix_global->registered_functions = xbt_dict_new_homogeneous(NULL);
210
211     simix_global->create_process_function = SIMIX_process_create;
212     simix_global->kill_process_function = kill_process;
213     simix_global->cleanup_process_function = SIMIX_process_cleanup;
214     simix_global->synchro_mallocator = xbt_mallocator_new(65536,
215         SIMIX_synchro_mallocator_new_f, SIMIX_synchro_mallocator_free_f,
216         SIMIX_synchro_mallocator_reset_f);
217     simix_global->mutex = xbt_os_mutex_init();
218
219     surf_init(argc, argv);      /* Initialize SURF structures */
220     SIMIX_context_mod_init();
221     SIMIX_create_maestro_process();
222
223     /* context exception handlers */
224     __xbt_running_ctx_fetch = SIMIX_process_get_running_context;
225     __xbt_ex_terminate = SIMIX_process_exception_terminate;
226
227     SIMIX_network_init();
228
229     /* Prepare to display some more info when dying on Ctrl-C pressing */
230     signal(SIGINT, inthandler);
231
232 #ifndef WIN32
233     /* Install SEGV handler */
234     install_segvhandler();
235 #endif
236     /* register a function to be called by SURF after the environment creation */
237     sg_platf_init();
238     simgrid::surf::on_postparse.connect(SIMIX_post_create_environment);
239     simgrid::s4u::Host::onCreation.connect([](simgrid::s4u::Host& host) {
240       SIMIX_host_create(&host);
241     });
242     surf_on_storage_created(SIMIX_storage_create_);
243
244   }
245   if (!simix_timers) {
246     simix_timers = xbt_heap_new(8, &free);
247   }
248
249   SIMIX_STORAGE_LEVEL = xbt_lib_add_level(storage_lib, SIMIX_storage_destroy);
250
251   if (sg_cfg_get_boolean("clean_atexit"))
252     atexit(SIMIX_clean);
253
254 #ifdef HAVE_MC
255   // The communication initialization is done ASAP.
256   // We need to communicate  initialization of the different layers to the model-checker.
257   MC_client_init();
258 #endif
259
260   if (_sg_cfg_exit_asap)
261     exit(0);
262 }
263
264 int smx_cleaned = 0;
265 /**
266  * \ingroup SIMIX_API
267  * \brief Clean the SIMIX simulation
268  *
269  * This functions remove the memory used by SIMIX
270  */
271 void SIMIX_clean(void)
272 {
273 #ifdef TIME_BENCH_PER_SR
274   smx_ctx_raw_new_sr();
275 #endif
276   if (smx_cleaned) return; // to avoid double cleaning by java and C
277   smx_cleaned = 1;
278   XBT_DEBUG("SIMIX_clean called. Simulation's over.");
279   if (!xbt_dynar_is_empty(simix_global->process_to_run) && SIMIX_get_clock() == 0.0) {
280           XBT_CRITICAL("   ");
281           XBT_CRITICAL("The time is still 0, and you still have processes ready to run.");
282           XBT_CRITICAL("It seems that you forgot to run the simulation that you setup.");
283           xbt_die("Bailing out to avoid that stop-before-start madness. Please fix your code.");
284   }
285   /* Kill all processes (but maestro) */
286   SIMIX_process_killall(simix_global->maestro_process, 1);
287
288   /* Exit the SIMIX network module */
289   SIMIX_network_exit();
290
291   xbt_heap_free(simix_timers);
292   simix_timers = NULL;
293   /* Free the remaining data structures */
294   xbt_dynar_free(&simix_global->process_to_run);
295   xbt_dynar_free(&simix_global->process_that_ran);
296   xbt_swag_free(simix_global->process_to_destroy);
297   xbt_swag_free(simix_global->process_list);
298   simix_global->process_list = NULL;
299   simix_global->process_to_destroy = NULL;
300   xbt_dict_free(&(simix_global->registered_functions));
301
302   xbt_os_mutex_destroy(simix_global->mutex);
303   simix_global->mutex = NULL;
304
305   /* Let's free maestro now */
306   SIMIX_context_free(simix_global->maestro_process->context);
307   xbt_free(simix_global->maestro_process->running_ctx);
308   xbt_free(simix_global->maestro_process);
309   simix_global->maestro_process = NULL;
310
311   /* Restore the default exception setup */
312   __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
313   __xbt_ex_terminate = &__xbt_ex_terminate_default;
314
315   /* Finish context module and SURF */
316   SIMIX_context_mod_exit();
317
318   surf_exit();
319
320 #ifdef TIME_BENCH_AMDAHL
321   xbt_os_cputimer_stop(simix_global->timer_seq);
322   XBT_INFO("Amdahl timing informations. Sequential time: %f; Parallel time: %f",
323            xbt_os_timer_elapsed(simix_global->timer_seq),
324            xbt_os_timer_elapsed(simix_global->timer_par));
325   xbt_os_timer_free(simix_global->timer_seq);
326   xbt_os_timer_free(simix_global->timer_par);
327 #endif
328
329   xbt_mallocator_free(simix_global->synchro_mallocator);
330   xbt_free(simix_global);
331   simix_global = NULL;
332
333   return;
334 }
335
336
337 /**
338  * \ingroup SIMIX_API
339  * \brief A clock (in second).
340  *
341  * \return Return the clock.
342  */
343 double SIMIX_get_clock(void)
344 {
345   if(MC_is_active() || MC_record_replay_is_active()){
346     return MC_process_clock_get(SIMIX_process_self());
347   }else{
348     return surf_get_clock();
349   }
350 }
351
352 static int process_syscall_color(void *p)
353 {
354   switch ((*(smx_process_t *)p)->simcall.call) {
355   case SIMCALL_NONE:
356   case SIMCALL_PROCESS_KILL:
357     return 2;
358   case SIMCALL_PROCESS_RESUME:
359     return 1;
360   default:
361     return 0;
362   }
363 }
364
365 /**
366  * \ingroup SIMIX_API
367  * \brief Run the main simulation loop.
368  */
369 void SIMIX_run(void)
370 {
371   if(MC_record_path) {
372     MC_record_replay_init();
373     MC_record_replay_from_string(MC_record_path);
374     return;
375   }
376
377   double time = 0;
378   smx_process_t process;
379   surf_action_t action;
380   smx_timer_t timer;
381   surf_model_t model;
382   unsigned int iter;
383
384   do {
385     XBT_DEBUG("New Schedule Round; size(queue)=%lu",
386         xbt_dynar_length(simix_global->process_to_run));
387 #ifdef TIME_BENCH_PER_SR
388     smx_ctx_raw_new_sr();
389 #endif
390     while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
391       XBT_DEBUG("New Sub-Schedule Round; size(queue)=%lu",
392               xbt_dynar_length(simix_global->process_to_run));
393
394       /* Run all processes that are ready to run, possibly in parallel */
395 #ifdef TIME_BENCH_AMDAHL
396       xbt_os_cputimer_stop(simix_global->timer_seq);
397       xbt_os_cputimer_resume(simix_global->timer_par);
398 #endif
399       SIMIX_process_runall();
400 #ifdef TIME_BENCH_AMDAHL
401       xbt_os_cputimer_stop(simix_global->timer_par);
402       xbt_os_cputimer_resume(simix_global->timer_seq);
403 #endif
404
405       /* Move all killer processes to the end of the list, because killing a process that have an ongoing simcall is a bad idea */
406       xbt_dynar_three_way_partition(simix_global->process_that_ran, process_syscall_color);
407
408       /* answer sequentially and in a fixed arbitrary order all the simcalls that were issued during that sub-round */
409
410       /* WARNING, the order *must* be fixed or you'll jeopardize the simulation reproducibility (see RR-7653) */
411
412       /* Here, the order is ok because:
413        *
414        *   Short proof: only maestro adds stuff to the process_to_run array, so the execution order of user contexts do not impact its order.
415        *
416        *   Long proof: processes remain sorted through an arbitrary (implicit, complex but fixed) order in all cases.
417        *
418        *   - if there is no kill during the simulation, processes remain sorted according by their PID.
419        *     rational: This can be proved inductively.
420        *        Assume that process_to_run is sorted at a beginning of one round (it is at round 0: the deployment file is parsed linearly).
421        *        Let's show that it is still so at the end of this round.
422        *        - if a process is added when being created, that's from maestro. It can be either at startup
423        *          time (and then in PID order), or in response to a process_create simcall. Since simcalls are handled
424        *          in arbitrary order (inductive hypothesis), we are fine.
425        *        - If a process is added because it's getting killed, its subsequent actions shouldn't matter
426        *        - If a process gets added to process_to_run because one of their blocking action constituting the meat
427        *          of a simcall terminates, we're still good. Proof:
428        *          - You are added from SIMIX_simcall_answer() only. When this function is called depends on the resource
429        *            kind (network, cpu, disk, whatever), but the same arguments hold. Let's take communications as an example.
430        *          - For communications, this function is called from SIMIX_comm_finish().
431        *            This function itself don't mess with the order since simcalls are handled in FIFO order.
432        *            The function is called:
433        *            - before the comm starts (invalid parameters, or resource already dead or whatever).
434        *              The order then trivial holds since maestro didn't interrupt its handling of the simcall yet
435        *            - because the communication failed or were canceled after startup. In this case, it's called from the function
436        *              we are in, by the chunk:
437        *                       set = model->states.failed_action_set;
438        *                       while ((synchro = xbt_swag_extract(set)))
439        *                          SIMIX_simcall_post((smx_synchro_t) synchro->data);
440        *              This order is also fixed because it depends of the order in which the surf actions were
441        *              added to the system, and only maestro can add stuff this way, through simcalls.
442        *              We thus use the inductive hypothesis once again to conclude that the order in which synchros are
443        *              poped out of the swag does not depend on the user code's execution order.
444        *            - because the communication terminated. In this case, synchros are served in the order given by
445        *                       set = model->states.done_action_set;
446        *                       while ((synchro = xbt_swag_extract(set)))
447        *                          SIMIX_simcall_post((smx_synchro_t) synchro->data);
448        *              and the argument is very similar to the previous one.
449        *            So, in any case, the orders of calls to SIMIX_comm_finish() do not depend on the order in which user processes are executed.
450        *          So, in any cases, the orders of processes within process_to_run do not depend on the order in which user processes were executed previously.
451        *     So, if there is no killing in the simulation, the simulation reproducibility is not jeopardized.
452        *   - If there is some process killings, the order is changed by this decision that comes from user-land
453        *     But this decision may not have been motivated by a situation that were different because the simulation is not reproducible.
454        *     So, even the order change induced by the process killing is perfectly reproducible.
455        *
456        *   So science works, bitches [http://xkcd.com/54/].
457        *
458        *   We could sort the process_that_ran array completely so that we can describe the order in which simcalls are handled
459        *   (like "according to the PID of issuer"), but it's not mandatory (order is fixed already even if unfriendly).
460        *   That would thus be a pure waste of time.
461        */
462
463       xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
464         if (process->simcall.call != SIMCALL_NONE) {
465           SIMIX_simcall_handle(&process->simcall, 0);
466         }
467       }
468       /* Wake up all processes waiting for a Surf action to finish */
469       xbt_dynar_foreach(all_existing_models, iter, model) {
470         XBT_DEBUG("Handling process whose action failed");
471         while ((action = surf_model_extract_failed_action_set(model))) {
472           XBT_DEBUG("   Handling Action %p",action);
473           SIMIX_simcall_exit((smx_synchro_t) action->getData());
474         }
475         XBT_DEBUG("Handling process whose action terminated normally");
476         while ((action = surf_model_extract_done_action_set(model))) {
477           XBT_DEBUG("   Handling Action %p",action);
478           if (action->getData() == NULL)
479             XBT_DEBUG("probably vcpu's action %p, skip", action);
480           else
481             SIMIX_simcall_exit((smx_synchro_t) action->getData());
482         }
483       }
484     }
485
486     time = SIMIX_timer_next();
487     if (time != -1.0 || xbt_swag_size(simix_global->process_list) != 0) {
488       XBT_DEBUG("Calling surf_solve");
489       time = surf_solve(time);
490       XBT_DEBUG("Moving time ahead : %g", time);
491     }
492     /* Notify all the hosts that have failed */
493     /* FIXME: iterate through the list of failed host and mark each of them */
494     /* as failed. On each host, signal all the running processes with host_fail */
495
496     /* Handle any pending timer */
497     while (xbt_heap_size(simix_timers) > 0 && SIMIX_get_clock() >= SIMIX_timer_next()) {
498        //FIXME: make the timers being real callbacks
499        // (i.e. provide dispatchers that read and expand the args)
500        timer = (smx_timer_t) xbt_heap_pop(simix_timers);
501        if (timer->func)
502          timer->func(timer->args);
503        xbt_free(timer);
504     }
505
506     /* Wake up all processes waiting for a Surf action to finish */
507     xbt_dynar_foreach(all_existing_models, iter, model) {
508       XBT_DEBUG("Handling process whose action failed");
509       while ((action = surf_model_extract_failed_action_set(model))) {
510         XBT_DEBUG("   Handling Action %p",action);
511         SIMIX_simcall_exit((smx_synchro_t) action->getData());
512       }
513       XBT_DEBUG("Handling process whose action terminated normally");
514       while ((action = surf_model_extract_done_action_set(model))) {
515         XBT_DEBUG("   Handling Action %p",action);
516         if (action->getData() == NULL)
517           XBT_DEBUG("probably vcpu's action %p, skip", action);
518         else
519           SIMIX_simcall_exit((smx_synchro_t) action->getData());
520       }
521     }
522
523     /* Autorestart all process */
524     if(host_that_restart) {
525       char *hostname = NULL;
526       xbt_dynar_foreach(host_that_restart,iter,hostname) {
527         XBT_INFO("Restart processes on host: %s",hostname);
528         SIMIX_host_autorestart(sg_host_by_name(hostname));
529       }
530       xbt_dynar_reset(host_that_restart);
531     }
532
533     /* Clean processes to destroy */
534     SIMIX_process_empty_trash();
535
536
537     XBT_DEBUG("### time %f, empty %d", time, xbt_dynar_is_empty(simix_global->process_to_run));
538
539   } while (time != -1.0 || !xbt_dynar_is_empty(simix_global->process_to_run));
540
541   if (xbt_swag_size(simix_global->process_list) != 0) {
542
543         TRACE_end();
544
545     XBT_CRITICAL("Oops ! Deadlock or code not perfectly clean.");
546     SIMIX_display_process_status();
547     xbt_abort();
548   }
549 }
550
551 /**
552  *   \brief Set the date to execute a function
553  *
554  * Set the date to execute the function on the surf.
555  *   \param date Date to execute function
556  *   \param function Function to be executed
557  *   \param arg Parameters of the function
558  *
559  */
560 smx_timer_t SIMIX_timer_set(double date, void (*function)(void*), void *arg)
561 {
562   smx_timer_t timer = xbt_new0(s_smx_timer_t, 1);
563
564   timer->date = date;
565   timer->func = function;
566   timer->args = arg;
567   xbt_heap_push(simix_timers, timer, date);
568   return timer;
569 }
570 /** @brief cancels a timer that was added earlier */
571 void SIMIX_timer_remove(smx_timer_t timer) {
572         xbt_heap_rm_elm(simix_timers, timer, timer->date);
573 }
574
575 /** @brief Returns the date at which the timer will trigger (or 0 if NULL timer) */
576 double SIMIX_timer_get_date(smx_timer_t timer) {
577         return timer?timer->date:0;
578 }
579
580 /**
581  * \brief Registers a function to create a process.
582  *
583  * This function registers a function to be called
584  * when a new process is created. The function has
585  * to call SIMIX_process_create().
586  * \param function create process function
587  */
588 void SIMIX_function_register_process_create(smx_creation_func_t
589                                                        function)
590 {
591   simix_global->create_process_function = function;
592 }
593
594 /**
595  * \brief Registers a function to kill a process.
596  *
597  * This function registers a function to be called when a
598  * process is killed. The function has to call the SIMIX_process_kill().
599  *
600  * \param function Kill process function
601  */
602 void SIMIX_function_register_process_kill(void_pfn_smxprocess_t
603                                                      function)
604 {
605   simix_global->kill_process_function = function;
606 }
607
608 /**
609  * \brief Registers a function to cleanup a process.
610  *
611  * This function registers a user function to be called when
612  * a process ends properly.
613  *
614  * \param function cleanup process function
615  */
616 void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t
617                                                         function)
618 {
619   simix_global->cleanup_process_function = function;
620 }
621
622
623 void SIMIX_display_process_status(void)
624 {
625   if (simix_global->process_list == NULL) {
626     return;
627   }
628
629   smx_process_t process = NULL;
630   int nbprocess = xbt_swag_size(simix_global->process_list);
631
632   XBT_INFO("%d processes are still running, waiting for something.", nbprocess);
633   /*  List the process and their state */
634   XBT_INFO
635     ("Legend of the following listing: \"Process <pid> (<name>@<host>): <status>\"");
636   xbt_swag_foreach(process, simix_global->process_list) {
637
638     if (process->waiting_synchro) {
639
640       const char* synchro_description = "unknown";
641       switch (process->waiting_synchro->type) {
642
643       case SIMIX_SYNC_EXECUTE:
644         synchro_description = "execution";
645         break;
646
647       case SIMIX_SYNC_PARALLEL_EXECUTE:
648         synchro_description = "parallel execution";
649         break;
650
651       case SIMIX_SYNC_COMMUNICATE:
652         synchro_description = "communication";
653         break;
654
655       case SIMIX_SYNC_SLEEP:
656         synchro_description = "sleeping";
657         break;
658
659       case SIMIX_SYNC_JOIN:
660         synchro_description = "joining";
661         break;
662
663       case SIMIX_SYNC_SYNCHRO:
664         synchro_description = "synchronization";
665         break;
666
667       case SIMIX_SYNC_IO:
668         synchro_description = "I/O";
669         break;
670       }
671       XBT_INFO("Process %lu (%s@%s): waiting for %s synchro %p (%s) in state %d to finish",
672           process->pid, process->name, sg_host_get_name(process->host),
673           synchro_description, process->waiting_synchro,
674           process->waiting_synchro->name, (int)process->waiting_synchro->state);
675     }
676     else {
677       XBT_INFO("Process %lu (%s@%s)", process->pid, process->name, sg_host_get_name(process->host));
678     }
679   }
680 }
681
682 static void* SIMIX_synchro_mallocator_new_f(void) {
683   smx_synchro_t synchro = xbt_new(s_smx_synchro_t, 1);
684   synchro->simcalls = xbt_fifo_new();
685   return synchro;
686 }
687
688 static void SIMIX_synchro_mallocator_free_f(void* synchro) {
689   xbt_fifo_free(((smx_synchro_t) synchro)->simcalls);
690   xbt_free(synchro);
691 }
692
693 static void SIMIX_synchro_mallocator_reset_f(void* synchro) {
694
695   // we also recycle the simcall list
696   xbt_fifo_t fifo = ((smx_synchro_t) synchro)->simcalls;
697   xbt_fifo_reset(fifo);
698   memset(synchro, 0, sizeof(s_smx_synchro_t));
699   ((smx_synchro_t) synchro)->simcalls = fifo;
700 }
701
702 xbt_dict_t simcall_HANDLER_asr_get_properties(smx_simcall_t simcall, const char *name){
703   return SIMIX_asr_get_properties(name);
704 }
705 xbt_dict_t SIMIX_asr_get_properties(const char *name)
706 {
707   return (xbt_dict_t) xbt_lib_get_or_null(as_router_lib, name, ROUTING_PROP_ASR_LEVEL);
708 }
709
710 int SIMIX_is_maestro()
711 {
712   return simix_global==NULL /*SimDag*/|| SIMIX_process_self() == simix_global->maestro_process;
713 }