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"
11 #include "src/simix/smx_private.h"
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "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
19 * your code interacting with the simulated world.
20 * A process may be defined as a <em>code</em> with some <em>private data</em>.
21 * Processes must be located on <em>hosts</em> (#msg_host_t), and they exchange data by sending tasks (#msg_task_t)
22 * that are similar to envelops containing data.
25 /******************************** Process ************************************/
27 * \brief Cleans the MSG data of a process.
28 * \param smx_proc a SIMIX process
30 void MSG_process_cleanup_from_SIMIX(smx_process_t smx_proc)
32 simdata_process_t msg_proc;
34 // get the MSG process from the SIMIX process
35 if (smx_proc == SIMIX_process_self()) {
36 /* avoid a SIMIX request if this function is called by the process itself */
37 msg_proc = (simdata_process_t) SIMIX_process_self_get_data();
38 SIMIX_process_self_set_data(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_destroy(smx_proc->name, smx_proc->pid);
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, xbt_main_func_t code, void *data, const char *hostname,
57 double kill_time, int argc, char **argv, xbt_dict_t properties,
58 int auto_restart, smx_process_t parent_process)
60 msg_host_t host = MSG_host_by_name(hostname);
61 msg_process_t p = MSG_process_create_with_environment(name, code, data, host, argc, argv, properties);
63 MSG_process_set_kill_time(p,kill_time);
64 MSG_process_auto_restart_set(p,auto_restart);
69 /** \ingroup m_process_management
70 * \brief Creates and runs a new #msg_process_t.
72 * Does exactly the same as #MSG_process_create_with_arguments but without providing standard arguments
73 * (\a argc, \a argv, \a start_time, \a kill_time).
74 * \sa MSG_process_create_with_arguments
76 msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
78 return MSG_process_create_with_environment(name, code, data, host, 0, NULL, NULL);
81 /** \ingroup m_process_management
82 * \brief Creates and runs a new #msg_process_t.
84 * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
85 * the corresponding thread) is created, and put in the list of ready process.
86 * \param name a name for the object. It is for user-level information and can be NULL.
87 * \param code is a function describing the behavior of the process. It should then only use functions described
88 * in \ref m_process_management (to create a new #msg_process_t for example),
89 in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
90 in \ref m_task_management (to create or destroy some #msg_task_t for example) and
91 in \ref msg_task_usage (to handle file transfers and task processing).
92 * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and
93 * can be NULL. It can be retrieved with the function \ref MSG_process_get_data.
94 * \param host the location where the new process is executed.
95 * \param argc first argument passed to \a code
96 * \param argv second argument passed to \a code
98 * \return The new corresponding object.
101 msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
102 int argc, char **argv)
104 return MSG_process_create_with_environment(name, code, data, host, argc, argv, NULL);
107 /** \ingroup m_process_management
108 * \brief Creates and runs a new #msg_process_t.
110 * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
111 * the corresponding thread) is created, and put in the list of ready process.
112 * \param name a name for the object. It is for user-level information and can be NULL.
113 * \param code is a function describing the behavior of the process. It should then only use functions described
114 * in \ref m_process_management (to create a new #msg_process_t for example),
115 in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
116 in \ref m_task_management (to create or destroy some #msg_task_t for example) and
117 in \ref msg_task_usage (to handle file transfers and task processing).
118 * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and
119 * can be NULL. It can be retrieved with the function \ref MSG_process_get_data.
120 * \param host the location where the new process is executed.
121 * \param argc first argument passed to \a code
122 * \param argv second argument passed to \a code. WARNING, these strings are freed by the SimGrid kernel when the
123 * process exits, so they cannot be static nor shared between several processes.
124 * \param properties list a properties defined for this process
126 * \return The new corresponding object.
128 msg_process_t MSG_process_create_with_environment(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
129 int argc, char **argv, xbt_dict_t properties)
131 xbt_assert(code != NULL && host != NULL, "Invalid parameters: host and code params must not be NULL");
132 simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1);
133 msg_process_t process;
135 /* Simulator data for MSG */
136 simdata->waiting_action = NULL;
137 simdata->waiting_task = NULL;
138 simdata->m_host = host;
139 simdata->argc = argc;
140 simdata->argv = argv;
141 simdata->data = data;
142 simdata->last_errno = MSG_OK;
144 /* Let's create the process: SIMIX may decide to start it right now,
145 * even before returning the flow control to us */
146 process = simcall_process_create(name, code, simdata, sg_host_get_name(host), -1, argc, argv, properties,0);
149 /* Undo everything we have just changed */
154 simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process);
159 static int MSG_maestro(int argc, char** argv)
161 int res = MSG_main();
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 != NULL, "Invalid parameters: host and code params must not be NULL");
175 simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1);
176 msg_process_t process;
178 /* Simulator data for MSG */
179 simdata->waiting_action = NULL;
180 simdata->waiting_task = NULL;
181 simdata->m_host = host;
183 simdata->argv = NULL;
184 simdata->data = data;
185 simdata->last_errno = MSG_OK;
187 /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
188 process = SIMIX_process_attach(name, simdata, sg_host_get_name(host), properties, NULL);
190 xbt_die("Could not attach");
191 simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process);
195 /** Detach a process attached with `MSG_process_attach()`
197 * This is called when the current process has finished its job.
198 * Used in the main thread, it waits for the simulation to finish before returning. When it returns, the other
199 * simulated processes and the maestro are destroyed.
201 void MSG_process_detach(void)
203 SIMIX_process_detach();
206 /** \ingroup m_process_management
207 * \param process poor victim
209 * This function simply kills a \a process... scary isn't it ? :)
211 void MSG_process_kill(msg_process_t process)
213 // /* FIXME: why do we only cancel communication actions? is this useful? */
214 // simdata_process_t p_simdata = simcall_process_get_data(process);
215 // if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) {
216 // simcall_comm_cancel(p_simdata->waiting_task->simdata->comm);
218 simcall_process_kill(process);
222 * \brief Wait for the completion of a #msg_process_t.
224 * \param process the process to wait for
225 * \param timeout wait until the process is over, or the timeout occurs
227 msg_error_t MSG_process_join(msg_process_t process, double timeout){
228 simcall_process_join(process, timeout);
232 /** \ingroup m_process_management
233 * \brief Migrates a process to another location.
235 * This function checks whether \a process and \a host are valid pointers and change the value of the #msg_host_t on
236 * which \a process is running.
238 msg_error_t MSG_process_migrate(msg_process_t process, msg_host_t host)
240 simdata_process_t simdata = (simdata_process_t) simcall_process_get_data(process);
241 simdata->m_host = host;
242 msg_host_t now = simdata->m_host;
243 TRACE_msg_process_change_host(process, now, host);
244 simcall_process_set_host(process, host);
248 /** \ingroup m_process_management
249 * \brief Returns the user data of a process.
251 * This function checks whether \a process is a valid pointer and returns the user data associated to this process.
253 void* MSG_process_get_data(msg_process_t process)
255 xbt_assert(process != NULL, "Invalid parameter: first parameter must not be NULL!");
257 /* get from SIMIX the MSG process data, and then the user data */
258 simdata_process_t simdata = (simdata_process_t) simcall_process_get_data(process);
260 return simdata->data;
265 /** \ingroup m_process_management
266 * \brief Sets the user data of a process.
268 * This function checks whether \a process is a valid pointer and sets the user data associated to this process.
270 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
272 xbt_assert(process != NULL, "Invalid parameter: first parameter must not be NULL!");
274 simdata_process_t simdata = (simdata_process_t) simcall_process_get_data(process);
275 simdata->data = data;
280 /** \ingroup m_process_management
281 * \brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
282 * \param data_cleanup a cleanup function for the userdata of a process, or NULL to call no function
284 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
285 msg_global->process_data_cleanup = data_cleanup;
288 /** \ingroup m_process_management
289 * \brief Return the location on which a process is running.
290 * \param process a process (NULL means the current one)
291 * \return the msg_host_t corresponding to the location on which \a process is running.
293 msg_host_t MSG_process_get_host(msg_process_t process)
295 simdata_process_t simdata;
296 if (process == NULL) {
297 simdata = (simdata_process_t) SIMIX_process_self_get_data();
300 simdata = (simdata_process_t) simcall_process_get_data(process);
302 return simdata ? simdata->m_host : NULL;
305 /** \ingroup m_process_management
307 * \brief Return a #msg_process_t given its PID.
309 * 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.
310 * If no host is found, \c NULL is returned.
311 Note that the PID are uniq in the whole simulation, not only on a given host.
313 msg_process_t MSG_process_from_PID(int PID)
315 return SIMIX_process_from_PID(PID);
318 /** @brief returns a list of all currently existing processes */
319 xbt_dynar_t MSG_processes_as_dynar(void) {
320 return SIMIX_processes_as_dynar();
323 /** @brief Return the current number MSG processes. */
324 int MSG_process_get_number(void)
326 return SIMIX_process_count();
329 /** \ingroup m_process_management
330 * \brief Set the kill time of a process.
332 * \param process a process
333 * \param kill_time the time when the process is killed.
335 msg_error_t MSG_process_set_kill_time(msg_process_t process, double kill_time)
337 simcall_process_set_kill_time(process,kill_time);
341 /** \ingroup m_process_management
342 * \brief Returns the process ID of \a process.
344 * This function checks whether \a process is a valid pointer and return its PID (or 0 in case of problem).
346 int MSG_process_get_PID(msg_process_t process)
348 /* Do not raise an exception here: this function is called by the logs
349 * and the exceptions, so it would be called back again and again */
350 if (process == NULL) {
353 return simcall_process_get_PID(process);
356 /** \ingroup m_process_management
357 * \brief Returns the process ID of the parent of \a process.
359 * This function checks whether \a process is a valid pointer and return its PID.
360 * Returns -1 if the process has not been created by any other process.
362 int MSG_process_get_PPID(msg_process_t process)
364 xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
365 return simcall_process_get_PPID(process);
368 /** \ingroup m_process_management
369 * \brief Return the name of a process.
371 * This function checks whether \a process is a valid pointer and return its name.
373 const char *MSG_process_get_name(msg_process_t process)
375 xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
376 return simcall_process_get_name(process);
379 /** \ingroup m_process_management
380 * \brief Returns the value of a given process property
382 * \param process a process
383 * \param name a property name
384 * \return value of a property (or NULL if the property is not set)
386 const char *MSG_process_get_property_value(msg_process_t process, const char *name)
388 return (char*) xbt_dict_get_or_null(MSG_process_get_properties(process), name);
391 /** \ingroup m_process_management
392 * \brief Return the list of properties
394 * This function returns all the parameters associated with a process
396 xbt_dict_t MSG_process_get_properties(msg_process_t process)
398 xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
399 return simcall_process_get_properties(process);
402 /** \ingroup m_process_management
403 * \brief Return the PID of the current process.
405 * This function returns the PID of the currently running #msg_process_t.
407 int MSG_process_self_PID(void)
409 return MSG_process_get_PID(MSG_process_self());
412 /** \ingroup m_process_management
413 * \brief Return the PPID of the current process.
415 * This function returns the PID of the parent of the currently running #msg_process_t.
417 int MSG_process_self_PPID(void)
419 return MSG_process_get_PPID(MSG_process_self());
422 /** \ingroup m_process_management
423 * \brief Return the current process.
425 * This function returns the currently running #msg_process_t.
427 msg_process_t MSG_process_self(void)
429 return SIMIX_process_self();
432 /** \ingroup m_process_management
433 * \brief Suspend the process.
435 * This function suspends the process by suspending the task on which it was waiting for the completion.
437 msg_error_t MSG_process_suspend(msg_process_t process)
439 xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
441 TRACE_msg_process_suspend(process);
442 simcall_process_suspend(process);
446 /** \ingroup m_process_management
447 * \brief Resume a suspended process.
449 * This function resumes a suspended process by resuming the task on 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 task on which it was waiting for the completion.
465 int MSG_process_is_suspended(msg_process_t process)
467 xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
468 return simcall_process_is_suspended(process);
471 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) {
472 return SIMIX_process_get_context(process);
475 * \ingroup m_process_management
476 * \brief Add a function to the list of "on_exit" functions for the current process.
477 * The on_exit functions are the functions executed when your process is killed.
478 * You should use them to free the data used by your process.
480 void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
481 simcall_process_on_exit(MSG_process_self(),fun,data);
484 * \ingroup m_process_management
485 * \brief Sets the "auto-restart" flag of the process.
486 * If the flag is set to 1, the process will be automatically restarted when its host comes back up.
488 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart) {
489 simcall_process_auto_restart_set(process,auto_restart);
492 * \ingroup m_process_management
493 * \brief Restarts a process from the beginning.
495 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process) {
496 return simcall_process_restart(process);