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 "src/msg/msg_private.hpp"
9 #include "simgrid/Exception.hpp"
10 #include "simgrid/s4u/Comm.hpp"
11 #include "simgrid/s4u/Mailbox.hpp"
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_comm, s4u_activity, "S4U asynchronous communications");
17 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Comm::on_sender_start;
18 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Comm::on_receiver_start;
19 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Comm::on_completion;
23 if (state_ == State::STARTED && not detached_ && (pimpl_ == nullptr || pimpl_->state_ == SIMIX_RUNNING)) {
24 XBT_INFO("Comm %p freed before its completion. Detached: %d, State: %d", this, detached_, (int)state_);
25 if (pimpl_ != nullptr)
26 XBT_INFO("pimpl_->state: %d", pimpl_->state_);
28 XBT_INFO("pimpl_ is null");
29 xbt_backtrace_display_current();
33 int Comm::wait_any_for(std::vector<CommPtr>* comms, double timeout)
35 std::unique_ptr<simgrid::kernel::activity::CommImpl* []> rcomms(
36 new simgrid::kernel::activity::CommImpl*[comms->size()]);
37 std::transform(begin(*comms), end(*comms), rcomms.get(), [](const CommPtr& comm) {
38 return static_cast<simgrid::kernel::activity::CommImpl*>(comm->pimpl_.get());
40 return simcall_comm_waitany(rcomms.get(), comms->size(), timeout);
43 void Comm::wait_all(std::vector<CommPtr>* comms)
45 // TODO: this should be a simcall or something
46 // TODO: we are missing a version with timeout
47 for (CommPtr comm : *comms)
51 CommPtr Comm::set_rate(double rate)
53 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
59 CommPtr Comm::set_src_data(void* buff)
61 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
63 xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
68 CommPtr Comm::set_src_data_size(size_t size)
70 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
72 src_buff_size_ = size;
76 CommPtr Comm::set_src_data(void* buff, size_t size)
78 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
81 xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
83 src_buff_size_ = size;
86 CommPtr Comm::set_dst_data(void** buff)
88 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
90 xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
95 size_t Comm::get_dst_data_size()
97 xbt_assert(state_ == State::FINISHED, "You cannot use %s before your communication terminated", __FUNCTION__);
98 return dst_buff_size_;
100 CommPtr Comm::set_dst_data(void** buff, size_t size)
102 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
105 xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
107 dst_buff_size_ = size;
113 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
116 if (src_buff_ != nullptr) { // Sender side
117 on_sender_start(Actor::self());
118 pimpl_ = simcall_comm_isend(sender_, mailbox_->get_impl(), remains_, rate_, src_buff_, src_buff_size_, match_fun_,
119 clean_fun_, copy_data_function_, user_data_, detached_);
120 } else if (dst_buff_ != nullptr) { // Receiver side
121 xbt_assert(not detached_, "Receive cannot be detached");
122 on_receiver_start(Actor::self());
123 pimpl_ = simcall_comm_irecv(receiver_, mailbox_->get_impl(), dst_buff_, &dst_buff_size_, match_fun_,
124 copy_data_function_, user_data_, rate_);
127 xbt_die("Cannot start a communication before specifying whether we are the sender or the receiver");
129 state_ = State::STARTED;
133 /** @brief Block the calling actor until the communication is finished */
136 return this->wait_for(-1);
139 /** @brief Block the calling actor until the communication is finished, or until timeout
141 * On timeout, an exception is thrown.
143 * @param timeout the amount of seconds to wait for the comm termination.
144 * Negative values denote infinite wait times. 0 as a timeout returns immediately. */
145 Comm* Comm::wait_for(double timeout)
148 case State::FINISHED:
151 case State::INITED: // It's not started yet. Do it in one simcall
152 if (src_buff_ != nullptr) {
153 on_sender_start(Actor::self());
154 simcall_comm_send(sender_, mailbox_->get_impl(), remains_, rate_, src_buff_, src_buff_size_, match_fun_,
155 copy_data_function_, user_data_, timeout);
158 on_receiver_start(Actor::self());
159 simcall_comm_recv(receiver_, mailbox_->get_impl(), dst_buff_, &dst_buff_size_, match_fun_, copy_data_function_,
160 user_data_, timeout, rate_);
162 state_ = State::FINISHED;
166 simcall_comm_wait(pimpl_, timeout);
167 on_completion(Actor::self());
168 state_ = State::FINISHED;
171 case State::CANCELED:
172 throw CancelException(XBT_THROW_POINT, "Communication canceled");
179 int Comm::test_any(std::vector<CommPtr>* comms)
181 std::unique_ptr<simgrid::kernel::activity::CommImpl* []> rcomms(
182 new simgrid::kernel::activity::CommImpl*[comms->size()]);
183 std::transform(begin(*comms), end(*comms), rcomms.get(), [](const CommPtr& comm) {
184 return static_cast<simgrid::kernel::activity::CommImpl*>(comm->pimpl_.get());
186 return simcall_comm_testany(rcomms.get(), comms->size());
191 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
193 xbt_assert(src_buff_ != nullptr && src_buff_size_ != 0, "You can only detach sends, not recvs");
200 simgrid::simix::simcall([this] {
202 boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->cancel();
204 state_ = State::CANCELED;
210 xbt_assert(state_ == State::INITED || state_ == State::STARTED || state_ == State::FINISHED);
212 if (state_ == State::FINISHED)
215 if (state_ == State::INITED)
218 if (simcall_comm_test(pimpl_)) {
219 state_ = State::FINISHED;
225 Mailbox* Comm::get_mailbox()
230 ActorPtr Comm::get_sender()
232 return sender_ ? sender_->iface() : nullptr;
235 void intrusive_ptr_release(simgrid::s4u::Comm* c)
237 if (c->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
238 std::atomic_thread_fence(std::memory_order_acquire);
242 void intrusive_ptr_add_ref(simgrid::s4u::Comm* c)
244 c->refcount_.fetch_add(1, std::memory_order_relaxed);
247 } // namespace simgrid