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_swag_remove(proc, msg_global->process_list);
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(void* process, 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 m_process_t p = MSG_process_create_with_environment(name, code, data,
70 *((m_process_t*) process) = p;
73 /** \ingroup m_process_management
74 * \brief Creates and runs a new #m_process_t.
76 * Does exactly the same as #MSG_process_create_with_arguments but without
77 providing standard arguments (\a argc, \a argv, \a start_time, \a kill_time).
78 * \sa MSG_process_create_with_arguments
80 m_process_t MSG_process_create(const char *name,
81 xbt_main_func_t code, void *data,
84 return MSG_process_create_with_environment(name, code, data, host, -1,
88 /** \ingroup m_process_management
89 * \brief Creates and runs a new #m_process_t.
91 * A constructor for #m_process_t taking four arguments and returning the
92 * corresponding object. The structure (and the corresponding thread) is
93 * created, and put in the list of ready process.
94 * \param name a name for the object. It is for user-level information
96 * \param code is a function describing the behavior of the agent. It
97 should then only use functions described in \ref
98 m_process_management (to create a new #m_process_t for example),
99 in \ref m_host_management (only the read-only functions i.e. whose
100 name contains the word get), in \ref m_task_management (to create
101 or destroy some #m_task_t for example) and in \ref
102 msg_gos_functions (to handle file transfers and task processing).
103 * \param data a pointer to any data one may want to attach to the new
104 object. It is for user-level information and can be NULL. It can
105 be retrieved with the function \ref MSG_process_get_data.
106 * \param host the location where the new agent is executed.
107 * \param argc first argument passed to \a code
108 * \param argv second argument passed to \a code
110 * \return The new corresponding object.
113 m_process_t MSG_process_create_with_arguments(const char *name,
114 xbt_main_func_t code,
115 void *data, m_host_t host,
116 int argc, char **argv)
118 return MSG_process_create_with_environment(name, code, data, host,
122 /** \ingroup m_process_management
123 * \brief Creates and runs a new #m_process_t.
125 * A constructor for #m_process_t taking four arguments and returning the
126 * corresponding object. The structure (and the corresponding thread) is
127 * created, and put in the list of ready process.
128 * \param name a name for the object. It is for user-level information
130 * \param code is a function describing the behavior of the agent. It
131 should then only use functions described in \ref
132 m_process_management (to create a new #m_process_t for example),
133 in \ref m_host_management (only the read-only functions i.e. whose
134 name contains the word get), in \ref m_task_management (to create
135 or destroy some #m_task_t for example) and in \ref
136 msg_gos_functions (to handle file transfers and task processing).
137 * \param data a pointer to any data one may want to attach to the new
138 object. It is for user-level information and can be NULL. It can
139 be retrieved with the function \ref MSG_process_get_data.
140 * \param host the location where the new agent is executed.
141 * \param argc first argument passed to \a code
142 * \param argv second argument passed to \a code
143 * \param properties list a properties defined for this process
145 * \return The new corresponding object.
147 m_process_t MSG_process_create_with_environment(const char *name,
148 xbt_main_func_t code,
149 void *data, m_host_t host,
150 int argc, char **argv,
151 xbt_dict_t properties)
153 simdata_process_t simdata = NULL;
154 m_process_t process = xbt_new0(s_m_process_t, 1);
155 xbt_assert0(((code != NULL) && (host != NULL)), "Invalid parameters");
157 simdata = xbt_new0(s_simdata_process_t, 1);
160 simdata->PID = msg_global->PID++;
161 simdata->waiting_action = NULL;
162 simdata->waiting_task = NULL;
163 simdata->m_host = host;
164 simdata->argc = argc;
165 simdata->argv = argv;
167 if (SIMIX_process_self()) {
168 simdata->PPID = MSG_process_get_PID(SIMIX_process_self_get_data());
172 simdata->last_errno = MSG_OK;
174 /* Process structure */
175 process->name = xbt_strdup(name);
176 process->simdata = simdata;
177 process->data = data;
178 xbt_swag_insert(process, msg_global->process_list);
181 TRACE_msg_process_create (process);
184 /* Let's create the process: SIMIX may decide to start it right now,
185 * even before returning the flow control to us */
186 SIMIX_req_process_create(&simdata->s_process, name, code, (void *) process, host->name,
187 argc, argv, properties);
189 if (!simdata->s_process) {
190 /* Undo everything we have just changed */
192 xbt_swag_remove(process, msg_global->process_list);
193 xbt_free(process->name);
202 void _MSG_process_kill_from_SIMIX(void *p)
205 TRACE_msg_process_kill((m_process_t) p);
207 MSG_process_kill((m_process_t) p);
210 /** \ingroup m_process_management
211 * \param process poor victim
213 * This function simply kills a \a process... scarry isn't it ? :)
215 void MSG_process_kill(m_process_t process)
217 simdata_process_t p_simdata = process->simdata;
220 TRACE_msg_process_kill(process);
223 XBT_DEBUG("Killing %s(%d) on %s",
224 process->name, p_simdata->PID, p_simdata->m_host->name);
226 if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) {
227 SIMIX_req_comm_cancel(p_simdata->waiting_task->simdata->comm);
230 xbt_swag_remove(process, msg_global->process_list);
231 SIMIX_req_process_kill(process->simdata->s_process);
236 /** \ingroup m_process_management
237 * \brief Migrates an agent to another location.
239 * This function checks whether \a process and \a host are valid pointers
240 and change the value of the #m_host_t on which \a process is running.
242 MSG_error_t MSG_process_change_host(m_host_t host)
244 m_process_t process = MSG_process_self();
245 m_host_t now = process->simdata->m_host;
246 process->simdata->m_host = host;
248 TRACE_msg_process_change_host(process, now, host);
250 SIMIX_req_process_change_host(process->simdata->s_process, now->name,
255 /** \ingroup m_process_management
256 * \brief Return the user data of a #m_process_t.
258 * This function checks whether \a process is a valid pointer or not
259 and return the user data associated to \a process if it is possible.
261 void *MSG_process_get_data(m_process_t process)
263 xbt_assert0((process != NULL), "Invalid parameters");
265 return (process->data);
268 /** \ingroup m_process_management
269 * \brief Set the user data of a #m_process_t.
271 * This function checks whether \a process is a valid pointer or not
272 and set the user data associated to \a process if it is possible.
274 MSG_error_t MSG_process_set_data(m_process_t process, void *data)
276 xbt_assert0((process != NULL), "Invalid parameters");
278 process->data = data;
283 /** \ingroup m_process_management
284 * \brief Return the location on which an agent is running.
286 * This function checks whether \a process is a valid pointer or not
287 and return the m_host_t corresponding to the location on which \a
290 m_host_t MSG_process_get_host(m_process_t process)
292 xbt_assert0(((process != NULL)
293 && (process->simdata)), "Invalid parameters");
295 return (((simdata_process_t) process->simdata)->m_host);
298 /** \ingroup m_process_management
300 * \brief Return a #m_process_t given its PID.
302 * This function search in the list of all the created m_process_t for a m_process_t
303 whose PID is equal to \a PID. If no host is found, \c NULL is returned.
304 Note that the PID are uniq in the whole simulation, not only on a given host.
306 m_process_t MSG_process_from_PID(int PID)
308 m_process_t process = NULL;
310 xbt_swag_foreach(process, msg_global->process_list) {
311 if (MSG_process_get_PID(process) == PID)
317 /** \ingroup m_process_management
318 * \brief Returns the process ID of \a process.
320 * This function checks whether \a process is a valid pointer or not
321 and return its PID (or 0 in case of problem).
323 int MSG_process_get_PID(m_process_t process)
325 /* Do not raise an exception here: this function is used in the logs,
326 and it will be called back by the exception handling stuff */
327 if (process == NULL || process->simdata == NULL)
330 return (((simdata_process_t) process->simdata)->PID);
333 /** \ingroup m_process_management
334 * \brief Returns the process ID of the parent of \a process.
336 * This function checks whether \a process is a valid pointer or not
337 and return its PID. Returns -1 if the agent has not been created by
340 int MSG_process_get_PPID(m_process_t process)
342 xbt_assert0(((process != NULL)
343 && (process->simdata)), "Invalid parameters");
345 return (((simdata_process_t) process->simdata)->PPID);
348 /** \ingroup m_process_management
349 * \brief Return the name of an agent.
351 * This function checks whether \a process is a valid pointer or not
354 const char *MSG_process_get_name(m_process_t process)
356 xbt_assert0(process, "Invalid parameter: process is NULL");
357 xbt_assert0(process->simdata,
358 "Invalid parameter: process->simdata is NULL");
360 return (process->name);
363 /** \ingroup m_process_management
364 * \brief Returns the value of a given process property
366 * \param process a process
367 * \param name a property name
368 * \return value of a property (or NULL if the property is not set)
370 const char *MSG_process_get_property_value(m_process_t process,
373 return xbt_dict_get_or_null(MSG_process_get_properties(process), name);
376 /** \ingroup m_process_management
377 * \brief Return the list of properties
379 * This function returns all the parameters associated with a process
381 xbt_dict_t MSG_process_get_properties(m_process_t process)
383 xbt_assert0((process != NULL), "Invalid parameters");
385 return (SIMIX_req_process_get_properties
386 (((simdata_process_t) process->simdata)->s_process));
390 /** \ingroup m_process_management
391 * \brief Return the PID of the current agent.
393 * This function returns the PID of the currently running #m_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 agent.
403 * This function returns the PID of the parent of the currently
404 * running #m_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 agent.
414 * This function returns the currently running #m_process_t.
416 m_process_t MSG_process_self(void)
418 /* we cannot make a SIMIX request here because this may create an exception or a logging
419 event, and both mechanisms call MSG_process_self() again (via xbt_getpid()) */
420 return (m_process_t) SIMIX_process_self_get_data();
423 /** \ingroup m_process_management
424 * \brief Suspend the process.
426 * This function suspends the process by suspending the task on which
427 * it was waiting for the completion.
429 MSG_error_t MSG_process_suspend(m_process_t process)
431 xbt_assert0(((process != NULL)
432 && (process->simdata)), "Invalid parameters");
436 TRACE_msg_process_suspend(process);
439 SIMIX_req_process_suspend(process->simdata->s_process);
443 /** \ingroup m_process_management
444 * \brief Resume a suspended process.
446 * This function resumes a suspended process by resuming the task on
447 * which it was waiting for the completion.
449 MSG_error_t MSG_process_resume(m_process_t process)
452 xbt_assert0(((process != NULL)
453 && (process->simdata)), "Invalid parameters");
457 TRACE_msg_process_resume(process);
460 SIMIX_req_process_resume(process->simdata->s_process);
464 /** \ingroup m_process_management
465 * \brief Returns true if the process is suspended .
467 * This checks whether a process is suspended or not by inspecting the
468 * task on which it was waiting for the completion.
470 int MSG_process_is_suspended(m_process_t process)
472 xbt_assert0(((process != NULL)
473 && (process->simdata)), "Invalid parameters");
474 return SIMIX_req_process_is_suspended(process->simdata->s_process);
478 smx_context_t MSG_process_get_smx_ctx(m_process_t process) {
479 return SIMIX_process_get_context(process->simdata->s_process);