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   TRACE_global_init(argc, argv);
  41
  42   xbt_getpid = MSG_process_self_PID;
  43   if (!msg_global) {
  44
  45     msg_global = xbt_new0(s_MSG_Global_t, 1);
  46
  47     xbt_cfg_register(&_sg_cfg_set, "msg/debug_multiple_use",
  48                      "Print backtraces of both processes when there is a conflict of multiple use of a task",
  49                      xbt_cfgelm_boolean, 1, 1, _sg_cfg_cb_msg_debug_multiple_use, NULL);
  50     xbt_cfg_setdefault_boolean(_sg_cfg_set, "msg/debug_multiple_use", "no");
  51
  52     SIMIX_global_init(argc, argv);
  53
  54 #ifdef MSG_USE_DEPRECATED
  55     msg_global->max_channel = 0;
  56 #endif
  57     msg_global->sent_msg = 0;
  58     msg_global->task_copy_callback = NULL;
  59     msg_global->process_data_cleanup = NULL;
  60
  61     SIMIX_function_register_process_create(MSG_process_create_from_SIMIX);
  62     SIMIX_function_register_process_cleanup(MSG_process_cleanup_from_SIMIX);
  63
  64     sg_platf_postparse_add_cb(MSG_post_create_environment);
  65   }
  66
  67   if(MC_is_active()){
  68     /* Ignore total amount of messages sent during the simulation for heap comparison */
  69     MC_ignore_heap(&(msg_global->sent_msg), sizeof(msg_global->sent_msg));
  70   }
  71
  72   XBT_DEBUG("ADD MSG LEVELS");
  73   MSG_HOST_LEVEL = xbt_lib_add_level(host_lib, (void_f_pvoid_t) __MSG_host_priv_free);
  74   MSG_STORAGE_LEVEL = xbt_lib_add_level(storage_lib, (void_f_pvoid_t) __MSG_storage_destroy);
  75   MSG_FILE_LEVEL = xbt_lib_add_level(file_lib, (void_f_pvoid_t) __MSG_file_destroy);
  76   if(sg_cfg_get_boolean("clean_atexit")) 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","ptask_L07");
 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(reset_PIDs);
 156
 157   if (reset_PIDs > 0)
 158     msg_global->session++;
 159
 160   return 0;
 161
 162 }
 163
 164 static void MSG_exit(void) {
 165   if (msg_global==NULL)
 166     return;
 167
 168   TRACE_surf_resource_utilization_release();
 169   TRACE_end();
 170   free(msg_global);
 171   msg_global = NULL;
 172 }
 173
 174
 175 /** \ingroup msg_simulation
 176  * \brief A clock (in second).
 177  */
 178 XBT_INLINE double MSG_get_clock(void)
 179 {
 180   return SIMIX_get_clock();
 181 }
 182
 183 unsigned long int MSG_get_sent_msg()
 184 {
 185   return msg_global->sent_msg;
 186 }
 187
 188 #ifdef MSG_USE_DEPRECATED
 189 msg_error_t MSG_clean(void) {
 190   return MSG_OK;
 191 }
 192 #endif