Logo AND Algorithmique Numérique Distribuée

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