src/msg/msg_global.cpp

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