1 // Copyright 2020 The Pigweed Authors
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License"); you may not
4 // use this file except in compliance with the License. You may obtain a copy of
5 // the License at
6 //
7 // https://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11 // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12 // License for the specific language governing permissions and limitations under
13 // the License.
14
15 #include "gtest/gtest.h"
16 #include "pw_sync/interrupt_spin_lock.h"
17
18 namespace pw::sync {
19 namespace {
20
21 extern "C" {
22
23 // Functions defined in interrupt_spin_lock_facade_test_c.c which call the API
24 // from C.
25 void pw_sync_InterruptSpinLock_CallLock(
26 pw_sync_InterruptSpinLock* interrupt_spin_lock);
27 bool pw_sync_InterruptSpinLock_CallTryLock(
28 pw_sync_InterruptSpinLock* interrupt_spin_lock);
29 void pw_sync_InterruptSpinLock_CallUnlock(
30 pw_sync_InterruptSpinLock* interrupt_spin_lock);
31
32 } // extern "C"
33
TEST(InterruptSpinLock,LockUnlock)34 TEST(InterruptSpinLock, LockUnlock) {
35 pw::sync::InterruptSpinLock interrupt_spin_lock;
36 interrupt_spin_lock.lock();
37 interrupt_spin_lock.unlock();
38 }
39
40 // TODO(pwbug/291): Add real concurrency tests once we have pw::thread on SMP
41 // systems given that uniprocessor systems cannot fail to acquire an ISL.
42
43 InterruptSpinLock static_interrupt_spin_lock;
TEST(InterruptSpinLock,LockUnlockStatic)44 TEST(InterruptSpinLock, LockUnlockStatic) {
45 static_interrupt_spin_lock.lock();
46 // TODO(pwbug/291): Ensure other cores fail to lock when its locked.
47 // EXPECT_FALSE(static_interrupt_spin_lock.try_lock());
48 static_interrupt_spin_lock.unlock();
49 }
50
TEST(InterruptSpinLock,TryLockUnlock)51 TEST(InterruptSpinLock, TryLockUnlock) {
52 pw::sync::InterruptSpinLock interrupt_spin_lock;
53 const bool locked = interrupt_spin_lock.try_lock();
54 EXPECT_TRUE(locked);
55 if (locked) {
56 // TODO(pwbug/291): Ensure other cores fail to lock when its locked.
57 // EXPECT_FALSE(interrupt_spin_lock.try_lock());
58 interrupt_spin_lock.unlock();
59 }
60 }
61
TEST(VirtualInterruptSpinLock,LockUnlock)62 TEST(VirtualInterruptSpinLock, LockUnlock) {
63 pw::sync::VirtualInterruptSpinLock interrupt_spin_lock;
64 interrupt_spin_lock.lock();
65 // TODO(pwbug/291): Ensure other cores fail to lock when its locked.
66 // EXPECT_FALSE(interrupt_spin_lock.try_lock());
67 interrupt_spin_lock.unlock();
68 }
69
70 VirtualInterruptSpinLock static_virtual_interrupt_spin_lock;
TEST(VirtualInterruptSpinLock,LockUnlockStatic)71 TEST(VirtualInterruptSpinLock, LockUnlockStatic) {
72 static_virtual_interrupt_spin_lock.lock();
73 // TODO(pwbug/291): Ensure other cores fail to lock when its locked.
74 // EXPECT_FALSE(static_virtual_interrupt_spin_lock.try_lock());
75 static_virtual_interrupt_spin_lock.unlock();
76 }
77
TEST(InterruptSpinLock,LockUnlockInC)78 TEST(InterruptSpinLock, LockUnlockInC) {
79 pw::sync::InterruptSpinLock interrupt_spin_lock;
80 pw_sync_InterruptSpinLock_CallLock(&interrupt_spin_lock);
81 pw_sync_InterruptSpinLock_CallUnlock(&interrupt_spin_lock);
82 }
83
TEST(InterruptSpinLock,TryLockUnlockInC)84 TEST(InterruptSpinLock, TryLockUnlockInC) {
85 pw::sync::InterruptSpinLock interrupt_spin_lock;
86 ASSERT_TRUE(pw_sync_InterruptSpinLock_CallTryLock(&interrupt_spin_lock));
87 // TODO(pwbug/291): Ensure other cores fail to lock when its locked.
88 // EXPECT_FALSE(pw_sync_InterruptSpinLock_CallTryLock(&interrupt_spin_lock));
89 pw_sync_InterruptSpinLock_CallUnlock(&interrupt_spin_lock);
90 }
91
92 } // namespace
93 } // namespace pw::sync
94