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     simgrid::s4u::Host::onCreation.connect([](simgrid::s4u::Host& host) {
  72       MSG_host_create_(&host);
  73     });
  74   }
  75
  76   if(MC_is_active()){
  77     /* Ignore total amount of messages sent during the simulation for heap comparison */
  78     MC_ignore_heap(&(msg_global->sent_msg), sizeof(msg_global->sent_msg));
  79   }
  80
  81   XBT_DEBUG("ADD MSG LEVELS");
  82   MSG_STORAGE_LEVEL = xbt_lib_add_level(storage_lib, (void_f_pvoid_t) __MSG_storage_destroy);
  83   MSG_FILE_LEVEL = xbt_lib_add_level(file_lib, (void_f_pvoid_t) __MSG_file_destroy);
  84   if(sg_cfg_get_boolean("clean_atexit")) atexit(MSG_exit);
  85 }
  86
  87 #ifdef MSG_USE_DEPRECATED
  88
  89 /* This deprecated function has to be called to fix the number of channel in the
  90    simulation before creating any host. Indeed, each channel is
  91    represented by a different mailbox on each #m_host_t. This
  92    function can then be called only once. This function takes only one
  93    parameter.
  94  * \param number the number of channel in the simulation. It has to be >0
  95  */
  96 msg_error_t MSG_set_channel_number(int number)
  97 {
  98   XBT_WARN("DEPRECATED! Please use aliases instead");
  99   xbt_assert((msg_global)
 100               && (msg_global->max_channel == 0),
 101               "Channel number already set!");
 102
 103   msg_global->max_channel = number;
 104
 105   return MSG_OK;
 106 }
 107
 108 /* This deprecated function has to be called once the number of channel is fixed. I can't
 109    figure out a reason why anyone would like to call this function but nevermind.
 110  * \return the number of channel in the simulation.
 111  */
 112 int MSG_get_channel_number(void)
 113 {
 114   XBT_WARN("DEPRECATED! Please use aliases instead");
 115   xbt_assert((msg_global)
 116               && (msg_global->max_channel != 0),
 117               "Channel number not set yet!");
 118
 119   return msg_global->max_channel;
 120 }
 121 #endif
 122
 123 /** \ingroup msg_simulation
 124  * \brief Launch the MSG simulation
 125  */
 126 msg_error_t MSG_main(void)
 127 {
 128   /* Clean IO before the run */
 129   fflush(stdout);
 130   fflush(stderr);
 131
 132   if (MC_is_active()) {
 133     MC_run();
 134   } else {
 135     SIMIX_run();
 136   }
 137   return MSG_OK;
 138 }
 139
 140 /** \ingroup msg_simulation
 141  * \brief set a configuration variable
 142  *
 143  * Do --help on any simgrid binary to see the list of currently existing configuration variables, and see Section @ref options.
 144  *
 145  * Example:
 146  * MSG_config("host/model","ptask_L07");
 147  */
 148 void MSG_config(const char *key, const char *value){
 149   xbt_assert(msg_global,"ERROR: Please call MSG_init() before using MSG_config()");
 150   xbt_cfg_set_as_string(_sg_cfg_set, key, value);
 151 }
 152
 153
 154 /** \ingroup msg_simulation
 155  * \brief Kill all running process
 156
 157  * \param reset_PIDs should we reset the PID numbers. A negative
 158  *   number means no reset and a positive number will be used to set the PID
 159  *   of the next newly created process.
 160  */
 161 int MSG_process_killall(int reset_PIDs)
 162 {
 163   simcall_process_killall(reset_PIDs);
 164
 165   if (reset_PIDs > 0)
 166     msg_global->session++;
 167
 168   return 0;
 169
 170 }
 171
 172 static void MSG_exit(void) {
 173   if (msg_global==NULL)
 174     return;
 175
 176   TRACE_surf_resource_utilization_release();
 177   TRACE_end();
 178   free(msg_global);
 179   msg_global = NULL;
 180 }
 181
 182
 183 /** \ingroup msg_simulation
 184  * \brief A clock (in second).
 185  */
 186 double MSG_get_clock(void)
 187 {
 188   return SIMIX_get_clock();
 189 }
 190
 191 unsigned long int MSG_get_sent_msg()
 192 {
 193   return msg_global->sent_msg;
 194 }
 195
 196 #ifdef MSG_USE_DEPRECATED
 197 msg_error_t MSG_clean(void) {
 198   return MSG_OK;
 199 }
 200 #endif