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