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