X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/6fb292d7e99020dc305b845e0a2284a9d811a4b2..5b547799240cfe5d60c1c4161e3fc8849095e2ca:/include/simgrid/s4u/Comm.hpp diff --git a/include/simgrid/s4u/Comm.hpp b/include/simgrid/s4u/Comm.hpp index 49b9071ad6..0fee089808 100644 --- a/include/simgrid/s4u/Comm.hpp +++ b/include/simgrid/s4u/Comm.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2020. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2021. 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. */ @@ -20,14 +20,15 @@ namespace s4u { */ class XBT_PUBLIC Comm : public Activity_T { Mailbox* mailbox_ = nullptr; - kernel::actor::ActorImpl* sender_ = nullptr; + kernel::actor::ActorImpl* sender_ = nullptr; /* specified for normal mailbox-based communications*/ 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*); - std::string tracing_category_ = ""; /* FIXME: expose these elements in the API */ bool detached_ = false; bool (*match_fun_)(void*, void*, kernel::activity::CommImpl*) = nullptr; @@ -36,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 @@ -43,25 +47,51 @@ public: ~Comm() override; - static xbt::signal on_sender_start; - static xbt::signal on_receiver_start; - static xbt::signal on_completion; + /*! 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 CommPtr sendto_async(Host* from, Host* to, double 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, double 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); } - /*! Same as wait_any, but with a timeout. If the timeout occurs, parameter last is returned.*/ - static int wait_any_for(const std::vector* comms_in, double timeout); + 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); + 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); + + 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)); } 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. */ @@ -78,26 +108,42 @@ public: /** 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 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(double bytes); + + /** 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); @@ -109,8 +155,8 @@ public: * * That's a buffer where the sent data will be copied */ CommPtr set_dst_data(void** buff, size_t size); - - CommPtr set_tracing_category(const std::string& category); + /** Retrieve where the data will be copied on the receiver side */ + void* get_dst_data(); /** Retrieve the mailbox on which this comm acts */ Mailbox* get_mailbox() const; @@ -118,6 +164,8 @@ public: size_t get_dst_data_size() const; Actor* get_sender() const; + + bool is_assigned() const override { return (to_ != nullptr && from_ != nullptr) || (mailbox_ != nullptr); } }; } // namespace s4u } // namespace simgrid