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 /**
  25  * \ingroup msg_simulation
  26  * \brief Initialize MSG with less verifications
  27  * You should use the MSG_init() function instead. Failing to do so may turn into PEBKAC some day. You've been warned.
  28  */
  29 void MSG_init_nocheck(int *argc, char **argv) {
  30
  31 #ifdef HAVE_TRACING
  32   TRACE_global_init(argc, argv);
  33 #endif
  34
  35   xbt_getpid = MSG_process_self_PID;
  36   if (!msg_global) {
  37     s_msg_vm_t vm; // to compute the offset
  38
  39     SIMIX_global_init(argc, argv);
  40
  41     msg_global = xbt_new0(s_MSG_Global_t, 1);
  42
  43 #ifdef MSG_USE_DEPRECATED
  44     msg_global->max_channel = 0;
  45 #endif
  46     msg_global->PID = 1;
  47     msg_global->sent_msg = 0;
  48     msg_global->task_copy_callback = NULL;
  49     msg_global->process_data_cleanup = NULL;
  50     msg_global->vms = xbt_swag_new(xbt_swag_offset(vm,all_vms_hookup));
  51
  52     if(MC_IS_ENABLED){
  53       /* Ignore total amount of messages sent during the simulation for heap comparison */
  54       MC_ignore(&(msg_global->sent_msg), sizeof(msg_global->sent_msg));
  55     }
  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
  63     sg_platf_postparse_add_cb(MSG_post_create_environment);
  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 #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_do_the_modelcheck_for_real();
 120   } else {
 121     SIMIX_run();
 122   }
 123   return MSG_OK;
 124 }
 125
 126 /** \ingroup msg_simulation
 127  * \brief Kill all running process
 128
 129  * \param reset_PIDs should we reset the PID numbers. A negative
 130  *   number means no reset and a positive number will be used to set the PID
 131  *   of the next newly created process.
 132  */
 133 int MSG_process_killall(int reset_PIDs)
 134 {
 135   simcall_process_killall();
 136
 137   if (reset_PIDs > 0) {
 138     msg_global->PID = reset_PIDs;
 139     msg_global->session++;
 140   }
 141
 142   return msg_global->PID;
 143
 144 }
 145
 146 /** \ingroup msg_simulation
 147  * \brief Clean the MSG simulation
 148  */
 149 msg_error_t MSG_clean(void)
 150 {
 151   XBT_DEBUG("Closing MSG");
 152
 153 #ifdef HAVE_TRACING
 154   TRACE_surf_release();
 155 #endif
 156
 157   MSG_process_killall(0);
 158
 159   /* initialization of the action module */
 160   _MSG_action_exit();
 161
 162 #ifdef HAVE_TRACING
 163   TRACE_end();
 164 #endif
 165
 166   SIMIX_clean();
 167
 168   xbt_swag_free(msg_global->vms);
 169   free(msg_global);
 170   msg_global = NULL;
 171
 172   return MSG_OK;
 173 }
 174
 175
 176 /** \ingroup msg_simulation
 177  * \brief A clock (in second).
 178  */
 179 XBT_INLINE double MSG_get_clock(void)
 180 {
 181   return SIMIX_get_clock();
 182 }
 183
 184 unsigned long int MSG_get_sent_msg()
 185 {
 186   return msg_global->sent_msg;
 187 }