2 * Copyright Andrey Semashev 2007 - 2015.
3 * Distributed under the Boost Software License, Version 1.0.
4 * (See accompanying file LICENSE_1_0.txt or copy at
5 * http://www.boost.org/LICENSE_1_0.txt)
8 * \file adaptive_mutex.hpp
9 * \author Andrey Semashev
12 * \brief This header is the Boost.Log library implementation, see the library documentation
13 * at http://www.boost.org/doc/libs/release/libs/log/doc/html/index.html.
16 #ifndef BOOST_LOG_DETAIL_ADAPTIVE_MUTEX_HPP_INCLUDED_
17 #define BOOST_LOG_DETAIL_ADAPTIVE_MUTEX_HPP_INCLUDED_
19 #include <boost/log/detail/config.hpp>
21 #ifdef BOOST_HAS_PRAGMA_ONCE
25 #ifndef BOOST_LOG_NO_THREADS
27 #include <boost/throw_exception.hpp>
28 #include <boost/thread/exceptions.hpp>
30 #if defined(BOOST_THREAD_POSIX) // This one can be defined by users, so it should go first
31 #define BOOST_LOG_ADAPTIVE_MUTEX_USE_PTHREAD
32 #elif defined(BOOST_WINDOWS)
33 #define BOOST_LOG_ADAPTIVE_MUTEX_USE_WINAPI
34 #elif defined(BOOST_HAS_PTHREADS)
35 #define BOOST_LOG_ADAPTIVE_MUTEX_USE_PTHREAD
38 #if defined(BOOST_LOG_ADAPTIVE_MUTEX_USE_WINAPI)
40 #include <boost/log/detail/pause.hpp>
41 #include <boost/detail/interlocked.hpp>
42 #include <boost/detail/winapi/thread.hpp>
44 #if defined(__INTEL_COMPILER) || defined(_MSC_VER)
45 # if defined(__INTEL_COMPILER)
46 # define BOOST_LOG_COMPILER_BARRIER __memory_barrier()
48 extern "C" void _ReadWriteBarrier(void);
49 # if defined(BOOST_MSVC)
50 # pragma intrinsic(_ReadWriteBarrier)
52 # define BOOST_LOG_COMPILER_BARRIER _ReadWriteBarrier()
54 #elif defined(__GNUC__) && (defined(__i386__) || defined(__x86_64__))
55 # define BOOST_LOG_COMPILER_BARRIER __asm__ __volatile__("" : : : "memory")
58 #include <boost/log/detail/header.hpp>
62 BOOST_LOG_OPEN_NAMESPACE
66 //! A mutex that performs spinning or thread yielding in case of contention
79 adaptive_mutex() : m_State(0) {}
83 return (BOOST_INTERLOCKED_COMPARE_EXCHANGE(&m_State, 1L, 0L) == 0L);
88 #if defined(BOOST_LOG_AUX_PAUSE)
89 unsigned int pause_count = initial_pause;
93 #if defined(BOOST_LOG_AUX_PAUSE)
94 if (pause_count < max_pause)
96 for (unsigned int i = 0; i < pause_count; ++i)
100 pause_count += pause_count;
104 // Restart spinning after waking up this thread
105 pause_count = initial_pause;
116 #if (defined(_M_IX86) || defined(_M_AMD64)) && defined(BOOST_LOG_COMPILER_BARRIER)
117 BOOST_LOG_COMPILER_BARRIER;
119 BOOST_LOG_COMPILER_BARRIER;
121 BOOST_INTERLOCKED_EXCHANGE(&m_State, 0L);
126 BOOST_DELETED_FUNCTION(adaptive_mutex(adaptive_mutex const&))
127 BOOST_DELETED_FUNCTION(adaptive_mutex& operator= (adaptive_mutex const&))
130 #undef BOOST_LOG_AUX_PAUSE
131 #undef BOOST_LOG_COMPILER_BARRIER
135 BOOST_LOG_CLOSE_NAMESPACE // namespace log
139 #include <boost/log/detail/footer.hpp>
141 #elif defined(BOOST_LOG_ADAPTIVE_MUTEX_USE_PTHREAD)
144 #include <boost/assert.hpp>
145 #include <boost/log/detail/header.hpp>
147 #if defined(PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP)
148 #define BOOST_LOG_ADAPTIVE_MUTEX_USE_PTHREAD_MUTEX_ADAPTIVE_NP
153 BOOST_LOG_OPEN_NAMESPACE
157 //! A mutex that performs spinning or thread yielding in case of contention
161 pthread_mutex_t m_State;
166 #if defined(BOOST_LOG_ADAPTIVE_MUTEX_USE_PTHREAD_MUTEX_ADAPTIVE_NP)
167 pthread_mutexattr_t attrs;
168 pthread_mutexattr_init(&attrs);
169 pthread_mutexattr_settype(&attrs, PTHREAD_MUTEX_ADAPTIVE_NP);
171 const int err = pthread_mutex_init(&m_State, &attrs);
172 pthread_mutexattr_destroy(&attrs);
174 const int err = pthread_mutex_init(&m_State, NULL);
176 if (BOOST_UNLIKELY(err != 0))
177 throw_exception< thread_resource_error >(err, "Failed to initialize an adaptive mutex", "adaptive_mutex::adaptive_mutex()", __FILE__, __LINE__);
182 BOOST_VERIFY(pthread_mutex_destroy(&m_State) == 0);
187 const int err = pthread_mutex_trylock(&m_State);
190 if (BOOST_UNLIKELY(err != EBUSY))
191 throw_exception< lock_error >(err, "Failed to lock an adaptive mutex", "adaptive_mutex::try_lock()", __FILE__, __LINE__);
197 const int err = pthread_mutex_lock(&m_State);
198 if (BOOST_UNLIKELY(err != 0))
199 throw_exception< lock_error >(err, "Failed to lock an adaptive mutex", "adaptive_mutex::lock()", __FILE__, __LINE__);
204 BOOST_VERIFY(pthread_mutex_unlock(&m_State) == 0);
208 BOOST_DELETED_FUNCTION(adaptive_mutex(adaptive_mutex const&))
209 BOOST_DELETED_FUNCTION(adaptive_mutex& operator= (adaptive_mutex const&))
212 template< typename ExceptionT >
213 static BOOST_NOINLINE BOOST_LOG_NORETURN void throw_exception(int err, const char* descr, const char* func, const char* file, int line)
215 #if !defined(BOOST_EXCEPTION_DISABLE)
216 boost::exception_detail::throw_exception_(ExceptionT(err, descr), func, file, line);
218 boost::throw_exception(ExceptionT(err, descr));
225 BOOST_LOG_CLOSE_NAMESPACE // namespace log
229 #include <boost/log/detail/footer.hpp>
233 #endif // BOOST_LOG_NO_THREADS
235 #endif // BOOST_LOG_DETAIL_ADAPTIVE_MUTEX_HPP_INCLUDED_