- /** Creates (but don't start) an async send to the mailbox @p dest */
- XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put_init(): v3.20 will turn this warning into an error.") static CommPtr
- send_init(MailboxPtr dest)
- {
- return dest->put_init();
- }
- /** Creates (but don't start) an async send to the mailbox @p dest */
- XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put_init(): v3.20 will turn this warning into an error.") static CommPtr
- send_init(MailboxPtr dest, void* data, int simulatedByteAmount)
- {
- return dest->put_init(data, simulatedByteAmount);
- }
- /** Creates and start an async send to the mailbox @p dest */
- XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put_async(): v3.20 will turn this warning into an error.") static CommPtr
- send_async(MailboxPtr dest, void* data, int simulatedByteAmount)
- {
- return dest->put_async(data, simulatedByteAmount);
- }
- /** Creates (but don't start) an async recv onto the mailbox @p from */
- XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::get_init(): v3.20 will turn this warning into an error.") static CommPtr
- recv_init(MailboxPtr from)
- {
- return from->get_init();
- }
- /** Creates and start an async recv to the mailbox @p from */
- XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::get_async(): v3.20 will turn this warning into an error.") static CommPtr
- recv_async(MailboxPtr from, void** data)
- {
- return from->get_async(data);
- }
+public:
+ /*! \static Add a callback fired when the send of any Comm is posted */
+ static void on_send_cb(const std::function<void(Comm const&)>& cb) { on_send.connect(cb); }
+ /*! Add a callback fired when the send of this specific Comm is posted */
+ void on_this_send_cb(const std::function<void(Comm const&)>& cb) { on_this_send.connect(cb); }
+ /*! \static Add a callback fired when the recv of any Comm is posted */
+ static void on_recv_cb(const std::function<void(Comm const&)>& cb) { on_recv.connect(cb); }
+ /*! Add a callback fired when the recv of this specific Comm is posted */
+ void on_this_recv_cb(const std::function<void(Comm const&)>& cb) { on_this_recv.connect(cb); }
+
+ CommPtr set_copy_data_callback(const std::function<void(kernel::activity::CommImpl*, void*, size_t)>& callback);
+ XBT_ATTRIB_DEPRECATED_v338("Please manifest if you actually need this function") static void copy_buffer_callback(
+ kernel::activity::CommImpl*, void*, size_t);
+ XBT_ATTRIB_DEPRECATED_v338("Please manifest if you actually need this function") static void copy_pointer_callback(
+ kernel::activity::CommImpl*, void*, size_t);
+
+ ~Comm() override;
+
+ static void send(kernel::actor::ActorImpl* sender, const Mailbox* mbox, double task_size, double rate, void* src_buff,
+ size_t src_buff_size,
+ const std::function<bool(void*, void*, simgrid::kernel::activity::CommImpl*)>& match_fun,
+ const std::function<void(simgrid::kernel::activity::CommImpl*, void*, size_t)>& copy_data_fun,
+ void* data, double timeout);
+ static void recv(kernel::actor::ActorImpl* receiver, const Mailbox* mbox, void* dst_buff, size_t* dst_buff_size,
+ const std::function<bool(void*, void*, simgrid::kernel::activity::CommImpl*)>& match_fun,
+ const std::function<void(simgrid::kernel::activity::CommImpl*, void*, size_t)>& copy_data_fun,
+ void* data, double timeout, double rate);
+
+ /* \static
+ * "One-sided" communications. This way of communicating bypasses the mailbox and actors mechanism. It creates a
+ * communication (vetoabled, asynchronous, or synchronous) directly between two hosts. There is really no limit on
+ * the hosts involved. In particular, the actor creating such a communication does not have to be on one of the
+ * involved hosts! Enjoy the comfort of the simulator :)
+ */
+ static CommPtr sendto_init(); /* Source and Destination hosts have to be set before the communication can start */
+ static CommPtr sendto_init(Host* from, Host* to);
+ static CommPtr sendto_async(Host* from, Host* to, uint64_t simulated_size_in_bytes);
+ static void sendto(Host* from, Host* to, uint64_t simulated_size_in_bytes);
+
+ CommPtr set_source(Host* from);
+ Host* get_source() const;
+ CommPtr set_destination(Host* to);
+ Host* get_destination() const;
+
+ /* Mailbox-based communications */
+ CommPtr set_mailbox(Mailbox* mailbox);
+ /** Retrieve the mailbox on which this comm acts */
+ Mailbox* get_mailbox() const { return mailbox_; }
+
+ /** Specify the data to send.
+ *
+ * @beginrst
+ * This is way will get actually copied over to the receiver.
+ * That's completely unrelated from the simulated size (given by :cpp:func:`simgrid::s4u::Comm::set_payload_size`):
+ * you can send a short buffer in your simulator, that represents a very large message
+ * in the simulated world, or the opposite.
+ * @endrst
+ */
+ CommPtr set_src_data(void* buff);
+ /** Specify the size of the data to send (not to be mixed with set_payload_size())
+ *
+ * @beginrst
+ * That's the size of the data to actually copy in the simulator (ie, the data passed with
+ * :cpp:func:`simgrid::s4u::Comm::set_src_data`). That's completely unrelated from the simulated size (given by
+ * :cpp:func:`simgrid::s4u::Comm::set_payload_size`)): you can send a short buffer in your simulator, that represents
+ * a very large message in the simulated world, or the opposite.
+ * @endrst
+ */
+ CommPtr set_src_data_size(size_t size);
+ /** Specify the data to send and its size (not to be mixed with set_payload_size())
+ *
+ * @beginrst
+ * This is way will get actually copied over to the receiver.
+ * That's completely unrelated from the simulated size (given by :cpp:func:`simgrid::s4u::Comm::set_payload_size`):
+ * you can send a short buffer in your simulator, that represents a very large message
+ * in the simulated world, or the opposite.
+ * @endrst
+ */
+ CommPtr set_src_data(void* buff, size_t size);
+
+ /** Specify where to receive the data.
+ *
+ * That's a buffer where the sent data will be copied */
+ CommPtr set_dst_data(void** buff);
+ /** Specify the buffer in which the data should be received
+ *
+ * That's a buffer where the sent data will be copied */
+ CommPtr set_dst_data(void** buff, size_t size);
+ /** Retrieve where the data will be copied on the receiver side */
+ void* get_dst_data() const { return dst_buff_; }
+ /** Retrieve the size of the received data. Not to be mixed with @ref Activity::get_remaining() */
+ size_t get_dst_data_size() const { return dst_buff_size_; }
+ /** Retrieve the payload associated to the communication. You can only do that once the comm is (gracefully)
+ * terminated, and it is only setup by the default copy_data callback (not the SMPI one) */
+ void* get_payload() const;
+
+ /* Common functions */
+
+ /** Specify the amount of bytes which exchange should be simulated (not to be mixed with set_src_data_size())
+ *
+ * @beginrst
+ * That's the size of the simulated data, that's completely unrelated from the actual data size (given by
+ * :cpp:func:`simgrid::s4u::Comm::set_src_data_size`).
+ * @endrst
+ */
+ CommPtr set_payload_size(uint64_t bytes);
+ /** Sets the maximal communication rate (in byte/sec). Must be done before start */
+ CommPtr set_rate(double rate);