metamorphic: add changes to iterOpts in metamorphic settings for new SeekPrefix lazy positioning

Part of #2002
Previous #5256

Author: Sachuman

metamorphic/cockroachkvs.go

@@ -162,6 +162,11 @@ func (kg *cockroachKeyGenerator) IncMaxSuffix() []byte {
 	return kg.suffixSpace.ToMaterializedSuffix(s)
 }
 
+// MaximumSuffixProperty returns the maximum suffix property.
+func (kg *cockroachKeyGenerator) MaximumSuffixProperty() pebble.MaximumSuffixProperty {
+	return cockroachkvs.MaxMVCCTimestampProperty{}
+}
+
 // SuffixRange generates a new uniformly random range of suffixes (low, high]
 // such that high is guaranteed to be strictly greater (as defined by
 // ComparePointSuffixes) than low.

metamorphic/config.go

@@ -440,4 +440,7 @@ type KeyGenerator interface {
 	//
 	// May return a nil suffix.
 	UniformSuffix() []byte
+	// MaximumSuffixProperty returns the maximum suffix property used during
+	// the lazy position of SeekPrefixGE optimization.
+	MaximumSuffixProperty() pebble.MaximumSuffixProperty
 }

metamorphic/generator.go

@@ -48,12 +48,16 @@ type iterOpts struct {
 	// see IterOptions.UseL6Filters.
 	useL6Filters bool
 
+	// MaximumSuffixProperty is the maximum suffix property used during the lazy
+	// position of SeekPrefixGE optimization.
+	maximumSuffixProperty pebble.MaximumSuffixProperty
 	// NB: If adding or removing fields, ensure IsZero is in sync.
 }
 
 func (o iterOpts) IsZero() bool {
 	return o.lower == nil && o.upper == nil && o.keyTypes == 0 &&
-		o.maskSuffix == nil && o.filterMin == nil && o.filterMax == nil && !o.useL6Filters
+		o.maskSuffix == nil && o.filterMin == nil && o.filterMax == nil && !o.useL6Filters &&
+		o.maximumSuffixProperty == nil
 }
 
 // GenerateOps generates n random operations, drawing randomness from the
@@ -566,6 +570,11 @@ func (g *generator) newIter() {
 		opts.useL6Filters = true
 	}
 
+	// With 20% probability, enable the lazy positioning SeekPrefixGE optimization.
+	if g.rng.Float64() <= 0.2 {
+		opts.maximumSuffixProperty = g.keyGenerator.MaximumSuffixProperty()
+	}
+
 	g.itersLastOpts[iterID] = opts
 	g.iterVisibleKeys[iterID] = g.keyManager.getSetOfVisibleKeys(readerID)
 	g.iterReaderID[iterID] = readerID
@@ -1562,6 +1571,10 @@ func (g *generator) maybeMutateOptions(readerID objID, opts *iterOpts) {
 		if g.rng.Float64() <= 0.1 {
 			opts.useL6Filters = !opts.useL6Filters
 		}
+		// With 20% probability, clear existing maximum suffix property.
+		if opts.maximumSuffixProperty != nil && g.rng.IntN(5) == 0 {
+			opts.maximumSuffixProperty = nil
+		}
 	}
 }
 

metamorphic/ops.go

