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);
48 // free the data if a function was provided
49 if (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
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
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->PID = msg_global->PID++;
166 simdata->waiting_action = NULL;
167 simdata->waiting_task = NULL;
168 simdata->m_host = host;
169 simdata->argc = argc;
170 simdata->argv = argv;
171 simdata->data = data;
172 simdata->last_errno = MSG_OK;
174 if (SIMIX_process_self()) {
175 simdata->PPID = MSG_process_get_PID(MSG_process_self());
181 TRACE_msg_process_create(name, simdata->PID, simdata->m_host);
183 /* Let's create the process: SIMIX may decide to start it right now,
184 * even before returning the flow control to us */
185 simcall_process_create(&process, name, code, simdata, SIMIX_host_get_name(host->smx_host), -1,
186 argc, argv, properties,0);
189 /* Undo everything we have just changed */
196 simcall_process_on_exit(process,(int_f_pvoid_t)TRACE_msg_process_kill,MSG_process_self());
202 /** \ingroup m_process_management
203 * \param process poor victim
205 * This function simply kills a \a process... scary isn't it ? :)
207 void MSG_process_kill(msg_process_t process)
209 // /* FIXME: why do we only cancel communication actions? is this useful? */
210 // simdata_process_t p_simdata = simcall_process_get_data(process);
211 // if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) {
212 // simcall_comm_cancel(p_simdata->waiting_task->simdata->comm);
215 simcall_process_kill(process);
220 /** \ingroup m_process_management
221 * \brief Migrates a process to another location.
223 * This function checks whether \a process and \a host are valid pointers
224 and change the value of the #msg_host_t on which \a process is running.
226 msg_error_t MSG_process_migrate(msg_process_t process, msg_host_t host)
228 simdata_process_t simdata = simcall_process_get_data(process);
229 simdata->m_host = host;
231 msg_host_t now = simdata->m_host;
232 TRACE_msg_process_change_host(process, now, host);
234 simcall_process_change_host(process, host->smx_host);
238 /** \ingroup m_process_management
239 * \brief Returns the user data of a process.
241 * This function checks whether \a process is a valid pointer or not
242 and returns the user data associated to this process.
244 void* MSG_process_get_data(msg_process_t process)
246 xbt_assert(process != NULL, "Invalid parameter");
248 /* get from SIMIX the MSG process data, and then the user data */
249 simdata_process_t simdata = simcall_process_get_data(process);
250 return simdata->data;
253 /** \ingroup m_process_management
254 * \brief Sets the user data of a process.
256 * This function checks whether \a process is a valid pointer or not
257 and sets the user data associated to this process.
259 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
261 xbt_assert(process != NULL, "Invalid parameter");
263 simdata_process_t simdata = simcall_process_get_data(process);
264 simdata->data = data;
269 /** \ingroup m_process_management
270 * \brief Sets a cleanup function to be called to free the userdata of a
271 * process when a process is destroyed.
272 * \param data_cleanup a cleanup function for the userdata of a process,
273 * or NULL to call no function
275 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
277 msg_global->process_data_cleanup = data_cleanup;
280 /** \ingroup m_process_management
281 * \brief Return the location on which a process is running.
282 * \param process a process (NULL means the current one)
283 * \return the msg_host_t corresponding to the location on which \a
284 * process is running.
286 msg_host_t MSG_process_get_host(msg_process_t process)
288 simdata_process_t simdata;
289 if (process == NULL) {
290 simdata = SIMIX_process_self_get_data(SIMIX_process_self());
293 simdata = simcall_process_get_data(process);
295 return simdata->m_host;
298 /** \ingroup m_process_management
300 * \brief Return a #msg_process_t given its PID.
302 * This function search in the list of all the created msg_process_t for a msg_process_t
303 whose PID is equal to \a PID. If no host is found, \c NULL is returned.
304 Note that the PID are uniq in the whole simulation, not only on a given host.
306 msg_process_t MSG_process_from_PID(int PID)
308 return SIMIX_process_from_PID(PID);
311 /** @brief returns a list of all currently existing processes */
312 xbt_dynar_t MSG_processes_as_dynar(void) {
313 return SIMIX_processes_as_dynar();
315 /** @brief Return the current number MSG processes.
317 int MSG_process_get_number(void)
319 return SIMIX_process_count();
322 /** \ingroup m_process_management
323 * \brief Set the kill time of a process.
325 * \param process a process
326 * \param kill_time the time when the process is killed.
328 msg_error_t MSG_process_set_kill_time(msg_process_t process, double kill_time)
330 simcall_process_set_kill_time(process,kill_time);
334 /** \ingroup m_process_management
335 * \brief Returns the process ID of \a process.
337 * This function checks whether \a process is a valid pointer or not
338 and return its PID (or 0 in case of problem).
340 int MSG_process_get_PID(msg_process_t process)
342 /* Do not raise an exception here: this function is called by the logs
343 * and the exceptions, so it would be called back again and again */
344 if (process == NULL) {
348 simdata_process_t simdata = simcall_process_get_data(process);
350 return simdata != NULL ? simdata->PID : 0;
353 /** \ingroup m_process_management
354 * \brief Returns the process ID of the parent of \a process.
356 * This function checks whether \a process is a valid pointer or not
357 and return its PID. Returns -1 if the process has not been created by
360 int MSG_process_get_PPID(msg_process_t process)
362 xbt_assert(process != NULL, "Invalid parameter");
364 simdata_process_t simdata = simcall_process_get_data(process);
366 return simdata->PPID;
369 /** \ingroup m_process_management
370 * \brief Return the name of a process.
372 * This function checks whether \a process is a valid pointer or not
375 const char *MSG_process_get_name(msg_process_t process)
377 xbt_assert(process, "Invalid parameter");
379 return simcall_process_get_name(process);
382 /** \ingroup m_process_management
383 * \brief Returns the value of a given process property
385 * \param process a process
386 * \param name a property name
387 * \return value of a property (or NULL if the property is not set)
389 const char *MSG_process_get_property_value(msg_process_t process,
392 return xbt_dict_get_or_null(MSG_process_get_properties(process), name);
395 /** \ingroup m_process_management
396 * \brief Return the list of properties
398 * This function returns all the parameters associated with a process
400 xbt_dict_t MSG_process_get_properties(msg_process_t process)
402 xbt_assert(process != NULL, "Invalid parameter");
404 return simcall_process_get_properties(process);
408 /** \ingroup m_process_management
409 * \brief Return the PID of the current process.
411 * This function returns the PID of the currently running #msg_process_t.
413 int MSG_process_self_PID(void)
415 return MSG_process_get_PID(MSG_process_self());
418 /** \ingroup m_process_management
419 * \brief Return the PPID of the current process.
421 * This function returns the PID of the parent of the currently
422 * running #msg_process_t.
424 int MSG_process_self_PPID(void)
426 return MSG_process_get_PPID(MSG_process_self());
429 /** \ingroup m_process_management
430 * \brief Return the current process.
432 * This function returns the currently running #msg_process_t.
434 msg_process_t MSG_process_self(void)
436 return SIMIX_process_self();
439 /** \ingroup m_process_management
440 * \brief Suspend the process.
442 * This function suspends the process by suspending the task on which
443 * it was waiting for the completion.
445 msg_error_t MSG_process_suspend(msg_process_t process)
447 xbt_assert(process != NULL, "Invalid parameter");
450 TRACE_msg_process_suspend(process);
453 simcall_process_suspend(process);
457 /** \ingroup m_process_management
458 * \brief Resume a suspended process.
460 * This function resumes a suspended process by resuming the task on
461 * which it was waiting for the completion.
463 msg_error_t MSG_process_resume(msg_process_t process)
465 xbt_assert(process != NULL, "Invalid parameter");
468 TRACE_msg_process_resume(process);
471 simcall_process_resume(process);
475 /** \ingroup m_process_management
476 * \brief Returns true if the process is suspended .
478 * This checks whether a process is suspended or not by inspecting the
479 * task on which it was waiting for the completion.
481 int MSG_process_is_suspended(msg_process_t process)
483 xbt_assert(process != NULL, "Invalid parameter");
484 return simcall_process_is_suspended(process);
487 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) {
488 return SIMIX_process_get_context(process);
491 * \ingroup m_process_management
492 * \brief Add a function to the list of "on_exit" functions for the current process.
493 * The on_exit functions are the functions executed when your process is killed.
494 * You should use them to free the data used by your process.
496 void MSG_process_on_exit(int_f_pvoid_t fun, void *data) {
497 simcall_process_on_exit(MSG_process_self(),fun,data);
500 * \ingroup m_process_management
501 * \brief Sets the "auto-restart" flag of the process.
502 * If the flag is set to 1, the process will be automatically restarted when
503 * its host comes back up.
505 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart) {
506 simcall_process_auto_restart_set(process,auto_restart);
509 * \ingroup m_process_management
510 * \brief Restarts a process from the beginning.
512 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process) {
513 return simcall_process_restart(process);