include/simgrid/s4u/Comm.hpp

   1 /* Copyright (c) 2006-2018. 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 <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 {
  22   Comm() : Activity() {}
  23 public:
  24   friend XBT_PUBLIC void intrusive_ptr_release(simgrid::s4u::Comm * c);
  25   friend XBT_PUBLIC void intrusive_ptr_add_ref(simgrid::s4u::Comm * c);
  26   friend simgrid::s4u::Mailbox; // Factory of comms
  27
  28   virtual ~Comm();
  29
  30   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_sender_start;
  31   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_receiver_start;
  32   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_completion;
  33
  34   /*! take a vector s4u::CommPtr and return when one of them is finished.
  35    * The return value is the rank of the first finished CommPtr. */
  36   static int wait_any(std::vector<CommPtr> * comms) { return wait_any_for(comms, -1); }
  37   /*! Same as wait_any, but with a timeout. If the timeout occurs, parameter last is returned.*/
  38   static int wait_any_for(std::vector<CommPtr>* comms_in, double timeout);
  39
  40   /*! take a vector s4u::CommPtr and return when all of them is finished. */
  41   static void wait_all(std::vector<CommPtr>* comms);
  42   /*! take a vector s4u::CommPtr and return the rank of the first finished one (or -1 if none is done). */
  43   static int test_any(std::vector<CommPtr> * comms);
  44
  45   Activity* start() override;
  46   Activity* wait() override;
  47   Activity* wait_for(double timeout) override;
  48   bool test() override;
  49
  50   /** Start the comm, and ignore its result. It can be completely forgotten after that. */
  51   Activity* detach();
  52   /** Start the comm, and ignore its result. It can be completely forgotten after that. */
  53   Activity* detach(void (*clean_function)(void*))
  54   {
  55     clean_fun_ = clean_function;
  56     return detach();
  57   }
  58
  59   /** Sets the maximal communication rate (in byte/sec). Must be done before start */
  60   Activity* set_rate(double rate);
  61
  62   /** Specify the data to send */
  63   Activity* set_src_data(void* buff);
  64   /** Specify the size of the data to send */
  65   Activity* set_src_data_size(size_t size);
  66   /** Specify the data to send and its size */
  67   Activity* set_src_data(void* buff, size_t size);
  68
  69   /** Specify where to receive the data */
  70   Activity* set_dst_data(void** buff);
  71   /** Specify the buffer in which the data should be received */
  72   Activity* set_dst_data(void** buff, size_t size);
  73   /** Retrieve the size of the received data */
  74   size_t get_dst_data_size();
  75
  76   Activity* cancel() override;
  77
  78   /** Retrieve the mailbox on which this comm acts */
  79   MailboxPtr get_mailbox();
  80
  81 #ifndef DOXYGEN
  82   XBT_ATTRIB_DEPRECATED_v324("Please use Comm::wait_for()") void wait(double t) override { wait_for(t); }
  83   XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_rate()") Activity* setRate(double rate) { return set_rate(rate); }
  84   XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data()") Activity* setSrcData(void* buff)
  85   {
  86     return set_src_data(buff);
  87   }
  88   XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data()") Activity* setSrcData(void* buff, size_t size)
  89   {
  90     return set_src_data(buff, size);
  91   }
  92   XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data_size()") Activity* setSrcDataSize(size_t size)
  93   {
  94     return set_src_data_size(size);
  95   }
  96   XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_dst_data()") Activity* setDstData(void** buff)
  97   {
  98     return set_dst_data(buff);
  99   }
 100   XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_dst_data()") Activity* setDstData(void** buff, size_t size)
 101   {
 102     return set_dst_data(buff, size);
 103   }
 104   XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_dst_data_size()") size_t getDstDataSize()
 105   {
 106     return get_dst_data_size();
 107   }
 108   XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_mailbox()") MailboxPtr getMailbox() { return get_mailbox(); }
 109 #endif
 110
 111 private:
 112   double rate_        = -1;
 113   void* dst_buff_       = nullptr;
 114   size_t dst_buff_size_ = 0;
 115   void* src_buff_       = nullptr;
 116   size_t src_buff_size_ = sizeof(void*);
 117
 118   /* FIXME: expose these elements in the API */
 119   int detached_ = 0;
 120   int (*match_fun_)(void*, void*, simgrid::kernel::activity::CommImpl*) = nullptr;
 121   void (*clean_fun_)(void*)                                             = nullptr;
 122   void (*copy_data_function_)(smx_activity_t, void*, size_t)            = nullptr;
 123
 124   smx_actor_t sender_   = nullptr;
 125   smx_actor_t receiver_ = nullptr;
 126   MailboxPtr mailbox_   = nullptr;
 127
 128   std::atomic_int_fast32_t refcount_{0};
 129 };
 130 } // namespace s4u
 131 } // namespace simgrid
 132
 133 #endif /* SIMGRID_S4U_COMM_HPP */