X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/2807fde4fd1f59c230d69a934634c5dfb77905f2..5b547799240cfe5d60c1c4161e3fc8849095e2ca:/include/simgrid/s4u/Comm.hpp diff --git a/include/simgrid/s4u/Comm.hpp b/include/simgrid/s4u/Comm.hpp index 6943de3534..0fee089808 100644 --- a/include/simgrid/s4u/Comm.hpp +++ b/include/simgrid/s4u/Comm.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2017. 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. */ @@ -6,13 +6,10 @@ #ifndef SIMGRID_S4U_COMM_HPP #define SIMGRID_S4U_COMM_HPP -#include - #include #include -#include // DEPRECATED 3.20 -#include +#include #include namespace simgrid { @@ -21,137 +18,156 @@ namespace s4u { * * Represents all asynchronous communications, that you can test or wait onto. */ -XBT_PUBLIC_CLASS Comm : public Activity -{ - Comm() : Activity() {} +class XBT_PUBLIC Comm : public Activity_T { + Mailbox* mailbox_ = 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*); + /* 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; + + Comm() = default; + +protected: + void complete(Activity::State state) override; + public: - friend void intrusive_ptr_release(simgrid::s4u::Comm * c); - friend void intrusive_ptr_add_ref(simgrid::s4u::Comm * c); +#ifndef DOXYGEN friend Mailbox; // Factory of comms - - virtual ~Comm(); +#endif + + ~Comm() override; + + /*! 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(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) - { - // Map to dynar: - xbt_dynar_t comms = xbt_dynar_new(sizeof(simgrid::kernel::activity::ActivityImpl*), [](void*ptr){ - intrusive_ptr_release(*(simgrid::kernel::activity::ActivityImpl**)ptr); - }); - for (auto const& comm : *comms_in) { - if (comm->state_ == inited) - comm->start(); - xbt_assert(comm->state_ == started); - simgrid::kernel::activity::ActivityImpl* ptr = comm->pimpl_.get(); - intrusive_ptr_add_ref(ptr); - xbt_dynar_push_as(comms, simgrid::kernel::activity::ActivityImpl*, ptr); - } - // Call the underlying simcall: - int idx = simcall_comm_waitany(comms, timeout); - xbt_dynar_free(&comms); - return idx; - } + 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(std::vector * comms) - { - // TODO: this should be a simcall or something - // TODO: we are missing a version with timeout - for (CommPtr comm : *comms) { - comm->wait(); - } - } - - /** Creates (but don't start) an async send to the mailbox @p dest */ - XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put_init(): v3.20 will turn this warning into an error.") static CommPtr - send_init(MailboxPtr dest) - { - return dest->put_init(); - } - /** Creates (but don't start) an async send to the mailbox @p dest */ - XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put_init(): v3.20 will turn this warning into an error.") static CommPtr - send_init(MailboxPtr dest, void* data, int simulatedByteAmount) - { - return dest->put_init(data, simulatedByteAmount); - } - /** Creates and start an async send to the mailbox @p dest */ - XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put_async(): v3.20 will turn this warning into an error.") static CommPtr - send_async(MailboxPtr dest, void* data, int simulatedByteAmount) - { - return dest->put_async(data, simulatedByteAmount); - } - /** Creates (but don't start) an async recv onto the mailbox @p from */ - XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::get_init(): v3.20 will turn this warning into an error.") static CommPtr - recv_init(MailboxPtr from) - { - return from->get_init(); - } - /** Creates and start an async recv to the mailbox @p from */ - XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::get_async(): v3.20 will turn this warning into an error.") static CommPtr - recv_async(MailboxPtr from, void** data) - { - return from->get_async(data); - } - - void start() override; - void wait() override; - void wait(double timeout) override; + 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); + + 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_for(double timeout) override; + bool test() override; /** Start the comm, and ignore its result. It can be completely forgotten after that. */ - void detach(); + Comm* detach(); /** Start the comm, and ignore its result. It can be completely forgotten after that. */ - void detach(void (*cleanFunction)(void*)) + Comm* detach(void (*clean_function)(void*)) { - cleanFunction_ = cleanFunction; - detach(); + clean_fun_ = clean_function; + return detach(); } /** Sets the maximal communication rate (in byte/sec). Must be done before start */ - void setRate(double rate); - - /** Specify the data to send */ - void setSrcData(void* buff); - /** Specify the size of the data to send */ - void setSrcDataSize(size_t size); - /** Specify the data to send and its size */ - void setSrcData(void* buff, size_t size); - - /** Specify where to receive the data */ - void setDstData(void** buff); - /** Specify the buffer in which the data should be received */ - void setDstData(void** buff, size_t size); - /** Retrieve the size of the received data */ - size_t getDstDataSize(); - - bool test(); - void cancel(); + CommPtr set_rate(double rate); + + /** 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 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 set_payload_size()) + * + * @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 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 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); + + /** Specify where to receive the data. + * + * That's a buffer where the sent data will be copied */ + CommPtr set_dst_data(void** buff); + /** Specify the buffer in which the data should be received + * + * 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(); /** Retrieve the mailbox on which this comm acts */ - MailboxPtr getMailbox(); - -private: - double rate_ = -1; - void* dstBuff_ = nullptr; - size_t dstBuffSize_ = 0; - void* srcBuff_ = nullptr; - size_t srcBuffSize_ = sizeof(void*); - - /* FIXME: expose these elements in the API */ - int detached_ = 0; - int (*matchFunction_)(void*, void*, simgrid::kernel::activity::CommImpl*) = nullptr; - void (*cleanFunction_)(void*) = nullptr; - void (*copyDataFunction_)(smx_activity_t, void*, size_t) = nullptr; + 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; - smx_actor_t sender_ = nullptr; - smx_actor_t receiver_ = nullptr; - MailboxPtr mailbox_ = nullptr; + Actor* get_sender() const; - std::atomic_int_fast32_t refcount_{0}; + bool is_assigned() const override { return (to_ != nullptr && from_ != nullptr) || (mailbox_ != nullptr); } }; -} -} // namespace simgrid::s4u +} // namespace s4u +} // namespace simgrid #endif /* SIMGRID_S4U_COMM_HPP */