XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg,
"Logging specific to MSG (process)");
-/** \defgroup m_process_management Management Functions of Agents
- * \brief This section describes the agent structure of MSG
- * (#m_process_t) and the functions for managing it.
- */
/** @addtogroup m_process_management
- * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Agents" --> \endhtmlonly
+ * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Processes" --> \endhtmlonly
*
* We need to simulate many independent scheduling decisions, so
* the concept of <em>process</em> is at the heart of the
*/
/******************************** Process ************************************/
+
+/**
+ * \brief Cleans the MSG data of a process.
+ * \param smx_proc a SIMIX process
+ */
void MSG_process_cleanup_from_SIMIX(smx_process_t smx_proc)
{
simdata_process_t msg_proc;
+ // get the MSG process from the SIMIX process
if (smx_proc == SIMIX_process_self()) {
/* avoid a SIMIX request if this function is called by the process itself */
msg_proc = SIMIX_process_self_get_data(smx_proc);
+ SIMIX_process_self_set_data(smx_proc, NULL);
}
else {
- msg_proc = SIMIX_req_process_get_data(smx_proc);
+ msg_proc = simcall_process_get_data(smx_proc);
+ simcall_process_set_data(smx_proc, NULL);
}
#ifdef HAVE_TRACING
TRACE_msg_process_end(smx_proc);
#endif
+ // free the data if a function was provided
+ if (msg_proc->data && msg_global->process_data_cleanup) {
+ msg_global->process_data_cleanup(msg_proc->data);
+ }
+
+ // free the MSG process
xbt_free(msg_proc);
}
* created, and put in the list of ready process.
* \param name a name for the object. It is for user-level information
and can be NULL.
- * \param code is a function describing the behavior of the agent. It
+ * \param code is a function describing the behavior of the process. It
should then only use functions described in \ref
m_process_management (to create a new #m_process_t for example),
in \ref m_host_management (only the read-only functions i.e. whose
name contains the word get), in \ref m_task_management (to create
or destroy some #m_task_t for example) and in \ref
- msg_gos_functions (to handle file transfers and task processing).
+ msg_task_usage (to handle file transfers and task processing).
* \param data a pointer to any data one may want to attach to the new
object. It is for user-level information and can be NULL. It can
be retrieved with the function \ref MSG_process_get_data.
- * \param host the location where the new agent is executed.
+ * \param host the location where the new process is executed.
* \param argc first argument passed to \a code
* \param argv second argument passed to \a code
* \see m_process_t
* created, and put in the list of ready process.
* \param name a name for the object. It is for user-level information
and can be NULL.
- * \param code is a function describing the behavior of the agent. It
+ * \param code is a function describing the behavior of the process. It
should then only use functions described in \ref
m_process_management (to create a new #m_process_t for example),
in \ref m_host_management (only the read-only functions i.e. whose
name contains the word get), in \ref m_task_management (to create
or destroy some #m_task_t for example) and in \ref
- msg_gos_functions (to handle file transfers and task processing).
+ msg_task_usage (to handle file transfers and task processing).
* \param data a pointer to any data one may want to attach to the new
object. It is for user-level information and can be NULL. It can
be retrieved with the function \ref MSG_process_get_data.
- * \param host the location where the new agent is executed.
+ * \param host the location where the new process is executed.
* \param argc first argument passed to \a code
* \param argv second argument passed to \a code
* \param properties list a properties defined for this process
/* Let's create the process: SIMIX may decide to start it right now,
* even before returning the flow control to us */
- SIMIX_req_process_create(&process, name, code, simdata, host->name,
+ simcall_process_create(&process, name, code, simdata, host->name,
argc, argv, properties);
if (!process) {
#endif
/* FIXME: why do we only cancel communication actions? is this useful? */
- simdata_process_t p_simdata = SIMIX_req_process_get_data(process);
+ simdata_process_t p_simdata = simcall_process_get_data(process);
if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) {
- SIMIX_req_comm_cancel(p_simdata->waiting_task->simdata->comm);
+ simcall_comm_cancel(p_simdata->waiting_task->simdata->comm);
}
- SIMIX_req_process_kill(process);
+ simcall_process_kill(process);
return;
}
/** \ingroup m_process_management
- * \brief Migrates an agent to another location.
+ * \brief Migrates a process to another location.
*
* This function checks whether \a process and \a host are valid pointers
and change the value of the #m_host_t on which \a process is running.
*/
MSG_error_t MSG_process_migrate(m_process_t process, m_host_t host)
{
- simdata_process_t simdata = SIMIX_req_process_get_data(process);
+ simdata_process_t simdata = simcall_process_get_data(process);
simdata->m_host = host;
#ifdef HAVE_TRACING
m_host_t now = simdata->m_host;
TRACE_msg_process_change_host(process, now, host);
#endif
- SIMIX_req_process_change_host(process, host->simdata->smx_host);
+ simcall_process_change_host(process, host->simdata->smx_host);
return MSG_OK;
}
xbt_assert(process != NULL, "Invalid parameter");
/* get from SIMIX the MSG process data, and then the user data */
- simdata_process_t simdata = SIMIX_req_process_get_data(process);
+ simdata_process_t simdata = simcall_process_get_data(process);
return simdata->data;
}
{
xbt_assert(process != NULL, "Invalid parameter");
- simdata_process_t simdata = SIMIX_req_process_get_data(process);
+ simdata_process_t simdata = simcall_process_get_data(process);
simdata->data = data;
return MSG_OK;
}
/** \ingroup m_process_management
- * \brief Return the location on which an agent is running.
+ * \brief Sets a cleanup function to be called to free the userdata of a
+ * process when a process is destroyed.
+ * \param data_cleanup a cleanup function for the userdata of a process,
+ * or NULL to call no function
+ */
+XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
+
+ msg_global->process_data_cleanup = data_cleanup;
+}
+
+/** \ingroup m_process_management
+ * \brief Return the location on which a process is running.
* \param process a process (NULL means the current one)
* \return the m_host_t corresponding to the location on which \a
* process is running.
simdata = SIMIX_process_self_get_data(SIMIX_process_self());
}
else {
- simdata = SIMIX_req_process_get_data(process);
+ simdata = simcall_process_get_data(process);
}
return simdata->m_host;
}
*/
m_process_t MSG_process_from_PID(int PID)
{
- /* FIXME: reimplement this function using SIMIX when we have a good PID.
- * In the meantime, I guess nobody uses it so it should not break anything. */
- THROW_UNIMPLEMENTED;
+ return SIMIX_process_from_PID(PID);
+}
+
+/** @brief returns a list of all currently existing processes */
+xbt_dynar_t MSG_processes_as_dynar(void) {
+ return SIMIX_processes_as_dynar();
}
/** \ingroup m_process_management
return 0;
}
- simdata_process_t simdata = SIMIX_req_process_get_data(process);
+ simdata_process_t simdata = simcall_process_get_data(process);
return simdata != NULL ? simdata->PID : 0;
}
* \brief Returns the process ID of the parent of \a process.
*
* This function checks whether \a process is a valid pointer or not
- and return its PID. Returns -1 if the agent has not been created by
- another agent.
+ and return its PID. Returns -1 if the process has not been created by
+ any other process.
*/
int MSG_process_get_PPID(m_process_t process)
{
xbt_assert(process != NULL, "Invalid parameter");
- simdata_process_t simdata = SIMIX_req_process_get_data(process);
+ simdata_process_t simdata = simcall_process_get_data(process);
return simdata->PPID;
}
/** \ingroup m_process_management
- * \brief Return the name of an agent.
+ * \brief Return the name of a process.
*
* This function checks whether \a process is a valid pointer or not
and return its name.
{
xbt_assert(process, "Invalid parameter");
- return SIMIX_req_process_get_name(process);
+ return simcall_process_get_name(process);
}
/** \ingroup m_process_management
{
xbt_assert(process != NULL, "Invalid parameter");
- return SIMIX_req_process_get_properties(process);
+ return simcall_process_get_properties(process);
}
/** \ingroup m_process_management
- * \brief Return the PID of the current agent.
+ * \brief Return the PID of the current process.
*
* This function returns the PID of the currently running #m_process_t.
*/
}
/** \ingroup m_process_management
- * \brief Return the PPID of the current agent.
+ * \brief Return the PPID of the current process.
*
* This function returns the PID of the parent of the currently
* running #m_process_t.
MSG_error_t MSG_process_suspend(m_process_t process)
{
xbt_assert(process != NULL, "Invalid parameter");
- CHECK_HOST();
#ifdef HAVE_TRACING
TRACE_msg_process_suspend(process);
#endif
- SIMIX_req_process_suspend(process);
+ simcall_process_suspend(process);
MSG_RETURN(MSG_OK);
}
MSG_error_t MSG_process_resume(m_process_t process)
{
xbt_assert(process != NULL, "Invalid parameter");
- CHECK_HOST();
#ifdef HAVE_TRACING
TRACE_msg_process_resume(process);
#endif
- SIMIX_req_process_resume(process);
+ simcall_process_resume(process);
MSG_RETURN(MSG_OK);
}
int MSG_process_is_suspended(m_process_t process)
{
xbt_assert(process != NULL, "Invalid parameter");
- return SIMIX_req_process_is_suspended(process);
+ return simcall_process_is_suspended(process);
}
smx_context_t MSG_process_get_smx_ctx(m_process_t process) {