XBT_PUBLIC(void) MSG_task_set_category (msg_task_t task, const char *category);
XBT_PUBLIC(const char *) MSG_task_get_category (msg_task_t task);
-/************************** Task handling ************************************/
-XBT_PUBLIC(msg_error_t)
- MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t * task,
- msg_host_t host, double timeout);
+/************************** Mailbox handling ************************************/
+/* @brief MSG_mailbox_new - create a new mailbox.
+ * 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.
+ */
+XBT_PUBLIC(msg_mailbox_t) MSG_mailbox_new(const char *alias);
-XBT_PUBLIC(msg_error_t)
- MSG_mailbox_get_task_ext_bounded(msg_mailbox_t mailbox, msg_task_t *task,
- msg_host_t host, double timeout, double rate);
+/* @brief MSG_mailbox_get_by_alias - get a mailbox from its alias.
+ * Returns the mailbox associated with the key specified by the parameter alias. If the mailbox does not exists,
+ * the function creates it.
+ * @param alias The alias of the mailbox to return.
+ * @return The mailbox associated with the alias specified as parameter or a new one if the key doesn't match.
+ */
+XBT_PUBLIC(msg_mailbox_t) MSG_mailbox_get_by_alias(const char *alias);
-XBT_PUBLIC(msg_error_t)
- MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, msg_task_t task,
- double timeout);
+/* @brief MSG_mailbox_is_empty - test if a mailbox is empty.
+ * Tests if a mailbox is empty (contains no msg task).
+ * @param mailbox The mailbox to get test.
+ * @return 1 if the mailbox is empty, 0 otherwise.
+ */
+XBT_PUBLIC(int) MSG_mailbox_is_empty(msg_mailbox_t mailbox);
+/* @brief MSG_mailbox_set_async - set a mailbox as eager
+ * Sets the mailbox to a permanent receiver mode. Messages sent to this mailbox will then be sent just after the send
+ * is issued, without waiting for the corresponding receive.
+ * This call should be done before issuing any receive, and on the receiver's side only
+ * @param alias The alias of the mailbox to modify.
+ */
XBT_PUBLIC(void) MSG_mailbox_set_async(const char *alias);
+/* @brief MSG_mailbox_get_head - get the task at the head of a mailbox.
+ * Returns the task at the head of the mailbox. This function does not remove the task from the mailbox.
+ * @param mailbox The mailbox concerned by the operation.
+ * @return The task at the head of the mailbox.
+ */
+XBT_PUBLIC(msg_task_t) 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.
+ * @param mailbox The mailbox concerned by the operation.
+ * @param host The host containing the processes that 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.
+ */
+XBT_PUBLIC(int) MSG_mailbox_get_count_host_waiting_tasks(msg_mailbox_t mailbox, msg_host_t host);
+XBT_PUBLIC(msg_error_t) MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t * task, msg_host_t host,
+ double timeout);
+XBT_PUBLIC(msg_error_t) MSG_mailbox_get_task_ext_bounded(msg_mailbox_t mailbox, msg_task_t *task, msg_host_t host,
+ double timeout, double rate);
+XBT_PUBLIC(msg_error_t) MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, msg_task_t task, double timeout);
+
/************************** Action handling **********************************/
XBT_PUBLIC(msg_error_t) MSG_action_trace_run(char *path);
#include "simgrid/msg.h"
#include "instr/instr_interface.h"
#include "msg_private.h"
-#include "msg_mailbox.h"
#include "mc/mc.h"
#include "xbt/sysdep.h"
#include "xbt/log.h"
* under the terms of the license (GNU LGPL) which comes with this package. */
#include "msg_private.h"
-#include "msg_mailbox.h"
#include "mc/mc.h"
#include "xbt/log.h"
#include "xbt/sysdep.h"
* under the terms of the license (GNU LGPL) which comes with this package. */
#include "src/msg/msg_private.h"
-#include "src/msg/msg_mailbox.h"
#include "xbt/sysdep.h"
#include "xbt/log.h"
#include "simgrid/simix.h"
#include "msg_private.h"
#include "xbt/log.h"
-#include "msg_mailbox.h"
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_io, msg,
"Logging specific to MSG (io)");
/* 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_mailbox.h"
+#include "simgrid/msg.h"
#include "msg_private.h"
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_mailbox, msg,
+++ /dev/null
-/* Copyright (c) 2008-2015. The SimGrid Team.
- * 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. */
-
-#ifndef MSG_MAILBOX_H
-#define MSG_MAILBOX_H
-
-#include <xbt/base.h>
-#include "xbt/fifo.h"
-#include "simgrid/simix.h"
-#include "simgrid/msg.h"
-
-
-SG_BEGIN_DECL()
-#define MAX_ALIAS_NAME ((size_t)260)
-
-/*! \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.
- */
-XBT_PUBLIC(msg_mailbox_t)
- MSG_mailbox_new(const char *alias);
-
-XBT_PRIVATE void MSG_mailbox_free(void *mailbox);
-
-/* \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.
- */
-XBT_PRIVATE 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.
- */
-XBT_PUBLIC(msg_mailbox_t)
- MSG_mailbox_get_by_alias(const char *alias);
-
-/*! \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.
- */
-XBT_PUBLIC(int) MSG_mailbox_is_empty(msg_mailbox_t mailbox);
-
-/* \brief MSG_mailbox_set_async - set a mailbox as eager
- *
- * The function MSG_mailbox_set_async sets the mailbox to a permanent receiver mode
- * Messages sent to this mailbox will then be sent just after the send is issued,
- * without waiting for the corresponding receive.
- *
- * This call should be done before issuing any receive, and on the receiver's side only
- *
- * \param alias The alias of the mailbox to modify.
- *
- */
-XBT_PUBLIC(void) MSG_mailbox_set_async(const char *alias);
-
-/*! \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.
- */
-XBT_PUBLIC(msg_task_t)
- 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.
- *
- * \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.
- */
-XBT_PUBLIC(int)
-MSG_mailbox_get_count_host_waiting_tasks(msg_mailbox_t mailbox,
- msg_host_t host);
-
-SG_END_DECL()
-#endif /* !MSG_MAILBOX_H */
XBT_PRIVATE void MSG_host_add_task(msg_host_t host, msg_task_t task);
XBT_PRIVATE void MSG_host_del_task(msg_host_t host, msg_task_t task);
+/* @brief MSG_mailbox_free - release a mailbox from the memory.
+ * Releases a mailbox from the memory but does not remove it from the dictionary.
+ * @param mailbox The mailbox to release.
+ */
+XBT_PRIVATE void MSG_mailbox_free(void *mailbox);
/********** Tracing **********/
/* declaration of instrumentation functions from msg_task_instr.c */
#include "xbt/log.h"
#include "src/msg/msg_private.h"
-#include "src/msg/msg_mailbox.h"
#include "simgrid/s4u/actor.hpp"
#include "simgrid/s4u/comm.hpp"
#include "xbt/log.h"
#include "src/msg/msg_private.h"
-#include "src/msg/msg_mailbox.h"
#include "simgrid/s4u/async.hpp"
#include "xbt/log.h"
#include "src/msg/msg_private.h"
-#include "src/msg/msg_mailbox.h"
#include "simgrid/s4u/comm.hpp"
#include "xbt/log.h"
#include "src/msg/msg_private.h"
-#include "src/msg/msg_mailbox.h"
#include "simgrid/s4u/actor.hpp"
#include "simgrid/s4u/comm.hpp"
#include "xbt/log.h"
#include "src/msg/msg_private.h"
-#include "src/msg/msg_mailbox.h"
#include "simgrid/s4u/mailbox.hpp"
src/include/surf/surf.h
src/include/xbt/win32_ucontext.h
src/include/xbt/wine_dbghelp.h
- src/msg/msg_mailbox.h
src/msg/msg_private.h
src/portable.h
src/probes.tp