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