forked from cockroachdb/pebble
-
Notifications
You must be signed in to change notification settings - Fork 0
/
options.go
905 lines (815 loc) · 28.8 KB
/
options.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
// Copyright 2011 The LevelDB-Go and Pebble Authors. All rights reserved. Use
// of this source code is governed by a BSD-style license that can be found in
// the LICENSE file.
package pebble
import (
"bytes"
"fmt"
"strconv"
"strings"
"time"
"github.com/cockroachdb/errors"
"github.com/cockroachdb/pebble/internal/base"
"github.com/cockroachdb/pebble/internal/cache"
"github.com/cockroachdb/pebble/sstable"
"github.com/cockroachdb/pebble/vfs"
)
const (
cacheDefaultSize = 8 << 20 // 8 MB
)
// Compression exports the base.Compression type.
type Compression = sstable.Compression
// Exported Compression constants.
const (
DefaultCompression = sstable.DefaultCompression
NoCompression = sstable.NoCompression
SnappyCompression = sstable.SnappyCompression
)
// FilterType exports the base.FilterType type.
type FilterType = base.FilterType
// Exported TableFilter constants.
const (
TableFilter = base.TableFilter
)
// FilterWriter exports the base.FilterWriter type.
type FilterWriter = base.FilterWriter
// FilterPolicy exports the base.FilterPolicy type.
type FilterPolicy = base.FilterPolicy
// TableFormat exports the base.TableFormat type.
type TableFormat = sstable.TableFormat
// Exported TableFormat constants.
const (
TableFormatRocksDBv2 = sstable.TableFormatRocksDBv2
TableFormatLevelDB = sstable.TableFormatLevelDB
)
// TablePropertyCollector exports the sstable.TablePropertyCollector type.
type TablePropertyCollector = sstable.TablePropertyCollector
// NeedCompacter exports the sstable.NeedCompacter type.
type NeedCompacter = sstable.NeedCompacter
// IterOptions hold the optional per-query parameters for NewIter.
//
// Like Options, a nil *IterOptions is valid and means to use the default
// values.
type IterOptions struct {
// LowerBound specifies the smallest key (inclusive) that the iterator will
// return during iteration. If the iterator is seeked or iterated past this
// boundary the iterator will return Valid()==false. Setting LowerBound
// effectively truncates the key space visible to the iterator.
LowerBound []byte
// UpperBound specifies the largest key (exclusive) that the iterator will
// return during iteration. If the iterator is seeked or iterated past this
// boundary the iterator will return Valid()==false. Setting UpperBound
// effectively truncates the key space visible to the iterator.
UpperBound []byte
// TableFilter can be used to filter the tables that are scanned during
// iteration based on the user properties. Return true to scan the table and
// false to skip scanning.
TableFilter func(userProps map[string]string) bool
// Internal options.
logger Logger
}
// GetLowerBound returns the LowerBound or nil if the receiver is nil.
func (o *IterOptions) GetLowerBound() []byte {
if o == nil {
return nil
}
return o.LowerBound
}
// GetUpperBound returns the UpperBound or nil if the receiver is nil.
func (o *IterOptions) GetUpperBound() []byte {
if o == nil {
return nil
}
return o.UpperBound
}
func (o *IterOptions) getLogger() Logger {
if o == nil || o.logger == nil {
return DefaultLogger
}
return o.logger
}
// WriteOptions hold the optional per-query parameters for Set and Delete
// operations.
//
// Like Options, a nil *WriteOptions is valid and means to use the default
// values.
type WriteOptions struct {
// Sync is whether to sync underlying writes from the OS buffer cache
// through to actual disk, if applicable. Setting Sync can result in
// slower writes.
//
// If false, and the machine crashes, then some recent writes may be lost.
// Note that if it is just the process that crashes (and the machine does
// not) then no writes will be lost.
//
// In other words, Sync being false has the same semantics as a write
// system call. Sync being true means write followed by fsync.
//
// The default value is true.
Sync bool
}
// Sync specifies the default write options for writes which synchronize to
// disk.
var Sync = &WriteOptions{Sync: true}
// NoSync specifies the default write options for writes which do not
// synchronize to disk.
var NoSync = &WriteOptions{Sync: false}
// GetSync returns the Sync value or true if the receiver is nil.
func (o *WriteOptions) GetSync() bool {
return o == nil || o.Sync
}
// LevelOptions holds the optional per-level parameters.
type LevelOptions struct {
// BlockRestartInterval is the number of keys between restart points
// for delta encoding of keys.
//
// The default value is 16.
BlockRestartInterval int
// BlockSize is the target uncompressed size in bytes of each table block.
//
// The default value is 4096.
BlockSize int
// BlockSizeThreshold finishes a block if the block size is larger than the
// specified percentage of the target block size and adding the next entry
// would cause the block to be larger than the target block size.
//
// The default value is 90
BlockSizeThreshold int
// Compression defines the per-block compression to use.
//
// The default value (DefaultCompression) uses snappy compression.
Compression Compression
// FilterPolicy defines a filter algorithm (such as a Bloom filter) that can
// reduce disk reads for Get calls.
//
// One such implementation is bloom.FilterPolicy(10) from the pebble/bloom
// package.
//
// The default value means to use no filter.
FilterPolicy FilterPolicy
// FilterType defines whether an existing filter policy is applied at a
// block-level or table-level. Block-level filters use less memory to create,
// but are slower to access as a check for the key in the index must first be
// performed to locate the filter block. A table-level filter will require
// memory proportional to the number of keys in an sstable to create, but
// avoids the index lookup when determining if a key is present. Table-level
// filters should be preferred except under constrained memory situations.
FilterType FilterType
// IndexBlockSize is the target uncompressed size in bytes of each index
// block. When the index block size is larger than this target, two-level
// indexes are automatically enabled. Setting this option to a large value
// (such as math.MaxInt32) disables the automatic creation of two-level
// indexes.
//
// The default value is the value of BlockSize.
IndexBlockSize int
// The target file size for the level.
TargetFileSize int64
}
// EnsureDefaults ensures that the default values for all of the options have
// been initialized. It is valid to call EnsureDefaults on a nil receiver. A
// non-nil result will always be returned.
func (o *LevelOptions) EnsureDefaults() *LevelOptions {
if o == nil {
o = &LevelOptions{}
}
if o.BlockRestartInterval <= 0 {
o.BlockRestartInterval = base.DefaultBlockRestartInterval
}
if o.BlockSize <= 0 {
o.BlockSize = base.DefaultBlockSize
}
if o.BlockSizeThreshold <= 0 {
o.BlockSizeThreshold = base.DefaultBlockSizeThreshold
}
if o.Compression <= DefaultCompression || o.Compression >= sstable.NCompression {
o.Compression = SnappyCompression
}
if o.IndexBlockSize <= 0 {
o.IndexBlockSize = o.BlockSize
}
if o.TargetFileSize <= 0 {
o.TargetFileSize = 2 << 20 // 2 MB
}
return o
}
// Options holds the optional parameters for configuring pebble. These options
// apply to the DB at large; per-query options are defined by the IterOptions
// and WriteOptions types.
type Options struct {
// Sync sstables and the WAL periodically in order to smooth out writes to
// disk. This option does not provide any persistency guarantee, but is used
// to avoid latency spikes if the OS automatically decides to write out a
// large chunk of dirty filesystem buffers.
//
// The default value is 512KB.
BytesPerSync int
// Cache is used to cache uncompressed blocks from sstables.
//
// The default cache size is 8 MB.
Cache *cache.Cache
// Cleaner cleans obsolete files.
//
// The default cleaner uses the DeleteCleaner.
Cleaner Cleaner
// Comparer defines a total ordering over the space of []byte keys: a 'less
// than' relationship. The same comparison algorithm must be used for reads
// and writes over the lifetime of the DB.
//
// The default value uses the same ordering as bytes.Compare.
Comparer *Comparer
// DebugCheck is invoked, if non-nil, whenever a new version is being
// installed. Typically, this is set to pebble.DebugCheckLevels in tests
// or tools only, to check invariants over all the data in the database.
DebugCheck func(*DB) error
// Disable the write-ahead log (WAL). Disabling the write-ahead log prohibits
// crash recovery, but can improve performance if crash recovery is not
// needed (e.g. when only temporary state is being stored in the database).
//
// TODO(peter): untested
DisableWAL bool
// ErrorIfExists is whether it is an error if the database already exists.
//
// The default value is false.
ErrorIfExists bool
// ErrorIfNotExists is whether it is an error if the database does not
// already exist.
//
// The default value is false which will cause a database to be created if it
// does not already exist.
ErrorIfNotExists bool
// EventListener provides hooks to listening to significant DB events such as
// flushes, compactions, and table deletion.
EventListener EventListener
// Filters is a map from filter policy name to filter policy. It is used for
// debugging tools which may be used on multiple databases configured with
// different filter policies. It is not necessary to populate this filters
// map during normal usage of a DB.
Filters map[string]FilterPolicy
// FS provides the interface for persistent file storage.
//
// The default value uses the underlying operating system's file system.
FS vfs.FS
// The number of files necessary to trigger an L0 compaction.
L0CompactionThreshold int
// Hard limit on the number of L0 files. Writes are stopped when this
// threshold is reached.
L0StopWritesThreshold int
// The maximum number of bytes for LBase. The base level is the level which
// L0 is compacted into. The base level is determined dynamically based on
// the existing data in the LSM. The maximum number of bytes for other levels
// is computed dynamically based on the base level's maximum size. When the
// maximum number of bytes for a level is exceeded, compaction is requested.
LBaseMaxBytes int64
// Per-level options. Options for at least one level must be specified. The
// options for the last level are used for all subsequent levels.
Levels []LevelOptions
// Logger used to write log messages.
//
// The default logger uses the Go standard library log package.
Logger Logger
// MaxManifestFileSize is the maximum size the MANIFEST file is allowed to
// become. When the MANIFEST exceeds this size it is rolled over and a new
// MANIFEST is created.
MaxManifestFileSize int64
// MaxOpenFiles is a soft limit on the number of open files that can be
// used by the DB.
//
// The default value is 1000.
MaxOpenFiles int
// The size of a MemTable in steady state. The actual MemTable size starts at
// min(256KB, MemTableSize) and doubles for each subsequent MemTable up to
// MemTableSize. This reduces the memory pressure caused by MemTables for
// short lived (test) DB instances. Note that more than one MemTable can be
// in existence since flushing a MemTable involves creating a new one and
// writing the contents of the old one in the
// background. MemTableStopWritesThreshold places a hard limit on the size of
// the queued MemTables.
MemTableSize int
// Hard limit on the size of queued of MemTables. Writes are stopped when the
// sum of the queued memtable sizes exceeds
// MemTableStopWritesThreshold*MemTableSize. This value should be at least 2
// or writes will stop whenever a MemTable is being flushed.
MemTableStopWritesThreshold int
// Merger defines the associative merge operation to use for merging values
// written with {Batch,DB}.Merge.
//
// The default merger concatenates values.
Merger *Merger
// MinCompactionRate sets the minimum rate at which compactions occur. The
// default is 4 MB/s.
MinCompactionRate int
// MinFlushRate sets the minimum rate at which the MemTables are flushed. The
// default is 1 MB/s.
MinFlushRate int
// MaxConcurrentCompactions specifies the maximum number of concurrent compactions. The
// default is 1.
MaxConcurrentCompactions int
// ReadOnly indicates that the DB should be opened in read-only mode. Writes
// to the DB will return an error, background compactions are disabled, and
// the flush that normally occurs after replaying the WAL at startup is
// disabled.
ReadOnly bool
// TableFormat specifies the format version for writing sstables. The default
// is TableFormatRocksDBv2 which creates RocksDB compatible sstables. Use
// TableFormatLevelDB to create LevelDB compatible sstable which can be used
// by a wider range of tools and libraries.
TableFormat TableFormat
// TablePropertyCollectors is a list of TablePropertyCollector creation
// functions. A new TablePropertyCollector is created for each sstable built
// and lives for the lifetime of the table.
TablePropertyCollectors []func() TablePropertyCollector
// WALDir specifies the directory to store write-ahead logs (WALs) in. If
// empty (the default), WALs will be stored in the same directory as sstables
// (i.e. the directory passed to pebble.Open).
WALDir string
// WALMinSyncInterval is the minimum duration between syncs of the WAL. If
// WAL syncs are requested faster than this interval, they will be
// artificially delayed. Introducing a small artificial delay (500us) between
// WAL syncs can allow more operations to arrive and reduce IO operations
// while having a minimal impact on throughput. This option is supplied as a
// closure in order to allow the value to be changed dynamically. The default
// value is 0.
//
// TODO(peter): rather than a closure, should there be another mechanism for
// changing options dynamically?
WALMinSyncInterval func() time.Duration
// TODO(peter): A private option to enable flush/compaction pacing. Only used
// by tests. Compaction/flush pacing is disabled until we fix the impact on
// throughput.
enablePacing bool
}
// DebugCheckLevels calls CheckLevels on the provided database.
// It may be set in the DebugCheck field of Options to check
// level invariants whenever a new version is installed.
func DebugCheckLevels(db *DB) error {
return db.CheckLevels(nil)
}
// EnsureDefaults ensures that the default values for all options are set if a
// valid value was not already specified. Returns the new options.
func (o *Options) EnsureDefaults() *Options {
if o == nil {
o = &Options{}
}
if o.BytesPerSync <= 0 {
o.BytesPerSync = 512 << 10 // 512 KB
}
if o.Cleaner == nil {
o.Cleaner = DeleteCleaner{}
}
if o.Comparer == nil {
o.Comparer = DefaultComparer
}
if o.FS == nil {
o.FS = vfs.Default
}
if o.L0CompactionThreshold <= 0 {
o.L0CompactionThreshold = 4
}
if o.L0StopWritesThreshold <= 0 {
o.L0StopWritesThreshold = 12
}
if o.LBaseMaxBytes <= 0 {
o.LBaseMaxBytes = 64 << 20 // 64 MB
}
if o.Levels == nil {
o.Levels = make([]LevelOptions, 1)
for i := range o.Levels {
if i > 0 {
l := &o.Levels[i]
if l.TargetFileSize <= 0 {
l.TargetFileSize = o.Levels[i-1].TargetFileSize * 2
}
}
o.Levels[i].EnsureDefaults()
}
} else {
for i := range o.Levels {
o.Levels[i].EnsureDefaults()
}
}
if o.Logger == nil {
o.Logger = DefaultLogger
}
o.EventListener.EnsureDefaults(o.Logger)
if o.MaxManifestFileSize == 0 {
o.MaxManifestFileSize = 128 << 20 // 128 MB
}
if o.MaxOpenFiles == 0 {
o.MaxOpenFiles = 1000
}
if o.MemTableSize <= 0 {
o.MemTableSize = 4 << 20
}
if o.MemTableStopWritesThreshold <= 0 {
o.MemTableStopWritesThreshold = 2
}
if o.Merger == nil {
o.Merger = DefaultMerger
}
if o.MinCompactionRate == 0 {
o.MinCompactionRate = 4 << 20 // 4 MB/s
}
if o.MinFlushRate == 0 {
o.MinFlushRate = 1 << 20 // 1 MB/s
}
if o.MaxConcurrentCompactions <= 0 {
o.MaxConcurrentCompactions = 1
}
o.initMaps()
return o
}
// initMaps initializes the Comparers, Filters, and Mergers maps.
func (o *Options) initMaps() {
for i := range o.Levels {
l := &o.Levels[i]
if l.FilterPolicy != nil {
if o.Filters == nil {
o.Filters = make(map[string]FilterPolicy)
}
name := l.FilterPolicy.Name()
if _, ok := o.Filters[name]; !ok {
o.Filters[name] = l.FilterPolicy
}
}
}
}
// Level returns the LevelOptions for the specified level.
func (o *Options) Level(level int) LevelOptions {
if level < len(o.Levels) {
return o.Levels[level]
}
n := len(o.Levels) - 1
l := o.Levels[n]
for i := n; i < level; i++ {
l.TargetFileSize *= 2
}
return l
}
// Clone creates a shallow-copy of the supplied options.
func (o *Options) Clone() *Options {
n := &Options{}
if o != nil {
*n = *o
}
return n
}
func filterPolicyName(p FilterPolicy) string {
if p == nil {
return "none"
}
return p.Name()
}
func (o *Options) String() string {
var buf bytes.Buffer
cacheSize := int64(cacheDefaultSize)
if o.Cache != nil {
cacheSize = o.Cache.MaxSize()
}
fmt.Fprintf(&buf, "[Version]\n")
fmt.Fprintf(&buf, " pebble_version=0.1\n")
fmt.Fprintf(&buf, "\n")
fmt.Fprintf(&buf, "[Options]\n")
fmt.Fprintf(&buf, " bytes_per_sync=%d\n", o.BytesPerSync)
fmt.Fprintf(&buf, " cache_size=%d\n", cacheSize)
fmt.Fprintf(&buf, " cleaner=%s\n", o.Cleaner)
fmt.Fprintf(&buf, " comparer=%s\n", o.Comparer.Name)
fmt.Fprintf(&buf, " disable_wal=%t\n", o.DisableWAL)
fmt.Fprintf(&buf, " l0_compaction_threshold=%d\n", o.L0CompactionThreshold)
fmt.Fprintf(&buf, " l0_stop_writes_threshold=%d\n", o.L0StopWritesThreshold)
fmt.Fprintf(&buf, " lbase_max_bytes=%d\n", o.LBaseMaxBytes)
fmt.Fprintf(&buf, " max_concurrent_compactions=%d\n", o.MaxConcurrentCompactions)
fmt.Fprintf(&buf, " max_manifest_file_size=%d\n", o.MaxManifestFileSize)
fmt.Fprintf(&buf, " max_open_files=%d\n", o.MaxOpenFiles)
fmt.Fprintf(&buf, " mem_table_size=%d\n", o.MemTableSize)
fmt.Fprintf(&buf, " mem_table_stop_writes_threshold=%d\n", o.MemTableStopWritesThreshold)
fmt.Fprintf(&buf, " min_compaction_rate=%d\n", o.MinCompactionRate)
fmt.Fprintf(&buf, " min_flush_rate=%d\n", o.MinFlushRate)
fmt.Fprintf(&buf, " merger=%s\n", o.Merger.Name)
fmt.Fprintf(&buf, " table_property_collectors=[")
for i := range o.TablePropertyCollectors {
if i > 0 {
fmt.Fprintf(&buf, ",")
}
// NB: This creates a new TablePropertyCollector, but Options.String() is
// called rarely so the overhead of doing so is not consequential.
fmt.Fprintf(&buf, "%s", o.TablePropertyCollectors[i]().Name())
}
fmt.Fprintf(&buf, "]\n")
fmt.Fprintf(&buf, " wal_dir=%s\n", o.WALDir)
for i := range o.Levels {
l := &o.Levels[i]
fmt.Fprintf(&buf, "\n")
fmt.Fprintf(&buf, "[Level \"%d\"]\n", i)
fmt.Fprintf(&buf, " block_restart_interval=%d\n", l.BlockRestartInterval)
fmt.Fprintf(&buf, " block_size=%d\n", l.BlockSize)
fmt.Fprintf(&buf, " compression=%s\n", l.Compression)
fmt.Fprintf(&buf, " filter_policy=%s\n", filterPolicyName(l.FilterPolicy))
fmt.Fprintf(&buf, " filter_type=%s\n", l.FilterType)
fmt.Fprintf(&buf, " index_block_size=%d\n", l.IndexBlockSize)
fmt.Fprintf(&buf, " target_file_size=%d\n", l.TargetFileSize)
}
return buf.String()
}
func parseOptions(s string, fn func(section, key, value string) error) error {
var section string
for _, line := range strings.Split(s, "\n") {
line = strings.TrimSpace(line)
if len(line) == 0 {
// Skip blank lines.
continue
}
if line[0] == ';' || line[0] == '#' {
// Skip comments.
continue
}
n := len(line)
if line[0] == '[' && line[n-1] == ']' {
// Parse section.
section = line[1 : n-1]
continue
}
pos := strings.Index(line, "=")
if pos < 0 {
return errors.Errorf("pebble: invalid key=value syntax: %s", errors.Safe(line))
}
key := strings.TrimSpace(line[:pos])
value := strings.TrimSpace(line[pos+1:])
// RocksDB uses a similar (INI-style) syntax for the OPTIONS file, but
// different section names and keys. The "CFOptions ..." paths are the
// RocksDB versions which we map to the Pebble paths.
mappedSection := section
if section == `CFOptions "default"` {
mappedSection = "Options"
switch key {
case "comparator":
key = "comparer"
case "merge_operator":
key = "merger"
}
}
if err := fn(mappedSection, key, value); err != nil {
return err
}
}
return nil
}
// ParseHooks contains callbacks to create options fields which can have
// user-defined implementations.
type ParseHooks struct {
NewCache func(size int64) *Cache
NewCleaner func(name string) (Cleaner, error)
NewComparer func(name string) (*Comparer, error)
NewFilterPolicy func(name string) (FilterPolicy, error)
NewMerger func(name string) (*Merger, error)
SkipUnknown func(name string) bool
}
// Parse parses the options from the specified string. Note that certain
// options cannot be parsed into populated fields. For example, comparer and
// merger.
func (o *Options) Parse(s string, hooks *ParseHooks) error {
return parseOptions(s, func(section, key, value string) error {
switch {
case section == "Version":
switch key {
case "pebble_version":
default:
if hooks != nil && hooks.SkipUnknown != nil && hooks.SkipUnknown(section+"."+key) {
return nil
}
return errors.Errorf("pebble: unknown option: %s.%s",
errors.Safe(section), errors.Safe(key))
}
return nil
case section == "Options":
var err error
switch key {
case "bytes_per_sync":
o.BytesPerSync, err = strconv.Atoi(value)
case "cache_size":
n, err := strconv.ParseInt(value, 10, 64)
if err == nil && hooks.NewCache != nil {
if o.Cache != nil {
o.Cache.Unref()
}
o.Cache = hooks.NewCache(n)
}
case "cleaner":
switch value {
case "archive":
o.Cleaner = ArchiveCleaner{}
case "delete":
o.Cleaner = DeleteCleaner{}
default:
if hooks != nil && hooks.NewCleaner != nil {
o.Cleaner, err = hooks.NewCleaner(value)
}
}
case "comparer":
switch value {
case "leveldb.BytewiseComparator":
o.Comparer = DefaultComparer
default:
if hooks != nil && hooks.NewComparer != nil {
o.Comparer, err = hooks.NewComparer(value)
}
}
case "disable_wal":
o.DisableWAL, err = strconv.ParseBool(value)
case "l0_compaction_threshold":
o.L0CompactionThreshold, err = strconv.Atoi(value)
case "l0_stop_writes_threshold":
o.L0StopWritesThreshold, err = strconv.Atoi(value)
case "lbase_max_bytes":
o.LBaseMaxBytes, err = strconv.ParseInt(value, 10, 64)
case "max_concurrent_compactions":
o.MaxConcurrentCompactions, err = strconv.Atoi(value)
case "max_manifest_file_size":
o.MaxManifestFileSize, err = strconv.ParseInt(value, 10, 64)
case "max_open_files":
o.MaxOpenFiles, err = strconv.Atoi(value)
case "mem_table_size":
o.MemTableSize, err = strconv.Atoi(value)
case "mem_table_stop_writes_threshold":
o.MemTableStopWritesThreshold, err = strconv.Atoi(value)
case "min_compaction_rate":
o.MinCompactionRate, err = strconv.Atoi(value)
case "min_flush_rate":
o.MinFlushRate, err = strconv.Atoi(value)
case "merger":
switch value {
case "nullptr":
o.Merger = nil
case "pebble.concatenate":
o.Merger = DefaultMerger
default:
if hooks != nil && hooks.NewMerger != nil {
o.Merger, err = hooks.NewMerger(value)
}
}
case "table_format":
switch value {
case "leveldb":
o.TableFormat = TableFormatLevelDB
case "rocksdbv2":
o.TableFormat = TableFormatRocksDBv2
default:
return errors.Errorf("pebble: unknown table format: %q", errors.Safe(value))
}
case "table_property_collectors":
// TODO(peter): set o.TablePropertyCollectors
case "wal_dir":
o.WALDir = value
default:
if hooks != nil && hooks.SkipUnknown != nil && hooks.SkipUnknown(section+"."+key) {
return nil
}
return errors.Errorf("pebble: unknown option: %s.%s",
errors.Safe(section), errors.Safe(key))
}
return err
case strings.HasPrefix(section, "Level "):
var index int
if n, err := fmt.Sscanf(section, `Level "%d"`, &index); err != nil {
return err
} else if n != 1 {
if hooks != nil && hooks.SkipUnknown != nil && hooks.SkipUnknown(section) {
return nil
}
return errors.Errorf("pebble: unknown section: %q", errors.Safe(section))
}
if len(o.Levels) <= index {
newLevels := make([]LevelOptions, index+1)
copy(newLevels, o.Levels)
o.Levels = newLevels
}
l := &o.Levels[index]
var err error
switch key {
case "block_restart_interval":
l.BlockRestartInterval, err = strconv.Atoi(value)
case "block_size":
l.BlockSize, err = strconv.Atoi(value)
case "compression":
switch value {
case "Default":
l.Compression = DefaultCompression
case "NoCompression":
l.Compression = NoCompression
case "Snappy":
l.Compression = SnappyCompression
default:
return errors.Errorf("pebble: unknown compression: %q", errors.Safe(value))
}
case "filter_policy":
if hooks != nil && hooks.NewFilterPolicy != nil {
l.FilterPolicy, err = hooks.NewFilterPolicy(value)
}
case "filter_type":
switch value {
case "table":
l.FilterType = TableFilter
default:
return errors.Errorf("pebble: unknown filter type: %q", errors.Safe(value))
}
case "index_block_size":
l.IndexBlockSize, err = strconv.Atoi(value)
case "target_file_size":
l.TargetFileSize, err = strconv.ParseInt(value, 10, 64)
default:
if hooks != nil && hooks.SkipUnknown != nil && hooks.SkipUnknown(section+"."+key) {
return nil
}
return errors.Errorf("pebble: unknown option: %s.%s", errors.Safe(section), errors.Safe(key))
}
return err
}
if hooks != nil && hooks.SkipUnknown != nil && hooks.SkipUnknown(section+"."+key) {
return nil
}
return errors.Errorf("pebble: unknown section: %q", errors.Safe(section))
})
}
// Check verifies the options are compatible with the previous options
// serialized by Options.String(). For example, the Comparer and Merger must be
// the same, or data will not be able to be properly read from the DB.
func (o *Options) Check(s string) error {
return parseOptions(s, func(section, key, value string) error {
switch section + "." + key {
case "Options.comparer":
if value != o.Comparer.Name {
return errors.Errorf("pebble: comparer name from file %q != comparer name from options %q",
errors.Safe(value), errors.Safe(o.Comparer.Name))
}
case "Options.merger":
// RocksDB allows the merge operator to be unspecified, in which case it
// shows up as "nullptr".
if value != "nullptr" && value != o.Merger.Name {
return errors.Errorf("pebble: merger name from file %q != merger name from options %q",
errors.Safe(value), errors.Safe(o.Merger.Name))
}
}
return nil
})
}
// Validate verifies that the options are mutually consistent. For example,
// L0StopWritesThreshold must be >= L0CompactionThreshold, otherwise a write
// stall would persist indefinitely.
func (o *Options) Validate() error {
// Note that we can presume Options.EnsureDefaults has been called, so there
// is no need to check for zero values.
var buf strings.Builder
if o.L0StopWritesThreshold < o.L0CompactionThreshold {
fmt.Fprintf(&buf, "L0StopWritesThreshold (%d) must be >= L0CompactionThreshold (%d)\n",
o.L0StopWritesThreshold, o.L0CompactionThreshold)
}
if o.MemTableStopWritesThreshold < 2 {
fmt.Fprintf(&buf, "MemTableStopWritesThreshold (%d) must be >= 2\n",
o.MemTableStopWritesThreshold)
}
switch o.TableFormat {
case TableFormatLevelDB:
fmt.Fprintf(&buf, "TableFormatLevelDB not supported for DB\n")
}
if buf.Len() == 0 {
return nil
}
return errors.New(buf.String())
}
// MakeReaderOptions constructs sstable.ReaderOptions from the corresponding
// options in the receiver.
func (o *Options) MakeReaderOptions() sstable.ReaderOptions {
var readerOpts sstable.ReaderOptions
if o != nil {
readerOpts.Cache = o.Cache
readerOpts.Comparer = o.Comparer
readerOpts.Filters = o.Filters
if o.Merger != nil {
readerOpts.MergerName = o.Merger.Name
}
}
return readerOpts
}
// MakeWriterOptions constructs sstable.WriterOptions for the specified level
// from the corresponding options in the receiver.
func (o *Options) MakeWriterOptions(level int) sstable.WriterOptions {
var writerOpts sstable.WriterOptions
if o != nil {
writerOpts.Cache = o.Cache
writerOpts.Comparer = o.Comparer
if o.Merger != nil {
writerOpts.MergerName = o.Merger.Name
}
writerOpts.TableFormat = o.TableFormat
writerOpts.TablePropertyCollectors = o.TablePropertyCollectors
}
levelOpts := o.Level(level)
writerOpts.BlockRestartInterval = levelOpts.BlockRestartInterval
writerOpts.BlockSize = levelOpts.BlockSize
writerOpts.BlockSizeThreshold = levelOpts.BlockSizeThreshold
writerOpts.Compression = levelOpts.Compression
writerOpts.FilterPolicy = levelOpts.FilterPolicy
writerOpts.FilterType = levelOpts.FilterType
writerOpts.IndexBlockSize = levelOpts.IndexBlockSize
return writerOpts
}