include/simgrid/s4u/Barrier.hpp

   1 /* Copyright (c) 2018-2021. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SIMGRID_S4U_BARRIER_HPP
   7 #define SIMGRID_S4U_BARRIER_HPP
   8
   9 #include <simgrid/barrier.h>
  10 #include <simgrid/chrono.hpp>
  11 #include <simgrid/forward.h>
  12 #include <simgrid/s4u/ConditionVariable.hpp>
  13 #include <simgrid/s4u/Mutex.hpp>
  14
  15 #include <atomic>
  16 #include <future>
  17
  18 namespace simgrid {
  19 namespace s4u {
  20
  21 class XBT_PUBLIC Barrier {
  22 private:
  23   MutexPtr mutex_            = Mutex::create();
  24   ConditionVariablePtr cond_ = ConditionVariable::create();
  25   unsigned int expected_actors_;
  26   unsigned int arrived_actors_ = 0;
  27
  28   /* refcounting */
  29   std::atomic_int_fast32_t refcount_{0};
  30
  31 public:
  32   /** Creates a barrier for the given amount of actors */
  33   explicit Barrier(unsigned int expected_actors) : expected_actors_(expected_actors) {}
  34 #ifndef DOXYGEN
  35   Barrier(Barrier const&) = delete;
  36   Barrier& operator=(Barrier const&) = delete;
  37 #endif
  38
  39   /** Creates a barrier for the given amount of actors */
  40   static BarrierPtr create(unsigned int expected_actors);
  41   /** Blocks into the barrier. Every waiting actors will be unlocked once the expected amount of actors reaches the barrier */
  42   int wait();
  43
  44 #ifndef DOXYGEN
  45   /* refcounting */
  46   friend XBT_PUBLIC void intrusive_ptr_add_ref(Barrier* barrier);
  47   friend XBT_PUBLIC void intrusive_ptr_release(Barrier* barrier);
  48 #endif
  49 };
  50 } // namespace s4u
  51 } // namespace simgrid
  52
  53 #endif