include/simgrid/s4u/Comm.hpp

   1 /* Copyright (c) 2006-2020. 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;
  24   kernel::actor::ActorImpl* receiver_ = nullptr;
  25   double rate_                        = -1;
  26   void* dst_buff_                     = nullptr;
  27   size_t dst_buff_size_               = 0;
  28   void* src_buff_                     = nullptr;
  29   size_t src_buff_size_               = sizeof(void*);
  30   /* FIXME: expose these elements in the API */
  31   bool detached_                                                          = false;
  32   bool (*match_fun_)(void*, void*, kernel::activity::CommImpl*)           = nullptr;
  33   void (*clean_fun_)(void*)                                               = nullptr;
  34   void (*copy_data_function_)(kernel::activity::CommImpl*, void*, size_t) = nullptr;
  35
  36   Comm() = default;
  37
  38 public:
  39 #ifndef DOXYGEN
  40   friend Mailbox; // Factory of comms
  41 #endif
  42
  43   ~Comm() override;
  44
  45   static xbt::signal<void(Comm const&, Actor const&)> on_sender_start;
  46   static xbt::signal<void(Comm const&, Actor const&)> on_receiver_start;
  47   static xbt::signal<void(Comm const&, Actor const&)> on_completion;
  48
  49   /*! take a vector s4u::CommPtr and return when one of them is finished.
  50    * The return value is the rank of the first finished CommPtr. */
  51   static int wait_any(const std::vector<CommPtr>* comms) { return wait_any_for(comms, -1); }
  52   /*! Same as wait_any, but with a timeout. Return -1 if the timeout occurs.*/
  53   static int wait_any_for(const std::vector<CommPtr>* comms_in, double timeout);
  54
  55   /*! take a vector s4u::CommPtr and return when all of them is finished. */
  56   static void wait_all(const std::vector<CommPtr>* comms);
  57   /*! take a vector s4u::CommPtr and return the rank of the first finished one (or -1 if none is done). */
  58   static int test_any(const std::vector<CommPtr>* comms);
  59
  60   Comm* start() override;
  61   Comm* wait() override;
  62   Comm* wait_for(double timeout) override;
  63   Comm* cancel() override;
  64   bool test() override;
  65
  66   /** Start the comm, and ignore its result. It can be completely forgotten after that. */
  67   Comm* detach();
  68   /** Start the comm, and ignore its result. It can be completely forgotten after that. */
  69   Comm* detach(void (*clean_function)(void*))
  70   {
  71     clean_fun_ = clean_function;
  72     return detach();
  73   }
  74
  75   /** Sets the maximal communication rate (in byte/sec). Must be done before start */
  76   CommPtr set_rate(double rate);
  77
  78   /** Specify the data to send.
  79    *
  80    * This is way will get actually copied over to the receiver.
  81    * That's completely unrelated from the simulated size (given with @ref Activity::set_remaining()):
  82    * you can send a short buffer in your simulator, that represents a very large message
  83    * in the simulated world, or the opposite.
  84    */
  85   CommPtr set_src_data(void* buff);
  86   /** Specify the size of the data to send. Not to be mixed with @ref Activity::set_remaining()
  87    *
  88    * That's the size of the data to actually copy in the simulator (ie, the data passed with Activity::set_src_data()).
  89    * That's completely unrelated from the simulated size (given with @ref Activity::set_remaining()):
  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    */
  93   CommPtr set_src_data_size(size_t size);
  94   /** Specify the data to send and its size. Don't mix the size with @ref Activity::set_remaining()
  95    *
  96    * This is way will get actually copied over to the receiver.
  97    * That's completely unrelated from the simulated size (given with @ref Activity::set_remaining()):
  98    * you can send a short buffer in your simulator, that represents a very large message
  99    * in the simulated world, or the opposite.
 100    */
 101   CommPtr set_src_data(void* buff, size_t size);
 102
 103   /** Specify where to receive the data.
 104    *
 105    * That's a buffer where the sent data will be copied */
 106   CommPtr set_dst_data(void** buff);
 107   /** Specify the buffer in which the data should be received
 108    *
 109    * That's a buffer where the sent data will be copied  */
 110   CommPtr set_dst_data(void** buff, size_t size);
 111
 112   /** Retrieve the mailbox on which this comm acts */
 113   Mailbox* get_mailbox() const;
 114   /** Retrieve the size of the received data. Not to be mixed with @ref Activity::set_remaining()  */
 115   size_t get_dst_data_size() const;
 116
 117   Actor* get_sender() const;
 118 };
 119 } // namespace s4u
 120 } // namespace simgrid
 121
 122 #endif /* SIMGRID_S4U_COMM_HPP */