include/simgrid/s4u/Comm.hpp

   1 /* Copyright (c) 2006-2021. 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 {
  16 namespace s4u {
  17 /** @brief Communication async
  18  *
  19  * Represents all asynchronous communications, that you can test or wait onto.
  20  */
  21 class XBT_PUBLIC Comm : public Activity_T<Comm> {
  22   Mailbox* mailbox_                   = nullptr;
  23   kernel::actor::ActorImpl* sender_   = nullptr; /* specified for normal mailbox-based communications*/
  24   kernel::actor::ActorImpl* receiver_ = nullptr;
  25   Host* from_                         = nullptr; /* specified only for direct host-to-host communications */
  26   Host* to_                           = 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   /* FIXME: expose these elements in the API */
  33   bool detached_                                                          = false;
  34   bool (*match_fun_)(void*, void*, kernel::activity::CommImpl*)           = nullptr;
  35   void (*clean_fun_)(void*)                                               = nullptr;
  36   void (*copy_data_function_)(kernel::activity::CommImpl*, void*, size_t) = nullptr;
  37
  38   Comm() = default;
  39
  40 public:
  41 #ifndef DOXYGEN
  42   friend Mailbox; // Factory of comms
  43 #endif
  44
  45   ~Comm() override;
  46
  47   /*! Creates a communication beween the two given hosts, bypassing the mailbox mechanism. */
  48   static CommPtr sendto_init(Host* from, Host* to);
  49   /*! Creates and start a communication of the given amount of bytes beween the two given hosts, bypassing the mailbox
  50    * mechanism */
  51   static CommPtr sendto_async(Host* from, Host* to, double simulated_size_in_bytes);
  52
  53   static xbt::signal<void(Comm const&, bool is_sender)> on_start;
  54   static xbt::signal<void(Comm const&)> on_completion;
  55
  56   /*! take a vector s4u::CommPtr and return when one of them is finished.
  57    * The return value is the rank of the first finished CommPtr. */
  58   static int wait_any(const std::vector<CommPtr>* comms) { return wait_any_for(comms, -1); }
  59   /*! Same as wait_any, but with a timeout. Return -1 if the timeout occurs.*/
  60   static int wait_any_for(const std::vector<CommPtr>* comms_in, double timeout);
  61
  62   /*! take a vector s4u::CommPtr and return when all of them is finished. */
  63   static void wait_all(const std::vector<CommPtr>* comms);
  64   /*! take a vector s4u::CommPtr and return the rank of the first finished one (or -1 if none is done). */
  65   static int test_any(const std::vector<CommPtr>* comms);
  66
  67   Comm* start() override;
  68   Comm* wait() override;
  69   Comm* wait_for(double timeout) override;
  70   Comm* cancel() override;
  71   bool test() override;
  72
  73   /** Start the comm, and ignore its result. It can be completely forgotten after that. */
  74   Comm* detach();
  75   /** Start the comm, and ignore its result. It can be completely forgotten after that. */
  76   Comm* detach(void (*clean_function)(void*))
  77   {
  78     clean_fun_ = clean_function;
  79     return detach();
  80   }
  81
  82   /** Sets the maximal communication rate (in byte/sec). Must be done before start */
  83   CommPtr set_rate(double rate);
  84
  85   /** Specify the data to send.
  86    *
  87    * @beginrst
  88    * This is way will get actually copied over to the receiver.
  89    * That's completely unrelated from the simulated size (given by :cpp:func:`simgrid::s4u::Comm::set_payload_size`):
  90    * you can send a short buffer in your simulator, that represents a very large message
  91    * in the simulated world, or the opposite.
  92    * @endrst
  93    */
  94   CommPtr set_src_data(void* buff);
  95   /** Specify the size of the data to send (not to be mixed with set_payload_size())
  96    *
  97    * @beginrst
  98    * That's the size of the data to actually copy in the simulator (ie, the data passed with
  99    * :cpp:func:`simgrid::s4u::Comm::set_src_data`). That's completely unrelated from the simulated size (given by
 100    * :cpp:func:`simgrid::s4u::Comm::set_payload_size`)): you can send a short buffer in your simulator, that represents
 101    * a very large message in the simulated world, or the opposite.
 102    * @endrst
 103    */
 104   CommPtr set_src_data_size(size_t size);
 105
 106   /** Specify the amount of bytes which exchange should be simulated (not to be mixed with set_src_data_size())
 107    *
 108    * @beginrst
 109    * That's the size of the simulated data, that's completely related from the actual data size (given by
 110    * :cpp:func:`simgrid::s4u::Comm::set_src_data_size`).
 111    * @endrst
 112    */
 113   CommPtr set_payload_size(double bytes);
 114
 115   /** Specify the data to send and its size (not to be mixed with set_payload_size())
 116    *
 117    * @beginrst
 118    * This is way will get actually copied over to the receiver.
 119    * That's completely unrelated from the simulated size (given by :cpp:func:`simgrid::s4u::Comm::set_payload_size`):
 120    * you can send a short buffer in your simulator, that represents a very large message
 121    * in the simulated world, or the opposite.
 122    * @endrst
 123    */
 124   CommPtr set_src_data(void* buff, size_t size);
 125
 126   /** Specify where to receive the data.
 127    *
 128    * That's a buffer where the sent data will be copied */
 129   CommPtr set_dst_data(void** buff);
 130   /** Specify the buffer in which the data should be received
 131    *
 132    * That's a buffer where the sent data will be copied  */
 133   CommPtr set_dst_data(void** buff, size_t size);
 134   /** Retrieve where the data will be copied on the receiver side */
 135   void* get_dst_data();
 136
 137   /** Retrieve the mailbox on which this comm acts */
 138   Mailbox* get_mailbox() const;
 139   /** Retrieve the size of the received data. Not to be mixed with @ref Activity::set_remaining()  */
 140   size_t get_dst_data_size() const;
 141
 142   Actor* get_sender() const;
 143
 144   bool is_assigned() const override { return (to_ != nullptr && from_ != nullptr) || (mailbox_ != nullptr); }
 145 };
 146 } // namespace s4u
 147 } // namespace simgrid
 148
 149 #endif /* SIMGRID_S4U_COMM_HPP */