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 Comm* Comm::set_payload_size(double bytes)
 122 {
 123   set_remaining(bytes);
 124   return this;
 125 }
 126
 127 CommPtr Comm::sendto_init(Host* from, Host* to)
 128 {
 129   CommPtr res(new Comm());
 130   res->from_ = from;
 131   res->to_   = to;
 132
 133   return res;
 134 }
 135 CommPtr Comm::sendto_async(Host* from, Host* to, double simulated_size_in_bytes)
 136 {
 137   auto res = Comm::sendto_init(from, to);
 138   res->set_remaining(simulated_size_in_bytes)->start();
 139   return res;
 140 }
 141
 142 Comm* Comm::start()
 143 {
 144   xbt_assert(get_state() == State::INITED || get_state() == State::STARTING,
 145              "You cannot use %s() once your communication started (not implemented)", __FUNCTION__);
 146   if (from_ != nullptr || to_ != nullptr) {
 147     xbt_assert(from_ != nullptr && to_ != nullptr, "When either from_ or to_ is specified, both must be.");
 148     xbt_assert(src_buff_ == nullptr && dst_buff_ == nullptr,
 149                "Direct host-to-host communications cannot carry any data.");
 150     pimpl_ = kernel::actor::simcall([this] {
 151       auto res = new kernel::activity::CommImpl(this->from_, this->to_, this->get_remaining());
 152       res->start();
 153       return res;
 154     });
 155
 156   } else if (src_buff_ != nullptr) { // Sender side
 157     on_start(*this, true /* is_sender*/);
 158     pimpl_ = simcall_comm_isend(sender_, mailbox_->get_impl(), remains_, rate_, src_buff_, src_buff_size_, match_fun_,
 159                                 clean_fun_, copy_data_function_, get_user_data(), detached_);
 160   } else if (dst_buff_ != nullptr) { // Receiver side
 161     xbt_assert(not detached_, "Receive cannot be detached");
 162     on_start(*this, false /*is_sender*/);
 163     pimpl_ = simcall_comm_irecv(receiver_, mailbox_->get_impl(), dst_buff_, &dst_buff_size_, match_fun_,
 164                                 copy_data_function_, get_user_data(), rate_);
 165
 166   } else {
 167     xbt_die("Cannot start a communication before specifying whether we are the sender or the receiver");
 168   }
 169
 170   if (suspended_)
 171     pimpl_->suspend();
 172
 173   state_ = State::STARTED;
 174   return this;
 175 }
 176
 177 /** @brief Block the calling actor until the communication is finished */
 178 Comm* Comm::wait()
 179 {
 180   return this->wait_for(-1);
 181 }
 182
 183 /** @brief Block the calling actor until the communication is finished, or until timeout
 184  *
 185  * On timeout, an exception is thrown and the communication is invalidated.
 186  *
 187  * @param timeout the amount of seconds to wait for the comm termination.
 188  *                Negative values denote infinite wait times. 0 as a timeout returns immediately. */
 189 Comm* Comm::wait_for(double timeout)
 190 {
 191   switch (state_) {
 192     case State::FINISHED:
 193       break;
 194
 195     case State::INITED:
 196     case State::STARTING: // It's not started yet. Do it in one simcall if it's a regular communication
 197       if (from_ != nullptr || to_ != nullptr) {
 198         return start()->wait_for(timeout); // In the case of host2host comm, do it in two simcalls
 199       } else if (src_buff_ != nullptr) {
 200         on_start(*this, true /*is_sender*/);
 201         simcall_comm_send(sender_, mailbox_->get_impl(), remains_, rate_, src_buff_, src_buff_size_, match_fun_,
 202                           copy_data_function_, get_user_data(), timeout);
 203
 204       } else { // Receiver
 205         on_start(*this, false /*is_sender*/);
 206         simcall_comm_recv(receiver_, mailbox_->get_impl(), dst_buff_, &dst_buff_size_, match_fun_, copy_data_function_,
 207                           get_user_data(), timeout, rate_);
 208       }
 209       state_ = State::FINISHED;
 210       this->release_dependencies();
 211       break;
 212
 213     case State::STARTED:
 214       simcall_comm_wait(get_impl(), timeout);
 215       state_ = State::FINISHED;
 216       this->release_dependencies();
 217       break;
 218
 219     case State::CANCELED:
 220       throw CancelException(XBT_THROW_POINT, "Communication canceled");
 221
 222     default:
 223       THROW_IMPOSSIBLE;
 224   }
 225   on_completion(*this);
 226   return this;
 227 }
 228
 229 int Comm::test_any(const std::vector<CommPtr>* comms)
 230 {
 231   std::vector<kernel::activity::CommImpl*> rcomms(comms->size());
 232   std::transform(begin(*comms), end(*comms), begin(rcomms),
 233                  [](const CommPtr& comm) { return static_cast<kernel::activity::CommImpl*>(comm->pimpl_.get()); });
 234   int changed_pos = simcall_comm_testany(rcomms.data(), rcomms.size());
 235   if (changed_pos != -1)
 236     comms->at(changed_pos)->release_dependencies();
 237   return changed_pos;
 238 }
 239
 240 Comm* Comm::detach()
 241 {
 242   xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication is %s (not implemented)",
 243              __FUNCTION__, get_state_str());
 244   xbt_assert(dst_buff_ == nullptr && dst_buff_size_ == 0, "You can only detach sends, not recvs");
 245   detached_ = true;
 246   vetoable_start();
 247   return this;
 248 }
 249
 250 Comm* Comm::cancel()
 251 {
 252   kernel::actor::simcall([this] {
 253     if (pimpl_)
 254       boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->cancel();
 255   });
 256   state_ = State::CANCELED;
 257   return this;
 258 }
 259
 260 bool Comm::test()
 261 {
 262   xbt_assert(state_ == State::INITED || state_ == State::STARTED || state_ == State::STARTING ||
 263              state_ == State::FINISHED);
 264
 265   if (state_ == State::FINISHED)
 266     return true;
 267
 268   if (state_ == State::INITED || state_ == State::STARTING)
 269     this->vetoable_start();
 270
 271   if (simcall_comm_test(get_impl())) {
 272     state_ = State::FINISHED;
 273     this->release_dependencies();
 274     return true;
 275   }
 276   return false;
 277 }
 278
 279 Mailbox* Comm::get_mailbox() const
 280 {
 281   return mailbox_;
 282 }
 283
 284 Actor* Comm::get_sender() const
 285 {
 286   kernel::actor::ActorImplPtr sender = nullptr;
 287   if (pimpl_)
 288     sender = boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->src_actor_;
 289   return sender ? sender->get_ciface() : nullptr;
 290 }
 291
 292 } // namespace s4u
 293 } // namespace simgrid
 294 /* **************************** Public C interface *************************** */
 295 void sg_comm_detach(sg_comm_t comm, void (*clean_function)(void*))
 296 {
 297   comm->detach(clean_function);
 298   comm->unref();
 299 }
 300 void sg_comm_unref(sg_comm_t comm)
 301 {
 302   comm->unref();
 303 }
 304 int sg_comm_test(sg_comm_t comm)
 305 {
 306   bool finished = comm->test();
 307   if (finished)
 308     comm->unref();
 309   return finished;
 310 }
 311
 312 sg_error_t sg_comm_wait(sg_comm_t comm)
 313 {
 314   sg_error_t status = SG_OK;
 315
 316   simgrid::s4u::CommPtr s4u_comm(comm, false);
 317   try {
 318     s4u_comm->wait_for(-1);
 319   } catch (const simgrid::TimeoutException&) {
 320     status = SG_ERROR_TIMEOUT;
 321   } catch (const simgrid::CancelException&) {
 322     status = SG_ERROR_CANCELED;
 323   } catch (const simgrid::NetworkFailureException&) {
 324     status = SG_ERROR_NETWORK;
 325   }
 326   return status;
 327 }
 328
 329 sg_error_t sg_comm_wait_for(sg_comm_t comm, double timeout)
 330 {
 331   sg_error_t status = SG_OK;
 332
 333   simgrid::s4u::CommPtr s4u_comm(comm, false);
 334   try {
 335     s4u_comm->wait_for(timeout);
 336   } catch (const simgrid::TimeoutException&) {
 337     status = SG_ERROR_TIMEOUT;
 338   } catch (const simgrid::CancelException&) {
 339     status = SG_ERROR_CANCELED;
 340   } catch (const simgrid::NetworkFailureException&) {
 341     status = SG_ERROR_NETWORK;
 342   }
 343   return status;
 344 }
 345
 346 void sg_comm_wait_all(sg_comm_t* comms, size_t count)
 347 {
 348   std::vector<simgrid::s4u::CommPtr> s4u_comms;
 349   for (unsigned int i = 0; i < count; i++)
 350     s4u_comms.emplace_back(comms[i], false);
 351
 352   simgrid::s4u::Comm::wait_all(&s4u_comms);
 353 }
 354
 355 int sg_comm_wait_any(sg_comm_t* comms, size_t count)
 356 {
 357   return sg_comm_wait_any_for(comms, count, -1);
 358 }
 359
 360 int sg_comm_wait_any_for(sg_comm_t* comms, size_t count, double timeout)
 361 {
 362   std::vector<simgrid::s4u::CommPtr> s4u_comms;
 363   for (unsigned int i = 0; i < count; i++)
 364     s4u_comms.emplace_back(comms[i], false);
 365
 366   int pos = simgrid::s4u::Comm::wait_any_for(&s4u_comms, timeout);
 367   for (unsigned i = 0; i < count; i++) {
 368     if (pos != -1 && static_cast<unsigned>(pos) != i)
 369       s4u_comms[i]->add_ref();
 370   }
 371   return pos;
 372 }