src/s4u/s4u_comm.cpp

   1 /* Copyright (c) 2006-2017. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "xbt/log.h"
   7 #include "src/msg/msg_private.h"
   8
   9 #include "simgrid/s4u/Comm.hpp"
  10 #include "simgrid/s4u/Mailbox.hpp"
  11
  12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_comm,s4u_activity,"S4U asynchronous communications");
  13
  14 namespace simgrid {
  15 namespace s4u {
  16 Comm::~Comm()
  17 {
  18   if (state_ == started && not detached_ && (pimpl_ == nullptr || pimpl_->state == SIMIX_RUNNING)) {
  19     XBT_INFO("Comm %p freed before its completion. Detached: %d, State: %d", this, detached_, state_);
  20     if (pimpl_ != nullptr)
  21       XBT_INFO("pimpl_->state: %d", pimpl_->state);
  22     else
  23       XBT_INFO("pimpl_ is null");
  24     xbt_backtrace_display_current();
  25   }
  26   if (pimpl_)
  27     pimpl_->unref();
  28 }
  29
  30 s4u::CommPtr Comm::send_init(s4u::MailboxPtr chan)
  31 {
  32   CommPtr res   = CommPtr(new s4u::Comm());
  33   res->sender_ = SIMIX_process_self();
  34   res->mailbox_ = chan;
  35   return res;
  36 }
  37
  38 s4u::CommPtr Comm::recv_init(s4u::MailboxPtr chan)
  39 {
  40   CommPtr res    = CommPtr(new s4u::Comm());
  41   res->receiver_ = SIMIX_process_self();
  42   res->mailbox_ = chan;
  43   return res;
  44 }
  45
  46 void Comm::setRate(double rate) {
  47   xbt_assert(state_==inited);
  48   rate_ = rate;
  49 }
  50
  51 void Comm::setSrcData(void * buff) {
  52   xbt_assert(state_==inited);
  53   xbt_assert(dstBuff_ == nullptr, "Cannot set the src and dst buffers at the same time");
  54   srcBuff_ = buff;
  55 }
  56 void Comm::setSrcDataSize(size_t size){
  57   xbt_assert(state_==inited);
  58   srcBuffSize_ = size;
  59 }
  60 void Comm::setSrcData(void * buff, size_t size) {
  61   xbt_assert(state_==inited);
  62
  63   xbt_assert(dstBuff_ == nullptr, "Cannot set the src and dst buffers at the same time");
  64   srcBuff_ = buff;
  65   srcBuffSize_ = size;
  66 }
  67 void Comm::setDstData(void ** buff) {
  68   xbt_assert(state_==inited);
  69   xbt_assert(srcBuff_ == nullptr, "Cannot set the src and dst buffers at the same time");
  70   dstBuff_ = buff;
  71 }
  72 size_t Comm::getDstDataSize(){
  73   xbt_assert(state_==finished);
  74   return dstBuffSize_;
  75 }
  76 void Comm::setDstData(void ** buff, size_t size) {
  77   xbt_assert(state_==inited);
  78
  79   xbt_assert(srcBuff_ == nullptr, "Cannot set the src and dst buffers at the same time");
  80   dstBuff_ = buff;
  81   dstBuffSize_ = size;
  82 }
  83
  84 void Comm::start() {
  85   xbt_assert(state_ == inited);
  86
  87   if (srcBuff_ != nullptr) { // Sender side
  88     pimpl_ = simcall_comm_isend(sender_, mailbox_->getImpl(), remains_, rate_,
  89         srcBuff_, srcBuffSize_,
  90         matchFunction_, cleanFunction_, copyDataFunction_,
  91         userData_, detached_);
  92   } else if (dstBuff_ != nullptr) { // Receiver side
  93     pimpl_ = simcall_comm_irecv(receiver_, mailbox_->getImpl(), dstBuff_, &dstBuffSize_,
  94         matchFunction_, copyDataFunction_,
  95         userData_, rate_);
  96
  97   } else {
  98     xbt_die("Cannot start a communication before specifying whether we are the sender or the receiver");
  99   }
 100   state_ = started;
 101 }
 102 void Comm::wait() {
 103   xbt_assert(state_ == started || state_ == inited);
 104
 105   if (state_ == started)
 106     simcall_comm_wait(pimpl_, -1/*timeout*/);
 107   else { // state_ == inited. Save a simcall and do directly a blocking send/recv
 108     if (srcBuff_ != nullptr) {
 109       simcall_comm_send(sender_, mailbox_->getImpl(), remains_, rate_,
 110           srcBuff_, srcBuffSize_,
 111           matchFunction_, copyDataFunction_,
 112           userData_, -1 /*timeout*/);
 113     } else {
 114       simcall_comm_recv(receiver_, mailbox_->getImpl(), dstBuff_, &dstBuffSize_,
 115           matchFunction_, copyDataFunction_,
 116           userData_, -1/*timeout*/, rate_);
 117     }
 118   }
 119   state_ = finished;
 120 }
 121 void Comm::wait(double timeout) {
 122   xbt_assert(state_ == started || state_ == inited);
 123
 124   if (state_ == started) {
 125     simcall_comm_wait(pimpl_, timeout);
 126     state_ = finished;
 127     return;
 128   }
 129
 130   // It's not started yet. Do it in one simcall
 131   if (srcBuff_ != nullptr) {
 132     simcall_comm_send(sender_, mailbox_->getImpl(), remains_, rate_,
 133         srcBuff_, srcBuffSize_,
 134         matchFunction_, copyDataFunction_,
 135         userData_, timeout);
 136   } else { // Receiver
 137     simcall_comm_recv(receiver_, mailbox_->getImpl(), dstBuff_, &dstBuffSize_,
 138         matchFunction_, copyDataFunction_,
 139         userData_, timeout, rate_);
 140   }
 141   state_ = finished;
 142 }
 143
 144 void Comm::send_detached(MailboxPtr dest, void* data, int simulatedSize)
 145 {
 146   s4u::CommPtr res = CommPtr(s4u::Comm::send_init(dest));
 147   res->setRemains(simulatedSize);
 148   res->srcBuff_     = data;
 149   res->srcBuffSize_ = sizeof(void*);
 150   res->detached_    = true;
 151   res->start();
 152 }
 153 s4u::CommPtr Comm::send_async(MailboxPtr dest, void* data, int simulatedSize)
 154 {
 155   s4u::CommPtr res = CommPtr(s4u::Comm::send_init(dest));
 156   res->setRemains(simulatedSize);
 157   res->srcBuff_     = data;
 158   res->srcBuffSize_ = sizeof(void*);
 159   res->start();
 160   return res;
 161 }
 162
 163 s4u::CommPtr Comm::recv_async(MailboxPtr dest, void** data)
 164 {
 165   s4u::CommPtr res = CommPtr(s4u::Comm::recv_init(dest));
 166   res->setDstData(data, sizeof(*data));
 167   res->start();
 168   return res;
 169 }
 170
 171 void Comm::cancel()
 172 {
 173   simgrid::kernel::activity::CommImpl* commPimpl = static_cast<simgrid::kernel::activity::CommImpl*>(pimpl_);
 174   commPimpl->cancel();
 175 }
 176 bool Comm::test() {
 177   xbt_assert(state_ == inited || state_ == started || state_ == finished);
 178
 179   if (state_ == finished)
 180     xbt_die("Don't call test on a finished comm.");
 181
 182   if (state_ == inited) {
 183     this->start();
 184   }
 185
 186   if(simcall_comm_test(pimpl_)){
 187     state_ = finished;
 188     return true;
 189   }
 190   return false;
 191 }
 192
 193 void intrusive_ptr_release(simgrid::s4u::Comm* c)
 194 {
 195   if (c->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
 196     std::atomic_thread_fence(std::memory_order_acquire);
 197     delete c;
 198   }
 199 }
 200 void intrusive_ptr_add_ref(simgrid::s4u::Comm* c)
 201 {
 202   c->refcount_.fetch_add(1, std::memory_order_relaxed);
 203 }
 204 }
 205 } // namespaces