1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
2 * All rights reserved. */
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. */
7 #include "msg/private.h"
9 #include "xbt/sysdep.h"
11 #include "xbt/virtu.h"
12 #include "xbt/ex.h" /* ex_backtrace_display */
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_kernel, msg,
16 "Logging specific to MSG (kernel)");
18 MSG_Global_t msg_global = NULL;
21 /** \defgroup msg_simulation MSG simulation Functions
22 * \brief This section describes the functions you need to know to
23 * set up a simulation. You should have a look at \ref MSG_examples
24 * to have an overview of their usage.
26 /** @addtogroup msg_simulation
27 * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Simulation functions" --> \endhtmlonly
30 /********************************* MSG **************************************/
32 /** \ingroup msg_simulation
33 * \brief Initialize some MSG internal data.
35 void MSG_global_init_args(int *argc, char **argv)
37 MSG_global_init(argc, argv);
41 XBT_LOG_EXTERNAL_CATEGORY(msg_gos);
42 XBT_LOG_EXTERNAL_CATEGORY(msg_kernel);
43 XBT_LOG_EXTERNAL_CATEGORY(msg_mailbox);
44 XBT_LOG_EXTERNAL_CATEGORY(msg_process);
46 /** \ingroup msg_simulation
47 * \brief Initialize some MSG internal data.
49 void MSG_global_init(int *argc, char **argv)
52 TRACE_global_init(argc, argv);
55 xbt_getpid = MSG_process_self_PID;
57 /* Connect our log channels: that must be done manually under windows */
58 XBT_LOG_CONNECT(msg_gos, msg);
59 XBT_LOG_CONNECT(msg_kernel, msg);
60 XBT_LOG_CONNECT(msg_mailbox, msg);
61 XBT_LOG_CONNECT(msg_process, msg);
63 SIMIX_global_init(argc, argv);
65 msg_global = xbt_new0(s_MSG_Global_t, 1);
67 msg_global->host = xbt_fifo_new();
68 msg_global->process_list = xbt_fifo_new();
69 msg_global->max_channel = 0;
71 msg_global->sent_msg = 0;
73 /* initialization of the mailbox module */
74 MSG_mailbox_mod_init();
76 /* initialization of the action module */
79 SIMIX_function_register_process_create(_MSG_process_create_from_SIMIX);
80 SIMIX_function_register_process_cleanup(__MSG_process_cleanup);
81 SIMIX_function_register_process_kill(_MSG_process_kill_from_SIMIX);
88 /** \defgroup m_channel_management Understanding channels
89 * \brief This section briefly describes the channel notion of MSG
92 /** @addtogroup m_channel_management
93 * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Channels" --> \endhtmlonly
96 * For convenience, the simulator provides the notion of channel
97 * that is close to the tag notion in MPI. A channel is not a
98 * socket. It doesn't need to be opened neither closed. It rather
99 * corresponds to the ports opened on the different machines.
103 /** \ingroup m_channel_management
104 * \brief Set the number of channel in the simulation.
106 * This function has to be called to fix the number of channel in the
107 simulation before creating any host. Indeed, each channel is
108 represented by a different mailbox on each #m_host_t. This
109 function can then be called only once. This function takes only one
111 * \param number the number of channel in the simulation. It has to be >0
113 MSG_error_t MSG_set_channel_number(int number)
115 xbt_assert0((msg_global)
116 && (msg_global->max_channel == 0),
117 "Channel number already set!");
119 msg_global->max_channel = number;
124 /** \ingroup m_channel_management
125 * \brief Return the number of channel in the simulation.
127 * This function has to be called once the number of channel is fixed. I can't
128 figure out a reason why anyone would like to call this function but nevermind.
129 * \return the number of channel in the simulation.
131 int MSG_get_channel_number(void)
133 xbt_assert0((msg_global)
134 && (msg_global->max_channel != 0),
135 "Channel number not set yet!");
137 return msg_global->max_channel;
140 /** \ingroup msg_simulation
141 * \brief Launch the MSG simulation
143 MSG_error_t MSG_main(void)
145 /* Clean IO before the run */
151 if (_surf_do_model_check)
155 while (SIMIX_solve(NULL, NULL) != -1.0);
160 /** \ingroup msg_simulation
161 * \brief Kill all running process
163 * \param reset_PIDs should we reset the PID numbers. A negative
164 * number means no reset and a positive number will be used to set the PID
165 * of the next newly created process.
167 int MSG_process_killall(int reset_PIDs)
169 m_process_t p = NULL;
170 m_process_t self = MSG_process_self();
172 while ((p = xbt_fifo_pop(msg_global->process_list))) {
177 if (reset_PIDs > 0) {
178 msg_global->PID = reset_PIDs;
179 msg_global->session++;
182 return msg_global->PID;
186 /** \ingroup msg_simulation
187 * \brief Clean the MSG simulation
189 MSG_error_t MSG_clean(void)
191 xbt_fifo_item_t i = NULL;
193 m_process_t p = NULL;
196 TRACE_surf_release();
199 while ((p = xbt_fifo_pop(msg_global->process_list))) {
203 xbt_fifo_foreach(msg_global->host, i, h, m_host_t) {
204 __MSG_host_destroy(h);
206 xbt_fifo_free(msg_global->host);
207 xbt_fifo_free(msg_global->process_list);
212 /* cleanup all resources in the mailbox module */
213 MSG_mailbox_mod_exit();
215 /* initialization of the action module */
228 /** \ingroup msg_easier_life
229 * \brief A clock (in second).
231 double MSG_get_clock(void)
233 return SIMIX_get_clock();
236 unsigned long int MSG_get_sent_msg()
238 return msg_global->sent_msg;