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([&observer] { observer.get_sem()->acquire(observer.get_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       [&observer] { observer.get_sem()->acquire(observer.get_issuer(), observer.get_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   xbt_assert(sem);
  55   sem->pimpl_->ref();
  56 }
  57
  58 void intrusive_ptr_release(const Semaphore* sem)
  59 {
  60   xbt_assert(sem);
  61   sem->pimpl_->unref();
  62 }
  63
  64 } // namespace s4u
  65 } // namespace simgrid
  66
  67 /* **************************** Public C interface *************************** */
  68 /** @brief creates a semaphore object of the given initial capacity */
  69 sg_sem_t sg_sem_init(int initial_value)
  70 {
  71   return simgrid::s4u::Semaphore::create(initial_value).detach();
  72 }
  73
  74 /** @brief locks on a semaphore object */
  75 void sg_sem_acquire(sg_sem_t sem)
  76 {
  77   sem->acquire();
  78 }
  79
  80 /** @brief locks on a semaphore object up until the provided timeout expires */
  81 int sg_sem_acquire_timeout(sg_sem_t sem, double timeout)
  82 {
  83   return sem->acquire_timeout(timeout);
  84 }
  85
  86 /** @brief releases the semaphore object */
  87 void sg_sem_release(sg_sem_t sem)
  88 {
  89   sem->release();
  90 }
  91
  92 int sg_sem_get_capacity(const_sg_sem_t sem)
  93 {
  94   return sem->get_capacity();
  95 }
  96
  97 void sg_sem_destroy(const_sg_sem_t sem)
  98 {
  99   intrusive_ptr_release(sem);
 100 }
 101
 102 /** @brief returns a boolean indicating if this semaphore would block at this very specific time
 103  *
 104  * Note that the returned value may be wrong right after the function call, when you try to use it...
 105  * But that's a classical semaphore issue, and SimGrid's semaphore are not different to usual ones here.
 106  */
 107 int sg_sem_would_block(const_sg_sem_t sem)
 108 {
 109   return sem->would_block();
 110 }