forked from iotaledger/hive.go
/
leak_detection.go
322 lines (253 loc) · 12.2 KB
/
leak_detection.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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
package objectstorage
import (
"fmt"
"os"
"strconv"
"sync"
"time"
"go.uber.org/atomic"
"github.com/izuc/zipp.foundation/core/platform"
"github.com/izuc/zipp.foundation/core/reflect"
"github.com/izuc/zipp.foundation/core/typeutils"
)
// region interfaces ///////////////////////////////////////////////////////////////////////////////////////////////////
type LeakDetectionWrapper interface {
CachedObject
Base() *CachedObjectImpl
GetInternalID() int64
SetRetainCallStack(callStack *reflect.CallStack)
GetRetainCallStack() *reflect.CallStack
GetRetainTime() time.Time
SetReleaseCallStack(callStack *reflect.CallStack)
GetReleaseCallStack() *reflect.CallStack
WasReleased() bool
}
// endregion ///////////////////////////////////////////////////////////////////////////////////////////////////////////
// region interface implementations ////////////////////////////////////////////////////////////////////////////////////
type LeakDetectionWrapperImpl struct {
*CachedObjectImpl
internalID int64
released *atomic.Bool
retainTime time.Time
retainCallStack *reflect.CallStack
releaseCallStack *reflect.CallStack
}
// Transaction is a synchronization primitive that executes the callback atomically which means that if multiple
// Transactions are being started from different goroutines, then only one of them can run at the same time.
//
// The identifiers allow to define the scope of the Transaction. Transactions with different scopes can run at the same
// time and act as if they are secured by different mutexes.
//
// It is also possible to provide multiple identifiers and the callback waits until all of them can be acquired at the
// same time. In contrast to normal mutexes where acquiring multiple locks can lead to deadlocks, this method is
// deadlock safe.
//
// Note: It is the equivalent of a mutex.Lock/Unlock.
func (wrappedCachedObject *LeakDetectionWrapperImpl) Transaction(callback func(object StorableObject), identifiers ...interface{}) CachedObject {
wrappedCachedObject.CachedObjectImpl.Transaction(callback, identifiers...)
return wrappedCachedObject
}
// RTransaction is a synchronization primitive that executes the callback together with other RTransactions but never
// together with a normal Transaction.
//
// The identifiers allow to define the scope of the RTransaction. RTransactions with different scopes can run at the
// same time independently of other RTransactions and act as if they are secured by different mutexes.
//
// It is also possible to provide multiple identifiers and the callback waits until all of them can be acquired at the
// same time. In contrast to normal mutexes where acquiring multiple locks can lead to deadlocks, this method is
// deadlock safe.
//
// Note: It is the equivalent of a mutex.RLock/RUnlock.
func (wrappedCachedObject *LeakDetectionWrapperImpl) RTransaction(callback func(object StorableObject), identifiers ...interface{}) CachedObject {
wrappedCachedObject.CachedObjectImpl.RTransaction(callback, identifiers...)
return wrappedCachedObject
}
var (
internalIDCounter = atomic.NewInt64(0)
)
func newLeakDetectionWrapperImpl(cachedObject *CachedObjectImpl) LeakDetectionWrapper {
return &LeakDetectionWrapperImpl{
CachedObjectImpl: cachedObject,
internalID: internalIDCounter.Inc(),
released: atomic.NewBool(false),
}
}
func (wrappedCachedObject *LeakDetectionWrapperImpl) GetInternalID() int64 {
return wrappedCachedObject.internalID
}
func (wrappedCachedObject *LeakDetectionWrapperImpl) Base() *CachedObjectImpl {
return wrappedCachedObject.CachedObjectImpl
}
func (wrappedCachedObject *LeakDetectionWrapperImpl) Consume(consumer func(StorableObject), forceRelease ...bool) bool {
defer wrappedCachedObject.Release(forceRelease...)
if storableObject := wrappedCachedObject.CachedObjectImpl.Get(); !typeutils.IsInterfaceNil(storableObject) && !storableObject.IsDeleted() {
consumer(storableObject)
return true
}
return false
}
func (wrappedCachedObject *LeakDetectionWrapperImpl) Retain() CachedObject {
baseCachedObject := wrappedCachedObject.CachedObjectImpl
baseCachedObject.Retain()
result := wrapCachedObject(baseCachedObject, 0).(*LeakDetectionWrapperImpl)
result.GetRetainCallStack()
return result
}
func (wrappedCachedObject *LeakDetectionWrapperImpl) retain() CachedObject {
baseCachedObject := wrappedCachedObject.CachedObjectImpl
baseCachedObject.retain()
result := wrapCachedObject(baseCachedObject, 0).(*LeakDetectionWrapperImpl)
result.GetRetainCallStack()
return result
}
func (wrappedCachedObject *LeakDetectionWrapperImpl) Release(force ...bool) {
if wrappedCachedObject.released.Swap(true) {
// was already released before
reportCachedObjectClosedTooOften(wrappedCachedObject, reflect.GetExternalCallers("objectstorage", 0))
} else {
baseCachedObject := wrappedCachedObject.CachedObjectImpl
wrappedCachedObject.SetReleaseCallStack(reflect.GetExternalCallers("objectstorage", 0))
registerCachedObjectReleased(wrappedCachedObject, baseCachedObject.objectStorage.options.leakDetectionOptions)
baseCachedObject.Release(force...)
}
}
func (wrappedCachedObject *LeakDetectionWrapperImpl) GetRetainTime() time.Time {
return wrappedCachedObject.retainTime
}
func (wrappedCachedObject *LeakDetectionWrapperImpl) SetRetainCallStack(retainCallStack *reflect.CallStack) {
wrappedCachedObject.retainCallStack = retainCallStack
wrappedCachedObject.retainTime = time.Now()
}
func (wrappedCachedObject *LeakDetectionWrapperImpl) GetRetainCallStack() *reflect.CallStack {
return wrappedCachedObject.retainCallStack
}
func (wrappedCachedObject *LeakDetectionWrapperImpl) SetReleaseCallStack(releaseCallStack *reflect.CallStack) {
wrappedCachedObject.releaseCallStack = releaseCallStack
}
func (wrappedCachedObject *LeakDetectionWrapperImpl) GetReleaseCallStack() *reflect.CallStack {
return wrappedCachedObject.releaseCallStack
}
func (wrappedCachedObject *LeakDetectionWrapperImpl) WasReleased() bool {
return wrappedCachedObject.released.Load()
}
// endregion ///////////////////////////////////////////////////////////////////////////////////////////////////////////
// region public API ///////////////////////////////////////////////////////////////////////////////////////////////////
var (
messageChan = make(chan interface{})
instanceRegister = make(map[string]map[int64]LeakDetectionWrapper)
instanceRegisterMutex = sync.Mutex{}
)
func init() {
go func() {
for {
if message, isString := (<-messageChan).(string); isString {
fmt.Println(message)
} else {
os.Exit(-1)
}
}
}()
}
var LeakDetection = struct {
WrapCachedObject func(cachedObject *CachedObjectImpl, skipCallerFrames int) CachedObject
ReportCachedObjectClosedTooOften func(wrappedCachedObject LeakDetectionWrapper, secondCallStack *reflect.CallStack)
MonitorCachedObjectReleased func(wrappedCachedObject LeakDetectionWrapper, options *LeakDetectionOptions)
RegisterCachedObjectRetained func(wrappedCachedObject LeakDetectionWrapper, options *LeakDetectionOptions)
RegisterCachedObjectReleased func(wrappedCachedObject LeakDetectionWrapper, options *LeakDetectionOptions)
}{
WrapCachedObject: wrapCachedObject,
ReportCachedObjectClosedTooOften: reportCachedObjectClosedTooOften,
MonitorCachedObjectReleased: monitorCachedObjectReleased,
RegisterCachedObjectRetained: registerCachedObjectRetained,
RegisterCachedObjectReleased: registerCachedObjectReleased,
}
func wrapCachedObject(baseCachedObject *CachedObjectImpl, skipCallerFrames int) CachedObject {
if baseCachedObject == nil {
return nil
}
options := baseCachedObject.objectStorage.options
if wrapCachedObject := options.leakDetectionWrapper; wrapCachedObject != nil {
wrappedCachedObject := wrapCachedObject(baseCachedObject)
wrappedCachedObject.SetRetainCallStack(reflect.GetExternalCallers("objectstorage", skipCallerFrames))
registerCachedObjectRetained(wrappedCachedObject, options.leakDetectionOptions)
monitorCachedObjectReleased(wrappedCachedObject, options.leakDetectionOptions)
return wrappedCachedObject
}
return baseCachedObject
}
func reportCachedObjectClosedTooOften(wrappedCachedObject LeakDetectionWrapper, secondCallStack *reflect.CallStack) {
retainCallStack := wrappedCachedObject.GetRetainCallStack()
releaseCallStack := wrappedCachedObject.GetReleaseCallStack()
messageChan <- "[objectstorage::leakkdetection] CachedObject released too often:" + platform.LineBreak +
"\tretained: " + retainCallStack.ExternalEntryPoint() + platform.LineBreak +
"\treleased (1): " + releaseCallStack.ExternalEntryPoint() + platform.LineBreak +
"\treleased (2): " + secondCallStack.ExternalEntryPoint() + platform.LineBreak +
platform.LineBreak +
"\tretain call stack (full):" + platform.LineBreak +
retainCallStack.String() + platform.LineBreak +
"\trelease call stack (1/2 full):" + platform.LineBreak +
releaseCallStack.String() + platform.LineBreak +
"\trelease call stack (2/2 full):" + platform.LineBreak +
secondCallStack.String()
messageChan <- nil
}
func monitorCachedObjectReleased(wrappedCachedObject LeakDetectionWrapper, options *LeakDetectionOptions) {
time.AfterFunc(options.MaxConsumerHoldTime, func() {
if !wrappedCachedObject.WasReleased() {
messageChan <- "[objectstorage::leakkdetection] possible leak detected - CachedObject not released for more than " + strconv.Itoa(int(time.Since(wrappedCachedObject.GetRetainTime()).Seconds())) + " seconds:" + platform.LineBreak +
"\tretained: " + wrappedCachedObject.GetRetainCallStack().ExternalEntryPoint() + platform.LineBreak +
platform.LineBreak +
"\tretain call stack (full):" + platform.LineBreak +
wrappedCachedObject.GetRetainCallStack().String()
monitorCachedObjectReleased(wrappedCachedObject, options)
}
})
}
func registerCachedObjectRetained(wrappedCachedObject LeakDetectionWrapper, options *LeakDetectionOptions) {
stringKey := string(wrappedCachedObject.Base().key)
instanceRegisterMutex.Lock()
instancesByKey, instancesByKeyExists := instanceRegister[stringKey]
if !instancesByKeyExists {
instancesByKey = make(map[int64]LeakDetectionWrapper)
instanceRegister[stringKey] = instancesByKey
}
instancesByKey[wrappedCachedObject.GetInternalID()] = wrappedCachedObject
if len(instancesByKey) > options.MaxConsumersPerObject {
var oldestEntry LeakDetectionWrapper
var oldestTime = time.Now()
for _, wrappedCachedObject := range instancesByKey {
if typeutils.IsInterfaceNil(oldestEntry) || wrappedCachedObject.GetRetainTime().Before(oldestTime) {
oldestEntry = wrappedCachedObject
oldestTime = wrappedCachedObject.GetRetainTime()
}
}
messageChan <- "[objectstorage::leakkdetection] possible leak detected - more than " + strconv.Itoa(options.MaxConsumersPerObject) + " (" + strconv.Itoa(len(instancesByKey)) + ") CachedObjects in cache:" + platform.LineBreak +
"\tretained (oldest): " + oldestEntry.GetRetainCallStack().ExternalEntryPoint() + platform.LineBreak +
"\tretain call stack (oldest full):" + platform.LineBreak +
oldestEntry.GetRetainCallStack().String() + platform.LineBreak +
platform.LineBreak +
"\tretained (current): " + wrappedCachedObject.GetRetainCallStack().ExternalEntryPoint() + platform.LineBreak +
"\tretain call stack (current full):" + platform.LineBreak +
wrappedCachedObject.GetRetainCallStack().String()
}
instanceRegisterMutex.Unlock()
}
func registerCachedObjectReleased(wrappedCachedObject LeakDetectionWrapper, options *LeakDetectionOptions) {
stringKey := string(wrappedCachedObject.Base().key)
instanceRegisterMutex.Lock()
instancesByKey, instancesByKeyExists := instanceRegister[stringKey]
if instancesByKeyExists {
delete(instancesByKey, wrappedCachedObject.GetInternalID())
if len(instancesByKey) == 0 {
delete(instanceRegister, stringKey)
}
}
instanceRegisterMutex.Unlock()
}
// endregion ///////////////////////////////////////////////////////////////////////////////////////////////////////////
// region options //////////////////////////////////////////////////////////////////////////////////////////////////////
type LeakDetectionOptions struct {
MaxConsumersPerObject int
MaxConsumerHoldTime time.Duration
}
// endregion ///////////////////////////////////////////////////////////////////////////////////////////////////////////