1 /* Copyright (c) 2004-2017. 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.h"
7 #include "simgrid/s4u/host.hpp"
8 #include "src/simix/ActorImpl.hpp"
10 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 a process.
26 * \param smx_proc a SIMIX process
28 void MSG_process_cleanup_from_SIMIX(smx_actor_t smx_actor)
30 simgrid::MsgActorExt* 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::MsgActorExt*)SIMIX_process_self_get_data();
36 SIMIX_process_self_set_data(nullptr);
38 msg_actor = (simgrid::MsgActorExt*)smx_actor->data;
39 simcall_process_set_data(smx_actor, nullptr);
42 TRACE_msg_process_destroy(smx_actor->name.c_str(), smx_actor->pid);
43 // free the data if a function was provided
44 if (msg_actor && msg_actor->data && msg_global->process_data_cleanup) {
45 msg_global->process_data_cleanup(msg_actor->data);
49 SIMIX_process_cleanup(smx_actor);
52 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
53 smx_actor_t MSG_process_create_from_SIMIX(const char* name, std::function<void()> code, void* data, sg_host_t host,
54 xbt_dict_t properties, smx_actor_t parent_process)
56 msg_process_t p = MSG_process_create_from_stdfunc(name, std::move(code), data, host, properties);
57 return p == nullptr ? nullptr : p->getImpl();
60 /** \ingroup m_process_management
61 * \brief Creates and runs a new #msg_process_t.
63 * Does exactly the same as #MSG_process_create_with_arguments but without providing standard arguments
64 * (\a argc, \a argv, \a start_time, \a kill_time).
65 * \sa MSG_process_create_with_arguments
67 msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
69 return MSG_process_create_with_environment(name, code, data, host, 0, nullptr, nullptr);
72 /** \ingroup m_process_management
73 * \brief Creates and runs a new #msg_process_t.
75 * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
76 * the corresponding thread) is created, and put in the list of ready process.
77 * \param name a name for the object. It is for user-level information and can be nullptr.
78 * \param code is a function describing the behavior of the process. It should then only use functions described
79 * in \ref m_process_management (to create a new #msg_process_t for example),
80 in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
81 in \ref m_task_management (to create or destroy some #msg_task_t for example) and
82 in \ref msg_task_usage (to handle file transfers and task processing).
83 * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and
84 * can be nullptr. It can be retrieved with the function \ref MSG_process_get_data.
85 * \param host the location where the new process is executed.
86 * \param argc first argument passed to \a code
87 * \param argv second argument passed to \a code
89 * \return The new corresponding object.
92 msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
93 int argc, char **argv)
95 return MSG_process_create_with_environment(name, code, data, host, argc, argv, nullptr);
98 /** \ingroup m_process_management
99 * \brief Creates and runs a new #msg_process_t.
101 * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
102 * the corresponding thread) is created, and put in the list of ready process.
103 * \param name a name for the object. It is for user-level information and can be nullptr.
104 * \param code is a function describing the behavior of the process. It should then only use functions described
105 * in \ref m_process_management (to create a new #msg_process_t for example),
106 in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
107 in \ref m_task_management (to create or destroy some #msg_task_t for example) and
108 in \ref msg_task_usage (to handle file transfers and task processing).
109 * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and
110 * can be nullptr. It can be retrieved with the function \ref MSG_process_get_data.
111 * \param host the location where the new process is executed.
112 * \param argc first argument passed to \a code
113 * \param argv second argument passed to \a code. WARNING, these strings are freed by the SimGrid kernel when the
114 * process exits, so they cannot be static nor shared between several processes.
115 * \param properties list a properties defined for this process
117 * \return The new corresponding object.
119 msg_process_t MSG_process_create_with_environment(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
120 int argc, char **argv, xbt_dict_t properties)
122 std::function<void()> function;
124 function = simgrid::xbt::wrapMain(code, argc, const_cast<const char*const*>(argv));
125 msg_process_t res = MSG_process_create_from_stdfunc(name, std::move(function), data, host, properties);
126 for (int i = 0; i != argc; ++i)
134 msg_process_t MSG_process_create_from_stdfunc(const char* name, std::function<void()> code, void* data, msg_host_t host,
135 xbt_dict_t properties)
137 xbt_assert(code != nullptr && host != nullptr, "Invalid parameters: host and code params must not be nullptr");
138 simgrid::MsgActorExt* msgExt = new simgrid::MsgActorExt(data);
140 smx_actor_t process = simcall_process_create(name, std::move(code), msgExt, host, properties);
142 if (!process) { /* Undo everything */
147 simcall_process_on_exit(process, (int_f_pvoid_pvoid_t)TRACE_msg_process_kill, process);
148 return process->ciface();
153 /* Become a process in the simulation
155 * Currently this can only be called by the main thread (once) and only work with some thread factories
156 * (currently ThreadContextFactory).
158 * In the future, it might be extended in order to attach other threads created by a third party library.
160 msg_process_t MSG_process_attach(const char *name, void *data, msg_host_t host, xbt_dict_t properties)
162 xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
164 /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
165 smx_actor_t process = SIMIX_process_attach(name, new simgrid::MsgActorExt(data), host->cname(), properties, nullptr);
167 xbt_die("Could not attach");
168 simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process);
169 return process->ciface();
172 /** Detach a process attached with `MSG_process_attach()`
174 * This is called when the current process has finished its job.
175 * Used in the main thread, it waits for the simulation to finish before returning. When it returns, the other
176 * simulated processes and the maestro are destroyed.
178 void MSG_process_detach()
180 SIMIX_process_detach();
183 /** \ingroup m_process_management
184 * \param process poor victim
186 * This function simply kills a \a process... scary isn't it ? :)
188 void MSG_process_kill(msg_process_t process)
190 simcall_process_kill(process->getImpl());
194 * \brief Wait for the completion of a #msg_process_t.
196 * \param process the process to wait for
197 * \param timeout wait until the process is over, or the timeout occurs
199 msg_error_t MSG_process_join(msg_process_t process, double timeout){
200 simcall_process_join(process->getImpl(), timeout);
204 /** \ingroup m_process_management
205 * \brief Migrates a process to another location.
207 * This function checks whether \a process and \a host are valid pointers and change the value of the #msg_host_t on
208 * which \a process is running.
210 msg_error_t MSG_process_migrate(msg_process_t process, msg_host_t host)
212 TRACE_msg_process_change_host(process, MSG_process_get_host(process), host);
213 simcall_process_set_host(process->getImpl(), host);
217 /** Yield the current actor; let the other actors execute first */
218 void MSG_process_yield()
220 simgrid::simix::kernelImmediate([] { /* do nothing*/ });
223 /** \ingroup m_process_management
224 * \brief Returns the user data of a process.
226 * This function checks whether \a process is a valid pointer and returns the user data associated to this process.
228 void* MSG_process_get_data(msg_process_t process)
230 xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
232 /* get from SIMIX the MSG process data, and then the user data */
233 simgrid::MsgActorExt* msgExt = (simgrid::MsgActorExt*)process->getImpl()->data;
240 /** \ingroup m_process_management
241 * \brief Sets the user data of a process.
243 * This function checks whether \a process is a valid pointer and sets the user data associated to this process.
245 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
247 xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
249 static_cast<simgrid::MsgActorExt*>(process->getImpl()->data)->data = data;
254 /** \ingroup m_process_management
255 * \brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
256 * \param data_cleanup a cleanup function for the userdata of a process, or nullptr to call no function
258 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
259 msg_global->process_data_cleanup = data_cleanup;
262 /** \ingroup m_process_management
263 * \brief Return the location on which a process is running.
264 * \param process a process (nullptr means the current one)
265 * \return the msg_host_t corresponding to the location on which \a process is running.
267 msg_host_t MSG_process_get_host(msg_process_t process)
269 if (process == nullptr) {
270 return SIMIX_process_self()->host;
272 return process->getImpl()->host;
276 /** \ingroup m_process_management
278 * \brief Return a #msg_process_t given its PID.
280 * 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.
281 * If no host is found, \c nullptr is returned.
282 Note that the PID are uniq in the whole simulation, not only on a given host.
284 msg_process_t MSG_process_from_PID(int PID)
286 return SIMIX_process_from_PID(PID)->ciface();
289 /** @brief returns a list of all currently existing processes */
290 xbt_dynar_t MSG_processes_as_dynar() {
291 return SIMIX_processes_as_dynar();
294 /** @brief Return the current number MSG processes. */
295 int MSG_process_get_number()
297 return SIMIX_process_count();
300 /** \ingroup m_process_management
301 * \brief Set the kill time of a process.
303 * \param process a process
304 * \param kill_time the time when the process is killed.
306 msg_error_t MSG_process_set_kill_time(msg_process_t process, double kill_time)
308 simcall_process_set_kill_time(process->getImpl(), kill_time);
312 /** \ingroup m_process_management
313 * \brief Returns the process ID of \a process.
315 * This function checks whether \a process is a valid pointer and return its PID (or 0 in case of problem).
317 int MSG_process_get_PID(msg_process_t process)
319 /* Do not raise an exception here: this function is called by the logs
320 * and the exceptions, so it would be called back again and again */
321 if (process == nullptr || process->getImpl() == nullptr)
323 return process->getImpl()->pid;
326 /** \ingroup m_process_management
327 * \brief Returns the process ID of the parent of \a process.
329 * This function checks whether \a process is a valid pointer and return its PID.
330 * Returns -1 if the process has not been created by any other process.
332 int MSG_process_get_PPID(msg_process_t process)
334 return process->getImpl()->ppid;
337 /** \ingroup m_process_management
338 * \brief Return the name of a process.
340 * This function checks whether \a process is a valid pointer and return its name.
342 const char *MSG_process_get_name(msg_process_t process)
344 return process->cname();
347 /** \ingroup m_process_management
348 * \brief Returns the value of a given process property
350 * \param process a process
351 * \param name a property name
352 * \return value of a property (or nullptr if the property is not set)
354 const char *MSG_process_get_property_value(msg_process_t process, const char *name)
356 return (char*) xbt_dict_get_or_null(MSG_process_get_properties(process), name);
359 /** \ingroup m_process_management
360 * \brief Return the list of properties
362 * This function returns all the parameters associated with a process
364 xbt_dict_t MSG_process_get_properties(msg_process_t process)
366 xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
367 return simcall_process_get_properties(process->getImpl());
370 /** \ingroup m_process_management
371 * \brief Return the PID of the current process.
373 * This function returns the PID of the currently running #msg_process_t.
375 int MSG_process_self_PID()
377 smx_actor_t self = SIMIX_process_self();
378 return self == nullptr ? 0 : self->pid;
381 /** \ingroup m_process_management
382 * \brief Return the PPID of the current process.
384 * This function returns the PID of the parent of the currently running #msg_process_t.
386 int MSG_process_self_PPID()
388 return MSG_process_get_PPID(MSG_process_self());
391 /** \ingroup m_process_management
392 * \brief Return the current process.
394 * This function returns the currently running #msg_process_t.
396 msg_process_t MSG_process_self()
398 return SIMIX_process_self()->ciface();
401 /** \ingroup m_process_management
402 * \brief Suspend the process.
404 * This function suspends the process by suspending the task on which it was waiting for the completion.
406 msg_error_t MSG_process_suspend(msg_process_t process)
408 xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
410 TRACE_msg_process_suspend(process);
411 simcall_process_suspend(process->getImpl());
415 /** \ingroup m_process_management
416 * \brief Resume a suspended process.
418 * This function resumes a suspended process by resuming the task on which it was waiting for the completion.
420 msg_error_t MSG_process_resume(msg_process_t process)
422 xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
424 TRACE_msg_process_resume(process);
425 simcall_process_resume(process->getImpl());
429 /** \ingroup m_process_management
430 * \brief Returns true if the process is suspended .
432 * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
434 int MSG_process_is_suspended(msg_process_t process)
436 return simcall_process_is_suspended(process->getImpl());
439 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) {
440 return SIMIX_process_get_context(process->getImpl());
443 * \ingroup m_process_management
444 * \brief Add a function to the list of "on_exit" functions for the current process.
445 * The on_exit functions are the functions executed when your process is killed.
446 * You should use them to free the data used by your process.
448 void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
449 simcall_process_on_exit(SIMIX_process_self(), fun, data);
452 * \ingroup m_process_management
453 * \brief Sets the "auto-restart" flag of the process.
454 * If the flag is set to 1, the process will be automatically restarted when its host comes back up.
456 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart) {
457 simcall_process_auto_restart_set(process->getImpl(), auto_restart);
460 * \ingroup m_process_management
461 * \brief Restarts a process from the beginning.
463 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process) {
464 return simcall_process_restart(process->getImpl())->ciface();
467 /** @ingroup m_process_management
468 * @brief This process will be terminated automatically when the last non-daemon process finishes
470 XBT_PUBLIC(void) MSG_process_daemonize(msg_process_t process)
472 simgrid::simix::kernelImmediate([process]() {
473 process->getImpl()->daemonize();
477 /** @ingroup m_process_management
478 * @brief Take an extra reference on that process to prevent it to be garbage-collected
480 XBT_PUBLIC(void) MSG_process_ref(msg_process_t process)
482 intrusive_ptr_add_ref(process);
484 /** @ingroup m_process_management
485 * @brief Release a reference on that process so that it can get be garbage-collected
487 XBT_PUBLIC(void) MSG_process_unref(msg_process_t process)
489 intrusive_ptr_release(process);