include/simgrid/s4u/Comm.hpp

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