3 /* Copyright (c) 2002-2007 Arnaud Legrand. */
4 /* Copyright (c) 2007 Bruno Donassolo. */
5 /* All rights reserved. */
7 /* This program is free software; you can redistribute it and/or modify it
8 * under the terms of the license (GNU LGPL) which comes with this package. */
10 #include "msg/private.h"
11 #include "xbt/sysdep.h"
13 #include "xbt/virtu.h"
14 #include "xbt/ex.h" /* ex_backtrace_display */
17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_kernel, msg,
18 "Logging specific to MSG (kernel)");
20 MSG_Global_t msg_global = NULL;
23 /** \defgroup msg_simulation MSG simulation Functions
24 * \brief This section describes the functions you need to know to
25 * set up a simulation. You should have a look at \ref MSG_examples
26 * to have an overview of their usage.
28 /** @addtogroup msg_simulation
29 * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Simulation functions" --> \endhtmlonly
32 /********************************* MSG **************************************/
34 /** \ingroup msg_simulation
35 * \brief Initialize some MSG internal data.
37 void MSG_global_init_args(int *argc, char **argv)
39 MSG_global_init(argc, argv);
43 XBT_LOG_EXTERNAL_CATEGORY(msg_gos);
44 XBT_LOG_EXTERNAL_CATEGORY(msg_kernel);
45 XBT_LOG_EXTERNAL_CATEGORY(msg_mailbox);
46 XBT_LOG_EXTERNAL_CATEGORY(msg_process);
48 /** \ingroup msg_simulation
49 * \brief Initialize some MSG internal data.
51 void MSG_global_init(int *argc, char **argv)
53 xbt_getpid = MSG_process_self_PID;
55 /* Connect our log channels: that must be done manually under windows */
56 XBT_LOG_CONNECT(msg_gos, msg);
57 XBT_LOG_CONNECT(msg_kernel, msg);
58 XBT_LOG_CONNECT(msg_mailbox, msg);
59 XBT_LOG_CONNECT(msg_process, msg);
61 SIMIX_global_init(argc, argv);
63 msg_global = xbt_new0(s_MSG_Global_t, 1);
65 msg_global->host = xbt_fifo_new();
66 msg_global->process_list = xbt_fifo_new();
67 msg_global->max_channel = 0;
69 msg_global->sent_msg = 0;
71 /* initialization of the mailbox module */
72 MSG_mailbox_mod_init();
74 /* initialization of the action module */
77 SIMIX_function_register_process_create(_MSG_process_create_from_SIMIX);
78 SIMIX_function_register_process_cleanup(__MSG_process_cleanup);
79 SIMIX_function_register_process_kill(_MSG_process_kill_from_SIMIX);
84 /** \defgroup m_channel_management Understanding channels
85 * \brief This section briefly describes the channel notion of MSG
88 /** @addtogroup m_channel_management
89 * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Channels" --> \endhtmlonly
92 * For convenience, the simulator provides the notion of channel
93 * that is close to the tag notion in MPI. A channel is not a
94 * socket. It doesn't need to be opened neither closed. It rather
95 * corresponds to the ports opened on the different machines.
99 /** \ingroup m_channel_management
100 * \brief Set the number of channel in the simulation.
102 * This function has to be called to fix the number of channel in the
103 simulation before creating any host. Indeed, each channel is
104 represented by a different mailbox on each #m_host_t. This
105 function can then be called only once. This function takes only one
107 * \param number the number of channel in the simulation. It has to be >0
109 MSG_error_t MSG_set_channel_number(int number)
111 xbt_assert0((msg_global)
112 && (msg_global->max_channel == 0),
113 "Channel number already set!");
115 msg_global->max_channel = number;
120 /** \ingroup m_channel_management
121 * \brief Return the number of channel in the simulation.
123 * This function has to be called once the number of channel is fixed. I can't
124 figure out a reason why anyone would like to call this function but nevermind.
125 * \return the number of channel in the simulation.
127 int MSG_get_channel_number(void)
129 xbt_assert0((msg_global)
130 && (msg_global->max_channel != 0),
131 "Channel number not set yet!");
133 return msg_global->max_channel;
136 /** \ingroup msg_simulation
137 * \brief Launch the MSG simulation
139 MSG_error_t MSG_main(void)
141 /* Clean IO before the run */
146 while (SIMIX_solve(NULL, NULL) != -1.0);
151 /** \ingroup msg_simulation
152 * \brief Kill all running process
154 * \param reset_PIDs should we reset the PID numbers. A negative
155 * number means no reset and a positive number will be used to set the PID
156 * of the next newly created process.
158 int MSG_process_killall(int reset_PIDs)
160 m_process_t p = NULL;
161 m_process_t self = MSG_process_self();
163 while ((p = xbt_fifo_pop(msg_global->process_list))) {
168 if (reset_PIDs > 0) {
169 msg_global->PID = reset_PIDs;
170 msg_global->session++;
173 return msg_global->PID;
177 /** \ingroup msg_simulation
178 * \brief Clean the MSG simulation
180 MSG_error_t MSG_clean(void)
182 xbt_fifo_item_t i = NULL;
184 m_process_t p = NULL;
187 while ((p = xbt_fifo_pop(msg_global->process_list))) {
191 xbt_fifo_foreach(msg_global->host, i, h, m_host_t) {
192 __MSG_host_destroy(h);
194 xbt_fifo_free(msg_global->host);
195 xbt_fifo_free(msg_global->process_list);
200 /* cleanup all resources in the mailbox module */
201 MSG_mailbox_mod_exit();
203 /* initialization of the action module */
212 /** \ingroup msg_easier_life
213 * \brief A clock (in second).
215 double MSG_get_clock(void)
217 return SIMIX_get_clock();
220 unsigned long int MSG_get_sent_msg()
222 return msg_global->sent_msg;