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