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 : "runtime"
12 : "strconv"
13 : "strings"
14 : "time"
15 : "unicode"
16 :
17 : "github.com/cockroachdb/errors"
18 : "github.com/cockroachdb/pebble/internal/base"
19 : "github.com/cockroachdb/pebble/internal/cache"
20 : "github.com/cockroachdb/pebble/internal/humanize"
21 : "github.com/cockroachdb/pebble/internal/keyspan"
22 : "github.com/cockroachdb/pebble/internal/manifest"
23 : "github.com/cockroachdb/pebble/objstorage/remote"
24 : "github.com/cockroachdb/pebble/rangekey"
25 : "github.com/cockroachdb/pebble/sstable"
26 : "github.com/cockroachdb/pebble/vfs"
27 : "github.com/cockroachdb/pebble/wal"
28 : )
29 :
30 : const (
31 : cacheDefaultSize = 8 << 20 // 8 MB
32 : defaultLevelMultiplier = 10
33 : )
34 :
35 : // Compression exports the base.Compression type.
36 : type Compression = sstable.Compression
37 :
38 : // Exported Compression constants.
39 : const (
40 : DefaultCompression = sstable.DefaultCompression
41 : NoCompression = sstable.NoCompression
42 : SnappyCompression = sstable.SnappyCompression
43 : ZstdCompression = sstable.ZstdCompression
44 : )
45 :
46 : // FilterType exports the base.FilterType type.
47 : type FilterType = base.FilterType
48 :
49 : // Exported TableFilter constants.
50 : const (
51 : TableFilter = base.TableFilter
52 : )
53 :
54 : // FilterWriter exports the base.FilterWriter type.
55 : type FilterWriter = base.FilterWriter
56 :
57 : // FilterPolicy exports the base.FilterPolicy type.
58 : type FilterPolicy = base.FilterPolicy
59 :
60 : // BlockPropertyCollector exports the sstable.BlockPropertyCollector type.
61 : type BlockPropertyCollector = sstable.BlockPropertyCollector
62 :
63 : // BlockPropertyFilter exports the sstable.BlockPropertyFilter type.
64 : type BlockPropertyFilter = base.BlockPropertyFilter
65 :
66 : // ShortAttributeExtractor exports the base.ShortAttributeExtractor type.
67 : type ShortAttributeExtractor = base.ShortAttributeExtractor
68 :
69 : // UserKeyPrefixBound exports the sstable.UserKeyPrefixBound type.
70 : type UserKeyPrefixBound = sstable.UserKeyPrefixBound
71 :
72 : // IterKeyType configures which types of keys an iterator should surface.
73 : type IterKeyType int8
74 :
75 : const (
76 : // IterKeyTypePointsOnly configures an iterator to iterate over point keys
77 : // only.
78 : IterKeyTypePointsOnly IterKeyType = iota
79 : // IterKeyTypeRangesOnly configures an iterator to iterate over range keys
80 : // only.
81 : IterKeyTypeRangesOnly
82 : // IterKeyTypePointsAndRanges configures an iterator iterate over both point
83 : // keys and range keys simultaneously.
84 : IterKeyTypePointsAndRanges
85 : )
86 :
87 : // String implements fmt.Stringer.
88 0 : func (t IterKeyType) String() string {
89 0 : switch t {
90 0 : case IterKeyTypePointsOnly:
91 0 : return "points-only"
92 0 : case IterKeyTypeRangesOnly:
93 0 : return "ranges-only"
94 0 : case IterKeyTypePointsAndRanges:
95 0 : return "points-and-ranges"
96 0 : default:
97 0 : panic(fmt.Sprintf("unknown key type %d", t))
98 : }
99 : }
100 :
101 : // IterOptions hold the optional per-query parameters for NewIter.
102 : //
103 : // Like Options, a nil *IterOptions is valid and means to use the default
104 : // values.
105 : type IterOptions struct {
106 : // LowerBound specifies the smallest key (inclusive) that the iterator will
107 : // return during iteration. If the iterator is seeked or iterated past this
108 : // boundary the iterator will return Valid()==false. Setting LowerBound
109 : // effectively truncates the key space visible to the iterator.
110 : LowerBound []byte
111 : // UpperBound specifies the largest key (exclusive) that the iterator will
112 : // return during iteration. If the iterator is seeked or iterated past this
113 : // boundary the iterator will return Valid()==false. Setting UpperBound
114 : // effectively truncates the key space visible to the iterator.
115 : UpperBound []byte
116 : // TableFilter can be used to filter the tables that are scanned during
117 : // iteration based on the user properties. Return true to scan the table and
118 : // false to skip scanning. This function must be thread-safe since the same
119 : // function can be used by multiple iterators, if the iterator is cloned.
120 : TableFilter func(userProps map[string]string) bool
121 : // SkipPoint may be used to skip over point keys that don't match an
122 : // arbitrary predicate during iteration. If set, the Iterator invokes
123 : // SkipPoint for keys encountered. If SkipPoint returns true, the iterator
124 : // will skip the key without yielding it to the iterator operation in
125 : // progress.
126 : //
127 : // SkipPoint must be a pure function and always return the same result when
128 : // provided the same arguments. The iterator may call SkipPoint multiple
129 : // times for the same user key.
130 : SkipPoint func(userKey []byte) bool
131 : // PointKeyFilters can be used to avoid scanning tables and blocks in tables
132 : // when iterating over point keys. This slice represents an intersection
133 : // across all filters, i.e., all filters must indicate that the block is
134 : // relevant.
135 : //
136 : // Performance note: When len(PointKeyFilters) > 0, the caller should ensure
137 : // that cap(PointKeyFilters) is at least len(PointKeyFilters)+1. This helps
138 : // avoid allocations in Pebble internal code that mutates the slice.
139 : PointKeyFilters []BlockPropertyFilter
140 : // RangeKeyFilters can be usefd to avoid scanning tables and blocks in tables
141 : // when iterating over range keys. The same requirements that apply to
142 : // PointKeyFilters apply here too.
143 : RangeKeyFilters []BlockPropertyFilter
144 : // KeyTypes configures which types of keys to iterate over: point keys,
145 : // range keys, or both.
146 : KeyTypes IterKeyType
147 : // RangeKeyMasking can be used to enable automatic masking of point keys by
148 : // range keys. Range key masking is only supported during combined range key
149 : // and point key iteration mode (IterKeyTypePointsAndRanges).
150 : RangeKeyMasking RangeKeyMasking
151 :
152 : // OnlyReadGuaranteedDurable is an advanced option that is only supported by
153 : // the Reader implemented by DB. When set to true, only the guaranteed to be
154 : // durable state is visible in the iterator.
155 : // - This definition is made under the assumption that the FS implementation
156 : // is providing a durability guarantee when data is synced.
157 : // - The visible state represents a consistent point in the history of the
158 : // DB.
159 : // - The implementation is free to choose a conservative definition of what
160 : // is guaranteed durable. For simplicity, the current implementation
161 : // ignores memtables. A more sophisticated implementation could track the
162 : // highest seqnum that is synced to the WAL and published and use that as
163 : // the visible seqnum for an iterator. Note that the latter approach is
164 : // not strictly better than the former since we can have DBs that are (a)
165 : // synced more rarely than memtable flushes, (b) have no WAL. (a) is
166 : // likely to be true in a future CockroachDB context where the DB
167 : // containing the state machine may be rarely synced.
168 : // NB: this current implementation relies on the fact that memtables are
169 : // flushed in seqnum order, and any ingested sstables that happen to have a
170 : // lower seqnum than a non-flushed memtable don't have any overlapping keys.
171 : // This is the fundamental level invariant used in other code too, like when
172 : // merging iterators.
173 : //
174 : // Semantically, using this option provides the caller a "snapshot" as of
175 : // the time the most recent memtable was flushed. An alternate interface
176 : // would be to add a NewSnapshot variant. Creating a snapshot is heavier
177 : // weight than creating an iterator, so we have opted to support this
178 : // iterator option.
179 : OnlyReadGuaranteedDurable bool
180 : // UseL6Filters allows the caller to opt into reading filter blocks for L6
181 : // sstables. Helpful if a lot of SeekPrefixGEs are expected in quick
182 : // succession, that are also likely to not yield a single key. Filter blocks in
183 : // L6 can be relatively large, often larger than data blocks, so the benefit of
184 : // loading them in the cache is minimized if the probability of the key
185 : // existing is not low or if we just expect a one-time Seek (where loading the
186 : // data block directly is better).
187 : UseL6Filters bool
188 : // CategoryAndQoS is used for categorized iterator stats. This should not be
189 : // changed by calling SetOptions.
190 : sstable.CategoryAndQoS
191 :
192 : DebugRangeKeyStack bool
193 :
194 : // Internal options.
195 :
196 : logger Logger
197 : // Level corresponding to this file. Only passed in if constructed by a
198 : // levelIter.
199 : level manifest.Level
200 : // disableLazyCombinedIteration is an internal testing option.
201 : disableLazyCombinedIteration bool
202 : // snapshotForHideObsoletePoints is specified for/by levelIter when opening
203 : // files and is used to decide whether to hide obsolete points. A value of 0
204 : // implies obsolete points should not be hidden.
205 : snapshotForHideObsoletePoints uint64
206 :
207 : // NB: If adding new Options, you must account for them in iterator
208 : // construction and Iterator.SetOptions.
209 : }
210 :
211 : // GetLowerBound returns the LowerBound or nil if the receiver is nil.
212 1 : func (o *IterOptions) GetLowerBound() []byte {
213 1 : if o == nil {
214 1 : return nil
215 1 : }
216 1 : return o.LowerBound
217 : }
218 :
219 : // GetUpperBound returns the UpperBound or nil if the receiver is nil.
220 1 : func (o *IterOptions) GetUpperBound() []byte {
221 1 : if o == nil {
222 1 : return nil
223 1 : }
224 1 : return o.UpperBound
225 : }
226 :
227 1 : func (o *IterOptions) pointKeys() bool {
228 1 : if o == nil {
229 0 : return true
230 0 : }
231 1 : return o.KeyTypes == IterKeyTypePointsOnly || o.KeyTypes == IterKeyTypePointsAndRanges
232 : }
233 :
234 1 : func (o *IterOptions) rangeKeys() bool {
235 1 : if o == nil {
236 0 : return false
237 0 : }
238 1 : return o.KeyTypes == IterKeyTypeRangesOnly || o.KeyTypes == IterKeyTypePointsAndRanges
239 : }
240 :
241 1 : func (o *IterOptions) getLogger() Logger {
242 1 : if o == nil || o.logger == nil {
243 1 : return DefaultLogger
244 1 : }
245 1 : return o.logger
246 : }
247 :
248 : // SpanIterOptions creates a SpanIterOptions from this IterOptions.
249 1 : func (o *IterOptions) SpanIterOptions() keyspan.SpanIterOptions {
250 1 : if o == nil {
251 1 : return keyspan.SpanIterOptions{}
252 1 : }
253 1 : return keyspan.SpanIterOptions{
254 1 : RangeKeyFilters: o.RangeKeyFilters,
255 1 : }
256 : }
257 :
258 : // scanInternalOptions is similar to IterOptions, meant for use with
259 : // scanInternalIterator.
260 : type scanInternalOptions struct {
261 : sstable.CategoryAndQoS
262 : IterOptions
263 :
264 : visitPointKey func(key *InternalKey, value LazyValue, iterInfo IteratorLevel) error
265 : visitRangeDel func(start, end []byte, seqNum uint64) error
266 : visitRangeKey func(start, end []byte, keys []rangekey.Key) error
267 : visitSharedFile func(sst *SharedSSTMeta) error
268 : visitExternalFile func(sst *ExternalFile) error
269 :
270 : // includeObsoleteKeys specifies whether keys shadowed by newer internal keys
271 : // are exposed. If false, only one internal key per user key is exposed.
272 : includeObsoleteKeys bool
273 :
274 : // rateLimitFunc is used to limit the amount of bytes read per second.
275 : rateLimitFunc func(key *InternalKey, value LazyValue) error
276 : }
277 :
278 : // RangeKeyMasking configures automatic hiding of point keys by range keys. A
279 : // non-nil Suffix enables range-key masking. When enabled, range keys with
280 : // suffixes ≥ Suffix behave as masks. All point keys that are contained within a
281 : // masking range key's bounds and have suffixes greater than the range key's
282 : // suffix are automatically skipped.
283 : //
284 : // Specifically, when configured with a RangeKeyMasking.Suffix _s_, and there
285 : // exists a range key with suffix _r_ covering a point key with suffix _p_, and
286 : //
287 : // _s_ ≤ _r_ < _p_
288 : //
289 : // then the point key is elided.
290 : //
291 : // Range-key masking may only be used when iterating over both point keys and
292 : // range keys with IterKeyTypePointsAndRanges.
293 : type RangeKeyMasking struct {
294 : // Suffix configures which range keys may mask point keys. Only range keys
295 : // that are defined at suffixes greater than or equal to Suffix will mask
296 : // point keys.
297 : Suffix []byte
298 : // Filter is an optional field that may be used to improve performance of
299 : // range-key masking through a block-property filter defined over key
300 : // suffixes. If non-nil, Filter is called by Pebble to construct a
301 : // block-property filter mask at iterator creation. The filter is used to
302 : // skip whole point-key blocks containing point keys with suffixes greater
303 : // than a covering range-key's suffix.
304 : //
305 : // To use this functionality, the caller must create and configure (through
306 : // Options.BlockPropertyCollectors) a block-property collector that records
307 : // the maxmimum suffix contained within a block. The caller then must write
308 : // and provide a BlockPropertyFilterMask implementation on that same
309 : // property. See the BlockPropertyFilterMask type for more information.
310 : Filter func() BlockPropertyFilterMask
311 : }
312 :
313 : // BlockPropertyFilterMask extends the BlockPropertyFilter interface for use
314 : // with range-key masking. Unlike an ordinary block property filter, a
315 : // BlockPropertyFilterMask's filtering criteria is allowed to change when Pebble
316 : // invokes its SetSuffix method.
317 : //
318 : // When a Pebble iterator steps into a range key's bounds and the range key has
319 : // a suffix greater than or equal to RangeKeyMasking.Suffix, the range key acts
320 : // as a mask. The masking range key hides all point keys that fall within the
321 : // range key's bounds and have suffixes > the range key's suffix. Without a
322 : // filter mask configured, Pebble performs this hiding by stepping through point
323 : // keys and comparing suffixes. If large numbers of point keys are masked, this
324 : // requires Pebble to load, iterate through and discard a large number of
325 : // sstable blocks containing masked point keys.
326 : //
327 : // If a block-property collector and a filter mask are configured, Pebble may
328 : // skip loading some point-key blocks altogether. If a block's keys are known to
329 : // all fall within the bounds of the masking range key and the block was
330 : // annotated by a block-property collector with the maximal suffix, Pebble can
331 : // ask the filter mask to compare the property to the current masking range
332 : // key's suffix. If the mask reports no intersection, the block may be skipped.
333 : //
334 : // If unsuffixed and suffixed keys are written to the database, care must be
335 : // taken to avoid unintentionally masking un-suffixed keys located in the same
336 : // block as suffixed keys. One solution is to interpret unsuffixed keys as
337 : // containing the maximal suffix value, ensuring that blocks containing
338 : // unsuffixed keys are always loaded.
339 : type BlockPropertyFilterMask interface {
340 : BlockPropertyFilter
341 :
342 : // SetSuffix configures the mask with the suffix of a range key. The filter
343 : // should return false from Intersects whenever it's provided with a
344 : // property encoding a block's minimum suffix that's greater (according to
345 : // Compare) than the provided suffix.
346 : SetSuffix(suffix []byte) error
347 : }
348 :
349 : // WriteOptions hold the optional per-query parameters for Set and Delete
350 : // operations.
351 : //
352 : // Like Options, a nil *WriteOptions is valid and means to use the default
353 : // values.
354 : type WriteOptions struct {
355 : // Sync is whether to sync writes through the OS buffer cache and down onto
356 : // the actual disk, if applicable. Setting Sync is required for durability of
357 : // individual write operations but can result in slower writes.
358 : //
359 : // If false, and the process or machine crashes, then a recent write may be
360 : // lost. This is due to the recently written data being buffered inside the
361 : // process running Pebble. This differs from the semantics of a write system
362 : // call in which the data is buffered in the OS buffer cache and would thus
363 : // survive a process crash.
364 : //
365 : // The default value is true.
366 : Sync bool
367 : }
368 :
369 : // Sync specifies the default write options for writes which synchronize to
370 : // disk.
371 : var Sync = &WriteOptions{Sync: true}
372 :
373 : // NoSync specifies the default write options for writes which do not
374 : // synchronize to disk.
375 : var NoSync = &WriteOptions{Sync: false}
376 :
377 : // GetSync returns the Sync value or true if the receiver is nil.
378 1 : func (o *WriteOptions) GetSync() bool {
379 1 : return o == nil || o.Sync
380 1 : }
381 :
382 : // LevelOptions holds the optional per-level parameters.
383 : type LevelOptions struct {
384 : // BlockRestartInterval is the number of keys between restart points
385 : // for delta encoding of keys.
386 : //
387 : // The default value is 16.
388 : BlockRestartInterval int
389 :
390 : // BlockSize is the target uncompressed size in bytes of each table block.
391 : //
392 : // The default value is 4096.
393 : BlockSize int
394 :
395 : // BlockSizeThreshold finishes a block if the block size is larger than the
396 : // specified percentage of the target block size and adding the next entry
397 : // would cause the block to be larger than the target block size.
398 : //
399 : // The default value is 90
400 : BlockSizeThreshold int
401 :
402 : // Compression defines the per-block compression to use.
403 : //
404 : // The default value (DefaultCompression) uses snappy compression.
405 : Compression func() Compression
406 :
407 : // FilterPolicy defines a filter algorithm (such as a Bloom filter) that can
408 : // reduce disk reads for Get calls.
409 : //
410 : // One such implementation is bloom.FilterPolicy(10) from the pebble/bloom
411 : // package.
412 : //
413 : // The default value means to use no filter.
414 : FilterPolicy FilterPolicy
415 :
416 : // FilterType defines whether an existing filter policy is applied at a
417 : // block-level or table-level. Block-level filters use less memory to create,
418 : // but are slower to access as a check for the key in the index must first be
419 : // performed to locate the filter block. A table-level filter will require
420 : // memory proportional to the number of keys in an sstable to create, but
421 : // avoids the index lookup when determining if a key is present. Table-level
422 : // filters should be preferred except under constrained memory situations.
423 : FilterType FilterType
424 :
425 : // IndexBlockSize is the target uncompressed size in bytes of each index
426 : // block. When the index block size is larger than this target, two-level
427 : // indexes are automatically enabled. Setting this option to a large value
428 : // (such as math.MaxInt32) disables the automatic creation of two-level
429 : // indexes.
430 : //
431 : // The default value is the value of BlockSize.
432 : IndexBlockSize int
433 :
434 : // The target file size for the level.
435 : TargetFileSize int64
436 : }
437 :
438 : // EnsureDefaults ensures that the default values for all of the options have
439 : // been initialized. It is valid to call EnsureDefaults on a nil receiver. A
440 : // non-nil result will always be returned.
441 1 : func (o *LevelOptions) EnsureDefaults() *LevelOptions {
442 1 : if o == nil {
443 0 : o = &LevelOptions{}
444 0 : }
445 1 : if o.BlockRestartInterval <= 0 {
446 0 : o.BlockRestartInterval = base.DefaultBlockRestartInterval
447 0 : }
448 1 : if o.BlockSize <= 0 {
449 0 : o.BlockSize = base.DefaultBlockSize
450 1 : } else if o.BlockSize > sstable.MaximumBlockSize {
451 0 : panic(errors.Errorf("BlockSize %d exceeds MaximumBlockSize", o.BlockSize))
452 : }
453 1 : if o.BlockSizeThreshold <= 0 {
454 0 : o.BlockSizeThreshold = base.DefaultBlockSizeThreshold
455 0 : }
456 1 : if o.Compression == nil {
457 0 : o.Compression = func() Compression { return DefaultCompression }
458 : }
459 1 : if o.IndexBlockSize <= 0 {
460 0 : o.IndexBlockSize = o.BlockSize
461 0 : }
462 1 : if o.TargetFileSize <= 0 {
463 0 : o.TargetFileSize = 2 << 20 // 2 MB
464 0 : }
465 1 : return o
466 : }
467 :
468 : // Options holds the optional parameters for configuring pebble. These options
469 : // apply to the DB at large; per-query options are defined by the IterOptions
470 : // and WriteOptions types.
471 : type Options struct {
472 : // Sync sstables periodically in order to smooth out writes to disk. This
473 : // option does not provide any persistency guarantee, but is used to avoid
474 : // latency spikes if the OS automatically decides to write out a large chunk
475 : // of dirty filesystem buffers. This option only controls SSTable syncs; WAL
476 : // syncs are controlled by WALBytesPerSync.
477 : //
478 : // The default value is 512KB.
479 : BytesPerSync int
480 :
481 : // Cache is used to cache uncompressed blocks from sstables.
482 : //
483 : // The default cache size is 8 MB.
484 : Cache *cache.Cache
485 :
486 : // Cleaner cleans obsolete files.
487 : //
488 : // The default cleaner uses the DeleteCleaner.
489 : Cleaner Cleaner
490 :
491 : // Comparer defines a total ordering over the space of []byte keys: a 'less
492 : // than' relationship. The same comparison algorithm must be used for reads
493 : // and writes over the lifetime of the DB.
494 : //
495 : // The default value uses the same ordering as bytes.Compare.
496 : Comparer *Comparer
497 :
498 : // DebugCheck is invoked, if non-nil, whenever a new version is being
499 : // installed. Typically, this is set to pebble.DebugCheckLevels in tests
500 : // or tools only, to check invariants over all the data in the database.
501 : DebugCheck func(*DB) error
502 :
503 : // Disable the write-ahead log (WAL). Disabling the write-ahead log prohibits
504 : // crash recovery, but can improve performance if crash recovery is not
505 : // needed (e.g. when only temporary state is being stored in the database).
506 : //
507 : // TODO(peter): untested
508 : DisableWAL bool
509 :
510 : // ErrorIfExists causes an error on Open if the database already exists.
511 : // The error can be checked with errors.Is(err, ErrDBAlreadyExists).
512 : //
513 : // The default value is false.
514 : ErrorIfExists bool
515 :
516 : // ErrorIfNotExists causes an error on Open if the database does not already
517 : // exist. The error can be checked with errors.Is(err, ErrDBDoesNotExist).
518 : //
519 : // The default value is false which will cause a database to be created if it
520 : // does not already exist.
521 : ErrorIfNotExists bool
522 :
523 : // ErrorIfNotPristine causes an error on Open if the database already exists
524 : // and any operations have been performed on the database. The error can be
525 : // checked with errors.Is(err, ErrDBNotPristine).
526 : //
527 : // Note that a database that contained keys that were all subsequently deleted
528 : // may or may not trigger the error. Currently, we check if there are any live
529 : // SSTs or log records to replay.
530 : ErrorIfNotPristine bool
531 :
532 : // EventListener provides hooks to listening to significant DB events such as
533 : // flushes, compactions, and table deletion.
534 : EventListener *EventListener
535 :
536 : // Experimental contains experimental options which are off by default.
537 : // These options are temporary and will eventually either be deleted, moved
538 : // out of the experimental group, or made the non-adjustable default. These
539 : // options may change at any time, so do not rely on them.
540 : Experimental struct {
541 : // The threshold of L0 read-amplification at which compaction concurrency
542 : // is enabled (if CompactionDebtConcurrency was not already exceeded).
543 : // Every multiple of this value enables another concurrent
544 : // compaction up to MaxConcurrentCompactions.
545 : L0CompactionConcurrency int
546 :
547 : // CompactionDebtConcurrency controls the threshold of compaction debt
548 : // at which additional compaction concurrency slots are added. For every
549 : // multiple of this value in compaction debt bytes, an additional
550 : // concurrent compaction is added. This works "on top" of
551 : // L0CompactionConcurrency, so the higher of the count of compaction
552 : // concurrency slots as determined by the two options is chosen.
553 : CompactionDebtConcurrency uint64
554 :
555 : // IngestSplit, if it returns true, allows for ingest-time splitting of
556 : // existing sstables into two virtual sstables to allow ingestion sstables to
557 : // slot into a lower level than they otherwise would have.
558 : IngestSplit func() bool
559 :
560 : // ReadCompactionRate controls the frequency of read triggered
561 : // compactions by adjusting `AllowedSeeks` in manifest.FileMetadata:
562 : //
563 : // AllowedSeeks = FileSize / ReadCompactionRate
564 : //
565 : // From LevelDB:
566 : // ```
567 : // We arrange to automatically compact this file after
568 : // a certain number of seeks. Let's assume:
569 : // (1) One seek costs 10ms
570 : // (2) Writing or reading 1MB costs 10ms (100MB/s)
571 : // (3) A compaction of 1MB does 25MB of IO:
572 : // 1MB read from this level
573 : // 10-12MB read from next level (boundaries may be misaligned)
574 : // 10-12MB written to next level
575 : // This implies that 25 seeks cost the same as the compaction
576 : // of 1MB of data. I.e., one seek costs approximately the
577 : // same as the compaction of 40KB of data. We are a little
578 : // conservative and allow approximately one seek for every 16KB
579 : // of data before triggering a compaction.
580 : // ```
581 : ReadCompactionRate int64
582 :
583 : // ReadSamplingMultiplier is a multiplier for the readSamplingPeriod in
584 : // iterator.maybeSampleRead() to control the frequency of read sampling
585 : // to trigger a read triggered compaction. A value of -1 prevents sampling
586 : // and disables read triggered compactions. The default is 1 << 4. which
587 : // gets multiplied with a constant of 1 << 16 to yield 1 << 20 (1MB).
588 : ReadSamplingMultiplier int64
589 :
590 : // TableCacheShards is the number of shards per table cache.
591 : // Reducing the value can reduce the number of idle goroutines per DB
592 : // instance which can be useful in scenarios with a lot of DB instances
593 : // and a large number of CPUs, but doing so can lead to higher contention
594 : // in the table cache and reduced performance.
595 : //
596 : // The default value is the number of logical CPUs, which can be
597 : // limited by runtime.GOMAXPROCS.
598 : TableCacheShards int
599 :
600 : // KeyValidationFunc is a function to validate a user key in an SSTable.
601 : //
602 : // Currently, this function is used to validate the smallest and largest
603 : // keys in an SSTable undergoing compaction. In this case, returning an
604 : // error from the validation function will result in a panic at runtime,
605 : // given that there is rarely any way of recovering from malformed keys
606 : // present in compacted files. By default, validation is not performed.
607 : //
608 : // Additional use-cases may be added in the future.
609 : //
610 : // NOTE: callers should take care to not mutate the key being validated.
611 : KeyValidationFunc func(userKey []byte) error
612 :
613 : // ValidateOnIngest schedules validation of sstables after they have
614 : // been ingested.
615 : //
616 : // By default, this value is false.
617 : ValidateOnIngest bool
618 :
619 : // LevelMultiplier configures the size multiplier used to determine the
620 : // desired size of each level of the LSM. Defaults to 10.
621 : LevelMultiplier int
622 :
623 : // MultiLevelCompactionHeuristic determines whether to add an additional
624 : // level to a conventional two level compaction. If nil, a multilevel
625 : // compaction will never get triggered.
626 : MultiLevelCompactionHeuristic MultiLevelHeuristic
627 :
628 : // MaxWriterConcurrency is used to indicate the maximum number of
629 : // compression workers the compression queue is allowed to use. If
630 : // MaxWriterConcurrency > 0, then the Writer will use parallelism, to
631 : // compress and write blocks to disk. Otherwise, the writer will
632 : // compress and write blocks to disk synchronously.
633 : MaxWriterConcurrency int
634 :
635 : // ForceWriterParallelism is used to force parallelism in the sstable
636 : // Writer for the metamorphic tests. Even with the MaxWriterConcurrency
637 : // option set, we only enable parallelism in the sstable Writer if there
638 : // is enough CPU available, and this option bypasses that.
639 : ForceWriterParallelism bool
640 :
641 : // CPUWorkPermissionGranter should be set if Pebble should be given the
642 : // ability to optionally schedule additional CPU. See the documentation
643 : // for CPUWorkPermissionGranter for more details.
644 : CPUWorkPermissionGranter CPUWorkPermissionGranter
645 :
646 : // EnableValueBlocks is used to decide whether to enable writing
647 : // TableFormatPebblev3 sstables. This setting is only respected by a
648 : // specific subset of format major versions: FormatSSTableValueBlocks,
649 : // FormatFlushableIngest and FormatPrePebblev1MarkedCompacted. In lower
650 : // format major versions, value blocks are never enabled. In higher
651 : // format major versions, value blocks are always enabled.
652 : EnableValueBlocks func() bool
653 :
654 : // ShortAttributeExtractor is used iff EnableValueBlocks() returns true
655 : // (else ignored). If non-nil, a ShortAttribute can be extracted from the
656 : // value and stored with the key, when the value is stored elsewhere.
657 : ShortAttributeExtractor ShortAttributeExtractor
658 :
659 : // RequiredInPlaceValueBound specifies an optional span of user key
660 : // prefixes that are not-MVCC, but have a suffix. For these the values
661 : // must be stored with the key, since the concept of "older versions" is
662 : // not defined. It is also useful for statically known exclusions to value
663 : // separation. In CockroachDB, this will be used for the lock table key
664 : // space that has non-empty suffixes, but those locks don't represent
665 : // actual MVCC versions (the suffix ordering is arbitrary). We will also
666 : // need to add support for dynamically configured exclusions (we want the
667 : // default to be to allow Pebble to decide whether to separate the value
668 : // or not, hence this is structured as exclusions), for example, for users
669 : // of CockroachDB to dynamically exclude certain tables.
670 : //
671 : // Any change in exclusion behavior takes effect only on future written
672 : // sstables, and does not start rewriting existing sstables.
673 : //
674 : // Even ignoring changes in this setting, exclusions are interpreted as a
675 : // guidance by Pebble, and not necessarily honored. Specifically, user
676 : // keys with multiple Pebble-versions *may* have the older versions stored
677 : // in value blocks.
678 : RequiredInPlaceValueBound UserKeyPrefixBound
679 :
680 : // DisableIngestAsFlushable disables lazy ingestion of sstables through
681 : // a WAL write and memtable rotation. Only effectual if the format
682 : // major version is at least `FormatFlushableIngest`.
683 : DisableIngestAsFlushable func() bool
684 :
685 : // CheckExternalIngestions enables opening external ssts at ingest time and
686 : // validating that they are not empty. Used for testing/debugging.
687 : CheckExternalIngestions bool
688 :
689 : // RemoteStorage enables use of remote storage (e.g. S3) for storing
690 : // sstables. Setting this option enables use of CreateOnShared option and
691 : // allows ingestion of external files.
692 : RemoteStorage remote.StorageFactory
693 :
694 : // If CreateOnShared is non-zero, new sstables are created on remote storage
695 : // (using CreateOnSharedLocator and with the appropriate
696 : // CreateOnSharedStrategy). These sstables can be shared between different
697 : // Pebble instances; the lifecycle of such objects is managed by the
698 : // remote.Storage constructed by options.RemoteStorage.
699 : //
700 : // Can only be used when RemoteStorage is set (and recognizes
701 : // CreateOnSharedLocator).
702 : CreateOnShared remote.CreateOnSharedStrategy
703 : CreateOnSharedLocator remote.Locator
704 :
705 : // CacheSizeBytesBytes is the size of the on-disk block cache for objects
706 : // on shared storage in bytes. If it is 0, no cache is used.
707 : SecondaryCacheSizeBytes int64
708 :
709 : // NB: DO NOT crash on SingleDeleteInvariantViolationCallback or
710 : // IneffectualSingleDeleteCallback, since these can be false positives
711 : // even if SingleDel has been used correctly.
712 : //
713 : // Pebble's delete-only compactions can cause a recent RANGEDEL to peek
714 : // below an older SINGLEDEL and delete an arbitrary subset of data below
715 : // that SINGLEDEL. When that SINGLEDEL gets compacted (without the
716 : // RANGEDEL), any of these callbacks can happen, without it being a real
717 : // correctness problem.
718 : //
719 : // Example 1:
720 : // RANGEDEL [a, c)#10 in L0
721 : // SINGLEDEL b#5 in L1
722 : // SET b#3 in L6
723 : //
724 : // If the L6 file containing the SET is narrow and the L1 file containing
725 : // the SINGLEDEL is wide, a delete-only compaction can remove the file in
726 : // L2 before the SINGLEDEL is compacted down. Then when the SINGLEDEL is
727 : // compacted down, it will not find any SET to delete, resulting in the
728 : // ineffectual callback.
729 : //
730 : // Example 2:
731 : // RANGEDEL [a, z)#60 in L0
732 : // SINGLEDEL g#50 in L1
733 : // SET g#40 in L2
734 : // RANGEDEL [g,h)#30 in L3
735 : // SET g#20 in L6
736 : //
737 : // In this example, the two SETs represent the same user write, and the
738 : // RANGEDELs are caused by the CockroachDB range being dropped. That is,
739 : // the user wrote to g once, range was dropped, then added back, which
740 : // caused the SET again, then at some point g was validly deleted using a
741 : // SINGLEDEL, and then the range was dropped again. The older RANGEDEL can
742 : // get fragmented due to compactions it has been part of. Say this L3 file
743 : // containing the RANGEDEL is very narrow, while the L1, L2, L6 files are
744 : // wider than the RANGEDEL in L0. Then the RANGEDEL in L3 can be dropped
745 : // using a delete-only compaction, resulting in an LSM with state:
746 : //
747 : // RANGEDEL [a, z)#60 in L0
748 : // SINGLEDEL g#50 in L1
749 : // SET g#40 in L2
750 : // SET g#20 in L6
751 : //
752 : // A multi-level compaction involving L1, L2, L6 will cause the invariant
753 : // violation callback. This example doesn't need multi-level compactions:
754 : // say there was a Pebble snapshot at g#21 preventing g#20 from being
755 : // dropped when it meets g#40 in a compaction. That snapshot will not save
756 : // RANGEDEL [g,h)#30, so we can have:
757 : //
758 : // SINGLEDEL g#50 in L1
759 : // SET g#40, SET g#20 in L6
760 : //
761 : // And say the snapshot is removed and then the L1 and L6 compaction
762 : // happens, resulting in the invariant violation callback.
763 : //
764 : // TODO(sumeer): rename SingleDeleteInvariantViolationCallback to remove
765 : // the word "invariant".
766 :
767 : // IneffectualPointDeleteCallback is called in compactions/flushes if any
768 : // single delete is being elided without deleting a point set/merge.
769 : IneffectualSingleDeleteCallback func(userKey []byte)
770 :
771 : // SingleDeleteInvariantViolationCallback is called in compactions/flushes if any
772 : // single delete has consumed a Set/Merge, and there is another immediately older
773 : // Set/SetWithDelete/Merge. The user of Pebble has violated the invariant under
774 : // which SingleDelete can be used correctly.
775 : //
776 : // Consider the sequence SingleDelete#3, Set#2, Set#1. There are three
777 : // ways some of these keys can first meet in a compaction.
778 : //
779 : // - All 3 keys in the same compaction: this callback will detect the
780 : // violation.
781 : //
782 : // - SingleDelete#3, Set#2 meet in a compaction first: Both keys will
783 : // disappear. The violation will not be detected, and the DB will have
784 : // Set#1 which is likely incorrect (from the user's perspective).
785 : //
786 : // - Set#2, Set#1 meet in a compaction first: The output will be Set#2,
787 : // which will later be consumed by SingleDelete#3. The violation will
788 : // not be detected and the DB will be correct.
789 : SingleDeleteInvariantViolationCallback func(userKey []byte)
790 : }
791 :
792 : // Filters is a map from filter policy name to filter policy. It is used for
793 : // debugging tools which may be used on multiple databases configured with
794 : // different filter policies. It is not necessary to populate this filters
795 : // map during normal usage of a DB.
796 : Filters map[string]FilterPolicy
797 :
798 : // FlushDelayDeleteRange configures how long the database should wait before
799 : // forcing a flush of a memtable that contains a range deletion. Disk space
800 : // cannot be reclaimed until the range deletion is flushed. No automatic
801 : // flush occurs if zero.
802 : FlushDelayDeleteRange time.Duration
803 :
804 : // FlushDelayRangeKey configures how long the database should wait before
805 : // forcing a flush of a memtable that contains a range key. Range keys in
806 : // the memtable prevent lazy combined iteration, so it's desirable to flush
807 : // range keys promptly. No automatic flush occurs if zero.
808 : FlushDelayRangeKey time.Duration
809 :
810 : // FlushSplitBytes denotes the target number of bytes per sublevel in
811 : // each flush split interval (i.e. range between two flush split keys)
812 : // in L0 sstables. When set to zero, only a single sstable is generated
813 : // by each flush. When set to a non-zero value, flushes are split at
814 : // points to meet L0's TargetFileSize, any grandparent-related overlap
815 : // options, and at boundary keys of L0 flush split intervals (which are
816 : // targeted to contain around FlushSplitBytes bytes in each sublevel
817 : // between pairs of boundary keys). Splitting sstables during flush
818 : // allows increased compaction flexibility and concurrency when those
819 : // tables are compacted to lower levels.
820 : FlushSplitBytes int64
821 :
822 : // FormatMajorVersion sets the format of on-disk files. It is
823 : // recommended to set the format major version to an explicit
824 : // version, as the default may change over time.
825 : //
826 : // At Open if the existing database is formatted using a later
827 : // format major version that is known to this version of Pebble,
828 : // Pebble will continue to use the later format major version. If
829 : // the existing database's version is unknown, the caller may use
830 : // FormatMostCompatible and will be able to open the database
831 : // regardless of its actual version.
832 : //
833 : // If the existing database is formatted using a format major
834 : // version earlier than the one specified, Open will automatically
835 : // ratchet the database to the specified format major version.
836 : FormatMajorVersion FormatMajorVersion
837 :
838 : // FS provides the interface for persistent file storage.
839 : //
840 : // The default value uses the underlying operating system's file system.
841 : FS vfs.FS
842 :
843 : // Lock, if set, must be a database lock acquired through LockDirectory for
844 : // the same directory passed to Open. If provided, Open will skip locking
845 : // the directory. Closing the database will not release the lock, and it's
846 : // the responsibility of the caller to release the lock after closing the
847 : // database.
848 : //
849 : // Open will enforce that the Lock passed locks the same directory passed to
850 : // Open. Concurrent calls to Open using the same Lock are detected and
851 : // prohibited.
852 : Lock *Lock
853 :
854 : // The count of L0 files necessary to trigger an L0 compaction.
855 : L0CompactionFileThreshold int
856 :
857 : // The amount of L0 read-amplification necessary to trigger an L0 compaction.
858 : L0CompactionThreshold int
859 :
860 : // Hard limit on L0 read-amplification, computed as the number of L0
861 : // sublevels. Writes are stopped when this threshold is reached.
862 : L0StopWritesThreshold int
863 :
864 : // The maximum number of bytes for LBase. The base level is the level which
865 : // L0 is compacted into. The base level is determined dynamically based on
866 : // the existing data in the LSM. The maximum number of bytes for other levels
867 : // is computed dynamically based on the base level's maximum size. When the
868 : // maximum number of bytes for a level is exceeded, compaction is requested.
869 : LBaseMaxBytes int64
870 :
871 : // Per-level options. Options for at least one level must be specified. The
872 : // options for the last level are used for all subsequent levels.
873 : Levels []LevelOptions
874 :
875 : // LoggerAndTracer will be used, if non-nil, else Logger will be used and
876 : // tracing will be a noop.
877 :
878 : // Logger used to write log messages.
879 : //
880 : // The default logger uses the Go standard library log package.
881 : Logger Logger
882 : // LoggerAndTracer is used for writing log messages and traces.
883 : LoggerAndTracer LoggerAndTracer
884 :
885 : // MaxManifestFileSize is the maximum size the MANIFEST file is allowed to
886 : // become. When the MANIFEST exceeds this size it is rolled over and a new
887 : // MANIFEST is created.
888 : MaxManifestFileSize int64
889 :
890 : // MaxOpenFiles is a soft limit on the number of open files that can be
891 : // used by the DB.
892 : //
893 : // The default value is 1000.
894 : MaxOpenFiles int
895 :
896 : // The size of a MemTable in steady state. The actual MemTable size starts at
897 : // min(256KB, MemTableSize) and doubles for each subsequent MemTable up to
898 : // MemTableSize. This reduces the memory pressure caused by MemTables for
899 : // short lived (test) DB instances. Note that more than one MemTable can be
900 : // in existence since flushing a MemTable involves creating a new one and
901 : // writing the contents of the old one in the
902 : // background. MemTableStopWritesThreshold places a hard limit on the size of
903 : // the queued MemTables.
904 : //
905 : // The default value is 4MB.
906 : MemTableSize uint64
907 :
908 : // Hard limit on the number of queued of MemTables. Writes are stopped when
909 : // the sum of the queued memtable sizes exceeds:
910 : // MemTableStopWritesThreshold * MemTableSize.
911 : //
912 : // This value should be at least 2 or writes will stop whenever a MemTable is
913 : // being flushed.
914 : //
915 : // The default value is 2.
916 : MemTableStopWritesThreshold int
917 :
918 : // Merger defines the associative merge operation to use for merging values
919 : // written with {Batch,DB}.Merge.
920 : //
921 : // The default merger concatenates values.
922 : Merger *Merger
923 :
924 : // MaxConcurrentCompactions specifies the maximum number of concurrent
925 : // compactions (not including download compactions).
926 : //
927 : // Concurrent compactions are performed:
928 : // - when L0 read-amplification passes the L0CompactionConcurrency threshold;
929 : // - for automatic background compactions;
930 : // - when a manual compaction for a level is split and parallelized.
931 : //
932 : // MaxConcurrentCompactions() must be greater than 0.
933 : //
934 : // The default value is 1.
935 : MaxConcurrentCompactions func() int
936 :
937 : // MaxConcurrentDownloads specifies the maximum number of download
938 : // compactions. These are compactions that copy an external file to the local
939 : // store.
940 : //
941 : // This limit is independent of MaxConcurrentCompactions; at any point in
942 : // time, we may be running MaxConcurrentCompactions non-download compactions
943 : // and MaxConcurrentDownloads download compactions.
944 : //
945 : // MaxConcurrentDownloads() must be greater than 0.
946 : //
947 : // The default value is 1.
948 : MaxConcurrentDownloads func() int
949 :
950 : // DisableAutomaticCompactions dictates whether automatic compactions are
951 : // scheduled or not. The default is false (enabled). This option is only used
952 : // externally when running a manual compaction, and internally for tests.
953 : DisableAutomaticCompactions bool
954 :
955 : // DisableConsistencyCheck disables the consistency check that is performed on
956 : // open. Should only be used when a database cannot be opened normally (e.g.
957 : // some of the tables don't exist / aren't accessible).
958 : DisableConsistencyCheck bool
959 :
960 : // DisableTableStats dictates whether tables should be loaded asynchronously
961 : // to compute statistics that inform compaction heuristics. The collection
962 : // of table stats improves compaction of tombstones, reclaiming disk space
963 : // more quickly and in some cases reducing write amplification in the
964 : // presence of tombstones. Disabling table stats may be useful in tests
965 : // that require determinism as the asynchronicity of table stats collection
966 : // introduces significant nondeterminism.
967 : DisableTableStats bool
968 :
969 : // NoSyncOnClose decides whether the Pebble instance will enforce a
970 : // close-time synchronization (e.g., fdatasync() or sync_file_range())
971 : // on files it writes to. Setting this to true removes the guarantee for a
972 : // sync on close. Some implementations can still issue a non-blocking sync.
973 : NoSyncOnClose bool
974 :
975 : // NumPrevManifest is the number of non-current or older manifests which
976 : // we want to keep around for debugging purposes. By default, we're going
977 : // to keep one older manifest.
978 : NumPrevManifest int
979 :
980 : // ReadOnly indicates that the DB should be opened in read-only mode. Writes
981 : // to the DB will return an error, background compactions are disabled, and
982 : // the flush that normally occurs after replaying the WAL at startup is
983 : // disabled.
984 : ReadOnly bool
985 :
986 : // TableCache is an initialized TableCache which should be set as an
987 : // option if the DB needs to be initialized with a pre-existing table cache.
988 : // If TableCache is nil, then a table cache which is unique to the DB instance
989 : // is created. TableCache can be shared between db instances by setting it here.
990 : // The TableCache set here must use the same underlying cache as Options.Cache
991 : // and pebble will panic otherwise.
992 : TableCache *TableCache
993 :
994 : // BlockPropertyCollectors is a list of BlockPropertyCollector creation
995 : // functions. A new BlockPropertyCollector is created for each sstable
996 : // built and lives for the lifetime of writing that table.
997 : BlockPropertyCollectors []func() BlockPropertyCollector
998 :
999 : // WALBytesPerSync sets the number of bytes to write to a WAL before calling
1000 : // Sync on it in the background. Just like with BytesPerSync above, this
1001 : // helps smooth out disk write latencies, and avoids cases where the OS
1002 : // writes a lot of buffered data to disk at once. However, this is less
1003 : // necessary with WALs, as many write operations already pass in
1004 : // Sync = true.
1005 : //
1006 : // The default value is 0, i.e. no background syncing. This matches the
1007 : // default behaviour in RocksDB.
1008 : WALBytesPerSync int
1009 :
1010 : // WALDir specifies the directory to store write-ahead logs (WALs) in. If
1011 : // empty (the default), WALs will be stored in the same directory as sstables
1012 : // (i.e. the directory passed to pebble.Open).
1013 : WALDir string
1014 :
1015 : // WALFailover may be set to configure Pebble to monitor writes to its
1016 : // write-ahead log and failover to writing write-ahead log entries to a
1017 : // secondary location (eg, a separate physical disk). WALFailover may be
1018 : // used to improve write availability in the presence of transient disk
1019 : // unavailability.
1020 : WALFailover *WALFailoverOptions
1021 :
1022 : // WALRecoveryDirs is a list of additional directories that should be
1023 : // scanned for the existence of additional write-ahead logs. WALRecoveryDirs
1024 : // is expected to be used when starting Pebble with a new WALDir or a new
1025 : // WALFailover configuration. The directories associated with the previous
1026 : // configuration may still contain WALs that are required for recovery of
1027 : // the current database state.
1028 : //
1029 : // If a previous WAL configuration may have stored WALs elsewhere but there
1030 : // is not a corresponding entry in WALRecoveryDirs, Open will error.
1031 : WALRecoveryDirs []wal.Dir
1032 :
1033 : // WALMinSyncInterval is the minimum duration between syncs of the WAL. If
1034 : // WAL syncs are requested faster than this interval, they will be
1035 : // artificially delayed. Introducing a small artificial delay (500us) between
1036 : // WAL syncs can allow more operations to arrive and reduce IO operations
1037 : // while having a minimal impact on throughput. This option is supplied as a
1038 : // closure in order to allow the value to be changed dynamically. The default
1039 : // value is 0.
1040 : //
1041 : // TODO(peter): rather than a closure, should there be another mechanism for
1042 : // changing options dynamically?
1043 : WALMinSyncInterval func() time.Duration
1044 :
1045 : // TargetByteDeletionRate is the rate (in bytes per second) at which sstable file
1046 : // deletions are limited to (under normal circumstances).
1047 : //
1048 : // Deletion pacing is used to slow down deletions when compactions finish up
1049 : // or readers close and newly-obsolete files need cleaning up. Deleting lots
1050 : // of files at once can cause disk latency to go up on some SSDs, which this
1051 : // functionality guards against.
1052 : //
1053 : // This value is only a best-effort target; the effective rate can be
1054 : // higher if deletions are falling behind or disk space is running low.
1055 : //
1056 : // Setting this to 0 disables deletion pacing, which is also the default.
1057 : TargetByteDeletionRate int
1058 :
1059 : // EnableSQLRowSpillMetrics specifies whether the Pebble instance will only be used
1060 : // to temporarily persist data spilled to disk for row-oriented SQL query execution.
1061 : EnableSQLRowSpillMetrics bool
1062 :
1063 : // AllocatorSizeClasses provides a sorted list containing the supported size
1064 : // classes of the underlying memory allocator. This provides hints to the
1065 : // sstable block writer's flushing policy to select block sizes that
1066 : // preemptively reduce internal fragmentation when loaded into the block cache.
1067 : AllocatorSizeClasses []int
1068 :
1069 : // private options are only used by internal tests or are used internally
1070 : // for facilitating upgrade paths of unconfigurable functionality.
1071 : private struct {
1072 : // disableDeleteOnlyCompactions prevents the scheduling of delete-only
1073 : // compactions that drop sstables wholy covered by range tombstones or
1074 : // range key tombstones.
1075 : disableDeleteOnlyCompactions bool
1076 :
1077 : // disableElisionOnlyCompactions prevents the scheduling of elision-only
1078 : // compactions that rewrite sstables in place in order to elide obsolete
1079 : // keys.
1080 : disableElisionOnlyCompactions bool
1081 :
1082 : // disableLazyCombinedIteration is a private option used by the
1083 : // metamorphic tests to test equivalence between lazy-combined iteration
1084 : // and constructing the range-key iterator upfront. It's a private
1085 : // option to avoid littering the public interface with options that we
1086 : // do not want to allow users to actually configure.
1087 : disableLazyCombinedIteration bool
1088 :
1089 : // testingAlwaysWaitForCleanup is set by some tests to force waiting for
1090 : // obsolete file deletion (to make events deterministic).
1091 : testingAlwaysWaitForCleanup bool
1092 :
1093 : // fsCloser holds a closer that should be invoked after a DB using these
1094 : // Options is closed. This is used to automatically stop the
1095 : // long-running goroutine associated with the disk-health-checking FS.
1096 : // See the initialization of FS in EnsureDefaults. Note that care has
1097 : // been taken to ensure that it is still safe to continue using the FS
1098 : // after this closer has been invoked. However, if write operations
1099 : // against the FS are made after the DB is closed, the FS may leak a
1100 : // goroutine indefinitely.
1101 : fsCloser io.Closer
1102 : }
1103 : }
1104 :
1105 : // WALFailoverOptions configures the WAL failover mechanics to use during
1106 : // transient write unavailability on the primary WAL volume.
1107 : type WALFailoverOptions struct {
1108 : // Secondary indicates the secondary directory and VFS to use in the event a
1109 : // write to the primary WAL stalls.
1110 : Secondary wal.Dir
1111 : // FailoverOptions provides configuration of the thresholds and intervals
1112 : // involved in WAL failover. If any of its fields are left unspecified,
1113 : // reasonable defaults will be used.
1114 : wal.FailoverOptions
1115 : }
1116 :
1117 : // DebugCheckLevels calls CheckLevels on the provided database.
1118 : // It may be set in the DebugCheck field of Options to check
1119 : // level invariants whenever a new version is installed.
1120 1 : func DebugCheckLevels(db *DB) error {
1121 1 : return db.CheckLevels(nil)
1122 1 : }
1123 :
1124 : // EnsureDefaults ensures that the default values for all options are set if a
1125 : // valid value was not already specified. Returns the new options.
1126 1 : func (o *Options) EnsureDefaults() *Options {
1127 1 : if o == nil {
1128 0 : o = &Options{}
1129 0 : }
1130 1 : o.Comparer = o.Comparer.EnsureDefaults()
1131 1 :
1132 1 : if o.BytesPerSync <= 0 {
1133 0 : o.BytesPerSync = 512 << 10 // 512 KB
1134 0 : }
1135 1 : if o.Cleaner == nil {
1136 0 : o.Cleaner = DeleteCleaner{}
1137 0 : }
1138 :
1139 1 : if o.Experimental.DisableIngestAsFlushable == nil {
1140 1 : o.Experimental.DisableIngestAsFlushable = func() bool { return false }
1141 : }
1142 1 : if o.Experimental.L0CompactionConcurrency <= 0 {
1143 0 : o.Experimental.L0CompactionConcurrency = 10
1144 0 : }
1145 1 : if o.Experimental.CompactionDebtConcurrency <= 0 {
1146 0 : o.Experimental.CompactionDebtConcurrency = 1 << 30 // 1 GB
1147 0 : }
1148 1 : if o.Experimental.KeyValidationFunc == nil {
1149 1 : o.Experimental.KeyValidationFunc = func([]byte) error { return nil }
1150 : }
1151 1 : if o.L0CompactionThreshold <= 0 {
1152 0 : o.L0CompactionThreshold = 4
1153 0 : }
1154 1 : if o.L0CompactionFileThreshold <= 0 {
1155 0 : // Some justification for the default of 500:
1156 0 : // Why not smaller?:
1157 0 : // - The default target file size for L0 is 2MB, so 500 files is <= 1GB
1158 0 : // of data. At observed compaction speeds of > 20MB/s, L0 can be
1159 0 : // cleared of all files in < 1min, so this backlog is not huge.
1160 0 : // - 500 files is low overhead for instantiating L0 sublevels from
1161 0 : // scratch.
1162 0 : // - Lower values were observed to cause excessive and inefficient
1163 0 : // compactions out of L0 in a TPCC import benchmark.
1164 0 : // Why not larger?:
1165 0 : // - More than 1min to compact everything out of L0.
1166 0 : // - CockroachDB's admission control system uses a threshold of 1000
1167 0 : // files to start throttling writes to Pebble. Using 500 here gives
1168 0 : // us headroom between when Pebble should start compacting L0 and
1169 0 : // when the admission control threshold is reached.
1170 0 : //
1171 0 : // We can revisit this default in the future based on better
1172 0 : // experimental understanding.
1173 0 : //
1174 0 : // TODO(jackson): Experiment with slightly lower thresholds [or higher
1175 0 : // admission control thresholds] to see whether a higher L0 score at the
1176 0 : // threshold (currently 2.0) is necessary for some workloads to avoid
1177 0 : // starving L0 in favor of lower-level compactions.
1178 0 : o.L0CompactionFileThreshold = 500
1179 0 : }
1180 1 : if o.L0StopWritesThreshold <= 0 {
1181 0 : o.L0StopWritesThreshold = 12
1182 0 : }
1183 1 : if o.LBaseMaxBytes <= 0 {
1184 0 : o.LBaseMaxBytes = 64 << 20 // 64 MB
1185 0 : }
1186 1 : if o.Levels == nil {
1187 0 : o.Levels = make([]LevelOptions, 1)
1188 0 : for i := range o.Levels {
1189 0 : if i > 0 {
1190 0 : l := &o.Levels[i]
1191 0 : if l.TargetFileSize <= 0 {
1192 0 : l.TargetFileSize = o.Levels[i-1].TargetFileSize * 2
1193 0 : }
1194 : }
1195 0 : o.Levels[i].EnsureDefaults()
1196 : }
1197 1 : } else {
1198 1 : for i := range o.Levels {
1199 1 : o.Levels[i].EnsureDefaults()
1200 1 : }
1201 : }
1202 1 : if o.Logger == nil {
1203 1 : o.Logger = DefaultLogger
1204 1 : }
1205 1 : if o.EventListener == nil {
1206 1 : o.EventListener = &EventListener{}
1207 1 : }
1208 1 : o.EventListener.EnsureDefaults(o.Logger)
1209 1 : if o.MaxManifestFileSize == 0 {
1210 0 : o.MaxManifestFileSize = 128 << 20 // 128 MB
1211 0 : }
1212 1 : if o.MaxOpenFiles == 0 {
1213 0 : o.MaxOpenFiles = 1000
1214 0 : }
1215 1 : if o.MemTableSize <= 0 {
1216 0 : o.MemTableSize = 4 << 20 // 4 MB
1217 0 : }
1218 1 : if o.MemTableStopWritesThreshold <= 0 {
1219 0 : o.MemTableStopWritesThreshold = 2
1220 0 : }
1221 1 : if o.Merger == nil {
1222 0 : o.Merger = DefaultMerger
1223 0 : }
1224 1 : if o.MaxConcurrentCompactions == nil {
1225 0 : o.MaxConcurrentCompactions = func() int { return 1 }
1226 : }
1227 1 : if o.MaxConcurrentDownloads == nil {
1228 0 : o.MaxConcurrentDownloads = func() int { return 1 }
1229 : }
1230 1 : if o.NumPrevManifest <= 0 {
1231 1 : o.NumPrevManifest = 1
1232 1 : }
1233 :
1234 1 : if o.FormatMajorVersion == FormatDefault {
1235 0 : o.FormatMajorVersion = FormatMinSupported
1236 0 : if o.Experimental.CreateOnShared != remote.CreateOnSharedNone {
1237 0 : o.FormatMajorVersion = FormatMinForSharedObjects
1238 0 : }
1239 : }
1240 :
1241 1 : if o.FS == nil {
1242 0 : o.WithFSDefaults()
1243 0 : }
1244 1 : if o.FlushSplitBytes <= 0 {
1245 0 : o.FlushSplitBytes = 2 * o.Levels[0].TargetFileSize
1246 0 : }
1247 1 : if o.WALFailover != nil {
1248 1 : o.WALFailover.FailoverOptions.EnsureDefaults()
1249 1 : }
1250 1 : if o.Experimental.LevelMultiplier <= 0 {
1251 1 : o.Experimental.LevelMultiplier = defaultLevelMultiplier
1252 1 : }
1253 1 : if o.Experimental.ReadCompactionRate == 0 {
1254 0 : o.Experimental.ReadCompactionRate = 16000
1255 0 : }
1256 1 : if o.Experimental.ReadSamplingMultiplier == 0 {
1257 0 : o.Experimental.ReadSamplingMultiplier = 1 << 4
1258 0 : }
1259 1 : if o.Experimental.TableCacheShards <= 0 {
1260 0 : o.Experimental.TableCacheShards = runtime.GOMAXPROCS(0)
1261 0 : }
1262 1 : if o.Experimental.CPUWorkPermissionGranter == nil {
1263 1 : o.Experimental.CPUWorkPermissionGranter = defaultCPUWorkGranter{}
1264 1 : }
1265 1 : if o.Experimental.MultiLevelCompactionHeuristic == nil {
1266 0 : o.Experimental.MultiLevelCompactionHeuristic = WriteAmpHeuristic{}
1267 0 : }
1268 :
1269 1 : o.initMaps()
1270 1 : return o
1271 : }
1272 :
1273 : // WithFSDefaults configures the Options to wrap the configured filesystem with
1274 : // the default virtual file system middleware, like disk-health checking.
1275 1 : func (o *Options) WithFSDefaults() *Options {
1276 1 : if o.FS == nil {
1277 0 : o.FS = vfs.Default
1278 0 : }
1279 1 : o.FS, o.private.fsCloser = vfs.WithDiskHealthChecks(o.FS, 5*time.Second, nil,
1280 1 : func(info vfs.DiskSlowInfo) {
1281 0 : o.EventListener.DiskSlow(info)
1282 0 : })
1283 1 : return o
1284 : }
1285 :
1286 : // AddEventListener adds the provided event listener to the Options, in addition
1287 : // to any existing event listener.
1288 0 : func (o *Options) AddEventListener(l EventListener) {
1289 0 : if o.EventListener != nil {
1290 0 : l = TeeEventListener(l, *o.EventListener)
1291 0 : }
1292 0 : o.EventListener = &l
1293 : }
1294 :
1295 : // initMaps initializes the Comparers, Filters, and Mergers maps.
1296 1 : func (o *Options) initMaps() {
1297 1 : for i := range o.Levels {
1298 1 : l := &o.Levels[i]
1299 1 : if l.FilterPolicy != nil {
1300 1 : if o.Filters == nil {
1301 1 : o.Filters = make(map[string]FilterPolicy)
1302 1 : }
1303 1 : name := l.FilterPolicy.Name()
1304 1 : if _, ok := o.Filters[name]; !ok {
1305 1 : o.Filters[name] = l.FilterPolicy
1306 1 : }
1307 : }
1308 : }
1309 : }
1310 :
1311 : // Level returns the LevelOptions for the specified level.
1312 1 : func (o *Options) Level(level int) LevelOptions {
1313 1 : if level < len(o.Levels) {
1314 1 : return o.Levels[level]
1315 1 : }
1316 1 : n := len(o.Levels) - 1
1317 1 : l := o.Levels[n]
1318 1 : for i := n; i < level; i++ {
1319 1 : l.TargetFileSize *= 2
1320 1 : }
1321 1 : return l
1322 : }
1323 :
1324 : // Clone creates a shallow-copy of the supplied options.
1325 1 : func (o *Options) Clone() *Options {
1326 1 : n := &Options{}
1327 1 : if o != nil {
1328 1 : *n = *o
1329 1 : }
1330 1 : return n
1331 : }
1332 :
1333 1 : func filterPolicyName(p FilterPolicy) string {
1334 1 : if p == nil {
1335 1 : return "none"
1336 1 : }
1337 1 : return p.Name()
1338 : }
1339 :
1340 1 : func (o *Options) String() string {
1341 1 : var buf bytes.Buffer
1342 1 :
1343 1 : cacheSize := int64(cacheDefaultSize)
1344 1 : if o.Cache != nil {
1345 1 : cacheSize = o.Cache.MaxSize()
1346 1 : }
1347 :
1348 1 : fmt.Fprintf(&buf, "[Version]\n")
1349 1 : fmt.Fprintf(&buf, " pebble_version=0.1\n")
1350 1 : fmt.Fprintf(&buf, "\n")
1351 1 : fmt.Fprintf(&buf, "[Options]\n")
1352 1 : fmt.Fprintf(&buf, " bytes_per_sync=%d\n", o.BytesPerSync)
1353 1 : fmt.Fprintf(&buf, " cache_size=%d\n", cacheSize)
1354 1 : fmt.Fprintf(&buf, " cleaner=%s\n", o.Cleaner)
1355 1 : fmt.Fprintf(&buf, " compaction_debt_concurrency=%d\n", o.Experimental.CompactionDebtConcurrency)
1356 1 : fmt.Fprintf(&buf, " comparer=%s\n", o.Comparer.Name)
1357 1 : fmt.Fprintf(&buf, " disable_wal=%t\n", o.DisableWAL)
1358 1 : if o.Experimental.DisableIngestAsFlushable != nil && o.Experimental.DisableIngestAsFlushable() {
1359 1 : fmt.Fprintf(&buf, " disable_ingest_as_flushable=%t\n", true)
1360 1 : }
1361 1 : fmt.Fprintf(&buf, " flush_delay_delete_range=%s\n", o.FlushDelayDeleteRange)
1362 1 : fmt.Fprintf(&buf, " flush_delay_range_key=%s\n", o.FlushDelayRangeKey)
1363 1 : fmt.Fprintf(&buf, " flush_split_bytes=%d\n", o.FlushSplitBytes)
1364 1 : fmt.Fprintf(&buf, " format_major_version=%d\n", o.FormatMajorVersion)
1365 1 : fmt.Fprintf(&buf, " l0_compaction_concurrency=%d\n", o.Experimental.L0CompactionConcurrency)
1366 1 : fmt.Fprintf(&buf, " l0_compaction_file_threshold=%d\n", o.L0CompactionFileThreshold)
1367 1 : fmt.Fprintf(&buf, " l0_compaction_threshold=%d\n", o.L0CompactionThreshold)
1368 1 : fmt.Fprintf(&buf, " l0_stop_writes_threshold=%d\n", o.L0StopWritesThreshold)
1369 1 : fmt.Fprintf(&buf, " lbase_max_bytes=%d\n", o.LBaseMaxBytes)
1370 1 : if o.Experimental.LevelMultiplier != defaultLevelMultiplier {
1371 1 : fmt.Fprintf(&buf, " level_multiplier=%d\n", o.Experimental.LevelMultiplier)
1372 1 : }
1373 1 : fmt.Fprintf(&buf, " max_concurrent_compactions=%d\n", o.MaxConcurrentCompactions())
1374 1 : fmt.Fprintf(&buf, " max_concurrent_downloads=%d\n", o.MaxConcurrentDownloads())
1375 1 : fmt.Fprintf(&buf, " max_manifest_file_size=%d\n", o.MaxManifestFileSize)
1376 1 : fmt.Fprintf(&buf, " max_open_files=%d\n", o.MaxOpenFiles)
1377 1 : fmt.Fprintf(&buf, " mem_table_size=%d\n", o.MemTableSize)
1378 1 : fmt.Fprintf(&buf, " mem_table_stop_writes_threshold=%d\n", o.MemTableStopWritesThreshold)
1379 1 : fmt.Fprintf(&buf, " min_deletion_rate=%d\n", o.TargetByteDeletionRate)
1380 1 : fmt.Fprintf(&buf, " merger=%s\n", o.Merger.Name)
1381 1 : if o.Experimental.MultiLevelCompactionHeuristic != nil {
1382 1 : fmt.Fprintf(&buf, " multilevel_compaction_heuristic=%s\n", o.Experimental.MultiLevelCompactionHeuristic.String())
1383 1 : }
1384 1 : fmt.Fprintf(&buf, " read_compaction_rate=%d\n", o.Experimental.ReadCompactionRate)
1385 1 : fmt.Fprintf(&buf, " read_sampling_multiplier=%d\n", o.Experimental.ReadSamplingMultiplier)
1386 1 : // We no longer care about strict_wal_tail, but set it to true in case an
1387 1 : // older version reads the options.
1388 1 : fmt.Fprintf(&buf, " strict_wal_tail=%t\n", true)
1389 1 : fmt.Fprintf(&buf, " table_cache_shards=%d\n", o.Experimental.TableCacheShards)
1390 1 : fmt.Fprintf(&buf, " validate_on_ingest=%t\n", o.Experimental.ValidateOnIngest)
1391 1 : fmt.Fprintf(&buf, " wal_dir=%s\n", o.WALDir)
1392 1 : fmt.Fprintf(&buf, " wal_bytes_per_sync=%d\n", o.WALBytesPerSync)
1393 1 : fmt.Fprintf(&buf, " max_writer_concurrency=%d\n", o.Experimental.MaxWriterConcurrency)
1394 1 : fmt.Fprintf(&buf, " force_writer_parallelism=%t\n", o.Experimental.ForceWriterParallelism)
1395 1 : fmt.Fprintf(&buf, " secondary_cache_size_bytes=%d\n", o.Experimental.SecondaryCacheSizeBytes)
1396 1 : fmt.Fprintf(&buf, " create_on_shared=%d\n", o.Experimental.CreateOnShared)
1397 1 :
1398 1 : // Private options.
1399 1 : //
1400 1 : // These options are only encoded if true, because we do not want them to
1401 1 : // appear in production serialized Options files, since they're testing-only
1402 1 : // options. They're only serialized when true, which still ensures that the
1403 1 : // metamorphic tests may propagate them to subprocesses.
1404 1 : if o.private.disableDeleteOnlyCompactions {
1405 1 : fmt.Fprintln(&buf, " disable_delete_only_compactions=true")
1406 1 : }
1407 1 : if o.private.disableElisionOnlyCompactions {
1408 1 : fmt.Fprintln(&buf, " disable_elision_only_compactions=true")
1409 1 : }
1410 1 : if o.private.disableLazyCombinedIteration {
1411 1 : fmt.Fprintln(&buf, " disable_lazy_combined_iteration=true")
1412 1 : }
1413 :
1414 1 : if o.WALFailover != nil {
1415 1 : unhealthyThreshold, _ := o.WALFailover.FailoverOptions.UnhealthyOperationLatencyThreshold()
1416 1 : fmt.Fprintf(&buf, "\n")
1417 1 : fmt.Fprintf(&buf, "[WAL Failover]\n")
1418 1 : fmt.Fprintf(&buf, " secondary_dir=%s\n", o.WALFailover.Secondary.Dirname)
1419 1 : fmt.Fprintf(&buf, " primary_dir_probe_interval=%s\n", o.WALFailover.FailoverOptions.PrimaryDirProbeInterval)
1420 1 : fmt.Fprintf(&buf, " healthy_probe_latency_threshold=%s\n", o.WALFailover.FailoverOptions.HealthyProbeLatencyThreshold)
1421 1 : fmt.Fprintf(&buf, " healthy_interval=%s\n", o.WALFailover.FailoverOptions.HealthyInterval)
1422 1 : fmt.Fprintf(&buf, " unhealthy_sampling_interval=%s\n", o.WALFailover.FailoverOptions.UnhealthySamplingInterval)
1423 1 : fmt.Fprintf(&buf, " unhealthy_operation_latency_threshold=%s\n", unhealthyThreshold)
1424 1 : fmt.Fprintf(&buf, " elevated_write_stall_threshold_lag=%s\n", o.WALFailover.FailoverOptions.ElevatedWriteStallThresholdLag)
1425 1 : }
1426 :
1427 1 : for i := range o.Levels {
1428 1 : l := &o.Levels[i]
1429 1 : fmt.Fprintf(&buf, "\n")
1430 1 : fmt.Fprintf(&buf, "[Level \"%d\"]\n", i)
1431 1 : fmt.Fprintf(&buf, " block_restart_interval=%d\n", l.BlockRestartInterval)
1432 1 : fmt.Fprintf(&buf, " block_size=%d\n", l.BlockSize)
1433 1 : fmt.Fprintf(&buf, " block_size_threshold=%d\n", l.BlockSizeThreshold)
1434 1 : fmt.Fprintf(&buf, " compression=%s\n", resolveDefaultCompression(l.Compression()))
1435 1 : fmt.Fprintf(&buf, " filter_policy=%s\n", filterPolicyName(l.FilterPolicy))
1436 1 : fmt.Fprintf(&buf, " filter_type=%s\n", l.FilterType)
1437 1 : fmt.Fprintf(&buf, " index_block_size=%d\n", l.IndexBlockSize)
1438 1 : fmt.Fprintf(&buf, " target_file_size=%d\n", l.TargetFileSize)
1439 1 : }
1440 :
1441 1 : return buf.String()
1442 : }
1443 :
1444 : // parseOptions takes options serialized by Options.String() and parses them into
1445 : // keys and values, calling fn for each one.
1446 1 : func parseOptions(s string, fn func(section, key, value string) error) error {
1447 1 : var section string
1448 1 : for _, line := range strings.Split(s, "\n") {
1449 1 : line = strings.TrimSpace(line)
1450 1 : if len(line) == 0 {
1451 1 : // Skip blank lines.
1452 1 : continue
1453 : }
1454 1 : if line[0] == ';' || line[0] == '#' {
1455 0 : // Skip comments.
1456 0 : continue
1457 : }
1458 1 : n := len(line)
1459 1 : if line[0] == '[' && line[n-1] == ']' {
1460 1 : // Parse section.
1461 1 : section = line[1 : n-1]
1462 1 : continue
1463 : }
1464 :
1465 1 : pos := strings.Index(line, "=")
1466 1 : if pos < 0 {
1467 0 : const maxLen = 50
1468 0 : if len(line) > maxLen {
1469 0 : line = line[:maxLen-3] + "..."
1470 0 : }
1471 0 : return base.CorruptionErrorf("invalid key=value syntax: %q", errors.Safe(line))
1472 : }
1473 :
1474 1 : key := strings.TrimSpace(line[:pos])
1475 1 : value := strings.TrimSpace(line[pos+1:])
1476 1 :
1477 1 : // RocksDB uses a similar (INI-style) syntax for the OPTIONS file, but
1478 1 : // different section names and keys. The "CFOptions ..." paths are the
1479 1 : // RocksDB versions which we map to the Pebble paths.
1480 1 : mappedSection := section
1481 1 : if section == `CFOptions "default"` {
1482 0 : mappedSection = "Options"
1483 0 : switch key {
1484 0 : case "comparator":
1485 0 : key = "comparer"
1486 0 : case "merge_operator":
1487 0 : key = "merger"
1488 : }
1489 : }
1490 :
1491 1 : if err := fn(mappedSection, key, value); err != nil {
1492 0 : return err
1493 0 : }
1494 : }
1495 1 : return nil
1496 : }
1497 :
1498 : // ParseHooks contains callbacks to create options fields which can have
1499 : // user-defined implementations.
1500 : type ParseHooks struct {
1501 : NewCache func(size int64) *Cache
1502 : NewCleaner func(name string) (Cleaner, error)
1503 : NewComparer func(name string) (*Comparer, error)
1504 : NewFilterPolicy func(name string) (FilterPolicy, error)
1505 : NewMerger func(name string) (*Merger, error)
1506 : SkipUnknown func(name, value string) bool
1507 : }
1508 :
1509 : // Parse parses the options from the specified string. Note that certain
1510 : // options cannot be parsed into populated fields. For example, comparer and
1511 : // merger.
1512 1 : func (o *Options) Parse(s string, hooks *ParseHooks) error {
1513 1 : return parseOptions(s, func(section, key, value string) error {
1514 1 : // WARNING: DO NOT remove entries from the switches below because doing so
1515 1 : // causes a key previously written to the OPTIONS file to be considered unknown,
1516 1 : // a backwards incompatible change. Instead, leave in support for parsing the
1517 1 : // key but simply don't parse the value.
1518 1 :
1519 1 : switch {
1520 1 : case section == "Version":
1521 1 : switch key {
1522 1 : case "pebble_version":
1523 0 : default:
1524 0 : if hooks != nil && hooks.SkipUnknown != nil && hooks.SkipUnknown(section+"."+key, value) {
1525 0 : return nil
1526 0 : }
1527 0 : return errors.Errorf("pebble: unknown option: %s.%s",
1528 0 : errors.Safe(section), errors.Safe(key))
1529 : }
1530 1 : return nil
1531 :
1532 1 : case section == "Options":
1533 1 : var err error
1534 1 : switch key {
1535 1 : case "bytes_per_sync":
1536 1 : o.BytesPerSync, err = strconv.Atoi(value)
1537 1 : case "cache_size":
1538 1 : var n int64
1539 1 : n, err = strconv.ParseInt(value, 10, 64)
1540 1 : if err == nil && hooks != nil && hooks.NewCache != nil {
1541 1 : if o.Cache != nil {
1542 0 : o.Cache.Unref()
1543 0 : }
1544 1 : o.Cache = hooks.NewCache(n)
1545 : }
1546 : // We avoid calling cache.New in parsing because it makes it
1547 : // too easy to leak a cache.
1548 1 : case "cleaner":
1549 1 : switch value {
1550 1 : case "archive":
1551 1 : o.Cleaner = ArchiveCleaner{}
1552 0 : case "delete":
1553 0 : o.Cleaner = DeleteCleaner{}
1554 0 : default:
1555 0 : if hooks != nil && hooks.NewCleaner != nil {
1556 0 : o.Cleaner, err = hooks.NewCleaner(value)
1557 0 : }
1558 : }
1559 1 : case "comparer":
1560 1 : switch value {
1561 0 : case "leveldb.BytewiseComparator":
1562 0 : o.Comparer = DefaultComparer
1563 1 : default:
1564 1 : if hooks != nil && hooks.NewComparer != nil {
1565 0 : o.Comparer, err = hooks.NewComparer(value)
1566 0 : }
1567 : }
1568 1 : case "compaction_debt_concurrency":
1569 1 : o.Experimental.CompactionDebtConcurrency, err = strconv.ParseUint(value, 10, 64)
1570 0 : case "delete_range_flush_delay":
1571 0 : // NB: This is a deprecated serialization of the
1572 0 : // `flush_delay_delete_range`.
1573 0 : o.FlushDelayDeleteRange, err = time.ParseDuration(value)
1574 1 : case "disable_delete_only_compactions":
1575 1 : o.private.disableDeleteOnlyCompactions, err = strconv.ParseBool(value)
1576 1 : case "disable_elision_only_compactions":
1577 1 : o.private.disableElisionOnlyCompactions, err = strconv.ParseBool(value)
1578 1 : case "disable_ingest_as_flushable":
1579 1 : var v bool
1580 1 : v, err = strconv.ParseBool(value)
1581 1 : if err == nil {
1582 1 : o.Experimental.DisableIngestAsFlushable = func() bool { return v }
1583 : }
1584 1 : case "disable_lazy_combined_iteration":
1585 1 : o.private.disableLazyCombinedIteration, err = strconv.ParseBool(value)
1586 1 : case "disable_wal":
1587 1 : o.DisableWAL, err = strconv.ParseBool(value)
1588 1 : case "flush_delay_delete_range":
1589 1 : o.FlushDelayDeleteRange, err = time.ParseDuration(value)
1590 1 : case "flush_delay_range_key":
1591 1 : o.FlushDelayRangeKey, err = time.ParseDuration(value)
1592 1 : case "flush_split_bytes":
1593 1 : o.FlushSplitBytes, err = strconv.ParseInt(value, 10, 64)
1594 1 : case "format_major_version":
1595 1 : // NB: The version written here may be stale. Open does
1596 1 : // not use the format major version encoded in the
1597 1 : // OPTIONS file other than to validate that the encoded
1598 1 : // version is valid right here.
1599 1 : var v uint64
1600 1 : v, err = strconv.ParseUint(value, 10, 64)
1601 1 : if vers := FormatMajorVersion(v); vers > internalFormatNewest || vers == FormatDefault {
1602 0 : err = errors.Newf("unsupported format major version %d", o.FormatMajorVersion)
1603 0 : }
1604 1 : if err == nil {
1605 1 : o.FormatMajorVersion = FormatMajorVersion(v)
1606 1 : }
1607 1 : case "l0_compaction_concurrency":
1608 1 : o.Experimental.L0CompactionConcurrency, err = strconv.Atoi(value)
1609 1 : case "l0_compaction_file_threshold":
1610 1 : o.L0CompactionFileThreshold, err = strconv.Atoi(value)
1611 1 : case "l0_compaction_threshold":
1612 1 : o.L0CompactionThreshold, err = strconv.Atoi(value)
1613 1 : case "l0_stop_writes_threshold":
1614 1 : o.L0StopWritesThreshold, err = strconv.Atoi(value)
1615 0 : case "l0_sublevel_compactions":
1616 : // Do nothing; option existed in older versions of pebble.
1617 1 : case "lbase_max_bytes":
1618 1 : o.LBaseMaxBytes, err = strconv.ParseInt(value, 10, 64)
1619 1 : case "level_multiplier":
1620 1 : o.Experimental.LevelMultiplier, err = strconv.Atoi(value)
1621 1 : case "max_concurrent_compactions":
1622 1 : var concurrentCompactions int
1623 1 : concurrentCompactions, err = strconv.Atoi(value)
1624 1 : if concurrentCompactions <= 0 {
1625 0 : err = errors.New("max_concurrent_compactions cannot be <= 0")
1626 1 : } else {
1627 1 : o.MaxConcurrentCompactions = func() int { return concurrentCompactions }
1628 : }
1629 1 : case "max_concurrent_downloads":
1630 1 : var concurrentDownloads int
1631 1 : concurrentDownloads, err = strconv.Atoi(value)
1632 1 : if concurrentDownloads <= 0 {
1633 0 : err = errors.New("max_concurrent_compactions cannot be <= 0")
1634 1 : } else {
1635 1 : o.MaxConcurrentDownloads = func() int { return concurrentDownloads }
1636 : }
1637 1 : case "max_manifest_file_size":
1638 1 : o.MaxManifestFileSize, err = strconv.ParseInt(value, 10, 64)
1639 1 : case "max_open_files":
1640 1 : o.MaxOpenFiles, err = strconv.Atoi(value)
1641 1 : case "mem_table_size":
1642 1 : o.MemTableSize, err = strconv.ParseUint(value, 10, 64)
1643 1 : case "mem_table_stop_writes_threshold":
1644 1 : o.MemTableStopWritesThreshold, err = strconv.Atoi(value)
1645 0 : case "min_compaction_rate":
1646 : // Do nothing; option existed in older versions of pebble, and
1647 : // may be meaningful again eventually.
1648 1 : case "min_deletion_rate":
1649 1 : o.TargetByteDeletionRate, err = strconv.Atoi(value)
1650 0 : case "min_flush_rate":
1651 : // Do nothing; option existed in older versions of pebble, and
1652 : // may be meaningful again eventually.
1653 1 : case "multilevel_compaction_heuristic":
1654 1 : switch {
1655 1 : case value == "none":
1656 1 : o.Experimental.MultiLevelCompactionHeuristic = NoMultiLevel{}
1657 1 : case strings.HasPrefix(value, "wamp"):
1658 1 : fields := strings.FieldsFunc(strings.TrimPrefix(value, "wamp"), func(r rune) bool {
1659 1 : return unicode.IsSpace(r) || r == ',' || r == '(' || r == ')'
1660 1 : })
1661 1 : if len(fields) != 2 {
1662 0 : err = errors.Newf("require 2 arguments")
1663 0 : }
1664 1 : var h WriteAmpHeuristic
1665 1 : if err == nil {
1666 1 : h.AddPropensity, err = strconv.ParseFloat(fields[0], 64)
1667 1 : }
1668 1 : if err == nil {
1669 1 : h.AllowL0, err = strconv.ParseBool(fields[1])
1670 1 : }
1671 1 : if err == nil {
1672 1 : o.Experimental.MultiLevelCompactionHeuristic = h
1673 1 : } else {
1674 0 : err = errors.Wrapf(err, "unexpected wamp heuristic arguments: %s", value)
1675 0 : }
1676 0 : default:
1677 0 : err = errors.Newf("unrecognized multilevel compaction heuristic: %s", value)
1678 : }
1679 0 : case "point_tombstone_weight":
1680 : // Do nothing; deprecated.
1681 1 : case "strict_wal_tail":
1682 1 : var strictWALTail bool
1683 1 : strictWALTail, err = strconv.ParseBool(value)
1684 1 : if err == nil && !strictWALTail {
1685 0 : err = errors.Newf("reading from versions with strict_wal_tail=false no longer supported")
1686 0 : }
1687 1 : case "merger":
1688 1 : switch value {
1689 0 : case "nullptr":
1690 0 : o.Merger = nil
1691 1 : case "pebble.concatenate":
1692 1 : o.Merger = DefaultMerger
1693 0 : default:
1694 0 : if hooks != nil && hooks.NewMerger != nil {
1695 0 : o.Merger, err = hooks.NewMerger(value)
1696 0 : }
1697 : }
1698 1 : case "read_compaction_rate":
1699 1 : o.Experimental.ReadCompactionRate, err = strconv.ParseInt(value, 10, 64)
1700 1 : case "read_sampling_multiplier":
1701 1 : o.Experimental.ReadSamplingMultiplier, err = strconv.ParseInt(value, 10, 64)
1702 1 : case "table_cache_shards":
1703 1 : o.Experimental.TableCacheShards, err = strconv.Atoi(value)
1704 0 : case "table_format":
1705 0 : switch value {
1706 0 : case "leveldb":
1707 0 : case "rocksdbv2":
1708 0 : default:
1709 0 : return errors.Errorf("pebble: unknown table format: %q", errors.Safe(value))
1710 : }
1711 0 : case "table_property_collectors":
1712 : // No longer implemented; ignore.
1713 1 : case "validate_on_ingest":
1714 1 : o.Experimental.ValidateOnIngest, err = strconv.ParseBool(value)
1715 1 : case "wal_dir":
1716 1 : o.WALDir = value
1717 1 : case "wal_bytes_per_sync":
1718 1 : o.WALBytesPerSync, err = strconv.Atoi(value)
1719 1 : case "max_writer_concurrency":
1720 1 : o.Experimental.MaxWriterConcurrency, err = strconv.Atoi(value)
1721 1 : case "force_writer_parallelism":
1722 1 : o.Experimental.ForceWriterParallelism, err = strconv.ParseBool(value)
1723 1 : case "secondary_cache_size_bytes":
1724 1 : o.Experimental.SecondaryCacheSizeBytes, err = strconv.ParseInt(value, 10, 64)
1725 1 : case "create_on_shared":
1726 1 : var createOnSharedInt int64
1727 1 : createOnSharedInt, err = strconv.ParseInt(value, 10, 64)
1728 1 : o.Experimental.CreateOnShared = remote.CreateOnSharedStrategy(createOnSharedInt)
1729 0 : default:
1730 0 : if hooks != nil && hooks.SkipUnknown != nil && hooks.SkipUnknown(section+"."+key, value) {
1731 0 : return nil
1732 0 : }
1733 0 : return errors.Errorf("pebble: unknown option: %s.%s",
1734 0 : errors.Safe(section), errors.Safe(key))
1735 : }
1736 1 : return err
1737 :
1738 1 : case section == "WAL Failover":
1739 1 : if o.WALFailover == nil {
1740 1 : o.WALFailover = new(WALFailoverOptions)
1741 1 : }
1742 1 : var err error
1743 1 : switch key {
1744 1 : case "secondary_dir":
1745 1 : o.WALFailover.Secondary = wal.Dir{Dirname: value, FS: vfs.Default}
1746 1 : case "primary_dir_probe_interval":
1747 1 : o.WALFailover.PrimaryDirProbeInterval, err = time.ParseDuration(value)
1748 1 : case "healthy_probe_latency_threshold":
1749 1 : o.WALFailover.HealthyProbeLatencyThreshold, err = time.ParseDuration(value)
1750 1 : case "healthy_interval":
1751 1 : o.WALFailover.HealthyInterval, err = time.ParseDuration(value)
1752 1 : case "unhealthy_sampling_interval":
1753 1 : o.WALFailover.UnhealthySamplingInterval, err = time.ParseDuration(value)
1754 1 : case "unhealthy_operation_latency_threshold":
1755 1 : var threshold time.Duration
1756 1 : threshold, err = time.ParseDuration(value)
1757 1 : o.WALFailover.UnhealthyOperationLatencyThreshold = func() (time.Duration, bool) {
1758 1 : return threshold, true
1759 1 : }
1760 1 : case "elevated_write_stall_threshold_lag":
1761 1 : o.WALFailover.ElevatedWriteStallThresholdLag, err = time.ParseDuration(value)
1762 0 : default:
1763 0 : if hooks != nil && hooks.SkipUnknown != nil && hooks.SkipUnknown(section+"."+key, value) {
1764 0 : return nil
1765 0 : }
1766 0 : return errors.Errorf("pebble: unknown option: %s.%s",
1767 0 : errors.Safe(section), errors.Safe(key))
1768 : }
1769 1 : return err
1770 :
1771 1 : case strings.HasPrefix(section, "Level "):
1772 1 : var index int
1773 1 : if n, err := fmt.Sscanf(section, `Level "%d"`, &index); err != nil {
1774 0 : return err
1775 1 : } else if n != 1 {
1776 0 : if hooks != nil && hooks.SkipUnknown != nil && hooks.SkipUnknown(section, value) {
1777 0 : return nil
1778 0 : }
1779 0 : return errors.Errorf("pebble: unknown section: %q", errors.Safe(section))
1780 : }
1781 :
1782 1 : if len(o.Levels) <= index {
1783 0 : newLevels := make([]LevelOptions, index+1)
1784 0 : copy(newLevels, o.Levels)
1785 0 : o.Levels = newLevels
1786 0 : }
1787 1 : l := &o.Levels[index]
1788 1 :
1789 1 : var err error
1790 1 : switch key {
1791 1 : case "block_restart_interval":
1792 1 : l.BlockRestartInterval, err = strconv.Atoi(value)
1793 1 : case "block_size":
1794 1 : l.BlockSize, err = strconv.Atoi(value)
1795 1 : case "block_size_threshold":
1796 1 : l.BlockSizeThreshold, err = strconv.Atoi(value)
1797 1 : case "compression":
1798 1 : switch value {
1799 0 : case "Default":
1800 0 : l.Compression = func() sstable.Compression { return DefaultCompression }
1801 1 : case "NoCompression":
1802 1 : l.Compression = func() sstable.Compression { return NoCompression }
1803 1 : case "Snappy":
1804 1 : l.Compression = func() sstable.Compression { return SnappyCompression }
1805 1 : case "ZSTD":
1806 1 : l.Compression = func() sstable.Compression { return ZstdCompression }
1807 0 : default:
1808 0 : return errors.Errorf("pebble: unknown compression: %q", errors.Safe(value))
1809 : }
1810 1 : case "filter_policy":
1811 1 : if hooks != nil && hooks.NewFilterPolicy != nil {
1812 1 : l.FilterPolicy, err = hooks.NewFilterPolicy(value)
1813 1 : }
1814 1 : case "filter_type":
1815 1 : switch value {
1816 1 : case "table":
1817 1 : l.FilterType = TableFilter
1818 0 : default:
1819 0 : return errors.Errorf("pebble: unknown filter type: %q", errors.Safe(value))
1820 : }
1821 1 : case "index_block_size":
1822 1 : l.IndexBlockSize, err = strconv.Atoi(value)
1823 1 : case "target_file_size":
1824 1 : l.TargetFileSize, err = strconv.ParseInt(value, 10, 64)
1825 0 : default:
1826 0 : if hooks != nil && hooks.SkipUnknown != nil && hooks.SkipUnknown(section+"."+key, value) {
1827 0 : return nil
1828 0 : }
1829 0 : return errors.Errorf("pebble: unknown option: %s.%s", errors.Safe(section), errors.Safe(key))
1830 : }
1831 1 : return err
1832 : }
1833 1 : if hooks != nil && hooks.SkipUnknown != nil && hooks.SkipUnknown(section+"."+key, value) {
1834 1 : return nil
1835 1 : }
1836 0 : return errors.Errorf("pebble: unknown section: %q", errors.Safe(section))
1837 : })
1838 : }
1839 :
1840 : // ErrMissingWALRecoveryDir is an error returned when a database is attempted to be
1841 : // opened without supplying a Options.WALRecoveryDir entry for a directory that
1842 : // may contain WALs required to recover a consistent database state.
1843 : type ErrMissingWALRecoveryDir struct {
1844 : Dir string
1845 : }
1846 :
1847 : // Error implements error.
1848 0 : func (e ErrMissingWALRecoveryDir) Error() string {
1849 0 : return fmt.Sprintf("directory %q may contain relevant WALs", e.Dir)
1850 0 : }
1851 :
1852 : // CheckCompatibility verifies the options are compatible with the previous options
1853 : // serialized by Options.String(). For example, the Comparer and Merger must be
1854 : // the same, or data will not be able to be properly read from the DB.
1855 : //
1856 : // This function only looks at specific keys and does not error out if the
1857 : // options are newer and contain unknown keys.
1858 1 : func (o *Options) CheckCompatibility(previousOptions string) error {
1859 1 : return parseOptions(previousOptions, func(section, key, value string) error {
1860 1 : switch section + "." + key {
1861 1 : case "Options.comparer":
1862 1 : if value != o.Comparer.Name {
1863 0 : return errors.Errorf("pebble: comparer name from file %q != comparer name from options %q",
1864 0 : errors.Safe(value), errors.Safe(o.Comparer.Name))
1865 0 : }
1866 1 : case "Options.merger":
1867 1 : // RocksDB allows the merge operator to be unspecified, in which case it
1868 1 : // shows up as "nullptr".
1869 1 : if value != "nullptr" && value != o.Merger.Name {
1870 0 : return errors.Errorf("pebble: merger name from file %q != merger name from options %q",
1871 0 : errors.Safe(value), errors.Safe(o.Merger.Name))
1872 0 : }
1873 1 : case "Options.wal_dir", "WAL Failover.secondary_dir":
1874 1 : switch {
1875 1 : case o.WALDir == value:
1876 1 : return nil
1877 1 : case o.WALFailover != nil && o.WALFailover.Secondary.Dirname == value:
1878 1 : return nil
1879 0 : default:
1880 0 : for _, d := range o.WALRecoveryDirs {
1881 0 : if d.Dirname == value {
1882 0 : return nil
1883 0 : }
1884 : }
1885 0 : return ErrMissingWALRecoveryDir{Dir: value}
1886 : }
1887 : }
1888 1 : return nil
1889 : })
1890 : }
1891 :
1892 : // Validate verifies that the options are mutually consistent. For example,
1893 : // L0StopWritesThreshold must be >= L0CompactionThreshold, otherwise a write
1894 : // stall would persist indefinitely.
1895 1 : func (o *Options) Validate() error {
1896 1 : // Note that we can presume Options.EnsureDefaults has been called, so there
1897 1 : // is no need to check for zero values.
1898 1 :
1899 1 : var buf strings.Builder
1900 1 : if o.Experimental.L0CompactionConcurrency < 1 {
1901 0 : fmt.Fprintf(&buf, "L0CompactionConcurrency (%d) must be >= 1\n",
1902 0 : o.Experimental.L0CompactionConcurrency)
1903 0 : }
1904 1 : if o.L0StopWritesThreshold < o.L0CompactionThreshold {
1905 0 : fmt.Fprintf(&buf, "L0StopWritesThreshold (%d) must be >= L0CompactionThreshold (%d)\n",
1906 0 : o.L0StopWritesThreshold, o.L0CompactionThreshold)
1907 0 : }
1908 1 : if uint64(o.MemTableSize) >= maxMemTableSize {
1909 0 : fmt.Fprintf(&buf, "MemTableSize (%s) must be < %s\n",
1910 0 : humanize.Bytes.Uint64(uint64(o.MemTableSize)), humanize.Bytes.Uint64(maxMemTableSize))
1911 0 : }
1912 1 : if o.MemTableStopWritesThreshold < 2 {
1913 0 : fmt.Fprintf(&buf, "MemTableStopWritesThreshold (%d) must be >= 2\n",
1914 0 : o.MemTableStopWritesThreshold)
1915 0 : }
1916 1 : if o.FormatMajorVersion < FormatMinSupported || o.FormatMajorVersion > internalFormatNewest {
1917 0 : fmt.Fprintf(&buf, "FormatMajorVersion (%d) must be between %d and %d\n",
1918 0 : o.FormatMajorVersion, FormatMinSupported, internalFormatNewest)
1919 0 : }
1920 1 : if o.Experimental.CreateOnShared != remote.CreateOnSharedNone && o.FormatMajorVersion < FormatMinForSharedObjects {
1921 0 : fmt.Fprintf(&buf, "FormatMajorVersion (%d) when CreateOnShared is set must be at least %d\n",
1922 0 : o.FormatMajorVersion, FormatMinForSharedObjects)
1923 0 :
1924 0 : }
1925 1 : if o.TableCache != nil && o.Cache != o.TableCache.cache {
1926 0 : fmt.Fprintf(&buf, "underlying cache in the TableCache and the Cache dont match\n")
1927 0 : }
1928 1 : if buf.Len() == 0 {
1929 1 : return nil
1930 1 : }
1931 0 : return errors.New(buf.String())
1932 : }
1933 :
1934 : // MakeReaderOptions constructs sstable.ReaderOptions from the corresponding
1935 : // options in the receiver.
1936 1 : func (o *Options) MakeReaderOptions() sstable.ReaderOptions {
1937 1 : var readerOpts sstable.ReaderOptions
1938 1 : if o != nil {
1939 1 : readerOpts.Cache = o.Cache
1940 1 : readerOpts.Comparer = o.Comparer
1941 1 : readerOpts.Filters = o.Filters
1942 1 : if o.Merger != nil {
1943 1 : readerOpts.Merge = o.Merger.Merge
1944 1 : readerOpts.MergerName = o.Merger.Name
1945 1 : }
1946 1 : readerOpts.LoggerAndTracer = o.LoggerAndTracer
1947 : }
1948 1 : return readerOpts
1949 : }
1950 :
1951 : // MakeWriterOptions constructs sstable.WriterOptions for the specified level
1952 : // from the corresponding options in the receiver.
1953 1 : func (o *Options) MakeWriterOptions(level int, format sstable.TableFormat) sstable.WriterOptions {
1954 1 : var writerOpts sstable.WriterOptions
1955 1 : writerOpts.TableFormat = format
1956 1 : if o != nil {
1957 1 : writerOpts.Cache = o.Cache
1958 1 : writerOpts.Comparer = o.Comparer
1959 1 : if o.Merger != nil {
1960 1 : writerOpts.MergerName = o.Merger.Name
1961 1 : }
1962 1 : writerOpts.BlockPropertyCollectors = o.BlockPropertyCollectors
1963 : }
1964 1 : if format >= sstable.TableFormatPebblev3 {
1965 1 : writerOpts.ShortAttributeExtractor = o.Experimental.ShortAttributeExtractor
1966 1 : writerOpts.RequiredInPlaceValueBound = o.Experimental.RequiredInPlaceValueBound
1967 1 : if format >= sstable.TableFormatPebblev4 && level == numLevels-1 {
1968 1 : writerOpts.WritingToLowestLevel = true
1969 1 : }
1970 : }
1971 1 : levelOpts := o.Level(level)
1972 1 : writerOpts.BlockRestartInterval = levelOpts.BlockRestartInterval
1973 1 : writerOpts.BlockSize = levelOpts.BlockSize
1974 1 : writerOpts.BlockSizeThreshold = levelOpts.BlockSizeThreshold
1975 1 : writerOpts.Compression = resolveDefaultCompression(levelOpts.Compression())
1976 1 : writerOpts.FilterPolicy = levelOpts.FilterPolicy
1977 1 : writerOpts.FilterType = levelOpts.FilterType
1978 1 : writerOpts.IndexBlockSize = levelOpts.IndexBlockSize
1979 1 : writerOpts.AllocatorSizeClasses = o.AllocatorSizeClasses
1980 1 : return writerOpts
1981 : }
1982 :
1983 1 : func resolveDefaultCompression(c Compression) Compression {
1984 1 : if c <= DefaultCompression || c >= sstable.NCompression {
1985 0 : c = SnappyCompression
1986 0 : }
1987 1 : return c
1988 : }
|
