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