X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/166ad11130482e81d2c3e860ab6c61e972a4cdf6..9caf173e476622d309cc5653a83d224d05787cc7:/include/simgrid/s4u/Comm.hpp diff --git a/include/simgrid/s4u/Comm.hpp b/include/simgrid/s4u/Comm.hpp index 697f259089..077718bebe 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,36 +6,44 @@ #ifndef SIMGRID_S4U_COMM_HPP #define SIMGRID_S4U_COMM_HPP +#include #include +#include #include #include #include +#include + +#include +#include + namespace simgrid { namespace s4u { /** @brief Communication async * * 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. */ - template static I wait_any(I first, I last) + /*! 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 (I iter = first; iter != last; iter++) { - CommPtr comm = *iter; + for (auto const& comm : *comms_in) { if (comm->state_ == inited) comm->start(); xbt_assert(comm->state_ == started); @@ -44,78 +52,58 @@ public: xbt_dynar_push_as(comms, simgrid::kernel::activity::ActivityImpl*, ptr); } // Call the underlying simcall: - int idx = simcall_comm_waitany(comms, -1); + int idx = simcall_comm_waitany(comms, timeout); xbt_dynar_free(&comms); - // Not found: - if (idx == -1) - return last; - // Lift the index to the corresponding iterator: - auto res = std::next(first, idx); - (*res)->state_ = finished; - return res; + return idx; } - /*! Same as wait_any, but with a timeout. If the timeout occurs, parameter last is returned.*/ - template static I wait_any_for(I first, I last, double timeout) + + /*! take a vector s4u::CommPtr and return when all of them is finished. */ + static void wait_all(std::vector * comms) { - // 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 (I iter = first; iter != last; iter++) { - CommPtr comm = *iter; - 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); + // TODO: this should be a simcall or something + // TODO: we are missing a version with timeout + for (CommPtr comm : *comms) { + comm->wait(); } - // Call the underlying simcall: - int idx = simcall_comm_waitany(comms, timeout); - xbt_dynar_free(&comms); - // Not found: - if (idx == -1) - return last; - // Lift the index to the corresponding iterator: - auto res = std::next(first, idx); - (*res)->state_ = finished; - return res; } - /** 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); - /** Creates and start a detached send to the mailbox @p dest - * TODO: make it possible to detach an already created comm */ - static void send_detached(MailboxPtr dest, void* data, int simulatedSize); - - void start() override; - void wait() override; - void wait(double timeout) override; + /*! 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. */ + 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* setRate(double rate); /** Specify the data to send */ - void setSrcData(void* buff); + Activity* setSrcData(void* buff); /** Specify the size of the data to send */ - void setSrcDataSize(size_t size); + Activity* setSrcDataSize(size_t size); /** Specify the data to send and its size */ - void setSrcData(void* buff, size_t size); + Activity* setSrcData(void* buff, size_t size); /** Specify where to receive the data */ - void setDstData(void** buff); + Activity* setDstData(void** buff); /** Specify the buffer in which the data should be received */ - void setDstData(void** buff, size_t size); + Activity* setDstData(void** buff, size_t size); /** Retrieve the size of the received data */ size_t getDstDataSize(); bool test(); - void cancel(); + Activity* cancel(); + + /** Retrieve the mailbox on which this comm acts */ + MailboxPtr getMailbox(); private: double rate_ = -1; @@ -126,7 +114,7 @@ private: /* FIXME: expose these elements in the API */ int detached_ = 0; - int (*matchFunction_)(void*, void*, smx_activity_t) = nullptr; + int (*matchFunction_)(void*, void*, simgrid::kernel::activity::CommImpl*) = nullptr; void (*cleanFunction_)(void*) = nullptr; void (*copyDataFunction_)(smx_activity_t, void*, size_t) = nullptr;