X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/a882344bc908a258a991701e226556ec23fd7cd6..09392faf42646e631a4e42553e901410eb3e488e:/include/simgrid/s4u/Comm.hpp diff --git a/include/simgrid/s4u/Comm.hpp b/include/simgrid/s4u/Comm.hpp index 84b0cbbb3f..57f6443c29 100644 --- a/include/simgrid/s4u/Comm.hpp +++ b/include/simgrid/s4u/Comm.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2022. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2023. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ @@ -12,14 +12,14 @@ #include #include -namespace simgrid { -namespace s4u { +namespace simgrid::s4u { /** @brief Communication async * * Represents all asynchronous communications, that you can test or wait onto. */ class XBT_PUBLIC Comm : public Activity_T { friend Mailbox; // Factory of comms + friend kernel::activity::CommImpl; /* specified for normal mailbox-based communications*/ Mailbox* mailbox_ = nullptr; kernel::actor::ActorImpl* sender_ = nullptr; @@ -37,23 +37,43 @@ class XBT_PUBLIC Comm : public Activity_T { std::function copy_data_function_; Comm() = default; + Comm* do_start() override; -public: - /* signals and related callbacks */ -#ifndef DOXYGEN - /* FIXME signals should be private */ static xbt::signal on_send; + xbt::signal on_this_send; static xbt::signal on_recv; - static xbt::signal on_start; -#endif + xbt::signal on_this_recv; + +protected: + void fire_on_completion() const override { + /* The completion signal of a Comm has to be thrown only once and not by the sender AND the receiver. + then Comm::on_completion is thrown in the kernel in CommImpl::finish. + */ + } + void fire_on_this_completion() const override { + /* The completion signal of a Comm has to be thrown only once and not by the sender AND the receiver. + then Comm::on_this_completion is thrown in the kernel in CommImpl::finish. + */ + } + /* These ensure that the on_completion signals are really thrown */ + void fire_on_completion_for_real() const { Activity_T::fire_on_completion(); } + void fire_on_this_completion_for_real() const { Activity_T::fire_on_this_completion(); } +public: + /*! \static Add a callback fired when the send of any Comm is posted */ static void on_send_cb(const std::function& 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& 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& cb) { on_recv.connect(cb); } - static void on_start_cb(const std::function& cb) { on_start.connect(cb); } - /* More callbacks */ + /*! Add a callback fired when the recv of this specific Comm is posted */ + void on_this_recv_cb(const std::function& cb) { on_this_recv.connect(cb); } + CommPtr set_copy_data_callback(const std::function& callback); - static void copy_buffer_callback(kernel::activity::CommImpl*, void*, size_t); - static void copy_pointer_callback(kernel::activity::CommImpl*, void*, size_t); + 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; @@ -67,7 +87,8 @@ public: const std::function& copy_data_fun, void* data, double timeout, double rate); - /* "One-sided" communications. This way of communicating bypasses the mailbox and actors mechanism. It creates a + /* \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 :) @@ -128,8 +149,11 @@ public: 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::set_remaining() */ + /** 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 */ @@ -146,9 +170,9 @@ public: bool is_assigned() const override; Actor* get_sender() const; + Actor* get_receiver() const; /* Comm life cycle */ - Comm* start() override; /** Start the comm, and ignore its result. It can be completely forgotten after that. */ Comm* detach(); /** Start the comm, and ignore its result. It can be completely forgotten after that. */ @@ -160,22 +184,19 @@ public: Comm* wait_for(double timeout) override; - /*! take a vector s4u::CommPtr and return the rank of the first finished one (or -1 if none is done). */ - static ssize_t test_any(const std::vector& comms); +#ifndef DOXYGEN + XBT_ATTRIB_DEPRECATED_v339("Please use ActivitySet instead") static ssize_t wait_any(const std::vector& comms) { return deprecated_wait_any_for(comms, -1); } + XBT_ATTRIB_DEPRECATED_v339("Please use ActivitySet instead") static ssize_t wait_any_for(const std::vector& comms, double timeout) { return deprecated_wait_any_for(comms, timeout); } - /*! take a vector s4u::CommPtr and return when one of them is finished. - * The return value is the rank of the first finished CommPtr. */ - static ssize_t wait_any(const std::vector& comms) { return wait_any_for(comms, -1); } - /*! Same as wait_any, but with a timeout. Return -1 if the timeout occurs.*/ - static ssize_t wait_any_for(const std::vector& comms, double timeout); + static ssize_t deprecated_wait_any_for(const std::vector& comms, + double timeout); // XBT_ATTRIB_DEPRECATED_v339 - /*! take a vector s4u::CommPtr and return when all of them is finished. */ - static void wait_all(const std::vector& comms); - /*! Same as wait_all, but with a timeout. Return the number of terminated comm (less than comms.size() if the timeout - * occurs). */ - static size_t wait_all_for(const std::vector& comms, double timeout); + XBT_ATTRIB_DEPRECATED_v339("Please use ActivitySet instead") static ssize_t test_any(const std::vector& comms); + XBT_ATTRIB_DEPRECATED_v339("Please use ActivitySet instead") static void wait_all(const std::vector& comms); + XBT_ATTRIB_DEPRECATED_v339("Please use ActivitySet instead") static size_t + wait_all_for(const std::vector& comms, double timeout); +#endif }; -} // namespace s4u -} // namespace simgrid +} // namespace simgrid::s4u #endif /* SIMGRID_S4U_COMM_HPP */