Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
d4636989cb83dfcef3f739b76e0fc4d12b724b30
[simgrid.git] / src / msg / msg_mailbox.cpp
1 /* Mailboxes in MSG */
2
3 /* Copyright (c) 2008-2015. The SimGrid Team.
4  * All rights reserved.                                                     */
5
6 /* This program is free software; you can redistribute it and/or modify it
7  * under the terms of the license (GNU LGPL) which comes with this package. */
8
9 #include <xbt/ex.hpp>
10
11 #include "simgrid/msg.h"
12 #include "msg_private.h"
13
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_mailbox, msg, "Logging specific to MSG (mailbox)");
15
16 int MSG_mailbox_is_empty(msg_mailbox_t mailbox)
17 {
18   return (nullptr == simcall_mbox_front(mailbox));
19 }
20
21 msg_task_t MSG_mailbox_front(msg_mailbox_t mailbox)
22 {
23   simgrid::kernel::activity::Comm* comm = static_cast<simgrid::kernel::activity::Comm*>(simcall_mbox_front(mailbox));
24
25   if (!comm)
26     return nullptr;
27
28   return (msg_task_t) comm->src_data;
29 }
30
31 msg_mailbox_t MSG_mailbox_get_by_alias(const char *alias)
32 {
33   msg_mailbox_t mailbox = simcall_mbox_get_by_name(alias);
34
35   if (!mailbox)
36     mailbox = simcall_mbox_create(alias);
37
38   return mailbox;
39 }
40
41 /** \ingroup msg_mailbox_management
42  * \brief Set the mailbox to receive in asynchronous mode
43  *
44  * All messages sent to this mailbox will be transferred to the receiver without waiting for the receive call.
45  * The receive call will still be necessary to use the received data.
46  * If there is a need to receive some messages asynchronously, and some not, two different mailboxes should be used.
47  *
48  * \param alias The name of the mailbox
49  */
50 void MSG_mailbox_set_async(const char *alias){
51   msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
52
53   simcall_mbox_set_receiver(mailbox, SIMIX_process_self());
54   XBT_VERB("%s mailbox set to receive eagerly for myself\n",alias);
55 }
56
57 /** \ingroup msg_mailbox_management
58  * \brief Get a task from a mailbox on a given host
59  *
60  * \param mailbox The mailbox where the task was sent
61  * \param task a memory location for storing a #msg_task_t.
62  * \param host a #msg_host_t host from where the task was sent
63  * \param timeout a timeout
64
65  * \return Returns
66  * #MSG_OK if the task was successfully received,
67  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
68  */
69 msg_error_t MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t *task, msg_host_t host, double timeout)
70 {
71   return MSG_mailbox_get_task_ext_bounded(mailbox, task, host, timeout, -1.0);
72 }
73
74 /** \ingroup msg_mailbox_management
75  * \brief Get a task from a mailbox on a given host at a given rate
76  *
77  * \param mailbox The mailbox where the task was sent
78  * \param task a memory location for storing a #msg_task_t.
79  * \param host a #msg_host_t host from where the task was sent
80  * \param timeout a timeout
81  * \param rate a rate
82
83  * \return Returns
84  * #MSG_OK if the task was successfully received,
85  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
86  */
87 msg_error_t MSG_mailbox_get_task_ext_bounded(msg_mailbox_t mailbox, msg_task_t * task, msg_host_t host, double timeout,
88                                              double rate)
89 {
90   msg_error_t ret = MSG_OK;
91   /* We no longer support getting a task from a specific host */
92   if (host)
93     THROW_UNIMPLEMENTED;
94
95   TRACE_msg_task_get_start();
96   double start_time = MSG_get_clock();
97
98   /* Sanity check */
99   xbt_assert(task, "Null pointer for the task storage");
100
101   if (*task)
102     XBT_WARN("Asked to write the received task in a non empty struct -- proceeding.");
103
104   /* Try to receive it by calling SIMIX network layer */
105   try {
106     simcall_comm_recv(MSG_process_self(), mailbox, task, nullptr, nullptr, nullptr, nullptr, timeout, rate);
107     XBT_DEBUG("Got task %s from %p",(*task)->name,mailbox);
108     (*task)->simdata->setNotUsed();
109   }
110   catch (xbt_ex& e) {
111     switch (e.category) {
112     case cancel_error:
113       ret = MSG_HOST_FAILURE;
114       break;
115     case network_error:
116       ret = MSG_TRANSFER_FAILURE;
117       break;
118     case timeout_error:
119       ret = MSG_TIMEOUT;
120       break;
121     case host_error:
122       ret = MSG_HOST_FAILURE;
123       break;
124     default:
125       throw;
126     }
127   }
128
129   if (ret != MSG_HOST_FAILURE && ret != MSG_TRANSFER_FAILURE && ret != MSG_TIMEOUT) {
130     TRACE_msg_task_get_end(start_time, *task);
131   }
132   MSG_RETURN(ret);
133 }