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 /** \defgroup m_process_management Management Functions of Agents
15 * \brief This section describes the agent structure of MSG
16 * (#m_process_t) and the functions for managing it.
18 /** @addtogroup m_process_management
19 * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Agents" --> \endhtmlonly
21 * We need to simulate many independent scheduling decisions, so
22 * the concept of <em>process</em> is at the heart of the
23 * simulator. A process may be defined as a <em>code</em>, with
24 * some <em>private data</em>, executing in a <em>location</em>.
28 /******************************** Process ************************************/
29 void __MSG_process_cleanup(smx_process_t smx_proc)
31 /* arg is a pointer to a simix process, we can get the msg process with the field data */
32 m_process_t proc = SIMIX_req_process_get_data(smx_proc);
34 TRACE_msg_process_end(proc);
36 xbt_fifo_remove(msg_global->process_list, proc);
37 SIMIX_process_cleanup(smx_proc);
51 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
52 void *_MSG_process_create_from_SIMIX(const char *name,
53 xbt_main_func_t code, void *data,
54 char *hostname, int argc, char **argv,
55 xbt_dict_t properties)
57 m_host_t host = MSG_get_host_by_name(hostname);
58 return (void *) MSG_process_create_with_environment(name, code, data,
63 /** \ingroup m_process_management
64 * \brief Creates and runs a new #m_process_t.
66 * Does exactly the same as #MSG_process_create_with_arguments but without
67 providing standard arguments (\a argc, \a argv, \a start_time, \a kill_time).
68 * \sa MSG_process_create_with_arguments
70 m_process_t MSG_process_create(const char *name,
71 xbt_main_func_t code, void *data,
74 return MSG_process_create_with_environment(name, code, data, host, -1,
78 /** \ingroup m_process_management
79 * \brief Creates and runs a new #m_process_t.
81 * A constructor for #m_process_t taking four arguments and returning the
82 * corresponding object. The structure (and the corresponding thread) is
83 * created, and put in the list of ready process.
84 * \param name a name for the object. It is for user-level information
86 * \param code is a function describing the behavior of the agent. It
87 should then only use functions described in \ref
88 m_process_management (to create a new #m_process_t for example),
89 in \ref m_host_management (only the read-only functions i.e. whose
90 name contains the word get), in \ref m_task_management (to create
91 or destroy some #m_task_t for example) and in \ref
92 msg_gos_functions (to handle file transfers and task processing).
93 * \param data a pointer to any data one may want to attach to the new
94 object. It is for user-level information and can be NULL. It can
95 be retrieved with the function \ref MSG_process_get_data.
96 * \param host the location where the new agent is executed.
97 * \param argc first argument passed to \a code
98 * \param argv second argument passed to \a code
100 * \return The new corresponding object.
103 m_process_t MSG_process_create_with_arguments(const char *name,
104 xbt_main_func_t code,
105 void *data, m_host_t host,
106 int argc, char **argv)
108 return MSG_process_create_with_environment(name, code, data, host,
112 /** \ingroup m_process_management
113 * \brief Creates and runs a new #m_process_t.
115 * A constructor for #m_process_t taking four arguments and returning the
116 * corresponding object. The structure (and the corresponding thread) is
117 * created, and put in the list of ready process.
118 * \param name a name for the object. It is for user-level information
120 * \param code is a function describing the behavior of the agent. It
121 should then only use functions described in \ref
122 m_process_management (to create a new #m_process_t for example),
123 in \ref m_host_management (only the read-only functions i.e. whose
124 name contains the word get), in \ref m_task_management (to create
125 or destroy some #m_task_t for example) and in \ref
126 msg_gos_functions (to handle file transfers and task processing).
127 * \param data a pointer to any data one may want to attach to the new
128 object. It is for user-level information and can be NULL. It can
129 be retrieved with the function \ref MSG_process_get_data.
130 * \param host the location where the new agent is executed.
131 * \param argc first argument passed to \a code
132 * \param argv second argument passed to \a code
133 * \param properties list a properties defined for this process
135 * \return The new corresponding object.
137 m_process_t MSG_process_create_with_environment(const char *name,
138 xbt_main_func_t code,
139 void *data, m_host_t host,
140 int argc, char **argv,
141 xbt_dict_t properties)
143 simdata_process_t simdata = NULL;
144 m_process_t process = xbt_new0(s_m_process_t, 1);
145 xbt_assert0(((code != NULL) && (host != NULL)), "Invalid parameters");
147 simdata = xbt_new0(s_simdata_process_t, 1);
150 simdata->PID = msg_global->PID++;
151 simdata->waiting_action = NULL;
152 simdata->waiting_task = NULL;
153 simdata->m_host = host;
154 simdata->argc = argc;
155 simdata->argv = argv;
157 if (SIMIX_process_self()) {
158 simdata->PPID = MSG_process_get_PID(SIMIX_process_self_get_data());
162 simdata->last_errno = MSG_OK;
164 /* Process structure */
165 process->name = xbt_strdup(name);
166 process->simdata = simdata;
167 process->data = data;
168 xbt_fifo_unshift(msg_global->process_list, process);
170 /* Let's create the process (SIMIX may decide to start it right now) */
171 simdata->s_process = SIMIX_req_process_create(name, code, (void *) process, host->name,
172 argc, argv, properties);
174 if (!simdata->s_process) {
175 /* Undo everything we have just changed */
177 xbt_fifo_remove(msg_global->process_list, process);
178 xbt_free(process->name);
187 void _MSG_process_kill_from_SIMIX(void *p)
190 TRACE_msg_process_kill((m_process_t) p);
192 MSG_process_kill((m_process_t) p);
195 /** \ingroup m_process_management
196 * \param process poor victim
198 * This function simply kills a \a process... scarry isn't it ? :)
200 void MSG_process_kill(m_process_t process)
202 simdata_process_t p_simdata = process->simdata;
205 TRACE_msg_process_kill(process);
208 DEBUG3("Killing %s(%d) on %s",
209 process->name, p_simdata->PID, p_simdata->m_host->name);
211 if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) {
212 SIMIX_req_comm_cancel(p_simdata->waiting_task->simdata->comm);
215 xbt_fifo_remove(msg_global->process_list, process);
216 SIMIX_req_process_kill(process->simdata->s_process);
221 /** \ingroup m_process_management
222 * \brief Migrates an agent 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_change_host(m_host_t host)
229 m_process_t process = MSG_process_self();
230 m_host_t now = process->simdata->m_host;
231 process->simdata->m_host = host;
233 TRACE_msg_process_change_host(process, now, host);
235 SIMIX_req_process_change_host(process->simdata->s_process, now->name,
240 /** \ingroup m_process_management
241 * \brief Return the user data of a #m_process_t.
243 * This function checks whether \a process is a valid pointer or not
244 and return the user data associated to \a process if it is possible.
246 void *MSG_process_get_data(m_process_t process)
248 xbt_assert0((process != NULL), "Invalid parameters");
250 return (process->data);
253 /** \ingroup m_process_management
254 * \brief Set the user data of a #m_process_t.
256 * This function checks whether \a process is a valid pointer or not
257 and set the user data associated to \a process if it is possible.
259 MSG_error_t MSG_process_set_data(m_process_t process, void *data)
261 xbt_assert0((process != NULL), "Invalid parameters");
263 process->data = data;
268 /** \ingroup m_process_management
269 * \brief Return the location on which an agent is running.
271 * This function checks whether \a process is a valid pointer or not
272 and return the m_host_t corresponding to the location on which \a
275 m_host_t MSG_process_get_host(m_process_t process)
277 xbt_assert0(((process != NULL)
278 && (process->simdata)), "Invalid parameters");
280 return (((simdata_process_t) process->simdata)->m_host);
283 /** \ingroup m_process_management
285 * \brief Return a #m_process_t given its PID.
287 * This function search in the list of all the created m_process_t for a m_process_t
288 whose PID is equal to \a PID. If no host is found, \c NULL is returned.
289 Note that the PID are uniq in the whole simulation, not only on a given host.
291 m_process_t MSG_process_from_PID(int PID)
293 xbt_fifo_item_t i = NULL;
294 m_process_t process = NULL;
296 xbt_fifo_foreach(msg_global->process_list, i, process, m_process_t) {
297 if (MSG_process_get_PID(process) == PID)
303 /** \ingroup m_process_management
304 * \brief Returns the process ID of \a process.
306 * This function checks whether \a process is a valid pointer or not
307 and return its PID (or 0 in case of problem).
309 int MSG_process_get_PID(m_process_t process)
311 /* Do not raise an exception here: this function is used in the logs,
312 and it will be called back by the exception handling stuff */
313 if (process == NULL || process->simdata == NULL)
316 return (((simdata_process_t) process->simdata)->PID);
319 /** \ingroup m_process_management
320 * \brief Returns the process ID of the parent of \a process.
322 * This function checks whether \a process is a valid pointer or not
323 and return its PID. Returns -1 if the agent has not been created by
326 int MSG_process_get_PPID(m_process_t process)
328 xbt_assert0(((process != NULL)
329 && (process->simdata)), "Invalid parameters");
331 return (((simdata_process_t) process->simdata)->PPID);
334 /** \ingroup m_process_management
335 * \brief Return the name of an agent.
337 * This function checks whether \a process is a valid pointer or not
340 const char *MSG_process_get_name(m_process_t process)
342 xbt_assert0(process, "Invalid parameter: process is NULL");
343 xbt_assert0(process->simdata,
344 "Invalid parameter: process->simdata is NULL");
346 return (process->name);
349 /** \ingroup m_process_management
350 * \brief Returns the value of a given process property
352 * \param process a process
353 * \param name a property name
354 * \return value of a property (or NULL if the property is not set)
356 const char *MSG_process_get_property_value(m_process_t process,
359 return xbt_dict_get_or_null(MSG_process_get_properties(process), name);
362 /** \ingroup m_process_management
363 * \brief Return the list of properties
365 * This function returns all the parameters associated with a process
367 xbt_dict_t MSG_process_get_properties(m_process_t process)
369 xbt_assert0((process != NULL), "Invalid parameters");
371 return (SIMIX_req_process_get_properties
372 (((simdata_process_t) process->simdata)->s_process));
376 /** \ingroup m_process_management
377 * \brief Return the PID of the current agent.
379 * This function returns the PID of the currently running #m_process_t.
381 int MSG_process_self_PID(void)
383 return (MSG_process_get_PID(MSG_process_self()));
386 /** \ingroup m_process_management
387 * \brief Return the PPID of the current agent.
389 * This function returns the PID of the parent of the currently
390 * running #m_process_t.
392 int MSG_process_self_PPID(void)
394 return (MSG_process_get_PPID(MSG_process_self()));
397 /** \ingroup m_process_management
398 * \brief Return the current agent.
400 * This function returns the currently running #m_process_t.
402 m_process_t MSG_process_self(void)
404 /* we cannot make a SIMIX request here because this may create an exception or a logging
405 event, and both mechanisms call MSG_process_self() again (via xbt_getpid()) */
406 return (m_process_t) SIMIX_process_self_get_data();
409 /** \ingroup m_process_management
410 * \brief Suspend the process.
412 * This function suspends the process by suspending the task on which
413 * it was waiting for the completion.
415 MSG_error_t MSG_process_suspend(m_process_t process)
417 xbt_assert0(((process != NULL)
418 && (process->simdata)), "Invalid parameters");
422 TRACE_msg_process_suspend(process);
425 SIMIX_req_process_suspend(process->simdata->s_process);
429 /** \ingroup m_process_management
430 * \brief Resume a suspended process.
432 * This function resumes a suspended process by resuming the task on
433 * which it was waiting for the completion.
435 MSG_error_t MSG_process_resume(m_process_t process)
438 xbt_assert0(((process != NULL)
439 && (process->simdata)), "Invalid parameters");
443 TRACE_msg_process_resume(process);
446 SIMIX_req_process_resume(process->simdata->s_process);
450 /** \ingroup m_process_management
451 * \brief Returns true if the process is suspended .
453 * This checks whether a process is suspended or not by inspecting the
454 * task on which it was waiting for the completion.
456 int MSG_process_is_suspended(m_process_t process)
458 xbt_assert0(((process != NULL)
459 && (process->simdata)), "Invalid parameters");
460 return SIMIX_req_process_is_suspended(process->simdata->s_process);
464 smx_context_t MSG_process_get_smx_ctx(m_process_t process) {
465 return SIMIX_process_get_context(process->simdata->s_process);