forked from keybase/client
-
Notifications
You must be signed in to change notification settings - Fork 0
/
folder_branch_ops.go
9840 lines (8749 loc) · 287 KB
/
folder_branch_ops.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
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// 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 (
"fmt"
"io"
"math/rand"
"os"
stdpath "path"
"path/filepath"
"reflect"
"sort"
"strings"
"sync"
"time"
"github.com/keybase/backoff"
"github.com/keybase/client/go/kbfs/data"
"github.com/keybase/client/go/kbfs/env"
"github.com/keybase/client/go/kbfs/idutil"
"github.com/keybase/client/go/kbfs/kbfsblock"
"github.com/keybase/client/go/kbfs/kbfscrypto"
"github.com/keybase/client/go/kbfs/kbfsedits"
"github.com/keybase/client/go/kbfs/kbfsmd"
"github.com/keybase/client/go/kbfs/kbfssync"
"github.com/keybase/client/go/kbfs/libcontext"
"github.com/keybase/client/go/kbfs/libkey"
"github.com/keybase/client/go/kbfs/tlf"
"github.com/keybase/client/go/kbfs/tlfhandle"
kbname "github.com/keybase/client/go/kbun"
"github.com/keybase/client/go/libkb"
"github.com/keybase/client/go/protocol/chat1"
"github.com/keybase/client/go/protocol/keybase1"
"github.com/keybase/go-framed-msgpack-rpc/rpc"
"github.com/pkg/errors"
"golang.org/x/net/context"
)
// mdReadType indicates whether a read needs identifies.
type mdReadType int
const (
// A read request that doesn't need an identify to be
// performed.
mdReadNoIdentify mdReadType = iota
// A read request that needs an identify to be performed (if
// it hasn't been already).
mdReadNeedIdentify
)
// mdUpdateType indicates update type.
type mdUpdateType int
const (
mdWrite mdUpdateType = iota
// A rekey request. Doesn't need an identify to be performed, as
// a rekey does its own (finer-grained) identifies.
mdRekey
)
type branchType int
const (
standard branchType = iota // an online, read-write branch
archive // an online, read-only branch
conflict // a cleared, local conflict branch
)
// Constants used in this file. TODO: Make these configurable?
const (
// Maximum number of blocks that can be sent in parallel
maxParallelBlockPuts = 100
// Max response size for a single DynamoDB query is 1MB.
maxMDsAtATime = 10
// Cap the number of times we retry after a recoverable error
maxRetriesOnRecoverableErrors = 10
// If it's been more than this long since our last update, check
// the current head before downloading all of the new revisions.
fastForwardTimeThresh = 15 * time.Minute
// If there are more than this many new revisions, fast forward
// rather than downloading them all.
fastForwardRevThresh = 50
// Period between mark-and-sweep attempts.
markAndSweepPeriod = 1 * time.Hour
// A hard-coded reason used to derive the log obfuscator secret.
obfuscatorDerivationString = "Keybase-Derived-KBFS-Log-Obfuscator-1"
// How long do we skip identifies after seeing one with a broken
// proof warning?
cacheBrokenProofIdentifiesDuration = 5 * time.Minute
)
// ErrStillStagedAfterCR indicates that conflict resolution failed to take
// the FBO out of staging.
type ErrStillStagedAfterCR struct{}
// Error implements the error interface.
func (*ErrStillStagedAfterCR) Error() string {
return "conflict resolution didn't take us out of staging"
}
type fboMutexLevel kbfssync.MutexLevel
const (
fboMDWriter fboMutexLevel = 1
fboHead fboMutexLevel = 2
fboBlock fboMutexLevel = 3
fboSync fboMutexLevel = 4
)
func (o fboMutexLevel) String() string {
switch o {
case fboMDWriter:
return "mdWriterLock"
case fboHead:
return "headLock"
case fboBlock:
return "blockLock"
case fboSync:
return "syncLock"
default:
return fmt.Sprintf("Invalid fboMutexLevel %d", int(o))
}
}
func fboMutexLevelToString(o kbfssync.MutexLevel) string {
return (fboMutexLevel(o)).String()
}
// Rules for working with kbfssync.LockState in FBO:
//
// - Every "execution flow" (i.e., program flow that happens
// sequentially) needs its own lockState object. This usually means
// that each "public" FBO method does:
//
// lState := makeFBOLockState()
//
// near the top.
//
// - Plumb lState through to all functions that hold any of the
// relevant locks, or are called under those locks.
//
// This way, violations of the lock hierarchy will be detected at
// runtime.
func makeFBOLockState() *kbfssync.LockState {
return kbfssync.MakeLevelState(fboMutexLevelToString)
}
// blockLock is just like a sync.RWMutex, but with an extra operation
// (DoRUnlockedIfPossible).
type blockLock struct {
kbfssync.LeveledRWMutex
locked bool
}
func (bl *blockLock) Lock(lState *kbfssync.LockState) {
bl.LeveledRWMutex.Lock(lState)
bl.locked = true
}
func (bl *blockLock) Unlock(lState *kbfssync.LockState) {
bl.locked = false
bl.LeveledRWMutex.Unlock(lState)
}
// DoRUnlockedIfPossible must be called when r- or w-locked. If
// r-locked, r-unlocks, runs the given function, and r-locks after
// it's done. Otherwise, just runs the given function.
func (bl *blockLock) DoRUnlockedIfPossible(
lState *kbfssync.LockState, f func(*kbfssync.LockState)) {
if !bl.locked {
bl.RUnlock(lState)
defer bl.RLock(lState)
}
f(lState)
}
// headTrustStatus marks whether the head is from a trusted or
// untrusted source. When rekeying we get the head MD by folder id
// and do not check the tlf handle
type headTrustStatus int
const (
headUntrusted headTrustStatus = iota
headTrusted
)
type cachedDirOp struct {
dirOp op
nodes []Node
}
type editChannelActivity struct {
convID chat1.ConversationID // set to nil to force a re-init
name string
message string
}
// folderBranchOps implements the KBFSOps interface for a specific
// branch of a specific folder. It is go-routine safe for operations
// within the folder.
//
// We use locks to protect against multiple goroutines accessing the
// same folder-branch. The goal with our locking strategy is maximize
// concurrent access whenever possible. See design/state_machine.md
// for more details. There are three important locks:
//
// 1) mdWriterLock: Any "remote-sync" operation (one which modifies the
// folder's metadata) must take this lock during the entirety of
// its operation, to avoid forking the MD.
//
// 2) headLock: This is a read/write mutex. It must be taken for
// reading before accessing any part of the current head MD. It
// should be taken for the shortest time possible -- that means in
// general that it should be taken, and the MD copied to a
// goroutine-local variable, and then it can be released.
// Remote-sync operations should take it for writing after pushing
// all of the blocks and MD to the KBFS servers (i.e., all network
// accesses), and then hold it until after all notifications have
// been fired, to ensure that no concurrent "local" operations ever
// see inconsistent state locally.
//
// 3) blockLock: This too is a read/write mutex. It must be taken for
// reading before accessing any blocks in the block cache that
// belong to this folder/branch. This includes checking their
// dirty status. It should be taken for the shortest time possible
// -- that means in general it should be taken, and then the blocks
// that will be modified should be copied to local variables in the
// goroutine, and then it should be released. The blocks should
// then be modified locally, and then readied and pushed out
// remotely. Only after the blocks have been pushed to the server
// should a remote-sync operation take the lock again (this time
// for writing) and put/finalize the blocks. Write and Truncate
// should take blockLock for their entire lifetime, since they
// don't involve writes over the network. Furthermore, if a block
// is not in the cache and needs to be fetched, we should release
// the mutex before doing the network operation, and lock it again
// before writing the block back to the cache.
//
// We want to allow writes and truncates to a file that's currently
// being sync'd, like any good networked file system. The tricky part
// is making sure the changes can both: a) be read while the sync is
// happening, and b) be applied to the new file path after the sync is
// done.
//
// For now, we just do the dumb, brute force thing for now: if a block
// is currently being sync'd, it copies the block and puts it back
// into the cache as modified. Then, when the sync finishes, it
// throws away the modified blocks and re-applies the change to the
// new file path (which might have a completely different set of
// blocks, so we can't just reuse the blocks that were modified during
// the sync.)
type folderBranchOps struct {
config Config
folderBranch data.FolderBranch
unmergedBID kbfsmd.BranchID // protected by mdWriterLock
bType branchType
observers *observerList
syncedTlfObservers *syncedTlfObserverList
serviceStatus *kbfsCurrentStatus
favs *Favorites
// The leveled locks below, when locked concurrently by the same
// goroutine, should only be taken in the following order to avoid
// deadlock.
// Taken by any method making MD modifications.
mdWriterLock kbfssync.LeveledMutex
dirOps []cachedDirOp
// protects access to head, headStatus, latestMergedRevision,
// and hasBeenCleared.
headLock kbfssync.LeveledRWMutex
head ImmutableRootMetadata
headStatus headTrustStatus
// latestMergedRevision tracks the latest heard merged revision on server
latestMergedRevision kbfsmd.Revision
latestMergedUpdated chan struct{}
// Has this folder ever been cleared?
hasBeenCleared bool
partialSyncRev kbfsmd.Revision
partialSyncConfig keybase1.FolderSyncConfig
syncLock kbfssync.LeveledRWMutex
markAndSweepTrigger chan<- struct{}
blocks folderBlockOps
prepper folderUpdatePrepper
// nodeCache itself is goroutine-safe, but this object's use
// of it has special requirements:
//
// - Reads can call PathFromNode() unlocked, since there are
// no guarantees with concurrent reads.
//
// - Operations that takes mdWriterLock always needs the
// most up-to-date paths, so those must call
// PathFromNode() under mdWriterLock.
//
// - Block write operations (write/truncate/sync) need to
// coordinate. Specifically, sync must make sure that
// blocks referenced in a path (including all of the child
// blocks) must exist in the cache during calls to
// PathFromNode from write/truncate. This means that sync
// must modify dirty file blocks only under blockLock, and
// write/truncate must call PathFromNode() under
// blockLock.
//
// Furthermore, calls to UpdatePointer() must happen
// before the copy-on-write mode induced by Sync() is
// finished.
nodeCache NodeCache
// Whether we've identified this TLF or not.
identifyLock sync.Mutex
identifyDone bool
identifyTime time.Time
identifyDoneWithWarning bool
// The current status summary for this folder
status *folderBranchStatusKeeper
// How to log
log traceLogger
deferLog traceLogger
defer2Log traceLogger
vlog *libkb.VDebugLog
deferVlog *libkb.VDebugLog
defer2Vlog *libkb.VDebugLog
// Closed on shutdown
shutdownChan chan struct{}
// Wait on this once we're done shutting down. Any goroutine that logs must
// be registered with this WaitGroup, to avoid test races.
doneWg sync.WaitGroup
// Can be used to turn off notifications for a while (e.g., for testing)
updatePauseChan chan (<-chan struct{})
cancelUpdatesLock sync.Mutex
// Cancels the goroutine currently waiting on TLF MD updates.
cancelUpdates context.CancelFunc
// This channel will be closed when the register goroutine completes.
updateDoneChan chan struct{}
// forceSyncChan is read from by the background sync process
// to know when it should sync immediately.
forceSyncChan <-chan struct{}
// syncNeededChan is signalled when a buffered write happens, and
// lets the background syncer wait rather than waking up all the
// time.
syncNeededChan chan struct{}
// How to resolve conflicts
cr *ConflictResolver
// Helper class for archiving and cleaning up the blocks for this TLF
fbm *folderBlockManager
rekeyFSM RekeyFSM
editHistory *kbfsedits.TlfHistory
editChannels chan editChannelActivity
refreshEditHistoryChannel chan struct{}
editsLock sync.Mutex
// Cancels the goroutine currently waiting on edits
cancelEdits context.CancelFunc
// This channel gets created when chat monitoring starts, and
// closed when it ends, so we can avoid sending messages to the
// monitorer when they won't be read.
editMonitoringInProgress chan struct{}
launchEditMonitor sync.Once
branchChanges kbfssync.RepeatedWaitGroup
mdFlushes kbfssync.RepeatedWaitGroup
forcedFastForwards kbfssync.RepeatedWaitGroup
editActivity kbfssync.RepeatedWaitGroup
partialSyncs kbfssync.RepeatedWaitGroup
rootWaits kbfssync.RepeatedWaitGroup
muLastGetHead sync.Mutex
// We record a timestamp everytime getHead or getTrustedHead is called, and
// use this as a heuristic for whether user is actively using KBFS. If user
// has been generating KBFS activities recently, it makes sense to try to
// reconnect as soon as possible in case of a deployment causes
// disconnection.
lastGetHead time.Time
convLock sync.Mutex
convID chat1.ConversationID
obLock sync.RWMutex
obSecret data.NodeObfuscatorSecret
}
var _ fbmHelper = (*folderBranchOps)(nil)
// newFolderBranchOps constructs a new folderBranchOps object.
func newFolderBranchOps(
ctx context.Context, appStateUpdater env.AppStateUpdater,
config Config, fb data.FolderBranch,
bType branchType,
quotaUsage *EventuallyConsistentQuotaUsage,
serviceStatus *kbfsCurrentStatus, favs *Favorites,
syncedTlfObservers *syncedTlfObserverList) *folderBranchOps {
var nodeCache NodeCache
if config.Mode().NodeCacheEnabled() {
nodeCache = newNodeCacheStandard(fb)
for _, f := range config.RootNodeWrappers() {
nodeCache.AddRootWrapper(f)
}
if bType == archive || bType == conflict {
nodeCache.AddRootWrapper(readonlyWrapper)
}
}
if bType == standard && fb.Branch != data.MasterBranch {
panic("standard FBOs must use the master branch")
} else if bType != standard && fb.Branch == data.MasterBranch {
panic("non-standard FBOs must not use the master branch")
}
// make logger
branchSuffix := ""
if fb.Branch != data.MasterBranch {
branchSuffix = " " + string(fb.Branch)
}
tlfStringFull := fb.Tlf.String()
// Shorten the TLF ID for the module name. 8 characters should be
// unique enough for a local node.
log := config.MakeLogger(fmt.Sprintf("FBO %s%s", tlfStringFull[:8],
branchSuffix))
deferLog := log.CloneWithAddedDepth(1)
defer2Log := log.CloneWithAddedDepth(2)
// But print it out once in full, just in case.
log.CInfof(ctx, "Created new folder-branch for %s", tlfStringFull)
observers := newObserverList()
mdWriterLock := kbfssync.MakeLeveledMutex(
kbfssync.MutexLevel(fboMDWriter), &sync.Mutex{})
headLock := kbfssync.MakeLeveledRWMutex(
kbfssync.MutexLevel(fboHead), &sync.RWMutex{})
blockLockMu := kbfssync.MakeLeveledRWMutex(
kbfssync.MutexLevel(fboBlock), &sync.RWMutex{})
syncLock := kbfssync.MakeLeveledRWMutex(
kbfssync.MutexLevel(fboSync), &sync.RWMutex{})
forceSyncChan := make(chan struct{})
fbo := &folderBranchOps{
config: config,
folderBranch: fb,
unmergedBID: kbfsmd.BranchID{},
bType: bType,
observers: observers,
syncedTlfObservers: syncedTlfObservers,
serviceStatus: serviceStatus,
favs: favs,
status: newFolderBranchStatusKeeper(
config, nodeCache, quotaUsage, fb.Tlf.Bytes()),
mdWriterLock: mdWriterLock,
headLock: headLock,
syncLock: syncLock,
blocks: folderBlockOps{
config: config,
log: log,
vlog: config.MakeVLogger(log),
folderBranch: fb,
observers: observers,
forceSyncChan: forceSyncChan,
blockLock: blockLock{
LeveledRWMutex: blockLockMu,
},
dirtyFiles: make(map[data.BlockPointer]*data.DirtyFile),
deferred: make(map[data.BlockRef]deferredState),
unrefCache: make(map[data.BlockRef]*syncInfo),
dirtyDirs: make(map[data.BlockPointer][]data.BlockInfo),
nodeCache: nodeCache,
},
nodeCache: nodeCache,
log: traceLogger{log},
deferLog: traceLogger{deferLog},
defer2Log: traceLogger{defer2Log},
vlog: config.MakeVLogger(log),
deferVlog: config.MakeVLogger(deferLog),
defer2Vlog: config.MakeVLogger(defer2Log),
shutdownChan: make(chan struct{}),
updatePauseChan: make(chan (<-chan struct{})),
forceSyncChan: forceSyncChan,
syncNeededChan: make(chan struct{}, 1),
editHistory: kbfsedits.NewTlfHistory(),
editChannels: make(chan editChannelActivity, 100),
refreshEditHistoryChannel: make(chan struct{}, 1),
}
fbo.prepper = folderUpdatePrepper{
config: config,
folderBranch: fb,
blocks: &fbo.blocks,
log: log,
vlog: config.MakeVLogger(log),
}
fbo.cr = NewConflictResolver(config, fbo)
fbo.fbm = newFolderBlockManager(appStateUpdater, config, fb, bType, fbo)
fbo.rekeyFSM = NewRekeyFSM(fbo)
if config.DoBackgroundFlushes() && bType == standard {
fbo.goTracked(fbo.backgroundFlusher)
}
if config.Mode().NodeCacheEnabled() {
nodeCache.SetObfuscatorMaker(fbo.makeObfuscator)
}
return fbo
}
func (fbo *folderBranchOps) goTracked(f func()) {
fbo.doneWg.Add(1)
go func() {
defer fbo.doneWg.Done()
f()
}()
}
// markForReIdentifyIfNeeded checks whether this tlf is identified and mark
// it for lazy reidentification if it exceeds time limits.
func (fbo *folderBranchOps) markForReIdentifyIfNeeded(now time.Time, maxValid time.Duration) {
fbo.identifyLock.Lock()
defer fbo.identifyLock.Unlock()
if fbo.identifyDone && (now.Before(fbo.identifyTime) || fbo.identifyTime.Add(maxValid).Before(now)) {
fbo.log.CDebugf(
context.TODO(), "Expiring identify from %v", fbo.identifyTime)
fbo.identifyDone = false
}
}
// Shutdown safely shuts down any background goroutines that may have
// been launched by folderBranchOps.
func (fbo *folderBranchOps) Shutdown(ctx context.Context) error {
if fbo.config.CheckStateOnShutdown() {
lState := makeFBOLockState()
switch {
case fbo.blocks.GetState(lState) == dirtyState:
fbo.log.CDebugf(ctx, "Skipping state-checking due to dirty state")
case fbo.isUnmerged(lState):
fbo.log.CDebugf(ctx, "Skipping state-checking due to being staged")
default:
// Make sure we're up to date first
if err := fbo.SyncFromServer(ctx,
fbo.folderBranch, nil); err != nil {
return err
}
// Check the state for consistency before shutting down.
sc := NewStateChecker(fbo.config)
if err := sc.CheckMergedState(ctx, fbo.id()); err != nil {
return err
}
}
}
if err := fbo.fbm.waitForArchives(ctx); err != nil {
return err
}
close(fbo.shutdownChan)
fbo.cr.Shutdown()
fbo.fbm.shutdown()
fbo.rekeyFSM.Shutdown()
// Wait for all the goroutines to finish, so that we don't have any races
// with logging during test reporting.
fbo.doneWg.Wait()
return nil
}
func (fbo *folderBranchOps) id() tlf.ID {
return fbo.folderBranch.Tlf
}
func (fbo *folderBranchOps) oa() keybase1.OfflineAvailability {
return fbo.config.OfflineAvailabilityForID(fbo.id())
}
func (fbo *folderBranchOps) branch() data.BranchName {
return fbo.folderBranch.Branch
}
func (fbo *folderBranchOps) addToFavorites(
ctx context.Context, created bool) (err error) {
lState := makeFBOLockState()
head := fbo.getTrustedHead(ctx, lState, mdNoCommit)
if head == (ImmutableRootMetadata{}) {
return OpsCantHandleFavorite{"Can't add a favorite without a handle"}
}
return fbo.addToFavoritesByHandle(ctx, head.GetTlfHandle(), created)
}
func (fbo *folderBranchOps) addToFavoritesByHandle(
ctx context.Context, handle *tlfhandle.Handle, created bool) (err error) {
if _, err := fbo.config.KBPKI().GetCurrentSession(ctx); err != nil {
// Can't favorite while not logged in
return nil
}
fbo.favs.AddAsync(ctx, handle.ToFavToAdd(created))
return nil
}
func (fbo *folderBranchOps) deleteFromFavorites(ctx context.Context) error {
if _, err := fbo.config.KBPKI().GetCurrentSession(ctx); err != nil {
// Can't unfavorite while not logged in
return nil
}
lState := makeFBOLockState()
head := fbo.getTrustedHead(ctx, lState, mdNoCommit)
if head == (ImmutableRootMetadata{}) {
// This can happen when identifies fail and the head is never set.
return OpsCantHandleFavorite{"Can't delete a favorite without a handle"}
}
h := head.GetTlfHandle()
return fbo.favs.Delete(ctx, h.ToFavorite())
}
func (fbo *folderBranchOps) doFavoritesOp(
ctx context.Context, fop FavoritesOp, handle *tlfhandle.Handle) error {
if fbo.bType == conflict {
// Ignore local conflicts, they should never be added as real favorites.
return nil
}
switch fop {
case FavoritesOpNoChange:
return nil
case FavoritesOpAdd:
if handle != nil {
return fbo.addToFavoritesByHandle(ctx, handle, false)
}
return fbo.addToFavorites(ctx, false)
case FavoritesOpAddNewlyCreated:
if handle != nil {
return fbo.addToFavoritesByHandle(ctx, handle, true)
}
return fbo.addToFavorites(ctx, true)
case FavoritesOpRemove:
return fbo.deleteFromFavorites(ctx)
default:
return InvalidFavoritesOpError{}
}
}
func (fbo *folderBranchOps) updateLastGetHeadTimestamp() {
fbo.muLastGetHead.Lock()
defer fbo.muLastGetHead.Unlock()
fbo.lastGetHead = fbo.config.Clock().Now()
}
type mdCommitType int
const (
mdCommit mdCommitType = iota
mdNoCommit
)
func (fbo *folderBranchOps) commitHeadLocked(
ctx context.Context, lState *kbfssync.LockState, ct mdCommitType) {
fbo.headLock.AssertRLocked(lState)
if ct == mdNoCommit {
return
}
diskMDCache := fbo.config.DiskMDCache()
if diskMDCache == nil {
return
}
if !fbo.head.putToServer {
return
}
rev := fbo.head.Revision()
id := fbo.id()
log := fbo.log
fbo.goTracked(func() {
err := diskMDCache.Commit(context.Background(), id, rev)
if err != nil {
log.CDebugf(ctx, "Error commiting revision %d: %+v", rev, err)
}
})
}
// getTrustedHead should not be called outside of folder_branch_ops.go.
// Returns ImmutableRootMetadata{} when the head is not trusted.
// See the comment on headTrustedStatus for more information.
func (fbo *folderBranchOps) getTrustedHead(
ctx context.Context, lState *kbfssync.LockState,
ct mdCommitType) ImmutableRootMetadata {
fbo.headLock.RLock(lState)
defer fbo.headLock.RUnlock(lState)
if fbo.headStatus == headUntrusted {
return ImmutableRootMetadata{}
}
// This triggers any mdserver backoff timer to fast forward. In case of a
// deployment, this causes KBFS client to try to reconnect to mdserver
// immediately rather than waiting until the random backoff timer is up.
// Note that this doesn't necessarily guarantee that the fbo handler that
// called this method would get latest MD.
fbo.config.MDServer().FastForwardBackoff()
fbo.updateLastGetHeadTimestamp()
fbo.commitHeadLocked(ctx, lState, ct)
return fbo.head
}
// getHead should not be called outside of folder_branch_ops.go.
func (fbo *folderBranchOps) getHead(
ctx context.Context, lState *kbfssync.LockState, ct mdCommitType) (
ImmutableRootMetadata, headTrustStatus) {
fbo.headLock.RLock(lState)
defer fbo.headLock.RUnlock(lState)
// See getTrustedHead for explanation.
fbo.config.MDServer().FastForwardBackoff()
fbo.updateLastGetHeadTimestamp()
fbo.commitHeadLocked(ctx, lState, ct)
return fbo.head, fbo.headStatus
}
// isUnmerged should not be called if mdWriterLock is already taken.
func (fbo *folderBranchOps) isUnmerged(lState *kbfssync.LockState) bool {
fbo.mdWriterLock.Lock(lState)
defer fbo.mdWriterLock.Unlock(lState)
return fbo.unmergedBID != kbfsmd.NullBranchID
}
func (fbo *folderBranchOps) isUnmergedLocked(lState *kbfssync.LockState) bool {
fbo.mdWriterLock.AssertLocked(lState)
return fbo.unmergedBID != kbfsmd.NullBranchID
}
var errJournalNotAvailable = errors.New("could not get journal for TLF")
// clearConflictView tells the journal to move any pending writes elsewhere,
// resets the CR counter, and resets the FBO to have a synced view of the TLF.
func (fbo *folderBranchOps) clearConflictView(ctx context.Context) (
err error) {
// TODO(KBFS-3990): show the cleared conflict view under a special path,
// so users can copy any unmerged files manually back into their synced
// view before nuking it.
fbo.log.CDebugf(ctx, "Clearing conflict view")
defer func() {
fbo.deferLog.CDebugf(ctx, "Done with clearConflictView: %+v", err)
}()
lState := makeFBOLockState()
fbo.mdWriterLock.Lock(lState)
defer fbo.mdWriterLock.Unlock(lState)
journalEnabled := TLFJournalEnabled(fbo.config, fbo.id())
if journalEnabled {
err = fbo.unstageLocked(ctx, lState, moveJournalsAway)
} else {
err = fbo.unstageLocked(ctx, lState, doPruneBranches)
}
if err != nil {
return err
}
return fbo.cr.clearConflictRecords(ctx)
}
// forceStuckConflictForTesting forces the TLF into a stuck conflict
// view, for testing.
func (fbo *folderBranchOps) forceStuckConflictForTesting(
ctx context.Context) (err error) {
startTime, timer := fbo.startOp(ctx, "Forcing a stuck conflict")
defer func() {
fbo.endOp(
ctx, startTime, timer, "Forcing a stuck conflict done: %+v", err)
}()
lState := makeFBOLockState()
fbo.mdWriterLock.Lock(lState)
defer fbo.mdWriterLock.Unlock(lState)
if fbo.isUnmergedLocked(lState) {
return errors.New("Cannot force conflict when already unmerged")
}
// Disable updates.
unpauseUpdatesCh := make(chan struct{})
fbo.updatePauseChan <- unpauseUpdatesCh
defer func() { unpauseUpdatesCh <- struct{}{} }()
// Make a no-op revision with an empty resolutionOp. Wait for it
// to flush to the server.
origHead, _ := fbo.getHead(ctx, lState, mdNoCommit)
mergedGCOp := newGCOp(origHead.data.LastGCRevision)
err = fbo.finalizeGCOpLocked(ctx, lState, mergedGCOp)
if err != nil {
return err
}
jManager, _ := GetJournalManager(fbo.config)
if jManager != nil {
err := fbo.waitForJournalLocked(ctx, lState, jManager)
if err != nil {
return err
}
// Wait for the flush handler to finish, so we don't
// accidentally swap in the upcoming MD on the conflict branch
// over the "merged" one we just flushed, before the pointer
// archiving step happens.
err = fbo.mdFlushes.Wait(ctx)
if err != nil {
return err
}
}
// Roll back the local view to the original revision.
err = func() error {
fbo.headLock.Lock(lState)
defer fbo.headLock.Unlock(lState)
err = fbo.setHeadLocked(ctx, lState, origHead, headTrusted, mdNoCommit)
if err != nil {
return err
}
fbo.setLatestMergedRevisionLocked(
ctx, lState, origHead.Revision(), true)
return nil
}()
if err != nil {
return err
}
// Set CR to always fail.
oldMode := fbo.cr.getFailModeForTesting()
fbo.cr.setFailModeForTesting(alwaysFailCR)
defer func() { fbo.cr.setFailModeForTesting(oldMode) }()
// Make fake conflicting files to trigger CR. Make one for each
// attempt needed to result in stuck CR.
handle := origHead.GetTlfHandle()
rootNode, err := fbo.nodeCache.GetOrCreate(
origHead.data.Dir.BlockPointer,
data.NewPathPartString(string(handle.GetCanonicalName()),
fbo.makeObfuscator()),
nil, data.Dir)
if err != nil {
return err
}
for i := 0; i < maxConflictResolutionAttempts+1; i++ {
filename := fmt.Sprintf("FILE_FOR_STUCK_CONFLICT_%02d", i)
_, _, err := fbo.createEntryLocked(
ctx, lState, rootNode, rootNode.ChildName(filename), data.File,
NoExcl)
if err != nil {
return err
}
err = fbo.syncAllLocked(ctx, lState, NoExcl)
if err != nil {
return err
}
if jManager != nil && TLFJournalEnabled(fbo.config, fbo.id()) {
// Can't use fbo.waitForJournalLocked here, since the
// flushing won't actually complete.
err := jManager.Wait(ctx, fbo.id())
if err != nil {
return err
}
newHead, _ := fbo.getHead(ctx, lState, mdNoCommit)
fbo.cr.Resolve(
ctx, newHead.Revision(), kbfsmd.RevisionUninitialized)
}
err = fbo.cr.Wait(ctx)
if err != nil {
return err
}
}
// Make sure we're stuck.
isStuck, err := fbo.cr.isStuck()
if err != nil {
return err
}
if !isStuck {
return errors.New("CR not stuck after trying to force conflict")
}
return nil
}
func (fbo *folderBranchOps) setBranchIDLocked(
lState *kbfssync.LockState, unmergedBID kbfsmd.BranchID) {
fbo.mdWriterLock.AssertLocked(lState)
if fbo.unmergedBID != unmergedBID {
fbo.cr.BeginNewBranch()
}
fbo.unmergedBID = unmergedBID
if unmergedBID == kbfsmd.NullBranchID {
fbo.status.setCRSummary(nil, nil)
}
}
var errNoFlushedRevisions = errors.New("No flushed MDs yet")
var errNoMergedRevWhileStaged = errors.New(
"Cannot find most recent merged revision while staged")
func (fbo *folderBranchOps) getJournalRevisions(ctx context.Context) (
predRev, journalEndRev kbfsmd.Revision, err error) {
jManager, err := GetJournalManager(fbo.config)
if err != nil {
// Journaling is disabled entirely.
return kbfsmd.RevisionUninitialized, kbfsmd.RevisionUninitialized, nil
}
jStatus, err := jManager.JournalStatus(fbo.id())
if err != nil {
// Journaling is disabled for this TLF, so use the local head.
// TODO: JournalStatus could return other errors (likely
// file/disk corruption) that indicate a real problem, so it
// might be nice to type those errors so we can distinguish
// them.
return kbfsmd.RevisionUninitialized, kbfsmd.RevisionUninitialized, nil
}
if jStatus.BranchID != kbfsmd.NullBranchID.String() {
return kbfsmd.RevisionUninitialized, kbfsmd.RevisionUninitialized,
errNoMergedRevWhileStaged
}
if jStatus.RevisionStart == kbfsmd.RevisionUninitialized {
// The journal is empty, so the local head must be the most recent.
return kbfsmd.RevisionUninitialized, kbfsmd.RevisionUninitialized, nil
} else if jStatus.RevisionStart == kbfsmd.RevisionInitial {
// Nothing has been flushed to the servers yet, so don't
// return anything.
return kbfsmd.RevisionUninitialized, kbfsmd.RevisionUninitialized,
errNoFlushedRevisions
}
return jStatus.RevisionStart - 1, jStatus.RevisionEnd, nil
}
// getJournalPredecessorRevision returns the revision that precedes
// the current journal head if journaling enabled and there are
// unflushed MD updates; otherwise it returns
// kbfsmd.RevisionUninitialized. If there aren't any flushed MD
// revisions, it returns errNoFlushedRevisions.
func (fbo *folderBranchOps) getJournalPredecessorRevision(ctx context.Context) (
kbfsmd.Revision, error) {
pred, _, err := fbo.getJournalRevisions(ctx)
return pred, err
}
// validateHeadLocked validates an untrusted head and sets it as trusted.
// see headTrustedState comment for more information.
func (fbo *folderBranchOps) validateHeadLocked(
ctx context.Context, lState *kbfssync.LockState,
md ImmutableRootMetadata) error {
fbo.headLock.AssertLocked(lState)
// Validate fbo against fetched md and discard the fetched one.
if fbo.head.TlfID() != md.TlfID() {
fbo.log.CCriticalf(ctx, "Fake untrusted TLF encountered %v %v %v %v", fbo.head.TlfID(), md.TlfID(), fbo.head.mdID, md.mdID)
return kbfsmd.MDTlfIDMismatch{CurrID: fbo.head.TlfID(), NextID: md.TlfID()}
}
fbo.headStatus = headTrusted
return nil
}
func (fbo *folderBranchOps) startMonitorChat(tlfName tlf.CanonicalName) {
if fbo.bType != standard || !fbo.config.Mode().TLFEditHistoryEnabled() {
return
}
fbo.editsLock.Lock()
defer fbo.editsLock.Unlock()
fbo.launchEditMonitor.Do(func() {
// The first event should initialize all the data. No need to
// check the monitoring channel here; we already know
// monitoring hasn't been started yet.