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