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"
8 #include "msg_mailbox.h"
10 #include "xbt/sysdep.h"
12 #include "xbt/virtu.h"
13 #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->max_channel = 0;
69 msg_global->sent_msg = 0;
70 msg_global->task_copy_callback = NULL;
72 /* initialization of the action module */
75 SIMIX_function_register_process_create(MSG_process_create_from_SIMIX);
76 SIMIX_function_register_process_cleanup(MSG_process_cleanup_from_SIMIX);
77 SIMIX_function_register_process_kill(MSG_process_kill_from_SIMIX);
83 XBT_DEBUG("ADD MSG LEVELS");
84 MSG_HOST_LEVEL = xbt_lib_add_level(host_lib, (void_f_pvoid_t) __MSG_host_destroy);
87 /** \defgroup m_channel_management Understanding channels
88 * \brief This section briefly describes the channel notion of MSG
91 /** @addtogroup m_channel_management
92 * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Channels" --> \endhtmlonly
95 * For convenience, the simulator provides the notion of channel
96 * that is close to the tag notion in MPI. A channel is not a
97 * socket. It doesn't need to be opened neither closed. It rather
98 * corresponds to the ports opened on the different machines.
102 /** \ingroup m_channel_management
103 * \brief Set the number of channel in the simulation.
105 * This function has to be called to fix the number of channel in the
106 simulation before creating any host. Indeed, each channel is
107 represented by a different mailbox on each #m_host_t. This
108 function can then be called only once. This function takes only one
110 * \param number the number of channel in the simulation. It has to be >0
112 MSG_error_t MSG_set_channel_number(int number)
114 xbt_assert((msg_global)
115 && (msg_global->max_channel == 0),
116 "Channel number already set!");
118 msg_global->max_channel = number;
123 /** \ingroup m_channel_management
124 * \brief Return the number of channel in the simulation.
126 * This function has to be called once the number of channel is fixed. I can't
127 figure out a reason why anyone would like to call this function but nevermind.
128 * \return the number of channel in the simulation.
130 int MSG_get_channel_number(void)
132 xbt_assert((msg_global)
133 && (msg_global->max_channel != 0),
134 "Channel number not set yet!");
136 return msg_global->max_channel;
139 /** \ingroup msg_simulation
140 * \brief Launch the MSG simulation
142 MSG_error_t MSG_main(void)
144 /* Clean IO before the run */
157 MSG_error_t MSG_main_stateful(void)
159 /* Clean IO before the run */
164 MC_modelcheck_stateful();
173 MSG_error_t MSG_main_liveness(xbt_automaton_t a, char *prgm)
175 /* Clean IO before the run */
180 MC_modelcheck_liveness(a, prgm);
188 /** \ingroup msg_simulation
189 * \brief Kill all running process
191 * \param reset_PIDs should we reset the PID numbers. A negative
192 * number means no reset and a positive number will be used to set the PID
193 * of the next newly created process.
195 int MSG_process_killall(int reset_PIDs)
197 SIMIX_req_process_killall();
199 if (reset_PIDs > 0) {
200 msg_global->PID = reset_PIDs;
201 msg_global->session++;
204 return msg_global->PID;
208 /** \ingroup msg_simulation
209 * \brief Clean the MSG simulation
211 MSG_error_t MSG_clean(void)
213 XBT_DEBUG("Closing MSG");
216 TRACE_surf_release();
219 MSG_process_killall(0);
221 /* initialization of the action module */
237 /** \ingroup msg_easier_life
238 * \brief A clock (in second).
240 XBT_INLINE double MSG_get_clock(void)
242 return SIMIX_get_clock();
245 unsigned long int MSG_get_sent_msg()
247 return msg_global->sent_msg;