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