-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
leveldb.go
283 lines (264 loc) · 8.44 KB
/
leveldb.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
// Copyright 2016 Keybase Inc. All rights reserved.
// Use of this source code is governed by a BSD
// license that can be found in the LICENSE file.
package ldbutils
import (
"context"
"fmt"
"io"
"os"
"path/filepath"
"strconv"
"strings"
"github.com/keybase/client/go/kbfs/ioutil"
"github.com/keybase/client/go/logger"
"github.com/pkg/errors"
"github.com/syndtr/goleveldb/leveldb"
ldberrors "github.com/syndtr/goleveldb/leveldb/errors"
"github.com/syndtr/goleveldb/leveldb/filter"
"github.com/syndtr/goleveldb/leveldb/opt"
"github.com/syndtr/goleveldb/leveldb/storage"
)
const (
diskCacheVersionFilename string = "version"
// Metered specified that this DB should be metered.
Metered = true
// Unmetered specified that this DB should not be metered.
Unmetered = false
)
// DbWriteBufferSizeGetter is an interface that contains a method for
// getting the size of a leveldb write buffer.
type DbWriteBufferSizeGetter interface {
// DbWriteBufferSize indicates how large the write buffer should
// be on local levelDbs -- this also controls how big the on-disk
// tables are before compaction.
DbWriteBufferSize() int
}
var leveldbOptions = &opt.Options{
Compression: opt.NoCompression,
WriteBuffer: 10 * opt.MiB,
BlockSize: 1 << 16,
// Default max open file descriptors (ulimit -n) is 256 on OS
// X, and >=1024 on (most?) Linux machines. So set to a low
// number since we have multiple leveldb instances.
OpenFilesCacheCapacity: 10,
}
// LeveldbOptions returns leveldb options.
func LeveldbOptions(sizeGetter DbWriteBufferSizeGetter) *opt.Options {
o := *leveldbOptions
if sizeGetter != nil {
o.WriteBuffer = sizeGetter.DbWriteBufferSize()
}
return &o
}
// LevelDb is a libkbfs wrapper for leveldb.DB.
type LevelDb struct {
*leveldb.DB
closer io.Closer
}
// Close closes the DB.
func (ldb *LevelDb) Close() (err error) {
err = ldb.DB.Close()
// Hide the closer error.
_ = ldb.closer.Close()
return err
}
// Get gets data from the DB.
func (ldb *LevelDb) Get(key []byte, ro *opt.ReadOptions) (
value []byte, err error) {
defer func() {
if err != nil {
err = errors.WithStack(err)
}
}()
return ldb.DB.Get(key, ro)
}
// GetWithMeter gets data from the DB while tracking the hit rate.
func (ldb *LevelDb) GetWithMeter(key []byte, hitMeter, missMeter *CountMeter) (
value []byte, err error) {
defer func() {
if err == nil {
if hitMeter != nil {
hitMeter.Mark(1)
}
} else if missMeter != nil {
missMeter.Mark(1)
}
}()
return ldb.Get(key, nil)
}
// Put puts data into the DB.
func (ldb *LevelDb) Put(key, value []byte, wo *opt.WriteOptions) (err error) {
defer func() {
if err != nil {
err = errors.WithStack(err)
}
}()
return ldb.DB.Put(key, value, wo)
}
// PutWithMeter gets data from the DB while tracking the hit rate.
func (ldb *LevelDb) PutWithMeter(key, value []byte, putMeter *CountMeter) (
err error) {
defer func() {
if err == nil && putMeter != nil {
putMeter.Mark(1)
}
}()
return ldb.Put(key, value, nil)
}
// StatStrings returns newline-split leveldb stats, suitable for JSONification.
func (ldb *LevelDb) StatStrings() ([]string, error) {
stats, err := ldb.GetProperty("leveldb.stats")
if err != nil {
return nil, err
}
return strings.Split(stats, "\n"), nil
}
// OpenLevelDbWithOptions opens or recovers a leveldb.DB with a
// passed-in storage.Storage as its underlying storage layer, and with
// the options specified.
func OpenLevelDbWithOptions(stor storage.Storage, options *opt.Options) (
*LevelDb, error) {
db, err := leveldb.Open(stor, options)
if ldberrors.IsCorrupted(err) {
// There's a possibility that if the leveldb wasn't closed properly
// last time while it was being written, then the manifest is corrupt.
// This means leveldb must rebuild its manifest, which takes longer
// than a simple `Open`.
// TODO: log here
db, err = leveldb.Recover(stor, options)
}
if err != nil {
stor.Close()
return nil, err
}
return &LevelDb{db, stor}, nil
}
// OpenLevelDb opens or recovers a leveldb.DB with a passed-in
// storage.Storage as its underlying storage layer.
func OpenLevelDb(
stor storage.Storage, sizeGetter DbWriteBufferSizeGetter) (
*LevelDb, error) {
options := LeveldbOptions(sizeGetter)
options.Filter = filter.NewBloomFilter(16)
return OpenLevelDbWithOptions(stor, options)
}
func versionPathFromVersion(dirPath string, version uint64) string {
return filepath.Join(dirPath, fmt.Sprintf("v%d", version))
}
// GetVersionedPathForDb returns a path for the db that includes a
// version number.
func GetVersionedPathForDb(
log logger.Logger, dirPath string, dbName string,
currentDbVersion uint64) (versionedDirPath string, err error) {
// Read the version file
versionFilepath := filepath.Join(dirPath, diskCacheVersionFilename)
versionBytes, err := ioutil.ReadFile(versionFilepath)
// We expect the file to open successfully or not exist. Anything else is a
// problem.
version := currentDbVersion
switch {
case ioutil.IsNotExist(err):
// Do nothing, meaning that we will create the version file below.
log.CDebugf(
context.TODO(), "Creating new version file for the %s DB.",
dbName)
case err != nil:
log.CDebugf(
context.TODO(),
"An error occurred while reading the %s DB "+
"version file. Using %d as the version and creating a new "+
"file to record it.", dbName, version)
// TODO: when we increase the version of the DB, we'll have to
// make sure we wipe all previous versions of the DB.
default:
// We expect a successfully opened version file to parse a
// single unsigned integer representing the version. Anything
// else is a corrupted version file. However, this we can
// solve by deleting everything in the cache. TODO:
// Eventually delete the whole DB if we have an out of date
// version.
version, err = strconv.ParseUint(string(versionBytes), 10,
strconv.IntSize)
if err == nil && version == currentDbVersion {
// Success case, no need to write the version file again.
log.CDebugf(
context.TODO(),
"Loaded the %s DB version file successfully."+
" Version: %d", dbName, version)
return versionPathFromVersion(dirPath, version), nil
}
switch {
case err != nil:
log.CDebugf(
context.TODO(),
"An error occurred while parsing the %s DB "+
"version file. Using %d as the version.",
dbName, currentDbVersion)
// TODO: when we increase the version of the DB, we'll have
// to make sure we wipe all previous versions of the DB.
version = currentDbVersion
case version < currentDbVersion:
log.CDebugf(
context.TODO(),
"The %s DB version file contained an old "+
"version: %d. Updating to the new version: %d.",
dbName, version, currentDbVersion)
// TODO: when we increase the version of the DB, we'll have
// to make sure we wipe all previous versions of the DB.
version = currentDbVersion
case version > currentDbVersion:
log.CDebugf(
context.TODO(),
"The %s DB version file contained a newer "+
"version (%d) than this client knows how to read. "+
"Switching to this client's newest known version: %d.",
dbName, version, currentDbVersion)
version = currentDbVersion
}
}
// Ensure the DB directory exists.
err = os.MkdirAll(dirPath, 0700)
if err != nil {
// This does actually need to be fatal.
return "", err
}
versionString := strconv.FormatUint(version, 10)
err = ioutil.WriteFile(versionFilepath, []byte(versionString), 0600)
if err != nil {
// This also needs to be fatal.
return "", err
}
return versionPathFromVersion(dirPath, version), nil
}
// OpenVersionedLevelDb opens a level DB under a versioned path on the
// local filesystem under storageRoot. The path include dbFolderName
// and dbFilename. Note that dbFilename is actually created as a
// folder; it's just where raw LevelDb lives.
func OpenVersionedLevelDb(
log logger.Logger, storageRoot string, dbFolderName string,
currentDbVersion uint64, dbFilename string,
sizeGetter DbWriteBufferSizeGetter) (db *LevelDb, err error) {
dbPath := filepath.Join(storageRoot, dbFolderName)
versionPath, err := GetVersionedPathForDb(
log, dbPath, dbFolderName, currentDbVersion)
if err != nil {
return nil, err
}
p := filepath.Join(versionPath, dbFilename)
log.Debug("opening LevelDB: %s", p)
storage, err := storage.OpenFile(p, false)
if err != nil {
return nil, err
}
defer func() {
if err != nil {
storage.Close()
}
}()
options := LeveldbOptions(sizeGetter)
if db, err = OpenLevelDbWithOptions(storage, options); err != nil {
return nil, err
}
return db, nil
}