-/* Copyright (c) 2007-2020. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2007-2023. 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. */
#ifndef SIMGRID_KERNEL_ACTIVITY_MAILBOX_HPP
#define SIMGRID_KERNEL_ACTIVITY_MAILBOX_HPP
-#include <boost/circular_buffer.hpp>
-#include <xbt/string.hpp>
-
+#include "simgrid/config.h" /* FIXME: KILLME. This makes the ABI config-dependent, but mandatory for the hack below */
+#include "simgrid/s4u/Engine.hpp"
#include "simgrid/s4u/Mailbox.hpp"
#include "src/kernel/activity/CommImpl.hpp"
#include "src/kernel/actor/ActorImpl.hpp"
-namespace simgrid {
-namespace kernel {
-namespace activity {
+namespace simgrid::kernel::activity {
/** @brief Implementation of the s4u::Mailbox */
class MailboxImpl {
- static constexpr size_t MAX_MAILBOX_SIZE = 10000000;
-
s4u::Mailbox piface_;
- xbt::string name_;
+ std::string name_;
+ actor::ActorImplPtr permanent_receiver_; // actor to which the mailbox is attached
+#if SIMGRID_HAVE_STATEFUL_MC
+ /* Using deque here is faster in benchmarks, but break the state equality heuristic of Liveness checking on Debian
+ * testing. This would desserve a proper investiguation, but simply use a single-sided list for the time being. HACK.
+ */
+ std::list<CommImplPtr> comm_queue_;
+ // messages already received in the permanent receive mode
+ std::list<CommImplPtr> done_comm_queue_;
+#else
+ std::deque<CommImplPtr> comm_queue_;
+ // messages already received in the permanent receive mode
+ std::deque<CommImplPtr> done_comm_queue_;
+#endif
+ friend s4u::Engine;
friend s4u::Mailbox;
+ friend s4u::Mailbox* s4u::Engine::mailbox_by_name_or_create(const std::string& name) const;
friend s4u::Mailbox* s4u::Mailbox::by_name(const std::string& name);
- friend mc::CommunicationDeterminismChecker;
+ static unsigned next_id_; // Next ID to be given
+ const unsigned id_ = next_id_++;
explicit MailboxImpl(const std::string& name) : piface_(this), name_(name) {}
+ MailboxImpl(const MailboxImpl&) = delete;
+ MailboxImpl& operator=(const MailboxImpl&) = delete;
public:
- const xbt::string& get_name() const { return name_; }
+ /** @brief Public interface */
+ unsigned get_id() const { return id_; }
+
+ ~MailboxImpl();
+
+ const s4u::Mailbox* get_iface() const { return &piface_; }
+ s4u::Mailbox* get_iface() { return &piface_; }
+
+ const std::string& get_name() const { return name_; }
const char* get_cname() const { return name_.c_str(); }
- static MailboxImpl* by_name_or_null(const std::string& name);
- static MailboxImpl* by_name_or_create(const std::string& name);
void set_receiver(s4u::ActorPtr actor);
- void push(CommImplPtr comm);
+ void push(const CommImplPtr& comm);
+ void push_done(const CommImplPtr& done_comm) { done_comm_queue_.push_back(done_comm); }
void remove(const CommImplPtr& comm);
- CommImplPtr iprobe(int type, bool (*match_fun)(void*, void*, CommImpl*), void* data);
- CommImplPtr find_matching_comm(CommImpl::Type type, bool (*match_fun)(void*, void*, CommImpl*), void* this_user_data,
- const CommImplPtr& my_synchro, bool done, bool remove_matching);
-
- actor::ActorImplPtr permanent_receiver_; // actor to which the mailbox is attached
- boost::circular_buffer_space_optimized<CommImplPtr> comm_queue_{MAX_MAILBOX_SIZE};
- // messages already received in the permanent receive mode
- boost::circular_buffer_space_optimized<CommImplPtr> done_comm_queue_{MAX_MAILBOX_SIZE};
+ void clear(bool do_finish);
+ CommImplPtr iprobe(int type, const std::function<bool(void*, void*, CommImpl*)>& match_fun, void* data);
+ CommImplPtr 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);
+ bool is_permanent() const { return permanent_receiver_ != nullptr; }
+ actor::ActorImplPtr get_permanent_receiver() const { return permanent_receiver_; }
+ bool empty() const { return comm_queue_.empty(); }
+ size_t size() const { return comm_queue_.size(); }
+ const CommImplPtr& front() const { return comm_queue_.front(); }
+ bool has_some_done_comm() const { return not done_comm_queue_.empty(); }
+ const CommImplPtr& done_front() const { return done_comm_queue_.front(); }
};
-} // namespace activity
-} // namespace kernel
-} // namespace simgrid
-
-XBT_PRIVATE void SIMIX_mailbox_exit();
+} // namespace simgrid::kernel::activity
#endif