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