X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/68d2e2165a1b9166b5e16ffc117921cb2cd1f5fc..419d880cf5ea0cc1f4c2b299923a6002811e55e3:/src/msg/m_process.c diff --git a/src/msg/m_process.c b/src/msg/m_process.c index f318b223f0..c2cab1b011 100644 --- a/src/msg/m_process.c +++ b/src/msg/m_process.c @@ -1,17 +1,19 @@ /* $Id$ */ - + /* Copyright (c) 2002-2007 Arnaud Legrand. */ /* Copyright (c) 2007 Bruno Donassolo. */ /* All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ - + #include "msg/private.h" #include "xbt/sysdep.h" #include "xbt/log.h" +#include "../simix/private.h" -XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (process)"); +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 @@ -19,7 +21,7 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (proc */ /** @addtogroup m_process_management * \htmlonly \endhtmlonly - * + * * We need to simulate many independent scheduling decisions, so * the concept of process is at the heart of the * simulator. A process may be defined as a code, with @@ -28,39 +30,51 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (proc */ /******************************** Process ************************************/ -/** \ingroup m_process_management - * \brief Creates and runs a new #m_process_t. - * - * Does exactly the same as #MSG_process_create_with_arguments but without - providing standard arguments (\a argc, \a argv, \a start_time, \a kill_time). - * \sa MSG_process_create_with_arguments - */ -m_process_t MSG_process_create(const char *name, - m_process_code_t code, void *data, - m_host_t host) -{ - return MSG_process_create_with_arguments(name, code, data, host, -1, NULL); -} - -static void MSG_process_cleanup(void *arg) +void __MSG_process_cleanup(void *arg) { - /* arg is a pointer to a simix process, we can get the msg process with the field data */ - m_process_t proc = ((smx_process_t)arg)->data; + /* arg is a pointer to a simix process, we can get the msg process with the field data */ + m_process_t proc = ((smx_process_t) arg)->data; xbt_fifo_remove(msg_global->process_list, proc); - SIMIX_process_cleanup(arg); + SIMIX_process_cleanup(arg); free(proc->name); proc->name = NULL; free(proc->simdata); proc->simdata = NULL; free(proc); - return; + return; +} + +/* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */ +void *_MSG_process_create_from_SIMIX(const char *name, + xbt_main_func_t code, void *data, + char *hostname, int argc, char **argv, + xbt_dict_t properties) +{ + m_host_t host = MSG_get_host_by_name(hostname); + return (void *) MSG_process_create_with_environment(name, code, data, host, + argc, argv, properties); +} + +/** \ingroup m_process_management + * \brief Creates and runs a new #m_process_t. + * + * Does exactly the same as #MSG_process_create_with_arguments but without + providing standard arguments (\a argc, \a argv, \a start_time, \a kill_time). + * \sa MSG_process_create_with_arguments + */ +m_process_t MSG_process_create(const char *name, + xbt_main_func_t code, void *data, + m_host_t host) +{ + return MSG_process_create_with_environment(name, code, data, host, -1, + NULL, NULL); } /** \ingroup m_process_management * \brief Creates and runs a new #m_process_t. - * A constructor for #m_process_t taking four arguments and returning the + * A constructor for #m_process_t taking four arguments and returning the * corresponding object. The structure (and the corresponding thread) is * created, and put in the list of ready process. * \param name a name for the object. It is for user-level information @@ -82,37 +96,76 @@ static void MSG_process_cleanup(void *arg) * \return The new corresponding object. */ - - -m_process_t __MSG_process_create_with_arguments(const char *name, - m_process_code_t code, void *data, - char * hostname, int argc, char **argv) +m_process_t MSG_process_create_with_arguments(const char *name, + xbt_main_func_t code, + void *data, m_host_t host, + int argc, char **argv) { - m_host_t host = MSG_get_host_by_name(hostname); - return MSG_process_create_with_arguments(name,code,data,host,argc,argv); + return MSG_process_create_with_environment(name, code, data, host, + argc, argv, NULL); } -m_process_t MSG_process_create_with_arguments(const char *name, - m_process_code_t code, void *data, - m_host_t host, int argc, char **argv) +/** \ingroup m_process_management + * \brief Creates and runs a new #m_process_t. + + * A constructor for #m_process_t taking four arguments and returning the + * corresponding object. The structure (and the corresponding thread) is + * 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 + 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). + * \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 argc first argument passed to \a code + * \param argv second argument passed to \a code + * \param properties list a properties defined for this process + * \see m_process_t + * \return The new corresponding object. + */ +m_process_t MSG_process_create_with_environment(const char *name, + xbt_main_func_t code, + void *data, m_host_t host, + int argc, char **argv, + xbt_dict_t properties) { - simdata_process_t simdata = xbt_new0(s_simdata_process_t,1); - m_process_t process = xbt_new0(s_m_process_t,1); + simdata_process_t simdata = NULL; + m_process_t process = xbt_new0(s_m_process_t, 1); + smx_process_t smx_process = NULL; xbt_assert0(((code != NULL) && (host != NULL)), "Invalid parameters"); + smx_process = SIMIX_process_create(name, code, + (void *) process, host->name, + argc, argv, properties); + if (!smx_process) { + xbt_free(process); + return NULL; + } + + simdata = xbt_new0(s_simdata_process_t, 1); + /* Simulator Data */ simdata->PID = msg_global->PID++; - simdata->waiting_task = NULL; - simdata->host = host; + simdata->waiting_action = NULL; + simdata->waiting_task = NULL; + simdata->m_host = host; simdata->argc = argc; simdata->argv = argv; - simdata->smx_process = SIMIX_process_create(name, (smx_process_code_t)code, (void*)process, host->name, argc, argv, MSG_process_cleanup ); + simdata->s_process = smx_process; - if (SIMIX_process_self()) { - simdata->PPID = MSG_process_get_PID(SIMIX_process_self()->data); - } - else simdata->PPID = -1; - simdata->last_errno=MSG_OK; + if (SIMIX_process_self()) { + simdata->PPID = MSG_process_get_PID(SIMIX_process_self()->data); + } else { + simdata->PPID = -1; + } + simdata->last_errno = MSG_OK; /* Process structure */ @@ -120,9 +173,15 @@ m_process_t MSG_process_create_with_arguments(const char *name, process->simdata = simdata; process->data = data; - xbt_fifo_unshift(msg_global->process_list, process); + xbt_fifo_unshift(msg_global->process_list, process); return process; + +} + +void _MSG_process_kill_from_SIMIX(void *p) +{ + MSG_process_kill((m_process_t) p); } /** \ingroup m_process_management @@ -134,40 +193,45 @@ void MSG_process_kill(m_process_t process) { simdata_process_t p_simdata = process->simdata; - DEBUG3("Killing %s(%d) on %s",process->name, p_simdata->PID, p_simdata->host->name); + DEBUG3("Killing %s(%d) on %s", + process->name, p_simdata->PID, p_simdata->m_host->name); - if(p_simdata->waiting_task) { - DEBUG1("Canceling waiting task %s",p_simdata->waiting_task->name); - if(p_simdata->waiting_task->simdata->compute) { - SIMIX_action_cancel(p_simdata->waiting_task->simdata->compute); - } - else if (p_simdata->waiting_task->simdata->comm) { - SIMIX_action_cancel(p_simdata->waiting_task->simdata->comm); - } + if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) { + SIMIX_communication_cancel(p_simdata->waiting_task->simdata->comm); } + + if (p_simdata->waiting_action) { + DEBUG1("Canceling waiting task %s", + SIMIX_action_get_name(p_simdata->waiting_action)); + SIMIX_action_cancel(p_simdata->waiting_action); + } + + xbt_fifo_remove(msg_global->process_list, process); + SIMIX_process_kill(process->simdata->s_process); - xbt_fifo_remove(msg_global->process_list,process); - SIMIX_process_kill(process->simdata->smx_process); - - return; + return; } /** \ingroup m_process_management * \brief Migrates an agent to another location. * - * This functions checks whether \a process and \a host are valid pointers + * 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_change_host(m_process_t process, m_host_t host) +MSG_error_t MSG_process_change_host(m_host_t host) { - xbt_die("MSG_process_change_host - not implemented yet - maybe useless function"); + m_process_t process = MSG_process_self(); + m_host_t now = process->simdata->m_host; + process->simdata->m_host = host; + SIMIX_process_change_host(process->simdata->s_process, now->name, + host->name); return MSG_OK; } /** \ingroup m_process_management * \brief Return the user data of a #m_process_t. * - * This functions checks whether \a process is a valid pointer or not + * This function checks whether \a process is a valid pointer or not and return the user data associated to \a process if it is possible. */ void *MSG_process_get_data(m_process_t process) @@ -180,39 +244,39 @@ void *MSG_process_get_data(m_process_t process) /** \ingroup m_process_management * \brief Set the user data of a #m_process_t. * - * This functions checks whether \a process is a valid pointer or not + * This function checks whether \a process is a valid pointer or not and set the user data associated to \a process if it is possible. */ -MSG_error_t MSG_process_set_data(m_process_t process,void *data) +MSG_error_t MSG_process_set_data(m_process_t process, void *data) { xbt_assert0((process != NULL), "Invalid parameters"); - xbt_assert0((process->data == NULL), "Data already set"); - + process->data = data; - + return MSG_OK; } /** \ingroup m_process_management * \brief Return the location on which an agent is running. * - * This functions checks whether \a process is a valid pointer or not - and return the m_host_t corresponding to the location on which \a + * This function checks whether \a process is a valid pointer or not + and return the m_host_t corresponding to the location on which \a process is running. */ m_host_t MSG_process_get_host(m_process_t process) { - xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters"); + xbt_assert0(((process != NULL) + && (process->simdata)), "Invalid parameters"); - return (((simdata_process_t) process->simdata)->host); + return (((simdata_process_t) process->simdata)->m_host); } /** \ingroup m_process_management * * \brief Return a #m_process_t given its PID. * - * This functions search in the list of all the created m_process_t for a m_process_t - whose PID is equal to \a PID. If no host is found, \c NULL is returned. + * This function search in the list of all the created m_process_t for a m_process_t + whose PID is equal to \a PID. If no host is found, \c NULL is returned. Note that the PID are uniq in the whole simulation, not only on a given host. */ m_process_t MSG_process_from_PID(int PID) @@ -220,8 +284,9 @@ m_process_t MSG_process_from_PID(int PID) xbt_fifo_item_t i = NULL; m_process_t process = NULL; - xbt_fifo_foreach(msg_global->process_list,i,process,m_process_t) { - if(MSG_process_get_PID(process) == PID) return process; + xbt_fifo_foreach(msg_global->process_list, i, process, m_process_t) { + if (MSG_process_get_PID(process) == PID) + return process; } return NULL; } @@ -229,12 +294,15 @@ m_process_t MSG_process_from_PID(int PID) /** \ingroup m_process_management * \brief Returns the process ID of \a process. * - * This functions checks whether \a process is a valid pointer or not - and return its PID. + * This function checks whether \a process is a valid pointer or not + and return its PID (or 0 in case of problem). */ int MSG_process_get_PID(m_process_t process) { - xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters"); + /* Do not raise an exception here: this function is used in the logs, + and it will be called back by the exception handling stuff */ + if (process == NULL || process->simdata == NULL) + return 0; return (((simdata_process_t) process->simdata)->PID); } @@ -242,13 +310,14 @@ int MSG_process_get_PID(m_process_t process) /** \ingroup m_process_management * \brief Returns the process ID of the parent of \a process. * - * This functions checks whether \a process is a valid pointer or not - and return its PID. Returns -1 if the agent has not been created by + * 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. */ int MSG_process_get_PPID(m_process_t process) { - xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters"); + xbt_assert0(((process != NULL) + && (process->simdata)), "Invalid parameters"); return (((simdata_process_t) process->simdata)->PPID); } @@ -256,20 +325,49 @@ int MSG_process_get_PPID(m_process_t process) /** \ingroup m_process_management * \brief Return the name of an agent. * - * This functions checks whether \a process is a valid pointer or not + * This function checks whether \a process is a valid pointer or not and return its name. */ const char *MSG_process_get_name(m_process_t process) { - xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters"); + xbt_assert0(process, "Invalid parameter: process is NULL"); + xbt_assert0(process->simdata, + "Invalid parameter: process->simdata is NULL"); return (process->name); } +/** \ingroup m_process_management + * \brief Returns the value of a given process property + * + * \param process a process + * \param name a property name + * \return value of a property (or NULL if the property is not set) + */ +const char *MSG_process_get_property_value(m_process_t process, + const char *name) +{ + return xbt_dict_get_or_null(MSG_process_get_properties(process), name); +} + +/** \ingroup m_process_management + * \brief Return the list of properties + * + * This function returns all the parameters associated with a process + */ +xbt_dict_t MSG_process_get_properties(m_process_t process) +{ + xbt_assert0((process != NULL), "Invalid parameters"); + + return (SIMIX_process_get_properties + (((simdata_process_t) process->simdata)->s_process)); + +} + /** \ingroup m_process_management * \brief Return the PID of the current agent. * - * This functions returns the PID of the currently running #m_process_t. + * This function returns the PID of the currently running #m_process_t. */ int MSG_process_self_PID(void) { @@ -279,7 +377,7 @@ int MSG_process_self_PID(void) /** \ingroup m_process_management * \brief Return the PPID of the current agent. * - * This functions returns the PID of the parent of the currently + * This function returns the PID of the parent of the currently * running #m_process_t. */ int MSG_process_self_PPID(void) @@ -290,48 +388,49 @@ int MSG_process_self_PPID(void) /** \ingroup m_process_management * \brief Return the current agent. * - * This functions returns the currently running #m_process_t. + * This function returns the currently running #m_process_t. */ m_process_t MSG_process_self(void) { - smx_process_t proc = SIMIX_process_self(); - if (proc != NULL) { - return (m_process_t)proc->data; - } - else { - return NULL; - } + smx_process_t proc = SIMIX_process_self(); + if (proc != NULL) { + return (m_process_t) proc->data; + } else { + return NULL; + } } /** \ingroup m_process_management * \brief Suspend the process. * - * This functions suspend the process by suspending the task on which + * This function suspends the process by suspending the task on which * it was waiting for the completion. */ MSG_error_t MSG_process_suspend(m_process_t process) { - xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters"); + xbt_assert0(((process != NULL) + && (process->simdata)), "Invalid parameters"); CHECK_HOST(); - SIMIX_process_suspend(process->simdata->smx_process); + SIMIX_process_suspend(process->simdata->s_process); MSG_RETURN(MSG_OK); } /** \ingroup m_process_management * \brief Resume a suspended process. * - * This functions resume a suspended process by resuming the task on + * This function resumes a suspended process by resuming the task on * which it was waiting for the completion. */ MSG_error_t MSG_process_resume(m_process_t process) { - xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters"); + xbt_assert0(((process != NULL) + && (process->simdata)), "Invalid parameters"); CHECK_HOST(); - SIMIX_process_resume(process->simdata->smx_process); + SIMIX_process_resume(process->simdata->s_process); MSG_RETURN(MSG_OK); } @@ -343,7 +442,7 @@ MSG_error_t MSG_process_resume(m_process_t process) */ int MSG_process_is_suspended(m_process_t process) { - xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters"); - return SIMIX_process_is_suspended(process->simdata->smx_process); + xbt_assert0(((process != NULL) + && (process->simdata)), "Invalid parameters"); + return SIMIX_process_is_suspended(process->simdata->s_process); } -