include/simgrid/s4u/Mailbox.hpp

   1 /* Copyright (c) 2006-2020. 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 <smpi/forward.hpp>
  12 #include <xbt/string.hpp>
  13
  14 #include <string>
  15
  16 namespace simgrid {
  17 namespace s4u {
  18
  19 /** @brief Mailboxes: Network rendez-vous points. */
  20 class XBT_PUBLIC Mailbox {
  21   friend Comm;
  22   friend smpi::Request;
  23   friend kernel::activity::MailboxImpl;
  24
  25   kernel::activity::MailboxImpl* const pimpl_;
  26
  27   explicit Mailbox(kernel::activity::MailboxImpl * mbox) : pimpl_(mbox) {}
  28   ~Mailbox() = default;
  29
  30 protected:
  31   kernel::activity::MailboxImpl* get_impl() const { return pimpl_; }
  32
  33 public:
  34   /** @brief Retrieves the name of that mailbox as a C++ string */
  35   const xbt::string& get_name() const;
  36   /** @brief Retrieves the name of that mailbox as a C string */
  37   const char* get_cname() const;
  38
  39   /** Retrieve the mailbox associated to the given name. Mailboxes are created on demand. */
  40   static Mailbox* by_name(const std::string& name);
  41
  42   /** Returns whether the mailbox contains queued communications */
  43   bool empty();
  44
  45   /** Check if there is a communication going on in a mailbox. */
  46   bool listen();
  47
  48   /** Check if there is a communication ready to be consumed from a mailbox. */
  49   bool ready();
  50
  51   /** Gets the first element in the queue (without dequeuing it), or nullptr if none is there */
  52   kernel::activity::CommImplPtr front();
  53
  54   /** Declare that the specified actor is a permanent receiver on that mailbox
  55    *
  56    * It means that the communications sent to this mailbox will start flowing to
  57    * its host even before it does a get(). This models the real behavior of TCP
  58    * and MPI communications, amongst other. It will improve the accuracy of
  59    * predictions, in particular if your application exhibits swarms of small messages.
  60    *
  61    * SimGrid does not enforces any kind of ownership over the mailbox. Even if a receiver
  62    * was declared, any other actors can still get() data from the mailbox. The timings
  63    * will then probably be off tracks, so you should strive on your side to not get data
  64    * from someone else's mailbox.
  65    *
  66    * Note that being permanent receivers of a mailbox prevents actors to be garbage-collected.
  67    * If your simulation creates many short-lived actors that marked as permanent receiver, you
  68    * should call mailbox->set_receiver(nullptr) by the end of the actors so that their memory gets
  69    * properly reclaimed. This call should be at the end of the actor's function, not in a on_exit
  70    * callback.
  71    */
  72   void set_receiver(ActorPtr actor);
  73
  74   /** Return the actor declared as permanent receiver, or nullptr if none **/
  75   ActorPtr get_receiver();
  76
  77   /** Creates (but don't start) a data transmission to that mailbox */
  78   CommPtr put_init();
  79   /** Creates (but don't start) a data transmission to that mailbox */
  80   CommPtr put_init(void* data, uint64_t simulated_size_in_bytes);
  81   /** Creates and start a data transmission to that mailbox */
  82   CommPtr put_async(void* data, uint64_t simulated_size_in_bytes);
  83
  84   smx_activity_t iprobe(int type, bool (*match_fun)(void*, void*, kernel::activity::CommImpl*), void* data);
  85   /** Blocking data transmission */
  86   void put(void* payload, uint64_t simulated_size_in_bytes);
  87   /** Blocking data transmission with timeout */
  88   void put(void* payload, uint64_t simulated_size_in_bytes, double timeout);
  89
  90   /** Creates (but don't start) a data reception onto that mailbox */
  91   CommPtr get_init();
  92   /** Creates and start an async data reception to that mailbox */
  93   CommPtr get_async(void** data);
  94
  95   /** Blocking data reception */
  96   void* get(); // FIXME: make a typed template version
  97   /** Blocking data reception with timeout */
  98   void* get(double timeout);
  99 };
 100
 101 } // namespace s4u
 102 } // namespace simgrid
 103
 104 #endif /* SIMGRID_S4U_MAILBOX_HPP */