1 /* Copyright (c) 2006-2022. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_S4U_COMM_HPP
7 #define SIMGRID_S4U_COMM_HPP
9 #include <simgrid/forward.h>
10 #include <simgrid/s4u/Activity.hpp>
17 /** @brief Communication async
19 * Represents all asynchronous communications, that you can test or wait onto.
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 */
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;
42 friend Mailbox; // Factory of comms
47 /*! Creates a communication that bypasses the mailbox mechanism. */
48 static CommPtr sendto_init();
49 /*! Creates a communication beween the two given hosts, bypassing the mailbox mechanism. */
50 static CommPtr sendto_init(Host* from, Host* to);
51 /** Do an asynchronous communication between two arbitrary hosts.
53 * This initializes a communication that completely bypass the mailbox and actors mechanism.
54 * There is really no limit on the hosts involved. In particular, the actor does not have to be on one of the involved
57 static CommPtr sendto_async(Host* from, Host* to, uint64_t simulated_size_in_bytes);
58 /** Do a blocking communication between two arbitrary hosts.
60 * This starts a blocking communication right away, bypassing the mailbox and actors mechanism.
61 * The calling actor is blocked until the end of the communication; there is really no limit on the hosts involved.
62 * In particular, the actor does not have to be on one of the involved hosts. Enjoy the comfort of the simulator :)
64 static void sendto(Host* from, Host* to, uint64_t simulated_size_in_bytes);
66 static void on_send_cb(const std::function<void(Comm const&)>& cb) { on_send.connect(cb); }
67 static void on_recv_cb(const std::function<void(Comm const&)>& cb) { on_recv.connect(cb); }
68 static void on_start_cb(const std::function<void(Comm const&)>& cb) { on_start.connect(cb); }
69 static void on_completion_cb(const std::function<void(Activity const&)>& cb) { on_completion.connect(cb); }
71 /* FIXME signals should be private */
72 static xbt::signal<void(Comm const&)> on_send;
73 static xbt::signal<void(Comm const&)> on_recv;
74 static xbt::signal<void(Comm const&)> on_start;
75 static xbt::signal<void(Comm const&)> on_completion;
78 /*! take a vector s4u::CommPtr and return when one of them is finished.
79 * The return value is the rank of the first finished CommPtr. */
80 static ssize_t wait_any(const std::vector<CommPtr>& comms) { return wait_any_for(comms, -1); }
81 /*! Same as wait_any, but with a timeout. Return -1 if the timeout occurs.*/
82 static ssize_t wait_any_for(const std::vector<CommPtr>& comms, double timeout);
84 /*! take a vector s4u::CommPtr and return when all of them is finished. */
85 static void wait_all(const std::vector<CommPtr>& comms);
86 /*! Same as wait_all, but with a timeout. Return the number of terminated comm (less than comms.size() if the timeout
88 static size_t wait_all_for(const std::vector<CommPtr>& comms, double timeout);
89 /*! take a vector s4u::CommPtr and return the rank of the first finished one (or -1 if none is done). */
90 static ssize_t test_any(const std::vector<CommPtr>& comms);
93 XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for parameter")
94 static int wait_any(const std::vector<CommPtr>* comms) { return static_cast<int>(wait_any_for(*comms, -1)); }
95 XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for first parameter")
96 static int wait_any_for(const std::vector<CommPtr>* comms, double timeout) { return static_cast<int>(wait_any_for(*comms, timeout)); }
97 XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for parameter")
98 static void wait_all(const std::vector<CommPtr>* comms) { wait_all(*comms); }
99 XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for parameter")
100 static int test_any(const std::vector<CommPtr>* comms) { return static_cast<int>(test_any(*comms)); }
103 Comm* start() override;
104 Comm* wait_for(double timeout) override;
105 bool test() override;
107 /** Start the comm, and ignore its result. It can be completely forgotten after that. */
109 /** Start the comm, and ignore its result. It can be completely forgotten after that. */
110 Comm* detach(void (*clean_function)(void*))
112 clean_fun_ = clean_function;
116 /** Set the source and destination of communications that bypass the mailbox mechanism */
117 CommPtr set_source(Host* from);
118 Host* get_source() const { return from_; }
119 CommPtr set_destination(Host* to);
120 Host* get_destination() const { return to_; }
122 /** Sets the maximal communication rate (in byte/sec). Must be done before start */
123 CommPtr set_rate(double rate);
125 /** Specify the data to send.
128 * This is way will get actually copied over to the receiver.
129 * That's completely unrelated from the simulated size (given by :cpp:func:`simgrid::s4u::Comm::set_payload_size`):
130 * you can send a short buffer in your simulator, that represents a very large message
131 * in the simulated world, or the opposite.
134 CommPtr set_src_data(void* buff);
135 /** Specify the size of the data to send (not to be mixed with set_payload_size())
138 * That's the size of the data to actually copy in the simulator (ie, the data passed with
139 * :cpp:func:`simgrid::s4u::Comm::set_src_data`). That's completely unrelated from the simulated size (given by
140 * :cpp:func:`simgrid::s4u::Comm::set_payload_size`)): you can send a short buffer in your simulator, that represents
141 * a very large message in the simulated world, or the opposite.
144 CommPtr set_src_data_size(size_t size);
146 /** Specify the amount of bytes which exchange should be simulated (not to be mixed with set_src_data_size())
149 * That's the size of the simulated data, that's completely related from the actual data size (given by
150 * :cpp:func:`simgrid::s4u::Comm::set_src_data_size`).
153 CommPtr set_payload_size(uint64_t bytes);
155 /** Specify the data to send and its size (not to be mixed with set_payload_size())
158 * This is way will get actually copied over to the receiver.
159 * That's completely unrelated from the simulated size (given by :cpp:func:`simgrid::s4u::Comm::set_payload_size`):
160 * you can send a short buffer in your simulator, that represents a very large message
161 * in the simulated world, or the opposite.
164 CommPtr set_src_data(void* buff, size_t size);
166 /** Specify where to receive the data.
168 * That's a buffer where the sent data will be copied */
169 CommPtr set_dst_data(void** buff);
170 /** Specify the buffer in which the data should be received
172 * That's a buffer where the sent data will be copied */
173 CommPtr set_dst_data(void** buff, size_t size);
174 /** Retrieve where the data will be copied on the receiver side */
175 void* get_dst_data();
177 /** Retrieve the mailbox on which this comm acts */
178 Mailbox* get_mailbox() const;
179 /** Retrieve the size of the received data. Not to be mixed with @ref Activity::set_remaining() */
180 size_t get_dst_data_size() const;
182 Actor* get_sender() const;
184 bool is_assigned() const override { return (to_ != nullptr && from_ != nullptr) || (mailbox_ != nullptr); }
186 CommPtr set_copy_data_callback(void (*callback)(kernel::activity::CommImpl*, void*, size_t));
187 static void copy_buffer_callback(kernel::activity::CommImpl*, void*, size_t);
188 static void copy_pointer_callback(kernel::activity::CommImpl*, void*, size_t);
191 } // namespace simgrid
193 #endif /* SIMGRID_S4U_COMM_HPP */