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