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 /** \ingroup msg_easier_life
85 * \brief Traces MSG events in the Paje format.
88 void MSG_paje_output(const char *filename)
92 /** \defgroup m_channel_management Understanding channels
93 * \brief This section briefly describes the channel notion of MSG
96 /** @addtogroup m_channel_management
97 * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Channels" --> \endhtmlonly
100 * For convenience, the simulator provides the notion of channel
101 * that is close to the tag notion in MPI. A channel is not a
102 * socket. It doesn't need to be opened neither closed. It rather
103 * corresponds to the ports opened on the different machines.
107 /** \ingroup m_channel_management
108 * \brief Set the number of channel in the simulation.
110 * This function has to be called to fix the number of channel in the
111 simulation before creating any host. Indeed, each channel is
112 represented by a different mailbox on each #m_host_t. This
113 function can then be called only once. This function takes only one
115 * \param number the number of channel in the simulation. It has to be >0
117 MSG_error_t MSG_set_channel_number(int number)
119 xbt_assert0((msg_global)
120 && (msg_global->max_channel == 0),
121 "Channel number already set!");
123 msg_global->max_channel = number;
128 /** \ingroup m_channel_management
129 * \brief Return the number of channel in the simulation.
131 * This function has to be called once the number of channel is fixed. I can't
132 figure out a reason why anyone would like to call this function but nevermind.
133 * \return the number of channel in the simulation.
135 int MSG_get_channel_number(void)
137 xbt_assert0((msg_global)
138 && (msg_global->max_channel != 0),
139 "Channel number not set yet!");
141 return msg_global->max_channel;
144 /** \ingroup msg_simulation
145 * \brief Launch the MSG simulation
147 MSG_error_t MSG_main(void)
149 /* Clean IO before the run */
154 while (SIMIX_solve(NULL, NULL) != -1.0);
159 /** \ingroup msg_simulation
160 * \brief Kill all running process
162 * \param reset_PIDs should we reset the PID numbers. A negative
163 * number means no reset and a positive number will be used to set the PID
164 * of the next newly created process.
166 int MSG_process_killall(int reset_PIDs)
168 m_process_t p = NULL;
169 m_process_t self = MSG_process_self();
171 while ((p = xbt_fifo_pop(msg_global->process_list))) {
176 if (reset_PIDs > 0) {
177 msg_global->PID = reset_PIDs;
178 msg_global->session++;
181 return msg_global->PID;
185 /** \ingroup msg_simulation
186 * \brief Clean the MSG simulation
188 MSG_error_t MSG_clean(void)
190 xbt_fifo_item_t i = NULL;
192 m_process_t p = NULL;
195 while ((p = xbt_fifo_pop(msg_global->process_list))) {
199 xbt_fifo_foreach(msg_global->host, i, h, m_host_t) {
200 __MSG_host_destroy(h);
202 xbt_fifo_free(msg_global->host);
203 xbt_fifo_free(msg_global->process_list);
208 /* cleanup all resources in the mailbox module */
209 MSG_mailbox_mod_exit();
217 /** \ingroup msg_easier_life
218 * \brief A clock (in second).
220 double MSG_get_clock(void)
222 return SIMIX_get_clock();
225 unsigned long int MSG_get_sent_msg()
227 return msg_global->sent_msg;