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