X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/9104957deccc59e0e804215d5db498fabfd40d29..0a6556cf9aa3e733965b6a18574efd63b54caa0d:/include/simgrid/s4u/Mailbox.hpp diff --git a/include/simgrid/s4u/Mailbox.hpp b/include/simgrid/s4u/Mailbox.hpp index 5c02b70061..a885cbad11 100644 --- a/include/simgrid/s4u/Mailbox.hpp +++ b/include/simgrid/s4u/Mailbox.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2020. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2022. 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. */ @@ -8,9 +8,10 @@ #include #include +#include #include -#include +#include #include namespace simgrid { @@ -18,9 +19,11 @@ namespace s4u { /** @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_; @@ -32,7 +35,7 @@ protected: 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; @@ -40,16 +43,22 @@ public: static Mailbox* by_name(const std::string& name); /** Returns whether the mailbox contains queued communications */ - bool empty(); + 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(); + 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 */ - kernel::activity::CommImplPtr front(); + kernel::activity::CommImplPtr front() const; /** Declare that the specified actor is a permanent receiver on that mailbox * @@ -66,39 +75,78 @@ public: * 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 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& 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 CommPtr get_async(T** data); /** Blocking data reception */ - void* get(); // FIXME: make a typed template version + template T* get(); + template std::unique_ptr get_unique() { return std::unique_ptr(get()); } + /** Blocking data reception with timeout */ - void* get(double timeout); + template T* get(double timeout); + template std::unique_ptr get_unique(double timeout) { return std::unique_ptr(get(timeout)); } + + void clear(); }; +template CommPtr Mailbox::get_async(T** data) +{ + CommPtr res = get_init()->set_dst_data(reinterpret_cast(data), sizeof(void*)); + res->vetoable_start(); + return res; +} + +template T* Mailbox::get() +{ + T* res = nullptr; + get_async(&res)->wait(); + return res; +} + +template T* Mailbox::get(double timeout) +{ + T* res = nullptr; + get_async(&res)->wait_for(timeout); + return res; +} } // namespace s4u } // namespace simgrid