X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/423d3ad610d6a1e0587b42fd7d2a7a9959af778d..ac080087b39ef79ff497d3992ff04b3e20fe40b2:/include/simgrid/s4u/Comm.hpp diff --git a/include/simgrid/s4u/Comm.hpp b/include/simgrid/s4u/Comm.hpp index a2c71d0a47..153be7e069 100644 --- a/include/simgrid/s4u/Comm.hpp +++ b/include/simgrid/s4u/Comm.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2016. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2019. 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.17 -#include +#include #include namespace simgrid { @@ -21,120 +18,108 @@ 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; + kernel::actor::ActorImpl* receiver_ = 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; + 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; + + Comm() = default; + 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 +#endif virtual ~Comm(); - /*! take a range of s4u::CommPtr (last excluded) and return when one of them is finished. The return value is an - * iterator on the finished Comms. */ + 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) - { - // 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 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; - } - /** Creates (but don't start) an async send to the mailbox @p dest */ - static CommPtr XBT_ATTRIB_DEPRECATED("please use Mailbox::put_init") // 3.17 - send_init(MailboxPtr dest) - { - return dest->put_init(); - } - /** Creates (but don't start) an async send to the mailbox @p dest */ - static CommPtr XBT_ATTRIB_DEPRECATED("please use Mailbox::put_init") // 3.17 - 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 */ - static CommPtr XBT_ATTRIB_DEPRECATED("please use Mailbox::put_async") // 3.17 - 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 */ - static CommPtr XBT_ATTRIB_DEPRECATED("please use Mailbox::get_init") // 3.17 - recv_init(MailboxPtr from) - { - return from->get_init(); - } - /** Creates and start an async recv to the mailbox @p from */ - static CommPtr XBT_ATTRIB_DEPRECATED("please use Mailbox::get_async") // 3.17 - recv_async(MailboxPtr from, void** data) - { - return from->get_async(data); - } + 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); - void start() override; - void wait() override; - void wait(double timeout) override; + 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. */ - void detach(); + 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(); + } /** 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. + * + * 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. + */ + CommPtr 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. + */ + 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() + * + * 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. + */ + 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); + + CommPtr set_tracing_category(const std::string& category); /** Retrieve the mailbox on which this comm acts */ - MailboxPtr mailbox(); - -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; - - smx_actor_t sender_ = nullptr; - smx_actor_t receiver_ = nullptr; - MailboxPtr mailbox_ = nullptr; + 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(); - std::atomic_int_fast32_t refcount_{0}; + Actor* get_sender(); }; -} -} // namespace simgrid::s4u +} // namespace s4u +} // namespace simgrid #endif /* SIMGRID_S4U_COMM_HPP */