src/msg/global.c

   1 /*     $Id$      */
   2
   3 /* Copyright (c) 2002-2007 Arnaud Legrand.                                  */
   4 /* Copyright (c) 2007 Bruno Donassolo.                                      */
   5 /* All rights reserved.                                                     */
   6
   7 /* This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the license (GNU LGPL) which comes with this package. */
   9
  10 #include "msg/private.h"
  11 #include "xbt/sysdep.h"
  12 #include "xbt/log.h"
  13 #include "xbt/virtu.h"
  14 #include "xbt/ex.h"             /* ex_backtrace_display */
  15 #include "mailbox.h"
  16
  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
  23 /** \defgroup msg_simulation   MSG simulation Functions
  24  *  \brief This section describes the functions you need to know to
  25  *  set up a simulation. You should have a look at \ref MSG_examples
  26  *  to have an overview of their usage.
  27  */
  28 /** @addtogroup msg_simulation
  29  *    \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Simulation functions" --> \endhtmlonly
  30  */
  31
  32 /********************************* MSG **************************************/
  33
  34 /** \ingroup msg_simulation
  35  * \brief Initialize some MSG internal data.
  36  */
  37 void MSG_global_init_args(int *argc, char **argv)
  38 {
  39   MSG_global_init(argc, argv);
  40 }
  41
  42
  43 XBT_LOG_EXTERNAL_CATEGORY(msg_gos);
  44 XBT_LOG_EXTERNAL_CATEGORY(msg_kernel);
  45 XBT_LOG_EXTERNAL_CATEGORY(msg_mailbox);
  46 XBT_LOG_EXTERNAL_CATEGORY(msg_process);
  47
  48 /** \ingroup msg_simulation
  49  * \brief Initialize some MSG internal data.
  50  */
  51 void MSG_global_init(int *argc, char **argv)
  52 {
  53   xbt_getpid = MSG_process_self_PID;
  54   if (!msg_global) {
  55     /* Connect our log channels: that must be done manually under windows */
  56     XBT_LOG_CONNECT(msg_gos, msg);
  57     XBT_LOG_CONNECT(msg_kernel, msg);
  58     XBT_LOG_CONNECT(msg_mailbox, msg);
  59     XBT_LOG_CONNECT(msg_process, msg);
  60
  61     SIMIX_global_init(argc, argv);
  62
  63     msg_global = xbt_new0(s_MSG_Global_t, 1);
  64
  65     msg_global->host = xbt_fifo_new();
  66     msg_global->process_list = xbt_fifo_new();
  67     msg_global->max_channel = 0;
  68     msg_global->PID = 1;
  69
  70         /* initialization of the mailbox module */
  71         MSG_mailbox_mod_init();
  72
  73     SIMIX_function_register_process_create(_MSG_process_create_from_SIMIX);
  74     SIMIX_function_register_process_cleanup(__MSG_process_cleanup);
  75     SIMIX_function_register_process_kill(_MSG_process_kill_from_SIMIX);
  76   }
  77   return;
  78 }
  79
  80 /** \ingroup msg_easier_life
  81  * \brief Traces MSG events in the Paje format.
  82  */
  83
  84 void MSG_paje_output(const char *filename)
  85 {
  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_assert0((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_assert0((msg_global)
 134               && (msg_global->max_channel != 0),
 135               "Channel number not set yet!");
 136
 137   return msg_global->max_channel;
 138 }
 139
 140 void __MSG_display_process_status(void)
 141 {
 142 }
 143
 144
 145 /* FIXME: Yeah, I'll do it in a portable maner one day [Mt] */
 146 #include <signal.h>
 147
 148 static void _XBT_CALL inthandler(int ignored)
 149 {
 150   INFO0("CTRL-C pressed. Displaying status and bailing out");
 151   __MSG_display_process_status();
 152   exit(1);
 153 }
 154
 155 /** \ingroup msg_simulation
 156  * \brief Launch the MSG simulation
 157  */
 158 MSG_error_t MSG_main(void)
 159 {
 160   smx_cond_t cond = NULL;
 161   smx_action_t smx_action;
 162   xbt_fifo_t actions_done = xbt_fifo_new();
 163   xbt_fifo_t actions_failed = xbt_fifo_new();
 164
 165   /* Prepare to display some more info when dying on Ctrl-C pressing */
 166   signal(SIGINT, inthandler);
 167
 168   /* Clean IO before the run */
 169   fflush(stdout);
 170   fflush(stderr);
 171   SIMIX_init();
 172
 173   //surf_solve(); /* Takes traces into account. Returns 0.0 */
 174   /* xbt_fifo_size(msg_global->process_to_run) */
 175
 176   while (SIMIX_solve(actions_done, actions_failed) != -1.0) {
 177
 178     while ((smx_action = xbt_fifo_pop(actions_failed))) {
 179
 180
 181       DEBUG1("** %s failed **", smx_action->name);
 182       while ((cond = xbt_fifo_pop(smx_action->cond_list))) {
 183         SIMIX_cond_broadcast(cond);
 184       }
 185     }
 186
 187     while ((smx_action = xbt_fifo_pop(actions_done))) {
 188
 189       DEBUG1("** %s done **", smx_action->name);
 190       while ((cond = xbt_fifo_pop(smx_action->cond_list))) {
 191         SIMIX_cond_broadcast(cond);
 192       }
 193     }
 194   }
 195   xbt_fifo_free(actions_failed);
 196   xbt_fifo_free(actions_done);
 197   return MSG_OK;
 198 }
 199
 200 /** \ingroup msg_simulation
 201  * \brief Kill all running process
 202
 203  * \param reset_PIDs should we reset the PID numbers. A negative
 204  *   number means no reset and a positive number will be used to set the PID
 205  *   of the next newly created process.
 206  */
 207 int MSG_process_killall(int reset_PIDs)
 208 {
 209   m_process_t p = NULL;
 210   m_process_t self = MSG_process_self();
 211
 212   while ((p = xbt_fifo_pop(msg_global->process_list))) {
 213     if (p != self)
 214       MSG_process_kill(p);
 215   }
 216
 217   if (reset_PIDs > 0) {
 218     msg_global->PID = reset_PIDs;
 219     msg_global->session++;
 220   }
 221
 222   return msg_global->PID;
 223
 224 }
 225
 226 /** \ingroup msg_simulation
 227  * \brief Clean the MSG simulation
 228  */
 229 MSG_error_t MSG_clean(void)
 230 {
 231   xbt_fifo_item_t i = NULL;
 232   m_host_t h = NULL;
 233   m_process_t p = NULL;
 234
 235
 236   while ((p = xbt_fifo_pop(msg_global->process_list))) {
 237     MSG_process_kill(p);
 238   }
 239
 240   xbt_fifo_foreach(msg_global->host, i, h, m_host_t) {
 241     __MSG_host_destroy(h);
 242   }
 243   xbt_fifo_free(msg_global->host);
 244   xbt_fifo_free(msg_global->process_list);
 245
 246   free(msg_global);
 247   msg_global = NULL;
 248
 249   /* cleanup all resources in the mailbox module */
 250   MSG_mailbox_mod_exit();
 251
 252   SIMIX_clean();
 253
 254
 255
 256   return MSG_OK;
 257 }
 258
 259
 260 /** \ingroup msg_easier_life
 261  * \brief A clock (in second).
 262  */
 263 double MSG_get_clock(void)
 264 {
 265   return SIMIX_get_clock();
 266 }