Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
introduce sg_actor_create and use it in C examples
[simgrid.git] / src / s4u / s4u_Mailbox.cpp
index 0170e6f..ffbfb69 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2020. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -6,6 +6,7 @@
 #include "simgrid/s4u/Comm.hpp"
 #include "simgrid/s4u/Mailbox.hpp"
 #include "src/kernel/activity/MailboxImpl.hpp"
+
 #include <simgrid/mailbox.h>
 
 XBT_LOG_EXTERNAL_CATEGORY(s4u);
@@ -14,7 +15,7 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_channel, s4u, "S4U Communication Mailboxes")
 namespace simgrid {
 namespace s4u {
 
-const simgrid::xbt::string& Mailbox::get_name() const
+const xbt::string& Mailbox::get_name() const
 {
   return pimpl_->get_name();
 }
@@ -24,52 +25,59 @@ const char* Mailbox::get_cname() const
   return pimpl_->get_cname();
 }
 
-MailboxPtr Mailbox::by_name(const char* name)
+Mailbox* Mailbox::by_name(const std::string& name)
 {
-  kernel::activity::MailboxImpl* mbox = kernel::activity::MailboxImpl::byNameOrNull(name);
+  kernel::activity::MailboxImpl* mbox = kernel::activity::MailboxImpl::by_name_or_null(name);
   if (mbox == nullptr) {
-    mbox = simix::simcall([name] { return kernel::activity::MailboxImpl::byNameOrCreate(name); });
+    mbox = kernel::actor::simcall([&name] { return kernel::activity::MailboxImpl::by_name_or_create(name); });
   }
-  return MailboxPtr(&mbox->piface_, true);
+  return &mbox->piface_;
 }
 
-MailboxPtr Mailbox::by_name(std::string name)
+bool Mailbox::empty()
 {
-  return by_name(name.c_str());
+  return pimpl_->comm_queue_.empty();
 }
 
-bool Mailbox::empty()
+bool Mailbox::listen()
 {
-  return pimpl_->comm_queue.empty();
+  return not this->empty() || (pimpl_->permanent_receiver_ && not pimpl_->done_comm_queue_.empty());
 }
 
-bool Mailbox::listen()
+bool Mailbox::ready()
 {
-  return not this->empty() || (pimpl_->permanent_receiver && not pimpl_->done_comm_queue.empty());
+  bool comm_ready = false;
+  if (not pimpl_->comm_queue_.empty()) {
+    comm_ready = pimpl_->comm_queue_.front()->state_ == kernel::activity::State::DONE;
+
+  } else if (pimpl_->permanent_receiver_ && not pimpl_->done_comm_queue_.empty()) {
+    comm_ready = pimpl_->done_comm_queue_.front()->state_ == kernel::activity::State::DONE;
+  }
+  return comm_ready;
 }
 
-smx_activity_t Mailbox::front()
+kernel::activity::CommImplPtr Mailbox::front()
 {
-  return pimpl_->comm_queue.empty() ? nullptr : pimpl_->comm_queue.front();
+  return pimpl_->comm_queue_.empty() ? nullptr : pimpl_->comm_queue_.front();
 }
 
 void Mailbox::set_receiver(ActorPtr actor)
 {
-  simix::simcall([this, actor]() { this->pimpl_->setReceiver(actor); });
+  kernel::actor::simcall([this, actor]() { this->pimpl_->set_receiver(actor); });
 }
 
 /** @brief get the receiver (process associated to the mailbox) */
 ActorPtr Mailbox::get_receiver()
 {
-  if (pimpl_->permanent_receiver == nullptr)
+  if (pimpl_->permanent_receiver_ == nullptr)
     return ActorPtr();
-  return pimpl_->permanent_receiver->iface();
+  return pimpl_->permanent_receiver_->iface();
 }
 
 CommPtr Mailbox::put_init()
 {
   CommPtr res   = CommPtr(new s4u::Comm());
-  res->sender_  = SIMIX_process_self();
+  res->sender_  = kernel::actor::ActorImpl::self();
   res->mailbox_ = this;
   return res;
 }
@@ -86,7 +94,7 @@ s4u::CommPtr Mailbox::put_async(void* payload, uint64_t simulated_size_in_bytes)
   xbt_assert(payload != nullptr, "You cannot send nullptr");
 
   s4u::CommPtr res = put_init(payload, simulated_size_in_bytes);
-  res->start();
+  res->vetoable_start();
   return res;
 }
 void Mailbox::put(void* payload, uint64_t simulated_size_in_bytes)
