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