Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
please sonar
[simgrid.git] / include / simgrid / s4u / comm.hpp
index c9d615c..7ff8615 100644 (file)
@@ -1,5 +1,4 @@
-/* Copyright (c) 2006-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2006-2016. 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. */
@@ -8,13 +7,16 @@
 #define SIMGRID_S4U_COMM_HPP
 
 #include <xbt/base.h>
+
 #include <simgrid/s4u/Activity.hpp>
 #include <simgrid/s4u/forward.hpp>
-#include <simgrid/s4u/mailbox.hpp>
+#include <simgrid/forward.h>
+
 
 namespace simgrid {
 namespace s4u {
 
+
 /** @brief Communication async
  *
  * Represents all asynchronous communications, that you can test or wait onto.
@@ -22,34 +24,74 @@ namespace s4u {
 XBT_PUBLIC_CLASS Comm : public Activity {
   Comm() : Activity() {}
 public:
-  virtual ~Comm();
+  ~Comm() override;
 
 public:
-  /** Creates (but don't start) an async send to the mailbox #dest */
-  static Comm &send_init(Actor *sender, Mailbox &dest);
-  /** Creates and start an async send to the mailbox #dest */
-  static Comm &send_async(s4u::Actor *sender, Mailbox &dest, void *data, int simulatedByteAmount);
-    /** Creates (but don't start) an async recv onto the mailbox #from */
-  static Comm &recv_init(s4u::Actor *receiver, Mailbox &from);
-  /** Creates and start an async recv to the mailbox #from */
-  static Comm &recv_async(s4u::Actor *receiver, Mailbox &from, void **data);
+  
+  /*! take a range of s4u::Comm* (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)
+  {
+    // Map to dynar<Synchro*>:
+    xbt_dynar_t comms = xbt_dynar_new(sizeof(simgrid::kernel::activity::ActivityImpl*), NULL);
+    for(I iter = first; iter != last; iter++) {
+      Comm& comm = **iter;
+      if (comm.state_ == inited)
+        comm.start();
+      xbt_assert(comm.state_ == started);
+      xbt_dynar_push_as(comms, simgrid::kernel::activity::ActivityImpl*, comm.pimpl_);
+    }
+    // Call the underlying simcall:
+    int idx = simcall_comm_waitany(comms, -1);
+    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;
+  }
+  /*! Same as wait_any, but with a timeout. If wait_any_for return because of the timeout last is returned.*/
+  template<class I> static
+  I wait_any_for(I first, I last, double timeout)
+  {
+    // Map to dynar<Synchro*>:
+    xbt_dynar_t comms = xbt_dynar_new(sizeof(simgrid::kernel::activity::ActivityImpl*), NULL);
+    for(I iter = first; iter != last; iter++) {
+      Comm& comm = **iter;
+      if (comm.state_ == inited)
+        comm.start();
+      xbt_assert(comm.state_ == started);
+      xbt_dynar_push_as(comms, simgrid::kernel::activity::ActivityImpl*, comm.pimpl_);
+    }
+    // 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 Comm &send_init(MailboxPtr dest);
+  /** Creates and start an async send to the mailbox @p dest */
+  static Comm &send_async(MailboxPtr dest, void *data, int simulatedByteAmount);
+    /** Creates (but don't start) an async recv onto the mailbox @p from */
+  static Comm &recv_init(MailboxPtr from);
+  /** Creates and start an async recv to the mailbox @p from */
+  static Comm &recv_async(MailboxPtr from, void **data);
 
   void start() override;
   void wait() override;
   void wait(double timeout) override;
 
-private:
-  double rate_=-1;
-public:
   /** Sets the maximal communication rate (in byte/sec). Must be done before start */
   void setRate(double rate);
 
-private:
-  void *dstBuff_ = NULL;
-  size_t dstBuffSize_ = 0;
-  void *srcBuff_ = NULL;
-  size_t srcBuffSize_ = sizeof(void*);
-public:
   /** Specify the data to send */
   void setSrcData(void * buff);
   /** Specify the size of the data to send */
@@ -64,17 +106,25 @@ public:
   /** Retrieve the size of the received data */
   size_t getDstDataSize();
 
+  bool test();
 
-private: /* FIXME: expose these elements in the API */
-  int detached_ = 0;
-  int (*matchFunction_)(void *, void *, smx_synchro_t) = NULL;
-  void (*cleanFunction_)(void *) = NULL;
-  void (*copyDataFunction_)(smx_synchro_t, void*, size_t) = NULL;
 
 private:
-  Actor *sender_ = NULL;
-  Actor *receiver_ = NULL;
-  Mailbox *mailbox_ = NULL;
+  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 *, smx_activity_t) = 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;
 };
 
 }} // namespace simgrid::s4u