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