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. Did you forget to detach it? (state: %s)", this, get_state_str());
27 if (pimpl_ != nullptr)
28 XBT_INFO("pimpl_->state: %s", pimpl_->get_state_str());
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 on_completion(*(comms->at(changed_pos)));
43 comms->at(changed_pos)->release_dependencies();
48 void Comm::wait_all(const std::vector<CommPtr>* comms)
50 // TODO: this should be a simcall or something
51 // TODO: we are missing a version with timeout
52 for (CommPtr comm : *comms)
56 CommPtr Comm::set_rate(double rate)
58 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
64 CommPtr Comm::set_src_data(void* buff)
66 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
68 xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
73 CommPtr Comm::set_src_data_size(size_t size)
75 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
77 src_buff_size_ = size;
81 CommPtr Comm::set_src_data(void* buff, size_t size)
83 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
86 xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
88 src_buff_size_ = size;
92 CommPtr Comm::set_dst_data(void** buff)
94 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
96 xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
100 void* Comm::get_dst_data()
105 size_t Comm::get_dst_data_size() const
107 return dst_buff_size_;
109 CommPtr Comm::set_dst_data(void** buff, size_t size)
111 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
114 xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
116 dst_buff_size_ = size;
119 CommPtr Comm::set_payload_size(double bytes)
121 Activity::set_remaining(bytes);
125 CommPtr Comm::sendto_init(Host* from, Host* to)
127 CommPtr res(new Comm());
134 CommPtr Comm::sendto_async(Host* from, Host* to, double simulated_size_in_bytes)
136 auto res = Comm::sendto_init(from, to)->set_payload_size(simulated_size_in_bytes);
137 res->vetoable_start();
143 xbt_assert(get_state() == State::INITED || get_state() == State::STARTING,
144 "You cannot use %s() once your communication started (not implemented)", __FUNCTION__);
145 if (from_ != nullptr || to_ != nullptr) {
146 xbt_assert(from_ != nullptr && to_ != nullptr, "When either from_ or to_ is specified, both must be.");
147 xbt_assert(src_buff_ == nullptr && dst_buff_ == nullptr,
148 "Direct host-to-host communications cannot carry any data.");
149 pimpl_ = kernel::actor::simcall([this] {
150 kernel::activity::CommImplPtr res(new kernel::activity::CommImpl(this->from_, this->to_, this->get_remaining()));
155 } else if (src_buff_ != nullptr) { // Sender side
156 on_start(*this, true /* is_sender*/);
157 pimpl_ = simcall_comm_isend(sender_, mailbox_->get_impl(), remains_, rate_, src_buff_, src_buff_size_, match_fun_,
158 clean_fun_, copy_data_function_, get_user_data(), detached_);
159 } else if (dst_buff_ != nullptr) { // Receiver side
160 xbt_assert(not detached_, "Receive cannot be detached");
161 on_start(*this, false /*is_sender*/);
162 pimpl_ = simcall_comm_irecv(receiver_, mailbox_->get_impl(), dst_buff_, &dst_buff_size_, match_fun_,
163 copy_data_function_, get_user_data(), rate_);
166 xbt_die("Cannot start a communication before specifying whether we are the sender or the receiver");
172 state_ = State::STARTED;
176 /** @brief Block the calling actor until the communication is finished */
179 return this->wait_for(-1);
182 /** @brief Block the calling actor until the communication is finished, or until timeout
184 * On timeout, an exception is thrown and the communication is invalidated.
186 * @param timeout the amount of seconds to wait for the comm termination.
187 * Negative values denote infinite wait times. 0 as a timeout returns immediately. */
188 Comm* Comm::wait_for(double timeout)
191 case State::FINISHED:
195 case State::STARTING: // It's not started yet. Do it in one simcall if it's a regular communication
196 if (from_ != nullptr || to_ != nullptr) {
197 return vetoable_start()->wait_for(timeout); // In the case of host2host comm, do it in two simcalls
198 } else if (src_buff_ != nullptr) {
199 on_start(*this, true /*is_sender*/);
200 simcall_comm_send(sender_, mailbox_->get_impl(), remains_, rate_, src_buff_, src_buff_size_, match_fun_,
201 copy_data_function_, get_user_data(), timeout);
204 on_start(*this, false /*is_sender*/);
205 simcall_comm_recv(receiver_, mailbox_->get_impl(), dst_buff_, &dst_buff_size_, match_fun_, copy_data_function_,
206 get_user_data(), timeout, rate_);
208 state_ = State::FINISHED;
209 this->release_dependencies();
213 simcall_comm_wait(get_impl(), timeout);
214 state_ = State::FINISHED;
215 this->release_dependencies();
218 case State::CANCELED:
219 throw CancelException(XBT_THROW_POINT, "Communication canceled");
224 on_completion(*this);
228 int Comm::test_any(const std::vector<CommPtr>* comms)
230 std::vector<kernel::activity::CommImpl*> rcomms(comms->size());
231 std::transform(begin(*comms), end(*comms), begin(rcomms),
232 [](const CommPtr& comm) { return static_cast<kernel::activity::CommImpl*>(comm->pimpl_.get()); });
233 int changed_pos = simcall_comm_testany(rcomms.data(), rcomms.size());
234 if (changed_pos != -1)
235 comms->at(changed_pos)->release_dependencies();
241 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication is %s (not implemented)",
242 __FUNCTION__, get_state_str());
243 xbt_assert(dst_buff_ == nullptr && dst_buff_size_ == 0, "You can only detach sends, not recvs");
251 kernel::actor::simcall([this] {
253 boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->cancel();
255 state_ = State::CANCELED;
261 xbt_assert(state_ == State::INITED || state_ == State::STARTED || state_ == State::STARTING ||
262 state_ == State::FINISHED);
264 if (state_ == State::FINISHED)
267 if (state_ == State::INITED || state_ == State::STARTING)
268 this->vetoable_start();
270 if (simcall_comm_test(get_impl())) {
271 state_ = State::FINISHED;
272 this->release_dependencies();
278 Mailbox* Comm::get_mailbox() const
283 Actor* Comm::get_sender() const
285 kernel::actor::ActorImplPtr sender = nullptr;
287 sender = boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->src_actor_;
288 return sender ? sender->get_ciface() : nullptr;
292 } // namespace simgrid
293 /* **************************** Public C interface *************************** */
294 void sg_comm_detach(sg_comm_t comm, void (*clean_function)(void*))
296 comm->detach(clean_function);
299 void sg_comm_unref(sg_comm_t comm)
303 int sg_comm_test(sg_comm_t comm)
305 bool finished = comm->test();
311 sg_error_t sg_comm_wait(sg_comm_t comm)
313 sg_error_t status = SG_OK;
315 simgrid::s4u::CommPtr s4u_comm(comm, false);
317 s4u_comm->wait_for(-1);
318 } catch (const simgrid::TimeoutException&) {
319 status = SG_ERROR_TIMEOUT;
320 } catch (const simgrid::CancelException&) {
321 status = SG_ERROR_CANCELED;
322 } catch (const simgrid::NetworkFailureException&) {
323 status = SG_ERROR_NETWORK;
328 sg_error_t sg_comm_wait_for(sg_comm_t comm, double timeout)
330 sg_error_t status = SG_OK;
332 simgrid::s4u::CommPtr s4u_comm(comm, false);
334 s4u_comm->wait_for(timeout);
335 } catch (const simgrid::TimeoutException&) {
336 status = SG_ERROR_TIMEOUT;
337 } catch (const simgrid::CancelException&) {
338 status = SG_ERROR_CANCELED;
339 } catch (const simgrid::NetworkFailureException&) {
340 status = SG_ERROR_NETWORK;
345 void sg_comm_wait_all(sg_comm_t* comms, size_t count)
347 std::vector<simgrid::s4u::CommPtr> s4u_comms;
348 for (unsigned int i = 0; i < count; i++)
349 s4u_comms.emplace_back(comms[i], false);
351 simgrid::s4u::Comm::wait_all(&s4u_comms);
354 int sg_comm_wait_any(sg_comm_t* comms, size_t count)
356 return sg_comm_wait_any_for(comms, count, -1);
359 int sg_comm_wait_any_for(sg_comm_t* comms, size_t count, double timeout)
361 std::vector<simgrid::s4u::CommPtr> s4u_comms;
362 for (unsigned int i = 0; i < count; i++)
363 s4u_comms.emplace_back(comms[i], false);
365 int pos = simgrid::s4u::Comm::wait_any_for(&s4u_comms, timeout);
366 for (unsigned i = 0; i < count; i++) {
367 if (pos != -1 && static_cast<unsigned>(pos) != i)
368 s4u_comms[i]->add_ref();