1 /* Copyright (c) 2006-2020. 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_;
39 return pimpl_->comm_queue_.empty();
42 bool Mailbox::listen()
44 return not this->empty() || (pimpl_->permanent_receiver_ && not pimpl_->done_comm_queue_.empty());
47 aid_t Mailbox::listen_from()
49 kernel::activity::CommImplPtr comm = front();
50 if (comm && comm->src_actor_)
51 return comm->src_actor_->get_pid();
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()
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()
81 if (pimpl_->permanent_receiver_ == nullptr)
83 return pimpl_->permanent_receiver_->iface();
86 CommPtr Mailbox::put_init()
88 CommPtr res = CommPtr(new s4u::Comm());
89 res->sender_ = kernel::actor::ActorImpl::self();
93 s4u::CommPtr Mailbox::put_init(void* data, uint64_t simulated_size_in_bytes)
95 s4u::CommPtr res = put_init();
96 res->set_remaining(simulated_size_in_bytes);
97 res->src_buff_ = data;
98 res->src_buff_size_ = sizeof(void*);
101 s4u::CommPtr Mailbox::put_async(void* payload, uint64_t simulated_size_in_bytes)
103 xbt_assert(payload != nullptr, "You cannot send nullptr");
105 s4u::CommPtr res = put_init(payload, simulated_size_in_bytes);
106 res->vetoable_start();
109 void Mailbox::put(void* payload, uint64_t simulated_size_in_bytes)
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);
119 /** Blocking send with timeout */
120 void Mailbox::put(void* payload, uint64_t simulated_size_in_bytes, double timeout)
122 xbt_assert(payload != nullptr, "You cannot send nullptr");
124 CommPtr c = put_init();
125 c->set_remaining(simulated_size_in_bytes);
126 c->set_src_data(payload);
128 c->wait_for(timeout);
131 s4u::CommPtr Mailbox::get_init()
133 CommPtr res = CommPtr(new s4u::Comm());
134 res->receiver_ = kernel::actor::ActorImpl::self();
135 res->mailbox_ = this;
138 s4u::CommPtr Mailbox::get_async(void** data)
140 s4u::CommPtr res = get_init();
141 res->set_dst_data(data, sizeof(*data));
142 res->vetoable_start();
149 CommPtr c = get_init();
150 c->set_dst_data(&res, sizeof(res));
155 void* Mailbox::get(double timeout)
158 CommPtr c = get_init();
159 c->set_dst_data(&res, sizeof(res));
161 c->wait_for(timeout);
165 kernel::activity::ActivityImplPtr
166 Mailbox::iprobe(int type, bool (*match_fun)(void*, void*, kernel::activity::CommImpl*), void* data)
168 return kernel::actor::simcall([this, type, match_fun, data] { return pimpl_->iprobe(type, match_fun, data); });
171 } // namespace simgrid
173 /* **************************** Public C interface *************************** */
174 sg_mailbox_t sg_mailbox_by_name(const char* alias)
176 return simgrid::s4u::Mailbox::by_name(alias);
179 const char* sg_mailbox_get_name(const_sg_mailbox_t mailbox)
181 return mailbox->get_cname();
184 /** @brief Set the mailbox to receive in asynchronous mode
186 * All messages sent to this mailbox will be transferred to the receiver without waiting for the receive call.
187 * The receive call will still be necessary to use the received data.
188 * If there is a need to receive some messages asynchronously, and some not, two different mailboxes should be used.
190 * @param alias The name of the mailbox
192 void sg_mailbox_set_receiver(const char* alias)
194 simgrid::s4u::Mailbox::by_name(alias)->set_receiver(simgrid::s4u::Actor::self());
195 XBT_VERB("%s mailbox set to receive eagerly for myself\n", alias);
198 /** @brief Check if there is a communication going on in a mailbox.
200 * @param alias the name of the mailbox to be considered
201 * @return Returns 1 if there is a communication, 0 otherwise
203 int sg_mailbox_listen(const char* alias)
205 return simgrid::s4u::Mailbox::by_name(alias)->listen() ? 1 : 0;
208 void* sg_mailbox_get(sg_mailbox_t mailbox)
210 return mailbox->get();
213 sg_comm_t sg_mailbox_get_async(sg_mailbox_t mailbox, void** data)
215 auto comm = mailbox->get_async(data);
220 void sg_mailbox_put(sg_mailbox_t mailbox, void* payload, long simulated_size_in_bytes)
222 mailbox->put(payload, simulated_size_in_bytes);
225 sg_comm_t sg_mailbox_put_async(sg_mailbox_t mailbox, void* payload, long simulated_size_in_bytes)
227 auto comm = mailbox->put_async(payload, simulated_size_in_bytes);
232 sg_comm_t sg_mailbox_put_init(sg_mailbox_t mailbox, void* payload, long simulated_size_in_bytes)
234 auto comm = mailbox->put_init(payload, simulated_size_in_bytes);