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