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. */
7 #include "msg_private.h"
8 #include "simgrid/s4u/host.hpp"
9 #include "src/simix/ActorImpl.hpp"
11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (process)");
13 /** @addtogroup m_process_management
15 * Processes (#msg_process_t) are independent agents that can do stuff on their own. They are in charge of executing
16 * your code interacting with the simulated world.
17 * A process may be defined as a <em>code</em> with some <em>private data</em>.
18 * Processes must be located on <em>hosts</em> (#msg_host_t), and they exchange data by sending tasks (#msg_task_t)
19 * that are similar to envelops containing data.
22 /******************************** Process ************************************/
24 * \brief Cleans the MSG data of a process.
25 * \param smx_proc a SIMIX process
27 void MSG_process_cleanup_from_SIMIX(smx_actor_t smx_actor)
29 MsgActorExt* msg_actor;
31 // get the MSG process from the SIMIX process
32 if (smx_actor == SIMIX_process_self()) {
33 /* avoid a SIMIX request if this function is called by the process itself */
34 msg_actor = (MsgActorExt*)SIMIX_process_self_get_data();
35 SIMIX_process_self_set_data(nullptr);
37 msg_actor = (MsgActorExt*)smx_actor->data;
38 simcall_process_set_data(smx_actor, nullptr);
41 TRACE_msg_process_destroy(smx_actor->name.c_str(), smx_actor->pid);
42 // free the data if a function was provided
43 if (msg_actor && msg_actor->data && msg_global->process_data_cleanup) {
44 msg_global->process_data_cleanup(msg_actor->data);
47 // free the MSG process
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(
54 const char *name, std::function<void()> code, void *data, sg_host_t host,
55 double kill_time, xbt_dict_t properties,
56 int auto_restart, smx_actor_t parent_process)
58 msg_process_t p = MSG_process_create_with_environment(name, std::move(code), data, host, properties);
60 MSG_process_set_kill_time(p,kill_time);
61 MSG_process_auto_restart_set(p,auto_restart);
66 /** \ingroup m_process_management
67 * \brief Creates and runs a new #msg_process_t.
69 * Does exactly the same as #MSG_process_create_with_arguments but without providing standard arguments
70 * (\a argc, \a argv, \a start_time, \a kill_time).
71 * \sa MSG_process_create_with_arguments
73 msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
75 return MSG_process_create_with_environment(name, code, data, host, 0, nullptr, nullptr);
78 /** \ingroup m_process_management
79 * \brief Creates and runs a new #msg_process_t.
81 * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
82 * the corresponding thread) is created, and put in the list of ready process.
83 * \param name a name for the object. It is for user-level information and can be nullptr.
84 * \param code is a function describing the behavior of the process. It should then only use functions described
85 * in \ref m_process_management (to create a new #msg_process_t for example),
86 in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
87 in \ref m_task_management (to create or destroy some #msg_task_t for example) and
88 in \ref msg_task_usage (to handle file transfers and task processing).
89 * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and
90 * can be nullptr. It can be retrieved with the function \ref MSG_process_get_data.
91 * \param host the location where the new process is executed.
92 * \param argc first argument passed to \a code
93 * \param argv second argument passed to \a code
95 * \return The new corresponding object.
98 msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
99 int argc, char **argv)
101 return MSG_process_create_with_environment(name, code, data, host, argc, argv, nullptr);
104 /** \ingroup m_process_management
105 * \brief Creates and runs a new #msg_process_t.
107 * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
108 * the corresponding thread) is created, and put in the list of ready process.
109 * \param name a name for the object. It is for user-level information and can be nullptr.
110 * \param code is a function describing the behavior of the process. It should then only use functions described
111 * in \ref m_process_management (to create a new #msg_process_t for example),
112 in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
113 in \ref m_task_management (to create or destroy some #msg_task_t for example) and
114 in \ref msg_task_usage (to handle file transfers and task processing).
115 * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and
116 * can be nullptr. It can be retrieved with the function \ref MSG_process_get_data.
117 * \param host the location where the new process is executed.
118 * \param argc first argument passed to \a code
119 * \param argv second argument passed to \a code. WARNING, these strings are freed by the SimGrid kernel when the
120 * process exits, so they cannot be static nor shared between several processes.
121 * \param properties list a properties defined for this process
123 * \return The new corresponding object.
125 msg_process_t MSG_process_create_with_environment(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
126 int argc, char **argv, xbt_dict_t properties)
128 std::function<void()> function;
130 function = simgrid::xbt::wrapMain(code, argc, const_cast<const char*const*>(argv));
131 msg_process_t res = MSG_process_create_with_environment(name,
132 std::move(function), data, host, properties);
133 for (int i = 0; i != argc; ++i)
139 msg_process_t MSG_process_create_with_environment(
140 const char *name, std::function<void()> code, void *data,
141 msg_host_t host, xbt_dict_t properties)
143 xbt_assert(code != nullptr && host != nullptr, "Invalid parameters: host and code params must not be nullptr");
144 MsgActorExt* simdata = new MsgActorExt();
146 /* Simulator data for MSG */
147 simdata->m_host = host;
148 simdata->data = data;
150 /* Let's create the process: SIMIX may decide to start it right now,
151 * even before returning the flow control to us */
152 msg_process_t process = simcall_process_create(name, std::move(code), simdata, host, -1, properties, 0);
155 /* Undo everything we have just changed */
160 simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process);
165 /* Become a process in the simulation
167 * Currently this can only be called by the main thread (once) and only work with some thread factories
168 * (currently ThreadContextFactory).
170 * In the future, it might be extended in order to attach other threads created by a third party library.
172 msg_process_t MSG_process_attach(const char *name, void *data, msg_host_t host, xbt_dict_t properties)
174 xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
175 MsgActorExt* msgExt = new MsgActorExt();
177 /* Simulator data for MSG */
178 msgExt->m_host = host;
181 /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
182 msg_process_t process = SIMIX_process_attach(name, msgExt, host->cname(), properties, nullptr);
184 xbt_die("Could not attach");
185 simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process);
189 /** Detach a process attached with `MSG_process_attach()`
191 * This is called when the current process has finished its job.
192 * Used in the main thread, it waits for the simulation to finish before returning. When it returns, the other
193 * simulated processes and the maestro are destroyed.
195 void MSG_process_detach()
197 SIMIX_process_detach();
200 /** \ingroup m_process_management
201 * \param process poor victim
203 * This function simply kills a \a process... scary isn't it ? :)
205 void MSG_process_kill(msg_process_t process)
207 simcall_process_kill(process);
211 * \brief Wait for the completion of a #msg_process_t.
213 * \param process the process to wait for
214 * \param timeout wait until the process is over, or the timeout occurs
216 msg_error_t MSG_process_join(msg_process_t process, double timeout){
217 simcall_process_join(process, timeout);
221 /** \ingroup m_process_management
222 * \brief Migrates a process to another location.
224 * This function checks whether \a process and \a host are valid pointers and change the value of the #msg_host_t on
225 * which \a process is running.
227 msg_error_t MSG_process_migrate(msg_process_t process, msg_host_t host)
229 MsgActorExt* msgExt = (MsgActorExt*)process->data;
230 msgExt->m_host = host;
231 msg_host_t now = msgExt->m_host;
232 TRACE_msg_process_change_host(process, now, host);
233 simcall_process_set_host(process, host);
237 /** Yield the current actor; let the other actors execute first */
238 void MSG_process_yield()
240 simgrid::simix::kernelImmediate([] { /* do nothing*/ });
243 /** \ingroup m_process_management
244 * \brief Returns the user data of a process.
246 * This function checks whether \a process is a valid pointer and returns the user data associated to this process.
248 void* MSG_process_get_data(msg_process_t process)
250 xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
252 /* get from SIMIX the MSG process data, and then the user data */
253 MsgActorExt* msgExt = (MsgActorExt*)process->data;
260 /** \ingroup m_process_management
261 * \brief Sets the user data of a process.
263 * This function checks whether \a process is a valid pointer and sets the user data associated to this process.
265 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
267 xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
269 MsgActorExt* msgExt = (MsgActorExt*)process->data;
275 /** \ingroup m_process_management
276 * \brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
277 * \param data_cleanup a cleanup function for the userdata of a process, or nullptr to call no function
279 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
280 msg_global->process_data_cleanup = data_cleanup;
283 /** \ingroup m_process_management
284 * \brief Return the location on which a process is running.
285 * \param process a process (nullptr means the current one)
286 * \return the msg_host_t corresponding to the location on which \a process is running.
288 msg_host_t MSG_process_get_host(msg_process_t process)
291 if (process == nullptr) {
292 msgExt = (MsgActorExt*)SIMIX_process_self_get_data();
295 msgExt = (MsgActorExt*)process->data;
297 return msgExt ? msgExt->m_host : nullptr;
300 /** \ingroup m_process_management
302 * \brief Return a #msg_process_t given its PID.
304 * 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.
305 * If no host is found, \c nullptr is returned.
306 Note that the PID are uniq in the whole simulation, not only on a given host.
308 msg_process_t MSG_process_from_PID(int PID)
310 return SIMIX_process_from_PID(PID);
313 /** @brief returns a list of all currently existing processes */
314 xbt_dynar_t MSG_processes_as_dynar() {
315 return SIMIX_processes_as_dynar();
318 /** @brief Return the current number MSG processes. */
319 int MSG_process_get_number()
321 return SIMIX_process_count();
324 /** \ingroup m_process_management
325 * \brief Set the kill time of a process.
327 * \param process a process
328 * \param kill_time the time when the process is killed.
330 msg_error_t MSG_process_set_kill_time(msg_process_t process, double kill_time)
332 simcall_process_set_kill_time(process,kill_time);
336 /** \ingroup m_process_management
337 * \brief Returns the process ID of \a process.
339 * This function checks whether \a process is a valid pointer and return its PID (or 0 in case of problem).
341 int MSG_process_get_PID(msg_process_t process)
343 /* Do not raise an exception here: this function is called by the logs
344 * and the exceptions, so it would be called back again and again */
345 if (process == nullptr)
350 /** \ingroup m_process_management
351 * \brief Returns the process ID of the parent of \a process.
353 * This function checks whether \a process is a valid pointer and return its PID.
354 * Returns -1 if the process has not been created by any other process.
356 int MSG_process_get_PPID(msg_process_t process)
358 return process->ppid;
361 /** \ingroup m_process_management
362 * \brief Return the name of a process.
364 * This function checks whether \a process is a valid pointer and return its name.
366 const char *MSG_process_get_name(msg_process_t process)
368 return process->name.c_str();
371 /** \ingroup m_process_management
372 * \brief Returns the value of a given process property
374 * \param process a process
375 * \param name a property name
376 * \return value of a property (or nullptr if the property is not set)
378 const char *MSG_process_get_property_value(msg_process_t process, const char *name)
380 return (char*) xbt_dict_get_or_null(MSG_process_get_properties(process), name);
383 /** \ingroup m_process_management
384 * \brief Return the list of properties
386 * This function returns all the parameters associated with a process
388 xbt_dict_t MSG_process_get_properties(msg_process_t process)
390 xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
391 return simcall_process_get_properties(process);
394 /** \ingroup m_process_management
395 * \brief Return the PID of the current process.
397 * This function returns the PID of the currently running #msg_process_t.
399 int MSG_process_self_PID()
401 return MSG_process_get_PID(MSG_process_self());
404 /** \ingroup m_process_management
405 * \brief Return the PPID of the current process.
407 * This function returns the PID of the parent of the currently running #msg_process_t.
409 int MSG_process_self_PPID()
411 return MSG_process_get_PPID(MSG_process_self());
414 /** \ingroup m_process_management
415 * \brief Return the current process.
417 * This function returns the currently running #msg_process_t.
419 msg_process_t MSG_process_self()
421 return SIMIX_process_self();
424 /** \ingroup m_process_management
425 * \brief Suspend the process.
427 * This function suspends the process by suspending the task on which it was waiting for the completion.
429 msg_error_t MSG_process_suspend(msg_process_t process)
431 xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
433 TRACE_msg_process_suspend(process);
434 simcall_process_suspend(process);
438 /** \ingroup m_process_management
439 * \brief Resume a suspended process.
441 * This function resumes a suspended process by resuming the task on which it was waiting for the completion.
443 msg_error_t MSG_process_resume(msg_process_t process)
445 xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
447 TRACE_msg_process_resume(process);
448 simcall_process_resume(process);
452 /** \ingroup m_process_management
453 * \brief Returns true if the process is suspended .
455 * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
457 int MSG_process_is_suspended(msg_process_t process)
459 xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
460 return simcall_process_is_suspended(process);
463 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) {
464 return SIMIX_process_get_context(process);
467 * \ingroup m_process_management
468 * \brief Add a function to the list of "on_exit" functions for the current process.
469 * The on_exit functions are the functions executed when your process is killed.
470 * You should use them to free the data used by your process.
472 void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
473 simcall_process_on_exit(MSG_process_self(),fun,data);
476 * \ingroup m_process_management
477 * \brief Sets the "auto-restart" flag of the process.
478 * If the flag is set to 1, the process will be automatically restarted when its host comes back up.
480 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart) {
481 simcall_process_auto_restart_set(process,auto_restart);
484 * \ingroup m_process_management
485 * \brief Restarts a process from the beginning.
487 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process) {
488 return simcall_process_restart(process);