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/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"
18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_comm, s4u_activity, "S4U asynchronous communications");
22 xbt::signal<void(Comm const&)> Comm::on_send;
23 xbt::signal<void(Comm const&)> Comm::on_recv;
24 xbt::signal<void(Comm const&)> Comm::on_completion;
26 void Comm::complete(Activity::State state)
28 Activity::complete(state);
34 if (state_ == State::STARTED && not detached_ &&
35 (pimpl_ == nullptr || pimpl_->state_ == kernel::activity::State::RUNNING)) {
36 XBT_INFO("Comm %p freed before its completion. Did you forget to detach it? (state: %s)", this, get_state_str());
37 if (pimpl_ != nullptr)
38 XBT_INFO("pimpl_->state: %s", pimpl_->get_state_str());
40 XBT_INFO("pimpl_ is null");
41 xbt_backtrace_display_current();
45 ssize_t Comm::wait_any_for(const std::vector<CommPtr>& comms, double timeout)
47 std::vector<kernel::activity::CommImpl*> rcomms(comms.size());
48 std::transform(begin(comms), end(comms), begin(rcomms),
49 [](const CommPtr& comm) { return static_cast<kernel::activity::CommImpl*>(comm->pimpl_.get()); });
52 changed_pos = simcall_comm_waitany(rcomms.data(), rcomms.size(), timeout);
53 } catch (const NetworkFailureException& e) {
54 for (auto c : comms) {
55 if (c->pimpl_->state_ == kernel::activity::State::FAILED) {
56 c->complete(State::FAILED);
59 e.rethrow_nested(XBT_THROW_POINT, boost::core::demangle(typeid(e).name()) + " raised in kernel mode.");
61 if (changed_pos != -1)
62 comms.at(changed_pos)->complete(State::FINISHED);
66 void Comm::wait_all(const std::vector<CommPtr>& comms)
68 // TODO: this should be a simcall or something
69 for (auto& comm : comms)
73 size_t Comm::wait_all_for(const std::vector<CommPtr>& comms, double timeout)
80 double deadline = Engine::get_clock() + timeout;
81 std::vector<CommPtr> waited_comm(1, nullptr);
82 for (size_t i = 0; i < comms.size(); i++) {
83 double wait_timeout = std::max(0.0, deadline - Engine::get_clock());
84 waited_comm[0] = comms[i];
85 // Using wait_any_for() here (and not wait_for) because we don't want comms to be invalidated on timeout
86 if (wait_any_for(waited_comm, wait_timeout) == -1) {
87 XBT_DEBUG("Timeout (%g): i = %zu", wait_timeout, i);
94 CommPtr Comm::set_rate(double rate)
96 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
102 CommPtr Comm::set_src_data(void* buff)
104 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
106 xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
111 CommPtr Comm::set_src_data_size(size_t size)
113 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
115 src_buff_size_ = size;
119 CommPtr Comm::set_src_data(void* buff, size_t size)
121 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
124 xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
126 src_buff_size_ = size;
130 CommPtr Comm::set_dst_data(void** buff)
132 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
134 xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
138 void* Comm::get_dst_data()
143 size_t Comm::get_dst_data_size() const
145 return dst_buff_size_;
147 CommPtr Comm::set_dst_data(void** buff, size_t size)
149 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
152 xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
154 dst_buff_size_ = size;
157 CommPtr Comm::set_payload_size(uint64_t bytes)
159 Activity::set_remaining(bytes);
163 CommPtr Comm::sendto_init(Host* from, Host* to)
165 CommPtr res(new Comm());
172 CommPtr Comm::sendto_async(Host* from, Host* to, uint64_t simulated_size_in_bytes)
174 auto res = Comm::sendto_init(from, to)->set_payload_size(simulated_size_in_bytes);
175 res->vetoable_start();
179 void Comm::sendto(Host* from, Host* to, uint64_t simulated_size_in_bytes)
181 sendto_async(from, to, simulated_size_in_bytes)->wait();
186 xbt_assert(get_state() == State::INITED || get_state() == State::STARTING,
187 "You cannot use %s() once your communication started (not implemented)", __FUNCTION__);
188 if (from_ != nullptr || to_ != nullptr) {
189 xbt_assert(from_ != nullptr && to_ != nullptr, "When either from_ or to_ is specified, both must be.");
190 xbt_assert(src_buff_ == nullptr && dst_buff_ == nullptr,
191 "Direct host-to-host communications cannot carry any data.");
192 pimpl_ = kernel::actor::simcall([this] {
193 kernel::activity::CommImplPtr res(new kernel::activity::CommImpl(this->from_, this->to_, this->get_remaining()));
198 } else if (src_buff_ != nullptr) { // Sender side
200 pimpl_ = simcall_comm_isend(sender_, mailbox_->get_impl(), remains_, rate_, src_buff_, src_buff_size_, match_fun_,
201 clean_fun_, copy_data_function_, get_user_data(), detached_);
202 } else if (dst_buff_ != nullptr) { // Receiver side
203 xbt_assert(not detached_, "Receive cannot be detached");
205 pimpl_ = simcall_comm_irecv(receiver_, mailbox_->get_impl(), dst_buff_, &dst_buff_size_, match_fun_,
206 copy_data_function_, get_user_data(), rate_);
209 xbt_die("Cannot start a communication before specifying whether we are the sender or the receiver");
215 state_ = State::STARTED;
219 /** @brief Block the calling actor until the communication is finished, or until timeout
221 * On timeout, an exception is thrown and the communication is invalidated.
223 * @param timeout the amount of seconds to wait for the comm termination.
224 * Negative values denote infinite wait times. 0 as a timeout returns immediately. */
225 Comm* Comm::wait_for(double timeout)
228 case State::FINISHED:
231 throw NetworkFailureException(XBT_THROW_POINT, "Cannot wait for a failed communication");
234 case State::STARTING: // It's not started yet. Do it in one simcall if it's a regular communication
235 if (from_ != nullptr || to_ != nullptr) {
236 return vetoable_start()->wait_for(timeout); // In the case of host2host comm, do it in two simcalls
237 } else if (src_buff_ != nullptr) {
239 simcall_comm_send(sender_, mailbox_->get_impl(), remains_, rate_, src_buff_, src_buff_size_, match_fun_,
240 copy_data_function_, get_user_data(), timeout);
244 simcall_comm_recv(receiver_, mailbox_->get_impl(), dst_buff_, &dst_buff_size_, match_fun_, copy_data_function_,
245 get_user_data(), timeout, rate_);
251 simcall_comm_wait(get_impl(), timeout);
252 } catch (const NetworkFailureException& e) {
253 complete(State::FAILED);
254 e.rethrow_nested(XBT_THROW_POINT, boost::core::demangle(typeid(e).name()) + " raised in kernel mode.");
258 case State::CANCELED:
259 throw CancelException(XBT_THROW_POINT, "Communication canceled");
264 complete(State::FINISHED);
268 ssize_t Comm::test_any(const std::vector<CommPtr>& comms)
270 std::vector<kernel::activity::CommImpl*> rcomms(comms.size());
271 std::transform(begin(comms), end(comms), begin(rcomms),
272 [](const CommPtr& comm) { return static_cast<kernel::activity::CommImpl*>(comm->pimpl_.get()); });
273 ssize_t changed_pos = simcall_comm_testany(rcomms.data(), rcomms.size());
274 if (changed_pos != -1)
275 comms.at(changed_pos)->complete(State::FINISHED);
281 xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication is %s (not implemented)",
282 __FUNCTION__, get_state_str());
283 xbt_assert(dst_buff_ == nullptr && dst_buff_size_ == 0, "You can only detach sends, not recvs");
289 bool Comm::test() // TODO: merge with Activity::test, once modernized
291 xbt_assert(state_ == State::INITED || state_ == State::STARTED || state_ == State::STARTING ||
292 state_ == State::CANCELED || state_ == State::FINISHED);
294 if (state_ == State::CANCELED || state_ == State::FINISHED)
297 if (state_ == State::INITED || state_ == State::STARTING)
298 this->vetoable_start();
300 if (simcall_comm_test(get_impl())) {
301 complete(State::FINISHED);
307 Mailbox* Comm::get_mailbox() const
312 Actor* Comm::get_sender() const
314 kernel::actor::ActorImplPtr sender = nullptr;
316 sender = boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->src_actor_;
317 return sender ? sender->get_ciface() : nullptr;
320 CommPtr Comm::set_copy_data_callback(void (*callback)(kernel::activity::CommImpl*, void*, size_t))
322 copy_data_function_ = callback;
325 void Comm::copy_buffer_callback(kernel::activity::CommImpl* comm, void* buff, size_t buff_size)
327 XBT_DEBUG("Copy the data over");
328 memcpy(comm->dst_buff_, buff, buff_size);
329 if (comm->detached()) { // if this is a detached send, the source buffer was duplicated by SMPI sender to make the
330 // original buffer available to the application ASAP
332 comm->src_buff_ = nullptr;
336 void Comm::copy_pointer_callback(kernel::activity::CommImpl* comm, void* buff, size_t buff_size)
338 xbt_assert((buff_size == sizeof(void*)), "Cannot copy %zu bytes: must be sizeof(void*)", buff_size);
339 *(void**)(comm->dst_buff_) = buff;
343 } // namespace simgrid
344 /* **************************** Public C interface *************************** */
345 void sg_comm_detach(sg_comm_t comm, void (*clean_function)(void*))
347 comm->detach(clean_function);
350 void sg_comm_unref(sg_comm_t comm)
354 int sg_comm_test(sg_comm_t comm)
356 bool finished = comm->test();
362 sg_error_t sg_comm_wait(sg_comm_t comm)
364 return sg_comm_wait_for(comm, -1);
367 sg_error_t sg_comm_wait_for(sg_comm_t comm, double timeout)
369 sg_error_t status = SG_OK;
371 simgrid::s4u::CommPtr s4u_comm(comm, false);
373 s4u_comm->wait_for(timeout);
374 } catch (const simgrid::TimeoutException&) {
375 status = SG_ERROR_TIMEOUT;
376 } catch (const simgrid::CancelException&) {
377 status = SG_ERROR_CANCELED;
378 } catch (const simgrid::NetworkFailureException&) {
379 status = SG_ERROR_NETWORK;
384 void sg_comm_wait_all(sg_comm_t* comms, size_t count)
386 sg_comm_wait_all_for(comms, count, -1);
389 size_t sg_comm_wait_all_for(sg_comm_t* comms, size_t count, double timeout)
391 std::vector<simgrid::s4u::CommPtr> s4u_comms;
392 for (size_t i = 0; i < count; i++)
393 s4u_comms.emplace_back(comms[i], false);
395 size_t pos = simgrid::s4u::Comm::wait_all_for(s4u_comms, timeout);
396 for (size_t i = pos; i < count; i++)
397 s4u_comms[i]->add_ref();
401 ssize_t sg_comm_wait_any(sg_comm_t* comms, size_t count)
403 return sg_comm_wait_any_for(comms, count, -1);
406 ssize_t sg_comm_wait_any_for(sg_comm_t* comms, size_t count, double timeout)
408 std::vector<simgrid::s4u::CommPtr> s4u_comms;
409 for (size_t i = 0; i < count; i++)
410 s4u_comms.emplace_back(comms[i], false);
412 ssize_t pos = simgrid::s4u::Comm::wait_any_for(s4u_comms, timeout);
413 for (size_t i = 0; i < count; i++) {
414 if (pos != -1 && static_cast<size_t>(pos) != i)
415 s4u_comms[i]->add_ref();