Skip to content

Commit ad9fdc6

Browse files
tbgtbg
committed
snaprecv: make methods private
1 parent 53c301b commit ad9fdc6

File tree

3 files changed

+27
-25
lines changed

3 files changed

+27
-25
lines changed

‎pkg/kv/kvserver/kv_snapshot_strategy.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ func (kvSS *kvBatchSnapshotStrategy) Receive(
172172
// All batch operations are guaranteed to be point key or range key puts.
173173
for batchReader.Next() {
174174
// TODO(lyang24): maybe avoid decoding engine key twice.
175-
// msstw calls (i.e. PutInternalPointKey) can use the decoded engine key here as input.
175+
// msstw calls (i.e. putInternalPointKey) can use the decoded engine key here as input.
176176

177177
bytesEstimate := msstw.EstimatedDataSize()
178178
delta := bytesEstimate - prevBytesEstimate

‎pkg/kv/kvserver/kvstorage/snaprecv/multi_sst_writer.go‎

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -114,14 +114,14 @@ func (msstw *MultiSSTWriter) ReadOne(
114114
) error {
115115
switch batchReader.KeyKind() {
116116
case pebble.InternalKeyKindSet, pebble.InternalKeyKindSetWithDelete:
117-
if err := msstw.Put(ctx, ek, batchReader.Value()); err != nil {
117+
if err := msstw.put(ctx, ek, batchReader.Value()); err != nil {
118118
return errors.Wrapf(err, "writing sst for raft snapshot")
119119
}
120120
case pebble.InternalKeyKindDelete, pebble.InternalKeyKindDeleteSized:
121121
if !shared {
122122
return errors.AssertionFailedf("unexpected batch entry key kind %d", batchReader.KeyKind())
123123
}
124-
if err := msstw.PutInternalPointKey(ctx, batchReader.Key(), batchReader.KeyKind(), nil); err != nil {
124+
if err := msstw.putInternalPointKey(ctx, batchReader.Key(), batchReader.KeyKind(), nil); err != nil {
125125
return errors.Wrapf(err, "writing sst for raft snapshot")
126126
}
127127
case pebble.InternalKeyKindRangeDelete:
@@ -133,7 +133,7 @@ func (msstw *MultiSSTWriter) ReadOne(
133133
if err != nil {
134134
return err
135135
}
136-
if err := msstw.PutInternalRangeDelete(ctx, start, end); err != nil {
136+
if err := msstw.putInternalRangeDelete(ctx, start, end); err != nil {
137137
return errors.Wrapf(err, "writing sst for raft snapshot")
138138
}
139139

@@ -151,7 +151,7 @@ func (msstw *MultiSSTWriter) ReadOne(
151151
return err
152152
}
153153
for _, rkv := range rangeKeys {
154-
err := msstw.PutInternalRangeKey(ctx, start, end, rkv)
154+
err := msstw.putInternalRangeKey(ctx, start, end, rkv)
155155
if err != nil {
156156
return errors.Wrapf(err, "writing sst for raft snapshot")
157157
}
@@ -167,7 +167,7 @@ func (msstw *MultiSSTWriter) ReadOne(
167167
return err
168168
}
169169
for _, rkv := range rangeKeys {
170-
err := msstw.PutRangeKey(ctx, start.Key, end.Key, rkv.Version, rkv.Value)
170+
err := msstw.putRangeKey(ctx, start.Key, end.Key, rkv.Version, rkv.Value)
171171
if err != nil {
172172
return errors.Wrapf(err, "writing sst for raft snapshot")
173173
}
@@ -370,7 +370,7 @@ func (msstw *MultiSSTWriter) rolloverSST(
370370
return nil
371371
}
372372

373-
func (msstw *MultiSSTWriter) Put(ctx context.Context, key storage.EngineKey, value []byte) error {
373+
func (msstw *MultiSSTWriter) put(ctx context.Context, key storage.EngineKey, value []byte) error {
374374
if err := msstw.rolloverSST(ctx, key, key); err != nil {
375375
return err
376376
}
@@ -380,7 +380,7 @@ func (msstw *MultiSSTWriter) Put(ctx context.Context, key storage.EngineKey, val
380380
return nil
381381
}
382382

383-
func (msstw *MultiSSTWriter) PutInternalPointKey(
383+
func (msstw *MultiSSTWriter) putInternalPointKey(
384384
ctx context.Context, key []byte, kind pebble.InternalKeyKind, val []byte,
385385
) error {
386386
decodedKey, ok := storage.DecodeEngineKey(key)
@@ -423,7 +423,7 @@ func decodeRangeStartEnd(
423423
return decodedStart, decodedEnd, nil
424424
}
425425

426-
func (msstw *MultiSSTWriter) PutInternalRangeDelete(ctx context.Context, start, end []byte) error {
426+
func (msstw *MultiSSTWriter) putInternalRangeDelete(ctx context.Context, start, end []byte) error {
427427
decodedStart, decodedEnd, err := decodeRangeStartEnd(start, end)
428428
if err != nil {
429429
return err
@@ -435,17 +435,19 @@ func (msstw *MultiSSTWriter) PutInternalRangeDelete(ctx context.Context, start,
435435
return nil
436436
}
437437

438-
func (msstw *MultiSSTWriter) PutInternalRangeKey(
438+
func (msstw *MultiSSTWriter) putInternalRangeKey(
439439
ctx context.Context, start, end []byte, key rangekey.Key,
440440
) error {
441-
return msstw.putRangeKey(ctx, storage.EngineKeyRange{}, [2][]byte{start, end}, key)
441+
return msstw.putRangeKeyWithEnc(ctx, storage.EngineKeyRange{}, [2][]byte{start, end}, key)
442442
}
443443

444-
func (msstw *MultiSSTWriter) putRangeKey(
444+
// putRangeKeyWithEnc is the internal implementation of putInternalRangeKey and
445+
// putRangeKey. We need both the encoded and decoded forms of the key range
446+
// here. The caller must supply at least one of `dec` or `enc` depending on what
447+
// they have available.
448+
func (msstw *MultiSSTWriter) putRangeKeyWithEnc(
445449
ctx context.Context, dec storage.EngineKeyRange, enc [2][]byte, key rangekey.Key,
446450
) error {
447-
// We need both the encoded and decoded forms of the key range here. The caller
448-
// may supply either.
449451
haveDec, haveEnc := len(dec.End.Key) != 0, len(enc[1]) != 0
450452
switch {
451453
case !haveDec && !haveEnc:
@@ -480,10 +482,10 @@ func (msstw *MultiSSTWriter) putRangeKey(
480482
return nil
481483
}
482484

483-
func (msstw *MultiSSTWriter) PutRangeKey(
485+
func (msstw *MultiSSTWriter) putRangeKey(
484486
ctx context.Context, start, end roachpb.Key, suffix []byte, value []byte,
485487
) error {
486-
return msstw.putRangeKey(
488+
return msstw.putRangeKeyWithEnc(
487489
ctx,
488490
storage.EngineKeyRange{
489491
Start: storage.EngineKey{Key: start},

‎pkg/kv/kvserver/kvstorage/snaprecv/sst_snapshot_storage_test.go‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -350,11 +350,11 @@ func testMultiSSTWriterInitSSTInner(t *testing.T, interesting bool) {
350350
// in stats when the SST is flushed.
351351
k := storage.EngineKey{Key: span.Key}.Encode()
352352
ek := storage.EngineKey{Key: span.EndKey}.Encode()
353-
require.NoError(t, msstw.PutInternalRangeDelete(ctx, k, ek))
353+
require.NoError(t, msstw.putInternalRangeDelete(ctx, k, ek))
354354
rk := rangekey.Key{
355355
Trailer: pebble.MakeInternalKeyTrailer(0, pebble.InternalKeyKindRangeKeySet),
356356
}
357-
require.NoError(t, msstw.PutInternalRangeKey(ctx, k, ek, rk))
357+
require.NoError(t, msstw.putInternalRangeKey(ctx, k, ek, rk))
358358
_, _ = fmt.Fprintf(&buf, ">> rangekeyset [%s-%s)\n", span.Key, span.EndKey)
359359
logSize(&buf)
360360
}
@@ -433,7 +433,7 @@ func TestMultiSSTWriterSize(t *testing.T) {
433433
now := timeutil.Now().UnixNano()
434434

435435
for i := range localSpans {
436-
require.NoError(t, referenceMsstw.Put(ctx, storage.EngineKey{Key: localSpans[i].Key}, []byte("foo")))
436+
require.NoError(t, referenceMsstw.put(ctx, storage.EngineKey{Key: localSpans[i].Key}, []byte("foo")))
437437
}
438438

439439
for i := 0; i < 1000; i++ {
@@ -445,10 +445,10 @@ func TestMultiSSTWriterSize(t *testing.T) {
445445
if i%50 == 0 {
446446
// Add a range key.
447447
endKey := binary.BigEndian.AppendUint32(desc.StartKey, uint32(i+10))
448-
require.NoError(t, referenceMsstw.PutRangeKey(
448+
require.NoError(t, referenceMsstw.putRangeKey(
449449
ctx, key, endKey, mvccencoding.EncodeMVCCTimestampSuffix(mvccKey.Timestamp.WallPrev()), []byte("")))
450450
}
451-
require.NoError(t, referenceMsstw.Put(ctx, engineKey, []byte("foobarbaz")))
451+
require.NoError(t, referenceMsstw.put(ctx, engineKey, []byte("foobarbaz")))
452452
}
453453
_, _, err = referenceMsstw.Finish(ctx)
454454
require.NoError(t, err)
@@ -464,7 +464,7 @@ func TestMultiSSTWriterSize(t *testing.T) {
464464
require.Equal(t, int64(0), multiSSTWriter.dataSize)
465465

466466
for i := range localSpans {
467-
require.NoError(t, multiSSTWriter.Put(ctx, storage.EngineKey{Key: localSpans[i].Key}, []byte("foo")))
467+
require.NoError(t, multiSSTWriter.put(ctx, storage.EngineKey{Key: localSpans[i].Key}, []byte("foo")))
468468
}
469469

470470
for i := 0; i < 1000; i++ {
@@ -475,10 +475,10 @@ func TestMultiSSTWriterSize(t *testing.T) {
475475
if i%50 == 0 {
476476
// Add a range key.
477477
endKey := binary.BigEndian.AppendUint32(desc.StartKey, uint32(i+10))
478-
require.NoError(t, multiSSTWriter.PutRangeKey(
478+
require.NoError(t, multiSSTWriter.putRangeKey(
479479
ctx, key, endKey, mvccencoding.EncodeMVCCTimestampSuffix(mvccKey.Timestamp.WallPrev()), []byte("")))
480480
}
481-
require.NoError(t, multiSSTWriter.Put(ctx, engineKey, []byte("foobarbaz")))
481+
require.NoError(t, multiSSTWriter.put(ctx, engineKey, []byte("foobarbaz")))
482482
}
483483

484484
_, _, err = multiSSTWriter.Finish(ctx)
@@ -545,7 +545,7 @@ func TestMultiSSTWriterAddLastSpan(t *testing.T) {
545545
require.NoError(t, err)
546546
testKey := storage.MVCCKey{Key: roachpb.RKey("d1").AsRawKey(), Timestamp: hlc.Timestamp{WallTime: 1}}
547547
testEngineKey, _ := storage.DecodeEngineKey(storage.EncodeMVCCKey(testKey))
548-
require.NoError(t, msstw.Put(ctx, testEngineKey, []byte("foo")))
548+
require.NoError(t, msstw.put(ctx, testEngineKey, []byte("foo")))
549549
_, _, err = msstw.Finish(ctx)
550550
require.NoError(t, err)
551551

0 commit comments

Comments
 (0)