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       /* Create list of elements to ignore for heap comparison algorithm */
  54       MC_ignore_init();
  55       /* Ignore total amount of messages sent during the simulation for heap comparison */
  56       MC_ignore(&(msg_global->sent_msg), sizeof(msg_global->sent_msg));
  57
  58     }
  59
  60     /* initialization of the action module */
  61     _MSG_action_init();
  62
  63     SIMIX_function_register_process_create(MSG_process_create_from_SIMIX);
  64     SIMIX_function_register_process_cleanup(MSG_process_cleanup_from_SIMIX);
  65   }
  66 #ifdef HAVE_TRACING
  67   TRACE_start();
  68 #endif
  69
  70   XBT_DEBUG("ADD MSG LEVELS");
  71   MSG_HOST_LEVEL = xbt_lib_add_level(host_lib, (void_f_pvoid_t) __MSG_host_destroy);
  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_do_the_modelcheck_for_real();
 121   } else {
 122     SIMIX_run();
 123   }
 124   return MSG_OK;
 125 }
 126
 127 /** \ingroup msg_simulation
 128  * \brief Kill all running process
 129
 130  * \param reset_PIDs should we reset the PID numbers. A negative
 131  *   number means no reset and a positive number will be used to set the PID
 132  *   of the next newly created process.
 133  */
 134 int MSG_process_killall(int reset_PIDs)
 135 {
 136   simcall_process_killall();
 137
 138   if (reset_PIDs > 0) {
 139     msg_global->PID = reset_PIDs;
 140     msg_global->session++;
 141   }
 142
 143   return msg_global->PID;
 144
 145 }
 146
 147 /** \ingroup msg_simulation
 148  * \brief Clean the MSG simulation
 149  */
 150 msg_error_t MSG_clean(void)
 151 {
 152   XBT_DEBUG("Closing MSG");
 153
 154 #ifdef HAVE_TRACING
 155   TRACE_surf_release();
 156 #endif
 157
 158   MSG_process_killall(0);
 159
 160   /* initialization of the action module */
 161   _MSG_action_exit();
 162
 163 #ifdef HAVE_TRACING
 164   TRACE_end();
 165 #endif
 166
 167   SIMIX_clean();
 168
 169   xbt_swag_free(msg_global->vms);
 170   free(msg_global);
 171   msg_global = NULL;
 172
 173   return MSG_OK;
 174 }
 175
 176
 177 /** \ingroup msg_simulation
 178  * \brief A clock (in second).
 179  */
 180 XBT_INLINE double MSG_get_clock(void)
 181 {
 182   return SIMIX_get_clock();
 183 }
 184
 185 unsigned long int MSG_get_sent_msg()
 186 {
 187   return msg_global->sent_msg;
 188 }