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"
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 = simix::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());
49 bool comm_ready = false;
50 if (not pimpl_->comm_queue_.empty()) {
51 comm_ready = pimpl_->comm_queue_.front()->state_ == SIMIX_DONE;
53 } else if (pimpl_->permanent_receiver_ && not pimpl_->done_comm_queue_.empty()) {
54 comm_ready = pimpl_->done_comm_queue_.front()->state_ == SIMIX_DONE;
59 kernel::activity::CommImplPtr Mailbox::front()
61 return pimpl_->comm_queue_.empty() ? nullptr : pimpl_->comm_queue_.front();
64 void Mailbox::set_receiver(ActorPtr actor)
66 simix::simcall([this, actor]() { this->pimpl_->set_receiver(actor); });
69 /** @brief get the receiver (process associated to the mailbox) */
70 ActorPtr Mailbox::get_receiver()
72 if (pimpl_->permanent_receiver_ == nullptr)
74 return pimpl_->permanent_receiver_->iface();
77 CommPtr Mailbox::put_init()
79 CommPtr res = CommPtr(new s4u::Comm());
80 res->sender_ = SIMIX_process_self();
84 s4u::CommPtr Mailbox::put_init(void* data, uint64_t simulated_size_in_bytes)
86 s4u::CommPtr res = put_init();
87 res->set_remaining(simulated_size_in_bytes);
88 res->src_buff_ = data;
89 res->src_buff_size_ = sizeof(void*);
92 s4u::CommPtr Mailbox::put_async(void* payload, uint64_t simulated_size_in_bytes)
94 xbt_assert(payload != nullptr, "You cannot send nullptr");
96 s4u::CommPtr res = put_init(payload, simulated_size_in_bytes);
100 void Mailbox::put(void* payload, uint64_t simulated_size_in_bytes)
102 xbt_assert(payload != nullptr, "You cannot send nullptr");
104 CommPtr c = put_init();
105 c->set_remaining(simulated_size_in_bytes);
106 c->set_src_data(payload);
109 /** Blocking send with timeout */
110 void Mailbox::put(void* payload, uint64_t simulated_size_in_bytes, double timeout)
112 xbt_assert(payload != nullptr, "You cannot send nullptr");
114 CommPtr c = put_init();
115 c->set_remaining(simulated_size_in_bytes);
116 c->set_src_data(payload);
117 // c->start() is optional.
118 c->wait_for(timeout);
121 s4u::CommPtr Mailbox::get_init()
123 CommPtr res = CommPtr(new s4u::Comm());
124 res->receiver_ = SIMIX_process_self();
125 res->mailbox_ = this;
128 s4u::CommPtr Mailbox::get_async(void** data)
130 s4u::CommPtr res = get_init();
131 res->set_dst_data(data, sizeof(*data));
139 CommPtr c = get_init();
140 c->set_dst_data(&res, sizeof(res));
144 void* Mailbox::get(double timeout)
147 CommPtr c = get_init();
148 c->set_dst_data(&res, sizeof(res));
149 c->wait_for(timeout);
153 smx_activity_t Mailbox::iprobe(int type, int (*match_fun)(void*, void*, kernel::activity::CommImpl*), void* data)
155 return simix::simcall([this, type, match_fun, data] { return pimpl_->iprobe(type, match_fun, data); });
158 } // namespace simgrid
160 /* **************************** Public C interface *************************** */
161 /** @brief Set the mailbox to receive in asynchronous mode
163 * All messages sent to this mailbox will be transferred to the receiver without waiting for the receive call.
164 * The receive call will still be necessary to use the received data.
165 * If there is a need to receive some messages asynchronously, and some not, two different mailboxes should be used.
167 * @param alias The name of the mailbox
169 void sg_mailbox_set_receiver(const char* alias)
171 simgrid::s4u::Mailbox::by_name(alias)->set_receiver(simgrid::s4u::Actor::self());
172 XBT_VERB("%s mailbox set to receive eagerly for myself\n", alias);
175 /** @brief Check if there is a communication going on in a mailbox.
177 * @param alias the name of the mailbox to be considered
178 * @return Returns 1 if there is a communication, 0 otherwise
180 int sg_mailbox_listen(const char* alias)
182 return simgrid::s4u::Mailbox::by_name(alias)->listen() ? 1 : 0;