-/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2006-2021. 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_S4U_MAILBOX_HPP
#define SIMGRID_S4U_MAILBOX_HPP
-#include <xbt/string.hpp>
+#include <simgrid/forward.h>
#include <simgrid/s4u/Actor.hpp>
+#include <simgrid/s4u/Comm.hpp>
+#include <smpi/forward.hpp>
+#include <xbt/string.hpp>
+#include <memory>
#include <string>
namespace simgrid {
/** @brief Mailboxes: Network rendez-vous points. */
class XBT_PUBLIC Mailbox {
- friend simgrid::s4u::Comm;
- friend simgrid::kernel::activity::MailboxImpl;
+ friend Comm;
+ friend smpi::Request;
+ friend kernel::activity::MailboxImpl;
- simgrid::kernel::activity::MailboxImpl* pimpl_;
+ kernel::activity::MailboxImpl* const pimpl_;
explicit Mailbox(kernel::activity::MailboxImpl * mbox) : pimpl_(mbox) {}
+ ~Mailbox() = default;
- /** private function to manage the mailboxes' lifetime (see @ref s4u_raii) */
- friend void intrusive_ptr_add_ref(Mailbox*) {}
- /** private function to manage the mailboxes' lifetime (see @ref s4u_raii) */
- friend void intrusive_ptr_release(Mailbox*) {}
+protected:
+ kernel::activity::MailboxImpl* get_impl() const { return pimpl_; }
public:
- /** private function, do not use. FIXME: make me protected */
- kernel::activity::MailboxImpl* get_impl() { return pimpl_; }
-
/** @brief Retrieves the name of that mailbox as a C++ string */
- const simgrid::xbt::string& get_name() const;
+ const xbt::string& get_name() const;
/** @brief Retrieves the name of that mailbox as a C string */
const char* get_cname() const;
- /** Retrieve the mailbox associated to the given name */
- static MailboxPtr by_name(std::string name);
+ /** Retrieve the mailbox associated to the given name. Mailboxes are created on demand. */
+ static Mailbox* by_name(const std::string& name);
/** Returns whether the mailbox contains queued communications */
- bool empty();
+ bool empty() const;
/** Check if there is a communication going on in a mailbox. */
- bool listen();
+ bool listen() const;
+
+ /** Look if there is a communication going on in a mailbox and return the PID of the sender actor */
+ aid_t listen_from() const;
/** Check if there is a communication ready to be consumed from a mailbox. */
- bool ready();
+ bool ready() const;
/** Gets the first element in the queue (without dequeuing it), or nullptr if none is there */
- smx_activity_t front();
+ kernel::activity::CommImplPtr front() const;
/** Declare that the specified actor is a permanent receiver on that mailbox
*
* Note that being permanent receivers of a mailbox prevents actors to be garbage-collected.
* If your simulation creates many short-lived actors that marked as permanent receiver, you
* should call mailbox->set_receiver(nullptr) by the end of the actors so that their memory gets
- * properly reclaimed. This call should be at the end of the actor's function, not in a on_exit
+ * properly reclaimed. This call should be at the end of the actor's function, not in an on_exit
* callback.
*/
void set_receiver(ActorPtr actor);
/** Return the actor declared as permanent receiver, or nullptr if none **/
- ActorPtr get_receiver();
+ ActorPtr get_receiver() const;
- /** Creates (but don't start) a data emission to that mailbox */
+ /** Creates (but don't start) a data transmission to that mailbox */
CommPtr put_init();
- /** Creates (but don't start) a data emission to that mailbox */
+ /** Creates (but don't start) a data transmission to that mailbox */
CommPtr put_init(void* data, uint64_t simulated_size_in_bytes);
- /** Creates and start a data emission to that mailbox */
+ /** Creates and start a data transmission to that mailbox */
CommPtr put_async(void* data, uint64_t simulated_size_in_bytes);
- /** Blocking data emission */
+ kernel::activity::ActivityImplPtr iprobe(int type, bool (*match_fun)(void*, void*, kernel::activity::CommImpl*),
+ void* data);
+ /** Blocking data transmission */
void put(void* payload, uint64_t simulated_size_in_bytes);
- /** Blocking data emission with timeout */
+ /** Blocking data transmission with timeout */
void put(void* payload, uint64_t simulated_size_in_bytes, double timeout);
/** Creates (but don't start) a data reception onto that mailbox */
CommPtr get_init();
/** Creates and start an async data reception to that mailbox */
- CommPtr get_async(void** data);
+ XBT_ATTRIB_DEPRECATED_v331("Please use typed template Mailbox::get_async<>()") CommPtr get_async(void** data);
+ template <typename T> CommPtr get_async(T** data);
/** Blocking data reception */
- void* get(); // FIXME: make a typed template version
+ template <typename T> T* get();
+ XBT_ATTRIB_DEPRECATED_v331("Please use typed template Mailbox::get<>()") void* get();
+ template <typename T> std::unique_ptr<T> get_unique() { return std::unique_ptr<T>(get<T>()); }
+
/** Blocking data reception with timeout */
- void* get(double timeout);
-
- // Deprecated functions
-#ifndef DOXYGEN
- /** @deprecated Mailbox::set_receiver() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::set_receiver()") void setReceiver(ActorPtr actor)
- {
- set_receiver(actor);
- }
- /** @deprecated Mailbox::get_receiver() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_receiver()") ActorPtr getReceiver() { return get_receiver(); }
- /** @deprecated Mailbox::get_name() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_name()") const simgrid::xbt::string& getName() const
- {
- return get_name();
- }
- /** @deprecated Mailbox::get_cname() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_cname()") const char* getCname() const { return get_cname(); }
- /** @deprecated Mailbox::get_impl() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_impl()") kernel::activity::MailboxImpl* getImpl()
- {
- return get_impl();
- }
- /** @deprecated Mailbox::by_name() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::by_name()") static MailboxPtr byName(const char* name)
- {
- return by_name(name);
- }
- /** @deprecated Mailbox::by_name() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::by_name()") static MailboxPtr byName(std::string name)
- {
- return by_name(name);
- }
-#endif
+ template <typename T> T* get(double timeout);
+ XBT_ATTRIB_DEPRECATED_v331("Please use typed template Mailbox::get<>()") void* get(double timeout);
+ template <typename T> std::unique_ptr<T> get_unique(double timeout) { return std::unique_ptr<T>(get<T>(timeout)); }
};
-}} // namespace simgrid::s4u
+template <typename T> CommPtr Mailbox::get_async(T** data)
+{
+ CommPtr res = get_init();
+ res->set_dst_data(reinterpret_cast<void**>(data), sizeof(void*));
+ res->vetoable_start();
+ return res;
+}
+
+template <typename T> T* Mailbox::get()
+{
+ T* res = nullptr;
+ get_async<T>(&res)->wait();
+ return res;
+}
+
+template <typename T> T* Mailbox::get(double timeout)
+{
+ T* res = nullptr;
+ get_async<T>(&res)->wait_for(timeout);
+ return res;
+}
+
+inline CommPtr Mailbox::get_async(void** data) // XBT_ATTRIB_DEPRECATED_v331
+{
+ return get_async<void>(data);
+}
+inline void* Mailbox::get() // XBT_ATTRIB_DEPRECATED_v331
+{
+ return get<void>();
+}
+inline void* Mailbox::get(double timeout) // XBT_ATTRIB_DEPRECATED_v331
+{
+ return get<void>(timeout);
+}
+
+} // namespace s4u
+} // namespace simgrid
#endif /* SIMGRID_S4U_MAILBOX_HPP */
