include/simgrid/s4u/Comm.hpp

   1 /* Copyright (c) 2006-2019. 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 <atomic>
  13 #include <string>
  14 #include <vector>
  15
  16 namespace simgrid {
  17 namespace s4u {
  18 /** @brief Communication async
  19  *
  20  * Represents all asynchronous communications, that you can test or wait onto.
  21  */
  22 class XBT_PUBLIC Comm : public Activity {
  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   std::string tracing_category_       = "";
  32   std::atomic_int_fast32_t refcount_{0};
  33   /* FIXME: expose these elements in the API */
  34   bool detached_                                                          = false;
  35   int (*match_fun_)(void*, void*, kernel::activity::CommImpl*)            = nullptr;
  36   void (*clean_fun_)(void*)                                               = nullptr;
  37   void (*copy_data_function_)(kernel::activity::CommImpl*, void*, size_t) = nullptr;
  38
  39   Comm() : Activity() {}
  40
  41 public:
  42 #ifndef DOXYGEN
  43   friend XBT_PUBLIC void intrusive_ptr_release(Comm* c);
  44   friend XBT_PUBLIC void intrusive_ptr_add_ref(Comm* c);
  45   friend Mailbox; // Factory of comms
  46 #endif
  47
  48   virtual ~Comm();
  49
  50   static xbt::signal<void(Actor const&)> on_sender_start;
  51   static xbt::signal<void(Actor const&)> on_receiver_start;
  52   static xbt::signal<void(Actor const&)> on_completion;
  53
  54   /*! take a vector s4u::CommPtr and return when one of them is finished.
  55    * The return value is the rank of the first finished CommPtr. */
  56   static int wait_any(std::vector<CommPtr> * comms) { return wait_any_for(comms, -1); }
  57   /*! Same as wait_any, but with a timeout. If the timeout occurs, parameter last is returned.*/
  58   static int wait_any_for(std::vector<CommPtr>* comms_in, double timeout);
  59
  60   /*! take a vector s4u::CommPtr and return when all of them is finished. */
  61   static void wait_all(std::vector<CommPtr>* comms);
  62   /*! take a vector s4u::CommPtr and return the rank of the first finished one (or -1 if none is done). */
  63   static int test_any(std::vector<CommPtr> * comms);
  64
  65   Comm* start() override;
  66   Comm* wait() override;
  67   Comm* wait_for(double timeout) override;
  68   Comm* cancel() override;
  69   bool test() override;
  70
  71   /** Start the comm, and ignore its result. It can be completely forgotten after that. */
  72   Comm* detach();
  73   /** Start the comm, and ignore its result. It can be completely forgotten after that. */
  74   Comm* detach(void (*clean_function)(void*))
  75   {
  76     clean_fun_ = clean_function;
  77     return detach();
  78   }
  79
  80   /** Sets the maximal communication rate (in byte/sec). Must be done before start */
  81   CommPtr set_rate(double rate);
  82
  83   /** Specify the data to send.
  84    *
  85    * This is way will get actually copied over to the receiver.
  86    * That's completely unrelated from the simulated size (given with @ref Activity::set_remaining()):
  87    * you can send a short buffer in your simulator, that represents a very large message
  88    * in the simulated world, or the opposite.
  89    */
  90   CommPtr set_src_data(void* buff);
  91   /** Specify the size of the data to send. Not to be mixed with @ref Activity::set_remaining()
  92    *
  93    * That's the size of the data to actually copy in the simulator (ie, the data passed with Activity::set_src_data()).
  94    * That's completely unrelated from the simulated size (given with @ref Activity::set_remaining()):
  95    * you can send a short buffer in your simulator, that represents a very large message
  96    * in the simulated world, or the opposite.
  97    */
  98   CommPtr set_src_data_size(size_t size);
  99   /** Specify the data to send and its size. Don't mix the size with @ref Activity::set_remaining()
 100    *
 101    * This is way will get actually copied over to the receiver.
 102    * That's completely unrelated from the simulated size (given with @ref Activity::set_remaining()):
 103    * you can send a short buffer in your simulator, that represents a very large message
 104    * in the simulated world, or the opposite.
 105    */
 106   CommPtr set_src_data(void* buff, size_t size);
 107
 108   /** Specify where to receive the data.
 109    *
 110    * That's a buffer where the sent data will be copied */
 111   CommPtr set_dst_data(void** buff);
 112   /** Specify the buffer in which the data should be received
 113    *
 114    * That's a buffer where the sent data will be copied  */
 115   CommPtr set_dst_data(void** buff, size_t size);
 116
 117   CommPtr set_tracing_category(const std::string& category);
 118
 119   /** Retrieve the mailbox on which this comm acts */
 120   Mailbox* get_mailbox();
 121   /** Retrieve the size of the received data. Not to be mixed with @ref Activity::set_remaining()  */
 122   size_t get_dst_data_size();
 123
 124   Actor* get_sender();
 125
 126 #ifndef DOXYGEN
 127   XBT_ATTRIB_DEPRECATED_v324("Please use Comm::wait_for()") void wait(double t) override { wait_for(t); }
 128 #endif
 129 };
 130 } // namespace s4u
 131 } // namespace simgrid
 132
 133 #endif /* SIMGRID_S4U_COMM_HPP */