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