-
Notifications
You must be signed in to change notification settings - Fork 0
/
sync.go
298 lines (254 loc) · 6.16 KB
/
sync.go
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
// Copyright (C) 2015 The Syncthing Authors.
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
// You can obtain one at https://mozilla.org/MPL/2.0/.
package sync
import (
"fmt"
"path/filepath"
"runtime"
"strconv"
"strings"
"sync"
"sync/atomic"
"time"
"github.com/sasha-s/go-deadlock"
)
var timeNow = time.Now
type Mutex interface {
Lock()
Unlock()
}
type RWMutex interface {
Mutex
RLock()
RUnlock()
}
type WaitGroup interface {
Add(int)
Done()
Wait()
}
func NewMutex() Mutex {
if useDeadlock {
return &deadlock.Mutex{}
}
if debug {
mutex := &loggedMutex{}
mutex.holder.Store(holder{})
return mutex
}
return &sync.Mutex{}
}
func NewRWMutex() RWMutex {
if useDeadlock {
return &deadlock.RWMutex{}
}
if debug {
mutex := &loggedRWMutex{
readHolders: make(map[int][]holder),
unlockers: make(chan holder, 1024),
}
mutex.holder.Store(holder{})
return mutex
}
return &sync.RWMutex{}
}
func NewWaitGroup() WaitGroup {
if debug {
return &loggedWaitGroup{}
}
return &sync.WaitGroup{}
}
type holder struct {
at string
time time.Time
goid int
}
func (h holder) String() string {
if h.at == "" {
return "not held"
}
return fmt.Sprintf("at %s goid: %d for %s", h.at, h.goid, timeNow().Sub(h.time))
}
type loggedMutex struct {
sync.Mutex
holder atomic.Value
}
func (m *loggedMutex) Lock() {
m.Mutex.Lock()
m.holder.Store(getHolder())
}
func (m *loggedMutex) Unlock() {
currentHolder := m.holder.Load().(holder)
duration := timeNow().Sub(currentHolder.time)
if duration >= threshold {
l.Debugf("Mutex held for %v. Locked at %s unlocked at %s", duration, currentHolder.at, getHolder().at)
}
m.holder.Store(holder{})
m.Mutex.Unlock()
}
func (m *loggedMutex) Holders() string {
return m.holder.Load().(holder).String()
}
type loggedRWMutex struct {
sync.RWMutex
holder atomic.Value
readHolders map[int][]holder
readHoldersMut sync.Mutex
logUnlockers int32
unlockers chan holder
}
func (m *loggedRWMutex) Lock() {
start := timeNow()
atomic.StoreInt32(&m.logUnlockers, 1)
m.RWMutex.Lock()
atomic.StoreInt32(&m.logUnlockers, 0)
holder := getHolder()
m.holder.Store(holder)
duration := holder.time.Sub(start)
if duration > threshold {
var unlockerStrings []string
loop:
for {
select {
case holder := <-m.unlockers:
unlockerStrings = append(unlockerStrings, holder.String())
default:
break loop
}
}
l.Debugf("RWMutex took %v to lock. Locked at %s. RUnlockers while locking:\n%s", duration, holder.at, strings.Join(unlockerStrings, "\n"))
}
}
func (m *loggedRWMutex) Unlock() {
currentHolder := m.holder.Load().(holder)
duration := timeNow().Sub(currentHolder.time)
if duration >= threshold {
l.Debugf("RWMutex held for %v. Locked at %s unlocked at %s", duration, currentHolder.at, getHolder().at)
}
m.holder.Store(holder{})
m.RWMutex.Unlock()
}
func (m *loggedRWMutex) RLock() {
m.RWMutex.RLock()
holder := getHolder()
m.readHoldersMut.Lock()
m.readHolders[holder.goid] = append(m.readHolders[holder.goid], holder)
m.readHoldersMut.Unlock()
}
func (m *loggedRWMutex) RUnlock() {
id := goid()
m.readHoldersMut.Lock()
current := m.readHolders[id]
if len(current) > 0 {
m.readHolders[id] = current[:len(current)-1]
}
m.readHoldersMut.Unlock()
if atomic.LoadInt32(&m.logUnlockers) == 1 {
holder := getHolder()
select {
case m.unlockers <- holder:
default:
l.Debugf("Dropped holder %s as channel full", holder)
}
}
m.RWMutex.RUnlock()
}
func (m *loggedRWMutex) Holders() string {
output := m.holder.Load().(holder).String() + " (writer)"
m.readHoldersMut.Lock()
for _, holders := range m.readHolders {
for _, holder := range holders {
output += "\n" + holder.String() + " (reader)"
}
}
m.readHoldersMut.Unlock()
return output
}
type loggedWaitGroup struct {
sync.WaitGroup
}
func (wg *loggedWaitGroup) Wait() {
start := timeNow()
wg.WaitGroup.Wait()
duration := timeNow().Sub(start)
if duration >= threshold {
l.Debugf("WaitGroup took %v at %s", duration, getHolder())
}
}
func getHolder() holder {
_, file, line, _ := runtime.Caller(2)
file = filepath.Join(filepath.Base(filepath.Dir(file)), filepath.Base(file))
return holder{
at: fmt.Sprintf("%s:%d", file, line),
goid: goid(),
time: timeNow(),
}
}
func goid() int {
var buf [64]byte
n := runtime.Stack(buf[:], false)
idField := strings.Fields(strings.TrimPrefix(string(buf[:n]), "goroutine "))[0]
id, err := strconv.Atoi(idField)
if err != nil {
return -1
}
return id
}
// TimeoutCond is a variant on Cond. It has roughly the same semantics regarding 'L' - it must be held
// both when broadcasting and when calling TimeoutCondWaiter.Wait()
// Call Broadcast() to broadcast to all waiters on the TimeoutCond. Call SetupWait to create a
// TimeoutCondWaiter configured with the given timeout, which can then be used to listen for
// broadcasts.
type TimeoutCond struct {
L sync.Locker
ch chan struct{}
}
// TimeoutCondWaiter is a type allowing a consumer to wait on a TimeoutCond with a timeout. Wait() may be called multiple times,
// and will return true every time that the TimeoutCond is broadcast to. Once the configured timeout
// expires, Wait() will return false.
// Call Stop() to release resources once this TimeoutCondWaiter is no longer needed.
type TimeoutCondWaiter struct {
c *TimeoutCond
timer *time.Timer
}
func NewTimeoutCond(l sync.Locker) *TimeoutCond {
return &TimeoutCond{
L: l,
}
}
func (c *TimeoutCond) Broadcast() {
// ch.L must be locked when calling this function
if c.ch != nil {
close(c.ch)
c.ch = nil
}
}
func (c *TimeoutCond) SetupWait(timeout time.Duration) *TimeoutCondWaiter {
timer := time.NewTimer(timeout)
return &TimeoutCondWaiter{
c: c,
timer: timer,
}
}
func (w *TimeoutCondWaiter) Wait() bool {
// ch.L must be locked when calling this function
// Ensure that the channel exists, since we're going to be waiting on it
if w.c.ch == nil {
w.c.ch = make(chan struct{})
}
ch := w.c.ch
w.c.L.Unlock()
defer w.c.L.Lock()
select {
case <-w.timer.C:
return false
case <-ch:
return true
}
}
func (w *TimeoutCondWaiter) Stop() {
w.timer.Stop()
}