src/s4u/s4u_Semaphore.cpp

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