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