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