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 /* This function should be always be executed by the process being
33 if(smx_proc != SIMIX_process_self())
36 /* arg is no longer used, just kept to avoid changing the interface */
37 m_process_t proc = SIMIX_process_self_get_data();
40 TRACE_msg_process_end(proc);
44 xbt_fifo_remove(msg_global->process_list, proc);
46 SIMIX_process_cleanup(smx_proc);
60 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
61 void *_MSG_process_create_from_SIMIX(const char *name,
62 xbt_main_func_t code, void *data,
63 char *hostname, int argc, char **argv,
64 xbt_dict_t properties)
66 m_host_t host = MSG_get_host_by_name(hostname);
67 return (void *) MSG_process_create_with_environment(name, code, data,
72 /** \ingroup m_process_management
73 * \brief Creates and runs a new #m_process_t.
75 * Does exactly the same as #MSG_process_create_with_arguments but without
76 providing standard arguments (\a argc, \a argv, \a start_time, \a kill_time).
77 * \sa MSG_process_create_with_arguments
79 m_process_t MSG_process_create(const char *name,
80 xbt_main_func_t code, void *data,
83 return MSG_process_create_with_environment(name, code, data, host, -1,
87 /** \ingroup m_process_management
88 * \brief Creates and runs a new #m_process_t.
90 * A constructor for #m_process_t taking four arguments and returning the
91 * corresponding object. The structure (and the corresponding thread) is
92 * created, and put in the list of ready process.
93 * \param name a name for the object. It is for user-level information
95 * \param code is a function describing the behavior of the agent. It
96 should then only use functions described in \ref
97 m_process_management (to create a new #m_process_t for example),
98 in \ref m_host_management (only the read-only functions i.e. whose
99 name contains the word get), in \ref m_task_management (to create
100 or destroy some #m_task_t for example) and in \ref
101 msg_gos_functions (to handle file transfers and task processing).
102 * \param data a pointer to any data one may want to attach to the new
103 object. It is for user-level information and can be NULL. It can
104 be retrieved with the function \ref MSG_process_get_data.
105 * \param host the location where the new agent is executed.
106 * \param argc first argument passed to \a code
107 * \param argv second argument passed to \a code
109 * \return The new corresponding object.
112 m_process_t MSG_process_create_with_arguments(const char *name,
113 xbt_main_func_t code,
114 void *data, m_host_t host,
115 int argc, char **argv)
117 return MSG_process_create_with_environment(name, code, data, host,
121 /** \ingroup m_process_management
122 * \brief Creates and runs a new #m_process_t.
124 * A constructor for #m_process_t taking four arguments and returning the
125 * corresponding object. The structure (and the corresponding thread) is
126 * created, and put in the list of ready process.
127 * \param name a name for the object. It is for user-level information
129 * \param code is a function describing the behavior of the agent. It
130 should then only use functions described in \ref
131 m_process_management (to create a new #m_process_t for example),
132 in \ref m_host_management (only the read-only functions i.e. whose
133 name contains the word get), in \ref m_task_management (to create
134 or destroy some #m_task_t for example) and in \ref
135 msg_gos_functions (to handle file transfers and task processing).
136 * \param data a pointer to any data one may want to attach to the new
137 object. It is for user-level information and can be NULL. It can
138 be retrieved with the function \ref MSG_process_get_data.
139 * \param host the location where the new agent is executed.
140 * \param argc first argument passed to \a code
141 * \param argv second argument passed to \a code
142 * \param properties list a properties defined for this process
144 * \return The new corresponding object.
146 m_process_t MSG_process_create_with_environment(const char *name,
147 xbt_main_func_t code,
148 void *data, m_host_t host,
149 int argc, char **argv,
150 xbt_dict_t properties)
152 simdata_process_t simdata = NULL;
153 m_process_t process = xbt_new0(s_m_process_t, 1);
154 xbt_assert0(((code != NULL) && (host != NULL)), "Invalid parameters");
156 simdata = xbt_new0(s_simdata_process_t, 1);
159 simdata->PID = msg_global->PID++;
160 simdata->waiting_action = NULL;
161 simdata->waiting_task = NULL;
162 simdata->m_host = host;
163 simdata->argc = argc;
164 simdata->argv = argv;
166 if (SIMIX_process_self()) {
167 simdata->PPID = MSG_process_get_PID(SIMIX_process_self_get_data());
171 simdata->last_errno = MSG_OK;
173 /* Process structure */
174 process->name = xbt_strdup(name);
175 process->simdata = simdata;
176 process->data = data;
177 xbt_fifo_unshift(msg_global->process_list, process);
179 /* Let's create the process (SIMIX may decide to start it right now) */
180 simdata->s_process = SIMIX_req_process_create(name, code, (void *) process, host->name,
181 argc, argv, properties);
183 if (!simdata->s_process) {
184 /* Undo everything we have just changed */
186 xbt_fifo_remove(msg_global->process_list, process);
187 xbt_free(process->name);
194 TRACE_msg_process_create (process);
200 void _MSG_process_kill_from_SIMIX(void *p)
203 TRACE_msg_process_kill((m_process_t) p);
205 MSG_process_kill((m_process_t) p);
208 /** \ingroup m_process_management
209 * \param process poor victim
211 * This function simply kills a \a process... scarry isn't it ? :)
213 void MSG_process_kill(m_process_t process)
215 simdata_process_t p_simdata = process->simdata;
218 TRACE_msg_process_kill(process);
221 DEBUG3("Killing %s(%d) on %s",
222 process->name, p_simdata->PID, p_simdata->m_host->name);
224 if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) {
225 SIMIX_req_comm_cancel(p_simdata->waiting_task->simdata->comm);
228 xbt_fifo_remove(msg_global->process_list, process);
229 SIMIX_req_process_kill(process->simdata->s_process);
234 /** \ingroup m_process_management
235 * \brief Migrates an agent to another location.
237 * This function checks whether \a process and \a host are valid pointers
238 and change the value of the #m_host_t on which \a process is running.
240 MSG_error_t MSG_process_change_host(m_host_t host)
242 m_process_t process = MSG_process_self();
243 m_host_t now = process->simdata->m_host;
244 process->simdata->m_host = host;
246 TRACE_msg_process_change_host(process, now, host);
248 SIMIX_req_process_change_host(process->simdata->s_process, now->name,
253 /** \ingroup m_process_management
254 * \brief Return the user data of a #m_process_t.
256 * This function checks whether \a process is a valid pointer or not
257 and return the user data associated to \a process if it is possible.
259 void *MSG_process_get_data(m_process_t process)
261 xbt_assert0((process != NULL), "Invalid parameters");
263 return (process->data);
266 /** \ingroup m_process_management
267 * \brief Set the user data of a #m_process_t.
269 * This function checks whether \a process is a valid pointer or not
270 and set the user data associated to \a process if it is possible.
272 MSG_error_t MSG_process_set_data(m_process_t process, void *data)
274 xbt_assert0((process != NULL), "Invalid parameters");
276 process->data = data;
281 /** \ingroup m_process_management
282 * \brief Return the location on which an agent is running.
284 * This function checks whether \a process is a valid pointer or not
285 and return the m_host_t corresponding to the location on which \a
288 m_host_t MSG_process_get_host(m_process_t process)
290 xbt_assert0(((process != NULL)
291 && (process->simdata)), "Invalid parameters");
293 return (((simdata_process_t) process->simdata)->m_host);
296 /** \ingroup m_process_management
298 * \brief Return a #m_process_t given its PID.
300 * This function search in the list of all the created m_process_t for a m_process_t
301 whose PID is equal to \a PID. If no host is found, \c NULL is returned.
302 Note that the PID are uniq in the whole simulation, not only on a given host.
304 m_process_t MSG_process_from_PID(int PID)
306 xbt_fifo_item_t i = NULL;
307 m_process_t process = NULL;
309 xbt_fifo_foreach(msg_global->process_list, i, process, m_process_t) {
310 if (MSG_process_get_PID(process) == PID)
316 /** \ingroup m_process_management
317 * \brief Returns the process ID of \a process.
319 * This function checks whether \a process is a valid pointer or not
320 and return its PID (or 0 in case of problem).
322 int MSG_process_get_PID(m_process_t process)
324 /* Do not raise an exception here: this function is used in the logs,
325 and it will be called back by the exception handling stuff */
326 if (process == NULL || process->simdata == NULL)
329 return (((simdata_process_t) process->simdata)->PID);
332 /** \ingroup m_process_management
333 * \brief Returns the process ID of the parent of \a process.
335 * This function checks whether \a process is a valid pointer or not
336 and return its PID. Returns -1 if the agent has not been created by
339 int MSG_process_get_PPID(m_process_t process)
341 xbt_assert0(((process != NULL)
342 && (process->simdata)), "Invalid parameters");
344 return (((simdata_process_t) process->simdata)->PPID);
347 /** \ingroup m_process_management
348 * \brief Return the name of an agent.
350 * This function checks whether \a process is a valid pointer or not
353 const char *MSG_process_get_name(m_process_t process)
355 xbt_assert0(process, "Invalid parameter: process is NULL");
356 xbt_assert0(process->simdata,
357 "Invalid parameter: process->simdata is NULL");
359 return (process->name);
362 /** \ingroup m_process_management
363 * \brief Returns the value of a given process property
365 * \param process a process
366 * \param name a property name
367 * \return value of a property (or NULL if the property is not set)
369 const char *MSG_process_get_property_value(m_process_t process,
372 return xbt_dict_get_or_null(MSG_process_get_properties(process), name);
375 /** \ingroup m_process_management
376 * \brief Return the list of properties
378 * This function returns all the parameters associated with a process
380 xbt_dict_t MSG_process_get_properties(m_process_t process)
382 xbt_assert0((process != NULL), "Invalid parameters");
384 return (SIMIX_req_process_get_properties
385 (((simdata_process_t) process->simdata)->s_process));
389 /** \ingroup m_process_management
390 * \brief Return the PID of the current agent.
392 * This function returns the PID of the currently running #m_process_t.
394 int MSG_process_self_PID(void)
396 return (MSG_process_get_PID(MSG_process_self()));
399 /** \ingroup m_process_management
400 * \brief Return the PPID of the current agent.
402 * This function returns the PID of the parent of the currently
403 * running #m_process_t.
405 int MSG_process_self_PPID(void)
407 return (MSG_process_get_PPID(MSG_process_self()));
410 /** \ingroup m_process_management
411 * \brief Return the current agent.
413 * This function returns the currently running #m_process_t.
415 m_process_t MSG_process_self(void)
417 /* we cannot make a SIMIX request here because this may create an exception or a logging
418 event, and both mechanisms call MSG_process_self() again (via xbt_getpid()) */
419 return (m_process_t) SIMIX_process_self_get_data();
422 /** \ingroup m_process_management
423 * \brief Suspend the process.
425 * This function suspends the process by suspending the task on which
426 * it was waiting for the completion.
428 MSG_error_t MSG_process_suspend(m_process_t process)
430 xbt_assert0(((process != NULL)
431 && (process->simdata)), "Invalid parameters");
435 TRACE_msg_process_suspend(process);
438 SIMIX_req_process_suspend(process->simdata->s_process);
442 /** \ingroup m_process_management
443 * \brief Resume a suspended process.
445 * This function resumes a suspended process by resuming the task on
446 * which it was waiting for the completion.
448 MSG_error_t MSG_process_resume(m_process_t process)
451 xbt_assert0(((process != NULL)
452 && (process->simdata)), "Invalid parameters");
456 TRACE_msg_process_resume(process);
459 SIMIX_req_process_resume(process->simdata->s_process);
463 /** \ingroup m_process_management
464 * \brief Returns true if the process is suspended .
466 * This checks whether a process is suspended or not by inspecting the
467 * task on which it was waiting for the completion.
469 int MSG_process_is_suspended(m_process_t process)
471 xbt_assert0(((process != NULL)
472 && (process->simdata)), "Invalid parameters");
473 return SIMIX_req_process_is_suspended(process->simdata->s_process);
477 smx_context_t MSG_process_get_smx_ctx(m_process_t process) {
478 return SIMIX_process_get_context(process->simdata->s_process);