@@ -19,6 +19,7 @@ import (
 
 	"github.com/cockroachdb/errors"
 	"github.com/cockroachdb/pebble"
+	"github.com/cockroachdb/pebble/cockroachkvs"
 	"github.com/cockroachdb/pebble/internal/base"
 	"github.com/cockroachdb/pebble/internal/keyspan"
 	"github.com/cockroachdb/pebble/internal/private"
@@ -564,6 +565,32 @@ func (o *rangeKeySetOp) diagramKeyRanges() []pebble.KeyRange {
 	return []pebble.KeyRange{{Start: o.start, End: o.end}}
 }
 
+// Helper functions to serialize/deserialize MaximumSuffixProperty for metamorphic tests
+func serializeMaximumSuffixProperty(prop pebble.MaximumSuffixProperty) string {
+	if prop == nil {
+		return "nil"
+	}
+	switch prop.(type) {
+	case sstable.MaxTestKeysSuffixProperty:
+		return "testkeys"
+	default:
+		return "cockroachkvs"
+	}
+}
+
+func deserializeMaximumSuffixProperty(s string) pebble.MaximumSuffixProperty {
+	switch s {
+	case "nil":
+		return nil
+	case "testkeys":
+		return sstable.MaxTestKeysSuffixProperty{}
+	case "cockroachkvs":
+		return cockroachkvs.MaxMVCCTimestampProperty{}
+	default:
+		return nil
+	}
+}
+
 // rangeKeyUnsetOp models a Write.RangeKeyUnset operation.
 type rangeKeyUnsetOp struct {
 	writerID objID
@@ -1206,10 +1233,10 @@ func (o *newIterOp) run(t *Test, h historyRecorder) {
 }
 
 func (o *newIterOp) formattedString(kf KeyFormat) string {
-	return fmt.Sprintf("%s = %s.NewIter(%q, %q, %d /* key types */, %q, %q, %t /* use L6 filters */, %q /* masking suffix */)",
+	return fmt.Sprintf("%s = %s.NewIter(%q, %q, %d /* key types */, %q, %q, %t /* use L6 filters */, %q /* masking suffix */, %q /* maximum suffix property */)",
 		o.iterID, o.readerID, kf.FormatKey(o.lower), kf.FormatKey(o.upper),
 		o.keyTypes, kf.FormatKeySuffix(o.filterMax), kf.FormatKeySuffix(o.filterMin),
-		o.useL6Filters, kf.FormatKeySuffix(o.maskSuffix))
+		o.useL6Filters, kf.FormatKeySuffix(o.maskSuffix), serializeMaximumSuffixProperty(o.maximumSuffixProperty))
 }
 
 func (o *newIterOp) receiver() objID { return o.readerID }
@@ -1273,10 +1300,10 @@ func (o *newIterUsingCloneOp) run(t *Test, h historyRecorder) {
 }
 
 func (o *newIterUsingCloneOp) formattedString(kf KeyFormat) string {
-	return fmt.Sprintf("%s = %s.Clone(%t, %q, %q, %d /* key types */, %q, %q, %t /* use L6 filters */, %q /* masking suffix */)",
+	return fmt.Sprintf("%s = %s.Clone(%t, %q, %q, %d /* key types */, %q, %q, %t /* use L6 filters */, %q /* masking suffix */, %q /* maximum suffix property */)",
 		o.iterID, o.existingIterID, o.refreshBatch, kf.FormatKey(o.lower),
 		kf.FormatKey(o.upper), o.keyTypes, kf.FormatKeySuffix(o.filterMax),
-		kf.FormatKeySuffix(o.filterMin), o.useL6Filters, kf.FormatKeySuffix(o.maskSuffix))
+		kf.FormatKeySuffix(o.filterMin), o.useL6Filters, kf.FormatKeySuffix(o.maskSuffix), serializeMaximumSuffixProperty(o.maximumSuffixProperty))
 }
 
 func (o *newIterUsingCloneOp) receiver() objID { return o.existingIterID }
@@ -1370,10 +1397,10 @@ func (o *iterSetOptionsOp) run(t *Test, h historyRecorder) {
 }
 
 func (o *iterSetOptionsOp) formattedString(kf KeyFormat) string {
-	return fmt.Sprintf("%s.SetOptions(%q, %q, %d /* key types */, %q, %q, %t /* use L6 filters */, %q /* masking suffix */)",
+	return fmt.Sprintf("%s.SetOptions(%q, %q, %d /* key types */, %q, %q, %t /* use L6 filters */, %q /* masking suffix */, %q /* maximum suffix property */)",
 		o.iterID, kf.FormatKey(o.lower), kf.FormatKey(o.upper),
 		o.keyTypes, kf.FormatKeySuffix(o.filterMax), kf.FormatKeySuffix(o.filterMin),
-		o.useL6Filters, kf.FormatKeySuffix(o.maskSuffix))
+		o.useL6Filters, kf.FormatKeySuffix(o.maskSuffix), serializeMaximumSuffixProperty(o.maximumSuffixProperty))
 }
 
 func iterOptions(kf KeyFormat, o iterOpts) *pebble.IterOptions {
@@ -1394,8 +1421,9 @@ func iterOptions(kf KeyFormat, o iterOpts) *pebble.IterOptions {
 		RangeKeyMasking: pebble.RangeKeyMasking{
 			Suffix: o.maskSuffix,
 		},
-		UseL6Filters:       o.useL6Filters,
-		DebugRangeKeyStack: debugIterators,
+		UseL6Filters:          o.useL6Filters,
+		DebugRangeKeyStack:    debugIterators,
+		MaximumSuffixProperty: o.maximumSuffixProperty,
 	}
 	if opts.RangeKeyMasking.Suffix != nil {
 		opts.RangeKeyMasking.Filter = kf.NewSuffixFilterMask

metamorphic/parser.go

@@ -93,9 +93,9 @@ func opArgs(op op) (receiverID *objID, targetID *objID, args []interface{}) {
 	case *newIndexedBatchOp:
 		return &t.dbID, &t.batchID, nil
 	case *newIterOp:
-		return &t.readerID, &t.iterID, []interface{}{&t.lower, &t.upper, &t.keyTypes, &t.filterMax, &t.filterMin, &t.useL6Filters, &t.maskSuffix}
+		return &t.readerID, &t.iterID, []interface{}{&t.lower, &t.upper, &t.keyTypes, &t.filterMax, &t.filterMin, &t.useL6Filters, &t.maskSuffix, &t.maximumSuffixProperty}
 	case *newIterUsingCloneOp:
-		return &t.existingIterID, &t.iterID, []interface{}{&t.refreshBatch, &t.lower, &t.upper, &t.keyTypes, &t.filterMax, &t.filterMin, &t.useL6Filters, &t.maskSuffix}
+		return &t.existingIterID, &t.iterID, []interface{}{&t.refreshBatch, &t.lower, &t.upper, &t.keyTypes, &t.filterMax, &t.filterMin, &t.useL6Filters, &t.maskSuffix, &t.maximumSuffixProperty}
 	case *newSnapshotOp:
 		return &t.dbID, &t.snapID, []interface{}{&t.bounds}
 	case *newExternalObjOp:
@@ -119,7 +119,7 @@ func opArgs(op op) (receiverID *objID, targetID *objID, args []interface{}) {
 	case *iterSetBoundsOp:
 		return &t.iterID, nil, []interface{}{&t.lower, &t.upper}
 	case *iterSetOptionsOp:
-		return &t.iterID, nil, []interface{}{&t.lower, &t.upper, &t.keyTypes, &t.filterMax, &t.filterMin, &t.useL6Filters, &t.maskSuffix}
+		return &t.iterID, nil, []interface{}{&t.lower, &t.upper, &t.keyTypes, &t.filterMax, &t.filterMin, &t.useL6Filters, &t.maskSuffix, &t.maximumSuffixProperty}
 	case *singleDeleteOp:
 		return &t.writerID, nil, []interface{}{&t.key, &t.maybeReplaceDelete}
 	case *rangeKeyDeleteOp:
@@ -408,6 +408,14 @@ func (p *parser) parseArgs(op op, methodName string, args []interface{}) {
 			}
 			*t = pebble.FormatMajorVersion(val)
 
+		case *pebble.MaximumSuffixProperty:
+			elem.expectToken(p, token.STRING)
+			s, err := strconv.Unquote(elem.lit)
+			if err != nil {
+				panic(p.errorf(elem.pos, "error parsing %q: %s", elem.lit, err))
+			}
+			*t = deserializeMaximumSuffixProperty(s)
+
 		default:
 			panic(p.errorf(pos, "%s: unsupported arg[%d] type: %T", methodName, i, args[i]))
 		}

metamorphic/testdata/diagram

@@ -5,7 +5,7 @@ snap9 = db2.NewSnapshot("a", "z")
 db2.RangeKeyDelete("d", "f")
 db2.Compact("g", "i", true /* parallelize */)
 db2.Replicate(db1, "b", "f")
-iter25 = db1.NewIter("", "", 2 /* key types */, "", "", false /* use L6 filters */, "@7" /* masking suffix */)
+iter25 = db1.NewIter("", "", 2 /* key types */, "", "", false /* use L6 filters */, "@7" /* masking suffix */, "nil" /* maximum suffix property */)
 iter25.SeekGE("e", "")
 ----
                                                         Init(2 /* dbs */, 49 /* batches */, 63 /* iters */, 45 /* snapshots */, 0 /* externalObjs */)
@@ -14,7 +14,7 @@ iter25.SeekGE("e", "")
                   |-----------|                         db2.RangeKeyDelete("d", "f")
                                     |-----------|       db2.Compact("g", "i", true /* parallelize */)
       |-----------------------|                         db2.Replicate(db1, "b", "f")
-                                                        iter25 = db1.NewIter("", "", 2 /* key types */, "", "", false /* use L6 filters */, "@7" /* masking suffix */)
+                                                        iter25 = db1.NewIter("", "", 2 /* key types */, "", "", false /* use L6 filters */, "@7" /* masking suffix */, "nil" /* maximum suffix property */)
                         |                               iter25.SeekGE("e", "")
 |-----|-----|-----|-----|-----|-----|-----|-----|-----|
 a     b     c     d     e     f     g     h     i     z

metamorphic/testkeys.go

@@ -156,6 +156,11 @@ func (kg *testkeyKeyGenerator) IncMaxSuffix() []byte {
 	return testkeys.Suffix(int64(kg.cfg.writeSuffixDist.Max()))
 }
 
+// MaximumSuffixProperty returns the maximum suffix property.
+func (kg *testkeyKeyGenerator) MaximumSuffixProperty() pebble.MaximumSuffixProperty {
+	return sstable.MaxTestKeysSuffixProperty{}
+}
+
 // SuffixRange generates a new uniformly random range of suffixes (low, high]
 // such that high is guaranteed to be strictly greater (as defined by
 // ComparePointSuffixes) than low.