src/msg/msg_global.c

   1 /* Copyright (c) 2004-2012. The SimGrid Team.  All rights reserved.         */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "instr/instr_interface.h"
   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 #include "simgrid/sg_config.h" /* Configuration mechanism of SimGrid */
  16
  17
  18 XBT_LOG_NEW_CATEGORY(msg, "All MSG categories");
  19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_kernel, msg,
  20                                 "Logging specific to MSG (kernel)");
  21
  22 MSG_Global_t msg_global = NULL;
  23 static void MSG_exit(void);
  24
  25 /********************************* MSG **************************************/
  26
  27 /**
  28  * \ingroup msg_simulation
  29  * \brief Initialize MSG with less verifications
  30  * You should use the MSG_init() function instead. Failing to do so may turn into PEBKAC some day. You've been warned.
  31  */
  32 void MSG_init_nocheck(int *argc, char **argv) {
  33
  34 #ifdef HAVE_TRACING
  35   TRACE_global_init(argc, argv);
  36 #endif
  37
  38   xbt_getpid = MSG_process_self_PID;
  39   if (!msg_global) {
  40  //   s_msg_vm_t vm; // to compute the offset
  41
  42     SIMIX_global_init(argc, argv);
  43
  44     msg_global = xbt_new0(s_MSG_Global_t, 1);
  45
  46 #ifdef MSG_USE_DEPRECATED
  47     msg_global->max_channel = 0;
  48 #endif
  49     msg_global->PID = 1;
  50     msg_global->sent_msg = 0;
  51     msg_global->task_copy_callback = NULL;
  52     msg_global->process_data_cleanup = NULL;
  53 //    msg_global->vms = xbt_swag_new(xbt_swag_offset(vm,all_vms_hookup));
  54
  55     /* initialization of the action module */
  56     _MSG_action_init();
  57
  58     SIMIX_function_register_process_create(MSG_process_create_from_SIMIX);
  59     SIMIX_function_register_process_cleanup(MSG_process_cleanup_from_SIMIX);
  60
  61     sg_platf_postparse_add_cb(MSG_post_create_environment);
  62   }
  63
  64   if(MC_is_active()){
  65     /* Ignore total amount of messages sent during the simulation for heap comparison */
  66     MC_ignore_heap(&(msg_global->sent_msg), sizeof(msg_global->sent_msg));
  67   }
  68
  69 #ifdef HAVE_TRACING
  70   TRACE_start();
  71 #endif
  72
  73   XBT_DEBUG("ADD MSG LEVELS");
  74   MSG_HOST_LEVEL = xbt_lib_add_level(host_lib, (void_f_pvoid_t) __MSG_host_destroy);
  75
  76   atexit(MSG_exit);
  77 }
  78
  79 #ifdef MSG_USE_DEPRECATED
  80
  81 /* This deprecated function has to be called to fix the number of channel in the
  82    simulation before creating any host. Indeed, each channel is
  83    represented by a different mailbox on each #m_host_t. This
  84    function can then be called only once. This function takes only one
  85    parameter.
  86  * \param number the number of channel in the simulation. It has to be >0
  87  */
  88 msg_error_t MSG_set_channel_number(int number)
  89 {
  90   XBT_WARN("DEPRECATED! Please use aliases instead");
  91   xbt_assert((msg_global)
  92               && (msg_global->max_channel == 0),
  93               "Channel number already set!");
  94
  95   msg_global->max_channel = number;
  96
  97   return MSG_OK;
  98 }
  99
 100 /* This deprecated function has to be called once the number of channel is fixed. I can't
 101    figure out a reason why anyone would like to call this function but nevermind.
 102  * \return the number of channel in the simulation.
 103  */
 104 int MSG_get_channel_number(void)
 105 {
 106   XBT_WARN("DEPRECATED! Please use aliases instead");
 107   xbt_assert((msg_global)
 108               && (msg_global->max_channel != 0),
 109               "Channel number not set yet!");
 110
 111   return msg_global->max_channel;
 112 }
 113 #endif
 114
 115 /** \ingroup msg_simulation
 116  * \brief Launch the MSG simulation
 117  */
 118 msg_error_t MSG_main(void)
 119 {
 120   /* Clean IO before the run */
 121   fflush(stdout);
 122   fflush(stderr);
 123
 124   if (MC_is_active()) {
 125     MC_do_the_modelcheck_for_real();
 126   } else {
 127     SIMIX_run();
 128   }
 129   return MSG_OK;
 130 }
 131
 132 /** \ingroup msg_simulation
 133  * \brief set a configuration variable
 134  *
 135  * Do --help on any simgrid binary to see the list of currently existing configuration variables, and see Section @ref options.
 136  *
 137  * Example:
 138  * MSG_config("workstation/model","KCCFLN05");
 139  */
 140 void MSG_config(const char *key, const char *value){
 141   xbt_assert(msg_global,"ERROR: Please call MSG_init() before using MSG_config()");
 142   xbt_cfg_set_as_string(_sg_cfg_set, key, value);
 143 }
 144
 145
 146 /** \ingroup msg_simulation
 147  * \brief Kill all running process
 148
 149  * \param reset_PIDs should we reset the PID numbers. A negative
 150  *   number means no reset and a positive number will be used to set the PID
 151  *   of the next newly created process.
 152  */
 153 int MSG_process_killall(int reset_PIDs)
 154 {
 155   simcall_process_killall();
 156
 157   if (reset_PIDs > 0) {
 158     msg_global->PID = reset_PIDs;
 159     msg_global->session++;
 160   }
 161
 162   return msg_global->PID;
 163
 164 }
 165
 166 static void MSG_exit(void) {
 167   if (msg_global==NULL)
 168     return;
 169
 170 #ifdef HAVE_TRACING
 171   TRACE_surf_resource_utilization_release();
 172 #endif
 173
 174   /* initialization of the action module */
 175   _MSG_action_exit();
 176
 177 #ifdef HAVE_TRACING
 178   TRACE_end();
 179 #endif
 180
 181   xbt_swag_free(msg_global->vms);
 182   free(msg_global);
 183   msg_global = NULL;
 184 }
 185
 186
 187 /** \ingroup msg_simulation
 188  * \brief A clock (in second).
 189  */
 190 XBT_INLINE double MSG_get_clock(void)
 191 {
 192   return SIMIX_get_clock();
 193 }
 194
 195 unsigned long int MSG_get_sent_msg()
 196 {
 197   return msg_global->sent_msg;
 198 }
 199
 200 #ifdef MSG_USE_DEPRECATED
 201 msg_error_t MSG_clean(void) {
 202   return MSG_OK;
 203 }
 204 #endif