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_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 extern void smx_ctx_raw_new_sr(void);
  26
  27 /* FIXME: Yeah, I'll do it in a portable maner one day [Mt] */
  28 #include <signal.h>
  29
  30 int _surf_do_verbose_exit = 1;
  31 static void _XBT_CALL inthandler(int ignored)
  32 {
  33   if ( _surf_do_verbose_exit ) {
  34      XBT_INFO("CTRL-C pressed. Displaying status and bailing out");
  35      SIMIX_display_process_status();
  36   }
  37   else {
  38      XBT_INFO("CTRL-C pressed. bailing out without displaying because verbose-exit is disabled");
  39   }
  40   exit(1);
  41 }
  42
  43 /********************************* SIMIX **************************************/
  44
  45 XBT_INLINE double SIMIX_timer_next(void)
  46 {
  47   return xbt_heap_size(simix_timers) > 0 ? xbt_heap_maxkey(simix_timers) : -1.0;
  48 }
  49
  50 /**
  51  * \brief Initialize SIMIX internal data.
  52  *
  53  * \param argc Argc
  54  * \param argv Argv
  55  */
  56 void SIMIX_global_init(int *argc, char **argv)
  57 {
  58   s_smx_process_t proc;
  59
  60   if (!simix_global) {
  61     /* Connect our log channels: that must be done manually under windows */
  62     XBT_LOG_CONNECT(simix_context, simix);
  63     XBT_LOG_CONNECT(simix_deployment, simix);
  64     XBT_LOG_CONNECT(simix_environment, simix);
  65     XBT_LOG_CONNECT(simix_host, simix);
  66     XBT_LOG_CONNECT(simix_kernel, simix);
  67     XBT_LOG_CONNECT(simix_process, simix);
  68     XBT_LOG_CONNECT(simix_synchro, simix);
  69
  70     simix_global = xbt_new0(s_smx_global_t, 1);
  71
  72     simix_global->process_to_run = xbt_dynar_new(sizeof(smx_process_t), NULL);
  73     simix_global->process_that_ran = xbt_dynar_new(sizeof(smx_process_t), NULL);
  74     simix_global->process_list =
  75         xbt_swag_new(xbt_swag_offset(proc, process_hookup));
  76     simix_global->process_to_destroy =
  77         xbt_swag_new(xbt_swag_offset(proc, destroy_hookup));
  78
  79     simix_global->maestro_process = NULL;
  80     simix_global->registered_functions = xbt_dict_new_homogeneous(NULL);
  81
  82     simix_global->create_process_function = SIMIX_process_create;
  83     simix_global->kill_process_function = SIMIX_process_kill;
  84     simix_global->cleanup_process_function = SIMIX_process_cleanup;
  85     simix_global->action_mallocator = xbt_mallocator_new(65536,
  86         SIMIX_action_mallocator_new_f, SIMIX_action_mallocator_free_f,
  87         SIMIX_action_mallocator_reset_f);
  88
  89     surf_init(argc, argv);      /* Initialize SURF structures */
  90     SIMIX_context_mod_init();
  91     SIMIX_create_maestro_process();
  92
  93     /* context exception handlers */
  94     __xbt_running_ctx_fetch = SIMIX_process_get_running_context;
  95     __xbt_ex_terminate = SIMIX_process_exception_terminate;
  96
  97     /* Initialize the SIMIX network module */
  98     SIMIX_network_init();
  99
 100     /* Prepare to display some more info when dying on Ctrl-C pressing */
 101     signal(SIGINT, inthandler);
 102   }
 103   if (!simix_timers) {
 104     simix_timers = xbt_heap_new(8, &free);
 105   }
 106
 107   XBT_DEBUG("ADD SIMIX LEVELS");
 108   SIMIX_HOST_LEVEL = xbt_lib_add_level(host_lib,SIMIX_host_destroy);
 109 }
 110
 111 /**
 112  * \brief Clean the SIMIX simulation
 113  *
 114  * This functions remove the memory used by SIMIX
 115  */
 116 void SIMIX_clean(void)
 117 {
 118 #ifdef TIME_BENCH
 119   smx_ctx_raw_new_sr();
 120 #endif
 121
 122   /* Kill everyone (except maestro) */
 123   SIMIX_process_killall(simix_global->maestro_process);
 124
 125   /* Exit the SIMIX network module */
 126   SIMIX_network_exit();
 127
 128   xbt_heap_free(simix_timers);
 129   simix_timers = NULL;
 130   /* Free the remaining data structures */
 131   xbt_dynar_free(&simix_global->process_to_run);
 132   xbt_dynar_free(&simix_global->process_that_ran);
 133   xbt_swag_free(simix_global->process_to_destroy);
 134   xbt_swag_free(simix_global->process_list);
 135   simix_global->process_list = NULL;
 136   simix_global->process_to_destroy = NULL;
 137   xbt_dict_free(&(simix_global->registered_functions));
 138
 139   /* Let's free maestro now */
 140   SIMIX_context_free(simix_global->maestro_process->context);
 141   xbt_free(simix_global->maestro_process->running_ctx);
 142   xbt_free(simix_global->maestro_process);
 143   simix_global->maestro_process = NULL;
 144
 145   /* Restore the default exception setup */
 146   __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
 147   __xbt_ex_terminate = &__xbt_ex_terminate_default;
 148
 149   /* Finish context module and SURF */
 150   SIMIX_context_mod_exit();
 151
 152   surf_exit();
 153
 154   xbt_mallocator_free(simix_global->action_mallocator);
 155   xbt_free(simix_global);
 156   simix_global = NULL;
 157
 158   return;
 159 }
 160
 161
 162 /**
 163  * \brief A clock (in second).
 164  *
 165  * \return Return the clock.
 166  */
 167 XBT_INLINE double SIMIX_get_clock(void)
 168 {
 169   if(MC_IS_ENABLED){
 170     return MC_process_clock_get(SIMIX_process_self());
 171   }else{
 172     return surf_get_clock();
 173   }
 174 }
 175
 176 void SIMIX_run(void)
 177 {
 178   double time = 0;
 179   smx_process_t process;
 180   xbt_swag_t set;
 181   surf_action_t action;
 182   smx_timer_t timer;
 183   surf_model_t model;
 184   unsigned int iter;
 185
 186   do {
 187     XBT_DEBUG("New Schedule Round; size(queue)=%lu",
 188         xbt_dynar_length(simix_global->process_to_run));
 189 #ifdef TIME_BENCH
 190     smx_ctx_raw_new_sr();
 191 #endif
 192     while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
 193       XBT_DEBUG("New Sub-Schedule Round; size(queue)=%lu",
 194               xbt_dynar_length(simix_global->process_to_run));
 195       SIMIX_process_runall();
 196       xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
 197         if (process->simcall.call != SIMCALL_NONE) {
 198           SIMIX_simcall_pre(&process->simcall, 0);
 199         }
 200       }
 201     }
 202
 203     time = SIMIX_timer_next();
 204     if (time != -1.0 || xbt_swag_size(simix_global->process_list) != 0)
 205       time = surf_solve(time);
 206
 207     /* Notify all the hosts that have failed */
 208     /* FIXME: iterate through the list of failed host and mark each of them */
 209     /* as failed. On each host, signal all the running processes with host_fail */
 210
 211     /* Handle any pending timer */
 212     while (xbt_heap_size(simix_timers) > 0 && SIMIX_get_clock() >= SIMIX_timer_next()) {
 213        //FIXME: make the timers being real callbacks
 214        // (i.e. provide dispatchers that read and expand the args)
 215        timer = xbt_heap_pop(simix_timers);
 216        if (timer->func)
 217          ((void (*)(void*))timer->func)(timer->args);
 218     }
 219     /* Wake up all processes waiting for a Surf action to finish */
 220     xbt_dynar_foreach(model_list, iter, model) {
 221       set = model->states.failed_action_set;
 222       while ((action = xbt_swag_extract(set)))
 223         SIMIX_simcall_post((smx_action_t) action->data);
 224       set = model->states.done_action_set;
 225       while ((action = xbt_swag_extract(set)))
 226         SIMIX_simcall_post((smx_action_t) action->data);
 227     }
 228
 229     /* Clean processes to destroy */
 230     SIMIX_process_empty_trash();
 231
 232   } while (time != -1.0 || !xbt_dynar_is_empty(simix_global->process_to_run));
 233
 234   if (xbt_swag_size(simix_global->process_list) != 0) {
 235
 236 #ifdef HAVE_TRACING
 237     TRACE_end();
 238 #endif
 239
 240     XBT_WARN("Oops ! Deadlock or code not perfectly clean.");
 241     SIMIX_display_process_status();
 242     xbt_abort();
 243   }
 244 }
 245
 246 /**
 247  *      \brief Set the date to execute a function
 248  *
 249  * Set the date to execute the function on the surf.
 250  *      \param date Date to execute function
 251  *      \param function Function to be executed
 252  *      \param arg Parameters of the function
 253  *
 254  */
 255 XBT_INLINE void SIMIX_timer_set(double date, void *function, void *arg)
 256 {
 257   smx_timer_t timer = xbt_new0(s_smx_timer_t, 1);
 258
 259   timer->date = date;
 260   timer->func = function;
 261   timer->args = arg;
 262   xbt_heap_push(simix_timers, timer, date);
 263 }
 264
 265 /**
 266  * \brief Registers a function to create a process.
 267  *
 268  * This function registers a function to be called
 269  * when a new process is created. The function has
 270  * to call SIMIX_process_create().
 271  * \param function create process function
 272  */
 273 XBT_INLINE void SIMIX_function_register_process_create(smx_creation_func_t
 274                                                        function)
 275 {
 276   simix_global->create_process_function = function;
 277 }
 278
 279 /**
 280  * \brief Registers a function to kill a process.
 281  *
 282  * This function registers a function to be called when a
 283  * process is killed. The function has to call the SIMIX_process_kill().
 284  *
 285  * \param function Kill process function
 286  */
 287 XBT_INLINE void SIMIX_function_register_process_kill(void_pfn_smxprocess_t
 288                                                      function)
 289 {
 290   simix_global->kill_process_function = function;
 291 }
 292
 293 /**
 294  * \brief Registers a function to cleanup a process.
 295  *
 296  * This function registers a user function to be called when
 297  * a process ends properly.
 298  *
 299  * \param function cleanup process function
 300  */
 301 XBT_INLINE void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t
 302                                                         function)
 303 {
 304   simix_global->cleanup_process_function = function;
 305 }
 306
 307
 308 void SIMIX_display_process_status(void)
 309 {
 310   if (simix_global->process_list == NULL) {
 311     return;
 312   }
 313
 314   smx_process_t process = NULL;
 315   int nbprocess = xbt_swag_size(simix_global->process_list);
 316
 317   XBT_INFO("%d processes are still running, waiting for something.", nbprocess);
 318   /*  List the process and their state */
 319   XBT_INFO
 320     ("Legend of the following listing: \"Process <pid> (<name>@<host>): <status>\"");
 321   xbt_swag_foreach(process, simix_global->process_list) {
 322
 323     if (process->waiting_action) {
 324
 325       const char* action_description = "unknown";
 326       switch (process->waiting_action->type) {
 327
 328       case SIMIX_ACTION_EXECUTE:
 329         action_description = "execution";
 330         break;
 331
 332       case SIMIX_ACTION_PARALLEL_EXECUTE:
 333         action_description = "parallel execution";
 334         break;
 335
 336       case SIMIX_ACTION_COMMUNICATE:
 337         action_description = "communication";
 338         break;
 339
 340       case SIMIX_ACTION_SLEEP:
 341         action_description = "sleeping";
 342         break;
 343
 344       case SIMIX_ACTION_SYNCHRO:
 345         action_description = "synchronization";
 346         break;
 347
 348       case SIMIX_ACTION_IO:
 349         action_description = "I/O";
 350         break;
 351       }
 352       XBT_INFO("Process %lu (%s@%s): waiting for %s action %p (%s) in state %d to finish",
 353           process->pid, process->name, process->smx_host->name,
 354           action_description, process->waiting_action,
 355           process->waiting_action->name, (int)process->waiting_action->state);
 356     }
 357     else {
 358       XBT_INFO("Process %lu (%s@%s)", process->pid, process->name, process->smx_host->name);
 359     }
 360   }
 361 }
 362
 363 static void* SIMIX_action_mallocator_new_f(void) {
 364   smx_action_t action = xbt_new(s_smx_action_t, 1);
 365   action->simcalls = xbt_fifo_new();
 366   return action;
 367 }
 368
 369 static void SIMIX_action_mallocator_free_f(void* action) {
 370   xbt_fifo_free(((smx_action_t) action)->simcalls);
 371   xbt_free(action);
 372 }
 373
 374 static void SIMIX_action_mallocator_reset_f(void* action) {
 375
 376   // we also recycle the simcall list
 377   xbt_fifo_t fifo = ((smx_action_t) action)->simcalls;
 378   xbt_fifo_reset(fifo);
 379   memset(action, 0, sizeof(s_smx_action_t));
 380   ((smx_action_t) action)->simcalls = fifo;
 381 }