include/simgrid/s4u/Mailbox.hpp

   1 /* Copyright (c) 2006-2018. 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 <xbt/string.hpp>
  10 #include <simgrid/s4u/Actor.hpp>
  11
  12 #include <string>
  13
  14 namespace simgrid {
  15 namespace s4u {
  16
  17 /** @brief Mailboxes: Network rendez-vous points. */
  18 class XBT_PUBLIC Mailbox {
  19   friend simgrid::s4u::Comm;
  20   friend simgrid::kernel::activity::MailboxImpl;
  21
  22   simgrid::kernel::activity::MailboxImpl* pimpl_;
  23
  24   explicit Mailbox(kernel::activity::MailboxImpl * mbox) : pimpl_(mbox) {}
  25
  26   /** private function to manage the mailboxes' lifetime (see @ref s4u_raii) */
  27   friend void intrusive_ptr_add_ref(Mailbox*) {}
  28   /** private function to manage the mailboxes' lifetime (see @ref s4u_raii) */
  29   friend void intrusive_ptr_release(Mailbox*) {}
  30 public:
  31   /** private function, do not use. FIXME: make me protected */
  32   kernel::activity::MailboxImpl* get_impl() { return pimpl_; }
  33
  34   /** @brief Retrieves the name of that mailbox as a C++ string */
  35   const simgrid::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 */
  40   static MailboxPtr by_name(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   smx_activity_t 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 emission to that mailbox */
  78   CommPtr put_init();
  79   /** Creates (but don't start) a data emission to that mailbox */
  80   CommPtr put_init(void* data, uint64_t simulated_size_in_bytes);
  81   /** Creates and start a data emission to that mailbox */
  82   CommPtr put_async(void* data, uint64_t simulated_size_in_bytes);
  83
  84   /** Blocking data emission */
  85   void put(void* payload, uint64_t simulated_size_in_bytes);
  86   /** Blocking data emission with timeout */
  87   void put(void* payload, uint64_t simulated_size_in_bytes, double timeout);
  88
  89   /** Creates (but don't start) a data reception onto that mailbox */
  90   CommPtr get_init();
  91   /** Creates and start an async data reception to that mailbox */
  92   CommPtr get_async(void** data);
  93
  94   /** Blocking data reception */
  95   void* get(); // FIXME: make a typed template version
  96   /** Blocking data reception with timeout */
  97   void* get(double timeout);
  98
  99   // Deprecated functions
 100   /** @deprecated Mailbox::set_receiver() */
 101   XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::set_receiver()") void setReceiver(ActorPtr actor)
 102   {
 103     set_receiver(actor);
 104   }
 105   /** @deprecated Mailbox::get_receiver() */
 106   XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_receiver()") ActorPtr getReceiver() { return get_receiver(); }
 107   /** @deprecated Mailbox::get_name() */
 108   XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_name()") const simgrid::xbt::string& getName() const
 109   {
 110     return get_name();
 111   }
 112   /** @deprecated Mailbox::get_cname() */
 113   XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_cname()") const char* getCname() const { return get_cname(); }
 114   /** @deprecated Mailbox::get_impl() */
 115   XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_impl()") kernel::activity::MailboxImpl* getImpl()
 116   {
 117     return get_impl();
 118   }
 119   /** @deprecated Mailbox::by_name() */
 120   XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::by_name()") static MailboxPtr byName(const char* name)
 121   {
 122     return by_name(name);
 123   }
 124   /** @deprecated Mailbox::by_name() */
 125   XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::by_name()") static MailboxPtr byName(std::string name)
 126   {
 127     return by_name(name);
 128   }
 129 };
 130
 131 }} // namespace simgrid::s4u
 132
 133 #endif /* SIMGRID_S4U_MAILBOX_HPP */