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