-
Notifications
You must be signed in to change notification settings - Fork 3.8k
/
stateloader.go
671 lines (612 loc) · 22.6 KB
/
stateloader.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
// Copyright 2016 The Cockroach Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
package stateloader
import (
"context"
"math"
"github.com/cockroachdb/cockroach/pkg/keys"
"github.com/cockroachdb/cockroach/pkg/roachpb"
"github.com/cockroachdb/cockroach/pkg/storage/engine"
"github.com/cockroachdb/cockroach/pkg/storage/engine/enginepb"
"github.com/cockroachdb/cockroach/pkg/storage/storagepb"
"github.com/cockroachdb/cockroach/pkg/util/encoding"
"github.com/cockroachdb/cockroach/pkg/util/hlc"
"github.com/cockroachdb/cockroach/pkg/util/log"
"github.com/cockroachdb/cockroach/pkg/util/protoutil"
"github.com/pkg/errors"
"go.etcd.io/etcd/raft/raftpb"
)
// StateLoader contains accessor methods to read or write the
// fields of storagebase.ReplicaState. It contains an internal buffer
// which is reused to avoid an allocation on frequently-accessed code
// paths.
//
// Because of this internal buffer, this struct is not safe for
// concurrent use, and the return values of methods that return keys
// are invalidated the next time any method is called.
//
// It is safe to have multiple replicaStateLoaders for the same
// Replica. Reusable replicaStateLoaders are typically found in a
// struct with a mutex, and temporary loaders may be created when
// locking is less desirable than an allocation.
type StateLoader struct {
keys.RangeIDPrefixBuf
}
// Make creates an Instance.
func Make(rangeID roachpb.RangeID) StateLoader {
rsl := StateLoader{
RangeIDPrefixBuf: keys.MakeRangeIDPrefixBuf(rangeID),
}
return rsl
}
// Load a ReplicaState from disk. The exception is the Desc field, which is
// updated transactionally, and is populated from the supplied RangeDescriptor
// under the convention that that is the latest committed version.
func (rsl StateLoader) Load(
ctx context.Context, reader engine.Reader, desc *roachpb.RangeDescriptor,
) (storagepb.ReplicaState, error) {
var s storagepb.ReplicaState
// TODO(tschottdorf): figure out whether this is always synchronous with
// on-disk state (likely iffy during Split/ChangeReplica triggers).
s.Desc = protoutil.Clone(desc).(*roachpb.RangeDescriptor)
// Read the range lease.
lease, err := rsl.LoadLease(ctx, reader)
if err != nil {
return storagepb.ReplicaState{}, err
}
s.Lease = &lease
if s.GCThreshold, err = rsl.LoadGCThreshold(ctx, reader); err != nil {
return storagepb.ReplicaState{}, err
}
if s.TxnSpanGCThreshold, err = rsl.LoadTxnSpanGCThreshold(ctx, reader); err != nil {
return storagepb.ReplicaState{}, err
}
if as, err := rsl.LoadRangeAppliedState(ctx, reader); err != nil {
return storagepb.ReplicaState{}, err
} else if as != nil {
s.UsingAppliedStateKey = true
s.RaftAppliedIndex = as.RaftAppliedIndex
s.LeaseAppliedIndex = as.LeaseAppliedIndex
ms := as.RangeStats.ToStats()
s.Stats = &ms
} else {
if s.RaftAppliedIndex, s.LeaseAppliedIndex, err = rsl.LoadAppliedIndex(ctx, reader); err != nil {
return storagepb.ReplicaState{}, err
}
ms, err := rsl.LoadMVCCStats(ctx, reader)
if err != nil {
return storagepb.ReplicaState{}, err
}
s.Stats = &ms
}
// The truncated state should not be optional (i.e. the pointer is
// pointless), but it is and the migration is not worth it.
truncState, _, err := rsl.LoadRaftTruncatedState(ctx, reader)
if err != nil {
return storagepb.ReplicaState{}, err
}
s.TruncatedState = &truncState
return s, nil
}
// TruncatedStateType determines whether to use a replicated (legacy) or an
// unreplicated TruncatedState. See VersionUnreplicatedRaftTruncatedStateKey.
type TruncatedStateType int
const (
// UseReplicatedTruncatedState means use the legacy (replicated) key.
UseReplicatedTruncatedState TruncatedStateType = iota
// UseReplicatedTruncatedState means use the new (unreplicated) key.
UseUnreplicatedTruncatedState
)
// Save persists the given ReplicaState to disk. It assumes that the contained
// Stats are up-to-date and returns the stats which result from writing the
// updated State.
//
// As an exception to the rule, the Desc field (whose on-disk state is special
// in that it's a full MVCC value and updated transactionally) is only used for
// its RangeID.
//
// TODO(tschottdorf): test and assert that none of the optional values are
// missing whenever save is called. Optional values should be reserved
// strictly for use in Result. Do before merge.
func (rsl StateLoader) Save(
ctx context.Context,
eng engine.ReadWriter,
state storagepb.ReplicaState,
truncStateType TruncatedStateType,
) (enginepb.MVCCStats, error) {
ms := state.Stats
if err := rsl.SetLease(ctx, eng, ms, *state.Lease); err != nil {
return enginepb.MVCCStats{}, err
}
if err := rsl.SetGCThreshold(ctx, eng, ms, state.GCThreshold); err != nil {
return enginepb.MVCCStats{}, err
}
if err := rsl.SetTxnSpanGCThreshold(ctx, eng, ms, state.TxnSpanGCThreshold); err != nil {
return enginepb.MVCCStats{}, err
}
if truncStateType == UseReplicatedTruncatedState {
if err := rsl.SetLegacyRaftTruncatedState(ctx, eng, ms, state.TruncatedState); err != nil {
return enginepb.MVCCStats{}, err
}
} else {
if err := rsl.SetRaftTruncatedState(ctx, eng, state.TruncatedState); err != nil {
return enginepb.MVCCStats{}, err
}
}
if state.UsingAppliedStateKey {
rai, lai := state.RaftAppliedIndex, state.LeaseAppliedIndex
if err := rsl.SetRangeAppliedState(ctx, eng, rai, lai, ms); err != nil {
return enginepb.MVCCStats{}, err
}
} else {
if err := rsl.SetLegacyAppliedIndex(
ctx, eng, ms, state.RaftAppliedIndex, state.LeaseAppliedIndex,
); err != nil {
return enginepb.MVCCStats{}, err
}
if err := rsl.SetLegacyMVCCStats(ctx, eng, ms); err != nil {
return enginepb.MVCCStats{}, err
}
}
return *ms, nil
}
// LoadLease loads the lease.
func (rsl StateLoader) LoadLease(ctx context.Context, reader engine.Reader) (roachpb.Lease, error) {
var lease roachpb.Lease
_, err := engine.MVCCGetProto(ctx, reader, rsl.RangeLeaseKey(),
hlc.Timestamp{}, &lease, engine.MVCCGetOptions{})
return lease, err
}
// SetLease persists a lease.
func (rsl StateLoader) SetLease(
ctx context.Context, eng engine.ReadWriter, ms *enginepb.MVCCStats, lease roachpb.Lease,
) error {
return engine.MVCCPutProto(ctx, eng, ms, rsl.RangeLeaseKey(),
hlc.Timestamp{}, nil, &lease)
}
// LoadRangeAppliedState loads the Range applied state. The returned pointer
// will be nil if the applied state key is not found.
func (rsl StateLoader) LoadRangeAppliedState(
ctx context.Context, reader engine.Reader,
) (*enginepb.RangeAppliedState, error) {
var as enginepb.RangeAppliedState
found, err := engine.MVCCGetProto(ctx, reader, rsl.RangeAppliedStateKey(), hlc.Timestamp{}, &as,
engine.MVCCGetOptions{})
if !found {
return nil, err
}
return &as, err
}
// AssertNoRangeAppliedState asserts that no Range applied state key is present.
func (rsl StateLoader) AssertNoRangeAppliedState(ctx context.Context, reader engine.Reader) error {
if as, err := rsl.LoadRangeAppliedState(ctx, reader); err != nil {
return err
} else if as != nil {
log.Fatalf(ctx, "unexpected RangeAppliedState present: %v", as)
}
return nil
}
// LoadAppliedIndex returns the Raft applied index and the lease applied index.
func (rsl StateLoader) LoadAppliedIndex(
ctx context.Context, reader engine.Reader,
) (raftAppliedIndex uint64, leaseAppliedIndex uint64, err error) {
// Check the applied state key.
if as, err := rsl.LoadRangeAppliedState(ctx, reader); err != nil {
return 0, 0, err
} else if as != nil {
return as.RaftAppliedIndex, as.LeaseAppliedIndex, nil
}
// If the range applied state is not found, check the legacy Raft applied
// index and the lease applied index keys. This is where these indices were
// stored before the range applied state was introduced.
v, _, err := engine.MVCCGet(ctx, reader, rsl.RaftAppliedIndexLegacyKey(),
hlc.Timestamp{}, engine.MVCCGetOptions{})
if err != nil {
return 0, 0, err
}
if v != nil {
int64AppliedIndex, err := v.GetInt()
if err != nil {
return 0, 0, err
}
raftAppliedIndex = uint64(int64AppliedIndex)
}
// TODO(tschottdorf): code duplication.
v, _, err = engine.MVCCGet(ctx, reader, rsl.LeaseAppliedIndexLegacyKey(),
hlc.Timestamp{}, engine.MVCCGetOptions{})
if err != nil {
return 0, 0, err
}
if v != nil {
int64LeaseAppliedIndex, err := v.GetInt()
if err != nil {
return 0, 0, err
}
leaseAppliedIndex = uint64(int64LeaseAppliedIndex)
}
return raftAppliedIndex, leaseAppliedIndex, nil
}
// LoadMVCCStats loads the MVCC stats.
func (rsl StateLoader) LoadMVCCStats(
ctx context.Context, reader engine.Reader,
) (enginepb.MVCCStats, error) {
// Check the applied state key.
if as, err := rsl.LoadRangeAppliedState(ctx, reader); err != nil {
return enginepb.MVCCStats{}, err
} else if as != nil {
return as.RangeStats.ToStats(), nil
}
// If the range applied state is not found, check the legacy stats
// key. This is where stats were stored before the range applied
// state was introduced.
var ms enginepb.MVCCStats
_, err := engine.MVCCGetProto(ctx, reader, rsl.RangeStatsLegacyKey(), hlc.Timestamp{}, &ms,
engine.MVCCGetOptions{})
return ms, err
}
// SetRangeAppliedState overwrites the range applied state. This state is a
// combination of the Raft and lease applied indices, along with the MVCC stats.
//
// The applied indices and the stats used to be stored separately in different
// keys. We now deem those keys to be "legacy" because they have been replaced
// by the range applied state key.
func (rsl StateLoader) SetRangeAppliedState(
ctx context.Context,
eng engine.ReadWriter,
appliedIndex, leaseAppliedIndex uint64,
newMS *enginepb.MVCCStats,
) error {
as := enginepb.RangeAppliedState{
RaftAppliedIndex: appliedIndex,
LeaseAppliedIndex: leaseAppliedIndex,
RangeStats: newMS.ToPersistentStats(),
}
// The RangeAppliedStateKey is not included in stats. This is also reflected
// in C.MVCCComputeStats and ComputeStatsGo.
ms := (*enginepb.MVCCStats)(nil)
return engine.MVCCPutProto(ctx, eng, ms, rsl.RangeAppliedStateKey(), hlc.Timestamp{}, nil, &as)
}
// MigrateToRangeAppliedStateKey TODO
func (rsl StateLoader) MigrateToRangeAppliedStateKey(
ctx context.Context, eng engine.ReadWriter, ms *enginepb.MVCCStats,
) error {
noTS := hlc.Timestamp{}
if err := engine.MVCCDelete(ctx, eng, ms, rsl.RaftAppliedIndexLegacyKey(), noTS, nil); err != nil {
return err
}
if err := engine.MVCCDelete(ctx, eng, ms, rsl.LeaseAppliedIndexLegacyKey(), noTS, nil); err != nil {
return err
}
return engine.MVCCDelete(ctx, eng, ms, rsl.RangeStatsLegacyKey(), noTS, nil)
}
// SetLegacyAppliedIndex sets the legacy {raft,lease} applied index values,
// properly accounting for existing keys in the returned stats.
//
// The range applied state key cannot already exist or an assetion will be
// triggered. See comment on SetRangeAppliedState for why this is "legacy".
func (rsl StateLoader) SetLegacyAppliedIndex(
ctx context.Context,
eng engine.ReadWriter,
ms *enginepb.MVCCStats,
appliedIndex, leaseAppliedIndex uint64,
) error {
if err := rsl.AssertNoRangeAppliedState(ctx, eng); err != nil {
return err
}
var value roachpb.Value
value.SetInt(int64(appliedIndex))
if err := engine.MVCCPut(ctx, eng, ms,
rsl.RaftAppliedIndexLegacyKey(),
hlc.Timestamp{},
value,
nil /* txn */); err != nil {
return err
}
value.SetInt(int64(leaseAppliedIndex))
return engine.MVCCPut(ctx, eng, ms,
rsl.LeaseAppliedIndexLegacyKey(),
hlc.Timestamp{},
value,
nil /* txn */)
}
// SetLegacyAppliedIndexBlind sets the legacy {raft,lease} applied index values
// using a "blind" put which ignores any existing keys. This is identical to
// SetLegacyAppliedIndex but is used to optimize the writing of the applied
// index values during write operations where we definitively know the size of
// the previous values.
//
// The range applied state key cannot already exist or an assetion will be
// triggered. See comment on SetRangeAppliedState for why this is "legacy".
func (rsl StateLoader) SetLegacyAppliedIndexBlind(
ctx context.Context,
eng engine.ReadWriter,
ms *enginepb.MVCCStats,
appliedIndex, leaseAppliedIndex uint64,
) error {
if err := rsl.AssertNoRangeAppliedState(ctx, eng); err != nil {
return err
}
var value roachpb.Value
value.SetInt(int64(appliedIndex))
if err := engine.MVCCBlindPut(ctx, eng, ms,
rsl.RaftAppliedIndexLegacyKey(),
hlc.Timestamp{},
value,
nil /* txn */); err != nil {
return err
}
value.SetInt(int64(leaseAppliedIndex))
return engine.MVCCBlindPut(ctx, eng, ms,
rsl.LeaseAppliedIndexLegacyKey(),
hlc.Timestamp{},
value,
nil /* txn */)
}
func inlineValueIntEncodedSize(v int64) int {
var value roachpb.Value
value.SetInt(v)
meta := enginepb.MVCCMetadata{RawBytes: value.RawBytes}
return meta.Size()
}
// CalcAppliedIndexSysBytes calculates the size (MVCCStats.SysBytes) of the {raft,lease} applied
// index keys/values.
func (rsl StateLoader) CalcAppliedIndexSysBytes(appliedIndex, leaseAppliedIndex uint64) int64 {
return int64(engine.MakeMVCCMetadataKey(rsl.RaftAppliedIndexLegacyKey()).EncodedSize() +
engine.MakeMVCCMetadataKey(rsl.LeaseAppliedIndexLegacyKey()).EncodedSize() +
inlineValueIntEncodedSize(int64(appliedIndex)) +
inlineValueIntEncodedSize(int64(leaseAppliedIndex)))
}
func (rsl StateLoader) writeLegacyMVCCStatsInternal(
ctx context.Context, eng engine.ReadWriter, newMS *enginepb.MVCCStats,
) error {
return engine.MVCCPutProto(ctx, eng, nil, rsl.RangeStatsLegacyKey(), hlc.Timestamp{}, nil, newMS)
}
// SetLegacyMVCCStats overwrites the legacy MVCC stats key.
//
// The range applied state key cannot already exist or an assetion will be
// triggered. See comment on SetRangeAppliedState for why this is "legacy".
func (rsl StateLoader) SetLegacyMVCCStats(
ctx context.Context, eng engine.ReadWriter, newMS *enginepb.MVCCStats,
) error {
if err := rsl.AssertNoRangeAppliedState(ctx, eng); err != nil {
return err
}
return rsl.writeLegacyMVCCStatsInternal(ctx, eng, newMS)
}
// SetMVCCStats overwrites the MVCC stats. This needs to perform a read on the
// RangeAppliedState key before overwriting the stats. Use SetRangeAppliedState
// when performance is important.
func (rsl StateLoader) SetMVCCStats(
ctx context.Context, eng engine.ReadWriter, newMS *enginepb.MVCCStats,
) error {
if as, err := rsl.LoadRangeAppliedState(ctx, eng); err != nil {
return err
} else if as != nil {
return rsl.SetRangeAppliedState(ctx, eng, as.RaftAppliedIndex, as.LeaseAppliedIndex, newMS)
}
return rsl.writeLegacyMVCCStatsInternal(ctx, eng, newMS)
}
// SetLegacyRaftTruncatedState overwrites the truncated state.
func (rsl StateLoader) SetLegacyRaftTruncatedState(
ctx context.Context,
eng engine.ReadWriter,
ms *enginepb.MVCCStats,
truncState *roachpb.RaftTruncatedState,
) error {
if (*truncState == roachpb.RaftTruncatedState{}) {
return errors.New("cannot persist empty RaftTruncatedState")
}
return engine.MVCCPutProto(ctx, eng, ms,
rsl.RaftTruncatedStateLegacyKey(), hlc.Timestamp{}, nil, truncState)
}
// LoadGCThreshold loads the GC threshold.
func (rsl StateLoader) LoadGCThreshold(
ctx context.Context, reader engine.Reader,
) (*hlc.Timestamp, error) {
var t hlc.Timestamp
_, err := engine.MVCCGetProto(ctx, reader, rsl.RangeLastGCKey(),
hlc.Timestamp{}, &t, engine.MVCCGetOptions{})
return &t, err
}
// SetGCThreshold sets the GC threshold.
func (rsl StateLoader) SetGCThreshold(
ctx context.Context, eng engine.ReadWriter, ms *enginepb.MVCCStats, threshold *hlc.Timestamp,
) error {
if threshold == nil {
return errors.New("cannot persist nil GCThreshold")
}
return engine.MVCCPutProto(ctx, eng, ms,
rsl.RangeLastGCKey(), hlc.Timestamp{}, nil, threshold)
}
// LoadTxnSpanGCThreshold loads the transaction GC threshold.
func (rsl StateLoader) LoadTxnSpanGCThreshold(
ctx context.Context, reader engine.Reader,
) (*hlc.Timestamp, error) {
var t hlc.Timestamp
_, err := engine.MVCCGetProto(ctx, reader, rsl.RangeTxnSpanGCThresholdKey(),
hlc.Timestamp{}, &t, engine.MVCCGetOptions{})
return &t, err
}
// SetTxnSpanGCThreshold overwrites the transaction GC threshold.
func (rsl StateLoader) SetTxnSpanGCThreshold(
ctx context.Context, eng engine.ReadWriter, ms *enginepb.MVCCStats, threshold *hlc.Timestamp,
) error {
if threshold == nil {
return errors.New("cannot persist nil TxnSpanGCThreshold")
}
return engine.MVCCPutProto(ctx, eng, ms,
rsl.RangeTxnSpanGCThresholdKey(), hlc.Timestamp{}, nil, threshold)
}
// The rest is not technically part of ReplicaState.
// LoadLastIndex loads the last index.
func (rsl StateLoader) LoadLastIndex(ctx context.Context, reader engine.Reader) (uint64, error) {
prefix := rsl.RaftLogPrefix()
iter := reader.NewIterator(engine.IterOptions{LowerBound: prefix})
defer iter.Close()
var lastIndex uint64
iter.SeekReverse(engine.MakeMVCCMetadataKey(rsl.RaftLogKey(math.MaxUint64)))
if ok, _ := iter.Valid(); ok {
key := iter.Key()
var err error
_, lastIndex, err = encoding.DecodeUint64Ascending(key.Key[len(prefix):])
if err != nil {
log.Fatalf(ctx, "unable to decode Raft log index key: %s", key)
}
}
if lastIndex == 0 {
// The log is empty, which means we are either starting from scratch
// or the entire log has been truncated away.
lastEnt, _, err := rsl.LoadRaftTruncatedState(ctx, reader)
if err != nil {
return 0, err
}
lastIndex = lastEnt.Index
}
return lastIndex, nil
}
// LoadRaftTruncatedState loads the truncated state. The returned boolean returns
// whether the result was read from the TruncatedStateLegacyKey. If both keys
// are missing, it is false which is used to migrate into the unreplicated key.
//
// See VersionUnreplicatedRaftTruncatedState.
func (rsl StateLoader) LoadRaftTruncatedState(
ctx context.Context, reader engine.Reader,
) (_ roachpb.RaftTruncatedState, isLegacy bool, _ error) {
var truncState roachpb.RaftTruncatedState
if found, err := engine.MVCCGetProto(
ctx, reader, rsl.RaftTruncatedStateKey(), hlc.Timestamp{}, &truncState, engine.MVCCGetOptions{},
); err != nil {
return roachpb.RaftTruncatedState{}, false, err
} else if found {
return truncState, false, nil
}
// If the "new" truncated state isn't there (yet), fall back to the legacy
// truncated state. The next log truncation will atomically rewrite them
// assuming the cluster version has advanced sufficiently.
//
// See VersionUnreplicatedRaftTruncatedState.
legacyFound, err := engine.MVCCGetProto(
ctx, reader, rsl.RaftTruncatedStateLegacyKey(), hlc.Timestamp{}, &truncState, engine.MVCCGetOptions{},
)
if err != nil {
return roachpb.RaftTruncatedState{}, false, err
}
return truncState, legacyFound, nil
}
// SetRaftTruncatedState overwrites the truncated state.
func (rsl StateLoader) SetRaftTruncatedState(
ctx context.Context, eng engine.ReadWriter, truncState *roachpb.RaftTruncatedState,
) error {
if (*truncState == roachpb.RaftTruncatedState{}) {
return errors.New("cannot persist empty RaftTruncatedState")
}
return engine.MVCCPutProto(ctx, eng, nil, /* ms */
rsl.RaftTruncatedStateKey(), hlc.Timestamp{}, nil, truncState)
}
// LoadReplicaDestroyedError loads the replica destroyed error for the specified
// range. If there is no error, nil is returned.
func (rsl StateLoader) LoadReplicaDestroyedError(
ctx context.Context, reader engine.Reader,
) (*roachpb.Error, error) {
var v roachpb.Error
found, err := engine.MVCCGetProto(ctx, reader,
rsl.RangeReplicaDestroyedErrorKey(),
hlc.Timestamp{}, &v, engine.MVCCGetOptions{})
if err != nil {
return nil, err
}
if !found {
return nil, nil
}
return &v, nil
}
// SetReplicaDestroyedError sets an error indicating that the replica has been
// destroyed.
func (rsl StateLoader) SetReplicaDestroyedError(
ctx context.Context, eng engine.ReadWriter, err *roachpb.Error,
) error {
return engine.MVCCPutProto(ctx, eng, nil,
rsl.RangeReplicaDestroyedErrorKey(), hlc.Timestamp{}, nil /* txn */, err)
}
// LoadHardState loads the HardState.
func (rsl StateLoader) LoadHardState(
ctx context.Context, reader engine.Reader,
) (raftpb.HardState, error) {
var hs raftpb.HardState
found, err := engine.MVCCGetProto(ctx, reader, rsl.RaftHardStateKey(),
hlc.Timestamp{}, &hs, engine.MVCCGetOptions{})
if !found || err != nil {
return raftpb.HardState{}, err
}
return hs, nil
}
// SetHardState overwrites the HardState.
func (rsl StateLoader) SetHardState(
ctx context.Context, batch engine.ReadWriter, st raftpb.HardState,
) error {
return engine.MVCCPutProto(ctx, batch, nil,
rsl.RaftHardStateKey(), hlc.Timestamp{}, nil, &st)
}
// SynthesizeRaftState creates a Raft state which synthesizes both a HardState
// and a lastIndex from pre-seeded data in the engine (typically created via
// writeInitialReplicaState and, on a split, perhaps the activity of an
// uninitialized Raft group)
func (rsl StateLoader) SynthesizeRaftState(ctx context.Context, eng engine.ReadWriter) error {
hs, err := rsl.LoadHardState(ctx, eng)
if err != nil {
return err
}
truncState, _, err := rsl.LoadRaftTruncatedState(ctx, eng)
if err != nil {
return err
}
raftAppliedIndex, _, err := rsl.LoadAppliedIndex(ctx, eng)
if err != nil {
return err
}
return rsl.SynthesizeHardState(ctx, eng, hs, truncState, raftAppliedIndex)
}
// SynthesizeHardState synthesizes an on-disk HardState from the given input,
// taking care that a HardState compatible with the existing data is written.
func (rsl StateLoader) SynthesizeHardState(
ctx context.Context,
eng engine.ReadWriter,
oldHS raftpb.HardState,
truncState roachpb.RaftTruncatedState,
raftAppliedIndex uint64,
) error {
newHS := raftpb.HardState{
Term: truncState.Term,
// Note that when applying a Raft snapshot, the applied index is
// equal to the Commit index represented by the snapshot.
Commit: raftAppliedIndex,
}
if oldHS.Commit > newHS.Commit {
return log.Safe(errors.Errorf("can't decrease HardState.Commit from %d to %d",
oldHS.Commit, newHS.Commit))
}
if oldHS.Term > newHS.Term {
// The existing HardState is allowed to be ahead of us, which is
// relevant in practice for the split trigger. We already checked above
// that we're not rewinding the acknowledged index, and we haven't
// updated votes yet.
newHS.Term = oldHS.Term
}
// If the existing HardState voted in this term, remember that.
if oldHS.Term == newHS.Term {
newHS.Vote = oldHS.Vote
}
err := rsl.SetHardState(ctx, eng, newHS)
return errors.Wrapf(err, "writing HardState %+v", &newHS)
}