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);
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);
49 msg_process_data_t process_data = (msg_process_data_t)msg_proc->data;
50 //free the process data
52 //Remove the process from its vm
53 if (process_data->current_vm) {
54 int pos = xbt_dynar_search(process_data->current_vm->processes,&smx_proc);
55 xbt_dynar_remove_at(process_data->current_vm->processes,pos, NULL);
57 //Free the data if a function was provided
58 if (process_data->data && msg_global->process_data_cleanup) {
59 msg_global->process_data_cleanup(process_data->data);
61 xbt_free(process_data);
64 //free the MSG process
68 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
69 void MSG_process_create_from_SIMIX(smx_process_t* process, const char *name,
70 xbt_main_func_t code, void *data,
71 const char *hostname, double kill_time, int argc, char **argv,
72 xbt_dict_t properties)
74 m_host_t host = MSG_get_host_by_name(hostname);
75 m_process_t p = MSG_process_create_with_environment(name, code, data,
78 MSG_process_set_kill_time(p,kill_time);
79 *((m_process_t*) process) = p;
82 /** \ingroup m_process_management
83 * \brief Creates and runs a new #m_process_t.
85 * Does exactly the same as #MSG_process_create_with_arguments but without
86 providing standard arguments (\a argc, \a argv, \a start_time, \a kill_time).
87 * \sa MSG_process_create_with_arguments
89 m_process_t MSG_process_create(const char *name,
90 xbt_main_func_t code, void *data,
93 return MSG_process_create_with_environment(name, code, data, host, -1,
97 /** \ingroup m_process_management
98 * \brief Creates and runs a new #m_process_t.
100 * A constructor for #m_process_t taking four arguments and returning the
101 * corresponding object. The structure (and the corresponding thread) is
102 * created, and put in the list of ready process.
103 * \param name a name for the object. It is for user-level information
105 * \param code is a function describing the behavior of the process. It
106 should then only use functions described in \ref
107 m_process_management (to create a new #m_process_t for example),
108 in \ref m_host_management (only the read-only functions i.e. whose
109 name contains the word get), in \ref m_task_management (to create
110 or destroy some #m_task_t for example) and in \ref
111 msg_task_usage (to handle file transfers and task processing).
112 * \param data a pointer to any data one may want to attach to the new
113 object. It is for user-level information and can be NULL. It can
114 be retrieved with the function \ref MSG_process_get_data.
115 * \param host the location where the new process is executed.
116 * \param argc first argument passed to \a code
117 * \param argv second argument passed to \a code
119 * \return The new corresponding object.
122 m_process_t MSG_process_create_with_arguments(const char *name,
123 xbt_main_func_t code,
124 void *data, m_host_t host,
125 int argc, char **argv)
127 return MSG_process_create_with_environment(name, code, data, host,
131 /** \ingroup m_process_management
132 * \brief Creates and runs a new #m_process_t.
134 * A constructor for #m_process_t taking four arguments and returning the
135 * corresponding object. The structure (and the corresponding thread) is
136 * created, and put in the list of ready process.
137 * \param name a name for the object. It is for user-level information
139 * \param code is a function describing the behavior of the process. It
140 should then only use functions described in \ref
141 m_process_management (to create a new #m_process_t for example),
142 in \ref m_host_management (only the read-only functions i.e. whose
143 name contains the word get), in \ref m_task_management (to create
144 or destroy some #m_task_t for example) and in \ref
145 msg_task_usage (to handle file transfers and task processing).
146 * \param data a pointer to any data one may want to attach to the new
147 object. It is for user-level information and can be NULL. It can
148 be retrieved with the function \ref MSG_process_get_data.
149 * \param host the location where the new process is executed.
150 * \param argc first argument passed to \a code
151 * \param argv second argument passed to \a code
152 * \param properties list a properties defined for this process
154 * \return The new corresponding object.
156 m_process_t MSG_process_create_with_environment(const char *name,
157 xbt_main_func_t code,
158 void *data, m_host_t host,
159 int argc, char **argv,
160 xbt_dict_t properties)
162 xbt_assert(code != NULL && host != NULL, "Invalid parameters");
163 simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1);
166 /* Simulator data for MSG */
167 simdata->PID = msg_global->PID++;
168 simdata->waiting_action = NULL;
169 simdata->waiting_task = NULL;
170 simdata->m_host = host;
171 simdata->argc = argc;
172 simdata->argv = argv;
173 simdata->data = data;
174 simdata->last_errno = MSG_OK;
176 if (SIMIX_process_self()) {
177 simdata->PPID = MSG_process_get_PID(MSG_process_self());
183 TRACE_msg_process_create(name, simdata->PID, simdata->m_host);
186 /* Let's create the process: SIMIX may decide to start it right now,
187 * even before returning the flow control to us */
188 simcall_process_create(&process, name, code, simdata, SIMIX_host_get_name(host->smx_host), -1,
189 argc, argv, properties);
192 /* Undo everything we have just changed */
201 void MSG_process_kill_from_SIMIX(smx_process_t p)
204 TRACE_msg_process_kill(p);
209 /** \ingroup m_process_management
210 * \param process poor victim
212 * This function simply kills a \a process... scary isn't it ? :)
214 void MSG_process_kill(m_process_t process)
217 TRACE_msg_process_kill(process);
220 // /* FIXME: why do we only cancel communication actions? is this useful? */
221 // simdata_process_t p_simdata = simcall_process_get_data(process);
222 // if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) {
223 // simcall_comm_cancel(p_simdata->waiting_task->simdata->comm);
226 simcall_process_kill(process);
231 /** \ingroup m_process_management
232 * \brief Migrates a process to another location.
234 * This function checks whether \a process and \a host are valid pointers
235 and change the value of the #m_host_t on which \a process is running.
237 MSG_error_t MSG_process_migrate(m_process_t process, m_host_t host)
239 simdata_process_t simdata = simcall_process_get_data(process);
240 simdata->m_host = host;
242 m_host_t now = simdata->m_host;
243 TRACE_msg_process_change_host(process, now, host);
245 simcall_process_change_host(process, host->smx_host);
249 /** \ingroup m_process_management
250 * \brief Returns the user data of a process.
252 * This function checks whether \a process is a valid pointer or not
253 and returns the user data associated to this process.
255 void* MSG_process_get_data(m_process_t process)
257 xbt_assert(process != NULL, "Invalid parameter");
259 /* get from SIMIX the MSG process data, and then the user data */
260 simdata_process_t simdata = simcall_process_get_data(process);
261 if (!simdata->data) {
264 return ((msg_process_data_t)simdata->data)->data;
267 /** \ingroup m_process_management
268 * \brief Sets the user data of a process.
270 * This function checks whether \a process is a valid pointer or not
271 and sets the user data associated to this process.
273 MSG_error_t MSG_process_set_data(m_process_t process, void *data)
275 xbt_assert(process != NULL, "Invalid parameter");
277 simdata_process_t simdata = simcall_process_get_data(process);
278 if (!simdata->data) {
279 simdata->data = xbt_new0(s_msg_process_data_t, 1);
281 ((msg_process_data_t)simdata->data)->data = data;
285 /** \ingroup m_process_management
286 * \brief Sets a cleanup function to be called to free the userdata of a
287 * process when a process is destroyed.
288 * \param data_cleanup a cleanup function for the userdata of a process,
289 * or NULL to call no function
291 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
293 msg_global->process_data_cleanup = data_cleanup;
296 /** \ingroup m_process_management
297 * \brief Return the location on which a process is running.
298 * \param process a process (NULL means the current one)
299 * \return the m_host_t corresponding to the location on which \a
300 * process is running.
302 m_host_t MSG_process_get_host(m_process_t process)
304 simdata_process_t simdata;
305 if (process == NULL) {
306 simdata = SIMIX_process_self_get_data(SIMIX_process_self());
309 simdata = simcall_process_get_data(process);
311 return simdata->m_host;
314 /** \ingroup m_process_management
316 * \brief Return a #m_process_t given its PID.
318 * This function search in the list of all the created m_process_t for a m_process_t
319 whose PID is equal to \a PID. If no host is found, \c NULL is returned.
320 Note that the PID are uniq in the whole simulation, not only on a given host.
322 m_process_t MSG_process_from_PID(int PID)
324 return SIMIX_process_from_PID(PID);
327 /** @brief returns a list of all currently existing processes */
328 xbt_dynar_t MSG_processes_as_dynar(void) {
329 return SIMIX_processes_as_dynar();
332 /** \ingroup m_process_management
333 * \brief Set the kill time of a process.
335 * \param process a process
336 * \param kill_time the time when the process is killed.
338 MSG_error_t MSG_process_set_kill_time(m_process_t process, double kill_time)
340 simcall_process_set_kill_time(process,kill_time);
344 /** \ingroup m_process_management
345 * \brief Returns the process ID of \a process.
347 * This function checks whether \a process is a valid pointer or not
348 and return its PID (or 0 in case of problem).
350 int MSG_process_get_PID(m_process_t process)
352 /* Do not raise an exception here: this function is called by the logs
353 * and the exceptions, so it would be called back again and again */
354 if (process == NULL) {
358 simdata_process_t simdata = simcall_process_get_data(process);
360 return simdata != NULL ? simdata->PID : 0;
363 /** \ingroup m_process_management
364 * \brief Returns the process ID of the parent of \a process.
366 * This function checks whether \a process is a valid pointer or not
367 and return its PID. Returns -1 if the process has not been created by
370 int MSG_process_get_PPID(m_process_t process)
372 xbt_assert(process != NULL, "Invalid parameter");
374 simdata_process_t simdata = simcall_process_get_data(process);
376 return simdata->PPID;
379 /** \ingroup m_process_management
380 * \brief Return the name of a process.
382 * This function checks whether \a process is a valid pointer or not
385 const char *MSG_process_get_name(m_process_t process)
387 xbt_assert(process, "Invalid parameter");
389 return simcall_process_get_name(process);
392 /** \ingroup m_process_management
393 * \brief Returns the value of a given process property
395 * \param process a process
396 * \param name a property name
397 * \return value of a property (or NULL if the property is not set)
399 const char *MSG_process_get_property_value(m_process_t process,
402 return xbt_dict_get_or_null(MSG_process_get_properties(process), name);
405 /** \ingroup m_process_management
406 * \brief Return the list of properties
408 * This function returns all the parameters associated with a process
410 xbt_dict_t MSG_process_get_properties(m_process_t process)
412 xbt_assert(process != NULL, "Invalid parameter");
414 return simcall_process_get_properties(process);
418 /** \ingroup m_process_management
419 * \brief Return the PID of the current process.
421 * This function returns the PID of the currently running #m_process_t.
423 int MSG_process_self_PID(void)
425 return MSG_process_get_PID(MSG_process_self());
428 /** \ingroup m_process_management
429 * \brief Return the PPID of the current process.
431 * This function returns the PID of the parent of the currently
432 * running #m_process_t.
434 int MSG_process_self_PPID(void)
436 return MSG_process_get_PPID(MSG_process_self());
439 /** \ingroup m_process_management
440 * \brief Return the current process.
442 * This function returns the currently running #m_process_t.
444 m_process_t MSG_process_self(void)
446 return SIMIX_process_self();
449 /** \ingroup m_process_management
450 * \brief Suspend the process.
452 * This function suspends the process by suspending the task on which
453 * it was waiting for the completion.
455 MSG_error_t MSG_process_suspend(m_process_t process)
457 xbt_assert(process != NULL, "Invalid parameter");
460 TRACE_msg_process_suspend(process);
463 simcall_process_suspend(process);
467 /** \ingroup m_process_management
468 * \brief Resume a suspended process.
470 * This function resumes a suspended process by resuming the task on
471 * which it was waiting for the completion.
473 MSG_error_t MSG_process_resume(m_process_t process)
475 xbt_assert(process != NULL, "Invalid parameter");
478 TRACE_msg_process_resume(process);
481 simcall_process_resume(process);
485 /** \ingroup m_process_management
486 * \brief Returns true if the process is suspended .
488 * This checks whether a process is suspended or not by inspecting the
489 * task on which it was waiting for the completion.
491 int MSG_process_is_suspended(m_process_t process)
493 xbt_assert(process != NULL, "Invalid parameter");
494 return simcall_process_is_suspended(process);
497 smx_context_t MSG_process_get_smx_ctx(m_process_t process) {
498 return SIMIX_process_get_context(process);