include/simgrid/s4u/Comm.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_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   friend Mailbox; // Factory of comms
  23   /* specified for normal mailbox-based communications*/
  24   Mailbox* mailbox_                   = nullptr;
  25   kernel::actor::ActorImpl* sender_   = nullptr;
  26   kernel::actor::ActorImpl* receiver_ = 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
  33   /* specified only for direct host-to-host communications */
  34   Host* from_ = nullptr;
  35   Host* to_   = nullptr;
  36
  37   /* FIXME: expose these elements in the API */
  38   bool detached_                                                          = false;
  39   bool (*match_fun_)(void*, void*, kernel::activity::CommImpl*)           = nullptr;
  40   void (*clean_fun_)(void*)                                               = nullptr;
  41   void (*copy_data_function_)(kernel::activity::CommImpl*, void*, size_t) = nullptr;
  42
  43   Comm() = default;
  44
  45 public:
  46   /* signals and related callbacks */
  47 #ifndef DOXYGEN
  48   /* FIXME signals should be private */
  49   static xbt::signal<void(Comm const&)> on_send;
  50   static xbt::signal<void(Comm const&)> on_recv;
  51   static xbt::signal<void(Comm const&)> on_start;
  52   static xbt::signal<void(Comm const&)> on_completion;
  53 #endif
  54
  55   static void on_send_cb(const std::function<void(Comm const&)>& cb) { on_send.connect(cb); }
  56   static void on_recv_cb(const std::function<void(Comm const&)>& cb) { on_recv.connect(cb); }
  57   static void on_start_cb(const std::function<void(Comm const&)>& cb) { on_start.connect(cb); }
  58   static void on_completion_cb(const std::function<void(Activity const&)>& cb) { on_completion.connect(cb); }
  59   /* More callbacks */
  60   CommPtr set_copy_data_callback(void (*callback)(kernel::activity::CommImpl*, void*, size_t));
  61   static void copy_buffer_callback(kernel::activity::CommImpl*, void*, size_t);
  62   static void copy_pointer_callback(kernel::activity::CommImpl*, void*, size_t);
  63
  64   ~Comm() override;
  65
  66   /* "One-sided" communications. This way of communicating bypasses the mailbox and actors mechanism. It creates a
  67    * communication (vetoabled, asynchronous, or synchronous) directly between two hosts. There is really no limit on
  68    * the hosts involved. In particular, the actor creating such a communication does not have to be on one of the
  69    * involved hosts! Enjoy the comfort of the simulator :)
  70    */
  71   static CommPtr sendto_init(); /* Source and Destination hosts have to be set before the communication can start */
  72   static CommPtr sendto_init(Host* from, Host* to);
  73   static CommPtr sendto_async(Host* from, Host* to, uint64_t simulated_size_in_bytes);
  74   static void sendto(Host* from, Host* to, uint64_t simulated_size_in_bytes);
  75
  76   CommPtr set_source(Host* from);
  77   Host* get_source() const { return from_; }
  78   CommPtr set_destination(Host* to);
  79   Host* get_destination() const { return to_; }
  80
  81   /* Mailbox-based communications */
  82   CommPtr set_mailbox(Mailbox* mailbox);
  83   /** Retrieve the mailbox on which this comm acts */
  84   Mailbox* get_mailbox() const { return mailbox_; }
  85
  86   /** Specify the data to send.
  87    *
  88    * @beginrst
  89    * This is way will get actually copied over to the receiver.
  90    * That's completely unrelated from the simulated size (given by :cpp:func:`simgrid::s4u::Comm::set_payload_size`):
  91    * you can send a short buffer in your simulator, that represents a very large message
  92    * in the simulated world, or the opposite.
  93    * @endrst
  94    */
  95   CommPtr set_src_data(void* buff);
  96   /** Specify the size of the data to send (not to be mixed with set_payload_size())
  97    *
  98    * @beginrst
  99    * That's the size of the data to actually copy in the simulator (ie, the data passed with
 100    * :cpp:func:`simgrid::s4u::Comm::set_src_data`). That's completely unrelated from the simulated size (given by
 101    * :cpp:func:`simgrid::s4u::Comm::set_payload_size`)): you can send a short buffer in your simulator, that represents
 102    * a very large message in the simulated world, or the opposite.
 103    * @endrst
 104    */
 105   CommPtr set_src_data_size(size_t size);
 106   /** Specify the data to send and its size (not to be mixed with set_payload_size())
 107    *
 108    * @beginrst
 109    * This is way will get actually copied over to the receiver.
 110    * That's completely unrelated from the simulated size (given by :cpp:func:`simgrid::s4u::Comm::set_payload_size`):
 111    * you can send a short buffer in your simulator, that represents a very large message
 112    * in the simulated world, or the opposite.
 113    * @endrst
 114    */
 115   CommPtr set_src_data(void* buff, size_t size);
 116
 117   /** Specify where to receive the data.
 118    *
 119    * That's a buffer where the sent data will be copied */
 120   CommPtr set_dst_data(void** buff);
 121   /** Specify the buffer in which the data should be received
 122    *
 123    * That's a buffer where the sent data will be copied  */
 124   CommPtr set_dst_data(void** buff, size_t size);
 125   /** Retrieve where the data will be copied on the receiver side */
 126   void* get_dst_data() { return dst_buff_; }
 127   /** Retrieve the size of the received data. Not to be mixed with @ref Activity::set_remaining()  */
 128   size_t get_dst_data_size() const { return dst_buff_size_; }
 129
 130   /* Common functions */
 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 unrelated 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   /** Sets the maximal communication rate (in byte/sec). Must be done before start */
 141   CommPtr set_rate(double rate);
 142
 143   bool is_assigned() const override { return (to_ != nullptr && from_ != nullptr) || (mailbox_ != nullptr); }
 144   Actor* get_sender() const;
 145
 146   /* Comm life cycle */
 147   Comm* start() override;
 148   /** Start the comm, and ignore its result. It can be completely forgotten after that. */
 149   Comm* detach();
 150   /** Start the comm, and ignore its result. It can be completely forgotten after that. */
 151   Comm* detach(void (*clean_function)(void*))
 152   {
 153     clean_fun_ = clean_function;
 154     return detach();
 155   }
 156
 157   Comm* wait_for(double timeout) override;
 158
 159   /*! take a vector s4u::CommPtr and return the rank of the first finished one (or -1 if none is done). */
 160   static ssize_t test_any(const std::vector<CommPtr>& comms);
 161
 162   /*! take a vector s4u::CommPtr and return when one of them is finished.
 163    * The return value is the rank of the first finished CommPtr. */
 164   static ssize_t wait_any(const std::vector<CommPtr>& comms) { return wait_any_for(comms, -1); }
 165   /*! Same as wait_any, but with a timeout. Return -1 if the timeout occurs.*/
 166   static ssize_t wait_any_for(const std::vector<CommPtr>& comms, double timeout);
 167
 168   /*! take a vector s4u::CommPtr and return when all of them is finished. */
 169   static void wait_all(const std::vector<CommPtr>& comms);
 170   /*! Same as wait_all, but with a timeout. Return the number of terminated comm (less than comms.size() if the timeout
 171    * occurs). */
 172   static size_t wait_all_for(const std::vector<CommPtr>& comms, double timeout);
 173
 174 #ifndef DOXYGEN
 175   XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for parameter") static int wait_any(
 176       const std::vector<CommPtr>* comms)
 177   {
 178     return static_cast<int>(wait_any_for(*comms, -1));
 179   }
 180   XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for first parameter") static int wait_any_for(
 181       const std::vector<CommPtr>* comms, double timeout)
 182   {
 183     return static_cast<int>(wait_any_for(*comms, timeout));
 184   }
 185   XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for parameter") static void wait_all(
 186       const std::vector<CommPtr>* comms)
 187   {
 188     wait_all(*comms);
 189   }
 190   XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for parameter") static int test_any(
 191       const std::vector<CommPtr>* comms)
 192   {
 193     return static_cast<int>(test_any(*comms));
 194   }
 195 #endif
 196 };
 197 } // namespace s4u
 198 } // namespace simgrid
 199
 200 #endif /* SIMGRID_S4U_COMM_HPP */