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