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