src/s4u/s4u_Mutex.cpp

   1 /* Copyright (c) 2006-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 "simgrid/forward.h"
   7 #include "simgrid/mutex.h"
   8 #include "simgrid/s4u/Mutex.hpp"
   9 #include "src/kernel/activity/MutexImpl.hpp"
  10 #include "src/mc/checker/SimcallObserver.hpp"
  11
  12 namespace simgrid {
  13 namespace s4u {
  14
  15 Mutex::~Mutex()
  16 {
  17   if (pimpl_ != nullptr)
  18     pimpl_->unref();
  19 }
  20
  21 /** @brief Blocks the calling actor until the mutex can be obtained */
  22 void Mutex::lock()
  23 {
  24   simcall_mutex_lock(pimpl_);
  25 }
  26
  27 /** @brief Release the ownership of the mutex, unleashing a blocked actor (if any)
  28  *
  29  * Will fail if the calling actor does not own the mutex.
  30  */
  31 void Mutex::unlock()
  32 {
  33   kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
  34   mc::MutexUnlockSimcall observer{issuer};
  35   kernel::actor::simcall([this, issuer] { this->pimpl_->unlock(issuer); }, &observer);
  36 }
  37
  38 /** @brief Acquire the mutex if it's free, and return false (without blocking) if not */
  39 bool Mutex::try_lock()
  40 {
  41   kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
  42   mc::MutexTrylockSimcall observer{issuer, pimpl_};
  43   return kernel::actor::simcall([&observer] { return observer.get_mutex()->try_lock(observer.get_issuer()); },
  44                                 &observer);
  45 }
  46
  47 /** @brief Create a new mutex
  48  *
  49  * See @ref s4u_raii.
  50  */
  51 MutexPtr Mutex::create()
  52 {
  53   auto* mutex = new kernel::activity::MutexImpl();
  54   return MutexPtr(&mutex->mutex(), false);
  55 }
  56
  57 /* refcounting of the intrusive_ptr is delegated to the implementation object */
  58 void intrusive_ptr_add_ref(const Mutex* mutex)
  59 {
  60   xbt_assert(mutex);
  61   if (mutex->pimpl_)
  62     mutex->pimpl_->ref();
  63 }
  64 void intrusive_ptr_release(const Mutex* mutex)
  65 {
  66   xbt_assert(mutex);
  67   if (mutex->pimpl_)
  68     mutex->pimpl_->unref();
  69 }
  70
  71 } // namespace s4u
  72 } // namespace simgrid
  73
  74 /* **************************** Public C interface *************************** */
  75 sg_mutex_t sg_mutex_init()
  76 {
  77   simgrid::kernel::activity::MutexImpl* mutex =
  78       simgrid::kernel::actor::simcall([] { return new simgrid::kernel::activity::MutexImpl(); });
  79
  80   return new simgrid::s4u::Mutex(mutex);
  81 }
  82
  83 void sg_mutex_lock(sg_mutex_t mutex)
  84 {
  85   mutex->lock();
  86 }
  87
  88 void sg_mutex_unlock(sg_mutex_t mutex)
  89 {
  90   mutex->unlock();
  91 }
  92
  93 int sg_mutex_try_lock(sg_mutex_t mutex)
  94 {
  95   return mutex->try_lock();
  96 }
  97
  98 void sg_mutex_destroy(const_sg_mutex_t mutex)
  99 {
 100   delete mutex;
 101 }