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