include/simgrid/s4u/Semaphore.hpp

   1 /* Copyright (c) 2006-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_SEMAPHORE_HPP
   7 #define SIMGRID_S4U_SEMAPHORE_HPP
   8
   9 #include <simgrid/forward.h>
  10 #include <simgrid/simix.h>
  11
  12 namespace simgrid {
  13 namespace s4u {
  14
  15 /** @brief A classical semaphore, but blocking in the simulation world
  16  *
  17  * @beginrst
  18  * It is strictly impossible to use a real semaphore, such as
  19  * `sem_init <http://pubs.opengroup.org/onlinepubs/9699919799/functions/sem_init.html>`_,
  20  * because it would block the whole simulation.
  21  * Instead, you should use the present class, that offers a very similar interface.
  22  *
  23  * An example is available in Section :ref:`s4u_ex_IPC`.
  24  *
  25  * As for any S4U object, you can use the :ref:`RAII idiom <s4u_raii>` for memory management of semaphores.
  26  * Use :cpp:func:`create() <simgrid::s4u::Mutex::create()>` to get a :cpp:type:`simgrid::s4u::SemaphorePtr` to a newly
  27  * created semaphore, that will get automatically freed when the variable goes out of scope.
  28  * @endrst
  29  *
  30  */
  31 class XBT_PUBLIC Semaphore {
  32 #ifndef DOXYGEN
  33   friend kernel::activity::SemaphoreImpl;
  34   friend void kernel::activity::intrusive_ptr_release(kernel::activity::SemaphoreImpl* sem);
  35 #endif
  36
  37   kernel::activity::SemaphoreImpl* const pimpl_;
  38
  39   friend void intrusive_ptr_add_ref(const Semaphore* sem);
  40   friend void intrusive_ptr_release(const Semaphore* sem);
  41
  42   explicit Semaphore(kernel::activity::SemaphoreImpl* sem) : pimpl_(sem) {}
  43   ~Semaphore() = default;
  44 #ifndef DOXYGEN
  45   Semaphore(Semaphore const&) = delete;            // No copy constructor. Use SemaphorePtr instead
  46   Semaphore& operator=(Semaphore const&) = delete; // No direct assignment either. Use SemaphorePtr instead
  47 #endif
  48
  49 public:
  50   /** Constructs a new semaphore */
  51   static SemaphorePtr create(unsigned int initial_capacity);
  52
  53   void acquire();
  54   bool acquire_timeout(double timeout);
  55   void release();
  56   int get_capacity() const;
  57   bool would_block() const;
  58 };
  59
  60 } // namespace s4u
  61 } // namespace simgrid
  62
  63 #endif /* SIMGRID_S4U_SEMAPHORE_HPP */