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       SIMIX_process_runall();
 201       xbt_dynar_three_way_partition(simix_global->process_that_ran, process_syscall_color);
 202       xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
 203         if (process->simcall.call != SIMCALL_NONE) {
 204           SIMIX_simcall_pre(&process->simcall, 0);
 205         }
 206       }
 207     }
 208
 209     time = SIMIX_timer_next();
 210     if (time != -1.0 || xbt_swag_size(simix_global->process_list) != 0)
 211       time = surf_solve(time);
 212
 213     /* Notify all the hosts that have failed */
 214     /* FIXME: iterate through the list of failed host and mark each of them */
 215     /* as failed. On each host, signal all the running processes with host_fail */
 216
 217     /* Handle any pending timer */
 218     while (xbt_heap_size(simix_timers) > 0 && SIMIX_get_clock() >= SIMIX_timer_next()) {
 219        //FIXME: make the timers being real callbacks
 220        // (i.e. provide dispatchers that read and expand the args)
 221        timer = xbt_heap_pop(simix_timers);
 222        if (timer->func)
 223          ((void (*)(void*))timer->func)(timer->args);
 224     }
 225     /* Wake up all processes waiting for a Surf action to finish */
 226     xbt_dynar_foreach(model_list, iter, model) {
 227       set = model->states.failed_action_set;
 228       while ((action = xbt_swag_extract(set)))
 229         SIMIX_simcall_post((smx_action_t) action->data);
 230       set = model->states.done_action_set;
 231       while ((action = xbt_swag_extract(set)))
 232         SIMIX_simcall_post((smx_action_t) action->data);
 233     }
 234
 235     /* Clean processes to destroy */
 236     SIMIX_process_empty_trash();
 237
 238   } while (time != -1.0 || !xbt_dynar_is_empty(simix_global->process_to_run));
 239
 240   if (xbt_swag_size(simix_global->process_list) != 0) {
 241
 242 #ifdef HAVE_TRACING
 243     TRACE_end();
 244 #endif
 245
 246     XBT_WARN("Oops ! Deadlock or code not perfectly clean.");
 247     SIMIX_display_process_status();
 248     xbt_abort();
 249   }
 250 }
 251
 252 /**
 253  *      \brief Set the date to execute a function
 254  *
 255  * Set the date to execute the function on the surf.
 256  *      \param date Date to execute function
 257  *      \param function Function to be executed
 258  *      \param arg Parameters of the function
 259  *
 260  */
 261 XBT_INLINE void SIMIX_timer_set(double date, void *function, void *arg)
 262 {
 263   smx_timer_t timer = xbt_new0(s_smx_timer_t, 1);
 264
 265   timer->date = date;
 266   timer->func = function;
 267   timer->args = arg;
 268   xbt_heap_push(simix_timers, timer, date);
 269 }
 270
 271 /**
 272  * \brief Registers a function to create a process.
 273  *
 274  * This function registers a function to be called
 275  * when a new process is created. The function has
 276  * to call SIMIX_process_create().
 277  * \param function create process function
 278  */
 279 XBT_INLINE void SIMIX_function_register_process_create(smx_creation_func_t
 280                                                        function)
 281 {
 282   simix_global->create_process_function = function;
 283 }
 284
 285 /**
 286  * \brief Registers a function to kill a process.
 287  *
 288  * This function registers a function to be called when a
 289  * process is killed. The function has to call the SIMIX_process_kill().
 290  *
 291  * \param function Kill process function
 292  */
 293 XBT_INLINE void SIMIX_function_register_process_kill(void_pfn_smxprocess_t
 294                                                      function)
 295 {
 296   simix_global->kill_process_function = function;
 297 }
 298
 299 /**
 300  * \brief Registers a function to cleanup a process.
 301  *
 302  * This function registers a user function to be called when
 303  * a process ends properly.
 304  *
 305  * \param function cleanup process function
 306  */
 307 XBT_INLINE void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t
 308                                                         function)
 309 {
 310   simix_global->cleanup_process_function = function;
 311 }
 312
 313
 314 void SIMIX_display_process_status(void)
 315 {
 316   if (simix_global->process_list == NULL) {
 317     return;
 318   }
 319
 320   smx_process_t process = NULL;
 321   int nbprocess = xbt_swag_size(simix_global->process_list);
 322
 323   XBT_INFO("%d processes are still running, waiting for something.", nbprocess);
 324   /*  List the process and their state */
 325   XBT_INFO
 326     ("Legend of the following listing: \"Process <pid> (<name>@<host>): <status>\"");
 327   xbt_swag_foreach(process, simix_global->process_list) {
 328
 329     if (process->waiting_action) {
 330
 331       const char* action_description = "unknown";
 332       switch (process->waiting_action->type) {
 333
 334       case SIMIX_ACTION_EXECUTE:
 335         action_description = "execution";
 336         break;
 337
 338       case SIMIX_ACTION_PARALLEL_EXECUTE:
 339         action_description = "parallel execution";
 340         break;
 341
 342       case SIMIX_ACTION_COMMUNICATE:
 343         action_description = "communication";
 344         break;
 345
 346       case SIMIX_ACTION_SLEEP:
 347         action_description = "sleeping";
 348         break;
 349
 350       case SIMIX_ACTION_SYNCHRO:
 351         action_description = "synchronization";
 352         break;
 353
 354       case SIMIX_ACTION_IO:
 355         action_description = "I/O";
 356         break;
 357       }
 358       XBT_INFO("Process %lu (%s@%s): waiting for %s action %p (%s) in state %d to finish",
 359           process->pid, process->name, process->smx_host->name,
 360           action_description, process->waiting_action,
 361           process->waiting_action->name, (int)process->waiting_action->state);
 362     }
 363     else {
 364       XBT_INFO("Process %lu (%s@%s)", process->pid, process->name, process->smx_host->name);
 365     }
 366   }
 367 }
 368
 369 static void* SIMIX_action_mallocator_new_f(void) {
 370   smx_action_t action = xbt_new(s_smx_action_t, 1);
 371   action->simcalls = xbt_fifo_new();
 372   return action;
 373 }
 374
 375 static void SIMIX_action_mallocator_free_f(void* action) {
 376   xbt_fifo_free(((smx_action_t) action)->simcalls);
 377   xbt_free(action);
 378 }
 379
 380 static void SIMIX_action_mallocator_reset_f(void* action) {
 381
 382   // we also recycle the simcall list
 383   xbt_fifo_t fifo = ((smx_action_t) action)->simcalls;
 384   xbt_fifo_reset(fifo);
 385   memset(action, 0, sizeof(s_smx_action_t));
 386   ((smx_action_t) action)->simcalls = fifo;
 387 }