/
MicroSpinLock.h
154 lines (130 loc) · 4.81 KB
/
MicroSpinLock.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* 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
*
* http://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.
*/
/*
* N.B. You most likely do _not_ want to use MicroSpinLock or any
* other kind of spinlock. Consider MicroLock instead.
*
* In short, spinlocks in preemptive multi-tasking operating systems
* have serious problems and fast mutexes like std::mutex are almost
* certainly the better choice, because letting the OS scheduler put a
* thread to sleep is better for system responsiveness and throughput
* than wasting a timeslice repeatedly querying a lock held by a
* thread that's blocked, and you can't prevent userspace
* programs blocking.
*
* Spinlocks in an operating system kernel make much more sense than
* they do in userspace.
*/
#pragma once
#include <array>
#include <atomic>
#include <cassert>
#include <cstdint>
#include <mutex>
#include <type_traits>
#include <folly/Portability.h>
#include <folly/lang/Align.h>
#include <folly/synchronization/SanitizeThread.h>
#include <folly/synchronization/detail/Sleeper.h>
namespace folly {
/*
* A really, *really* small spinlock for fine-grained locking of lots
* of teeny-tiny data.
*
* Zero initializing these is guaranteed to be as good as calling
* init(), since the free state is guaranteed to be all-bits zero.
*
* This class should be kept a POD, so we can used it in other packed
* structs (gcc does not allow __attribute__((__packed__)) on structs that
* contain non-POD data). This means avoid adding a constructor, or
* making some members private, etc.
*/
struct MicroSpinLock {
enum { FREE = 0, LOCKED = 1 };
// lock_ can't be std::atomic<> to preserve POD-ness.
uint8_t lock_;
// Initialize this MSL. It is unnecessary to call this if you
// zero-initialize the MicroSpinLock.
void init() noexcept { payload()->store(FREE); }
bool try_lock() noexcept {
bool ret = xchg(LOCKED) == FREE;
annotate_rwlock_try_acquired(
this, annotate_rwlock_level::wrlock, ret, __FILE__, __LINE__);
return ret;
}
void lock() noexcept {
detail::Sleeper sleeper;
while (xchg(LOCKED) != FREE) {
do {
sleeper.wait();
} while (payload()->load(std::memory_order_relaxed) == LOCKED);
}
assert(payload()->load() == LOCKED);
annotate_rwlock_acquired(
this, annotate_rwlock_level::wrlock, __FILE__, __LINE__);
}
void unlock() noexcept {
assert(payload()->load() == LOCKED);
annotate_rwlock_released(
this, annotate_rwlock_level::wrlock, __FILE__, __LINE__);
payload()->store(FREE, std::memory_order_release);
}
private:
std::atomic<uint8_t>* payload() noexcept {
return reinterpret_cast<std::atomic<uint8_t>*>(&this->lock_);
}
uint8_t xchg(uint8_t newVal) noexcept {
return std::atomic_exchange_explicit(
payload(), newVal, std::memory_order_acq_rel);
}
};
static_assert(
std::is_standard_layout<MicroSpinLock>::value &&
std::is_trivial<MicroSpinLock>::value,
"MicroSpinLock must be kept a POD type.");
//////////////////////////////////////////////////////////////////////
/**
* Array of spinlocks where each one is padded to prevent false sharing.
* Useful for shard-based locking implementations in environments where
* contention is unlikely.
*/
template <class T, size_t N>
struct alignas(max_align_v) SpinLockArray {
T& operator[](size_t i) noexcept { return data_[i].lock; }
const T& operator[](size_t i) const noexcept { return data_[i].lock; }
constexpr size_t size() const noexcept { return N; }
private:
struct PaddedSpinLock {
PaddedSpinLock() : lock() {}
T lock;
char padding[hardware_destructive_interference_size - sizeof(T)];
};
static_assert(
sizeof(PaddedSpinLock) == hardware_destructive_interference_size,
"Invalid size of PaddedSpinLock");
// Check if T can theoretically cross a cache line.
static_assert(
max_align_v > 0 &&
hardware_destructive_interference_size % max_align_v == 0 &&
sizeof(T) <= max_align_v,
"T can cross cache line boundaries");
char padding_[hardware_destructive_interference_size];
std::array<PaddedSpinLock, N> data_;
};
//////////////////////////////////////////////////////////////////////
typedef std::lock_guard<MicroSpinLock> MSLGuard;
//////////////////////////////////////////////////////////////////////
} // namespace folly