Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix mailbox::clear() to properly finish Comms
[simgrid.git] / src / kernel / activity / MailboxImpl.cpp
index 9aaa5e6..88b2a08 100644 (file)
@@ -1,57 +1,40 @@
-/* Copyright (c) 2007-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2007-2022. 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. */
 
 #include "src/kernel/activity/MailboxImpl.hpp"
+#include "simgrid/msg.h"
 #include "src/kernel/activity/CommImpl.hpp"
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_mailbox, simix, "Mailbox implementation");
+#include <unordered_map>
 
-static std::map<std::string, smx_mailbox_t>* mailboxes = new std::map<std::string, smx_mailbox_t>;
-
-void SIMIX_mailbox_exit()
-{
-  for (auto const& elm : *mailboxes)
-    delete elm.second;
-  delete mailboxes;
-}
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_mailbox, kernel, "Mailbox implementation");
 
 /******************************************************************************/
 /*                           Rendez-Vous Points                               */
 /******************************************************************************/
 
-namespace simgrid {
-namespace kernel {
-namespace activity {
-/** @brief Returns the mailbox of that name, or nullptr */
-MailboxImpl* MailboxImpl::by_name_or_null(const std::string& name)
-{
-  auto mbox = mailboxes->find(name);
-  if (mbox != mailboxes->end())
-    return mbox->second;
-  else
-    return nullptr;
-}
+namespace simgrid::kernel::activity {
 
-/** @brief Returns the mailbox of that name, newly created on need */
-MailboxImpl* MailboxImpl::by_name_or_create(const std::string& name)
+unsigned MailboxImpl::next_id_ = 0;
+
+MailboxImpl::~MailboxImpl()
 {
-  /* two processes may have pushed the same mbox_create simcall at the same time */
-  auto m = mailboxes->find(name);
-  if (m == mailboxes->end()) {
-    smx_mailbox_t mbox = new MailboxImpl(name);
-    XBT_DEBUG("Creating a mailbox at %p with name %s", mbox, name.c_str());
-    (*mailboxes)[mbox->name_] = mbox;
-    return mbox;
-  } else
-    return m->second;
+  clear();
+  set_receiver(nullptr);
 }
+
 /** @brief set the receiver of the mailbox to allow eager sends
  *  @param actor The receiving dude
  */
 void MailboxImpl::set_receiver(s4u::ActorPtr actor)
 {
+  if (this->permanent_receiver_) {
+    std::vector<MailboxImpl*>& mboxes = this->permanent_receiver_->mailboxes_;
+    mboxes.erase(std::remove(mboxes.begin(), mboxes.end(), this), mboxes.end());
+  }
+
   if (actor != nullptr)
     this->permanent_receiver_ = actor->get_impl();
   else
@@ -60,23 +43,21 @@ void MailboxImpl::set_receiver(s4u::ActorPtr actor)
 /** @brief Pushes a communication activity into a mailbox
  *  @param comm What to add
  */
-void MailboxImpl::push(activity::CommImplPtr comm)
+void MailboxImpl::push(CommImplPtr comm)
 {
-  comm->mbox = this;
+  comm->set_mailbox(this);
   this->comm_queue_.push_back(std::move(comm));
 }
 
 /** @brief Removes a communication activity from a mailbox
- *  @param activity What to remove
+ *  @param comm What to remove
  */
-void MailboxImpl::remove(smx_activity_t activity)
+void MailboxImpl::remove(const CommImplPtr& comm)
 {
-  simgrid::kernel::activity::CommImplPtr comm =
-      boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(activity);
+  xbt_assert(comm->get_mailbox() == this, "Comm %p is in mailbox %s, not mailbox %s", comm.get(),
+             (comm->get_mailbox() ? comm->get_mailbox()->get_cname() : "(null)"), this->get_cname());
 
-  xbt_assert(comm->mbox == this, "Comm %p is in mailbox %s, not mailbox %s", comm.get(),
-             (comm->mbox ? comm->mbox->get_cname() : "(null)"), this->get_cname());
-  comm->mbox = nullptr;
+  comm->set_mailbox(nullptr);
   for (auto it = this->comm_queue_.begin(); it != this->comm_queue_.end(); it++)
     if (*it == comm) {
       this->comm_queue_.erase(it);
@@ -85,30 +66,54 @@ void MailboxImpl::remove(smx_activity_t activity)
   xbt_die("Comm %p not found in mailbox %s", comm.get(), this->get_cname());
 }
 
-smx_activity_t MailboxImpl::iprobe(int type, int (*match_fun)(void*, void*, CommImpl*), void* data)
+/** @brief Removes all communication activities from a mailbox
+ */
+void MailboxImpl::clear()
+{
+  // CommImpl::cancel() will remove the comm from the mailbox..
+  for (auto comm : done_comm_queue_) {
+    comm->cancel();
+    comm->set_state(State::FAILED);
+    comm->post();
+  }
+  done_comm_queue_.clear();
+
+  while (not comm_queue_.empty()) {
+    auto comm = comm_queue_.back();
+    if (comm->get_state() == State::WAITING && not comm->is_detached()) {
+      comm->cancel();
+      comm->set_state(State::FAILED);
+      comm->post();
+    } else
+      comm_queue_.pop_back();
+  }
+  xbt_assert(comm_queue_.empty() && done_comm_queue_.empty());
+}
+
+CommImplPtr MailboxImpl::iprobe(int type, const std::function<bool(void*, void*, CommImpl*)>& match_fun, void* data)
 {
   XBT_DEBUG("iprobe from %p %p", this, &comm_queue_);
 
-  CommImplPtr this_comm;
-  CommImpl::Type smx_type;
+  CommImplPtr this_comm(new CommImpl);
+  CommImplType other_type;
   if (type == 1) {
-    this_comm = CommImplPtr(new CommImpl(CommImpl::Type::SEND));
-    smx_type  = CommImpl::Type::SEND;
+    this_comm->set_type(CommImplType::SEND);
+    other_type = CommImplType::RECEIVE;
   } else {
-    this_comm = CommImplPtr(new CommImpl(CommImpl::Type::RECEIVE));
-    smx_type  = CommImpl::Type::RECEIVE;
+    this_comm->set_type(CommImplType::RECEIVE);
+    other_type = CommImplType::SEND;
   }
-  smx_activity_t other_synchro = nullptr;
+  CommImplPtr other_comm = nullptr;
   if (permanent_receiver_ != nullptr && not done_comm_queue_.empty()) {
     XBT_DEBUG("first check in the permanent recv mailbox, to see if we already got something");
-    other_synchro = find_matching_comm(smx_type, match_fun, data, this_comm, /*done*/ true, /*remove_matching*/ false);
+    other_comm = find_matching_comm(other_type, match_fun, data, this_comm, /*done*/ true, /*remove_matching*/ false);
   }
-  if (not other_synchro) {
+  if (not other_comm) {
     XBT_DEBUG("check if we have more luck in the normal mailbox");
-    other_synchro = find_matching_comm(smx_type, match_fun, data, this_comm, /*done*/ false, /*remove_matching*/ false);
+    other_comm = find_matching_comm(other_type, match_fun, data, this_comm, /*done*/ false, /*remove_matching*/ false);
   }
 
-  return other_synchro;
+  return other_comm;
 }
 
 /**
@@ -120,43 +125,30 @@ smx_activity_t MailboxImpl::iprobe(int type, int (*match_fun)(void*, void*, Comm
  *  @param remove_matching whether or not to clean the found object from the queue
  *  @return The communication activity if found, nullptr otherwise
  */
-CommImplPtr MailboxImpl::find_matching_comm(CommImpl::Type type, int (*match_fun)(void*, void*, CommImpl*),
-                                            void* this_user_data, CommImplPtr my_synchro, bool done,
+CommImplPtr MailboxImpl::find_matching_comm(CommImplType type,
+                                            const std::function<bool(void*, void*, CommImpl*)>& match_fun,
+                                            void* this_user_data, const CommImplPtr& my_synchro, bool done,
                                             bool remove_matching)
 {
-  void* other_user_data = nullptr;
-  boost::circular_buffer_space_optimized<smx_activity_t>* deque;
-  if (done)
-    deque = &done_comm_queue_;
-  else
-    deque = &comm_queue_;
-
-  for (auto it = deque->begin(); it != deque->end(); it++) {
-    CommImplPtr comm = boost::dynamic_pointer_cast<CommImpl>(std::move(*it));
-
-    if (comm->type == CommImpl::Type::SEND) {
-      other_user_data = comm->src_data_;
-    } else if (comm->type == CommImpl::Type::RECEIVE) {
-      other_user_data = comm->dst_data_;
-    }
-    if (comm->type == type && (match_fun == nullptr || match_fun(this_user_data, other_user_data, comm.get())) &&
-        (not comm->match_fun || comm->match_fun(other_user_data, this_user_data, my_synchro.get()))) {
-      XBT_DEBUG("Found a matching communication synchro %p", comm.get());
-      if (remove_matching)
-        deque->erase(it);
-#if SIMGRID_HAVE_MC
-      comm->mbox_cpy = comm->mbox;
-#endif
-      comm->mbox = nullptr;
-      return comm;
-    }
-    XBT_DEBUG("Sorry, communication synchro %p does not match our needs:"
-              " its type is %d but we are looking for a comm of type %d (or maybe the filtering didn't match)",
-              comm.get(), (int)comm->type, (int)type);
+  auto& comm_queue      = done ? done_comm_queue_ : comm_queue_;
+
+  auto iter = std::find_if(
+      comm_queue.begin(), comm_queue.end(), [&type, &match_fun, &this_user_data, &my_synchro](const CommImplPtr& comm) {
+        void* other_user_data = (comm->get_type() == CommImplType::SEND ? comm->src_data_ : comm->dst_data_);
+        return (comm->get_type() == type && (not match_fun || match_fun(this_user_data, other_user_data, comm.get())) &&
+                (not comm->match_fun || comm->match_fun(other_user_data, this_user_data, my_synchro.get())));
+      });
+  if (iter == comm_queue.end()) {
+    XBT_DEBUG("No matching communication synchro found");
+    return nullptr;
   }
-  XBT_DEBUG("No matching communication synchro found");
-  return nullptr;
-}
-}
-}
+
+  const CommImplPtr& comm = *iter;
+  XBT_DEBUG("Found a matching communication synchro %p", comm.get());
+  comm->set_mailbox(nullptr);
+  CommImplPtr comm_cpy = comm;
+  if (remove_matching)
+    comm_queue.erase(iter);
+  return comm_cpy;
 }
+} // namespace simgrid::kernel::activity