-/* Copyright (c) 2006-2015. The SimGrid Team.
- * All rights reserved. */
+/* Copyright (c) 2006-2018. 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 "src/msg/msg_private.h"
-#include "src/msg/msg_mailbox.h"
-
-#include "simgrid/s4u/comm.hpp"
-
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_comm,s4u_async,"S4U asynchronous communications");
-using namespace simgrid;
-
-s4u::Comm::~Comm() {
+#include "simgrid/s4u/Comm.hpp"
+#include "simgrid/s4u/Mailbox.hpp"
+
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_comm,s4u_activity,"S4U asynchronous communications");
+
+namespace simgrid {
+namespace s4u {
+Comm::~Comm()
+{
+ if (state_ == State::started && not detached_ && (pimpl_ == nullptr || pimpl_->state == SIMIX_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);
+ else
+ XBT_INFO("pimpl_ is null");
+ xbt_backtrace_display_current();
+ }
}
-s4u::Comm &s4u::Comm::send_init(s4u::Actor *sender, s4u::Mailbox &chan) {
- s4u::Comm *res = new s4u::Comm();
- res->p_sender = sender;
- res->p_mailbox = &chan;
-
- return *res;
+int Comm::wait_any_for(std::vector<CommPtr>* comms_in, 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;
}
-s4u::Comm &s4u::Comm::recv_init(s4u::Actor *receiver, s4u::Mailbox &chan) {
- s4u::Comm *res = new s4u::Comm();
- res->p_receiver = receiver;
- res->p_mailbox = &chan;
- return *res;
+void Comm::wait_all(std::vector<CommPtr>* comms)
+{
+ // TODO: this should be a simcall or something
+ // TODO: we are missing a version with timeout
+ for (CommPtr comm : *comms) {
+ comm->wait();
+ }
}
-void s4u::Comm::setRate(double rate) {
- xbt_assert(p_state==inited);
- p_rate = rate;
+Activity* Comm::set_rate(double rate)
+{
+ xbt_assert(state_ == State::inited);
+ rate_ = rate;
+ return this;
}
-void s4u::Comm::setSrcData(void * buff) {
- xbt_assert(p_state==inited);
- xbt_assert(p_dstBuff == NULL, "Cannot set the src and dst buffers at the same time");
- p_srcBuff = buff;
+Activity* Comm::set_src_data(void* buff)
+{
+ xbt_assert(state_ == State::inited);
+ xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
+ src_buff_ = buff;
+ return this;
}
-void s4u::Comm::setSrcDataSize(size_t size){
- xbt_assert(p_state==inited);
- p_srcBuffSize = size;
+Activity* Comm::set_src_data_size(size_t size)
+{
+ xbt_assert(state_ == State::inited);
+ src_buff_size_ = size;
+ return this;
}
-void s4u::Comm::setSrcData(void * buff, size_t size) {
- xbt_assert(p_state==inited);
-
- xbt_assert(p_dstBuff == NULL, "Cannot set the src and dst buffers at the same time");
- p_srcBuff = buff;
- p_srcBuffSize = size;
+Activity* Comm::set_src_data(void* buff, size_t size)
+{
+ xbt_assert(state_ == State::inited);
+
+ 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;
}
-void s4u::Comm::setDstData(void ** buff) {
- xbt_assert(p_state==inited);
- xbt_assert(p_srcBuff == NULL, "Cannot set the src and dst buffers at the same time");
- p_dstBuff = buff;
+Activity* Comm::set_dst_data(void** buff)
+{
+ xbt_assert(state_ == State::inited);
+ xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
+ dst_buff_ = buff;
+ return this;
}
-size_t s4u::Comm::getDstDataSize(){
- xbt_assert(p_state==finished);
- return p_dstBuffSize;
+size_t Comm::get_dst_data_size()
+{
+ xbt_assert(state_ == State::finished);
+ return dst_buff_size_;
}
-void s4u::Comm::setDstData(void ** buff, size_t size) {
- xbt_assert(p_state==inited);
-
- xbt_assert(p_srcBuff == NULL, "Cannot set the src and dst buffers at the same time");
- p_dstBuff = buff;
- p_dstBuffSize = size;
+Activity* Comm::set_dst_data(void** buff, size_t size)
+{
+ xbt_assert(state_ == State::inited);
+
+ xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
+ dst_buff_ = buff;
+ dst_buff_size_ = size;
+ return this;
}
-void s4u::Comm::start() {
- xbt_assert(p_state == inited);
+Activity* Comm::start()
+{
+ xbt_assert(state_ == State::inited);
- if (p_srcBuff != NULL) { // Sender side
- p_inferior = simcall_comm_isend(p_sender->getInferior(), p_mailbox->getInferior(), p_remains, p_rate,
- p_srcBuff, p_srcBuffSize,
- p_matchFunction, p_cleanFunction, p_copyDataFunction,
- p_userData, p_detached);
- } else if (p_dstBuff != NULL) { // Receiver side
- p_inferior = simcall_comm_irecv(p_receiver->getInferior(), p_mailbox->getInferior(), p_dstBuff, &p_dstBuffSize,
- p_matchFunction, p_copyDataFunction,
- p_userData, p_rate);
+ if (src_buff_ != nullptr) { // Sender side
+ 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_);
+ } else if (dst_buff_ != nullptr) { // Receiver side
+ xbt_assert(not detached_, "Receive cannot be detached");
+ pimpl_ = simcall_comm_irecv(receiver_, mailbox_->get_impl(), dst_buff_, &dst_buff_size_, match_fun_,
+ copy_data_function_, user_data_, rate_);
} else {
xbt_die("Cannot start a communication before specifying whether we are the sender or the receiver");
}
- p_state = started;
-}
-void s4u::Comm::wait() {
- xbt_assert(p_state == started || p_state == inited);
-
- if (p_state == started)
- simcall_comm_wait(p_inferior, -1/*timeout*/);
- else {// p_state == inited. Save a simcall and do directly a blocking send/recv
- if (p_srcBuff != NULL) {
- simcall_comm_send(p_sender->getInferior(), p_mailbox->getInferior(), p_remains, p_rate,
- p_srcBuff, p_srcBuffSize,
- p_matchFunction, p_copyDataFunction,
- p_userData, -1 /*timeout*/);
- } else {
- simcall_comm_recv(p_receiver->getInferior(), p_mailbox->getInferior(), p_dstBuff, &p_dstBuffSize,
- p_matchFunction, p_copyDataFunction,
- p_userData, -1/*timeout*/, p_rate);
- }
- }
- p_state = finished;
+ state_ = State::started;
+ return this;
}
-void s4u::Comm::wait(double timeout) {
- xbt_assert(p_state == started || p_state == inited);
- if (p_state == started) {
- simcall_comm_wait(p_inferior, timeout);
- p_state = finished;
- return;
- }
+/** @brief Block the calling actor until the communication is finished */
+Activity* Comm::wait()
+{
+ return this->wait(-1);
+}
- // It's not started yet. Do it in one simcall
- if (p_srcBuff != NULL) {
- simcall_comm_send(p_sender->getInferior(), p_mailbox->getInferior(), p_remains, p_rate,
- p_srcBuff, p_srcBuffSize,
- p_matchFunction, p_copyDataFunction,
- p_userData, timeout);
- } else { // Receiver
- simcall_comm_recv(p_receiver->getInferior(), p_mailbox->getInferior(), p_dstBuff, &p_dstBuffSize,
- p_matchFunction, p_copyDataFunction,
- p_userData, timeout, p_rate);
+/** @brief Block the calling actor until the communication is finished, or until timeout
+ *
+ * On timeout, an exception is thrown.
+ *
+ * @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)
+{
+ switch (state_) {
+ case State::finished:
+ return this;
+
+ case State::inited: // It's not started yet. Do it in one simcall
+ if (src_buff_ != nullptr) {
+ simcall_comm_send(sender_, mailbox_->get_impl(), remains_, rate_, src_buff_, src_buff_size_, match_fun_,
+ copy_data_function_, user_data_, timeout);
+ } else { // Receiver
+ simcall_comm_recv(receiver_, mailbox_->get_impl(), dst_buff_, &dst_buff_size_, match_fun_, copy_data_function_,
+ user_data_, timeout, rate_);
+ }
+ state_ = State::finished;
+ return this;
+
+ case State::started:
+ simcall_comm_wait(pimpl_, timeout);
+ state_ = State::finished;
+ return this;
+
+ default:
+ THROW_IMPOSSIBLE;
}
- p_state = finished;
+ return this;
+}
+int Comm::test_any(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;
}
-s4u::Comm &s4u::Comm::send_async(s4u::Actor *sender, Mailbox &dest, void *data, int simulatedSize) {
- s4u::Comm &res = s4u::Comm::send_init(sender, dest);
-
- res.setRemains(simulatedSize);
- res.p_srcBuff = data;
- res.p_srcBuffSize = sizeof(void*);
+Activity* Comm::detach()
+{
+ xbt_assert(state_ == State::inited, "You cannot detach communications once they are started (not implemented).");
+ xbt_assert(src_buff_ != nullptr && src_buff_size_ != 0, "You can only detach sends, not recvs");
+ detached_ = true;
+ return start();
+}
- res.start();
- return res;
+Activity* Comm::cancel()
+{
+ simgrid::kernel::activity::CommImplPtr commPimpl =
+ boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(pimpl_);
+ commPimpl->cancel();
+ return this;
}
-s4u::Comm &s4u::Comm::recv_async(s4u::Actor *receiver, Mailbox &dest, void **data) {
- s4u::Comm &res = s4u::Comm::recv_init(receiver, dest);
+bool Comm::test()
+{
+ xbt_assert(state_ == State::inited || state_ == State::started || state_ == State::finished);
- res.setDstData(data);
+ if (state_ == State::finished)
+ return true;
- res.start();
- return res;
+ if (state_ == State::inited)
+ this->start();
+
+ if(simcall_comm_test(pimpl_)){
+ state_ = State::finished;
+ return true;
+ }
+ return false;
}
+MailboxPtr Comm::get_mailbox()
+{
+ return mailbox_;
+}
+
+void intrusive_ptr_release(simgrid::s4u::Comm* c)
+{
+ 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);
+}
+}
+} // namespaces