1 /* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #include "msg_private.hpp"
7 #include "simgrid/s4u/Host.hpp"
8 #include "src/instr/instr_private.hpp"
9 #include "src/simix/ActorImpl.hpp"
10 #include "src/simix/smx_private.hpp"
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (process)");
14 /** @addtogroup m_process_management
16 * Processes (#msg_process_t) are independent agents that can do stuff on their own. They are in charge of executing
17 * your code interacting with the simulated world.
18 * A process may be defined as a <em>code</em> with some <em>private data</em>.
19 * Processes must be located on <em>hosts</em> (#msg_host_t), and they exchange data by sending tasks (#msg_task_t)
20 * that are similar to envelops containing data.
23 /******************************** Process ************************************/
25 * \brief Cleans the MSG data of an actor
26 * \param smx_actor a SIMIX actor
28 void MSG_process_cleanup_from_SIMIX(smx_actor_t smx_actor)
30 simgrid::msg::ActorExt* msg_actor;
32 // get the MSG process from the SIMIX process
33 if (smx_actor == SIMIX_process_self()) {
34 /* avoid a SIMIX request if this function is called by the process itself */
35 msg_actor = (simgrid::msg::ActorExt*)SIMIX_process_self_get_data();
36 SIMIX_process_self_set_data(nullptr);
38 msg_actor = (simgrid::msg::ActorExt*)smx_actor->getUserData();
39 simcall_process_set_data(smx_actor, nullptr);
42 if (TRACE_actor_is_enabled())
43 simgrid::instr::Container::byName(instr_pid(smx_actor->ciface()))->removeFromParent();
45 // free the data if a function was provided
46 if (msg_actor && msg_actor->data && msg_global->process_data_cleanup) {
47 msg_global->process_data_cleanup(msg_actor->data);
51 SIMIX_process_cleanup(smx_actor);
54 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
55 smx_actor_t MSG_process_create_from_SIMIX(const char* name, std::function<void()> code, void* data, sg_host_t host,
56 std::map<std::string, std::string>* properties,
57 smx_actor_t /*parent_process*/)
59 msg_process_t p = MSG_process_create_from_stdfunc(name, std::move(code), data, host, properties);
60 return p == nullptr ? nullptr : p->get_impl();
63 /** \ingroup m_process_management
64 * \brief Creates and runs a new #msg_process_t.
66 * Does exactly the same as #MSG_process_create_with_arguments but without providing standard arguments
67 * (\a argc, \a argv, \a start_time, \a kill_time).
68 * \sa MSG_process_create_with_arguments
70 msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
72 return MSG_process_create_with_environment(name, code, data, host, 0, nullptr, nullptr);
75 /** \ingroup m_process_management
76 * \brief Creates and runs a new #msg_process_t.
78 * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
79 * the corresponding thread) is created, and put in the list of ready process.
80 * \param name a name for the object. It is for user-level information and can be nullptr.
81 * \param code is a function describing the behavior of the process. It should then only use functions described
82 * in \ref m_process_management (to create a new #msg_process_t for example),
83 in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
84 in \ref m_task_management (to create or destroy some #msg_task_t for example) and
85 in \ref msg_task_usage (to handle file transfers and task processing).
86 * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and
87 * can be nullptr. It can be retrieved with the function \ref MSG_process_get_data.
88 * \param host the location where the new process is executed.
89 * \param argc first argument passed to \a code
90 * \param argv second argument passed to \a code
92 * \return The new corresponding object.
95 msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
96 int argc, char **argv)
98 return MSG_process_create_with_environment(name, code, data, host, argc, argv, nullptr);
101 /** \ingroup m_process_management
102 * \brief Creates and runs a new #msg_process_t.
104 * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
105 * the corresponding thread) is created, and put in the list of ready process.
106 * \param name a name for the object. It is for user-level information and can be nullptr.
107 * \param code is a function describing the behavior of the process. It should then only use functions described
108 * in \ref m_process_management (to create a new #msg_process_t for example),
109 in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
110 in \ref m_task_management (to create or destroy some #msg_task_t for example) and
111 in \ref msg_task_usage (to handle file transfers and task processing).
112 * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and
113 * can be nullptr. It can be retrieved with the function \ref MSG_process_get_data.
114 * \param host the location where the new process is executed.
115 * \param argc first argument passed to \a code
116 * \param argv second argument passed to \a code. WARNING, these strings are freed by the SimGrid kernel when the
117 * process exits, so they cannot be static nor shared between several processes.
118 * \param properties list a properties defined for this process
120 * \return The new corresponding object.
122 msg_process_t MSG_process_create_with_environment(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
123 int argc, char **argv, xbt_dict_t properties)
125 std::function<void()> function;
127 function = simgrid::xbt::wrapMain(code, argc, static_cast<const char* const*>(argv));
129 std::map<std::string, std::string> props;
130 xbt_dict_cursor_t cursor = nullptr;
133 xbt_dict_foreach (properties, cursor, key, value)
135 xbt_dict_free(&properties);
137 msg_process_t res = MSG_process_create_from_stdfunc(name, std::move(function), data, host, &props);
138 for (int i = 0; i != argc; ++i)
144 msg_process_t MSG_process_create_from_stdfunc(const char* name, std::function<void()> code, void* data, msg_host_t host,
145 std::map<std::string, std::string>* properties)
147 xbt_assert(code != nullptr && host != nullptr, "Invalid parameters: host and code params must not be nullptr");
148 simgrid::msg::ActorExt* msgExt = new simgrid::msg::ActorExt(data);
150 smx_actor_t process = simcall_process_create(name, std::move(code), msgExt, host, properties);
152 if (not process) { /* Undo everything */
157 process->ciface()->on_exit((int_f_pvoid_pvoid_t)TRACE_msg_process_kill, process);
158 return process->ciface();
161 /* Become a process in the simulation
163 * Currently this can only be called by the main thread (once) and only work with some thread factories
164 * (currently ThreadContextFactory).
166 * In the future, it might be extended in order to attach other threads created by a third party library.
168 msg_process_t MSG_process_attach(const char *name, void *data, msg_host_t host, xbt_dict_t properties)
170 xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
171 std::map<std::string, std::string> props;
172 xbt_dict_cursor_t cursor = nullptr;
175 xbt_dict_foreach (properties, cursor, key, value)
177 xbt_dict_free(&properties);
179 /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
180 smx_actor_t process =
181 SIMIX_process_attach(name, new simgrid::msg::ActorExt(data), host->get_cname(), &props, nullptr);
183 xbt_die("Could not attach");
184 process->ciface()->on_exit((int_f_pvoid_pvoid_t)TRACE_msg_process_kill, process);
185 return process->ciface();
188 /** Detach a process attached with `MSG_process_attach()`
190 * This is called when the current process has finished its job.
191 * Used in the main thread, it waits for the simulation to finish before returning. When it returns, the other
192 * simulated processes and the maestro are destroyed.
194 void MSG_process_detach()
196 SIMIX_process_detach();
199 /** Yield the current actor; let the other actors execute first */
200 void MSG_process_yield()
202 simgrid::simix::kernelImmediate([] { /* do nothing*/ });
205 /** \ingroup m_process_management
206 * \brief Returns the user data of a process.
208 * This function checks whether \a process is a valid pointer and returns the user data associated to this process.
210 void* MSG_process_get_data(msg_process_t process)
212 xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
214 /* get from SIMIX the MSG process data, and then the user data */
215 simgrid::msg::ActorExt* msgExt = (simgrid::msg::ActorExt*)process->get_impl()->getUserData();
222 /** \ingroup m_process_management
223 * \brief Sets the user data of a process.
225 * This function checks whether \a process is a valid pointer and sets the user data associated to this process.
227 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
229 xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
231 static_cast<simgrid::msg::ActorExt*>(process->get_impl()->getUserData())->data = data;
236 /** \ingroup m_process_management
237 * \brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
238 * \param data_cleanup a cleanup function for the userdata of a process, or nullptr to call no function
240 XBT_PUBLIC void MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup)
242 msg_global->process_data_cleanup = data_cleanup;
245 /** @brief returns a list of all currently existing processes */
246 xbt_dynar_t MSG_processes_as_dynar() {
247 xbt_dynar_t res = xbt_dynar_new(sizeof(smx_actor_t), nullptr);
248 for (auto const& kv : simix_global->process_list) {
249 smx_actor_t actor = kv.second;
250 xbt_dynar_push(res, &actor);
255 /** @brief Return the current number MSG processes. */
256 int MSG_process_get_number()
258 return SIMIX_process_count();
261 /** \ingroup m_process_management
262 * \brief Return the PID of the current process.
264 * This function returns the PID of the currently running #msg_process_t.
266 int MSG_process_self_PID()
268 smx_actor_t self = SIMIX_process_self();
269 return self == nullptr ? 0 : self->pid;
272 /** \ingroup m_process_management
273 * \brief Return the PPID of the current process.
275 * This function returns the PID of the parent of the currently running #msg_process_t.
277 int MSG_process_self_PPID()
279 return MSG_process_get_PPID(MSG_process_self());
282 /** \ingroup m_process_management
283 * \brief Return the name of the current process.
285 const char* MSG_process_self_name()
287 return SIMIX_process_self_get_name();
290 /** \ingroup m_process_management
291 * \brief Return the current process.
293 * This function returns the currently running #msg_process_t.
295 msg_process_t MSG_process_self()
297 return SIMIX_process_self()->ciface();
300 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) { // deprecated -- smx_context_t should die afterward
301 return process->get_impl()->context;
304 * \ingroup m_process_management
305 * \brief Add a function to the list of "on_exit" functions for the current process.
306 * The on_exit functions are the functions executed when your process is killed.
307 * You should use them to free the data used by your process.
309 void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
310 simgrid::s4u::this_actor::on_exit(fun, data);
313 * \ingroup m_process_management
314 * \brief Sets the "auto-restart" flag of the process.
315 * If the flag is set to 1, the process will be automatically restarted when its host comes back up.
317 XBT_PUBLIC void MSG_process_auto_restart_set(msg_process_t process, int auto_restart)
319 process->set_auto_restart(auto_restart);
322 /** @ingroup m_process_management
323 * @brief Take an extra reference on that process to prevent it to be garbage-collected
325 XBT_PUBLIC void MSG_process_ref(msg_process_t process)
327 intrusive_ptr_add_ref(process);
329 /** @ingroup m_process_management
330 * @brief Release a reference on that process so that it can get be garbage-collected
332 XBT_PUBLIC void MSG_process_unref(msg_process_t process)
334 intrusive_ptr_release(process);