include/simgrid/s4u/Comm.hpp

   1 /* Copyright (c) 2006-2021. 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_COMM_HPP
   7 #define SIMGRID_S4U_COMM_HPP
   8
   9 #include <simgrid/forward.h>
  10 #include <simgrid/s4u/Activity.hpp>
  11
  12 #include <string>
  13 #include <vector>
  14
  15 namespace simgrid {
  16 namespace s4u {
  17 /** @brief Communication async
  18  *
  19  * Represents all asynchronous communications, that you can test or wait onto.
  20  */
  21 class XBT_PUBLIC Comm : public Activity_T<Comm> {
  22   Mailbox* mailbox_                   = nullptr;
  23   kernel::actor::ActorImpl* sender_   = nullptr; /* specified for normal mailbox-based communications*/
  24   kernel::actor::ActorImpl* receiver_ = nullptr;
  25   Host* from_                         = nullptr; /* specified only for direct host-to-host communications */
  26   Host* to_                           = nullptr;
  27   double rate_                        = -1;
  28   void* dst_buff_                     = nullptr;
  29   size_t dst_buff_size_               = 0;
  30   void* src_buff_                     = nullptr;
  31   size_t src_buff_size_               = sizeof(void*);
  32   /* FIXME: expose these elements in the API */
  33   bool detached_                                                          = false;
  34   bool (*match_fun_)(void*, void*, kernel::activity::CommImpl*)           = nullptr;
  35   void (*clean_fun_)(void*)                                               = nullptr;
  36   void (*copy_data_function_)(kernel::activity::CommImpl*, void*, size_t) = nullptr;
  37
  38   Comm() = default;
  39
  40 protected:
  41   void complete(Activity::State state) override;
  42
  43 public:
  44 #ifndef DOXYGEN
  45   friend Mailbox; // Factory of comms
  46 #endif
  47
  48   ~Comm() override;
  49
  50   /*! Creates a communication beween the two given hosts, bypassing the mailbox mechanism. */
  51   static CommPtr sendto_init(Host* from, Host* to);
  52   /** Do an asynchronous communication between two arbitrary hosts.
  53    *
  54    * This initializes a communication that completely bypass the mailbox and actors mechanism.
  55    * There is really no limit on the hosts involved. In particular, the actor does not have to be on one of the involved
  56    * hosts.
  57    */
  58   static CommPtr sendto_async(Host* from, Host* to, uint64_t simulated_size_in_bytes);
  59   /** Do a blocking communication between two arbitrary hosts.
  60    *
  61    * This starts a blocking communication right away, bypassing the mailbox and actors mechanism.
  62    * The calling actor is blocked until the end of the communication; there is really no limit on the hosts involved.
  63    * In particular, the actor does not have to be on one of the involved hosts. Enjoy the comfort of the simulator :)
  64    */
  65   static void sendto(Host* from, Host* to, uint64_t simulated_size_in_bytes);
  66
  67   static xbt::signal<void(Comm const&, bool is_sender)> on_start;
  68   static xbt::signal<void(Comm const&)> on_completion;
  69
  70   /*! take a vector s4u::CommPtr and return when one of them is finished.
  71    * The return value is the rank of the first finished CommPtr. */
  72   static ssize_t wait_any(const std::vector<CommPtr>& comms) { return wait_any_for(comms, -1); }
  73   /*! Same as wait_any, but with a timeout. Return -1 if the timeout occurs.*/
  74   static ssize_t wait_any_for(const std::vector<CommPtr>& comms, double timeout);
  75
  76   /*! take a vector s4u::CommPtr and return when all of them is finished. */
  77   static void wait_all(const std::vector<CommPtr>& comms);
  78   /*! Same as wait_all, but with a timeout. Return the number of terminated comm (less than comms.size() if the timeout
  79    * occurs). */
  80   static size_t wait_all_for(const std::vector<CommPtr>& comms, double timeout);
  81   /*! take a vector s4u::CommPtr and return the rank of the first finished one (or -1 if none is done). */
  82   static ssize_t test_any(const std::vector<CommPtr>& comms);
  83
  84 #ifndef DOXYGEN
  85   XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for parameter")
  86   static int wait_any(const std::vector<CommPtr>* comms) { return static_cast<int>(wait_any_for(*comms, -1)); }
  87   XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for first parameter")
  88   static int wait_any_for(const std::vector<CommPtr>* comms, double timeout) { return static_cast<int>(wait_any_for(*comms, timeout)); }
  89   XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for parameter")
  90   static void wait_all(const std::vector<CommPtr>* comms) { wait_all(*comms); }
  91   XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for parameter")
  92   static int test_any(const std::vector<CommPtr>* comms) { return static_cast<int>(test_any(*comms)); }
  93 #endif
  94
  95   Comm* start() override;
  96   Comm* wait_for(double timeout) override;
  97   bool test() override;
  98
  99   /** Start the comm, and ignore its result. It can be completely forgotten after that. */
 100   Comm* detach();
 101   /** Start the comm, and ignore its result. It can be completely forgotten after that. */
 102   Comm* detach(void (*clean_function)(void*))
 103   {
 104     clean_fun_ = clean_function;
 105     return detach();
 106   }
 107
 108   /** Sets the maximal communication rate (in byte/sec). Must be done before start */
 109   CommPtr set_rate(double rate);
 110
 111   /** Specify the data to send.
 112    *
 113    * @beginrst
 114    * This is way will get actually copied over to the receiver.
 115    * That's completely unrelated from the simulated size (given by :cpp:func:`simgrid::s4u::Comm::set_payload_size`):
 116    * you can send a short buffer in your simulator, that represents a very large message
 117    * in the simulated world, or the opposite.
 118    * @endrst
 119    */
 120   CommPtr set_src_data(void* buff);
 121   /** Specify the size of the data to send (not to be mixed with set_payload_size())
 122    *
 123    * @beginrst
 124    * That's the size of the data to actually copy in the simulator (ie, the data passed with
 125    * :cpp:func:`simgrid::s4u::Comm::set_src_data`). That's completely unrelated from the simulated size (given by
 126    * :cpp:func:`simgrid::s4u::Comm::set_payload_size`)): you can send a short buffer in your simulator, that represents
 127    * a very large message in the simulated world, or the opposite.
 128    * @endrst
 129    */
 130   CommPtr set_src_data_size(size_t size);
 131
 132   /** Specify the amount of bytes which exchange should be simulated (not to be mixed with set_src_data_size())
 133    *
 134    * @beginrst
 135    * That's the size of the simulated data, that's completely related from the actual data size (given by
 136    * :cpp:func:`simgrid::s4u::Comm::set_src_data_size`).
 137    * @endrst
 138    */
 139   CommPtr set_payload_size(uint64_t bytes);
 140
 141   /** Specify the data to send and its size (not to be mixed with set_payload_size())
 142    *
 143    * @beginrst
 144    * This is way will get actually copied over to the receiver.
 145    * That's completely unrelated from the simulated size (given by :cpp:func:`simgrid::s4u::Comm::set_payload_size`):
 146    * you can send a short buffer in your simulator, that represents a very large message
 147    * in the simulated world, or the opposite.
 148    * @endrst
 149    */
 150   CommPtr set_src_data(void* buff, size_t size);
 151
 152   /** Specify where to receive the data.
 153    *
 154    * That's a buffer where the sent data will be copied */
 155   CommPtr set_dst_data(void** buff);
 156   /** Specify the buffer in which the data should be received
 157    *
 158    * That's a buffer where the sent data will be copied  */
 159   CommPtr set_dst_data(void** buff, size_t size);
 160   /** Retrieve where the data will be copied on the receiver side */
 161   void* get_dst_data();
 162
 163   /** Retrieve the mailbox on which this comm acts */
 164   Mailbox* get_mailbox() const;
 165   /** Retrieve the size of the received data. Not to be mixed with @ref Activity::set_remaining()  */
 166   size_t get_dst_data_size() const;
 167
 168   Actor* get_sender() const;
 169
 170   bool is_assigned() const override { return (to_ != nullptr && from_ != nullptr) || (mailbox_ != nullptr); }
 171
 172   CommPtr set_copy_data_callback(void (*callback)(kernel::activity::CommImpl*, void*, size_t));
 173 };
 174 } // namespace s4u
 175 } // namespace simgrid
 176
 177 #endif /* SIMGRID_S4U_COMM_HPP */