src/simix/smx_global.c

   1 /* Copyright (c) 2007-2012. 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 "smx_private.h"
   7 #include "xbt/heap.h"
   8 #include "xbt/sysdep.h"
   9 #include "xbt/log.h"
  10 #include "xbt/str.h"
  11 #include "xbt/ex.h"             /* ex_backtrace_display */
  12 #include "mc/mc.h"
  13 #include "simgrid/sg_config.h"
  14
  15 XBT_LOG_NEW_CATEGORY(simix, "All SIMIX categories");
  16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_kernel, simix,
  17                                 "Logging specific to SIMIX (kernel)");
  18
  19 smx_global_t simix_global = NULL;
  20 static xbt_heap_t simix_timers = NULL;
  21
  22 static void* SIMIX_action_mallocator_new_f(void);
  23 static void SIMIX_action_mallocator_free_f(void* action);
  24 static void SIMIX_action_mallocator_reset_f(void* action);
  25
  26 static void SIMIX_clean(void);
  27
  28 /* FIXME: Yeah, I'll do it in a portable maner one day [Mt] */
  29 #include <signal.h>
  30
  31 int _sg_do_verbose_exit = 1;
  32 static void _XBT_CALL inthandler(int ignored)
  33 {
  34   if ( _sg_do_verbose_exit ) {
  35      XBT_INFO("CTRL-C pressed. Displaying status and bailing out");
  36      SIMIX_display_process_status();
  37   }
  38   else {
  39      XBT_INFO("CTRL-C pressed. bailing out without displaying because verbose-exit is disabled");
  40   }
  41   exit(1);
  42 }
  43
  44 /********************************* SIMIX **************************************/
  45
  46 XBT_INLINE double SIMIX_timer_next(void)
  47 {
  48   return xbt_heap_size(simix_timers) > 0 ? xbt_heap_maxkey(simix_timers) : -1.0;
  49 }
  50
  51 /**
  52  * \ingroup SIMIX_API
  53  * \brief Initialize SIMIX internal data.
  54  *
  55  * \param argc Argc
  56  * \param argv Argv
  57  */
  58 void SIMIX_global_init(int *argc, char **argv)
  59 {
  60   s_smx_process_t proc;
  61
  62   if (!simix_global) {
  63     simix_global = xbt_new0(s_smx_global_t, 1);
  64
  65 #ifdef TIME_BENCH_AMDAHL
  66     simix_global->timer_seq = xbt_os_timer_new();
  67     simix_global->timer_par = xbt_os_timer_new();
  68     xbt_os_cputimer_start(simix_global->timer_seq);
  69 #endif
  70     simix_global->process_to_run = xbt_dynar_new(sizeof(smx_process_t), NULL);
  71     simix_global->process_that_ran = xbt_dynar_new(sizeof(smx_process_t), NULL);
  72     simix_global->process_list =
  73         xbt_swag_new(xbt_swag_offset(proc, process_hookup));
  74     simix_global->process_to_destroy =
  75         xbt_swag_new(xbt_swag_offset(proc, destroy_hookup));
  76
  77     simix_global->maestro_process = NULL;
  78     simix_global->registered_functions = xbt_dict_new_homogeneous(NULL);
  79
  80     simix_global->create_process_function = SIMIX_process_create;
  81     simix_global->kill_process_function = SIMIX_process_kill;
  82     simix_global->cleanup_process_function = SIMIX_process_cleanup;
  83     simix_global->action_mallocator = xbt_mallocator_new(65536,
  84         SIMIX_action_mallocator_new_f, SIMIX_action_mallocator_free_f,
  85         SIMIX_action_mallocator_reset_f);
  86     simix_global->autorestart = SIMIX_host_restart_processes;
  87
  88     surf_init(argc, argv);      /* Initialize SURF structures */
  89     SIMIX_context_mod_init();
  90     SIMIX_create_maestro_process();
  91
  92     /* context exception handlers */
  93     __xbt_running_ctx_fetch = SIMIX_process_get_running_context;
  94     __xbt_ex_terminate = SIMIX_process_exception_terminate;
  95
  96     SIMIX_network_init();
  97
  98     /* Prepare to display some more info when dying on Ctrl-C pressing */
  99     signal(SIGINT, inthandler);
 100
 101     /* register a function to be called by SURF after the environment creation */
 102     sg_platf_init();
 103     sg_platf_postparse_add_cb(SIMIX_post_create_environment);
 104
 105   }
 106   if (!simix_timers) {
 107     simix_timers = xbt_heap_new(8, &free);
 108   }
 109
 110   SIMIX_HOST_LEVEL = xbt_lib_add_level(host_lib,SIMIX_host_destroy);
 111
 112   if(sg_cfg_get_boolean("clean_atexit")) atexit(SIMIX_clean);
 113 }
 114
 115 /**
 116  * \ingroup SIMIX_API
 117  * \brief Clean the SIMIX simulation
 118  *
 119  * This functions remove the memory used by SIMIX
 120  */
 121 static void SIMIX_clean(void)
 122 {
 123 #ifdef TIME_BENCH_PER_SR
 124   smx_ctx_raw_new_sr();
 125 #endif
 126
 127   /* Kill everyone (except maestro) */
 128   SIMIX_process_killall(simix_global->maestro_process, 1);
 129
 130   /* Exit the SIMIX network module */
 131   SIMIX_network_exit();
 132
 133   xbt_heap_free(simix_timers);
 134   simix_timers = NULL;
 135   /* Free the remaining data structures */
 136   xbt_dynar_free(&simix_global->process_to_run);
 137   xbt_dynar_free(&simix_global->process_that_ran);
 138   xbt_swag_free(simix_global->process_to_destroy);
 139   xbt_swag_free(simix_global->process_list);
 140   simix_global->process_list = NULL;
 141   simix_global->process_to_destroy = NULL;
 142   xbt_dict_free(&(simix_global->registered_functions));
 143
 144   /* Let's free maestro now */
 145   SIMIX_context_free(simix_global->maestro_process->context);
 146   xbt_free(simix_global->maestro_process->running_ctx);
 147   xbt_free(simix_global->maestro_process);
 148   simix_global->maestro_process = NULL;
 149
 150   /* Restore the default exception setup */
 151   __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
 152   __xbt_ex_terminate = &__xbt_ex_terminate_default;
 153
 154   /* Finish context module and SURF */
 155   SIMIX_context_mod_exit();
 156
 157   surf_exit();
 158
 159 #ifdef TIME_BENCH_AMDAHL
 160   xbt_os_cputimer_stop(simix_global->timer_seq);
 161   XBT_INFO("Amdhal timing informations. Sequential time: %lf; Parallel time: %lf",
 162            xbt_os_timer_elapsed(simix_global->timer_seq),
 163            xbt_os_timer_elapsed(simix_global->timer_par));
 164   xbt_os_timer_free(simix_global->timer_seq);
 165   xbt_os_timer_free(simix_global->timer_par);
 166 #endif
 167
 168   xbt_mallocator_free(simix_global->action_mallocator);
 169   xbt_free(simix_global);
 170   simix_global = NULL;
 171
 172   return;
 173 }
 174
 175
 176 /**
 177  * \ingroup SIMIX_API
 178  * \brief A clock (in second).
 179  *
 180  * \return Return the clock.
 181  */
 182 XBT_INLINE double SIMIX_get_clock(void)
 183 {
 184   if(MC_is_active()){
 185     return MC_process_clock_get(SIMIX_process_self());
 186   }else{
 187     return surf_get_clock();
 188   }
 189 }
 190
 191 static int process_syscall_color(void *p)
 192 {
 193   switch ((*(smx_process_t *)p)->simcall.call) {
 194   case SIMCALL_NONE:
 195   case SIMCALL_PROCESS_KILL:
 196     return 2;
 197   case SIMCALL_PROCESS_RESUME:
 198     return 1;
 199   default:
 200     return 0;
 201   }
 202 }
 203
 204 /**
 205  * \ingroup SIMIX_API
 206  * \brief Run the main simulation loop.
 207  */
 208 void SIMIX_run(void)
 209 {
 210   double time = 0;
 211   smx_process_t process;
 212   xbt_swag_t set;
 213   surf_action_t action;
 214   smx_timer_t timer;
 215   surf_model_t model;
 216   unsigned int iter;
 217
 218   do {
 219     XBT_DEBUG("New Schedule Round; size(queue)=%lu",
 220         xbt_dynar_length(simix_global->process_to_run));
 221 #ifdef TIME_BENCH_PER_SR
 222     smx_ctx_raw_new_sr();
 223 #endif
 224     while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
 225       XBT_DEBUG("New Sub-Schedule Round; size(queue)=%lu",
 226               xbt_dynar_length(simix_global->process_to_run));
 227
 228       /* Run all processes that are ready to run, possibly in parallel */
 229 #ifdef TIME_BENCH_AMDAHL
 230       xbt_os_cputimer_stop(simix_global->timer_seq);
 231       xbt_os_cputimer_resume(simix_global->timer_par);
 232 #endif
 233       SIMIX_process_runall();
 234 #ifdef TIME_BENCH_AMDAHL
 235       xbt_os_cputimer_stop(simix_global->timer_par);
 236       xbt_os_cputimer_resume(simix_global->timer_seq);
 237 #endif
 238
 239       /* Move all killing processes to the end of the list, because killing a process that have an ongoing simcall is a bad idea */
 240       xbt_dynar_three_way_partition(simix_global->process_that_ran, process_syscall_color);
 241
 242       /* answer sequentially and in a fixed arbitrary order all the simcalls that were issued during that sub-round */
 243
 244       /* WARNING, the order *must* be fixed or you'll jeopardize the simulation reproducibility (see RR-7653) */
 245
 246       /* Here, the order is ok because:
 247        *
 248        *   Short proof: only maestro adds stuff to the process_to_run array, so the execution order of user contexts do not impact its order.
 249        *
 250        *   Long proof: processes remain sorted through an arbitrary (implicit, complex but fixed) order in all cases.
 251        *
 252        *   - if there is no kill during the simulation, processes remain sorted according by their PID.
 253        *     rational: This can be proved inductively.
 254        *        Assume that process_to_run is sorted at a beginning of one round (it is at round 0: the deployment file is parsed linearly).
 255        *        Let's show that it is still so at the end of this round.
 256        *        - if a process is added when being created, that's from maestro. It can be either at startup
 257        *          time (and then in PID order), or in response to a process_create simcall. Since simcalls are handled
 258        *          in arbitrary order (inductive hypothesis), we are fine.
 259        *        - If a process is added because it's getting killed, its subsequent actions shouldn't matter
 260        *        - If a process gets added to process_to_run because one of their blocking action constituting the meat
 261        *          of a simcall terminates, we're still good. Proof:
 262        *          - You are added from SIMIX_simcall_answer() only. When this function is called depends on the resource
 263        *            kind (network, cpu, disk, whatever), but the same arguments hold. Let's take communications as an example.
 264        *          - For communications, this function is called from SIMIX_comm_finish().
 265        *            This function itself don't mess with the order since simcalls are handled in FIFO order.
 266        *            The function is called:
 267        *            - before the comm starts (invalid parameters, or resource already dead or whatever).
 268        *              The order then trivial holds since maestro didn't interrupt its handling of the simcall yet
 269        *            - because the communication failed or were canceled after startup. In this case, it's called from the function
 270        *              we are in, by the chunk:
 271        *                       set = model->states.failed_action_set;
 272        *                       while ((action = xbt_swag_extract(set)))
 273        *                          SIMIX_simcall_post((smx_action_t) action->data);
 274        *              This order is also fixed because it depends of the order in which the surf actions were
 275        *              added to the system, and only maestro can add stuff this way, through simcalls.
 276        *              We thus use the inductive hypothesis once again to conclude that the order in which actions are
 277        *              poped out of the swag does not depend on the user code's execution order.
 278        *            - because the communication terminated. In this case, actions are served in the order given by
 279        *                       set = model->states.done_action_set;
 280        *                       while ((action = xbt_swag_extract(set)))
 281        *                          SIMIX_simcall_post((smx_action_t) action->data);
 282        *              and the argument is very similar to the previous one.
 283        *            So, in any case, the orders of calls to SIMIX_comm_finish() do not depend on the order in which user processes are executed.
 284        *          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.
 285        *     So, if there is no killing in the simulation, the simulation reproducibility is not jeopardized.
 286        *   - If there is some process killings, the order is changed by this decision that comes from user-land
 287        *     But this decision may not have been motivated by a situation that were different because the simulation is not reproducible.
 288        *     So, even the order change induced by the process killing is perfectly reproducible.
 289        *
 290        *   So science works, bitches [http://xkcd.com/54/].
 291        *
 292        *   We could sort the process_that_ran array completely so that we can describe the order in which simcalls are handled
 293        *   (like "according to the PID of issuer"), but it's not mandatory (order is fixed already even if unfriendly).
 294        *   That would thus be a pure waste of time.
 295        */
 296
 297       xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
 298         if (process->simcall.call != SIMCALL_NONE) {
 299           SIMIX_simcall_pre(&process->simcall, 0);
 300         }
 301       }
 302     }
 303
 304     time = SIMIX_timer_next();
 305     if (time != -1.0 || xbt_swag_size(simix_global->process_list) != 0)
 306       time = surf_solve(time);
 307
 308     /* Notify all the hosts that have failed */
 309     /* FIXME: iterate through the list of failed host and mark each of them */
 310     /* as failed. On each host, signal all the running processes with host_fail */
 311
 312     /* Handle any pending timer */
 313     while (xbt_heap_size(simix_timers) > 0 && SIMIX_get_clock() >= SIMIX_timer_next()) {
 314        //FIXME: make the timers being real callbacks
 315        // (i.e. provide dispatchers that read and expand the args)
 316        timer = xbt_heap_pop(simix_timers);
 317        if (timer->func)
 318          ((void (*)(void*))timer->func)(timer->args);
 319        xbt_free(timer);
 320     }
 321     /* Wake up all processes waiting for a Surf action to finish */
 322     xbt_dynar_foreach(model_list, iter, model) {
 323       set = model->states.failed_action_set;
 324       while ((action = xbt_swag_extract(set)))
 325         SIMIX_simcall_post((smx_action_t) action->data);
 326       set = model->states.done_action_set;
 327       while ((action = xbt_swag_extract(set)))
 328         SIMIX_simcall_post((smx_action_t) action->data);
 329     }
 330
 331     /* Autorestart all process */
 332     char *hostname = NULL;
 333     xbt_dynar_foreach(host_that_restart,iter,hostname) {
 334       XBT_INFO("Restart processes on host: %s",hostname);
 335       SIMIX_host_autorestart(SIMIX_host_get_by_name(hostname));
 336     }
 337     xbt_dynar_reset(host_that_restart);
 338
 339     /* Clean processes to destroy */
 340     SIMIX_process_empty_trash();
 341
 342   } while (time != -1.0 || !xbt_dynar_is_empty(simix_global->process_to_run));
 343
 344   if (xbt_swag_size(simix_global->process_list) != 0) {
 345
 346 #ifdef HAVE_TRACING
 347     TRACE_end();
 348 #endif
 349
 350     XBT_WARN("Oops ! Deadlock or code not perfectly clean.");
 351     SIMIX_display_process_status();
 352     xbt_abort();
 353   }
 354 }
 355
 356 /**
 357  *   \brief Set the date to execute a function
 358  *
 359  * Set the date to execute the function on the surf.
 360  *   \param date Date to execute function
 361  *   \param function Function to be executed
 362  *   \param arg Parameters of the function
 363  *
 364  */
 365 XBT_INLINE void SIMIX_timer_set(double date, void *function, void *arg)
 366 {
 367   smx_timer_t timer = xbt_new0(s_smx_timer_t, 1);
 368
 369   timer->date = date;
 370   timer->func = function;
 371   timer->args = arg;
 372   xbt_heap_push(simix_timers, timer, date);
 373 }
 374
 375 /**
 376  * \brief Registers a function to create a process.
 377  *
 378  * This function registers a function to be called
 379  * when a new process is created. The function has
 380  * to call SIMIX_process_create().
 381  * \param function create process function
 382  */
 383 XBT_INLINE void SIMIX_function_register_process_create(smx_creation_func_t
 384                                                        function)
 385 {
 386   simix_global->create_process_function = function;
 387 }
 388
 389 /**
 390  * \brief Registers a function to kill a process.
 391  *
 392  * This function registers a function to be called when a
 393  * process is killed. The function has to call the SIMIX_process_kill().
 394  *
 395  * \param function Kill process function
 396  */
 397 XBT_INLINE void SIMIX_function_register_process_kill(void_pfn_smxprocess_t_smxprocess_t
 398                                                      function)
 399 {
 400   simix_global->kill_process_function = function;
 401 }
 402
 403 /**
 404  * \brief Registers a function to cleanup a process.
 405  *
 406  * This function registers a user function to be called when
 407  * a process ends properly.
 408  *
 409  * \param function cleanup process function
 410  */
 411 XBT_INLINE void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t
 412                                                         function)
 413 {
 414   simix_global->cleanup_process_function = function;
 415 }
 416
 417
 418 void SIMIX_display_process_status(void)
 419 {
 420   if (simix_global->process_list == NULL) {
 421     return;
 422   }
 423
 424   smx_process_t process = NULL;
 425   int nbprocess = xbt_swag_size(simix_global->process_list);
 426
 427   XBT_INFO("%d processes are still running, waiting for something.", nbprocess);
 428   /*  List the process and their state */
 429   XBT_INFO
 430     ("Legend of the following listing: \"Process <pid> (<name>@<host>): <status>\"");
 431   xbt_swag_foreach(process, simix_global->process_list) {
 432
 433     if (process->waiting_action) {
 434
 435       const char* action_description = "unknown";
 436       switch (process->waiting_action->type) {
 437
 438       case SIMIX_ACTION_EXECUTE:
 439         action_description = "execution";
 440         break;
 441
 442       case SIMIX_ACTION_PARALLEL_EXECUTE:
 443         action_description = "parallel execution";
 444         break;
 445
 446       case SIMIX_ACTION_COMMUNICATE:
 447         action_description = "communication";
 448         break;
 449
 450       case SIMIX_ACTION_SLEEP:
 451         action_description = "sleeping";
 452         break;
 453
 454       case SIMIX_ACTION_SYNCHRO:
 455         action_description = "synchronization";
 456         break;
 457
 458       case SIMIX_ACTION_IO:
 459         action_description = "I/O";
 460         break;
 461       /* **************************************/
 462       /* TUTORIAL: New API                    */
 463       case SIMIX_ACTION_NEW_API:
 464         action_description = "NEW API";
 465       /* **************************************/
 466
 467         break;
 468       }
 469       XBT_INFO("Process %lu (%s@%s): waiting for %s action %p (%s) in state %d to finish",
 470           process->pid, process->name, sg_host_name(process->smx_host),
 471           action_description, process->waiting_action,
 472           process->waiting_action->name, (int)process->waiting_action->state);
 473     }
 474     else {
 475       XBT_INFO("Process %lu (%s@%s)", process->pid, process->name, sg_host_name(process->smx_host));
 476     }
 477   }
 478 }
 479
 480 static void* SIMIX_action_mallocator_new_f(void) {
 481   smx_action_t action = xbt_new(s_smx_action_t, 1);
 482   action->simcalls = xbt_fifo_new();
 483   return action;
 484 }
 485
 486 static void SIMIX_action_mallocator_free_f(void* action) {
 487   xbt_fifo_free(((smx_action_t) action)->simcalls);
 488   xbt_free(action);
 489 }
 490
 491 static void SIMIX_action_mallocator_reset_f(void* action) {
 492
 493   // we also recycle the simcall list
 494   xbt_fifo_t fifo = ((smx_action_t) action)->simcalls;
 495   xbt_fifo_reset(fifo);
 496   memset(action, 0, sizeof(s_smx_action_t));
 497   ((smx_action_t) action)->simcalls = fifo;
 498 }
 499
 500 xbt_dict_t SIMIX_pre_asr_get_properties(smx_simcall_t simcall, const char *name){
 501   return SIMIX_asr_get_properties(name);
 502 }
 503 xbt_dict_t SIMIX_asr_get_properties(const char *name)
 504 {
 505   return xbt_lib_get_or_null(as_router_lib, name, ROUTING_PROP_ASR_LEVEL);
 506 }
 507