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"
13 #include "../simix/private.h"
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg,
16 "Logging specific to MSG (process)");
18 /** \defgroup m_process_management Management Functions of Agents
19 * \brief This section describes the agent structure of MSG
20 * (#m_process_t) and the functions for managing it.
22 /** @addtogroup m_process_management
23 * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Agents" --> \endhtmlonly
25 * We need to simulate many independent scheduling decisions, so
26 * the concept of <em>process</em> is at the heart of the
27 * simulator. A process may be defined as a <em>code</em>, with
28 * some <em>private data</em>, executing in a <em>location</em>.
32 /******************************** Process ************************************/
33 void __MSG_process_cleanup(void *arg)
35 /* arg is a pointer to a simix process, we can get the msg process with the field data */
36 m_process_t proc = ((smx_process_t) arg)->data;
37 xbt_fifo_remove(msg_global->process_list, proc);
38 SIMIX_process_cleanup(arg);
48 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
49 void *_MSG_process_create_from_SIMIX(const char *name,
50 xbt_main_func_t code, void *data,
51 char *hostname, int argc, char **argv, xbt_dict_t properties)
53 m_host_t host = MSG_get_host_by_name(hostname);
54 return (void *) MSG_process_create_with_environment(name, code, data, host,
55 argc, argv,properties);
58 /** \ingroup m_process_management
59 * \brief Creates and runs a new #m_process_t.
61 * Does exactly the same as #MSG_process_create_with_arguments but without
62 providing standard arguments (\a argc, \a argv, \a start_time, \a kill_time).
63 * \sa MSG_process_create_with_arguments
65 m_process_t MSG_process_create(const char *name,
66 xbt_main_func_t code, void *data,
69 return MSG_process_create_with_environment(name, code, data, host, -1,
73 /** \ingroup m_process_management
74 * \brief Creates and runs a new #m_process_t.
76 * A constructor for #m_process_t taking four arguments and returning the
77 * corresponding object. The structure (and the corresponding thread) is
78 * created, and put in the list of ready process.
79 * \param name a name for the object. It is for user-level information
81 * \param code is a function describing the behavior of the agent. It
82 should then only use functions described in \ref
83 m_process_management (to create a new #m_process_t for example),
84 in \ref m_host_management (only the read-only functions i.e. whose
85 name contains the word get), in \ref m_task_management (to create
86 or destroy some #m_task_t for example) and in \ref
87 msg_gos_functions (to handle file transfers and task processing).
88 * \param data a pointer to any data one may want to attach to the new
89 object. It is for user-level information and can be NULL. It can
90 be retrieved with the function \ref MSG_process_get_data.
91 * \param host the location where the new agent is executed.
92 * \param argc first argument passed to \a code
93 * \param argv second argument passed to \a code
95 * \return The new corresponding object.
98 m_process_t MSG_process_create_with_arguments(const char *name,
100 void *data, m_host_t host,
101 int argc, char **argv)
103 return MSG_process_create_with_environment(name, code, data, host,
107 /** \ingroup m_process_management
108 * \brief Creates and runs a new #m_process_t.
110 * A constructor for #m_process_t taking four arguments and returning the
111 * corresponding object. The structure (and the corresponding thread) is
112 * created, and put in the list of ready process.
113 * \param name a name for the object. It is for user-level information
115 * \param code is a function describing the behavior of the agent. It
116 should then only use functions described in \ref
117 m_process_management (to create a new #m_process_t for example),
118 in \ref m_host_management (only the read-only functions i.e. whose
119 name contains the word get), in \ref m_task_management (to create
120 or destroy some #m_task_t for example) and in \ref
121 msg_gos_functions (to handle file transfers and task processing).
122 * \param data a pointer to any data one may want to attach to the new
123 object. It is for user-level information and can be NULL. It can
124 be retrieved with the function \ref MSG_process_get_data.
125 * \param host the location where the new agent is executed.
126 * \param argc first argument passed to \a code
127 * \param argv second argument passed to \a code
128 * \param properties list a properties defined for this process
130 * \return The new corresponding object.
132 m_process_t MSG_process_create_with_environment(const char *name,
133 xbt_main_func_t code,
134 void *data, m_host_t host,
135 int argc, char **argv, xbt_dict_t properties)
137 simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1);
138 m_process_t process = xbt_new0(s_m_process_t, 1);
139 xbt_assert0(((code != NULL) && (host != NULL)), "Invalid parameters");
142 simdata->PID = msg_global->PID++;
143 simdata->waiting_task = NULL;
144 simdata->m_host = host;
145 simdata->argc = argc;
146 simdata->argv = argv;
147 simdata->s_process = SIMIX_process_create(name, code,
148 (void *) process, host->name,
149 argc, argv, properties);
151 if (SIMIX_process_self()) {
152 simdata->PPID = MSG_process_get_PID(SIMIX_process_self()->data);
156 simdata->last_errno = MSG_OK;
159 /* Process structure */
160 process->name = xbt_strdup(name);
161 process->simdata = simdata;
162 process->data = data;
164 xbt_fifo_unshift(msg_global->process_list, process);
170 void _MSG_process_kill_from_SIMIX(void *p)
172 MSG_process_kill((m_process_t) p);
175 /** \ingroup m_process_management
176 * \param process poor victim
178 * This function simply kills a \a process... scarry isn't it ? :)
180 void MSG_process_kill(m_process_t process)
182 simdata_process_t p_simdata = process->simdata;
184 DEBUG3("Killing %s(%d) on %s",
185 process->name, p_simdata->PID, p_simdata->m_host->name);
187 if (p_simdata->waiting_task) {
188 DEBUG1("Canceling waiting task %s", p_simdata->waiting_task->name);
189 if (p_simdata->waiting_task->simdata->compute) {
190 SIMIX_action_cancel(p_simdata->waiting_task->simdata->compute);
191 } else if (p_simdata->waiting_task->simdata->comm) {
192 SIMIX_action_cancel(p_simdata->waiting_task->simdata->comm);
196 xbt_fifo_remove(msg_global->process_list, process);
197 SIMIX_process_kill(process->simdata->s_process);
202 /** \ingroup m_process_management
203 * \brief Migrates an agent to another location.
205 * This function checks whether \a process and \a host are valid pointers
206 and change the value of the #m_host_t on which \a process is running.
208 MSG_error_t MSG_process_change_host(m_host_t host)
210 m_process_t process = MSG_process_self();
211 m_host_t now = process->simdata->m_host;
212 process->simdata->m_host = host;
213 SIMIX_process_change_host(process->simdata->s_process, now->name, host->name);
217 /** \ingroup m_process_management
218 * \brief Return the user data of a #m_process_t.
220 * This function checks whether \a process is a valid pointer or not
221 and return the user data associated to \a process if it is possible.
223 void *MSG_process_get_data(m_process_t process)
225 xbt_assert0((process != NULL), "Invalid parameters");
227 return (process->data);
230 /** \ingroup m_process_management
231 * \brief Set the user data of a #m_process_t.
233 * This function checks whether \a process is a valid pointer or not
234 and set the user data associated to \a process if it is possible.
236 MSG_error_t MSG_process_set_data(m_process_t process, void *data)
238 xbt_assert0((process != NULL), "Invalid parameters");
239 xbt_assert0((process->data == NULL), "Data already set");
241 process->data = data;
246 /** \ingroup m_process_management
247 * \brief Return the location on which an agent is running.
249 * This function checks whether \a process is a valid pointer or not
250 and return the m_host_t corresponding to the location on which \a
253 m_host_t MSG_process_get_host(m_process_t process)
255 xbt_assert0(((process != NULL)
256 && (process->simdata)), "Invalid parameters");
258 return (((simdata_process_t) process->simdata)->m_host);
261 /** \ingroup m_process_management
263 * \brief Return a #m_process_t given its PID.
265 * This function search in the list of all the created m_process_t for a m_process_t
266 whose PID is equal to \a PID. If no host is found, \c NULL is returned.
267 Note that the PID are uniq in the whole simulation, not only on a given host.
269 m_process_t MSG_process_from_PID(int PID)
271 xbt_fifo_item_t i = NULL;
272 m_process_t process = NULL;
274 xbt_fifo_foreach(msg_global->process_list, i, process, m_process_t) {
275 if (MSG_process_get_PID(process) == PID)
281 /** \ingroup m_process_management
282 * \brief Returns the process ID of \a process.
284 * This function checks whether \a process is a valid pointer or not
285 and return its PID (or 0 in case of problem).
287 int MSG_process_get_PID(m_process_t process)
289 /* Do not raise an exception here: this function is used in the logs,
290 and it will be called back by the exception handling stuff */
291 if (process == NULL || process->simdata == NULL)
294 return (((simdata_process_t) process->simdata)->PID);
297 /** \ingroup m_process_management
298 * \brief Returns the process ID of the parent of \a process.
300 * This function checks whether \a process is a valid pointer or not
301 and return its PID. Returns -1 if the agent has not been created by
304 int MSG_process_get_PPID(m_process_t process)
306 xbt_assert0(((process != NULL)
307 && (process->simdata)), "Invalid parameters");
309 return (((simdata_process_t) process->simdata)->PPID);
312 /** \ingroup m_process_management
313 * \brief Return the name of an agent.
315 * This function checks whether \a process is a valid pointer or not
318 const char *MSG_process_get_name(m_process_t process)
320 xbt_assert0(((process != NULL)
321 && (process->simdata)), "Invalid parameters");
323 return (process->name);
326 /** \ingroup m_process_management
327 * \brief Returns the value of a given process property
329 * \param process a process
330 * \param name a property name
331 * \return value of a property (or NULL if the property is not set)
333 const char* MSG_process_get_property_value(m_process_t process, const char* name)
335 return xbt_dict_get_or_null(MSG_process_get_properties(process), name);
338 /** \ingroup m_process_management
339 * \brief Return the list of properties
341 * This function returns all the parameters associated with a process
343 xbt_dict_t MSG_process_get_properties(m_process_t process)
345 xbt_assert0((process != NULL), "Invalid parameters");
347 return (SIMIX_process_get_properties(((simdata_process_t)process->simdata)->s_process));
351 /** \ingroup m_process_management
352 * \brief Return the PID of the current agent.
354 * This function returns the PID of the currently running #m_process_t.
356 int MSG_process_self_PID(void)
358 return (MSG_process_get_PID(MSG_process_self()));
361 /** \ingroup m_process_management
362 * \brief Return the PPID of the current agent.
364 * This function returns the PID of the parent of the currently
365 * running #m_process_t.
367 int MSG_process_self_PPID(void)
369 return (MSG_process_get_PPID(MSG_process_self()));
372 /** \ingroup m_process_management
373 * \brief Return the current agent.
375 * This function returns the currently running #m_process_t.
377 m_process_t MSG_process_self(void)
379 smx_process_t proc = SIMIX_process_self();
381 return (m_process_t) proc->data;
388 /** \ingroup m_process_management
389 * \brief Suspend the process.
391 * This function suspends the process by suspending the task on which
392 * it was waiting for the completion.
394 MSG_error_t MSG_process_suspend(m_process_t process)
396 xbt_assert0(((process != NULL)
397 && (process->simdata)), "Invalid parameters");
400 SIMIX_process_suspend(process->simdata->s_process);
404 /** \ingroup m_process_management
405 * \brief Resume a suspended process.
407 * This function resumes a suspended process by resuming the task on
408 * which it was waiting for the completion.
410 MSG_error_t MSG_process_resume(m_process_t process)
413 xbt_assert0(((process != NULL)
414 && (process->simdata)), "Invalid parameters");
417 SIMIX_process_resume(process->simdata->s_process);
421 /** \ingroup m_process_management
422 * \brief Returns true if the process is suspended .
424 * This checks whether a process is suspended or not by inspecting the
425 * task on which it was waiting for the completion.
427 int MSG_process_is_suspended(m_process_t process)
429 xbt_assert0(((process != NULL)
430 && (process->simdata)), "Invalid parameters");
431 return SIMIX_process_is_suspended(process->simdata->s_process);