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/ActorImpl.hpp"
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_actor_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_actor_t MSG_process_create_from_SIMIX(
59 const char *name, std::function<void()> code, void *data, sg_host_t host,
60 double kill_time, xbt_dict_t properties,
61 int auto_restart, smx_actor_t parent_process)
63 msg_process_t p = MSG_process_create_with_environment(name, std::move(code), data, host, properties);
65 MSG_process_set_kill_time(p,kill_time);
66 MSG_process_auto_restart_set(p,auto_restart);
71 /** \ingroup m_process_management
72 * \brief Creates and runs a new #msg_process_t.
74 * Does exactly the same as #MSG_process_create_with_arguments but without providing standard arguments
75 * (\a argc, \a argv, \a start_time, \a kill_time).
76 * \sa MSG_process_create_with_arguments
78 msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
80 return MSG_process_create_with_environment(name, code, data, host, 0, nullptr, nullptr);
83 /** \ingroup m_process_management
84 * \brief Creates and runs a new #msg_process_t.
86 * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
87 * the corresponding thread) is created, and put in the list of ready process.
88 * \param name a name for the object. It is for user-level information and can be nullptr.
89 * \param code is a function describing the behavior of the process. It should then only use functions described
90 * in \ref m_process_management (to create a new #msg_process_t for example),
91 in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
92 in \ref m_task_management (to create or destroy some #msg_task_t for example) and
93 in \ref msg_task_usage (to handle file transfers and task processing).
94 * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and
95 * can be nullptr. It can be retrieved with the function \ref MSG_process_get_data.
96 * \param host the location where the new process is executed.
97 * \param argc first argument passed to \a code
98 * \param argv second argument passed to \a code
100 * \return The new corresponding object.
103 msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
104 int argc, char **argv)
106 return MSG_process_create_with_environment(name, code, data, host, argc, argv, nullptr);
109 /** \ingroup m_process_management
110 * \brief Creates and runs a new #msg_process_t.
112 * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
113 * the corresponding thread) is created, and put in the list of ready process.
114 * \param name a name for the object. It is for user-level information and can be nullptr.
115 * \param code is a function describing the behavior of the process. It should then only use functions described
116 * in \ref m_process_management (to create a new #msg_process_t for example),
117 in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
118 in \ref m_task_management (to create or destroy some #msg_task_t for example) and
119 in \ref msg_task_usage (to handle file transfers and task processing).
120 * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and
121 * can be nullptr. It can be retrieved with the function \ref MSG_process_get_data.
122 * \param host the location where the new process is executed.
123 * \param argc first argument passed to \a code
124 * \param argv second argument passed to \a code. WARNING, these strings are freed by the SimGrid kernel when the
125 * process exits, so they cannot be static nor shared between several processes.
126 * \param properties list a properties defined for this process
128 * \return The new corresponding object.
130 msg_process_t MSG_process_create_with_environment(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
131 int argc, char **argv, xbt_dict_t properties)
133 std::function<void()> function;
135 function = simgrid::xbt::wrapMain(code, argc, const_cast<const char*const*>(argv));
136 msg_process_t res = MSG_process_create_with_environment(name,
137 std::move(function), data, host, properties);
138 for (int i = 0; i != argc; ++i)
144 msg_process_t MSG_process_create_with_environment(
145 const char *name, std::function<void()> code, void *data,
146 msg_host_t host, xbt_dict_t properties)
148 xbt_assert(code != nullptr && host != nullptr, "Invalid parameters: host and code params must not be nullptr");
149 simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1);
150 msg_process_t process;
152 /* Simulator data for MSG */
153 simdata->waiting_action = nullptr;
154 simdata->waiting_task = nullptr;
155 simdata->m_host = host;
156 simdata->data = data;
157 simdata->last_errno = MSG_OK;
159 /* Let's create the process: SIMIX may decide to start it right now,
160 * even before returning the flow control to us */
161 process = simcall_process_create(
162 name, std::move(code), simdata, host, -1, properties, 0);
165 /* Undo everything we have just changed */
170 simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process);
175 static int MSG_maestro(int argc, char** argv)
177 int res = MSG_main();
181 /* Become a process in the simulation
183 * Currently this can only be called by the main thread (once) and only work with some thread factories
184 * (currently ThreadContextFactory).
186 * In the future, it might be extended in order to attach other threads created by a third party library.
188 msg_process_t MSG_process_attach(const char *name, void *data, msg_host_t host, xbt_dict_t properties)
190 xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
191 simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1);
192 msg_process_t process;
194 /* Simulator data for MSG */
195 simdata->waiting_action = nullptr;
196 simdata->waiting_task = nullptr;
197 simdata->m_host = host;
198 simdata->data = data;
199 simdata->last_errno = MSG_OK;
201 /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
202 process = SIMIX_process_attach(name, simdata, host->cname(), properties, nullptr);
204 xbt_die("Could not attach");
205 simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process);
209 /** Detach a process attached with `MSG_process_attach()`
211 * This is called when the current process has finished its job.
212 * Used in the main thread, it waits for the simulation to finish before returning. When it returns, the other
213 * simulated processes and the maestro are destroyed.
215 void MSG_process_detach()
217 SIMIX_process_detach();
220 /** \ingroup m_process_management
221 * \param process poor victim
223 * This function simply kills a \a process... scary isn't it ? :)
225 void MSG_process_kill(msg_process_t process)
227 // /* FIXME: why do we only cancel communication actions? is this useful? */
228 // simdata_process_t p_simdata = simcall_process_get_data(process);
229 // if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) {
230 // simcall_comm_cancel(p_simdata->waiting_task->simdata->comm);
232 simcall_process_kill(process);
236 * \brief Wait for the completion of a #msg_process_t.
238 * \param process the process to wait for
239 * \param timeout wait until the process is over, or the timeout occurs
241 msg_error_t MSG_process_join(msg_process_t process, double timeout){
242 simcall_process_join(process, timeout);
246 /** \ingroup m_process_management
247 * \brief Migrates a process to another location.
249 * This function checks whether \a process and \a host are valid pointers and change the value of the #msg_host_t on
250 * which \a process is running.
252 msg_error_t MSG_process_migrate(msg_process_t process, msg_host_t host)
254 simdata_process_t simdata = (simdata_process_t) simcall_process_get_data(process);
255 simdata->m_host = host;
256 msg_host_t now = simdata->m_host;
257 TRACE_msg_process_change_host(process, now, host);
258 simcall_process_set_host(process, host);
262 /** \ingroup m_process_management
263 * \brief Returns the user data of a process.
265 * This function checks whether \a process is a valid pointer and returns the user data associated to this process.
267 void* MSG_process_get_data(msg_process_t process)
269 xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
271 /* get from SIMIX the MSG process data, and then the user data */
272 simdata_process_t simdata = (simdata_process_t) simcall_process_get_data(process);
274 return simdata->data;
279 /** \ingroup m_process_management
280 * \brief Sets the user data of a process.
282 * This function checks whether \a process is a valid pointer and sets the user data associated to this process.
284 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
286 xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
288 simdata_process_t simdata = (simdata_process_t) simcall_process_get_data(process);
289 simdata->data = data;
294 /** \ingroup m_process_management
295 * \brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
296 * \param data_cleanup a cleanup function for the userdata of a process, or nullptr to call no function
298 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
299 msg_global->process_data_cleanup = data_cleanup;
302 /** \ingroup m_process_management
303 * \brief Return the location on which a process is running.
304 * \param process a process (nullptr means the current one)
305 * \return the msg_host_t corresponding to the location on which \a process is running.
307 msg_host_t MSG_process_get_host(msg_process_t process)
309 simdata_process_t simdata;
310 if (process == nullptr) {
311 simdata = (simdata_process_t) SIMIX_process_self_get_data();
314 simdata = (simdata_process_t) simcall_process_get_data(process);
316 return simdata ? simdata->m_host : nullptr;
319 /** \ingroup m_process_management
321 * \brief Return a #msg_process_t given its PID.
323 * 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.
324 * If no host is found, \c nullptr is returned.
325 Note that the PID are uniq in the whole simulation, not only on a given host.
327 msg_process_t MSG_process_from_PID(int PID)
329 return SIMIX_process_from_PID(PID);
332 /** @brief returns a list of all currently existing processes */
333 xbt_dynar_t MSG_processes_as_dynar() {
334 return SIMIX_processes_as_dynar();
337 /** @brief Return the current number MSG processes. */
338 int MSG_process_get_number()
340 return SIMIX_process_count();
343 /** \ingroup m_process_management
344 * \brief Set the kill time of a process.
346 * \param process a process
347 * \param kill_time the time when the process is killed.
349 msg_error_t MSG_process_set_kill_time(msg_process_t process, double kill_time)
351 simcall_process_set_kill_time(process,kill_time);
355 /** \ingroup m_process_management
356 * \brief Returns the process ID of \a process.
358 * This function checks whether \a process is a valid pointer and return its PID (or 0 in case of problem).
360 int MSG_process_get_PID(msg_process_t process)
362 /* Do not raise an exception here: this function is called by the logs
363 * and the exceptions, so it would be called back again and again */
364 if (process == nullptr)
369 /** \ingroup m_process_management
370 * \brief Returns the process ID of the parent of \a process.
372 * This function checks whether \a process is a valid pointer and return its PID.
373 * Returns -1 if the process has not been created by any other process.
375 int MSG_process_get_PPID(msg_process_t process)
377 return process->ppid;
380 /** \ingroup m_process_management
381 * \brief Return the name of a process.
383 * This function checks whether \a process is a valid pointer and return its name.
385 const char *MSG_process_get_name(msg_process_t process)
387 return process->name.c_str();
390 /** \ingroup m_process_management
391 * \brief Returns the value of a given process property
393 * \param process a process
394 * \param name a property name
395 * \return value of a property (or nullptr if the property is not set)
397 const char *MSG_process_get_property_value(msg_process_t process, const char *name)
399 return (char*) xbt_dict_get_or_null(MSG_process_get_properties(process), name);
402 /** \ingroup m_process_management
403 * \brief Return the list of properties
405 * This function returns all the parameters associated with a process
407 xbt_dict_t MSG_process_get_properties(msg_process_t process)
409 xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
410 return simcall_process_get_properties(process);
413 /** \ingroup m_process_management
414 * \brief Return the PID of the current process.
416 * This function returns the PID of the currently running #msg_process_t.
418 int MSG_process_self_PID()
420 return MSG_process_get_PID(MSG_process_self());
423 /** \ingroup m_process_management
424 * \brief Return the PPID of the current process.
426 * This function returns the PID of the parent of the currently running #msg_process_t.
428 int MSG_process_self_PPID()
430 return MSG_process_get_PPID(MSG_process_self());
433 /** \ingroup m_process_management
434 * \brief Return the current process.
436 * This function returns the currently running #msg_process_t.
438 msg_process_t MSG_process_self()
440 return SIMIX_process_self();
443 /** \ingroup m_process_management
444 * \brief Suspend the process.
446 * This function suspends the process by suspending the task on which it was waiting for the completion.
448 msg_error_t MSG_process_suspend(msg_process_t process)
450 xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
452 TRACE_msg_process_suspend(process);
453 simcall_process_suspend(process);
457 /** \ingroup m_process_management
458 * \brief Resume a suspended process.
460 * This function resumes a suspended process by resuming the task on which it was waiting for the completion.
462 msg_error_t MSG_process_resume(msg_process_t process)
464 xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
466 TRACE_msg_process_resume(process);
467 simcall_process_resume(process);
471 /** \ingroup m_process_management
472 * \brief Returns true if the process is suspended .
474 * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
476 int MSG_process_is_suspended(msg_process_t process)
478 xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
479 return simcall_process_is_suspended(process);
482 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) {
483 return SIMIX_process_get_context(process);
486 * \ingroup m_process_management
487 * \brief Add a function to the list of "on_exit" functions for the current process.
488 * The on_exit functions are the functions executed when your process is killed.
489 * You should use them to free the data used by your process.
491 void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
492 simcall_process_on_exit(MSG_process_self(),fun,data);
495 * \ingroup m_process_management
496 * \brief Sets the "auto-restart" flag of the process.
497 * If the flag is set to 1, the process will be automatically restarted when its host comes back up.
499 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart) {
500 simcall_process_auto_restart_set(process,auto_restart);
503 * \ingroup m_process_management
504 * \brief Restarts a process from the beginning.
506 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process) {
507 return simcall_process_restart(process);