LCOV - code coverage report
Current view: top level - pebble - iterator.go (source / functions) Coverage Total Hit
Test: 2025-05-18 08:18Z f2f316e7 - tests only.lcov Lines: 88.9 % 1930 1716
Test Date: 2025-05-18 08:19:41 Functions: - 0 0

            Line data    Source code
       1              : // Copyright 2011 The LevelDB-Go and Pebble Authors. All rights reserved. Use
       2              : // of this source code is governed by a BSD-style license that can be found in
       3              : // the LICENSE file.
       4              : 
       5              : package pebble
       6              : 
       7              : import (
       8              :         "bytes"
       9              :         "context"
      10              :         "io"
      11              :         "math/rand/v2"
      12              :         "sync"
      13              :         "unsafe"
      14              : 
      15              :         "github.com/cockroachdb/errors"
      16              :         "github.com/cockroachdb/pebble/internal/base"
      17              :         "github.com/cockroachdb/pebble/internal/bytealloc"
      18              :         "github.com/cockroachdb/pebble/internal/humanize"
      19              :         "github.com/cockroachdb/pebble/internal/invariants"
      20              :         "github.com/cockroachdb/pebble/internal/keyspan"
      21              :         "github.com/cockroachdb/pebble/internal/keyspan/keyspanimpl"
      22              :         "github.com/cockroachdb/pebble/internal/manifest"
      23              :         "github.com/cockroachdb/pebble/internal/rangekeystack"
      24              :         "github.com/cockroachdb/pebble/internal/treeprinter"
      25              :         "github.com/cockroachdb/pebble/sstable/blob"
      26              :         "github.com/cockroachdb/redact"
      27              : )
      28              : 
      29              : // iterPos describes the state of the internal iterator, in terms of whether it
      30              : // is at the position returned to the user (cur), one ahead of the position
      31              : // returned (next for forward iteration and prev for reverse iteration). The cur
      32              : // position is split into two states, for forward and reverse iteration, since
      33              : // we need to differentiate for switching directions.
      34              : //
      35              : // There is subtlety in what is considered the current position of the Iterator.
      36              : // The internal iterator exposes a sequence of internal keys. There is not
      37              : // always a single internalIterator position corresponding to the position
      38              : // returned to the user. Consider the example:
      39              : //
      40              : //      a.MERGE.9 a.MERGE.8 a.MERGE.7 a.SET.6 b.DELETE.9 b.DELETE.5 b.SET.4
      41              : //      \                                   /
      42              : //        \       Iterator.Key() = 'a'    /
      43              : //
      44              : // The Iterator exposes one valid position at user key 'a' and the two exhausted
      45              : // positions at the beginning and end of iteration. The underlying
      46              : // internalIterator contains 7 valid positions and 2 exhausted positions.
      47              : //
      48              : // Iterator positioning methods must set iterPos to iterPosCur{Foward,Backward}
      49              : // iff the user key at the current internalIterator position equals the
      50              : // Iterator.Key returned to the user. This guarantees that a call to nextUserKey
      51              : // or prevUserKey will advance to the next or previous iterator position.
      52              : // iterPosCur{Forward,Backward} does not make any guarantee about the internal
      53              : // iterator position among internal keys with matching user keys, and it will
      54              : // vary subtly depending on the particular key kinds encountered. In the above
      55              : // example, the iterator returning 'a' may set iterPosCurForward if the internal
      56              : // iterator is positioned at any of a.MERGE.9, a.MERGE.8, a.MERGE.7 or a.SET.6.
      57              : //
      58              : // When setting iterPos to iterPosNext or iterPosPrev, the internal iterator
      59              : // must be advanced to the first internalIterator position at a user key greater
      60              : // (iterPosNext) or less (iterPosPrev) than the key returned to the user. An
      61              : // internalIterator position that's !Valid() must also be considered greater or
      62              : // less—depending on the direction of iteration—than the last valid Iterator
      63              : // position.
      64              : type iterPos int8
      65              : 
      66              : const (
      67              :         iterPosCurForward iterPos = 0
      68              :         iterPosNext       iterPos = 1
      69              :         iterPosPrev       iterPos = -1
      70              :         iterPosCurReverse iterPos = -2
      71              : 
      72              :         // For limited iteration. When the iterator is at iterPosCurForwardPaused
      73              :         // - Next*() call should behave as if the internal iterator is already
      74              :         //   at next (akin to iterPosNext).
      75              :         // - Prev*() call should behave as if the internal iterator is at the
      76              :         //   current key (akin to iterPosCurForward).
      77              :         //
      78              :         // Similar semantics apply to CurReversePaused.
      79              :         iterPosCurForwardPaused iterPos = 2
      80              :         iterPosCurReversePaused iterPos = -3
      81              : )
      82              : 
      83              : // Approximate gap in bytes between samples of data read during iteration.
      84              : // This is multiplied with a default ReadSamplingMultiplier of 1 << 4 to yield
      85              : // 1 << 20 (1MB). The 1MB factor comes from:
      86              : // https://github.com/cockroachdb/pebble/issues/29#issuecomment-494477985
      87              : const readBytesPeriod uint64 = 1 << 16
      88              : 
      89              : var errReversePrefixIteration = errors.New("pebble: unsupported reverse prefix iteration")
      90              : 
      91              : // IteratorMetrics holds per-iterator metrics. These do not change over the
      92              : // lifetime of the iterator.
      93              : type IteratorMetrics struct {
      94              :         // The read amplification experienced by this iterator. This is the sum of
      95              :         // the memtables, the L0 sublevels and the non-empty Ln levels. Higher read
      96              :         // amplification generally results in slower reads, though allowing higher
      97              :         // read amplification can also result in faster writes.
      98              :         ReadAmp int
      99              : }
     100              : 
     101              : // IteratorStatsKind describes the two kind of iterator stats.
     102              : type IteratorStatsKind int8
     103              : 
     104              : const (
     105              :         // InterfaceCall represents calls to Iterator.
     106              :         InterfaceCall IteratorStatsKind = iota
     107              :         // InternalIterCall represents calls by Iterator to its internalIterator.
     108              :         InternalIterCall
     109              :         // NumStatsKind is the number of kinds, and is used for array sizing.
     110              :         NumStatsKind
     111              : )
     112              : 
     113              : // IteratorStats contains iteration stats.
     114              : type IteratorStats struct {
     115              :         // ForwardSeekCount includes SeekGE, SeekPrefixGE, First.
     116              :         ForwardSeekCount [NumStatsKind]int
     117              :         // ReverseSeek includes SeekLT, Last.
     118              :         ReverseSeekCount [NumStatsKind]int
     119              :         // ForwardStepCount includes Next.
     120              :         ForwardStepCount [NumStatsKind]int
     121              :         // ReverseStepCount includes Prev.
     122              :         ReverseStepCount [NumStatsKind]int
     123              :         InternalStats    InternalIteratorStats
     124              :         RangeKeyStats    RangeKeyIteratorStats
     125              : }
     126              : 
     127              : var _ redact.SafeFormatter = &IteratorStats{}
     128              : 
     129              : // InternalIteratorStats contains miscellaneous stats produced by internal
     130              : // iterators.
     131              : type InternalIteratorStats = base.InternalIteratorStats
     132              : 
     133              : // RangeKeyIteratorStats contains miscellaneous stats about range keys
     134              : // encountered by the iterator.
     135              : type RangeKeyIteratorStats struct {
     136              :         // Count records the number of range keys encountered during
     137              :         // iteration. Range keys may be counted multiple times if the iterator
     138              :         // leaves a range key's bounds and then returns.
     139              :         Count int
     140              :         // ContainedPoints records the number of point keys encountered within the
     141              :         // bounds of a range key. Note that this includes point keys with suffixes
     142              :         // that sort both above and below the covering range key's suffix.
     143              :         ContainedPoints int
     144              :         // SkippedPoints records the count of the subset of ContainedPoints point
     145              :         // keys that were skipped during iteration due to range-key masking. It does
     146              :         // not include point keys that were never loaded because a
     147              :         // RangeKeyMasking.Filter excluded the entire containing block.
     148              :         SkippedPoints int
     149              : }
     150              : 
     151              : // Merge adds all of the argument's statistics to the receiver. It may be used
     152              : // to accumulate stats across multiple iterators.
     153            1 : func (s *RangeKeyIteratorStats) Merge(o RangeKeyIteratorStats) {
     154            1 :         s.Count += o.Count
     155            1 :         s.ContainedPoints += o.ContainedPoints
     156            1 :         s.SkippedPoints += o.SkippedPoints
     157            1 : }
     158              : 
     159            0 : func (s *RangeKeyIteratorStats) String() string {
     160            0 :         return redact.StringWithoutMarkers(s)
     161            0 : }
     162              : 
     163              : // SafeFormat implements the redact.SafeFormatter interface.
     164            1 : func (s *RangeKeyIteratorStats) SafeFormat(p redact.SafePrinter, verb rune) {
     165            1 :         p.Printf("range keys: %s, contained points: %s (%s skipped)",
     166            1 :                 humanize.Count.Uint64(uint64(s.Count)),
     167            1 :                 humanize.Count.Uint64(uint64(s.ContainedPoints)),
     168            1 :                 humanize.Count.Uint64(uint64(s.SkippedPoints)))
     169            1 : }
     170              : 
     171              : // LazyValue is a lazy value. See the long comment in base.LazyValue.
     172              : type LazyValue = base.LazyValue
     173              : 
     174              : // Iterator iterates over a DB's key/value pairs in key order.
     175              : //
     176              : // An iterator must be closed after use, but it is not necessary to read an
     177              : // iterator until exhaustion.
     178              : //
     179              : // An iterator is not goroutine-safe, but it is safe to use multiple iterators
     180              : // concurrently, with each in a dedicated goroutine.
     181              : //
     182              : // It is also safe to use an iterator concurrently with modifying its
     183              : // underlying DB, if that DB permits modification. However, the resultant
     184              : // key/value pairs are not guaranteed to be a consistent snapshot of that DB
     185              : // at a particular point in time.
     186              : //
     187              : // If an iterator encounters an error during any operation, it is stored by
     188              : // the Iterator and surfaced through the Error method. All absolute
     189              : // positioning methods (eg, SeekLT, SeekGT, First, Last, etc) reset any
     190              : // accumulated error before positioning. All relative positioning methods (eg,
     191              : // Next, Prev) return without advancing if the iterator has an accumulated
     192              : // error.
     193              : type Iterator struct {
     194              :         // The context is stored here since (a) Iterators are expected to be
     195              :         // short-lived (since they pin memtables and sstables), (b) plumbing a
     196              :         // context into every method is very painful, (c) they do not (yet) respect
     197              :         // context cancellation and are only used for tracing.
     198              :         ctx       context.Context
     199              :         opts      IterOptions
     200              :         merge     Merge
     201              :         comparer  base.Comparer
     202              :         iter      internalIterator
     203              :         pointIter topLevelIterator
     204              :         // Either readState or version is set, but not both.
     205              :         readState *readState
     206              :         version   *version
     207              :         // rangeKey holds iteration state specific to iteration over range keys.
     208              :         // The range key field may be nil if the Iterator has never been configured
     209              :         // to iterate over range keys. Its non-nilness cannot be used to determine
     210              :         // if the Iterator is currently iterating over range keys: For that, consult
     211              :         // the IterOptions using opts.rangeKeys(). If non-nil, its rangeKeyIter
     212              :         // field is guaranteed to be non-nil too.
     213              :         rangeKey *iteratorRangeKeyState
     214              :         // rangeKeyMasking holds state for range-key masking of point keys.
     215              :         rangeKeyMasking rangeKeyMasking
     216              :         err             error
     217              :         // When iterValidityState=IterValid, key represents the current key, which
     218              :         // is backed by keyBuf.
     219              :         key    []byte
     220              :         keyBuf []byte
     221              :         value  base.InternalValue
     222              :         // For use in LazyValue.Clone.
     223              :         valueBuf []byte
     224              :         fetcher  base.LazyFetcher
     225              :         // For use in LazyValue.Value.
     226              :         lazyValueBuf []byte
     227              :         valueCloser  io.Closer
     228              :         // blobValueFetcher is the ValueFetcher to use when retrieving values stored
     229              :         // externally in blob files.
     230              :         blobValueFetcher blob.ValueFetcher
     231              :         // boundsBuf holds two buffers used to store the lower and upper bounds.
     232              :         // Whenever the Iterator's bounds change, the new bounds are copied into
     233              :         // boundsBuf[boundsBufIdx]. The two bounds share a slice to reduce
     234              :         // allocations. opts.LowerBound and opts.UpperBound point into this slice.
     235              :         boundsBuf    [2][]byte
     236              :         boundsBufIdx int
     237              :         // iterKV reflects the latest position of iter, except when SetBounds is
     238              :         // called. In that case, it is explicitly set to nil.
     239              :         iterKV              *base.InternalKV
     240              :         alloc               *iterAlloc
     241              :         getIterAlloc        *getIterAlloc
     242              :         prefixOrFullSeekKey []byte
     243              :         readSampling        readSampling
     244              :         stats               IteratorStats
     245              :         externalIter        *externalIterState
     246              :         // Following fields used when constructing an iterator stack, eg, in Clone
     247              :         // and SetOptions or when re-fragmenting a batch's range keys/range dels.
     248              :         // Non-nil if this Iterator includes a Batch.
     249              :         batch            *Batch
     250              :         fc               *fileCacheHandle
     251              :         newIters         tableNewIters
     252              :         newIterRangeKey  keyspanimpl.TableNewSpanIter
     253              :         lazyCombinedIter lazyCombinedIter
     254              :         seqNum           base.SeqNum
     255              :         // batchSeqNum is used by Iterators over indexed batches to detect when the
     256              :         // underlying batch has been mutated. The batch beneath an indexed batch may
     257              :         // be mutated while the Iterator is open, but new keys are not surfaced
     258              :         // until the next call to SetOptions.
     259              :         batchSeqNum base.SeqNum
     260              :         // batch{PointIter,RangeDelIter,RangeKeyIter} are used when the Iterator is
     261              :         // configured to read through an indexed batch. If a batch is set, these
     262              :         // iterators will be included within the iterator stack regardless of
     263              :         // whether the batch currently contains any keys of their kind. These
     264              :         // pointers are used during a call to SetOptions to refresh the Iterator's
     265              :         // view of its indexed batch.
     266              :         batchPointIter    batchIter
     267              :         batchRangeDelIter keyspan.Iter
     268              :         batchRangeKeyIter keyspan.Iter
     269              :         // merging is a pointer to this iterator's point merging iterator. It
     270              :         // appears here because key visibility is handled by the merging iterator.
     271              :         // During SetOptions on an iterator over an indexed batch, this field is
     272              :         // used to update the merging iterator's batch snapshot.
     273              :         merging *mergingIter
     274              : 
     275              :         // Keeping the bools here after all the 8 byte aligned fields shrinks the
     276              :         // sizeof this struct by 24 bytes.
     277              : 
     278              :         // INVARIANT:
     279              :         // iterValidityState==IterAtLimit <=>
     280              :         //  pos==iterPosCurForwardPaused || pos==iterPosCurReversePaused
     281              :         iterValidityState IterValidityState
     282              :         // Set to true by SetBounds, SetOptions. Causes the Iterator to appear
     283              :         // exhausted externally, while preserving the correct iterValidityState for
     284              :         // the iterator's internal state. Preserving the correct internal validity
     285              :         // is used for SeekPrefixGE(..., trySeekUsingNext), and SeekGE/SeekLT
     286              :         // optimizations after "no-op" calls to SetBounds and SetOptions.
     287              :         requiresReposition bool
     288              :         // The position of iter. When this is iterPos{Prev,Next} the iter has been
     289              :         // moved past the current key-value, which can only happen if
     290              :         // iterValidityState=IterValid, i.e., there is something to return to the
     291              :         // client for the current position.
     292              :         pos iterPos
     293              :         // Relates to the prefixOrFullSeekKey field above.
     294              :         hasPrefix bool
     295              :         // Used for deriving the value of SeekPrefixGE(..., trySeekUsingNext),
     296              :         // and SeekGE/SeekLT optimizations
     297              :         lastPositioningOp lastPositioningOpKind
     298              :         // Used for determining when it's safe to perform SeekGE optimizations that
     299              :         // reuse the iterator state to avoid the cost of a full seek if the iterator
     300              :         // is already positioned in the correct place. If the iterator's view of its
     301              :         // indexed batch was just refreshed, some optimizations cannot be applied on
     302              :         // the first seek after the refresh:
     303              :         // - SeekGE has a no-op optimization that does not seek on the internal
     304              :         //   iterator at all if the iterator is already in the correct place.
     305              :         //   This optimization cannot be performed if the internal iterator was
     306              :         //   last positioned when the iterator had a different view of an
     307              :         //   underlying batch.
     308              :         // - Seek[Prefix]GE set flags.TrySeekUsingNext()=true when the seek key is
     309              :         //   greater than the previous operation's seek key, under the expectation
     310              :         //   that the various internal iterators can use their current position to
     311              :         //   avoid a full expensive re-seek. This applies to the batchIter as well.
     312              :         //   However, if the view of the batch was just refreshed, the batchIter's
     313              :         //   position is not useful because it may already be beyond new keys less
     314              :         //   than the seek key. To prevent the use of this optimization in
     315              :         //   batchIter, Seek[Prefix]GE set flags.BatchJustRefreshed()=true if this
     316              :         //   bit is enabled.
     317              :         batchJustRefreshed bool
     318              :         // batchOnlyIter is set to true for Batch.NewBatchOnlyIter.
     319              :         batchOnlyIter bool
     320              :         // Used in some tests to disable the random disabling of seek optimizations.
     321              :         forceEnableSeekOpt bool
     322              :         // Set to true if NextPrefix is not currently permitted. Defaults to false
     323              :         // in case an iterator never had any bounds.
     324              :         nextPrefixNotPermittedByUpperBound bool
     325              : }
     326              : 
     327              : // cmp is a convenience shorthand for the i.comparer.Compare function.
     328            1 : func (i *Iterator) cmp(a, b []byte) int {
     329            1 :         return i.comparer.Compare(a, b)
     330            1 : }
     331              : 
     332              : // equal is a convenience shorthand for the i.comparer.Equal function.
     333            1 : func (i *Iterator) equal(a, b []byte) bool {
     334            1 :         return i.comparer.Equal(a, b)
     335            1 : }
     336              : 
     337              : // iteratorRangeKeyState holds an iterator's range key iteration state.
     338              : type iteratorRangeKeyState struct {
     339              :         opts  *IterOptions
     340              :         cmp   base.Compare
     341              :         split base.Split
     342              :         // rangeKeyIter holds the range key iterator stack that iterates over the
     343              :         // merged spans across the entirety of the LSM.
     344              :         rangeKeyIter keyspan.FragmentIterator
     345              :         iiter        keyspan.InterleavingIter
     346              :         // stale is set to true when the range key state recorded here (in start,
     347              :         // end and keys) may not be in sync with the current range key at the
     348              :         // interleaving iterator's current position.
     349              :         //
     350              :         // When the interelaving iterator passes over a new span, it invokes the
     351              :         // SpanChanged hook defined on the `rangeKeyMasking` type,  which sets stale
     352              :         // to true if the span is non-nil.
     353              :         //
     354              :         // The parent iterator may not be positioned over the interleaving
     355              :         // iterator's current position (eg, i.iterPos = iterPos{Next,Prev}), so
     356              :         // {keys,start,end} are only updated to the new range key during a call to
     357              :         // Iterator.saveRangeKey.
     358              :         stale bool
     359              :         // updated is used to signal to the Iterator client whether the state of
     360              :         // range keys has changed since the previous iterator position through the
     361              :         // `RangeKeyChanged` method. It's set to true during an Iterator positioning
     362              :         // operation that changes the state of the current range key. Each Iterator
     363              :         // positioning operation sets it back to false before executing.
     364              :         //
     365              :         // TODO(jackson): The lifecycle of {stale,updated,prevPosHadRangeKey} is
     366              :         // intricate and confusing. Try to refactor to reduce complexity.
     367              :         updated bool
     368              :         // prevPosHadRangeKey records whether the previous Iterator position had a
     369              :         // range key (HasPointAndRage() = (_, true)). It's updated at the beginning
     370              :         // of each new Iterator positioning operation. It's required by saveRangeKey to
     371              :         // to set `updated` appropriately: Without this record of the previous iterator
     372              :         // state, it's ambiguous whether an iterator only temporarily stepped onto a
     373              :         // position without a range key.
     374              :         prevPosHadRangeKey bool
     375              :         // rangeKeyOnly is set to true if at the current iterator position there is
     376              :         // no point key, only a range key start boundary.
     377              :         rangeKeyOnly bool
     378              :         // hasRangeKey is true when the current iterator position has a covering
     379              :         // range key (eg, a range key with bounds [<lower>,<upper>) such that
     380              :         // <lower> ≤ Key() < <upper>).
     381              :         hasRangeKey bool
     382              :         // start and end are the [start, end) boundaries of the current range keys.
     383              :         start []byte
     384              :         end   []byte
     385              : 
     386              :         rangeKeyBuffers
     387              : 
     388              :         // iterConfig holds fields that are used for the construction of the
     389              :         // iterator stack, but do not need to be directly accessed during iteration.
     390              :         // This struct is bundled within the iteratorRangeKeyState struct to reduce
     391              :         // allocations.
     392              :         iterConfig rangekeystack.UserIteratorConfig
     393              : }
     394              : 
     395              : type rangeKeyBuffers struct {
     396              :         // keys is sorted by Suffix ascending.
     397              :         keys []RangeKeyData
     398              :         // buf is used to save range-key data before moving the range-key iterator.
     399              :         // Start and end boundaries, suffixes and values are all copied into buf.
     400              :         buf bytealloc.A
     401              :         // internal holds buffers used by the range key internal iterators.
     402              :         internal rangekeystack.Buffers
     403              : }
     404              : 
     405            1 : func (b *rangeKeyBuffers) PrepareForReuse() {
     406            1 :         const maxKeysReuse = 100
     407            1 :         if len(b.keys) > maxKeysReuse {
     408            0 :                 b.keys = nil
     409            0 :         }
     410              :         // Avoid caching the key buf if it is overly large. The constant is
     411              :         // fairly arbitrary.
     412            1 :         if cap(b.buf) >= maxKeyBufCacheSize {
     413            1 :                 b.buf = nil
     414            1 :         } else {
     415            1 :                 b.buf = b.buf[:0]
     416            1 :         }
     417            1 :         b.internal.PrepareForReuse()
     418              : }
     419              : 
     420            1 : func (i *iteratorRangeKeyState) init(cmp base.Compare, split base.Split, opts *IterOptions) {
     421            1 :         i.cmp = cmp
     422            1 :         i.split = split
     423            1 :         i.opts = opts
     424            1 : }
     425              : 
     426              : var iterRangeKeyStateAllocPool = sync.Pool{
     427            1 :         New: func() interface{} {
     428            1 :                 return &iteratorRangeKeyState{}
     429            1 :         },
     430              : }
     431              : 
     432              : // isEphemeralPosition returns true iff the current iterator position is
     433              : // ephemeral, and won't be visited during subsequent relative positioning
     434              : // operations.
     435              : //
     436              : // The iterator position resulting from a SeekGE or SeekPrefixGE that lands on a
     437              : // straddling range key without a coincident point key is such a position.
     438            1 : func (i *Iterator) isEphemeralPosition() bool {
     439            1 :         return i.opts.rangeKeys() && i.rangeKey != nil && i.rangeKey.rangeKeyOnly &&
     440            1 :                 !i.equal(i.rangeKey.start, i.key)
     441            1 : }
     442              : 
     443              : type lastPositioningOpKind int8
     444              : 
     445              : const (
     446              :         unknownLastPositionOp lastPositioningOpKind = iota
     447              :         seekPrefixGELastPositioningOp
     448              :         seekGELastPositioningOp
     449              :         seekLTLastPositioningOp
     450              :         // internalNextOp is a special internal iterator positioning operation used
     451              :         // by CanDeterministicallySingleDelete. It exists for enforcing requirements
     452              :         // around calling CanDeterministicallySingleDelete at most once per external
     453              :         // iterator position.
     454              :         internalNextOp
     455              : )
     456              : 
     457              : // Limited iteration mode. Not for use with prefix iteration.
     458              : //
     459              : // SeekGE, SeekLT, Prev, Next have WithLimit variants, that pause the iterator
     460              : // at the limit in a best-effort manner. The client should behave correctly
     461              : // even if the limits are ignored. These limits are not "deep", in that they
     462              : // are not passed down to the underlying collection of internalIterators. This
     463              : // is because the limits are transient, and apply only until the next
     464              : // iteration call. They serve mainly as a way to bound the amount of work when
     465              : // two (or more) Iterators are being coordinated at a higher level.
     466              : //
     467              : // In limited iteration mode:
     468              : // - Avoid using Iterator.Valid if the last call was to a *WithLimit() method.
     469              : //   The return value from the *WithLimit() method provides a more precise
     470              : //   disposition.
     471              : // - The limit is exclusive for forward and inclusive for reverse.
     472              : //
     473              : //
     474              : // Limited iteration mode & range keys
     475              : //
     476              : // Limited iteration interacts with range-key iteration. When range key
     477              : // iteration is enabled, range keys are interleaved at their start boundaries.
     478              : // Limited iteration must ensure that if a range key exists within the limit,
     479              : // the iterator visits the range key.
     480              : //
     481              : // During forward limited iteration, this is trivial: An overlapping range key
     482              : // must have a start boundary less than the limit, and the range key's start
     483              : // boundary will be interleaved and found to be within the limit.
     484              : //
     485              : // During reverse limited iteration, the tail of the range key may fall within
     486              : // the limit. The range key must be surfaced even if the range key's start
     487              : // boundary is less than the limit, and if there are no point keys between the
     488              : // current iterator position and the limit. To provide this guarantee, reverse
     489              : // limited iteration ignores the limit as long as there is a range key
     490              : // overlapping the iteration position.
     491              : 
     492              : // IterValidityState captures the state of the Iterator.
     493              : type IterValidityState int8
     494              : 
     495              : const (
     496              :         // IterExhausted represents an Iterator that is exhausted.
     497              :         IterExhausted IterValidityState = iota
     498              :         // IterValid represents an Iterator that is valid.
     499              :         IterValid
     500              :         // IterAtLimit represents an Iterator that has a non-exhausted
     501              :         // internalIterator, but has reached a limit without any key for the
     502              :         // caller.
     503              :         IterAtLimit
     504              : )
     505              : 
     506              : // readSampling stores variables used to sample a read to trigger a read
     507              : // compaction
     508              : type readSampling struct {
     509              :         bytesUntilReadSampling uint64
     510              :         initialSamplePassed    bool
     511              :         pendingCompactions     readCompactionQueue
     512              :         // forceReadSampling is used for testing purposes to force a read sample on every
     513              :         // call to Iterator.maybeSampleRead()
     514              :         forceReadSampling bool
     515              : }
     516              : 
     517            1 : func (i *Iterator) findNextEntry(limit []byte) {
     518            1 :         i.iterValidityState = IterExhausted
     519            1 :         i.pos = iterPosCurForward
     520            1 :         if i.opts.rangeKeys() && i.rangeKey != nil {
     521            1 :                 i.rangeKey.rangeKeyOnly = false
     522            1 :         }
     523              : 
     524              :         // Close the closer for the current value if one was open.
     525            1 :         if i.closeValueCloser() != nil {
     526            0 :                 return
     527            0 :         }
     528              : 
     529            1 :         for i.iterKV != nil {
     530            1 :                 key := i.iterKV.K
     531            1 : 
     532            1 :                 // The topLevelIterator.StrictSeekPrefixGE contract requires that in
     533            1 :                 // prefix mode [i.hasPrefix=t], every point key returned by the internal
     534            1 :                 // iterator must have the current iteration prefix.
     535            1 :                 if invariants.Enabled && i.hasPrefix {
     536            1 :                         // Range keys are an exception to the contract and may return a different
     537            1 :                         // prefix. This case is explicitly handled in the switch statement below.
     538            1 :                         if key.Kind() != base.InternalKeyKindRangeKeySet {
     539            1 :                                 if p := i.comparer.Split.Prefix(key.UserKey); !i.equal(i.prefixOrFullSeekKey, p) {
     540            0 :                                         i.opts.logger.Fatalf("pebble: prefix violation: key %q does not have prefix %q\n", key.UserKey, i.prefixOrFullSeekKey)
     541            0 :                                 }
     542              :                         }
     543              :                 }
     544              : 
     545              :                 // Compare with limit every time we start at a different user key.
     546              :                 // Note that given the best-effort contract of limit, we could avoid a
     547              :                 // comparison in the common case by doing this only after
     548              :                 // i.nextUserKey is called for the deletes below. However that makes
     549              :                 // the behavior non-deterministic (since the behavior will vary based
     550              :                 // on what has been compacted), which makes it hard to test with the
     551              :                 // metamorphic test. So we forego that performance optimization.
     552            1 :                 if limit != nil && i.cmp(limit, i.iterKV.K.UserKey) <= 0 {
     553            1 :                         i.iterValidityState = IterAtLimit
     554            1 :                         i.pos = iterPosCurForwardPaused
     555            1 :                         return
     556            1 :                 }
     557              : 
     558              :                 // If the user has configured a SkipPoint function, invoke it to see
     559              :                 // whether we should skip over the current user key.
     560            1 :                 if i.opts.SkipPoint != nil && key.Kind() != InternalKeyKindRangeKeySet && i.opts.SkipPoint(i.iterKV.K.UserKey) {
     561            1 :                         // NB: We could call nextUserKey, but in some cases the SkipPoint
     562            1 :                         // predicate function might be cheaper than nextUserKey's key copy
     563            1 :                         // and key comparison. This should be the case for MVCC suffix
     564            1 :                         // comparisons, for example. In the future, we could expand the
     565            1 :                         // SkipPoint interface to give the implementor more control over
     566            1 :                         // whether we skip over just the internal key, the user key, or even
     567            1 :                         // the key prefix.
     568            1 :                         i.stats.ForwardStepCount[InternalIterCall]++
     569            1 :                         i.iterKV = i.iter.Next()
     570            1 :                         continue
     571              :                 }
     572              : 
     573            1 :                 switch key.Kind() {
     574            1 :                 case InternalKeyKindRangeKeySet:
     575            1 :                         if i.hasPrefix {
     576            1 :                                 if p := i.comparer.Split.Prefix(key.UserKey); !i.equal(i.prefixOrFullSeekKey, p) {
     577            1 :                                         return
     578            1 :                                 }
     579              :                         }
     580              :                         // Save the current key.
     581            1 :                         i.keyBuf = append(i.keyBuf[:0], key.UserKey...)
     582            1 :                         i.key = i.keyBuf
     583            1 :                         i.value = base.InternalValue{}
     584            1 :                         // There may also be a live point key at this userkey that we have
     585            1 :                         // not yet read. We need to find the next entry with this user key
     586            1 :                         // to find it. Save the range key so we don't lose it when we Next
     587            1 :                         // the underlying iterator.
     588            1 :                         i.saveRangeKey()
     589            1 :                         pointKeyExists := i.nextPointCurrentUserKey()
     590            1 :                         if i.err != nil {
     591            0 :                                 i.iterValidityState = IterExhausted
     592            0 :                                 return
     593            0 :                         }
     594            1 :                         i.rangeKey.rangeKeyOnly = !pointKeyExists
     595            1 :                         i.iterValidityState = IterValid
     596            1 :                         return
     597              : 
     598            1 :                 case InternalKeyKindDelete, InternalKeyKindSingleDelete, InternalKeyKindDeleteSized:
     599            1 :                         // NB: treating InternalKeyKindSingleDelete as equivalent to DEL is not
     600            1 :                         // only simpler, but is also necessary for correctness due to
     601            1 :                         // InternalKeyKindSSTableInternalObsoleteBit.
     602            1 :                         i.nextUserKey()
     603            1 :                         continue
     604              : 
     605            1 :                 case InternalKeyKindSet, InternalKeyKindSetWithDelete:
     606            1 :                         i.keyBuf = append(i.keyBuf[:0], key.UserKey...)
     607            1 :                         i.key = i.keyBuf
     608            1 :                         i.value = i.iterKV.V
     609            1 :                         i.iterValidityState = IterValid
     610            1 :                         i.saveRangeKey()
     611            1 :                         return
     612              : 
     613            1 :                 case InternalKeyKindMerge:
     614            1 :                         // Resolving the merge may advance us to the next point key, which
     615            1 :                         // may be covered by a different set of range keys. Save the range
     616            1 :                         // key state so we don't lose it.
     617            1 :                         i.saveRangeKey()
     618            1 :                         if i.mergeForward(key) {
     619            1 :                                 i.iterValidityState = IterValid
     620            1 :                                 return
     621            1 :                         }
     622              : 
     623              :                         // The merge didn't yield a valid key, either because the value
     624              :                         // merger indicated it should be deleted, or because an error was
     625              :                         // encountered.
     626            1 :                         i.iterValidityState = IterExhausted
     627            1 :                         if i.err != nil {
     628            1 :                                 return
     629            1 :                         }
     630            1 :                         if i.pos != iterPosNext {
     631            0 :                                 i.nextUserKey()
     632            0 :                         }
     633            1 :                         if i.closeValueCloser() != nil {
     634            0 :                                 return
     635            0 :                         }
     636            1 :                         i.pos = iterPosCurForward
     637              : 
     638            0 :                 default:
     639            0 :                         i.err = base.CorruptionErrorf("pebble: invalid internal key kind: %d", errors.Safe(key.Kind()))
     640            0 :                         i.iterValidityState = IterExhausted
     641            0 :                         return
     642              :                 }
     643              :         }
     644              : 
     645              :         // Is iterKey nil due to an error?
     646            1 :         if err := i.iter.Error(); err != nil {
     647            1 :                 i.err = err
     648            1 :                 i.iterValidityState = IterExhausted
     649            1 :         }
     650              : }
     651              : 
     652            1 : func (i *Iterator) nextPointCurrentUserKey() bool {
     653            1 :         // If the user has configured a SkipPoint function and the current user key
     654            1 :         // would be skipped by it, there's no need to step forward looking for a
     655            1 :         // point key. If we were to find one, it should be skipped anyways.
     656            1 :         if i.opts.SkipPoint != nil && i.opts.SkipPoint(i.key) {
     657            1 :                 return false
     658            1 :         }
     659              : 
     660            1 :         i.pos = iterPosCurForward
     661            1 : 
     662            1 :         i.iterKV = i.iter.Next()
     663            1 :         i.stats.ForwardStepCount[InternalIterCall]++
     664            1 :         if i.iterKV == nil {
     665            1 :                 if err := i.iter.Error(); err != nil {
     666            0 :                         i.err = err
     667            1 :                 } else {
     668            1 :                         i.pos = iterPosNext
     669            1 :                 }
     670            1 :                 return false
     671              :         }
     672            1 :         if !i.equal(i.key, i.iterKV.K.UserKey) {
     673            1 :                 i.pos = iterPosNext
     674            1 :                 return false
     675            1 :         }
     676              : 
     677            1 :         key := i.iterKV.K
     678            1 :         switch key.Kind() {
     679            0 :         case InternalKeyKindRangeKeySet:
     680            0 :                 // RangeKeySets must always be interleaved as the first internal key
     681            0 :                 // for a user key.
     682            0 :                 i.err = base.CorruptionErrorf("pebble: unexpected range key set mid-user key")
     683            0 :                 return false
     684              : 
     685            1 :         case InternalKeyKindDelete, InternalKeyKindSingleDelete, InternalKeyKindDeleteSized:
     686            1 :                 // NB: treating InternalKeyKindSingleDelete as equivalent to DEL is not
     687            1 :                 // only simpler, but is also necessary for correctness due to
     688            1 :                 // InternalKeyKindSSTableInternalObsoleteBit.
     689            1 :                 return false
     690              : 
     691            1 :         case InternalKeyKindSet, InternalKeyKindSetWithDelete:
     692            1 :                 i.value = i.iterKV.V
     693            1 :                 return true
     694              : 
     695            1 :         case InternalKeyKindMerge:
     696            1 :                 return i.mergeForward(key)
     697              : 
     698            0 :         default:
     699            0 :                 i.err = base.CorruptionErrorf("pebble: invalid internal key kind: %d", errors.Safe(key.Kind()))
     700            0 :                 return false
     701              :         }
     702              : }
     703              : 
     704              : // mergeForward resolves a MERGE key, advancing the underlying iterator forward
     705              : // to merge with subsequent keys with the same userkey. mergeForward returns a
     706              : // boolean indicating whether or not the merge yielded a valid key. A merge may
     707              : // not yield a valid key if an error occurred, in which case i.err is non-nil,
     708              : // or the user's value merger specified the key to be deleted.
     709              : //
     710              : // mergeForward does not update iterValidityState.
     711            1 : func (i *Iterator) mergeForward(key base.InternalKey) (valid bool) {
     712            1 :         var iterValue []byte
     713            1 :         iterValue, _, i.err = i.iterKV.Value(nil)
     714            1 :         if i.err != nil {
     715            0 :                 return false
     716            0 :         }
     717            1 :         var valueMerger ValueMerger
     718            1 :         valueMerger, i.err = i.merge(key.UserKey, iterValue)
     719            1 :         if i.err != nil {
     720            0 :                 return false
     721            0 :         }
     722              : 
     723            1 :         i.mergeNext(key, valueMerger)
     724            1 :         if i.err != nil {
     725            1 :                 return false
     726            1 :         }
     727              : 
     728            1 :         var needDelete bool
     729            1 :         var value []byte
     730            1 :         value, needDelete, i.valueCloser, i.err = finishValueMerger(
     731            1 :                 valueMerger, true /* includesBase */)
     732            1 :         i.value = base.MakeInPlaceValue(value)
     733            1 :         if i.err != nil {
     734            0 :                 return false
     735            0 :         }
     736            1 :         if needDelete {
     737            1 :                 _ = i.closeValueCloser()
     738            1 :                 return false
     739            1 :         }
     740            1 :         return true
     741              : }
     742              : 
     743            1 : func (i *Iterator) closeValueCloser() error {
     744            1 :         if i.valueCloser != nil {
     745            0 :                 i.err = i.valueCloser.Close()
     746            0 :                 i.valueCloser = nil
     747            0 :         }
     748            1 :         return i.err
     749              : }
     750              : 
     751            1 : func (i *Iterator) nextUserKey() {
     752            1 :         if i.iterKV == nil {
     753            1 :                 return
     754            1 :         }
     755            1 :         trailer := i.iterKV.K.Trailer
     756            1 :         done := i.iterKV.K.Trailer <= base.InternalKeyZeroSeqnumMaxTrailer
     757            1 :         if i.iterValidityState != IterValid {
     758            1 :                 i.keyBuf = append(i.keyBuf[:0], i.iterKV.K.UserKey...)
     759            1 :                 i.key = i.keyBuf
     760            1 :         }
     761            1 :         for {
     762            1 :                 i.stats.ForwardStepCount[InternalIterCall]++
     763            1 :                 i.iterKV = i.iter.Next()
     764            1 :                 if i.iterKV == nil {
     765            1 :                         if err := i.iter.Error(); err != nil {
     766            1 :                                 i.err = err
     767            1 :                                 return
     768            1 :                         }
     769              :                 }
     770              :                 // NB: We're guaranteed to be on the next user key if the previous key
     771              :                 // had a zero sequence number (`done`), or the new key has a trailer
     772              :                 // greater or equal to the previous key's trailer. This is true because
     773              :                 // internal keys with the same user key are sorted by InternalKeyTrailer in
     774              :                 // strictly monotonically descending order. We expect the trailer
     775              :                 // optimization to trigger around 50% of the time with randomly
     776              :                 // distributed writes. We expect it to trigger very frequently when
     777              :                 // iterating through ingested sstables, which contain keys that all have
     778              :                 // the same sequence number.
     779            1 :                 if done || i.iterKV == nil || i.iterKV.K.Trailer >= trailer {
     780            1 :                         break
     781              :                 }
     782            1 :                 if !i.equal(i.key, i.iterKV.K.UserKey) {
     783            1 :                         break
     784              :                 }
     785            1 :                 done = i.iterKV.K.Trailer <= base.InternalKeyZeroSeqnumMaxTrailer
     786            1 :                 trailer = i.iterKV.K.Trailer
     787              :         }
     788              : }
     789              : 
     790            1 : func (i *Iterator) maybeSampleRead() {
     791            1 :         // This method is only called when a public method of Iterator is
     792            1 :         // returning, and below we exclude the case were the iterator is paused at
     793            1 :         // a limit. The effect of these choices is that keys that are deleted, but
     794            1 :         // are encountered during iteration, are not accounted for in the read
     795            1 :         // sampling and will not cause read driven compactions, even though we are
     796            1 :         // incurring cost in iterating over them. And this issue is not limited to
     797            1 :         // Iterator, which does not see the effect of range deletes, which may be
     798            1 :         // causing iteration work in mergingIter. It is not clear at this time
     799            1 :         // whether this is a deficiency worth addressing.
     800            1 :         if i.iterValidityState != IterValid {
     801            1 :                 return
     802            1 :         }
     803            1 :         if i.readState == nil {
     804            1 :                 return
     805            1 :         }
     806            1 :         if i.readSampling.forceReadSampling {
     807            1 :                 i.sampleRead()
     808            1 :                 return
     809            1 :         }
     810            1 :         samplingPeriod := int32(int64(readBytesPeriod) * i.readState.db.opts.Experimental.ReadSamplingMultiplier)
     811            1 :         if samplingPeriod <= 0 {
     812            0 :                 return
     813            0 :         }
     814            1 :         bytesRead := uint64(len(i.key) + i.value.Len())
     815            1 :         for i.readSampling.bytesUntilReadSampling < bytesRead {
     816            1 :                 i.readSampling.bytesUntilReadSampling += uint64(rand.Uint32N(2 * uint32(samplingPeriod)))
     817            1 :                 // The block below tries to adjust for the case where this is the
     818            1 :                 // first read in a newly-opened iterator. As bytesUntilReadSampling
     819            1 :                 // starts off at zero, we don't want to sample the first read of
     820            1 :                 // every newly-opened iterator, but we do want to sample some of them.
     821            1 :                 if !i.readSampling.initialSamplePassed {
     822            1 :                         i.readSampling.initialSamplePassed = true
     823            1 :                         if i.readSampling.bytesUntilReadSampling > bytesRead {
     824            1 :                                 if rand.Uint64N(i.readSampling.bytesUntilReadSampling) > bytesRead {
     825            1 :                                         continue
     826              :                                 }
     827              :                         }
     828              :                 }
     829            1 :                 i.sampleRead()
     830              :         }
     831            1 :         i.readSampling.bytesUntilReadSampling -= bytesRead
     832              : }
     833              : 
     834            1 : func (i *Iterator) sampleRead() {
     835            1 :         var topFile *manifest.TableMetadata
     836            1 :         topLevel, numOverlappingLevels := numLevels, 0
     837            1 :         mi := i.merging
     838            1 :         if mi == nil {
     839            0 :                 return
     840            0 :         }
     841            1 :         if len(mi.levels) > 1 {
     842            1 :                 mi.ForEachLevelIter(func(li *levelIter) (done bool) {
     843            1 :                         if li.layer.IsFlushableIngests() {
     844            0 :                                 return false
     845            0 :                         }
     846            1 :                         l := li.layer.Level()
     847            1 :                         if f := li.iterFile; f != nil {
     848            1 :                                 var containsKey bool
     849            1 :                                 if i.pos == iterPosNext || i.pos == iterPosCurForward ||
     850            1 :                                         i.pos == iterPosCurForwardPaused {
     851            1 :                                         containsKey = i.cmp(f.PointKeyBounds.SmallestUserKey(), i.key) <= 0
     852            1 :                                 } else if i.pos == iterPosPrev || i.pos == iterPosCurReverse ||
     853            1 :                                         i.pos == iterPosCurReversePaused {
     854            1 :                                         containsKey = i.cmp(f.PointKeyBounds.LargestUserKey(), i.key) >= 0
     855            1 :                                 }
     856              :                                 // Do nothing if the current key is not contained in f's
     857              :                                 // bounds. We could seek the LevelIterator at this level
     858              :                                 // to find the right file, but the performance impacts of
     859              :                                 // doing that are significant enough to negate the benefits
     860              :                                 // of read sampling in the first place. See the discussion
     861              :                                 // at:
     862              :                                 // https://github.com/cockroachdb/pebble/pull/1041#issuecomment-763226492
     863            1 :                                 if containsKey {
     864            1 :                                         numOverlappingLevels++
     865            1 :                                         if numOverlappingLevels >= 2 {
     866            1 :                                                 // Terminate the loop early if at least 2 overlapping levels are found.
     867            1 :                                                 return true
     868            1 :                                         }
     869            1 :                                         topLevel = l
     870            1 :                                         topFile = f
     871              :                                 }
     872              :                         }
     873            1 :                         return false
     874              :                 })
     875              :         }
     876            1 :         if topFile == nil || topLevel >= numLevels {
     877            1 :                 return
     878            1 :         }
     879            1 :         if numOverlappingLevels >= 2 {
     880            1 :                 allowedSeeks := topFile.AllowedSeeks.Add(-1)
     881            1 :                 if allowedSeeks == 0 {
     882            1 : 
     883            1 :                         // Since the compaction queue can handle duplicates, we can keep
     884            1 :                         // adding to the queue even once allowedSeeks hits 0.
     885            1 :                         // In fact, we NEED to keep adding to the queue, because the queue
     886            1 :                         // is small and evicts older and possibly useful compactions.
     887            1 :                         topFile.AllowedSeeks.Add(topFile.InitAllowedSeeks)
     888            1 : 
     889            1 :                         read := readCompaction{
     890            1 :                                 start:   topFile.PointKeyBounds.SmallestUserKey(),
     891            1 :                                 end:     topFile.PointKeyBounds.LargestUserKey(),
     892            1 :                                 level:   topLevel,
     893            1 :                                 fileNum: topFile.TableNum,
     894            1 :                         }
     895            1 :                         i.readSampling.pendingCompactions.add(&read, i.cmp)
     896            1 :                 }
     897              :         }
     898              : }
     899              : 
     900            1 : func (i *Iterator) findPrevEntry(limit []byte) {
     901            1 :         i.iterValidityState = IterExhausted
     902            1 :         i.pos = iterPosCurReverse
     903            1 :         if i.opts.rangeKeys() && i.rangeKey != nil {
     904            1 :                 i.rangeKey.rangeKeyOnly = false
     905            1 :         }
     906              : 
     907              :         // Close the closer for the current value if one was open.
     908            1 :         if i.valueCloser != nil {
     909            0 :                 i.err = i.valueCloser.Close()
     910            0 :                 i.valueCloser = nil
     911            0 :                 if i.err != nil {
     912            0 :                         i.iterValidityState = IterExhausted
     913            0 :                         return
     914            0 :                 }
     915              :         }
     916              : 
     917            1 :         var valueMerger ValueMerger
     918            1 :         firstLoopIter := true
     919            1 :         rangeKeyBoundary := false
     920            1 :         // The code below compares with limit in multiple places. As documented in
     921            1 :         // findNextEntry, this is being done to make the behavior of limit
     922            1 :         // deterministic to allow for metamorphic testing. It is not required by
     923            1 :         // the best-effort contract of limit.
     924            1 :         for i.iterKV != nil {
     925            1 :                 key := i.iterKV.K
     926            1 : 
     927            1 :                 // NB: We cannot pause if the current key is covered by a range key.
     928            1 :                 // Otherwise, the user might not ever learn of a range key that covers
     929            1 :                 // the key space being iterated over in which there are no point keys.
     930            1 :                 // Since limits are best effort, ignoring the limit in this case is
     931            1 :                 // allowed by the contract of limit.
     932            1 :                 if firstLoopIter && limit != nil && i.cmp(limit, i.iterKV.K.UserKey) > 0 && !i.rangeKeyWithinLimit(limit) {
     933            1 :                         i.iterValidityState = IterAtLimit
     934            1 :                         i.pos = iterPosCurReversePaused
     935            1 :                         return
     936            1 :                 }
     937            1 :                 firstLoopIter = false
     938            1 : 
     939            1 :                 if i.iterValidityState == IterValid {
     940            1 :                         if !i.equal(key.UserKey, i.key) {
     941            1 :                                 // We've iterated to the previous user key.
     942            1 :                                 i.pos = iterPosPrev
     943            1 :                                 if valueMerger != nil {
     944            1 :                                         var needDelete bool
     945            1 :                                         var value []byte
     946            1 :                                         value, needDelete, i.valueCloser, i.err = finishValueMerger(valueMerger, true /* includesBase */)
     947            1 :                                         i.value = base.MakeInPlaceValue(value)
     948            1 :                                         if i.err == nil && needDelete {
     949            1 :                                                 // The point key at this key is deleted. If we also have
     950            1 :                                                 // a range key boundary at this key, we still want to
     951            1 :                                                 // return. Otherwise, we need to continue looking for
     952            1 :                                                 // a live key.
     953            1 :                                                 i.value = base.InternalValue{}
     954            1 :                                                 if rangeKeyBoundary {
     955            0 :                                                         i.rangeKey.rangeKeyOnly = true
     956            1 :                                                 } else {
     957            1 :                                                         i.iterValidityState = IterExhausted
     958            1 :                                                         if i.closeValueCloser() == nil {
     959            1 :                                                                 continue
     960              :                                                         }
     961              :                                                 }
     962              :                                         }
     963              :                                 }
     964            1 :                                 if i.err != nil {
     965            0 :                                         i.iterValidityState = IterExhausted
     966            0 :                                 }
     967            1 :                                 return
     968              :                         }
     969              :                 }
     970              : 
     971              :                 // If the user has configured a SkipPoint function, invoke it to see
     972              :                 // whether we should skip over the current user key.
     973            1 :                 if i.opts.SkipPoint != nil && key.Kind() != InternalKeyKindRangeKeySet && i.opts.SkipPoint(key.UserKey) {
     974            1 :                         // NB: We could call prevUserKey, but in some cases the SkipPoint
     975            1 :                         // predicate function might be cheaper than prevUserKey's key copy
     976            1 :                         // and key comparison. This should be the case for MVCC suffix
     977            1 :                         // comparisons, for example. In the future, we could expand the
     978            1 :                         // SkipPoint interface to give the implementor more control over
     979            1 :                         // whether we skip over just the internal key, the user key, or even
     980            1 :                         // the key prefix.
     981            1 :                         i.stats.ReverseStepCount[InternalIterCall]++
     982            1 :                         i.iterKV = i.iter.Prev()
     983            1 :                         if i.iterKV == nil {
     984            1 :                                 if err := i.iter.Error(); err != nil {
     985            0 :                                         i.err = err
     986            0 :                                         i.iterValidityState = IterExhausted
     987            0 :                                         return
     988            0 :                                 }
     989              :                         }
     990            1 :                         if limit != nil && i.iterKV != nil && i.cmp(limit, i.iterKV.K.UserKey) > 0 && !i.rangeKeyWithinLimit(limit) {
     991            1 :                                 i.iterValidityState = IterAtLimit
     992            1 :                                 i.pos = iterPosCurReversePaused
     993            1 :                                 return
     994            1 :                         }
     995            1 :                         continue
     996              :                 }
     997              : 
     998            1 :                 switch key.Kind() {
     999            1 :                 case InternalKeyKindRangeKeySet:
    1000            1 :                         // Range key start boundary markers are interleaved with the maximum
    1001            1 :                         // sequence number, so if there's a point key also at this key, we
    1002            1 :                         // must've already iterated over it.
    1003            1 :                         // This is the final entry at this user key, so we may return
    1004            1 :                         i.rangeKey.rangeKeyOnly = i.iterValidityState != IterValid
    1005            1 :                         i.keyBuf = append(i.keyBuf[:0], key.UserKey...)
    1006            1 :                         i.key = i.keyBuf
    1007            1 :                         i.iterValidityState = IterValid
    1008            1 :                         i.saveRangeKey()
    1009            1 :                         // In all other cases, previous iteration requires advancing to
    1010            1 :                         // iterPosPrev in order to determine if the key is live and
    1011            1 :                         // unshadowed by another key at the same user key. In this case,
    1012            1 :                         // because range key start boundary markers are always interleaved
    1013            1 :                         // at the maximum sequence number, we know that there aren't any
    1014            1 :                         // additional keys with the same user key in the backward direction.
    1015            1 :                         //
    1016            1 :                         // We Prev the underlying iterator once anyways for consistency, so
    1017            1 :                         // that we can maintain the invariant during backward iteration that
    1018            1 :                         // i.iterPos = iterPosPrev.
    1019            1 :                         i.stats.ReverseStepCount[InternalIterCall]++
    1020            1 :                         i.iterKV = i.iter.Prev()
    1021            1 : 
    1022            1 :                         // Set rangeKeyBoundary so that on the next iteration, we know to
    1023            1 :                         // return the key even if the MERGE point key is deleted.
    1024            1 :                         rangeKeyBoundary = true
    1025              : 
    1026            1 :                 case InternalKeyKindDelete, InternalKeyKindSingleDelete, InternalKeyKindDeleteSized:
    1027            1 :                         i.value = base.InternalValue{}
    1028            1 :                         i.iterValidityState = IterExhausted
    1029            1 :                         valueMerger = nil
    1030            1 :                         i.stats.ReverseStepCount[InternalIterCall]++
    1031            1 :                         i.iterKV = i.iter.Prev()
    1032            1 :                         // Compare with the limit. We could optimize by only checking when
    1033            1 :                         // we step to the previous user key, but detecting that requires a
    1034            1 :                         // comparison too. Note that this position may already passed a
    1035            1 :                         // number of versions of this user key, but they are all deleted, so
    1036            1 :                         // the fact that a subsequent Prev*() call will not see them is
    1037            1 :                         // harmless. Also note that this is the only place in the loop,
    1038            1 :                         // other than the firstLoopIter and SkipPoint cases above, where we
    1039            1 :                         // could step to a different user key and start processing it for
    1040            1 :                         // returning to the caller.
    1041            1 :                         if limit != nil && i.iterKV != nil && i.cmp(limit, i.iterKV.K.UserKey) > 0 && !i.rangeKeyWithinLimit(limit) {
    1042            1 :                                 i.iterValidityState = IterAtLimit
    1043            1 :                                 i.pos = iterPosCurReversePaused
    1044            1 :                                 return
    1045            1 :                         }
    1046            1 :                         continue
    1047              : 
    1048            1 :                 case InternalKeyKindSet, InternalKeyKindSetWithDelete:
    1049            1 :                         i.keyBuf = append(i.keyBuf[:0], key.UserKey...)
    1050            1 :                         i.key = i.keyBuf
    1051            1 :                         // iterValue is owned by i.iter and could change after the Prev()
    1052            1 :                         // call, so use valueBuf instead. Note that valueBuf is only used
    1053            1 :                         // in this one instance; everywhere else (eg. in findNextEntry),
    1054            1 :                         // we just point i.value to the unsafe i.iter-owned value buffer.
    1055            1 :                         i.value, i.valueBuf = i.iterKV.V.Clone(i.valueBuf[:0], &i.fetcher)
    1056            1 :                         i.saveRangeKey()
    1057            1 :                         i.iterValidityState = IterValid
    1058            1 :                         i.iterKV = i.iter.Prev()
    1059            1 :                         i.stats.ReverseStepCount[InternalIterCall]++
    1060            1 :                         valueMerger = nil
    1061            1 :                         continue
    1062              : 
    1063            1 :                 case InternalKeyKindMerge:
    1064            1 :                         if i.iterValidityState == IterExhausted {
    1065            1 :                                 i.keyBuf = append(i.keyBuf[:0], key.UserKey...)
    1066            1 :                                 i.key = i.keyBuf
    1067            1 :                                 i.saveRangeKey()
    1068            1 :                                 var iterValue []byte
    1069            1 :                                 iterValue, _, i.err = i.iterKV.Value(nil)
    1070            1 :                                 if i.err != nil {
    1071            0 :                                         return
    1072            0 :                                 }
    1073            1 :                                 valueMerger, i.err = i.merge(i.key, iterValue)
    1074            1 :                                 if i.err != nil {
    1075            0 :                                         return
    1076            0 :                                 }
    1077            1 :                                 i.iterValidityState = IterValid
    1078            1 :                         } else if valueMerger == nil {
    1079            1 :                                 // Extract value before iterValue since we use value before iterValue
    1080            1 :                                 // and the underlying iterator is not required to provide backing
    1081            1 :                                 // memory for both simultaneously.
    1082            1 :                                 var value []byte
    1083            1 :                                 var callerOwned bool
    1084            1 :                                 value, callerOwned, i.err = i.value.Value(i.lazyValueBuf)
    1085            1 :                                 if callerOwned {
    1086            0 :                                         i.lazyValueBuf = value[:0]
    1087            0 :                                 }
    1088            1 :                                 if i.err != nil {
    1089            0 :                                         i.iterValidityState = IterExhausted
    1090            0 :                                         return
    1091            0 :                                 }
    1092            1 :                                 valueMerger, i.err = i.merge(i.key, value)
    1093            1 :                                 var iterValue []byte
    1094            1 :                                 iterValue, _, i.err = i.iterKV.Value(nil)
    1095            1 :                                 if i.err != nil {
    1096            0 :                                         i.iterValidityState = IterExhausted
    1097            0 :                                         return
    1098            0 :                                 }
    1099            1 :                                 if i.err == nil {
    1100            1 :                                         i.err = valueMerger.MergeNewer(iterValue)
    1101            1 :                                 }
    1102            1 :                                 if i.err != nil {
    1103            0 :                                         i.iterValidityState = IterExhausted
    1104            0 :                                         return
    1105            0 :                                 }
    1106            1 :                         } else {
    1107            1 :                                 var iterValue []byte
    1108            1 :                                 iterValue, _, i.err = i.iterKV.Value(nil)
    1109            1 :                                 if i.err != nil {
    1110            0 :                                         i.iterValidityState = IterExhausted
    1111            0 :                                         return
    1112            0 :                                 }
    1113            1 :                                 i.err = valueMerger.MergeNewer(iterValue)
    1114            1 :                                 if i.err != nil {
    1115            0 :                                         i.iterValidityState = IterExhausted
    1116            0 :                                         return
    1117            0 :                                 }
    1118              :                         }
    1119            1 :                         i.iterKV = i.iter.Prev()
    1120            1 :                         i.stats.ReverseStepCount[InternalIterCall]++
    1121            1 :                         continue
    1122              : 
    1123            0 :                 default:
    1124            0 :                         i.err = base.CorruptionErrorf("pebble: invalid internal key kind: %d", errors.Safe(key.Kind()))
    1125            0 :                         i.iterValidityState = IterExhausted
    1126            0 :                         return
    1127              :                 }
    1128              :         }
    1129              :         // i.iterKV == nil, so broke out of the preceding loop.
    1130              : 
    1131              :         // Is iterKey nil due to an error?
    1132            1 :         if i.err = i.iter.Error(); i.err != nil {
    1133            1 :                 i.iterValidityState = IterExhausted
    1134            1 :                 return
    1135            1 :         }
    1136              : 
    1137            1 :         if i.iterValidityState == IterValid {
    1138            1 :                 i.pos = iterPosPrev
    1139            1 :                 if valueMerger != nil {
    1140            1 :                         var needDelete bool
    1141            1 :                         var value []byte
    1142            1 :                         value, needDelete, i.valueCloser, i.err = finishValueMerger(valueMerger, true /* includesBase */)
    1143            1 :                         i.value = base.MakeInPlaceValue(value)
    1144            1 :                         if i.err == nil && needDelete {
    1145            1 :                                 i.key = nil
    1146            1 :                                 i.value = base.InternalValue{}
    1147            1 :                                 i.iterValidityState = IterExhausted
    1148            1 :                         }
    1149              :                 }
    1150            1 :                 if i.err != nil {
    1151            0 :                         i.iterValidityState = IterExhausted
    1152            0 :                 }
    1153              :         }
    1154              : }
    1155              : 
    1156            1 : func (i *Iterator) prevUserKey() {
    1157            1 :         if i.iterKV == nil {
    1158            1 :                 return
    1159            1 :         }
    1160            1 :         if i.iterValidityState != IterValid {
    1161            1 :                 // If we're going to compare against the prev key, we need to save the
    1162            1 :                 // current key.
    1163            1 :                 i.keyBuf = append(i.keyBuf[:0], i.iterKV.K.UserKey...)
    1164            1 :                 i.key = i.keyBuf
    1165            1 :         }
    1166            1 :         for {
    1167            1 :                 i.iterKV = i.iter.Prev()
    1168            1 :                 i.stats.ReverseStepCount[InternalIterCall]++
    1169            1 :                 if i.iterKV == nil {
    1170            1 :                         if err := i.iter.Error(); err != nil {
    1171            0 :                                 i.err = err
    1172            0 :                                 i.iterValidityState = IterExhausted
    1173            0 :                         }
    1174            1 :                         break
    1175              :                 }
    1176            1 :                 if !i.equal(i.key, i.iterKV.K.UserKey) {
    1177            1 :                         break
    1178              :                 }
    1179              :         }
    1180              : }
    1181              : 
    1182            1 : func (i *Iterator) mergeNext(key InternalKey, valueMerger ValueMerger) {
    1183            1 :         // Save the current key.
    1184            1 :         i.keyBuf = append(i.keyBuf[:0], key.UserKey...)
    1185            1 :         i.key = i.keyBuf
    1186            1 : 
    1187            1 :         // Loop looking for older values for this key and merging them.
    1188            1 :         for {
    1189            1 :                 i.iterKV = i.iter.Next()
    1190            1 :                 i.stats.ForwardStepCount[InternalIterCall]++
    1191            1 :                 if i.iterKV == nil {
    1192            1 :                         if i.err = i.iter.Error(); i.err != nil {
    1193            1 :                                 return
    1194            1 :                         }
    1195            1 :                         i.pos = iterPosNext
    1196            1 :                         return
    1197              :                 }
    1198            1 :                 key = i.iterKV.K
    1199            1 :                 if !i.equal(i.key, key.UserKey) {
    1200            1 :                         // We've advanced to the next key.
    1201            1 :                         i.pos = iterPosNext
    1202            1 :                         return
    1203            1 :                 }
    1204            1 :                 switch key.Kind() {
    1205            1 :                 case InternalKeyKindDelete, InternalKeyKindSingleDelete, InternalKeyKindDeleteSized:
    1206            1 :                         // We've hit a deletion tombstone. Return everything up to this
    1207            1 :                         // point.
    1208            1 :                         //
    1209            1 :                         // NB: treating InternalKeyKindSingleDelete as equivalent to DEL is not
    1210            1 :                         // only simpler, but is also necessary for correctness due to
    1211            1 :                         // InternalKeyKindSSTableInternalObsoleteBit.
    1212            1 :                         return
    1213              : 
    1214            1 :                 case InternalKeyKindSet, InternalKeyKindSetWithDelete:
    1215            1 :                         // We've hit a Set value. Merge with the existing value and return.
    1216            1 :                         var iterValue []byte
    1217            1 :                         iterValue, _, i.err = i.iterKV.Value(nil)
    1218            1 :                         if i.err != nil {
    1219            0 :                                 return
    1220            0 :                         }
    1221            1 :                         i.err = valueMerger.MergeOlder(iterValue)
    1222            1 :                         return
    1223              : 
    1224            1 :                 case InternalKeyKindMerge:
    1225            1 :                         // We've hit another Merge value. Merge with the existing value and
    1226            1 :                         // continue looping.
    1227            1 :                         var iterValue []byte
    1228            1 :                         iterValue, _, i.err = i.iterKV.Value(nil)
    1229            1 :                         if i.err != nil {
    1230            0 :                                 return
    1231            0 :                         }
    1232            1 :                         i.err = valueMerger.MergeOlder(iterValue)
    1233            1 :                         if i.err != nil {
    1234            0 :                                 return
    1235            0 :                         }
    1236            1 :                         continue
    1237              : 
    1238            0 :                 case InternalKeyKindRangeKeySet:
    1239            0 :                         // The RANGEKEYSET marker must sort before a MERGE at the same user key.
    1240            0 :                         i.err = base.CorruptionErrorf("pebble: out of order range key marker")
    1241            0 :                         return
    1242              : 
    1243            0 :                 default:
    1244            0 :                         i.err = base.CorruptionErrorf("pebble: invalid internal key kind: %d", errors.Safe(key.Kind()))
    1245            0 :                         return
    1246              :                 }
    1247              :         }
    1248              : }
    1249              : 
    1250              : // SeekGE moves the iterator to the first key/value pair whose key is greater
    1251              : // than or equal to the given key. Returns true if the iterator is pointing at
    1252              : // a valid entry and false otherwise.
    1253            1 : func (i *Iterator) SeekGE(key []byte) bool {
    1254            1 :         return i.SeekGEWithLimit(key, nil) == IterValid
    1255            1 : }
    1256              : 
    1257              : // SeekGEWithLimit moves the iterator to the first key/value pair whose key is
    1258              : // greater than or equal to the given key.
    1259              : //
    1260              : // If limit is provided, it serves as a best-effort exclusive limit. If the
    1261              : // first key greater than or equal to the given search key is also greater than
    1262              : // or equal to limit, the Iterator may pause and return IterAtLimit. Because
    1263              : // limits are best-effort, SeekGEWithLimit may return a key beyond limit.
    1264              : //
    1265              : // If the Iterator is configured to iterate over range keys, SeekGEWithLimit
    1266              : // guarantees it will surface any range keys with bounds overlapping the
    1267              : // keyspace [key, limit).
    1268            1 : func (i *Iterator) SeekGEWithLimit(key []byte, limit []byte) IterValidityState {
    1269            1 :         if i.rangeKey != nil {
    1270            1 :                 // NB: Check Valid() before clearing requiresReposition.
    1271            1 :                 i.rangeKey.prevPosHadRangeKey = i.rangeKey.hasRangeKey && i.Valid()
    1272            1 :                 // If we have a range key but did not expose it at the previous iterator
    1273            1 :                 // position (because the iterator was not at a valid position), updated
    1274            1 :                 // must be true. This ensures that after an iterator op sequence like:
    1275            1 :                 //   - Next()             → (IterValid, RangeBounds() = [a,b))
    1276            1 :                 //   - NextWithLimit(...) → (IterAtLimit, RangeBounds() = -)
    1277            1 :                 //   - SeekGE(...)        → (IterValid, RangeBounds() = [a,b))
    1278            1 :                 // the iterator returns RangeKeyChanged()=true.
    1279            1 :                 //
    1280            1 :                 // The remainder of this function will only update i.rangeKey.updated if
    1281            1 :                 // the iterator moves into a new range key, or out of the current range
    1282            1 :                 // key.
    1283            1 :                 i.rangeKey.updated = i.rangeKey.hasRangeKey && !i.Valid() && i.opts.rangeKeys()
    1284            1 :         }
    1285            1 :         lastPositioningOp := i.lastPositioningOp
    1286            1 :         // Set it to unknown, since this operation may not succeed, in which case
    1287            1 :         // the SeekGE following this should not make any assumption about iterator
    1288            1 :         // position.
    1289            1 :         i.lastPositioningOp = unknownLastPositionOp
    1290            1 :         i.requiresReposition = false
    1291            1 :         i.err = nil // clear cached iteration error
    1292            1 :         i.hasPrefix = false
    1293            1 :         i.stats.ForwardSeekCount[InterfaceCall]++
    1294            1 :         if lowerBound := i.opts.GetLowerBound(); lowerBound != nil && i.cmp(key, lowerBound) < 0 {
    1295            1 :                 key = lowerBound
    1296            1 :         } else if upperBound := i.opts.GetUpperBound(); upperBound != nil && i.cmp(key, upperBound) > 0 {
    1297            1 :                 key = upperBound
    1298            1 :         }
    1299            1 :         seekInternalIter := true
    1300            1 : 
    1301            1 :         var flags base.SeekGEFlags
    1302            1 :         if i.batchJustRefreshed {
    1303            1 :                 i.batchJustRefreshed = false
    1304            1 :                 flags = flags.EnableBatchJustRefreshed()
    1305            1 :         }
    1306            1 :         if lastPositioningOp == seekGELastPositioningOp {
    1307            1 :                 cmp := i.cmp(i.prefixOrFullSeekKey, key)
    1308            1 :                 // If this seek is to the same or later key, and the iterator is
    1309            1 :                 // already positioned there, this is a noop. This can be helpful for
    1310            1 :                 // sparse key spaces that have many deleted keys, where one can avoid
    1311            1 :                 // the overhead of iterating past them again and again.
    1312            1 :                 if cmp <= 0 {
    1313            1 :                         if !flags.BatchJustRefreshed() &&
    1314            1 :                                 (i.iterValidityState == IterExhausted ||
    1315            1 :                                         (i.iterValidityState == IterValid && i.cmp(key, i.key) <= 0 &&
    1316            1 :                                                 (limit == nil || i.cmp(i.key, limit) < 0))) {
    1317            1 :                                 // Noop
    1318            1 :                                 if i.forceEnableSeekOpt || !testingDisableSeekOpt(key, uintptr(unsafe.Pointer(i))) {
    1319            1 :                                         i.lastPositioningOp = seekGELastPositioningOp
    1320            1 :                                         return i.iterValidityState
    1321            1 :                                 }
    1322              :                         }
    1323              :                         // cmp == 0 is not safe to optimize since
    1324              :                         // - i.pos could be at iterPosNext, due to a merge.
    1325              :                         // - Even if i.pos were at iterPosCurForward, we could have a DELETE,
    1326              :                         //   SET pair for a key, and the iterator would have moved past DELETE
    1327              :                         //   but stayed at iterPosCurForward. A similar situation occurs for a
    1328              :                         //   MERGE, SET pair where the MERGE is consumed and the iterator is
    1329              :                         //   at the SET.
    1330              :                         // We also leverage the IterAtLimit <=> i.pos invariant defined in the
    1331              :                         // comment on iterValidityState, to exclude any cases where i.pos
    1332              :                         // is iterPosCur{Forward,Reverse}Paused. This avoids the need to
    1333              :                         // special-case those iterator positions and their interactions with
    1334              :                         // TrySeekUsingNext, as the main uses for TrySeekUsingNext in CockroachDB
    1335              :                         // do not use limited Seeks in the first place.
    1336            1 :                         if cmp < 0 && i.iterValidityState != IterAtLimit && limit == nil {
    1337            1 :                                 flags = flags.EnableTrySeekUsingNext()
    1338            1 :                         }
    1339            1 :                         if testingDisableSeekOpt(key, uintptr(unsafe.Pointer(i))) && !i.forceEnableSeekOpt {
    1340            1 :                                 flags = flags.DisableTrySeekUsingNext()
    1341            1 :                         }
    1342            1 :                         if !flags.BatchJustRefreshed() && i.pos == iterPosCurForwardPaused && i.cmp(key, i.iterKV.K.UserKey) <= 0 {
    1343            1 :                                 // Have some work to do, but don't need to seek, and we can
    1344            1 :                                 // start doing findNextEntry from i.iterKey.
    1345            1 :                                 seekInternalIter = false
    1346            1 :                         }
    1347              :                 }
    1348              :         }
    1349            1 :         if seekInternalIter {
    1350            1 :                 i.iterKV = i.iter.SeekGE(key, flags)
    1351            1 :                 i.stats.ForwardSeekCount[InternalIterCall]++
    1352            1 :                 if err := i.iter.Error(); err != nil {
    1353            1 :                         i.err = err
    1354            1 :                         i.iterValidityState = IterExhausted
    1355            1 :                         return i.iterValidityState
    1356            1 :                 }
    1357              :         }
    1358            1 :         i.findNextEntry(limit)
    1359            1 :         i.maybeSampleRead()
    1360            1 :         if i.Error() == nil {
    1361            1 :                 // Prepare state for a future noop optimization.
    1362            1 :                 i.prefixOrFullSeekKey = append(i.prefixOrFullSeekKey[:0], key...)
    1363            1 :                 i.lastPositioningOp = seekGELastPositioningOp
    1364            1 :         }
    1365            1 :         return i.iterValidityState
    1366              : }
    1367              : 
    1368              : // SeekPrefixGE moves the iterator to the first key/value pair whose key is
    1369              : // greater than or equal to the given key and which has the same "prefix" as
    1370              : // the given key. The prefix for a key is determined by the user-defined
    1371              : // Comparer.Split function. The iterator will not observe keys not matching the
    1372              : // "prefix" of the search key. Calling SeekPrefixGE puts the iterator in prefix
    1373              : // iteration mode. The iterator remains in prefix iteration until a subsequent
    1374              : // call to another absolute positioning method (SeekGE, SeekLT, First,
    1375              : // Last). Reverse iteration (Prev) is not supported when an iterator is in
    1376              : // prefix iteration mode. Returns true if the iterator is pointing at a valid
    1377              : // entry and false otherwise.
    1378              : //
    1379              : // The semantics of SeekPrefixGE are slightly unusual and designed for
    1380              : // iteration to be able to take advantage of bloom filters that have been
    1381              : // created on the "prefix". If you're not using bloom filters, there is no
    1382              : // reason to use SeekPrefixGE.
    1383              : //
    1384              : // An example Split function may separate a timestamp suffix from the prefix of
    1385              : // the key.
    1386              : //
    1387              : //      Split(<key>@<timestamp>) -> <key>
    1388              : //
    1389              : // Consider the keys "a@1", "a@2", "aa@3", "aa@4". The prefixes for these keys
    1390              : // are "a", and "aa". Note that despite "a" and "aa" sharing a prefix by the
    1391              : // usual definition, those prefixes differ by the definition of the Split
    1392              : // function. To see how this works, consider the following set of calls on this
    1393              : // data set:
    1394              : //
    1395              : //      SeekPrefixGE("a@0") -> "a@1"
    1396              : //      Next()              -> "a@2"
    1397              : //      Next()              -> EOF
    1398              : //
    1399              : // If you're just looking to iterate over keys with a shared prefix, as
    1400              : // defined by the configured comparer, set iterator bounds instead:
    1401              : //
    1402              : //      iter := db.NewIter(&pebble.IterOptions{
    1403              : //        LowerBound: []byte("prefix"),
    1404              : //        UpperBound: []byte("prefiy"),
    1405              : //      })
    1406              : //      for iter.First(); iter.Valid(); iter.Next() {
    1407              : //        // Only keys beginning with "prefix" will be visited.
    1408              : //      }
    1409              : //
    1410              : // See ExampleIterator_SeekPrefixGE for a working example.
    1411              : //
    1412              : // When iterating with range keys enabled, all range keys encountered are
    1413              : // truncated to the seek key's prefix's bounds. The truncation of the upper
    1414              : // bound requires that the database's Comparer is configured with a
    1415              : // ImmediateSuccessor method. For example, a SeekPrefixGE("a@9") call with the
    1416              : // prefix "a" will truncate range key bounds to [a,ImmediateSuccessor(a)].
    1417            1 : func (i *Iterator) SeekPrefixGE(key []byte) bool {
    1418            1 :         if i.rangeKey != nil {
    1419            1 :                 // NB: Check Valid() before clearing requiresReposition.
    1420            1 :                 i.rangeKey.prevPosHadRangeKey = i.rangeKey.hasRangeKey && i.Valid()
    1421            1 :                 // If we have a range key but did not expose it at the previous iterator
    1422            1 :                 // position (because the iterator was not at a valid position), updated
    1423            1 :                 // must be true. This ensures that after an iterator op sequence like:
    1424            1 :                 //   - Next()             → (IterValid, RangeBounds() = [a,b))
    1425            1 :                 //   - NextWithLimit(...) → (IterAtLimit, RangeBounds() = -)
    1426            1 :                 //   - SeekPrefixGE(...)  → (IterValid, RangeBounds() = [a,b))
    1427            1 :                 // the iterator returns RangeKeyChanged()=true.
    1428            1 :                 //
    1429            1 :                 // The remainder of this function will only update i.rangeKey.updated if
    1430            1 :                 // the iterator moves into a new range key, or out of the current range
    1431            1 :                 // key.
    1432            1 :                 i.rangeKey.updated = i.rangeKey.hasRangeKey && !i.Valid() && i.opts.rangeKeys()
    1433            1 :         }
    1434            1 :         lastPositioningOp := i.lastPositioningOp
    1435            1 :         // Set it to unknown, since this operation may not succeed, in which case
    1436            1 :         // the SeekPrefixGE following this should not make any assumption about
    1437            1 :         // iterator position.
    1438            1 :         i.lastPositioningOp = unknownLastPositionOp
    1439            1 :         i.requiresReposition = false
    1440            1 :         i.err = nil // clear cached iteration error
    1441            1 :         i.stats.ForwardSeekCount[InterfaceCall]++
    1442            1 :         if i.comparer.ImmediateSuccessor == nil && i.opts.KeyTypes != IterKeyTypePointsOnly {
    1443            0 :                 panic("pebble: ImmediateSuccessor must be provided for SeekPrefixGE with range keys")
    1444              :         }
    1445            1 :         prefixLen := i.comparer.Split(key)
    1446            1 :         keyPrefix := key[:prefixLen]
    1447            1 :         var flags base.SeekGEFlags
    1448            1 :         if i.batchJustRefreshed {
    1449            1 :                 flags = flags.EnableBatchJustRefreshed()
    1450            1 :                 i.batchJustRefreshed = false
    1451            1 :         }
    1452            1 :         if lastPositioningOp == seekPrefixGELastPositioningOp {
    1453            1 :                 if !i.hasPrefix {
    1454            0 :                         panic("lastPositioningOpsIsSeekPrefixGE is true, but hasPrefix is false")
    1455              :                 }
    1456              :                 // The iterator has not been repositioned after the last SeekPrefixGE.
    1457              :                 // See if we are seeking to a larger key, since then we can optimize
    1458              :                 // the seek by using next. Note that we could also optimize if Next
    1459              :                 // has been called, if the iterator is not exhausted and the current
    1460              :                 // position is <= the seek key. We are keeping this limited for now
    1461              :                 // since such optimizations require care for correctness, and to not
    1462              :                 // become de-optimizations (if one usually has to do all the next
    1463              :                 // calls and then the seek). This SeekPrefixGE optimization
    1464              :                 // specifically benefits CockroachDB.
    1465            1 :                 cmp := i.cmp(i.prefixOrFullSeekKey, keyPrefix)
    1466            1 :                 // cmp == 0 is not safe to optimize since
    1467            1 :                 // - i.pos could be at iterPosNext, due to a merge.
    1468            1 :                 // - Even if i.pos were at iterPosCurForward, we could have a DELETE,
    1469            1 :                 //   SET pair for a key, and the iterator would have moved past DELETE
    1470            1 :                 //   but stayed at iterPosCurForward. A similar situation occurs for a
    1471            1 :                 //   MERGE, SET pair where the MERGE is consumed and the iterator is
    1472            1 :                 //   at the SET.
    1473            1 :                 // In general some versions of i.prefix could have been consumed by
    1474            1 :                 // the iterator, so we only optimize for cmp < 0.
    1475            1 :                 if cmp < 0 {
    1476            1 :                         flags = flags.EnableTrySeekUsingNext()
    1477            1 :                 }
    1478            1 :                 if testingDisableSeekOpt(key, uintptr(unsafe.Pointer(i))) && !i.forceEnableSeekOpt {
    1479            1 :                         flags = flags.DisableTrySeekUsingNext()
    1480            1 :                 }
    1481              :         }
    1482              :         // Make a copy of the prefix so that modifications to the key after
    1483              :         // SeekPrefixGE returns does not affect the stored prefix.
    1484            1 :         if cap(i.prefixOrFullSeekKey) < prefixLen {
    1485            1 :                 i.prefixOrFullSeekKey = make([]byte, prefixLen)
    1486            1 :         } else {
    1487            1 :                 i.prefixOrFullSeekKey = i.prefixOrFullSeekKey[:prefixLen]
    1488            1 :         }
    1489            1 :         i.hasPrefix = true
    1490            1 :         copy(i.prefixOrFullSeekKey, keyPrefix)
    1491            1 : 
    1492            1 :         if lowerBound := i.opts.GetLowerBound(); lowerBound != nil && i.cmp(key, lowerBound) < 0 {
    1493            1 :                 if p := i.comparer.Split.Prefix(lowerBound); !bytes.Equal(i.prefixOrFullSeekKey, p) {
    1494            1 :                         i.err = errors.New("pebble: SeekPrefixGE supplied with key outside of lower bound")
    1495            1 :                         i.iterValidityState = IterExhausted
    1496            1 :                         return false
    1497            1 :                 }
    1498            1 :                 key = lowerBound
    1499            1 :         } else if upperBound := i.opts.GetUpperBound(); upperBound != nil && i.cmp(key, upperBound) > 0 {
    1500            1 :                 if p := i.comparer.Split.Prefix(upperBound); !bytes.Equal(i.prefixOrFullSeekKey, p) {
    1501            1 :                         i.err = errors.New("pebble: SeekPrefixGE supplied with key outside of upper bound")
    1502            1 :                         i.iterValidityState = IterExhausted
    1503            1 :                         return false
    1504            1 :                 }
    1505            0 :                 key = upperBound
    1506              :         }
    1507            1 :         i.iterKV = i.iter.SeekPrefixGE(i.prefixOrFullSeekKey, key, flags)
    1508            1 :         i.stats.ForwardSeekCount[InternalIterCall]++
    1509            1 :         i.findNextEntry(nil)
    1510            1 :         i.maybeSampleRead()
    1511            1 :         if i.Error() == nil {
    1512            1 :                 i.lastPositioningOp = seekPrefixGELastPositioningOp
    1513            1 :         }
    1514            1 :         return i.iterValidityState == IterValid
    1515              : }
    1516              : 
    1517              : // Deterministic disabling (in testing mode) of the seek optimizations. It uses
    1518              : // the iterator pointer, since we want diversity in iterator behavior for the
    1519              : // same key.  Used for tests.
    1520            1 : func testingDisableSeekOpt(key []byte, ptr uintptr) bool {
    1521            1 :         if !invariants.Enabled {
    1522            0 :                 return false
    1523            0 :         }
    1524              :         // Fibonacci hash https://probablydance.com/2018/06/16/fibonacci-hashing-the-optimization-that-the-world-forgot-or-a-better-alternative-to-integer-modulo/
    1525            1 :         simpleHash := (11400714819323198485 * uint64(ptr)) >> 63
    1526            1 :         return key != nil && key[0]&byte(1) == 0 && simpleHash == 0
    1527              : }
    1528              : 
    1529              : // SeekLT moves the iterator to the last key/value pair whose key is less than
    1530              : // the given key. Returns true if the iterator is pointing at a valid entry and
    1531              : // false otherwise.
    1532            1 : func (i *Iterator) SeekLT(key []byte) bool {
    1533            1 :         return i.SeekLTWithLimit(key, nil) == IterValid
    1534            1 : }
    1535              : 
    1536              : // SeekLTWithLimit moves the iterator to the last key/value pair whose key is
    1537              : // less than the given key.
    1538              : //
    1539              : // If limit is provided, it serves as a best-effort inclusive limit. If the last
    1540              : // key less than the given search key is also less than limit, the Iterator may
    1541              : // pause and return IterAtLimit. Because limits are best-effort, SeekLTWithLimit
    1542              : // may return a key beyond limit.
    1543              : //
    1544              : // If the Iterator is configured to iterate over range keys, SeekLTWithLimit
    1545              : // guarantees it will surface any range keys with bounds overlapping the
    1546              : // keyspace up to limit.
    1547            1 : func (i *Iterator) SeekLTWithLimit(key []byte, limit []byte) IterValidityState {
    1548            1 :         if i.rangeKey != nil {
    1549            1 :                 // NB: Check Valid() before clearing requiresReposition.
    1550            1 :                 i.rangeKey.prevPosHadRangeKey = i.rangeKey.hasRangeKey && i.Valid()
    1551            1 :                 // If we have a range key but did not expose it at the previous iterator
    1552            1 :                 // position (because the iterator was not at a valid position), updated
    1553            1 :                 // must be true. This ensures that after an iterator op sequence like:
    1554            1 :                 //   - Next()               → (IterValid, RangeBounds() = [a,b))
    1555            1 :                 //   - NextWithLimit(...)   → (IterAtLimit, RangeBounds() = -)
    1556            1 :                 //   - SeekLTWithLimit(...) → (IterValid, RangeBounds() = [a,b))
    1557            1 :                 // the iterator returns RangeKeyChanged()=true.
    1558            1 :                 //
    1559            1 :                 // The remainder of this function will only update i.rangeKey.updated if
    1560            1 :                 // the iterator moves into a new range key, or out of the current range
    1561            1 :                 // key.
    1562            1 :                 i.rangeKey.updated = i.rangeKey.hasRangeKey && !i.Valid() && i.opts.rangeKeys()
    1563            1 :         }
    1564            1 :         lastPositioningOp := i.lastPositioningOp
    1565            1 :         // Set it to unknown, since this operation may not succeed, in which case
    1566            1 :         // the SeekLT following this should not make any assumption about iterator
    1567            1 :         // position.
    1568            1 :         i.lastPositioningOp = unknownLastPositionOp
    1569            1 :         i.batchJustRefreshed = false
    1570            1 :         i.requiresReposition = false
    1571            1 :         i.err = nil // clear cached iteration error
    1572            1 :         i.stats.ReverseSeekCount[InterfaceCall]++
    1573            1 :         if upperBound := i.opts.GetUpperBound(); upperBound != nil && i.cmp(key, upperBound) > 0 {
    1574            1 :                 key = upperBound
    1575            1 :         } else if lowerBound := i.opts.GetLowerBound(); lowerBound != nil && i.cmp(key, lowerBound) < 0 {
    1576            1 :                 key = lowerBound
    1577            1 :         }
    1578            1 :         i.hasPrefix = false
    1579            1 :         seekInternalIter := true
    1580            1 :         // The following noop optimization only applies when i.batch == nil, since
    1581            1 :         // an iterator over a batch is iterating over mutable data, that may have
    1582            1 :         // changed since the last seek.
    1583            1 :         if lastPositioningOp == seekLTLastPositioningOp && i.batch == nil {
    1584            1 :                 cmp := i.cmp(key, i.prefixOrFullSeekKey)
    1585            1 :                 // If this seek is to the same or earlier key, and the iterator is
    1586            1 :                 // already positioned there, this is a noop. This can be helpful for
    1587            1 :                 // sparse key spaces that have many deleted keys, where one can avoid
    1588            1 :                 // the overhead of iterating past them again and again.
    1589            1 :                 if cmp <= 0 {
    1590            1 :                         // NB: when pos != iterPosCurReversePaused, the invariant
    1591            1 :                         // documented earlier implies that iterValidityState !=
    1592            1 :                         // IterAtLimit.
    1593            1 :                         if i.iterValidityState == IterExhausted ||
    1594            1 :                                 (i.iterValidityState == IterValid && i.cmp(i.key, key) < 0 &&
    1595            1 :                                         (limit == nil || i.cmp(limit, i.key) <= 0)) {
    1596            1 :                                 if !testingDisableSeekOpt(key, uintptr(unsafe.Pointer(i))) {
    1597            1 :                                         i.lastPositioningOp = seekLTLastPositioningOp
    1598            1 :                                         return i.iterValidityState
    1599            1 :                                 }
    1600              :                         }
    1601            1 :                         if i.pos == iterPosCurReversePaused && i.cmp(i.iterKV.K.UserKey, key) < 0 {
    1602            1 :                                 // Have some work to do, but don't need to seek, and we can
    1603            1 :                                 // start doing findPrevEntry from i.iterKey.
    1604            1 :                                 seekInternalIter = false
    1605            1 :                         }
    1606              :                 }
    1607              :         }
    1608            1 :         if seekInternalIter {
    1609            1 :                 i.iterKV = i.iter.SeekLT(key, base.SeekLTFlagsNone)
    1610            1 :                 i.stats.ReverseSeekCount[InternalIterCall]++
    1611            1 :                 if err := i.iter.Error(); err != nil {
    1612            1 :                         i.err = err
    1613            1 :                         i.iterValidityState = IterExhausted
    1614            1 :                         return i.iterValidityState
    1615            1 :                 }
    1616              :         }
    1617            1 :         i.findPrevEntry(limit)
    1618            1 :         i.maybeSampleRead()
    1619            1 :         if i.Error() == nil && i.batch == nil {
    1620            1 :                 // Prepare state for a future noop optimization.
    1621            1 :                 i.prefixOrFullSeekKey = append(i.prefixOrFullSeekKey[:0], key...)
    1622            1 :                 i.lastPositioningOp = seekLTLastPositioningOp
    1623            1 :         }
    1624            1 :         return i.iterValidityState
    1625              : }
    1626              : 
    1627              : // First moves the iterator the first key/value pair. Returns true if the
    1628              : // iterator is pointing at a valid entry and false otherwise.
    1629            1 : func (i *Iterator) First() bool {
    1630            1 :         if i.rangeKey != nil {
    1631            1 :                 // NB: Check Valid() before clearing requiresReposition.
    1632            1 :                 i.rangeKey.prevPosHadRangeKey = i.rangeKey.hasRangeKey && i.Valid()
    1633            1 :                 // If we have a range key but did not expose it at the previous iterator
    1634            1 :                 // position (because the iterator was not at a valid position), updated
    1635            1 :                 // must be true. This ensures that after an iterator op sequence like:
    1636            1 :                 //   - Next()             → (IterValid, RangeBounds() = [a,b))
    1637            1 :                 //   - NextWithLimit(...) → (IterAtLimit, RangeBounds() = -)
    1638            1 :                 //   - First(...)         → (IterValid, RangeBounds() = [a,b))
    1639            1 :                 // the iterator returns RangeKeyChanged()=true.
    1640            1 :                 //
    1641            1 :                 // The remainder of this function will only update i.rangeKey.updated if
    1642            1 :                 // the iterator moves into a new range key, or out of the current range
    1643            1 :                 // key.
    1644            1 :                 i.rangeKey.updated = i.rangeKey.hasRangeKey && !i.Valid() && i.opts.rangeKeys()
    1645            1 :         }
    1646            1 :         i.err = nil // clear cached iteration error
    1647            1 :         i.hasPrefix = false
    1648            1 :         i.batchJustRefreshed = false
    1649            1 :         i.lastPositioningOp = unknownLastPositionOp
    1650            1 :         i.requiresReposition = false
    1651            1 :         i.stats.ForwardSeekCount[InterfaceCall]++
    1652            1 : 
    1653            1 :         i.err = i.iterFirstWithinBounds()
    1654            1 :         if i.err != nil {
    1655            1 :                 i.iterValidityState = IterExhausted
    1656            1 :                 return false
    1657            1 :         }
    1658            1 :         i.findNextEntry(nil)
    1659            1 :         i.maybeSampleRead()
    1660            1 :         return i.iterValidityState == IterValid
    1661              : }
    1662              : 
    1663              : // Last moves the iterator the last key/value pair. Returns true if the
    1664              : // iterator is pointing at a valid entry and false otherwise.
    1665            1 : func (i *Iterator) Last() bool {
    1666            1 :         if i.rangeKey != nil {
    1667            1 :                 // NB: Check Valid() before clearing requiresReposition.
    1668            1 :                 i.rangeKey.prevPosHadRangeKey = i.rangeKey.hasRangeKey && i.Valid()
    1669            1 :                 // If we have a range key but did not expose it at the previous iterator
    1670            1 :                 // position (because the iterator was not at a valid position), updated
    1671            1 :                 // must be true. This ensures that after an iterator op sequence like:
    1672            1 :                 //   - Next()             → (IterValid, RangeBounds() = [a,b))
    1673            1 :                 //   - NextWithLimit(...) → (IterAtLimit, RangeBounds() = -)
    1674            1 :                 //   - Last(...)          → (IterValid, RangeBounds() = [a,b))
    1675            1 :                 // the iterator returns RangeKeyChanged()=true.
    1676            1 :                 //
    1677            1 :                 // The remainder of this function will only update i.rangeKey.updated if
    1678            1 :                 // the iterator moves into a new range key, or out of the current range
    1679            1 :                 // key.
    1680            1 :                 i.rangeKey.updated = i.rangeKey.hasRangeKey && !i.Valid() && i.opts.rangeKeys()
    1681            1 :         }
    1682            1 :         i.err = nil // clear cached iteration error
    1683            1 :         i.hasPrefix = false
    1684            1 :         i.batchJustRefreshed = false
    1685            1 :         i.lastPositioningOp = unknownLastPositionOp
    1686            1 :         i.requiresReposition = false
    1687            1 :         i.stats.ReverseSeekCount[InterfaceCall]++
    1688            1 : 
    1689            1 :         if i.err = i.iterLastWithinBounds(); i.err != nil {
    1690            0 :                 i.iterValidityState = IterExhausted
    1691            0 :                 return false
    1692            0 :         }
    1693            1 :         i.findPrevEntry(nil)
    1694            1 :         i.maybeSampleRead()
    1695            1 :         return i.iterValidityState == IterValid
    1696              : }
    1697              : 
    1698              : // Next moves the iterator to the next key/value pair. Returns true if the
    1699              : // iterator is pointing at a valid entry and false otherwise.
    1700            1 : func (i *Iterator) Next() bool {
    1701            1 :         return i.nextWithLimit(nil) == IterValid
    1702            1 : }
    1703              : 
    1704              : // NextWithLimit moves the iterator to the next key/value pair.
    1705              : //
    1706              : // If limit is provided, it serves as a best-effort exclusive limit. If the next
    1707              : // key  is greater than or equal to limit, the Iterator may pause and return
    1708              : // IterAtLimit. Because limits are best-effort, NextWithLimit may return a key
    1709              : // beyond limit.
    1710              : //
    1711              : // If the Iterator is configured to iterate over range keys, NextWithLimit
    1712              : // guarantees it will surface any range keys with bounds overlapping the
    1713              : // keyspace up to limit.
    1714            1 : func (i *Iterator) NextWithLimit(limit []byte) IterValidityState {
    1715            1 :         return i.nextWithLimit(limit)
    1716            1 : }
    1717              : 
    1718              : // NextPrefix moves the iterator to the next key/value pair with a key
    1719              : // containing a different prefix than the current key. Prefixes are determined
    1720              : // by Comparer.Split. Exhausts the iterator if invoked while in prefix-iteration
    1721              : // mode.
    1722              : //
    1723              : // It is not permitted to invoke NextPrefix while at a IterAtLimit position.
    1724              : // When called in this condition, NextPrefix has non-deterministic behavior.
    1725              : //
    1726              : // It is not permitted to invoke NextPrefix when the Iterator has an
    1727              : // upper-bound that is a versioned MVCC key (see the comment for
    1728              : // Comparer.Split). It returns an error in this case.
    1729            1 : func (i *Iterator) NextPrefix() bool {
    1730            1 :         if i.nextPrefixNotPermittedByUpperBound {
    1731            1 :                 i.lastPositioningOp = unknownLastPositionOp
    1732            1 :                 i.requiresReposition = false
    1733            1 :                 i.err = errors.Errorf("NextPrefix not permitted with upper bound %s",
    1734            1 :                         i.comparer.FormatKey(i.opts.UpperBound))
    1735            1 :                 i.iterValidityState = IterExhausted
    1736            1 :                 return false
    1737            1 :         }
    1738            1 :         if i.hasPrefix {
    1739            1 :                 i.iterValidityState = IterExhausted
    1740            1 :                 return false
    1741            1 :         }
    1742            1 :         if i.Error() != nil {
    1743            0 :                 return false
    1744            0 :         }
    1745            1 :         return i.nextPrefix() == IterValid
    1746              : }
    1747              : 
    1748            1 : func (i *Iterator) nextPrefix() IterValidityState {
    1749            1 :         if i.rangeKey != nil {
    1750            1 :                 // NB: Check Valid() before clearing requiresReposition.
    1751            1 :                 i.rangeKey.prevPosHadRangeKey = i.rangeKey.hasRangeKey && i.Valid()
    1752            1 :                 // If we have a range key but did not expose it at the previous iterator
    1753            1 :                 // position (because the iterator was not at a valid position), updated
    1754            1 :                 // must be true. This ensures that after an iterator op sequence like:
    1755            1 :                 //   - Next()             → (IterValid, RangeBounds() = [a,b))
    1756            1 :                 //   - NextWithLimit(...) → (IterAtLimit, RangeBounds() = -)
    1757            1 :                 //   - NextWithLimit(...) → (IterValid, RangeBounds() = [a,b))
    1758            1 :                 // the iterator returns RangeKeyChanged()=true.
    1759            1 :                 //
    1760            1 :                 // The remainder of this function will only update i.rangeKey.updated if
    1761            1 :                 // the iterator moves into a new range key, or out of the current range
    1762            1 :                 // key.
    1763            1 :                 i.rangeKey.updated = i.rangeKey.hasRangeKey && !i.Valid() && i.opts.rangeKeys()
    1764            1 :         }
    1765              : 
    1766              :         // Although NextPrefix documents that behavior at IterAtLimit is undefined,
    1767              :         // this function handles these cases as a simple prefix-agnostic Next. This
    1768              :         // is done for deterministic behavior in the metamorphic tests.
    1769              :         //
    1770              :         // TODO(jackson): If the metamorphic test operation generator is adjusted to
    1771              :         // make generation of some operations conditional on the previous
    1772              :         // operations, then we can remove this behavior and explicitly error.
    1773              : 
    1774            1 :         i.lastPositioningOp = unknownLastPositionOp
    1775            1 :         i.requiresReposition = false
    1776            1 :         switch i.pos {
    1777            1 :         case iterPosCurForward:
    1778            1 :                 // Positioned on the current key. Advance to the next prefix.
    1779            1 :                 i.internalNextPrefix(i.comparer.Split(i.key))
    1780            0 :         case iterPosCurForwardPaused:
    1781              :                 // Positioned at a limit. Implement as a prefix-agnostic Next. See TODO
    1782              :                 // up above. The iterator is already positioned at the next key.
    1783            1 :         case iterPosCurReverse:
    1784            1 :                 // Switching directions.
    1785            1 :                 // Unless the iterator was exhausted, reverse iteration needs to
    1786            1 :                 // position the iterator at iterPosPrev.
    1787            1 :                 if i.iterKV != nil {
    1788            0 :                         i.err = errors.New("switching from reverse to forward but iter is not at prev")
    1789            0 :                         i.iterValidityState = IterExhausted
    1790            0 :                         return i.iterValidityState
    1791            0 :                 }
    1792              :                 // The Iterator is exhausted and i.iter is positioned before the first
    1793              :                 // key. Reposition to point to the first internal key.
    1794            1 :                 if i.err = i.iterFirstWithinBounds(); i.err != nil {
    1795            0 :                         i.iterValidityState = IterExhausted
    1796            0 :                         return i.iterValidityState
    1797            0 :                 }
    1798            1 :         case iterPosCurReversePaused:
    1799            1 :                 // Positioned at a limit. Implement as a prefix-agnostic Next. See TODO
    1800            1 :                 // up above.
    1801            1 :                 //
    1802            1 :                 // Switching directions; The iterator must not be exhausted since it
    1803            1 :                 // paused.
    1804            1 :                 if i.iterKV == nil {
    1805            0 :                         i.err = errors.New("switching paused from reverse to forward but iter is exhausted")
    1806            0 :                         i.iterValidityState = IterExhausted
    1807            0 :                         return i.iterValidityState
    1808            0 :                 }
    1809            1 :                 i.nextUserKey()
    1810            1 :         case iterPosPrev:
    1811            1 :                 // The underlying iterator is pointed to the previous key (this can
    1812            1 :                 // only happen when switching iteration directions).
    1813            1 :                 if i.iterKV == nil {
    1814            1 :                         // We're positioned before the first key. Need to reposition to point to
    1815            1 :                         // the first key.
    1816            1 :                         i.err = i.iterFirstWithinBounds()
    1817            1 :                         if i.iterKV == nil {
    1818            0 :                                 i.iterValidityState = IterExhausted
    1819            0 :                                 return i.iterValidityState
    1820            0 :                         }
    1821            1 :                         if invariants.Enabled && !i.equal(i.iterKV.K.UserKey, i.key) {
    1822            0 :                                 i.opts.getLogger().Fatalf("pebble: invariant violation: First internal iterator from iterPosPrev landed on %q, not %q",
    1823            0 :                                         i.iterKV.K.UserKey, i.key)
    1824            0 :                         }
    1825            1 :                 } else {
    1826            1 :                         // Move the internal iterator back onto the user key stored in
    1827            1 :                         // i.key. iterPosPrev guarantees that it's positioned at the last
    1828            1 :                         // key with the user key less than i.key, so we're guaranteed to
    1829            1 :                         // land on the correct key with a single Next.
    1830            1 :                         i.iterKV = i.iter.Next()
    1831            1 :                         if i.iterKV == nil {
    1832            1 :                                 // This should only be possible if i.iter.Next() encountered an
    1833            1 :                                 // error.
    1834            1 :                                 if i.iter.Error() == nil {
    1835            0 :                                         i.opts.getLogger().Fatalf("pebble: invariant violation: Nexting internal iterator from iterPosPrev found nothing")
    1836            0 :                                 }
    1837              :                                 // NB: Iterator.Error() will return i.iter.Error().
    1838            1 :                                 i.iterValidityState = IterExhausted
    1839            1 :                                 return i.iterValidityState
    1840              :                         }
    1841            1 :                         if invariants.Enabled && !i.equal(i.iterKV.K.UserKey, i.key) {
    1842            0 :                                 i.opts.getLogger().Fatalf("pebble: invariant violation: Nexting internal iterator from iterPosPrev landed on %q, not %q",
    1843            0 :                                         i.iterKV.K.UserKey, i.key)
    1844            0 :                         }
    1845              :                 }
    1846              :                 // The internal iterator is now positioned at i.key. Advance to the next
    1847              :                 // prefix.
    1848            1 :                 i.internalNextPrefix(i.comparer.Split(i.key))
    1849            1 :         case iterPosNext:
    1850            1 :                 // Already positioned on the next key. Only call nextPrefixKey if the
    1851            1 :                 // next key shares the same prefix.
    1852            1 :                 if i.iterKV != nil {
    1853            1 :                         currKeyPrefixLen := i.comparer.Split(i.key)
    1854            1 :                         if bytes.Equal(i.comparer.Split.Prefix(i.iterKV.K.UserKey), i.key[:currKeyPrefixLen]) {
    1855            1 :                                 i.internalNextPrefix(currKeyPrefixLen)
    1856            1 :                         }
    1857              :                 }
    1858              :         }
    1859              : 
    1860            1 :         i.stats.ForwardStepCount[InterfaceCall]++
    1861            1 :         i.findNextEntry(nil /* limit */)
    1862            1 :         i.maybeSampleRead()
    1863            1 :         return i.iterValidityState
    1864              : }
    1865              : 
    1866            1 : func (i *Iterator) internalNextPrefix(currKeyPrefixLen int) {
    1867            1 :         if i.iterKV == nil {
    1868            1 :                 return
    1869            1 :         }
    1870              :         // The Next "fast-path" is not really a fast-path when there is more than
    1871              :         // one version. However, even with TableFormatPebblev3, there is a small
    1872              :         // slowdown (~10%) for one version if we remove it and only call NextPrefix.
    1873              :         // When there are two versions, only calling NextPrefix is ~30% faster.
    1874            1 :         i.stats.ForwardStepCount[InternalIterCall]++
    1875            1 :         if i.iterKV = i.iter.Next(); i.iterKV == nil {
    1876            1 :                 return
    1877            1 :         }
    1878            1 :         if !bytes.Equal(i.comparer.Split.Prefix(i.iterKV.K.UserKey), i.key[:currKeyPrefixLen]) {
    1879            1 :                 return
    1880            1 :         }
    1881            1 :         i.stats.ForwardStepCount[InternalIterCall]++
    1882            1 :         i.prefixOrFullSeekKey = i.comparer.ImmediateSuccessor(i.prefixOrFullSeekKey[:0], i.key[:currKeyPrefixLen])
    1883            1 :         if i.iterKV.K.IsExclusiveSentinel() {
    1884            0 :                 panic(errors.AssertionFailedf("pebble: unexpected exclusive sentinel key: %q", i.iterKV.K))
    1885              :         }
    1886              : 
    1887            1 :         i.iterKV = i.iter.NextPrefix(i.prefixOrFullSeekKey)
    1888            1 :         if invariants.Enabled && i.iterKV != nil {
    1889            1 :                 if p := i.comparer.Split.Prefix(i.iterKV.K.UserKey); i.cmp(p, i.prefixOrFullSeekKey) < 0 {
    1890            0 :                         panic(errors.AssertionFailedf("pebble: iter.NextPrefix did not advance beyond the current prefix: now at %q; expected to be geq %q",
    1891            0 :                                 i.iterKV.K, i.prefixOrFullSeekKey))
    1892              :                 }
    1893              :         }
    1894              : }
    1895              : 
    1896            1 : func (i *Iterator) nextWithLimit(limit []byte) IterValidityState {
    1897            1 :         i.stats.ForwardStepCount[InterfaceCall]++
    1898            1 :         if i.hasPrefix {
    1899            1 :                 if limit != nil {
    1900            1 :                         i.err = errors.New("cannot use limit with prefix iteration")
    1901            1 :                         i.iterValidityState = IterExhausted
    1902            1 :                         return i.iterValidityState
    1903            1 :                 } else if i.iterValidityState == IterExhausted {
    1904            1 :                         // No-op, already exhausted. We avoid executing the Next because it
    1905            1 :                         // can break invariants: Specifically, a file that fails the bloom
    1906            1 :                         // filter test may result in its level being removed from the
    1907            1 :                         // merging iterator. The level's removal can cause a lazy combined
    1908            1 :                         // iterator to miss range keys and trigger a switch to combined
    1909            1 :                         // iteration at a larger key, breaking keyspan invariants.
    1910            1 :                         return i.iterValidityState
    1911            1 :                 }
    1912              :         }
    1913            1 :         if i.err != nil {
    1914            1 :                 return i.iterValidityState
    1915            1 :         }
    1916            1 :         if i.rangeKey != nil {
    1917            1 :                 // NB: Check Valid() before clearing requiresReposition.
    1918            1 :                 i.rangeKey.prevPosHadRangeKey = i.rangeKey.hasRangeKey && i.Valid()
    1919            1 :                 // If we have a range key but did not expose it at the previous iterator
    1920            1 :                 // position (because the iterator was not at a valid position), updated
    1921            1 :                 // must be true. This ensures that after an iterator op sequence like:
    1922            1 :                 //   - Next()             → (IterValid, RangeBounds() = [a,b))
    1923            1 :                 //   - NextWithLimit(...) → (IterAtLimit, RangeBounds() = -)
    1924            1 :                 //   - NextWithLimit(...) → (IterValid, RangeBounds() = [a,b))
    1925            1 :                 // the iterator returns RangeKeyChanged()=true.
    1926            1 :                 //
    1927            1 :                 // The remainder of this function will only update i.rangeKey.updated if
    1928            1 :                 // the iterator moves into a new range key, or out of the current range
    1929            1 :                 // key.
    1930            1 :                 i.rangeKey.updated = i.rangeKey.hasRangeKey && !i.Valid() && i.opts.rangeKeys()
    1931            1 :         }
    1932            1 :         i.lastPositioningOp = unknownLastPositionOp
    1933            1 :         i.requiresReposition = false
    1934            1 :         switch i.pos {
    1935            1 :         case iterPosCurForward:
    1936            1 :                 i.nextUserKey()
    1937            1 :         case iterPosCurForwardPaused:
    1938              :                 // Already at the right place.
    1939            1 :         case iterPosCurReverse:
    1940            1 :                 // Switching directions.
    1941            1 :                 // Unless the iterator was exhausted, reverse iteration needs to
    1942            1 :                 // position the iterator at iterPosPrev.
    1943            1 :                 if i.iterKV != nil {
    1944            0 :                         i.err = errors.New("switching from reverse to forward but iter is not at prev")
    1945            0 :                         i.iterValidityState = IterExhausted
    1946            0 :                         return i.iterValidityState
    1947            0 :                 }
    1948              :                 // We're positioned before the first key. Need to reposition to point to
    1949              :                 // the first key.
    1950            1 :                 if i.err = i.iterFirstWithinBounds(); i.err != nil {
    1951            0 :                         i.iterValidityState = IterExhausted
    1952            0 :                         return i.iterValidityState
    1953            0 :                 }
    1954            1 :         case iterPosCurReversePaused:
    1955            1 :                 // Switching directions.
    1956            1 :                 // The iterator must not be exhausted since it paused.
    1957            1 :                 if i.iterKV == nil {
    1958            0 :                         i.err = errors.New("switching paused from reverse to forward but iter is exhausted")
    1959            0 :                         i.iterValidityState = IterExhausted
    1960            0 :                         return i.iterValidityState
    1961            0 :                 }
    1962            1 :                 i.nextUserKey()
    1963            1 :         case iterPosPrev:
    1964            1 :                 // The underlying iterator is pointed to the previous key (this can
    1965            1 :                 // only happen when switching iteration directions). We set
    1966            1 :                 // i.iterValidityState to IterExhausted here to force the calls to
    1967            1 :                 // nextUserKey to save the current key i.iter is pointing at in order
    1968            1 :                 // to determine when the next user-key is reached.
    1969            1 :                 i.iterValidityState = IterExhausted
    1970            1 :                 if i.iterKV == nil {
    1971            1 :                         // We're positioned before the first key. Need to reposition to point to
    1972            1 :                         // the first key.
    1973            1 :                         i.err = i.iterFirstWithinBounds()
    1974            1 :                 } else {
    1975            1 :                         i.nextUserKey()
    1976            1 :                 }
    1977            1 :                 if i.err != nil {
    1978            1 :                         i.iterValidityState = IterExhausted
    1979            1 :                         return i.iterValidityState
    1980            1 :                 }
    1981            1 :                 i.nextUserKey()
    1982            1 :         case iterPosNext:
    1983              :                 // Already at the right place.
    1984              :         }
    1985            1 :         i.findNextEntry(limit)
    1986            1 :         i.maybeSampleRead()
    1987            1 :         return i.iterValidityState
    1988              : }
    1989              : 
    1990              : // Prev moves the iterator to the previous key/value pair. Returns true if the
    1991              : // iterator is pointing at a valid entry and false otherwise.
    1992            1 : func (i *Iterator) Prev() bool {
    1993            1 :         return i.PrevWithLimit(nil) == IterValid
    1994            1 : }
    1995              : 
    1996              : // PrevWithLimit moves the iterator to the previous key/value pair.
    1997              : //
    1998              : // If limit is provided, it serves as a best-effort inclusive limit. If the
    1999              : // previous key is less than limit, the Iterator may pause and return
    2000              : // IterAtLimit. Because limits are best-effort, PrevWithLimit may return a key
    2001              : // beyond limit.
    2002              : //
    2003              : // If the Iterator is configured to iterate over range keys, PrevWithLimit
    2004              : // guarantees it will surface any range keys with bounds overlapping the
    2005              : // keyspace up to limit.
    2006            1 : func (i *Iterator) PrevWithLimit(limit []byte) IterValidityState {
    2007            1 :         i.stats.ReverseStepCount[InterfaceCall]++
    2008            1 :         if i.err != nil {
    2009            1 :                 return i.iterValidityState
    2010            1 :         }
    2011            1 :         if i.rangeKey != nil {
    2012            1 :                 // NB: Check Valid() before clearing requiresReposition.
    2013            1 :                 i.rangeKey.prevPosHadRangeKey = i.rangeKey.hasRangeKey && i.Valid()
    2014            1 :                 // If we have a range key but did not expose it at the previous iterator
    2015            1 :                 // position (because the iterator was not at a valid position), updated
    2016            1 :                 // must be true. This ensures that after an iterator op sequence like:
    2017            1 :                 //   - Next()             → (IterValid, RangeBounds() = [a,b))
    2018            1 :                 //   - NextWithLimit(...) → (IterAtLimit, RangeBounds() = -)
    2019            1 :                 //   - PrevWithLimit(...) → (IterValid, RangeBounds() = [a,b))
    2020            1 :                 // the iterator returns RangeKeyChanged()=true.
    2021            1 :                 //
    2022            1 :                 // The remainder of this function will only update i.rangeKey.updated if
    2023            1 :                 // the iterator moves into a new range key, or out of the current range
    2024            1 :                 // key.
    2025            1 :                 i.rangeKey.updated = i.rangeKey.hasRangeKey && !i.Valid() && i.opts.rangeKeys()
    2026            1 :         }
    2027            1 :         i.lastPositioningOp = unknownLastPositionOp
    2028            1 :         i.requiresReposition = false
    2029            1 :         if i.hasPrefix {
    2030            1 :                 i.err = errReversePrefixIteration
    2031            1 :                 i.iterValidityState = IterExhausted
    2032            1 :                 return i.iterValidityState
    2033            1 :         }
    2034            1 :         switch i.pos {
    2035            1 :         case iterPosCurForward:
    2036              :                 // Switching directions, and will handle this below.
    2037            1 :         case iterPosCurForwardPaused:
    2038              :                 // Switching directions, and will handle this below.
    2039            1 :         case iterPosCurReverse:
    2040            1 :                 i.prevUserKey()
    2041            1 :         case iterPosCurReversePaused:
    2042              :                 // Already at the right place.
    2043            1 :         case iterPosNext:
    2044              :                 // The underlying iterator is pointed to the next key (this can only happen
    2045              :                 // when switching iteration directions). We will handle this below.
    2046            1 :         case iterPosPrev:
    2047              :                 // Already at the right place.
    2048              :         }
    2049            1 :         if i.pos == iterPosCurForward || i.pos == iterPosNext || i.pos == iterPosCurForwardPaused {
    2050            1 :                 // Switching direction.
    2051            1 :                 stepAgain := i.pos == iterPosNext
    2052            1 : 
    2053            1 :                 // Synthetic range key markers are a special case. Consider SeekGE(b)
    2054            1 :                 // which finds a range key [a, c). To ensure the user observes the range
    2055            1 :                 // key, the Iterator pauses at Key() = b. The iterator must advance the
    2056            1 :                 // internal iterator to see if there's also a coincident point key at
    2057            1 :                 // 'b', leaving the iterator at iterPosNext if there's not.
    2058            1 :                 //
    2059            1 :                 // This is a problem: Synthetic range key markers are only interleaved
    2060            1 :                 // during the original seek. A subsequent Prev() of i.iter will not move
    2061            1 :                 // back onto the synthetic range key marker. In this case where the
    2062            1 :                 // previous iterator position was a synthetic range key start boundary,
    2063            1 :                 // we must not step a second time.
    2064            1 :                 if i.isEphemeralPosition() {
    2065            1 :                         stepAgain = false
    2066            1 :                 }
    2067              : 
    2068              :                 // We set i.iterValidityState to IterExhausted here to force the calls
    2069              :                 // to prevUserKey to save the current key i.iter is pointing at in
    2070              :                 // order to determine when the prev user-key is reached.
    2071            1 :                 i.iterValidityState = IterExhausted
    2072            1 :                 if i.iterKV == nil {
    2073            1 :                         // We're positioned after the last key. Need to reposition to point to
    2074            1 :                         // the last key.
    2075            1 :                         i.err = i.iterLastWithinBounds()
    2076            1 :                 } else {
    2077            1 :                         i.prevUserKey()
    2078            1 :                 }
    2079            1 :                 if i.err != nil {
    2080            0 :                         return i.iterValidityState
    2081            0 :                 }
    2082            1 :                 if stepAgain {
    2083            1 :                         i.prevUserKey()
    2084            1 :                         if i.err != nil {
    2085            0 :                                 return i.iterValidityState
    2086            0 :                         }
    2087              :                 }
    2088              :         }
    2089            1 :         i.findPrevEntry(limit)
    2090            1 :         i.maybeSampleRead()
    2091            1 :         return i.iterValidityState
    2092              : }
    2093              : 
    2094              : // iterFirstWithinBounds moves the internal iterator to the first key,
    2095              : // respecting bounds.
    2096            1 : func (i *Iterator) iterFirstWithinBounds() error {
    2097            1 :         i.stats.ForwardSeekCount[InternalIterCall]++
    2098            1 :         if lowerBound := i.opts.GetLowerBound(); lowerBound != nil {
    2099            1 :                 i.iterKV = i.iter.SeekGE(lowerBound, base.SeekGEFlagsNone)
    2100            1 :         } else {
    2101            1 :                 i.iterKV = i.iter.First()
    2102            1 :         }
    2103            1 :         if i.iterKV == nil {
    2104            1 :                 return i.iter.Error()
    2105            1 :         }
    2106            1 :         return nil
    2107              : }
    2108              : 
    2109              : // iterLastWithinBounds moves the internal iterator to the last key, respecting
    2110              : // bounds.
    2111            1 : func (i *Iterator) iterLastWithinBounds() error {
    2112            1 :         i.stats.ReverseSeekCount[InternalIterCall]++
    2113            1 :         if upperBound := i.opts.GetUpperBound(); upperBound != nil {
    2114            1 :                 i.iterKV = i.iter.SeekLT(upperBound, base.SeekLTFlagsNone)
    2115            1 :         } else {
    2116            1 :                 i.iterKV = i.iter.Last()
    2117            1 :         }
    2118            1 :         if i.iterKV == nil {
    2119            1 :                 return i.iter.Error()
    2120            1 :         }
    2121            1 :         return nil
    2122              : }
    2123              : 
    2124              : // RangeKeyData describes a range key's data, set through RangeKeySet. The key
    2125              : // boundaries of the range key is provided by Iterator.RangeBounds.
    2126              : type RangeKeyData struct {
    2127              :         Suffix []byte
    2128              :         Value  []byte
    2129              : }
    2130              : 
    2131              : // rangeKeyWithinLimit is called during limited reverse iteration when
    2132              : // positioned over a key beyond the limit. If there exists a range key that lies
    2133              : // within the limit, the iterator must not pause in order to ensure the user has
    2134              : // an opportunity to observe the range key within limit.
    2135              : //
    2136              : // It would be valid to ignore the limit whenever there's a range key covering
    2137              : // the key, but that would introduce nondeterminism. To preserve determinism for
    2138              : // testing, the iterator ignores the limit only if the covering range key does
    2139              : // cover the keyspace within the limit.
    2140              : //
    2141              : // This awkwardness exists because range keys are interleaved at their inclusive
    2142              : // start positions. Note that limit is inclusive.
    2143            1 : func (i *Iterator) rangeKeyWithinLimit(limit []byte) bool {
    2144            1 :         if i.rangeKey == nil || !i.opts.rangeKeys() {
    2145            1 :                 return false
    2146            1 :         }
    2147            1 :         s := i.rangeKey.iiter.Span()
    2148            1 :         // If the range key ends beyond the limit, then the range key does not cover
    2149            1 :         // any portion of the keyspace within the limit and it is safe to pause.
    2150            1 :         return s != nil && i.cmp(s.End, limit) > 0
    2151              : }
    2152              : 
    2153              : // saveRangeKey saves the current range key to the underlying iterator's current
    2154              : // range key state. If the range key has not changed, saveRangeKey is a no-op.
    2155              : // If there is a new range key, saveRangeKey copies all of the key, value and
    2156              : // suffixes into Iterator-managed buffers.
    2157            1 : func (i *Iterator) saveRangeKey() {
    2158            1 :         if i.rangeKey == nil || i.opts.KeyTypes == IterKeyTypePointsOnly {
    2159            1 :                 return
    2160            1 :         }
    2161              : 
    2162            1 :         s := i.rangeKey.iiter.Span()
    2163            1 :         if s == nil {
    2164            1 :                 i.rangeKey.hasRangeKey = false
    2165            1 :                 i.rangeKey.updated = i.rangeKey.prevPosHadRangeKey
    2166            1 :                 return
    2167            1 :         } else if !i.rangeKey.stale {
    2168            1 :                 // The range key `s` is identical to the one currently saved. No-op.
    2169            1 :                 return
    2170            1 :         }
    2171              : 
    2172            1 :         if s.KeysOrder != keyspan.BySuffixAsc {
    2173            0 :                 panic("pebble: range key span's keys unexpectedly not in ascending suffix order")
    2174              :         }
    2175              : 
    2176              :         // Although `i.rangeKey.stale` is true, the span s may still be identical
    2177              :         // to the currently saved span. This is possible when seeking the iterator,
    2178              :         // which may land back on the same range key. If we previously had a range
    2179              :         // key and the new one has an identical start key, then it must be the same
    2180              :         // range key and we can avoid copying and keep `i.rangeKey.updated=false`.
    2181              :         //
    2182              :         // TODO(jackson): These key comparisons could be avoidable during relative
    2183              :         // positioning operations continuing in the same direction, because these
    2184              :         // ops will never encounter the previous position's range key while
    2185              :         // stale=true. However, threading whether the current op is a seek or step
    2186              :         // maybe isn't worth it. This key comparison is only necessary once when we
    2187              :         // step onto a new range key, which should be relatively rare.
    2188            1 :         if i.rangeKey.prevPosHadRangeKey && i.equal(i.rangeKey.start, s.Start) &&
    2189            1 :                 i.equal(i.rangeKey.end, s.End) {
    2190            1 :                 i.rangeKey.updated = false
    2191            1 :                 i.rangeKey.stale = false
    2192            1 :                 i.rangeKey.hasRangeKey = true
    2193            1 :                 return
    2194            1 :         }
    2195            1 :         i.stats.RangeKeyStats.Count += len(s.Keys)
    2196            1 :         i.rangeKey.buf.Reset()
    2197            1 :         i.rangeKey.hasRangeKey = true
    2198            1 :         i.rangeKey.updated = true
    2199            1 :         i.rangeKey.stale = false
    2200            1 :         i.rangeKey.buf, i.rangeKey.start = i.rangeKey.buf.Copy(s.Start)
    2201            1 :         i.rangeKey.buf, i.rangeKey.end = i.rangeKey.buf.Copy(s.End)
    2202            1 :         i.rangeKey.keys = i.rangeKey.keys[:0]
    2203            1 :         for j := 0; j < len(s.Keys); j++ {
    2204            1 :                 if invariants.Enabled {
    2205            1 :                         if s.Keys[j].Kind() != base.InternalKeyKindRangeKeySet {
    2206            0 :                                 panic("pebble: user iteration encountered non-RangeKeySet key kind")
    2207            1 :                         } else if j > 0 && i.comparer.CompareRangeSuffixes(s.Keys[j].Suffix, s.Keys[j-1].Suffix) < 0 {
    2208            0 :                                 panic("pebble: user iteration encountered range keys not in suffix order")
    2209              :                         }
    2210              :                 }
    2211            1 :                 var rkd RangeKeyData
    2212            1 :                 i.rangeKey.buf, rkd.Suffix = i.rangeKey.buf.Copy(s.Keys[j].Suffix)
    2213            1 :                 i.rangeKey.buf, rkd.Value = i.rangeKey.buf.Copy(s.Keys[j].Value)
    2214            1 :                 i.rangeKey.keys = append(i.rangeKey.keys, rkd)
    2215              :         }
    2216              : }
    2217              : 
    2218              : // RangeKeyChanged indicates whether the most recent iterator positioning
    2219              : // operation resulted in the iterator stepping into or out of a new range key.
    2220              : // If true, previously returned range key bounds and data has been invalidated.
    2221              : // If false, previously obtained range key bounds, suffix and value slices are
    2222              : // still valid and may continue to be read.
    2223              : //
    2224              : // Invalid iterator positions are considered to not hold range keys, meaning
    2225              : // that if an iterator steps from an IterExhausted or IterAtLimit position onto
    2226              : // a position with a range key, RangeKeyChanged will yield true.
    2227            1 : func (i *Iterator) RangeKeyChanged() bool {
    2228            1 :         return i.iterValidityState == IterValid && i.rangeKey != nil && i.rangeKey.updated
    2229            1 : }
    2230              : 
    2231              : // HasPointAndRange indicates whether there exists a point key, a range key or
    2232              : // both at the current iterator position.
    2233            1 : func (i *Iterator) HasPointAndRange() (hasPoint, hasRange bool) {
    2234            1 :         if i.iterValidityState != IterValid || i.requiresReposition {
    2235            1 :                 return false, false
    2236            1 :         }
    2237            1 :         if i.opts.KeyTypes == IterKeyTypePointsOnly {
    2238            1 :                 return true, false
    2239            1 :         }
    2240            1 :         return i.rangeKey == nil || !i.rangeKey.rangeKeyOnly, i.rangeKey != nil && i.rangeKey.hasRangeKey
    2241              : }
    2242              : 
    2243              : // RangeBounds returns the start (inclusive) and end (exclusive) bounds of the
    2244              : // range key covering the current iterator position. RangeBounds returns nil
    2245              : // bounds if there is no range key covering the current iterator position, or
    2246              : // the iterator is not configured to surface range keys.
    2247              : //
    2248              : // If valid, the returned start bound is less than or equal to Key() and the
    2249              : // returned end bound is greater than Key().
    2250            1 : func (i *Iterator) RangeBounds() (start, end []byte) {
    2251            1 :         if i.rangeKey == nil || !i.opts.rangeKeys() || !i.rangeKey.hasRangeKey {
    2252            0 :                 return nil, nil
    2253            0 :         }
    2254            1 :         return i.rangeKey.start, i.rangeKey.end
    2255              : }
    2256              : 
    2257              : // Key returns the key of the current key/value pair, or nil if done. The
    2258              : // caller should not modify the contents of the returned slice, and its
    2259              : // contents may change on the next call to Next.
    2260              : //
    2261              : // If positioned at an iterator position that only holds a range key, Key()
    2262              : // always returns the start bound of the range key. Otherwise, it returns the
    2263              : // point key's key.
    2264            1 : func (i *Iterator) Key() []byte {
    2265            1 :         return i.key
    2266            1 : }
    2267              : 
    2268              : // Value returns the value of the current key/value pair, or nil if done. The
    2269              : // caller should not modify the contents of the returned slice, and its
    2270              : // contents may change on the next call to Next.
    2271              : //
    2272              : // Only valid if HasPointAndRange() returns true for hasPoint.
    2273              : // Deprecated: use ValueAndErr instead.
    2274            1 : func (i *Iterator) Value() []byte {
    2275            1 :         val, _ := i.ValueAndErr()
    2276            1 :         return val
    2277            1 : }
    2278              : 
    2279              : // ValueAndErr returns the value, and any error encountered in extracting the value.
    2280              : // REQUIRES: i.Error()==nil and HasPointAndRange() returns true for hasPoint.
    2281              : //
    2282              : // The caller should not modify the contents of the returned slice, and its
    2283              : // contents may change on the next call to Next.
    2284            1 : func (i *Iterator) ValueAndErr() ([]byte, error) {
    2285            1 :         val, callerOwned, err := i.value.Value(i.lazyValueBuf)
    2286            1 :         if err != nil {
    2287            0 :                 i.err = err
    2288            0 :                 i.iterValidityState = IterExhausted
    2289            0 :         }
    2290            1 :         if callerOwned {
    2291            1 :                 i.lazyValueBuf = val[:0]
    2292            1 :         }
    2293            1 :         return val, err
    2294              : }
    2295              : 
    2296              : // LazyValue returns the LazyValue. Only for advanced use cases.
    2297              : // REQUIRES: i.Error()==nil and HasPointAndRange() returns true for hasPoint.
    2298            0 : func (i *Iterator) LazyValue() LazyValue {
    2299            0 :         return i.value.LazyValue()
    2300            0 : }
    2301              : 
    2302              : // RangeKeys returns the range key values and their suffixes covering the
    2303              : // current iterator position. The range bounds may be retrieved separately
    2304              : // through Iterator.RangeBounds().
    2305            1 : func (i *Iterator) RangeKeys() []RangeKeyData {
    2306            1 :         if i.rangeKey == nil || !i.opts.rangeKeys() || !i.rangeKey.hasRangeKey {
    2307            0 :                 return nil
    2308            0 :         }
    2309            1 :         return i.rangeKey.keys
    2310              : }
    2311              : 
    2312              : // Valid returns true if the iterator is positioned at a valid key/value pair
    2313              : // and false otherwise.
    2314            1 : func (i *Iterator) Valid() bool {
    2315            1 :         valid := i.iterValidityState == IterValid && !i.requiresReposition
    2316            1 :         if invariants.Enabled {
    2317            1 :                 if err := i.Error(); valid && err != nil {
    2318            0 :                         panic(errors.AssertionFailedf("pebble: iterator is valid with non-nil Error: %+v", err))
    2319              :                 }
    2320              :         }
    2321            1 :         return valid
    2322              : }
    2323              : 
    2324              : // Error returns any accumulated error.
    2325            1 : func (i *Iterator) Error() error {
    2326            1 :         if i.err != nil {
    2327            1 :                 return i.err
    2328            1 :         }
    2329            1 :         if i.iter != nil {
    2330            1 :                 return i.iter.Error()
    2331            1 :         }
    2332            0 :         return nil
    2333              : }
    2334              : 
    2335              : const maxKeyBufCacheSize = 4 << 10 // 4 KB
    2336              : 
    2337              : // Close closes the iterator and returns any accumulated error. Exhausting
    2338              : // all the key/value pairs in a table is not considered to be an error.
    2339              : // It is not valid to call any method, including Close, after the iterator
    2340              : // has been closed.
    2341            1 : func (i *Iterator) Close() error {
    2342            1 :         // Close the child iterator before releasing the readState because when the
    2343            1 :         // readState is released sstables referenced by the readState may be deleted
    2344            1 :         // which will fail on Windows if the sstables are still open by the child
    2345            1 :         // iterator.
    2346            1 :         if i.iter != nil {
    2347            1 :                 i.err = firstError(i.err, i.iter.Close())
    2348            1 : 
    2349            1 :                 // Closing i.iter did not necessarily close the point and range key
    2350            1 :                 // iterators. Calls to SetOptions may have 'disconnected' either one
    2351            1 :                 // from i.iter if iteration key types were changed. Both point and range
    2352            1 :                 // key iterators are preserved in case the iterator needs to switch key
    2353            1 :                 // types again. We explicitly close both of these iterators here.
    2354            1 :                 //
    2355            1 :                 // NB: If the iterators were still connected to i.iter, they may be
    2356            1 :                 // closed, but calling Close on a closed internal iterator or fragment
    2357            1 :                 // iterator is allowed.
    2358            1 :                 if i.pointIter != nil {
    2359            1 :                         i.err = firstError(i.err, i.pointIter.Close())
    2360            1 :                 }
    2361            1 :                 if i.rangeKey != nil && i.rangeKey.rangeKeyIter != nil {
    2362            1 :                         i.rangeKey.rangeKeyIter.Close()
    2363            1 :                 }
    2364            1 :                 i.err = firstError(i.err, i.blobValueFetcher.Close())
    2365              :         }
    2366            1 :         err := i.err
    2367            1 : 
    2368            1 :         if i.readState != nil {
    2369            1 :                 if i.readSampling.pendingCompactions.size > 0 {
    2370            1 :                         // Copy pending read compactions using db.mu.Lock()
    2371            1 :                         i.readState.db.mu.Lock()
    2372            1 :                         i.readState.db.mu.compact.readCompactions.combine(&i.readSampling.pendingCompactions, i.cmp)
    2373            1 :                         reschedule := i.readState.db.mu.compact.rescheduleReadCompaction
    2374            1 :                         i.readState.db.mu.compact.rescheduleReadCompaction = false
    2375            1 :                         concurrentCompactions := i.readState.db.mu.compact.compactingCount
    2376            1 :                         i.readState.db.mu.Unlock()
    2377            1 : 
    2378            1 :                         if reschedule && concurrentCompactions == 0 {
    2379            0 :                                 // In a read heavy workload, flushes may not happen frequently enough to
    2380            0 :                                 // schedule compactions.
    2381            0 :                                 i.readState.db.compactionSchedulers.Add(1)
    2382            0 :                                 go i.readState.db.maybeScheduleCompactionAsync()
    2383            0 :                         }
    2384              :                 }
    2385              : 
    2386            1 :                 i.readState.unref()
    2387            1 :                 i.readState = nil
    2388              :         }
    2389              : 
    2390            1 :         if i.version != nil {
    2391            1 :                 i.version.Unref()
    2392            1 :         }
    2393            1 :         if i.externalIter != nil {
    2394            1 :                 err = firstError(err, i.externalIter.Close())
    2395            1 :         }
    2396              : 
    2397              :         // Close the closer for the current value if one was open.
    2398            1 :         if i.valueCloser != nil {
    2399            1 :                 err = firstError(err, i.valueCloser.Close())
    2400            1 :                 i.valueCloser = nil
    2401            1 :         }
    2402              : 
    2403            1 :         if i.rangeKey != nil {
    2404            1 :                 i.rangeKey.rangeKeyBuffers.PrepareForReuse()
    2405            1 :                 *i.rangeKey = iteratorRangeKeyState{
    2406            1 :                         rangeKeyBuffers: i.rangeKey.rangeKeyBuffers,
    2407            1 :                 }
    2408            1 :                 iterRangeKeyStateAllocPool.Put(i.rangeKey)
    2409            1 :                 i.rangeKey = nil
    2410            1 :         }
    2411            1 :         if alloc := i.alloc; alloc != nil {
    2412            1 :                 var (
    2413            1 :                         keyBuf               []byte
    2414            1 :                         boundsBuf            [2][]byte
    2415            1 :                         prefixOrFullSeekKey  []byte
    2416            1 :                         mergingIterHeapItems []mergingIterHeapItem
    2417            1 :                 )
    2418            1 : 
    2419            1 :                 // Avoid caching the key buf if it is overly large. The constant is fairly
    2420            1 :                 // arbitrary.
    2421            1 :                 if cap(i.keyBuf) < maxKeyBufCacheSize {
    2422            1 :                         keyBuf = i.keyBuf
    2423            1 :                 }
    2424            1 :                 if cap(i.prefixOrFullSeekKey) < maxKeyBufCacheSize {
    2425            1 :                         prefixOrFullSeekKey = i.prefixOrFullSeekKey
    2426            1 :                 }
    2427            1 :                 for j := range i.boundsBuf {
    2428            1 :                         if cap(i.boundsBuf[j]) < maxKeyBufCacheSize {
    2429            1 :                                 boundsBuf[j] = i.boundsBuf[j]
    2430            1 :                         }
    2431              :                 }
    2432            1 :                 mergingIterHeapItems = alloc.merging.heap.items
    2433            1 : 
    2434            1 :                 // Reset the alloc struct, re-assign the fields that are being recycled, and
    2435            1 :                 // then return it to the pool. Splitting the first two steps performs better
    2436            1 :                 // than doing them in a single step (e.g. *alloc = iterAlloc{...}) because
    2437            1 :                 // the compiler can avoid the use of a stack allocated autotmp iterAlloc
    2438            1 :                 // variable (~12KB, as of Dec 2024), which must first be zeroed out, then
    2439            1 :                 // assigned into, then copied over into the heap-allocated alloc. Instead,
    2440            1 :                 // the two-step process allows the compiler to quickly zero out the heap
    2441            1 :                 // allocated object and then assign the few fields we want to preserve.
    2442            1 :                 //
    2443            1 :                 // TODO(nvanbenschoten): even with this optimization, zeroing out the alloc
    2444            1 :                 // struct still shows up in profiles because it is such a large struct. Can
    2445            1 :                 // we do something better here? We are hanging 22 separated iterators off of
    2446            1 :                 // the alloc struct (or more, depending on how you count), many of which are
    2447            1 :                 // only used in a few cases. Can those iterators be responsible for zeroing
    2448            1 :                 // out their own memory on Close, allowing us to assume that most of the
    2449            1 :                 // alloc struct is already zeroed out by this point?
    2450            1 :                 *alloc = iterAlloc{}
    2451            1 :                 alloc.keyBuf = keyBuf
    2452            1 :                 alloc.boundsBuf = boundsBuf
    2453            1 :                 alloc.prefixOrFullSeekKey = prefixOrFullSeekKey
    2454            1 :                 alloc.merging.heap.items = mergingIterHeapItems
    2455            1 : 
    2456            1 :                 iterAllocPool.Put(alloc)
    2457            1 :         } else if alloc := i.getIterAlloc; alloc != nil {
    2458            1 :                 if cap(i.keyBuf) >= maxKeyBufCacheSize {
    2459            0 :                         alloc.keyBuf = nil
    2460            1 :                 } else {
    2461            1 :                         alloc.keyBuf = i.keyBuf
    2462            1 :                 }
    2463            1 :                 *alloc = getIterAlloc{
    2464            1 :                         keyBuf: alloc.keyBuf,
    2465            1 :                 }
    2466            1 :                 getIterAllocPool.Put(alloc)
    2467              :         }
    2468            1 :         return err
    2469              : }
    2470              : 
    2471              : // SetBounds sets the lower and upper bounds for the iterator. Once SetBounds
    2472              : // returns, the caller is free to mutate the provided slices.
    2473              : //
    2474              : // The iterator will always be invalidated and must be repositioned with a call
    2475              : // to SeekGE, SeekPrefixGE, SeekLT, First, or Last.
    2476            1 : func (i *Iterator) SetBounds(lower, upper []byte) {
    2477            1 :         // Ensure that the Iterator appears exhausted, regardless of whether we
    2478            1 :         // actually have to invalidate the internal iterator. Optimizations that
    2479            1 :         // avoid exhaustion are an internal implementation detail that shouldn't
    2480            1 :         // leak through the interface. The caller should still call an absolute
    2481            1 :         // positioning method to reposition the iterator.
    2482            1 :         i.requiresReposition = true
    2483            1 : 
    2484            1 :         if ((i.opts.LowerBound == nil) == (lower == nil)) &&
    2485            1 :                 ((i.opts.UpperBound == nil) == (upper == nil)) &&
    2486            1 :                 i.equal(i.opts.LowerBound, lower) &&
    2487            1 :                 i.equal(i.opts.UpperBound, upper) {
    2488            1 :                 // Unchanged, noop.
    2489            1 :                 return
    2490            1 :         }
    2491              : 
    2492              :         // Copy the user-provided bounds into an Iterator-owned buffer, and set them
    2493              :         // on i.opts.{Lower,Upper}Bound.
    2494            1 :         i.processBounds(lower, upper)
    2495            1 : 
    2496            1 :         i.iter.SetBounds(i.opts.LowerBound, i.opts.UpperBound)
    2497            1 :         // If the iterator has an open point iterator that's not currently being
    2498            1 :         // used, propagate the new bounds to it.
    2499            1 :         if i.pointIter != nil && !i.opts.pointKeys() {
    2500            1 :                 i.pointIter.SetBounds(i.opts.LowerBound, i.opts.UpperBound)
    2501            1 :         }
    2502              :         // If the iterator has a range key iterator, propagate bounds to it. The
    2503              :         // top-level SetBounds on the interleaving iterator (i.iter) won't propagate
    2504              :         // bounds to the range key iterator stack, because the FragmentIterator
    2505              :         // interface doesn't define a SetBounds method. We need to directly inform
    2506              :         // the iterConfig stack.
    2507            1 :         if i.rangeKey != nil {
    2508            1 :                 i.rangeKey.iterConfig.SetBounds(i.opts.LowerBound, i.opts.UpperBound)
    2509            1 :         }
    2510              : 
    2511              :         // Even though this is not a positioning operation, the alteration of the
    2512              :         // bounds means we cannot optimize Seeks by using Next.
    2513            1 :         i.invalidate()
    2514              : }
    2515              : 
    2516              : // SetContext replaces the context provided at iterator creation, or the last
    2517              : // one provided by SetContext. Even though iterators are expected to be
    2518              : // short-lived, there are some cases where either (a) iterators are used far
    2519              : // from the code that created them, (b) iterators are reused (while being
    2520              : // short-lived) for processing different requests. For such scenarios, we
    2521              : // allow the caller to replace the context.
    2522            0 : func (i *Iterator) SetContext(ctx context.Context) {
    2523            0 :         i.ctx = ctx
    2524            0 :         i.iter.SetContext(ctx)
    2525            0 :         // If the iterator has an open point iterator that's not currently being
    2526            0 :         // used, propagate the new context to it.
    2527            0 :         if i.pointIter != nil && !i.opts.pointKeys() {
    2528            0 :                 i.pointIter.SetContext(i.ctx)
    2529            0 :         }
    2530              : }
    2531              : 
    2532              : // Initialization and changing of the bounds must call processBounds.
    2533              : // processBounds saves the bounds and computes derived state from those
    2534              : // bounds.
    2535            1 : func (i *Iterator) processBounds(lower, upper []byte) {
    2536            1 :         // Copy the user-provided bounds into an Iterator-owned buffer. We can't
    2537            1 :         // overwrite the current bounds, because some internal iterators compare old
    2538            1 :         // and new bounds for optimizations.
    2539            1 : 
    2540            1 :         buf := i.boundsBuf[i.boundsBufIdx][:0]
    2541            1 :         if lower != nil {
    2542            1 :                 buf = append(buf, lower...)
    2543            1 :                 i.opts.LowerBound = buf
    2544            1 :         } else {
    2545            1 :                 i.opts.LowerBound = nil
    2546            1 :         }
    2547            1 :         i.nextPrefixNotPermittedByUpperBound = false
    2548            1 :         if upper != nil {
    2549            1 :                 buf = append(buf, upper...)
    2550            1 :                 i.opts.UpperBound = buf[len(buf)-len(upper):]
    2551            1 :                 if i.comparer.Split(i.opts.UpperBound) != len(i.opts.UpperBound) {
    2552            1 :                         // Setting an upper bound that is a versioned MVCC key. This means
    2553            1 :                         // that a key can have some MVCC versions before the upper bound and
    2554            1 :                         // some after. This causes significant complications for NextPrefix,
    2555            1 :                         // so we bar the user of NextPrefix.
    2556            1 :                         i.nextPrefixNotPermittedByUpperBound = true
    2557            1 :                 }
    2558            1 :         } else {
    2559            1 :                 i.opts.UpperBound = nil
    2560            1 :         }
    2561            1 :         i.boundsBuf[i.boundsBufIdx] = buf
    2562            1 :         i.boundsBufIdx = 1 - i.boundsBufIdx
    2563              : }
    2564              : 
    2565              : // SetOptions sets new iterator options for the iterator. Note that the lower
    2566              : // and upper bounds applied here will supersede any bounds set by previous calls
    2567              : // to SetBounds.
    2568              : //
    2569              : // Note that the slices provided in this SetOptions must not be changed by the
    2570              : // caller until the iterator is closed, or a subsequent SetBounds or SetOptions
    2571              : // has returned. This is because comparisons between the existing and new bounds
    2572              : // are sometimes used to optimize seeking. See the extended commentary on
    2573              : // SetBounds.
    2574              : //
    2575              : // If the iterator was created over an indexed mutable batch, the iterator's
    2576              : // view of the mutable batch is refreshed.
    2577              : //
    2578              : // The iterator will always be invalidated and must be repositioned with a call
    2579              : // to SeekGE, SeekPrefixGE, SeekLT, First, or Last.
    2580              : //
    2581              : // If only lower and upper bounds need to be modified, prefer SetBounds.
    2582            1 : func (i *Iterator) SetOptions(o *IterOptions) {
    2583            1 :         if i.externalIter != nil {
    2584            1 :                 if err := validateExternalIterOpts(o); err != nil {
    2585            0 :                         panic(err)
    2586              :                 }
    2587              :         }
    2588              : 
    2589              :         // Ensure that the Iterator appears exhausted, regardless of whether we
    2590              :         // actually have to invalidate the internal iterator. Optimizations that
    2591              :         // avoid exhaustion are an internal implementation detail that shouldn't
    2592              :         // leak through the interface. The caller should still call an absolute
    2593              :         // positioning method to reposition the iterator.
    2594            1 :         i.requiresReposition = true
    2595            1 : 
    2596            1 :         // Check if global state requires we close all internal iterators.
    2597            1 :         //
    2598            1 :         // If the Iterator is in an error state, invalidate the existing iterators
    2599            1 :         // so that we reconstruct an iterator state from scratch.
    2600            1 :         //
    2601            1 :         // If OnlyReadGuaranteedDurable changed, the iterator stacks are incorrect,
    2602            1 :         // improperly including or excluding memtables. Invalidate them so that
    2603            1 :         // finishInitializingIter will reconstruct them.
    2604            1 :         closeBoth := i.err != nil ||
    2605            1 :                 o.OnlyReadGuaranteedDurable != i.opts.OnlyReadGuaranteedDurable
    2606            1 : 
    2607            1 :         // If either options specify block property filters for an iterator stack,
    2608            1 :         // reconstruct it.
    2609            1 :         if i.pointIter != nil && (closeBoth || len(o.PointKeyFilters) > 0 || len(i.opts.PointKeyFilters) > 0 ||
    2610            1 :                 o.RangeKeyMasking.Filter != nil || i.opts.RangeKeyMasking.Filter != nil || o.SkipPoint != nil ||
    2611            1 :                 i.opts.SkipPoint != nil) {
    2612            1 :                 i.err = firstError(i.err, i.pointIter.Close())
    2613            1 :                 i.pointIter = nil
    2614            1 :         }
    2615            1 :         if i.rangeKey != nil {
    2616            1 :                 if closeBoth || len(o.RangeKeyFilters) > 0 || len(i.opts.RangeKeyFilters) > 0 {
    2617            1 :                         i.rangeKey.rangeKeyIter.Close()
    2618            1 :                         i.rangeKey = nil
    2619            1 :                 } else {
    2620            1 :                         // If there's still a range key iterator stack, invalidate the
    2621            1 :                         // iterator. This ensures RangeKeyChanged() returns true if a
    2622            1 :                         // subsequent positioning operation discovers a range key. It also
    2623            1 :                         // prevents seek no-op optimizations.
    2624            1 :                         i.invalidate()
    2625            1 :                 }
    2626              :         }
    2627              : 
    2628              :         // If the iterator is backed by a batch that's been mutated, refresh its
    2629              :         // existing point and range-key iterators, and invalidate the iterator to
    2630              :         // prevent seek-using-next optimizations. If we don't yet have a point-key
    2631              :         // iterator or range-key iterator but we require one, it'll be created in
    2632              :         // the slow path that reconstructs the iterator in finishInitializingIter.
    2633            1 :         if i.batch != nil {
    2634            1 :                 nextBatchSeqNum := (base.SeqNum(len(i.batch.data)) | base.SeqNumBatchBit)
    2635            1 :                 if nextBatchSeqNum != i.batchSeqNum {
    2636            1 :                         i.batchSeqNum = nextBatchSeqNum
    2637            1 :                         if i.merging != nil {
    2638            1 :                                 i.merging.batchSnapshot = nextBatchSeqNum
    2639            1 :                         }
    2640              :                         // Prevent a no-op seek optimization on the next seek. We won't be
    2641              :                         // able to reuse the top-level Iterator state, because it may be
    2642              :                         // incorrect after the inclusion of new batch mutations.
    2643            1 :                         i.batchJustRefreshed = true
    2644            1 :                         if i.pointIter != nil && i.batch.countRangeDels > 0 {
    2645            1 :                                 if i.batchRangeDelIter.Count() == 0 {
    2646            1 :                                         // When we constructed this iterator, there were no
    2647            1 :                                         // rangedels in the batch. Iterator construction will
    2648            1 :                                         // have excluded the batch rangedel iterator from the
    2649            1 :                                         // point iterator stack. We need to reconstruct the
    2650            1 :                                         // point iterator to add i.batchRangeDelIter into the
    2651            1 :                                         // iterator stack.
    2652            1 :                                         i.err = firstError(i.err, i.pointIter.Close())
    2653            1 :                                         i.pointIter = nil
    2654            1 :                                 } else {
    2655            1 :                                         // There are range deletions in the batch and we already
    2656            1 :                                         // have a batch rangedel iterator. We can update the
    2657            1 :                                         // batch rangedel iterator in place.
    2658            1 :                                         //
    2659            1 :                                         // NB: There may or may not be new range deletions. We
    2660            1 :                                         // can't tell based on i.batchRangeDelIter.Count(),
    2661            1 :                                         // which is the count of fragmented range deletions, NOT
    2662            1 :                                         // the number of range deletions written to the batch
    2663            1 :                                         // [i.batch.countRangeDels].
    2664            1 :                                         i.batch.initRangeDelIter(&i.opts, &i.batchRangeDelIter, nextBatchSeqNum)
    2665            1 :                                 }
    2666              :                         }
    2667            1 :                         if i.rangeKey != nil && i.batch.countRangeKeys > 0 {
    2668            1 :                                 if i.batchRangeKeyIter.Count() == 0 {
    2669            1 :                                         // When we constructed this iterator, there were no range
    2670            1 :                                         // keys in the batch. Iterator construction will have
    2671            1 :                                         // excluded the batch rangekey iterator from the range key
    2672            1 :                                         // iterator stack. We need to reconstruct the range key
    2673            1 :                                         // iterator to add i.batchRangeKeyIter into the iterator
    2674            1 :                                         // stack.
    2675            1 :                                         i.rangeKey.rangeKeyIter.Close()
    2676            1 :                                         i.rangeKey = nil
    2677            1 :                                 } else {
    2678            1 :                                         // There are range keys in the batch and we already
    2679            1 :                                         // have a batch rangekey iterator. We can update the batch
    2680            1 :                                         // rangekey iterator in place.
    2681            1 :                                         //
    2682            1 :                                         // NB: There may or may not be new range keys. We can't
    2683            1 :                                         // tell based on i.batchRangeKeyIter.Count(), which is the
    2684            1 :                                         // count of fragmented range keys, NOT the number of
    2685            1 :                                         // range keys written to the batch [i.batch.countRangeKeys].
    2686            1 :                                         i.batch.initRangeKeyIter(&i.opts, &i.batchRangeKeyIter, nextBatchSeqNum)
    2687            1 :                                         i.invalidate()
    2688            1 :                                 }
    2689              :                         }
    2690              :                 }
    2691              :         }
    2692              : 
    2693              :         // Reset combinedIterState.initialized in case the iterator key types
    2694              :         // changed. If there's already a range key iterator stack, the combined
    2695              :         // iterator is already initialized.  Additionally, if the iterator is not
    2696              :         // configured to include range keys, mark it as initialized to signal that
    2697              :         // lower level iterators should not trigger a switch to combined iteration.
    2698            1 :         i.lazyCombinedIter.combinedIterState = combinedIterState{
    2699            1 :                 initialized: i.rangeKey != nil || !i.opts.rangeKeys(),
    2700            1 :         }
    2701            1 : 
    2702            1 :         boundsEqual := ((i.opts.LowerBound == nil) == (o.LowerBound == nil)) &&
    2703            1 :                 ((i.opts.UpperBound == nil) == (o.UpperBound == nil)) &&
    2704            1 :                 i.equal(i.opts.LowerBound, o.LowerBound) &&
    2705            1 :                 i.equal(i.opts.UpperBound, o.UpperBound)
    2706            1 : 
    2707            1 :         if boundsEqual && o.KeyTypes == i.opts.KeyTypes &&
    2708            1 :                 (i.pointIter != nil || !i.opts.pointKeys()) &&
    2709            1 :                 (i.rangeKey != nil || !i.opts.rangeKeys() || i.opts.KeyTypes == IterKeyTypePointsAndRanges) &&
    2710            1 :                 i.comparer.CompareRangeSuffixes(o.RangeKeyMasking.Suffix, i.opts.RangeKeyMasking.Suffix) == 0 &&
    2711            1 :                 o.UseL6Filters == i.opts.UseL6Filters {
    2712            1 :                 // The options are identical, so we can likely use the fast path. In
    2713            1 :                 // addition to all the above constraints, we cannot use the fast path if
    2714            1 :                 // configured to perform lazy combined iteration but an indexed batch
    2715            1 :                 // used by the iterator now contains range keys. Lazy combined iteration
    2716            1 :                 // is not compatible with batch range keys because we always need to
    2717            1 :                 // merge the batch's range keys into iteration.
    2718            1 :                 if i.rangeKey != nil || !i.opts.rangeKeys() || i.batch == nil || i.batch.countRangeKeys == 0 {
    2719            1 :                         // Fast path. This preserves the Seek-using-Next optimizations as
    2720            1 :                         // long as the iterator wasn't already invalidated up above.
    2721            1 :                         return
    2722            1 :                 }
    2723              :         }
    2724              :         // Slow path.
    2725              : 
    2726              :         // The options changed. Save the new ones to i.opts.
    2727            1 :         if boundsEqual {
    2728            1 :                 // Copying the options into i.opts will overwrite LowerBound and
    2729            1 :                 // UpperBound fields with the user-provided slices. We need to hold on
    2730            1 :                 // to the Pebble-owned slices, so save them and re-set them after the
    2731            1 :                 // copy.
    2732            1 :                 lower, upper := i.opts.LowerBound, i.opts.UpperBound
    2733            1 :                 i.opts = *o
    2734            1 :                 i.opts.LowerBound, i.opts.UpperBound = lower, upper
    2735            1 :         } else {
    2736            1 :                 i.opts = *o
    2737            1 :                 i.processBounds(o.LowerBound, o.UpperBound)
    2738            1 :                 // Propagate the changed bounds to the existing point iterator.
    2739            1 :                 // NB: We propagate i.opts.{Lower,Upper}Bound, not o.{Lower,Upper}Bound
    2740            1 :                 // because i.opts now point to buffers owned by Pebble.
    2741            1 :                 if i.pointIter != nil {
    2742            1 :                         i.pointIter.SetBounds(i.opts.LowerBound, i.opts.UpperBound)
    2743            1 :                 }
    2744            1 :                 if i.rangeKey != nil {
    2745            1 :                         i.rangeKey.iterConfig.SetBounds(i.opts.LowerBound, i.opts.UpperBound)
    2746            1 :                 }
    2747              :         }
    2748              : 
    2749              :         // Even though this is not a positioning operation, the invalidation of the
    2750              :         // iterator stack means we cannot optimize Seeks by using Next.
    2751            1 :         i.invalidate()
    2752            1 : 
    2753            1 :         // Iterators created through NewExternalIter have a different iterator
    2754            1 :         // initialization process.
    2755            1 :         if i.externalIter != nil {
    2756            1 :                 _ = finishInitializingExternal(i.ctx, i)
    2757            1 :                 return
    2758            1 :         }
    2759            1 :         finishInitializingIter(i.ctx, i.alloc)
    2760              : }
    2761              : 
    2762            1 : func (i *Iterator) invalidate() {
    2763            1 :         i.lastPositioningOp = unknownLastPositionOp
    2764            1 :         i.hasPrefix = false
    2765            1 :         i.iterKV = nil
    2766            1 :         i.err = nil
    2767            1 :         // This switch statement isn't necessary for correctness since callers
    2768            1 :         // should call a repositioning method. We could have arbitrarily set i.pos
    2769            1 :         // to one of the values. But it results in more intuitive behavior in
    2770            1 :         // tests, which do not always reposition.
    2771            1 :         switch i.pos {
    2772            1 :         case iterPosCurForward, iterPosNext, iterPosCurForwardPaused:
    2773            1 :                 i.pos = iterPosCurForward
    2774            1 :         case iterPosCurReverse, iterPosPrev, iterPosCurReversePaused:
    2775            1 :                 i.pos = iterPosCurReverse
    2776              :         }
    2777            1 :         i.iterValidityState = IterExhausted
    2778            1 :         if i.rangeKey != nil {
    2779            1 :                 i.rangeKey.iiter.Invalidate()
    2780            1 :                 i.rangeKey.prevPosHadRangeKey = false
    2781            1 :         }
    2782              : }
    2783              : 
    2784              : // Metrics returns per-iterator metrics.
    2785            0 : func (i *Iterator) Metrics() IteratorMetrics {
    2786            0 :         m := IteratorMetrics{
    2787            0 :                 ReadAmp: 1,
    2788            0 :         }
    2789            0 :         if mi, ok := i.iter.(*mergingIter); ok {
    2790            0 :                 m.ReadAmp = len(mi.levels)
    2791            0 :         }
    2792            0 :         return m
    2793              : }
    2794              : 
    2795              : // ResetStats resets the stats to 0.
    2796            0 : func (i *Iterator) ResetStats() {
    2797            0 :         i.stats = IteratorStats{}
    2798            0 : }
    2799              : 
    2800              : // Stats returns the current stats.
    2801            1 : func (i *Iterator) Stats() IteratorStats {
    2802            1 :         return i.stats
    2803            1 : }
    2804              : 
    2805              : // CloneOptions configures an iterator constructed through Iterator.Clone.
    2806              : type CloneOptions struct {
    2807              :         // IterOptions, if non-nil, define the iterator options to configure a
    2808              :         // cloned iterator. If nil, the clone adopts the same IterOptions as the
    2809              :         // iterator being cloned.
    2810              :         IterOptions *IterOptions
    2811              :         // RefreshBatchView may be set to true when cloning an Iterator over an
    2812              :         // indexed batch. When false, the clone adopts the same (possibly stale)
    2813              :         // view of the indexed batch as the cloned Iterator. When true, the clone is
    2814              :         // constructed with a refreshed view of the batch, observing all of the
    2815              :         // batch's mutations at the time of the Clone. If the cloned iterator was
    2816              :         // not constructed to read over an indexed batch, RefreshVatchView has no
    2817              :         // effect.
    2818              :         RefreshBatchView bool
    2819              : }
    2820              : 
    2821              : // Clone creates a new Iterator over the same underlying data, i.e., over the
    2822              : // same {batch, memtables, sstables}). The resulting iterator is not positioned.
    2823              : // It starts with the same IterOptions, unless opts.IterOptions is set.
    2824              : //
    2825              : // When called on an Iterator over an indexed batch, the clone's visibility of
    2826              : // the indexed batch is determined by CloneOptions.RefreshBatchView. If false,
    2827              : // the clone inherits the iterator's current (possibly stale) view of the batch,
    2828              : // and callers may call SetOptions to subsequently refresh the clone's view to
    2829              : // include all batch mutations. If true, the clone is constructed with a
    2830              : // complete view of the indexed batch's mutations at the time of the Clone.
    2831              : //
    2832              : // Callers can use Clone if they need multiple iterators that need to see
    2833              : // exactly the same underlying state of the DB. This should not be used to
    2834              : // extend the lifetime of the data backing the original Iterator since that
    2835              : // will cause an increase in memory and disk usage (use NewSnapshot for that
    2836              : // purpose).
    2837            1 : func (i *Iterator) Clone(opts CloneOptions) (*Iterator, error) {
    2838            1 :         return i.CloneWithContext(context.Background(), opts)
    2839            1 : }
    2840              : 
    2841              : // CloneWithContext is like Clone, and additionally accepts a context for
    2842              : // tracing.
    2843            1 : func (i *Iterator) CloneWithContext(ctx context.Context, opts CloneOptions) (*Iterator, error) {
    2844            1 :         if opts.IterOptions == nil {
    2845            1 :                 opts.IterOptions = &i.opts
    2846            1 :         }
    2847            1 :         if i.batchOnlyIter {
    2848            1 :                 return nil, errors.Errorf("cannot Clone a batch-only Iterator")
    2849            1 :         }
    2850            1 :         readState := i.readState
    2851            1 :         vers := i.version
    2852            1 :         if readState == nil && vers == nil {
    2853            1 :                 return nil, errors.Errorf("cannot Clone a closed Iterator")
    2854            1 :         }
    2855              :         // i is already holding a ref, so there is no race with unref here.
    2856              :         //
    2857              :         // TODO(bilal): If the underlying iterator was created on a snapshot, we could
    2858              :         // grab a reference to the current readState instead of reffing the original
    2859              :         // readState. This allows us to release references to some zombie sstables
    2860              :         // and memtables.
    2861            1 :         if readState != nil {
    2862            1 :                 readState.ref()
    2863            1 :         }
    2864            1 :         if vers != nil {
    2865            1 :                 vers.Ref()
    2866            1 :         }
    2867              :         // Bundle various structures under a single umbrella in order to allocate
    2868              :         // them together.
    2869            1 :         buf := iterAllocPool.Get().(*iterAlloc)
    2870            1 :         dbi := &buf.dbi
    2871            1 :         *dbi = Iterator{
    2872            1 :                 ctx:                 ctx,
    2873            1 :                 opts:                *opts.IterOptions,
    2874            1 :                 alloc:               buf,
    2875            1 :                 merge:               i.merge,
    2876            1 :                 comparer:            i.comparer,
    2877            1 :                 readState:           readState,
    2878            1 :                 version:             vers,
    2879            1 :                 keyBuf:              buf.keyBuf,
    2880            1 :                 prefixOrFullSeekKey: buf.prefixOrFullSeekKey,
    2881            1 :                 boundsBuf:           buf.boundsBuf,
    2882            1 :                 batch:               i.batch,
    2883            1 :                 batchSeqNum:         i.batchSeqNum,
    2884            1 :                 fc:                  i.fc,
    2885            1 :                 newIters:            i.newIters,
    2886            1 :                 newIterRangeKey:     i.newIterRangeKey,
    2887            1 :                 seqNum:              i.seqNum,
    2888            1 :         }
    2889            1 :         dbi.processBounds(dbi.opts.LowerBound, dbi.opts.UpperBound)
    2890            1 : 
    2891            1 :         // If the caller requested the clone have a current view of the indexed
    2892            1 :         // batch, set the clone's batch sequence number appropriately.
    2893            1 :         if i.batch != nil && opts.RefreshBatchView {
    2894            1 :                 dbi.batchSeqNum = (base.SeqNum(len(i.batch.data)) | base.SeqNumBatchBit)
    2895            1 :         }
    2896              : 
    2897            1 :         return finishInitializingIter(ctx, buf), nil
    2898              : }
    2899              : 
    2900              : // Merge adds all of the argument's statistics to the receiver. It may be used
    2901              : // to accumulate stats across multiple iterators.
    2902            1 : func (stats *IteratorStats) Merge(o IteratorStats) {
    2903            1 :         for i := InterfaceCall; i < NumStatsKind; i++ {
    2904            1 :                 stats.ForwardSeekCount[i] += o.ForwardSeekCount[i]
    2905            1 :                 stats.ReverseSeekCount[i] += o.ReverseSeekCount[i]
    2906            1 :                 stats.ForwardStepCount[i] += o.ForwardStepCount[i]
    2907            1 :                 stats.ReverseStepCount[i] += o.ReverseStepCount[i]
    2908            1 :         }
    2909            1 :         stats.InternalStats.Merge(o.InternalStats)
    2910            1 :         stats.RangeKeyStats.Merge(o.RangeKeyStats)
    2911              : }
    2912              : 
    2913            1 : func (stats *IteratorStats) String() string {
    2914            1 :         return redact.StringWithoutMarkers(stats)
    2915            1 : }
    2916              : 
    2917              : // SafeFormat implements the redact.SafeFormatter interface.
    2918            1 : func (stats *IteratorStats) SafeFormat(s redact.SafePrinter, verb rune) {
    2919            1 :         if stats.ReverseSeekCount[InterfaceCall] == 0 && stats.ReverseSeekCount[InternalIterCall] == 0 {
    2920            1 :                 s.Printf("seeked %s times (%s internal)",
    2921            1 :                         humanize.Count.Uint64(uint64(stats.ForwardSeekCount[InterfaceCall])),
    2922            1 :                         humanize.Count.Uint64(uint64(stats.ForwardSeekCount[InternalIterCall])),
    2923            1 :                 )
    2924            1 :         } else {
    2925            1 :                 s.Printf("seeked %s times (%s fwd/%s rev, internal: %s fwd/%s rev)",
    2926            1 :                         humanize.Count.Uint64(uint64(stats.ForwardSeekCount[InterfaceCall]+stats.ReverseSeekCount[InterfaceCall])),
    2927            1 :                         humanize.Count.Uint64(uint64(stats.ForwardSeekCount[InterfaceCall])),
    2928            1 :                         humanize.Count.Uint64(uint64(stats.ReverseSeekCount[InterfaceCall])),
    2929            1 :                         humanize.Count.Uint64(uint64(stats.ForwardSeekCount[InternalIterCall])),
    2930            1 :                         humanize.Count.Uint64(uint64(stats.ReverseSeekCount[InternalIterCall])),
    2931            1 :                 )
    2932            1 :         }
    2933            1 :         s.SafeString("; ")
    2934            1 : 
    2935            1 :         if stats.ReverseStepCount[InterfaceCall] == 0 && stats.ReverseStepCount[InternalIterCall] == 0 {
    2936            1 :                 s.Printf("stepped %s times (%s internal)",
    2937            1 :                         humanize.Count.Uint64(uint64(stats.ForwardStepCount[InterfaceCall])),
    2938            1 :                         humanize.Count.Uint64(uint64(stats.ForwardStepCount[InternalIterCall])),
    2939            1 :                 )
    2940            1 :         } else {
    2941            1 :                 s.Printf("stepped %s times (%s fwd/%s rev, internal: %s fwd/%s rev)",
    2942            1 :                         humanize.Count.Uint64(uint64(stats.ForwardStepCount[InterfaceCall]+stats.ReverseStepCount[InterfaceCall])),
    2943            1 :                         humanize.Count.Uint64(uint64(stats.ForwardStepCount[InterfaceCall])),
    2944            1 :                         humanize.Count.Uint64(uint64(stats.ReverseStepCount[InterfaceCall])),
    2945            1 :                         humanize.Count.Uint64(uint64(stats.ForwardStepCount[InternalIterCall])),
    2946            1 :                         humanize.Count.Uint64(uint64(stats.ReverseStepCount[InternalIterCall])),
    2947            1 :                 )
    2948            1 :         }
    2949              : 
    2950            1 :         if stats.InternalStats != (InternalIteratorStats{}) {
    2951            1 :                 s.SafeString("; ")
    2952            1 :                 stats.InternalStats.SafeFormat(s, verb)
    2953            1 :         }
    2954            1 :         if stats.RangeKeyStats != (RangeKeyIteratorStats{}) {
    2955            1 :                 s.SafeString(", ")
    2956            1 :                 stats.RangeKeyStats.SafeFormat(s, verb)
    2957            1 :         }
    2958              : }
    2959              : 
    2960              : // CanDeterministicallySingleDelete takes a valid iterator and examines internal
    2961              : // state to determine if a SingleDelete deleting Iterator.Key() would
    2962              : // deterministically delete the key. CanDeterministicallySingleDelete requires
    2963              : // the iterator to be oriented in the forward direction (eg, the last
    2964              : // positioning operation must've been a First, a Seek[Prefix]GE, or a
    2965              : // Next[Prefix][WithLimit]).
    2966              : //
    2967              : // This function does not change the external position of the iterator, and all
    2968              : // positioning methods should behave the same as if it was never called. This
    2969              : // function will only return a meaningful result the first time it's invoked at
    2970              : // an iterator position. This function invalidates the iterator Value's memory,
    2971              : // and the caller must not rely on the memory safety of the previous Iterator
    2972              : // position.
    2973              : //
    2974              : // If CanDeterministicallySingleDelete returns true AND the key at the iterator
    2975              : // position is not modified between the creation of the Iterator and the commit
    2976              : // of a batch containing a SingleDelete over the key, then the caller can be
    2977              : // assured that SingleDelete is equivalent to Delete on the local engine, but it
    2978              : // may not be true on another engine that received the same writes and with
    2979              : // logically equivalent state since this engine may have collapsed multiple SETs
    2980              : // into one.
    2981            1 : func CanDeterministicallySingleDelete(it *Iterator) (bool, error) {
    2982            1 :         // This function may only be called once per external iterator position. We
    2983            1 :         // can validate this by checking the last positioning operation.
    2984            1 :         if it.lastPositioningOp == internalNextOp {
    2985            1 :                 return false, errors.New("pebble: CanDeterministicallySingleDelete called twice")
    2986            1 :         }
    2987            1 :         validity, kind := it.internalNext()
    2988            1 :         var shadowedBySingleDelete bool
    2989            1 :         for validity == internalNextValid {
    2990            1 :                 switch kind {
    2991            1 :                 case InternalKeyKindDelete, InternalKeyKindDeleteSized:
    2992            1 :                         // A DEL or DELSIZED tombstone is okay. An internal key
    2993            1 :                         // sequence like SINGLEDEL; SET; DEL; SET can be handled
    2994            1 :                         // deterministically. If there are SETs further down, we
    2995            1 :                         // don't care about them.
    2996            1 :                         return true, nil
    2997            1 :                 case InternalKeyKindSingleDelete:
    2998            1 :                         // A SingleDelete is okay as long as when that SingleDelete was
    2999            1 :                         // written, it was written deterministically (eg, with its own
    3000            1 :                         // CanDeterministicallySingleDelete check). Validate that it was
    3001            1 :                         // written deterministically. We'll allow one set to appear after
    3002            1 :                         // the SingleDelete.
    3003            1 :                         shadowedBySingleDelete = true
    3004            1 :                         validity, kind = it.internalNext()
    3005            1 :                         continue
    3006            1 :                 case InternalKeyKindSet, InternalKeyKindSetWithDelete, InternalKeyKindMerge:
    3007            1 :                         // If we observed a single delete, it's allowed to delete 1 key.
    3008            1 :                         // We'll keep looping to validate that the internal keys beneath the
    3009            1 :                         // already-written single delete are copacetic.
    3010            1 :                         if shadowedBySingleDelete {
    3011            1 :                                 shadowedBySingleDelete = false
    3012            1 :                                 validity, kind = it.internalNext()
    3013            1 :                                 continue
    3014              :                         }
    3015              :                         // We encountered a shadowed SET, SETWITHDEL, MERGE. A SINGLEDEL
    3016              :                         // that deleted the KV at the original iterator position could
    3017              :                         // result in this key becoming visible.
    3018            1 :                         return false, nil
    3019            0 :                 case InternalKeyKindRangeDelete:
    3020            0 :                         // RangeDeletes are handled by the merging iterator and should never
    3021            0 :                         // be observed by the top-level Iterator.
    3022            0 :                         panic(errors.AssertionFailedf("pebble: unexpected range delete"))
    3023            0 :                 case InternalKeyKindRangeKeySet, InternalKeyKindRangeKeyUnset, InternalKeyKindRangeKeyDelete:
    3024            0 :                         // Range keys are interleaved at the maximal sequence number and
    3025            0 :                         // should never be observed within a user key.
    3026            0 :                         panic(errors.AssertionFailedf("pebble: unexpected range key"))
    3027            0 :                 default:
    3028            0 :                         panic(errors.AssertionFailedf("pebble: unexpected key kind: %s", errors.Safe(kind)))
    3029              :                 }
    3030              :         }
    3031            1 :         if validity == internalNextError {
    3032            1 :                 return false, it.Error()
    3033            1 :         }
    3034            1 :         return true, nil
    3035              : }
    3036              : 
    3037              : // internalNextValidity enumerates the potential outcomes of a call to
    3038              : // internalNext.
    3039              : type internalNextValidity int8
    3040              : 
    3041              : const (
    3042              :         // internalNextError is returned by internalNext when an error occurred and
    3043              :         // the caller is responsible for checking iter.Error().
    3044              :         internalNextError internalNextValidity = iota
    3045              :         // internalNextExhausted is returned by internalNext when the next internal
    3046              :         // key is an internal key with a different user key than Iterator.Key().
    3047              :         internalNextExhausted
    3048              :         // internalNextValid is returned by internalNext when the internal next
    3049              :         // found a shadowed internal key with a user key equal to Iterator.Key().
    3050              :         internalNextValid
    3051              : )
    3052              : 
    3053              : // internalNext advances internal Iterator state forward to expose the
    3054              : // InternalKeyKind of the next internal key with a user key equal to Key().
    3055              : //
    3056              : // internalNext is a highly specialized operation and is unlikely to be
    3057              : // generally useful. See Iterator.Next for how to reposition the iterator to the
    3058              : // next key. internalNext requires the Iterator to be at a valid position in the
    3059              : // forward direction (the last positioning operation must've been a First, a
    3060              : // Seek[Prefix]GE, or a Next[Prefix][WithLimit] and Valid() must return true).
    3061              : //
    3062              : // internalNext, unlike all other Iterator methods, exposes internal LSM state.
    3063              : // internalNext advances the Iterator's internal iterator to the next shadowed
    3064              : // key with a user key equal to Key(). When a key is overwritten or deleted, its
    3065              : // removal from the LSM occurs lazily as a part of compactions. internalNext
    3066              : // allows the caller to see whether an obsolete internal key exists with the
    3067              : // current Key(), and what it's key kind is. Note that the existence of an
    3068              : // internal key is nondeterministic and dependent on internal LSM state. These
    3069              : // semantics are unlikely to be applicable to almost all use cases.
    3070              : //
    3071              : // If internalNext finds a key that shares the same user key as Key(), it
    3072              : // returns internalNextValid and the internal key's kind. If internalNext
    3073              : // encounters an error, it returns internalNextError and the caller is expected
    3074              : // to call Iterator.Error() to retrieve it. In all other circumstances,
    3075              : // internalNext returns internalNextExhausted, indicating that there are no more
    3076              : // additional internal keys with the user key Key().
    3077              : //
    3078              : // internalNext does not change the external position of the iterator, and a
    3079              : // Next operation should behave the same as if internalNext was never called.
    3080              : // internalNext does invalidate the iterator Value's memory, and the caller must
    3081              : // not rely on the memory safety of the previous Iterator position.
    3082            1 : func (i *Iterator) internalNext() (internalNextValidity, base.InternalKeyKind) {
    3083            1 :         i.stats.ForwardStepCount[InterfaceCall]++
    3084            1 :         if i.err != nil {
    3085            1 :                 return internalNextError, base.InternalKeyKindInvalid
    3086            1 :         } else if i.iterValidityState != IterValid {
    3087            1 :                 return internalNextExhausted, base.InternalKeyKindInvalid
    3088            1 :         }
    3089            1 :         i.lastPositioningOp = internalNextOp
    3090            1 : 
    3091            1 :         switch i.pos {
    3092            1 :         case iterPosCurForward:
    3093            1 :                 i.iterKV = i.iter.Next()
    3094            1 :                 if i.iterKV == nil {
    3095            1 :                         // We check i.iter.Error() here and return an internalNextError enum
    3096            1 :                         // variant so that the caller does not need to check i.iter.Error()
    3097            1 :                         // in the common case that the next internal key has a new user key.
    3098            1 :                         if i.err = i.iter.Error(); i.err != nil {
    3099            0 :                                 return internalNextError, base.InternalKeyKindInvalid
    3100            0 :                         }
    3101            1 :                         i.pos = iterPosNext
    3102            1 :                         return internalNextExhausted, base.InternalKeyKindInvalid
    3103            1 :                 } else if i.comparer.Equal(i.iterKV.K.UserKey, i.key) {
    3104            1 :                         return internalNextValid, i.iterKV.Kind()
    3105            1 :                 }
    3106            1 :                 i.pos = iterPosNext
    3107            1 :                 return internalNextExhausted, base.InternalKeyKindInvalid
    3108            1 :         case iterPosCurReverse, iterPosCurReversePaused, iterPosPrev:
    3109            1 :                 i.err = errors.New("switching from reverse to forward via internalNext is prohibited")
    3110            1 :                 i.iterValidityState = IterExhausted
    3111            1 :                 return internalNextError, base.InternalKeyKindInvalid
    3112            1 :         case iterPosNext, iterPosCurForwardPaused:
    3113            1 :                 // The previous method already moved onto the next user key. This is
    3114            1 :                 // only possible if
    3115            1 :                 //   - the last positioning method was a call to internalNext, and we
    3116            1 :                 //     advanced to a new user key.
    3117            1 :                 //   - the previous non-internalNext iterator operation encountered a
    3118            1 :                 //     range key or merge, forcing an internal Next that found a new
    3119            1 :                 //     user key that's not equal to i.Iterator.Key().
    3120            1 :                 return internalNextExhausted, base.InternalKeyKindInvalid
    3121            0 :         default:
    3122            0 :                 panic("unreachable")
    3123              :         }
    3124              : }
    3125              : 
    3126              : var _ base.IteratorDebug = (*Iterator)(nil)
    3127              : 
    3128              : // DebugTree implements the base.IteratorDebug interface.
    3129            0 : func (i *Iterator) DebugTree(tp treeprinter.Node) {
    3130            0 :         n := tp.Childf("%T(%p)", i, i)
    3131            0 :         if i.iter != nil {
    3132            0 :                 i.iter.DebugTree(n)
    3133            0 :         }
    3134            0 :         if i.pointIter != nil {
    3135            0 :                 i.pointIter.DebugTree(n)
    3136            0 :         }
    3137              : }
        

Generated by: LCOV version 2.0-1