src/simix/smx_global.c

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