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.hpp"
   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
  86 /** @brief Block the calling actor until the communication is finished */
  87 void Comm::wait() {
  88   this->wait(-1);
  89 }
  90
  91 /** @brief Block the calling actor until the communication is finished, or until timeout
  92  *
  93  * On timeout, an exception is thrown.
  94  *
  95  * @param timeout the amount of seconds to wait for the comm termination.
  96  *                Negative values denote infinite wait times. 0 as a timeout returns immediately. */
  97 void Comm::wait(double timeout) {
  98   switch (state_) {
  99     case finished:
 100       return;
 101
 102     case inited: // It's not started yet. Do it in one simcall
 103       if (srcBuff_ != nullptr) {
 104         simcall_comm_send(sender_, mailbox_->getImpl(), remains_, rate_, srcBuff_, srcBuffSize_, matchFunction_,
 105                           copyDataFunction_, userData_, timeout);
 106       } else { // Receiver
 107         simcall_comm_recv(receiver_, mailbox_->getImpl(), dstBuff_, &dstBuffSize_, matchFunction_, copyDataFunction_,
 108                           userData_, timeout, rate_);
 109       }
 110       state_ = finished;
 111       return;
 112
 113     case started:
 114       simcall_comm_wait(pimpl_, timeout);
 115       state_ = finished;
 116       return;
 117
 118     default:
 119       THROW_IMPOSSIBLE;
 120   }
 121 }
 122
 123 void Comm::detach()
 124 {
 125   xbt_assert(state_ == inited, "You cannot detach communications once they are started.");
 126   xbt_assert(srcBuff_ != nullptr && srcBuffSize_ != 0, "You can only detach sends, not recvs");
 127   detached_ = true;
 128   start();
 129 }
 130
 131 void Comm::cancel()
 132 {
 133   simgrid::kernel::activity::CommImplPtr commPimpl =
 134       boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(pimpl_);
 135   commPimpl->cancel();
 136 }
 137
 138 bool Comm::test()
 139 {
 140   xbt_assert(state_ == inited || state_ == started || state_ == finished);
 141
 142   if (state_ == finished) {
 143     return true;
 144   }
 145
 146   if (state_ == inited) {
 147     this->start();
 148   }
 149
 150   if(simcall_comm_test(pimpl_)){
 151     state_ = finished;
 152     return true;
 153   }
 154   return false;
 155 }
 156
 157 MailboxPtr Comm::getMailbox()
 158 {
 159   return mailbox_;
 160 }
 161
 162 void intrusive_ptr_release(simgrid::s4u::Comm* c)
 163 {
 164   if (c->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
 165     std::atomic_thread_fence(std::memory_order_acquire);
 166     delete c;
 167   }
 168 }
 169 void intrusive_ptr_add_ref(simgrid::s4u::Comm* c)
 170 {
 171   c->refcount_.fetch_add(1, std::memory_order_relaxed);
 172 }
 173 }
 174 } // namespaces