Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
tiny doc improvement
[simgrid.git] / src / s4u / s4u_Comm.cpp
index 0b57262..39a46e1 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2019. 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,6 +6,7 @@
 #include "src/msg/msg_private.hpp"
 #include "xbt/log.h"
 
+#include "simgrid/Exception.hpp"
 #include "simgrid/s4u/Comm.hpp"
 #include "simgrid/s4u/Mailbox.hpp"
 
@@ -13,6 +14,10 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_comm, s4u_activity, "S4U asynchronous commun
 
 namespace simgrid {
 namespace s4u {
+xbt::signal<void(ActorPtr)> Comm::on_sender_start;
+xbt::signal<void(ActorPtr)> Comm::on_receiver_start;
+xbt::signal<void(ActorPtr)> Comm::on_completion;
+
 Comm::~Comm()
 {
   if (state_ == State::STARTED && not detached_ && (pimpl_ == nullptr || pimpl_->state_ == SIMIX_RUNNING)) {
@@ -25,79 +30,75 @@ Comm::~Comm()
   }
 }
 
-int Comm::wait_any_for(std::vector<CommPtr>* comms_in, double timeout)
+int Comm::wait_any_for(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()); });
+  return simcall_comm_waitany(rcomms.get(), comms->size(), timeout);
 }
 
 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) {
+  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()
 {
-  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;
@@ -105,15 +106,18 @@ Activity* Comm::set_dst_data(void** buff, size_t size)
   return this;
 }
 
-Activity* Comm::start()
+Comm* Comm::start()
 {
-  xbt_assert(state_ == State::INITED);
+  xbt_assert(state_ == State::INITED, "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_);
   } 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_);
 
@@ -125,38 +129,45 @@ Activity* Comm::start()
 }
 
 /** @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
       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);
+
       } 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_);
       }
       state_ = State::FINISHED;
-      return this;
+      break;
 
     case State::STARTED:
       simcall_comm_wait(pimpl_, timeout);
+      on_completion(Actor::self());
       state_ = State::FINISHED;
-      return this;
+      break;
+
+    case State::CANCELED:
+      throw CancelException(XBT_THROW_POINT, "Communication canceled");
 
     default:
       THROW_IMPOSSIBLE;
@@ -165,26 +176,27 @@ Activity* Comm::wait(double timeout)
 }
 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;
+  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()); });
+  return simcall_comm_testany(rcomms.get(), comms->size());
 }
 
-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();
 }
 
-Activity* Comm::cancel()
+Comm* Comm::cancel()
 {
-  simgrid::simix::simcall([this] { dynamic_cast<kernel::activity::CommImpl*>(pimpl_.get())->cancel(); });
+  simix::simcall([this] {
+    if (pimpl_)
+      boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->cancel();
+  });
   state_ = State::CANCELED;
   return this;
 }
@@ -206,11 +218,16 @@ bool Comm::test()
   return false;
 }
 
-MailboxPtr Comm::get_mailbox()
+Mailbox* Comm::get_mailbox()
 {
   return mailbox_;
 }
 
+ActorPtr Comm::get_sender()
+{
+  return sender_ ? sender_->iface() : nullptr;
+}
+
 void intrusive_ptr_release(simgrid::s4u::Comm* c)
 {
   if (c->refcount_.fetch_sub(1, std::memory_order_release) == 1) {