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