1 /* Copyright (c) 2006-2023. 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. */
7 #include <simgrid/Exception.hpp>
8 #include <simgrid/comm.h>
9 #include <simgrid/s4u/Comm.hpp>
10 #include <simgrid/s4u/Engine.hpp>
11 #include <simgrid/s4u/Mailbox.hpp>
13 #include "src/kernel/activity/CommImpl.hpp"
14 #include "src/kernel/actor/ActorImpl.hpp"
15 #include "src/kernel/actor/SimcallObserver.hpp"
16 #include "src/mc/mc.h"
17 #include "src/mc/mc_replay.hpp"
19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_comm, s4u_activity, "S4U asynchronous communications");
21 namespace simgrid::s4u {
22 xbt::signal<void(Comm const&)> Comm::on_send;
23 xbt::signal<void(Comm const&)> Comm::on_recv;
25 CommPtr Comm::set_copy_data_callback(const std::function<void(kernel::activity::CommImpl*, void*, size_t)>& callback)
27 copy_data_function_ = callback;
31 void Comm::copy_buffer_callback(kernel::activity::CommImpl* comm, void* buff,
32 size_t buff_size) // XBT_ATTRIB_DEPRECATED_v337
34 XBT_DEBUG("Copy the data over");
35 memcpy(comm->dst_buff_, buff, buff_size);
36 if (comm->is_detached()) { // if this is a detached send, the source buffer was duplicated by SMPI sender to make the
37 // original buffer available to the application ASAP
39 comm->src_buff_ = nullptr;
43 void Comm::copy_pointer_callback(kernel::activity::CommImpl* comm, void* buff,
44 size_t buff_size) // XBT_ATTRIB_DEPRECATED_v337
46 xbt_assert((buff_size == sizeof(void*)), "Cannot copy %zu bytes: must be sizeof(void*)", buff_size);
47 *(void**)(comm->dst_buff_) = buff;
52 if (state_ == State::STARTED && not detached_ &&
53 (pimpl_ == nullptr || pimpl_->get_state() == kernel::activity::State::RUNNING)) {
54 XBT_INFO("Comm %p freed before its completion. Did you forget to detach it? (state: %s)", this, get_state_str());
55 if (pimpl_ != nullptr)
56 XBT_INFO("pimpl_->state: %s", pimpl_->get_state_str());
58 XBT_INFO("pimpl_ is null");
59 xbt_backtrace_display_current();
61 if (pimpl_ != nullptr)
62 pimpl_->set_iface(nullptr);
65 void Comm::send(kernel::actor::ActorImpl* sender, const Mailbox* mbox, double task_size, double rate, void* src_buff,
67 const std::function<bool(void*, void*, simgrid::kernel::activity::CommImpl*)>& match_fun,
68 const std::function<void(simgrid::kernel::activity::CommImpl*, void*, size_t)>& copy_data_fun,
69 void* data, double timeout)
71 /* checking for infinite values */
72 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
73 xbt_assert(std::isfinite(rate), "rate is not finite!");
74 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
76 xbt_assert(mbox, "No rendez-vous point defined for send");
78 if (MC_is_active() || MC_record_replay_is_active()) {
79 /* the model-checker wants two separate simcalls, and wants comm to be nullptr during the simcall */
80 simgrid::kernel::activity::ActivityImplPtr comm = nullptr;
82 simgrid::kernel::actor::CommIsendSimcall send_observer{
83 sender, mbox->get_impl(), task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size, match_fun,
84 nullptr, copy_data_fun, data, false};
85 comm = simgrid::kernel::actor::simcall_answered(
86 [&send_observer] { return simgrid::kernel::activity::CommImpl::isend(&send_observer); }, &send_observer);
88 if (simgrid::kernel::actor::ActivityWaitSimcall wait_observer{sender, comm.get(), timeout};
89 simgrid::kernel::actor::simcall_blocking(
91 wait_observer.get_activity()->wait_for(wait_observer.get_issuer(), wait_observer.get_timeout());
94 throw simgrid::TimeoutException(XBT_THROW_POINT, "Timeouted");
98 simgrid::kernel::actor::CommIsendSimcall observer(sender, mbox->get_impl(), task_size, rate,
99 static_cast<unsigned char*>(src_buff), src_buff_size, match_fun,
100 nullptr, copy_data_fun, data, false);
101 simgrid::kernel::actor::simcall_blocking([&observer, timeout] {
102 simgrid::kernel::activity::ActivityImplPtr comm = simgrid::kernel::activity::CommImpl::isend(&observer);
103 comm->wait_for(observer.get_issuer(), timeout);
108 void Comm::recv(kernel::actor::ActorImpl* receiver, const Mailbox* mbox, void* dst_buff, size_t* dst_buff_size,
109 const std::function<bool(void*, void*, simgrid::kernel::activity::CommImpl*)>& match_fun,
110 const std::function<void(simgrid::kernel::activity::CommImpl*, void*, size_t)>& copy_data_fun,
111 void* data, double timeout, double rate)
113 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
114 xbt_assert(mbox, "No rendez-vous point defined for recv");
116 if (MC_is_active() || MC_record_replay_is_active()) {
117 /* the model-checker wants two separate simcalls, and wants comm to be nullptr during the simcall */
118 simgrid::kernel::activity::ActivityImplPtr comm = nullptr;
120 simgrid::kernel::actor::CommIrecvSimcall observer{receiver,
122 static_cast<unsigned char*>(dst_buff),
128 comm = simgrid::kernel::actor::simcall_answered(
129 [&observer] { return simgrid::kernel::activity::CommImpl::irecv(&observer); }, &observer);
131 if (simgrid::kernel::actor::ActivityWaitSimcall wait_observer{receiver, comm.get(), timeout};
132 simgrid::kernel::actor::simcall_blocking(
134 wait_observer.get_activity()->wait_for(wait_observer.get_issuer(), wait_observer.get_timeout());
137 throw simgrid::TimeoutException(XBT_THROW_POINT, "Timeouted");
141 simgrid::kernel::actor::CommIrecvSimcall observer(receiver, mbox->get_impl(), static_cast<unsigned char*>(dst_buff),
142 dst_buff_size, match_fun, copy_data_fun, data, rate);
143 simgrid::kernel::actor::simcall_blocking([&observer, timeout] {
144 simgrid::kernel::activity::ActivityImplPtr comm = simgrid::kernel::activity::CommImpl::irecv(&observer);
145 comm->wait_for(observer.get_issuer(), timeout);
150 CommPtr Comm::sendto_init()
152 CommPtr res(new Comm());
153 res->pimpl_ = kernel::activity::CommImplPtr(new kernel::activity::CommImpl());
154 boost::static_pointer_cast<kernel::activity::CommImpl>(res->pimpl_)->detach();
155 res->sender_ = kernel::actor::ActorImpl::self();
159 CommPtr Comm::sendto_init(Host* from, Host* to)
161 auto res = Comm::sendto_init()->set_source(from)->set_destination(to);
162 res->set_state(State::STARTING);
166 CommPtr Comm::sendto_async(Host* from, Host* to, uint64_t simulated_size_in_bytes)
168 return Comm::sendto_init()->set_payload_size(simulated_size_in_bytes)->set_source(from)->set_destination(to);
171 void Comm::sendto(Host* from, Host* to, uint64_t simulated_size_in_bytes)
173 sendto_async(from, to, simulated_size_in_bytes)->wait();
176 CommPtr Comm::set_source(Host* from)
178 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
179 "Cannot change the source of a Comm once it's started (state: %s)", to_c_str(state_));
180 boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->set_source(from);
181 // Setting 'source' may allow to start the activity, let's try
182 if (state_ == State::STARTING && remains_ <= 0)
183 XBT_DEBUG("This communication has a payload size of 0 byte. It cannot start yet");
189 Host* Comm::get_source() const
191 return pimpl_ ? boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->get_source() : nullptr;
194 CommPtr Comm::set_destination(Host* to)
196 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
197 "Cannot change the destination of a Comm once it's started (state: %s)", to_c_str(state_));
198 boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->set_destination(to);
199 // Setting 'destination' may allow to start the activity, let's try
200 if (state_ == State::STARTING && remains_ <= 0)
201 XBT_DEBUG("This communication has a payload size of 0 byte. It cannot start yet");
208 Host* Comm::get_destination() const
210 return pimpl_ ? boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->get_destination() : nullptr;
213 CommPtr Comm::set_rate(double rate)
215 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
221 CommPtr Comm::set_mailbox(Mailbox* mailbox)
223 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
229 CommPtr Comm::set_src_data(void* buff)
231 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
233 xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
238 CommPtr Comm::set_src_data_size(size_t size)
240 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
242 src_buff_size_ = size;
246 CommPtr Comm::set_src_data(void* buff, size_t size)
248 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
251 xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
253 src_buff_size_ = size;
257 CommPtr Comm::set_dst_data(void** buff)
259 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
261 xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
266 CommPtr Comm::set_dst_data(void** buff, size_t size)
268 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
271 xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
273 dst_buff_size_ = size;
277 CommPtr Comm::set_payload_size(uint64_t bytes)
279 set_remaining(bytes);
281 boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->set_size(bytes);
286 Actor* Comm::get_sender() const
288 kernel::actor::ActorImplPtr sender = nullptr;
290 sender = boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->src_actor_;
291 return sender ? sender->get_ciface() : nullptr;
294 Actor* Comm::get_receiver() const
296 kernel::actor::ActorImplPtr receiver = nullptr;
298 receiver = boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->dst_actor_;
299 return receiver ? receiver->get_ciface() : nullptr;
302 bool Comm::is_assigned() const
304 return (pimpl_ && boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->is_assigned()) ||
308 Comm* Comm::do_start()
310 xbt_assert(get_state() == State::INITED || get_state() == State::STARTING,
311 "You cannot use %s() once your communication started (not implemented)", __FUNCTION__);
312 if (get_source() != nullptr || get_destination() != nullptr) {
313 xbt_assert(is_assigned(), "When either from_ or to_ is specified, both must be.");
314 xbt_assert(src_buff_ == nullptr && dst_buff_ == nullptr,
315 "Direct host-to-host communications cannot carry any data.");
316 XBT_DEBUG("host-to-host Comm. Pimpl already created and set, just start it.");
318 on_this_start(*this);
319 kernel::actor::simcall_answered([this] {
320 pimpl_->set_state(kernel::activity::State::READY);
321 boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->start();
323 } else if (src_buff_ != nullptr) { // Sender side
326 kernel::actor::CommIsendSimcall observer{sender_,
327 mailbox_->get_impl(),
330 static_cast<unsigned char*>(src_buff_),
337 pimpl_ = kernel::actor::simcall_answered([&observer] { return kernel::activity::CommImpl::isend(&observer); },
339 } else if (dst_buff_ != nullptr) { // Receiver side
340 xbt_assert(not detached_, "Receive cannot be detached");
343 kernel::actor::CommIrecvSimcall observer{receiver_,
344 mailbox_->get_impl(),
345 static_cast<unsigned char*>(dst_buff_),
351 pimpl_ = kernel::actor::simcall_answered([&observer] { return kernel::activity::CommImpl::irecv(&observer); },
354 xbt_die("Cannot start a communication before specifying whether we are the sender or the receiver");
361 pimpl_->set_iface(this);
362 pimpl_->set_actor(sender_);
363 // Only throw the signal when both sides are here and the status is READY
364 if (pimpl_->get_state() != kernel::activity::State::WAITING) {
366 on_this_start(*this);
370 state_ = State::STARTED;
376 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
377 "You cannot use %s() once your communication is %s (not implemented)", __FUNCTION__, get_state_str());
378 xbt_assert(dst_buff_ == nullptr && dst_buff_size_ == 0, "You can only detach sends, not recvs");
384 ssize_t Comm::test_any(const std::vector<CommPtr>& comms)
386 std::vector<ActivityPtr> activities;
387 for (const auto& comm : comms)
388 activities.push_back(boost::dynamic_pointer_cast<Activity>(comm));
389 return Activity::test_any(activities);
392 /** @brief Block the calling actor until the communication is finished, or until timeout
394 * On timeout, an exception is thrown and the communication is invalidated.
396 * @param timeout the amount of seconds to wait for the comm termination.
397 * Negative values denote infinite wait times. 0 as a timeout returns immediately. */
398 Comm* Comm::wait_for(double timeout)
400 XBT_DEBUG("Calling Comm::wait_for with state %s", get_state_str());
401 kernel::actor::ActorImpl* issuer = nullptr;
403 case State::FINISHED:
406 throw NetworkFailureException(XBT_THROW_POINT, "Cannot wait for a failed communication");
408 case State::STARTING: // It's not started yet. Do it in one simcall if it's a regular communication
409 if (get_source() != nullptr || get_destination() != nullptr) {
410 return start()->wait_for(timeout); // In the case of host2host comm, do it in two simcalls
411 } else if (src_buff_ != nullptr) {
414 send(sender_, mailbox_, remains_, rate_, src_buff_, src_buff_size_, match_fun_, copy_data_function_,
415 get_data<void>(), timeout);
420 recv(receiver_, mailbox_, dst_buff_, &dst_buff_size_, match_fun_, copy_data_function_, get_data<void>(),
426 issuer = kernel::actor::ActorImpl::self();
427 kernel::actor::ActivityWaitSimcall observer{issuer, pimpl_.get(), timeout};
428 if (kernel::actor::simcall_blocking(
429 [&observer] { observer.get_activity()->wait_for(observer.get_issuer(), observer.get_timeout()); },
431 throw TimeoutException(XBT_THROW_POINT, "Timeouted");
433 } catch (const NetworkFailureException& e) {
434 issuer->simcall_.observer_ = nullptr; // Comm failed on network failure, reset the observer to nullptr
435 complete(State::FAILED);
436 e.rethrow_nested(XBT_THROW_POINT, boost::core::demangle(typeid(e).name()) + " raised in kernel mode.");
440 case State::CANCELED:
441 throw CancelException(XBT_THROW_POINT, "Communication canceled");
446 complete(State::FINISHED);
450 ssize_t Comm::wait_any_for(const std::vector<CommPtr>& comms, double timeout)
452 std::vector<ActivityPtr> activities;
453 for (const auto& comm : comms)
454 activities.push_back(boost::dynamic_pointer_cast<Activity>(comm));
457 changed_pos = Activity::wait_any_for(activities, timeout);
458 } catch (const NetworkFailureException& e) {
460 for (auto c : comms) {
461 if (c->pimpl_->get_state() == kernel::activity::State::FAILED) {
462 c->complete(State::FAILED);
465 e.rethrow_nested(XBT_THROW_POINT, boost::core::demangle(typeid(e).name()) + " raised in kernel mode.");
470 void Comm::wait_all(const std::vector<CommPtr>& comms)
472 // TODO: this should be a simcall or something
473 for (auto& comm : comms)
477 size_t Comm::wait_all_for(const std::vector<CommPtr>& comms, double timeout)
484 double deadline = Engine::get_clock() + timeout;
485 std::vector<CommPtr> waited_comm(1, nullptr);
486 for (size_t i = 0; i < comms.size(); i++) {
487 double wait_timeout = std::max(0.0, deadline - Engine::get_clock());
488 waited_comm[0] = comms[i];
489 // Using wait_any_for() here (and not wait_for) because we don't want comms to be invalidated on timeout
490 if (wait_any_for(waited_comm, wait_timeout) == -1) {
491 XBT_DEBUG("Timeout (%g): i = %zu", wait_timeout, i);
497 } // namespace simgrid::s4u
498 /* **************************** Public C interface *************************** */
499 void sg_comm_detach(sg_comm_t comm, void (*clean_function)(void*))
501 comm->detach(clean_function);
504 void sg_comm_unref(sg_comm_t comm)
508 int sg_comm_test(sg_comm_t comm)
510 bool finished = comm->test();
516 sg_error_t sg_comm_wait(sg_comm_t comm)
518 return sg_comm_wait_for(comm, -1);
521 sg_error_t sg_comm_wait_for(sg_comm_t comm, double timeout)
523 sg_error_t status = SG_OK;
525 simgrid::s4u::CommPtr s4u_comm(comm, false);
527 s4u_comm->wait_for(timeout);
528 } catch (const simgrid::TimeoutException&) {
529 status = SG_ERROR_TIMEOUT;
530 } catch (const simgrid::CancelException&) {
531 status = SG_ERROR_CANCELED;
532 } catch (const simgrid::NetworkFailureException&) {
533 status = SG_ERROR_NETWORK;
538 void sg_comm_wait_all(sg_comm_t* comms, size_t count)
540 sg_comm_wait_all_for(comms, count, -1);
543 size_t sg_comm_wait_all_for(sg_comm_t* comms, size_t count, double timeout)
545 std::vector<simgrid::s4u::CommPtr> s4u_comms;
546 for (size_t i = 0; i < count; i++)
547 s4u_comms.emplace_back(comms[i], false);
549 size_t pos = simgrid::s4u::Comm::wait_all_for(s4u_comms, timeout);
550 for (size_t i = pos; i < count; i++)
551 s4u_comms[i]->add_ref();
555 ssize_t sg_comm_wait_any(sg_comm_t* comms, size_t count)
557 return sg_comm_wait_any_for(comms, count, -1);
560 ssize_t sg_comm_wait_any_for(sg_comm_t* comms, size_t count, double timeout)
562 std::vector<simgrid::s4u::CommPtr> s4u_comms;
563 for (size_t i = 0; i < count; i++)
564 s4u_comms.emplace_back(comms[i], false);
566 ssize_t pos = simgrid::s4u::Comm::wait_any_for(s4u_comms, timeout);
567 for (size_t i = 0; i < count; i++) {
568 if (pos != -1 && static_cast<size_t>(pos) != i)
569 s4u_comms[i]->add_ref();