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/Engine.hpp"
8 #include "simgrid/s4u/Mailbox.hpp"
9 #include "src/kernel/activity/MailboxImpl.hpp"
11 #include <simgrid/mailbox.h>
13 XBT_LOG_EXTERNAL_CATEGORY(s4u);
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_channel, s4u, "S4U Communication Mailboxes");
19 const xbt::string& Mailbox::get_name() const
21 return pimpl_->get_name();
24 const char* Mailbox::get_cname() const
26 return pimpl_->get_cname();
29 Mailbox* Mailbox::by_name(const std::string& name)
31 return Engine::get_instance()->mailbox_by_name_or_create(name);
34 bool Mailbox::empty() const
36 return pimpl_->empty();
39 size_t Mailbox::size() const
41 return pimpl_->size();
44 bool Mailbox::listen() const
46 return not pimpl_->empty() || (pimpl_->is_permanent() && pimpl_->has_some_done_comm());
49 aid_t Mailbox::listen_from() const
51 kernel::activity::CommImplPtr comm = front();
52 if (comm && comm->src_actor_)
53 return comm->src_actor_->get_pid();
58 bool Mailbox::ready() const
60 bool comm_ready = false;
61 if (not pimpl_->empty()) {
62 comm_ready = pimpl_->front()->state_ == kernel::activity::State::DONE;
64 } else if (pimpl_->is_permanent() && pimpl_->has_some_done_comm()) {
65 comm_ready = pimpl_->done_front()->state_ == kernel::activity::State::DONE;
70 kernel::activity::CommImplPtr Mailbox::front() const
72 return pimpl_->empty() ? nullptr : pimpl_->front();
75 void Mailbox::set_receiver(ActorPtr actor)
77 kernel::actor::simcall([this, actor]() { this->pimpl_->set_receiver(actor); });
80 /** @brief get the receiver (process associated to the mailbox) */
81 ActorPtr Mailbox::get_receiver() const
83 if (pimpl_->is_permanent())
85 return pimpl_->get_permanent_receiver()->get_iface();
88 CommPtr Mailbox::put_init()
90 CommPtr res(new Comm());
91 res->sender_ = kernel::actor::ActorImpl::self();
96 CommPtr Mailbox::put_init(void* payload, uint64_t simulated_size_in_bytes)
98 return put_init()->set_payload_size(simulated_size_in_bytes)->set_src_data(payload)->set_src_data_size(sizeof(void*));
101 CommPtr Mailbox::put_async(void* payload, uint64_t simulated_size_in_bytes)
103 xbt_assert(payload != nullptr, "You cannot send nullptr");
105 CommPtr res = put_init(payload, simulated_size_in_bytes);
106 res->vetoable_start();
110 void Mailbox::put(void* payload, uint64_t simulated_size_in_bytes)
112 xbt_assert(payload != nullptr, "You cannot send nullptr");
114 put_init()->set_payload_size(simulated_size_in_bytes)->set_src_data(payload)->vetoable_start()->wait();
117 /** Blocking send with timeout */
118 void Mailbox::put(void* payload, uint64_t simulated_size_in_bytes, double timeout)
120 xbt_assert(payload != nullptr, "You cannot send nullptr");
122 put_init()->set_payload_size(simulated_size_in_bytes)->set_src_data(payload)->vetoable_start()->wait_for(timeout);
125 CommPtr Mailbox::get_init()
127 CommPtr res(new Comm());
128 res->receiver_ = kernel::actor::ActorImpl::self();
129 res->mailbox_ = this;
133 kernel::activity::ActivityImplPtr
134 Mailbox::iprobe(int type, bool (*match_fun)(void*, void*, kernel::activity::CommImpl*), void* data)
136 return kernel::actor::simcall([this, type, match_fun, data] { return pimpl_->iprobe(type, match_fun, data); });
139 } // namespace simgrid
141 /* **************************** Public C interface *************************** */
142 sg_mailbox_t sg_mailbox_by_name(const char* alias)
144 return simgrid::s4u::Mailbox::by_name(alias);
147 const char* sg_mailbox_get_name(const_sg_mailbox_t mailbox)
149 return mailbox->get_cname();
152 /** @brief Set the mailbox to receive in asynchronous mode
154 * All messages sent to this mailbox will be transferred to the receiver without waiting for the receive call.
155 * The receive call will still be necessary to use the received data.
156 * If there is a need to receive some messages asynchronously, and some not, two different mailboxes should be used.
158 * @param alias The name of the mailbox
160 void sg_mailbox_set_receiver(const char* alias)
162 simgrid::s4u::Mailbox::by_name(alias)->set_receiver(simgrid::s4u::Actor::self());
163 XBT_VERB("%s mailbox set to receive eagerly for myself\n", alias);
166 /** @brief Check if there is a communication going on in a mailbox.
168 * @param alias the name of the mailbox to be considered
169 * @return Returns 1 if there is a communication, 0 otherwise
171 int sg_mailbox_listen(const char* alias)
173 return simgrid::s4u::Mailbox::by_name(alias)->listen() ? 1 : 0;
176 void* sg_mailbox_get(sg_mailbox_t mailbox)
178 return mailbox->get<void>();
181 sg_comm_t sg_mailbox_get_async(sg_mailbox_t mailbox, void** data)
183 auto comm = mailbox->get_async<void>(data);
188 void sg_mailbox_put(sg_mailbox_t mailbox, void* payload, long simulated_size_in_bytes)
190 mailbox->put(payload, simulated_size_in_bytes);
193 sg_comm_t sg_mailbox_put_async(sg_mailbox_t mailbox, void* payload, long simulated_size_in_bytes)
195 auto comm = mailbox->put_async(payload, simulated_size_in_bytes);
200 sg_comm_t sg_mailbox_put_init(sg_mailbox_t mailbox, void* payload, long simulated_size_in_bytes)
202 auto comm = mailbox->put_init(payload, simulated_size_in_bytes);