src/s4u/s4u_Semaphore.cpp

   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 #include "src/msg/msg_private.hpp"
   7 #include "xbt/log.h"
   8
   9 #include "simgrid/forward.h"
  10 #include "simgrid/s4u/Semaphore.hpp"
  11 #include "src/kernel/activity/SemaphoreImpl.hpp"
  12
  13 namespace simgrid {
  14 namespace s4u {
  15
  16 Semaphore::Semaphore(unsigned int initial_capacity) : pimpl_(new kernel::activity::SemaphoreImpl(initial_capacity)) {}
  17
  18 Semaphore::~Semaphore()
  19 {
  20   xbt_assert(not pimpl_->is_used(), "Cannot destroy semaphore since someone is still using it");
  21   delete pimpl_;
  22 }
  23
  24 SemaphorePtr Semaphore::create(unsigned int initial_capacity)
  25 {
  26   return SemaphorePtr(new Semaphore(initial_capacity));
  27 }
  28
  29 void Semaphore::acquire()
  30 {
  31   simcall_sem_acquire(pimpl_);
  32 }
  33
  34 int Semaphore::acquire_timeout(double timeout)
  35 {
  36   return simcall_sem_acquire_timeout(pimpl_, timeout);
  37 }
  38
  39 void Semaphore::release()
  40 {
  41   kernel::actor::simcall([this] { pimpl_->release(); });
  42 }
  43
  44 int Semaphore::get_capacity() const
  45 {
  46   return kernel::actor::simcall([this] { return pimpl_->get_capacity(); });
  47 }
  48
  49 int Semaphore::would_block() const
  50 {
  51   return kernel::actor::simcall([this] { return pimpl_->would_block(); });
  52 }
  53
  54 void intrusive_ptr_add_ref(Semaphore* sem)
  55 {
  56   xbt_assert(sem);
  57   sem->refcount_.fetch_add(1, std::memory_order_relaxed);
  58 }
  59
  60 void intrusive_ptr_release(Semaphore* sem)
  61 {
  62   xbt_assert(sem);
  63   if (sem->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
  64     std::atomic_thread_fence(std::memory_order_acquire);
  65     delete sem;
  66   }
  67 }
  68
  69 } // namespace s4u
  70 } // namespace simgrid
  71
  72 /* **************************** Public C interface *************************** */
  73 /** @brief creates a semaphore object of the given initial capacity */
  74 sg_sem_t sg_sem_init(int initial_value)
  75 {
  76   return new simgrid::s4u::Semaphore(initial_value);
  77 }
  78
  79 /** @brief locks on a semaphore object */
  80 void sg_sem_acquire(sg_sem_t sem)
  81 {
  82   sem->acquire();
  83 }
  84
  85 /** @brief locks on a semaphore object up until the provided timeout expires */
  86 int sg_sem_acquire_timeout(sg_sem_t sem, double timeout)
  87 {
  88   return sem->acquire_timeout(timeout);
  89 }
  90
  91 /** @brief releases the semaphore object */
  92 void sg_sem_release(sg_sem_t sem)
  93 {
  94   sem->release();
  95 }
  96
  97 int sg_sem_get_capacity(const_sg_sem_t sem)
  98 {
  99   return sem->get_capacity();
 100 }
 101
 102 void sg_sem_destroy(const_sg_sem_t sem)
 103 {
 104   delete sem;
 105 }
 106
 107 /** @brief returns a boolean indicating if this semaphore would block at this very specific time
 108  *
 109  * Note that the returned value may be wrong right after the function call, when you try to use it...
 110  * But that's a classical semaphore issue, and SimGrid's semaphore are not different to usual ones here.
 111  */
 112 int sg_sem_would_block(const_sg_sem_t sem)
 113 {
 114   return sem->would_block();
 115 }