src/msg/msg_global.c

   1 /* Copyright (c) 2004, 2005, 2006, 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 "msg_private.h"
   8 #include "msg_mailbox.h"
   9 #include "mc/mc.h"
  10 #include "xbt/sysdep.h"
  11 #include "xbt/log.h"
  12 #include "xbt/virtu.h"
  13 #include "xbt/ex.h"             /* ex_backtrace_display */
  14 #include "xbt/replay.h"
  15
  16 XBT_LOG_NEW_CATEGORY(msg, "All MSG categories");
  17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_kernel, msg,
  18                                 "Logging specific to MSG (kernel)");
  19
  20 MSG_Global_t msg_global = NULL;
  21
  22 /********************************* MSG **************************************/
  23
  24 /* @brief Initialize MSG with less verifications
  25  *
  26  * You should use the MSG_init() function instead. Failing to do so may turn into PEBKAC some day. You've been warned.
  27  */
  28 void MSG_init_nocheck(int *argc, char **argv) {
  29
  30 #ifdef HAVE_TRACING
  31   TRACE_global_init(argc, argv);
  32 #endif
  33
  34   xbt_getpid = MSG_process_self_PID;
  35   if (!msg_global) {
  36     s_msg_vm_t vm; // to compute the offset
  37
  38     SIMIX_global_init(argc, argv);
  39
  40     msg_global = xbt_new0(s_MSG_Global_t, 1);
  41
  42 #ifdef MSG_USE_DEPRECATED
  43     msg_global->max_channel = 0;
  44 #endif
  45     msg_global->PID = 1;
  46     msg_global->sent_msg = 0;
  47     msg_global->task_copy_callback = NULL;
  48     msg_global->process_data_cleanup = NULL;
  49     msg_global->vms = xbt_swag_new(xbt_swag_offset(vm,all_vms_hookup));
  50
  51     /* initialization of the action module */
  52     _MSG_action_init();
  53
  54     SIMIX_function_register_process_create(MSG_process_create_from_SIMIX);
  55     SIMIX_function_register_process_cleanup(MSG_process_cleanup_from_SIMIX);
  56     SIMIX_function_register_process_kill(MSG_process_kill_from_SIMIX);
  57   }
  58 #ifdef HAVE_TRACING
  59   TRACE_start();
  60 #endif
  61
  62   XBT_DEBUG("ADD MSG LEVELS");
  63   MSG_HOST_LEVEL = xbt_lib_add_level(host_lib, (void_f_pvoid_t) __MSG_host_destroy);
  64 }
  65
  66 #ifdef MSG_USE_DEPRECATED
  67
  68 /* This deprecated function has to be called to fix the number of channel in the
  69    simulation before creating any host. Indeed, each channel is
  70    represented by a different mailbox on each #m_host_t. This
  71    function can then be called only once. This function takes only one
  72    parameter.
  73  * \param number the number of channel in the simulation. It has to be >0
  74  */
  75 MSG_error_t MSG_set_channel_number(int number)
  76 {
  77   XBT_WARN("DEPRECATED! Please use aliases instead");
  78   xbt_assert((msg_global)
  79               && (msg_global->max_channel == 0),
  80               "Channel number already set!");
  81
  82   msg_global->max_channel = number;
  83
  84   return MSG_OK;
  85 }
  86
  87 /* This deprecated function has to be called once the number of channel is fixed. I can't
  88    figure out a reason why anyone would like to call this function but nevermind.
  89  * \return the number of channel in the simulation.
  90  */
  91 int MSG_get_channel_number(void)
  92 {
  93   XBT_WARN("DEPRECATED! Please use aliases instead");
  94   xbt_assert((msg_global)
  95               && (msg_global->max_channel != 0),
  96               "Channel number not set yet!");
  97
  98   return msg_global->max_channel;
  99 }
 100 #endif
 101
 102 /** \ingroup msg_simulation
 103  * \brief Launch the MSG simulation
 104  */
 105 MSG_error_t MSG_main(void)
 106 {
 107   /* Clean IO before the run */
 108   fflush(stdout);
 109   fflush(stderr);
 110
 111   if (MC_IS_ENABLED) {
 112     MC_modelcheck();
 113   }
 114   else {
 115     SIMIX_run();
 116   }
 117   return MSG_OK;
 118 }
 119
 120 MSG_error_t MSG_main_stateful(void)
 121 {
 122   /* Clean IO before the run */
 123   fflush(stdout);
 124   fflush(stderr);
 125
 126   if (MC_IS_ENABLED) {
 127     MC_modelcheck_stateful();
 128   }
 129   else {
 130     SIMIX_run();
 131   }
 132   return MSG_OK;
 133 }
 134
 135
 136 MSG_error_t MSG_main_liveness(xbt_automaton_t a)
 137 {
 138   /* Clean IO before the run */
 139   fflush(stdout);
 140   fflush(stderr);
 141
 142   if (MC_IS_ENABLED) {
 143     MC_modelcheck_liveness(a);
 144   }
 145   else {
 146     SIMIX_run();
 147   }
 148   return MSG_OK;
 149 }
 150
 151 /** \ingroup msg_simulation
 152  * \brief Kill all running process
 153
 154  * \param reset_PIDs should we reset the PID numbers. A negative
 155  *   number means no reset and a positive number will be used to set the PID
 156  *   of the next newly created process.
 157  */
 158 int MSG_process_killall(int reset_PIDs)
 159 {
 160   simcall_process_killall();
 161
 162   if (reset_PIDs > 0) {
 163     msg_global->PID = reset_PIDs;
 164     msg_global->session++;
 165   }
 166
 167   return msg_global->PID;
 168
 169 }
 170
 171 /** \ingroup msg_simulation
 172  * \brief Clean the MSG simulation
 173  */
 174 MSG_error_t MSG_clean(void)
 175 {
 176   XBT_DEBUG("Closing MSG");
 177
 178 #ifdef HAVE_TRACING
 179   TRACE_surf_release();
 180 #endif
 181
 182   MSG_process_killall(0);
 183
 184   /* initialization of the action module */
 185   _MSG_action_exit();
 186
 187 #ifdef HAVE_TRACING
 188   TRACE_end();
 189 #endif
 190
 191   SIMIX_clean();
 192
 193   xbt_swag_free(msg_global->vms);
 194   free(msg_global);
 195   msg_global = NULL;
 196
 197   return MSG_OK;
 198 }
 199
 200
 201 /** \ingroup msg_simulation
 202  * \brief A clock (in second).
 203  */
 204 XBT_INLINE double MSG_get_clock(void)
 205 {
 206   return SIMIX_get_clock();
 207 }
 208
 209 unsigned long int MSG_get_sent_msg()
 210 {
 211   return msg_global->sent_msg;
 212 }