forked from keybase/client
-
Notifications
You must be signed in to change notification settings - Fork 0
/
unflushed_path_cache.go
503 lines (456 loc) · 14.2 KB
/
unflushed_path_cache.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
// 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 (
"errors"
"fmt"
"sync"
"time"
"github.com/keybase/client/go/kbfs/idutil"
"github.com/keybase/client/go/kbfs/kbfscodec"
"github.com/keybase/client/go/kbfs/kbfscrypto"
"github.com/keybase/client/go/kbfs/kbfsmd"
"github.com/keybase/client/go/logger"
"github.com/keybase/client/go/protocol/keybase1"
"golang.org/x/net/context"
)
type unflushedPathCacheState int
const (
upcUninitialized unflushedPathCacheState = iota
upcInitializing
upcInitialized
)
type unflushedPathsPerRevMap map[string]bool
type unflushedPathsMap map[kbfsmd.Revision]unflushedPathsPerRevMap
type upcQueuedOpType int
const (
upcOpAppend upcQueuedOpType = iota
upcOpRemove
upcOpReinit
)
type upcQueuedOp struct {
op upcQueuedOpType
// Remove ops don't need an info.
info unflushedPathMDInfo
// All op types should set this.
rev kbfsmd.Revision
// Only reinit ops need to set this explicitly.
isLocalSquash bool
}
// unflushedPathCache tracks the paths that have been modified by MD
// updates that haven't yet been flushed from the journal.
type unflushedPathCache struct {
lock sync.RWMutex
state unflushedPathCacheState
unflushedPaths unflushedPathsMap
ready chan struct{}
chainsPopulator chainsPathPopulator
queue []upcQueuedOp
}
var errUPCNotInitialized = errors.New("The unflushed path cache is not yet initialized")
// getUnflushedPaths returns a copy of the unflushed path cache if it
// has been initialized, otherwise nil. It must be called under the
// same lock as the callers of appendToCache/removeFromCache. The
// caller must not modify the inner per-revision maps of the return
// value.
func (upc *unflushedPathCache) getUnflushedPaths() unflushedPathsMap {
upc.lock.RLock()
defer upc.lock.RUnlock()
if upc.unflushedPaths == nil {
return nil
}
cache := make(unflushedPathsMap)
// Only need to deep-copy the outer level of the map; the inner
// level (per-revision) shouldn't be modified us once it's set,
// and the caller isn't supposed to modify it.
for k, v := range upc.unflushedPaths {
cache[k] = v
}
return cache
}
func (upc *unflushedPathCache) doStartInitialization() (
bool, <-chan struct{}) {
upc.lock.Lock()
defer upc.lock.Unlock()
switch upc.state {
case upcUninitialized:
upc.state = upcInitializing
if upc.ready != nil {
panic("Unflushed path cache should not have a non-nil channel " +
"when uninitialized")
}
upc.ready = make(chan struct{})
return true, upc.ready
case upcInitializing:
return false, upc.ready
case upcInitialized:
return false, nil
default:
panic(fmt.Sprintf("Unknown unflushedPathsCache state: %v", upc.state))
}
}
// startInitializeOrWait returns true if the caller should start
// initialization, otherwise false (which means the cache is already
// initialized when it returns). It may block for an extended period
// of time during while another caller is initializing.
func (upc *unflushedPathCache) startInitializeOrWait(ctx context.Context) (
bool, error) {
// Retry in case the original initializer has to abort due to
// error; limit the number of retries by the lifetime of `ctx`.
for {
doInit, readyCh := upc.doStartInitialization()
if doInit {
return true, nil
} else if readyCh == nil {
// Already initialized.
return false, nil
}
select {
case <-readyCh:
continue
case <-ctx.Done():
return false, ctx.Err()
}
}
}
func (upc *unflushedPathCache) abortInitialization() {
upc.lock.Lock()
defer upc.lock.Unlock()
upc.state = upcUninitialized
upc.queue = nil
if upc.ready != nil {
close(upc.ready)
upc.ready = nil
}
}
// unflushedPathMDInfo is the subset of metadata info needed by
// unflushedPathCache.
type unflushedPathMDInfo struct {
revision kbfsmd.Revision
kmd KeyMetadataWithRootDirEntry
pmd PrivateMetadata
localTimestamp time.Time
}
// addUnflushedPaths populates the given unflushed paths object. The
// caller should NOT be holding any locks, as it's possible that
// blocks will need to be fetched.
func addUnflushedPaths(ctx context.Context,
uid keybase1.UID, key kbfscrypto.VerifyingKey, codec kbfscodec.Codec,
log logger.Logger, osg idutil.OfflineStatusGetter,
mdInfos []unflushedPathMDInfo, cpp chainsPathPopulator,
unflushedPaths unflushedPathsMap) error {
// Make chains over the entire range to get the unflushed files.
chains := newCRChainsEmpty(cpp.obfuscatorMaker())
if len(mdInfos) > 0 {
mostRecentMDInfo := mdInfos[len(mdInfos)-1]
chains.mostRecentChainMDInfo = mostRecentMDInfo.kmd
}
processedOne := false
for _, mdInfo := range mdInfos {
offline := keybase1.OfflineAvailability_NONE
if osg != nil {
offline = osg.OfflineAvailabilityForID(mdInfo.kmd.TlfID())
}
winfo := newWriterInfo(uid, key, mdInfo.revision, offline)
if _, ok := unflushedPaths[mdInfo.revision]; ok {
if processedOne {
return fmt.Errorf("Couldn't skip revision %d after "+
"already processing one", mdInfo.revision)
}
log.CDebugf(ctx, "Skipping unflushed paths for revision %d "+
"since it's already in the cache", mdInfo.revision)
continue
}
unflushedPaths[mdInfo.revision] = make(map[string]bool)
processedOne = true
err := chains.addOps(codec, mdInfo.pmd, winfo, mdInfo.localTimestamp)
if err != nil {
return err
}
}
if !processedOne {
return nil
}
// Does the last op already have a valid path in each chain? If
// so, we don't need to bother populating the paths, which can
// take a fair amount of CPU since the node cache isn't already
// up-to-date with the current set of pointers (because the MDs
// haven't been committed yet).
populatePaths := false
for _, chain := range chains.byOriginal {
if len(chain.ops) > 0 &&
!chain.ops[len(chain.ops)-1].getFinalPath().
IsValidForNotification() {
populatePaths = true
break
}
}
if populatePaths {
err := cpp.populateChainPaths(ctx, log, chains, true)
if err != nil {
return err
}
}
for _, chain := range chains.byOriginal {
if len(chain.ops) > 0 {
// Use the same final path from the chain for all ops.
// Use the plaintext here, since this will be included
// directly in the `.kbfs_status` output for unflushed
// paths.
finalPath := chain.ops[len(chain.ops)-1].getFinalPath().
CanonicalPathPlaintext()
for _, op := range chain.ops {
revPaths, ok := unflushedPaths[op.getWriterInfo().revision]
if !ok {
panic(fmt.Sprintf("No rev map for revision %d",
op.getWriterInfo().revision))
}
revPaths[finalPath] = true
}
}
}
return nil
}
// prepUnflushedPaths returns a set of paths that were updated in the
// given revision.
func (upc *unflushedPathCache) prepUnflushedPaths(ctx context.Context,
uid keybase1.UID, key kbfscrypto.VerifyingKey, codec kbfscodec.Codec,
log logger.Logger, osg idutil.OfflineStatusGetter, mdInfo unflushedPathMDInfo) (
unflushedPathsPerRevMap, error) {
cpp := func() chainsPathPopulator {
upc.lock.Lock()
defer upc.lock.Unlock()
return upc.chainsPopulator
}()
// The unflushed paths haven't been initialized yet.
if cpp == nil {
return nil, nil
}
newUnflushedPaths := make(unflushedPathsMap)
mdInfos := []unflushedPathMDInfo{mdInfo}
err := addUnflushedPaths(
ctx, uid, key, codec, log, osg, mdInfos, cpp, newUnflushedPaths)
if err != nil {
return nil, err
}
if len(newUnflushedPaths) > 1 {
return nil, fmt.Errorf("%d unflushed revisions on a single put",
len(newUnflushedPaths))
}
perRevMap, ok := newUnflushedPaths[mdInfo.revision]
if !ok {
panic(fmt.Errorf("Cannot find per-revision map for revision %d",
mdInfo.revision))
}
return perRevMap, nil
}
// appendToCache returns true when successful, and false if it needs
// to be retried after the per-revision map is recomputed.
func (upc *unflushedPathCache) appendToCache(mdInfo unflushedPathMDInfo,
perRevMap unflushedPathsPerRevMap) bool {
upc.lock.Lock()
defer upc.lock.Unlock()
switch upc.state {
case upcUninitialized:
// Nothing to do.
case upcInitializing:
// Append to queue for processing at the end of initialization.
upc.queue = append(upc.queue, upcQueuedOp{
op: upcOpAppend,
info: mdInfo,
rev: mdInfo.revision,
})
case upcInitialized:
if perRevMap == nil {
// This was prepared before `upc.chainsPopulator` was set,
// and needs to be done again.
return false
}
// Update the cache with the prepared paths.
upc.unflushedPaths[mdInfo.revision] = perRevMap
default:
panic(fmt.Sprintf("Unknown unflushedPathsCache state: %v", upc.state))
}
return true
}
func (upc *unflushedPathCache) removeFromCache(rev kbfsmd.Revision) {
upc.lock.Lock()
defer upc.lock.Unlock()
switch upc.state {
case upcUninitialized:
// Nothing to do.
case upcInitializing:
// Append to queue for processing at the end of initialization.
upc.queue = append(upc.queue, upcQueuedOp{
op: upcOpRemove,
rev: rev,
})
case upcInitialized:
delete(upc.unflushedPaths, rev)
default:
panic(fmt.Sprintf("Unknown unflushedPathsCache state: %v", upc.state))
}
}
func (upc *unflushedPathCache) setCacheIfPossible(cache unflushedPathsMap,
cpp chainsPathPopulator) []upcQueuedOp {
upc.lock.Lock()
defer upc.lock.Unlock()
if len(upc.queue) > 0 {
// We need to process more appends!
queue := upc.queue
upc.queue = nil
return queue
}
upc.unflushedPaths = cache
upc.chainsPopulator = cpp
if upc.ready != nil {
close(upc.ready)
upc.ready = nil
}
upc.state = upcInitialized
return nil
}
func reinitUpcCache(revision kbfsmd.Revision,
unflushedPaths unflushedPathsMap, perRevMap unflushedPathsPerRevMap,
isLocalSquash bool) {
// Remove all entries equal or bigger to this revision. Keep
// earlier revisions (likely preserved local squashes).
for rev := range unflushedPaths {
// Keep the revision if this is a local squash and it's
// smaller than the squash revision.
if isLocalSquash && rev < revision {
continue
}
delete(unflushedPaths, rev)
}
unflushedPaths[revision] = perRevMap
}
// initialize should only be called when the caller saw a `true` value
// from `startInitializeOrWait()`. It returns the unflushed paths
// associated with `irmds`. If it returns a `false` boolean, the
// caller must abort the initialization (although as long as `err` is
// nil, the returns unflushed paths may be used). The caller should
// not modify any of the per-revision inner maps of the returned
// unflushed path map.
func (upc *unflushedPathCache) initialize(ctx context.Context,
uid keybase1.UID, key kbfscrypto.VerifyingKey, codec kbfscodec.Codec,
log logger.Logger, osg idutil.OfflineStatusGetter, cpp chainsPathPopulator,
mdInfos []unflushedPathMDInfo) (unflushedPathsMap, bool, error) {
// First get all the paths for the given range. On the first try
unflushedPaths := make(unflushedPathsMap)
log.CDebugf(ctx, "Initializing unflushed path cache with %d revisions",
len(mdInfos))
err := addUnflushedPaths(
ctx, uid, key, codec, log, osg, mdInfos, cpp, unflushedPaths)
if err != nil {
return nil, false, err
}
initialUnflushedPaths := make(unflushedPathsMap)
// Only need to deep-copy the outer level of the map; the inner
// level (per-revision) shouldn't be modified us once it's set,
// and the caller isn't supposed to modify it.
for k, v := range unflushedPaths {
initialUnflushedPaths[k] = v
}
// Try to drain the queue a few times. We may be unable to if we
// are continuously racing with MD puts.
for i := 0; i < 10; i++ {
queue := upc.setCacheIfPossible(unflushedPaths, cpp)
if len(queue) == 0 {
// Return the paths corresponding only to the original set
// of RMDs, not to anything from the queue.
return initialUnflushedPaths, true, nil
}
select {
case <-ctx.Done():
return nil, false, ctx.Err()
default:
}
// Do the queued appends up to the first reinitialization.
for len(queue) > 0 {
var appends []unflushedPathMDInfo
for _, op := range queue {
if op.op == upcOpAppend {
appends = append(appends, op.info)
} else if op.op == upcOpReinit {
break
}
}
log.CDebugf(ctx, "Processing unflushed paths for %d items in "+
"the append queue", len(appends))
err := addUnflushedPaths(
ctx, uid, key, codec, log, osg, appends, cpp, unflushedPaths)
if err != nil {
return nil, false, err
}
// Do the queued removes up to the first reinitialization.
// Then to do the reinitialization and repeat using the
// remainder of the queue.
reinit := false
for i, op := range queue {
if op.op == upcOpRemove {
delete(unflushedPaths, op.rev)
} else if op.op == upcOpReinit {
perRevMap, err := upc.prepUnflushedPaths(
ctx, uid, key, codec, log, osg, op.info)
if err != nil {
return nil, false, err
}
reinitUpcCache(
op.rev, unflushedPaths, perRevMap, op.isLocalSquash)
queue = queue[i+1:]
reinit = true
break
}
}
if !reinit {
queue = nil
}
}
}
// If we can't catch up to the queue, then instruct the caller to
// abort the initialization.
return initialUnflushedPaths, false, nil
}
// reinitializeWithResolution returns true when successful, and false
// if it needs to be retried after the per-revision map is recomputed.
func (upc *unflushedPathCache) reinitializeWithResolution(
mdInfo unflushedPathMDInfo, perRevMap unflushedPathsPerRevMap,
isLocalSquash bool) bool {
upc.lock.Lock()
defer upc.lock.Unlock()
if perRevMap == nil {
switch upc.state {
case upcInitialized:
// Initialization started since the perRevMap was created,
// so try again.
return false
case upcInitializing:
// Save this reinit for later.
upc.queue = append(upc.queue, upcQueuedOp{
op: upcOpReinit,
info: mdInfo,
rev: mdInfo.revision,
isLocalSquash: isLocalSquash,
})
return true
default:
// We can't initialize with a nil revision map.
return true
}
}
if upc.unflushedPaths != nil {
reinitUpcCache(
mdInfo.revision, upc.unflushedPaths, perRevMap, isLocalSquash)
} else {
upc.unflushedPaths = unflushedPathsMap{mdInfo.revision: perRevMap}
}
upc.queue = nil
if upc.ready != nil {
close(upc.ready)
upc.ready = nil
}
upc.state = upcInitialized
return true
}