X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/7ec4bfe63855f02819ad397d3b29babf4421ea00..09392faf42646e631a4e42553e901410eb3e488e:/include/simgrid/s4u/Comm.hpp diff --git a/include/simgrid/s4u/Comm.hpp b/include/simgrid/s4u/Comm.hpp index bee49b304a..57f6443c29 100644 --- a/include/simgrid/s4u/Comm.hpp +++ b/include/simgrid/s4u/Comm.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2021. 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,108 +12,101 @@ #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; /* specified for normal mailbox-based communications*/ + kernel::actor::ActorImpl* sender_ = nullptr; kernel::actor::ActorImpl* receiver_ = nullptr; - Host* from_ = nullptr; /* specified only for direct host-to-host communications */ - Host* to_ = nullptr; double rate_ = -1; void* dst_buff_ = nullptr; size_t dst_buff_size_ = 0; void* src_buff_ = nullptr; size_t src_buff_size_ = sizeof(void*); + /* FIXME: expose these elements in the API */ bool detached_ = false; - bool (*match_fun_)(void*, void*, kernel::activity::CommImpl*) = nullptr; - void (*clean_fun_)(void*) = nullptr; - void (*copy_data_function_)(kernel::activity::CommImpl*, void*, size_t) = nullptr; + std::function match_fun_; + std::function clean_fun_; + std::function copy_data_function_; Comm() = default; + Comm* do_start() override; + + static xbt::signal on_send; + xbt::signal on_this_send; + static xbt::signal on_recv; + 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: -#ifndef DOXYGEN - friend Mailbox; // Factory of comms -#endif + /*! \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); } + /*! 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); + 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; - /*! Creates a communication that bypasses the mailbox mechanism. */ - static CommPtr sendto_init(); - /*! Creates a communication beween the two given hosts, bypassing the mailbox mechanism. */ - static CommPtr sendto_init(Host* from, Host* to); - /** 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 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& match_fun, + const std::function& 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& match_fun, + const std::function& 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); - /** 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_send; - static xbt::signal on_recv; - 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 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); - - /*! 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); - /*! 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_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_for(double timeout) override; - bool test() 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. */ - Comm* detach(void (*clean_function)(void*)) - { - clean_fun_ = clean_function; - return detach(); - } - - /** Set the source and destination of communications that bypass the mailbox mechanism */ CommPtr set_source(Host* from); - Host* get_source() const { return from_; } + Host* get_source() const; CommPtr set_destination(Host* to); - Host* get_destination() const { return to_; } + Host* get_destination() const; - /** Sets the maximal communication rate (in byte/sec). Must be done before start */ - CommPtr set_rate(double rate); + /* 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. * @@ -135,16 +128,6 @@ public: * @endrst */ CommPtr set_src_data_size(size_t size); - - /** 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 related from the actual data size (given by - * :cpp:func:`simgrid::s4u::Comm::set_src_data_size`). - * @endrst - */ - CommPtr set_payload_size(uint64_t bytes); - /** Specify the data to send and its size (not to be mixed with set_payload_size()) * * @beginrst @@ -165,22 +148,55 @@ public: * 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(); + 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; - /** Retrieve the mailbox on which this comm acts */ - Mailbox* get_mailbox() const; - /** Retrieve the size of the received data. Not to be mixed with @ref Activity::set_remaining() */ - size_t get_dst_data_size() 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); + bool is_assigned() const override; Actor* get_sender() const; + Actor* get_receiver() const; - bool is_assigned() const override { return (to_ != nullptr && from_ != nullptr) || (mailbox_ != nullptr); } + /* Comm life cycle */ + /** 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. */ + Comm* detach(const std::function& clean_function) + { + clean_fun_ = clean_function; + return detach(); + } + + Comm* wait_for(double timeout) override; - CommPtr set_copy_data_callback(void (*callback)(kernel::activity::CommImpl*, void*, size_t)); - static void copy_buffer_callback(kernel::activity::CommImpl*, void*, size_t); - static void copy_pointer_callback(kernel::activity::CommImpl*, void*, size_t); +#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); } + + static ssize_t deprecated_wait_any_for(const std::vector& comms, + double timeout); // XBT_ATTRIB_DEPRECATED_v339 + + 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 */