X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/88fad0aaff9eb463f048bfdfe4ad6218aba44ddb..e3879f46e9ecd25bf7da2e0caaf24688414b5dc0:/include/simgrid/s4u/Comm.hpp diff --git a/include/simgrid/s4u/Comm.hpp b/include/simgrid/s4u/Comm.hpp index 077718bebe..c9016f9da2 100644 --- a/include/simgrid/s4u/Comm.hpp +++ b/include/simgrid/s4u/Comm.hpp @@ -6,14 +6,8 @@ #ifndef SIMGRID_S4U_COMM_HPP #define SIMGRID_S4U_COMM_HPP -#include -#include -#include - #include #include -#include -#include #include #include @@ -29,94 +23,125 @@ class XBT_PUBLIC Comm : public Activity { public: friend XBT_PUBLIC void intrusive_ptr_release(simgrid::s4u::Comm * c); friend XBT_PUBLIC void intrusive_ptr_add_ref(simgrid::s4u::Comm * c); - friend Mailbox; // Factory of comms + friend simgrid::s4u::Mailbox; // Factory of comms virtual ~Comm(); + static simgrid::xbt::signal on_sender_start; + static simgrid::xbt::signal on_receiver_start; + static simgrid::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 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) - { - // TODO: this should be a simcall or something - // TODO: we are missing a version with timeout - for (CommPtr comm : *comms) { - comm->wait(); - } - } + 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); Activity* start() override; Activity* wait() override; - Activity* wait(double timeout) override; + Activity* wait_for(double timeout) override; + bool test() override; /** Start the comm, and ignore its result. It can be completely forgotten after that. */ Activity* detach(); /** Start the comm, and ignore its result. It can be completely forgotten after that. */ - Activity* detach(void (*cleanFunction)(void*)) + Activity* detach(void (*clean_function)(void*)) { - cleanFunction_ = cleanFunction; + clean_fun_ = clean_function; return detach(); } /** Sets the maximal communication rate (in byte/sec). Must be done before start */ - Activity* setRate(double rate); - - /** Specify the data to send */ - Activity* setSrcData(void* buff); - /** Specify the size of the data to send */ - Activity* setSrcDataSize(size_t size); - /** Specify the data to send and its size */ - Activity* setSrcData(void* buff, size_t size); - - /** Specify where to receive the data */ - Activity* setDstData(void** buff); - /** Specify the buffer in which the data should be received */ - Activity* setDstData(void** buff, size_t size); - /** Retrieve the size of the received data */ - size_t getDstDataSize(); - - bool test(); - Activity* cancel(); + Activity* set_rate(double rate); + + /** Specify the data to send. + * + * 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()): + * you can send a short buffer in your simulator, that represents a very large message + * in the simulated world, or the opposite. + */ + Activity* set_src_data(void* buff); + /** Specify the size of the data to send. Not to be mixed with @ref Activity::set_remaining() + * + * 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. + */ + Activity* 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() + * + * 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()): + * you can send a short buffer in your simulator, that represents a very large message + * in the simulated world, or the opposite. + */ + Activity* 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 */ + Activity* 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 */ + Activity* set_dst_data(void** buff, size_t size); + /** Retrieve the size of the received data. Not to be mixed with @ref Activity::set_remaining() */ + size_t get_dst_data_size(); + + Activity* cancel() override; /** Retrieve the mailbox on which this comm acts */ - MailboxPtr getMailbox(); + MailboxPtr get_mailbox(); + +#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); } + XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data()") Activity* setSrcData(void* buff) + { + return set_src_data(buff); + } + XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data()") Activity* setSrcData(void* buff, size_t size) + { + return set_src_data(buff, size); + } + XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data_size()") Activity* setSrcDataSize(size_t size) + { + return set_src_data_size(size); + } + XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_dst_data()") Activity* setDstData(void** buff) + { + return set_dst_data(buff); + } + XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_dst_data()") Activity* setDstData(void** buff, size_t size) + { + return set_dst_data(buff, size); + } + XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_dst_data_size()") size_t getDstDataSize() + { + return get_dst_data_size(); + } + XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_mailbox()") MailboxPtr getMailbox() { return get_mailbox(); } +#endif private: double rate_ = -1; - void* dstBuff_ = nullptr; - size_t dstBuffSize_ = 0; - void* srcBuff_ = nullptr; - size_t srcBuffSize_ = sizeof(void*); + 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 */ 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; + int (*match_fun_)(void*, void*, simgrid::kernel::activity::CommImpl*) = nullptr; + void (*clean_fun_)(void*) = nullptr; + void (*copy_data_function_)(smx_activity_t, void*, size_t) = nullptr; smx_actor_t sender_ = nullptr; smx_actor_t receiver_ = nullptr; @@ -124,7 +149,7 @@ private: std::atomic_int_fast32_t refcount_{0}; }; -} -} // namespace simgrid::s4u +} // namespace s4u +} // namespace simgrid #endif /* SIMGRID_S4U_COMM_HPP */