X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/4cb325dfc0f85a07d47f0467601df1b2a68b16fc..6de9090dd8692387ae343c587b26915f9922d7bd:/src/msg/msg_process.c diff --git a/src/msg/msg_process.c b/src/msg/msg_process.c index 8a2f8eaf00..2834674865 100644 --- a/src/msg/msg_process.c +++ b/src/msg/msg_process.c @@ -11,12 +11,8 @@ 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 \endhtmlonly + * \htmlonly \endhtmlonly * * We need to simulate many independent scheduling decisions, so * the concept of process is at the heart of the @@ -26,35 +22,56 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, */ /******************************** 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); + } + + // remove the process from its virtual machine + if (msg_proc->vm) { + int pos = xbt_dynar_search(msg_proc->vm->processes,&smx_proc); + xbt_dynar_remove_at(msg_proc->vm->processes,pos, NULL); + } + + // free the MSG process xbt_free(msg_proc); } /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */ void MSG_process_create_from_SIMIX(smx_process_t* process, const char *name, xbt_main_func_t code, void *data, - const char *hostname, int argc, char **argv, + const char *hostname, double kill_time, int argc, char **argv, xbt_dict_t properties) { m_host_t host = MSG_get_host_by_name(hostname); m_process_t p = MSG_process_create_with_environment(name, code, data, host, argc, argv, properties); + MSG_process_set_kill_time(p,kill_time); *((m_process_t*) process) = p; } @@ -81,17 +98,17 @@ m_process_t MSG_process_create(const char *name, * 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 @@ -115,17 +132,17 @@ m_process_t MSG_process_create_with_arguments(const char *name, * 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 @@ -164,7 +181,7 @@ m_process_t MSG_process_create_with_environment(const char *name, /* 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, SIMIX_host_get_name(host->smx_host), -1, argc, argv, properties); if (!process) { @@ -196,32 +213,32 @@ void MSG_process_kill(m_process_t process) TRACE_msg_process_kill(process); #endif - /* FIXME: why do we only cancel communication actions? is this useful? */ - simdata_process_t p_simdata = SIMIX_req_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); - } +// /* FIXME: why do we only cancel communication actions? is this useful? */ +// simdata_process_t p_simdata = simcall_process_get_data(process); +// if (p_simdata->waiting_task && 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->smx_host); return MSG_OK; } @@ -236,7 +253,7 @@ void* MSG_process_get_data(m_process_t process) 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; } @@ -250,14 +267,25 @@ MSG_error_t MSG_process_set_data(m_process_t process, void *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. @@ -269,7 +297,7 @@ m_host_t MSG_process_get_host(m_process_t process) 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; } @@ -284,9 +312,24 @@ m_host_t MSG_process_get_host(m_process_t process) */ 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 + * \brief Set the kill time of a process. + * + * \param process a process + * \param kill_time the time when the process is killed. + */ +MSG_error_t MSG_process_set_kill_time(m_process_t process, double kill_time) +{ + simcall_process_set_kill_time(process,kill_time); + return MSG_OK; } /** \ingroup m_process_management @@ -303,7 +346,7 @@ int MSG_process_get_PID(m_process_t process) 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; } @@ -312,20 +355,20 @@ int MSG_process_get_PID(m_process_t process) * \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. @@ -334,7 +377,7 @@ const char *MSG_process_get_name(m_process_t process) { xbt_assert(process, "Invalid parameter"); - return SIMIX_req_process_get_name(process); + return simcall_process_get_name(process); } /** \ingroup m_process_management @@ -359,12 +402,12 @@ xbt_dict_t MSG_process_get_properties(m_process_t process) { 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. */ @@ -374,7 +417,7 @@ int MSG_process_self_PID(void) } /** \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. @@ -403,13 +446,12 @@ m_process_t MSG_process_self(void) 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); } @@ -422,13 +464,12 @@ MSG_error_t MSG_process_suspend(m_process_t process) 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); } @@ -441,9 +482,18 @@ MSG_error_t MSG_process_resume(m_process_t process) 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) { return SIMIX_process_get_context(process); } +/** + * \ingroup m_process_management + * \brief Add a function to the list of "on_exit" functions for the current process. + * The on_exit functions are the functions executed when your process is killed. + * You should use them to free the data used by your process. + */ +void MSG_process_on_exit_add(int_f_pvoid_t fun, void *data) { + SIMIX_process_on_exit_add(fun,data); +}