1 /* Copyright (c) 2004-2015. 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. */
9 #include "msg_private.h"
10 #include "xbt/sysdep.h"
12 #include "xbt/functional.hpp"
13 #include "src/simix/smx_process_private.h"
14 #include "src/simix/smx_private.h"
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (process)");
18 /** @addtogroup m_process_management
20 * Processes (#msg_process_t) are independent agents that can do stuff on their own. They are in charge of executing
21 * your code interacting with the simulated world.
22 * A process may be defined as a <em>code</em> with some <em>private data</em>.
23 * Processes must be located on <em>hosts</em> (#msg_host_t), and they exchange data by sending tasks (#msg_task_t)
24 * that are similar to envelops containing data.
27 /******************************** Process ************************************/
29 * \brief Cleans the MSG data of a process.
30 * \param smx_proc a SIMIX process
32 void MSG_process_cleanup_from_SIMIX(smx_process_t smx_proc)
34 simdata_process_t msg_proc;
36 // get the MSG process from the SIMIX process
37 if (smx_proc == SIMIX_process_self()) {
38 /* avoid a SIMIX request if this function is called by the process itself */
39 msg_proc = (simdata_process_t) SIMIX_process_self_get_data();
40 SIMIX_process_self_set_data(nullptr);
42 msg_proc = (simdata_process_t) simcall_process_get_data(smx_proc);
43 simcall_process_set_data(smx_proc, nullptr);
46 TRACE_msg_process_destroy(smx_proc->name.c_str(), smx_proc->pid);
47 // free the data if a function was provided
48 if (msg_proc && msg_proc->data && msg_global->process_data_cleanup) {
49 msg_global->process_data_cleanup(msg_proc->data);
52 // free the MSG process
54 SIMIX_process_cleanup(smx_proc);
57 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
58 smx_process_t MSG_process_create_from_SIMIX(
59 const char *name, std::function<void()> code, void *data, const char *hostname,
60 double kill_time, xbt_dict_t properties,
61 int auto_restart, smx_process_t parent_process)
63 msg_host_t host = MSG_host_by_name(hostname);
64 msg_process_t p = MSG_process_create_with_environment(
65 name, std::move(code), data, host, properties);
67 MSG_process_set_kill_time(p,kill_time);
68 MSG_process_auto_restart_set(p,auto_restart);
73 /** \ingroup m_process_management
74 * \brief Creates and runs a new #msg_process_t.
76 * Does exactly the same as #MSG_process_create_with_arguments but without providing standard arguments
77 * (\a argc, \a argv, \a start_time, \a kill_time).
78 * \sa MSG_process_create_with_arguments
80 msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
82 return MSG_process_create_with_environment(name, code, data, host, 0, nullptr, nullptr);
85 /** \ingroup m_process_management
86 * \brief Creates and runs a new #msg_process_t.
88 * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
89 * the corresponding thread) is created, and put in the list of ready process.
90 * \param name a name for the object. It is for user-level information and can be nullptr.
91 * \param code is a function describing the behavior of the process. It should then only use functions described
92 * in \ref m_process_management (to create a new #msg_process_t for example),
93 in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
94 in \ref m_task_management (to create or destroy some #msg_task_t for example) and
95 in \ref msg_task_usage (to handle file transfers and task processing).
96 * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and
97 * can be nullptr. It can be retrieved with the function \ref MSG_process_get_data.
98 * \param host the location where the new process is executed.
99 * \param argc first argument passed to \a code
100 * \param argv second argument passed to \a code
102 * \return The new corresponding object.
105 msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
106 int argc, char **argv)
108 return MSG_process_create_with_environment(name, code, data, host, argc, argv, nullptr);
111 /** \ingroup m_process_management
112 * \brief Creates and runs a new #msg_process_t.
114 * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
115 * the corresponding thread) is created, and put in the list of ready process.
116 * \param name a name for the object. It is for user-level information and can be nullptr.
117 * \param code is a function describing the behavior of the process. It should then only use functions described
118 * in \ref m_process_management (to create a new #msg_process_t for example),
119 in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
120 in \ref m_task_management (to create or destroy some #msg_task_t for example) and
121 in \ref msg_task_usage (to handle file transfers and task processing).
122 * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and
123 * can be nullptr. It can be retrieved with the function \ref MSG_process_get_data.
124 * \param host the location where the new process is executed.
125 * \param argc first argument passed to \a code
126 * \param argv second argument passed to \a code. WARNING, these strings are freed by the SimGrid kernel when the
127 * process exits, so they cannot be static nor shared between several processes.
128 * \param properties list a properties defined for this process
130 * \return The new corresponding object.
132 msg_process_t MSG_process_create_with_environment(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
133 int argc, char **argv, xbt_dict_t properties)
135 std::function<void()> function;
137 function = simgrid::xbt::wrapMain(code, argc, const_cast<const char*const*>(argv));
138 msg_process_t res = MSG_process_create_with_environment(name,
139 std::move(function), data, host, properties);
140 for (int i = 0; i != argc; ++i)
146 msg_process_t MSG_process_create_with_environment(
147 const char *name, std::function<void()> code, void *data,
148 msg_host_t host, xbt_dict_t properties)
150 xbt_assert(code != nullptr && host != nullptr, "Invalid parameters: host and code params must not be nullptr");
151 simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1);
152 msg_process_t process;
154 /* Simulator data for MSG */
155 simdata->waiting_action = nullptr;
156 simdata->waiting_task = nullptr;
157 simdata->m_host = host;
158 simdata->data = data;
159 simdata->last_errno = MSG_OK;
161 /* Let's create the process: SIMIX may decide to start it right now,
162 * even before returning the flow control to us */
163 process = simcall_process_create(
164 name, std::move(code), simdata, sg_host_get_name(host), -1, properties, 0);
167 /* Undo everything we have just changed */
172 simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process);
177 static int MSG_maestro(int argc, char** argv)
179 int res = MSG_main();
183 /* Become a process in the simulation
185 * Currently this can only be called by the main thread (once) and only work with some thread factories
186 * (currently ThreadContextFactory).
188 * In the future, it might be extended in order to attach other threads created by a third party library.
190 msg_process_t MSG_process_attach(const char *name, void *data, msg_host_t host, xbt_dict_t properties)
192 xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
193 simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1);
194 msg_process_t process;
196 /* Simulator data for MSG */
197 simdata->waiting_action = nullptr;
198 simdata->waiting_task = nullptr;
199 simdata->m_host = host;
200 simdata->data = data;
201 simdata->last_errno = MSG_OK;
203 /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
204 process = SIMIX_process_attach(name, simdata, sg_host_get_name(host), properties, nullptr);
206 xbt_die("Could not attach");
207 simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process);
211 /** Detach a process attached with `MSG_process_attach()`
213 * This is called when the current process has finished its job.
214 * Used in the main thread, it waits for the simulation to finish before returning. When it returns, the other
215 * simulated processes and the maestro are destroyed.
217 void MSG_process_detach(void)
219 SIMIX_process_detach();
222 /** \ingroup m_process_management
223 * \param process poor victim
225 * This function simply kills a \a process... scary isn't it ? :)
227 void MSG_process_kill(msg_process_t process)
229 // /* FIXME: why do we only cancel communication actions? is this useful? */
230 // simdata_process_t p_simdata = simcall_process_get_data(process);
231 // if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) {
232 // simcall_comm_cancel(p_simdata->waiting_task->simdata->comm);
234 simcall_process_kill(process);
238 * \brief Wait for the completion of a #msg_process_t.
240 * \param process the process to wait for
241 * \param timeout wait until the process is over, or the timeout occurs
243 msg_error_t MSG_process_join(msg_process_t process, double timeout){
244 simcall_process_join(process, timeout);
248 /** \ingroup m_process_management
249 * \brief Migrates a process to another location.
251 * This function checks whether \a process and \a host are valid pointers and change the value of the #msg_host_t on
252 * which \a process is running.
254 msg_error_t MSG_process_migrate(msg_process_t process, msg_host_t host)
256 simdata_process_t simdata = (simdata_process_t) simcall_process_get_data(process);
257 simdata->m_host = host;
258 msg_host_t now = simdata->m_host;
259 TRACE_msg_process_change_host(process, now, host);
260 simcall_process_set_host(process, host);
264 /** \ingroup m_process_management
265 * \brief Returns the user data of a process.
267 * This function checks whether \a process is a valid pointer and returns the user data associated to this process.
269 void* MSG_process_get_data(msg_process_t process)
271 xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
273 /* get from SIMIX the MSG process data, and then the user data */
274 simdata_process_t simdata = (simdata_process_t) simcall_process_get_data(process);
276 return simdata->data;
281 /** \ingroup m_process_management
282 * \brief Sets the user data of a process.
284 * This function checks whether \a process is a valid pointer and sets the user data associated to this process.
286 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
288 xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
290 simdata_process_t simdata = (simdata_process_t) simcall_process_get_data(process);
291 simdata->data = data;
296 /** \ingroup m_process_management
297 * \brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
298 * \param data_cleanup a cleanup function for the userdata of a process, or nullptr to call no function
300 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
301 msg_global->process_data_cleanup = data_cleanup;
304 /** \ingroup m_process_management
305 * \brief Return the location on which a process is running.
306 * \param process a process (nullptr means the current one)
307 * \return the msg_host_t corresponding to the location on which \a process is running.
309 msg_host_t MSG_process_get_host(msg_process_t process)
311 simdata_process_t simdata;
312 if (process == nullptr) {
313 simdata = (simdata_process_t) SIMIX_process_self_get_data();
316 simdata = (simdata_process_t) simcall_process_get_data(process);
318 return simdata ? simdata->m_host : nullptr;
321 /** \ingroup m_process_management
323 * \brief Return a #msg_process_t given its PID.
325 * This function search in the list of all the created msg_process_t for a msg_process_t whose PID is equal to \a PID.
326 * If no host is found, \c nullptr is returned.
327 Note that the PID are uniq in the whole simulation, not only on a given host.
329 msg_process_t MSG_process_from_PID(int PID)
331 return SIMIX_process_from_PID(PID);
334 /** @brief returns a list of all currently existing processes */
335 xbt_dynar_t MSG_processes_as_dynar(void) {
336 return SIMIX_processes_as_dynar();
339 /** @brief Return the current number MSG processes. */
340 int MSG_process_get_number(void)
342 return SIMIX_process_count();
345 /** \ingroup m_process_management
346 * \brief Set the kill time of a process.
348 * \param process a process
349 * \param kill_time the time when the process is killed.
351 msg_error_t MSG_process_set_kill_time(msg_process_t process, double kill_time)
353 simcall_process_set_kill_time(process,kill_time);
357 /** \ingroup m_process_management
358 * \brief Returns the process ID of \a process.
360 * This function checks whether \a process is a valid pointer and return its PID (or 0 in case of problem).
362 int MSG_process_get_PID(msg_process_t process)
364 /* Do not raise an exception here: this function is called by the logs
365 * and the exceptions, so it would be called back again and again */
366 if (process == nullptr) {
369 return simcall_process_get_PID(process);
372 /** \ingroup m_process_management
373 * \brief Returns the process ID of the parent of \a process.
375 * This function checks whether \a process is a valid pointer and return its PID.
376 * Returns -1 if the process has not been created by any other process.
378 int MSG_process_get_PPID(msg_process_t process)
380 xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
381 return simcall_process_get_PPID(process);
384 /** \ingroup m_process_management
385 * \brief Return the name of a process.
387 * This function checks whether \a process is a valid pointer and return its name.
389 const char *MSG_process_get_name(msg_process_t process)
391 xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
392 return simcall_process_get_name(process);
395 /** \ingroup m_process_management
396 * \brief Returns the value of a given process property
398 * \param process a process
399 * \param name a property name
400 * \return value of a property (or nullptr if the property is not set)
402 const char *MSG_process_get_property_value(msg_process_t process, const char *name)
404 return (char*) xbt_dict_get_or_null(MSG_process_get_properties(process), name);
407 /** \ingroup m_process_management
408 * \brief Return the list of properties
410 * This function returns all the parameters associated with a process
412 xbt_dict_t MSG_process_get_properties(msg_process_t process)
414 xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
415 return simcall_process_get_properties(process);
418 /** \ingroup m_process_management
419 * \brief Return the PID of the current process.
421 * This function returns the PID of the currently running #msg_process_t.
423 int MSG_process_self_PID(void)
425 return MSG_process_get_PID(MSG_process_self());
428 /** \ingroup m_process_management
429 * \brief Return the PPID of the current process.
431 * This function returns the PID of the parent of the currently running #msg_process_t.
433 int MSG_process_self_PPID(void)
435 return MSG_process_get_PPID(MSG_process_self());
438 /** \ingroup m_process_management
439 * \brief Return the current process.
441 * This function returns the currently running #msg_process_t.
443 msg_process_t MSG_process_self(void)
445 return SIMIX_process_self();
448 /** \ingroup m_process_management
449 * \brief Suspend the process.
451 * This function suspends the process by suspending the task on which it was waiting for the completion.
453 msg_error_t MSG_process_suspend(msg_process_t process)
455 xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
457 TRACE_msg_process_suspend(process);
458 simcall_process_suspend(process);
462 /** \ingroup m_process_management
463 * \brief Resume a suspended process.
465 * This function resumes a suspended process by resuming the task on which it was waiting for the completion.
467 msg_error_t MSG_process_resume(msg_process_t process)
469 xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
471 TRACE_msg_process_resume(process);
472 simcall_process_resume(process);
476 /** \ingroup m_process_management
477 * \brief Returns true if the process is suspended .
479 * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
481 int MSG_process_is_suspended(msg_process_t process)
483 xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
484 return simcall_process_is_suspended(process);
487 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) {
488 return SIMIX_process_get_context(process);
491 * \ingroup m_process_management
492 * \brief Add a function to the list of "on_exit" functions for the current process.
493 * The on_exit functions are the functions executed when your process is killed.
494 * You should use them to free the data used by your process.
496 void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
497 simcall_process_on_exit(MSG_process_self(),fun,data);
500 * \ingroup m_process_management
501 * \brief Sets the "auto-restart" flag of the process.
502 * If the flag is set to 1, the process will be automatically restarted when its host comes back up.
504 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart) {
505 simcall_process_auto_restart_set(process,auto_restart);
508 * \ingroup m_process_management
509 * \brief Restarts a process from the beginning.
511 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process) {
512 return simcall_process_restart(process);