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