1 /* Copyright (c) 2007-2021. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_KERNEL_ACTIVITY_MAILBOX_HPP
7 #define SIMGRID_KERNEL_ACTIVITY_MAILBOX_HPP
9 #include <boost/circular_buffer.hpp>
10 #include <xbt/string.hpp>
12 #include "simgrid/s4u/Engine.hpp"
13 #include "simgrid/s4u/Mailbox.hpp"
14 #include "src/kernel/activity/CommImpl.hpp"
15 #include "src/kernel/actor/ActorImpl.hpp"
21 /** @brief Implementation of the s4u::Mailbox */
24 static constexpr size_t MAX_MAILBOX_SIZE = 10000000;
28 actor::ActorImplPtr permanent_receiver_; // actor to which the mailbox is attached
29 boost::circular_buffer_space_optimized<CommImplPtr> comm_queue_{MAX_MAILBOX_SIZE};
30 // messages already received in the permanent receive mode
31 boost::circular_buffer_space_optimized<CommImplPtr> done_comm_queue_{MAX_MAILBOX_SIZE};
35 friend s4u::Mailbox* s4u::Engine::mailbox_by_name_or_create(const std::string& name) const;
36 friend s4u::Mailbox* s4u::Mailbox::by_name(const std::string& name);
37 friend mc::CommunicationDeterminismChecker;
39 explicit MailboxImpl(const std::string& name) : piface_(this), name_(name) {}
42 /** @brief Public interface */
43 const s4u::Mailbox* get_iface() const { return &piface_; }
44 s4u::Mailbox* get_iface() { return &piface_; }
46 const xbt::string& get_name() const { return name_; }
47 const char* get_cname() const { return name_.c_str(); }
48 void set_receiver(s4u::ActorPtr actor);
49 void push(CommImplPtr comm);
50 void push_done(CommImplPtr done_comm) { done_comm_queue_.push_back(done_comm); }
51 void remove(const CommImplPtr& comm);
52 CommImplPtr iprobe(int type, bool (*match_fun)(void*, void*, CommImpl*), void* data);
53 CommImplPtr find_matching_comm(CommImpl::Type type, bool (*match_fun)(void*, void*, CommImpl*), void* this_user_data,
54 const CommImplPtr& my_synchro, bool done, bool remove_matching);
55 bool is_permanent() const { return permanent_receiver_ != nullptr; }
56 actor::ActorImplPtr get_permanent_receiver() const { return permanent_receiver_; }
57 bool empty() const { return comm_queue_.empty(); }
58 size_t size() const { return comm_queue_.size(); }
59 CommImplPtr front() const { return comm_queue_.front(); }
60 bool has_some_done_comm() const { return not done_comm_queue_.empty(); }
61 CommImplPtr done_front() const { return done_comm_queue_.front(); }
63 } // namespace activity
65 } // namespace simgrid