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)
70 m_host_t host = MSG_get_host_by_name(hostname);
71 m_process_t p = MSG_process_create_with_environment(name, code, data,
74 MSG_process_set_kill_time(p,kill_time);
75 *((m_process_t*) process) = p;
78 /** \ingroup m_process_management
79 * \brief Creates and runs a new #m_process_t.
81 * Does exactly the same as #MSG_process_create_with_arguments but without
82 providing standard arguments (\a argc, \a argv, \a start_time, \a kill_time).
83 * \sa MSG_process_create_with_arguments
85 m_process_t MSG_process_create(const char *name,
86 xbt_main_func_t code, void *data,
89 return MSG_process_create_with_environment(name, code, data, host, -1,
93 /** \ingroup m_process_management
94 * \brief Creates and runs a new #m_process_t.
96 * A constructor for #m_process_t taking four arguments and returning the
97 * corresponding object. The structure (and the corresponding thread) is
98 * created, and put in the list of ready process.
99 * \param name a name for the object. It is for user-level information
101 * \param code is a function describing the behavior of the process. It
102 should then only use functions described in \ref
103 m_process_management (to create a new #m_process_t for example),
104 in \ref m_host_management (only the read-only functions i.e. whose
105 name contains the word get), in \ref m_task_management (to create
106 or destroy some #m_task_t for example) and in \ref
107 msg_task_usage (to handle file transfers and task processing).
108 * \param data a pointer to any data one may want to attach to the new
109 object. It is for user-level information and can be NULL. It can
110 be retrieved with the function \ref MSG_process_get_data.
111 * \param host the location where the new process is executed.
112 * \param argc first argument passed to \a code
113 * \param argv second argument passed to \a code
115 * \return The new corresponding object.
118 m_process_t MSG_process_create_with_arguments(const char *name,
119 xbt_main_func_t code,
120 void *data, m_host_t host,
121 int argc, char **argv)
123 return MSG_process_create_with_environment(name, code, data, host,
127 /** \ingroup m_process_management
128 * \brief Creates and runs a new #m_process_t.
130 * A constructor for #m_process_t taking four arguments and returning the
131 * corresponding object. The structure (and the corresponding thread) is
132 * created, and put in the list of ready process.
133 * \param name a name for the object. It is for user-level information
135 * \param code is a function describing the behavior of the process. It
136 should then only use functions described in \ref
137 m_process_management (to create a new #m_process_t for example),
138 in \ref m_host_management (only the read-only functions i.e. whose
139 name contains the word get), in \ref m_task_management (to create
140 or destroy some #m_task_t for example) and in \ref
141 msg_task_usage (to handle file transfers and task processing).
142 * \param data a pointer to any data one may want to attach to the new
143 object. It is for user-level information and can be NULL. It can
144 be retrieved with the function \ref MSG_process_get_data.
145 * \param host the location where the new process is executed.
146 * \param argc first argument passed to \a code
147 * \param argv second argument passed to \a code
148 * \param properties list a properties defined for this process
150 * \return The new corresponding object.
152 m_process_t MSG_process_create_with_environment(const char *name,
153 xbt_main_func_t code,
154 void *data, m_host_t host,
155 int argc, char **argv,
156 xbt_dict_t properties)
158 xbt_assert(code != NULL && host != NULL, "Invalid parameters");
159 simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1);
162 /* Simulator data for MSG */
163 simdata->PID = msg_global->PID++;
164 simdata->waiting_action = NULL;
165 simdata->waiting_task = NULL;
166 simdata->m_host = host;
167 simdata->argc = argc;
168 simdata->argv = argv;
169 simdata->data = data;
170 simdata->last_errno = MSG_OK;
172 if (SIMIX_process_self()) {
173 simdata->PPID = MSG_process_get_PID(MSG_process_self());
179 TRACE_msg_process_create(name, simdata->PID, simdata->m_host);
181 /* Let's create the process: SIMIX may decide to start it right now,
182 * even before returning the flow control to us */
183 simcall_process_create(&process, name, code, simdata, SIMIX_host_get_name(host->smx_host), -1,
184 argc, argv, properties);
187 /* Undo everything we have just changed */
194 simcall_process_on_exit(process,(int_f_pvoid_t)TRACE_msg_process_kill,MSG_process_self());
200 /** \ingroup m_process_management
201 * \param process poor victim
203 * This function simply kills a \a process... scary isn't it ? :)
205 void MSG_process_kill(m_process_t process)
207 // /* FIXME: why do we only cancel communication actions? is this useful? */
208 // simdata_process_t p_simdata = simcall_process_get_data(process);
209 // if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) {
210 // simcall_comm_cancel(p_simdata->waiting_task->simdata->comm);
213 simcall_process_kill(process);
218 /** \ingroup m_process_management
219 * \brief Migrates a process to another location.
221 * This function checks whether \a process and \a host are valid pointers
222 and change the value of the #m_host_t on which \a process is running.
224 MSG_error_t MSG_process_migrate(m_process_t process, m_host_t host)
226 simdata_process_t simdata = simcall_process_get_data(process);
227 simdata->m_host = host;
229 m_host_t now = simdata->m_host;
230 TRACE_msg_process_change_host(process, now, host);
232 simcall_process_change_host(process, host->smx_host);
236 /** \ingroup m_process_management
237 * \brief Returns the user data of a process.
239 * This function checks whether \a process is a valid pointer or not
240 and returns the user data associated to this process.
242 void* MSG_process_get_data(m_process_t process)
244 xbt_assert(process != NULL, "Invalid parameter");
246 /* get from SIMIX the MSG process data, and then the user data */
247 simdata_process_t simdata = simcall_process_get_data(process);
248 return simdata->data;
251 /** \ingroup m_process_management
252 * \brief Sets the user data of a process.
254 * This function checks whether \a process is a valid pointer or not
255 and sets the user data associated to this process.
257 MSG_error_t MSG_process_set_data(m_process_t process, void *data)
259 xbt_assert(process != NULL, "Invalid parameter");
261 simdata_process_t simdata = simcall_process_get_data(process);
262 simdata->data = data;
267 /** \ingroup m_process_management
268 * \brief Sets a cleanup function to be called to free the userdata of a
269 * process when a process is destroyed.
270 * \param data_cleanup a cleanup function for the userdata of a process,
271 * or NULL to call no function
273 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
275 msg_global->process_data_cleanup = data_cleanup;
278 /** \ingroup m_process_management
279 * \brief Return the location on which a process is running.
280 * \param process a process (NULL means the current one)
281 * \return the m_host_t corresponding to the location on which \a
282 * process is running.
284 m_host_t MSG_process_get_host(m_process_t process)
286 simdata_process_t simdata;
287 if (process == NULL) {
288 simdata = SIMIX_process_self_get_data(SIMIX_process_self());
291 simdata = simcall_process_get_data(process);
293 return simdata->m_host;
296 /** \ingroup m_process_management
298 * \brief Return a #m_process_t given its PID.
300 * This function search in the list of all the created m_process_t for a m_process_t
301 whose PID is equal to \a PID. If no host is found, \c NULL is returned.
302 Note that the PID are uniq in the whole simulation, not only on a given host.
304 m_process_t MSG_process_from_PID(int PID)
306 return SIMIX_process_from_PID(PID);
309 /** @brief returns a list of all currently existing processes */
310 xbt_dynar_t MSG_processes_as_dynar(void) {
311 return SIMIX_processes_as_dynar();
314 /** \ingroup m_process_management
315 * \brief Set the kill time of a process.
317 * \param process a process
318 * \param kill_time the time when the process is killed.
320 MSG_error_t MSG_process_set_kill_time(m_process_t process, double kill_time)
322 simcall_process_set_kill_time(process,kill_time);
326 /** \ingroup m_process_management
327 * \brief Returns the process ID of \a process.
329 * This function checks whether \a process is a valid pointer or not
330 and return its PID (or 0 in case of problem).
332 int MSG_process_get_PID(m_process_t process)
334 /* Do not raise an exception here: this function is called by the logs
335 * and the exceptions, so it would be called back again and again */
336 if (process == NULL) {
340 simdata_process_t simdata = simcall_process_get_data(process);
342 return simdata != NULL ? simdata->PID : 0;
345 /** \ingroup m_process_management
346 * \brief Returns the process ID of the parent of \a process.
348 * This function checks whether \a process is a valid pointer or not
349 and return its PID. Returns -1 if the process has not been created by
352 int MSG_process_get_PPID(m_process_t process)
354 xbt_assert(process != NULL, "Invalid parameter");
356 simdata_process_t simdata = simcall_process_get_data(process);
358 return simdata->PPID;
361 /** \ingroup m_process_management
362 * \brief Return the name of a process.
364 * This function checks whether \a process is a valid pointer or not
367 const char *MSG_process_get_name(m_process_t process)
369 xbt_assert(process, "Invalid parameter");
371 return simcall_process_get_name(process);
374 /** \ingroup m_process_management
375 * \brief Returns the value of a given process property
377 * \param process a process
378 * \param name a property name
379 * \return value of a property (or NULL if the property is not set)
381 const char *MSG_process_get_property_value(m_process_t process,
384 return xbt_dict_get_or_null(MSG_process_get_properties(process), name);
387 /** \ingroup m_process_management
388 * \brief Return the list of properties
390 * This function returns all the parameters associated with a process
392 xbt_dict_t MSG_process_get_properties(m_process_t process)
394 xbt_assert(process != NULL, "Invalid parameter");
396 return simcall_process_get_properties(process);
400 /** \ingroup m_process_management
401 * \brief Return the PID of the current process.
403 * This function returns the PID of the currently running #m_process_t.
405 int MSG_process_self_PID(void)
407 return MSG_process_get_PID(MSG_process_self());
410 /** \ingroup m_process_management
411 * \brief Return the PPID of the current process.
413 * This function returns the PID of the parent of the currently
414 * running #m_process_t.
416 int MSG_process_self_PPID(void)
418 return MSG_process_get_PPID(MSG_process_self());
421 /** \ingroup m_process_management
422 * \brief Return the current process.
424 * This function returns the currently running #m_process_t.
426 m_process_t MSG_process_self(void)
428 return SIMIX_process_self();
431 /** \ingroup m_process_management
432 * \brief Suspend the process.
434 * This function suspends the process by suspending the task on which
435 * it was waiting for the completion.
437 MSG_error_t MSG_process_suspend(m_process_t process)
439 xbt_assert(process != NULL, "Invalid parameter");
442 TRACE_msg_process_suspend(process);
445 simcall_process_suspend(process);
449 /** \ingroup m_process_management
450 * \brief Resume a suspended process.
452 * This function resumes a suspended process by resuming the task on
453 * which it was waiting for the completion.
455 MSG_error_t MSG_process_resume(m_process_t process)
457 xbt_assert(process != NULL, "Invalid parameter");
460 TRACE_msg_process_resume(process);
463 simcall_process_resume(process);
467 /** \ingroup m_process_management
468 * \brief Returns true if the process is suspended .
470 * This checks whether a process is suspended or not by inspecting the
471 * task on which it was waiting for the completion.
473 int MSG_process_is_suspended(m_process_t process)
475 xbt_assert(process != NULL, "Invalid parameter");
476 return simcall_process_is_suspended(process);
479 smx_context_t MSG_process_get_smx_ctx(m_process_t process) {
480 return SIMIX_process_get_context(process);
483 * \ingroup m_process_management
484 * \brief Add a function to the list of "on_exit" functions for the current process.
485 * The on_exit functions are the functions executed when your process is killed.
486 * You should use them to free the data used by your process.
488 void MSG_process_on_exit(int_f_pvoid_t fun, void *data) {
489 simcall_process_on_exit(MSG_process_self(),fun,data);