1 /* Copyright (c) 2006-2021. 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 #include <simgrid/comm.h>
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_comm, s4u_activity, "S4U asynchronous communications");
19 xbt::signal<void(Comm const&, bool is_sender)> Comm::on_start;
20 xbt::signal<void(Comm const&)> Comm::on_completion;
24 if (state_ == State::STARTED && not detached_ &&
25 (pimpl_ == nullptr || pimpl_->state_ == kernel::activity::State::RUNNING)) {
26 XBT_INFO("Comm %p freed before its completion. Detached: %d, State: %d", this, detached_, (int)state_);
27 if (pimpl_ != nullptr)
28 XBT_INFO("pimpl_->state: %d", static_cast<int>(pimpl_->state_));
30 XBT_INFO("pimpl_ is null");
31 xbt_backtrace_display_current();
35 int Comm::wait_any_for(const std::vector<CommPtr>* comms, double timeout)
37 std::vector<kernel::activity::CommImpl*> rcomms(comms->size());
38 std::transform(begin(*comms), end(*comms), begin(rcomms),
39 [](const CommPtr& comm) { return static_cast<kernel::activity::CommImpl*>(comm->pimpl_.get()); });
40 int changed_pos = simcall_comm_waitany(rcomms.data(), rcomms.size(), timeout);
41 if (changed_pos != -1)
42 comms->at(changed_pos)->release_dependencies();
46 void Comm::wait_all(const std::vector<CommPtr>* comms)
48 // TODO: this should be a simcall or something
49 // TODO: we are missing a version with timeout
50 for (CommPtr comm : *comms)
54 CommPtr Comm::set_rate(double rate)
56 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
62 CommPtr Comm::set_src_data(void* buff)
64 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
66 xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
71 CommPtr Comm::set_src_data_size(size_t size)
73 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
75 src_buff_size_ = size;
79 CommPtr Comm::set_src_data(void* buff, size_t size)
81 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
84 xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
86 src_buff_size_ = size;
90 CommPtr Comm::set_dst_data(void** buff)
92 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
94 xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
98 void* Comm::get_dst_data()
103 size_t Comm::get_dst_data_size() const
105 return dst_buff_size_;
107 CommPtr Comm::set_dst_data(void** buff, size_t size)
109 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
112 xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
114 dst_buff_size_ = size;
118 CommPtr Comm::sendto_init(Host* from, Host* to)
120 CommPtr res(new Comm());
126 CommPtr Comm::sendto_async(Host* from, Host* to, double simulated_size_in_bytes)
128 auto res = Comm::sendto_init(from, to);
129 res->set_remaining(simulated_size_in_bytes)->start();
135 xbt_assert(get_state() == State::INITED || get_state() == State::STARTING,
136 "You cannot use %s() once your communication started (not implemented)", __FUNCTION__);
137 if (from_ != nullptr || to_ != nullptr) {
138 xbt_assert(from_ != nullptr && to_ != nullptr, "When either from_ or to_ is specified, both must be.");
139 xbt_assert(src_buff_ == nullptr && dst_buff_ == nullptr,
140 "Direct host-to-host communications cannot carry any data.");
141 pimpl_ = kernel::actor::simcall([this] {
142 auto res = new kernel::activity::CommImpl(this->from_, this->to_, this->get_remaining());
147 } else if (src_buff_ != nullptr) { // Sender side
148 on_start(*this, true /* is_sender*/);
149 pimpl_ = simcall_comm_isend(sender_, mailbox_->get_impl(), remains_, rate_, src_buff_, src_buff_size_, match_fun_,
150 clean_fun_, copy_data_function_, get_user_data(), detached_);
151 } else if (dst_buff_ != nullptr) { // Receiver side
152 xbt_assert(not detached_, "Receive cannot be detached");
153 on_start(*this, false /*is_sender*/);
154 pimpl_ = simcall_comm_irecv(receiver_, mailbox_->get_impl(), dst_buff_, &dst_buff_size_, match_fun_,
155 copy_data_function_, get_user_data(), rate_);
158 xbt_die("Cannot start a communication before specifying whether we are the sender or the receiver");
164 state_ = State::STARTED;
168 /** @brief Block the calling actor until the communication is finished */
171 return this->wait_for(-1);
174 /** @brief Block the calling actor until the communication is finished, or until timeout
176 * On timeout, an exception is thrown and the communication is invalidated.
178 * @param timeout the amount of seconds to wait for the comm termination.
179 * Negative values denote infinite wait times. 0 as a timeout returns immediately. */
180 Comm* Comm::wait_for(double timeout)
183 case State::FINISHED:
187 case State::STARTING: // It's not started yet. Do it in one simcall if it's a regular communication
188 if (from_ != nullptr || to_ != nullptr) {
189 return start()->wait_for(timeout); // In the case of host2host comm, do it in two simcalls
190 } else if (src_buff_ != nullptr) {
191 on_start(*this, true /*is_sender*/);
192 simcall_comm_send(sender_, mailbox_->get_impl(), remains_, rate_, src_buff_, src_buff_size_, match_fun_,
193 copy_data_function_, get_user_data(), timeout);
196 on_start(*this, false /*is_sender*/);
197 simcall_comm_recv(receiver_, mailbox_->get_impl(), dst_buff_, &dst_buff_size_, match_fun_, copy_data_function_,
198 get_user_data(), timeout, rate_);
200 state_ = State::FINISHED;
201 this->release_dependencies();
205 simcall_comm_wait(get_impl(), timeout);
206 state_ = State::FINISHED;
207 this->release_dependencies();
210 case State::CANCELED:
211 throw CancelException(XBT_THROW_POINT, "Communication canceled");
216 on_completion(*this);
220 int Comm::test_any(const std::vector<CommPtr>* comms)
222 std::vector<kernel::activity::CommImpl*> rcomms(comms->size());
223 std::transform(begin(*comms), end(*comms), begin(rcomms),
224 [](const CommPtr& comm) { return static_cast<kernel::activity::CommImpl*>(comm->pimpl_.get()); });
225 int changed_pos = simcall_comm_testany(rcomms.data(), rcomms.size());
226 if (changed_pos != -1)
227 comms->at(changed_pos)->release_dependencies();
233 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication is %s (not implemented)",
234 __FUNCTION__, get_state_str());
235 xbt_assert(dst_buff_ == nullptr && dst_buff_size_ == 0, "You can only detach sends, not recvs");
243 kernel::actor::simcall([this] {
245 boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->cancel();
247 state_ = State::CANCELED;
253 xbt_assert(state_ == State::INITED || state_ == State::STARTED || state_ == State::STARTING ||
254 state_ == State::FINISHED);
256 if (state_ == State::FINISHED)
259 if (state_ == State::INITED || state_ == State::STARTING)
260 this->vetoable_start();
262 if (simcall_comm_test(get_impl())) {
263 state_ = State::FINISHED;
264 this->release_dependencies();
270 Mailbox* Comm::get_mailbox() const
275 Actor* Comm::get_sender() const
277 kernel::actor::ActorImplPtr sender = nullptr;
279 sender = boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->src_actor_;
280 return sender ? sender->get_ciface() : nullptr;
284 } // namespace simgrid
285 /* **************************** Public C interface *************************** */
286 void sg_comm_detach(sg_comm_t comm, void (*clean_function)(void*))
288 comm->detach(clean_function);
291 void sg_comm_unref(sg_comm_t comm)
295 int sg_comm_test(sg_comm_t comm)
297 bool finished = comm->test();
303 sg_error_t sg_comm_wait(sg_comm_t comm)
305 sg_error_t status = SG_OK;
307 simgrid::s4u::CommPtr s4u_comm(comm, false);
309 s4u_comm->wait_for(-1);
310 } catch (const simgrid::TimeoutException&) {
311 status = SG_ERROR_TIMEOUT;
312 } catch (const simgrid::CancelException&) {
313 status = SG_ERROR_CANCELED;
314 } catch (const simgrid::NetworkFailureException&) {
315 status = SG_ERROR_NETWORK;
320 sg_error_t sg_comm_wait_for(sg_comm_t comm, double timeout)
322 sg_error_t status = SG_OK;
324 simgrid::s4u::CommPtr s4u_comm(comm, false);
326 s4u_comm->wait_for(timeout);
327 } catch (const simgrid::TimeoutException&) {
328 status = SG_ERROR_TIMEOUT;
329 } catch (const simgrid::CancelException&) {
330 status = SG_ERROR_CANCELED;
331 } catch (const simgrid::NetworkFailureException&) {
332 status = SG_ERROR_NETWORK;
337 void sg_comm_wait_all(sg_comm_t* comms, size_t count)
339 std::vector<simgrid::s4u::CommPtr> s4u_comms;
340 for (unsigned int i = 0; i < count; i++)
341 s4u_comms.emplace_back(comms[i], false);
343 simgrid::s4u::Comm::wait_all(&s4u_comms);
346 int sg_comm_wait_any(sg_comm_t* comms, size_t count)
348 return sg_comm_wait_any_for(comms, count, -1);
351 int sg_comm_wait_any_for(sg_comm_t* comms, size_t count, double timeout)
353 std::vector<simgrid::s4u::CommPtr> s4u_comms;
354 for (unsigned int i = 0; i < count; i++)
355 s4u_comms.emplace_back(comms[i], false);
357 int pos = simgrid::s4u::Comm::wait_any_for(&s4u_comms, timeout);
358 for (unsigned i = 0; i < count; i++) {
359 if (pos != -1 && static_cast<unsigned>(pos) != i)
360 s4u_comms[i]->add_ref();