src/kernel/activity/SemaphoreImpl.hpp

   1 /* Copyright (c) 2019-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 #ifndef SIMGRID_KERNEL_ACTIVITY_SEMAPHOREIMPL_HPP
   7 #define SIMGRID_KERNEL_ACTIVITY_SEMAPHOREIMPL_HPP
   8
   9 #include <atomic>
  10 #include <boost/intrusive/list.hpp>
  11
  12 #include "simgrid/s4u/Semaphore.hpp"
  13 #include "src/kernel/actor/ActorImpl.hpp"
  14 #include "src/kernel/actor/SynchroObserver.hpp"
  15
  16 namespace simgrid::kernel::activity {
  17
  18 /** Semaphore Acquisition: the act / process of acquiring the semaphore.
  19  *
  20  * You can declare some interest on a semaphore without being blocked waiting if it's already empty.
  21  * See the documentation of the MutexAcquisitionImpl for further details.
  22  */
  23 class XBT_PUBLIC SemAcquisitionImpl : public ActivityImpl_T<SemAcquisitionImpl> {
  24   actor::ActorImpl* issuer_ = nullptr;
  25   SemaphoreImpl* semaphore_ = nullptr;
  26   bool granted_             = false;
  27
  28   friend SemaphoreImpl;
  29   friend actor::SemaphoreAcquisitionObserver;
  30
  31 public:
  32   SemAcquisitionImpl(actor::ActorImpl* issuer, SemaphoreImpl* sem) : issuer_(issuer), semaphore_(sem) {}
  33   SemaphoreImplPtr get_semaphore() { return semaphore_; }
  34   actor::ActorImpl* get_issuer() { return issuer_; }
  35
  36   bool test(actor::ActorImpl* issuer = nullptr) override { return granted_; }
  37   void wait_for(actor::ActorImpl* issuer, double timeout) override;
  38   void post() override;
  39   void finish() override;
  40   void cancel() override;
  41   void set_exception(actor::ActorImpl* issuer) override
  42   { /* nothing to do */
  43   }
  44 };
  45
  46 class XBT_PUBLIC SemaphoreImpl {
  47   std::atomic_int_fast32_t refcount_{1};
  48   s4u::Semaphore piface_;
  49   unsigned int value_;
  50   std::deque<SemAcquisitionImplPtr> ongoing_acquisitions_;
  51
  52   static unsigned next_id_;
  53   unsigned id_ = next_id_++;
  54
  55   friend SemAcquisitionImpl;
  56   friend actor::SemaphoreObserver;
  57
  58 public:
  59   explicit SemaphoreImpl(unsigned int value) : piface_(this), value_(value){};
  60
  61   SemaphoreImpl(SemaphoreImpl const&) = delete;
  62   SemaphoreImpl& operator=(SemaphoreImpl const&) = delete;
  63
  64   SemAcquisitionImplPtr acquire_async(actor::ActorImpl* issuer);
  65   void release();
  66   bool would_block() const { return (value_ == 0); }
  67
  68   unsigned int get_capacity() const { return value_; }
  69   bool is_used() const { return not ongoing_acquisitions_.empty(); }
  70
  71   friend void intrusive_ptr_add_ref(SemaphoreImpl* sem)
  72   {
  73     XBT_ATTRIB_UNUSED auto previous = sem->refcount_.fetch_add(1);
  74     xbt_assert(previous != 0);
  75   }
  76   friend void intrusive_ptr_release(SemaphoreImpl* sem)
  77   {
  78     if (sem->refcount_.fetch_sub(1) == 1) {
  79       xbt_assert(not sem->is_used(), "Cannot destroy semaphore since someone is still using it");
  80       delete sem;
  81     }
  82   }
  83   unsigned get_id() const { return id_; }
  84   s4u::Semaphore& sem() { return piface_; }
  85 };
  86 } // namespace simgrid::kernel::activity
  87
  88 #endif /* SIMGRID_KERNEL_ACTIVITY_SEMAPHOREIMPL_HPP */