Logo AND Algorithmique Numérique Distribuée

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