include/simgrid/s4u/Mailbox.hpp

   1 /* Copyright (c) 2006-2022. The SimGrid Team. All rights reserved.          */
   2
   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. */
   5
   6 #ifndef SIMGRID_S4U_MAILBOX_HPP
   7 #define SIMGRID_S4U_MAILBOX_HPP
   8
   9 #include <simgrid/forward.h>
  10 #include <simgrid/s4u/Actor.hpp>
  11 #include <simgrid/s4u/Comm.hpp>
  12 #include <smpi/forward.hpp>
  13
  14 #include <memory>
  15 #include <string>
  16
  17 namespace simgrid {
  18 namespace s4u {
  19
  20 /** @brief Mailboxes: Network rendez-vous points. */
  21 class XBT_PUBLIC Mailbox {
  22 #ifndef DOXYGEN
  23   friend Comm;
  24   friend smpi::Request;
  25   friend kernel::activity::MailboxImpl;
  26 #endif
  27
  28   kernel::activity::MailboxImpl* const pimpl_;
  29
  30   explicit Mailbox(kernel::activity::MailboxImpl * mbox) : pimpl_(mbox) {}
  31   ~Mailbox() = default;
  32
  33 protected:
  34   kernel::activity::MailboxImpl* get_impl() const { return pimpl_; }
  35
  36 public:
  37   /** @brief Retrieves the name of that mailbox as a C++ string */
  38   const std::string& get_name() const;
  39   /** @brief Retrieves the name of that mailbox as a C string */
  40   const char* get_cname() const;
  41
  42   /** Retrieve the mailbox associated to the given name. Mailboxes are created on demand. */
  43   static Mailbox* by_name(const std::string& name);
  44
  45   /** Returns whether the mailbox contains queued communications */
  46   bool empty() const;
  47
  48   /* Returns the number of queued communications */
  49   size_t size() const;
  50
  51   /** Check if there is a communication going on in a mailbox. */
  52   bool listen() const;
  53
  54   /** Look if there is a communication going on in a mailbox and return the PID of the sender actor */
  55   aid_t listen_from() const;
  56
  57   /** Check if there is a communication ready to be consumed from a mailbox. */
  58   bool ready() const;
  59
  60   /** Gets the first element in the queue (without dequeuing it), or nullptr if none is there */
  61   kernel::activity::CommImplPtr front() const;
  62
  63   /** Declare that the specified actor is a permanent receiver on that mailbox
  64    *
  65    * It means that the communications sent to this mailbox will start flowing to
  66    * its host even before it does a get(). This models the real behavior of TCP
  67    * and MPI communications, amongst other. It will improve the accuracy of
  68    * predictions, in particular if your application exhibits swarms of small messages.
  69    *
  70    * SimGrid does not enforces any kind of ownership over the mailbox. Even if a receiver
  71    * was declared, any other actors can still get() data from the mailbox. The timings
  72    * will then probably be off tracks, so you should strive on your side to not get data
  73    * from someone else's mailbox.
  74    *
  75    * Note that being permanent receivers of a mailbox prevents actors to be garbage-collected.
  76    * If your simulation creates many short-lived actors that marked as permanent receiver, you
  77    * should call mailbox->set_receiver(nullptr) by the end of the actors so that their memory gets
  78    * properly reclaimed. This call should be at the end of the actor's function, not in an on_exit
  79    * callback.
  80    */
  81   void set_receiver(ActorPtr actor);
  82
  83   /** Return the actor declared as permanent receiver, or nullptr if none **/
  84   ActorPtr get_receiver() const;
  85
  86   /** Creates (but don't start) a data transmission to that mailbox */
  87   CommPtr put_init();
  88   /** Creates (but don't start) a data transmission to that mailbox.
  89    *
  90    * Please note that if you send a pointer to some data, you must ensure that your data remains live during the
  91    * communication, or the receiver will get a pointer to a garbled memory area.
  92    */
  93   CommPtr put_init(void* data, uint64_t simulated_size_in_bytes);
  94   /** Creates and start a data transmission to that mailbox.
  95    *
  96    * Please note that if you send a pointer to some data, you must ensure that your data remains live during the
  97    * communication, or the receiver will get a pointer to a garbled memory area.
  98    */
  99   CommPtr put_async(void* data, uint64_t simulated_size_in_bytes);
 100
 101   kernel::activity::ActivityImplPtr
 102   iprobe(int type, const std::function<bool(void*, void*, kernel::activity::CommImpl*)>& match_fun, void* data);
 103   /** Blocking data transmission.
 104    *
 105    * Please note that if you send a pointer to some data, you must ensure that your data remains live during the
 106    * communication, or the receiver will get a pointer to a garbled memory area.
 107    */
 108   void put(void* payload, uint64_t simulated_size_in_bytes);
 109   /** Blocking data transmission with timeout */
 110   void put(void* payload, uint64_t simulated_size_in_bytes, double timeout);
 111
 112   /** Creates (but don't start) a data reception onto that mailbox.
 113    * @verbatim embed:rst:inline You probably want to use :cpp:func:`simgrid::s4u::Comm::set_dst_data` and friends before
 114    * starting that activity. @endverbatim  */
 115   CommPtr get_init();
 116   /** Creates and start an async data reception to that mailbox */
 117   template <typename T> CommPtr get_async(T** data);
 118
 119   /** Blocking data reception */
 120   template <typename T> T* get();
 121   template <typename T> std::unique_ptr<T> get_unique() { return std::unique_ptr<T>(get<T>()); }
 122
 123   /** Blocking data reception with timeout */
 124   template <typename T> T* get(double timeout);
 125   template <typename T> std::unique_ptr<T> get_unique(double timeout) { return std::unique_ptr<T>(get<T>(timeout)); }
 126
 127   void clear();
 128 };
 129
 130 template <typename T> CommPtr Mailbox::get_async(T** data)
 131 {
 132   CommPtr res = get_init()->set_dst_data(reinterpret_cast<void**>(data), sizeof(void*));
 133   res->vetoable_start();
 134   return res;
 135 }
 136
 137 template <typename T> T* Mailbox::get()
 138 {
 139   T* res = nullptr;
 140   get_async<T>(&res)->wait();
 141   return res;
 142 }
 143
 144 template <typename T> T* Mailbox::get(double timeout)
 145 {
 146   T* res = nullptr;
 147   get_async<T>(&res)->wait_for(timeout);
 148   return res;
 149 }
 150 } // namespace s4u
 151 } // namespace simgrid
 152
 153 #endif /* SIMGRID_S4U_MAILBOX_HPP */