3 /* Copyright (c) 2002-2007 Arnaud Legrand. */
4 /* Copyright (c) 2007 Bruno Donassolo. */
5 /* All rights reserved. */
7 /* This program is free software; you can redistribute it and/or modify it
8 * under the terms of the license (GNU LGPL) which comes with this package. */
10 #include "msg/private.h"
11 #include "xbt/sysdep.h"
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (process)");
16 /** \defgroup m_process_management Management Functions of Agents
17 * \brief This section describes the agent structure of MSG
18 * (#m_process_t) and the functions for managing it.
20 /** @addtogroup m_process_management
21 * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Agents" --> \endhtmlonly
23 * We need to simulate many independent scheduling decisions, so
24 * the concept of <em>process</em> is at the heart of the
25 * simulator. A process may be defined as a <em>code</em>, with
26 * some <em>private data</em>, executing in a <em>location</em>.
30 /******************************** Process ************************************/
31 /** \ingroup m_process_management
32 * \brief Creates and runs a new #m_process_t.
34 * Does exactly the same as #MSG_process_create_with_arguments but without
35 providing standard arguments (\a argc, \a argv, \a start_time, \a kill_time).
36 * \sa MSG_process_create_with_arguments
38 m_process_t MSG_process_create(const char *name,
39 m_process_code_t code, void *data,
42 return MSG_process_create_with_arguments(name, code, data, host, -1, NULL);
45 static void MSG_process_cleanup(void *arg)
47 /* arg is a pointer to a simix process, we can get the msg process with the field data */
48 m_process_t proc = ((smx_process_t)arg)->data;
49 xbt_fifo_remove(msg_global->process_list, proc);
50 SIMIX_process_cleanup(arg);
60 /** \ingroup m_process_management
61 * \brief Creates and runs a new #m_process_t.
63 * A constructor for #m_process_t taking four arguments and returning the
64 * corresponding object. The structure (and the corresponding thread) is
65 * created, and put in the list of ready process.
66 * \param name a name for the object. It is for user-level information
68 * \param code is a function describing the behavior of the agent. It
69 should then only use functions described in \ref
70 m_process_management (to create a new #m_process_t for example),
71 in \ref m_host_management (only the read-only functions i.e. whose
72 name contains the word get), in \ref m_task_management (to create
73 or destroy some #m_task_t for example) and in \ref
74 msg_gos_functions (to handle file transfers and task processing).
75 * \param data a pointer to any data one may want to attach to the new
76 object. It is for user-level information and can be NULL. It can
77 be retrieved with the function \ref MSG_process_get_data.
78 * \param host the location where the new agent is executed.
79 * \param argc first argument passed to \a code
80 * \param argv second argument passed to \a code
82 * \return The new corresponding object.
87 m_process_t __MSG_process_create_with_arguments(const char *name,
88 m_process_code_t code, void *data,
89 char * hostname, int argc, char **argv)
91 m_host_t host = MSG_get_host_by_name(hostname);
92 return MSG_process_create_with_arguments(name,code,data,host,argc,argv);
95 m_process_t MSG_process_create_with_arguments(const char *name,
96 m_process_code_t code, void *data,
97 m_host_t host, int argc, char **argv)
99 simdata_process_t simdata = xbt_new0(s_simdata_process_t,1);
100 m_process_t process = xbt_new0(s_m_process_t,1);
101 xbt_assert0(((code != NULL) && (host != NULL)), "Invalid parameters");
104 simdata->PID = msg_global->PID++;
105 simdata->waiting_task = NULL;
106 simdata->host = host;
107 simdata->argc = argc;
108 simdata->argv = argv;
109 simdata->smx_process = SIMIX_process_create(name, (smx_process_code_t)code, (void*)process, host->name, argc, argv, MSG_process_cleanup );
111 if (SIMIX_process_self()) {
112 simdata->PPID = MSG_process_get_PID(SIMIX_process_self()->data);
114 else simdata->PPID = -1;
115 simdata->last_errno=MSG_OK;
118 /* Process structure */
119 process->name = xbt_strdup(name);
120 process->simdata = simdata;
121 process->data = data;
123 xbt_fifo_unshift(msg_global->process_list, process);
128 /** \ingroup m_process_management
129 * \param process poor victim
131 * This function simply kills a \a process... scarry isn't it ? :)
133 void MSG_process_kill(m_process_t process)
135 simdata_process_t p_simdata = process->simdata;
137 DEBUG3("Killing %s(%d) on %s",process->name, p_simdata->PID, p_simdata->host->name);
139 if(p_simdata->waiting_task) {
140 DEBUG1("Canceling waiting task %s",p_simdata->waiting_task->name);
141 if(p_simdata->waiting_task->simdata->compute) {
142 SIMIX_action_cancel(p_simdata->waiting_task->simdata->compute);
144 else if (p_simdata->waiting_task->simdata->comm) {
145 SIMIX_action_cancel(p_simdata->waiting_task->simdata->comm);
149 xbt_fifo_remove(msg_global->process_list,process);
150 SIMIX_process_kill(process->simdata->smx_process);
155 /** \ingroup m_process_management
156 * \brief Migrates an agent to another location.
158 * This functions checks whether \a process and \a host are valid pointers
159 and change the value of the #m_host_t on which \a process is running.
161 MSG_error_t MSG_process_change_host(m_process_t process, m_host_t host)
163 xbt_die("MSG_process_change_host - not implemented yet - maybe useless function");
167 /** \ingroup m_process_management
168 * \brief Return the user data of a #m_process_t.
170 * This functions checks whether \a process is a valid pointer or not
171 and return the user data associated to \a process if it is possible.
173 void *MSG_process_get_data(m_process_t process)
175 xbt_assert0((process != NULL), "Invalid parameters");
177 return (process->data);
180 /** \ingroup m_process_management
181 * \brief Set the user data of a #m_process_t.
183 * This functions checks whether \a process is a valid pointer or not
184 and set the user data associated to \a process if it is possible.
186 MSG_error_t MSG_process_set_data(m_process_t process,void *data)
188 xbt_assert0((process != NULL), "Invalid parameters");
189 xbt_assert0((process->data == NULL), "Data already set");
191 process->data = data;
196 /** \ingroup m_process_management
197 * \brief Return the location on which an agent is running.
199 * This functions checks whether \a process is a valid pointer or not
200 and return the m_host_t corresponding to the location on which \a
203 m_host_t MSG_process_get_host(m_process_t process)
205 xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
207 return (((simdata_process_t) process->simdata)->host);
210 /** \ingroup m_process_management
212 * \brief Return a #m_process_t given its PID.
214 * This functions search in the list of all the created m_process_t for a m_process_t
215 whose PID is equal to \a PID. If no host is found, \c NULL is returned.
216 Note that the PID are uniq in the whole simulation, not only on a given host.
218 m_process_t MSG_process_from_PID(int PID)
220 xbt_fifo_item_t i = NULL;
221 m_process_t process = NULL;
223 xbt_fifo_foreach(msg_global->process_list,i,process,m_process_t) {
224 if(MSG_process_get_PID(process) == PID) return process;
229 /** \ingroup m_process_management
230 * \brief Returns the process ID of \a process.
232 * This functions checks whether \a process is a valid pointer or not
235 int MSG_process_get_PID(m_process_t process)
237 /* Do not raise an exception here: this function is used in the logs,
238 and it will be called back by the exception handling stuff */
239 if (process == NULL || process->simdata == NULL)
242 return (((simdata_process_t) process->simdata)->PID);
245 /** \ingroup m_process_management
246 * \brief Returns the process ID of the parent of \a process.
248 * This functions checks whether \a process is a valid pointer or not
249 and return its PID. Returns -1 if the agent has not been created by
252 int MSG_process_get_PPID(m_process_t process)
254 xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
256 return (((simdata_process_t) process->simdata)->PPID);
259 /** \ingroup m_process_management
260 * \brief Return the name of an agent.
262 * This functions checks whether \a process is a valid pointer or not
265 const char *MSG_process_get_name(m_process_t process)
267 xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
269 return (process->name);
272 /** \ingroup m_process_management
273 * \brief Return the PID of the current agent.
275 * This functions returns the PID of the currently running #m_process_t.
277 int MSG_process_self_PID(void)
279 return (MSG_process_get_PID(MSG_process_self()));
282 /** \ingroup m_process_management
283 * \brief Return the PPID of the current agent.
285 * This functions returns the PID of the parent of the currently
286 * running #m_process_t.
288 int MSG_process_self_PPID(void)
290 return (MSG_process_get_PPID(MSG_process_self()));
293 /** \ingroup m_process_management
294 * \brief Return the current agent.
296 * This functions returns the currently running #m_process_t.
298 m_process_t MSG_process_self(void)
300 smx_process_t proc = SIMIX_process_self();
302 return (m_process_t)proc->data;
310 /** \ingroup m_process_management
311 * \brief Suspend the process.
313 * This functions suspend the process by suspending the task on which
314 * it was waiting for the completion.
316 MSG_error_t MSG_process_suspend(m_process_t process)
318 xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
321 SIMIX_process_suspend(process->simdata->smx_process);
325 /** \ingroup m_process_management
326 * \brief Resume a suspended process.
328 * This functions resume a suspended process by resuming the task on
329 * which it was waiting for the completion.
331 MSG_error_t MSG_process_resume(m_process_t process)
334 xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
337 SIMIX_process_resume(process->simdata->smx_process);
341 /** \ingroup m_process_management
342 * \brief Returns true if the process is suspended .
344 * This checks whether a process is suspended or not by inspecting the
345 * task on which it was waiting for the completion.
347 int MSG_process_is_suspended(m_process_t process)
349 xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
350 return SIMIX_process_is_suspended(process->simdata->smx_process);