Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
new tracing mask TRACE_VOLUME to trace the msg tasks communication size and group...
[simgrid.git] / src / msg / mailbox.h
index bceaa98..6e577fe 100644 (file)
@@ -2,20 +2,21 @@
 #define SMX_MAILBOX_H
 
 #include "xbt/fifo.h"
-#include "simix/private.h"
+#include "simix/simix.h"
 #include "msg/datatypes.h"
 
+
 SG_BEGIN_DECL()
 #define MAX_ALIAS_NAME ((size_t)260)
 /*
  * Initialization of the mailbox module.
  */
-void MSG_mailbox_mod_init(void);
+     void MSG_mailbox_mod_init(void);
 
 /*
  * Terminaison of the mailbox module.
  */
-void MSG_mailbox_mod_exit(void);
+     void MSG_mailbox_mod_exit(void);
 
 
 /*! \brief MSG_mailbox_new - create a new mailbox.
@@ -28,7 +29,7 @@ void MSG_mailbox_mod_exit(void);
  * \return             The newly created mailbox.
  */
 XBT_PUBLIC(msg_mailbox_t)
-MSG_mailbox_new(const char *alias);
+  MSG_mailbox_new(const char *alias);
 
 /*! \brief MSG_mailbox_create - create a new mailbox.
  *
@@ -41,8 +42,7 @@ MSG_mailbox_new(const char *alias);
  *
  * \return             The newly created mailbox.
  */
-msg_mailbox_t
-MSG_mailbox_create(const char *alias);
+     msg_mailbox_t MSG_mailbox_create(const char *alias);
 
 /* \brief MSG_mailbox_free - release a mailbox from the memory.
  *
@@ -53,8 +53,7 @@ MSG_mailbox_create(const char *alias);
  *
  * \see                        MSG_mailbox_destroy.
  */
-void
-MSG_mailbox_free(void *mailbox);
+     void MSG_mailbox_free(void *mailbox);
 
 /* \brief MSG_mailbox_get_by_alias - get a mailbox from its alias.
  *
@@ -68,7 +67,7 @@ MSG_mailbox_free(void *mailbox);
  *             or a new mailbox if the key does not match.
  */
 XBT_PUBLIC(msg_mailbox_t)
-MSG_mailbox_get_by_alias(const char *alias);
+  MSG_mailbox_get_by_alias(const char *alias);
 
 /* \brief MSG_mailbox_get_by_channel - get a mailbox of the specified host from its channel.
  *
@@ -84,7 +83,7 @@ MSG_mailbox_get_by_alias(const char *alias);
  *
  */
 XBT_PUBLIC(msg_mailbox_t)
-MSG_mailbox_get_by_channel(m_host_t host, m_channel_t channel);
+  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.
  *
@@ -95,8 +94,7 @@ MSG_mailbox_get_by_channel(m_host_t host, m_channel_t channel);
  *
  * \return     The alias of the mailbox specified by the parameter mailbox.
  */
-XBT_PUBLIC(const char *)
-MSG_mailbox_get_alias(msg_mailbox_t mailbox);
+XBT_PUBLIC(const char *) MSG_mailbox_get_alias(msg_mailbox_t mailbox);
 
 /*! \brief MSG_mailbox_get_cond - get the simix condition of a mailbox.
  *
@@ -108,7 +106,7 @@ MSG_mailbox_get_alias(msg_mailbox_t mailbox);
  * \return The simix condition of the mailbox specified by the parameter mailbox.
  */
 XBT_PUBLIC(smx_cond_t)
-MSG_mailbox_get_cond(msg_mailbox_t mailbox);
+  MSG_mailbox_get_cond(msg_mailbox_t mailbox);
 
 /*! \brief MSG_mailbox_set_cond - set the simix condition of a mailbox.
  *
@@ -119,33 +117,7 @@ MSG_mailbox_get_cond(msg_mailbox_t mailbox);
  * \param cond         The new simix condition of the mailbox.
  *
  */
-XBT_PUBLIC(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.
- */
-XBT_PUBLIC(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.
- *
- */
-XBT_PUBLIC(void)
-MSG_mailbox_set_hostname(msg_mailbox_t mailbox, const char *hostname);
-
+XBT_PUBLIC(void) MSG_mailbox_set_cond(msg_mailbox_t mailbox, smx_cond_t cond);
 
 /*! \brief MSG_mailbox_is_empty - test if a mailbox is empty.
  *
@@ -157,18 +129,7 @@ MSG_mailbox_set_hostname(msg_mailbox_t mailbox, const char *hostname);
  * \return     The function returns 1 if the mailbox is empty. Otherwise the function
  *             returns 0.
  */
-XBT_PUBLIC(int)
-MSG_mailbox_is_empty(msg_mailbox_t mailbox);
-
-/*! \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.
- */
-XBT_PUBLIC(void)
-MSG_mailbox_remove(msg_mailbox_t mailbox, m_task_t task);
+XBT_PUBLIC(int) MSG_mailbox_is_empty(msg_mailbox_t mailbox);
 
 /*! \brief MSG_mailbox_get_head - get the task at the head of a mailbox.
  *
@@ -181,34 +142,7 @@ MSG_mailbox_remove(msg_mailbox_t mailbox, m_task_t task);
  * \return             The task at the head of the mailbox.
  */
 XBT_PUBLIC(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.
- */
-XBT_PUBLIC(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.
- */
-XBT_PUBLIC(m_task_t)
-MSG_mailbox_get_first_host_task(msg_mailbox_t mailbox, m_host_t host);
+  MSG_mailbox_get_head(msg_mailbox_t mailbox);
 
 /*! \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.
@@ -223,9 +157,8 @@ MSG_mailbox_get_first_host_task(msg_mailbox_t mailbox, m_host_t host);
  */
 XBT_PUBLIC(int)
 MSG_mailbox_get_count_host_waiting_tasks(msg_mailbox_t mailbox,
-                                        m_host_t host);
+                                         m_host_t host);
 
 
 SG_END_DECL()
-
-#endif                         /* !SMX_MAILBOX_H */
+#endif /* !SMX_MAILBOX_H */