@@ -96,6 +104,7 @@ void Mailbox::put(void* payload, uint64_t simulated_size_in_bytes)
   CommPtr c = put_init();
   c->set_remaining(simulated_size_in_bytes);
   c->set_src_data(payload);
+  c->vetoable_start();
   c->wait();
 }
 /** Blocking send with timeout */
@@ -106,14 +115,14 @@ void Mailbox::put(void* payload, uint64_t simulated_size_in_bytes, double timeou
   CommPtr c = put_init();
   c->set_remaining(simulated_size_in_bytes);
   c->set_src_data(payload);
-  // c->start() is optional.
-  c->wait(timeout);
+  c->vetoable_start();
+  c->wait_for(timeout);
 }
 
 s4u::CommPtr Mailbox::get_init()
 {
   CommPtr res    = CommPtr(new s4u::Comm());
-  res->receiver_ = SIMIX_process_self();
+  res->receiver_ = kernel::actor::ActorImpl::self();
   res->mailbox_  = this;
   return res;
 }
@@ -121,7 +130,7 @@ s4u::CommPtr Mailbox::get_async(void** data)
 {
   s4u::CommPtr res = get_init();
   res->set_dst_data(data, sizeof(*data));
-  res->start();
+  res->vetoable_start();
   return res;
 }
 
@@ -130,6 +139,7 @@ void* Mailbox::get()
   void* res = nullptr;
   CommPtr c = get_init();
   c->set_dst_data(&res, sizeof(res));
+  c->vetoable_start();
   c->wait();
   return res;
 }
@@ -138,20 +148,37 @@ void* Mailbox::get(double timeout)
   void* res = nullptr;
   CommPtr c = get_init();
   c->set_dst_data(&res, sizeof(res));
-  c->wait(timeout);
+  c->vetoable_start();
+  c->wait_for(timeout);
   return res;
 }
+
+kernel::activity::ActivityImplPtr
+Mailbox::iprobe(int type, bool (*match_fun)(void*, void*, kernel::activity::CommImpl*), void* data)
+{
+  return kernel::actor::simcall([this, type, match_fun, data] { return pimpl_->iprobe(type, match_fun, data); });
+}
 } // namespace s4u
 } // namespace simgrid
 
 /* **************************** Public C interface *************************** */
-/** \brief Set the mailbox to receive in asynchronous mode
+sg_mailbox_t sg_mailbox_by_name(const char* alias)
+{
+  return simgrid::s4u::Mailbox::by_name(alias);
+}
+
+const char* sg_mailbox_get_name(const_sg_mailbox_t mailbox)
+{
+  return mailbox->get_cname();
+}
+
+/** @brief Set the mailbox to receive in asynchronous mode
  *
  * All messages sent to this mailbox will be transferred to the receiver without waiting for the receive call.
  * The receive call will still be necessary to use the received data.
  * If there is a need to receive some messages asynchronously, and some not, two different mailboxes should be used.
  *
- * \param alias The name of the mailbox
+ * @param alias The name of the mailbox
  */
 void sg_mailbox_set_receiver(const char* alias)
 {
@@ -159,12 +186,36 @@ void sg_mailbox_set_receiver(const char* alias)
   XBT_VERB("%s mailbox set to receive eagerly for myself\n", alias);
 }
 
-/** \brief Check if there is a communication going on in a mailbox.
+/** @brief Check if there is a communication going on in a mailbox.
  *
- * \param alias the name of the mailbox to be considered
- * \return Returns 1 if there is a communication, 0 otherwise
+ * @param alias the name of the mailbox to be considered
+ * @return Returns 1 if there is a communication, 0 otherwise
  */
 int sg_mailbox_listen(const char* alias)
 {
   return simgrid::s4u::Mailbox::by_name(alias)->listen() ? 1 : 0;
 }
+
+void* sg_mailbox_get(sg_mailbox_t mailbox)
+{
+  return mailbox->get();
+}
+
+sg_comm_t sg_mailbox_get_async(sg_mailbox_t mailbox, void** data)
+{
+  auto comm = mailbox->get_async(data);
+  comm->add_ref();
+  return comm.get();
+}
+
+void sg_mailbox_put(sg_mailbox_t mailbox, void* payload, long simulated_size_in_bytes)
+{
+  return mailbox->put(payload, simulated_size_in_bytes);
+}
+
+sg_comm_t sg_mailbox_put_async(sg_mailbox_t mailbox, void* payload, long simulated_size_in_bytes)
+{
+  auto comm = mailbox->put_async(payload, simulated_size_in_bytes);
+  comm->add_ref();
+  return comm.get();
+}