src/msg/msg_global.c

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