1 /* Copyright (c) 2006-2022. 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/comm.h>
11 #include <simgrid/s4u/Comm.hpp>
12 #include <simgrid/s4u/Engine.hpp>
13 #include <simgrid/s4u/Mailbox.hpp>
15 #include "src/kernel/activity/CommImpl.hpp"
16 #include "src/kernel/actor/ActorImpl.hpp"
17 #include "src/kernel/actor/SimcallObserver.hpp"
19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_comm, s4u_activity, "S4U asynchronous communications");
23 xbt::signal<void(Comm const&)> Comm::on_send;
24 xbt::signal<void(Comm const&)> Comm::on_recv;
25 xbt::signal<void(Comm const&)> Comm::on_completion;
29 if (state_ == State::STARTED && not detached_ &&
30 (pimpl_ == nullptr || pimpl_->get_state() == kernel::activity::State::RUNNING)) {
31 XBT_INFO("Comm %p freed before its completion. Did you forget to detach it? (state: %s)", this, get_state_str());
32 if (pimpl_ != nullptr)
33 XBT_INFO("pimpl_->state: %s", pimpl_->get_state_str());
35 XBT_INFO("pimpl_ is null");
36 xbt_backtrace_display_current();
40 ssize_t Comm::wait_any_for(const std::vector<CommPtr>& comms, double timeout)
42 std::vector<ActivityPtr> activities;
43 for (const auto& comm : comms)
44 activities.push_back(boost::dynamic_pointer_cast<Activity>(comm));
47 changed_pos = Activity::wait_any_for(activities, timeout);
48 } catch (const NetworkFailureException& e) {
50 for (auto c : comms) {
51 if (c->pimpl_->get_state() == kernel::activity::State::FAILED) {
52 c->complete(State::FAILED);
55 e.rethrow_nested(XBT_THROW_POINT, boost::core::demangle(typeid(e).name()) + " raised in kernel mode.");
60 void Comm::wait_all(const std::vector<CommPtr>& comms)
62 // TODO: this should be a simcall or something
63 for (auto& comm : comms)
67 size_t Comm::wait_all_for(const std::vector<CommPtr>& comms, double timeout)
74 double deadline = Engine::get_clock() + timeout;
75 std::vector<CommPtr> waited_comm(1, nullptr);
76 for (size_t i = 0; i < comms.size(); i++) {
77 double wait_timeout = std::max(0.0, deadline - Engine::get_clock());
78 waited_comm[0] = comms[i];
79 // Using wait_any_for() here (and not wait_for) because we don't want comms to be invalidated on timeout
80 if (wait_any_for(waited_comm, wait_timeout) == -1) {
81 XBT_DEBUG("Timeout (%g): i = %zu", wait_timeout, i);
88 CommPtr Comm::set_source(Host* from)
90 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
91 "Cannot change the source of a Comm once it's started (state: %s)", to_c_str(state_));
93 // Setting 'from_' may allow to start the activity, let's try
99 CommPtr Comm::set_destination(Host* to)
101 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
102 "Cannot change the destination of a Comm once it's started (state: %s)", to_c_str(state_));
104 // Setting 'to_' may allow to start the activity, let's try
110 CommPtr Comm::set_rate(double rate)
112 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
118 CommPtr Comm::set_src_data(void* buff)
120 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
122 xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
127 CommPtr Comm::set_src_data_size(size_t size)
129 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
131 src_buff_size_ = size;
135 CommPtr Comm::set_src_data(void* buff, size_t size)
137 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
140 xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
142 src_buff_size_ = size;
146 CommPtr Comm::set_dst_data(void** buff)
148 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
150 xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
154 void* Comm::get_dst_data()
159 size_t Comm::get_dst_data_size() const
161 return dst_buff_size_;
163 CommPtr Comm::set_dst_data(void** buff, size_t size)
165 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
168 xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
170 dst_buff_size_ = size;
173 CommPtr Comm::set_payload_size(uint64_t bytes)
175 Activity::set_remaining(bytes);
179 CommPtr Comm::sendto_init()
181 CommPtr res(new Comm());
182 res->sender_ = kernel::actor::ActorImpl::self();
186 CommPtr Comm::sendto_init(Host* from, Host* to)
188 auto res = Comm::sendto_init();
195 CommPtr Comm::sendto_async(Host* from, Host* to, uint64_t simulated_size_in_bytes)
197 auto res = Comm::sendto_init(from, to)->set_payload_size(simulated_size_in_bytes);
198 res->vetoable_start();
202 void Comm::sendto(Host* from, Host* to, uint64_t simulated_size_in_bytes)
204 sendto_async(from, to, simulated_size_in_bytes)->wait();
209 xbt_assert(get_state() == State::INITED || get_state() == State::STARTING,
210 "You cannot use %s() once your communication started (not implemented)", __FUNCTION__);
211 if (from_ != nullptr || to_ != nullptr) {
212 xbt_assert(from_ != nullptr && to_ != nullptr, "When either from_ or to_ is specified, both must be.");
213 xbt_assert(src_buff_ == nullptr && dst_buff_ == nullptr,
214 "Direct host-to-host communications cannot carry any data.");
215 pimpl_ = kernel::actor::simcall_answered([this] {
216 kernel::activity::CommImplPtr res(new kernel::activity::CommImpl(this->from_, this->to_, this->get_remaining()));
221 } else if (src_buff_ != nullptr) { // Sender side
223 kernel::actor::CommIsendSimcall observer{sender_,
224 mailbox_->get_impl(),
227 static_cast<unsigned char*>(src_buff_),
234 pimpl_ = kernel::actor::simcall_answered([&observer] { return kernel::activity::CommImpl::isend(&observer); },
236 } else if (dst_buff_ != nullptr) { // Receiver side
237 xbt_assert(not detached_, "Receive cannot be detached");
239 kernel::actor::CommIrecvSimcall observer{receiver_,
240 mailbox_->get_impl(),
241 static_cast<unsigned char*>(dst_buff_),
247 pimpl_ = kernel::actor::simcall_answered([&observer] { return kernel::activity::CommImpl::irecv(&observer); },
250 xbt_die("Cannot start a communication before specifying whether we are the sender or the receiver");
257 pimpl_->set_iface(this);
258 pimpl_->set_actor(sender_);
261 state_ = State::STARTED;
265 /** @brief Block the calling actor until the communication is finished, or until timeout
267 * On timeout, an exception is thrown and the communication is invalidated.
269 * @param timeout the amount of seconds to wait for the comm termination.
270 * Negative values denote infinite wait times. 0 as a timeout returns immediately. */
271 Comm* Comm::wait_for(double timeout)
273 XBT_DEBUG("Calling Comm::wait_for with state %s", get_state_str());
274 kernel::actor::ActorImpl* issuer = nullptr;
276 case State::FINISHED:
279 throw NetworkFailureException(XBT_THROW_POINT, "Cannot wait for a failed communication");
281 case State::STARTING: // It's not started yet. Do it in one simcall if it's a regular communication
282 if (from_ != nullptr || to_ != nullptr) {
283 return vetoable_start()->wait_for(timeout); // In the case of host2host comm, do it in two simcalls
284 } else if (src_buff_ != nullptr) {
286 simcall_comm_send(sender_, mailbox_->get_impl(), remains_, rate_, src_buff_, src_buff_size_, match_fun_,
287 copy_data_function_, get_data<void>(), timeout);
291 simcall_comm_recv(receiver_, mailbox_->get_impl(), dst_buff_, &dst_buff_size_, match_fun_, copy_data_function_,
292 get_data<void>(), timeout, rate_);
297 issuer = kernel::actor::ActorImpl::self();
298 kernel::actor::ActivityWaitSimcall observer{issuer, pimpl_.get(), timeout};
299 if (kernel::actor::simcall_blocking(
300 [&observer] { observer.get_activity()->wait_for(observer.get_issuer(), observer.get_timeout()); },
302 throw TimeoutException(XBT_THROW_POINT, "Timeouted");
304 } catch (const NetworkFailureException& e) {
305 issuer->simcall_.observer_ = nullptr; // Comm failed on network failure, reset the observer to nullptr
306 complete(State::FAILED);
307 e.rethrow_nested(XBT_THROW_POINT, boost::core::demangle(typeid(e).name()) + " raised in kernel mode.");
311 case State::CANCELED:
312 throw CancelException(XBT_THROW_POINT, "Communication canceled");
317 complete(State::FINISHED);
321 ssize_t Comm::test_any(const std::vector<CommPtr>& comms)
323 std::vector<ActivityPtr> activities;
324 for (const auto& comm : comms)
325 activities.push_back(boost::dynamic_pointer_cast<Activity>(comm));
326 return Activity::test_any(activities);
331 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication is %s (not implemented)",
332 __FUNCTION__, get_state_str());
333 xbt_assert(dst_buff_ == nullptr && dst_buff_size_ == 0, "You can only detach sends, not recvs");
339 Mailbox* Comm::get_mailbox() const
344 Actor* Comm::get_sender() const
346 kernel::actor::ActorImplPtr sender = nullptr;
348 sender = boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->src_actor_;
349 return sender ? sender->get_ciface() : nullptr;
352 CommPtr Comm::set_copy_data_callback(void (*callback)(kernel::activity::CommImpl*, void*, size_t))
354 copy_data_function_ = callback;
357 void Comm::copy_buffer_callback(kernel::activity::CommImpl* comm, void* buff, size_t buff_size)
359 XBT_DEBUG("Copy the data over");
360 memcpy(comm->dst_buff_, buff, buff_size);
361 if (comm->detached()) { // if this is a detached send, the source buffer was duplicated by SMPI sender to make the
362 // original buffer available to the application ASAP
364 comm->src_buff_ = nullptr;
368 void Comm::copy_pointer_callback(kernel::activity::CommImpl* comm, void* buff, size_t buff_size)
370 xbt_assert((buff_size == sizeof(void*)), "Cannot copy %zu bytes: must be sizeof(void*)", buff_size);
371 *(void**)(comm->dst_buff_) = buff;
375 } // namespace simgrid
376 /* **************************** Public C interface *************************** */
377 void sg_comm_detach(sg_comm_t comm, void (*clean_function)(void*))
379 comm->detach(clean_function);
382 void sg_comm_unref(sg_comm_t comm)
386 int sg_comm_test(sg_comm_t comm)
388 bool finished = comm->test();
394 sg_error_t sg_comm_wait(sg_comm_t comm)
396 return sg_comm_wait_for(comm, -1);
399 sg_error_t sg_comm_wait_for(sg_comm_t comm, double timeout)
401 sg_error_t status = SG_OK;
403 simgrid::s4u::CommPtr s4u_comm(comm, false);
405 s4u_comm->wait_for(timeout);
406 } catch (const simgrid::TimeoutException&) {
407 status = SG_ERROR_TIMEOUT;
408 } catch (const simgrid::CancelException&) {
409 status = SG_ERROR_CANCELED;
410 } catch (const simgrid::NetworkFailureException&) {
411 status = SG_ERROR_NETWORK;
416 void sg_comm_wait_all(sg_comm_t* comms, size_t count)
418 sg_comm_wait_all_for(comms, count, -1);
421 size_t sg_comm_wait_all_for(sg_comm_t* comms, size_t count, double timeout)
423 std::vector<simgrid::s4u::CommPtr> s4u_comms;
424 for (size_t i = 0; i < count; i++)
425 s4u_comms.emplace_back(comms[i], false);
427 size_t pos = simgrid::s4u::Comm::wait_all_for(s4u_comms, timeout);
428 for (size_t i = pos; i < count; i++)
429 s4u_comms[i]->add_ref();
433 ssize_t sg_comm_wait_any(sg_comm_t* comms, size_t count)
435 return sg_comm_wait_any_for(comms, count, -1);
438 ssize_t sg_comm_wait_any_for(sg_comm_t* comms, size_t count, double timeout)
440 std::vector<simgrid::s4u::CommPtr> s4u_comms;
441 for (size_t i = 0; i < count; i++)
442 s4u_comms.emplace_back(comms[i], false);
444 ssize_t pos = simgrid::s4u::Comm::wait_any_for(s4u_comms, timeout);
445 for (size_t i = 0; i < count; i++) {
446 if (pos != -1 && static_cast<size_t>(pos) != i)
447 s4u_comms[i]->add_ref();