1 /* Copyright (c) 2006-2021. 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"
10 #include <simgrid/mailbox.h>
12 XBT_LOG_EXTERNAL_CATEGORY(s4u);
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_channel, s4u, "S4U Communication Mailboxes");
18 const xbt::string& Mailbox::get_name() const
20 return pimpl_->get_name();
23 const char* Mailbox::get_cname() const
25 return pimpl_->get_cname();
28 Mailbox* Mailbox::by_name(const std::string& name)
30 kernel::activity::MailboxImpl* mbox = kernel::activity::MailboxImpl::by_name_or_null(name);
31 if (mbox == nullptr) {
32 mbox = kernel::actor::simcall([&name] { return kernel::activity::MailboxImpl::by_name_or_create(name); });
34 return &mbox->piface_;
37 bool Mailbox::empty() const
39 return pimpl_->comm_queue_.empty();
42 bool Mailbox::listen() const
44 return not this->empty() || (pimpl_->permanent_receiver_ && not pimpl_->done_comm_queue_.empty());
47 aid_t Mailbox::listen_from() const
49 kernel::activity::CommImplPtr comm = front();
50 if (comm && comm->src_actor_)
51 return comm->src_actor_->get_pid();
56 bool Mailbox::ready() const
58 bool comm_ready = false;
59 if (not pimpl_->comm_queue_.empty()) {
60 comm_ready = pimpl_->comm_queue_.front()->state_ == kernel::activity::State::DONE;
62 } else if (pimpl_->permanent_receiver_ && not pimpl_->done_comm_queue_.empty()) {
63 comm_ready = pimpl_->done_comm_queue_.front()->state_ == kernel::activity::State::DONE;
68 kernel::activity::CommImplPtr Mailbox::front() const
70 return pimpl_->comm_queue_.empty() ? nullptr : pimpl_->comm_queue_.front();
73 void Mailbox::set_receiver(ActorPtr actor)
75 kernel::actor::simcall([this, actor]() { this->pimpl_->set_receiver(actor); });
78 /** @brief get the receiver (process associated to the mailbox) */
79 ActorPtr Mailbox::get_receiver() const
81 if (pimpl_->permanent_receiver_ == nullptr)
83 return pimpl_->permanent_receiver_->get_iface();
86 CommPtr Mailbox::put_init()
88 CommPtr res(new Comm());
89 res->sender_ = kernel::actor::ActorImpl::self();
94 CommPtr Mailbox::put_init(void* data, uint64_t simulated_size_in_bytes)
96 CommPtr res = put_init();
97 res->set_remaining(simulated_size_in_bytes);
98 res->src_buff_ = data;
99 res->src_buff_size_ = sizeof(void*);
103 CommPtr Mailbox::put_async(void* payload, uint64_t simulated_size_in_bytes)
105 xbt_assert(payload != nullptr, "You cannot send nullptr");
107 CommPtr res = put_init(payload, simulated_size_in_bytes);
108 res->vetoable_start();
111 void Mailbox::put(void* payload, uint64_t simulated_size_in_bytes)
113 xbt_assert(payload != nullptr, "You cannot send nullptr");
115 CommPtr c = put_init();
116 c->set_remaining(simulated_size_in_bytes);
117 c->set_src_data(payload);
121 /** Blocking send with timeout */
122 void Mailbox::put(void* payload, uint64_t simulated_size_in_bytes, double timeout)
124 xbt_assert(payload != nullptr, "You cannot send nullptr");
126 CommPtr c = put_init();
127 c->set_remaining(simulated_size_in_bytes);
128 c->set_src_data(payload);
130 c->wait_for(timeout);
133 CommPtr Mailbox::get_init()
135 CommPtr res(new Comm());
136 res->receiver_ = kernel::actor::ActorImpl::self();
137 res->mailbox_ = this;
141 kernel::activity::ActivityImplPtr
142 Mailbox::iprobe(int type, bool (*match_fun)(void*, void*, kernel::activity::CommImpl*), void* data)
144 return kernel::actor::simcall([this, type, match_fun, data] { return pimpl_->iprobe(type, match_fun, data); });
147 } // namespace simgrid
149 /* **************************** Public C interface *************************** */
150 sg_mailbox_t sg_mailbox_by_name(const char* alias)
152 return simgrid::s4u::Mailbox::by_name(alias);
155 const char* sg_mailbox_get_name(const_sg_mailbox_t mailbox)
157 return mailbox->get_cname();
160 /** @brief Set the mailbox to receive in asynchronous mode
162 * All messages sent to this mailbox will be transferred to the receiver without waiting for the receive call.
163 * The receive call will still be necessary to use the received data.
164 * If there is a need to receive some messages asynchronously, and some not, two different mailboxes should be used.
166 * @param alias The name of the mailbox
168 void sg_mailbox_set_receiver(const char* alias)
170 simgrid::s4u::Mailbox::by_name(alias)->set_receiver(simgrid::s4u::Actor::self());
171 XBT_VERB("%s mailbox set to receive eagerly for myself\n", alias);
174 /** @brief Check if there is a communication going on in a mailbox.
176 * @param alias the name of the mailbox to be considered
177 * @return Returns 1 if there is a communication, 0 otherwise
179 int sg_mailbox_listen(const char* alias)
181 return simgrid::s4u::Mailbox::by_name(alias)->listen() ? 1 : 0;
184 void* sg_mailbox_get(sg_mailbox_t mailbox)
186 return mailbox->get<void>();
189 sg_comm_t sg_mailbox_get_async(sg_mailbox_t mailbox, void** data)
191 auto comm = mailbox->get_async<void>(data);
196 void sg_mailbox_put(sg_mailbox_t mailbox, void* payload, long simulated_size_in_bytes)
198 mailbox->put(payload, simulated_size_in_bytes);
201 sg_comm_t sg_mailbox_put_async(sg_mailbox_t mailbox, void* payload, long simulated_size_in_bytes)
203 auto comm = mailbox->put_async(payload, simulated_size_in_bytes);
208 sg_comm_t sg_mailbox_put_init(sg_mailbox_t mailbox, void* payload, long simulated_size_in_bytes)
210 auto comm = mailbox->put_init(payload, simulated_size_in_bytes);