X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/e16ebb1333db2cee332bbfed4098df88777cec22..37333910920389b485d01f9f50659b8e5ef6a785:/include/simgrid/s4u/Comm.hpp diff --git a/include/simgrid/s4u/Comm.hpp b/include/simgrid/s4u/Comm.hpp index 1975d6e613..b39f8ba4cf 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-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,12 +6,16 @@ #ifndef SIMGRID_S4U_COMM_HPP #define SIMGRID_S4U_COMM_HPP +#include #include +#include #include #include #include +#include +#include #include namespace simgrid { @@ -20,17 +24,17 @@ 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 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 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. */ + /*! 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) @@ -39,10 +43,10 @@ public: 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) + for (auto const& comm : *comms_in) { + if (comm->state_ == Activity::State::inited) comm->start(); - xbt_assert(comm->state_ == started); + xbt_assert(comm->state_ == Activity::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); @@ -52,41 +56,81 @@ public: xbt_dynar_free(&comms); return idx; } - /** Creates (but don't start) an async send to the mailbox @p dest */ - static CommPtr send_init(MailboxPtr dest); - /** Creates and start an async send to the mailbox @p dest */ - static CommPtr send_async(MailboxPtr dest, void* data, int simulatedByteAmount); - /** Creates (but don't start) an async recv onto the mailbox @p from */ - static CommPtr recv_init(MailboxPtr from); - /** Creates and start an async recv to the mailbox @p from */ - static CommPtr recv_async(MailboxPtr from, void** data); - - void start() override; - void wait() override; - void wait(double timeout) override; + /*! 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(); + } + } + /*! 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; + + /** 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. */ - void detach(); + Activity* detach(void (*cleanFunction)(void*)) + { + cleanFunction_ = cleanFunction; + return detach(); + } /** Sets the maximal communication rate (in byte/sec). Must be done before start */ - void setRate(double rate); + Activity* set_rate(double rate); /** Specify the data to send */ - void setSrcData(void* buff); + Activity* set_src_data(void* buff); /** Specify the size of the data to send */ - void setSrcDataSize(size_t size); + Activity* set_src_data_size(size_t size); /** Specify the data to send and its size */ - void setSrcData(void* buff, size_t size); + Activity* set_src_data(void* buff, size_t size); /** Specify where to receive the data */ - void setDstData(void** buff); + Activity* set_dst_data(void** buff); /** Specify the buffer in which the data should be received */ - void setDstData(void** buff, size_t size); + Activity* set_dst_data(void** buff, size_t size); /** Retrieve the size of the received data */ - size_t getDstDataSize(); + size_t get_dst_data_size(); bool test(); - void cancel(); + Activity* cancel(); + + /** Retrieve the mailbox on which this comm acts */ + MailboxPtr get_mailbox(); + + 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(); } private: double rate_ = -1;