src/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 "mc/mc.h"
   9 #include "xbt/sysdep.h"
  10 #include "xbt/log.h"
  11 #include "xbt/virtu.h"
  12 #include "xbt/ex.h"             /* ex_backtrace_display */
  13 #include "mailbox.h"
  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->host = xbt_fifo_new();
  68     msg_global->process_list = xbt_fifo_new();
  69     msg_global->max_channel = 0;
  70     msg_global->PID = 1;
  71     msg_global->sent_msg = 0;
  72
  73     /* initialization of the action module */
  74     _MSG_action_init();
  75
  76     SIMIX_function_register_process_create(_MSG_process_create_from_SIMIX);
  77     SIMIX_function_register_process_cleanup(__MSG_process_cleanup);
  78     SIMIX_function_register_process_kill(_MSG_process_kill_from_SIMIX);
  79   }
  80 #ifdef HAVE_TRACING
  81   TRACE_start();
  82 #endif
  83 }
  84
  85 /** \defgroup m_channel_management    Understanding channels
  86  *  \brief This section briefly describes the channel notion of MSG
  87  *  (#m_channel_t).
  88  */
  89 /** @addtogroup m_channel_management
  90  *    \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Channels" --> \endhtmlonly
  91  *
  92  *
  93  *  For convenience, the simulator provides the notion of channel
  94  *  that is close to the tag notion in MPI. A channel is not a
  95  *  socket. It doesn't need to be opened neither closed. It rather
  96  *  corresponds to the ports opened on the different machines.
  97  */
  98
  99
 100 /** \ingroup m_channel_management
 101  * \brief Set the number of channel in the simulation.
 102  *
 103  * This function has to be called to fix the number of channel in the
 104    simulation before creating any host. Indeed, each channel is
 105    represented by a different mailbox on each #m_host_t. This
 106    function can then be called only once. This function takes only one
 107    parameter.
 108  * \param number the number of channel in the simulation. It has to be >0
 109  */
 110 MSG_error_t MSG_set_channel_number(int number)
 111 {
 112   xbt_assert0((msg_global)
 113               && (msg_global->max_channel == 0),
 114               "Channel number already set!");
 115
 116   msg_global->max_channel = number;
 117
 118   return MSG_OK;
 119 }
 120
 121 /** \ingroup m_channel_management
 122  * \brief Return the number of channel in the simulation.
 123  *
 124  * This function has to be called once the number of channel is fixed. I can't
 125    figure out a reason why anyone would like to call this function but nevermind.
 126  * \return the number of channel in the simulation.
 127  */
 128 int MSG_get_channel_number(void)
 129 {
 130   xbt_assert0((msg_global)
 131               && (msg_global->max_channel != 0),
 132               "Channel number not set yet!");
 133
 134   return msg_global->max_channel;
 135 }
 136
 137 /** \ingroup msg_simulation
 138  * \brief Launch the MSG simulation
 139  */
 140 MSG_error_t MSG_main(void)
 141 {
 142   /* Clean IO before the run */
 143   fflush(stdout);
 144   fflush(stderr);
 145
 146   if (MC_IS_ENABLED) {
 147     MC_modelcheck();
 148   }
 149   else {
 150     SIMIX_run();
 151   }
 152   return MSG_OK;
 153 }
 154
 155 /** \ingroup msg_simulation
 156  * \brief Kill all running process
 157
 158  * \param reset_PIDs should we reset the PID numbers. A negative
 159  *   number means no reset and a positive number will be used to set the PID
 160  *   of the next newly created process.
 161  */
 162 int MSG_process_killall(int reset_PIDs)
 163 {
 164   m_process_t p = NULL;
 165   m_process_t self = MSG_process_self();
 166
 167   while ((p = xbt_fifo_pop(msg_global->process_list))) {
 168     if (p != self)
 169       MSG_process_kill(p);
 170   }
 171
 172   if (reset_PIDs > 0) {
 173     msg_global->PID = reset_PIDs;
 174     msg_global->session++;
 175   }
 176
 177   return msg_global->PID;
 178
 179 }
 180
 181 /** \ingroup msg_simulation
 182  * \brief Clean the MSG simulation
 183  */
 184 MSG_error_t MSG_clean(void)
 185 {
 186   xbt_fifo_item_t i = NULL;
 187   m_host_t h = NULL;
 188   m_process_t p = NULL;
 189
 190 #ifdef HAVE_TRACING
 191   TRACE_surf_release();
 192 #endif
 193
 194   while ((p = xbt_fifo_pop(msg_global->process_list))) {
 195     MSG_process_kill(p);
 196   }
 197
 198   xbt_fifo_foreach(msg_global->host, i, h, m_host_t) {
 199     __MSG_host_destroy(h);
 200   }
 201   xbt_fifo_free(msg_global->host);
 202   xbt_fifo_free(msg_global->process_list);
 203
 204   free(msg_global);
 205   msg_global = NULL;
 206
 207   /* initialization of the action module */
 208   _MSG_action_exit();
 209
 210 #ifdef HAVE_TRACING
 211   TRACE_end();
 212 #endif
 213
 214   SIMIX_clean();
 215
 216   return MSG_OK;
 217 }
 218
 219
 220 /** \ingroup msg_easier_life
 221  * \brief A clock (in second).
 222  */
 223 XBT_INLINE double MSG_get_clock(void)
 224 {
 225   return SIMIX_get_clock();
 226 }
 227
 228 unsigned long int MSG_get_sent_msg()
 229 {
 230   return msg_global->sent_msg;
 231 }