src/s4u/s4u_Semaphore.cpp

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