1 /* Copyright (c) 2006-2023. 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 friend Mailbox; // Factory of comms
23 /* specified for normal mailbox-based communications*/
24 Mailbox* mailbox_ = nullptr;
25 kernel::actor::ActorImpl* sender_ = nullptr;
26 kernel::actor::ActorImpl* receiver_ = nullptr;
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*);
33 /* FIXME: expose these elements in the API */
34 bool detached_ = false;
35 std::function<bool(void*, void*, kernel::activity::CommImpl*)> match_fun_;
36 std::function<void(void*)> clean_fun_;
37 std::function<void(kernel::activity::CommImpl*, void*, size_t)> copy_data_function_;
40 Comm* do_start() override;
43 /* signals and related callbacks */
45 /* FIXME signals should be private */
46 static xbt::signal<void(Comm const&)> on_send;
47 static xbt::signal<void(Comm const&)> on_recv;
48 static xbt::signal<void(Comm const&)> on_start;
51 static void on_send_cb(const std::function<void(Comm const&)>& cb) { on_send.connect(cb); }
52 static void on_recv_cb(const std::function<void(Comm const&)>& cb) { on_recv.connect(cb); }
53 static void on_start_cb(const std::function<void(Comm const&)>& cb) { on_start.connect(cb); }
55 CommPtr set_copy_data_callback(const std::function<void(kernel::activity::CommImpl*, void*, size_t)>& callback);
56 XBT_ATTRIB_DEPRECATED_v337("Please manifest if you actually need this function") static void copy_buffer_callback(
57 kernel::activity::CommImpl*, void*, size_t);
58 XBT_ATTRIB_DEPRECATED_v337("Please manifest if you actually need this function") static void copy_pointer_callback(
59 kernel::activity::CommImpl*, void*, size_t);
63 static void send(kernel::actor::ActorImpl* sender, const Mailbox* mbox, double task_size, double rate, void* src_buff,
65 const std::function<bool(void*, void*, simgrid::kernel::activity::CommImpl*)>& match_fun,
66 const std::function<void(simgrid::kernel::activity::CommImpl*, void*, size_t)>& copy_data_fun,
67 void* data, double timeout);
68 static void recv(kernel::actor::ActorImpl* receiver, const Mailbox* mbox, void* dst_buff, size_t* dst_buff_size,
69 const std::function<bool(void*, void*, simgrid::kernel::activity::CommImpl*)>& match_fun,
70 const std::function<void(simgrid::kernel::activity::CommImpl*, void*, size_t)>& copy_data_fun,
71 void* data, double timeout, double rate);
73 /* "One-sided" communications. This way of communicating bypasses the mailbox and actors mechanism. It creates a
74 * communication (vetoabled, asynchronous, or synchronous) directly between two hosts. There is really no limit on
75 * the hosts involved. In particular, the actor creating such a communication does not have to be on one of the
76 * involved hosts! Enjoy the comfort of the simulator :)
78 static CommPtr sendto_init(); /* Source and Destination hosts have to be set before the communication can start */
79 static CommPtr sendto_init(Host* from, Host* to);
80 static CommPtr sendto_async(Host* from, Host* to, uint64_t simulated_size_in_bytes);
81 static void sendto(Host* from, Host* to, uint64_t simulated_size_in_bytes);
83 CommPtr set_source(Host* from);
84 Host* get_source() const;
85 CommPtr set_destination(Host* to);
86 Host* get_destination() const;
88 /* Mailbox-based communications */
89 CommPtr set_mailbox(Mailbox* mailbox);
90 /** Retrieve the mailbox on which this comm acts */
91 Mailbox* get_mailbox() const { return mailbox_; }
93 /** Specify the data to send.
96 * This is way will get actually copied over to the receiver.
97 * That's completely unrelated from the simulated size (given by :cpp:func:`simgrid::s4u::Comm::set_payload_size`):
98 * you can send a short buffer in your simulator, that represents a very large message
99 * in the simulated world, or the opposite.
102 CommPtr set_src_data(void* buff);
103 /** Specify the size of the data to send (not to be mixed with set_payload_size())
106 * That's the size of the data to actually copy in the simulator (ie, the data passed with
107 * :cpp:func:`simgrid::s4u::Comm::set_src_data`). That's completely unrelated from the simulated size (given by
108 * :cpp:func:`simgrid::s4u::Comm::set_payload_size`)): you can send a short buffer in your simulator, that represents
109 * a very large message in the simulated world, or the opposite.
112 CommPtr set_src_data_size(size_t size);
113 /** Specify the data to send and its size (not to be mixed with set_payload_size())
116 * This is way will get actually copied over to the receiver.
117 * That's completely unrelated from the simulated size (given by :cpp:func:`simgrid::s4u::Comm::set_payload_size`):
118 * you can send a short buffer in your simulator, that represents a very large message
119 * in the simulated world, or the opposite.
122 CommPtr set_src_data(void* buff, size_t size);
124 /** Specify where to receive the data.
126 * That's a buffer where the sent data will be copied */
127 CommPtr set_dst_data(void** buff);
128 /** Specify the buffer in which the data should be received
130 * That's a buffer where the sent data will be copied */
131 CommPtr set_dst_data(void** buff, size_t size);
132 /** Retrieve where the data will be copied on the receiver side */
133 void* get_dst_data() const { return dst_buff_; }
134 /** Retrieve the size of the received data. Not to be mixed with @ref Activity::get_remaining() */
135 size_t get_dst_data_size() const { return dst_buff_size_; }
137 /* Common functions */
139 /** Specify the amount of bytes which exchange should be simulated (not to be mixed with set_src_data_size())
142 * That's the size of the simulated data, that's completely unrelated from the actual data size (given by
143 * :cpp:func:`simgrid::s4u::Comm::set_src_data_size`).
146 CommPtr set_payload_size(uint64_t bytes);
147 /** Sets the maximal communication rate (in byte/sec). Must be done before start */
148 CommPtr set_rate(double rate);
150 bool is_assigned() const override;
151 Actor* get_sender() const;
153 /* Comm life cycle */
154 /** Start the comm, and ignore its result. It can be completely forgotten after that. */
156 /** Start the comm, and ignore its result. It can be completely forgotten after that. */
157 Comm* detach(const std::function<void(void*)>& clean_function)
159 clean_fun_ = clean_function;
163 Comm* wait_for(double timeout) override;
165 /*! take a vector s4u::CommPtr and return the rank of the first finished one (or -1 if none is done). */
166 static ssize_t test_any(const std::vector<CommPtr>& comms);
168 /*! take a vector s4u::CommPtr and return when one of them is finished.
169 * The return value is the rank of the first finished CommPtr. */
170 static ssize_t wait_any(const std::vector<CommPtr>& comms) { return wait_any_for(comms, -1); }
171 /*! Same as wait_any, but with a timeout. Return -1 if the timeout occurs.*/
172 static ssize_t wait_any_for(const std::vector<CommPtr>& comms, double timeout);
174 /*! take a vector s4u::CommPtr and return when all of them is finished. */
175 static void wait_all(const std::vector<CommPtr>& comms);
176 /*! Same as wait_all, but with a timeout. Return the number of terminated comm (less than comms.size() if the timeout
178 static size_t wait_all_for(const std::vector<CommPtr>& comms, double timeout);
181 } // namespace simgrid
183 #endif /* SIMGRID_S4U_COMM_HPP */