From: cherierm Date: Fri, 11 Jan 2008 10:12:35 +0000 (+0000) Subject: rename msg_mailbox.h mailbox.h X-Git-Tag: v3.3~669 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/349849fb3243c5650fa9706f0f6df5069d51cf9b rename msg_mailbox.h mailbox.h git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk@5191 48e7efb5-ca39-0410-a469-dd3cf9ba447f --- diff --git a/src/msg/mailbox.h b/src/msg/mailbox.h new file mode 100644 index 0000000000..9534f04152 --- /dev/null +++ b/src/msg/mailbox.h @@ -0,0 +1,253 @@ +#ifndef SMX_MAILBOX_H +#define SMX_MAILBOX_H + +#include "xbt/fifo.h" +#include "simix/private.h" +#include "msg/datatypes.h" + +SG_BEGIN_DECL() + +#define MAX_ALIAS_NAME ((size_t)260) + +/* forward declaration */ +typedef struct s_msg_mailbox* msg_mailbox_t; + +/* + * Initialization of the mailbox module. + */ +void +MSG_mailbox_mod_init(void); + +/* + * Terminaison of the mailbox module. + */ +void +MSG_mailbox_mod_exit(void); + + +/*! \brief MSG_mailbox_new - create a new mailbox. + * + * The function MSG_mailbox_new creates a new mailbox identified by the key specified + * by the parameter alias and add it in the global dictionary. + * + * \param alias The alias of the mailbox to create. + * + * \return The newly created mailbox. + */ +msg_mailbox_t +MSG_mailbox_new(const char *alias); + +/*! \brief MSG_mailbox_create - create a new mailbox. + * + * The function MSG_mailbox_new creates a new mailbox identified by the key specified + * by the parameter alias and add it in the global dictionary but doesn't add it in + * the global dictionary. Typicaly, this type of mailbox is associated with a channel. + * + * \param alias The alias of the mailbox to create. + * + * \return The newly created mailbox. + */ +msg_mailbox_t +MSG_mailbox_create(const char *alias); + +/* \brief MSG_mailbox_free - release a mailbox from the memory. + * + * The function MSG_mailbox_free release a mailbox from the memory but does + * not remove it from the dictionary. + * + * \param mailbox The mailbox to release. + * + * \see MSG_mailbox_destroy. + */ +void +MSG_mailbox_free(void* mailbox); + +/* \brief MSG_mailbox_get_by_alias - get a mailbox from its alias. + * + * The function MSG_mailbox_get_by_alias returns the mailbox associated with + * the key specified by the parameter alias. If the mailbox does not exists, + * the function create it. + * + * \param alias The alias of the mailbox to return. + * + * \return The mailbox associated with the alias specified as parameter + * or a new mailbox if the key does not match. + */ +msg_mailbox_t +MSG_mailbox_get_by_alias(const char* alias); + +/* \brief MSG_mailbox_get_by_channel - get a mailbox of the specified host from its channel. + * + * The function MSG_mailbox_get_by_channel returns the mailbox of the specified host + * from the channel specified by the parameter channel. If the mailbox does not exists, + * the function fails. + * + * \param host The host containing he mailbox to get. + * \param channel The channel used to identify the mailbox. + * + * \return The mailbox of the specified host associated the channel specified as parameter. + * + */ +msg_mailbox_t +MSG_mailbox_get_by_channel(m_host_t host, m_channel_t channel); + +/*! \brief MSG_mailbox_get_alias - get the alias associated with the mailbox. + * + * The function MSG_mailbox_get_alias returns the alias of the mailbox specified + * by the parameter mailbox. + * + * \param mailbox The mailbox to get the alias. + * + * \return The alias of the mailbox specified by the parameter mailbox. + */ +const char* +MSG_mailbox_get_alias(msg_mailbox_t mailbox); + +/*! \brief MSG_mailbox_get_cond - get the simix condition of a mailbox. + * + * The function MSG_mailbox_get_cond returns the condition of the mailbox specified + * by the parameter mailbox. + * + * \param mailbox The mailbox to get the condition. + * + * \return The simix condition of the mailbox specified by the parameter mailbox. + */ +smx_cond_t +MSG_mailbox_get_cond(msg_mailbox_t mailbox); + +/*! \brief MSG_mailbox_set_cond - set the simix condition of a mailbox. + * + * The function MSG_mailbox_set_cond set the condition of the mailbox specified + * by the parameter mailbox. + * + * \param mailbox The mailbox to set the condition. + * \param cond The new simix condition of the mailbox. + * + */ +void +MSG_mailbox_set_cond(msg_mailbox_t mailbox, smx_cond_t cond); + +/*! \brief MSG_mailbox_get_hostname - get the name of the host owned a mailbox. + * + * The function MSG_mailbox_get_hostname returns name of the host owned the mailbox specified + * by the parameter mailbox. + * + * \param mailbox The mailbox to get the name of the host. + * + * \return The name of the host owned the mailbox specified by the parameter mailbox. + */ +const char* +MSG_mailbox_get_hostname(msg_mailbox_t mailbox); + +/*! \brief MSG_mailbox_set_hostname - set the name of the host owned a mailbox. + * + * The function MSG_mailbox_set_hostname sets the name of the host owned the mailbox specified + * by the parameter mailbox. + * + * \param mailbox The mailbox to set the name of the host. + * \param hostname The name of the owner of the mailbox. + * + */ +void +MSG_mailbox_set_hostname(msg_mailbox_t mailbox, const char* hostname); + + +/*! \brief MSG_mailbox_is_empty - test if a mailbox is empty. + * + * The function MSG_mailbox_is_empty tests if a mailbox is empty (contains no msg task). + * + * \param mailbox The mailbox to get test. + * + * \return The function returns 1 if the mailbox is empty. Otherwise the function + * returns 0. + */ +int +MSG_mailbox_is_empty(msg_mailbox_t mailbox); + +/*! \brief MSG_mailbox_put - put a task in a mailbox. + * + * The MSG_mailbox_put puts a task in a specified mailbox. + * + * \param mailbox The mailbox where put the task. + * \param task The task to put in the mailbox. + */ +void +MSG_mailbox_put(msg_mailbox_t mailbox, m_task_t task); + +/*! \brief MSG_mailbox_remove - remove a task from a mailbox. + * + * The MSG_mailbox_remove removes a task from a specified mailbox. + * + * \param mailbox The mailbox concerned by this operation. + * \param task The task to remove from the mailbox. + */ +void +MSG_mailbox_remove(msg_mailbox_t mailbox, m_task_t task); + +/*! \brief MSG_mailbox_get_head - get the task at the head of a mailbox. + * + * The MSG_mailbox_get_head returns the task at the head of the mailbox. + * This function does not remove the task from the mailbox (contrary to + * the function MSG_mailbox_pop_head). + * + * \param mailbox The mailbox concerned by the operation. + * + * \return The task at the head of the mailbox. + */ +m_task_t +MSG_mailbox_get_head(msg_mailbox_t mailbox); + +/*! \brief MSG_mailbox_pop_head - get the task at the head of a mailbox + * and remove it from it. + * + * The MSG_mailbox_pop_head returns the task at the head of the mailbox + * and remove it from it. + * + * \param mailbox The mailbox concerned by the operation. + * + * \return The task at the head of the mailbox. + */ +m_task_t +MSG_mailbox_pop_head(msg_mailbox_t mailbox); + +/*! \brief MSG_mailbox_get_first_host_task - get the first msg task + * of a specified mailbox, sended by a process of a specified host. + * + * \param mailbox The mailbox concerned by the operation. + * \param host The msg host of the process that has sended the + * task. + * + * \return The first task in the mailbox specified by the + * parameter mailbox and sended by a process located + * on the host specified by the parameter host. + */ +m_task_t +MSG_mailbox_get_first_host_task(msg_mailbox_t mailbox, m_host_t host); + +/*! \brief MSG_mailbox_get_count_host_waiting_tasks - Return the number of tasks + waiting to be received in a mailbox and sent by a host. + * + * \param mailbox The mailbox concerned by the operation. + * \param host The msg host containing the processes that have sended the + * tasks. + * + * \return The number of tasks in the mailbox specified by the + * parameter mailbox and sended by all the processes located + * on the host specified by the parameter host. + */ +int +MSG_mailbox_get_count_host_waiting_tasks(msg_mailbox_t mailbox, m_host_t host); + + +MSG_error_t +MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, m_task_t* task, m_host_t host, double timeout); + + +MSG_error_t +MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task, double timeout); + +SG_END_DECL() + + +#endif /* !SMX_MAILBOX_H */ +