third_party.pigweed.src/pw_sync/interrupt_spin_lock_facade_test.cc
Ewout van Bekkum cc9ef83673 pw_sync: add lock safety annotations for C++ clang usage
Adds clang thread safety annotations to the interrupt spin lock for
C++ usage. Note that this is only checked when compiling with clang.

C APIs explicitly escape the thread safety annotations.

Change-Id: Ic829afd41b3978c507ebe294d34e1e0dc03865b4
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/40241
Reviewed-by: Keir Mierle <keir@google.com>
Reviewed-by: Wyatt Hepler <hepler@google.com>
Pigweed-Auto-Submit: Ewout van Bekkum <ewout@google.com>
Commit-Queue: Auto-Submit <auto-submit@pigweed.google.com.iam.gserviceaccount.com>
2021-04-12 16:53:37 +00:00

77 lines
2.5 KiB
C++

// Copyright 2020 The Pigweed Authors
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.
#include "gtest/gtest.h"
#include "pw_sync/interrupt_spin_lock.h"
namespace pw::sync {
namespace {
extern "C" {
// Functions defined in interrupt_spin_lock_facade_test_c.c which call the API
// from C.
void pw_sync_InterruptSpinLock_CallLock(
pw_sync_InterruptSpinLock* interrupt_spin_lock);
bool pw_sync_InterruptSpinLock_CallTryLock(
pw_sync_InterruptSpinLock* interrupt_spin_lock);
void pw_sync_InterruptSpinLock_CallUnlock(
pw_sync_InterruptSpinLock* interrupt_spin_lock);
} // extern "C"
TEST(InterruptSpinLock, LockUnlock) {
pw::sync::InterruptSpinLock interrupt_spin_lock;
interrupt_spin_lock.lock();
interrupt_spin_lock.unlock();
}
// TODO(pwbug/291): Add real concurrency tests once we have pw::thread.
InterruptSpinLock static_interrupt_spin_lock;
TEST(InterruptSpinLock, LockUnlockStatic) {
static_interrupt_spin_lock.lock();
// Ensure it fails to lock when already held.
EXPECT_FALSE(static_interrupt_spin_lock.try_lock());
static_interrupt_spin_lock.unlock();
}
TEST(InterruptSpinLock, TryLockUnlock) {
pw::sync::InterruptSpinLock interrupt_spin_lock;
const bool locked = interrupt_spin_lock.try_lock();
EXPECT_TRUE(locked);
if (locked) {
// Ensure it fails to lock when already held.
EXPECT_FALSE(interrupt_spin_lock.try_lock());
interrupt_spin_lock.unlock();
}
}
TEST(InterruptSpinLock, LockUnlockInC) {
pw::sync::InterruptSpinLock interrupt_spin_lock;
pw_sync_InterruptSpinLock_CallLock(&interrupt_spin_lock);
pw_sync_InterruptSpinLock_CallUnlock(&interrupt_spin_lock);
}
TEST(InterruptSpinLock, TryLockUnlockInC) {
pw::sync::InterruptSpinLock interrupt_spin_lock;
ASSERT_TRUE(pw_sync_InterruptSpinLock_CallTryLock(&interrupt_spin_lock));
// Ensure it fails to lock when already held.
EXPECT_FALSE(pw_sync_InterruptSpinLock_CallTryLock(&interrupt_spin_lock));
pw_sync_InterruptSpinLock_CallUnlock(&interrupt_spin_lock);
}
} // namespace
} // namespace pw::sync