X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/4de2a148bea34f550b79c07fb5e80ac36e6aa0e9..09392faf42646e631a4e42553e901410eb3e488e:/src/s4u/s4u_Comm.cpp diff --git a/src/s4u/s4u_Comm.cpp b/src/s4u/s4u_Comm.cpp index eec97a78ad..aec421bfa9 100644 --- a/src/s4u/s4u_Comm.cpp +++ b/src/s4u/s4u_Comm.cpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2022. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2023. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ @@ -6,23 +6,22 @@ #include #include #include +#include #include #include #include -#include "mc/mc.h" #include "src/kernel/activity/CommImpl.hpp" #include "src/kernel/actor/ActorImpl.hpp" #include "src/kernel/actor/SimcallObserver.hpp" +#include "src/mc/mc.h" #include "src/mc/mc_replay.hpp" XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_comm, s4u_activity, "S4U asynchronous communications"); -namespace simgrid { -namespace s4u { +namespace simgrid::s4u { xbt::signal Comm::on_send; xbt::signal Comm::on_recv; -xbt::signal Comm::on_completion; CommPtr Comm::set_copy_data_callback(const std::function& callback) { @@ -30,7 +29,8 @@ CommPtr Comm::set_copy_data_callback(const std::functiondst_buff_, buff, buff_size); @@ -41,7 +41,8 @@ void Comm::copy_buffer_callback(kernel::activity::CommImpl* comm, void* buff, si } } -void Comm::copy_pointer_callback(kernel::activity::CommImpl* comm, void* buff, size_t buff_size) +void Comm::copy_pointer_callback(kernel::activity::CommImpl* comm, void* buff, + size_t buff_size) // XBT_ATTRIB_DEPRECATED_v338 { xbt_assert((buff_size == sizeof(void*)), "Cannot copy %zu bytes: must be sizeof(void*)", buff_size); *(void**)(comm->dst_buff_) = buff; @@ -78,13 +79,14 @@ void Comm::send(kernel::actor::ActorImpl* sender, const Mailbox* mbox, double ta simgrid::kernel::activity::ActivityImplPtr comm = nullptr; simgrid::kernel::actor::CommIsendSimcall send_observer{ - sender, mbox->get_impl(), task_size, rate, static_cast(src_buff), src_buff_size, match_fun, - nullptr, copy_data_fun, data, false}; + sender, mbox->get_impl(), task_size, rate, static_cast(src_buff), + src_buff_size, match_fun, nullptr, copy_data_fun, data, + false, "Isend"}; comm = simgrid::kernel::actor::simcall_answered( [&send_observer] { return simgrid::kernel::activity::CommImpl::isend(&send_observer); }, &send_observer); - simgrid::kernel::actor::ActivityWaitSimcall wait_observer{sender, comm.get(), timeout}; - if (simgrid::kernel::actor::simcall_blocking( + if (simgrid::kernel::actor::ActivityWaitSimcall wait_observer{sender, comm.get(), timeout, "Wait"}; + simgrid::kernel::actor::simcall_blocking( [&wait_observer] { wait_observer.get_activity()->wait_for(wait_observer.get_issuer(), wait_observer.get_timeout()); }, @@ -95,7 +97,7 @@ void Comm::send(kernel::actor::ActorImpl* sender, const Mailbox* mbox, double ta } else { simgrid::kernel::actor::CommIsendSimcall observer(sender, mbox->get_impl(), task_size, rate, static_cast(src_buff), src_buff_size, match_fun, - nullptr, copy_data_fun, data, false); + nullptr, copy_data_fun, data, false, "Isend"); simgrid::kernel::actor::simcall_blocking([&observer, timeout] { simgrid::kernel::activity::ActivityImplPtr comm = simgrid::kernel::activity::CommImpl::isend(&observer); comm->wait_for(observer.get_issuer(), timeout); @@ -122,12 +124,13 @@ void Comm::recv(kernel::actor::ActorImpl* receiver, const Mailbox* mbox, void* d match_fun, copy_data_fun, data, - rate}; + rate, + "Irecv"}; comm = simgrid::kernel::actor::simcall_answered( [&observer] { return simgrid::kernel::activity::CommImpl::irecv(&observer); }, &observer); - simgrid::kernel::actor::ActivityWaitSimcall wait_observer{receiver, comm.get(), timeout}; - if (simgrid::kernel::actor::simcall_blocking( + if (simgrid::kernel::actor::ActivityWaitSimcall wait_observer{receiver, comm.get(), timeout, "wait"}; + simgrid::kernel::actor::simcall_blocking( [&wait_observer] { wait_observer.get_activity()->wait_for(wait_observer.get_issuer(), wait_observer.get_timeout()); }, @@ -137,7 +140,7 @@ void Comm::recv(kernel::actor::ActorImpl* receiver, const Mailbox* mbox, void* d comm = nullptr; } else { simgrid::kernel::actor::CommIrecvSimcall observer(receiver, mbox->get_impl(), static_cast(dst_buff), - dst_buff_size, match_fun, copy_data_fun, data, rate); + dst_buff_size, match_fun, copy_data_fun, data, rate, "Irecv"); simgrid::kernel::actor::simcall_blocking([&observer, timeout] { simgrid::kernel::activity::ActivityImplPtr comm = simgrid::kernel::activity::CommImpl::irecv(&observer); comm->wait_for(observer.get_issuer(), timeout); @@ -180,7 +183,7 @@ CommPtr Comm::set_source(Host* from) if (state_ == State::STARTING && remains_ <= 0) XBT_DEBUG("This communication has a payload size of 0 byte. It cannot start yet"); else - vetoable_start(); + start(); return this; } @@ -198,7 +201,7 @@ CommPtr Comm::set_destination(Host* to) if (state_ == State::STARTING && remains_ <= 0) XBT_DEBUG("This communication has a payload size of 0 byte. It cannot start yet"); else - vetoable_start(); + start(); return this; } @@ -211,7 +214,7 @@ Host* Comm::get_destination() const CommPtr Comm::set_rate(double rate) { xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)", - __FUNCTION__); + __func__); rate_ = rate; return this; } @@ -219,7 +222,7 @@ CommPtr Comm::set_rate(double rate) CommPtr Comm::set_mailbox(Mailbox* mailbox) { xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)", - __FUNCTION__); + __func__); mailbox_ = mailbox; return this; } @@ -227,7 +230,7 @@ CommPtr Comm::set_mailbox(Mailbox* mailbox) CommPtr Comm::set_src_data(void* buff) { xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)", - __FUNCTION__); + __func__); xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time"); src_buff_ = buff; return this; @@ -236,7 +239,7 @@ CommPtr Comm::set_src_data(void* buff) CommPtr Comm::set_src_data_size(size_t size) { xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)", - __FUNCTION__); + __func__); src_buff_size_ = size; return this; } @@ -244,7 +247,7 @@ CommPtr Comm::set_src_data_size(size_t size) CommPtr Comm::set_src_data(void* buff, size_t size) { xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)", - __FUNCTION__); + __func__); xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time"); src_buff_ = buff; @@ -255,7 +258,7 @@ CommPtr Comm::set_src_data(void* buff, size_t size) CommPtr Comm::set_dst_data(void** buff) { xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)", - __FUNCTION__); + __func__); xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time"); dst_buff_ = buff; return this; @@ -264,7 +267,7 @@ CommPtr Comm::set_dst_data(void** buff) CommPtr Comm::set_dst_data(void** buff, size_t size) { xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)", - __FUNCTION__); + __func__); xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time"); dst_buff_ = buff; @@ -274,13 +277,21 @@ CommPtr Comm::set_dst_data(void** buff, size_t size) CommPtr Comm::set_payload_size(uint64_t bytes) { - Activity::set_remaining(bytes); + set_remaining(bytes); if (pimpl_) { boost::static_pointer_cast(pimpl_)->set_size(bytes); } return this; } +void* Comm::get_payload() const +{ + xbt_assert(get_state() == State::FINISHED, + "You can only retrieve the payload of a communication that gracefully terminated, but its state is %s.", + get_state_str()); + return static_cast(pimpl_.get())->payload_; +} + Actor* Comm::get_sender() const { kernel::actor::ActorImplPtr sender = nullptr; @@ -289,16 +300,27 @@ Actor* Comm::get_sender() const return sender ? sender->get_ciface() : nullptr; } +Actor* Comm::get_receiver() const +{ + kernel::actor::ActorImplPtr receiver = nullptr; + if (pimpl_) + receiver = boost::static_pointer_cast(pimpl_)->dst_actor_; + return receiver ? receiver->get_ciface() : nullptr; +} + bool Comm::is_assigned() const { return (pimpl_ && boost::static_pointer_cast(pimpl_)->is_assigned()) || mailbox_ != nullptr; } -Comm* Comm::start() +Comm* Comm::do_start() { xbt_assert(get_state() == State::INITED || get_state() == State::STARTING, - "You cannot use %s() once your communication started (not implemented)", __FUNCTION__); + "You cannot use %s() once your communication started (not implemented)", __func__); + + auto myself = kernel::actor::ActorImpl::self(); + if (get_source() != nullptr || get_destination() != nullptr) { xbt_assert(is_assigned(), "When either from_ or to_ is specified, both must be."); xbt_assert(src_buff_ == nullptr && dst_buff_ == nullptr, @@ -308,8 +330,11 @@ Comm* Comm::start() pimpl_->set_state(kernel::activity::State::READY); boost::static_pointer_cast(pimpl_)->start(); }); - } else if (src_buff_ != nullptr) { // Sender side + fire_on_start(); + fire_on_this_start(); + } else if (myself == sender_) { on_send(*this); + on_this_send(*this); kernel::actor::CommIsendSimcall observer{sender_, mailbox_->get_impl(), remains_, @@ -320,12 +345,14 @@ Comm* Comm::start() clean_fun_, copy_data_function_, get_data(), - detached_}; + detached_, + "Isend"}; pimpl_ = kernel::actor::simcall_answered([&observer] { return kernel::activity::CommImpl::isend(&observer); }, &observer); - } else if (dst_buff_ != nullptr) { // Receiver side + } else if (myself == receiver_) { xbt_assert(not detached_, "Receive cannot be detached"); on_recv(*this); + on_this_recv(*this); kernel::actor::CommIrecvSimcall observer{receiver_, mailbox_->get_impl(), static_cast(dst_buff_), @@ -333,7 +360,8 @@ Comm* Comm::start() match_fun_, copy_data_function_, get_data(), - rate_}; + rate_, + "Irecv"}; pimpl_ = kernel::actor::simcall_answered([&observer] { return kernel::activity::CommImpl::irecv(&observer); }, &observer); } else { @@ -346,6 +374,11 @@ Comm* Comm::start() if (not detached_) { pimpl_->set_iface(this); pimpl_->set_actor(sender_); + // Only throw the signal when both sides are here and the status is READY + if (pimpl_->get_state() != kernel::activity::State::WAITING) { + fire_on_start(); + fire_on_this_start(); + } } state_ = State::STARTED; @@ -355,19 +388,28 @@ Comm* Comm::start() Comm* Comm::detach() { xbt_assert(state_ == State::INITED || state_ == State::STARTING, - "You cannot use %s() once your communication is %s (not implemented)", __FUNCTION__, get_state_str()); + "You cannot use %s() once your communication is %s (not implemented)", __func__, get_state_str()); xbt_assert(dst_buff_ == nullptr && dst_buff_size_ == 0, "You can only detach sends, not recvs"); detached_ = true; - vetoable_start(); + start(); return this; } -ssize_t Comm::test_any(const std::vector& comms) +ssize_t Comm::test_any(const std::vector& comms) // XBT_ATTRIB_DEPRECATED_v339 { - std::vector activities; - for (const auto& comm : comms) - activities.push_back(boost::dynamic_pointer_cast(comm)); - return Activity::test_any(activities); + std::vector ractivities(comms.size()); + std::transform(begin(comms), end(comms), begin(ractivities), [](const CommPtr& act) { return act->pimpl_.get(); }); + + kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self(); + kernel::actor::ActivityTestanySimcall observer{issuer, ractivities, "test_any"}; + ssize_t changed_pos = kernel::actor::simcall_answered( + [&observer] { + return kernel::activity::ActivityImpl::test_any(observer.get_issuer(), observer.get_activities()); + }, + &observer); + if (changed_pos != -1) + comms.at(changed_pos)->complete(State::FINISHED); + return changed_pos; } /** @brief Block the calling actor until the communication is finished, or until timeout @@ -388,14 +430,16 @@ Comm* Comm::wait_for(double timeout) case State::INITED: case State::STARTING: // It's not started yet. Do it in one simcall if it's a regular communication if (get_source() != nullptr || get_destination() != nullptr) { - return vetoable_start()->wait_for(timeout); // In the case of host2host comm, do it in two simcalls + return start()->wait_for(timeout); // In the case of host2host comm, do it in two simcalls } else if (src_buff_ != nullptr) { on_send(*this); + on_this_send(*this); send(sender_, mailbox_, remains_, rate_, src_buff_, src_buff_size_, match_fun_, copy_data_function_, get_data(), timeout); } else { // Receiver on_recv(*this); + on_this_recv(*this); recv(receiver_, mailbox_, dst_buff_, &dst_buff_size_, match_fun_, copy_data_function_, get_data(), timeout, rate_); } @@ -403,7 +447,7 @@ Comm* Comm::wait_for(double timeout) case State::STARTED: try { issuer = kernel::actor::ActorImpl::self(); - kernel::actor::ActivityWaitSimcall observer{issuer, pimpl_.get(), timeout}; + kernel::actor::ActivityWaitSimcall observer{issuer, pimpl_.get(), timeout, "Wait"}; if (kernel::actor::simcall_blocking( [&observer] { observer.get_activity()->wait_for(observer.get_issuer(), observer.get_timeout()); }, &observer)) { @@ -426,56 +470,60 @@ Comm* Comm::wait_for(double timeout) return this; } -ssize_t Comm::wait_any_for(const std::vector& comms, double timeout) +ssize_t Comm::deprecated_wait_any_for(const std::vector& comms, double timeout) // XBT_ATTRIB_DEPRECATED_v339 { - std::vector activities; + if (comms.empty()) + return -1; + ActivitySet set; for (const auto& comm : comms) - activities.push_back(boost::dynamic_pointer_cast(comm)); - ssize_t changed_pos; + set.push(comm); try { - changed_pos = Activity::wait_any_for(activities, timeout); + auto* ret = set.wait_any_for(timeout).get(); + for (size_t i = 0; i < comms.size(); i++) + if (comms[i].get() == ret) + return i; + + } catch (TimeoutException& e) { + return -1; } catch (const NetworkFailureException& e) { - changed_pos = -1; - for (auto c : comms) { - if (c->pimpl_->get_state() == kernel::activity::State::FAILED) { + for (auto c : comms) + if (c->pimpl_->get_state() == kernel::activity::State::FAILED) c->complete(State::FAILED); - } - } + e.rethrow_nested(XBT_THROW_POINT, boost::core::demangle(typeid(e).name()) + " raised in kernel mode."); } - return changed_pos; + return -1; } -void Comm::wait_all(const std::vector& comms) +void Comm::wait_all(const std::vector& comms) // XBT_ATTRIB_DEPRECATED_v339 { // TODO: this should be a simcall or something - for (auto& comm : comms) + for (const auto& comm : comms) comm->wait(); } -size_t Comm::wait_all_for(const std::vector& comms, double timeout) +size_t Comm::wait_all_for(const std::vector& comms, double timeout) // XBT_ATTRIB_DEPRECATED_v339 { if (timeout < 0.0) { - wait_all(comms); + for (const auto& comm : comms) + comm->wait(); return comms.size(); } - double deadline = Engine::get_clock() + timeout; - std::vector waited_comm(1, nullptr); - for (size_t i = 0; i < comms.size(); i++) { - double wait_timeout = std::max(0.0, deadline - Engine::get_clock()); - waited_comm[0] = comms[i]; - // Using wait_any_for() here (and not wait_for) because we don't want comms to be invalidated on timeout - if (wait_any_for(waited_comm, wait_timeout) == -1) { - XBT_DEBUG("Timeout (%g): i = %zu", wait_timeout, i); - return i; - } - } - return comms.size(); + ActivitySet set; + for (auto comm : comms) + set.push(comm); + set.wait_all_for(timeout); + + return set.size(); } -} // namespace s4u -} // namespace simgrid +} // namespace simgrid::s4u /* **************************** Public C interface *************************** */ +int sg_comm_isinstance(sg_activity_t acti) +{ + return dynamic_cast(acti) != nullptr; +} + void sg_comm_detach(sg_comm_t comm, void (*clean_function)(void*)) { comm->detach(clean_function); @@ -515,35 +563,36 @@ sg_error_t sg_comm_wait_for(sg_comm_t comm, double timeout) return status; } -void sg_comm_wait_all(sg_comm_t* comms, size_t count) +void sg_comm_wait_all(sg_comm_t* comms, size_t count) // XBT_ATTRIB_DEPRECATED_v339 { - sg_comm_wait_all_for(comms, count, -1); + simgrid::s4u::ActivitySet as; + for (size_t i = 0; i < count; i++) + as.push(comms[i]); + + as.wait_all(); } -size_t sg_comm_wait_all_for(sg_comm_t* comms, size_t count, double timeout) +ssize_t sg_comm_wait_any(sg_comm_t* comms, size_t count) // XBT_ATTRIB_DEPRECATED_v339 { std::vector s4u_comms; for (size_t i = 0; i < count; i++) s4u_comms.emplace_back(comms[i], false); - size_t pos = simgrid::s4u::Comm::wait_all_for(s4u_comms, timeout); - for (size_t i = pos; i < count; i++) - s4u_comms[i]->add_ref(); + ssize_t pos = simgrid::s4u::Comm::deprecated_wait_any_for(s4u_comms, -1); + for (size_t i = 0; i < count; i++) { + if (pos != -1 && static_cast(pos) != i) + s4u_comms[i]->add_ref(); + } return pos; } -ssize_t sg_comm_wait_any(sg_comm_t* comms, size_t count) -{ - return sg_comm_wait_any_for(comms, count, -1); -} - -ssize_t sg_comm_wait_any_for(sg_comm_t* comms, size_t count, double timeout) +ssize_t sg_comm_wait_any_for(sg_comm_t* comms, size_t count, double timeout) // XBT_ATTRIB_DEPRECATED_v339 { std::vector s4u_comms; for (size_t i = 0; i < count; i++) s4u_comms.emplace_back(comms[i], false); - ssize_t pos = simgrid::s4u::Comm::wait_any_for(s4u_comms, timeout); + ssize_t pos = simgrid::s4u::Comm::deprecated_wait_any_for(s4u_comms, timeout); for (size_t i = 0; i < count; i++) { if (pos != -1 && static_cast(pos) != i) s4u_comms[i]->add_ref();