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