src/s4u/s4u_Mailbox.cpp

   1 /* Copyright (c) 2006-2022. 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 <simgrid/mailbox.h>
   7 #include <simgrid/s4u/Engine.hpp>
   8 #include <simgrid/s4u/Mailbox.hpp>
   9
  10 #include "src/kernel/activity/MailboxImpl.hpp"
  11
  12 XBT_LOG_EXTERNAL_CATEGORY(s4u);
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_channel, s4u, "S4U Communication Mailboxes");
  14
  15 namespace simgrid::s4u {
  16
  17 const xbt::string& Mailbox::get_name() const
  18 {
  19   return pimpl_->get_name();
  20 }
  21
  22 const char* Mailbox::get_cname() const
  23 {
  24   return pimpl_->get_cname();
  25 }
  26
  27 Mailbox* Mailbox::by_name(const std::string& name)
  28 {
  29   return Engine::get_instance()->mailbox_by_name_or_create(name);
  30 }
  31
  32 bool Mailbox::empty() const
  33 {
  34   return pimpl_->empty();
  35 }
  36
  37 size_t Mailbox::size() const
  38 {
  39   return pimpl_->size();
  40 }
  41
  42 bool Mailbox::listen() const
  43 {
  44   return not pimpl_->empty() || (pimpl_->is_permanent() && pimpl_->has_some_done_comm());
  45 }
  46
  47 aid_t Mailbox::listen_from() const
  48 {
  49   kernel::activity::CommImplPtr comm = front();
  50   if (comm && comm->src_actor_)
  51     return comm->src_actor_->get_pid();
  52   else
  53     return -1;
  54 }
  55
  56 bool Mailbox::ready() const
  57 {
  58   bool comm_ready = false;
  59   if (not pimpl_->empty()) {
  60     comm_ready = pimpl_->front()->get_state() == kernel::activity::State::DONE;
  61
  62   } else if (pimpl_->is_permanent() && pimpl_->has_some_done_comm()) {
  63     comm_ready = pimpl_->done_front()->get_state() == kernel::activity::State::DONE;
  64   }
  65   return comm_ready;
  66 }
  67
  68 kernel::activity::CommImplPtr Mailbox::front() const
  69 {
  70   return pimpl_->empty() ? nullptr : pimpl_->front();
  71 }
  72
  73 void Mailbox::set_receiver(ActorPtr actor)
  74 {
  75   kernel::actor::simcall_answered([this, actor]() { this->pimpl_->set_receiver(actor); });
  76 }
  77
  78 /** @brief get the receiver (process associated to the mailbox) */
  79 ActorPtr Mailbox::get_receiver() const
  80 {
  81   if (pimpl_->is_permanent())
  82     return ActorPtr();
  83   return pimpl_->get_permanent_receiver()->get_iface();
  84 }
  85
  86 CommPtr Mailbox::put_init()
  87 {
  88   CommPtr res(new Comm());
  89   res->sender_  = kernel::actor::ActorImpl::self();
  90   res->set_mailbox(this);
  91   return res;
  92 }
  93
  94 CommPtr Mailbox::put_init(void* payload, uint64_t simulated_size_in_bytes)
  95 {
  96   return put_init()->set_payload_size(simulated_size_in_bytes)->set_src_data(payload)->set_src_data_size(sizeof(void*));
  97 }
  98
  99 CommPtr Mailbox::put_async(void* payload, uint64_t simulated_size_in_bytes)
 100 {
 101   xbt_assert(payload != nullptr, "You cannot send nullptr");
 102
 103   CommPtr res = put_init(payload, simulated_size_in_bytes);
 104   res->vetoable_start();
 105   return res;
 106 }
 107
 108 void Mailbox::put(void* payload, uint64_t simulated_size_in_bytes)
 109 {
 110   xbt_assert(payload != nullptr, "You cannot send nullptr");
 111
 112   put_init()->set_payload_size(simulated_size_in_bytes)->set_src_data(payload)->vetoable_start()->wait();
 113 }
 114
 115 /** Blocking send with timeout */
 116 void Mailbox::put(void* payload, uint64_t simulated_size_in_bytes, double timeout)
 117 {
 118   xbt_assert(payload != nullptr, "You cannot send nullptr");
 119
 120   put_init()->set_payload_size(simulated_size_in_bytes)->set_src_data(payload)->vetoable_start()->wait_for(timeout);
 121 }
 122
 123 CommPtr Mailbox::get_init()
 124 {
 125   auto res       = CommPtr(new Comm())->set_mailbox(this);
 126   res->receiver_ = kernel::actor::ActorImpl::self();
 127   return res;
 128 }
 129
 130 kernel::activity::ActivityImplPtr
 131 Mailbox::iprobe(int type, const std::function<bool(void*, void*, kernel::activity::CommImpl*)>& match_fun, void* data)
 132 {
 133   return kernel::actor::simcall_answered(
 134       [this, type, &match_fun, data] { return pimpl_->iprobe(type, match_fun, data); });
 135 }
 136
 137 void Mailbox::clear()
 138 {
 139   kernel::actor::simcall_answered([this]() { this->pimpl_->clear(true); });
 140 }
 141
 142 } // namespace simgrid::s4u
 143
 144 /* **************************** Public C interface *************************** */
 145 sg_mailbox_t sg_mailbox_by_name(const char* alias)
 146 {
 147   return simgrid::s4u::Mailbox::by_name(alias);
 148 }
 149
 150 const char* sg_mailbox_get_name(const_sg_mailbox_t mailbox)
 151 {
 152   return mailbox->get_cname();
 153 }
 154
 155 /** @brief Set the mailbox to receive in asynchronous mode
 156  *
 157  * All messages sent to this mailbox will be transferred to the receiver without waiting for the receive call.
 158  * The receive call will still be necessary to use the received data.
 159  * If there is a need to receive some messages asynchronously, and some not, two different mailboxes should be used.
 160  *
 161  * @param alias The name of the mailbox
 162  */
 163 void sg_mailbox_set_receiver(const char* alias)
 164 {
 165   simgrid::s4u::Mailbox::by_name(alias)->set_receiver(simgrid::s4u::Actor::self());
 166   XBT_VERB("%s mailbox set to receive eagerly for myself\n", alias);
 167 }
 168
 169 /** @brief Check if there is a communication going on in a mailbox.
 170  *
 171  * @param alias the name of the mailbox to be considered
 172  * @return Returns 1 if there is a communication, 0 otherwise
 173  */
 174 int sg_mailbox_listen(const char* alias)
 175 {
 176   return simgrid::s4u::Mailbox::by_name(alias)->listen() ? 1 : 0;
 177 }
 178
 179 void* sg_mailbox_get(sg_mailbox_t mailbox)
 180 {
 181   return mailbox->get<void>();
 182 }
 183
 184 sg_comm_t sg_mailbox_get_async(sg_mailbox_t mailbox, void** data)
 185 {
 186   auto comm = mailbox->get_async<void>(data);
 187   comm->add_ref();
 188   return comm.get();
 189 }
 190
 191 void sg_mailbox_put(sg_mailbox_t mailbox, void* payload, long simulated_size_in_bytes)
 192 {
 193   mailbox->put(payload, simulated_size_in_bytes);
 194 }
 195
 196 sg_comm_t sg_mailbox_put_async(sg_mailbox_t mailbox, void* payload, long simulated_size_in_bytes)
 197 {
 198   auto comm = mailbox->put_async(payload, simulated_size_in_bytes);
 199   comm->add_ref();
 200   return comm.get();
 201 }
 202
 203 sg_comm_t sg_mailbox_put_init(sg_mailbox_t mailbox, void* payload, long simulated_size_in_bytes)
 204 {
 205   auto comm = mailbox->put_init(payload, simulated_size_in_bytes);
 206   comm->add_ref();
 207   return comm.get();
 208 }