-/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2006-2020. 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. */
#include "src/msg/msg_private.hpp"
#include "xbt/log.h"
+#include "simgrid/Exception.hpp"
#include "simgrid/s4u/Comm.hpp"
#include "simgrid/s4u/Mailbox.hpp"
+#include <simgrid/comm.h>
+
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_comm, s4u_activity, "S4U asynchronous communications");
namespace simgrid {
namespace s4u {
+xbt::signal<void(Actor const&)> Comm::on_sender_start;
+xbt::signal<void(Actor const&)> Comm::on_receiver_start;
+xbt::signal<void(Actor const&)> Comm::on_completion;
+
Comm::~Comm()
{
- if (state_ == State::STARTED && not detached_ && (pimpl_ == nullptr || pimpl_->state_ == SIMIX_RUNNING)) {
+ if (state_ == State::STARTED && not detached_ &&
+ (pimpl_ == nullptr || pimpl_->state_ == kernel::activity::State::RUNNING)) {
XBT_INFO("Comm %p freed before its completion. Detached: %d, State: %d", this, detached_, (int)state_);
if (pimpl_ != nullptr)
- XBT_INFO("pimpl_->state: %d", pimpl_->state_);
+ XBT_INFO("pimpl_->state: %d", static_cast<int>(pimpl_->state_));
else
XBT_INFO("pimpl_ is null");
xbt_backtrace_display_current();
}
}
-int Comm::wait_any_for(std::vector<CommPtr>* comms_in, double timeout)
+int Comm::wait_any_for(const std::vector<CommPtr>* comms, double timeout)
{
- // Map to dynar<Synchro*>:
- xbt_dynar_t comms = xbt_dynar_new(sizeof(simgrid::kernel::activity::ActivityImpl*), [](void* ptr) {
- intrusive_ptr_release(*(simgrid::kernel::activity::ActivityImpl**)ptr);
- });
- for (auto const& comm : *comms_in) {
- if (comm->state_ == Activity::State::INITED)
- comm->start();
- xbt_assert(comm->state_ == Activity::State::STARTED);
- simgrid::kernel::activity::ActivityImpl* ptr = comm->pimpl_.get();
- intrusive_ptr_add_ref(ptr);
- xbt_dynar_push_as(comms, simgrid::kernel::activity::ActivityImpl*, ptr);
- }
- // Call the underlying simcall:
- int idx = simcall_comm_waitany(comms, timeout);
- xbt_dynar_free(&comms);
- return idx;
+ std::unique_ptr<kernel::activity::CommImpl* []> rcomms(new kernel::activity::CommImpl*[comms->size()]);
+ std::transform(begin(*comms), end(*comms), rcomms.get(),
+ [](const CommPtr& comm) { return static_cast<kernel::activity::CommImpl*>(comm->pimpl_.get()); });
+ int changed_pos = simcall_comm_waitany(rcomms.get(), comms->size(), timeout);
+ if (changed_pos != -1)
+ comms->at(changed_pos)->release_dependencies();
+ return changed_pos;
}
-void Comm::wait_all(std::vector<CommPtr>* comms)
+void Comm::wait_all(const std::vector<CommPtr>* comms)
{
// TODO: this should be a simcall or something
// TODO: we are missing a version with timeout
- for (CommPtr comm : *comms) {
+ for (CommPtr comm : *comms)
comm->wait();
- }
}
-Activity* Comm::set_rate(double rate)
+CommPtr Comm::set_rate(double rate)
{
- xbt_assert(state_ == State::INITED);
+ xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
+ __FUNCTION__);
rate_ = rate;
return this;
}
-Activity* Comm::set_src_data(void* buff)
+CommPtr Comm::set_src_data(void* buff)
{
- xbt_assert(state_ == State::INITED);
+ xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
+ __FUNCTION__);
xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
src_buff_ = buff;
return this;
}
-Activity* Comm::set_src_data_size(size_t size)
+
+CommPtr Comm::set_src_data_size(size_t size)
{
- xbt_assert(state_ == State::INITED);
+ xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
+ __FUNCTION__);
src_buff_size_ = size;
return this;
}
-Activity* Comm::set_src_data(void* buff, size_t size)
+
+CommPtr Comm::set_src_data(void* buff, size_t size)
{
- xbt_assert(state_ == State::INITED);
+ xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
+ __FUNCTION__);
xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
src_buff_ = buff;
src_buff_size_ = size;
return this;
}
-Activity* Comm::set_dst_data(void** buff)
+
+CommPtr Comm::set_dst_data(void** buff)
{
- xbt_assert(state_ == State::INITED);
+ xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
+ __FUNCTION__);
xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
dst_buff_ = buff;
return this;
}
-size_t Comm::get_dst_data_size()
+
+size_t Comm::get_dst_data_size() const
{
- xbt_assert(state_ == State::FINISHED);
+ xbt_assert(state_ == State::FINISHED, "You cannot use %s before your communication terminated", __FUNCTION__);
return dst_buff_size_;
}
-Activity* Comm::set_dst_data(void** buff, size_t size)
+CommPtr Comm::set_dst_data(void** buff, size_t size)
{
- xbt_assert(state_ == State::INITED);
+ xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
+ __FUNCTION__);
xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
dst_buff_ = buff;
return this;
}
-Activity* Comm::start()
+CommPtr Comm::set_tracing_category(const std::string& category)
{
- xbt_assert(state_ == State::INITED);
+ xbt_assert(state_ == State::INITED, "Cannot change the tracing category of an exec after its start");
+ tracing_category_ = category;
+ return this;
+}
+
+Comm* Comm::start()
+{
+ xbt_assert(get_state() == State::INITED || get_state() == State::STARTING,
+ "You cannot use %s() once your communication started (not implemented)", __FUNCTION__);
if (src_buff_ != nullptr) { // Sender side
+ on_sender_start(*Actor::self());
pimpl_ = simcall_comm_isend(sender_, mailbox_->get_impl(), remains_, rate_, src_buff_, src_buff_size_, match_fun_,
- clean_fun_, copy_data_function_, user_data_, detached_);
+ clean_fun_, copy_data_function_, get_user_data(), detached_);
} else if (dst_buff_ != nullptr) { // Receiver side
xbt_assert(not detached_, "Receive cannot be detached");
+ on_receiver_start(*Actor::self());
pimpl_ = simcall_comm_irecv(receiver_, mailbox_->get_impl(), dst_buff_, &dst_buff_size_, match_fun_,
- copy_data_function_, user_data_, rate_);
+ copy_data_function_, get_user_data(), rate_);
} else {
xbt_die("Cannot start a communication before specifying whether we are the sender or the receiver");
}
/** @brief Block the calling actor until the communication is finished */
-Activity* Comm::wait()
+Comm* Comm::wait()
{
- return this->wait(-1);
+ return this->wait_for(-1);
}
/** @brief Block the calling actor until the communication is finished, or until timeout
*
- * On timeout, an exception is thrown.
+ * On timeout, an exception is thrown and the communication is invalidated.
*
* @param timeout the amount of seconds to wait for the comm termination.
* Negative values denote infinite wait times. 0 as a timeout returns immediately. */
-Activity* Comm::wait(double timeout)
+Comm* Comm::wait_for(double timeout)
{
switch (state_) {
case State::FINISHED:
- return this;
+ break;
- case State::INITED: // It's not started yet. Do it in one simcall
+ case State::INITED:
+ case State::STARTING: // It's not started yet. Do it in one simcall
if (src_buff_ != nullptr) {
+ on_sender_start(*Actor::self());
simcall_comm_send(sender_, mailbox_->get_impl(), remains_, rate_, src_buff_, src_buff_size_, match_fun_,
- copy_data_function_, user_data_, timeout);
+ copy_data_function_, get_user_data(), timeout);
+
} else { // Receiver
+ on_receiver_start(*Actor::self());
simcall_comm_recv(receiver_, mailbox_->get_impl(), dst_buff_, &dst_buff_size_, match_fun_, copy_data_function_,
- user_data_, timeout, rate_);
+ get_user_data(), timeout, rate_);
}
state_ = State::FINISHED;
- return this;
+ this->release_dependencies();
+ break;
case State::STARTED:
- simcall_comm_wait(pimpl_, timeout);
+ simcall_comm_wait(get_impl(), timeout);
+ on_completion(*Actor::self());
state_ = State::FINISHED;
- return this;
+ this->release_dependencies();
+ break;
+
+ case State::CANCELED:
+ throw CancelException(XBT_THROW_POINT, "Communication canceled");
default:
THROW_IMPOSSIBLE;
}
return this;
}
-int Comm::test_any(std::vector<CommPtr>* comms)
+
+int Comm::test_any(const std::vector<CommPtr>* comms)
{
- smx_activity_t* array = new smx_activity_t[comms->size()];
- for (unsigned int i = 0; i < comms->size(); i++) {
- array[i] = comms->at(i)->pimpl_;
- }
- int res = simcall_comm_testany(array, comms->size());
- delete[] array;
- return res;
+ std::unique_ptr<kernel::activity::CommImpl* []> rcomms(new kernel::activity::CommImpl*[comms->size()]);
+ std::transform(begin(*comms), end(*comms), rcomms.get(),
+ [](const CommPtr& comm) { return static_cast<kernel::activity::CommImpl*>(comm->pimpl_.get()); });
+ int changed_pos = simcall_comm_testany(rcomms.get(), comms->size());
+ if (changed_pos != -1)
+ comms->at(changed_pos)->release_dependencies();
+ return changed_pos;
}
-Activity* Comm::detach()
+Comm* Comm::detach()
{
- xbt_assert(state_ == State::INITED, "You cannot detach communications once they are started (not implemented).");
+ xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
+ __FUNCTION__);
xbt_assert(src_buff_ != nullptr && src_buff_size_ != 0, "You can only detach sends, not recvs");
detached_ = true;
- return start();
+ vetoable_start();
+ return this;
}
-Activity* Comm::cancel()
+Comm* Comm::cancel()
{
- simgrid::kernel::activity::CommImplPtr commPimpl =
- boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(pimpl_);
- commPimpl->cancel();
+ kernel::actor::simcall([this] {
+ if (pimpl_)
+ boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->cancel();
+ });
+ state_ = State::CANCELED;
return this;
}
bool Comm::test()
{
- xbt_assert(state_ == State::INITED || state_ == State::STARTED || state_ == State::FINISHED);
+ xbt_assert(state_ == State::INITED || state_ == State::STARTED || state_ == State::STARTING ||
+ state_ == State::FINISHED);
if (state_ == State::FINISHED)
return true;
- if (state_ == State::INITED)
- this->start();
+ if (state_ == State::INITED || state_ == State::STARTING)
+ this->vetoable_start();
- if (simcall_comm_test(pimpl_)) {
+ if (simcall_comm_test(get_impl())) {
state_ = State::FINISHED;
+ this->release_dependencies();
return true;
}
return false;
}
-MailboxPtr Comm::get_mailbox()
+Mailbox* Comm::get_mailbox() const
{
return mailbox_;
}
-void intrusive_ptr_release(simgrid::s4u::Comm* c)
+Actor* Comm::get_sender() const
{
- if (c->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
- std::atomic_thread_fence(std::memory_order_acquire);
- delete c;
- }
-}
-void intrusive_ptr_add_ref(simgrid::s4u::Comm* c)
-{
- c->refcount_.fetch_add(1, std::memory_order_relaxed);
+ return sender_ ? sender_->ciface() : nullptr;
}
+
} // namespace s4u
} // namespace simgrid
+/* **************************** Public C interface *************************** */
+int sg_comm_test(sg_comm_t comm)
+{
+ return comm->test();
+}
+
+void sg_comm_wait_all(sg_comm_t* comms, size_t count)
+{
+ std::vector<simgrid::s4u::CommPtr> s4u_comms;
+ for (unsigned int i = 0; i < count; i++)
+ s4u_comms.emplace_back(comms[i]);
+
+ simgrid::s4u::Comm::wait_all(&s4u_comms);
+ for (unsigned int i = 0; i < count; i++)
+ s4u_comms[i]->unref();
+}
+
+int sg_comm_wait_any(sg_comm_t* comms, size_t count)
+{
+ return sg_comm_wait_any_for(comms, count, -1);
+}
+
+int sg_comm_wait_any_for(sg_comm_t* comms, size_t count, double timeout)
+{
+ std::vector<simgrid::s4u::CommPtr> s4u_comms;
+ for (unsigned int i = 0; i < count; i++) {
+ s4u_comms.emplace_back(comms[i]);
+ }
+ int pos = simgrid::s4u::Comm::wait_any_for(&s4u_comms, timeout);
+ if (pos != -1)
+ s4u_comms[pos]->unref();
+ return pos;
+}