src/s4u/s4u_Comm.cpp

   1 /* Copyright (c) 2006-2020. 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/Exception.hpp"
  10 #include "simgrid/s4u/Comm.hpp"
  11 #include "simgrid/s4u/Mailbox.hpp"
  12
  13 #include <simgrid/comm.h>
  14
  15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_comm, s4u_activity, "S4U asynchronous communications");
  16
  17 namespace simgrid {
  18 namespace s4u {
  19 xbt::signal<void(Actor const&)> Comm::on_sender_start;
  20 xbt::signal<void(Actor const&)> Comm::on_receiver_start;
  21 xbt::signal<void(Actor const&)> Comm::on_completion;
  22
  23 Comm::~Comm()
  24 {
  25   if (state_ == State::STARTED && not detached_ &&
  26       (pimpl_ == nullptr || pimpl_->state_ == kernel::activity::State::RUNNING)) {
  27     XBT_INFO("Comm %p freed before its completion. Detached: %d, State: %d", this, detached_, (int)state_);
  28     if (pimpl_ != nullptr)
  29       XBT_INFO("pimpl_->state: %d", static_cast<int>(pimpl_->state_));
  30     else
  31       XBT_INFO("pimpl_ is null");
  32     xbt_backtrace_display_current();
  33   }
  34 }
  35
  36 int Comm::wait_any_for(const std::vector<CommPtr>* comms, double timeout)
  37 {
  38   std::unique_ptr<kernel::activity::CommImpl* []> rcomms(new kernel::activity::CommImpl*[comms->size()]);
  39   std::transform(begin(*comms), end(*comms), rcomms.get(),
  40                  [](const CommPtr& comm) { return static_cast<kernel::activity::CommImpl*>(comm->pimpl_.get()); });
  41   int changed_pos = simcall_comm_waitany(rcomms.get(), comms->size(), timeout);
  42   if (changed_pos != -1)
  43     comms->at(changed_pos)->release_dependencies();
  44   return changed_pos;
  45 }
  46
  47 void Comm::wait_all(const std::vector<CommPtr>* comms)
  48 {
  49   // TODO: this should be a simcall or something
  50   // TODO: we are missing a version with timeout
  51   for (CommPtr comm : *comms)
  52     comm->wait();
  53 }
  54
  55 CommPtr Comm::set_rate(double rate)
  56 {
  57   xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
  58              __FUNCTION__);
  59   rate_ = rate;
  60   return this;
  61 }
  62
  63 CommPtr Comm::set_src_data(void* buff)
  64 {
  65   xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
  66              __FUNCTION__);
  67   xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
  68   src_buff_ = buff;
  69   return this;
  70 }
  71
  72 CommPtr Comm::set_src_data_size(size_t size)
  73 {
  74   xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
  75              __FUNCTION__);
  76   src_buff_size_ = size;
  77   return this;
  78 }
  79
  80 CommPtr Comm::set_src_data(void* buff, size_t size)
  81 {
  82   xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
  83              __FUNCTION__);
  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
  91 CommPtr Comm::set_dst_data(void** buff)
  92 {
  93   xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
  94              __FUNCTION__);
  95   xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
  96   dst_buff_ = buff;
  97   return this;
  98 }
  99
 100 size_t Comm::get_dst_data_size()
 101 {
 102   xbt_assert(state_ == State::FINISHED, "You cannot use %s before your communication terminated", __FUNCTION__);
 103   return dst_buff_size_;
 104 }
 105 CommPtr Comm::set_dst_data(void** buff, size_t size)
 106 {
 107   xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
 108              __FUNCTION__);
 109
 110   xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
 111   dst_buff_      = buff;
 112   dst_buff_size_ = size;
 113   return this;
 114 }
 115
 116 CommPtr Comm::set_tracing_category(const std::string& category)
 117 {
 118   xbt_assert(state_ == State::INITED, "Cannot change the tracing category of an exec after its start");
 119   tracing_category_ = category;
 120   return this;
 121 }
 122
 123 Comm* Comm::start()
 124 {
 125   xbt_assert(get_state() == State::INITED || get_state() == State::STARTING,
 126              "You cannot use %s() once your communication started (not implemented)", __FUNCTION__);
 127
 128   if (src_buff_ != nullptr) { // Sender side
 129     on_sender_start(*Actor::self());
 130     pimpl_ = simcall_comm_isend(sender_, mailbox_->get_impl(), remains_, rate_, src_buff_, src_buff_size_, match_fun_,
 131                                 clean_fun_, copy_data_function_, get_user_data(), detached_);
 132   } else if (dst_buff_ != nullptr) { // Receiver side
 133     xbt_assert(not detached_, "Receive cannot be detached");
 134     on_receiver_start(*Actor::self());
 135     pimpl_ = simcall_comm_irecv(receiver_, mailbox_->get_impl(), dst_buff_, &dst_buff_size_, match_fun_,
 136                                 copy_data_function_, get_user_data(), rate_);
 137
 138   } else {
 139     xbt_die("Cannot start a communication before specifying whether we are the sender or the receiver");
 140   }
 141   state_ = State::STARTED;
 142   return this;
 143 }
 144
 145 /** @brief Block the calling actor until the communication is finished */
 146 Comm* Comm::wait()
 147 {
 148   return this->wait_for(-1);
 149 }
 150
 151 /** @brief Block the calling actor until the communication is finished, or until timeout
 152  *
 153  * On timeout, an exception is thrown and the communication is invalidated.
 154  *
 155  * @param timeout the amount of seconds to wait for the comm termination.
 156  *                Negative values denote infinite wait times. 0 as a timeout returns immediately. */
 157 Comm* Comm::wait_for(double timeout)
 158 {
 159   switch (state_) {
 160     case State::FINISHED:
 161       break;
 162
 163     case State::INITED:
 164     case State::STARTING: // It's not started yet. Do it in one simcall
 165       if (src_buff_ != nullptr) {
 166         on_sender_start(*Actor::self());
 167         simcall_comm_send(sender_, mailbox_->get_impl(), remains_, rate_, src_buff_, src_buff_size_, match_fun_,
 168                           copy_data_function_, get_user_data(), timeout);
 169
 170       } else { // Receiver
 171         on_receiver_start(*Actor::self());
 172         simcall_comm_recv(receiver_, mailbox_->get_impl(), dst_buff_, &dst_buff_size_, match_fun_, copy_data_function_,
 173                           get_user_data(), timeout, rate_);
 174       }
 175       state_ = State::FINISHED;
 176       this->release_dependencies();
 177       break;
 178
 179     case State::STARTED:
 180       simcall_comm_wait(pimpl_, timeout);
 181       on_completion(*Actor::self());
 182       state_ = State::FINISHED;
 183       this->release_dependencies();
 184       break;
 185
 186     case State::CANCELED:
 187       throw CancelException(XBT_THROW_POINT, "Communication canceled");
 188
 189     default:
 190       THROW_IMPOSSIBLE;
 191   }
 192   return this;
 193 }
 194
 195 int Comm::test_any(const std::vector<CommPtr>* comms)
 196 {
 197   std::unique_ptr<kernel::activity::CommImpl* []> rcomms(new kernel::activity::CommImpl*[comms->size()]);
 198   std::transform(begin(*comms), end(*comms), rcomms.get(),
 199                  [](const CommPtr& comm) { return static_cast<kernel::activity::CommImpl*>(comm->pimpl_.get()); });
 200   int changed_pos = simcall_comm_testany(rcomms.get(), comms->size());
 201   if (changed_pos != -1)
 202     comms->at(changed_pos)->release_dependencies();
 203   return changed_pos;
 204 }
 205
 206 Comm* Comm::detach()
 207 {
 208   xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
 209              __FUNCTION__);
 210   xbt_assert(src_buff_ != nullptr && src_buff_size_ != 0, "You can only detach sends, not recvs");
 211   detached_ = true;
 212   vetoable_start();
 213   return this;
 214 }
 215
 216 Comm* Comm::cancel()
 217 {
 218   kernel::actor::simcall([this] {
 219     if (pimpl_)
 220       boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->cancel();
 221   });
 222   state_ = State::CANCELED;
 223   return this;
 224 }
 225
 226 bool Comm::test()
 227 {
 228   xbt_assert(state_ == State::INITED || state_ == State::STARTED || state_ == State::FINISHED);
 229
 230   if (state_ == State::FINISHED)
 231     return true;
 232
 233   if (state_ == State::INITED || state_ == State::STARTING)
 234     this->vetoable_start();
 235
 236   if (simcall_comm_test(pimpl_)) {
 237     state_ = State::FINISHED;
 238     this->release_dependencies();
 239     return true;
 240   }
 241   return false;
 242 }
 243
 244 Mailbox* Comm::get_mailbox()
 245 {
 246   return mailbox_;
 247 }
 248
 249 Actor* Comm::get_sender()
 250 {
 251   return sender_ ? sender_->ciface() : nullptr;
 252 }
 253
 254 } // namespace s4u
 255 } // namespace simgrid
 256 /* **************************** Public C interface *************************** */
 257 int sg_comm_wait_any_for(sg_comm_t* comms, size_t count, double timeout)
 258 {
 259   std::vector<simgrid::s4u::CommPtr> s4u_comms;
 260   for (unsigned int i = 0; i < count; i++) {
 261     s4u_comms.emplace_back(comms[i]);
 262   }
 263   int pos = simgrid::s4u::Comm::wait_any_for(&s4u_comms, timeout);
 264   if (pos != -1)
 265     s4u_comms[pos]->unref();
 266   return pos;
 267 }