src/s4u/s4u_Comm.cpp

   1 /* Copyright (c) 2006-2018. 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 "src/msg/msg_private.hpp"
   7 #include "xbt/log.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 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Comm::on_sender_start;
  17 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Comm::on_receiver_start;
  18 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Comm::on_completion;
  19
  20 Comm::~Comm()
  21 {
  22   if (state_ == State::STARTED && not detached_ && (pimpl_ == nullptr || pimpl_->state_ == SIMIX_RUNNING)) {
  23     XBT_INFO("Comm %p freed before its completion. Detached: %d, State: %d", this, detached_, (int)state_);
  24     if (pimpl_ != nullptr)
  25       XBT_INFO("pimpl_->state: %d", pimpl_->state_);
  26     else
  27       XBT_INFO("pimpl_ is null");
  28     xbt_backtrace_display_current();
  29   }
  30 }
  31
  32 int Comm::wait_any_for(std::vector<CommPtr>* comms_in, double timeout)
  33 {
  34   // Map to dynar<Synchro*>:
  35   xbt_dynar_t comms = xbt_dynar_new(sizeof(simgrid::kernel::activity::ActivityImpl*), [](void* ptr) {
  36     intrusive_ptr_release(*(simgrid::kernel::activity::ActivityImpl**)ptr);
  37   });
  38   for (auto const& comm : *comms_in) {
  39     if (comm->state_ == Activity::State::INITED)
  40       comm->start();
  41     xbt_assert(comm->state_ == Activity::State::STARTED);
  42     simgrid::kernel::activity::ActivityImpl* ptr = comm->pimpl_.get();
  43     intrusive_ptr_add_ref(ptr);
  44     xbt_dynar_push_as(comms, simgrid::kernel::activity::ActivityImpl*, ptr);
  45   }
  46   // Call the underlying simcall:
  47   int idx = simcall_comm_waitany(comms, timeout);
  48   xbt_dynar_free(&comms);
  49   return idx;
  50 }
  51
  52 void Comm::wait_all(std::vector<CommPtr>* comms)
  53 {
  54   // TODO: this should be a simcall or something
  55   // TODO: we are missing a version with timeout
  56   for (CommPtr comm : *comms) {
  57     comm->wait();
  58   }
  59 }
  60
  61 Activity* Comm::set_rate(double rate)
  62 {
  63   xbt_assert(state_ == State::INITED);
  64   rate_ = rate;
  65   return this;
  66 }
  67
  68 Activity* Comm::set_src_data(void* buff)
  69 {
  70   xbt_assert(state_ == State::INITED);
  71   xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
  72   src_buff_ = buff;
  73   return this;
  74 }
  75 Activity* Comm::set_src_data_size(size_t size)
  76 {
  77   xbt_assert(state_ == State::INITED);
  78   src_buff_size_ = size;
  79   return this;
  80 }
  81 Activity* Comm::set_src_data(void* buff, size_t size)
  82 {
  83   xbt_assert(state_ == State::INITED);
  84
  85   xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
  86   src_buff_      = buff;
  87   src_buff_size_ = size;
  88   return this;
  89 }
  90 Activity* Comm::set_dst_data(void** buff)
  91 {
  92   xbt_assert(state_ == State::INITED);
  93   xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
  94   dst_buff_ = buff;
  95   return this;
  96 }
  97 size_t Comm::get_dst_data_size()
  98 {
  99   xbt_assert(state_ == State::FINISHED);
 100   return dst_buff_size_;
 101 }
 102 Activity* Comm::set_dst_data(void** buff, size_t size)
 103 {
 104   xbt_assert(state_ == State::INITED);
 105
 106   xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
 107   dst_buff_      = buff;
 108   dst_buff_size_ = size;
 109   return this;
 110 }
 111
 112 Activity* Comm::start()
 113 {
 114   xbt_assert(state_ == State::INITED);
 115
 116   if (src_buff_ != nullptr) { // Sender side
 117     on_sender_start(Actor::self());
 118     pimpl_ = simcall_comm_isend(sender_, mailbox_->get_impl(), remains_, rate_, src_buff_, src_buff_size_, match_fun_,
 119                                 clean_fun_, copy_data_function_, user_data_, detached_);
 120   } else if (dst_buff_ != nullptr) { // Receiver side
 121     xbt_assert(not detached_, "Receive cannot be detached");
 122     on_receiver_start(Actor::self());
 123     pimpl_ = simcall_comm_irecv(receiver_, mailbox_->get_impl(), dst_buff_, &dst_buff_size_, match_fun_,
 124                                 copy_data_function_, user_data_, rate_);
 125
 126   } else {
 127     xbt_die("Cannot start a communication before specifying whether we are the sender or the receiver");
 128   }
 129   state_ = State::STARTED;
 130   return this;
 131 }
 132
 133 /** @brief Block the calling actor until the communication is finished */
 134 Activity* Comm::wait()
 135 {
 136   return this->wait(-1);
 137 }
 138
 139 /** @brief Block the calling actor until the communication is finished, or until timeout
 140  *
 141  * On timeout, an exception is thrown.
 142  *
 143  * @param timeout the amount of seconds to wait for the comm termination.
 144  *                Negative values denote infinite wait times. 0 as a timeout returns immediately. */
 145 Activity* Comm::wait(double timeout)
 146 {
 147   switch (state_) {
 148     case State::FINISHED:
 149       return this;
 150
 151     case State::INITED: // It's not started yet. Do it in one simcall
 152       if (src_buff_ != nullptr) {
 153         on_sender_start(Actor::self());
 154         simcall_comm_send(sender_, mailbox_->get_impl(), remains_, rate_, src_buff_, src_buff_size_, match_fun_,
 155                           copy_data_function_, user_data_, timeout);
 156
 157       } else { // Receiver
 158         on_receiver_start(Actor::self());
 159         simcall_comm_recv(receiver_, mailbox_->get_impl(), dst_buff_, &dst_buff_size_, match_fun_, copy_data_function_,
 160                           user_data_, timeout, rate_);
 161       }
 162       state_ = State::FINISHED;
 163       return this;
 164
 165     case State::STARTED:
 166       simcall_comm_wait(pimpl_, timeout);
 167       on_completion(Actor::self());
 168       state_ = State::FINISHED;
 169       return this;
 170
 171     default:
 172       THROW_IMPOSSIBLE;
 173   }
 174   return this;
 175 }
 176 int Comm::test_any(std::vector<CommPtr>* comms)
 177 {
 178   smx_activity_t* array = new smx_activity_t[comms->size()];
 179   for (unsigned int i = 0; i < comms->size(); i++) {
 180     array[i] = comms->at(i)->pimpl_;
 181   }
 182   int res = simcall_comm_testany(array, comms->size());
 183   delete[] array;
 184   return res;
 185 }
 186
 187 Activity* Comm::detach()
 188 {
 189   xbt_assert(state_ == State::INITED, "You cannot detach communications once they are started (not implemented).");
 190   xbt_assert(src_buff_ != nullptr && src_buff_size_ != 0, "You can only detach sends, not recvs");
 191   detached_ = true;
 192   return start();
 193 }
 194
 195 Activity* Comm::cancel()
 196 {
 197   simgrid::simix::simcall([this] { dynamic_cast<kernel::activity::CommImpl*>(pimpl_.get())->cancel(); });
 198   state_ = State::CANCELED;
 199   return this;
 200 }
 201
 202 bool Comm::test()
 203 {
 204   xbt_assert(state_ == State::INITED || state_ == State::STARTED || state_ == State::FINISHED);
 205
 206   if (state_ == State::FINISHED)
 207     return true;
 208
 209   if (state_ == State::INITED)
 210     this->start();
 211
 212   if (simcall_comm_test(pimpl_)) {
 213     state_ = State::FINISHED;
 214     return true;
 215   }
 216   return false;
 217 }
 218
 219 MailboxPtr Comm::get_mailbox()
 220 {
 221   return mailbox_;
 222 }
 223
 224 void intrusive_ptr_release(simgrid::s4u::Comm* c)
 225 {
 226   if (c->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
 227     std::atomic_thread_fence(std::memory_order_acquire);
 228     delete c;
 229   }
 230 }
 231 void intrusive_ptr_add_ref(simgrid::s4u::Comm* c)
 232 {
 233   c->refcount_.fetch_add(1, std::memory_order_relaxed);
 234 }
 235 } // namespace s4u
 236 } // namespace simgrid