X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/1a64ca4c11a1eb7ba2ecd102f877ac571486a034..7d195832dafde68afd749dd614e9a14d697bdb92:/include/simgrid/s4u/Comm.hpp diff --git a/include/simgrid/s4u/Comm.hpp b/include/simgrid/s4u/Comm.hpp index 45094324e8..e45f2ae3e7 100644 --- a/include/simgrid/s4u/Comm.hpp +++ b/include/simgrid/s4u/Comm.hpp @@ -37,6 +37,9 @@ class XBT_PUBLIC Comm : public Activity_T { Comm() = default; +protected: + void complete(Activity::State state) override; + public: #ifndef DOXYGEN friend Mailbox; // Factory of comms @@ -46,28 +49,51 @@ public: /*! Creates a communication beween the two given hosts, bypassing the mailbox mechanism. */ static CommPtr sendto_init(Host* from, Host* to); - /*! Creates and start a communication of the given amount of bytes beween the two given hosts, bypassing the mailbox - * mechanism */ - static CommPtr sendto_async(Host* from, Host* to, double simulated_size_in_bytes); + /** Do an asynchronous communication between two arbitrary hosts. + * + * This initializes a communication that completely bypass the mailbox and actors mechanism. + * There is really no limit on the hosts involved. In particular, the actor does not have to be on one of the involved + * hosts. + */ + static CommPtr sendto_async(Host* from, Host* to, uint64_t simulated_size_in_bytes); + /** Do a blocking communication between two arbitrary hosts. + * + * This starts a blocking communication right away, bypassing the mailbox and actors mechanism. + * The calling actor is blocked until the end of the communication; there is really no limit on the hosts involved. + * In particular, the actor does not have to be on one of the involved hosts. Enjoy the comfort of the simulator :) + */ + static void sendto(Host* from, Host* to, uint64_t simulated_size_in_bytes); static xbt::signal on_start; static xbt::signal on_completion; /*! 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 int wait_any(const std::vector* comms) { return wait_any_for(comms, -1); } + 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 int wait_any_for(const std::vector* comms_in, double timeout); + static ssize_t wait_any_for(const std::vector& comms, double timeout); /*! take a vector s4u::CommPtr and return when all of them is finished. */ - static void wait_all(const std::vector* comms); + 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); /*! take a vector s4u::CommPtr and return the rank of the first finished one (or -1 if none is done). */ - static int test_any(const std::vector* comms); + static ssize_t test_any(const std::vector& comms); + +#ifndef DOXYGEN + XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for parameter") + static int wait_any(const std::vector* comms) { return static_cast(wait_any_for(*comms, -1)); } + XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for first parameter") + static int wait_any_for(const std::vector* comms, double timeout) { return static_cast(wait_any_for(*comms, timeout)); } + XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for parameter") + static void wait_all(const std::vector* comms) { wait_all(*comms); } + XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for parameter") + static int test_any(const std::vector* comms) { return static_cast(test_any(*comms)); } +#endif Comm* start() override; - Comm* wait() override; Comm* wait_for(double timeout) override; - Comm* cancel() override; bool test() override; /** Start the comm, and ignore its result. It can be completely forgotten after that. */ @@ -110,7 +136,7 @@ public: * :cpp:func:`simgrid::s4u::Comm::set_src_data_size`). * @endrst */ - CommPtr set_payload_size(double bytes); + CommPtr set_payload_size(uint64_t bytes); /** Specify the data to send and its size (not to be mixed with set_payload_size()) * @@ -142,6 +168,8 @@ public: Actor* get_sender() const; bool is_assigned() const override { return (to_ != nullptr && from_ != nullptr) || (mailbox_ != nullptr); } + + CommPtr set_copy_data_callback(void (*callback)(kernel::activity::CommImpl*, void*, size_t)); }; } // namespace s4u } // namespace simgrid