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 "xbt/sysdep.h"
10 #include "src/simix/smx_process_private.h"
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg,
13 "Logging specific to MSG (process)");
15 /** @addtogroup m_process_management
16 * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Processes" --> \endhtmlonly
18 * Processes (#msg_process_t) are independent agents that can do stuff on their own. They are in charge of executing your code interacting with the simulated world.
19 * A process may be defined as a <em>code</em> with some <em>private data</em>.
20 * Processes must be located on <em>hosts</em> (#msg_host_t), and they exchange data by sending tasks (#msg_task_t) that are similar to envelops containing data.
23 /******************************** Process ************************************/
26 * \brief Cleans the MSG data of a process.
27 * \param smx_proc a SIMIX process
29 void MSG_process_cleanup_from_SIMIX(smx_process_t smx_proc)
31 simdata_process_t msg_proc;
33 // get the MSG process from the SIMIX process
34 if (smx_proc == SIMIX_process_self()) {
35 /* avoid a SIMIX request if this function is called by the process itself */
36 msg_proc = (simdata_process_t) SIMIX_process_self_get_data(smx_proc);
37 SIMIX_process_self_set_data(smx_proc, NULL);
40 msg_proc = (simdata_process_t) simcall_process_get_data(smx_proc);
41 simcall_process_set_data(smx_proc, NULL);
44 TRACE_msg_process_end(smx_proc);
45 // free the data if a function was provided
46 if (msg_proc && msg_proc->data && msg_global->process_data_cleanup) {
47 msg_global->process_data_cleanup(msg_proc->data);
50 // free the MSG process
52 SIMIX_process_cleanup(smx_proc);
55 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
56 smx_process_t MSG_process_create_from_SIMIX(const char *name,
57 xbt_main_func_t code, void *data,
58 const char *hostname, double kill_time,
59 int argc, char **argv,
60 xbt_dict_t properties, int auto_restart,
61 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(name, code, data,
68 MSG_process_set_kill_time(p,kill_time);
69 MSG_process_auto_restart_set(p,auto_restart);
74 /** \ingroup m_process_management
75 * \brief Creates and runs a new #msg_process_t.
77 * Does exactly the same as #MSG_process_create_with_arguments but without
78 providing standard arguments (\a argc, \a argv, \a start_time, \a kill_time).
79 * \sa MSG_process_create_with_arguments
81 msg_process_t MSG_process_create(const char *name,
82 xbt_main_func_t code, void *data,
85 return MSG_process_create_with_environment(name, code, data, host, 0,
89 /** \ingroup m_process_management
90 * \brief Creates and runs a new #msg_process_t.
92 * A constructor for #msg_process_t taking four arguments and returning the
93 * corresponding object. The structure (and the corresponding thread) is
94 * created, and put in the list of ready process.
95 * \param name a name for the object. It is for user-level information
97 * \param code is a function describing the behavior of the process. It
98 should then only use functions described in \ref
99 m_process_management (to create a new #msg_process_t for example),
100 in \ref m_host_management (only the read-only functions i.e. whose
101 name contains the word get), in \ref m_task_management (to create
102 or destroy some #msg_task_t for example) and in \ref
103 msg_task_usage (to handle file transfers and task processing).
104 * \param data a pointer to any data one may want to attach to the new
105 object. It is for user-level information and can be NULL. It can
106 be retrieved with the function \ref MSG_process_get_data.
107 * \param host the location where the new process is executed.
108 * \param argc first argument passed to \a code
109 * \param argv second argument passed to \a code
111 * \return The new corresponding object.
114 msg_process_t MSG_process_create_with_arguments(const char *name,
115 xbt_main_func_t code,
116 void *data, msg_host_t host,
117 int argc, char **argv)
119 return MSG_process_create_with_environment(name, code, data, host,
123 /** \ingroup m_process_management
124 * \brief Creates and runs a new #msg_process_t.
126 * A constructor for #msg_process_t taking four arguments and returning the
127 * corresponding object. The structure (and the corresponding thread) is
128 * created, and put in the list of ready process.
129 * \param name a name for the object. It is for user-level information
131 * \param code is a function describing the behavior of the process. It
132 should then only use functions described in \ref
133 m_process_management (to create a new #msg_process_t for example),
134 in \ref m_host_management (only the read-only functions i.e. whose
135 name contains the word get), in \ref m_task_management (to create
136 or destroy some #msg_task_t for example) and in \ref
137 msg_task_usage (to handle file transfers and task processing).
138 * \param data a pointer to any data one may want to attach to the new
139 object. It is for user-level information and can be NULL. It can
140 be retrieved with the function \ref MSG_process_get_data.
141 * \param host the location where the new process is executed.
142 * \param argc first argument passed to \a code
143 * \param argv second argument passed to \a code. WARNING, these strings are freed by the SimGrid kernel when the process exits, so they cannot be static nor shared between several processes.
144 * \param properties list a properties defined for this process
146 * \return The new corresponding object.
148 msg_process_t MSG_process_create_with_environment(const char *name,
149 xbt_main_func_t code,
150 void *data, msg_host_t host,
151 int argc, char **argv,
152 xbt_dict_t properties)
154 xbt_assert(code != NULL && host != NULL, "Invalid parameters: host and code params must not be NULL");
155 simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1);
156 msg_process_t process;
158 /* Simulator data for MSG */
159 simdata->waiting_action = NULL;
160 simdata->waiting_task = NULL;
161 simdata->m_host = host;
162 simdata->argc = argc;
163 simdata->argv = argv;
164 simdata->data = data;
165 simdata->last_errno = MSG_OK;
167 /* Let's create the process: SIMIX may decide to start it right now,
168 * even before returning the flow control to us */
169 process = simcall_process_create(name, code, simdata, sg_host_get_name(host), -1,
170 argc, argv, properties,0);
172 TRACE_msg_process_create(name, SIMIX_process_get_PID(process), host);
175 /* Undo everything we have just changed */
180 simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process);
185 /** \ingroup m_process_management
186 * \param process poor victim
188 * This function simply kills a \a process... scary isn't it ? :)
190 void MSG_process_kill(msg_process_t process)
192 // /* FIXME: why do we only cancel communication actions? is this useful? */
193 // simdata_process_t p_simdata = simcall_process_get_data(process);
194 // if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) {
195 // simcall_comm_cancel(p_simdata->waiting_task->simdata->comm);
198 simcall_process_kill(process);
204 * \brief Wait for the completion of a #msg_process_t.
206 * \param process the process to wait for
207 * \param timeout wait until the process is over, or the timeout occurs
209 msg_error_t MSG_process_join(msg_process_t process, double timeout){
210 simcall_process_join(process, timeout);
214 /** \ingroup m_process_management
215 * \brief Migrates a process to another location.
217 * This function checks whether \a process and \a host are valid pointers
218 and change the value of the #msg_host_t on which \a process is running.
220 msg_error_t MSG_process_migrate(msg_process_t process, msg_host_t host)
222 simdata_process_t simdata = (simdata_process_t) simcall_process_get_data(process);
223 simdata->m_host = host;
224 msg_host_t now = simdata->m_host;
225 TRACE_msg_process_change_host(process, now, host);
226 simcall_process_set_host(process, host);
230 /** \ingroup m_process_management
231 * \brief Returns the user data of a process.
233 * This function checks whether \a process is a valid pointer or not
234 and returns the user data associated to this process.
236 void* MSG_process_get_data(msg_process_t process)
238 xbt_assert(process != NULL, "Invalid parameter: first parameter must not be NULL!");
240 /* get from SIMIX the MSG process data, and then the user data */
241 simdata_process_t simdata = (simdata_process_t) simcall_process_get_data(process);
243 return simdata->data;
248 /** \ingroup m_process_management
249 * \brief Sets the user data of a process.
251 * This function checks whether \a process is a valid pointer or not
252 and sets the user data associated to this process.
254 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
256 xbt_assert(process != NULL, "Invalid parameter: first parameter must not be NULL!");
258 simdata_process_t simdata =
259 (simdata_process_t) simcall_process_get_data(process);
260 simdata->data = data;
265 /** \ingroup m_process_management
266 * \brief Sets a cleanup function to be called to free the userdata of a
267 * process when a process is destroyed.
268 * \param data_cleanup a cleanup function for the userdata of a process,
269 * or NULL to call no function
271 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
273 msg_global->process_data_cleanup = data_cleanup;
276 /** \ingroup m_process_management
277 * \brief Return the location on which a process is running.
278 * \param process a process (NULL means the current one)
279 * \return the msg_host_t corresponding to the location on which \a
280 * process is running.
282 msg_host_t MSG_process_get_host(msg_process_t process)
284 simdata_process_t simdata;
285 if (process == NULL) {
286 simdata = (simdata_process_t) SIMIX_process_self_get_data(SIMIX_process_self());
289 simdata = (simdata_process_t) simcall_process_get_data(process);
291 return simdata ? simdata->m_host : NULL;
294 /** \ingroup m_process_management
296 * \brief Return a #msg_process_t given its PID.
298 * This function search in the list of all the created msg_process_t for a msg_process_t
299 whose PID is equal to \a PID. If no host is found, \c NULL is returned.
300 Note that the PID are uniq in the whole simulation, not only on a given host.
302 msg_process_t MSG_process_from_PID(int PID)
304 return SIMIX_process_from_PID(PID);
307 /** @brief returns a list of all currently existing processes */
308 xbt_dynar_t MSG_processes_as_dynar(void) {
309 return SIMIX_processes_as_dynar();
311 /** @brief Return the current number MSG processes.
313 int MSG_process_get_number(void)
315 return SIMIX_process_count();
318 /** \ingroup m_process_management
319 * \brief Set the kill time of a process.
321 * \param process a process
322 * \param kill_time the time when the process is killed.
324 msg_error_t MSG_process_set_kill_time(msg_process_t process, double kill_time)
326 simcall_process_set_kill_time(process,kill_time);
330 /** \ingroup m_process_management
331 * \brief Returns the process ID of \a process.
333 * This function checks whether \a process is a valid pointer or not
334 and return its PID (or 0 in case of problem).
336 int MSG_process_get_PID(msg_process_t process)
338 /* Do not raise an exception here: this function is called by the logs
339 * and the exceptions, so it would be called back again and again */
340 if (process == NULL) {
343 return simcall_process_get_PID(process);
346 /** \ingroup m_process_management
347 * \brief Returns the process ID of the parent of \a process.
349 * This function checks whether \a process is a valid pointer or not
350 and return its PID. Returns -1 if the process has not been created by
353 int MSG_process_get_PPID(msg_process_t process)
355 xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
357 return simcall_process_get_PPID(process);
360 /** \ingroup m_process_management
361 * \brief Return the name of a process.
363 * This function checks whether \a process is a valid pointer or not
366 const char *MSG_process_get_name(msg_process_t process)
368 xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
370 return simcall_process_get_name(process);
373 /** \ingroup m_process_management
374 * \brief Returns the value of a given process property
376 * \param process a process
377 * \param name a property name
378 * \return value of a property (or NULL if the property is not set)
380 const char *MSG_process_get_property_value(msg_process_t process,
383 return (char*) xbt_dict_get_or_null(MSG_process_get_properties(process), name);
386 /** \ingroup m_process_management
387 * \brief Return the list of properties
389 * This function returns all the parameters associated with a process
391 xbt_dict_t MSG_process_get_properties(msg_process_t process)
393 xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
395 return simcall_process_get_properties(process);
399 /** \ingroup m_process_management
400 * \brief Return the PID of the current process.
402 * This function returns the PID of the currently running #msg_process_t.
404 int MSG_process_self_PID(void)
406 return MSG_process_get_PID(MSG_process_self());
409 /** \ingroup m_process_management
410 * \brief Return the PPID of the current process.
412 * This function returns the PID of the parent of the currently
413 * running #msg_process_t.
415 int MSG_process_self_PPID(void)
417 return MSG_process_get_PPID(MSG_process_self());
420 /** \ingroup m_process_management
421 * \brief Return the current process.
423 * This function returns the currently running #msg_process_t.
425 msg_process_t MSG_process_self(void)
427 return SIMIX_process_self();
430 /** \ingroup m_process_management
431 * \brief Suspend the process.
433 * This function suspends the process by suspending the task on which
434 * it was waiting for the completion.
436 msg_error_t MSG_process_suspend(msg_process_t process)
438 xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
440 TRACE_msg_process_suspend(process);
441 simcall_process_suspend(process);
445 /** \ingroup m_process_management
446 * \brief Resume a suspended process.
448 * This function resumes a suspended process by resuming the task on
449 * which it was waiting for the completion.
451 msg_error_t MSG_process_resume(msg_process_t process)
453 xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
455 TRACE_msg_process_resume(process);
456 simcall_process_resume(process);
460 /** \ingroup m_process_management
461 * \brief Returns true if the process is suspended .
463 * This checks whether a process is suspended or not by inspecting the
464 * task on which it was waiting for the completion.
466 int MSG_process_is_suspended(msg_process_t process)
468 xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
469 return simcall_process_is_suspended(process);
472 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) {
473 return SIMIX_process_get_context(process);
476 * \ingroup m_process_management
477 * \brief Add a function to the list of "on_exit" functions for the current process.
478 * The on_exit functions are the functions executed when your process is killed.
479 * You should use them to free the data used by your process.
481 void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
482 simcall_process_on_exit(MSG_process_self(),fun,data);
485 * \ingroup m_process_management
486 * \brief Sets the "auto-restart" flag of the process.
487 * If the flag is set to 1, the process will be automatically restarted when
488 * its host comes back up.
490 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart) {
491 simcall_process_auto_restart_set(process,auto_restart);
494 * \ingroup m_process_management
495 * \brief Restarts a process from the beginning.
497 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process) {
498 return simcall_process_restart(process);