1 /* Copyright (c) 2004-2013. 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 && msg_proc->data && msg_global->process_data_cleanup) {
50 msg_global->process_data_cleanup(msg_proc->data);
53 // free the MSG process
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, int argc, char **argv,
61 xbt_dict_t properties, int auto_restart)
63 msg_host_t host = MSG_get_host_by_name(hostname);
64 msg_process_t p = MSG_process_create_with_environment(name, code, data,
68 MSG_process_set_kill_time(p,kill_time);
69 MSG_process_auto_restart_set(p,auto_restart);
71 *((msg_process_t*) process) = p;
74 /** \ingroup m_process_management
75 * \brief Creates and runs a new #msg_process_t.
77 * Does exactly the same as #MSG_process_create_with_arguments but without
78 providing standard arguments (\a argc, \a argv, \a start_time, \a kill_time).
79 * \sa MSG_process_create_with_arguments
81 msg_process_t MSG_process_create(const char *name,
82 xbt_main_func_t code, void *data,
85 return MSG_process_create_with_environment(name, code, data, host, -1,
89 /** \ingroup m_process_management
90 * \brief Creates and runs a new #msg_process_t.
92 * A constructor for #msg_process_t taking four arguments and returning the
93 * corresponding object. The structure (and the corresponding thread) is
94 * created, and put in the list of ready process.
95 * \param name a name for the object. It is for user-level information
97 * \param code is a function describing the behavior of the process. It
98 should then only use functions described in \ref
99 m_process_management (to create a new #msg_process_t for example),
100 in \ref m_host_management (only the read-only functions i.e. whose
101 name contains the word get), in \ref m_task_management (to create
102 or destroy some #msg_task_t for example) and in \ref
103 msg_task_usage (to handle file transfers and task processing).
104 * \param data a pointer to any data one may want to attach to the new
105 object. It is for user-level information and can be NULL. It can
106 be retrieved with the function \ref MSG_process_get_data.
107 * \param host the location where the new process is executed.
108 * \param argc first argument passed to \a code
109 * \param argv second argument passed to \a code
111 * \return The new corresponding object.
114 msg_process_t MSG_process_create_with_arguments(const char *name,
115 xbt_main_func_t code,
116 void *data, msg_host_t host,
117 int argc, char **argv)
119 return MSG_process_create_with_environment(name, code, data, host,
123 /** \ingroup m_process_management
124 * \brief Creates and runs a new #msg_process_t.
126 * A constructor for #msg_process_t taking four arguments and returning the
127 * corresponding object. The structure (and the corresponding thread) is
128 * created, and put in the list of ready process.
129 * \param name a name for the object. It is for user-level information
131 * \param code is a function describing the behavior of the process. It
132 should then only use functions described in \ref
133 m_process_management (to create a new #msg_process_t for example),
134 in \ref m_host_management (only the read-only functions i.e. whose
135 name contains the word get), in \ref m_task_management (to create
136 or destroy some #msg_task_t for example) and in \ref
137 msg_task_usage (to handle file transfers and task processing).
138 * \param data a pointer to any data one may want to attach to the new
139 object. It is for user-level information and can be NULL. It can
140 be retrieved with the function \ref MSG_process_get_data.
141 * \param host the location where the new process is executed.
142 * \param argc first argument passed to \a code
143 * \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.
144 * \param properties list a properties defined for this process
146 * \return The new corresponding object.
148 msg_process_t MSG_process_create_with_environment(const char *name,
149 xbt_main_func_t code,
150 void *data, msg_host_t host,
151 int argc, char **argv,
152 xbt_dict_t properties)
154 xbt_assert(code != NULL && host != NULL, "Invalid parameters");
155 simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1);
156 msg_process_t process;
158 /* Simulator data for MSG */
159 simdata->waiting_action = NULL;
160 simdata->waiting_task = NULL;
161 simdata->m_host = host;
162 simdata->argc = argc;
163 simdata->argv = argv;
164 simdata->data = data;
165 simdata->last_errno = MSG_OK;
167 /* Let's create the process: SIMIX may decide to start it right now,
168 * even before returning the flow control to us */
169 simcall_process_create(&process, name, code, simdata, sg_host_name(host), -1,
170 argc, argv, properties,0);
173 TRACE_msg_process_create(name, simcall_process_get_PID(process), simdata->m_host);
177 /* Undo everything we have just changed */
183 simcall_process_on_exit(process,(int_f_pvoid_t)TRACE_msg_process_kill,MSG_process_self());
189 /** \ingroup m_process_management
190 * \param process poor victim
192 * This function simply kills a \a process... scary isn't it ? :)
194 void MSG_process_kill(msg_process_t process)
196 // /* FIXME: why do we only cancel communication actions? is this useful? */
197 // simdata_process_t p_simdata = simcall_process_get_data(process);
198 // if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) {
199 // simcall_comm_cancel(p_simdata->waiting_task->simdata->comm);
202 simcall_process_kill(process);
207 /** \ingroup m_process_management
208 * \brief Migrates a process to another location.
210 * This function checks whether \a process and \a host are valid pointers
211 and change the value of the #msg_host_t on which \a process is running.
213 msg_error_t MSG_process_migrate(msg_process_t process, msg_host_t host)
215 simdata_process_t simdata = simcall_process_get_data(process);
216 simdata->m_host = host;
218 msg_host_t now = simdata->m_host;
219 TRACE_msg_process_change_host(process, now, host);
221 simcall_process_change_host(process, host);
225 /** \ingroup m_process_management
226 * \brief Returns the user data of a process.
228 * This function checks whether \a process is a valid pointer or not
229 and returns the user data associated to this process.
231 void* MSG_process_get_data(msg_process_t process)
233 xbt_assert(process != NULL, "Invalid parameter");
235 /* get from SIMIX the MSG process data, and then the user data */
236 simdata_process_t simdata = simcall_process_get_data(process);
237 return simdata->data;
240 /** \ingroup m_process_management
241 * \brief Sets the user data of a process.
243 * This function checks whether \a process is a valid pointer or not
244 and sets the user data associated to this process.
246 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
248 xbt_assert(process != NULL, "Invalid parameter");
250 simdata_process_t simdata = simcall_process_get_data(process);
251 simdata->data = data;
256 /** \ingroup m_process_management
257 * \brief Sets a cleanup function to be called to free the userdata of a
258 * process when a process is destroyed.
259 * \param data_cleanup a cleanup function for the userdata of a process,
260 * or NULL to call no function
262 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
264 msg_global->process_data_cleanup = data_cleanup;
267 /** \ingroup m_process_management
268 * \brief Return the location on which a process is running.
269 * \param process a process (NULL means the current one)
270 * \return the msg_host_t corresponding to the location on which \a
271 * process is running.
273 msg_host_t MSG_process_get_host(msg_process_t process)
275 simdata_process_t simdata;
276 if (process == NULL) {
277 simdata = SIMIX_process_self_get_data(SIMIX_process_self());
280 simdata = simcall_process_get_data(process);
282 return simdata->m_host;
285 /** \ingroup m_process_management
287 * \brief Return a #msg_process_t given its PID.
289 * This function search in the list of all the created msg_process_t for a msg_process_t
290 whose PID is equal to \a PID. If no host is found, \c NULL is returned.
291 Note that the PID are uniq in the whole simulation, not only on a given host.
293 msg_process_t MSG_process_from_PID(int PID)
295 return SIMIX_process_from_PID(PID);
298 /** @brief returns a list of all currently existing processes */
299 xbt_dynar_t MSG_processes_as_dynar(void) {
300 return SIMIX_processes_as_dynar();
302 /** @brief Return the current number MSG processes.
304 int MSG_process_get_number(void)
306 return SIMIX_process_count();
309 /** \ingroup m_process_management
310 * \brief Set the kill time of a process.
312 * \param process a process
313 * \param kill_time the time when the process is killed.
315 msg_error_t MSG_process_set_kill_time(msg_process_t process, double kill_time)
317 simcall_process_set_kill_time(process,kill_time);
321 /** \ingroup m_process_management
322 * \brief Returns the process ID of \a process.
324 * This function checks whether \a process is a valid pointer or not
325 and return its PID (or 0 in case of problem).
327 int MSG_process_get_PID(msg_process_t process)
329 /* Do not raise an exception here: this function is called by the logs
330 * and the exceptions, so it would be called back again and again */
331 if (process == NULL) {
334 return simcall_process_get_PID(process);
337 /** \ingroup m_process_management
338 * \brief Returns the process ID of the parent of \a process.
340 * This function checks whether \a process is a valid pointer or not
341 and return its PID. Returns -1 if the process has not been created by
344 int MSG_process_get_PPID(msg_process_t process)
346 xbt_assert(process != NULL, "Invalid parameter");
348 return simcall_process_get_PPID(process);
351 /** \ingroup m_process_management
352 * \brief Return the name of a process.
354 * This function checks whether \a process is a valid pointer or not
357 const char *MSG_process_get_name(msg_process_t process)
359 xbt_assert(process, "Invalid parameter");
361 return simcall_process_get_name(process);
364 /** \ingroup m_process_management
365 * \brief Returns the value of a given process property
367 * \param process a process
368 * \param name a property name
369 * \return value of a property (or NULL if the property is not set)
371 const char *MSG_process_get_property_value(msg_process_t process,
374 return xbt_dict_get_or_null(MSG_process_get_properties(process), name);
377 /** \ingroup m_process_management
378 * \brief Return the list of properties
380 * This function returns all the parameters associated with a process
382 xbt_dict_t MSG_process_get_properties(msg_process_t process)
384 xbt_assert(process != NULL, "Invalid parameter");
386 return simcall_process_get_properties(process);
390 /** \ingroup m_process_management
391 * \brief Return the PID of the current process.
393 * This function returns the PID of the currently running #msg_process_t.
395 int MSG_process_self_PID(void)
397 return MSG_process_get_PID(MSG_process_self());
400 /** \ingroup m_process_management
401 * \brief Return the PPID of the current process.
403 * This function returns the PID of the parent of the currently
404 * running #msg_process_t.
406 int MSG_process_self_PPID(void)
408 return MSG_process_get_PPID(MSG_process_self());
411 /** \ingroup m_process_management
412 * \brief Return the current process.
414 * This function returns the currently running #msg_process_t.
416 msg_process_t MSG_process_self(void)
418 return SIMIX_process_self();
421 /** \ingroup m_process_management
422 * \brief Suspend the process.
424 * This function suspends the process by suspending the task on which
425 * it was waiting for the completion.
427 msg_error_t MSG_process_suspend(msg_process_t process)
429 xbt_assert(process != NULL, "Invalid parameter");
432 TRACE_msg_process_suspend(process);
435 simcall_process_suspend(process);
439 /** \ingroup m_process_management
440 * \brief Resume a suspended process.
442 * This function resumes a suspended process by resuming the task on
443 * which it was waiting for the completion.
445 msg_error_t MSG_process_resume(msg_process_t process)
447 xbt_assert(process != NULL, "Invalid parameter");
450 TRACE_msg_process_resume(process);
453 simcall_process_resume(process);
457 /** \ingroup m_process_management
458 * \brief Returns true if the process is suspended .
460 * This checks whether a process is suspended or not by inspecting the
461 * task on which it was waiting for the completion.
463 int MSG_process_is_suspended(msg_process_t process)
465 xbt_assert(process != NULL, "Invalid parameter");
466 return simcall_process_is_suspended(process);
469 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) {
470 return SIMIX_process_get_context(process);
473 * \ingroup m_process_management
474 * \brief Add a function to the list of "on_exit" functions for the current process.
475 * The on_exit functions are the functions executed when your process is killed.
476 * You should use them to free the data used by your process.
478 void MSG_process_on_exit(int_f_pvoid_t fun, void *data) {
479 simcall_process_on_exit(MSG_process_self(),fun,data);
482 * \ingroup m_process_management
483 * \brief Sets the "auto-restart" flag of the process.
484 * If the flag is set to 1, the process will be automatically restarted when
485 * its host comes back up.
487 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart) {
488 simcall_process_auto_restart_set(process,auto_restart);
491 * \ingroup m_process_management
492 * \brief Restarts a process from the beginning.
494 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process) {
495 return simcall_process_restart(process);