Skip to content

Commit

Permalink
Add internal interface to determine if a SpinLock is cooperative.
Browse files Browse the repository at this point in the history
Some use cases of SpinLock need to verify that it is configured for
non-cooperative scheduling.

PiperOrigin-RevId: 575278400
Change-Id: Ic49f57a989a3f7f67e346a1ec545f4cd5b94f849
  • Loading branch information
ckennelly authored and copybara-github committed Oct 20, 2023
1 parent 3bc08b8 commit 133360c
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
13 changes: 13 additions & 0 deletions absl/base/internal/spinlock.h
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,14 @@
#include "absl/base/internal/tsan_mutex_interface.h"
#include "absl/base/thread_annotations.h"

namespace tcmalloc {
namespace tcmalloc_internal {

class AllocationGuardSpinLockHolder;

} // namespace tcmalloc_internal
} // namespace tcmalloc

namespace absl {
ABSL_NAMESPACE_BEGIN
namespace base_internal {
Expand Down Expand Up @@ -137,6 +145,7 @@ class ABSL_LOCKABLE SpinLock {

// Provide access to protected method above. Use for testing only.
friend struct SpinLockTest;
friend class tcmalloc::tcmalloc_internal::AllocationGuardSpinLockHolder;

private:
// lockword_ is used to store the following:
Expand Down Expand Up @@ -171,6 +180,10 @@ class ABSL_LOCKABLE SpinLock {
return scheduling_mode == base_internal::SCHEDULE_COOPERATIVE_AND_KERNEL;
}

bool IsCooperative() const {
return lockword_.load(std::memory_order_relaxed) & kSpinLockCooperative;
}

uint32_t TryLockInternal(uint32_t lock_value, uint32_t wait_cycles);
void SlowLock() ABSL_ATTRIBUTE_COLD;
void SlowUnlock(uint32_t lock_value) ABSL_ATTRIBUTE_COLD;
Expand Down
13 changes: 13 additions & 0 deletions absl/base/spinlock_test_common.cc
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ struct SpinLockTest {
static int64_t DecodeWaitCycles(uint32_t lock_value) {
return SpinLock::DecodeWaitCycles(lock_value);
}

static bool IsCooperative(const SpinLock& l) { return l.IsCooperative(); }
};

namespace {
Expand Down Expand Up @@ -266,6 +268,17 @@ TEST(SpinLockWithThreads, DoesNotDeadlock) {
base_internal::NumCPUs() * 2);
}

TEST(SpinLockTest, IsCooperative) {
SpinLock default_constructor;
EXPECT_TRUE(SpinLockTest::IsCooperative(default_constructor));

SpinLock cooperative(base_internal::SCHEDULE_COOPERATIVE_AND_KERNEL);
EXPECT_TRUE(SpinLockTest::IsCooperative(cooperative));

SpinLock kernel_only(base_internal::SCHEDULE_KERNEL_ONLY);
EXPECT_FALSE(SpinLockTest::IsCooperative(kernel_only));
}

} // namespace
} // namespace base_internal
ABSL_NAMESPACE_END
Expand Down

0 comments on commit 133360c

Please sign in to comment.