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 "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_action);
  17 XBT_LOG_EXTERNAL_CATEGORY(simix_deployment);
  18 XBT_LOG_EXTERNAL_CATEGORY(simix_environment);
  19 XBT_LOG_EXTERNAL_CATEGORY(simix_host);
  20 XBT_LOG_EXTERNAL_CATEGORY(simix_process);
  21 XBT_LOG_EXTERNAL_CATEGORY(simix_synchro);
  22 XBT_LOG_EXTERNAL_CATEGORY(simix_context);
  23 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_kernel, simix,
  24                                 "Logging specific to SIMIX (kernel)");
  25
  26 smx_global_t simix_global = NULL;
  27 static xbt_heap_t simix_timers = NULL;
  28
  29 static void* SIMIX_action_mallocator_new_f(void);
  30 static void SIMIX_action_mallocator_free_f(void* action);
  31 static void SIMIX_action_mallocator_reset_f(void* action);
  32
  33 extern void smx_ctx_raw_new_sr(void);
  34
  35 /* FIXME: Yeah, I'll do it in a portable maner one day [Mt] */
  36 #include <signal.h>
  37
  38 int _surf_do_verbose_exit = 1;
  39 static void _XBT_CALL inthandler(int ignored)
  40 {
  41   if ( _surf_do_verbose_exit ) {
  42      XBT_INFO("CTRL-C pressed. Displaying status and bailing out");
  43      SIMIX_display_process_status();
  44   }
  45   else {
  46      XBT_INFO("CTRL-C pressed. bailing out without displaying because verbose-exit disabled");
  47   }
  48   exit(1);
  49 }
  50
  51 /********************************* SIMIX **************************************/
  52
  53 XBT_INLINE double SIMIX_timer_next(void)
  54 {
  55   return xbt_heap_size(simix_timers) > 0 ? xbt_heap_maxkey(simix_timers) : -1.0;
  56 }
  57
  58 /**
  59  * \brief Initialize SIMIX internal data.
  60  *
  61  * \param argc Argc
  62  * \param argv Argv
  63  */
  64 void SIMIX_global_init(int *argc, char **argv)
  65 {
  66   s_smx_process_t proc;
  67
  68   if (!simix_global) {
  69     /* Connect our log channels: that must be done manually under windows */
  70     XBT_LOG_CONNECT(simix_action, simix);
  71     XBT_LOG_CONNECT(simix_deployment, simix);
  72     XBT_LOG_CONNECT(simix_environment, simix);
  73     XBT_LOG_CONNECT(simix_host, simix);
  74     XBT_LOG_CONNECT(simix_kernel, simix);
  75     XBT_LOG_CONNECT(simix_process, simix);
  76     XBT_LOG_CONNECT(simix_synchro, simix);
  77     XBT_LOG_CONNECT(simix_context, simix);
  78
  79     simix_global = xbt_new0(s_smx_global_t, 1);
  80
  81     simix_global->process_to_run = xbt_dynar_new(sizeof(void *), NULL);
  82     simix_global->process_list =
  83         xbt_swag_new(xbt_swag_offset(proc, process_hookup));
  84     simix_global->process_to_destroy =
  85         xbt_swag_new(xbt_swag_offset(proc, destroy_hookup));
  86
  87     simix_global->maestro_process = NULL;
  88     simix_global->registered_functions = xbt_dict_new();
  89
  90     simix_global->create_process_function = SIMIX_process_create;
  91     simix_global->kill_process_function = SIMIX_process_kill;
  92     simix_global->cleanup_process_function = SIMIX_process_cleanup;
  93     simix_global->action_mallocator = xbt_mallocator_new(65536,
  94         SIMIX_action_mallocator_new_f, SIMIX_action_mallocator_free_f,
  95         SIMIX_action_mallocator_reset_f);
  96
  97     surf_init(argc, argv);      /* Initialize SURF structures */
  98     SIMIX_context_mod_init();
  99     SIMIX_create_maestro_process();
 100
 101     /* context exception handlers */
 102     __xbt_running_ctx_fetch = SIMIX_process_get_running_context;
 103     __xbt_ex_terminate = SIMIX_process_exception_terminate;
 104
 105     /* Initialize request mechanism */
 106     SIMIX_request_init();
 107
 108     /* Initialize the SIMIX network module */
 109     SIMIX_network_init();
 110
 111     /* Prepare to display some more info when dying on Ctrl-C pressing */
 112     signal(SIGINT, inthandler);
 113   }
 114   if (!simix_timers) {
 115     simix_timers = xbt_heap_new(8, &free);
 116   }
 117
 118   XBT_DEBUG("ADD SIMIX LEVELS");
 119   SIMIX_HOST_LEVEL = xbt_lib_add_level(host_lib,SIMIX_host_destroy);
 120 }
 121
 122 /**
 123  * \brief Clean the SIMIX simulation
 124  *
 125  * This functions remove the memory used by SIMIX
 126  */
 127 void SIMIX_clean(void)
 128 {
 129 #ifdef TIME_BENCH
 130   smx_ctx_raw_new_sr();
 131 #endif
 132
 133   /* Kill everyone (except maestro) */
 134   SIMIX_process_killall(simix_global->maestro_process);
 135
 136   /* Exit the SIMIX network module */
 137   SIMIX_network_exit();
 138
 139   /* Exit request mechanism */
 140   SIMIX_request_destroy();
 141
 142   xbt_heap_free(simix_timers);
 143   /* Free the remaining data structures */
 144   xbt_dynar_free(&simix_global->process_to_run);
 145   xbt_swag_free(simix_global->process_to_destroy);
 146   xbt_swag_free(simix_global->process_list);
 147   simix_global->process_list = NULL;
 148   simix_global->process_to_destroy = NULL;
 149   xbt_dict_free(&(simix_global->registered_functions));
 150
 151   /* Let's free maestro now */
 152   SIMIX_context_free(simix_global->maestro_process->context);
 153   xbt_free(simix_global->maestro_process->running_ctx);
 154   xbt_free(simix_global->maestro_process);
 155   simix_global->maestro_process = NULL;
 156
 157   /* Restore the default exception setup */
 158   __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
 159   __xbt_ex_terminate = &__xbt_ex_terminate_default;
 160
 161   /* Finish context module and SURF */
 162   SIMIX_context_mod_exit();
 163
 164   surf_exit();
 165
 166   xbt_mallocator_free(simix_global->action_mallocator);
 167   xbt_free(simix_global);
 168   simix_global = NULL;
 169
 170   return;
 171 }
 172
 173
 174 /**
 175  * \brief A clock (in second).
 176  *
 177  * \return Return the clock.
 178  */
 179 XBT_INLINE double SIMIX_get_clock(void)
 180 {
 181   if(MC_IS_ENABLED){
 182     return MC_process_clock_get(SIMIX_process_self());
 183   }else{
 184     return surf_get_clock();
 185   }
 186 }
 187
 188 void SIMIX_run(void)
 189 {
 190   double time = 0;
 191   smx_req_t req;
 192   xbt_swag_t set;
 193   surf_action_t action;
 194   smx_timer_t timer;
 195   surf_model_t model;
 196   unsigned int iter;
 197
 198   do {
 199     XBT_DEBUG("New Schedule Round; size(queue)=%lu",
 200         xbt_dynar_length(simix_global->process_to_run));
 201 #ifdef TIME_BENCH
 202     smx_ctx_raw_new_sr();
 203 #endif
 204     do {
 205       XBT_DEBUG("New Sub-Schedule Round; size(queue)=%lu",
 206               xbt_dynar_length(simix_global->process_to_run));
 207       SIMIX_context_runall(simix_global->process_to_run);
 208       while ((req = SIMIX_request_pop())) {
 209         XBT_DEBUG("Handling request %p", req);
 210         SIMIX_request_pre(req, 0);
 211       }
 212     } while (xbt_dynar_length(simix_global->process_to_run));
 213
 214     time = surf_solve(SIMIX_timer_next());
 215
 216     /* Notify all the hosts that have failed */
 217     /* FIXME: iterate through the list of failed host and mark each of them */
 218     /* as failed. On each host, signal all the running processes with host_fail */
 219
 220     /* Handle any pending timer */
 221     while (xbt_heap_size(simix_timers) > 0 && SIMIX_get_clock() >= SIMIX_timer_next()) {
 222        //FIXME: make the timers being real callbacks
 223        // (i.e. provide dispatchers that read and expand the args)
 224        timer = xbt_heap_pop(simix_timers);
 225        if (timer->func)
 226          ((void (*)(void*))timer->func)(timer->args);
 227     }
 228     /* Wake up all process waiting for the action finish */
 229     xbt_dynar_foreach(model_list, iter, model) {
 230       for (set = model->states.failed_action_set;
 231            set;
 232            set = (set == model->states.failed_action_set)
 233                  ? model->states.done_action_set
 234                  : NULL) {
 235         while ((action = xbt_swag_extract(set)))
 236           SIMIX_request_post((smx_action_t) action->data);
 237       }
 238     }
 239   } while (time != -1.0);
 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> on <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("Waiting for %s action %p to finish", action_description, process->waiting_action);
 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->request_list = 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)->request_list);
 372   xbt_free(action);
 373 }
 374
 375 static void SIMIX_action_mallocator_reset_f(void* action) {
 376
 377   // we also recycle the request list
 378   xbt_fifo_t fifo = ((smx_action_t) action)->request_list;
 379   xbt_fifo_reset(fifo);
 380   memset(action, 0, sizeof(s_smx_action_t));
 381   ((smx_action_t) action)->request_list = fifo;
 382 }