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
  14 XBT_LOG_EXTERNAL_CATEGORY(simix);
  15 XBT_LOG_EXTERNAL_CATEGORY(simix_action);
  16 XBT_LOG_EXTERNAL_CATEGORY(simix_deployment);
  17 XBT_LOG_EXTERNAL_CATEGORY(simix_environment);
  18 XBT_LOG_EXTERNAL_CATEGORY(simix_host);
  19 XBT_LOG_EXTERNAL_CATEGORY(simix_process);
  20 XBT_LOG_EXTERNAL_CATEGORY(simix_synchro);
  21 XBT_LOG_EXTERNAL_CATEGORY(simix_context);
  22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_kernel, simix,
  23                                 "Logging specific to SIMIX (kernel)");
  24
  25 SIMIX_Global_t simix_global = NULL;
  26 static xbt_heap_t simix_timers = NULL;
  27
  28 /* FIXME: Yeah, I'll do it in a portable maner one day [Mt] */
  29 #include <signal.h>
  30
  31 static void _XBT_CALL inthandler(int ignored)
  32 {
  33   INFO0("CTRL-C pressed. Displaying status and bailing out");
  34   SIMIX_display_process_status();
  35   exit(1);
  36 }
  37
  38 /********************************* SIMIX **************************************/
  39
  40 XBT_INLINE double SIMIX_timer_next(void)
  41 {
  42   return xbt_heap_size(simix_timers) > 0 ? xbt_heap_maxkey(simix_timers) : -1.0;
  43 }
  44
  45 /**
  46  * \brief Initialize SIMIX internal data.
  47  *
  48  * \param argc Argc
  49  * \param argv Argv
  50  */
  51 void SIMIX_global_init(int *argc, char **argv)
  52 {
  53   s_smx_process_t proc;
  54
  55   if (!simix_global) {
  56     /* Connect our log channels: that must be done manually under windows */
  57     XBT_LOG_CONNECT(simix_action, simix);
  58     XBT_LOG_CONNECT(simix_deployment, simix);
  59     XBT_LOG_CONNECT(simix_environment, simix);
  60     XBT_LOG_CONNECT(simix_host, simix);
  61     XBT_LOG_CONNECT(simix_kernel, simix);
  62     XBT_LOG_CONNECT(simix_process, simix);
  63     XBT_LOG_CONNECT(simix_synchro, simix);
  64     XBT_LOG_CONNECT(simix_context, simix);
  65
  66     simix_global = xbt_new0(s_SIMIX_Global_t, 1);
  67
  68     simix_global->host = xbt_dict_new();
  69     simix_global->process_to_run =
  70         xbt_swag_new(xbt_swag_offset(proc, synchro_hookup));
  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->current_process = NULL;
  77     simix_global->maestro_process = NULL;
  78     simix_global->registered_functions = xbt_dict_new();
  79
  80     simix_global->create_process_function = NULL;
  81     simix_global->kill_process_function = NULL;
  82     simix_global->cleanup_process_function = SIMIX_process_cleanup;
  83
  84 #ifdef HAVE_LATENCY_BOUND_TRACKING
  85     simix_global->latency_limited_dict = xbt_dict_new();
  86 #endif
  87
  88     SIMIX_context_mod_init();
  89     SIMIX_create_maestro_process();
  90
  91     /* context exception handlers */
  92     __xbt_running_ctx_fetch = SIMIX_process_get_running_context;
  93     __xbt_ex_terminate = SIMIX_process_exception_terminate;
  94
  95     /* Initialize request mechanism */
  96     SIMIX_request_init();
  97
  98     /* Initialize the SIMIX network module */
  99     SIMIX_network_init();
 100
 101     /* Prepare to display some more info when dying on Ctrl-C pressing */
 102     signal(SIGINT, inthandler);
 103     surf_init(argc, argv);      /* Initialize SURF structures */
 104   }
 105   if (!simix_timers) {
 106     simix_timers = xbt_heap_new(8, &free);
 107   }
 108 }
 109
 110 /**
 111  * \brief Clean the SIMIX simulation
 112  *
 113  * This functions remove the memory used by SIMIX
 114  */
 115 void SIMIX_clean(void)
 116 {
 117   /* Kill everyone (except maestro) */
 118   SIMIX_process_killall();
 119
 120   /* Exit the SIMIX network module */
 121   SIMIX_network_exit();
 122
 123   /* Exit request mechanism */
 124   SIMIX_request_destroy();
 125
 126   xbt_heap_free(simix_timers);
 127   /* Free the remaining data structures */
 128   xbt_swag_free(simix_global->process_to_run);
 129   xbt_swag_free(simix_global->process_to_destroy);
 130   xbt_swag_free(simix_global->process_list);
 131   simix_global->process_list = NULL;
 132   simix_global->process_to_destroy = NULL;
 133   xbt_dict_free(&(simix_global->registered_functions));
 134   xbt_dict_free(&(simix_global->host));
 135
 136 #ifdef HAVE_LATENCY_BOUND_TRACKING
 137   xbt_dict_free(&(simix_global->latency_limited_dict));
 138 #endif
 139
 140   /* Let's free maestro now */
 141   SIMIX_context_free(simix_global->maestro_process->context);
 142   xbt_free(simix_global->maestro_process->running_ctx);
 143   xbt_free(simix_global->maestro_process);
 144   simix_global->maestro_process = NULL;
 145
 146   /* Restore the default exception setup */
 147   __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
 148   __xbt_ex_terminate = &__xbt_ex_terminate_default;
 149
 150   /* Finish context module and SURF */
 151   SIMIX_context_mod_exit();
 152
 153   surf_exit();
 154
 155   xbt_free(simix_global);
 156   simix_global = NULL;
 157
 158   return;
 159 }
 160
 161
 162 /**
 163  * \brief A clock (in second).
 164  *
 165  * \return Return the clock.
 166  */
 167 XBT_INLINE double SIMIX_get_clock(void)
 168 {
 169   return surf_get_clock();
 170 }
 171
 172 void SIMIX_run(void)
 173 {
 174   double time = 0;
 175   smx_req_t req;
 176   xbt_swag_t set;
 177   surf_action_t action;
 178   smx_timer_t timer;
 179   surf_model_t model;
 180   unsigned int iter;
 181
 182   do {
 183     do {
 184       DEBUG0("New Schedule Round");
 185       SIMIX_context_runall(simix_global->process_to_run);
 186       while((req = SIMIX_request_pop())){
 187         DEBUG1("Handling request %p", req);
 188         SIMIX_request_pre(req);
 189       }
 190     } while (xbt_swag_size(simix_global->process_to_run));
 191
 192     time = surf_solve(SIMIX_timer_next());
 193
 194     /* Notify all the hosts that have failed */
 195     /* FIXME: iterate through the list of failed host and mark each of them */
 196     /* as failed. On each host, signal all the running processes with host_fail */
 197
 198     /* Handle any pending timer */
 199     while (xbt_heap_size(simix_timers) > 0 && SIMIX_get_clock() >= SIMIX_timer_next()) {
 200        //FIXME: make the timers being real callbacks
 201        // (i.e. provide dispatchers that read and expand the args)
 202        timer = xbt_heap_pop(simix_timers);
 203        if (timer->func)
 204          ((void (*)(void*))timer->func)(timer->args);
 205     }
 206     /* Wake up all process waiting for the action finish */
 207     xbt_dynar_foreach(model_list, iter, model) {
 208       for(set = model->states.failed_action_set;
 209           set;
 210           set = (set == model->states.failed_action_set)
 211                 ? model->states.done_action_set
 212                 : NULL) {
 213         while ((action = xbt_swag_extract(set)))
 214           SIMIX_request_post((smx_action_t)action->data);
 215       }
 216     }
 217   } while(time != -1.0);
 218
 219 }
 220
 221 /**
 222  *      \brief Set the date to execute a function
 223  *
 224  * Set the date to execute the function on the surf.
 225  *      \param date Date to execute function
 226  *      \param function Function to be executed
 227  *      \param arg Parameters of the function
 228  *
 229  */
 230 XBT_INLINE void SIMIX_timer_set(double date, void *function, void *arg)
 231 {
 232   smx_timer_t timer = xbt_new0(s_smx_timer_t, 1);
 233
 234   timer->date = date;
 235   timer->func = function;
 236   timer->args = arg;
 237   xbt_heap_push(simix_timers, timer, date);
 238 }
 239
 240 /**
 241  *      \brief Registers a function to create a process.
 242  *
 243  *      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.
 244  *      \param function Create process function
 245  *
 246  */
 247 XBT_INLINE void SIMIX_function_register_process_create(smx_creation_func_t
 248                                                        function)
 249 {
 250   xbt_assert0((simix_global->create_process_function == NULL),
 251               "Data already set");
 252
 253   simix_global->create_process_function = function;
 254 }
 255
 256 /**
 257  *      \brief Registers a function to kill a process.
 258  *
 259  *      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.
 260  *      \param function Kill process function
 261  *
 262  */
 263 XBT_INLINE void SIMIX_function_register_process_kill(void_f_pvoid_t
 264                                                      function)
 265 {
 266   xbt_assert0((simix_global->kill_process_function == NULL),
 267               "Data already set");
 268
 269   simix_global->kill_process_function = function;
 270 }
 271
 272 /**
 273  *      \brief Registers a function to cleanup a process.
 274  *
 275  *      This function registers an user function to be called when a new process ends properly.
 276  *      \param function cleanup process function
 277  *
 278  */
 279 XBT_INLINE void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t
 280                                                         function)
 281 {
 282   simix_global->cleanup_process_function = function;
 283 }
 284
 285
 286 void SIMIX_display_process_status(void)
 287 {
 288   if (simix_global->process_list == NULL) {
 289     return;
 290   }
 291
 292   smx_process_t process = NULL;
 293   /*xbt_fifo_item_t item = NULL;
 294   smx_action_t act;*/
 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     char *who, *who2;
 303
 304     asprintf(&who, "%s on %s: %s",
 305              process->name,
 306              process->smx_host->name,
 307              (process->blocked) ? "[BLOCKED] "
 308              : ((process->suspended) ? "[SUSPENDED] " : ""));
 309
 310     if (process->waiting_action) {
 311       who2 = bprintf("Waiting for action %p to finish", process->waiting_action);
 312     }
 313
 314       /*
 315     if (process->mutex) {
 316       who2 =
 317         bprintf("%s Blocked on mutex %p", who,
 318                 (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_verbose)) ?
 319                 process->mutex : (void *) 0xdead);
 320       free(who);
 321       who = who2;
 322     } else if (process->cond) {
 323       who2 =
 324         bprintf
 325         ("%s Blocked on condition %p; Waiting for the following actions:",
 326          who,
 327          (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_verbose)) ?
 328          process->cond : (void *) 0xdead);
 329       free(who);
 330       who = who2;
 331       xbt_fifo_foreach(process->cond->actions, item, act, smx_action_t) {
 332         who2 =
 333           bprintf("%s '%s'(%p)", who, act->name,
 334                   (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_verbose))
 335                   ? act : (void *) 0xdead);
 336         free(who);
 337         who = who2;
 338       }
 339     } else if (process->sem) {
 340       who2 =
 341         bprintf
 342         ("%s Blocked on semaphore %p; Waiting for the following actions:",
 343          who,
 344          (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_verbose)) ?
 345          process->sem : (void *) 0xdead);
 346       free(who);
 347       who = who2;
 348       xbt_fifo_foreach(process->sem->actions, item, act, smx_action_t) {
 349         who2 =
 350           bprintf("%s '%s'(%p)", who, act->name,
 351                   (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_verbose))
 352                   ? act : (void *) 0xdead);
 353         free(who);
 354         who = who2;
 355       }
 356
 357     } else {
 358       who2 =
 359         bprintf
 360         ("%s Blocked in an unknown status (please report this bug)", who);
 361       free(who);
 362       who = who2;
 363     }
 364     */
 365     INFO1("%s.", who);
 366     free(who);
 367   }
 368 }