1 /*
2     Copyright (c) 2005-2021 Intel Corporation
3 
4     Licensed under the Apache License, Version 2.0 (the "License");
5     you may not use this file except in compliance with the License.
6     You may obtain a copy of the License at
7 
8         http://www.apache.org/licenses/LICENSE-2.0
9 
10     Unless required by applicable law or agreed to in writing, software
11     distributed under the License is distributed on an "AS IS" BASIS,
12     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13     See the License for the specific language governing permissions and
14     limitations under the License.
15 */
16 
17 #if __INTEL_COMPILER && _MSC_VER
18 #pragma warning(disable : 2586) // decorated name length exceeded, name was truncated
19 #endif
20 
21 #include "conformance_mutex.h"
22 
23 #include "oneapi/tbb/spin_mutex.h"
24 #include "oneapi/tbb/mutex.h"
25 #include "oneapi/tbb/spin_rw_mutex.h"
26 #include "oneapi/tbb/rw_mutex.h"
27 #include "oneapi/tbb/queuing_mutex.h"
28 #include "oneapi/tbb/queuing_rw_mutex.h"
29 #include "oneapi/tbb/null_mutex.h"
30 #include "oneapi/tbb/null_rw_mutex.h"
31 
32 //! \file conformance_mutex.cpp
33 //! \brief Test for [mutex.spin_mutex mutex.spin_rw_mutex mutex.queuing_mutex mutex.queuing_rw_mutex mutex.speculative_spin_mutex mutex.speculative_spin_rw_mutex mutex.null_mutex mutex.null_rw_mutex] specifications
34 
35 //! Testing Mutex requirements
36 //! \brief \ref interface \ref requirement
37 TEST_CASE("Basic Locable requirement test") {
38     // BasicLockable
39     GeneralTest<oneapi::tbb::spin_mutex>("Spin Mutex");
40     GeneralTest<oneapi::tbb::spin_rw_mutex>("Spin RW Mutex");
41     GeneralTest<oneapi::tbb::queuing_mutex>("Queuing Mutex");
42     GeneralTest<oneapi::tbb::queuing_rw_mutex>("Queuing RW Mutex");
43     GeneralTest<oneapi::tbb::speculative_spin_mutex>("Speculative Spin Mutex");
44     GeneralTest<oneapi::tbb::speculative_spin_rw_mutex>("Speculative Spin RW Mutex");
45     // NullMutexes
46     GeneralTest<oneapi::tbb::null_mutex, utils::AtomicCounter<oneapi::tbb::null_mutex>>("Null Mutex", false);
47     GeneralTest<oneapi::tbb::null_rw_mutex, utils::AtomicCounter<oneapi::tbb::null_rw_mutex>>("Null RW Mutex", false);
48     TestNullMutex<oneapi::tbb::null_mutex>("Null Mutex");
49     TestNullMutex<oneapi::tbb::null_rw_mutex>("Null RW Mutex");
50 }
51 
52 //! \brief \ref interface \ref requirement
53 TEST_CASE("Lockable requirement test") {
54     // Lockable - single threaded try_acquire operations
55     TestTryAcquire<oneapi::tbb::spin_mutex>("Spin Mutex");
56     TestTryAcquire<oneapi::tbb::spin_rw_mutex>("Spin RW Mutex");
57     TestTryAcquire<oneapi::tbb::queuing_mutex>("Queuing Mutex");
58     TestTryAcquire<oneapi::tbb::queuing_rw_mutex>("Queuing RW Mutex");
59     TestTryAcquire<oneapi::tbb::speculative_spin_mutex>("Speculative Spin Mutex");
60     TestTryAcquire<oneapi::tbb::speculative_spin_rw_mutex>("Speculative Spin RW Mutex");
61     TestTryAcquire<oneapi::tbb::null_mutex>("Null Mutex");
62 }
63 
64 //! Testing ReaderWriterMutex requirements
65 //! \brief \ref interface \ref requirement
66 TEST_CASE("Shared mutexes (reader/writer) test") {
67     // General reader writer capabilities + upgrade/downgrade
68     TestReaderWriterLock<oneapi::tbb::spin_rw_mutex>("Spin RW Mutex");
69     TestReaderWriterLock<oneapi::tbb::queuing_rw_mutex>("Queuing RW Mutex");
70     TestReaderWriterLock<oneapi::tbb::speculative_spin_rw_mutex>("Speculative Spin RW Mutex");
71     TestNullRWMutex<oneapi::tbb::null_rw_mutex>("Null RW Mutex");
72     // Single threaded read/write try_acquire operations
73     TestTryAcquireReader<oneapi::tbb::spin_rw_mutex>("Spin RW Mutex");
74     TestTryAcquireReader<oneapi::tbb::queuing_rw_mutex>("Queuing RW Mutex");
75     TestRWStateMultipleChange<oneapi::tbb::spin_rw_mutex>("Spin RW Mutex");
76     TestRWStateMultipleChange<oneapi::tbb::queuing_rw_mutex>("Queuing RW Mutex");
77     TestTryAcquireReader<oneapi::tbb::speculative_spin_rw_mutex>("Speculative Spin RW Mutex");
78     TestRWStateMultipleChange<oneapi::tbb::speculative_spin_rw_mutex>("Speculative Spin RW Mutex");
79     TestTryAcquireReader<oneapi::tbb::null_rw_mutex>("Null RW Mutex");
80 }
81 
82 //! Testing ISO C++ Mutex and Shared Mutex requirements.
83 //! Compatibility with the standard
84 //! \brief \ref interface \ref requirement
85 TEST_CASE("ISO interface test") {
86     GeneralTest<TBB_MutexFromISO_Mutex<oneapi::tbb::spin_mutex> >("ISO Spin Mutex");
87     GeneralTest<TBB_MutexFromISO_Mutex<oneapi::tbb::spin_rw_mutex> >("ISO Spin RW Mutex");
88     TestTryAcquire<TBB_MutexFromISO_Mutex<oneapi::tbb::spin_mutex> >("ISO Spin Mutex");
89     TestTryAcquire<TBB_MutexFromISO_Mutex<oneapi::tbb::spin_rw_mutex> >("ISO Spin RW Mutex");
90     TestTryAcquireReader<TBB_MutexFromISO_Mutex<oneapi::tbb::spin_rw_mutex> >("ISO Spin RW Mutex");
91     TestReaderWriterLock<TBB_MutexFromISO_Mutex<oneapi::tbb::spin_rw_mutex> >("ISO Spin RW Mutex");
92 }
93