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 static std::function<void()> maestro_code;
 179
 180 namespace simgrid {
 181 namespace simix {
 182
 183 XBT_PUBLIC(void) set_maestro(std::function<void()> code)
 184 {
 185   maestro_code = std::move(code);
 186 }
 187
 188 }
 189 }
 190
 191 void SIMIX_set_maestro(void (*code)(void*), void* data)
 192 {
 193   maestro_code = std::bind(code, data);
 194 }
 195
 196 /**
 197  * \ingroup SIMIX_API
 198  * \brief Initialize SIMIX internal data.
 199  *
 200  * \param argc Argc
 201  * \param argv Argv
 202  */
 203 void SIMIX_global_init(int *argc, char **argv)
 204 {
 205 #ifdef HAVE_MC
 206   _sg_do_model_check = getenv(MC_ENV_VARIABLE) != NULL;
 207 #endif
 208
 209   s_smx_process_t proc;
 210
 211   if (!simix_global) {
 212     simix_global = xbt_new0(s_smx_global_t, 1);
 213
 214 #ifdef TIME_BENCH_AMDAHL
 215     simix_global->timer_seq = xbt_os_timer_new();
 216     simix_global->timer_par = xbt_os_timer_new();
 217     xbt_os_cputimer_start(simix_global->timer_seq);
 218 #endif
 219     simix_global->process_to_run = xbt_dynar_new(sizeof(smx_process_t), NULL);
 220     simix_global->process_that_ran = xbt_dynar_new(sizeof(smx_process_t), NULL);
 221     simix_global->process_list =
 222         xbt_swag_new(xbt_swag_offset(proc, process_hookup));
 223     simix_global->process_to_destroy =
 224         xbt_swag_new(xbt_swag_offset(proc, destroy_hookup));
 225
 226     simix_global->maestro_process = NULL;
 227     simix_global->registered_functions = xbt_dict_new_homogeneous(NULL);
 228
 229     simix_global->create_process_function = SIMIX_process_create;
 230     simix_global->kill_process_function = kill_process;
 231     simix_global->cleanup_process_function = SIMIX_process_cleanup;
 232     simix_global->synchro_mallocator = xbt_mallocator_new(65536,
 233         SIMIX_synchro_mallocator_new_f, SIMIX_synchro_mallocator_free_f,
 234         SIMIX_synchro_mallocator_reset_f);
 235     simix_global->mutex = xbt_os_mutex_init();
 236
 237     surf_init(argc, argv);      /* Initialize SURF structures */
 238     SIMIX_context_mod_init();
 239
 240     // Either create a new context with maestro or create
 241     // a context object with the current context mestro):
 242     simgrid::simix::create_maestro(maestro_code);
 243
 244     /* context exception handlers */
 245     __xbt_running_ctx_fetch = SIMIX_process_get_running_context;
 246     __xbt_ex_terminate = SIMIX_process_exception_terminate;
 247
 248     SIMIX_network_init();
 249
 250     /* Prepare to display some more info when dying on Ctrl-C pressing */
 251     signal(SIGINT, inthandler);
 252
 253 #ifndef WIN32
 254     /* Install SEGV handler */
 255     install_segvhandler();
 256 #endif
 257     /* register a function to be called by SURF after the environment creation */
 258     sg_platf_init();
 259     simgrid::surf::on_postparse.connect(SIMIX_post_create_environment);
 260     simgrid::s4u::Host::onCreation.connect([](simgrid::s4u::Host& host) {
 261       SIMIX_host_create(&host);
 262     });
 263     surf_on_storage_created(SIMIX_storage_create_);
 264
 265   }
 266   if (!simix_timers) {
 267     simix_timers = xbt_heap_new(8, &free);
 268   }
 269
 270   SIMIX_STORAGE_LEVEL = xbt_lib_add_level(storage_lib, SIMIX_storage_destroy);
 271
 272   if (sg_cfg_get_boolean("clean_atexit"))
 273     atexit(SIMIX_clean);
 274
 275 #ifdef HAVE_MC
 276   // The communication initialization is done ASAP.
 277   // We need to communicate  initialization of the different layers to the model-checker.
 278   MC_client_init();
 279 #endif
 280
 281   if (_sg_cfg_exit_asap)
 282     exit(0);
 283 }
 284
 285 int smx_cleaned = 0;
 286 /**
 287  * \ingroup SIMIX_API
 288  * \brief Clean the SIMIX simulation
 289  *
 290  * This functions remove the memory used by SIMIX
 291  */
 292 void SIMIX_clean(void)
 293 {
 294 #ifdef TIME_BENCH_PER_SR
 295   smx_ctx_raw_new_sr();
 296 #endif
 297   if (smx_cleaned) return; // to avoid double cleaning by java and C
 298   smx_cleaned = 1;
 299   XBT_DEBUG("SIMIX_clean called. Simulation's over.");
 300   if (!xbt_dynar_is_empty(simix_global->process_to_run) && SIMIX_get_clock() == 0.0) {
 301     XBT_CRITICAL("   ");
 302     XBT_CRITICAL("The time is still 0, and you still have processes ready to run.");
 303     XBT_CRITICAL("It seems that you forgot to run the simulation that you setup.");
 304     xbt_die("Bailing out to avoid that stop-before-start madness. Please fix your code.");
 305   }
 306   /* Kill all processes (but maestro) */
 307   SIMIX_process_killall(simix_global->maestro_process, 1);
 308
 309   /* Exit the SIMIX network module */
 310   SIMIX_network_exit();
 311
 312   xbt_heap_free(simix_timers);
 313   simix_timers = NULL;
 314   /* Free the remaining data structures */
 315   xbt_dynar_free(&simix_global->process_to_run);
 316   xbt_dynar_free(&simix_global->process_that_ran);
 317   xbt_swag_free(simix_global->process_to_destroy);
 318   xbt_swag_free(simix_global->process_list);
 319   simix_global->process_list = NULL;
 320   simix_global->process_to_destroy = NULL;
 321   xbt_dict_free(&(simix_global->registered_functions));
 322
 323   xbt_os_mutex_destroy(simix_global->mutex);
 324   simix_global->mutex = NULL;
 325
 326   /* Let's free maestro now */
 327   SIMIX_context_free(simix_global->maestro_process->context);
 328   xbt_free(simix_global->maestro_process->running_ctx);
 329   xbt_free(simix_global->maestro_process);
 330   simix_global->maestro_process = NULL;
 331
 332   /* Restore the default exception setup */
 333   __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
 334   __xbt_ex_terminate = &__xbt_ex_terminate_default;
 335
 336   /* Finish context module and SURF */
 337   SIMIX_context_mod_exit();
 338
 339   surf_exit();
 340
 341 #ifdef TIME_BENCH_AMDAHL
 342   xbt_os_cputimer_stop(simix_global->timer_seq);
 343   XBT_INFO("Amdahl timing informations. Sequential time: %f; Parallel time: %f",
 344            xbt_os_timer_elapsed(simix_global->timer_seq),
 345            xbt_os_timer_elapsed(simix_global->timer_par));
 346   xbt_os_timer_free(simix_global->timer_seq);
 347   xbt_os_timer_free(simix_global->timer_par);
 348 #endif
 349
 350   xbt_mallocator_free(simix_global->synchro_mallocator);
 351   xbt_free(simix_global);
 352   simix_global = NULL;
 353
 354   return;
 355 }
 356
 357
 358 /**
 359  * \ingroup SIMIX_API
 360  * \brief A clock (in second).
 361  *
 362  * \return Return the clock.
 363  */
 364 double SIMIX_get_clock(void)
 365 {
 366   if(MC_is_active() || MC_record_replay_is_active()){
 367     return MC_process_clock_get(SIMIX_process_self());
 368   }else{
 369     return surf_get_clock();
 370   }
 371 }
 372
 373 static int process_syscall_color(void *p)
 374 {
 375   switch ((*(smx_process_t *)p)->simcall.call) {
 376   case SIMCALL_NONE:
 377   case SIMCALL_PROCESS_KILL:
 378     return 2;
 379   case SIMCALL_PROCESS_RESUME:
 380     return 1;
 381   default:
 382     return 0;
 383   }
 384 }
 385
 386 /**
 387  * \ingroup SIMIX_API
 388  * \brief Run the main simulation loop.
 389  */
 390 void SIMIX_run(void)
 391 {
 392   if(MC_record_path) {
 393     MC_record_replay_init();
 394     MC_record_replay_from_string(MC_record_path);
 395     return;
 396   }
 397
 398   double time = 0;
 399   smx_process_t process;
 400   surf_action_t action;
 401   smx_timer_t timer;
 402   surf_model_t model;
 403   unsigned int iter;
 404
 405   do {
 406     XBT_DEBUG("New Schedule Round; size(queue)=%lu",
 407         xbt_dynar_length(simix_global->process_to_run));
 408 #ifdef TIME_BENCH_PER_SR
 409     smx_ctx_raw_new_sr();
 410 #endif
 411     while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
 412       XBT_DEBUG("New Sub-Schedule Round; size(queue)=%lu",
 413               xbt_dynar_length(simix_global->process_to_run));
 414
 415       /* Run all processes that are ready to run, possibly in parallel */
 416 #ifdef TIME_BENCH_AMDAHL
 417       xbt_os_cputimer_stop(simix_global->timer_seq);
 418       xbt_os_cputimer_resume(simix_global->timer_par);
 419 #endif
 420       SIMIX_process_runall();
 421 #ifdef TIME_BENCH_AMDAHL
 422       xbt_os_cputimer_stop(simix_global->timer_par);
 423       xbt_os_cputimer_resume(simix_global->timer_seq);
 424 #endif
 425
 426       /* Move all killer processes to the end of the list, because killing a process that have an ongoing simcall is a bad idea */
 427       xbt_dynar_three_way_partition(simix_global->process_that_ran, process_syscall_color);
 428
 429       /* answer sequentially and in a fixed arbitrary order all the simcalls that were issued during that sub-round */
 430
 431       /* WARNING, the order *must* be fixed or you'll jeopardize the simulation reproducibility (see RR-7653) */
 432
 433       /* Here, the order is ok because:
 434        *
 435        *   Short proof: only maestro adds stuff to the process_to_run array, so the execution order of user contexts do not impact its order.
 436        *
 437        *   Long proof: processes remain sorted through an arbitrary (implicit, complex but fixed) order in all cases.
 438        *
 439        *   - if there is no kill during the simulation, processes remain sorted according by their PID.
 440        *     rational: This can be proved inductively.
 441        *        Assume that process_to_run is sorted at a beginning of one round (it is at round 0: the deployment file is parsed linearly).
 442        *        Let's show that it is still so at the end of this round.
 443        *        - if a process is added when being created, that's from maestro. It can be either at startup
 444        *          time (and then in PID order), or in response to a process_create simcall. Since simcalls are handled
 445        *          in arbitrary order (inductive hypothesis), we are fine.
 446        *        - If a process is added because it's getting killed, its subsequent actions shouldn't matter
 447        *        - If a process gets added to process_to_run because one of their blocking action constituting the meat
 448        *          of a simcall terminates, we're still good. Proof:
 449        *          - You are added from SIMIX_simcall_answer() only. When this function is called depends on the resource
 450        *            kind (network, cpu, disk, whatever), but the same arguments hold. Let's take communications as an example.
 451        *          - For communications, this function is called from SIMIX_comm_finish().
 452        *            This function itself don't mess with the order since simcalls are handled in FIFO order.
 453        *            The function is called:
 454        *            - before the comm starts (invalid parameters, or resource already dead or whatever).
 455        *              The order then trivial holds since maestro didn't interrupt its handling of the simcall yet
 456        *            - because the communication failed or were canceled after startup. In this case, it's called from the function
 457        *              we are in, by the chunk:
 458        *                       set = model->states.failed_action_set;
 459        *                       while ((synchro = xbt_swag_extract(set)))
 460        *                          SIMIX_simcall_post((smx_synchro_t) synchro->data);
 461        *              This order is also fixed because it depends of the order in which the surf actions were
 462        *              added to the system, and only maestro can add stuff this way, through simcalls.
 463        *              We thus use the inductive hypothesis once again to conclude that the order in which synchros are
 464        *              poped out of the swag does not depend on the user code's execution order.
 465        *            - because the communication terminated. In this case, synchros are served in the order given by
 466        *                       set = model->states.done_action_set;
 467        *                       while ((synchro = xbt_swag_extract(set)))
 468        *                          SIMIX_simcall_post((smx_synchro_t) synchro->data);
 469        *              and the argument is very similar to the previous one.
 470        *            So, in any case, the orders of calls to SIMIX_comm_finish() do not depend on the order in which user processes are executed.
 471        *          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.
 472        *     So, if there is no killing in the simulation, the simulation reproducibility is not jeopardized.
 473        *   - If there is some process killings, the order is changed by this decision that comes from user-land
 474        *     But this decision may not have been motivated by a situation that were different because the simulation is not reproducible.
 475        *     So, even the order change induced by the process killing is perfectly reproducible.
 476        *
 477        *   So science works, bitches [http://xkcd.com/54/].
 478        *
 479        *   We could sort the process_that_ran array completely so that we can describe the order in which simcalls are handled
 480        *   (like "according to the PID of issuer"), but it's not mandatory (order is fixed already even if unfriendly).
 481        *   That would thus be a pure waste of time.
 482        */
 483
 484       xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
 485         if (process->simcall.call != SIMCALL_NONE) {
 486           SIMIX_simcall_handle(&process->simcall, 0);
 487         }
 488       }
 489       /* Wake up all processes waiting for a Surf action to finish */
 490       xbt_dynar_foreach(all_existing_models, iter, model) {
 491         XBT_DEBUG("Handling process whose action failed");
 492         while ((action = surf_model_extract_failed_action_set(model))) {
 493           XBT_DEBUG("   Handling Action %p",action);
 494           SIMIX_simcall_exit((smx_synchro_t) action->getData());
 495         }
 496         XBT_DEBUG("Handling process whose action terminated normally");
 497         while ((action = surf_model_extract_done_action_set(model))) {
 498           XBT_DEBUG("   Handling Action %p",action);
 499           if (action->getData() == NULL)
 500             XBT_DEBUG("probably vcpu's action %p, skip", action);
 501           else
 502             SIMIX_simcall_exit((smx_synchro_t) action->getData());
 503         }
 504       }
 505     }
 506
 507     time = SIMIX_timer_next();
 508     if (time != -1.0 || xbt_swag_size(simix_global->process_list) != 0) {
 509       XBT_DEBUG("Calling surf_solve");
 510       time = surf_solve(time);
 511       XBT_DEBUG("Moving time ahead : %g", time);
 512     }
 513     /* Notify all the hosts that have failed */
 514     /* FIXME: iterate through the list of failed host and mark each of them */
 515     /* as failed. On each host, signal all the running processes with host_fail */
 516
 517     /* Handle any pending timer */
 518     while (xbt_heap_size(simix_timers) > 0 && SIMIX_get_clock() >= SIMIX_timer_next()) {
 519        //FIXME: make the timers being real callbacks
 520        // (i.e. provide dispatchers that read and expand the args)
 521        timer = (smx_timer_t) xbt_heap_pop(simix_timers);
 522        if (timer->func)
 523          timer->func(timer->args);
 524        xbt_free(timer);
 525     }
 526
 527     /* Wake up all processes waiting for a Surf action to finish */
 528     xbt_dynar_foreach(all_existing_models, iter, model) {
 529       XBT_DEBUG("Handling process whose action failed");
 530       while ((action = surf_model_extract_failed_action_set(model))) {
 531         XBT_DEBUG("   Handling Action %p",action);
 532         SIMIX_simcall_exit((smx_synchro_t) action->getData());
 533       }
 534       XBT_DEBUG("Handling process whose action terminated normally");
 535       while ((action = surf_model_extract_done_action_set(model))) {
 536         XBT_DEBUG("   Handling Action %p",action);
 537         if (action->getData() == NULL)
 538           XBT_DEBUG("probably vcpu's action %p, skip", action);
 539         else
 540           SIMIX_simcall_exit((smx_synchro_t) action->getData());
 541       }
 542     }
 543
 544     /* Autorestart all process */
 545     char *hostname = NULL;
 546     xbt_dynar_foreach(host_that_restart,iter,hostname) {
 547       XBT_INFO("Restart processes on host: %s",hostname);
 548       SIMIX_host_autorestart(sg_host_by_name(hostname));
 549     }
 550     xbt_dynar_reset(host_that_restart);
 551
 552     /* Clean processes to destroy */
 553     SIMIX_process_empty_trash();
 554
 555
 556     XBT_DEBUG("### time %f, empty %d", time, xbt_dynar_is_empty(simix_global->process_to_run));
 557
 558   } while (time != -1.0 || !xbt_dynar_is_empty(simix_global->process_to_run));
 559
 560   if (xbt_swag_size(simix_global->process_list) != 0) {
 561
 562   TRACE_end();
 563
 564     XBT_CRITICAL("Oops ! Deadlock or code not perfectly clean.");
 565     SIMIX_display_process_status();
 566     xbt_abort();
 567   }
 568 }
 569
 570 /**
 571  *   \brief Set the date to execute a function
 572  *
 573  * Set the date to execute the function on the surf.
 574  *   \param date Date to execute function
 575  *   \param function Function to be executed
 576  *   \param arg Parameters of the function
 577  *
 578  */
 579 smx_timer_t SIMIX_timer_set(double date, void (*function)(void*), void *arg)
 580 {
 581   smx_timer_t timer = xbt_new0(s_smx_timer_t, 1);
 582
 583   timer->date = date;
 584   timer->func = function;
 585   timer->args = arg;
 586   xbt_heap_push(simix_timers, timer, date);
 587   return timer;
 588 }
 589 /** @brief cancels a timer that was added earlier */
 590 void SIMIX_timer_remove(smx_timer_t timer) {
 591   xbt_heap_rm_elm(simix_timers, timer, timer->date);
 592 }
 593
 594 /** @brief Returns the date at which the timer will trigger (or 0 if NULL timer) */
 595 double SIMIX_timer_get_date(smx_timer_t timer) {
 596   return timer?timer->date:0;
 597 }
 598
 599 /**
 600  * \brief Registers a function to create a process.
 601  *
 602  * This function registers a function to be called
 603  * when a new process is created. The function has
 604  * to call SIMIX_process_create().
 605  * \param function create process function
 606  */
 607 void SIMIX_function_register_process_create(smx_creation_func_t
 608                                                        function)
 609 {
 610   simix_global->create_process_function = function;
 611 }
 612
 613 /**
 614  * \brief Registers a function to kill a process.
 615  *
 616  * This function registers a function to be called when a
 617  * process is killed. The function has to call the SIMIX_process_kill().
 618  *
 619  * \param function Kill process function
 620  */
 621 void SIMIX_function_register_process_kill(void_pfn_smxprocess_t
 622                                                      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
 631  * a process ends properly.
 632  *
 633  * \param function cleanup process function
 634  */
 635 void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t
 636                                                         function)
 637 {
 638   simix_global->cleanup_process_function = function;
 639 }
 640
 641
 642 void SIMIX_display_process_status(void)
 643 {
 644   if (simix_global->process_list == NULL) {
 645     return;
 646   }
 647
 648   smx_process_t process = NULL;
 649   int nbprocess = xbt_swag_size(simix_global->process_list);
 650
 651   XBT_INFO("%d processes are still running, waiting for something.", nbprocess);
 652   /*  List the process and their state */
 653   XBT_INFO
 654     ("Legend of the following listing: \"Process <pid> (<name>@<host>): <status>\"");
 655   xbt_swag_foreach(process, simix_global->process_list) {
 656
 657     if (process->waiting_synchro) {
 658
 659       const char* synchro_description = "unknown";
 660       switch (process->waiting_synchro->type) {
 661
 662       case SIMIX_SYNC_EXECUTE:
 663         synchro_description = "execution";
 664         break;
 665
 666       case SIMIX_SYNC_PARALLEL_EXECUTE:
 667         synchro_description = "parallel execution";
 668         break;
 669
 670       case SIMIX_SYNC_COMMUNICATE:
 671         synchro_description = "communication";
 672         break;
 673
 674       case SIMIX_SYNC_SLEEP:
 675         synchro_description = "sleeping";
 676         break;
 677
 678       case SIMIX_SYNC_JOIN:
 679         synchro_description = "joining";
 680         break;
 681
 682       case SIMIX_SYNC_SYNCHRO:
 683         synchro_description = "synchronization";
 684         break;
 685
 686       case SIMIX_SYNC_IO:
 687         synchro_description = "I/O";
 688         break;
 689       }
 690       XBT_INFO("Process %lu (%s@%s): waiting for %s synchro %p (%s) in state %d to finish",
 691           process->pid, process->name, sg_host_get_name(process->host),
 692           synchro_description, process->waiting_synchro,
 693           process->waiting_synchro->name, (int)process->waiting_synchro->state);
 694     }
 695     else {
 696       XBT_INFO("Process %lu (%s@%s)", process->pid, process->name, sg_host_get_name(process->host));
 697     }
 698   }
 699 }
 700
 701 static void* SIMIX_synchro_mallocator_new_f(void) {
 702   smx_synchro_t synchro = xbt_new(s_smx_synchro_t, 1);
 703   synchro->simcalls = xbt_fifo_new();
 704   return synchro;
 705 }
 706
 707 static void SIMIX_synchro_mallocator_free_f(void* synchro) {
 708   xbt_fifo_free(((smx_synchro_t) synchro)->simcalls);
 709   xbt_free(synchro);
 710 }
 711
 712 static void SIMIX_synchro_mallocator_reset_f(void* synchro) {
 713
 714   // we also recycle the simcall list
 715   xbt_fifo_t fifo = ((smx_synchro_t) synchro)->simcalls;
 716   xbt_fifo_reset(fifo);
 717   memset(synchro, 0, sizeof(s_smx_synchro_t));
 718   ((smx_synchro_t) synchro)->simcalls = fifo;
 719 }
 720
 721 xbt_dict_t simcall_HANDLER_asr_get_properties(smx_simcall_t simcall, const char *name){
 722   return SIMIX_asr_get_properties(name);
 723 }
 724 xbt_dict_t SIMIX_asr_get_properties(const char *name)
 725 {
 726   return (xbt_dict_t) xbt_lib_get_or_null(as_router_lib, name, ROUTING_PROP_ASR_LEVEL);
 727 }
 728
 729 int SIMIX_is_maestro()
 730 {
 731   return simix_global==NULL /*SimDag*/|| SIMIX_process_self() == simix_global->maestro_process;
 732 }