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();
63 void Comm::send(kernel::actor::ActorImpl* sender, const Mailbox* mbox, double task_size, double rate, void* src_buff,
65 const std::function<bool(void*, void*, simgrid::kernel::activity::CommImpl*)>& match_fun,
66 const std::function<void(simgrid::kernel::activity::CommImpl*, void*, size_t)>& copy_data_fun,
67 void* data, double timeout)
69 /* checking for infinite values */
70 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
71 xbt_assert(std::isfinite(rate), "rate is not finite!");
72 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
74 xbt_assert(mbox, "No rendez-vous point defined for send");
76 if (MC_is_active() || MC_record_replay_is_active()) {
77 /* the model-checker wants two separate simcalls, and wants comm to be nullptr during the simcall */
78 simgrid::kernel::activity::ActivityImplPtr comm = nullptr;
80 simgrid::kernel::actor::CommIsendSimcall send_observer{
81 sender, mbox->get_impl(), task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size, match_fun,
82 nullptr, copy_data_fun, data, false};
83 comm = simgrid::kernel::actor::simcall_answered(
84 [&send_observer] { return simgrid::kernel::activity::CommImpl::isend(&send_observer); }, &send_observer);
86 if (simgrid::kernel::actor::ActivityWaitSimcall wait_observer{sender, comm.get(), timeout};
87 simgrid::kernel::actor::simcall_blocking(
89 wait_observer.get_activity()->wait_for(wait_observer.get_issuer(), wait_observer.get_timeout());
92 throw simgrid::TimeoutException(XBT_THROW_POINT, "Timeouted");
96 simgrid::kernel::actor::CommIsendSimcall observer(sender, mbox->get_impl(), task_size, rate,
97 static_cast<unsigned char*>(src_buff), src_buff_size, match_fun,
98 nullptr, copy_data_fun, data, false);
99 simgrid::kernel::actor::simcall_blocking([&observer, timeout] {
100 simgrid::kernel::activity::ActivityImplPtr comm = simgrid::kernel::activity::CommImpl::isend(&observer);
101 comm->wait_for(observer.get_issuer(), timeout);
106 void Comm::recv(kernel::actor::ActorImpl* receiver, const Mailbox* mbox, void* dst_buff, size_t* dst_buff_size,
107 const std::function<bool(void*, void*, simgrid::kernel::activity::CommImpl*)>& match_fun,
108 const std::function<void(simgrid::kernel::activity::CommImpl*, void*, size_t)>& copy_data_fun,
109 void* data, double timeout, double rate)
111 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
112 xbt_assert(mbox, "No rendez-vous point defined for recv");
114 if (MC_is_active() || MC_record_replay_is_active()) {
115 /* the model-checker wants two separate simcalls, and wants comm to be nullptr during the simcall */
116 simgrid::kernel::activity::ActivityImplPtr comm = nullptr;
118 simgrid::kernel::actor::CommIrecvSimcall observer{receiver,
120 static_cast<unsigned char*>(dst_buff),
126 comm = simgrid::kernel::actor::simcall_answered(
127 [&observer] { return simgrid::kernel::activity::CommImpl::irecv(&observer); }, &observer);
129 if (simgrid::kernel::actor::ActivityWaitSimcall wait_observer{receiver, comm.get(), timeout};
130 simgrid::kernel::actor::simcall_blocking(
132 wait_observer.get_activity()->wait_for(wait_observer.get_issuer(), wait_observer.get_timeout());
135 throw simgrid::TimeoutException(XBT_THROW_POINT, "Timeouted");
139 simgrid::kernel::actor::CommIrecvSimcall observer(receiver, mbox->get_impl(), static_cast<unsigned char*>(dst_buff),
140 dst_buff_size, match_fun, copy_data_fun, data, rate);
141 simgrid::kernel::actor::simcall_blocking([&observer, timeout] {
142 simgrid::kernel::activity::ActivityImplPtr comm = simgrid::kernel::activity::CommImpl::irecv(&observer);
143 comm->wait_for(observer.get_issuer(), timeout);
148 CommPtr Comm::sendto_init()
150 CommPtr res(new Comm());
151 res->pimpl_ = kernel::activity::CommImplPtr(new kernel::activity::CommImpl());
152 boost::static_pointer_cast<kernel::activity::CommImpl>(res->pimpl_)->detach();
153 res->sender_ = kernel::actor::ActorImpl::self();
157 CommPtr Comm::sendto_init(Host* from, Host* to)
159 auto res = Comm::sendto_init()->set_source(from)->set_destination(to);
160 res->set_state(State::STARTING);
164 CommPtr Comm::sendto_async(Host* from, Host* to, uint64_t simulated_size_in_bytes)
166 return Comm::sendto_init()->set_payload_size(simulated_size_in_bytes)->set_source(from)->set_destination(to);
169 void Comm::sendto(Host* from, Host* to, uint64_t simulated_size_in_bytes)
171 sendto_async(from, to, simulated_size_in_bytes)->wait();
174 CommPtr Comm::set_source(Host* from)
176 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
177 "Cannot change the source of a Comm once it's started (state: %s)", to_c_str(state_));
178 boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->set_source(from);
179 // Setting 'source' may allow to start the activity, let's try
180 if (state_ == State::STARTING && remains_ <= 0)
181 XBT_DEBUG("This communication has a payload size of 0 byte. It cannot start yet");
187 Host* Comm::get_source() const
189 return pimpl_ ? boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->get_source() : nullptr;
192 CommPtr Comm::set_destination(Host* to)
194 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
195 "Cannot change the destination of a Comm once it's started (state: %s)", to_c_str(state_));
196 boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->set_destination(to);
197 // Setting 'destination' may allow to start the activity, let's try
198 if (state_ == State::STARTING && remains_ <= 0)
199 XBT_DEBUG("This communication has a payload size of 0 byte. It cannot start yet");
206 Host* Comm::get_destination() const
208 return pimpl_ ? boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->get_destination() : nullptr;
211 CommPtr Comm::set_rate(double rate)
213 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
219 CommPtr Comm::set_mailbox(Mailbox* mailbox)
221 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
227 CommPtr Comm::set_src_data(void* buff)
229 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
231 xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
236 CommPtr Comm::set_src_data_size(size_t size)
238 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
240 src_buff_size_ = size;
244 CommPtr Comm::set_src_data(void* buff, size_t size)
246 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
249 xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
251 src_buff_size_ = size;
255 CommPtr Comm::set_dst_data(void** buff)
257 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
259 xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
264 CommPtr Comm::set_dst_data(void** buff, size_t size)
266 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
269 xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
271 dst_buff_size_ = size;
275 CommPtr Comm::set_payload_size(uint64_t bytes)
277 set_remaining(bytes);
279 boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->set_size(bytes);
284 Actor* Comm::get_sender() const
286 kernel::actor::ActorImplPtr sender = nullptr;
288 sender = boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->src_actor_;
289 return sender ? sender->get_ciface() : nullptr;
292 Actor* Comm::get_receiver() const
294 kernel::actor::ActorImplPtr receiver = nullptr;
296 receiver = boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->dst_actor_;
297 return receiver ? receiver->get_ciface() : nullptr;
300 bool Comm::is_assigned() const
302 return (pimpl_ && boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->is_assigned()) ||
306 Comm* Comm::do_start()
308 xbt_assert(get_state() == State::INITED || get_state() == State::STARTING,
309 "You cannot use %s() once your communication started (not implemented)", __FUNCTION__);
310 if (get_source() != nullptr || get_destination() != nullptr) {
311 xbt_assert(is_assigned(), "When either from_ or to_ is specified, both must be.");
312 xbt_assert(src_buff_ == nullptr && dst_buff_ == nullptr,
313 "Direct host-to-host communications cannot carry any data.");
314 XBT_DEBUG("host-to-host Comm. Pimpl already created and set, just start it.");
316 on_this_start(*this);
317 kernel::actor::simcall_answered([this] {
318 pimpl_->set_state(kernel::activity::State::READY);
319 boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->start();
321 } else if (src_buff_ != nullptr) { // Sender side
324 kernel::actor::CommIsendSimcall observer{sender_,
325 mailbox_->get_impl(),
328 static_cast<unsigned char*>(src_buff_),
335 pimpl_ = kernel::actor::simcall_answered([&observer] { return kernel::activity::CommImpl::isend(&observer); },
337 } else if (dst_buff_ != nullptr) { // Receiver side
338 xbt_assert(not detached_, "Receive cannot be detached");
341 kernel::actor::CommIrecvSimcall observer{receiver_,
342 mailbox_->get_impl(),
343 static_cast<unsigned char*>(dst_buff_),
349 pimpl_ = kernel::actor::simcall_answered([&observer] { return kernel::activity::CommImpl::irecv(&observer); },
352 xbt_die("Cannot start a communication before specifying whether we are the sender or the receiver");
359 pimpl_->set_iface(this);
360 pimpl_->set_actor(sender_);
361 // Only throw the signal when both sides are here and the status is READY
362 if (pimpl_->get_state() != kernel::activity::State::WAITING) {
364 on_this_start(*this);
368 state_ = State::STARTED;
374 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
375 "You cannot use %s() once your communication is %s (not implemented)", __FUNCTION__, get_state_str());
376 xbt_assert(dst_buff_ == nullptr && dst_buff_size_ == 0, "You can only detach sends, not recvs");
382 ssize_t Comm::test_any(const std::vector<CommPtr>& comms)
384 std::vector<ActivityPtr> activities;
385 for (const auto& comm : comms)
386 activities.push_back(boost::dynamic_pointer_cast<Activity>(comm));
387 return Activity::test_any(activities);
390 /** @brief Block the calling actor until the communication is finished, or until timeout
392 * On timeout, an exception is thrown and the communication is invalidated.
394 * @param timeout the amount of seconds to wait for the comm termination.
395 * Negative values denote infinite wait times. 0 as a timeout returns immediately. */
396 Comm* Comm::wait_for(double timeout)
398 XBT_DEBUG("Calling Comm::wait_for with state %s", get_state_str());
399 kernel::actor::ActorImpl* issuer = nullptr;
401 case State::FINISHED:
404 throw NetworkFailureException(XBT_THROW_POINT, "Cannot wait for a failed communication");
406 case State::STARTING: // It's not started yet. Do it in one simcall if it's a regular communication
407 if (get_source() != nullptr || get_destination() != nullptr) {
408 return start()->wait_for(timeout); // In the case of host2host comm, do it in two simcalls
409 } else if (src_buff_ != nullptr) {
412 send(sender_, mailbox_, remains_, rate_, src_buff_, src_buff_size_, match_fun_, copy_data_function_,
413 get_data<void>(), timeout);
418 recv(receiver_, mailbox_, dst_buff_, &dst_buff_size_, match_fun_, copy_data_function_, get_data<void>(),
424 issuer = kernel::actor::ActorImpl::self();
425 kernel::actor::ActivityWaitSimcall observer{issuer, pimpl_.get(), timeout};
426 if (kernel::actor::simcall_blocking(
427 [&observer] { observer.get_activity()->wait_for(observer.get_issuer(), observer.get_timeout()); },
429 throw TimeoutException(XBT_THROW_POINT, "Timeouted");
431 } catch (const NetworkFailureException& e) {
432 issuer->simcall_.observer_ = nullptr; // Comm failed on network failure, reset the observer to nullptr
433 complete(State::FAILED);
434 e.rethrow_nested(XBT_THROW_POINT, boost::core::demangle(typeid(e).name()) + " raised in kernel mode.");
438 case State::CANCELED:
439 throw CancelException(XBT_THROW_POINT, "Communication canceled");
444 complete(State::FINISHED);
448 ssize_t Comm::wait_any_for(const std::vector<CommPtr>& comms, double timeout)
450 std::vector<ActivityPtr> activities;
451 for (const auto& comm : comms)
452 activities.push_back(boost::dynamic_pointer_cast<Activity>(comm));
455 changed_pos = Activity::wait_any_for(activities, timeout);
456 } catch (const NetworkFailureException& e) {
458 for (auto c : comms) {
459 if (c->pimpl_->get_state() == kernel::activity::State::FAILED) {
460 c->complete(State::FAILED);
463 e.rethrow_nested(XBT_THROW_POINT, boost::core::demangle(typeid(e).name()) + " raised in kernel mode.");
468 void Comm::wait_all(const std::vector<CommPtr>& comms)
470 // TODO: this should be a simcall or something
471 for (auto& comm : comms)
475 size_t Comm::wait_all_for(const std::vector<CommPtr>& comms, double timeout)
482 double deadline = Engine::get_clock() + timeout;
483 std::vector<CommPtr> waited_comm(1, nullptr);
484 for (size_t i = 0; i < comms.size(); i++) {
485 double wait_timeout = std::max(0.0, deadline - Engine::get_clock());
486 waited_comm[0] = comms[i];
487 // Using wait_any_for() here (and not wait_for) because we don't want comms to be invalidated on timeout
488 if (wait_any_for(waited_comm, wait_timeout) == -1) {
489 XBT_DEBUG("Timeout (%g): i = %zu", wait_timeout, i);
495 } // namespace simgrid::s4u
496 /* **************************** Public C interface *************************** */
497 void sg_comm_detach(sg_comm_t comm, void (*clean_function)(void*))
499 comm->detach(clean_function);
502 void sg_comm_unref(sg_comm_t comm)
506 int sg_comm_test(sg_comm_t comm)
508 bool finished = comm->test();
514 sg_error_t sg_comm_wait(sg_comm_t comm)
516 return sg_comm_wait_for(comm, -1);
519 sg_error_t sg_comm_wait_for(sg_comm_t comm, double timeout)
521 sg_error_t status = SG_OK;
523 simgrid::s4u::CommPtr s4u_comm(comm, false);
525 s4u_comm->wait_for(timeout);
526 } catch (const simgrid::TimeoutException&) {
527 status = SG_ERROR_TIMEOUT;
528 } catch (const simgrid::CancelException&) {
529 status = SG_ERROR_CANCELED;
530 } catch (const simgrid::NetworkFailureException&) {
531 status = SG_ERROR_NETWORK;
536 void sg_comm_wait_all(sg_comm_t* comms, size_t count)
538 sg_comm_wait_all_for(comms, count, -1);
541 size_t sg_comm_wait_all_for(sg_comm_t* comms, size_t count, double timeout)
543 std::vector<simgrid::s4u::CommPtr> s4u_comms;
544 for (size_t i = 0; i < count; i++)
545 s4u_comms.emplace_back(comms[i], false);
547 size_t pos = simgrid::s4u::Comm::wait_all_for(s4u_comms, timeout);
548 for (size_t i = pos; i < count; i++)
549 s4u_comms[i]->add_ref();
553 ssize_t sg_comm_wait_any(sg_comm_t* comms, size_t count)
555 return sg_comm_wait_any_for(comms, count, -1);
558 ssize_t sg_comm_wait_any_for(sg_comm_t* comms, size_t count, double timeout)
560 std::vector<simgrid::s4u::CommPtr> s4u_comms;
561 for (size_t i = 0; i < count; i++)
562 s4u_comms.emplace_back(comms[i], false);
564 ssize_t pos = simgrid::s4u::Comm::wait_any_for(s4u_comms, timeout);
565 for (size_t i = 0; i < count; i++) {
566 if (pos != -1 && static_cast<size_t>(pos) != i)
567 s4u_comms[i]->add_ref();