-
Notifications
You must be signed in to change notification settings - Fork 679
/
cyclecallbackgroup.go
430 lines (377 loc) · 10.3 KB
/
cyclecallbackgroup.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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
// _ _
// __ _____ __ ___ ___ __ _| |_ ___
// \ \ /\ / / _ \/ _` \ \ / / |/ _` | __/ _ \
// \ V V / __/ (_| |\ V /| | (_| | || __/
// \_/\_/ \___|\__,_| \_/ |_|\__,_|\__\___|
//
// Copyright © 2016 - 2024 Weaviate B.V. All rights reserved.
//
// CONTACT: hello@weaviate.io
//
package cyclemanager
import (
"context"
"sync"
"time"
enterrors "github.com/weaviate/weaviate/entities/errors"
"github.com/sirupsen/logrus"
)
// Container for multiple callbacks exposing CycleCallback method acting as single callback.
// Can be provided to CycleManager.
type CycleCallbackGroup interface {
// Adds CycleCallback method to container
Register(id string, cycleCallback CycleCallback, options ...RegisterOption) CycleCallbackCtrl
// Method of CycleCallback acting as single callback for all callbacks added to the container
CycleCallback(shouldAbort ShouldAbortCallback) bool
}
type cycleCallbackGroup struct {
sync.Mutex
logger logrus.FieldLogger
customId string
routinesLimit int
nextId uint32
callbackIds []uint32
callbacks map[uint32]*cycleCallbackMeta
}
func NewCallbackGroup(id string, logger logrus.FieldLogger, routinesLimit int) CycleCallbackGroup {
return &cycleCallbackGroup{
logger: logger,
customId: id,
routinesLimit: routinesLimit,
nextId: 0,
callbackIds: []uint32{},
callbacks: map[uint32]*cycleCallbackMeta{},
}
}
func (c *cycleCallbackGroup) Register(id string, cycleCallback CycleCallback, options ...RegisterOption) CycleCallbackCtrl {
c.Lock()
defer c.Unlock()
meta := &cycleCallbackMeta{
customId: id,
cycleCallback: cycleCallback,
active: true,
runningCtx: nil,
started: time.Now(),
intervals: nil,
}
for _, option := range options {
if option != nil {
option(meta)
}
}
callbackId := c.nextId
c.callbackIds = append(c.callbackIds, callbackId)
c.callbacks[callbackId] = meta
c.nextId++
return &cycleCallbackCtrl{
callbackId: callbackId,
callbackCustomId: id,
isActive: c.isActive,
activate: c.activate,
deactivate: c.deactivate,
unregister: c.unregister,
}
}
func (c *cycleCallbackGroup) CycleCallback(shouldAbort ShouldAbortCallback) bool {
if c.routinesLimit <= 1 {
return c.cycleCallbackSequential(shouldAbort)
}
return c.cycleCallbackParallel(shouldAbort, c.routinesLimit)
}
func (c *cycleCallbackGroup) cycleCallbackSequential(shouldAbort ShouldAbortCallback) bool {
anyExecuted := false
i := 0
for {
if shouldAbort() {
break
}
c.Lock()
// no more callbacks left, exit the loop
if i >= len(c.callbackIds) {
c.Unlock()
break
}
callbackId := c.callbackIds[i]
meta, ok := c.callbacks[callbackId]
// callback deleted in the meantime, remove its id
// and proceed to the next one (no "i" increment required)
if !ok {
c.callbackIds = append(c.callbackIds[:i], c.callbackIds[i+1:]...)
c.Unlock()
continue
}
i++
// callback deactivated, proceed to the next one
if !meta.active {
c.Unlock()
continue
}
now := time.Now()
// not enough time passed since previous execution
if meta.intervals != nil && now.Sub(meta.started) < meta.intervals.Get() {
c.Unlock()
continue
}
// callback active, mark as running
runningCtx, cancel := context.WithCancel(context.Background())
meta.runningCtx = runningCtx
meta.started = now
c.Unlock()
func() {
// cancel called in recover, regardless of panic occurred or not
defer c.recover(meta.customId, cancel)
executed := meta.cycleCallback(func() bool {
if shouldAbort() {
return true
}
c.Lock()
defer c.Unlock()
return meta.shouldAbort
})
anyExecuted = executed || anyExecuted
if meta.intervals != nil {
if executed {
meta.intervals.Reset()
} else {
meta.intervals.Advance()
}
}
}()
}
return anyExecuted
}
func (c *cycleCallbackGroup) cycleCallbackParallel(shouldAbort ShouldAbortCallback, routinesLimit int) bool {
anyExecuted := false
ch := make(chan uint32)
lock := new(sync.Mutex)
wg := new(sync.WaitGroup)
wg.Add(routinesLimit)
i := 0
for r := 0; r < routinesLimit; r++ {
f := func() {
for callbackId := range ch {
if shouldAbort() {
// keep reading from channel until it is closed
continue
}
c.Lock()
meta, ok := c.callbacks[callbackId]
// callback missing or deactivated, proceed to the next one
if !ok || !meta.active {
c.Unlock()
continue
}
now := time.Now()
// not enough time passed since previous execution
if meta.intervals != nil && now.Sub(meta.started) < meta.intervals.Get() {
c.Unlock()
continue
}
// callback active, mark as running
runningCtx, cancel := context.WithCancel(context.Background())
meta.runningCtx = runningCtx
meta.started = now
c.Unlock()
func() {
// cancel called in recover, regardless of panic occurred or not
defer c.recover(meta.customId, cancel)
executed := meta.cycleCallback(func() bool {
if shouldAbort() {
return true
}
c.Lock()
defer c.Unlock()
return meta.shouldAbort
})
if executed {
lock.Lock()
anyExecuted = true
lock.Unlock()
}
if meta.intervals != nil {
if executed {
meta.intervals.Reset()
} else {
meta.intervals.Advance()
}
}
}()
}
wg.Done()
}
enterrors.GoWrapper(f, c.logger)
}
for {
if shouldAbort() {
close(ch)
break
}
c.Lock()
// no more callbacks left, exit the loop
if i >= len(c.callbackIds) {
c.Unlock()
close(ch)
break
}
callbackId := c.callbackIds[i]
_, ok := c.callbacks[callbackId]
// callback deleted in the meantime, remove its id
// and proceed to the next one (no "i" increment required)
if !ok {
c.callbackIds = append(c.callbackIds[:i], c.callbackIds[i+1:]...)
c.Unlock()
continue
}
c.Unlock()
ch <- callbackId
i++
}
wg.Wait()
return anyExecuted
}
func (c *cycleCallbackGroup) recover(callbackCustomId string, cancel context.CancelFunc) {
if r := recover(); r != nil {
c.logger.WithFields(logrus.Fields{
"action": "cyclemanager",
"callback_id": callbackCustomId,
"callbacks_id": c.customId,
}).Errorf("callback panic: %v", r)
}
cancel()
}
func (c *cycleCallbackGroup) mutateCallback(ctx context.Context, callbackId uint32,
onMetaNotFound func(callbackId uint32) error,
onMetaFound func(callbackId uint32, meta *cycleCallbackMeta, running bool) error,
) error {
if ctx.Err() != nil {
return ctx.Err()
}
for {
// mutate callback in collection only if not running (not yet started of finished)
c.Lock()
meta, ok := c.callbacks[callbackId]
if !ok {
err := onMetaNotFound(callbackId)
c.Unlock()
return err
}
runningCtx := meta.runningCtx
running := runningCtx != nil && runningCtx.Err() == nil
if err := onMetaFound(callbackId, meta, running); err != nil {
c.Unlock()
return err
}
if !running {
c.Unlock()
return nil
}
c.Unlock()
// wait for callback to finish
select {
case <-runningCtx.Done():
// get back to the beginning of the loop to make sure state.runningCtx
// was not changed. If not, loop will finish on runningCtx.Err() != nil check
continue
case <-ctx.Done():
// in case both contexts are ready, but input ctx was selected
// check again running ctx as priority one
if runningCtx.Err() != nil {
// get back to the beginning of the loop to make sure state.runningCtx
// was not changed. If not, loop will finish on runningCtx.Err() != nil check
continue
}
// input ctx expired
return ctx.Err()
}
}
}
func (c *cycleCallbackGroup) unregister(ctx context.Context, callbackId uint32, callbackCustomId string) error {
err := c.mutateCallback(ctx, callbackId,
func(callbackId uint32) error {
return nil
},
func(callbackId uint32, meta *cycleCallbackMeta, running bool) error {
meta.shouldAbort = true
if !running {
meta.active = false
delete(c.callbacks, callbackId)
}
return nil
},
)
return errorUnregisterCallback(callbackCustomId, c.customId, err)
}
func (c *cycleCallbackGroup) deactivate(ctx context.Context, callbackId uint32, callbackCustomId string) error {
err := c.mutateCallback(ctx, callbackId,
func(callbackId uint32) error {
return ErrorCallbackNotFound
},
func(callbackId uint32, meta *cycleCallbackMeta, running bool) error {
meta.shouldAbort = true
if !running {
meta.active = false
}
return nil
},
)
return errorDeactivateCallback(callbackCustomId, c.customId, err)
}
func (c *cycleCallbackGroup) activate(callbackId uint32, callbackCustomId string) error {
c.Lock()
defer c.Unlock()
meta, ok := c.callbacks[callbackId]
if !ok {
return errorActivateCallback(callbackCustomId, c.customId, ErrorCallbackNotFound)
}
meta.shouldAbort = false
meta.active = true
return nil
}
func (c *cycleCallbackGroup) isActive(callbackId uint32, callbackCustomId string) bool {
c.Lock()
defer c.Unlock()
if meta, ok := c.callbacks[callbackId]; ok {
return meta.active
}
return false
}
type cycleCallbackMeta struct {
customId string
cycleCallback CycleCallback
active bool
// indicates whether callback is already running - context active
// or not running (already finished) - context expired
// or not running (not yet started) - context nil
runningCtx context.Context
started time.Time
intervals CycleIntervals
// true if deactivate or unregister were requested to abort callback when running
shouldAbort bool
}
type cycleCallbackGroupNoop struct{}
func NewCallbackGroupNoop() CycleCallbackGroup {
return &cycleCallbackGroupNoop{}
}
func (c *cycleCallbackGroupNoop) Register(id string, cycleCallback CycleCallback, options ...RegisterOption) CycleCallbackCtrl {
return NewCallbackCtrlNoop()
}
func (c *cycleCallbackGroupNoop) CycleCallback(shouldAbort ShouldAbortCallback) bool {
return false
}
type RegisterOption func(meta *cycleCallbackMeta)
func AsInactive() RegisterOption {
return func(meta *cycleCallbackMeta) {
meta.active = false
}
}
func WithIntervals(intervals CycleIntervals) RegisterOption {
if intervals == nil {
return nil
}
return func(meta *cycleCallbackMeta) {
meta.intervals = intervals
// adjusts start time to allow for immediate callback execution without
// having to wait for interval duration to pass
meta.started = time.Now().Add(-intervals.Get())
}
}