README
¶
Preface
Based on https://github.com/sasha-s/go-deadlock.
Changes from that package:
- Uses build tags to eliminate all overhead when not in use
- Only supports Go 1.16+
- Simplifies the code and improves code coverage
- Tests now pass race checker
- This package drops the dummy implementations for types other than Mutex and RWMutex, just use sync for those
- Adds
deadlock.Enabledconstant - Diagnostic output matches
-racestyle
Installation
go get github.com/linkdata/deadlock
Usage
The package enables itself when either the 'deadlock' or 'race' build tag is set, and the
'nodeadlock' build tag is not set. The easiest way is to simply use deadlock.(RW)Mutex and
run or test your code with the race detector.
import "github.com/linkdata/deadlock"
var mu deadlock.Mutex
mu.Lock()
defer mu.Unlock()
var rw deadlock.RWMutex
rw.RLock()
defer rw.RUnlock()
go run -race ./...
Deadlocks
One of the most common sources of deadlocks is inconsistent lock ordering: say, you have two mutexes A and B, and in some goroutines you have
A.Lock() // defer A.Unlock() or similar.
...
B.Lock() // defer B.Unlock() or similar.
And in another goroutine the order of locks is reversed:
B.Lock() // defer B.Unlock() or similar.
...
A.Lock() // defer A.Unlock() or similar.
Another common sources of deadlocks is duplicate take a lock in a goroutine:
A.RLock() // or A.Lock()
...
A.Lock() // or A.RLock()
This does not guarantee a deadlock (maybe the goroutines above can never be running at the same time), but it usually a design flaw at least.
deadlock can detect such cases (unless you cross goroutine boundary - say lock A, then spawn a goroutine, block until it is signals, and lock B inside of the goroutine), even if the deadlock itself happens very infrequently and is painful to reproduce!
Each time deadlock sees a lock attempt for lock B, it records the order A before B, for each lock that is currently being held in the same goroutine, and it prints (and exits the program by default) when it sees the locking order being violated.
In addition, if it sees that we are waiting on a lock for a long time (opts.DeadlockTimeout, 30 seconds by default), it reports a potential deadlock, also printing the stacktrace for a goroutine that is currently holding the lock we are desperately trying to grab.
Sample output
Inconsistent lock ordering:
POTENTIAL DEADLOCK: Inconsistent locking:
in one goroutine: happened before
github.com/linkdata/deadlock.(*DeadlockRWMutex).Lock()
/home/user/src/deadlock/deadlock.go:55 +0xa8
github.com/linkdata/deadlock.TestLockOrder.func2()
/home/user/src/deadlock/deadlock_test.go:120 +0x34
happened after
github.com/linkdata/deadlock.(*DeadlockMutex).Lock()
/home/user/src/deadlock/deadlock.go:26 +0x11a
github.com/linkdata/deadlock.TestLockOrder.func2()
/home/user/src/deadlock/deadlock_test.go:121 +0xa9
in another goroutine: happened before
github.com/linkdata/deadlock.(*DeadlockMutex).Lock()
/home/user/src/deadlock/deadlock.go:26 +0xa5
github.com/linkdata/deadlock.TestLockOrder.func3()
/home/user/src/deadlock/deadlock_test.go:129 +0x34
happened after
github.com/linkdata/deadlock.(*DeadlockRWMutex).RLock()
/home/user/src/deadlock/deadlock.go:74 +0x11a
github.com/linkdata/deadlock.TestLockOrder.func3()
/home/user/src/deadlock/deadlock_test.go:130 +0xa6
Waiting for a lock for a long time:
POTENTIAL DEADLOCK:
goroutine 624 have been trying to lock 0xc0009a20d8 for more than 20ms:
github.com/linkdata/deadlock.(*DeadlockMutex).Lock()
/home/user/src/deadlock/deadlock.go:26 +0x113
github.com/linkdata/deadlock.TestHardDeadlock.func2()
/home/user/src/deadlock/deadlock_test.go:154 +0x92
goroutine 622 previously locked it from:
github.com/linkdata/deadlock.(*DeadlockMutex).Lock()
/home/user/src/deadlock/deadlock.go:26 +0x164
github.com/linkdata/deadlock.TestHardDeadlock()
/home/user/src/deadlock/deadlock_test.go:150 +0xe6
goroutine 622 current stack:
goroutine 622 [sleep]:
time.Sleep(0xf4240)
/usr/local/go/src/runtime/time.go:195 +0x135
github.com/linkdata/deadlock.spinWait(0xc000988340, 0x0?, 0x1)
/home/user/src/deadlock/deadlock_test.go:25 +0x3e
github.com/linkdata/deadlock.TestHardDeadlock(0xc000988340)
/home/user/src/deadlock/deadlock_test.go:157 +0x265
testing.tRunner(0xc000988340, 0x6187e8)
/usr/local/go/src/testing/testing.go:1576 +0x217
created by testing.(*T).Run
/usr/local/go/src/testing/testing.go:1629 +0x806
Configuring
Have a look at Opts.
Opts.DeadlockTimeout: blocking on mutex for longer than DeadlockTimeout is considered a deadlock. ignored if negativeOpts.OnPotentialDeadlock: callback for then deadlock is detectedOpts.MaxMapSize: size of happens before // happens after table, can also disable order based deadlock detectionOpts.PrintAllCurrentGoroutines: dump stacktraces of all goroutines when inconsistent locking is detected, verboseOpts.LogBuf: where to write deadlock info/stacktraces
Documentation
¶
Index ¶
Constants ¶
const Enabled = false
Enabled is true if deadlock checking is enabled
Variables ¶
var Opts = Options{ DeadlockTimeout: time.Second * 30, MaxMapSize: 1024 * 64, LogBuf: os.Stderr, }
Opts control how deadlock detection behaves. To safely read or change options during runtime, use Opts.ReadLocked() and Opts.WriteLocked()
Functions ¶
This section is empty.
Types ¶
type DeadlockMutex ¶
type DeadlockMutex struct {
// contains filtered or unexported fields
}
A DeadlockMutex is a drop-in replacement for sync.Mutex, except it does not support TryLock().
func (*DeadlockMutex) Lock ¶
func (m *DeadlockMutex) Lock()
Lock locks the mutex. If the lock is already in use, the calling goroutine blocks until the mutex is available.
Logs potential deadlocks to Opts.LogBuf, calling Opts.OnPotentialDeadlock on each occasion.
func (*DeadlockMutex) Unlock ¶
func (m *DeadlockMutex) Unlock()
Unlock unlocks the mutex. It is a run-time error if m is not locked on entry to Unlock.
A locked Mutex is not associated with a particular goroutine. It is allowed for one goroutine to lock a Mutex and then arrange for another goroutine to unlock it.
type DeadlockRWMutex ¶
type DeadlockRWMutex struct {
// contains filtered or unexported fields
}
An DeadlockRWMutex is a drop-in replacement for sync.RWMutex, except it does not support TryLock().
func (*DeadlockRWMutex) Lock ¶
func (m *DeadlockRWMutex) Lock()
Lock locks rw for writing. If the lock is already locked for reading or writing, Lock blocks until the lock is available. To ensure that the lock eventually becomes available, a blocked Lock call excludes new readers from acquiring the lock.
Logs potential deadlocks to Opts.LogBuf, calling Opts.OnPotentialDeadlock on each occasion.
func (*DeadlockRWMutex) RLock ¶
func (m *DeadlockRWMutex) RLock()
RLock locks the mutex for reading.
Logs potential deadlocks to Opts.LogBuf, calling Opts.OnPotentialDeadlock on each occasion.
func (*DeadlockRWMutex) RLocker ¶
func (m *DeadlockRWMutex) RLocker() sync.Locker
RLocker returns a Locker interface that implements the Lock and Unlock methods by calling RLock and RUnlock.
func (*DeadlockRWMutex) RUnlock ¶
func (m *DeadlockRWMutex) RUnlock()
RUnlock undoes a single RLock call; it does not affect other simultaneous readers. It is a run-time error if rw is not locked for reading on entry to RUnlock.
func (*DeadlockRWMutex) Unlock ¶
func (m *DeadlockRWMutex) Unlock()
Unlock unlocks the mutex for writing. It is a run-time error if rw is not locked for writing on entry to Unlock.
As with Mutexes, a locked RWMutex is not associated with a particular goroutine. One goroutine may RLock (Lock) an RWMutex and then arrange for another goroutine to RUnlock (Unlock) it.
type Options ¶
type Options struct {
// Waiting for a lock for longer than DeadlockTimeout is considered a deadlock.
// Ignored if DeadlockTimeout <= 0.
DeadlockTimeout time.Duration
// OnPotentialDeadlock is called each time a potential deadlock is detected -- either based on
// lock order or on lock wait time.
OnPotentialDeadlock func()
// Sets the maximum size of the map that tracks lock ordering.
// Setting this to zero or lower disables tracking of lock order.
MaxMapSize int
// Will dump stacktraces of all goroutines when inconsistent locking is detected.
PrintAllCurrentGoroutines bool
// Will print deadlock info to log buffer.
LogBuf io.Writer
}
func (*Options) PotentialDeadlock ¶ added in v0.0.2
func (opts *Options) PotentialDeadlock()
PotentialDeadlock calls OnPotentialDeadlock if it is set, or panics if not.
func (*Options) ReadLocked ¶
func (opts *Options) ReadLocked(fn func())
ReadLocked calls the given function with Opts locked for reading.
func (*Options) WriteLocked ¶
func (opts *Options) WriteLocked(fn func())
WriteLocked calls the given function with Opts locked for writing.
Source Files