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 "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 xbt::signal<void(Actor const&)> Comm::on_sender_start;
18 xbt::signal<void(Actor const&)> Comm::on_receiver_start;
19 xbt::signal<void(Actor const&)> Comm::on_completion;
23 if (state_ == State::STARTED && not detached_ &&
24 (pimpl_ == nullptr || pimpl_->state_ == kernel::activity::State::RUNNING)) {
25 XBT_INFO("Comm %p freed before its completion. Detached: %d, State: %d", this, detached_, (int)state_);
26 if (pimpl_ != nullptr)
27 XBT_INFO("pimpl_->state: %d", static_cast<int>(pimpl_->state_));
29 XBT_INFO("pimpl_ is null");
30 xbt_backtrace_display_current();
34 int Comm::wait_any_for(const std::vector<CommPtr>* comms, double timeout)
36 std::unique_ptr<kernel::activity::CommImpl* []> rcomms(new kernel::activity::CommImpl*[comms->size()]);
37 std::transform(begin(*comms), end(*comms), rcomms.get(),
38 [](const CommPtr& comm) { return static_cast<kernel::activity::CommImpl*>(comm->pimpl_.get()); });
39 int changed_pos = simcall_comm_waitany(rcomms.get(), comms->size(), timeout);
40 if (changed_pos != -1)
41 comms->at(changed_pos)->release_dependencies();
45 void Comm::wait_all(const std::vector<CommPtr>* comms)
47 // TODO: this should be a simcall or something
48 // TODO: we are missing a version with timeout
49 for (CommPtr comm : *comms)
53 CommPtr Comm::set_rate(double rate)
55 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
61 CommPtr Comm::set_src_data(void* buff)
63 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
65 xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
70 CommPtr Comm::set_src_data_size(size_t size)
72 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
74 src_buff_size_ = size;
78 CommPtr Comm::set_src_data(void* buff, size_t size)
80 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
83 xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
85 src_buff_size_ = size;
89 CommPtr Comm::set_dst_data(void** buff)
91 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
93 xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
98 size_t Comm::get_dst_data_size()
100 xbt_assert(state_ == State::FINISHED, "You cannot use %s before your communication terminated", __FUNCTION__);
101 return dst_buff_size_;
103 CommPtr Comm::set_dst_data(void** buff, size_t size)
105 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
108 xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
110 dst_buff_size_ = size;
114 CommPtr Comm::set_tracing_category(const std::string& category)
116 xbt_assert(state_ == State::INITED, "Cannot change the tracing category of an exec after its start");
117 tracing_category_ = category;
123 xbt_assert(get_state() == State::INITED || get_state() == State::STARTING,
124 "You cannot use %s() once your communication started (not implemented)", __FUNCTION__);
126 if (src_buff_ != nullptr) { // Sender side
127 on_sender_start(*Actor::self());
128 pimpl_ = simcall_comm_isend(sender_, mailbox_->get_impl(), remains_, rate_, src_buff_, src_buff_size_, match_fun_,
129 clean_fun_, copy_data_function_, get_user_data(), detached_);
130 } else if (dst_buff_ != nullptr) { // Receiver side
131 xbt_assert(not detached_, "Receive cannot be detached");
132 on_receiver_start(*Actor::self());
133 pimpl_ = simcall_comm_irecv(receiver_, mailbox_->get_impl(), dst_buff_, &dst_buff_size_, match_fun_,
134 copy_data_function_, get_user_data(), rate_);
137 xbt_die("Cannot start a communication before specifying whether we are the sender or the receiver");
139 state_ = State::STARTED;
143 /** @brief Block the calling actor until the communication is finished */
146 return this->wait_for(-1);
149 /** @brief Block the calling actor until the communication is finished, or until timeout
151 * On timeout, an exception is thrown and the communication is invalidated.
153 * @param timeout the amount of seconds to wait for the comm termination.
154 * Negative values denote infinite wait times. 0 as a timeout returns immediately. */
155 Comm* Comm::wait_for(double timeout)
158 case State::FINISHED:
162 case State::STARTING: // It's not started yet. Do it in one simcall
163 if (src_buff_ != nullptr) {
164 on_sender_start(*Actor::self());
165 simcall_comm_send(sender_, mailbox_->get_impl(), remains_, rate_, src_buff_, src_buff_size_, match_fun_,
166 copy_data_function_, get_user_data(), timeout);
169 on_receiver_start(*Actor::self());
170 simcall_comm_recv(receiver_, mailbox_->get_impl(), dst_buff_, &dst_buff_size_, match_fun_, copy_data_function_,
171 get_user_data(), timeout, rate_);
173 state_ = State::FINISHED;
174 this->release_dependencies();
178 simcall_comm_wait(pimpl_, timeout);
179 on_completion(*Actor::self());
180 state_ = State::FINISHED;
181 this->release_dependencies();
184 case State::CANCELED:
185 throw CancelException(XBT_THROW_POINT, "Communication canceled");
193 int Comm::test_any(const std::vector<CommPtr>* comms)
195 std::unique_ptr<kernel::activity::CommImpl* []> rcomms(new kernel::activity::CommImpl*[comms->size()]);
196 std::transform(begin(*comms), end(*comms), rcomms.get(),
197 [](const CommPtr& comm) { return static_cast<kernel::activity::CommImpl*>(comm->pimpl_.get()); });
198 int changed_pos = simcall_comm_testany(rcomms.get(), comms->size());
199 if (changed_pos != -1)
200 comms->at(changed_pos)->release_dependencies();
206 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
208 xbt_assert(src_buff_ != nullptr && src_buff_size_ != 0, "You can only detach sends, not recvs");
216 kernel::actor::simcall([this] {
218 boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->cancel();
220 state_ = State::CANCELED;
226 xbt_assert(state_ == State::INITED || state_ == State::STARTED || state_ == State::FINISHED);
228 if (state_ == State::FINISHED)
231 if (state_ == State::INITED || state_ == State::STARTING)
232 this->vetoable_start();
234 if (simcall_comm_test(pimpl_)) {
235 state_ = State::FINISHED;
236 this->release_dependencies();
242 Mailbox* Comm::get_mailbox()
247 Actor* Comm::get_sender()
249 return sender_ ? sender_->ciface() : nullptr;
253 } // namespace simgrid