Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
further snake_case in routing
[simgrid.git] / src / s4u / s4u_comm.cpp
index 02f5e98..f2ab1fd 100644 (file)
-/* Copyright (c) 2006-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2006-2017. 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 "msg/msg_private.h"
-#include "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_ == started && not detached_ && (pimpl_ == nullptr || pimpl_->state == SIMIX_RUNNING)) {
+    XBT_INFO("Comm %p freed before its completion. Detached: %d, State: %d", this, detached_, 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;
-}
-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;
+Activity* Comm::setRate(double rate)
+{
+  xbt_assert(state_==inited);
+  rate_ = rate;
+  return this;
 }
 
-void s4u::Comm::setRate(double rate) {
-       xbt_assert(p_state==inited);
-       p_rate = rate;
+Activity* Comm::setSrcData(void* buff)
+{
+  xbt_assert(state_==inited);
+  xbt_assert(dstBuff_ == nullptr, "Cannot set the src and dst buffers at the same time");
+  srcBuff_ = buff;
+  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::setSrcDataSize(size_t size)
+{
+  xbt_assert(state_==inited);
+  srcBuffSize_ = size;
+  return this;
 }
-void s4u::Comm::setSrcDataSize(size_t size){
-       xbt_assert(p_state==inited);
-       p_srcBuffSize = size;
+Activity* Comm::setSrcData(void* buff, size_t size)
+{
+  xbt_assert(state_==inited);
+
+  xbt_assert(dstBuff_ == nullptr, "Cannot set the src and dst buffers at the same time");
+  srcBuff_ = buff;
+  srcBuffSize_ = 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::setDstData(void** buff)
+{
+  xbt_assert(state_==inited);
+  xbt_assert(srcBuff_ == nullptr, "Cannot set the src and dst buffers at the same time");
+  dstBuff_ = buff;
+  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;
+size_t Comm::getDstDataSize(){
+  xbt_assert(state_==finished);
+  return dstBuffSize_;
 }
-size_t s4u::Comm::getDstDataSize(){
-       xbt_assert(p_state==finished);
-       return p_dstBuffSize;
+Activity* Comm::setDstData(void** buff, size_t size)
+{
+  xbt_assert(state_==inited);
+
+  xbt_assert(srcBuff_ == nullptr, "Cannot set the src and dst buffers at the same time");
+  dstBuff_ = buff;
+  dstBuffSize_ = size;
+  return this;
 }
-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::start()
+{
+  xbt_assert(state_ == inited);
+
+  if (srcBuff_ != nullptr) { // Sender side
+    pimpl_ = simcall_comm_isend(sender_, mailbox_->getImpl(), remains_, rate_, srcBuff_, srcBuffSize_, matchFunction_,
+                                cleanFunction_, copyDataFunction_, user_data_, detached_);
+  } else if (dstBuff_ != nullptr) { // Receiver side
+    xbt_assert(not detached_, "Receive cannot be detached");
+    pimpl_ = simcall_comm_irecv(receiver_, mailbox_->getImpl(), dstBuff_, &dstBuffSize_, matchFunction_,
+                                copyDataFunction_, user_data_, rate_);
+
+  } else {
+    xbt_die("Cannot start a communication before specifying whether we are the sender or the receiver");
+  }
+  state_ = started;
+  return this;
 }
 
-void s4u::Comm::start() {
-       xbt_assert(p_state == inited);
+/** @brief Block the calling actor until the communication is finished */
+Activity* Comm::wait()
+{
+  return this->wait(-1);
+}
 
-       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);
+/** @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 finished:
+      return this;
+
+    case inited: // It's not started yet. Do it in one simcall
+      if (srcBuff_ != nullptr) {
+        simcall_comm_send(sender_, mailbox_->getImpl(), remains_, rate_, srcBuff_, srcBuffSize_, matchFunction_,
+                          copyDataFunction_, user_data_, timeout);
+      } else { // Receiver
+        simcall_comm_recv(receiver_, mailbox_->getImpl(), dstBuff_, &dstBuffSize_, matchFunction_, copyDataFunction_,
+                          user_data_, timeout, rate_);
+      }
+      state_ = finished;
+      return this;
+
+    case started:
+      simcall_comm_wait(pimpl_, timeout);
+      state_ = finished;
+      return this;
+
+    default:
+      THROW_IMPOSSIBLE;
+  }
+  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;
+}
 
-       } else {
-               xbt_die("Cannot start a communication before specifying whether we are the sender or the receiver");
-       }
-       p_state = started;
+Activity* Comm::detach()
+{
+  xbt_assert(state_ == inited, "You cannot detach communications once they are started.");
+  xbt_assert(srcBuff_ != nullptr && srcBuffSize_ != 0, "You can only detach sends, not recvs");
+  detached_ = true;
+  return start();
 }
-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;
+Activity* Comm::cancel()
+{
+  simgrid::kernel::activity::CommImplPtr commPimpl =
+      boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(pimpl_);
+  commPimpl->cancel();
+  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;
-       }
+bool Comm::test()
+{
+  xbt_assert(state_ == inited || state_ == started || state_ == finished);
+
+  if (state_ == finished) {
+    return true;
+  }
+
+  if (state_ == inited) {
+    this->start();
+  }
 
-       // 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);
-       }
-       p_state = finished;
+  if(simcall_comm_test(pimpl_)){
+    state_ = finished;
+    return true;
+  }
+  return false;
 }
 
-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*);
-
-       res.start();
-       return res;
-}
-
-s4u::Comm &s4u::Comm::recv_async(s4u::Actor *receiver, Mailbox &dest, void **data) {
-       s4u::Comm &res = s4u::Comm::recv_init(receiver, dest);
-
-       res.setDstData(data);
-
-       res.start();
-       return res;
+MailboxPtr Comm::getMailbox()
+{
+  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