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 }
  27
  28 void Comm::setRate(double rate) {
  29   xbt_assert(state_==inited);
  30   rate_ = rate;
  31 }
  32
  33 void Comm::setSrcData(void * buff) {
  34   xbt_assert(state_==inited);
  35   xbt_assert(dstBuff_ == nullptr, "Cannot set the src and dst buffers at the same time");
  36   srcBuff_ = buff;
  37 }
  38 void Comm::setSrcDataSize(size_t size){
  39   xbt_assert(state_==inited);
  40   srcBuffSize_ = size;
  41 }
  42 void Comm::setSrcData(void * buff, size_t size) {
  43   xbt_assert(state_==inited);
  44
  45   xbt_assert(dstBuff_ == nullptr, "Cannot set the src and dst buffers at the same time");
  46   srcBuff_ = buff;
  47   srcBuffSize_ = size;
  48 }
  49 void Comm::setDstData(void ** buff) {
  50   xbt_assert(state_==inited);
  51   xbt_assert(srcBuff_ == nullptr, "Cannot set the src and dst buffers at the same time");
  52   dstBuff_ = buff;
  53 }
  54 size_t Comm::getDstDataSize(){
  55   xbt_assert(state_==finished);
  56   return dstBuffSize_;
  57 }
  58 void Comm::setDstData(void ** buff, size_t size) {
  59   xbt_assert(state_==inited);
  60
  61   xbt_assert(srcBuff_ == nullptr, "Cannot set the src and dst buffers at the same time");
  62   dstBuff_ = buff;
  63   dstBuffSize_ = size;
  64 }
  65
  66 void Comm::start() {
  67   xbt_assert(state_ == inited);
  68
  69   if (srcBuff_ != nullptr) { // Sender side
  70     pimpl_ = simcall_comm_isend(sender_, mailbox_->getImpl(), remains_, rate_,
  71         srcBuff_, srcBuffSize_,
  72         matchFunction_, cleanFunction_, copyDataFunction_,
  73         userData_, detached_);
  74   } else if (dstBuff_ != nullptr) { // Receiver side
  75     xbt_assert(not detached_, "Receive cannot be detached");
  76     pimpl_ = simcall_comm_irecv(receiver_, mailbox_->getImpl(), dstBuff_, &dstBuffSize_,
  77         matchFunction_, copyDataFunction_,
  78         userData_, rate_);
  79
  80   } else {
  81     xbt_die("Cannot start a communication before specifying whether we are the sender or the receiver");
  82   }
  83   state_ = started;
  84 }
  85 void Comm::wait() {
  86   xbt_assert(state_ == started || state_ == inited);
  87
  88   if (state_ == started)
  89     simcall_comm_wait(pimpl_, -1/*timeout*/);
  90   else { // state_ == inited. Save a simcall and do directly a blocking send/recv
  91     if (srcBuff_ != nullptr) {
  92       simcall_comm_send(sender_, mailbox_->getImpl(), remains_, rate_,
  93           srcBuff_, srcBuffSize_,
  94           matchFunction_, copyDataFunction_,
  95           userData_, -1 /*timeout*/);
  96     } else {
  97       simcall_comm_recv(receiver_, mailbox_->getImpl(), dstBuff_, &dstBuffSize_,
  98           matchFunction_, copyDataFunction_,
  99           userData_, -1/*timeout*/, rate_);
 100     }
 101   }
 102   state_ = finished;
 103 }
 104
 105 void Comm::wait(double timeout) {
 106   xbt_assert(state_ == started || state_ == inited);
 107
 108   if (state_ == started) {
 109     simcall_comm_wait(pimpl_, timeout);
 110     state_ = finished;
 111     return;
 112   }
 113
 114   // It's not started yet. Do it in one simcall
 115   if (srcBuff_ != nullptr) {
 116     simcall_comm_send(sender_, mailbox_->getImpl(), remains_, rate_,
 117         srcBuff_, srcBuffSize_,
 118         matchFunction_, copyDataFunction_,
 119         userData_, timeout);
 120   } else { // Receiver
 121     simcall_comm_recv(receiver_, mailbox_->getImpl(), dstBuff_, &dstBuffSize_,
 122         matchFunction_, copyDataFunction_,
 123         userData_, timeout, rate_);
 124   }
 125   state_ = finished;
 126 }
 127
 128 void Comm::detach()
 129 {
 130   xbt_assert(state_ == inited, "You cannot detach communications once they are started.");
 131   xbt_assert(srcBuff_ != nullptr && srcBuffSize_ != 0, "You can only detach sends, not recvs");
 132   detached_ = true;
 133   start();
 134 }
 135
 136 void Comm::cancel()
 137 {
 138   simgrid::kernel::activity::CommImplPtr commPimpl =
 139       boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(pimpl_);
 140   commPimpl->cancel();
 141 }
 142
 143 bool Comm::test() {
 144   xbt_assert(state_ == inited || state_ == started || state_ == finished);
 145
 146   if (state_ == finished) {
 147     return true;
 148   }
 149
 150   if (state_ == inited) {
 151     this->start();
 152   }
 153
 154   if(simcall_comm_test(pimpl_)){
 155     state_ = finished;
 156     return true;
 157   }
 158   return false;
 159 }
 160
 161 void intrusive_ptr_release(simgrid::s4u::Comm* c)
 162 {
 163   if (c->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
 164     std::atomic_thread_fence(std::memory_order_acquire);
 165     delete c;
 166   }
 167 }
 168 void intrusive_ptr_add_ref(simgrid::s4u::Comm* c)
 169 {
 170   c->refcount_.fetch_add(1, std::memory_order_relaxed);
 171 }
 172 }
 173 } // namespaces