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 smx_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_smx_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->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 #ifdef HAVE_LATENCY_BOUND_TRACKING
  84     simix_global->latency_limited_dict = xbt_dict_new();
  85 #endif
  86
  87     surf_init(argc, argv);      /* Initialize SURF structures */
  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   }
 104   if (!simix_timers) {
 105     simix_timers = xbt_heap_new(8, &free);
 106   }
 107 }
 108
 109 /**
 110  * \brief Clean the SIMIX simulation
 111  *
 112  * This functions remove the memory used by SIMIX
 113  */
 114 void SIMIX_clean(void)
 115 {
 116   /* Kill everyone (except maestro) */
 117   SIMIX_process_killall();
 118
 119   /* Exit the SIMIX network module */
 120   SIMIX_network_exit();
 121
 122   /* Exit request mechanism */
 123   SIMIX_request_destroy();
 124
 125   xbt_heap_free(simix_timers);
 126   /* Free the remaining data structures */
 127   xbt_swag_free(simix_global->process_to_run);
 128   xbt_swag_free(simix_global->process_to_destroy);
 129   xbt_swag_free(simix_global->process_list);
 130   simix_global->process_list = NULL;
 131   simix_global->process_to_destroy = NULL;
 132   xbt_dict_free(&(simix_global->registered_functions));
 133   xbt_dict_free(&(simix_global->host));
 134
 135 #ifdef HAVE_LATENCY_BOUND_TRACKING
 136   xbt_dict_free(&(simix_global->latency_limited_dict));
 137 #endif
 138
 139   /* Let's free maestro now */
 140   SIMIX_context_free(simix_global->maestro_process->context);
 141   xbt_free(simix_global->maestro_process->running_ctx);
 142   xbt_free(simix_global->maestro_process);
 143   simix_global->maestro_process = NULL;
 144
 145   /* Restore the default exception setup */
 146   __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
 147   __xbt_ex_terminate = &__xbt_ex_terminate_default;
 148
 149   /* Finish context module and SURF */
 150   SIMIX_context_mod_exit();
 151
 152   surf_exit();
 153
 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   return surf_get_clock();
 169 }
 170
 171 void SIMIX_run(void)
 172 {
 173   double time = 0;
 174   smx_req_t req;
 175   xbt_swag_t set;
 176   surf_action_t action;
 177   smx_timer_t timer;
 178   surf_model_t model;
 179   unsigned int iter;
 180
 181   do {
 182     do {
 183       DEBUG0("New Schedule Round");
 184       SIMIX_context_runall(simix_global->process_to_run);
 185       while ((req = SIMIX_request_pop())) {
 186         DEBUG1("Handling request %p", req);
 187         SIMIX_request_pre(req);
 188       }
 189     } while (xbt_swag_size(simix_global->process_to_run));
 190
 191     time = surf_solve(SIMIX_timer_next());
 192
 193     /* Notify all the hosts that have failed */
 194     /* FIXME: iterate through the list of failed host and mark each of them */
 195     /* as failed. On each host, signal all the running processes with host_fail */
 196
 197     /* Handle any pending timer */
 198     while (xbt_heap_size(simix_timers) > 0 && SIMIX_get_clock() >= SIMIX_timer_next()) {
 199        //FIXME: make the timers being real callbacks
 200        // (i.e. provide dispatchers that read and expand the args)
 201        timer = xbt_heap_pop(simix_timers);
 202        if (timer->func)
 203          ((void (*)(void*))timer->func)(timer->args);
 204     }
 205     /* Wake up all process waiting for the action finish */
 206     xbt_dynar_foreach(model_list, iter, model) {
 207       for (set = model->states.failed_action_set;
 208            set;
 209            set = (set == model->states.failed_action_set)
 210                  ? model->states.done_action_set
 211                  : NULL) {
 212         while ((action = xbt_swag_extract(set)))
 213           SIMIX_request_post((smx_action_t) action->data);
 214       }
 215     }
 216   } while (time != -1.0);
 217
 218 }
 219
 220 /**
 221  *      \brief Set the date to execute a function
 222  *
 223  * Set the date to execute the function on the surf.
 224  *      \param date Date to execute function
 225  *      \param function Function to be executed
 226  *      \param arg Parameters of the function
 227  *
 228  */
 229 XBT_INLINE void SIMIX_timer_set(double date, void *function, void *arg)
 230 {
 231   smx_timer_t timer = xbt_new0(s_smx_timer_t, 1);
 232
 233   timer->date = date;
 234   timer->func = function;
 235   timer->args = arg;
 236   xbt_heap_push(simix_timers, timer, date);
 237 }
 238
 239 /**
 240  *      \brief Registers a function to create a process.
 241  *
 242  *      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.
 243  *      \param function Create process function
 244  *
 245  */
 246 XBT_INLINE void SIMIX_function_register_process_create(smx_creation_func_t
 247                                                        function)
 248 {
 249   xbt_assert0((simix_global->create_process_function == NULL),
 250               "Data already set");
 251
 252   simix_global->create_process_function = function;
 253 }
 254
 255 /**
 256  *      \brief Registers a function to kill a process.
 257  *
 258  *      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.
 259  *      \param function Kill process function
 260  *
 261  */
 262 XBT_INLINE void SIMIX_function_register_process_kill(void_f_pvoid_t
 263                                                      function)
 264 {
 265   xbt_assert0((simix_global->kill_process_function == NULL),
 266               "Data already set");
 267
 268   simix_global->kill_process_function = function;
 269 }
 270
 271 /**
 272  *      \brief Registers a function to cleanup a process.
 273  *
 274  *      This function registers an user function to be called when a new process ends properly.
 275  *      \param function cleanup process function
 276  *
 277  */
 278 XBT_INLINE void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t
 279                                                         function)
 280 {
 281   simix_global->cleanup_process_function = function;
 282 }
 283
 284
 285 void SIMIX_display_process_status(void)
 286 {
 287   if (simix_global->process_list == NULL) {
 288     return;
 289   }
 290
 291   /*smx_process_t process = NULL;
 292   xbt_fifo_item_t item = NULL;
 293   smx_action_t act;*/
 294   int nbprocess = xbt_swag_size(simix_global->process_list);
 295
 296   INFO1("%d processes are still running, waiting for something.", nbprocess);
 297   /*  List the process and their state */
 298   /* FIXME: reimplement me
 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     if (process->mutex) {
 315       who2 =
 316         bprintf("%s Blocked on mutex %p", who,
 317                 (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_verbose)) ?
 318                 process->mutex : (void *) 0xdead);
 319       free(who);
 320       who = who2;
 321     } else if (process->cond) {
 322       who2 =
 323         bprintf
 324         ("%s Blocked on condition %p; Waiting for the following actions:",
 325          who,
 326          (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_verbose)) ?
 327          process->cond : (void *) 0xdead);
 328       free(who);
 329       who = who2;
 330       xbt_fifo_foreach(process->cond->actions, item, act, smx_action_t) {
 331         who2 =
 332           bprintf("%s '%s'(%p)", who, act->name,
 333                   (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_verbose))
 334                   ? act : (void *) 0xdead);
 335         free(who);
 336         who = who2;
 337       }
 338     } else if (process->sem) {
 339       who2 =
 340         bprintf
 341         ("%s Blocked on semaphore %p; Waiting for the following actions:",
 342          who,
 343          (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_verbose)) ?
 344          process->sem : (void *) 0xdead);
 345       free(who);
 346       who = who2;
 347       xbt_fifo_foreach(process->sem->actions, item, act, smx_action_t) {
 348         who2 =
 349           bprintf("%s '%s'(%p)", who, act->name,
 350                   (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_verbose))
 351                   ? act : (void *) 0xdead);
 352         free(who);
 353         who = who2;
 354       }
 355
 356     } else {
 357       who2 =
 358         bprintf
 359         ("%s Blocked in an unknown status (please report this bug)", who);
 360       free(who);
 361       who = who2;
 362     }
 363     INFO1("%s.", who);
 364     free(who);
 365   }
 366   */
 367 }