implement getter s4u::Comm::mailbox()

[simgrid.git] / include / simgrid / s4u / Comm.hpp

diff --git a/include/simgrid/s4u/Comm.hpp b/include/simgrid/s4u/Comm.hpp
index d409c0b..a2c71d0 100644 (file)
--- a/include/simgrid/s4u/Comm.hpp
+++ b/include/simgrid/s4u/Comm.hpp
@@ -10,7 +10,11 @@
 
 #include <simgrid/forward.h>
 #include <simgrid/s4u/Activity.hpp>
+#include <simgrid/s4u/Mailbox.hpp> // DEPRECATED 3.17
 #include <simgrid/s4u/forward.hpp>
+
+#include <vector>
+
 namespace simgrid {
 namespace s4u {
 /** @brief Communication async
@@ -23,24 +27,21 @@ XBT_PUBLIC_CLASS Comm : public 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
 
   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 <class I> static I wait_any(I first, I last)
-  {
-    return wait_any_for(first, last, -1);
-  }
+  static int wait_any(std::vector<CommPtr> * comms) { return wait_any_for(comms, -1); }
   /*! Same as wait_any, but with a timeout. If the timeout occurs, parameter last is returned.*/
-  template <class I> static I wait_any_for(I first, I last, double timeout)
+  static int wait_any_for(std::vector<CommPtr> * comms_in, double timeout)
   {
     // Map to dynar<Synchro*>:
     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 comm : *comms_in) {
       if (comm->state_ == inited)
         comm->start();
       xbt_assert(comm->state_ == started);
@@ -51,30 +52,46 @@ public:
     // 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;
+    return idx;
   }
   /** Creates (but don't start) an async send to the mailbox @p dest */
-  static CommPtr send_init(MailboxPtr 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 send_async(MailboxPtr dest, void* data, int simulatedByteAmount);
+  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 recv_init(MailboxPtr 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 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);
+  static CommPtr XBT_ATTRIB_DEPRECATED("please use Mailbox::get_async") // 3.17
+      recv_async(MailboxPtr from, void** data)
+  {
+    return from->get_async(data);
+  }
 
   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();
+
   /** Sets the maximal communication rate (in byte/sec). Must be done before start */
   void setRate(double rate);
 
@@ -95,6 +112,9 @@ public:
   bool test();
   void cancel();
 
+  /** Retrieve the mailbox on which this comm acts */
+  MailboxPtr mailbox();
+
 private:
   double rate_        = -1;
   void* dstBuff_      = nullptr;