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   INFO0("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 = NULL;
  84     simix_global->kill_process_function = NULL;
  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();
 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_free(simix_global);
 154   simix_global = NULL;
 155
 156   return;
 157 }
 158
 159
 160 /**
 161  * \brief A clock (in second).
 162  *
 163  * \return Return the clock.
 164  */
 165 XBT_INLINE double SIMIX_get_clock(void)
 166 {
 167   if(MC_IS_ENABLED){
 168     return MC_process_clock_get(SIMIX_process_self());
 169   }else{
 170     return surf_get_clock();
 171   }
 172 }
 173
 174 void SIMIX_run(void)
 175 {
 176   double time = 0;
 177   smx_req_t req;
 178   xbt_swag_t set;
 179   surf_action_t action;
 180   smx_timer_t timer;
 181   surf_model_t model;
 182   unsigned int iter;
 183
 184   do {
 185     DEBUG1("New Schedule Round; size(queue)=%lu",
 186         xbt_dynar_length(simix_global->process_to_run));
 187     do {
 188       DEBUG1("New Sub-Schedule Round; size(queue)=%lu",
 189               xbt_dynar_length(simix_global->process_to_run));
 190       SIMIX_context_runall(simix_global->process_to_run);
 191       while ((req = SIMIX_request_pop())) {
 192         DEBUG1("Handling request %p", req);
 193         SIMIX_request_pre(req, 0);
 194       }
 195     } while (xbt_dynar_length(simix_global->process_to_run));
 196
 197     time = surf_solve(SIMIX_timer_next());
 198
 199     /* Notify all the hosts that have failed */
 200     /* FIXME: iterate through the list of failed host and mark each of them */
 201     /* as failed. On each host, signal all the running processes with host_fail */
 202
 203     /* Handle any pending timer */
 204     while (xbt_heap_size(simix_timers) > 0 && SIMIX_get_clock() >= SIMIX_timer_next()) {
 205        //FIXME: make the timers being real callbacks
 206        // (i.e. provide dispatchers that read and expand the args)
 207        timer = xbt_heap_pop(simix_timers);
 208        if (timer->func)
 209          ((void (*)(void*))timer->func)(timer->args);
 210     }
 211     /* Wake up all process waiting for the action finish */
 212     xbt_dynar_foreach(model_list, iter, model) {
 213       for (set = model->states.failed_action_set;
 214            set;
 215            set = (set == model->states.failed_action_set)
 216                  ? model->states.done_action_set
 217                  : NULL) {
 218         while ((action = xbt_swag_extract(set)))
 219           SIMIX_request_post((smx_action_t) action->data);
 220       }
 221     }
 222   } while (time != -1.0);
 223
 224   if (xbt_swag_size(simix_global->process_list) != 0) {
 225
 226     WARN0("Oops ! Deadlock or code not perfectly clean.");
 227     SIMIX_display_process_status();
 228     xbt_abort();
 229   }
 230 }
 231
 232 /**
 233  *      \brief Set the date to execute a function
 234  *
 235  * Set the date to execute the function on the surf.
 236  *      \param date Date to execute function
 237  *      \param function Function to be executed
 238  *      \param arg Parameters of the function
 239  *
 240  */
 241 XBT_INLINE void SIMIX_timer_set(double date, void *function, void *arg)
 242 {
 243   smx_timer_t timer = xbt_new0(s_smx_timer_t, 1);
 244
 245   timer->date = date;
 246   timer->func = function;
 247   timer->args = arg;
 248   xbt_heap_push(simix_timers, timer, date);
 249 }
 250
 251 /**
 252  *      \brief Registers a function to create a process.
 253  *
 254  *      This function registers an user function to be called when a new process is created. The user function have to call the SIMIX_create_process function.
 255  *      \param function Create process function
 256  *
 257  */
 258 XBT_INLINE void SIMIX_function_register_process_create(smx_creation_func_t
 259                                                        function)
 260 {
 261   xbt_assert0((simix_global->create_process_function == NULL),
 262               "Data already set");
 263
 264   simix_global->create_process_function = function;
 265 }
 266
 267 /**
 268  *      \brief Registers a function to kill a process.
 269  *
 270  *      This function registers an user function to be called when a new process is killed. The user function have to call the SIMIX_kill_process function.
 271  *      \param function Kill process function
 272  *
 273  */
 274 XBT_INLINE void SIMIX_function_register_process_kill(void_f_pvoid_t
 275                                                      function)
 276 {
 277   xbt_assert0((simix_global->kill_process_function == NULL),
 278               "Data already set");
 279
 280   simix_global->kill_process_function = function;
 281 }
 282
 283 /**
 284  *      \brief Registers a function to cleanup a process.
 285  *
 286  *      This function registers an user function to be called when a new process ends properly.
 287  *      \param function cleanup process function
 288  *
 289  */
 290 XBT_INLINE void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t
 291                                                         function)
 292 {
 293   simix_global->cleanup_process_function = function;
 294 }
 295
 296
 297 void SIMIX_display_process_status(void)
 298 {
 299   if (simix_global->process_list == NULL) {
 300     return;
 301   }
 302
 303   smx_process_t process = NULL;
 304   int nbprocess = xbt_swag_size(simix_global->process_list);
 305
 306   INFO1("%d processes are still running, waiting for something.", nbprocess);
 307   /*  List the process and their state */
 308   INFO0
 309     ("Legend of the following listing: \"<process> on <host>: <status>.\"");
 310   xbt_swag_foreach(process, simix_global->process_list) {
 311
 312     if (process->waiting_action) {
 313
 314       const char* action_description = "unknown";
 315       switch (process->waiting_action->type) {
 316
 317         case SIMIX_ACTION_EXECUTE:
 318           action_description = "execution";
 319           break;
 320
 321         case SIMIX_ACTION_PARALLEL_EXECUTE:
 322           action_description = "parallel execution";
 323           break;
 324
 325         case SIMIX_ACTION_COMMUNICATE:
 326           action_description = "communication";
 327           break;
 328
 329         case SIMIX_ACTION_SLEEP:
 330           action_description = "sleeping";
 331           break;
 332
 333         case SIMIX_ACTION_SYNCHRO:
 334           action_description = "synchronization";
 335           break;
 336
 337         case SIMIX_ACTION_IO:
 338           action_description = "I/O";
 339           break;
 340       }
 341       INFO2("Waiting for %s action %p to finish", action_description, process->waiting_action);
 342     }
 343   }
 344 }
 345
 346 static void* SIMIX_action_mallocator_new_f(void) {
 347   smx_action_t action = xbt_new(s_smx_action_t, 1);
 348   action->request_list = xbt_fifo_new();
 349   return action;
 350 }
 351
 352 static void SIMIX_action_mallocator_free_f(void* action) {
 353   xbt_fifo_free(((smx_action_t) action)->request_list);
 354   xbt_free(action);
 355 }
 356
 357 static void SIMIX_action_mallocator_reset_f(void* action) {
 358
 359   // we also recycle the request list
 360   xbt_fifo_t fifo = ((smx_action_t) action)->request_list;
 361   xbt_fifo_reset(fifo);
 362   memset(action, 0, sizeof(s_smx_action_t));
 363   ((smx_action_t) action)->request_list = fifo;
 364 }