1 /* Copyright (c) 2006-2019. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #include "simgrid/s4u/Comm.hpp"
7 #include "simgrid/s4u/Mailbox.hpp"
8 #include "src/kernel/activity/MailboxImpl.hpp"
9 #include <simgrid/mailbox.h>
11 XBT_LOG_EXTERNAL_CATEGORY(s4u);
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_channel, s4u, "S4U Communication Mailboxes");
17 const simgrid::xbt::string& Mailbox::get_name() const
19 return pimpl_->get_name();
22 const char* Mailbox::get_cname() const
24 return pimpl_->get_cname();
27 MailboxPtr Mailbox::by_name(std::string name)
29 kernel::activity::MailboxImpl* mbox = kernel::activity::MailboxImpl::by_name_or_null(name);
30 if (mbox == nullptr) {
31 mbox = simix::simcall([name] { return kernel::activity::MailboxImpl::by_name_or_create(name); });
33 return MailboxPtr(&mbox->piface_, true);
38 return pimpl_->comm_queue_.empty();
41 bool Mailbox::listen()
43 return not this->empty() || (pimpl_->permanent_receiver_ && not pimpl_->done_comm_queue_.empty());
48 bool comm_ready = false;
49 if (not pimpl_->comm_queue_.empty()) {
50 comm_ready = pimpl_->comm_queue_.front()->state_ == SIMIX_DONE;
52 } else if (pimpl_->permanent_receiver_ && not pimpl_->done_comm_queue_.empty()) {
53 comm_ready = pimpl_->done_comm_queue_.front()->state_ == SIMIX_DONE;
58 smx_activity_t Mailbox::front()
60 return pimpl_->comm_queue_.empty() ? nullptr : pimpl_->comm_queue_.front();
63 void Mailbox::set_receiver(ActorPtr actor)
65 simix::simcall([this, actor]() { this->pimpl_->set_receiver(actor); });
68 /** @brief get the receiver (process associated to the mailbox) */
69 ActorPtr Mailbox::get_receiver()
71 if (pimpl_->permanent_receiver_ == nullptr)
73 return pimpl_->permanent_receiver_->iface();
76 CommPtr Mailbox::put_init()
78 CommPtr res = CommPtr(new s4u::Comm());
79 res->sender_ = SIMIX_process_self();
83 s4u::CommPtr Mailbox::put_init(void* data, uint64_t simulated_size_in_bytes)
85 s4u::CommPtr res = put_init();
86 res->set_remaining(simulated_size_in_bytes);
87 res->src_buff_ = data;
88 res->src_buff_size_ = sizeof(void*);
91 s4u::CommPtr Mailbox::put_async(void* payload, uint64_t simulated_size_in_bytes)
93 xbt_assert(payload != nullptr, "You cannot send nullptr");
95 s4u::CommPtr res = put_init(payload, simulated_size_in_bytes);
99 void Mailbox::put(void* payload, uint64_t simulated_size_in_bytes)
101 xbt_assert(payload != nullptr, "You cannot send nullptr");
103 CommPtr c = put_init();
104 c->set_remaining(simulated_size_in_bytes);
105 c->set_src_data(payload);
108 /** Blocking send with timeout */
109 void Mailbox::put(void* payload, uint64_t simulated_size_in_bytes, double timeout)
111 xbt_assert(payload != nullptr, "You cannot send nullptr");
113 CommPtr c = put_init();
114 c->set_remaining(simulated_size_in_bytes);
115 c->set_src_data(payload);
116 // c->start() is optional.
117 c->wait_for(timeout);
120 s4u::CommPtr Mailbox::get_init()
122 CommPtr res = CommPtr(new s4u::Comm());
123 res->receiver_ = SIMIX_process_self();
124 res->mailbox_ = this;
127 s4u::CommPtr Mailbox::get_async(void** data)
129 s4u::CommPtr res = get_init();
130 res->set_dst_data(data, sizeof(*data));
138 CommPtr c = get_init();
139 c->set_dst_data(&res, sizeof(res));
143 void* Mailbox::get(double timeout)
146 CommPtr c = get_init();
147 c->set_dst_data(&res, sizeof(res));
148 c->wait_for(timeout);
152 } // namespace simgrid
154 /* **************************** Public C interface *************************** */
155 /** @brief Set the mailbox to receive in asynchronous mode
157 * All messages sent to this mailbox will be transferred to the receiver without waiting for the receive call.
158 * The receive call will still be necessary to use the received data.
159 * If there is a need to receive some messages asynchronously, and some not, two different mailboxes should be used.
161 * @param alias The name of the mailbox
163 void sg_mailbox_set_receiver(const char* alias)
165 simgrid::s4u::Mailbox::by_name(alias)->set_receiver(simgrid::s4u::Actor::self());
166 XBT_VERB("%s mailbox set to receive eagerly for myself\n", alias);
169 /** @brief Check if there is a communication going on in a mailbox.
171 * @param alias the name of the mailbox to be considered
172 * @return Returns 1 if there is a communication, 0 otherwise
174 int sg_mailbox_listen(const char* alias)
176 return simgrid::s4u::Mailbox::by_name(alias)->listen() ? 1 : 0;