. /include/boost/corosio /detail /conditionally_enabled_mutex.hpp
100.00% Lines (32/32) 100.00% Functions (9/9)
[ ] prev/next file n p prev/next uncovered line
TLA Baseline Branch
Line Hits Code Line Hits Code
1   // 1   //
2   // Copyright (c) 2026 Michael Vandeberg 2   // Copyright (c) 2026 Michael Vandeberg
3   // 3   //
4   // Distributed under the Boost Software License, Version 1.0. (See accompanying 4   // Distributed under the Boost Software License, Version 1.0. (See accompanying
5   // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) 5   // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
6   // 6   //
7   // Official repository: https://github.com/cppalliance/corosio 7   // Official repository: https://github.com/cppalliance/corosio
8   // 8   //
9   9  
10   #ifndef BOOST_COROSIO_DETAIL_CONDITIONALLY_ENABLED_MUTEX_HPP 10   #ifndef BOOST_COROSIO_DETAIL_CONDITIONALLY_ENABLED_MUTEX_HPP
11   #define BOOST_COROSIO_DETAIL_CONDITIONALLY_ENABLED_MUTEX_HPP 11   #define BOOST_COROSIO_DETAIL_CONDITIONALLY_ENABLED_MUTEX_HPP
12   12  
13   #include <mutex> 13   #include <mutex>
14   14  
15   namespace boost::corosio::detail { 15   namespace boost::corosio::detail {
16   16  
17   /* Mutex wrapper that becomes a no-op when disabled. 17   /* Mutex wrapper that becomes a no-op when disabled.
18   18  
19   When enabled (the default), lock/unlock delegate to an 19   When enabled (the default), lock/unlock delegate to an
20   underlying std::mutex. When disabled, all operations are 20   underlying std::mutex. When disabled, all operations are
21   no-ops. The enabled flag is fixed after construction. 21   no-ops. The enabled flag is fixed after construction.
22   22  
23   scoped_lock wraps std::unique_lock<std::mutex> internally 23   scoped_lock wraps std::unique_lock<std::mutex> internally
24   so that condvar wait paths (which require the real lock 24   so that condvar wait paths (which require the real lock
25   type) compile and work in multi-threaded mode. 25   type) compile and work in multi-threaded mode.
26   */ 26   */
27   class conditionally_enabled_mutex 27   class conditionally_enabled_mutex
28   { 28   {
29   std::mutex mutex_; 29   std::mutex mutex_;
30   bool enabled_; 30   bool enabled_;
31   31  
32   public: 32   public:
HITCBC 33   19968 explicit conditionally_enabled_mutex(bool enabled = true) noexcept 33   20202 explicit conditionally_enabled_mutex(bool enabled = true) noexcept
HITCBC 34   19968 : enabled_(enabled) 34   20202 : enabled_(enabled)
35   { 35   {
HITCBC 36   19968 } 36   20202 }
37   37  
38   conditionally_enabled_mutex(conditionally_enabled_mutex const&) = delete; 38   conditionally_enabled_mutex(conditionally_enabled_mutex const&) = delete;
39   conditionally_enabled_mutex& 39   conditionally_enabled_mutex&
40   operator=(conditionally_enabled_mutex const&) = delete; 40   operator=(conditionally_enabled_mutex const&) = delete;
41   41  
42   bool enabled() const noexcept 42   bool enabled() const noexcept
43   { 43   {
44   return enabled_; 44   return enabled_;
45   } 45   }
46   46  
HITCBC 47   12841 void set_enabled(bool v) noexcept 47   12982 void set_enabled(bool v) noexcept
48   { 48   {
HITCBC 49   12841 enabled_ = v; 49   12982 enabled_ = v;
HITCBC 50   12841 } 50   12982 }
51   51  
52   // Lockable interface — allows std::lock_guard<conditionally_enabled_mutex> 52   // Lockable interface — allows std::lock_guard<conditionally_enabled_mutex>
HITCBC 53   69054 void lock() 53   69504 void lock()
54   { 54   {
HITCBC 55   69054 if (enabled_) 55   69504 if (enabled_)
HITCBC 56   69054 mutex_.lock(); 56   69504 mutex_.lock();
HITCBC 57   69054 } 57   69504 }
HITCBC 58   69054 void unlock() 58   69504 void unlock()
59   { 59   {
HITCBC 60   69054 if (enabled_) 60   69504 if (enabled_)
HITCBC 61   69054 mutex_.unlock(); 61   69504 mutex_.unlock();
HITCBC 62   69054 } 62   69504 }
63   bool try_lock() 63   bool try_lock()
64   { 64   {
65   return !enabled_ || mutex_.try_lock(); 65   return !enabled_ || mutex_.try_lock();
66   } 66   }
67   67  
68   class scoped_lock 68   class scoped_lock
69   { 69   {
70   std::unique_lock<std::mutex> lock_; 70   std::unique_lock<std::mutex> lock_;
71   bool enabled_; 71   bool enabled_;
72   72  
73   public: 73   public:
HITCBC 74   821343 explicit scoped_lock(conditionally_enabled_mutex& m) 74   932650 explicit scoped_lock(conditionally_enabled_mutex& m)
HITCBC 75   821343 : lock_(m.mutex_, std::defer_lock) 75   932650 : lock_(m.mutex_, std::defer_lock)
HITCBC 76   821343 , enabled_(m.enabled_) 76   932650 , enabled_(m.enabled_)
77   { 77   {
HITCBC 78   821343 if (enabled_) 78   932650 if (enabled_)
HITCBC 79   821323 lock_.lock(); 79   932630 lock_.lock();
HITCBC 80   821343 } 80   932650 }
81   81  
82   scoped_lock(scoped_lock const&) = delete; 82   scoped_lock(scoped_lock const&) = delete;
83   scoped_lock& operator=(scoped_lock const&) = delete; 83   scoped_lock& operator=(scoped_lock const&) = delete;
84   84  
HITCBC 85   748884 void lock() 85   853045 void lock()
86   { 86   {
HITCBC 87   748884 if (enabled_) 87   853045 if (enabled_)
HITCBC 88   748876 lock_.lock(); 88   853037 lock_.lock();
HITCBC 89   748884 } 89   853045 }
90   90  
HITCBC 91   765552 void unlock() 91   869814 void unlock()
92   { 92   {
HITCBC 93   765552 if (enabled_) 93   869814 if (enabled_)
HITCBC 94   765544 lock_.unlock(); 94   869806 lock_.unlock();
HITCBC 95   765552 } 95   869814 }
96   96  
HITCBC 97   757757 bool owns_lock() const noexcept 97   861825 bool owns_lock() const noexcept
98   { 98   {
HITCBC 99   757757 return enabled_ && lock_.owns_lock(); 99   861825 return enabled_ && lock_.owns_lock();
100   } 100   }
101   101  
102   // Access the underlying unique_lock for condvar wait(). 102   // Access the underlying unique_lock for condvar wait().
103   // Only called when locking is enabled. 103   // Only called when locking is enabled.
HITCBC 104   18 std::unique_lock<std::mutex>& underlying() noexcept 104   22 std::unique_lock<std::mutex>& underlying() noexcept
105   { 105   {
HITCBC 106   18 return lock_; 106   22 return lock_;
107   } 107   }
108   }; 108   };
109   }; 109   };
110   110  
111   } // namespace boost::corosio::detail 111   } // namespace boost::corosio::detail
112   112  
113   #endif // BOOST_COROSIO_DETAIL_CONDITIONALLY_ENABLED_MUTEX_HPP 113   #endif // BOOST_COROSIO_DETAIL_CONDITIONALLY_ENABLED_MUTEX_HPP