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