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/s4u/Comm.hpp"
10 #include "simgrid/s4u/Mailbox.hpp"
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_comm, s4u_activity, "S4U asynchronous communications");
16 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Comm::on_sender_start;
17 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Comm::on_receiver_start;
18 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Comm::on_completion;
22 if (state_ == State::STARTED && not detached_ && (pimpl_ == nullptr || pimpl_->state_ == SIMIX_RUNNING)) {
23 XBT_INFO("Comm %p freed before its completion. Detached: %d, State: %d", this, detached_, (int)state_);
24 if (pimpl_ != nullptr)
25 XBT_INFO("pimpl_->state: %d", pimpl_->state_);
27 XBT_INFO("pimpl_ is null");
28 xbt_backtrace_display_current();
32 int Comm::wait_any_for(std::vector<CommPtr>* comms, double timeout)
34 std::unique_ptr<simgrid::kernel::activity::CommImpl* []> rcomms(
35 new simgrid::kernel::activity::CommImpl*[comms->size()]);
36 std::transform(begin(*comms), end(*comms), rcomms.get(), [](const CommPtr& comm) {
37 return static_cast<simgrid::kernel::activity::CommImpl*>(comm->pimpl_.get());
39 return simcall_comm_waitany(rcomms.get(), comms->size(), timeout);
42 void Comm::wait_all(std::vector<CommPtr>* comms)
44 // TODO: this should be a simcall or something
45 // TODO: we are missing a version with timeout
46 for (CommPtr comm : *comms)
50 CommPtr Comm::set_rate(double rate)
52 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
58 CommPtr Comm::set_src_data(void* buff)
60 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
62 xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
67 CommPtr Comm::set_src_data_size(size_t size)
69 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
71 src_buff_size_ = size;
75 CommPtr Comm::set_src_data(void* buff, size_t size)
77 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
80 xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
82 src_buff_size_ = size;
85 CommPtr Comm::set_dst_data(void** buff)
87 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
89 xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
94 size_t Comm::get_dst_data_size()
96 xbt_assert(state_ == State::FINISHED, "You cannot use %s before your communication terminated", __FUNCTION__);
97 return dst_buff_size_;
99 CommPtr Comm::set_dst_data(void** buff, size_t size)
101 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
104 xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
106 dst_buff_size_ = size;
112 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
115 if (src_buff_ != nullptr) { // Sender side
116 on_sender_start(Actor::self());
117 pimpl_ = simcall_comm_isend(sender_, mailbox_->get_impl(), remains_, rate_, src_buff_, src_buff_size_, match_fun_,
118 clean_fun_, copy_data_function_, user_data_, detached_);
119 } else if (dst_buff_ != nullptr) { // Receiver side
120 xbt_assert(not detached_, "Receive cannot be detached");
121 on_receiver_start(Actor::self());
122 pimpl_ = simcall_comm_irecv(receiver_, mailbox_->get_impl(), dst_buff_, &dst_buff_size_, match_fun_,
123 copy_data_function_, user_data_, rate_);
126 xbt_die("Cannot start a communication before specifying whether we are the sender or the receiver");
128 state_ = State::STARTED;
132 /** @brief Block the calling actor until the communication is finished */
135 return this->wait_for(-1);
138 /** @brief Block the calling actor until the communication is finished, or until timeout
140 * On timeout, an exception is thrown.
142 * @param timeout the amount of seconds to wait for the comm termination.
143 * Negative values denote infinite wait times. 0 as a timeout returns immediately. */
144 Comm* Comm::wait_for(double timeout)
147 case State::FINISHED:
150 case State::INITED: // It's not started yet. Do it in one simcall
151 if (src_buff_ != nullptr) {
152 on_sender_start(Actor::self());
153 simcall_comm_send(sender_, mailbox_->get_impl(), remains_, rate_, src_buff_, src_buff_size_, match_fun_,
154 copy_data_function_, user_data_, timeout);
157 on_receiver_start(Actor::self());
158 simcall_comm_recv(receiver_, mailbox_->get_impl(), dst_buff_, &dst_buff_size_, match_fun_, copy_data_function_,
159 user_data_, timeout, rate_);
161 state_ = State::FINISHED;
165 simcall_comm_wait(pimpl_, timeout);
166 on_completion(Actor::self());
167 state_ = State::FINISHED;
175 int Comm::test_any(std::vector<CommPtr>* comms)
177 std::unique_ptr<simgrid::kernel::activity::CommImpl* []> rcomms(
178 new simgrid::kernel::activity::CommImpl*[comms->size()]);
179 std::transform(begin(*comms), end(*comms), rcomms.get(), [](const CommPtr& comm) {
180 return static_cast<simgrid::kernel::activity::CommImpl*>(comm->pimpl_.get());
182 return simcall_comm_testany(rcomms.get(), comms->size());
187 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
189 xbt_assert(src_buff_ != nullptr && src_buff_size_ != 0, "You can only detach sends, not recvs");
196 simgrid::simix::simcall([this] { static_cast<kernel::activity::CommImpl*>(pimpl_.get())->cancel(); });
197 state_ = State::CANCELED;
203 xbt_assert(state_ == State::INITED || state_ == State::STARTED || state_ == State::FINISHED);
205 if (state_ == State::FINISHED)
208 if (state_ == State::INITED)
211 if (simcall_comm_test(pimpl_)) {
212 state_ = State::FINISHED;
218 MailboxPtr Comm::get_mailbox()
223 void intrusive_ptr_release(simgrid::s4u::Comm* c)
225 if (c->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
226 std::atomic_thread_fence(std::memory_order_acquire);
230 void intrusive_ptr_add_ref(simgrid::s4u::Comm* c)
232 c->refcount_.fetch_add(1, std::memory_order_relaxed);
235 } // namespace simgrid