Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
allow to cancel a s4u::Exec
[simgrid.git] / include / simgrid / s4u / Comm.hpp
index 8bf6c8f..dd24d51 100644 (file)
@@ -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. */
 #ifndef SIMGRID_S4U_COMM_HPP
 #define SIMGRID_S4U_COMM_HPP
 
-#include <xbt/base.h>
-
 #include <simgrid/forward.h>
 #include <simgrid/s4u/Activity.hpp>
-#include <simgrid/s4u/forward.hpp>
+
+#include <atomic>
+#include <vector>
+
 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 <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*), [](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);
-    }
-    // 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;
-  }
+  /*! 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<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);
+
+  /*! take a vector s4u::CommPtr and return when all of them is finished. */
+  static void wait_all(std::vector<CommPtr>* 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<CommPtr> * 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 (*clean_function)(void*))
   {
-    // 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;
-      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);
-    // 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;
+    clean_fun_ = clean_function;
+    return detach();
   }
-  /** 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;
 
   /** 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() override;
+
+  /** Retrieve the mailbox on which this comm acts */
+  MailboxPtr get_mailbox();
+
+  /** @deprecated See Comm::set_rate() */
+  XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_rate()") Activity* setRate(double rate) { return set_rate(rate); }
+  /** @deprecated See Comm::set_src_data() */
+  XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data()") Activity* setSrcData(void* buff)
+  {
+    return set_src_data(buff);
+  }
+  /** @deprecated See Comm::set_src_data() */
+  XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data()") Activity* setSrcData(void* buff, size_t size)
+  {
+    return set_src_data(buff, size);
+  }
+  /** @deprecated See Comm::set_src_data_size() */
+  XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data_size()") Activity* setSrcDataSize(size_t size)
+  {
+    return set_src_data_size(size);
+  }
+  /** @deprecated See Comm::set_dst_data() */
+  XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_dst_data()") Activity* setDstData(void** buff)
+  {
+    return set_dst_data(buff);
+  }
+  /** @deprecated See Comm::set_dst_data() */
+  XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_dst_data()") Activity* setDstData(void** buff, size_t size)
+  {
+    return set_dst_data(buff, size);
+  }
+  /** @deprecated See Comm::get_dst_data_size() */
+  XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_dst_data_size()") size_t getDstDataSize()
+  {
+    return get_dst_data_size();
+  }
+  /** @deprecated See Comm::get_mailbox() */
+  XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_mailbox()") MailboxPtr getMailbox() { return get_mailbox(); }
 
 private:
   double rate_        = -1;
-  void* dstBuff_      = nullptr;
-  size_t dstBuffSize_ = 0;
-  void* srcBuff_      = nullptr;
-  size_t srcBuffSize_ = sizeof(void*);
+  void* dst_buff_       = nullptr;
+  size_t dst_buff_size_ = 0;
+  void* src_buff_       = nullptr;
+  size_t src_buff_size_ = 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;
+  int (*match_fun_)(void*, void*, simgrid::kernel::activity::CommImpl*) = nullptr;
+  void (*clean_fun_)(void*)                                             = nullptr;
+  void (*copy_data_function_)(smx_activity_t, void*, size_t)            = nullptr;
 
   smx_actor_t sender_   = nullptr;
   smx_actor_t receiver_ = nullptr;
@@ -136,7 +128,7 @@ private:
 
   std::atomic_int_fast32_t refcount_{0};
 };
-}
-} // namespace simgrid::s4u
+} // namespace s4u
+} // namespace simgrid
 
 #endif /* SIMGRID_S4U_COMM_HPP */