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