1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. 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);
49 // free the data if a function was provided
50 if (msg_proc->data && msg_global->process_data_cleanup) {
51 msg_global->process_data_cleanup(msg_proc->data);
54 // remove the process from its virtual machine
56 int pos = xbt_dynar_search(msg_proc->vm->processes,&smx_proc);
57 xbt_dynar_remove_at(msg_proc->vm->processes,pos, NULL);
60 // free the MSG process
64 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
65 void MSG_process_create_from_SIMIX(smx_process_t* process, const char *name,
66 xbt_main_func_t code, void *data,
67 const char *hostname, double kill_time, int argc, char **argv,
68 xbt_dict_t properties, int auto_restart)
70 m_host_t host = MSG_get_host_by_name(hostname);
71 m_process_t p = MSG_process_create_with_environment(name, code, data,
75 MSG_process_set_kill_time(p,kill_time);
76 MSG_process_auto_restart_set(p,auto_restart);
78 *((m_process_t*) process) = p;
81 /** \ingroup m_process_management
82 * \brief Creates and runs a new #m_process_t.
84 * Does exactly the same as #MSG_process_create_with_arguments but without
85 providing standard arguments (\a argc, \a argv, \a start_time, \a kill_time).
86 * \sa MSG_process_create_with_arguments
88 m_process_t MSG_process_create(const char *name,
89 xbt_main_func_t code, void *data,
92 return MSG_process_create_with_environment(name, code, data, host, -1,
96 /** \ingroup m_process_management
97 * \brief Creates and runs a new #m_process_t.
99 * A constructor for #m_process_t taking four arguments and returning the
100 * corresponding object. The structure (and the corresponding thread) is
101 * created, and put in the list of ready process.
102 * \param name a name for the object. It is for user-level information
104 * \param code is a function describing the behavior of the process. It
105 should then only use functions described in \ref
106 m_process_management (to create a new #m_process_t for example),
107 in \ref m_host_management (only the read-only functions i.e. whose
108 name contains the word get), in \ref m_task_management (to create
109 or destroy some #m_task_t for example) and in \ref
110 msg_task_usage (to handle file transfers and task processing).
111 * \param data a pointer to any data one may want to attach to the new
112 object. It is for user-level information and can be NULL. It can
113 be retrieved with the function \ref MSG_process_get_data.
114 * \param host the location where the new process is executed.
115 * \param argc first argument passed to \a code
116 * \param argv second argument passed to \a code
118 * \return The new corresponding object.
121 m_process_t MSG_process_create_with_arguments(const char *name,
122 xbt_main_func_t code,
123 void *data, m_host_t host,
124 int argc, char **argv)
126 return MSG_process_create_with_environment(name, code, data, host,
130 /** \ingroup m_process_management
131 * \brief Creates and runs a new #m_process_t.
133 * A constructor for #m_process_t taking four arguments and returning the
134 * corresponding object. The structure (and the corresponding thread) is
135 * created, and put in the list of ready process.
136 * \param name a name for the object. It is for user-level information
138 * \param code is a function describing the behavior of the process. It
139 should then only use functions described in \ref
140 m_process_management (to create a new #m_process_t for example),
141 in \ref m_host_management (only the read-only functions i.e. whose
142 name contains the word get), in \ref m_task_management (to create
143 or destroy some #m_task_t for example) and in \ref
144 msg_task_usage (to handle file transfers and task processing).
145 * \param data a pointer to any data one may want to attach to the new
146 object. It is for user-level information and can be NULL. It can
147 be retrieved with the function \ref MSG_process_get_data.
148 * \param host the location where the new process is executed.
149 * \param argc first argument passed to \a code
150 * \param argv second argument passed to \a code
151 * \param properties list a properties defined for this process
153 * \return The new corresponding object.
155 m_process_t MSG_process_create_with_environment(const char *name,
156 xbt_main_func_t code,
157 void *data, m_host_t host,
158 int argc, char **argv,
159 xbt_dict_t properties)
161 xbt_assert(code != NULL && host != NULL, "Invalid parameters");
162 simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1);
165 /* Simulator data for MSG */
166 simdata->PID = msg_global->PID++;
167 simdata->waiting_action = NULL;
168 simdata->waiting_task = NULL;
169 simdata->m_host = host;
170 simdata->argc = argc;
171 simdata->argv = argv;
172 simdata->data = data;
173 simdata->last_errno = MSG_OK;
175 if (SIMIX_process_self()) {
176 simdata->PPID = MSG_process_get_PID(MSG_process_self());
182 TRACE_msg_process_create(name, simdata->PID, simdata->m_host);
184 /* Let's create the process: SIMIX may decide to start it right now,
185 * even before returning the flow control to us */
186 simcall_process_create(&process, name, code, simdata, SIMIX_host_get_name(host->smx_host), -1,
187 argc, argv, properties,0);
190 /* Undo everything we have just changed */
197 simcall_process_on_exit(process,(int_f_pvoid_t)TRACE_msg_process_kill,MSG_process_self());
203 /** \ingroup m_process_management
204 * \param process poor victim
206 * This function simply kills a \a process... scary isn't it ? :)
208 void MSG_process_kill(m_process_t process)
210 // /* FIXME: why do we only cancel communication actions? is this useful? */
211 // simdata_process_t p_simdata = simcall_process_get_data(process);
212 // if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) {
213 // simcall_comm_cancel(p_simdata->waiting_task->simdata->comm);
216 simcall_process_kill(process);
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
225 and change the value of the #m_host_t on which \a process is running.
227 MSG_error_t MSG_process_migrate(m_process_t process, m_host_t host)
229 simdata_process_t simdata = simcall_process_get_data(process);
230 simdata->m_host = host;
232 m_host_t now = simdata->m_host;
233 TRACE_msg_process_change_host(process, now, host);
235 simcall_process_change_host(process, host->smx_host);
239 /** \ingroup m_process_management
240 * \brief Returns the user data of a process.
242 * This function checks whether \a process is a valid pointer or not
243 and returns the user data associated to this process.
245 void* MSG_process_get_data(m_process_t process)
247 xbt_assert(process != NULL, "Invalid parameter");
249 /* get from SIMIX the MSG process data, and then the user data */
250 simdata_process_t simdata = simcall_process_get_data(process);
251 return simdata->data;
254 /** \ingroup m_process_management
255 * \brief Sets the user data of a process.
257 * This function checks whether \a process is a valid pointer or not
258 and sets the user data associated to this process.
260 MSG_error_t MSG_process_set_data(m_process_t process, void *data)
262 xbt_assert(process != NULL, "Invalid parameter");
264 simdata_process_t simdata = simcall_process_get_data(process);
265 simdata->data = data;
270 /** \ingroup m_process_management
271 * \brief Sets a cleanup function to be called to free the userdata of a
272 * process when a process is destroyed.
273 * \param data_cleanup a cleanup function for the userdata of a process,
274 * or NULL to call no function
276 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
278 msg_global->process_data_cleanup = data_cleanup;
281 /** \ingroup m_process_management
282 * \brief Return the location on which a process is running.
283 * \param process a process (NULL means the current one)
284 * \return the m_host_t corresponding to the location on which \a
285 * process is running.
287 m_host_t MSG_process_get_host(m_process_t process)
289 simdata_process_t simdata;
290 if (process == NULL) {
291 simdata = SIMIX_process_self_get_data(SIMIX_process_self());
294 simdata = simcall_process_get_data(process);
296 return simdata->m_host;
299 /** \ingroup m_process_management
301 * \brief Return a #m_process_t given its PID.
303 * This function search in the list of all the created m_process_t for a m_process_t
304 whose PID is equal to \a PID. If no host is found, \c NULL is returned.
305 Note that the PID are uniq in the whole simulation, not only on a given host.
307 m_process_t MSG_process_from_PID(int PID)
309 return SIMIX_process_from_PID(PID);
312 /** @brief returns a list of all currently existing processes */
313 xbt_dynar_t MSG_processes_as_dynar(void) {
314 return SIMIX_processes_as_dynar();
317 /** \ingroup m_process_management
318 * \brief Set the kill time of a process.
320 * \param process a process
321 * \param kill_time the time when the process is killed.
323 MSG_error_t MSG_process_set_kill_time(m_process_t process, double kill_time)
325 simcall_process_set_kill_time(process,kill_time);
329 /** \ingroup m_process_management
330 * \brief Returns the process ID of \a process.
332 * This function checks whether \a process is a valid pointer or not
333 and return its PID (or 0 in case of problem).
335 int MSG_process_get_PID(m_process_t process)
337 /* Do not raise an exception here: this function is called by the logs
338 * and the exceptions, so it would be called back again and again */
339 if (process == NULL) {
343 simdata_process_t simdata = simcall_process_get_data(process);
345 return simdata != NULL ? simdata->PID : 0;
348 /** \ingroup m_process_management
349 * \brief Returns the process ID of the parent of \a process.
351 * This function checks whether \a process is a valid pointer or not
352 and return its PID. Returns -1 if the process has not been created by
355 int MSG_process_get_PPID(m_process_t process)
357 xbt_assert(process != NULL, "Invalid parameter");
359 simdata_process_t simdata = simcall_process_get_data(process);
361 return simdata->PPID;
364 /** \ingroup m_process_management
365 * \brief Return the name of a process.
367 * This function checks whether \a process is a valid pointer or not
370 const char *MSG_process_get_name(m_process_t process)
372 xbt_assert(process, "Invalid parameter");
374 return simcall_process_get_name(process);
377 /** \ingroup m_process_management
378 * \brief Returns the value of a given process property
380 * \param process a process
381 * \param name a property name
382 * \return value of a property (or NULL if the property is not set)
384 const char *MSG_process_get_property_value(m_process_t process,
387 return xbt_dict_get_or_null(MSG_process_get_properties(process), name);
390 /** \ingroup m_process_management
391 * \brief Return the list of properties
393 * This function returns all the parameters associated with a process
395 xbt_dict_t MSG_process_get_properties(m_process_t process)
397 xbt_assert(process != NULL, "Invalid parameter");
399 return simcall_process_get_properties(process);
403 /** \ingroup m_process_management
404 * \brief Return the PID of the current process.
406 * This function returns the PID of the currently running #m_process_t.
408 int MSG_process_self_PID(void)
410 return MSG_process_get_PID(MSG_process_self());
413 /** \ingroup m_process_management
414 * \brief Return the PPID of the current process.
416 * This function returns the PID of the parent of the currently
417 * running #m_process_t.
419 int MSG_process_self_PPID(void)
421 return MSG_process_get_PPID(MSG_process_self());
424 /** \ingroup m_process_management
425 * \brief Return the current process.
427 * This function returns the currently running #m_process_t.
429 m_process_t MSG_process_self(void)
431 return SIMIX_process_self();
434 /** \ingroup m_process_management
435 * \brief Suspend the process.
437 * This function suspends the process by suspending the task on which
438 * it was waiting for the completion.
440 MSG_error_t MSG_process_suspend(m_process_t process)
442 xbt_assert(process != NULL, "Invalid parameter");
445 TRACE_msg_process_suspend(process);
448 simcall_process_suspend(process);
452 /** \ingroup m_process_management
453 * \brief Resume a suspended process.
455 * This function resumes a suspended process by resuming the task on
456 * which it was waiting for the completion.
458 MSG_error_t MSG_process_resume(m_process_t process)
460 xbt_assert(process != NULL, "Invalid parameter");
463 TRACE_msg_process_resume(process);
466 simcall_process_resume(process);
470 /** \ingroup m_process_management
471 * \brief Returns true if the process is suspended .
473 * This checks whether a process is suspended or not by inspecting the
474 * task on which it was waiting for the completion.
476 int MSG_process_is_suspended(m_process_t process)
478 xbt_assert(process != NULL, "Invalid parameter");
479 return simcall_process_is_suspended(process);
482 smx_context_t MSG_process_get_smx_ctx(m_process_t process) {
483 return SIMIX_process_get_context(process);
486 * \ingroup m_process_management
487 * \brief Add a function to the list of "on_exit" functions for the current process.
488 * The on_exit functions are the functions executed when your process is killed.
489 * You should use them to free the data used by your process.
491 void MSG_process_on_exit(int_f_pvoid_t fun, void *data) {
492 simcall_process_on_exit(MSG_process_self(),fun,data);
495 * \ingroup m_process_management
496 * \brief Sets the "auto-restart" flag of the process.
497 * If the flag is set to 1, the process will be automatically restarted when
498 * its host comes back up.
500 XBT_PUBLIC(void) MSG_process_auto_restart_set(m_process_t process, int auto_restart) {
501 simcall_process_auto_restart_set(process,auto_restart);