1 /* Copyright (c) 2006-2019. 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_S4U_MAILBOX_HPP
7 #define SIMGRID_S4U_MAILBOX_HPP
9 #include <xbt/string.hpp>
10 #include <simgrid/s4u/Actor.hpp>
17 /** @brief Mailboxes: Network rendez-vous points. */
18 class XBT_PUBLIC Mailbox {
19 friend simgrid::s4u::Comm;
20 friend simgrid::kernel::activity::MailboxImpl;
22 simgrid::kernel::activity::MailboxImpl* const pimpl_;
24 explicit Mailbox(kernel::activity::MailboxImpl * mbox) : pimpl_(mbox) {}
26 /** private function to manage the mailboxes' lifetime (see @ref s4u_raii) */
27 friend void intrusive_ptr_add_ref(Mailbox*) {}
28 /** private function to manage the mailboxes' lifetime (see @ref s4u_raii) */
29 friend void intrusive_ptr_release(Mailbox*) {}
32 /** private function, do not use. FIXME: make me protected */
33 kernel::activity::MailboxImpl* get_impl() { return pimpl_; }
35 /** @brief Retrieves the name of that mailbox as a C++ string */
36 const simgrid::xbt::string& get_name() const;
37 /** @brief Retrieves the name of that mailbox as a C string */
38 const char* get_cname() const;
40 /** Retrieve the mailbox associated to the given name */
41 static MailboxPtr by_name(const std::string& name);
43 /** Returns whether the mailbox contains queued communications */
46 /** Check if there is a communication going on in a mailbox. */
49 /** Check if there is a communication ready to be consumed from a mailbox. */
52 /** Gets the first element in the queue (without dequeuing it), or nullptr if none is there */
53 kernel::activity::CommImplPtr front();
55 /** Declare that the specified actor is a permanent receiver on that mailbox
57 * It means that the communications sent to this mailbox will start flowing to
58 * its host even before it does a get(). This models the real behavior of TCP
59 * and MPI communications, amongst other. It will improve the accuracy of
60 * predictions, in particular if your application exhibits swarms of small messages.
62 * SimGrid does not enforces any kind of ownership over the mailbox. Even if a receiver
63 * was declared, any other actors can still get() data from the mailbox. The timings
64 * will then probably be off tracks, so you should strive on your side to not get data
65 * from someone else's mailbox.
67 * Note that being permanent receivers of a mailbox prevents actors to be garbage-collected.
68 * If your simulation creates many short-lived actors that marked as permanent receiver, you
69 * should call mailbox->set_receiver(nullptr) by the end of the actors so that their memory gets
70 * properly reclaimed. This call should be at the end of the actor's function, not in a on_exit
73 void set_receiver(ActorPtr actor);
75 /** Return the actor declared as permanent receiver, or nullptr if none **/
76 ActorPtr get_receiver();
78 /** Creates (but don't start) a data transmission to that mailbox */
80 /** Creates (but don't start) a data transmission to that mailbox */
81 CommPtr put_init(void* data, uint64_t simulated_size_in_bytes);
82 /** Creates and start a data transmission to that mailbox */
83 CommPtr put_async(void* data, uint64_t simulated_size_in_bytes);
85 smx_activity_t iprobe(int type, int (*match_fun)(void*, void*, kernel::activity::CommImpl*), void* data);
86 /** Blocking data transmission */
87 void put(void* payload, uint64_t simulated_size_in_bytes);
88 /** Blocking data transmission with timeout */
89 void put(void* payload, uint64_t simulated_size_in_bytes, double timeout);
91 /** Creates (but don't start) a data reception onto that mailbox */
93 /** Creates and start an async data reception to that mailbox */
94 CommPtr get_async(void** data);
96 /** Blocking data reception */
97 void* get(); // FIXME: make a typed template version
98 /** Blocking data reception with timeout */
99 void* get(double timeout);
101 // Deprecated functions
103 /** @deprecated Mailbox::set_receiver() */
104 XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::set_receiver()") void setReceiver(ActorPtr actor)
108 /** @deprecated Mailbox::get_receiver() */
109 XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_receiver()") ActorPtr getReceiver() { return get_receiver(); }
110 /** @deprecated Mailbox::get_name() */
111 XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_name()") const simgrid::xbt::string& getName() const
115 /** @deprecated Mailbox::get_cname() */
116 XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_cname()") const char* getCname() const { return get_cname(); }
117 /** @deprecated Mailbox::get_impl() */
118 XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_impl()") kernel::activity::MailboxImpl* getImpl()
122 /** @deprecated Mailbox::by_name() */
123 XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::by_name()") static MailboxPtr byName(const char* name)
125 return by_name(name);
127 /** @deprecated Mailbox::by_name() */
128 XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::by_name()") static MailboxPtr byName(const std::string& name)
130 return by_name(name);
135 }} // namespace simgrid::s4u
137 #endif /* SIMGRID_S4U_MAILBOX_HPP */