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