Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
e0f42aede6ce771bd44e9549830e7b32525148de
[simgrid.git] / 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    * This is way will get actually copied over to the receiver.
88    * That's completely unrelated from the simulated size (given with @ref Comm::set_payload_size()):
89    * you can send a short buffer in your simulator, that represents a very large message
90    * in the simulated world, or the opposite.
91    */
92   CommPtr set_src_data(void* buff);
93   /** Specify the size of the data to send. Not to be mixed with @ref Comm::set_payload_size()
94    *
95    * That's the size of the data to actually copy in the simulator (ie, the data passed with Activity::set_src_data()).
96    * That's completely unrelated from the simulated size (given with @ref Comm::set_payload_size()):
97    * you can send a short buffer in your simulator, that represents a very large message
98    * in the simulated world, or the opposite.
99    */
100   CommPtr set_src_data_size(size_t size);
101
102   /* Specify the amount of bytes which exchange should be simulated. Not to be mixed with @ref Comm::set_src_data_size()
103    *
104    * That's the size of the simulated data, that's completely related from the actual data size (given with @ref
105    * Comm::set_src_data_size()).
106    */
107   Comm* set_payload_size(double bytes);
108
109   /** Specify the data to send and its size. Don't mix the size with @ref Comm::set_payload_size()
110    *
111    * This is way will get actually copied over to the receiver.
112    * That's completely unrelated from the simulated size (given with @ref Comm::set_payload_size()):
113    * you can send a short buffer in your simulator, that represents a very large message
114    * in the simulated world, or the opposite.
115    */
116   CommPtr set_src_data(void* buff, size_t size);
117
118   /** Specify where to receive the data.
119    *
120    * That's a buffer where the sent data will be copied */
121   CommPtr set_dst_data(void** buff);
122   /** Specify the buffer in which the data should be received
123    *
124    * That's a buffer where the sent data will be copied  */
125   CommPtr set_dst_data(void** buff, size_t size);
126   /** Retrieve where the data will be copied on the receiver side */
127   void* get_dst_data();
128
129   /** Retrieve the mailbox on which this comm acts */
130   Mailbox* get_mailbox() const;
131   /** Retrieve the size of the received data. Not to be mixed with @ref Activity::set_remaining()  */
132   size_t get_dst_data_size() const;
133
134   Actor* get_sender() const;
135 };
136 } // namespace s4u
137 } // namespace simgrid
138
139 #endif /* SIMGRID_S4U_COMM_HPP */