-
Notifications
You must be signed in to change notification settings - Fork 3.8k
/
rocksdb.go
3318 lines (2920 loc) · 96.4 KB
/
rocksdb.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
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2014 The Cockroach Authors.
//
// Use of this software is governed by the Business Source License
// included in the file licenses/BSL.txt.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0, included in the file
// licenses/APL.txt.
//
// +build !short
package storage
import (
"context"
"fmt"
"io"
"os"
"path/filepath"
"runtime/debug"
"sort"
"strings"
"sync"
"time"
"unsafe"
"github.com/cockroachdb/cockroach/pkg/base"
"github.com/cockroachdb/cockroach/pkg/roachpb"
"github.com/cockroachdb/cockroach/pkg/storage/enginepb"
"github.com/cockroachdb/cockroach/pkg/storage/fs"
"github.com/cockroachdb/cockroach/pkg/util"
"github.com/cockroachdb/cockroach/pkg/util/hlc"
"github.com/cockroachdb/cockroach/pkg/util/humanizeutil"
"github.com/cockroachdb/cockroach/pkg/util/log"
"github.com/cockroachdb/cockroach/pkg/util/protoutil"
"github.com/cockroachdb/cockroach/pkg/util/syncutil"
"github.com/cockroachdb/cockroach/pkg/util/timeutil"
"github.com/cockroachdb/errors"
"github.com/cockroachdb/logtags"
)
// TODO(tamird): why does rocksdb not link jemalloc,snappy statically?
// #cgo CPPFLAGS: -I../../c-deps/libroach/include
// #cgo LDFLAGS: -lroach
// #cgo LDFLAGS: -lprotobuf
// #cgo LDFLAGS: -lrocksdb
// #cgo LDFLAGS: -lsnappy
// #cgo linux LDFLAGS: -lrt -lpthread
// #cgo windows LDFLAGS: -lshlwapi -lrpcrt4
//
// #include <stdlib.h>
// #include <libroach.h>
import "C"
// Set to true to perform expensive iterator debug leak checking. In normal
// operation, we perform inexpensive iterator leak checking but those checks do
// not indicate where the leak arose. The expensive checking tracks the stack
// traces of every iterator allocated. DO NOT ENABLE in production code.
const debugIteratorLeak = false
var rocksdbLogger *log.SecondaryLogger
// InitRocksDBLogger initializes the logger to use for RocksDB log messages. If
// not called, WARNING, ERROR, and FATAL logs will be output to the normal
// CockroachDB log. The caller is responsible for ensuring the
// Close() method is eventually called on the new logger.
func InitRocksDBLogger(ctx context.Context) *log.SecondaryLogger {
rocksdbLogger = log.NewSecondaryLogger(ctx, nil, "rocksdb",
true /* enableGC */, false /* forceSyncWrites */, false /* enableMsgCount */)
return rocksdbLogger
}
//export rocksDBLog
func rocksDBLog(usePrimaryLog C.bool, sevLvl C.int, s *C.char, n C.int) {
sev := log.Severity(sevLvl)
if !usePrimaryLog {
if rocksdbLogger != nil {
// NB: No need for the rocksdb tag if we're logging to a rocksdb specific
// file.
rocksdbLogger.LogSev(context.Background(), sev, C.GoStringN(s, n))
return
}
// Only log INFO logs to the normal CockroachDB log at --v=3 and
// above. This only applies when we're not using the primary log for
// RocksDB generated messages (which is utilized by the encryption-at-rest
// code).
if sev == log.Severity_INFO && !log.V(3) {
return
}
}
ctx := logtags.AddTag(context.Background(), "rocksdb", nil)
switch sev {
case log.Severity_WARNING:
log.Warningf(ctx, "%v", C.GoStringN(s, n))
case log.Severity_ERROR:
log.Errorf(ctx, "%v", C.GoStringN(s, n))
case log.Severity_FATAL:
log.Fatalf(ctx, "%v", C.GoStringN(s, n))
default:
log.Infof(ctx, "%v", C.GoStringN(s, n))
}
}
//export prettyPrintKey
func prettyPrintKey(cKey C.DBKey) *C.char {
mvccKey := MVCCKey{
Key: gobytes(unsafe.Pointer(cKey.key.data), int(cKey.key.len)),
Timestamp: hlc.Timestamp{
WallTime: int64(cKey.wall_time),
Logical: int32(cKey.logical),
},
}
return C.CString(mvccKey.String())
}
// RocksDBCache is a wrapper around C.DBCache
type RocksDBCache struct {
cache *C.DBCache
}
// SetRocksDBOpenHook sets the DBOpenHook function that will be called during
// RocksDB initialization. It is intended to be called by CCL code.
func SetRocksDBOpenHook(fn unsafe.Pointer) {
C.DBSetOpenHook(fn)
}
// NewRocksDBCache creates a new cache of the specified size. Note that the
// cache is refcounted internally and starts out with a refcount of one (i.e.
// Release() should be called after having used the cache).
func NewRocksDBCache(cacheSize int64) RocksDBCache {
return RocksDBCache{cache: C.DBNewCache(C.uint64_t(cacheSize))}
}
func (c RocksDBCache) ref() RocksDBCache {
if c.cache != nil {
c.cache = C.DBRefCache(c.cache)
}
return c
}
// Release releases the cache. Note that the cache will continue to be used
// until all of the RocksDB engines it was attached to have been closed, and
// that RocksDB engines which use it auto-release when they close.
func (c RocksDBCache) Release() {
if c.cache != nil {
C.DBReleaseCache(c.cache)
}
}
// RocksDBConfig holds all configuration parameters and knobs used in setting
// up a new RocksDB instance.
type RocksDBConfig struct {
// StorageConfig contains storage configs for all storage engines.
base.StorageConfig
// ReadOnly will open the database in read only mode if set to true.
ReadOnly bool
// MaxOpenFiles controls the maximum number of file descriptors RocksDB
// creates. If MaxOpenFiles is zero, this is set to DefaultMaxOpenFiles.
MaxOpenFiles uint64
// WarnLargeBatchThreshold controls if a log message is printed when a
// WriteBatch takes longer than WarnLargeBatchThreshold. If it is set to
// zero, no log messages are ever printed.
WarnLargeBatchThreshold time.Duration
// RocksDBOptions contains RocksDB specific options using a semicolon
// separated key-value syntax ("key1=value1; key2=value2").
RocksDBOptions string
}
// RocksDB is a wrapper around a RocksDB database instance.
type RocksDB struct {
cfg RocksDBConfig
rdb *C.DBEngine
cache RocksDBCache // Shared cache.
// auxDir is used for storing auxiliary files. Ideally it is a subdirectory of Dir.
auxDir string
commit struct {
syncutil.Mutex
cond sync.Cond
committing bool
groupSize int
pending []*rocksDBBatch
}
syncer struct {
syncutil.Mutex
cond sync.Cond
closed bool
pending []*rocksDBBatch
}
iters struct {
syncutil.Mutex
m map[*rocksDBIterator][]byte
}
}
var _ Engine = &RocksDB{}
// NewRocksDB allocates and returns a new RocksDB object.
// This creates options and opens the database. If the database
// doesn't yet exist at the specified directory, one is initialized
// from scratch.
// The caller must call the engine's Close method when the engine is no longer
// needed.
func NewRocksDB(cfg RocksDBConfig, cache RocksDBCache) (*RocksDB, error) {
if cfg.Dir == "" {
return nil, errors.New("dir must be non-empty")
}
r := &RocksDB{
cfg: cfg,
cache: cache.ref(),
auxDir: filepath.Join(cfg.Dir, base.AuxiliaryDir),
}
if err := r.open(); err != nil {
return nil, err
}
return r, nil
}
func newRocksDBInMem(attrs roachpb.Attributes, cacheSize int64) *RocksDB {
cache := NewRocksDBCache(cacheSize)
// The cache starts out with a refcount of one, and creating the engine
// from it adds another refcount, at which point we release one of them.
defer cache.Release()
// TODO(bdarnell): The hard-coded 512 MiB is wrong; see
// https://github.com/cockroachdb/cockroach/issues/16750
db, err := newMemRocksDB(attrs, cache, 512<<20 /* MaxSize: 512 MiB */)
if err != nil {
panic(err)
}
return db
}
func newMemRocksDB(attrs roachpb.Attributes, cache RocksDBCache, maxSize int64) (*RocksDB, error) {
r := &RocksDB{
cfg: RocksDBConfig{
StorageConfig: base.StorageConfig{
Attrs: attrs,
MaxSize: maxSize,
},
},
// dir: empty dir == "mem" RocksDB instance.
cache: cache.ref(),
auxDir: "cockroach-auxiliary",
}
if err := r.open(); err != nil {
return nil, err
}
return r, nil
}
// String formatter.
func (r *RocksDB) String() string {
dir := r.cfg.Dir
if r.cfg.Dir == "" {
dir = "<in-mem>"
}
attrs := r.Attrs().String()
if attrs == "" {
attrs = "<no-attributes>"
}
return fmt.Sprintf("%s=%s", attrs, dir)
}
func (r *RocksDB) open() error {
var existingVersion, newVersion storageVersion
if len(r.cfg.Dir) != 0 {
log.Infof(context.TODO(), "opening rocksdb instance at %q", r.cfg.Dir)
// Check the version number.
var err error
if existingVersion, err = getVersion(r.cfg.Dir); err != nil {
return err
}
if existingVersion < versionMinimum || existingVersion > versionCurrent {
// Instead of an error, we should call a migration if possible when
// one is needed immediately following the DBOpen call.
return fmt.Errorf("incompatible rocksdb data version, current:%d, on disk:%d, minimum:%d",
versionCurrent, existingVersion, versionMinimum)
}
newVersion = existingVersion
if newVersion == versionNoFile {
// We currently set the default store version one before the file registry
// to allow downgrades to older binaries as long as encryption is not in use.
// TODO(mberhault): once enough releases supporting versionFileRegistry have passed, we can upgrade
// to it without worry.
newVersion = versionBeta20160331
}
// Using the file registry forces the latest version. We can't downgrade!
if r.cfg.UseFileRegistry {
newVersion = versionCurrent
}
} else {
if log.V(2) {
log.Infof(context.TODO(), "opening in memory rocksdb instance")
}
// In memory dbs are always current.
existingVersion = versionCurrent
}
maxOpenFiles := uint64(RecommendedMaxOpenFiles)
if r.cfg.MaxOpenFiles != 0 {
maxOpenFiles = r.cfg.MaxOpenFiles
}
if r.cfg.Dir != "" {
if err := os.MkdirAll(r.cfg.Dir, os.ModePerm); err != nil {
return err
}
}
status := C.DBOpen(&r.rdb, goToCSlice([]byte(r.cfg.Dir)),
C.DBOptions{
cache: r.cache.cache,
num_cpu: C.int(rocksdbConcurrency),
max_open_files: C.int(maxOpenFiles),
use_file_registry: C.bool(newVersion == versionCurrent),
must_exist: C.bool(r.cfg.MustExist),
read_only: C.bool(r.cfg.ReadOnly),
rocksdb_options: goToCSlice([]byte(r.cfg.RocksDBOptions)),
extra_options: goToCSlice(r.cfg.ExtraOptions),
})
if err := statusToError(status); err != nil {
return errors.Wrap(err, "could not open rocksdb instance")
}
// Update or add the version file if needed and if on-disk.
if len(r.cfg.Dir) != 0 && existingVersion < newVersion {
if err := writeVersionFile(r.cfg.Dir, newVersion); err != nil {
return err
}
}
// Create the auxiliary directory if necessary.
if !r.cfg.ReadOnly {
if err := r.MkdirAll(r.auxDir); err != nil {
return err
}
}
r.commit.cond.L = &r.commit.Mutex
r.syncer.cond.L = &r.syncer.Mutex
r.iters.m = make(map[*rocksDBIterator][]byte)
// NB: The sync goroutine acts as a check that the RocksDB instance was
// properly closed as the goroutine will leak otherwise.
go r.syncLoop()
return nil
}
func (r *RocksDB) syncLoop() {
s := &r.syncer
s.Lock()
var lastSync time.Time
var err error
for {
for len(s.pending) == 0 && !s.closed {
s.cond.Wait()
}
if s.closed {
s.Unlock()
return
}
var min time.Duration
if r.cfg.Settings != nil {
min = minWALSyncInterval.Get(&r.cfg.Settings.SV)
}
if delta := timeutil.Since(lastSync); delta < min {
s.Unlock()
time.Sleep(min - delta)
s.Lock()
}
pending := s.pending
s.pending = nil
s.Unlock()
// Linux only guarantees we'll be notified of a writeback error once
// during a sync call. After sync fails once, we cannot rely on any
// future data written to WAL being crash-recoverable. That's because
// any future writes will be appended after a potential corruption in
// the WAL, and RocksDB's recovery terminates upon encountering any
// corruption. So, we must not call `DBSyncWAL` again after it has
// failed once.
if r.cfg.Dir != "" && err == nil {
err = statusToError(C.DBSyncWAL(r.rdb))
lastSync = timeutil.Now()
}
for _, b := range pending {
b.commitErr = err
b.commitWG.Done()
}
s.Lock()
}
}
// Close closes the database by deallocating the underlying handle.
func (r *RocksDB) Close() {
if r.rdb == nil {
log.Errorf(context.TODO(), "closing unopened rocksdb instance")
return
}
if len(r.cfg.Dir) == 0 {
if log.V(1) {
log.Infof(context.TODO(), "closing in-memory rocksdb instance")
}
} else {
log.Infof(context.TODO(), "closing rocksdb instance at %q", r.cfg.Dir)
}
if r.rdb != nil {
if err := statusToError(C.DBClose(r.rdb)); err != nil {
if debugIteratorLeak {
r.iters.Lock()
for _, stack := range r.iters.m {
fmt.Printf("%s\n", stack)
}
r.iters.Unlock()
}
panic(err)
}
r.rdb = nil
}
r.cache.Release()
r.syncer.Lock()
r.syncer.closed = true
r.syncer.cond.Signal()
r.syncer.Unlock()
}
// CreateCheckpoint creates a RocksDB checkpoint in the given directory (which
// must not exist). This directory should be located on the same file system, or
// copies of all data are used instead of hard links, which is very expensive.
func (r *RocksDB) CreateCheckpoint(dir string) error {
status := C.DBCreateCheckpoint(r.rdb, goToCSlice([]byte(dir)))
return errors.Wrap(statusToError(status), "unable to take RocksDB checkpoint")
}
// Closed returns true if the engine is closed.
func (r *RocksDB) Closed() bool {
return r.rdb == nil
}
// ExportToSst is part of the engine.Reader interface.
func (r *RocksDB) ExportToSst(
startKey, endKey roachpb.Key,
startTS, endTS hlc.Timestamp,
exportAllRevisions bool,
targetSize, maxSize uint64,
io IterOptions,
) ([]byte, roachpb.BulkOpSummary, roachpb.Key, error) {
start := MVCCKey{Key: startKey, Timestamp: startTS}
end := MVCCKey{Key: endKey, Timestamp: endTS}
var data C.DBString
var intentErr C.DBString
var bulkopSummary C.DBString
var resumeKey C.DBString
err := statusToError(C.DBExportToSst(goToCKey(start), goToCKey(end),
C.bool(exportAllRevisions),
C.uint64_t(targetSize), C.uint64_t(maxSize),
goToCIterOptions(io), r.rdb, &data, &intentErr, &bulkopSummary, &resumeKey))
if err != nil {
if err.Error() == "WriteIntentError" {
var e roachpb.WriteIntentError
if err := protoutil.Unmarshal(cStringToGoBytes(intentErr), &e); err != nil {
return nil, roachpb.BulkOpSummary{}, nil, errors.Wrap(err, "failed to decode write intent error")
}
return nil, roachpb.BulkOpSummary{}, nil, &e
}
return nil, roachpb.BulkOpSummary{}, nil, err
}
var summary roachpb.BulkOpSummary
if err := protoutil.Unmarshal(cStringToGoBytes(bulkopSummary), &summary); err != nil {
return nil, roachpb.BulkOpSummary{}, nil, errors.Wrap(err, "failed to decode BulkopSummary")
}
return cStringToGoBytes(data), summary, roachpb.Key(cStringToGoBytes(resumeKey)), nil
}
// Attrs returns the list of attributes describing this engine. This
// may include a specification of disk type (e.g. hdd, ssd, fio, etc.)
// and potentially other labels to identify important attributes of
// the engine.
func (r *RocksDB) Attrs() roachpb.Attributes {
return r.cfg.Attrs
}
// Put sets the given key to the value provided.
//
// It is safe to modify the contents of the arguments after Put returns.
func (r *RocksDB) Put(key MVCCKey, value []byte) error {
b := r.NewWriteOnlyBatch()
defer b.Close()
if err := b.Put(key, value); err != nil {
return err
}
return b.Commit(true)
}
// Merge implements the RocksDB merge operator using the function goMergeInit
// to initialize missing values and goMerge to merge the old and the given
// value into a new value, which is then stored under key.
// Currently 64-bit counter logic is implemented. See the documentation of
// goMerge and goMergeInit for details.
//
// It is safe to modify the contents of the arguments after Merge returns.
func (r *RocksDB) Merge(key MVCCKey, value []byte) error {
b := r.NewWriteOnlyBatch()
defer b.Close()
if err := b.Merge(key, value); err != nil {
return err
}
return b.Commit(true)
}
// LogData is part of the Writer interface.
//
// It is safe to modify the contents of the arguments after LogData returns.
func (r *RocksDB) LogData(data []byte) error {
panic("unimplemented")
}
// LogLogicalOp is part of the Writer interface.
func (r *RocksDB) LogLogicalOp(op MVCCLogicalOpType, details MVCCLogicalOpDetails) {
// No-op. Logical logging disabled.
}
// ApplyBatchRepr atomically applies a set of batched updates. Created by
// calling Repr() on a batch. Using this method is equivalent to constructing
// and committing a batch whose Repr() equals repr.
//
// It is safe to modify the contents of the arguments after ApplyBatchRepr
// returns.
func (r *RocksDB) ApplyBatchRepr(repr []byte, sync bool) error {
b := r.NewWriteOnlyBatch()
defer b.Close()
if err := b.ApplyBatchRepr(repr, sync); err != nil {
return err
}
return b.Commit(sync)
}
// Get returns the value for the given key.
func (r *RocksDB) Get(key MVCCKey) ([]byte, error) {
return dbGet(r.rdb, key)
}
// GetProto fetches the value at the specified key and unmarshals it.
func (r *RocksDB) GetProto(
key MVCCKey, msg protoutil.Message,
) (ok bool, keyBytes, valBytes int64, err error) {
return dbGetProto(r.rdb, key, msg)
}
// Clear removes the item from the db with the given key.
//
// It is safe to modify the contents of the arguments after Clear returns.
func (r *RocksDB) Clear(key MVCCKey) error {
b := r.NewWriteOnlyBatch()
defer b.Close()
if err := b.Clear(key); err != nil {
return err
}
return b.Commit(true)
}
// SingleClear removes the most recent item from the db with the given key.
//
// It is safe to modify the contents of the arguments after SingleClear returns.
func (r *RocksDB) SingleClear(key MVCCKey) error {
b := r.NewWriteOnlyBatch()
defer b.Close()
if err := b.SingleClear(key); err != nil {
return err
}
return b.Commit(true)
}
// ClearRange removes a set of entries, from start (inclusive) to end
// (exclusive).
//
// It is safe to modify the contents of the arguments after ClearRange returns.
func (r *RocksDB) ClearRange(start, end MVCCKey) error {
b := r.NewWriteOnlyBatch()
defer b.Close()
if err := b.ClearRange(start, end); err != nil {
return err
}
return b.Commit(true)
}
// ClearIterRange removes a set of entries, from start (inclusive) to end
// (exclusive).
//
// It is safe to modify the contents of the arguments after ClearIterRange
// returns.
func (r *RocksDB) ClearIterRange(iter Iterator, start, end roachpb.Key) error {
b := r.NewWriteOnlyBatch()
defer b.Close()
err := r.Iterate(start, end, func(keyValue MVCCKeyValue) error {
return b.Clear(keyValue.Key)
})
if err != nil {
return err
}
return b.Commit(true)
}
// Iterate iterates from start to end keys, invoking f on each
// key/value pair. See engine.Iterate for details.
func (r *RocksDB) Iterate(start, end roachpb.Key, f func(MVCCKeyValue) error) error {
return iterateOnReader(r, start, end, f)
}
// Capacity queries the underlying file system for disk capacity information.
func (r *RocksDB) Capacity() (roachpb.StoreCapacity, error) {
return computeCapacity(r.cfg.Dir, r.cfg.MaxSize)
}
// Compact forces compaction over the entire database.
func (r *RocksDB) Compact() error {
return statusToError(C.DBCompact(r.rdb))
}
// CompactRange forces compaction over a specified range of keys in the database.
func (r *RocksDB) CompactRange(start, end roachpb.Key, forceBottommost bool) error {
return statusToError(C.DBCompactRange(r.rdb, goToCSlice(start), goToCSlice(end), C.bool(forceBottommost)))
}
// disableAutoCompaction disables automatic compactions. For testing use only.
func (r *RocksDB) disableAutoCompaction() error {
return statusToError(C.DBDisableAutoCompaction(r.rdb))
}
// ApproximateDiskBytes returns the approximate on-disk size of the specified key range.
func (r *RocksDB) ApproximateDiskBytes(from, to roachpb.Key) (uint64, error) {
start := MVCCKey{Key: from}
end := MVCCKey{Key: to}
var result C.uint64_t
err := statusToError(C.DBApproximateDiskBytes(r.rdb, goToCKey(start), goToCKey(end), &result))
return uint64(result), err
}
// Flush causes RocksDB to write all in-memory data to disk immediately.
func (r *RocksDB) Flush() error {
return statusToError(C.DBFlush(r.rdb))
}
// NewIterator returns an iterator over this rocksdb engine.
func (r *RocksDB) NewIterator(opts IterOptions) Iterator {
return newRocksDBIterator(r.rdb, opts, r, r)
}
// NewSnapshot creates a snapshot handle from engine and returns a
// read-only rocksDBSnapshot engine.
func (r *RocksDB) NewSnapshot() Reader {
if r.rdb == nil {
panic("RocksDB is not initialized yet")
}
return &rocksDBSnapshot{
parent: r,
handle: C.DBNewSnapshot(r.rdb),
}
}
// Type implements the Engine interface.
func (r *RocksDB) Type() enginepb.EngineType {
return enginepb.EngineTypeRocksDB
}
// NewReadOnly returns a new ReadWriter wrapping this rocksdb engine.
func (r *RocksDB) NewReadOnly() ReadWriter {
return &rocksDBReadOnly{
parent: r,
isClosed: false,
}
}
type rocksDBReadOnly struct {
parent *RocksDB
prefixIter reusableIterator
normalIter reusableIterator
isClosed bool
}
func (r *rocksDBReadOnly) Close() {
if r.isClosed {
panic("closing an already-closed rocksDBReadOnly")
}
r.isClosed = true
if i := &r.prefixIter.rocksDBIterator; i.iter != nil {
i.destroy()
}
if i := &r.normalIter.rocksDBIterator; i.iter != nil {
i.destroy()
}
}
// Read-only batches are not committed
func (r *rocksDBReadOnly) Closed() bool {
return r.isClosed
}
// ExportToSst is part of the engine.Reader interface.
func (r *rocksDBReadOnly) ExportToSst(
startKey, endKey roachpb.Key,
startTS, endTS hlc.Timestamp,
exportAllRevisions bool,
targetSize, maxSize uint64,
io IterOptions,
) ([]byte, roachpb.BulkOpSummary, roachpb.Key, error) {
return r.parent.ExportToSst(startKey, endKey, startTS, endTS, exportAllRevisions, targetSize, maxSize, io)
}
func (r *rocksDBReadOnly) Get(key MVCCKey) ([]byte, error) {
if r.isClosed {
panic("using a closed rocksDBReadOnly")
}
return dbGet(r.parent.rdb, key)
}
func (r *rocksDBReadOnly) GetProto(
key MVCCKey, msg protoutil.Message,
) (ok bool, keyBytes, valBytes int64, err error) {
if r.isClosed {
panic("using a closed rocksDBReadOnly")
}
return dbGetProto(r.parent.rdb, key, msg)
}
func (r *rocksDBReadOnly) Iterate(start, end roachpb.Key, f func(MVCCKeyValue) error) error {
if r.isClosed {
panic("using a closed rocksDBReadOnly")
}
return iterateOnReader(r, start, end, f)
}
// NewIterator returns an iterator over the underlying engine. Note
// that the returned iterator is cached and re-used for the lifetime of the
// rocksDBReadOnly. A panic will be thrown if multiple prefix or normal (non-prefix)
// iterators are used simultaneously on the same rocksDBReadOnly.
func (r *rocksDBReadOnly) NewIterator(opts IterOptions) Iterator {
if r.isClosed {
panic("using a closed rocksDBReadOnly")
}
if opts.MinTimestampHint != (hlc.Timestamp{}) {
// Iterators that specify timestamp bounds cannot be cached.
return newRocksDBIterator(r.parent.rdb, opts, r, r.parent)
}
iter := &r.normalIter
if opts.Prefix {
iter = &r.prefixIter
}
if iter.rocksDBIterator.iter == nil {
iter.rocksDBIterator.init(r.parent.rdb, opts, r, r.parent)
} else {
iter.rocksDBIterator.setOptions(opts)
}
if iter.inuse {
panic("iterator already in use")
}
iter.inuse = true
return iter
}
// Writer methods are not implemented for rocksDBReadOnly. Ideally, the code
// could be refactored so that a Reader could be supplied to evaluateBatch
// Writer is the write interface to an engine's data.
func (r *rocksDBReadOnly) ApplyBatchRepr(repr []byte, sync bool) error {
panic("not implemented")
}
func (r *rocksDBReadOnly) Clear(key MVCCKey) error {
panic("not implemented")
}
func (r *rocksDBReadOnly) SingleClear(key MVCCKey) error {
panic("not implemented")
}
func (r *rocksDBReadOnly) ClearRange(start, end MVCCKey) error {
panic("not implemented")
}
func (r *rocksDBReadOnly) ClearIterRange(iter Iterator, start, end roachpb.Key) error {
panic("not implemented")
}
func (r *rocksDBReadOnly) Merge(key MVCCKey, value []byte) error {
panic("not implemented")
}
func (r *rocksDBReadOnly) Put(key MVCCKey, value []byte) error {
panic("not implemented")
}
func (r *rocksDBReadOnly) LogData(data []byte) error {
panic("not implemented")
}
func (r *rocksDBReadOnly) LogLogicalOp(op MVCCLogicalOpType, details MVCCLogicalOpDetails) {
panic("not implemented")
}
// NewBatch returns a new batch wrapping this rocksdb engine.
func (r *RocksDB) NewBatch() Batch {
b := newRocksDBBatch(r, false /* writeOnly */)
return b
}
// NewWriteOnlyBatch returns a new write-only batch wrapping this rocksdb
// engine.
func (r *RocksDB) NewWriteOnlyBatch() Batch {
return newRocksDBBatch(r, true /* writeOnly */)
}
// GetSSTables retrieves metadata about this engine's live sstables.
func (r *RocksDB) GetSSTables() SSTableInfos {
var n C.int
tables := C.DBGetSSTables(r.rdb, &n)
// We can't index into tables because it is a pointer, not a slice. The
// hackery below treats the pointer as an array and then constructs a slice
// from it.
tableSize := unsafe.Sizeof(C.DBSSTable{})
tableVal := func(i int) C.DBSSTable {
return *(*C.DBSSTable)(unsafe.Pointer(uintptr(unsafe.Pointer(tables)) + uintptr(i)*tableSize))
}
res := make(SSTableInfos, n)
for i := range res {
r := &res[i]
tv := tableVal(i)
r.Level = int(tv.level)
r.Size = int64(tv.size)
r.Start = cToGoKey(tv.start_key)
r.End = cToGoKey(tv.end_key)
if ptr := tv.start_key.key.data; ptr != nil {
C.free(unsafe.Pointer(ptr))
}
if ptr := tv.end_key.key.data; ptr != nil {
C.free(unsafe.Pointer(ptr))
}
}
C.free(unsafe.Pointer(tables))
sort.Sort(res)
return res
}
// WALFileInfo contains metadata about a single write-ahead log file. Note this
// mirrors the C.DBWALFile struct.
type WALFileInfo struct {
LogNumber int64
Size int64
}
// GetSortedWALFiles retrievews information about all of the write-ahead log
// files in this engine in order from oldest to newest.
func (r *RocksDB) GetSortedWALFiles() ([]WALFileInfo, error) {
var n C.int
var files *C.DBWALFile
status := C.DBGetSortedWALFiles(r.rdb, &files, &n)
if err := statusToError(status); err != nil {
return nil, errors.Wrap(err, "could not get sorted WAL files")
}
defer C.free(unsafe.Pointer(files))
// We can't index into files because it is a pointer, not a slice. The hackery
// below treats the pointer as an array and then constructs a slice from it.
structSize := unsafe.Sizeof(C.DBWALFile{})
getWALFile := func(i int) *C.DBWALFile {
return (*C.DBWALFile)(unsafe.Pointer(uintptr(unsafe.Pointer(files)) + uintptr(i)*structSize))
}
res := make([]WALFileInfo, n)
for i := range res {
wf := getWALFile(i)
res[i].LogNumber = int64(wf.log_number)
res[i].Size = int64(wf.size)
}
return res, nil
}
// GetUserProperties fetches the user properties stored in each sstable's
// metadata.
func (r *RocksDB) GetUserProperties() (enginepb.SSTUserPropertiesCollection, error) {
buf := cStringToGoBytes(C.DBGetUserProperties(r.rdb))
var ssts enginepb.SSTUserPropertiesCollection
if err := protoutil.Unmarshal(buf, &ssts); err != nil {
return enginepb.SSTUserPropertiesCollection{}, err
}
if ssts.Error != "" {
return enginepb.SSTUserPropertiesCollection{}, errors.Newf("%s", ssts.Error)
}
return ssts, nil
}
// GetMetrics retrieves stats from this engine's RocksDB instance and
// returns it in a new instance of Metrics.
func (r *RocksDB) GetMetrics() (*Metrics, error) {
var s C.DBStatsResult
if err := statusToError(C.DBGetStats(r.rdb, &s)); err != nil {
return nil, err
}
ssts := r.GetSSTables()
return &Metrics{
BlockCacheHits: int64(s.block_cache_hits),
BlockCacheMisses: int64(s.block_cache_misses),
BlockCacheUsage: int64(s.block_cache_usage),
BlockCachePinnedUsage: int64(s.block_cache_pinned_usage),
BloomFilterPrefixChecked: int64(s.bloom_filter_prefix_checked),
BloomFilterPrefixUseful: int64(s.bloom_filter_prefix_useful),
MemtableTotalSize: int64(s.memtable_total_size),
Flushes: int64(s.flushes),
FlushedBytes: int64(s.flush_bytes),
Compactions: int64(s.compactions),
IngestedBytes: 0, // Not exposed by RocksDB.
CompactedBytesRead: int64(s.compact_read_bytes),
CompactedBytesWritten: int64(s.compact_write_bytes),
TableReadersMemEstimate: int64(s.table_readers_mem_estimate),
PendingCompactionBytesEstimate: int64(s.pending_compaction_bytes_estimate),
L0FileCount: int64(s.l0_file_count),
L0SublevelCount: -1, // Not a RocksDB feature.
ReadAmplification: ssts.readAmplification(-1),
NumSSTables: int64(ssts.Len()),
}, nil
}
// GetTickersAndHistograms retrieves maps of all RocksDB tickers and
// histograms. It differs from `GetMetrics` by getting _every_ ticker and
// histogram, and by not getting anything else (DB properties, for example).
func (r *RocksDB) GetTickersAndHistograms() (*enginepb.TickersAndHistograms, error) {
res := new(enginepb.TickersAndHistograms)
var s C.DBTickersAndHistogramsResult
if err := statusToError(C.DBGetTickersAndHistograms(r.rdb, &s)); err != nil {
return nil, err
}
tickers := (*[MaxArrayLen / C.sizeof_TickerInfo]C.TickerInfo)(
unsafe.Pointer(s.tickers))[:s.tickers_len:s.tickers_len]
res.Tickers = make(map[string]uint64)
for _, ticker := range tickers {
name := cStringToGoString(ticker.name)
value := uint64(ticker.value)
res.Tickers[name] = value
}
C.free(unsafe.Pointer(s.tickers))
res.Histograms = make(map[string]enginepb.HistogramData)
histograms := (*[MaxArrayLen / C.sizeof_HistogramInfo]C.HistogramInfo)(
unsafe.Pointer(s.histograms))[:s.histograms_len:s.histograms_len]
for _, histogram := range histograms {
name := cStringToGoString(histogram.name)
value := enginepb.HistogramData{
Mean: float64(histogram.mean),
P50: float64(histogram.p50),
P95: float64(histogram.p95),
P99: float64(histogram.p99),
Max: float64(histogram.max),
Count: uint64(histogram.count),
Sum: uint64(histogram.sum),
}
res.Histograms[name] = value
}
C.free(unsafe.Pointer(s.histograms))
return res, nil
}
// GetCompactionStats returns the internal RocksDB compaction stats. See
// https://github.com/facebook/rocksdb/wiki/RocksDB-Tuning-Guide#rocksdb-statistics.
func (r *RocksDB) GetCompactionStats() string {
s := cStringToGoString(C.DBGetCompactionStats(r.rdb)) +
"estimated_pending_compaction_bytes: "
m, err := r.GetMetrics()
if err != nil {
return s + err.Error()
}