1 /* Copyright (c) 2004-2013. 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"
11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg,
12 "Logging specific to MSG (process)");
14 /** @addtogroup m_process_management
15 * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Processes" --> \endhtmlonly
17 * We need to simulate many independent scheduling decisions, so
18 * the concept of <em>process</em> is at the heart of the
19 * simulator. A process may be defined as a <em>code</em>, with
20 * some <em>private data</em>, executing in a <em>location</em>.
24 /******************************** 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 = SIMIX_process_self_get_data(smx_proc);
38 SIMIX_process_self_set_data(smx_proc, NULL);
41 msg_proc = simcall_process_get_data(smx_proc);
42 simcall_process_set_data(smx_proc, NULL);
46 TRACE_msg_process_end(smx_proc);
48 // free the data if a function was provided
49 if (msg_proc && msg_proc->data && msg_global->process_data_cleanup) {
50 msg_global->process_data_cleanup(msg_proc->data);
53 // remove the process from its virtual machine
54 if (msg_proc && msg_proc->vm) {
55 int pos = xbt_dynar_search(msg_proc->vm->processes,&smx_proc);
56 xbt_dynar_remove_at(msg_proc->vm->processes,pos, NULL);
59 // free the MSG process
63 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
64 void MSG_process_create_from_SIMIX(smx_process_t* process, const char *name,
65 xbt_main_func_t code, void *data,
66 const char *hostname, double kill_time, int argc, char **argv,
67 xbt_dict_t properties, int auto_restart)
69 msg_host_t host = MSG_get_host_by_name(hostname);
70 msg_process_t p = MSG_process_create_with_environment(name, code, data,
74 MSG_process_set_kill_time(p,kill_time);
75 MSG_process_auto_restart_set(p,auto_restart);
77 *((msg_process_t*) process) = p;
80 /** \ingroup m_process_management
81 * \brief Creates and runs a new #msg_process_t.
83 * Does exactly the same as #MSG_process_create_with_arguments but without
84 providing standard arguments (\a argc, \a argv, \a start_time, \a kill_time).
85 * \sa MSG_process_create_with_arguments
87 msg_process_t MSG_process_create(const char *name,
88 xbt_main_func_t code, void *data,
91 return MSG_process_create_with_environment(name, code, data, host, -1,
95 /** \ingroup m_process_management
96 * \brief Creates and runs a new #msg_process_t.
98 * A constructor for #msg_process_t taking four arguments and returning the
99 * corresponding object. The structure (and the corresponding thread) is
100 * created, and put in the list of ready process.
101 * \param name a name for the object. It is for user-level information
103 * \param code is a function describing the behavior of the process. It
104 should then only use functions described in \ref
105 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
107 name contains the word get), in \ref m_task_management (to create
108 or destroy some #msg_task_t for example) and in \ref
109 msg_task_usage (to handle file transfers and task processing).
110 * \param data a pointer to any data one may want to attach to the new
111 object. It is for user-level information and can be NULL. It can
112 be retrieved with the function \ref MSG_process_get_data.
113 * \param host the location where the new process is executed.
114 * \param argc first argument passed to \a code
115 * \param argv second argument passed to \a code
117 * \return The new corresponding object.
120 msg_process_t MSG_process_create_with_arguments(const char *name,
121 xbt_main_func_t code,
122 void *data, msg_host_t host,
123 int argc, char **argv)
125 return MSG_process_create_with_environment(name, code, data, host,
129 /** \ingroup m_process_management
130 * \brief Creates and runs a new #msg_process_t.
132 * A constructor for #msg_process_t taking four arguments and returning the
133 * corresponding object. The structure (and the corresponding thread) is
134 * created, and put in the list of ready process.
135 * \param name a name for the object. It is for user-level information
137 * \param code is a function describing the behavior of the process. It
138 should then only use functions described in \ref
139 m_process_management (to create a new #msg_process_t for example),
140 in \ref m_host_management (only the read-only functions i.e. whose
141 name contains the word get), in \ref m_task_management (to create
142 or destroy some #msg_task_t for example) and in \ref
143 msg_task_usage (to handle file transfers and task processing).
144 * \param data a pointer to any data one may want to attach to the new
145 object. It is for user-level information and can be NULL. It can
146 be retrieved with the function \ref MSG_process_get_data.
147 * \param host the location where the new process is executed.
148 * \param argc first argument passed to \a code
149 * \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.
150 * \param properties list a properties defined for this process
152 * \return The new corresponding object.
154 msg_process_t MSG_process_create_with_environment(const char *name,
155 xbt_main_func_t code,
156 void *data, msg_host_t host,
157 int argc, char **argv,
158 xbt_dict_t properties)
160 xbt_assert(code != NULL && host != NULL, "Invalid parameters");
161 simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1);
162 msg_process_t process;
164 /* Simulator data for MSG */
165 simdata->waiting_action = NULL;
166 simdata->waiting_task = NULL;
167 simdata->m_host = host;
168 simdata->argc = argc;
169 simdata->argv = argv;
170 simdata->data = data;
171 simdata->last_errno = MSG_OK;
173 /* Let's create the process: SIMIX may decide to start it right now,
174 * even before returning the flow control to us */
175 simcall_process_create(&process, name, code, simdata, sg_host_name(host), -1,
176 argc, argv, properties,0);
179 TRACE_msg_process_create(name, simcall_process_get_PID(process), simdata->m_host);
183 /* Undo everything we have just changed */
189 simcall_process_on_exit(process,(int_f_pvoid_t)TRACE_msg_process_kill,MSG_process_self());
195 /** \ingroup m_process_management
196 * \param process poor victim
198 * This function simply kills a \a process... scary isn't it ? :)
200 void MSG_process_kill(msg_process_t process)
202 // /* FIXME: why do we only cancel communication actions? is this useful? */
203 // simdata_process_t p_simdata = simcall_process_get_data(process);
204 // if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) {
205 // simcall_comm_cancel(p_simdata->waiting_task->simdata->comm);
208 simcall_process_kill(process);
213 /** \ingroup m_process_management
214 * \brief Migrates a process to another location.
216 * This function checks whether \a process and \a host are valid pointers
217 and change the value of the #msg_host_t on which \a process is running.
219 msg_error_t MSG_process_migrate(msg_process_t process, msg_host_t host)
221 simdata_process_t simdata = simcall_process_get_data(process);
222 simdata->m_host = host;
224 msg_host_t now = simdata->m_host;
225 TRACE_msg_process_change_host(process, now, host);
227 simcall_process_change_host(process, host);
231 /** \ingroup m_process_management
232 * \brief Returns the user data of a process.
234 * This function checks whether \a process is a valid pointer or not
235 and returns the user data associated to this process.
237 void* MSG_process_get_data(msg_process_t process)
239 xbt_assert(process != NULL, "Invalid parameter");
241 /* get from SIMIX the MSG process data, and then the user data */
242 simdata_process_t simdata = simcall_process_get_data(process);
243 return simdata->data;
246 /** \ingroup m_process_management
247 * \brief Sets the user data of a process.
249 * This function checks whether \a process is a valid pointer or not
250 and sets the user data associated to this process.
252 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
254 xbt_assert(process != NULL, "Invalid parameter");
256 simdata_process_t simdata = simcall_process_get_data(process);
257 simdata->data = data;
262 /** \ingroup m_process_management
263 * \brief Sets a cleanup function to be called to free the userdata of a
264 * process when a process is destroyed.
265 * \param data_cleanup a cleanup function for the userdata of a process,
266 * or NULL to call no function
268 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
270 msg_global->process_data_cleanup = data_cleanup;
273 /** \ingroup m_process_management
274 * \brief Return the location on which a process is running.
275 * \param process a process (NULL means the current one)
276 * \return the msg_host_t corresponding to the location on which \a
277 * process is running.
279 msg_host_t MSG_process_get_host(msg_process_t process)
281 simdata_process_t simdata;
282 if (process == NULL) {
283 simdata = SIMIX_process_self_get_data(SIMIX_process_self());
286 simdata = simcall_process_get_data(process);
288 return simdata->m_host;
291 /** \ingroup m_process_management
293 * \brief Return a #msg_process_t given its PID.
295 * This function search in the list of all the created msg_process_t for a msg_process_t
296 whose PID is equal to \a PID. If no host is found, \c NULL is returned.
297 Note that the PID are uniq in the whole simulation, not only on a given host.
299 msg_process_t MSG_process_from_PID(int PID)
301 return SIMIX_process_from_PID(PID);
304 /** @brief returns a list of all currently existing processes */
305 xbt_dynar_t MSG_processes_as_dynar(void) {
306 return SIMIX_processes_as_dynar();
308 /** @brief Return the current number MSG processes.
310 int MSG_process_get_number(void)
312 return SIMIX_process_count();
315 /** \ingroup m_process_management
316 * \brief Set the kill time of a process.
318 * \param process a process
319 * \param kill_time the time when the process is killed.
321 msg_error_t MSG_process_set_kill_time(msg_process_t process, double kill_time)
323 simcall_process_set_kill_time(process,kill_time);
327 /** \ingroup m_process_management
328 * \brief Returns the process ID of \a process.
330 * This function checks whether \a process is a valid pointer or not
331 and return its PID (or 0 in case of problem).
333 int MSG_process_get_PID(msg_process_t process)
335 /* Do not raise an exception here: this function is called by the logs
336 * and the exceptions, so it would be called back again and again */
337 if (process == NULL) {
340 return simcall_process_get_PID(process);
343 /** \ingroup m_process_management
344 * \brief Returns the process ID of the parent of \a process.
346 * This function checks whether \a process is a valid pointer or not
347 and return its PID. Returns -1 if the process has not been created by
350 int MSG_process_get_PPID(msg_process_t process)
352 xbt_assert(process != NULL, "Invalid parameter");
354 return simcall_process_get_PPID(process);
357 /** \ingroup m_process_management
358 * \brief Return the name of a process.
360 * This function checks whether \a process is a valid pointer or not
363 const char *MSG_process_get_name(msg_process_t process)
365 xbt_assert(process, "Invalid parameter");
367 return simcall_process_get_name(process);
370 /** \ingroup m_process_management
371 * \brief Returns the value of a given process property
373 * \param process a process
374 * \param name a property name
375 * \return value of a property (or NULL if the property is not set)
377 const char *MSG_process_get_property_value(msg_process_t process,
380 return 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 != NULL, "Invalid parameter");
392 return simcall_process_get_properties(process);
396 /** \ingroup m_process_management
397 * \brief Return the PID of the current process.
399 * This function returns the PID of the currently running #msg_process_t.
401 int MSG_process_self_PID(void)
403 return MSG_process_get_PID(MSG_process_self());
406 /** \ingroup m_process_management
407 * \brief Return the PPID of the current process.
409 * This function returns the PID of the parent of the currently
410 * running #msg_process_t.
412 int MSG_process_self_PPID(void)
414 return MSG_process_get_PPID(MSG_process_self());
417 /** \ingroup m_process_management
418 * \brief Return the current process.
420 * This function returns the currently running #msg_process_t.
422 msg_process_t MSG_process_self(void)
424 return SIMIX_process_self();
427 /** \ingroup m_process_management
428 * \brief Suspend the process.
430 * This function suspends the process by suspending the task on which
431 * it was waiting for the completion.
433 msg_error_t MSG_process_suspend(msg_process_t process)
435 xbt_assert(process != NULL, "Invalid parameter");
438 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");
456 TRACE_msg_process_resume(process);
459 simcall_process_resume(process);
463 /** \ingroup m_process_management
464 * \brief Returns true if the process is suspended .
466 * This checks whether a process is suspended or not by inspecting the
467 * task on which it was waiting for the completion.
469 int MSG_process_is_suspended(msg_process_t process)
471 xbt_assert(process != NULL, "Invalid parameter");
472 return simcall_process_is_suspended(process);
475 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) {
476 return SIMIX_process_get_context(process);
479 * \ingroup m_process_management
480 * \brief Add a function to the list of "on_exit" functions for the current process.
481 * The on_exit functions are the functions executed when your process is killed.
482 * You should use them to free the data used by your process.
484 void MSG_process_on_exit(int_f_pvoid_t fun, void *data) {
485 simcall_process_on_exit(MSG_process_self(),fun,data);
488 * \ingroup m_process_management
489 * \brief Sets the "auto-restart" flag of the process.
490 * If the flag is set to 1, the process will be automatically restarted when
491 * its host comes back up.
493 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart) {
494 simcall_process_auto_restart_set(process,auto_restart);
497 * \ingroup m_process_management
498 * \brief Restarts a process from the beginning.
500 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process) {
501 return simcall_process_restart(process);