X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/078a96e4b84369c23073bb68e15273030e9a357b..5ed37babb2fa9097abe82df299c0aa259ed84d5a:/include/simgrid/s4u/Comm.hpp diff --git a/include/simgrid/s4u/Comm.hpp b/include/simgrid/s4u/Comm.hpp index d59fc2a8ea..ba67bc32e8 100644 --- a/include/simgrid/s4u/Comm.hpp +++ b/include/simgrid/s4u/Comm.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2019. 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. */ @@ -9,7 +9,7 @@ #include #include -#include +#include #include namespace simgrid { @@ -18,7 +18,9 @@ namespace s4u { * * Represents all asynchronous communications, that you can test or wait onto. */ -class XBT_PUBLIC Comm : public Activity { +class XBT_PUBLIC Comm : public Activity_T { + friend Mailbox; // Factory of comms + /* specified for normal mailbox-based communications*/ Mailbox* mailbox_ = nullptr; kernel::actor::ActorImpl* sender_ = nullptr; kernel::actor::ActorImpl* receiver_ = nullptr; @@ -27,78 +29,92 @@ class XBT_PUBLIC Comm : public Activity { size_t dst_buff_size_ = 0; void* src_buff_ = nullptr; size_t src_buff_size_ = sizeof(void*); - std::string tracing_category_ = ""; - std::atomic_int_fast32_t refcount_{0}; + /* FIXME: expose these elements in the API */ - int detached_ = 0; - int (*match_fun_)(void*, void*, kernel::activity::CommImpl*) = nullptr; - void (*clean_fun_)(void*) = nullptr; - void (*copy_data_function_)(kernel::activity::CommImpl*, void*, size_t) = nullptr; + bool detached_ = false; + std::function match_fun_; + std::function clean_fun_; + std::function copy_data_function_; - Comm() : Activity() {} + Comm() = default; public: - friend XBT_PUBLIC void intrusive_ptr_release(Comm* c); - friend XBT_PUBLIC void intrusive_ptr_add_ref(Comm* c); - friend Mailbox; // Factory of comms - - virtual ~Comm(); - - static xbt::signal on_sender_start; - static xbt::signal on_receiver_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(std::vector * comms) { return wait_any_for(comms, -1); } - /*! Same as wait_any, but with a timeout. If the timeout occurs, parameter last is returned.*/ - static int wait_any_for(std::vector* comms_in, double timeout); - - /*! take a vector s4u::CommPtr and return when all of them is finished. */ - static void wait_all(std::vector* comms); - /*! take a vector s4u::CommPtr and return the rank of the first finished one (or -1 if none is done). */ - static int test_any(std::vector * comms); - - 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. */ - 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(); - } + /* signals and related callbacks */ +#ifndef DOXYGEN + /* FIXME signals should be private */ + static xbt::signal on_send; + static xbt::signal on_recv; + static xbt::signal on_start; +#endif - /** Sets the maximal communication rate (in byte/sec). Must be done before start */ - CommPtr set_rate(double rate); + static void on_send_cb(const std::function& cb) { on_send.connect(cb); } + 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 */ + 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); + + ~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& 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); + + /* "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 with @ref Activity::set_remaining()): + * 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 @ref Activity::set_remaining() + /** Specify the size of the data to send (not to be mixed with set_payload_size()) * - * That's the size of the data to actually copy in the simulator (ie, the data passed with Activity::set_src_data()). - * That's completely unrelated from the simulated size (given with @ref Activity::set_remaining()): - * you can send a short buffer in your simulator, that represents a very large message - * in the simulated world, or the opposite. + * @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. Don't mix the size with @ref Activity::set_remaining() + /** 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 with @ref Activity::set_remaining()): + * 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); @@ -110,48 +126,54 @@ 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() 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_; } - CommPtr set_tracing_category(const std::string& category); + /* Common functions */ - /** Retrieve the mailbox on which this comm acts */ - Mailbox* get_mailbox(); - /** Retrieve the size of the received data. Not to be mixed with @ref Activity::set_remaining() */ - size_t get_dst_data_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 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); - s4u::ActorPtr get_sender(); + bool is_assigned() const override; + Actor* get_sender() const; -#ifndef DOXYGEN - XBT_ATTRIB_DEPRECATED_v324("Please use Comm::wait_for()") void wait(double t) override { wait_for(t); } - XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_rate()") Activity* setRate(double rate) - { - return set_rate(rate).get(); - } - XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data()") Activity* setSrcData(void* buff) - { - return set_src_data(buff).get(); - } - XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data()") Activity* setSrcData(void* buff, size_t size) - { - return set_src_data(buff, size).get(); - } - XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data_size()") Activity* setSrcDataSize(size_t size) - { - return set_src_data_size(size).get(); - } - XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_dst_data()") Activity* setDstData(void** buff) - { - return set_dst_data(buff).get(); - } - XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_dst_data()") Activity* setDstData(void** buff, size_t size) - { - return set_dst_data(buff, size).get(); - } - XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_dst_data_size()") size_t getDstDataSize() + /* 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. */ + Comm* detach(const std::function& clean_function) { - return get_dst_data_size(); + clean_fun_ = clean_function; + return detach(); } - XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_mailbox()") Mailbox* getMailbox() { return get_mailbox(); } -#endif + + 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); + + /*! 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); }; } // namespace s4u } // namespace simgrid