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 #ifdef HAVE_TRACING
  64   TRACE_start();
  65 #endif
  66
  67   XBT_DEBUG("ADD MSG LEVELS");
  68   MSG_HOST_LEVEL = xbt_lib_add_level(host_lib, (void_f_pvoid_t) __MSG_host_destroy);
  69 }
  70
  71 #ifdef MSG_USE_DEPRECATED
  72
  73 /* This deprecated function has to be called to fix the number of channel in the
  74    simulation before creating any host. Indeed, each channel is
  75    represented by a different mailbox on each #m_host_t. This
  76    function can then be called only once. This function takes only one
  77    parameter.
  78  * \param number the number of channel in the simulation. It has to be >0
  79  */
  80 msg_error_t MSG_set_channel_number(int number)
  81 {
  82   XBT_WARN("DEPRECATED! Please use aliases instead");
  83   xbt_assert((msg_global)
  84               && (msg_global->max_channel == 0),
  85               "Channel number already set!");
  86
  87   msg_global->max_channel = number;
  88
  89   return MSG_OK;
  90 }
  91
  92 /* This deprecated function has to be called once the number of channel is fixed. I can't
  93    figure out a reason why anyone would like to call this function but nevermind.
  94  * \return the number of channel in the simulation.
  95  */
  96 int MSG_get_channel_number(void)
  97 {
  98   XBT_WARN("DEPRECATED! Please use aliases instead");
  99   xbt_assert((msg_global)
 100               && (msg_global->max_channel != 0),
 101               "Channel number not set yet!");
 102
 103   return msg_global->max_channel;
 104 }
 105 #endif
 106
 107 /** \ingroup msg_simulation
 108  * \brief Launch the MSG simulation
 109  */
 110 msg_error_t MSG_main(void)
 111 {
 112   /* Clean IO before the run */
 113   fflush(stdout);
 114   fflush(stderr);
 115
 116   if (MC_IS_ENABLED) {
 117     MC_do_the_modelcheck_for_real();
 118   } else {
 119     SIMIX_run();
 120   }
 121   return MSG_OK;
 122 }
 123
 124 /** \ingroup msg_simulation
 125  * \brief Kill all running process
 126
 127  * \param reset_PIDs should we reset the PID numbers. A negative
 128  *   number means no reset and a positive number will be used to set the PID
 129  *   of the next newly created process.
 130  */
 131 int MSG_process_killall(int reset_PIDs)
 132 {
 133   simcall_process_killall();
 134
 135   if (reset_PIDs > 0) {
 136     msg_global->PID = reset_PIDs;
 137     msg_global->session++;
 138   }
 139
 140   return msg_global->PID;
 141
 142 }
 143
 144 /** \ingroup msg_simulation
 145  * \brief Clean the MSG simulation
 146  */
 147 msg_error_t MSG_clean(void)
 148 {
 149   XBT_DEBUG("Closing MSG");
 150
 151 #ifdef HAVE_TRACING
 152   TRACE_surf_release();
 153 #endif
 154
 155   MSG_process_killall(0);
 156
 157   /* initialization of the action module */
 158   _MSG_action_exit();
 159
 160 #ifdef HAVE_TRACING
 161   TRACE_end();
 162 #endif
 163
 164   SIMIX_clean();
 165
 166   xbt_swag_free(msg_global->vms);
 167   free(msg_global);
 168   msg_global = NULL;
 169
 170   return MSG_OK;
 171 }
 172
 173
 174 /** \ingroup msg_simulation
 175  * \brief A clock (in second).
 176  */
 177 XBT_INLINE double MSG_get_clock(void)
 178 {
 179   return SIMIX_get_clock();
 180 }
 181
 182 unsigned long int MSG_get_sent_msg()
 183 {
 184   return msg_global->sent_msg;
 185 }