src/s4u/s4u_Comm.cpp

   1 /* Copyright (c) 2006-2021. 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(Comm const&, bool is_sender)> Comm::on_start;
  20 xbt::signal<void(Comm const&)> Comm::on_completion;
  21
  22 Comm::~Comm()
  23 {
  24   if (state_ == State::STARTED && not detached_ &&
  25       (pimpl_ == nullptr || pimpl_->state_ == kernel::activity::State::RUNNING)) {
  26     XBT_INFO("Comm %p freed before its completion. Detached: %d, State: %d", this, detached_, (int)state_);
  27     if (pimpl_ != nullptr)
  28       XBT_INFO("pimpl_->state: %d", static_cast<int>(pimpl_->state_));
  29     else
  30       XBT_INFO("pimpl_ is null");
  31     xbt_backtrace_display_current();
  32   }
  33 }
  34
  35 int Comm::wait_any_for(const std::vector<CommPtr>* comms, double timeout)
  36 {
  37   std::vector<kernel::activity::CommImpl*> rcomms(comms->size());
  38   std::transform(begin(*comms), end(*comms), begin(rcomms),
  39                  [](const CommPtr& comm) { return static_cast<kernel::activity::CommImpl*>(comm->pimpl_.get()); });
  40   int changed_pos = simcall_comm_waitany(rcomms.data(), rcomms.size(), timeout);
  41   if (changed_pos != -1)
  42     comms->at(changed_pos)->release_dependencies();
  43   return changed_pos;
  44 }
  45
  46 void Comm::wait_all(const std::vector<CommPtr>* comms)
  47 {
  48   // TODO: this should be a simcall or something
  49   // TODO: we are missing a version with timeout
  50   for (CommPtr comm : *comms)
  51     comm->wait();
  52 }
  53
  54 CommPtr Comm::set_rate(double rate)
  55 {
  56   xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
  57              __FUNCTION__);
  58   rate_ = rate;
  59   return this;
  60 }
  61
  62 CommPtr Comm::set_src_data(void* buff)
  63 {
  64   xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
  65              __FUNCTION__);
  66   xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
  67   src_buff_ = buff;
  68   return this;
  69 }
  70
  71 CommPtr Comm::set_src_data_size(size_t size)
  72 {
  73   xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
  74              __FUNCTION__);
  75   src_buff_size_ = size;
  76   return this;
  77 }
  78
  79 CommPtr Comm::set_src_data(void* buff, size_t size)
  80 {
  81   xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
  82              __FUNCTION__);
  83
  84   xbt_assert(dst_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
  85   src_buff_      = buff;
  86   src_buff_size_ = size;
  87   return this;
  88 }
  89
  90 CommPtr Comm::set_dst_data(void** buff)
  91 {
  92   xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
  93              __FUNCTION__);
  94   xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
  95   dst_buff_ = buff;
  96   return this;
  97 }
  98 void* Comm::get_dst_data()
  99 {
 100   return dst_buff_;
 101 }
 102
 103 size_t Comm::get_dst_data_size() const
 104 {
 105   return dst_buff_size_;
 106 }
 107 CommPtr Comm::set_dst_data(void** buff, size_t size)
 108 {
 109   xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
 110              __FUNCTION__);
 111
 112   xbt_assert(src_buff_ == nullptr, "Cannot set the src and dst buffers at the same time");
 113   dst_buff_      = buff;
 114   dst_buff_size_ = size;
 115   return this;
 116 }
 117
 118 Comm* Comm::start()
 119 {
 120   xbt_assert(get_state() == State::INITED || get_state() == State::STARTING,
 121              "You cannot use %s() once your communication started (not implemented)", __FUNCTION__);
 122
 123   if (src_buff_ != nullptr) { // Sender side
 124     on_start(*this, true /* is_sender*/);
 125     pimpl_ = simcall_comm_isend(sender_, mailbox_->get_impl(), remains_, rate_, src_buff_, src_buff_size_, match_fun_,
 126                                 clean_fun_, copy_data_function_, get_user_data(), detached_);
 127   } else if (dst_buff_ != nullptr) { // Receiver side
 128     xbt_assert(not detached_, "Receive cannot be detached");
 129     on_start(*this, false /*is_sender*/);
 130     pimpl_ = simcall_comm_irecv(receiver_, mailbox_->get_impl(), dst_buff_, &dst_buff_size_, match_fun_,
 131                                 copy_data_function_, get_user_data(), rate_);
 132
 133   } else {
 134     xbt_die("Cannot start a communication before specifying whether we are the sender or the receiver");
 135   }
 136
 137   if (suspended_)
 138     pimpl_->suspend();
 139
 140   state_ = State::STARTED;
 141   return this;
 142 }
 143
 144 /** @brief Block the calling actor until the communication is finished */
 145 Comm* Comm::wait()
 146 {
 147   return this->wait_for(-1);
 148 }
 149
 150 /** @brief Block the calling actor until the communication is finished, or until timeout
 151  *
 152  * On timeout, an exception is thrown and the communication is invalidated.
 153  *
 154  * @param timeout the amount of seconds to wait for the comm termination.
 155  *                Negative values denote infinite wait times. 0 as a timeout returns immediately. */
 156 Comm* Comm::wait_for(double timeout)
 157 {
 158   switch (state_) {
 159     case State::FINISHED:
 160       break;
 161
 162     case State::INITED:
 163     case State::STARTING: // It's not started yet. Do it in one simcall
 164       if (src_buff_ != nullptr) {
 165         on_start(*this, true /*is_sender*/);
 166         simcall_comm_send(sender_, mailbox_->get_impl(), remains_, rate_, src_buff_, src_buff_size_, match_fun_,
 167                           copy_data_function_, get_user_data(), timeout);
 168
 169       } else { // Receiver
 170         on_start(*this, false /*is_sender*/);
 171         simcall_comm_recv(receiver_, mailbox_->get_impl(), dst_buff_, &dst_buff_size_, match_fun_, copy_data_function_,
 172                           get_user_data(), timeout, rate_);
 173       }
 174       state_ = State::FINISHED;
 175       this->release_dependencies();
 176       break;
 177
 178     case State::STARTED:
 179       simcall_comm_wait(get_impl(), timeout);
 180       state_ = State::FINISHED;
 181       this->release_dependencies();
 182       break;
 183
 184     case State::CANCELED:
 185       throw CancelException(XBT_THROW_POINT, "Communication canceled");
 186
 187     default:
 188       THROW_IMPOSSIBLE;
 189   }
 190   on_completion(*this);
 191   return this;
 192 }
 193
 194 int Comm::test_any(const std::vector<CommPtr>* comms)
 195 {
 196   std::vector<kernel::activity::CommImpl*> rcomms(comms->size());
 197   std::transform(begin(*comms), end(*comms), begin(rcomms),
 198                  [](const CommPtr& comm) { return static_cast<kernel::activity::CommImpl*>(comm->pimpl_.get()); });
 199   int changed_pos = simcall_comm_testany(rcomms.data(), rcomms.size());
 200   if (changed_pos != -1)
 201     comms->at(changed_pos)->release_dependencies();
 202   return changed_pos;
 203 }
 204
 205 Comm* Comm::detach()
 206 {
 207   xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
 208              __FUNCTION__);
 209   xbt_assert(src_buff_ != nullptr && src_buff_size_ != 0, "You can only detach sends, not recvs");
 210   detached_ = true;
 211   vetoable_start();
 212   return this;
 213 }
 214
 215 Comm* Comm::cancel()
 216 {
 217   kernel::actor::simcall([this] {
 218     if (pimpl_)
 219       boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->cancel();
 220   });
 221   state_ = State::CANCELED;
 222   return this;
 223 }
 224
 225 bool Comm::test()
 226 {
 227   xbt_assert(state_ == State::INITED || state_ == State::STARTED || state_ == State::STARTING ||
 228              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(get_impl())) {
 237     state_ = State::FINISHED;
 238     this->release_dependencies();
 239     return true;
 240   }
 241   return false;
 242 }
 243
 244 Mailbox* Comm::get_mailbox() const
 245 {
 246   return mailbox_;
 247 }
 248
 249 Actor* Comm::get_sender() const
 250 {
 251   kernel::actor::ActorImplPtr sender = nullptr;
 252   if (pimpl_)
 253     sender = boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->src_actor_;
 254   return sender ? sender->get_ciface() : nullptr;
 255 }
 256
 257 } // namespace s4u
 258 } // namespace simgrid
 259 /* **************************** Public C interface *************************** */
 260 void sg_comm_detach(sg_comm_t comm, void (*clean_function)(void*))
 261 {
 262   comm->detach(clean_function);
 263   comm->unref();
 264 }
 265 void sg_comm_unref(sg_comm_t comm)
 266 {
 267   comm->unref();
 268 }
 269 int sg_comm_test(sg_comm_t comm)
 270 {
 271   bool finished = comm->test();
 272   if (finished)
 273     comm->unref();
 274   return finished;
 275 }
 276
 277 sg_error_t sg_comm_wait(sg_comm_t comm)
 278 {
 279   sg_error_t status = SG_OK;
 280
 281   simgrid::s4u::CommPtr s4u_comm(comm, false);
 282   try {
 283     s4u_comm->wait_for(-1);
 284   } catch (const simgrid::TimeoutException&) {
 285     status = SG_ERROR_TIMEOUT;
 286   } catch (const simgrid::CancelException&) {
 287     status = SG_ERROR_CANCELED;
 288   } catch (const simgrid::NetworkFailureException&) {
 289     status = SG_ERROR_NETWORK;
 290   }
 291   return status;
 292 }
 293
 294 sg_error_t sg_comm_wait_for(sg_comm_t comm, double timeout)
 295 {
 296   sg_error_t status = SG_OK;
 297
 298   simgrid::s4u::CommPtr s4u_comm(comm, false);
 299   try {
 300     s4u_comm->wait_for(timeout);
 301   } catch (const simgrid::TimeoutException&) {
 302     status = SG_ERROR_TIMEOUT;
 303   } catch (const simgrid::CancelException&) {
 304     status = SG_ERROR_CANCELED;
 305   } catch (const simgrid::NetworkFailureException&) {
 306     status = SG_ERROR_NETWORK;
 307   }
 308   return status;
 309 }
 310
 311 void sg_comm_wait_all(sg_comm_t* comms, size_t count)
 312 {
 313   std::vector<simgrid::s4u::CommPtr> s4u_comms;
 314   for (unsigned int i = 0; i < count; i++)
 315     s4u_comms.emplace_back(comms[i], false);
 316
 317   simgrid::s4u::Comm::wait_all(&s4u_comms);
 318 }
 319
 320 int sg_comm_wait_any(sg_comm_t* comms, size_t count)
 321 {
 322   return sg_comm_wait_any_for(comms, count, -1);
 323 }
 324
 325 int sg_comm_wait_any_for(sg_comm_t* comms, size_t count, double timeout)
 326 {
 327   std::vector<simgrid::s4u::CommPtr> s4u_comms;
 328   for (unsigned int i = 0; i < count; i++)
 329     s4u_comms.emplace_back(comms[i], false);
 330
 331   int pos = simgrid::s4u::Comm::wait_any_for(&s4u_comms, timeout);
 332   for (unsigned i = 0; i < count; i++) {
 333     if (pos != -1 && static_cast<unsigned>(pos) != i)
 334       s4u_comms[i]->add_ref();
 335   }
 336   return pos;
 337 }