Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add new entry in Release_Notes.
[simgrid.git] / include / simgrid / s4u / Barrier.hpp
index 4b57898..2d6db86 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2018-2023. 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,31 +6,42 @@
 #ifndef SIMGRID_S4U_BARRIER_HPP
 #define SIMGRID_S4U_BARRIER_HPP
 
-#include "simgrid/s4u/ConditionVariable.hpp"
+#include <simgrid/barrier.h>
 #include <simgrid/chrono.hpp>
+#include <simgrid/forward.h>
+#include <simgrid/s4u/ConditionVariable.hpp>
 #include <simgrid/s4u/Mutex.hpp>
 
+#include <atomic>
 #include <future>
 
-namespace simgrid {
-namespace s4u {
+namespace simgrid::s4u {
 
 class XBT_PUBLIC Barrier {
-private:
-  MutexPtr mutex_;
-  ConditionVariablePtr cond_;
-  unsigned int expected_processes_;
-  unsigned int arrived_processes_ = 0;
+  kernel::activity::BarrierImpl* pimpl_;
+  friend kernel::activity::BarrierImpl;
+
+  explicit Barrier(kernel::activity::BarrierImpl* pimpl) : pimpl_(pimpl) {}
 
 public:
-  explicit Barrier(unsigned int count);
-  ~Barrier()              = default;
+#ifndef DOXYGEN
   Barrier(Barrier const&) = delete;
   Barrier& operator=(Barrier const&) = delete;
+#endif
 
+  /** \static Creates a barrier for the given amount of actors */
+  static BarrierPtr create(unsigned int expected_actors);
+  /** Blocks into the barrier. Every waiting actors will be unlocked once the expected amount of actors reaches the barrier */
   int wait();
+  /** Returns some debug information about the barrier */
+  std::string to_string() const;
+
+#ifndef DOXYGEN
+  /* refcounting */
+  friend XBT_PUBLIC void intrusive_ptr_add_ref(Barrier* barrier);
+  friend XBT_PUBLIC void intrusive_ptr_release(Barrier* barrier);
+#endif
 };
-}
 } // namespace simgrid::s4u
 
 #endif