Logo AND Algorithmique Numérique Distribuée

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