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