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   /* "One-sided" communications. This way of communicating bypasses the mailbox and actors mechanism. It creates a
  63    * communication (vetoabled, asynchronous, or synchronous) directly between two hosts. There is really no limit on
  64    * the hosts involved. In particular, the actor creating such a communication does not have to be on one of the
  65    * involved hosts! Enjoy the comfort of the simulator :)
  66    */
  67   static CommPtr sendto_init(); /* Source and Destination hosts have to be set before the communication can start */
  68   static CommPtr sendto_init(Host* from, Host* to);
  69   static CommPtr sendto_async(Host* from, Host* to, uint64_t simulated_size_in_bytes);
  70   static void sendto(Host* from, Host* to, uint64_t simulated_size_in_bytes);
  71
  72   CommPtr set_source(Host* from);
  73   Host* get_source() const;
  74   CommPtr set_destination(Host* to);
  75   Host* get_destination() const;
  76
  77   /* Mailbox-based communications */
  78   CommPtr set_mailbox(Mailbox* mailbox);
  79   /** Retrieve the mailbox on which this comm acts */
  80   Mailbox* get_mailbox() const { return mailbox_; }
  81
  82   /** Specify the data to send.
  83    *
  84    * @beginrst
  85    * This is way will get actually copied over to the receiver.
  86    * That's completely unrelated from the simulated size (given by :cpp:func:`simgrid::s4u::Comm::set_payload_size`):
  87    * you can send a short buffer in your simulator, that represents a very large message
  88    * in the simulated world, or the opposite.
  89    * @endrst
  90    */
  91   CommPtr set_src_data(void* buff);
  92   /** Specify the size of the data to send (not to be mixed with set_payload_size())
  93    *
  94    * @beginrst
  95    * That's the size of the data to actually copy in the simulator (ie, the data passed with
  96    * :cpp:func:`simgrid::s4u::Comm::set_src_data`). That's completely unrelated from the simulated size (given by
  97    * :cpp:func:`simgrid::s4u::Comm::set_payload_size`)): you can send a short buffer in your simulator, that represents
  98    * a very large message in the simulated world, or the opposite.
  99    * @endrst
 100    */
 101   CommPtr set_src_data_size(size_t size);
 102   /** Specify the data to send and its size (not to be mixed with set_payload_size())
 103    *
 104    * @beginrst
 105    * This is way will get actually copied over to the receiver.
 106    * That's completely unrelated from the simulated size (given by :cpp:func:`simgrid::s4u::Comm::set_payload_size`):
 107    * you can send a short buffer in your simulator, that represents a very large message
 108    * in the simulated world, or the opposite.
 109    * @endrst
 110    */
 111   CommPtr set_src_data(void* buff, size_t size);
 112
 113   /** Specify where to receive the data.
 114    *
 115    * That's a buffer where the sent data will be copied */
 116   CommPtr set_dst_data(void** buff);
 117   /** Specify the buffer in which the data should be received
 118    *
 119    * That's a buffer where the sent data will be copied  */
 120   CommPtr set_dst_data(void** buff, size_t size);
 121   /** Retrieve where the data will be copied on the receiver side */
 122   void* get_dst_data() { return dst_buff_; }
 123   /** Retrieve the size of the received data. Not to be mixed with @ref Activity::set_remaining()  */
 124   size_t get_dst_data_size() const { return dst_buff_size_; }
 125
 126   /* Common functions */
 127
 128   /** Specify the amount of bytes which exchange should be simulated (not to be mixed with set_src_data_size())
 129    *
 130    * @beginrst
 131    * That's the size of the simulated data, that's completely unrelated from the actual data size (given by
 132    * :cpp:func:`simgrid::s4u::Comm::set_src_data_size`).
 133    * @endrst
 134    */
 135   CommPtr set_payload_size(uint64_t bytes);
 136   /** Sets the maximal communication rate (in byte/sec). Must be done before start */
 137   CommPtr set_rate(double rate);
 138
 139   bool is_assigned() const override;
 140   Actor* get_sender() const;
 141
 142   /* Comm life cycle */
 143   Comm* start() override;
 144   /** Start the comm, and ignore its result. It can be completely forgotten after that. */
 145   Comm* detach();
 146   /** Start the comm, and ignore its result. It can be completely forgotten after that. */
 147   Comm* detach(void (*clean_function)(void*))
 148   {
 149     clean_fun_ = clean_function;
 150     return detach();
 151   }
 152
 153   Comm* wait_for(double timeout) override;
 154
 155   /*! take a vector s4u::CommPtr and return the rank of the first finished one (or -1 if none is done). */
 156   static ssize_t test_any(const std::vector<CommPtr>& comms);
 157
 158   /*! take a vector s4u::CommPtr and return when one of them is finished.
 159    * The return value is the rank of the first finished CommPtr. */
 160   static ssize_t wait_any(const std::vector<CommPtr>& comms) { return wait_any_for(comms, -1); }
 161   /*! Same as wait_any, but with a timeout. Return -1 if the timeout occurs.*/
 162   static ssize_t wait_any_for(const std::vector<CommPtr>& comms, double timeout);
 163
 164   /*! take a vector s4u::CommPtr and return when all of them is finished. */
 165   static void wait_all(const std::vector<CommPtr>& comms);
 166   /*! Same as wait_all, but with a timeout. Return the number of terminated comm (less than comms.size() if the timeout
 167    * occurs). */
 168   static size_t wait_all_for(const std::vector<CommPtr>& comms, double timeout);
 169
 170 #ifndef DOXYGEN
 171   XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for parameter") static int wait_any(
 172       const std::vector<CommPtr>* comms)
 173   {
 174     return static_cast<int>(wait_any_for(*comms, -1));
 175   }
 176   XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for first parameter") static int wait_any_for(
 177       const std::vector<CommPtr>* comms, double timeout)
 178   {
 179     return static_cast<int>(wait_any_for(*comms, timeout));
 180   }
 181   XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for parameter") static void wait_all(
 182       const std::vector<CommPtr>* comms)
 183   {
 184     wait_all(*comms);
 185   }
 186   XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for parameter") static int test_any(
 187       const std::vector<CommPtr>* comms)
 188   {
 189     return static_cast<int>(test_any(*comms));
 190   }
 191 #endif
 192 };
 193 } // namespace s4u
 194 } // namespace simgrid
 195
 196 #endif /* SIMGRID_S4U_COMM_HPP */