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 : "fmt"
10 : "io"
11 : "regexp"
12 : "runtime"
13 : "slices"
14 : "sort"
15 : "strconv"
16 : "strings"
17 : "time"
18 : "unicode"
19 :
20 : "github.com/cockroachdb/crlib/fifo"
21 : "github.com/cockroachdb/errors"
22 : "github.com/cockroachdb/pebble/internal/base"
23 : "github.com/cockroachdb/pebble/internal/cache"
24 : "github.com/cockroachdb/pebble/internal/humanize"
25 : "github.com/cockroachdb/pebble/internal/keyspan"
26 : "github.com/cockroachdb/pebble/internal/manifest"
27 : "github.com/cockroachdb/pebble/internal/testkeys"
28 : "github.com/cockroachdb/pebble/objstorage/objstorageprovider"
29 : "github.com/cockroachdb/pebble/objstorage/remote"
30 : "github.com/cockroachdb/pebble/rangekey"
31 : "github.com/cockroachdb/pebble/sstable"
32 : "github.com/cockroachdb/pebble/sstable/blob"
33 : "github.com/cockroachdb/pebble/sstable/block"
34 : "github.com/cockroachdb/pebble/sstable/colblk"
35 : "github.com/cockroachdb/pebble/vfs"
36 : "github.com/cockroachdb/pebble/wal"
37 : "github.com/cockroachdb/redact"
38 : )
39 :
40 : const (
41 : cacheDefaultSize = 8 << 20 // 8 MB
42 : defaultLevelMultiplier = 10
43 : )
44 :
45 : // FilterType exports the base.FilterType type.
46 : type FilterType = base.FilterType
47 :
48 : // Exported TableFilter constants.
49 : const (
50 : TableFilter = base.TableFilter
51 : )
52 :
53 : // FilterWriter exports the base.FilterWriter type.
54 : type FilterWriter = base.FilterWriter
55 :
56 : // FilterPolicy exports the base.FilterPolicy type.
57 : type FilterPolicy = base.FilterPolicy
58 :
59 : var NoFilterPolicy = base.NoFilterPolicy
60 :
61 : // KeySchema exports the colblk.KeySchema type.
62 : type KeySchema = colblk.KeySchema
63 :
64 : // BlockPropertyCollector exports the sstable.BlockPropertyCollector type.
65 : type BlockPropertyCollector = sstable.BlockPropertyCollector
66 :
67 : // BlockPropertyFilter exports the sstable.BlockPropertyFilter type.
68 : type BlockPropertyFilter = base.BlockPropertyFilter
69 :
70 : // ShortAttributeExtractor exports the base.ShortAttributeExtractor type.
71 : type ShortAttributeExtractor = base.ShortAttributeExtractor
72 :
73 : // UserKeyPrefixBound exports the sstable.UserKeyPrefixBound type.
74 : type UserKeyPrefixBound = sstable.UserKeyPrefixBound
75 :
76 : // IterKeyType configures which types of keys an iterator should surface.
77 : type IterKeyType int8
78 :
79 : // DirLock represents a file lock on a directory. It may be passed to Open through
80 : // Options.Lock to elide lock aquisition during Open.
81 : type DirLock = base.DirLock
82 :
83 : // LockDirectory acquires the directory lock in the named directory, preventing
84 : // another process from opening the database. LockDirectory returns a
85 : // handle to the held lock that may be passed to Open, skipping lock acquisition
86 : // during Open.
87 : //
88 : // LockDirectory may be used to expand the critical section protected by the
89 : // database lock to include setup before the call to Open.
90 0 : func LockDirectory(dirname string, fs vfs.FS) (*DirLock, error) {
91 0 : return base.LockDirectory(dirname, fs)
92 0 : }
93 :
94 : const (
95 : // IterKeyTypePointsOnly configures an iterator to iterate over point keys
96 : // only.
97 : IterKeyTypePointsOnly IterKeyType = iota
98 : // IterKeyTypeRangesOnly configures an iterator to iterate over range keys
99 : // only.
100 : IterKeyTypeRangesOnly
101 : // IterKeyTypePointsAndRanges configures an iterator iterate over both point
102 : // keys and range keys simultaneously.
103 : IterKeyTypePointsAndRanges
104 : )
105 :
106 : // String implements fmt.Stringer.
107 0 : func (t IterKeyType) String() string {
108 0 : switch t {
109 0 : case IterKeyTypePointsOnly:
110 0 : return "points-only"
111 0 : case IterKeyTypeRangesOnly:
112 0 : return "ranges-only"
113 0 : case IterKeyTypePointsAndRanges:
114 0 : return "points-and-ranges"
115 0 : default:
116 0 : panic(fmt.Sprintf("unknown key type %d", t))
117 : }
118 : }
119 :
120 : // IterOptions hold the optional per-query parameters for NewIter.
121 : //
122 : // Like Options, a nil *IterOptions is valid and means to use the default
123 : // values.
124 : type IterOptions struct {
125 : // LowerBound specifies the smallest key (inclusive) that the iterator will
126 : // return during iteration. If the iterator is seeked or iterated past this
127 : // boundary the iterator will return Valid()==false. Setting LowerBound
128 : // effectively truncates the key space visible to the iterator.
129 : LowerBound []byte
130 : // UpperBound specifies the largest key (exclusive) that the iterator will
131 : // return during iteration. If the iterator is seeked or iterated past this
132 : // boundary the iterator will return Valid()==false. Setting UpperBound
133 : // effectively truncates the key space visible to the iterator.
134 : UpperBound []byte
135 : // SkipPoint may be used to skip over point keys that don't match an
136 : // arbitrary predicate during iteration. If set, the Iterator invokes
137 : // SkipPoint for keys encountered. If SkipPoint returns true, the iterator
138 : // will skip the key without yielding it to the iterator operation in
139 : // progress.
140 : //
141 : // SkipPoint must be a pure function and always return the same result when
142 : // provided the same arguments. The iterator may call SkipPoint multiple
143 : // times for the same user key.
144 : SkipPoint func(userKey []byte) bool
145 : // PointKeyFilters can be used to avoid scanning tables and blocks in tables
146 : // when iterating over point keys. This slice represents an intersection
147 : // across all filters, i.e., all filters must indicate that the block is
148 : // relevant.
149 : //
150 : // Performance note: When len(PointKeyFilters) > 0, the caller should ensure
151 : // that cap(PointKeyFilters) is at least len(PointKeyFilters)+1. This helps
152 : // avoid allocations in Pebble internal code that mutates the slice.
153 : PointKeyFilters []BlockPropertyFilter
154 : // RangeKeyFilters can be usefd to avoid scanning tables and blocks in tables
155 : // when iterating over range keys. The same requirements that apply to
156 : // PointKeyFilters apply here too.
157 : RangeKeyFilters []BlockPropertyFilter
158 : // KeyTypes configures which types of keys to iterate over: point keys,
159 : // range keys, or both.
160 : KeyTypes IterKeyType
161 : // RangeKeyMasking can be used to enable automatic masking of point keys by
162 : // range keys. Range key masking is only supported during combined range key
163 : // and point key iteration mode (IterKeyTypePointsAndRanges).
164 : RangeKeyMasking RangeKeyMasking
165 :
166 : // OnlyReadGuaranteedDurable is an advanced option that is only supported by
167 : // the Reader implemented by DB. When set to true, only the guaranteed to be
168 : // durable state is visible in the iterator.
169 : // - This definition is made under the assumption that the FS implementation
170 : // is providing a durability guarantee when data is synced.
171 : // - The visible state represents a consistent point in the history of the
172 : // DB.
173 : // - The implementation is free to choose a conservative definition of what
174 : // is guaranteed durable. For simplicity, the current implementation
175 : // ignores memtables. A more sophisticated implementation could track the
176 : // highest seqnum that is synced to the WAL and published and use that as
177 : // the visible seqnum for an iterator. Note that the latter approach is
178 : // not strictly better than the former since we can have DBs that are (a)
179 : // synced more rarely than memtable flushes, (b) have no WAL. (a) is
180 : // likely to be true in a future CockroachDB context where the DB
181 : // containing the state machine may be rarely synced.
182 : // NB: this current implementation relies on the fact that memtables are
183 : // flushed in seqnum order, and any ingested sstables that happen to have a
184 : // lower seqnum than a non-flushed memtable don't have any overlapping keys.
185 : // This is the fundamental level invariant used in other code too, like when
186 : // merging iterators.
187 : //
188 : // Semantically, using this option provides the caller a "snapshot" as of
189 : // the time the most recent memtable was flushed. An alternate interface
190 : // would be to add a NewSnapshot variant. Creating a snapshot is heavier
191 : // weight than creating an iterator, so we have opted to support this
192 : // iterator option.
193 : OnlyReadGuaranteedDurable bool
194 : // UseL6Filters allows the caller to opt into reading filter blocks for L6
195 : // sstables. Helpful if a lot of SeekPrefixGEs are expected in quick
196 : // succession, that are also likely to not yield a single key. Filter blocks in
197 : // L6 can be relatively large, often larger than data blocks, so the benefit of
198 : // loading them in the cache is minimized if the probability of the key
199 : // existing is not low or if we just expect a one-time Seek (where loading the
200 : // data block directly is better).
201 : UseL6Filters bool
202 : // Category is used for categorized iterator stats. This should not be
203 : // changed by calling SetOptions.
204 : Category block.Category
205 :
206 : DebugRangeKeyStack bool
207 :
208 : // Internal options.
209 :
210 : logger Logger
211 : // Layer corresponding to this file. Only passed in if constructed by a
212 : // levelIter.
213 : layer manifest.Layer
214 : // disableLazyCombinedIteration is an internal testing option.
215 : disableLazyCombinedIteration bool
216 : // snapshotForHideObsoletePoints is specified for/by levelIter when opening
217 : // files and is used to decide whether to hide obsolete points. A value of 0
218 : // implies obsolete points should not be hidden.
219 : snapshotForHideObsoletePoints base.SeqNum
220 :
221 : // NB: If adding new Options, you must account for them in iterator
222 : // construction and Iterator.SetOptions.
223 : }
224 :
225 : // GetLowerBound returns the LowerBound or nil if the receiver is nil.
226 1 : func (o *IterOptions) GetLowerBound() []byte {
227 1 : if o == nil {
228 1 : return nil
229 1 : }
230 1 : return o.LowerBound
231 : }
232 :
233 : // GetUpperBound returns the UpperBound or nil if the receiver is nil.
234 1 : func (o *IterOptions) GetUpperBound() []byte {
235 1 : if o == nil {
236 1 : return nil
237 1 : }
238 1 : return o.UpperBound
239 : }
240 :
241 1 : func (o *IterOptions) pointKeys() bool {
242 1 : if o == nil {
243 0 : return true
244 0 : }
245 1 : return o.KeyTypes == IterKeyTypePointsOnly || o.KeyTypes == IterKeyTypePointsAndRanges
246 : }
247 :
248 1 : func (o *IterOptions) rangeKeys() bool {
249 1 : if o == nil {
250 0 : return false
251 0 : }
252 1 : return o.KeyTypes == IterKeyTypeRangesOnly || o.KeyTypes == IterKeyTypePointsAndRanges
253 : }
254 :
255 1 : func (o *IterOptions) getLogger() Logger {
256 1 : if o == nil || o.logger == nil {
257 1 : return DefaultLogger
258 1 : }
259 1 : return o.logger
260 : }
261 :
262 : // SpanIterOptions creates a SpanIterOptions from this IterOptions.
263 1 : func (o *IterOptions) SpanIterOptions() keyspan.SpanIterOptions {
264 1 : if o == nil {
265 1 : return keyspan.SpanIterOptions{}
266 1 : }
267 1 : return keyspan.SpanIterOptions{
268 1 : RangeKeyFilters: o.RangeKeyFilters,
269 1 : }
270 : }
271 :
272 : // scanInternalOptions is similar to IterOptions, meant for use with
273 : // scanInternalIterator.
274 : type scanInternalOptions struct {
275 : IterOptions
276 :
277 : category block.Category
278 :
279 : visitPointKey func(key *InternalKey, value LazyValue, iterInfo IteratorLevel) error
280 : visitRangeDel func(start, end []byte, seqNum SeqNum) error
281 : visitRangeKey func(start, end []byte, keys []rangekey.Key) error
282 : visitSharedFile func(sst *SharedSSTMeta) error
283 : visitExternalFile func(sst *ExternalFile) error
284 :
285 : // includeObsoleteKeys specifies whether keys shadowed by newer internal keys
286 : // are exposed. If false, only one internal key per user key is exposed.
287 : includeObsoleteKeys bool
288 :
289 : // rateLimitFunc is used to limit the amount of bytes read per second.
290 : rateLimitFunc func(key *InternalKey, value LazyValue) error
291 : }
292 :
293 : // RangeKeyMasking configures automatic hiding of point keys by range keys. A
294 : // non-nil Suffix enables range-key masking. When enabled, range keys with
295 : // suffixes ≥ Suffix behave as masks. All point keys that are contained within a
296 : // masking range key's bounds and have suffixes greater than the range key's
297 : // suffix are automatically skipped.
298 : //
299 : // Specifically, when configured with a RangeKeyMasking.Suffix _s_, and there
300 : // exists a range key with suffix _r_ covering a point key with suffix _p_, and
301 : //
302 : // _s_ ≤ _r_ < _p_
303 : //
304 : // then the point key is elided.
305 : //
306 : // Range-key masking may only be used when iterating over both point keys and
307 : // range keys with IterKeyTypePointsAndRanges.
308 : type RangeKeyMasking struct {
309 : // Suffix configures which range keys may mask point keys. Only range keys
310 : // that are defined at suffixes greater than or equal to Suffix will mask
311 : // point keys.
312 : Suffix []byte
313 : // Filter is an optional field that may be used to improve performance of
314 : // range-key masking through a block-property filter defined over key
315 : // suffixes. If non-nil, Filter is called by Pebble to construct a
316 : // block-property filter mask at iterator creation. The filter is used to
317 : // skip whole point-key blocks containing point keys with suffixes greater
318 : // than a covering range-key's suffix.
319 : //
320 : // To use this functionality, the caller must create and configure (through
321 : // Options.BlockPropertyCollectors) a block-property collector that records
322 : // the maxmimum suffix contained within a block. The caller then must write
323 : // and provide a BlockPropertyFilterMask implementation on that same
324 : // property. See the BlockPropertyFilterMask type for more information.
325 : Filter func() BlockPropertyFilterMask
326 : }
327 :
328 : // BlockPropertyFilterMask extends the BlockPropertyFilter interface for use
329 : // with range-key masking. Unlike an ordinary block property filter, a
330 : // BlockPropertyFilterMask's filtering criteria is allowed to change when Pebble
331 : // invokes its SetSuffix method.
332 : //
333 : // When a Pebble iterator steps into a range key's bounds and the range key has
334 : // a suffix greater than or equal to RangeKeyMasking.Suffix, the range key acts
335 : // as a mask. The masking range key hides all point keys that fall within the
336 : // range key's bounds and have suffixes > the range key's suffix. Without a
337 : // filter mask configured, Pebble performs this hiding by stepping through point
338 : // keys and comparing suffixes. If large numbers of point keys are masked, this
339 : // requires Pebble to load, iterate through and discard a large number of
340 : // sstable blocks containing masked point keys.
341 : //
342 : // If a block-property collector and a filter mask are configured, Pebble may
343 : // skip loading some point-key blocks altogether. If a block's keys are known to
344 : // all fall within the bounds of the masking range key and the block was
345 : // annotated by a block-property collector with the maximal suffix, Pebble can
346 : // ask the filter mask to compare the property to the current masking range
347 : // key's suffix. If the mask reports no intersection, the block may be skipped.
348 : //
349 : // If unsuffixed and suffixed keys are written to the database, care must be
350 : // taken to avoid unintentionally masking un-suffixed keys located in the same
351 : // block as suffixed keys. One solution is to interpret unsuffixed keys as
352 : // containing the maximal suffix value, ensuring that blocks containing
353 : // unsuffixed keys are always loaded.
354 : type BlockPropertyFilterMask interface {
355 : BlockPropertyFilter
356 :
357 : // SetSuffix configures the mask with the suffix of a range key. The filter
358 : // should return false from Intersects whenever it's provided with a
359 : // property encoding a block's minimum suffix that's greater (according to
360 : // Compare) than the provided suffix.
361 : SetSuffix(suffix []byte) error
362 : }
363 :
364 : // WriteOptions hold the optional per-query parameters for Set and Delete
365 : // operations.
366 : //
367 : // Like Options, a nil *WriteOptions is valid and means to use the default
368 : // values.
369 : type WriteOptions struct {
370 : // Sync is whether to sync writes through the OS buffer cache and down onto
371 : // the actual disk, if applicable. Setting Sync is required for durability of
372 : // individual write operations but can result in slower writes.
373 : //
374 : // If false, and the process or machine crashes, then a recent write may be
375 : // lost. This is due to the recently written data being buffered inside the
376 : // process running Pebble. This differs from the semantics of a write system
377 : // call in which the data is buffered in the OS buffer cache and would thus
378 : // survive a process crash.
379 : //
380 : // The default value is true.
381 : Sync bool
382 : }
383 :
384 : // Sync specifies the default write options for writes which synchronize to
385 : // disk.
386 : var Sync = &WriteOptions{Sync: true}
387 :
388 : // NoSync specifies the default write options for writes which do not
389 : // synchronize to disk.
390 : var NoSync = &WriteOptions{Sync: false}
391 :
392 : // GetSync returns the Sync value or true if the receiver is nil.
393 1 : func (o *WriteOptions) GetSync() bool {
394 1 : return o == nil || o.Sync
395 1 : }
396 :
397 : // LevelOptions holds the optional per-level parameters.
398 : type LevelOptions struct {
399 : // BlockRestartInterval is the number of keys between restart points
400 : // for delta encoding of keys.
401 : //
402 : // The default value is 16 for L0, and the value from the previous level for
403 : // all other levels.
404 : BlockRestartInterval int
405 :
406 : // BlockSize is the target uncompressed size in bytes of each table block.
407 : //
408 : // The default value is 4096 for L0, and the value from the previous level for
409 : // all other levels.
410 : BlockSize int
411 :
412 : // BlockSizeThreshold finishes a block if the block size is larger than the
413 : // specified percentage of the target block size and adding the next entry
414 : // would cause the block to be larger than the target block size.
415 : //
416 : // The default value is 90 for L0, and the value from the previous level for
417 : // all other levels.
418 : BlockSizeThreshold int
419 :
420 : // Compression defines the per-block compression to use.
421 : //
422 : // The default value is Snappy for L0, or the function from the previous level
423 : // for all other levels.
424 : //
425 : // ApplyCompressionSettings can be used to initialize this field for all levels.
426 : Compression func() *sstable.CompressionProfile
427 :
428 : // FilterPolicy defines a filter algorithm (such as a Bloom filter) that can
429 : // reduce disk reads for Get calls.
430 : //
431 : // One such implementation is bloom.FilterPolicy(10) from the pebble/bloom
432 : // package.
433 : //
434 : // The default value for L0 is NoFilterPolicy (no filter), and the value from
435 : // the previous level for all other levels.
436 : FilterPolicy FilterPolicy
437 :
438 : // FilterType is a legacy field. The default and only possible value is
439 : // TableFilter.
440 : FilterType FilterType
441 :
442 : // IndexBlockSize is the target uncompressed size in bytes of each index
443 : // block. When the index block size is larger than this target, two-level
444 : // indexes are automatically enabled. Setting this option to a large value
445 : // (such as math.MaxInt32) disables the automatic creation of two-level
446 : // indexes.
447 : //
448 : // The default value is the value of BlockSize for L0, or the value from the
449 : // previous level for all other levels.
450 : IndexBlockSize int
451 : }
452 :
453 : // EnsureL0Defaults ensures that the L0 default values for the options have been
454 : // initialized.
455 1 : func (o *LevelOptions) EnsureL0Defaults() {
456 1 : if o.BlockRestartInterval <= 0 {
457 0 : o.BlockRestartInterval = base.DefaultBlockRestartInterval
458 0 : }
459 1 : if o.BlockSize <= 0 {
460 0 : o.BlockSize = base.DefaultBlockSize
461 1 : } else if o.BlockSize > sstable.MaximumRestartOffset {
462 0 : panic(errors.Errorf("BlockSize %d exceeds MaximumRestartOffset", o.BlockSize))
463 : }
464 1 : if o.BlockSizeThreshold <= 0 {
465 0 : o.BlockSizeThreshold = base.DefaultBlockSizeThreshold
466 0 : }
467 1 : if o.Compression == nil {
468 0 : o.Compression = func() *sstable.CompressionProfile { return sstable.SnappyCompression }
469 : }
470 1 : if o.FilterPolicy == nil {
471 0 : o.FilterPolicy = NoFilterPolicy
472 0 : }
473 1 : if o.IndexBlockSize <= 0 {
474 0 : o.IndexBlockSize = o.BlockSize
475 0 : }
476 : }
477 :
478 : // EnsureL1PlusDefaults ensures that the L1+ default values for the options have
479 : // been initialized. Requires the fully initialized options for the level above.
480 1 : func (o *LevelOptions) EnsureL1PlusDefaults(previousLevel *LevelOptions) {
481 1 : if o.BlockRestartInterval <= 0 {
482 0 : o.BlockRestartInterval = previousLevel.BlockRestartInterval
483 0 : }
484 1 : if o.BlockSize <= 0 {
485 0 : o.BlockSize = previousLevel.BlockSize
486 1 : } else if o.BlockSize > sstable.MaximumRestartOffset {
487 0 : panic(errors.Errorf("BlockSize %d exceeds MaximumRestartOffset", o.BlockSize))
488 : }
489 1 : if o.BlockSizeThreshold <= 0 {
490 0 : o.BlockSizeThreshold = previousLevel.BlockSizeThreshold
491 0 : }
492 1 : if o.Compression == nil {
493 0 : o.Compression = previousLevel.Compression
494 0 : }
495 1 : if o.FilterPolicy == nil {
496 0 : o.FilterPolicy = previousLevel.FilterPolicy
497 0 : }
498 1 : if o.IndexBlockSize <= 0 {
499 0 : o.IndexBlockSize = previousLevel.IndexBlockSize
500 0 : }
501 : }
502 :
503 : // Options holds the optional parameters for configuring pebble. These options
504 : // apply to the DB at large; per-query options are defined by the IterOptions
505 : // and WriteOptions types.
506 : type Options struct {
507 : // Sync sstables periodically in order to smooth out writes to disk. This
508 : // option does not provide any persistency guarantee, but is used to avoid
509 : // latency spikes if the OS automatically decides to write out a large chunk
510 : // of dirty filesystem buffers. This option only controls SSTable syncs; WAL
511 : // syncs are controlled by WALBytesPerSync.
512 : //
513 : // The default value is 512KB.
514 : BytesPerSync int
515 :
516 : // Cache is used to cache uncompressed blocks from sstables. If it is nil,
517 : // a block cache of CacheSize will be created for each DB.
518 : Cache *cache.Cache
519 : // CacheSize is used when Cache is not set. The default value is 8 MB.
520 : CacheSize int64
521 :
522 : // LoadBlockSema, if set, is used to limit the number of blocks that can be
523 : // loaded (i.e. read from the filesystem) in parallel. Each load acquires one
524 : // unit from the semaphore for the duration of the read.
525 : LoadBlockSema *fifo.Semaphore
526 :
527 : // Cleaner cleans obsolete files.
528 : //
529 : // The default cleaner uses the DeleteCleaner.
530 : Cleaner Cleaner
531 :
532 : // Local contains option that pertain to files stored on the local filesystem.
533 : Local struct {
534 : // ReadaheadConfig is used to retrieve the current readahead mode; it is
535 : // consulted whenever a read handle is initialized.
536 : ReadaheadConfig *ReadaheadConfig
537 :
538 : // TODO(radu): move BytesPerSync, LoadBlockSema, Cleaner here.
539 : }
540 :
541 : // Comparer defines a total ordering over the space of []byte keys: a 'less
542 : // than' relationship. The same comparison algorithm must be used for reads
543 : // and writes over the lifetime of the DB.
544 : //
545 : // The default value uses the same ordering as bytes.Compare.
546 : Comparer *Comparer
547 :
548 : // DebugCheck is invoked, if non-nil, whenever a new version is being
549 : // installed. Typically, this is set to pebble.DebugCheckLevels in tests
550 : // or tools only, to check invariants over all the data in the database.
551 : DebugCheck func(*DB) error
552 :
553 : // Disable the write-ahead log (WAL). Disabling the write-ahead log prohibits
554 : // crash recovery, but can improve performance if crash recovery is not
555 : // needed (e.g. when only temporary state is being stored in the database).
556 : //
557 : // TODO(peter): untested
558 : DisableWAL bool
559 :
560 : // ErrorIfExists causes an error on Open if the database already exists.
561 : // The error can be checked with errors.Is(err, ErrDBAlreadyExists).
562 : //
563 : // The default value is false.
564 : ErrorIfExists bool
565 :
566 : // ErrorIfNotExists causes an error on Open if the database does not already
567 : // exist. The error can be checked with errors.Is(err, ErrDBDoesNotExist).
568 : //
569 : // The default value is false which will cause a database to be created if it
570 : // does not already exist.
571 : ErrorIfNotExists bool
572 :
573 : // ErrorIfNotPristine causes an error on Open if the database already exists
574 : // and any operations have been performed on the database. The error can be
575 : // checked with errors.Is(err, ErrDBNotPristine).
576 : //
577 : // Note that a database that contained keys that were all subsequently deleted
578 : // may or may not trigger the error. Currently, we check if there are any live
579 : // SSTs or log records to replay.
580 : ErrorIfNotPristine bool
581 :
582 : // EventListener provides hooks to listening to significant DB events such as
583 : // flushes, compactions, and table deletion.
584 : EventListener *EventListener
585 :
586 : // Experimental contains experimental options which are off by default.
587 : // These options are temporary and will eventually either be deleted, moved
588 : // out of the experimental group, or made the non-adjustable default. These
589 : // options may change at any time, so do not rely on them.
590 : Experimental struct {
591 : // The threshold of L0 read-amplification at which compaction concurrency
592 : // is enabled (if CompactionDebtConcurrency was not already exceeded).
593 : // Every multiple of this value enables another concurrent
594 : // compaction up to CompactionConcurrencyRange.
595 : L0CompactionConcurrency int
596 :
597 : // CompactionDebtConcurrency controls the threshold of compaction debt
598 : // at which additional compaction concurrency slots are added. For every
599 : // multiple of this value in compaction debt bytes, an additional
600 : // concurrent compaction is added. This works "on top" of
601 : // L0CompactionConcurrency, so the higher of the count of compaction
602 : // concurrency slots as determined by the two options is chosen.
603 : CompactionDebtConcurrency uint64
604 :
605 : // CompactionGarbageFractionForMaxConcurrency is the fraction of garbage
606 : // due to DELs and RANGEDELs that causes MaxConcurrentCompactions to be
607 : // allowed. Concurrent compactions are allowed in a linear manner upto
608 : // this limit being reached. A value <= 0.0 disables adding concurrency
609 : // due to garbage.
610 : CompactionGarbageFractionForMaxConcurrency func() float64
611 :
612 : // IngestSplit, if it returns true, allows for ingest-time splitting of
613 : // existing sstables into two virtual sstables to allow ingestion sstables to
614 : // slot into a lower level than they otherwise would have.
615 : IngestSplit func() bool
616 :
617 : // ReadCompactionRate controls the frequency of read triggered
618 : // compactions by adjusting `AllowedSeeks` in manifest.TableMetadata:
619 : //
620 : // AllowedSeeks = FileSize / ReadCompactionRate
621 : //
622 : // From LevelDB:
623 : // ```
624 : // We arrange to automatically compact this file after
625 : // a certain number of seeks. Let's assume:
626 : // (1) One seek costs 10ms
627 : // (2) Writing or reading 1MB costs 10ms (100MB/s)
628 : // (3) A compaction of 1MB does 25MB of IO:
629 : // 1MB read from this level
630 : // 10-12MB read from next level (boundaries may be misaligned)
631 : // 10-12MB written to next level
632 : // This implies that 25 seeks cost the same as the compaction
633 : // of 1MB of data. I.e., one seek costs approximately the
634 : // same as the compaction of 40KB of data. We are a little
635 : // conservative and allow approximately one seek for every 16KB
636 : // of data before triggering a compaction.
637 : // ```
638 : ReadCompactionRate int64
639 :
640 : // ReadSamplingMultiplier is a multiplier for the readSamplingPeriod in
641 : // iterator.maybeSampleRead() to control the frequency of read sampling
642 : // to trigger a read triggered compaction. A value of -1 prevents sampling
643 : // and disables read triggered compactions. The default is 1 << 4. which
644 : // gets multiplied with a constant of 1 << 16 to yield 1 << 20 (1MB).
645 : ReadSamplingMultiplier int64
646 :
647 : // NumDeletionsThreshold defines the minimum number of point tombstones
648 : // that must be present in a single data block for that block to be
649 : // considered tombstone-dense for the purposes of triggering a
650 : // tombstone density compaction. Data blocks may also be considered
651 : // tombstone-dense if they meet the criteria defined by
652 : // DeletionSizeRatioThreshold below. Tombstone-dense blocks are identified
653 : // when sstables are written, and so this is effectively an option for
654 : // sstable writers. The default value is 100.
655 : NumDeletionsThreshold int
656 :
657 : // DeletionSizeRatioThreshold defines the minimum ratio of the size of
658 : // point tombstones to the size of a data block that must be reached
659 : // for that block to be considered tombstone-dense for the purposes of
660 : // triggering a tombstone density compaction. Data blocks may also be
661 : // considered tombstone-dense if they meet the criteria defined by
662 : // NumDeletionsThreshold above. Tombstone-dense blocks are identified
663 : // when sstables are written, and so this is effectively an option for
664 : // sstable writers. The default value is 0.5.
665 : DeletionSizeRatioThreshold float32
666 :
667 : // TombstoneDenseCompactionThreshold is the minimum percent of data
668 : // blocks in a table that must be tombstone-dense for that table to be
669 : // eligible for a tombstone density compaction. It should be defined as a
670 : // ratio out of 1. The default value is 0.10.
671 : //
672 : // If multiple tables are eligible for a tombstone density compaction, then
673 : // tables with a higher percent of tombstone-dense blocks are still
674 : // prioritized for compaction.
675 : //
676 : // A zero or negative value disables tombstone density compactions.
677 : TombstoneDenseCompactionThreshold float64
678 :
679 : // FileCacheShards is the number of shards per file cache.
680 : // Reducing the value can reduce the number of idle goroutines per DB
681 : // instance which can be useful in scenarios with a lot of DB instances
682 : // and a large number of CPUs, but doing so can lead to higher contention
683 : // in the file cache and reduced performance.
684 : //
685 : // The default value is the number of logical CPUs, which can be
686 : // limited by runtime.GOMAXPROCS.
687 : FileCacheShards int
688 :
689 : // ValidateOnIngest schedules validation of sstables after they have
690 : // been ingested.
691 : //
692 : // By default, this value is false.
693 : ValidateOnIngest bool
694 :
695 : // LevelMultiplier configures the size multiplier used to determine the
696 : // desired size of each level of the LSM. Defaults to 10.
697 : LevelMultiplier int
698 :
699 : // MultiLevelCompactionHeuristic determines whether to add an additional
700 : // level to a conventional two level compaction.
701 : MultiLevelCompactionHeuristic func() MultiLevelHeuristic
702 :
703 : // EnableColumnarBlocks is used to decide whether to enable writing
704 : // TableFormatPebblev5 sstables. This setting is only respected by
705 : // FormatColumnarBlocks. In lower format major versions, the
706 : // TableFormatPebblev5 format is prohibited. If EnableColumnarBlocks is
707 : // nil and the DB is at FormatColumnarBlocks, the DB defaults to not
708 : // writing columnar blocks.
709 : EnableColumnarBlocks func() bool
710 :
711 : // EnableValueBlocks is used to decide whether to enable writing
712 : // TableFormatPebblev3 sstables. This setting is only respected by a
713 : // specific subset of format major versions: FormatSSTableValueBlocks,
714 : // FormatFlushableIngest and FormatPrePebblev1MarkedCompacted. In lower
715 : // format major versions, value blocks are never enabled. In higher
716 : // format major versions, value blocks are always enabled.
717 : EnableValueBlocks func() bool
718 :
719 : // ShortAttributeExtractor is used iff EnableValueBlocks() returns true
720 : // (else ignored). If non-nil, a ShortAttribute can be extracted from the
721 : // value and stored with the key, when the value is stored elsewhere.
722 : ShortAttributeExtractor ShortAttributeExtractor
723 :
724 : // DisableIngestAsFlushable disables lazy ingestion of sstables through
725 : // a WAL write and memtable rotation. Only effectual if the format
726 : // major version is at least `FormatFlushableIngest`.
727 : DisableIngestAsFlushable func() bool
728 :
729 : // RemoteStorage enables use of remote storage (e.g. S3) for storing
730 : // sstables. Setting this option enables use of CreateOnShared option and
731 : // allows ingestion of external files.
732 : RemoteStorage remote.StorageFactory
733 :
734 : // If CreateOnShared is non-zero, new sstables are created on remote storage
735 : // (using CreateOnSharedLocator and with the appropriate
736 : // CreateOnSharedStrategy). These sstables can be shared between different
737 : // Pebble instances; the lifecycle of such objects is managed by the
738 : // remote.Storage constructed by options.RemoteStorage.
739 : //
740 : // Can only be used when RemoteStorage is set (and recognizes
741 : // CreateOnSharedLocator).
742 : CreateOnShared remote.CreateOnSharedStrategy
743 : CreateOnSharedLocator remote.Locator
744 :
745 : // CacheSizeBytesBytes is the size of the on-disk block cache for objects
746 : // on shared storage in bytes. If it is 0, no cache is used.
747 : SecondaryCacheSizeBytes int64
748 :
749 : // EnableDeleteOnlyCompactionExcises enables delete-only compactions to also
750 : // apply delete-only compaction hints on sstables that partially overlap
751 : // with it. This application happens through an excise, similar to
752 : // the excise phase of IngestAndExcise.
753 : EnableDeleteOnlyCompactionExcises func() bool
754 :
755 : // CompactionScheduler, if set, is used to limit concurrent compactions as
756 : // well as to pace compactions already chosen. If nil, a default scheduler
757 : // is created and used.
758 : CompactionScheduler CompactionScheduler
759 :
760 : UserKeyCategories UserKeyCategories
761 :
762 : // ValueSeparationPolicy controls the policy for separating values into
763 : // external blob files. If nil, value separation defaults to disabled.
764 : // The value separation policy is ignored if EnableColumnarBlocks() is
765 : // false.
766 : ValueSeparationPolicy func() ValueSeparationPolicy
767 :
768 : // SpanPolicyFunc is used to determine the SpanPolicy for a key region.
769 : SpanPolicyFunc SpanPolicyFunc
770 : }
771 :
772 : // Filters is a map from filter policy name to filter policy. It is used for
773 : // debugging tools which may be used on multiple databases configured with
774 : // different filter policies. It is not necessary to populate this filters
775 : // map during normal usage of a DB (it will be done automatically by
776 : // EnsureDefaults).
777 : Filters map[string]FilterPolicy
778 :
779 : // FlushDelayDeleteRange configures how long the database should wait before
780 : // forcing a flush of a memtable that contains a range deletion. Disk space
781 : // cannot be reclaimed until the range deletion is flushed. No automatic
782 : // flush occurs if zero.
783 : FlushDelayDeleteRange time.Duration
784 :
785 : // FlushDelayRangeKey configures how long the database should wait before
786 : // forcing a flush of a memtable that contains a range key. Range keys in
787 : // the memtable prevent lazy combined iteration, so it's desirable to flush
788 : // range keys promptly. No automatic flush occurs if zero.
789 : FlushDelayRangeKey time.Duration
790 :
791 : // FlushSplitBytes denotes the target number of bytes per sublevel in
792 : // each flush split interval (i.e. range between two flush split keys)
793 : // in L0 sstables. When set to zero, only a single sstable is generated
794 : // by each flush. When set to a non-zero value, flushes are split at
795 : // points to meet L0's TargetFileSize, any grandparent-related overlap
796 : // options, and at boundary keys of L0 flush split intervals (which are
797 : // targeted to contain around FlushSplitBytes bytes in each sublevel
798 : // between pairs of boundary keys). Splitting sstables during flush
799 : // allows increased compaction flexibility and concurrency when those
800 : // tables are compacted to lower levels.
801 : FlushSplitBytes int64
802 :
803 : // FormatMajorVersion sets the format of on-disk files. It is
804 : // recommended to set the format major version to an explicit
805 : // version, as the default may change over time.
806 : //
807 : // At Open if the existing database is formatted using a later
808 : // format major version that is known to this version of Pebble,
809 : // Pebble will continue to use the later format major version. If
810 : // the existing database's version is unknown, the caller may use
811 : // FormatMostCompatible and will be able to open the database
812 : // regardless of its actual version.
813 : //
814 : // If the existing database is formatted using a format major
815 : // version earlier than the one specified, Open will automatically
816 : // ratchet the database to the specified format major version.
817 : FormatMajorVersion FormatMajorVersion
818 :
819 : // FS provides the interface for persistent file storage.
820 : //
821 : // The default value uses the underlying operating system's file system.
822 : FS vfs.FS
823 :
824 : // KeySchema is the name of the key schema that should be used when writing
825 : // new sstables. There must be a key schema with this name defined in
826 : // KeySchemas. If not set, colblk.DefaultKeySchema is used to construct a
827 : // default key schema.
828 : KeySchema string
829 :
830 : // KeySchemas defines the set of known schemas of user keys. When columnar
831 : // blocks are in use (see FormatColumnarBlocks), the user may specify how a
832 : // key should be decomposed into columns. Each KeySchema must have a unique
833 : // name. The schema named by Options.KeySchema is used while writing
834 : // sstables during flushes and compactions.
835 : //
836 : // Multiple KeySchemas may be used over the lifetime of a database. Once a
837 : // KeySchema is used, it must be provided in KeySchemas in subsequent calls
838 : // to Open for perpetuity.
839 : KeySchemas sstable.KeySchemas
840 :
841 : // Lock, if set, must be a database lock acquired through LockDirectory for
842 : // the same directory passed to Open. If provided, Open will skip locking
843 : // the directory. Closing the database will not release the lock, and it's
844 : // the responsibility of the caller to release the lock after closing the
845 : // database.
846 : //
847 : // Open will enforce that the Lock passed locks the same directory passed to
848 : // Open. Concurrent calls to Open using the same Lock are detected and
849 : // prohibited.
850 : Lock *base.DirLock
851 :
852 : // The count of L0 files necessary to trigger an L0 compaction.
853 : L0CompactionFileThreshold int
854 :
855 : // The amount of L0 read-amplification necessary to trigger an L0 compaction.
856 : L0CompactionThreshold int
857 :
858 : // Hard limit on L0 read-amplification, computed as the number of L0
859 : // sublevels. Writes are stopped when this threshold is reached.
860 : L0StopWritesThreshold int
861 :
862 : // The maximum number of bytes for LBase. The base level is the level which
863 : // L0 is compacted into. The base level is determined dynamically based on
864 : // the existing data in the LSM. The maximum number of bytes for other levels
865 : // is computed dynamically based on the base level's maximum size. When the
866 : // maximum number of bytes for a level is exceeded, compaction is requested.
867 : LBaseMaxBytes int64
868 :
869 : // TargetFileSizes contains the target file size for each level, ignoring
870 : // unpopulated levels. Specifically:
871 : // - TargetFileSizes[0] is the target file size for L0;
872 : // - TargetFileSizes[1] is the target file size for Lbase;
873 : // - TargetFileSizes[2] is the target file size for Lbase+1;
874 : // and so on.
875 : //
876 : // The default value for TargetFileSizes[0] is 2MB.
877 : // The default value for TargetFileSizes[i] is TargetFileSizes[i-1] * 2.
878 : TargetFileSizes [manifest.NumLevels]int64
879 :
880 : // Per-level options. Levels[i] contains the options for Li (regardless of
881 : // what Lbase is).
882 : Levels [manifest.NumLevels]LevelOptions
883 :
884 : // LoggerAndTracer will be used, if non-nil, else Logger will be used and
885 : // tracing will be a noop.
886 :
887 : // Logger used to write log messages.
888 : //
889 : // The default logger uses the Go standard library log package.
890 : Logger Logger
891 : // LoggerAndTracer is used for writing log messages and traces.
892 : LoggerAndTracer LoggerAndTracer
893 :
894 : // MaxManifestFileSize is the maximum size the MANIFEST file is allowed to
895 : // become. When the MANIFEST exceeds this size it is rolled over and a new
896 : // MANIFEST is created.
897 : MaxManifestFileSize int64
898 :
899 : // MaxOpenFiles is a soft limit on the number of open files that can be
900 : // used by the DB.
901 : //
902 : // The default value is 1000.
903 : MaxOpenFiles int
904 :
905 : // The size of a MemTable in steady state. The actual MemTable size starts at
906 : // min(256KB, MemTableSize) and doubles for each subsequent MemTable up to
907 : // MemTableSize. This reduces the memory pressure caused by MemTables for
908 : // short lived (test) DB instances. Note that more than one MemTable can be
909 : // in existence since flushing a MemTable involves creating a new one and
910 : // writing the contents of the old one in the
911 : // background. MemTableStopWritesThreshold places a hard limit on the size of
912 : // the queued MemTables.
913 : //
914 : // The default value is 4MB.
915 : MemTableSize uint64
916 :
917 : // Hard limit on the number of queued of MemTables. Writes are stopped when
918 : // the sum of the queued memtable sizes exceeds:
919 : // MemTableStopWritesThreshold * MemTableSize.
920 : //
921 : // This value should be at least 2 or writes will stop whenever a MemTable is
922 : // being flushed.
923 : //
924 : // The default value is 2.
925 : MemTableStopWritesThreshold int
926 :
927 : // Merger defines the associative merge operation to use for merging values
928 : // written with {Batch,DB}.Merge.
929 : //
930 : // The default merger concatenates values.
931 : Merger *Merger
932 :
933 : // CompactionConcurrencyRange returns a [lower, upper] range for the number of
934 : // compactions Pebble runs in parallel (with the caveats below), not including
935 : // download compactions (which have a separate limit specified by
936 : // MaxConcurrentDownloads).
937 : //
938 : // The lower value is the concurrency allowed under normal circumstances.
939 : // Pebble can dynamically increase the concurrency based on heuristics (like
940 : // high read amplification or compaction debt) up to the maximum.
941 : //
942 : // The upper value is a rough upper bound since delete-only compactions (a) do
943 : // not use the CompactionScheduler, and (b) the CompactionScheduler may use
944 : // other criteria to decide on how many compactions to permit.
945 : //
946 : // Elaborating on (b), when the ConcurrencyLimitScheduler is being used, the
947 : // value returned by DB.GetAllowedWithoutPermission fully controls how many
948 : // compactions get to run. Other CompactionSchedulers may use additional
949 : // criteria, like resource availability.
950 : //
951 : // Elaborating on (a), we don't use the CompactionScheduler to schedule
952 : // delete-only compactions since they are expected to be almost free from a
953 : // CPU and disk usage perspective. Since the CompactionScheduler does not
954 : // know about their existence, the total running count can exceed this
955 : // value. For example, consider CompactionConcurrencyRange returns 3, and the
956 : // current value returned from DB.GetAllowedWithoutPermission is also 3. Say
957 : // 3 delete-only compactions are also running. Then the
958 : // ConcurrencyLimitScheduler can also start 3 other compactions, for a total
959 : // of 6.
960 : //
961 : // DB.GetAllowedWithoutPermission returns a value in the interval
962 : // [lower, upper]. A value > lower is returned:
963 : // - when L0 read-amplification passes the L0CompactionConcurrency threshold;
964 : // - when compaction debt passes the CompactionDebtConcurrency threshold;
965 : // - when there are multiple manual compactions waiting to run.
966 : //
967 : // lower and upper must be greater than 0. If lower > upper, then upper is
968 : // used for both.
969 : //
970 : // The default values are 1, 1.
971 : CompactionConcurrencyRange func() (lower, upper int)
972 :
973 : // MaxConcurrentDownloads specifies the maximum number of download
974 : // compactions. These are compactions that copy an external file to the local
975 : // store.
976 : //
977 : // This limit is independent of CompactionConcurrencyRange; at any point in
978 : // time, we may be running CompactionConcurrencyRange non-download compactions
979 : // and MaxConcurrentDownloads download compactions.
980 : //
981 : // MaxConcurrentDownloads() must be greater than 0.
982 : //
983 : // The default value is 1.
984 : MaxConcurrentDownloads func() int
985 :
986 : // DisableAutomaticCompactions dictates whether automatic compactions are
987 : // scheduled or not. The default is false (enabled). This option is only used
988 : // externally when running a manual compaction, and internally for tests.
989 : DisableAutomaticCompactions bool
990 :
991 : // DisableConsistencyCheck disables the consistency check that is performed on
992 : // open. Should only be used when a database cannot be opened normally (e.g.
993 : // some of the tables don't exist / aren't accessible).
994 : DisableConsistencyCheck bool
995 :
996 : // DisableTableStats dictates whether tables should be loaded asynchronously
997 : // to compute statistics that inform compaction heuristics. The collection
998 : // of table stats improves compaction of tombstones, reclaiming disk space
999 : // more quickly and in some cases reducing write amplification in the
1000 : // presence of tombstones. Disabling table stats may be useful in tests
1001 : // that require determinism as the asynchronicity of table stats collection
1002 : // introduces significant nondeterminism.
1003 : DisableTableStats bool
1004 :
1005 : // NoSyncOnClose decides whether the Pebble instance will enforce a
1006 : // close-time synchronization (e.g., fdatasync() or sync_file_range())
1007 : // on files it writes to. Setting this to true removes the guarantee for a
1008 : // sync on close. Some implementations can still issue a non-blocking sync.
1009 : NoSyncOnClose bool
1010 :
1011 : // NumPrevManifest is the number of non-current or older manifests which
1012 : // we want to keep around for debugging purposes. By default, we're going
1013 : // to keep one older manifest.
1014 : NumPrevManifest int
1015 :
1016 : // ReadOnly indicates that the DB should be opened in read-only mode. Writes
1017 : // to the DB will return an error, background compactions are disabled, and
1018 : // the flush that normally occurs after replaying the WAL at startup is
1019 : // disabled.
1020 : ReadOnly bool
1021 :
1022 : // FileCache is an initialized FileCache which should be set as an
1023 : // option if the DB needs to be initialized with a pre-existing file cache.
1024 : // If FileCache is nil, then a file cache which is unique to the DB instance
1025 : // is created. FileCache can be shared between db instances by setting it here.
1026 : // The FileCache set here must use the same underlying cache as Options.Cache
1027 : // and pebble will panic otherwise.
1028 : FileCache *FileCache
1029 :
1030 : // BlockPropertyCollectors is a list of BlockPropertyCollector creation
1031 : // functions. A new BlockPropertyCollector is created for each sstable
1032 : // built and lives for the lifetime of writing that table.
1033 : BlockPropertyCollectors []func() BlockPropertyCollector
1034 :
1035 : // WALBytesPerSync sets the number of bytes to write to a WAL before calling
1036 : // Sync on it in the background. Just like with BytesPerSync above, this
1037 : // helps smooth out disk write latencies, and avoids cases where the OS
1038 : // writes a lot of buffered data to disk at once. However, this is less
1039 : // necessary with WALs, as many write operations already pass in
1040 : // Sync = true.
1041 : //
1042 : // The default value is 0, i.e. no background syncing. This matches the
1043 : // default behaviour in RocksDB.
1044 : WALBytesPerSync int
1045 :
1046 : // WALDir specifies the directory to store write-ahead logs (WALs) in. If
1047 : // empty (the default), WALs will be stored in the same directory as sstables
1048 : // (i.e. the directory passed to pebble.Open).
1049 : WALDir string
1050 :
1051 : // WALDirLock, if set, must be a directory lock acquired through LockDirectory
1052 : // for the same directory set on WALDir passed to Open. If provided, Open will
1053 : // skip locking the directory. Closing the database will not release the lock,
1054 : // and it's the responsibility of the caller to release the lock after closing the
1055 : // database.
1056 : //
1057 : // Open will enforce that the Lock passed locks the same WAL directory passed to
1058 : // Open. Concurrent calls to Open using the same Lock are detected and
1059 : // prohibited.
1060 : WALDirLock *base.DirLock
1061 :
1062 : // WALFailover may be set to configure Pebble to monitor writes to its
1063 : // write-ahead log and failover to writing write-ahead log entries to a
1064 : // secondary location (eg, a separate physical disk). WALFailover may be
1065 : // used to improve write availability in the presence of transient disk
1066 : // unavailability.
1067 : WALFailover *WALFailoverOptions
1068 :
1069 : // WALRecoveryDirs is a list of additional directories that should be
1070 : // scanned for the existence of additional write-ahead logs. WALRecoveryDirs
1071 : // is expected to be used when starting Pebble with a new WALDir or a new
1072 : // WALFailover configuration. The directories associated with the previous
1073 : // configuration may still contain WALs that are required for recovery of
1074 : // the current database state.
1075 : //
1076 : // If a previous WAL configuration may have stored WALs elsewhere but there
1077 : // is not a corresponding entry in WALRecoveryDirs, Open will error.
1078 : WALRecoveryDirs []wal.Dir
1079 :
1080 : // WALMinSyncInterval is the minimum duration between syncs of the WAL. If
1081 : // WAL syncs are requested faster than this interval, they will be
1082 : // artificially delayed. Introducing a small artificial delay (500us) between
1083 : // WAL syncs can allow more operations to arrive and reduce IO operations
1084 : // while having a minimal impact on throughput. This option is supplied as a
1085 : // closure in order to allow the value to be changed dynamically. The default
1086 : // value is 0.
1087 : //
1088 : // TODO(peter): rather than a closure, should there be another mechanism for
1089 : // changing options dynamically?
1090 : WALMinSyncInterval func() time.Duration
1091 :
1092 : // The controls below manage deletion pacing, which slows down
1093 : // deletions when compactions finish or when readers close and
1094 : // obsolete files must be cleaned up. Rapid deletion of many
1095 : // files simultaneously can increase disk latency on certain
1096 : // SSDs, and this functionality helps protect against that.
1097 :
1098 : // TargetByteDeletionRate is the rate (in bytes per second) at which sstable file
1099 : // deletions are limited to (under normal circumstances).
1100 : //
1101 : // This value is only a best-effort target; the effective rate can be
1102 : // higher if deletions are falling behind or disk space is running low.
1103 : //
1104 : // Setting this to 0 disables deletion pacing, which is also the default.
1105 : TargetByteDeletionRate int
1106 :
1107 : // FreeSpaceThresholdBytes specifies the minimum amount of free disk space that Pebble
1108 : // attempts to maintain. If free disk space drops below this threshold, deletions
1109 : // are accelerated above TargetByteDeletionRate until the threshold is restored.
1110 : // Default is 16GB.
1111 : FreeSpaceThresholdBytes uint64
1112 :
1113 : // FreeSpaceTimeframe sets the duration (in seconds) within which Pebble attempts
1114 : // to restore the free disk space back to FreeSpaceThreshold. A lower value means
1115 : // more aggressive deletions. Default is 10s.
1116 : FreeSpaceTimeframe time.Duration
1117 :
1118 : // ObsoleteBytesMaxRatio specifies the maximum allowed ratio of obsolete files to
1119 : // live files. If this ratio is exceeded, Pebble speeds up deletions above the
1120 : // TargetByteDeletionRate until the ratio is restored. Default is 0.20.
1121 : ObsoleteBytesMaxRatio float64
1122 :
1123 : // ObsoleteBytesTimeframe sets the duration (in seconds) within which Pebble aims
1124 : // to restore the obsolete-to-live bytes ratio below ObsoleteBytesMaxRatio. A lower
1125 : // value means more aggressive deletions. Default is 300s.
1126 : ObsoleteBytesTimeframe time.Duration
1127 :
1128 : // EnableSQLRowSpillMetrics specifies whether the Pebble instance will only be used
1129 : // to temporarily persist data spilled to disk for row-oriented SQL query execution.
1130 : EnableSQLRowSpillMetrics bool
1131 :
1132 : // AllocatorSizeClasses provides a sorted list containing the supported size
1133 : // classes of the underlying memory allocator. This provides hints to the
1134 : // sstable block writer's flushing policy to select block sizes that
1135 : // preemptively reduce internal fragmentation when loaded into the block cache.
1136 : AllocatorSizeClasses []int
1137 :
1138 : // private options are only used by internal tests or are used internally
1139 : // for facilitating upgrade paths of unconfigurable functionality.
1140 : private struct {
1141 : // disableDeleteOnlyCompactions prevents the scheduling of delete-only
1142 : // compactions that drop sstables wholy covered by range tombstones or
1143 : // range key tombstones.
1144 : disableDeleteOnlyCompactions bool
1145 :
1146 : // disableElisionOnlyCompactions prevents the scheduling of elision-only
1147 : // compactions that rewrite sstables in place in order to elide obsolete
1148 : // keys.
1149 : disableElisionOnlyCompactions bool
1150 :
1151 : // disableLazyCombinedIteration is a private option used by the
1152 : // metamorphic tests to test equivalence between lazy-combined iteration
1153 : // and constructing the range-key iterator upfront. It's a private
1154 : // option to avoid littering the public interface with options that we
1155 : // do not want to allow users to actually configure.
1156 : disableLazyCombinedIteration bool
1157 :
1158 : // testingAlwaysWaitForCleanup is set by some tests to force waiting for
1159 : // obsolete file deletion (to make events deterministic).
1160 : testingAlwaysWaitForCleanup bool
1161 :
1162 : // fsCloser holds a closer that should be invoked after a DB using these
1163 : // Options is closed. This is used to automatically stop the
1164 : // long-running goroutine associated with the disk-health-checking FS.
1165 : // See the initialization of FS in EnsureDefaults. Note that care has
1166 : // been taken to ensure that it is still safe to continue using the FS
1167 : // after this closer has been invoked. However, if write operations
1168 : // against the FS are made after the DB is closed, the FS may leak a
1169 : // goroutine indefinitely.
1170 : fsCloser io.Closer
1171 : }
1172 : }
1173 :
1174 : // ValueSeparationPolicy controls the policy for separating values into
1175 : // external blob files.
1176 : type ValueSeparationPolicy struct {
1177 : // Enabled controls whether value separation is enabled.
1178 : Enabled bool
1179 : // MinimumSize imposes a lower bound on the size of values that can be
1180 : // separated into a blob file. Values smaller than this are always written
1181 : // to the sstable (but may still be written to a value block within the
1182 : // sstable).
1183 : //
1184 : // MinimumSize must be > 0.
1185 : MinimumSize int
1186 : // MaxBlobReferenceDepth limits the number of potentially overlapping (in
1187 : // the keyspace) blob files that can be referenced by a single sstable. If a
1188 : // compaction may produce an output sstable referencing more than this many
1189 : // overlapping blob files, the compaction will instead rewrite referenced
1190 : // values into new blob files.
1191 : //
1192 : // MaxBlobReferenceDepth must be > 0.
1193 : MaxBlobReferenceDepth int
1194 : // RewriteMinimumAge specifies how old a blob file must be in order for it
1195 : // to be eligible for a rewrite that reclaims disk space. Lower values
1196 : // reduce space amplification at the cost of write amplification
1197 : RewriteMinimumAge time.Duration
1198 : // TargetGarbageRatio is a value in the range [0, 1.0] and configures how
1199 : // aggressively blob files should be written in order to reduce space
1200 : // amplification induced by value separation. As compactions rewrite blob
1201 : // files, data may be duplicated. Older blob files containing the
1202 : // duplicated data may need to remain because other sstables are referencing
1203 : // other values contained in the same file.
1204 : //
1205 : // The DB can rewrite these blob files in place in order to reduce this
1206 : // space amplification, but this incurs write amplification. This option
1207 : // configures how much garbage may accrue before the DB will attempt to
1208 : // rewrite blob files to reduce it. A value of 0.20 indicates that once 20%
1209 : // of values in blob files are unreferenced, the DB should attempt to
1210 : // rewrite blob files to reclaim disk space.
1211 : //
1212 : // A value of 1.0 indicates that the DB should never attempt to rewrite blob
1213 : // files.
1214 : TargetGarbageRatio float64
1215 : }
1216 :
1217 : // SpanPolicy contains policies that can vary by key range. The zero value is
1218 : // the default value.
1219 : type SpanPolicy struct {
1220 : // Prefer a faster compression algorithm for the keys in this span.
1221 : //
1222 : // This is useful for keys that are frequently read or written but which don't
1223 : // amount to a significant amount of space.
1224 : PreferFastCompression bool
1225 :
1226 : // DisableValueSeparationBySuffix disables discriminating KVs depending on
1227 : // suffix.
1228 : //
1229 : // Among a set of keys with the same prefix, Pebble's default heuristics
1230 : // optimize access to the KV with the smallest suffix. This is useful for MVCC
1231 : // keys (where the smallest suffix is the latest version), but should be
1232 : // disabled for keys where the suffix does not correspond to a version.
1233 : DisableValueSeparationBySuffix bool
1234 :
1235 : // ValueStoragePolicy is a hint used to determine where to store the values
1236 : // for KVs.
1237 : ValueStoragePolicy ValueStoragePolicy
1238 : }
1239 :
1240 : // String returns a string representation of the SpanPolicy.
1241 0 : func (p SpanPolicy) String() string {
1242 0 : var sb strings.Builder
1243 0 : if p.PreferFastCompression {
1244 0 : sb.WriteString("fast-compression,")
1245 0 : }
1246 0 : if p.DisableValueSeparationBySuffix {
1247 0 : sb.WriteString("disable-value-separation-by-suffix,")
1248 0 : }
1249 0 : switch p.ValueStoragePolicy {
1250 0 : case ValueStorageLowReadLatency:
1251 0 : sb.WriteString("low-read-latency,")
1252 0 : case ValueStorageLatencyTolerant:
1253 0 : sb.WriteString("latency-tolerant,")
1254 : }
1255 0 : return strings.TrimSuffix(sb.String(), ",")
1256 : }
1257 :
1258 : // ValueStoragePolicy is a hint used to determine where to store the values for
1259 : // KVs.
1260 : type ValueStoragePolicy uint8
1261 :
1262 : const (
1263 : // ValueStorageDefault is the default value; Pebble will respect global
1264 : // configuration for value blocks and value separation.
1265 : ValueStorageDefault ValueStoragePolicy = iota
1266 :
1267 : // ValueStorageLowReadLatency indicates Pebble should prefer storing values
1268 : // in-place.
1269 : ValueStorageLowReadLatency
1270 :
1271 : // ValueStorageLatencyTolerant indicates value retrieval can tolerate
1272 : // additional latency, so Pebble should aggressively prefer storing values
1273 : // separately if it can reduce write amplification.
1274 : //
1275 : // If the global Options' enable value separation, Pebble may choose to
1276 : // separate values under the LatencyTolerant policy even if they do not meet
1277 : // the minimum size threshold of the global Options' ValueSeparationPolicy.
1278 : ValueStorageLatencyTolerant
1279 : )
1280 :
1281 : // SpanPolicyFunc is used to determine the SpanPolicy for a key region.
1282 : //
1283 : // The returned policy is valid from the start key until (and not including) the
1284 : // end key.
1285 : //
1286 : // A flush or compaction will call this function once for the first key to be
1287 : // output. If the compaction reaches the end key, the current output sst is
1288 : // finished and the function is called again.
1289 : //
1290 : // The end key can be empty, in which case the policy is valid for the entire
1291 : // keyspace after startKey.
1292 : type SpanPolicyFunc func(startKey []byte) (policy SpanPolicy, endKey []byte, err error)
1293 :
1294 : // SpanAndPolicy defines a key range and the policy to apply to it.
1295 : type SpanAndPolicy struct {
1296 : KeyRange KeyRange
1297 : Policy SpanPolicy
1298 : }
1299 :
1300 : // MakeStaticSpanPolicyFunc returns a SpanPolicyFunc that applies a given policy
1301 : // to the given span (and the default policy outside the span). The supplied
1302 : // policies must be non-overlapping in key range.
1303 0 : func MakeStaticSpanPolicyFunc(cmp base.Compare, inputPolicies ...SpanAndPolicy) SpanPolicyFunc {
1304 0 : // Collect all the boundaries of the input policies, sort and deduplicate them.
1305 0 : uniqueKeys := make([][]byte, 0, 2*len(inputPolicies))
1306 0 : for i := range inputPolicies {
1307 0 : uniqueKeys = append(uniqueKeys, inputPolicies[i].KeyRange.Start)
1308 0 : uniqueKeys = append(uniqueKeys, inputPolicies[i].KeyRange.End)
1309 0 : }
1310 0 : slices.SortFunc(uniqueKeys, cmp)
1311 0 : uniqueKeys = slices.CompactFunc(uniqueKeys, func(a, b []byte) bool { return cmp(a, b) == 0 })
1312 :
1313 : // Create a list of policies.
1314 0 : policies := make([]SpanPolicy, len(uniqueKeys)-1)
1315 0 : for _, p := range inputPolicies {
1316 0 : idx, _ := slices.BinarySearchFunc(uniqueKeys, p.KeyRange.Start, cmp)
1317 0 : policies[idx] = p.Policy
1318 0 : }
1319 :
1320 0 : return func(startKey []byte) (_ SpanPolicy, endKey []byte, _ error) {
1321 0 : // Find the policy that applies to the start key.
1322 0 : idx, eq := slices.BinarySearchFunc(uniqueKeys, startKey, cmp)
1323 0 : switch idx {
1324 0 : case len(uniqueKeys):
1325 0 : // The start key is after the last policy.
1326 0 : return SpanPolicy{}, nil, nil
1327 0 : case len(uniqueKeys) - 1:
1328 0 : if eq {
1329 0 : // The start key is exactly the start of the last policy.
1330 0 : return SpanPolicy{}, nil, nil
1331 0 : }
1332 0 : case 0:
1333 0 : if !eq {
1334 0 : // The start key is before the first policy.
1335 0 : return SpanPolicy{}, uniqueKeys[0], nil
1336 0 : }
1337 : }
1338 0 : if eq {
1339 0 : // The start key is exactly the start of this policy.
1340 0 : return policies[idx], uniqueKeys[idx+1], nil
1341 0 : }
1342 : // The start key is between two policies.
1343 0 : return policies[idx-1], uniqueKeys[idx], nil
1344 : }
1345 : }
1346 :
1347 : // WALFailoverOptions configures the WAL failover mechanics to use during
1348 : // transient write unavailability on the primary WAL volume.
1349 : type WALFailoverOptions struct {
1350 : // Secondary indicates the secondary directory and VFS to use in the event a
1351 : // write to the primary WAL stalls. The Lock field may be set during setup to
1352 : // preacquire the lock on the secondary directory.
1353 : Secondary wal.Dir
1354 :
1355 : // FailoverOptions provides configuration of the thresholds and intervals
1356 : // involved in WAL failover. If any of its fields are left unspecified,
1357 : // reasonable defaults will be used.
1358 : wal.FailoverOptions
1359 : }
1360 :
1361 : // ReadaheadConfig controls the use of read-ahead.
1362 : type ReadaheadConfig = objstorageprovider.ReadaheadConfig
1363 :
1364 : // JemallocSizeClasses exports sstable.JemallocSizeClasses.
1365 : var JemallocSizeClasses = sstable.JemallocSizeClasses
1366 :
1367 : // DebugCheckLevels calls CheckLevels on the provided database.
1368 : // It may be set in the DebugCheck field of Options to check
1369 : // level invariants whenever a new version is installed.
1370 1 : func DebugCheckLevels(db *DB) error {
1371 1 : return db.CheckLevels(nil)
1372 1 : }
1373 :
1374 : // DBCompressionSettings contains compression settings for the entire store. It
1375 : // defines compression profiles for each LSM level.
1376 : type DBCompressionSettings struct {
1377 : Name string
1378 : Levels [manifest.NumLevels]*block.CompressionProfile
1379 : }
1380 :
1381 : // Predefined compression settings.
1382 : var (
1383 : DBCompressionNone = UniformDBCompressionSettings(block.NoCompression)
1384 : DBCompressionFastest = UniformDBCompressionSettings(block.FastestCompression)
1385 1 : DBCompressionBalanced = func() DBCompressionSettings {
1386 1 : cs := DBCompressionSettings{Name: "Balanced"}
1387 1 : for i := 0; i < manifest.NumLevels-2; i++ {
1388 1 : cs.Levels[i] = block.FastestCompression
1389 1 : }
1390 1 : cs.Levels[manifest.NumLevels-2] = block.FastCompression // Zstd1 for value blocks.
1391 1 : cs.Levels[manifest.NumLevels-1] = block.BalancedCompression // Zstd1 for data and value blocks.
1392 1 : return cs
1393 : }()
1394 1 : DBCompressionGood = func() DBCompressionSettings {
1395 1 : cs := DBCompressionSettings{Name: "Good"}
1396 1 : for i := 0; i < manifest.NumLevels-2; i++ {
1397 1 : cs.Levels[i] = block.FastestCompression
1398 1 : }
1399 1 : cs.Levels[manifest.NumLevels-2] = block.BalancedCompression // Zstd1 for data and value blocks.
1400 1 : cs.Levels[manifest.NumLevels-1] = block.GoodCompression // Zstd3 for data and value blocks.
1401 1 : return cs
1402 : }()
1403 : )
1404 :
1405 : // UniformDBCompressionSettings returns a DBCompressionSettings which uses the
1406 : // same compression profile on all LSM levels.
1407 1 : func UniformDBCompressionSettings(profile *block.CompressionProfile) DBCompressionSettings {
1408 1 : cs := DBCompressionSettings{Name: profile.Name}
1409 1 : for i := range cs.Levels {
1410 1 : cs.Levels[i] = profile
1411 1 : }
1412 1 : return cs
1413 : }
1414 :
1415 : // ApplyCompressionSettings sets the Compression field in each LevelOptions to
1416 : // call the given function and return the compression profile for that level.
1417 0 : func (o *Options) ApplyCompressionSettings(csFn func() DBCompressionSettings) {
1418 0 : for i := range o.Levels {
1419 0 : levelIdx := i
1420 0 : o.Levels[i].Compression = func() *block.CompressionProfile {
1421 0 : return csFn().Levels[levelIdx]
1422 0 : }
1423 : }
1424 : }
1425 :
1426 : // EnsureDefaults ensures that the default values for all options are set if a
1427 : // valid value was not already specified.
1428 1 : func (o *Options) EnsureDefaults() {
1429 1 : if o.Cache == nil && o.CacheSize == 0 {
1430 0 : o.CacheSize = cacheDefaultSize
1431 0 : }
1432 1 : o.Comparer = o.Comparer.EnsureDefaults()
1433 1 :
1434 1 : if o.BytesPerSync <= 0 {
1435 0 : o.BytesPerSync = 512 << 10 // 512 KB
1436 0 : }
1437 1 : if o.Cleaner == nil {
1438 0 : o.Cleaner = DeleteCleaner{}
1439 0 : }
1440 :
1441 1 : if o.FreeSpaceThresholdBytes == 0 {
1442 0 : o.FreeSpaceThresholdBytes = 16 << 30 // 16 GB
1443 0 : }
1444 :
1445 1 : if o.FreeSpaceTimeframe == 0 {
1446 0 : o.FreeSpaceTimeframe = 10 * time.Second
1447 0 : }
1448 :
1449 1 : if o.ObsoleteBytesMaxRatio == 0 {
1450 0 : o.ObsoleteBytesMaxRatio = 0.20
1451 0 : }
1452 :
1453 1 : if o.ObsoleteBytesTimeframe == 0 {
1454 0 : o.ObsoleteBytesTimeframe = 300 * time.Second
1455 0 : }
1456 :
1457 1 : if o.Experimental.DisableIngestAsFlushable == nil {
1458 1 : o.Experimental.DisableIngestAsFlushable = func() bool { return false }
1459 : }
1460 1 : if o.Experimental.L0CompactionConcurrency <= 0 {
1461 0 : o.Experimental.L0CompactionConcurrency = 10
1462 0 : }
1463 1 : if o.Experimental.CompactionDebtConcurrency <= 0 {
1464 0 : o.Experimental.CompactionDebtConcurrency = 1 << 30 // 1 GB
1465 0 : }
1466 1 : if o.Experimental.CompactionGarbageFractionForMaxConcurrency == nil {
1467 0 : // When 40% of the DB is garbage, the compaction concurrency is at the
1468 0 : // maximum permitted.
1469 0 : o.Experimental.CompactionGarbageFractionForMaxConcurrency = func() float64 { return 0.4 }
1470 : }
1471 1 : if o.Experimental.ValueSeparationPolicy == nil {
1472 0 : o.Experimental.ValueSeparationPolicy = func() ValueSeparationPolicy {
1473 0 : return ValueSeparationPolicy{Enabled: false}
1474 0 : }
1475 : }
1476 1 : if o.KeySchema == "" && len(o.KeySchemas) == 0 {
1477 0 : ks := colblk.DefaultKeySchema(o.Comparer, 16 /* bundleSize */)
1478 0 : o.KeySchema = ks.Name
1479 0 : o.KeySchemas = sstable.MakeKeySchemas(&ks)
1480 0 : }
1481 1 : if o.L0CompactionThreshold <= 0 {
1482 0 : o.L0CompactionThreshold = 4
1483 0 : }
1484 1 : if o.L0CompactionFileThreshold <= 0 {
1485 0 : // Some justification for the default of 500:
1486 0 : // Why not smaller?:
1487 0 : // - The default target file size for L0 is 2MB, so 500 files is <= 1GB
1488 0 : // of data. At observed compaction speeds of > 20MB/s, L0 can be
1489 0 : // cleared of all files in < 1min, so this backlog is not huge.
1490 0 : // - 500 files is low overhead for instantiating L0 sublevels from
1491 0 : // scratch.
1492 0 : // - Lower values were observed to cause excessive and inefficient
1493 0 : // compactions out of L0 in a TPCC import benchmark.
1494 0 : // Why not larger?:
1495 0 : // - More than 1min to compact everything out of L0.
1496 0 : // - CockroachDB's admission control system uses a threshold of 1000
1497 0 : // files to start throttling writes to Pebble. Using 500 here gives
1498 0 : // us headroom between when Pebble should start compacting L0 and
1499 0 : // when the admission control threshold is reached.
1500 0 : //
1501 0 : // We can revisit this default in the future based on better
1502 0 : // experimental understanding.
1503 0 : //
1504 0 : // TODO(jackson): Experiment with slightly lower thresholds [or higher
1505 0 : // admission control thresholds] to see whether a higher L0 score at the
1506 0 : // threshold (currently 2.0) is necessary for some workloads to avoid
1507 0 : // starving L0 in favor of lower-level compactions.
1508 0 : o.L0CompactionFileThreshold = 500
1509 0 : }
1510 1 : if o.L0StopWritesThreshold <= 0 {
1511 0 : o.L0StopWritesThreshold = 12
1512 0 : }
1513 1 : if o.LBaseMaxBytes <= 0 {
1514 0 : o.LBaseMaxBytes = 64 << 20 // 64 MB
1515 0 : }
1516 1 : if o.TargetFileSizes[0] <= 0 {
1517 0 : o.TargetFileSizes[0] = 2 << 20 // 2 MB
1518 0 : }
1519 1 : for i := 1; i < len(o.TargetFileSizes); i++ {
1520 1 : if o.TargetFileSizes[i] <= 0 {
1521 0 : o.TargetFileSizes[i] = o.TargetFileSizes[i-1] * 2
1522 0 : }
1523 : }
1524 1 : o.Levels[0].EnsureL0Defaults()
1525 1 : for i := 1; i < len(o.Levels); i++ {
1526 1 : o.Levels[i].EnsureL1PlusDefaults(&o.Levels[i-1])
1527 1 : }
1528 1 : if o.Logger == nil {
1529 1 : o.Logger = DefaultLogger
1530 1 : }
1531 1 : if o.EventListener == nil {
1532 1 : o.EventListener = &EventListener{}
1533 1 : }
1534 1 : o.EventListener.EnsureDefaults(o.Logger)
1535 1 : if o.MaxManifestFileSize == 0 {
1536 0 : o.MaxManifestFileSize = 128 << 20 // 128 MB
1537 0 : }
1538 1 : if o.MaxOpenFiles == 0 {
1539 0 : o.MaxOpenFiles = 1000
1540 0 : }
1541 1 : if o.MemTableSize <= 0 {
1542 0 : o.MemTableSize = 4 << 20 // 4 MB
1543 0 : }
1544 1 : if o.MemTableStopWritesThreshold <= 0 {
1545 0 : o.MemTableStopWritesThreshold = 2
1546 0 : }
1547 1 : if o.Merger == nil {
1548 0 : o.Merger = DefaultMerger
1549 0 : }
1550 1 : if o.CompactionConcurrencyRange == nil {
1551 0 : o.CompactionConcurrencyRange = func() (int, int) { return 1, 1 }
1552 : }
1553 1 : if o.MaxConcurrentDownloads == nil {
1554 0 : o.MaxConcurrentDownloads = func() int { return 1 }
1555 : }
1556 1 : if o.NumPrevManifest <= 0 {
1557 1 : o.NumPrevManifest = 1
1558 1 : }
1559 :
1560 1 : if o.FormatMajorVersion == FormatDefault {
1561 0 : o.FormatMajorVersion = FormatMinSupported
1562 0 : if o.Experimental.CreateOnShared != remote.CreateOnSharedNone {
1563 0 : o.FormatMajorVersion = FormatMinForSharedObjects
1564 0 : }
1565 : }
1566 :
1567 1 : if o.FS == nil {
1568 0 : o.WithFSDefaults()
1569 0 : }
1570 1 : if o.FlushSplitBytes <= 0 {
1571 0 : o.FlushSplitBytes = 2 * o.TargetFileSizes[0]
1572 0 : }
1573 1 : if o.WALFailover != nil {
1574 1 : o.WALFailover.FailoverOptions.EnsureDefaults()
1575 1 : }
1576 1 : if o.Experimental.LevelMultiplier <= 0 {
1577 1 : o.Experimental.LevelMultiplier = defaultLevelMultiplier
1578 1 : }
1579 1 : if o.Experimental.ReadCompactionRate == 0 {
1580 0 : o.Experimental.ReadCompactionRate = 16000
1581 0 : }
1582 1 : if o.Experimental.ReadSamplingMultiplier == 0 {
1583 0 : o.Experimental.ReadSamplingMultiplier = 1 << 4
1584 0 : }
1585 1 : if o.Experimental.NumDeletionsThreshold == 0 {
1586 0 : o.Experimental.NumDeletionsThreshold = sstable.DefaultNumDeletionsThreshold
1587 0 : }
1588 1 : if o.Experimental.DeletionSizeRatioThreshold == 0 {
1589 0 : o.Experimental.DeletionSizeRatioThreshold = sstable.DefaultDeletionSizeRatioThreshold
1590 0 : }
1591 1 : if o.Experimental.EnableColumnarBlocks == nil {
1592 0 : o.Experimental.EnableColumnarBlocks = func() bool { return true }
1593 : }
1594 1 : if o.Experimental.TombstoneDenseCompactionThreshold == 0 {
1595 0 : o.Experimental.TombstoneDenseCompactionThreshold = 0.10
1596 0 : }
1597 1 : if o.Experimental.FileCacheShards <= 0 {
1598 0 : o.Experimental.FileCacheShards = runtime.GOMAXPROCS(0)
1599 0 : }
1600 1 : if o.Experimental.MultiLevelCompactionHeuristic == nil {
1601 0 : o.Experimental.MultiLevelCompactionHeuristic = OptionWriteAmpHeuristic
1602 0 : }
1603 1 : if o.Experimental.SpanPolicyFunc == nil {
1604 1 : o.Experimental.SpanPolicyFunc = func(startKey []byte) (SpanPolicy, []byte, error) { return SpanPolicy{}, nil, nil }
1605 : }
1606 : // TODO(jackson): Enable value separation by default once we have confidence
1607 : // in a default policy.
1608 :
1609 1 : o.initMaps()
1610 : }
1611 :
1612 : // TargetFileSize computes the target file size for the given output level.
1613 1 : func (o *Options) TargetFileSize(outputLevel int, baseLevel int) int64 {
1614 1 : if outputLevel == 0 {
1615 1 : return o.TargetFileSizes[0]
1616 1 : }
1617 1 : if baseLevel > outputLevel {
1618 0 : panic(fmt.Sprintf("invalid base level %d (output level %d)", baseLevel, outputLevel))
1619 : }
1620 1 : return o.TargetFileSizes[outputLevel-baseLevel+1]
1621 : }
1622 :
1623 : // DefaultOptions returns a new Options object with the default values set.
1624 0 : func DefaultOptions() *Options {
1625 0 : o := &Options{}
1626 0 : o.EnsureDefaults()
1627 0 : return o
1628 0 : }
1629 :
1630 : // WithFSDefaults configures the Options to wrap the configured filesystem with
1631 : // the default virtual file system middleware, like disk-health checking.
1632 1 : func (o *Options) WithFSDefaults() {
1633 1 : if o.FS == nil {
1634 0 : o.FS = vfs.Default
1635 0 : }
1636 1 : o.FS, o.private.fsCloser = vfs.WithDiskHealthChecks(o.FS, 5*time.Second, nil,
1637 1 : func(info vfs.DiskSlowInfo) {
1638 0 : o.EventListener.DiskSlow(info)
1639 0 : })
1640 : }
1641 :
1642 : // AddEventListener adds the provided event listener to the Options, in addition
1643 : // to any existing event listener.
1644 0 : func (o *Options) AddEventListener(l EventListener) {
1645 0 : if o.EventListener != nil {
1646 0 : l = TeeEventListener(l, *o.EventListener)
1647 0 : }
1648 0 : o.EventListener = &l
1649 : }
1650 :
1651 : // initMaps initializes the Comparers, Filters, and Mergers maps.
1652 1 : func (o *Options) initMaps() {
1653 1 : for i := range o.Levels {
1654 1 : l := &o.Levels[i]
1655 1 : if l.FilterPolicy != NoFilterPolicy {
1656 1 : if o.Filters == nil {
1657 1 : o.Filters = make(map[string]FilterPolicy)
1658 1 : }
1659 1 : name := l.FilterPolicy.Name()
1660 1 : if _, ok := o.Filters[name]; !ok {
1661 1 : o.Filters[name] = l.FilterPolicy
1662 1 : }
1663 : }
1664 : }
1665 : }
1666 :
1667 : // Clone creates a shallow-copy of the supplied options.
1668 1 : func (o *Options) Clone() *Options {
1669 1 : if o == nil {
1670 0 : return &Options{}
1671 0 : }
1672 1 : n := *o
1673 1 : if o.WALFailover != nil {
1674 1 : c := *o.WALFailover
1675 1 : n.WALFailover = &c
1676 1 : }
1677 1 : return &n
1678 : }
1679 :
1680 1 : func (o *Options) String() string {
1681 1 : var buf bytes.Buffer
1682 1 :
1683 1 : cacheSize := o.CacheSize
1684 1 : if o.Cache != nil {
1685 1 : cacheSize = o.Cache.MaxSize()
1686 1 : }
1687 :
1688 1 : fmt.Fprintf(&buf, "[Version]\n")
1689 1 : fmt.Fprintf(&buf, " pebble_version=0.1\n")
1690 1 : fmt.Fprintf(&buf, "\n")
1691 1 : fmt.Fprintf(&buf, "[Options]\n")
1692 1 : fmt.Fprintf(&buf, " bytes_per_sync=%d\n", o.BytesPerSync)
1693 1 : fmt.Fprintf(&buf, " cache_size=%d\n", cacheSize)
1694 1 : fmt.Fprintf(&buf, " cleaner=%s\n", o.Cleaner)
1695 1 : fmt.Fprintf(&buf, " compaction_debt_concurrency=%d\n", o.Experimental.CompactionDebtConcurrency)
1696 1 : fmt.Fprintf(&buf, " compaction_garbage_fraction_for_max_concurrency=%.2f\n",
1697 1 : o.Experimental.CompactionGarbageFractionForMaxConcurrency())
1698 1 : fmt.Fprintf(&buf, " comparer=%s\n", o.Comparer.Name)
1699 1 : fmt.Fprintf(&buf, " disable_wal=%t\n", o.DisableWAL)
1700 1 : if o.Experimental.DisableIngestAsFlushable != nil && o.Experimental.DisableIngestAsFlushable() {
1701 1 : fmt.Fprintf(&buf, " disable_ingest_as_flushable=%t\n", true)
1702 1 : }
1703 1 : if o.Experimental.EnableColumnarBlocks != nil && o.Experimental.EnableColumnarBlocks() {
1704 1 : fmt.Fprintf(&buf, " enable_columnar_blocks=%t\n", true)
1705 1 : }
1706 1 : fmt.Fprintf(&buf, " flush_delay_delete_range=%s\n", o.FlushDelayDeleteRange)
1707 1 : fmt.Fprintf(&buf, " flush_delay_range_key=%s\n", o.FlushDelayRangeKey)
1708 1 : fmt.Fprintf(&buf, " flush_split_bytes=%d\n", o.FlushSplitBytes)
1709 1 : fmt.Fprintf(&buf, " format_major_version=%d\n", o.FormatMajorVersion)
1710 1 : fmt.Fprintf(&buf, " key_schema=%s\n", o.KeySchema)
1711 1 : fmt.Fprintf(&buf, " l0_compaction_concurrency=%d\n", o.Experimental.L0CompactionConcurrency)
1712 1 : fmt.Fprintf(&buf, " l0_compaction_file_threshold=%d\n", o.L0CompactionFileThreshold)
1713 1 : fmt.Fprintf(&buf, " l0_compaction_threshold=%d\n", o.L0CompactionThreshold)
1714 1 : fmt.Fprintf(&buf, " l0_stop_writes_threshold=%d\n", o.L0StopWritesThreshold)
1715 1 : fmt.Fprintf(&buf, " lbase_max_bytes=%d\n", o.LBaseMaxBytes)
1716 1 : if o.Experimental.LevelMultiplier != defaultLevelMultiplier {
1717 1 : fmt.Fprintf(&buf, " level_multiplier=%d\n", o.Experimental.LevelMultiplier)
1718 1 : }
1719 1 : lower, upper := o.CompactionConcurrencyRange()
1720 1 : fmt.Fprintf(&buf, " concurrent_compactions=%d\n", lower)
1721 1 : fmt.Fprintf(&buf, " max_concurrent_compactions=%d\n", upper)
1722 1 : fmt.Fprintf(&buf, " max_concurrent_downloads=%d\n", o.MaxConcurrentDownloads())
1723 1 : fmt.Fprintf(&buf, " max_manifest_file_size=%d\n", o.MaxManifestFileSize)
1724 1 : fmt.Fprintf(&buf, " max_open_files=%d\n", o.MaxOpenFiles)
1725 1 : fmt.Fprintf(&buf, " mem_table_size=%d\n", o.MemTableSize)
1726 1 : fmt.Fprintf(&buf, " mem_table_stop_writes_threshold=%d\n", o.MemTableStopWritesThreshold)
1727 1 : fmt.Fprintf(&buf, " min_deletion_rate=%d\n", o.TargetByteDeletionRate)
1728 1 : fmt.Fprintf(&buf, " free_space_threshold_bytes=%d\n", o.FreeSpaceThresholdBytes)
1729 1 : fmt.Fprintf(&buf, " free_space_timeframe=%s\n", o.FreeSpaceTimeframe.String())
1730 1 : fmt.Fprintf(&buf, " obsolete_bytes_max_ratio=%f\n", o.ObsoleteBytesMaxRatio)
1731 1 : fmt.Fprintf(&buf, " obsolete_bytes_timeframe=%s\n", o.ObsoleteBytesTimeframe.String())
1732 1 : fmt.Fprintf(&buf, " merger=%s\n", o.Merger.Name)
1733 1 : if o.Experimental.MultiLevelCompactionHeuristic != nil {
1734 1 : fmt.Fprintf(&buf, " multilevel_compaction_heuristic=%s\n", o.Experimental.MultiLevelCompactionHeuristic().String())
1735 1 : }
1736 1 : fmt.Fprintf(&buf, " read_compaction_rate=%d\n", o.Experimental.ReadCompactionRate)
1737 1 : fmt.Fprintf(&buf, " read_sampling_multiplier=%d\n", o.Experimental.ReadSamplingMultiplier)
1738 1 : fmt.Fprintf(&buf, " num_deletions_threshold=%d\n", o.Experimental.NumDeletionsThreshold)
1739 1 : fmt.Fprintf(&buf, " deletion_size_ratio_threshold=%f\n", o.Experimental.DeletionSizeRatioThreshold)
1740 1 : fmt.Fprintf(&buf, " tombstone_dense_compaction_threshold=%f\n", o.Experimental.TombstoneDenseCompactionThreshold)
1741 1 : // We no longer care about strict_wal_tail, but set it to true in case an
1742 1 : // older version reads the options.
1743 1 : fmt.Fprintf(&buf, " strict_wal_tail=%t\n", true)
1744 1 : fmt.Fprintf(&buf, " table_cache_shards=%d\n", o.Experimental.FileCacheShards)
1745 1 : fmt.Fprintf(&buf, " validate_on_ingest=%t\n", o.Experimental.ValidateOnIngest)
1746 1 : fmt.Fprintf(&buf, " wal_dir=%s\n", o.WALDir)
1747 1 : fmt.Fprintf(&buf, " wal_bytes_per_sync=%d\n", o.WALBytesPerSync)
1748 1 : fmt.Fprintf(&buf, " secondary_cache_size_bytes=%d\n", o.Experimental.SecondaryCacheSizeBytes)
1749 1 : fmt.Fprintf(&buf, " create_on_shared=%d\n", o.Experimental.CreateOnShared)
1750 1 :
1751 1 : // Private options.
1752 1 : //
1753 1 : // These options are only encoded if true, because we do not want them to
1754 1 : // appear in production serialized Options files, since they're testing-only
1755 1 : // options. They're only serialized when true, which still ensures that the
1756 1 : // metamorphic tests may propagate them to subprocesses.
1757 1 : if o.private.disableDeleteOnlyCompactions {
1758 1 : fmt.Fprintln(&buf, " disable_delete_only_compactions=true")
1759 1 : }
1760 1 : if o.private.disableElisionOnlyCompactions {
1761 1 : fmt.Fprintln(&buf, " disable_elision_only_compactions=true")
1762 1 : }
1763 1 : if o.private.disableLazyCombinedIteration {
1764 1 : fmt.Fprintln(&buf, " disable_lazy_combined_iteration=true")
1765 1 : }
1766 :
1767 1 : if o.Experimental.ValueSeparationPolicy != nil {
1768 1 : policy := o.Experimental.ValueSeparationPolicy()
1769 1 : if policy.Enabled {
1770 1 : fmt.Fprintln(&buf)
1771 1 : fmt.Fprintln(&buf, "[Value Separation]")
1772 1 : fmt.Fprintf(&buf, " enabled=%t\n", policy.Enabled)
1773 1 : fmt.Fprintf(&buf, " minimum_size=%d\n", policy.MinimumSize)
1774 1 : fmt.Fprintf(&buf, " max_blob_reference_depth=%d\n", policy.MaxBlobReferenceDepth)
1775 1 : fmt.Fprintf(&buf, " rewrite_minimum_age=%s\n", policy.RewriteMinimumAge)
1776 1 : fmt.Fprintf(&buf, " target_garbage_ratio=%.2f\n", policy.TargetGarbageRatio)
1777 1 : }
1778 : }
1779 :
1780 1 : if o.WALFailover != nil {
1781 1 : unhealthyThreshold, _ := o.WALFailover.FailoverOptions.UnhealthyOperationLatencyThreshold()
1782 1 : fmt.Fprintf(&buf, "\n")
1783 1 : fmt.Fprintf(&buf, "[WAL Failover]\n")
1784 1 : fmt.Fprintf(&buf, " secondary_dir=%s\n", o.WALFailover.Secondary.Dirname)
1785 1 : fmt.Fprintf(&buf, " primary_dir_probe_interval=%s\n", o.WALFailover.FailoverOptions.PrimaryDirProbeInterval)
1786 1 : fmt.Fprintf(&buf, " healthy_probe_latency_threshold=%s\n", o.WALFailover.FailoverOptions.HealthyProbeLatencyThreshold)
1787 1 : fmt.Fprintf(&buf, " healthy_interval=%s\n", o.WALFailover.FailoverOptions.HealthyInterval)
1788 1 : fmt.Fprintf(&buf, " unhealthy_sampling_interval=%s\n", o.WALFailover.FailoverOptions.UnhealthySamplingInterval)
1789 1 : fmt.Fprintf(&buf, " unhealthy_operation_latency_threshold=%s\n", unhealthyThreshold)
1790 1 : fmt.Fprintf(&buf, " elevated_write_stall_threshold_lag=%s\n", o.WALFailover.FailoverOptions.ElevatedWriteStallThresholdLag)
1791 1 : }
1792 :
1793 1 : for i := range o.Levels {
1794 1 : l := &o.Levels[i]
1795 1 : fmt.Fprintf(&buf, "\n")
1796 1 : fmt.Fprintf(&buf, "[Level \"%d\"]\n", i)
1797 1 : fmt.Fprintf(&buf, " block_restart_interval=%d\n", l.BlockRestartInterval)
1798 1 : fmt.Fprintf(&buf, " block_size=%d\n", l.BlockSize)
1799 1 : fmt.Fprintf(&buf, " block_size_threshold=%d\n", l.BlockSizeThreshold)
1800 1 : fmt.Fprintf(&buf, " compression=%s\n", l.Compression().Name)
1801 1 : fmt.Fprintf(&buf, " filter_policy=%s\n", l.FilterPolicy.Name())
1802 1 : fmt.Fprintf(&buf, " filter_type=%s\n", l.FilterType)
1803 1 : fmt.Fprintf(&buf, " index_block_size=%d\n", l.IndexBlockSize)
1804 1 : fmt.Fprintf(&buf, " target_file_size=%d\n", o.TargetFileSizes[i])
1805 1 : }
1806 :
1807 1 : return buf.String()
1808 : }
1809 :
1810 : type parseOptionsFuncs struct {
1811 : visitNewSection func(i, j int, section string) error
1812 : visitKeyValue func(i, j int, section, key, value string) error
1813 : visitCommentOrWhitespace func(i, j int, whitespace string) error
1814 : }
1815 :
1816 : // parseOptions takes options serialized by Options.String() and parses them
1817 : // into keys and values. It calls fns.visitNewSection for the beginning of each
1818 : // new section, fns.visitKeyValue for each key-value pair, and
1819 : // visitCommentOrWhitespace for comments and whitespace between key-value pairs.
1820 1 : func parseOptions(s string, fns parseOptionsFuncs) error {
1821 1 : var section, mappedSection string
1822 1 : i := 0
1823 1 : for i < len(s) {
1824 1 : rem := s[i:]
1825 1 : j := strings.IndexByte(rem, '\n')
1826 1 : if j < 0 {
1827 0 : j = len(rem)
1828 1 : } else {
1829 1 : j += 1 // Include the newline.
1830 1 : }
1831 1 : line := strings.TrimSpace(s[i : i+j])
1832 1 : startOff, endOff := i, i+j
1833 1 : i += j
1834 1 :
1835 1 : if len(line) == 0 || line[0] == ';' || line[0] == '#' {
1836 1 : // Skip blank lines and comments.
1837 1 : if fns.visitCommentOrWhitespace != nil {
1838 1 : if err := fns.visitCommentOrWhitespace(startOff, endOff, line); err != nil {
1839 0 : return err
1840 0 : }
1841 : }
1842 1 : continue
1843 : }
1844 1 : n := len(line)
1845 1 : if line[0] == '[' && line[n-1] == ']' {
1846 1 : // Parse section.
1847 1 : section = line[1 : n-1]
1848 1 : // RocksDB uses a similar (INI-style) syntax for the OPTIONS file, but
1849 1 : // different section names and keys. The "CFOptions ..." paths are the
1850 1 : // RocksDB versions which we map to the Pebble paths.
1851 1 : mappedSection = section
1852 1 : if section == `CFOptions "default"` {
1853 0 : mappedSection = "Options"
1854 0 : }
1855 1 : if fns.visitNewSection != nil {
1856 1 : if err := fns.visitNewSection(startOff, endOff, mappedSection); err != nil {
1857 0 : return err
1858 0 : }
1859 : }
1860 1 : continue
1861 : }
1862 :
1863 1 : pos := strings.Index(line, "=")
1864 1 : if pos < 0 {
1865 0 : const maxLen = 50
1866 0 : if len(line) > maxLen {
1867 0 : line = line[:maxLen-3] + "..."
1868 0 : }
1869 0 : return base.CorruptionErrorf("invalid key=value syntax: %q", errors.Safe(line))
1870 : }
1871 :
1872 1 : key := strings.TrimSpace(line[:pos])
1873 1 : value := strings.TrimSpace(line[pos+1:])
1874 1 :
1875 1 : if section == `CFOptions "default"` {
1876 0 : switch key {
1877 0 : case "comparator":
1878 0 : key = "comparer"
1879 0 : case "merge_operator":
1880 0 : key = "merger"
1881 : }
1882 : }
1883 1 : if fns.visitKeyValue != nil {
1884 1 : if err := fns.visitKeyValue(startOff, endOff, mappedSection, key, value); err != nil {
1885 0 : return err
1886 0 : }
1887 : }
1888 : }
1889 1 : return nil
1890 : }
1891 :
1892 : // ParseHooks contains callbacks to create options fields which can have
1893 : // user-defined implementations.
1894 : type ParseHooks struct {
1895 : NewCleaner func(name string) (Cleaner, error)
1896 : NewComparer func(name string) (*Comparer, error)
1897 : NewFilterPolicy func(name string) (FilterPolicy, error)
1898 : NewKeySchema func(name string) (KeySchema, error)
1899 : NewMerger func(name string) (*Merger, error)
1900 : SkipUnknown func(name, value string) bool
1901 : }
1902 :
1903 : // Parse parses the options from the specified string. Note that certain
1904 : // options cannot be parsed into populated fields. For example, comparer and
1905 : // merger.
1906 1 : func (o *Options) Parse(s string, hooks *ParseHooks) error {
1907 1 : var valSepPolicy ValueSeparationPolicy
1908 1 : var concurrencyLimit struct {
1909 1 : lower int
1910 1 : lowerSet bool
1911 1 : upper int
1912 1 : upperSet bool
1913 1 : }
1914 1 :
1915 1 : visitKeyValue := func(i, j int, section, key, value string) error {
1916 1 : // WARNING: DO NOT remove entries from the switches below because doing so
1917 1 : // causes a key previously written to the OPTIONS file to be considered unknown,
1918 1 : // a backwards incompatible change. Instead, leave in support for parsing the
1919 1 : // key but simply don't parse the value.
1920 1 :
1921 1 : parseComparer := func(name string) (*Comparer, error) {
1922 1 : switch name {
1923 0 : case DefaultComparer.Name:
1924 0 : return DefaultComparer, nil
1925 1 : case testkeys.Comparer.Name:
1926 1 : return testkeys.Comparer, nil
1927 1 : default:
1928 1 : if hooks != nil && hooks.NewComparer != nil {
1929 1 : return hooks.NewComparer(name)
1930 1 : }
1931 0 : return nil, nil
1932 : }
1933 : }
1934 :
1935 1 : switch {
1936 1 : case section == "Version":
1937 1 : switch key {
1938 1 : case "pebble_version":
1939 0 : default:
1940 0 : if hooks != nil && hooks.SkipUnknown != nil && hooks.SkipUnknown(section+"."+key, value) {
1941 0 : return nil
1942 0 : }
1943 0 : return errors.Errorf("pebble: unknown option: %s.%s",
1944 0 : errors.Safe(section), errors.Safe(key))
1945 : }
1946 1 : return nil
1947 :
1948 1 : case section == "Options":
1949 1 : var err error
1950 1 : switch key {
1951 1 : case "bytes_per_sync":
1952 1 : o.BytesPerSync, err = strconv.Atoi(value)
1953 1 : case "cache_size":
1954 1 : o.CacheSize, err = strconv.ParseInt(value, 10, 64)
1955 1 : case "cleaner":
1956 1 : switch value {
1957 1 : case "archive":
1958 1 : o.Cleaner = ArchiveCleaner{}
1959 0 : case "delete":
1960 0 : o.Cleaner = DeleteCleaner{}
1961 0 : default:
1962 0 : if hooks != nil && hooks.NewCleaner != nil {
1963 0 : o.Cleaner, err = hooks.NewCleaner(value)
1964 0 : }
1965 : }
1966 1 : case "comparer":
1967 1 : var comparer *Comparer
1968 1 : comparer, err = parseComparer(value)
1969 1 : if comparer != nil {
1970 1 : o.Comparer = comparer
1971 1 : }
1972 1 : case "compaction_debt_concurrency":
1973 1 : o.Experimental.CompactionDebtConcurrency, err = strconv.ParseUint(value, 10, 64)
1974 1 : case "compaction_garbage_fraction_for_max_concurrency":
1975 1 : var frac float64
1976 1 : frac, err = strconv.ParseFloat(value, 64)
1977 1 : if err == nil {
1978 1 : o.Experimental.CompactionGarbageFractionForMaxConcurrency =
1979 1 : func() float64 { return frac }
1980 : }
1981 0 : case "delete_range_flush_delay":
1982 0 : // NB: This is a deprecated serialization of the
1983 0 : // `flush_delay_delete_range`.
1984 0 : o.FlushDelayDeleteRange, err = time.ParseDuration(value)
1985 1 : case "disable_delete_only_compactions":
1986 1 : o.private.disableDeleteOnlyCompactions, err = strconv.ParseBool(value)
1987 1 : case "disable_elision_only_compactions":
1988 1 : o.private.disableElisionOnlyCompactions, err = strconv.ParseBool(value)
1989 1 : case "disable_ingest_as_flushable":
1990 1 : var v bool
1991 1 : v, err = strconv.ParseBool(value)
1992 1 : if err == nil {
1993 1 : o.Experimental.DisableIngestAsFlushable = func() bool { return v }
1994 : }
1995 1 : case "disable_lazy_combined_iteration":
1996 1 : o.private.disableLazyCombinedIteration, err = strconv.ParseBool(value)
1997 1 : case "disable_wal":
1998 1 : o.DisableWAL, err = strconv.ParseBool(value)
1999 1 : case "enable_columnar_blocks":
2000 1 : var v bool
2001 1 : if v, err = strconv.ParseBool(value); err == nil {
2002 1 : o.Experimental.EnableColumnarBlocks = func() bool { return v }
2003 : }
2004 1 : case "flush_delay_delete_range":
2005 1 : o.FlushDelayDeleteRange, err = time.ParseDuration(value)
2006 1 : case "flush_delay_range_key":
2007 1 : o.FlushDelayRangeKey, err = time.ParseDuration(value)
2008 1 : case "flush_split_bytes":
2009 1 : o.FlushSplitBytes, err = strconv.ParseInt(value, 10, 64)
2010 1 : case "format_major_version":
2011 1 : // NB: The version written here may be stale. Open does
2012 1 : // not use the format major version encoded in the
2013 1 : // OPTIONS file other than to validate that the encoded
2014 1 : // version is valid right here.
2015 1 : var v uint64
2016 1 : v, err = strconv.ParseUint(value, 10, 64)
2017 1 : if vers := FormatMajorVersion(v); vers > internalFormatNewest || vers == FormatDefault {
2018 0 : err = errors.Newf("unsupported format major version %d", o.FormatMajorVersion)
2019 0 : }
2020 1 : if err == nil {
2021 1 : o.FormatMajorVersion = FormatMajorVersion(v)
2022 1 : }
2023 1 : case "key_schema":
2024 1 : o.KeySchema = value
2025 1 : if o.KeySchemas == nil {
2026 0 : o.KeySchemas = make(map[string]*KeySchema)
2027 0 : }
2028 1 : if _, ok := o.KeySchemas[o.KeySchema]; !ok {
2029 0 : if strings.HasPrefix(value, "DefaultKeySchema(") && strings.HasSuffix(value, ")") {
2030 0 : argsStr := strings.TrimSuffix(strings.TrimPrefix(value, "DefaultKeySchema("), ")")
2031 0 : args := strings.FieldsFunc(argsStr, func(r rune) bool {
2032 0 : return unicode.IsSpace(r) || r == ','
2033 0 : })
2034 0 : var comparer *base.Comparer
2035 0 : var bundleSize int
2036 0 : comparer, err = parseComparer(args[0])
2037 0 : if err == nil {
2038 0 : bundleSize, err = strconv.Atoi(args[1])
2039 0 : }
2040 0 : if err == nil {
2041 0 : schema := colblk.DefaultKeySchema(comparer, bundleSize)
2042 0 : o.KeySchema = schema.Name
2043 0 : o.KeySchemas[o.KeySchema] = &schema
2044 0 : }
2045 0 : } else if hooks != nil && hooks.NewKeySchema != nil {
2046 0 : var schema KeySchema
2047 0 : schema, err = hooks.NewKeySchema(value)
2048 0 : if err == nil {
2049 0 : o.KeySchemas[value] = &schema
2050 0 : }
2051 : }
2052 : }
2053 1 : case "l0_compaction_concurrency":
2054 1 : o.Experimental.L0CompactionConcurrency, err = strconv.Atoi(value)
2055 1 : case "l0_compaction_file_threshold":
2056 1 : o.L0CompactionFileThreshold, err = strconv.Atoi(value)
2057 1 : case "l0_compaction_threshold":
2058 1 : o.L0CompactionThreshold, err = strconv.Atoi(value)
2059 1 : case "l0_stop_writes_threshold":
2060 1 : o.L0StopWritesThreshold, err = strconv.Atoi(value)
2061 0 : case "l0_sublevel_compactions":
2062 : // Do nothing; option existed in older versions of pebble.
2063 1 : case "lbase_max_bytes":
2064 1 : o.LBaseMaxBytes, err = strconv.ParseInt(value, 10, 64)
2065 1 : case "level_multiplier":
2066 1 : o.Experimental.LevelMultiplier, err = strconv.Atoi(value)
2067 1 : case "concurrent_compactions":
2068 1 : concurrencyLimit.lowerSet = true
2069 1 : concurrencyLimit.lower, err = strconv.Atoi(value)
2070 1 : case "max_concurrent_compactions":
2071 1 : concurrencyLimit.upperSet = true
2072 1 : concurrencyLimit.upper, err = strconv.Atoi(value)
2073 1 : case "max_concurrent_downloads":
2074 1 : var concurrentDownloads int
2075 1 : concurrentDownloads, err = strconv.Atoi(value)
2076 1 : if concurrentDownloads <= 0 {
2077 0 : err = errors.New("max_concurrent_compactions cannot be <= 0")
2078 1 : } else {
2079 1 : o.MaxConcurrentDownloads = func() int { return concurrentDownloads }
2080 : }
2081 1 : case "max_manifest_file_size":
2082 1 : o.MaxManifestFileSize, err = strconv.ParseInt(value, 10, 64)
2083 1 : case "max_open_files":
2084 1 : o.MaxOpenFiles, err = strconv.Atoi(value)
2085 1 : case "mem_table_size":
2086 1 : o.MemTableSize, err = strconv.ParseUint(value, 10, 64)
2087 1 : case "mem_table_stop_writes_threshold":
2088 1 : o.MemTableStopWritesThreshold, err = strconv.Atoi(value)
2089 0 : case "min_compaction_rate":
2090 : // Do nothing; option existed in older versions of pebble, and
2091 : // may be meaningful again eventually.
2092 1 : case "min_deletion_rate":
2093 1 : o.TargetByteDeletionRate, err = strconv.Atoi(value)
2094 1 : case "free_space_threshold_bytes":
2095 1 : o.FreeSpaceThresholdBytes, err = strconv.ParseUint(value, 10, 64)
2096 1 : case "free_space_timeframe":
2097 1 : o.FreeSpaceTimeframe, err = time.ParseDuration(value)
2098 1 : case "obsolete_bytes_max_ratio":
2099 1 : o.ObsoleteBytesMaxRatio, err = strconv.ParseFloat(value, 64)
2100 1 : case "obsolete_bytes_timeframe":
2101 1 : o.ObsoleteBytesTimeframe, err = time.ParseDuration(value)
2102 0 : case "min_flush_rate":
2103 : // Do nothing; option existed in older versions of pebble, and
2104 : // may be meaningful again eventually.
2105 1 : case "multilevel_compaction_heuristic":
2106 1 : switch {
2107 1 : case value == "none":
2108 1 : o.Experimental.MultiLevelCompactionHeuristic = OptionNoMultiLevel
2109 1 : case strings.HasPrefix(value, "wamp"):
2110 1 : o.Experimental.MultiLevelCompactionHeuristic = OptionWriteAmpHeuristic
2111 1 : fields := strings.FieldsFunc(strings.TrimPrefix(value, "wamp"), func(r rune) bool {
2112 1 : return unicode.IsSpace(r) || r == ',' || r == '(' || r == ')'
2113 1 : })
2114 1 : if len(fields) != 2 {
2115 0 : err = errors.Newf("require 2 arguments")
2116 0 : }
2117 1 : var h WriteAmpHeuristic
2118 1 : if err == nil {
2119 1 : h.AddPropensity, err = strconv.ParseFloat(fields[0], 64)
2120 1 : }
2121 1 : if err == nil {
2122 1 : h.AllowL0, err = strconv.ParseBool(fields[1])
2123 1 : }
2124 :
2125 1 : if err == nil {
2126 1 : if h.AllowL0 || h.AddPropensity != 0 {
2127 1 : o.Experimental.MultiLevelCompactionHeuristic = func() MultiLevelHeuristic {
2128 1 : return &h
2129 1 : }
2130 : }
2131 0 : } else {
2132 0 : err = errors.Wrapf(err, "unexpected wamp heuristic arguments: %s", value)
2133 0 : }
2134 0 : default:
2135 0 : err = errors.Newf("unrecognized multilevel compaction heuristic: %s", value)
2136 : }
2137 0 : case "point_tombstone_weight":
2138 : // Do nothing; deprecated.
2139 1 : case "strict_wal_tail":
2140 1 : var strictWALTail bool
2141 1 : strictWALTail, err = strconv.ParseBool(value)
2142 1 : if err == nil && !strictWALTail {
2143 0 : err = errors.Newf("reading from versions with strict_wal_tail=false no longer supported")
2144 0 : }
2145 1 : case "merger":
2146 1 : switch value {
2147 0 : case "nullptr":
2148 0 : o.Merger = nil
2149 1 : case "pebble.concatenate":
2150 1 : o.Merger = DefaultMerger
2151 0 : default:
2152 0 : if hooks != nil && hooks.NewMerger != nil {
2153 0 : o.Merger, err = hooks.NewMerger(value)
2154 0 : }
2155 : }
2156 1 : case "read_compaction_rate":
2157 1 : o.Experimental.ReadCompactionRate, err = strconv.ParseInt(value, 10, 64)
2158 1 : case "read_sampling_multiplier":
2159 1 : o.Experimental.ReadSamplingMultiplier, err = strconv.ParseInt(value, 10, 64)
2160 1 : case "num_deletions_threshold":
2161 1 : o.Experimental.NumDeletionsThreshold, err = strconv.Atoi(value)
2162 1 : case "deletion_size_ratio_threshold":
2163 1 : val, parseErr := strconv.ParseFloat(value, 32)
2164 1 : o.Experimental.DeletionSizeRatioThreshold = float32(val)
2165 1 : err = parseErr
2166 1 : case "tombstone_dense_compaction_threshold":
2167 1 : o.Experimental.TombstoneDenseCompactionThreshold, err = strconv.ParseFloat(value, 64)
2168 1 : case "table_cache_shards":
2169 1 : o.Experimental.FileCacheShards, err = strconv.Atoi(value)
2170 0 : case "table_format":
2171 0 : switch value {
2172 0 : case "leveldb":
2173 0 : case "rocksdbv2":
2174 0 : default:
2175 0 : return errors.Errorf("pebble: unknown table format: %q", errors.Safe(value))
2176 : }
2177 0 : case "table_property_collectors":
2178 : // No longer implemented; ignore.
2179 1 : case "validate_on_ingest":
2180 1 : o.Experimental.ValidateOnIngest, err = strconv.ParseBool(value)
2181 1 : case "wal_dir":
2182 1 : o.WALDir = value
2183 1 : case "wal_bytes_per_sync":
2184 1 : o.WALBytesPerSync, err = strconv.Atoi(value)
2185 0 : case "max_writer_concurrency":
2186 : // No longer implemented; ignore.
2187 0 : case "force_writer_parallelism":
2188 : // No longer implemented; ignore.
2189 1 : case "secondary_cache_size_bytes":
2190 1 : o.Experimental.SecondaryCacheSizeBytes, err = strconv.ParseInt(value, 10, 64)
2191 1 : case "create_on_shared":
2192 1 : var createOnSharedInt int64
2193 1 : createOnSharedInt, err = strconv.ParseInt(value, 10, 64)
2194 1 : o.Experimental.CreateOnShared = remote.CreateOnSharedStrategy(createOnSharedInt)
2195 0 : default:
2196 0 : if hooks != nil && hooks.SkipUnknown != nil && hooks.SkipUnknown(section+"."+key, value) {
2197 0 : return nil
2198 0 : }
2199 0 : return errors.Errorf("pebble: unknown option: %s.%s",
2200 0 : errors.Safe(section), errors.Safe(key))
2201 : }
2202 1 : return err
2203 :
2204 1 : case section == "Value Separation":
2205 1 : var err error
2206 1 : switch key {
2207 1 : case "enabled":
2208 1 : valSepPolicy.Enabled, err = strconv.ParseBool(value)
2209 1 : case "minimum_size":
2210 1 : var minimumSize int
2211 1 : minimumSize, err = strconv.Atoi(value)
2212 1 : valSepPolicy.MinimumSize = minimumSize
2213 1 : case "max_blob_reference_depth":
2214 1 : valSepPolicy.MaxBlobReferenceDepth, err = strconv.Atoi(value)
2215 1 : case "rewrite_minimum_age":
2216 1 : valSepPolicy.RewriteMinimumAge, err = time.ParseDuration(value)
2217 1 : case "target_garbage_ratio":
2218 1 : valSepPolicy.TargetGarbageRatio, err = strconv.ParseFloat(value, 64)
2219 0 : default:
2220 0 : if hooks != nil && hooks.SkipUnknown != nil && hooks.SkipUnknown(section+"."+key, value) {
2221 0 : return nil
2222 0 : }
2223 0 : return errors.Errorf("pebble: unknown option: %s.%s", errors.Safe(section), errors.Safe(key))
2224 : }
2225 1 : return err
2226 :
2227 1 : case section == "WAL Failover":
2228 1 : if o.WALFailover == nil {
2229 1 : o.WALFailover = new(WALFailoverOptions)
2230 1 : }
2231 1 : var err error
2232 1 : switch key {
2233 1 : case "secondary_dir":
2234 1 : o.WALFailover.Secondary = wal.Dir{Dirname: value, FS: vfs.Default}
2235 1 : case "primary_dir_probe_interval":
2236 1 : o.WALFailover.PrimaryDirProbeInterval, err = time.ParseDuration(value)
2237 1 : case "healthy_probe_latency_threshold":
2238 1 : o.WALFailover.HealthyProbeLatencyThreshold, err = time.ParseDuration(value)
2239 1 : case "healthy_interval":
2240 1 : o.WALFailover.HealthyInterval, err = time.ParseDuration(value)
2241 1 : case "unhealthy_sampling_interval":
2242 1 : o.WALFailover.UnhealthySamplingInterval, err = time.ParseDuration(value)
2243 1 : case "unhealthy_operation_latency_threshold":
2244 1 : var threshold time.Duration
2245 1 : threshold, err = time.ParseDuration(value)
2246 1 : o.WALFailover.UnhealthyOperationLatencyThreshold = func() (time.Duration, bool) {
2247 1 : return threshold, true
2248 1 : }
2249 1 : case "elevated_write_stall_threshold_lag":
2250 1 : o.WALFailover.ElevatedWriteStallThresholdLag, err = time.ParseDuration(value)
2251 0 : default:
2252 0 : if hooks != nil && hooks.SkipUnknown != nil && hooks.SkipUnknown(section+"."+key, value) {
2253 0 : return nil
2254 0 : }
2255 0 : return errors.Errorf("pebble: unknown option: %s.%s",
2256 0 : errors.Safe(section), errors.Safe(key))
2257 : }
2258 1 : return err
2259 :
2260 1 : case strings.HasPrefix(section, "Level "):
2261 1 : m := regexp.MustCompile(`Level\s*"?(\d+)"?\s*$`).FindStringSubmatch(section)
2262 1 : if m == nil {
2263 0 : return errors.Errorf("pebble: unknown section: %q", errors.Safe(section))
2264 0 : }
2265 1 : index, _ := strconv.Atoi(m[1])
2266 1 :
2267 1 : l := &o.Levels[index]
2268 1 :
2269 1 : var err error
2270 1 : switch key {
2271 1 : case "block_restart_interval":
2272 1 : l.BlockRestartInterval, err = strconv.Atoi(value)
2273 1 : case "block_size":
2274 1 : l.BlockSize, err = strconv.Atoi(value)
2275 1 : case "block_size_threshold":
2276 1 : l.BlockSizeThreshold, err = strconv.Atoi(value)
2277 1 : case "compression":
2278 1 : profile := block.CompressionProfileByName(value)
2279 1 : if profile == nil {
2280 0 : return errors.Errorf("pebble: unknown compression: %q", errors.Safe(value))
2281 0 : }
2282 1 : l.Compression = func() *sstable.CompressionProfile { return profile }
2283 1 : case "filter_policy":
2284 1 : if hooks != nil && hooks.NewFilterPolicy != nil {
2285 1 : l.FilterPolicy, err = hooks.NewFilterPolicy(value)
2286 1 : } else {
2287 0 : l.FilterPolicy = NoFilterPolicy
2288 0 : }
2289 1 : case "filter_type":
2290 1 : switch value {
2291 1 : case "table":
2292 1 : l.FilterType = TableFilter
2293 0 : default:
2294 0 : return errors.Errorf("pebble: unknown filter type: %q", errors.Safe(value))
2295 : }
2296 1 : case "index_block_size":
2297 1 : l.IndexBlockSize, err = strconv.Atoi(value)
2298 1 : case "target_file_size":
2299 1 : o.TargetFileSizes[index], err = strconv.ParseInt(value, 10, 64)
2300 0 : default:
2301 0 : if hooks != nil && hooks.SkipUnknown != nil && hooks.SkipUnknown(section+"."+key, value) {
2302 0 : return nil
2303 0 : }
2304 0 : return errors.Errorf("pebble: unknown option: %s.%s", errors.Safe(section), errors.Safe(key))
2305 : }
2306 1 : return err
2307 : }
2308 1 : if hooks != nil && hooks.SkipUnknown != nil && hooks.SkipUnknown(section+"."+key, value) {
2309 1 : return nil
2310 1 : }
2311 0 : return errors.Errorf("pebble: unknown section %q or key %q", errors.Safe(section), errors.Safe(key))
2312 : }
2313 1 : err := parseOptions(s, parseOptionsFuncs{
2314 1 : visitKeyValue: visitKeyValue,
2315 1 : })
2316 1 : if err != nil {
2317 0 : return err
2318 0 : }
2319 1 : o.Experimental.ValueSeparationPolicy = func() ValueSeparationPolicy { return valSepPolicy }
2320 1 : if concurrencyLimit.lowerSet || concurrencyLimit.upperSet {
2321 1 : if !concurrencyLimit.lowerSet {
2322 0 : concurrencyLimit.lower = 1
2323 1 : } else if concurrencyLimit.lower < 1 {
2324 0 : return errors.New("baseline_concurrent_compactions cannot be <= 0")
2325 0 : }
2326 1 : if !concurrencyLimit.upperSet {
2327 0 : concurrencyLimit.upper = concurrencyLimit.lower
2328 1 : } else if concurrencyLimit.upper < concurrencyLimit.lower {
2329 0 : return errors.Newf("max_concurrent_compactions cannot be < %d", concurrencyLimit.lower)
2330 0 : }
2331 1 : o.CompactionConcurrencyRange = func() (int, int) {
2332 1 : return concurrencyLimit.lower, concurrencyLimit.upper
2333 1 : }
2334 : }
2335 1 : return nil
2336 : }
2337 :
2338 : // ErrMissingWALRecoveryDir is an error returned when a database is attempted to be
2339 : // opened without supplying a Options.WALRecoveryDir entry for a directory that
2340 : // may contain WALs required to recover a consistent database state.
2341 : type ErrMissingWALRecoveryDir struct {
2342 : Dir string
2343 : ExtraInfo string
2344 : }
2345 :
2346 : // Error implements error.
2347 0 : func (e ErrMissingWALRecoveryDir) Error() string {
2348 0 : return fmt.Sprintf("directory %q may contain relevant WALs but is not in WALRecoveryDirs%s", e.Dir, e.ExtraInfo)
2349 0 : }
2350 :
2351 : // CheckCompatibility verifies the options are compatible with the previous options
2352 : // serialized by Options.String(). For example, the Comparer and Merger must be
2353 : // the same, or data will not be able to be properly read from the DB.
2354 : //
2355 : // This function only looks at specific keys and does not error out if the
2356 : // options are newer and contain unknown keys.
2357 1 : func (o *Options) CheckCompatibility(storeDir string, previousOptions string) error {
2358 1 : previousWALDir := ""
2359 1 :
2360 1 : visitKeyValue := func(i, j int, section, key, value string) error {
2361 1 : switch section + "." + key {
2362 1 : case "Options.comparer":
2363 1 : if value != o.Comparer.Name {
2364 0 : return errors.Errorf("pebble: comparer name from file %q != comparer name from options %q",
2365 0 : errors.Safe(value), errors.Safe(o.Comparer.Name))
2366 0 : }
2367 1 : case "Options.merger":
2368 1 : // RocksDB allows the merge operator to be unspecified, in which case it
2369 1 : // shows up as "nullptr".
2370 1 : if value != "nullptr" && value != o.Merger.Name {
2371 0 : return errors.Errorf("pebble: merger name from file %q != merger name from options %q",
2372 0 : errors.Safe(value), errors.Safe(o.Merger.Name))
2373 0 : }
2374 1 : case "Options.wal_dir":
2375 1 : previousWALDir = value
2376 1 : case "WAL Failover.secondary_dir":
2377 1 : previousWALSecondaryDir := value
2378 1 : if err := o.checkWALDir(storeDir, previousWALSecondaryDir, "WALFailover.Secondary changed from previous options"); err != nil {
2379 0 : return err
2380 0 : }
2381 : }
2382 1 : return nil
2383 : }
2384 1 : if err := parseOptions(previousOptions, parseOptionsFuncs{visitKeyValue: visitKeyValue}); err != nil {
2385 0 : return err
2386 0 : }
2387 1 : if err := o.checkWALDir(storeDir, previousWALDir, "WALDir changed from previous options"); err != nil {
2388 0 : return err
2389 0 : }
2390 1 : return nil
2391 : }
2392 :
2393 : // checkWALDir verifies that walDir is among o.WALDir, o.WALFailover.Secondary,
2394 : // or o.WALRecoveryDirs. An empty "walDir" maps to the storeDir.
2395 1 : func (o *Options) checkWALDir(storeDir, walDir, errContext string) error {
2396 1 : walPath := resolveStorePath(storeDir, walDir)
2397 1 : if walDir == "" {
2398 1 : walPath = storeDir
2399 1 : }
2400 :
2401 1 : if o.WALDir == "" {
2402 1 : if walPath == storeDir {
2403 1 : return nil
2404 1 : }
2405 1 : } else {
2406 1 : if walPath == resolveStorePath(storeDir, o.WALDir) {
2407 1 : return nil
2408 1 : }
2409 : }
2410 :
2411 1 : if o.WALFailover != nil && walPath == resolveStorePath(storeDir, o.WALFailover.Secondary.Dirname) {
2412 1 : return nil
2413 1 : }
2414 :
2415 0 : for _, d := range o.WALRecoveryDirs {
2416 0 : // TODO(radu): should we also check that d.FS is the same as walDir's FS?
2417 0 : if walPath == resolveStorePath(storeDir, d.Dirname) {
2418 0 : return nil
2419 0 : }
2420 : }
2421 :
2422 0 : var buf bytes.Buffer
2423 0 : fmt.Fprintf(&buf, "\n %s\n", errContext)
2424 0 : fmt.Fprintf(&buf, " o.WALDir: %q\n", o.WALDir)
2425 0 : if o.WALFailover != nil {
2426 0 : fmt.Fprintf(&buf, " o.WALFailover.Secondary.Dirname: %q\n", o.WALFailover.Secondary.Dirname)
2427 0 : }
2428 0 : fmt.Fprintf(&buf, " o.WALRecoveryDirs: %d", len(o.WALRecoveryDirs))
2429 0 : for _, d := range o.WALRecoveryDirs {
2430 0 : fmt.Fprintf(&buf, "\n %q", d.Dirname)
2431 0 : }
2432 0 : return ErrMissingWALRecoveryDir{Dir: walPath, ExtraInfo: buf.String()}
2433 : }
2434 :
2435 : // Validate verifies that the options are mutually consistent. For example,
2436 : // L0StopWritesThreshold must be >= L0CompactionThreshold, otherwise a write
2437 : // stall would persist indefinitely.
2438 1 : func (o *Options) Validate() error {
2439 1 : // Note that we can presume Options.EnsureDefaults has been called, so there
2440 1 : // is no need to check for zero values.
2441 1 :
2442 1 : var buf strings.Builder
2443 1 : if o.Experimental.L0CompactionConcurrency < 1 {
2444 0 : fmt.Fprintf(&buf, "L0CompactionConcurrency (%d) must be >= 1\n",
2445 0 : o.Experimental.L0CompactionConcurrency)
2446 0 : }
2447 1 : if o.L0StopWritesThreshold < o.L0CompactionThreshold {
2448 0 : fmt.Fprintf(&buf, "L0StopWritesThreshold (%d) must be >= L0CompactionThreshold (%d)\n",
2449 0 : o.L0StopWritesThreshold, o.L0CompactionThreshold)
2450 0 : }
2451 1 : if uint64(o.MemTableSize) >= maxMemTableSize {
2452 0 : fmt.Fprintf(&buf, "MemTableSize (%s) must be < %s\n",
2453 0 : humanize.Bytes.Uint64(uint64(o.MemTableSize)), humanize.Bytes.Uint64(maxMemTableSize))
2454 0 : }
2455 1 : if o.MemTableStopWritesThreshold < 2 {
2456 0 : fmt.Fprintf(&buf, "MemTableStopWritesThreshold (%d) must be >= 2\n",
2457 0 : o.MemTableStopWritesThreshold)
2458 0 : }
2459 1 : if o.FormatMajorVersion < FormatMinSupported || o.FormatMajorVersion > internalFormatNewest {
2460 0 : fmt.Fprintf(&buf, "FormatMajorVersion (%d) must be between %d and %d\n",
2461 0 : o.FormatMajorVersion, FormatMinSupported, internalFormatNewest)
2462 0 : }
2463 1 : if o.Experimental.CreateOnShared != remote.CreateOnSharedNone && o.FormatMajorVersion < FormatMinForSharedObjects {
2464 0 : fmt.Fprintf(&buf, "FormatMajorVersion (%d) when CreateOnShared is set must be at least %d\n",
2465 0 : o.FormatMajorVersion, FormatMinForSharedObjects)
2466 0 : }
2467 1 : if len(o.KeySchemas) > 0 {
2468 1 : if o.KeySchema == "" {
2469 0 : fmt.Fprintf(&buf, "KeySchemas is set but KeySchema is not\n")
2470 0 : }
2471 1 : if _, ok := o.KeySchemas[o.KeySchema]; !ok {
2472 0 : fmt.Fprintf(&buf, "KeySchema %q not found in KeySchemas\n", o.KeySchema)
2473 0 : }
2474 : }
2475 1 : if policy := o.Experimental.ValueSeparationPolicy(); policy.Enabled {
2476 1 : if policy.MinimumSize <= 0 {
2477 0 : fmt.Fprintf(&buf, "ValueSeparationPolicy.MinimumSize (%d) must be > 0\n", policy.MinimumSize)
2478 0 : }
2479 1 : if policy.MaxBlobReferenceDepth <= 0 {
2480 0 : fmt.Fprintf(&buf, "ValueSeparationPolicy.MaxBlobReferenceDepth (%d) must be > 0\n", policy.MaxBlobReferenceDepth)
2481 0 : }
2482 : }
2483 :
2484 1 : if buf.Len() == 0 {
2485 1 : return nil
2486 1 : }
2487 0 : return errors.New(buf.String())
2488 : }
2489 :
2490 : // MakeReaderOptions constructs sstable.ReaderOptions from the corresponding
2491 : // options in the receiver.
2492 1 : func (o *Options) MakeReaderOptions() sstable.ReaderOptions {
2493 1 : var readerOpts sstable.ReaderOptions
2494 1 : if o != nil {
2495 1 : readerOpts.Comparer = o.Comparer
2496 1 : readerOpts.Filters = o.Filters
2497 1 : readerOpts.KeySchemas = o.KeySchemas
2498 1 : readerOpts.LoadBlockSema = o.LoadBlockSema
2499 1 : readerOpts.LoggerAndTracer = o.LoggerAndTracer
2500 1 : readerOpts.Merger = o.Merger
2501 1 : }
2502 1 : return readerOpts
2503 : }
2504 :
2505 : // MakeWriterOptions constructs sstable.WriterOptions for the specified level
2506 : // from the corresponding options in the receiver.
2507 1 : func (o *Options) MakeWriterOptions(level int, format sstable.TableFormat) sstable.WriterOptions {
2508 1 : var writerOpts sstable.WriterOptions
2509 1 : writerOpts.TableFormat = format
2510 1 : if o != nil {
2511 1 : writerOpts.Comparer = o.Comparer
2512 1 : if o.Merger != nil {
2513 1 : writerOpts.MergerName = o.Merger.Name
2514 1 : }
2515 1 : writerOpts.BlockPropertyCollectors = o.BlockPropertyCollectors
2516 : }
2517 1 : if format >= sstable.TableFormatPebblev3 {
2518 1 : writerOpts.ShortAttributeExtractor = o.Experimental.ShortAttributeExtractor
2519 1 : if format >= sstable.TableFormatPebblev4 && level == numLevels-1 {
2520 1 : writerOpts.WritingToLowestLevel = true
2521 1 : }
2522 : }
2523 1 : levelOpts := o.Levels[level]
2524 1 : writerOpts.BlockRestartInterval = levelOpts.BlockRestartInterval
2525 1 : writerOpts.BlockSize = levelOpts.BlockSize
2526 1 : writerOpts.BlockSizeThreshold = levelOpts.BlockSizeThreshold
2527 1 : writerOpts.Compression = levelOpts.Compression()
2528 1 : writerOpts.FilterPolicy = levelOpts.FilterPolicy
2529 1 : writerOpts.FilterType = levelOpts.FilterType
2530 1 : writerOpts.IndexBlockSize = levelOpts.IndexBlockSize
2531 1 : if o.KeySchema != "" {
2532 1 : var ok bool
2533 1 : writerOpts.KeySchema, ok = o.KeySchemas[o.KeySchema]
2534 1 : if !ok {
2535 0 : panic(fmt.Sprintf("invalid schema %q", redact.Safe(o.KeySchema)))
2536 : }
2537 : }
2538 1 : writerOpts.AllocatorSizeClasses = o.AllocatorSizeClasses
2539 1 : writerOpts.NumDeletionsThreshold = o.Experimental.NumDeletionsThreshold
2540 1 : writerOpts.DeletionSizeRatioThreshold = o.Experimental.DeletionSizeRatioThreshold
2541 1 : return writerOpts
2542 : }
2543 :
2544 : // MakeBlobWriterOptions constructs blob.FileWriterOptions from the corresponding
2545 : // options in the receiver.
2546 1 : func (o *Options) MakeBlobWriterOptions(level int) blob.FileWriterOptions {
2547 1 : lo := o.Levels[level]
2548 1 : return blob.FileWriterOptions{
2549 1 : Compression: lo.Compression(),
2550 1 : ChecksumType: block.ChecksumTypeCRC32c,
2551 1 : FlushGovernor: block.MakeFlushGovernor(
2552 1 : lo.BlockSize,
2553 1 : lo.BlockSizeThreshold,
2554 1 : base.SizeClassAwareBlockSizeThreshold,
2555 1 : o.AllocatorSizeClasses,
2556 1 : ),
2557 1 : }
2558 1 : }
2559 :
2560 1 : func (o *Options) MakeObjStorageProviderSettings(dirname string) objstorageprovider.Settings {
2561 1 : s := objstorageprovider.Settings{
2562 1 : Logger: o.Logger,
2563 1 : FS: o.FS,
2564 1 : FSDirName: dirname,
2565 1 : FSCleaner: o.Cleaner,
2566 1 : NoSyncOnClose: o.NoSyncOnClose,
2567 1 : BytesPerSync: o.BytesPerSync,
2568 1 : }
2569 1 : s.Local.ReadaheadConfig = o.Local.ReadaheadConfig
2570 1 : s.Remote.StorageFactory = o.Experimental.RemoteStorage
2571 1 : s.Remote.CreateOnShared = o.Experimental.CreateOnShared
2572 1 : s.Remote.CreateOnSharedLocator = o.Experimental.CreateOnSharedLocator
2573 1 : s.Remote.CacheSizeBytes = o.Experimental.SecondaryCacheSizeBytes
2574 1 : return s
2575 1 : }
2576 :
2577 : // UserKeyCategories describes a partitioning of the user key space. Each
2578 : // partition is a category with a name. The categories are used for informative
2579 : // purposes only (like pprof labels). Pebble does not treat keys differently
2580 : // based on the UserKeyCategories.
2581 : //
2582 : // The partitions are defined by their upper bounds. The last partition is
2583 : // assumed to go until the end of keyspace; its UpperBound is ignored. The rest
2584 : // of the partitions are ordered by their UpperBound.
2585 : type UserKeyCategories struct {
2586 : categories []UserKeyCategory
2587 : cmp base.Compare
2588 : // rangeNames[i][j] contains the string referring to the categories in the
2589 : // range [i, j], with j > i.
2590 : rangeNames [][]string
2591 : }
2592 :
2593 : // UserKeyCategory describes a partition of the user key space.
2594 : //
2595 : // User keys >= the previous category's UpperBound and < this category's
2596 : // UpperBound are part of this category.
2597 : type UserKeyCategory struct {
2598 : Name string
2599 : // UpperBound is the exclusive upper bound of the category. All user keys >= the
2600 : // previous category's UpperBound and < this UpperBound are part of this
2601 : // category.
2602 : UpperBound []byte
2603 : }
2604 :
2605 : // MakeUserKeyCategories creates a UserKeyCategories object with the given
2606 : // categories. The object is immutable and can be reused across different
2607 : // stores.
2608 0 : func MakeUserKeyCategories(cmp base.Compare, categories ...UserKeyCategory) UserKeyCategories {
2609 0 : n := len(categories)
2610 0 : if n == 0 {
2611 0 : return UserKeyCategories{}
2612 0 : }
2613 0 : if categories[n-1].UpperBound != nil {
2614 0 : panic("last category UpperBound must be nil")
2615 : }
2616 : // Verify that the partitions are ordered as expected.
2617 0 : for i := 1; i < n-1; i++ {
2618 0 : if cmp(categories[i-1].UpperBound, categories[i].UpperBound) >= 0 {
2619 0 : panic("invalid UserKeyCategories: key prefixes must be sorted")
2620 : }
2621 : }
2622 :
2623 : // Precalculate a table of range names to avoid allocations in the
2624 : // categorization path.
2625 0 : rangeNamesBuf := make([]string, n*n)
2626 0 : rangeNames := make([][]string, n)
2627 0 : for i := range rangeNames {
2628 0 : rangeNames[i] = rangeNamesBuf[:n]
2629 0 : rangeNamesBuf = rangeNamesBuf[n:]
2630 0 : for j := i + 1; j < n; j++ {
2631 0 : rangeNames[i][j] = categories[i].Name + "-" + categories[j].Name
2632 0 : }
2633 : }
2634 0 : return UserKeyCategories{
2635 0 : categories: categories,
2636 0 : cmp: cmp,
2637 0 : rangeNames: rangeNames,
2638 0 : }
2639 : }
2640 :
2641 : // Len returns the number of categories defined.
2642 1 : func (kc *UserKeyCategories) Len() int {
2643 1 : return len(kc.categories)
2644 1 : }
2645 :
2646 : // CategorizeKey returns the name of the category containing the key.
2647 0 : func (kc *UserKeyCategories) CategorizeKey(userKey []byte) string {
2648 0 : idx := sort.Search(len(kc.categories)-1, func(i int) bool {
2649 0 : return kc.cmp(userKey, kc.categories[i].UpperBound) < 0
2650 0 : })
2651 0 : return kc.categories[idx].Name
2652 : }
2653 :
2654 : // CategorizeKeyRange returns the name of the category containing the key range.
2655 : // If the key range spans multiple categories, the result shows the first and
2656 : // last category separated by a dash, e.g. `cat1-cat5`.
2657 0 : func (kc *UserKeyCategories) CategorizeKeyRange(startUserKey, endUserKey []byte) string {
2658 0 : n := len(kc.categories)
2659 0 : p := sort.Search(n-1, func(i int) bool {
2660 0 : return kc.cmp(startUserKey, kc.categories[i].UpperBound) < 0
2661 0 : })
2662 0 : if p == n-1 || kc.cmp(endUserKey, kc.categories[p].UpperBound) < 0 {
2663 0 : // Fast path for a single category.
2664 0 : return kc.categories[p].Name
2665 0 : }
2666 : // Binary search among the remaining categories.
2667 0 : q := p + 1 + sort.Search(n-2-p, func(i int) bool {
2668 0 : return kc.cmp(endUserKey, kc.categories[p+1+i].UpperBound) < 0
2669 0 : })
2670 0 : return kc.rangeNames[p][q]
2671 : }
2672 :
2673 : const storePathIdentifier = "{store_path}"
2674 :
2675 : // MakeStoreRelativePath takes a path that is relative to the store directory
2676 : // and creates a path that can be used for Options.WALDir and wal.Dir.Dirname.
2677 : //
2678 : // This is used in metamorphic tests, so that the test run directory can be
2679 : // copied or moved.
2680 0 : func MakeStoreRelativePath(fs vfs.FS, relativePath string) string {
2681 0 : if relativePath == "" {
2682 0 : return storePathIdentifier
2683 0 : }
2684 0 : return fs.PathJoin(storePathIdentifier, relativePath)
2685 : }
2686 :
2687 : // resolveStorePath is the inverse of MakeStoreRelativePath(). It replaces any
2688 : // storePathIdentifier prefix with the store dir.
2689 1 : func resolveStorePath(storeDir, path string) string {
2690 1 : if remainder, ok := strings.CutPrefix(path, storePathIdentifier); ok {
2691 1 : return storeDir + remainder
2692 1 : }
2693 1 : return path
2694 : }
|
