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
  15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_kernel, msg,
  16                                 "Logging specific to MSG (kernel)");
  17
  18 MSG_Global_t msg_global = NULL;
  19
  20
  21 /** \defgroup msg_simulation   MSG simulation Functions
  22  *  \brief This section describes the functions you need to know to
  23  *  set up a simulation. You should have a look at \ref MSG_examples
  24  *  to have an overview of their usage.
  25  */
  26 /** @addtogroup msg_simulation
  27  *    \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Simulation functions" --> \endhtmlonly
  28  */
  29
  30 /********************************* MSG **************************************/
  31
  32 /** \ingroup msg_simulation
  33  * \brief Initialize some MSG internal data.
  34  */
  35 void MSG_global_init_args(int *argc, char **argv)
  36 {
  37   MSG_global_init(argc, argv);
  38 }
  39
  40
  41 XBT_LOG_EXTERNAL_CATEGORY(msg_gos);
  42 XBT_LOG_EXTERNAL_CATEGORY(msg_kernel);
  43 XBT_LOG_EXTERNAL_CATEGORY(msg_mailbox);
  44 XBT_LOG_EXTERNAL_CATEGORY(msg_process);
  45
  46 /** \ingroup msg_simulation
  47  * \brief Initialize some MSG internal data.
  48  */
  49 void MSG_global_init(int *argc, char **argv)
  50 {
  51 #ifdef HAVE_TRACING
  52   TRACE_global_init(argc, argv);
  53 #endif
  54
  55   xbt_getpid = MSG_process_self_PID;
  56   if (!msg_global) {
  57     /* Connect our log channels: that must be done manually under windows */
  58     XBT_LOG_CONNECT(msg_gos, msg);
  59     XBT_LOG_CONNECT(msg_kernel, msg);
  60     XBT_LOG_CONNECT(msg_mailbox, msg);
  61     XBT_LOG_CONNECT(msg_process, msg);
  62
  63     SIMIX_global_init(argc, argv);
  64
  65     msg_global = xbt_new0(s_MSG_Global_t, 1);
  66
  67     msg_global->max_channel = 0;
  68     msg_global->PID = 1;
  69     msg_global->sent_msg = 0;
  70     msg_global->task_copy_callback = NULL;
  71
  72     /* initialization of the action module */
  73     _MSG_action_init();
  74
  75     SIMIX_function_register_process_create(MSG_process_create_from_SIMIX);
  76     SIMIX_function_register_process_cleanup(MSG_process_cleanup_from_SIMIX);
  77     SIMIX_function_register_process_kill(MSG_process_kill_from_SIMIX);
  78     SIMIX_comm_set_copy_data_callback(MSG_comm_copy_data_from_SIMIX);
  79   }
  80 #ifdef HAVE_TRACING
  81   TRACE_start();
  82 #endif
  83
  84   XBT_DEBUG("ADD MSG LEVELS");
  85   MSG_HOST_LEVEL = xbt_lib_add_level(host_lib, (void_f_pvoid_t) __MSG_host_destroy);
  86 }
  87
  88 /** \defgroup m_channel_management    Understanding channels
  89  *  \brief This section briefly describes the channel notion of MSG
  90  *  (#m_channel_t).
  91  */
  92 /** @addtogroup m_channel_management
  93  *    \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Channels" --> \endhtmlonly
  94  *
  95  *
  96  *  For convenience, the simulator provides the notion of channel
  97  *  that is close to the tag notion in MPI. A channel is not a
  98  *  socket. It doesn't need to be opened neither closed. It rather
  99  *  corresponds to the ports opened on the different machines.
 100  */
 101
 102
 103 /** \ingroup m_channel_management
 104  * \brief Set the number of channel in the simulation.
 105  *
 106  * This function has to be called to fix the number of channel in the
 107    simulation before creating any host. Indeed, each channel is
 108    represented by a different mailbox on each #m_host_t. This
 109    function can then be called only once. This function takes only one
 110    parameter.
 111  * \param number the number of channel in the simulation. It has to be >0
 112  */
 113 MSG_error_t MSG_set_channel_number(int number)
 114 {
 115   xbt_assert((msg_global)
 116               && (msg_global->max_channel == 0),
 117               "Channel number already set!");
 118
 119   msg_global->max_channel = number;
 120
 121   return MSG_OK;
 122 }
 123
 124 /** \ingroup m_channel_management
 125  * \brief Return the number of channel in the simulation.
 126  *
 127  * This function has to be called once the number of channel is fixed. I can't
 128    figure out a reason why anyone would like to call this function but nevermind.
 129  * \return the number of channel in the simulation.
 130  */
 131 int MSG_get_channel_number(void)
 132 {
 133   xbt_assert((msg_global)
 134               && (msg_global->max_channel != 0),
 135               "Channel number not set yet!");
 136
 137   return msg_global->max_channel;
 138 }
 139
 140 /** \ingroup msg_simulation
 141  * \brief Launch the MSG simulation
 142  */
 143 MSG_error_t MSG_main(void)
 144 {
 145   /* Clean IO before the run */
 146   fflush(stdout);
 147   fflush(stderr);
 148
 149   if (MC_IS_ENABLED) {
 150     MC_modelcheck();
 151   }
 152   else {
 153     SIMIX_run();
 154   }
 155   return MSG_OK;
 156 }
 157
 158 MSG_error_t MSG_main_stateful(void)
 159 {
 160   /* Clean IO before the run */
 161   fflush(stdout);
 162   fflush(stderr);
 163
 164   if (MC_IS_ENABLED) {
 165     MC_modelcheck_stateful();
 166   }
 167   else {
 168     SIMIX_run();
 169   }
 170   return MSG_OK;
 171 }
 172
 173
 174 MSG_error_t MSG_main_liveness(xbt_automaton_t a, char *prgm)
 175 {
 176   /* Clean IO before the run */
 177   fflush(stdout);
 178   fflush(stderr);
 179
 180   if (MC_IS_ENABLED) {
 181     MC_modelcheck_liveness(a, prgm);
 182   }
 183   else {
 184     SIMIX_run();
 185   }
 186   return MSG_OK;
 187 }
 188
 189 /** \ingroup msg_simulation
 190  * \brief Kill all running process
 191
 192  * \param reset_PIDs should we reset the PID numbers. A negative
 193  *   number means no reset and a positive number will be used to set the PID
 194  *   of the next newly created process.
 195  */
 196 int MSG_process_killall(int reset_PIDs)
 197 {
 198   SIMIX_req_process_killall();
 199
 200   if (reset_PIDs > 0) {
 201     msg_global->PID = reset_PIDs;
 202     msg_global->session++;
 203   }
 204
 205   return msg_global->PID;
 206
 207 }
 208
 209 /** \ingroup msg_simulation
 210  * \brief Clean the MSG simulation
 211  */
 212 MSG_error_t MSG_clean(void)
 213 {
 214   XBT_DEBUG("Closing MSG");
 215
 216 #ifdef HAVE_TRACING
 217   TRACE_surf_release();
 218 #endif
 219
 220   MSG_process_killall(0);
 221
 222   /* initialization of the action module */
 223   _MSG_action_exit();
 224
 225 #ifdef HAVE_TRACING
 226   TRACE_end();
 227 #endif
 228
 229   SIMIX_clean();
 230
 231   free(msg_global);
 232   msg_global = NULL;
 233
 234   return MSG_OK;
 235 }
 236
 237
 238 /** \ingroup msg_easier_life
 239  * \brief A clock (in second).
 240  */
 241 XBT_INLINE double MSG_get_clock(void)
 242 {
 243   return SIMIX_get_clock();
 244 }
 245
 246 unsigned long int MSG_get_sent_msg()
 247 {
 248   return msg_global->sent_msg;
 249 }