X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/9e2e32849ed01a869c9c70e78014e6938f098be5..e3879f46e9ecd25bf7da2e0caaf24688414b5dc0:/include/simgrid/s4u/Comm.hpp diff --git a/include/simgrid/s4u/Comm.hpp b/include/simgrid/s4u/Comm.hpp index 6943de3534..c9016f9da2 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-2018. 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,129 +18,130 @@ namespace s4u { * * Represents all asynchronous communications, that you can test or wait onto. */ -XBT_PUBLIC_CLASS Comm : public Activity -{ +class XBT_PUBLIC Comm : public Activity { Comm() : Activity() {} public: - friend void intrusive_ptr_release(simgrid::s4u::Comm * c); - friend void intrusive_ptr_add_ref(simgrid::s4u::Comm * c); - friend Mailbox; // Factory of comms + friend XBT_PUBLIC void intrusive_ptr_release(simgrid::s4u::Comm * c); + friend XBT_PUBLIC void intrusive_ptr_add_ref(simgrid::s4u::Comm * c); + 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) + 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_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 (*clean_function)(void*)) { - // TODO: this should be a simcall or something - // TODO: we are missing a version with timeout - for (CommPtr comm : *comms) { - comm->wait(); - } + clean_fun_ = clean_function; + return detach(); } - /** 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) + /** Sets the maximal communication rate (in byte/sec). Must be done before start */ + 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 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 dest->put_init(); + return set_src_data(buff); } - /** 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) + XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data()") Activity* setSrcData(void* buff, size_t size) { - return dest->put_init(data, simulatedByteAmount); + return set_src_data(buff, size); } - /** 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) + XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data_size()") Activity* setSrcDataSize(size_t size) { - return dest->put_async(data, simulatedByteAmount); + return set_src_data_size(size); } - /** 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) + XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_dst_data()") Activity* setDstData(void** buff) { - return from->get_init(); + return set_dst_data(buff); } - /** 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) + XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_dst_data()") Activity* setDstData(void** buff, size_t size) { - return from->get_async(data); + return set_dst_data(buff, size); } - - void start() override; - void wait() override; - void wait(double timeout) override; - - /** Start the comm, and ignore its result. It can be completely forgotten after that. */ - void detach(); - /** Start the comm, and ignore its result. It can be completely forgotten after that. */ - void detach(void (*cleanFunction)(void*)) + XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_dst_data_size()") size_t getDstDataSize() { - cleanFunction_ = cleanFunction; - detach(); + return get_dst_data_size(); } - - /** 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(); - - /** Retrieve the mailbox on which this comm acts */ - MailboxPtr getMailbox(); + 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; @@ -151,7 +149,7 @@ private: std::atomic_int_fast32_t refcount_{0}; }; -} -} // namespace simgrid::s4u +} // namespace s4u +} // namespace simgrid #endif /* SIMGRID_S4U_COMM_HPP */