-
Notifications
You must be signed in to change notification settings - Fork 91
/
lock.go
139 lines (112 loc) · 3.26 KB
/
lock.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
/*
Copyright 2022 The Katalyst 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
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.
*/
/*
native locking functions in package-sync doesn't contain deadlock-detecting logic,
to avoid deadlock during runtime processes, it's advised to use locking functions
here to provide deadlock-detecting when it exceeds timeout
*/
package syntax
import (
"runtime"
"sync"
"time"
"k8s.io/klog/v2"
"github.com/kubewharf/katalyst-core/pkg/metrics"
)
const defaultDeadlockPeriod = time.Minute * 5
const (
metricsNameLockTimeout = "lock_timeout"
metricsNameRLockTimeout = "rlock_timeout"
)
type Mutex struct {
sync.Mutex
emitter metrics.MetricEmitter
deadlock time.Duration
}
func NewMutex(emitter metrics.MetricEmitter) *Mutex {
return &Mutex{
emitter: emitter,
deadlock: defaultDeadlockPeriod,
}
}
func NewMutexWithPeriod(emitter metrics.MetricEmitter, period time.Duration) *Mutex {
return &Mutex{
emitter: emitter,
deadlock: period,
}
}
func (m *Mutex) Lock() int {
return runWithTimeoutDetect(m.deadlock, m.Mutex.Lock, func() {
_ = m.emitter.StoreInt64(metricsNameLockTimeout, 1, metrics.MetricTypeNameRaw)
klog.Infof("potential deadlock Mutex.Lock for caller: %v", getCaller())
})
}
func (m *Mutex) Unlock() { m.Mutex.Unlock() }
type RWMutex struct {
sync.RWMutex
emitter metrics.MetricEmitter
deadlock time.Duration
}
func NewRWMutex(emitter metrics.MetricEmitter) *RWMutex {
return &RWMutex{
emitter: emitter,
deadlock: defaultDeadlockPeriod,
}
}
func NewRWMutexWithPeriod(emitter metrics.MetricEmitter, period time.Duration) *RWMutex {
return &RWMutex{
emitter: emitter,
deadlock: period,
}
}
func (rm *RWMutex) Lock() int {
return runWithTimeoutDetect(rm.deadlock, rm.RWMutex.Lock, func() {
_ = rm.emitter.StoreInt64(metricsNameLockTimeout, 1, metrics.MetricTypeNameRaw)
klog.Infof("potential deadlock RWMutex.Lock for caller: %v", getCaller())
})
}
func (rm *RWMutex) RLock() int {
return runWithTimeoutDetect(rm.deadlock, rm.RWMutex.RLock, func() {
_ = rm.emitter.StoreInt64(metricsNameRLockTimeout, 1, metrics.MetricTypeNameRaw)
klog.Infof("potential deadlock RWMutex.RLock for caller: %v", getCaller())
})
}
func (rm *RWMutex) Unlock() { rm.RWMutex.Unlock() }
func (rm *RWMutex) RUnlock() { rm.RWMutex.RUnlock() }
// getCaller returns the caller info for logging
func getCaller() string {
pc, _, _, ok := runtime.Caller(4)
if !ok {
return ""
}
return runtime.FuncForPC(pc).Name()
}
// runWithTimeoutDetect runs the given command, and exec the onTimeout function if timeout
func runWithTimeoutDetect(timeout time.Duration, command, onTimeout func()) int {
c := make(chan interface{})
cnt := 0
go func() {
for {
select {
case <-c:
return
case <-time.After(timeout):
onTimeout()
cnt++
}
}
}()
command()
c <- struct{}{}
return cnt
}