1 /* Copyright (c) 2004-2014. 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 "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 * We need to simulate many independent scheduling decisions, so
19 * the concept of <em>process</em> is at the heart of the
20 * simulator. A process may be defined as a <em>code</em>, with
21 * some <em>private data</em>, executing in a <em>location</em>.
25 /******************************** Process ************************************/
28 * \brief Cleans the MSG data of a process.
29 * \param smx_proc a SIMIX process
31 void MSG_process_cleanup_from_SIMIX(smx_process_t smx_proc)
33 simdata_process_t msg_proc;
35 // get the MSG process from the SIMIX process
36 if (smx_proc == SIMIX_process_self()) {
37 /* avoid a SIMIX request if this function is called by the process itself */
38 msg_proc = SIMIX_process_self_get_data(smx_proc);
39 SIMIX_process_self_set_data(smx_proc, NULL);
42 msg_proc = simcall_process_get_data(smx_proc);
43 simcall_process_set_data(smx_proc, NULL);
46 TRACE_msg_process_end(smx_proc);
47 // free the data if a function was provided
48 if (msg_proc && msg_proc->data && msg_global->process_data_cleanup) {
49 msg_global->process_data_cleanup(msg_proc->data);
52 // free the MSG process
54 SIMIX_process_cleanup(smx_proc);
57 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
58 void MSG_process_create_from_SIMIX(smx_process_t* process, const char *name,
59 xbt_main_func_t code, void *data,
60 const char *hostname, double kill_time,
61 int argc, char **argv,
62 xbt_dict_t properties, int auto_restart,
63 smx_process_t parent_process)
65 msg_host_t host = MSG_get_host_by_name(hostname);
66 msg_process_t p = MSG_process_create_with_environment(name, code, data,
70 MSG_process_set_kill_time(p,kill_time);
71 MSG_process_auto_restart_set(p,auto_restart);
73 *((msg_process_t*) process) = p;
76 /** \ingroup m_process_management
77 * \brief Creates and runs a new #msg_process_t.
79 * Does exactly the same as #MSG_process_create_with_arguments but without
80 providing standard arguments (\a argc, \a argv, \a start_time, \a kill_time).
81 * \sa MSG_process_create_with_arguments
83 msg_process_t MSG_process_create(const char *name,
84 xbt_main_func_t code, void *data,
87 return MSG_process_create_with_environment(name, code, data, host, -1,
91 /** \ingroup m_process_management
92 * \brief Creates and runs a new #msg_process_t.
94 * A constructor for #msg_process_t taking four arguments and returning the
95 * corresponding object. The structure (and the corresponding thread) is
96 * created, and put in the list of ready process.
97 * \param name a name for the object. It is for user-level information
99 * \param code is a function describing the behavior of the process. It
100 should then only use functions described in \ref
101 m_process_management (to create a new #msg_process_t for example),
102 in \ref m_host_management (only the read-only functions i.e. whose
103 name contains the word get), in \ref m_task_management (to create
104 or destroy some #msg_task_t for example) and in \ref
105 msg_task_usage (to handle file transfers and task processing).
106 * \param data a pointer to any data one may want to attach to the new
107 object. It is for user-level information and can be NULL. It can
108 be retrieved with the function \ref MSG_process_get_data.
109 * \param host the location where the new process is executed.
110 * \param argc first argument passed to \a code
111 * \param argv second argument passed to \a code
113 * \return The new corresponding object.
116 msg_process_t MSG_process_create_with_arguments(const char *name,
117 xbt_main_func_t code,
118 void *data, msg_host_t host,
119 int argc, char **argv)
121 return MSG_process_create_with_environment(name, code, data, host,
125 /** \ingroup m_process_management
126 * \brief Creates and runs a new #msg_process_t.
128 * A constructor for #msg_process_t taking four arguments and returning the
129 * corresponding object. The structure (and the corresponding thread) is
130 * created, and put in the list of ready process.
131 * \param name a name for the object. It is for user-level information
133 * \param code is a function describing the behavior of the process. It
134 should then only use functions described in \ref
135 m_process_management (to create a new #msg_process_t for example),
136 in \ref m_host_management (only the read-only functions i.e. whose
137 name contains the word get), in \ref m_task_management (to create
138 or destroy some #msg_task_t for example) and in \ref
139 msg_task_usage (to handle file transfers and task processing).
140 * \param data a pointer to any data one may want to attach to the new
141 object. It is for user-level information and can be NULL. It can
142 be retrieved with the function \ref MSG_process_get_data.
143 * \param host the location where the new process is executed.
144 * \param argc first argument passed to \a code
145 * \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.
146 * \param properties list a properties defined for this process
148 * \return The new corresponding object.
150 msg_process_t MSG_process_create_with_environment(const char *name,
151 xbt_main_func_t code,
152 void *data, msg_host_t host,
153 int argc, char **argv,
154 xbt_dict_t properties)
156 xbt_assert(code != NULL && host != NULL, "Invalid parameters: host and code params must not be NULL");
157 simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1);
158 msg_process_t process;
160 /* Simulator data for MSG */
161 simdata->waiting_action = NULL;
162 simdata->waiting_task = NULL;
163 simdata->m_host = host;
164 simdata->argc = argc;
165 simdata->argv = argv;
166 simdata->data = data;
167 simdata->last_errno = MSG_OK;
169 /* Let's create the process: SIMIX may decide to start it right now,
170 * even before returning the flow control to us */
171 simcall_process_create(&process, name, code, simdata, sg_host_name(host), -1,
172 argc, argv, properties,0);
174 TRACE_msg_process_create(name, SIMIX_process_get_PID(process), host);
177 /* Undo everything we have just changed */
182 simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process);
187 /** \ingroup m_process_management
188 * \param process poor victim
190 * This function simply kills a \a process... scary isn't it ? :)
192 void MSG_process_kill(msg_process_t process)
194 // /* FIXME: why do we only cancel communication actions? is this useful? */
195 // simdata_process_t p_simdata = simcall_process_get_data(process);
196 // if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) {
197 // simcall_comm_cancel(p_simdata->waiting_task->simdata->comm);
200 simcall_process_kill(process);
206 * \brief Wait for the completion of a #msg_process_t.
208 * \param process the process to wait for
209 * \param timeout wait until the process is over, or the timeout occurs
211 msg_error_t MSG_process_join(msg_process_t process, double timeout){
212 simcall_process_join(process, timeout);
216 /** \ingroup m_process_management
217 * \brief Migrates a process to another location.
219 * This function checks whether \a process and \a host are valid pointers
220 and change the value of the #msg_host_t on which \a process is running.
222 msg_error_t MSG_process_migrate(msg_process_t process, msg_host_t host)
224 simdata_process_t simdata = simcall_process_get_data(process);
225 simdata->m_host = host;
226 msg_host_t now = simdata->m_host;
227 TRACE_msg_process_change_host(process, now, host);
228 simcall_process_change_host(process, host);
232 /** \ingroup m_process_management
233 * \brief Returns the user data of a process.
235 * This function checks whether \a process is a valid pointer or not
236 and returns the user data associated to this process.
238 void* MSG_process_get_data(msg_process_t process)
240 xbt_assert(process != NULL, "Invalid parameter: first parameter must not be NULL!");
242 /* get from SIMIX the MSG process data, and then the user data */
243 simdata_process_t simdata = simcall_process_get_data(process);
244 return simdata->data;
247 /** \ingroup m_process_management
248 * \brief Sets the user data of a process.
250 * This function checks whether \a process is a valid pointer or not
251 and sets the user data associated to this process.
253 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
255 xbt_assert(process != NULL, "Invalid parameter: first parameter must not be NULL!");
257 simdata_process_t simdata = simcall_process_get_data(process);
258 simdata->data = data;
263 /** \ingroup m_process_management
264 * \brief Sets a cleanup function to be called to free the userdata of a
265 * process when a process is destroyed.
266 * \param data_cleanup a cleanup function for the userdata of a process,
267 * or NULL to call no function
269 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
271 msg_global->process_data_cleanup = data_cleanup;
274 /** \ingroup m_process_management
275 * \brief Return the location on which a process is running.
276 * \param process a process (NULL means the current one)
277 * \return the msg_host_t corresponding to the location on which \a
278 * process is running.
280 msg_host_t MSG_process_get_host(msg_process_t process)
282 simdata_process_t simdata;
283 if (process == NULL) {
284 simdata = SIMIX_process_self_get_data(SIMIX_process_self());
287 simdata = simcall_process_get_data(process);
289 return simdata ? simdata->m_host : NULL;
292 /** \ingroup m_process_management
294 * \brief Return a #msg_process_t given its PID.
296 * This function search in the list of all the created msg_process_t for a msg_process_t
297 whose PID is equal to \a PID. If no host is found, \c NULL is returned.
298 Note that the PID are uniq in the whole simulation, not only on a given host.
300 msg_process_t MSG_process_from_PID(int PID)
302 return SIMIX_process_from_PID(PID);
305 /** @brief returns a list of all currently existing processes */
306 xbt_dynar_t MSG_processes_as_dynar(void) {
307 return SIMIX_processes_as_dynar();
309 /** @brief Return the current number MSG processes.
311 int MSG_process_get_number(void)
313 return SIMIX_process_count();
316 /** \ingroup m_process_management
317 * \brief Set the kill time of a process.
319 * \param process a process
320 * \param kill_time the time when the process is killed.
322 msg_error_t MSG_process_set_kill_time(msg_process_t process, double kill_time)
324 simcall_process_set_kill_time(process,kill_time);
328 /** \ingroup m_process_management
329 * \brief Returns the process ID of \a process.
331 * This function checks whether \a process is a valid pointer or not
332 and return its PID (or 0 in case of problem).
334 int MSG_process_get_PID(msg_process_t process)
336 /* Do not raise an exception here: this function is called by the logs
337 * and the exceptions, so it would be called back again and again */
338 if (process == NULL) {
341 return simcall_process_get_PID(process);
344 /** \ingroup m_process_management
345 * \brief Returns the process ID of the parent of \a process.
347 * This function checks whether \a process is a valid pointer or not
348 and return its PID. Returns -1 if the process has not been created by
351 int MSG_process_get_PPID(msg_process_t process)
353 xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
355 return simcall_process_get_PPID(process);
358 /** \ingroup m_process_management
359 * \brief Return the name of a process.
361 * This function checks whether \a process is a valid pointer or not
364 const char *MSG_process_get_name(msg_process_t process)
366 xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
368 return simcall_process_get_name(process);
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 NULL if the property is not set)
378 const char *MSG_process_get_property_value(msg_process_t process,
381 return xbt_dict_get_or_null(MSG_process_get_properties(process), name);
384 /** \ingroup m_process_management
385 * \brief Return the list of properties
387 * This function returns all the parameters associated with a process
389 xbt_dict_t MSG_process_get_properties(msg_process_t process)
391 xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
393 return simcall_process_get_properties(process);
397 /** \ingroup m_process_management
398 * \brief Return the PID of the current process.
400 * This function returns the PID of the currently running #msg_process_t.
402 int MSG_process_self_PID(void)
404 return MSG_process_get_PID(MSG_process_self());
407 /** \ingroup m_process_management
408 * \brief Return the PPID of the current process.
410 * This function returns the PID of the parent of the currently
411 * running #msg_process_t.
413 int MSG_process_self_PPID(void)
415 return MSG_process_get_PPID(MSG_process_self());
418 /** \ingroup m_process_management
419 * \brief Return the current process.
421 * This function returns the currently running #msg_process_t.
423 msg_process_t MSG_process_self(void)
425 return SIMIX_process_self();
428 /** \ingroup m_process_management
429 * \brief Suspend the process.
431 * This function suspends the process by suspending the task on which
432 * it was waiting for the completion.
434 msg_error_t MSG_process_suspend(msg_process_t process)
436 xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
438 TRACE_msg_process_suspend(process);
439 simcall_process_suspend(process);
443 /** \ingroup m_process_management
444 * \brief Resume a suspended process.
446 * This function resumes a suspended process by resuming the task on
447 * which it was waiting for the completion.
449 msg_error_t MSG_process_resume(msg_process_t process)
451 xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
453 TRACE_msg_process_resume(process);
454 simcall_process_resume(process);
458 /** \ingroup m_process_management
459 * \brief Returns true if the process is suspended .
461 * This checks whether a process is suspended or not by inspecting the
462 * task on which it was waiting for the completion.
464 int MSG_process_is_suspended(msg_process_t process)
466 xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
467 return simcall_process_is_suspended(process);
470 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) {
471 return SIMIX_process_get_context(process);
474 * \ingroup m_process_management
475 * \brief Add a function to the list of "on_exit" functions for the current process.
476 * The on_exit functions are the functions executed when your process is killed.
477 * You should use them to free the data used by your process.
479 void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
480 simcall_process_on_exit(MSG_process_self(),fun,data);
483 * \ingroup m_process_management
484 * \brief Sets the "auto-restart" flag of the process.
485 * If the flag is set to 1, the process will be automatically restarted when
486 * 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);