forked from keybase/client
-
Notifications
You must be signed in to change notification settings - Fork 0
/
test_stallers.go
556 lines (503 loc) · 18.4 KB
/
test_stallers.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
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
// Copyright 2016 Keybase Inc. All rights reserved.
// Use of this source code is governed by a BSD
// license that can be found in the LICENSE file.
package libkbfs
import (
"math/rand"
"sync"
"time"
"github.com/keybase/client/go/kbfs/data"
"github.com/keybase/client/go/kbfs/kbfsblock"
"github.com/keybase/client/go/kbfs/kbfscrypto"
"github.com/keybase/client/go/kbfs/kbfsmd"
"github.com/keybase/client/go/kbfs/libcontext"
"github.com/keybase/client/go/kbfs/tlf"
"github.com/keybase/client/go/kbfs/tlfhandle"
"github.com/keybase/client/go/protocol/keybase1"
"golang.org/x/net/context"
)
type stallableOp string
// StallableBlockOp defines an Op that is stallable using StallBlockOp
type StallableBlockOp stallableOp
// StallableMDOp defines an Op that is stallable using StallMDOp
type StallableMDOp stallableOp
// stallable Block Ops and MD Ops
const (
StallableBlockGet StallableBlockOp = "Get"
StallableBlockPut StallableBlockOp = "Put"
StallableMDGetForTLF StallableMDOp = "GetForTLF"
StallableMDGetForTLFByTime StallableMDOp = "GetForTLFByTime"
StallableMDGetLatestHandleForTLF StallableMDOp = "GetLatestHandleForTLF"
StallableMDValidateLatestHandleNotFinal StallableMDOp = "ValidateLatestHandleNotFinal"
StallableMDGetUnmergedForTLF StallableMDOp = "GetUnmergedForTLF"
StallableMDGetRange StallableMDOp = "GetRange"
StallableMDAfterGetRange StallableMDOp = "AfterGetRange"
StallableMDGetUnmergedRange StallableMDOp = "GetUnmergedRange"
StallableMDPut StallableMDOp = "Put"
StallableMDAfterPut StallableMDOp = "AfterPut"
StallableMDPutUnmerged StallableMDOp = "PutUnmerged"
StallableMDAfterPutUnmerged StallableMDOp = "AfterPutUnmerged"
StallableMDPruneBranch StallableMDOp = "PruneBranch"
StallableMDResolveBranch StallableMDOp = "ResolveBranch"
)
type stallKeyType uint64
const stallKeyStallEverything stallKeyType = 0
type naïveStallInfo struct {
onStalled <-chan struct{}
unstall chan<- struct{}
oldBlockServer BlockServer
oldMDOps MDOps
oldJournalDelegateMDOps MDOps
}
// NaïveStaller is used to stall certain ops in BlockServer or
// MDOps. Unlike StallBlockOp and StallMDOp which provides a way to
// precisely control which particular op is stalled by passing in ctx
// with corresponding stallKey, NaïveStaller simply stalls all
// instances of specified op.
type NaïveStaller struct {
config Config
mu sync.RWMutex
blockOpsStalls map[StallableBlockOp]*naïveStallInfo
mdOpsStalls map[StallableMDOp]*naïveStallInfo
// We are only supporting stalling one Op per kind at a time for now. If in
// the future a dsl test needs to stall different Ops, please see
// https://github.com/keybase/client/go/kbfs/pull/163 for an implementation.
blockStalled bool
mdStalled bool
}
// NewNaïveStaller returns a new NaïveStaller
func NewNaïveStaller(config Config) *NaïveStaller {
return &NaïveStaller{
config: config,
blockOpsStalls: make(map[StallableBlockOp]*naïveStallInfo),
mdOpsStalls: make(map[StallableMDOp]*naïveStallInfo),
}
}
func (s *NaïveStaller) getNaïveStallInfoForBlockOpOrBust(
stalledOp StallableBlockOp) *naïveStallInfo {
s.mu.RLock()
defer s.mu.RUnlock()
info, ok := s.blockOpsStalls[stalledOp]
if !ok {
panic("naïveStallInfo is not found." +
"This indicates incorrect use of NaïveStaller")
}
return info
}
func (s *NaïveStaller) getNaïveStallInfoForMDOpOrBust(
stalledOp StallableMDOp) *naïveStallInfo {
s.mu.RLock()
defer s.mu.RUnlock()
info, ok := s.mdOpsStalls[stalledOp]
if !ok {
panic("naïveStallInfo is not found." +
"This indicates incorrect use of NaïveStaller")
}
return info
}
// StallBlockOp wraps the internal BlockServer so that all subsequent stalledOp
// will be stalled. This can be undone by calling UndoStallBlockOp.
func (s *NaïveStaller) StallBlockOp(stalledOp StallableBlockOp, maxStalls int) {
s.mu.Lock()
defer s.mu.Unlock()
if s.blockStalled {
panic("incorrect use of NaïveStaller;" +
" only one stalled Op at a time is supported")
}
onStalledCh := make(chan struct{}, maxStalls)
unstallCh := make(chan struct{})
oldBlockServer := s.config.BlockServer()
s.config.SetBlockServer(&stallingBlockServer{
BlockServer: oldBlockServer,
stallOpName: stalledOp,
stallKey: stallKeyStallEverything,
staller: staller{
stalled: onStalledCh,
unstall: unstallCh,
},
})
s.blockStalled = true
s.blockOpsStalls[stalledOp] = &naïveStallInfo{
onStalled: onStalledCh,
unstall: unstallCh,
oldBlockServer: oldBlockServer,
}
}
// StallMDOp wraps the internal MDOps so that all subsequent stalledOp
// will be stalled. This can be undone by calling UndoStallMDOp.
func (s *NaïveStaller) StallMDOp(stalledOp StallableMDOp, maxStalls int,
stallDelegate bool) {
s.mu.Lock()
defer s.mu.Unlock()
if s.mdStalled {
panic("incorrect use of NaïveStaller;" +
" only one stalled Op at a time is supported")
}
onStalledCh := make(chan struct{}, maxStalls)
unstallCh := make(chan struct{})
oldMDOps := s.config.MDOps()
var oldJDelegate MDOps
if jManager, err := GetJournalManager(s.config); err == nil && stallDelegate {
oldJDelegate = jManager.delegateMDOps
// Stall the delegate server as well
jManager.delegateMDOps = &stallingMDOps{
stallOpName: stalledOp,
stallKey: stallKeyStallEverything,
staller: staller{
stalled: onStalledCh,
unstall: unstallCh,
},
delegate: jManager.delegateMDOps,
}
s.config.SetMDOps(jManager.mdOps())
} else {
s.config.SetMDOps(&stallingMDOps{
stallOpName: stalledOp,
stallKey: stallKeyStallEverything,
staller: staller{
stalled: onStalledCh,
unstall: unstallCh,
},
delegate: oldMDOps,
})
}
s.mdStalled = true
s.mdOpsStalls[stalledOp] = &naïveStallInfo{
onStalled: onStalledCh,
unstall: unstallCh,
oldMDOps: oldMDOps,
oldJournalDelegateMDOps: oldJDelegate,
}
}
// WaitForStallBlockOp blocks until stalledOp is stalled. StallBlockOp should
// have been called upon stalledOp, otherwise this would panic.
func (s *NaïveStaller) WaitForStallBlockOp(stalledOp StallableBlockOp) {
<-s.getNaïveStallInfoForBlockOpOrBust(stalledOp).onStalled
}
// WaitForStallMDOp blocks until stalledOp is stalled. StallMDOp should
// have been called upon stalledOp, otherwise this would panic.
func (s *NaïveStaller) WaitForStallMDOp(stalledOp StallableMDOp) {
<-s.getNaïveStallInfoForMDOpOrBust(stalledOp).onStalled
}
// UnstallOneBlockOp unstalls exactly one stalled stalledOp. StallBlockOp
// should have been called upon stalledOp, otherwise this would panic.
func (s *NaïveStaller) UnstallOneBlockOp(stalledOp StallableBlockOp) {
s.getNaïveStallInfoForBlockOpOrBust(stalledOp).unstall <- struct{}{}
}
// UnstallOneMDOp unstalls exactly one stalled stalledOp. StallMDOp
// should have been called upon stalledOp, otherwise this would panic.
func (s *NaïveStaller) UnstallOneMDOp(stalledOp StallableMDOp) {
s.getNaïveStallInfoForMDOpOrBust(stalledOp).unstall <- struct{}{}
}
// UndoStallBlockOp reverts StallBlockOp so that future stalledOp are not
// stalled anymore. It also unstalls any stalled stalledOp. StallBlockOp
// should have been called upon stalledOp, otherwise this would panic.
func (s *NaïveStaller) UndoStallBlockOp(stalledOp StallableBlockOp) {
ns := s.getNaïveStallInfoForBlockOpOrBust(stalledOp)
s.config.SetBlockServer(ns.oldBlockServer)
close(ns.unstall)
s.mu.Lock()
defer s.mu.Unlock()
s.blockStalled = false
delete(s.blockOpsStalls, stalledOp)
}
// UndoStallMDOp reverts StallMDOp so that future stalledOp are not
// stalled anymore. It also unstalls any stalled stalledOp. StallMDOp
// should have been called upon stalledOp, otherwise this would panic.
func (s *NaïveStaller) UndoStallMDOp(stalledOp StallableMDOp) {
ns := s.getNaïveStallInfoForMDOpOrBust(stalledOp)
if jManager, err := GetJournalManager(s.config); err == nil &&
ns.oldJournalDelegateMDOps != nil {
jManager.delegateMDOps = ns.oldJournalDelegateMDOps
}
s.config.SetMDOps(ns.oldMDOps)
close(ns.unstall)
s.mu.Lock()
defer s.mu.Unlock()
s.mdStalled = false
delete(s.mdOpsStalls, stalledOp)
}
// StallBlockOp sets a wrapped BlockOps in config so that the specified Op, stalledOp,
// is stalled. Caller should use the returned newCtx for subsequent operations
// for the stall to be effective. onStalled is a channel to notify the caller
// when the stall has happened. unstall is a channel for caller to unstall an
// Op.
func StallBlockOp(ctx context.Context, config Config,
stalledOp StallableBlockOp, maxStalls int) (
onStalled <-chan struct{}, unstall chan<- struct{}, newCtx context.Context) {
onStalledCh := make(chan struct{}, maxStalls)
unstallCh := make(chan struct{})
stallKey := newStallKey()
config.SetBlockServer(&stallingBlockServer{
BlockServer: config.BlockServer(),
stallOpName: stalledOp,
stallKey: stallKey,
staller: staller{
stalled: onStalledCh,
unstall: unstallCh,
},
})
newCtx = libcontext.NewContextReplayable(ctx, func(ctx context.Context) context.Context {
return context.WithValue(ctx, stallKey, true)
})
return onStalledCh, unstallCh, newCtx
}
// StallMDOp sets a wrapped MDOps in config so that the specified Op,
// stalledOp, is stalled. Caller should use the returned newCtx for subsequent
// operations for the stall to be effective. onStalled is a channel to notify
// the caller when the stall has happened. unstall is a channel for caller to
// unstall an Op.
func StallMDOp(ctx context.Context, config Config, stalledOp StallableMDOp,
maxStalls int) (
onStalled <-chan struct{}, unstall chan<- struct{}, newCtx context.Context) {
onStalledCh := make(chan struct{}, maxStalls)
unstallCh := make(chan struct{})
stallKey := newStallKey()
config.SetMDOps(&stallingMDOps{
stallOpName: stalledOp,
stallKey: stallKey,
staller: staller{
stalled: onStalledCh,
unstall: unstallCh,
},
delegate: config.MDOps(),
})
newCtx = libcontext.NewContextReplayable(ctx, func(ctx context.Context) context.Context {
return context.WithValue(ctx, stallKey, true)
})
return onStalledCh, unstallCh, newCtx
}
func newStallKey() stallKeyType {
stallKey := stallKeyStallEverything
for stallKey == stallKeyStallEverything {
stallKey = stallKeyType(rand.Int63())
}
return stallKey
}
// staller is a pair of channels. Whenever something is to be
// stalled, a value is sent on stalled (if not blocked), and then
// unstall is waited on.
type staller struct {
stalled chan<- struct{}
unstall <-chan struct{}
}
func maybeStall(ctx context.Context, opName stallableOp,
stallOpName stallableOp, stallKey stallKeyType,
staller staller) {
if opName != stallOpName {
return
}
if stallKey != stallKeyStallEverything {
if v, ok := ctx.Value(stallKey).(bool); !ok || !v {
return
}
}
select {
case staller.stalled <- struct{}{}:
default:
}
<-staller.unstall
}
// runWithContextCheck checks ctx.Done() before and after running action. If
// either ctx.Done() check has error, ctx's error is returned. Otherwise,
// action's returned value is returned.
func runWithContextCheck(ctx context.Context, action func(ctx context.Context) error) error {
select {
case <-ctx.Done():
return ctx.Err()
default:
}
err := action(ctx)
select {
case <-ctx.Done():
return ctx.Err()
default:
}
return err
}
// stallingBlockServer is an implementation of BlockServer whose
// operations sometimes stall. In particular, if the operation name
// matches stallOpName, and ctx.Value(stallKey) is a key in the
// corresponding staller is used to stall the operation.
type stallingBlockServer struct {
BlockServer
stallOpName StallableBlockOp
// stallKey is a key for switching on/off stalling. If it's present in ctx,
// and equal to `true`, the operation is stalled. This allows us to use the
// ctx to control stallings
stallKey stallKeyType
staller staller
}
var _ BlockServer = (*stallingBlockServer)(nil)
func (f *stallingBlockServer) maybeStall(ctx context.Context, opName StallableBlockOp) {
maybeStall(ctx, stallableOp(opName), stallableOp(f.stallOpName),
f.stallKey, f.staller)
}
func (f *stallingBlockServer) Get(
ctx context.Context, tlfID tlf.ID, id kbfsblock.ID,
bctx kbfsblock.Context, cacheType DiskBlockCacheType) (
buf []byte, serverHalf kbfscrypto.BlockCryptKeyServerHalf, err error) {
f.maybeStall(ctx, StallableBlockGet)
err = runWithContextCheck(ctx, func(ctx context.Context) error {
var errGet error
buf, serverHalf, errGet = f.BlockServer.Get(
ctx, tlfID, id, bctx, cacheType)
return errGet
})
return buf, serverHalf, err
}
func (f *stallingBlockServer) Put(
ctx context.Context, tlfID tlf.ID, id kbfsblock.ID,
bctx kbfsblock.Context, buf []byte,
serverHalf kbfscrypto.BlockCryptKeyServerHalf,
cacheType DiskBlockCacheType) error {
f.maybeStall(ctx, StallableBlockPut)
return runWithContextCheck(ctx, func(ctx context.Context) error {
return f.BlockServer.Put(
ctx, tlfID, id, bctx, buf, serverHalf, cacheType)
})
}
// stallingMDOps is an implementation of MDOps whose operations
// sometimes stall. In particular, if the operation name matches
// stallOpName, and ctx.Value(stallKey) is a key in the corresponding
// staller is used to stall the operation.
type stallingMDOps struct {
stallOpName StallableMDOp
// stallKey is a key for switching on/off stalling. If it's present in ctx,
// and equal to `true`, the operation is stalled. This allows us to use the
// ctx to control stallings
stallKey stallKeyType
staller staller
delegate MDOps
}
var _ MDOps = (*stallingMDOps)(nil)
func (m *stallingMDOps) maybeStall(ctx context.Context, opName StallableMDOp) {
maybeStall(ctx, stallableOp(opName), stallableOp(m.stallOpName),
m.stallKey, m.staller)
}
func (m *stallingMDOps) GetIDForHandle(
ctx context.Context, handle *tlfhandle.Handle) (tlfID tlf.ID, err error) {
return m.delegate.GetIDForHandle(ctx, handle)
}
func (m *stallingMDOps) GetForTLF(ctx context.Context, id tlf.ID,
lockBeforeGet *keybase1.LockID) (md ImmutableRootMetadata, err error) {
m.maybeStall(ctx, StallableMDGetForTLF)
err = runWithContextCheck(ctx, func(ctx context.Context) error {
var errGetForTLF error
md, errGetForTLF = m.delegate.GetForTLF(ctx, id, lockBeforeGet)
return errGetForTLF
})
return md, err
}
func (m *stallingMDOps) GetForTLFByTime(
ctx context.Context, id tlf.ID, serverTime time.Time) (
md ImmutableRootMetadata, err error) {
m.maybeStall(ctx, StallableMDGetForTLFByTime)
err = runWithContextCheck(ctx, func(ctx context.Context) error {
var errGetForTLF error
md, errGetForTLF = m.delegate.GetForTLFByTime(ctx, id, serverTime)
return errGetForTLF
})
return md, err
}
func (m *stallingMDOps) GetLatestHandleForTLF(ctx context.Context, id tlf.ID) (
h tlf.Handle, err error) {
m.maybeStall(ctx, StallableMDGetLatestHandleForTLF)
err = runWithContextCheck(ctx, func(ctx context.Context) error {
var errGetLatestHandleForTLF error
h, errGetLatestHandleForTLF = m.delegate.GetLatestHandleForTLF(
ctx, id)
return errGetLatestHandleForTLF
})
return h, err
}
func (m *stallingMDOps) ValidateLatestHandleNotFinal(
ctx context.Context, h *tlfhandle.Handle) (b bool, err error) {
m.maybeStall(ctx, StallableMDValidateLatestHandleNotFinal)
err = runWithContextCheck(ctx, func(ctx context.Context) error {
var errValidateLatestHandleNotFinal error
b, errValidateLatestHandleNotFinal =
m.delegate.ValidateLatestHandleNotFinal(ctx, h)
return errValidateLatestHandleNotFinal
})
return b, err
}
func (m *stallingMDOps) GetUnmergedForTLF(ctx context.Context, id tlf.ID,
bid kbfsmd.BranchID) (md ImmutableRootMetadata, err error) {
m.maybeStall(ctx, StallableMDGetUnmergedForTLF)
err = runWithContextCheck(ctx, func(ctx context.Context) error {
var errGetUnmergedForTLF error
md, errGetUnmergedForTLF = m.delegate.GetUnmergedForTLF(ctx, id, bid)
return errGetUnmergedForTLF
})
return md, err
}
func (m *stallingMDOps) GetRange(ctx context.Context, id tlf.ID,
start, stop kbfsmd.Revision, lockBeforeGet *keybase1.LockID) (
mds []ImmutableRootMetadata, err error) {
m.maybeStall(ctx, StallableMDGetRange)
err = runWithContextCheck(ctx, func(ctx context.Context) error {
var errGetRange error
mds, errGetRange = m.delegate.GetRange(
ctx, id, start, stop, lockBeforeGet)
m.maybeStall(ctx, StallableMDAfterGetRange)
return errGetRange
})
return mds, err
}
func (m *stallingMDOps) GetUnmergedRange(ctx context.Context, id tlf.ID,
bid kbfsmd.BranchID, start, stop kbfsmd.Revision) (mds []ImmutableRootMetadata, err error) {
m.maybeStall(ctx, StallableMDGetUnmergedRange)
err = runWithContextCheck(ctx, func(ctx context.Context) error {
var errGetUnmergedRange error
mds, errGetUnmergedRange = m.delegate.GetUnmergedRange(
ctx, id, bid, start, stop)
return errGetUnmergedRange
})
return mds, err
}
func (m *stallingMDOps) Put(
ctx context.Context, md *RootMetadata, verifyingKey kbfscrypto.VerifyingKey,
lockContext *keybase1.LockContext, priority keybase1.MDPriority,
bps data.BlockPutState) (irmd ImmutableRootMetadata, err error) {
m.maybeStall(ctx, StallableMDPut)
err = runWithContextCheck(ctx, func(ctx context.Context) error {
irmd, err = m.delegate.Put(
ctx, md, verifyingKey, lockContext, priority, bps)
m.maybeStall(ctx, StallableMDAfterPut)
return err
})
return irmd, err
}
func (m *stallingMDOps) PutUnmerged(
ctx context.Context, md *RootMetadata,
verifyingKey kbfscrypto.VerifyingKey, bps data.BlockPutState) (
irmd ImmutableRootMetadata, err error) {
m.maybeStall(ctx, StallableMDPutUnmerged)
err = runWithContextCheck(ctx, func(ctx context.Context) error {
irmd, err = m.delegate.PutUnmerged(ctx, md, verifyingKey, bps)
m.maybeStall(ctx, StallableMDAfterPutUnmerged)
return err
})
return irmd, err
}
func (m *stallingMDOps) PruneBranch(
ctx context.Context, id tlf.ID, bid kbfsmd.BranchID) error {
m.maybeStall(ctx, StallableMDPruneBranch)
return runWithContextCheck(ctx, func(ctx context.Context) error {
return m.delegate.PruneBranch(ctx, id, bid)
})
}
func (m *stallingMDOps) ResolveBranch(
ctx context.Context, id tlf.ID, bid kbfsmd.BranchID,
blocksToDelete []kbfsblock.ID, rmd *RootMetadata,
verifyingKey kbfscrypto.VerifyingKey, bps data.BlockPutState) (
irmd ImmutableRootMetadata, err error) {
m.maybeStall(ctx, StallableMDResolveBranch)
err = runWithContextCheck(ctx, func(ctx context.Context) error {
irmd, err = m.delegate.ResolveBranch(
ctx, id, bid, blocksToDelete, rmd, verifyingKey, bps)
return err
})
return irmd, err
}