-/* Copyright (c) 2006-2020. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2006-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. */
#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 {
+#ifndef DOXYGEN
friend Comm;
friend smpi::Request;
friend kernel::activity::MailboxImpl;
+#endif
kernel::activity::MailboxImpl* const pimpl_;
public:
/** @brief Retrieves the name of that mailbox as a C++ string */
- const xbt::string& get_name() const;
+ const std::string& get_name() const;
/** @brief Retrieves the name of that mailbox as a C string */
const char* get_cname() const;
/** Returns whether the mailbox contains queued communications */
bool empty() const;
+ /* Returns the number of queued communications */
+ size_t size() const;
+
/** Check if there is a communication going on in a mailbox. */
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. */
+ /** Check if there is a communication ready to be consumed from a mailbox.
+ * \beginrst
+ * See :ref:`this example <s4u_ex_mailbox_ready>`.
+ * \endrst
+ */
bool ready() const;
/** Gets the first element in the queue (without dequeuing it), or nullptr if none is there */
/** Creates (but don't start) a data transmission to that mailbox */
CommPtr put_init();
- /** Creates (but don't start) a data transmission to that mailbox */
+ /** Creates (but don't start) a data transmission to that mailbox.
+ *
+ * Please note that if you send a pointer to some data, you must ensure that your data remains live during the
+ * communication, or the receiver will get a pointer to a garbled memory area.
+ */
CommPtr put_init(void* data, uint64_t simulated_size_in_bytes);
- /** Creates and start a data transmission to that mailbox */
+ /** Creates and start a data transmission to that mailbox.
+ *
+ * Please note that if you send a pointer to some data, you must ensure that your data remains live during the
+ * communication, or the receiver will get a pointer to a garbled memory area.
+ */
CommPtr put_async(void* data, uint64_t simulated_size_in_bytes);
- kernel::activity::ActivityImplPtr iprobe(int type, bool (*match_fun)(void*, void*, kernel::activity::CommImpl*),
- void* data);
- /** Blocking data transmission */
+ kernel::activity::ActivityImplPtr
+ iprobe(int type, const std::function<bool(void*, void*, kernel::activity::CommImpl*)>& match_fun, void* data);
+ /** Blocking data transmission.
+ *
+ * Please note that if you send a pointer to some data, you must ensure that your data remains live during the
+ * communication, or the receiver will get a pointer to a garbled memory area.
+ */
void put(void* payload, uint64_t simulated_size_in_bytes);
/** 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 */
+ /** Creates (but don't start) a data reception onto that mailbox.
+ * @verbatim embed:rst:inline You probably want to use :cpp:func:`simgrid::s4u::Comm::set_dst_data` and friends before
+ * starting that activity. @endverbatim */
CommPtr get_init();
/** Creates and start an async data reception to that mailbox */
- CommPtr get_async(void** data);
- template <typename T> CommPtr get_async(T** data) { return get_async<void>(reinterpret_cast<void**>(data)); }
+ template <typename T> CommPtr get_async(T** data);
/** Blocking data reception */
- void* get();
- template <typename T> T* get() { return static_cast<T*>(get<void>()); }
+ template <typename T> T* 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);
- template <typename T> T* get(double timeout) { return static_cast<T*>(get<void>(timeout)); }
-};
+ template <typename T> T* get(double timeout);
+ template <typename T> std::unique_ptr<T> get_unique(double timeout) { return std::unique_ptr<T>(get<T>(timeout)); }
-template <> CommPtr Mailbox::get_async<void>(void** data);
-template <> void* Mailbox::get<void>();
-template <> void* Mailbox::get<void>(double timeout);
+ void clear();
+};
-inline CommPtr Mailbox::get_async(void** data)
+template <typename T> CommPtr Mailbox::get_async(T** data)
{
- return get_async<void>(data);
+ CommPtr res = get_init()->set_dst_data(reinterpret_cast<void**>(data), sizeof(void*));
+ res->vetoable_start();
+ return res;
}
-inline void* Mailbox::get()
+
+template <typename T> T* Mailbox::get()
{
- return get<void>();
+ T* res = nullptr;
+ get_async<T>(&res)->wait();
+ return res;
}
-inline void* Mailbox::get(double timeout)
+
+template <typename T> T* Mailbox::get(double timeout)
{
- return get<void>(timeout);
+ T* res = nullptr;
+ get_async<T>(&res)->wait_for(timeout);
+ return res;
}
-
} // namespace s4u
} // namespace simgrid
