-
Notifications
You must be signed in to change notification settings - Fork 258
/
dataStore_bolt.go
492 lines (417 loc) · 11.8 KB
/
dataStore_bolt.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
//go:build !PSIPHON_USE_BADGER_DB && !PSIPHON_USE_FILES_DB
// +build !PSIPHON_USE_BADGER_DB,!PSIPHON_USE_FILES_DB
/*
* Copyright (c) 2018, Psiphon Inc.
* All rights reserved.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
package psiphon
import (
std_errors "errors"
"os"
"path/filepath"
"runtime/debug"
"sync/atomic"
"time"
"github.com/Psiphon-Labs/bolt"
"github.com/Psiphon-Labs/psiphon-tunnel-core/psiphon/common/errors"
)
const (
OPEN_DB_RETRIES = 2
)
type datastoreDB struct {
boltDB *bolt.DB
isFailed int32
}
type datastoreTx struct {
db *datastoreDB
boltTx *bolt.Tx
}
type datastoreBucket struct {
db *datastoreDB
boltBucket *bolt.Bucket
}
type datastoreCursor struct {
db *datastoreDB
boltCursor *bolt.Cursor
}
func datastoreOpenDB(
rootDataDirectory string, retryAndReset bool) (*datastoreDB, error) {
var db *datastoreDB
var err error
attempts := 1
if retryAndReset {
attempts += OPEN_DB_RETRIES
}
reset := false
for attempt := 0; attempt < attempts; attempt++ {
db, err = tryDatastoreOpenDB(rootDataDirectory, reset)
if err == nil {
break
}
NoticeWarning("tryDatastoreOpenDB failed: %s", err)
// The datastore file may be corrupt, so, in subsequent iterations,
// set the "reset" flag and attempt to delete the file and try again.
//
// Don't reset the datastore when open failed due to timeout obtaining
// the file lock, as the datastore is simply locked by another
// process and not corrupt. As the file lock is advisory, deleting
// the file would succeed despite the lock. In this case, still retry
// in case the the lock is released.
reset = !std_errors.Is(err, bolt.ErrTimeout)
}
return db, err
}
func tryDatastoreOpenDB(
rootDataDirectory string, reset bool) (retdb *datastoreDB, reterr error) {
// Testing indicates that the bolt Check function can raise SIGSEGV due to
// invalid mmap buffer accesses in cases such as opening a valid but
// truncated datastore file.
//
// To handle this, we temporarily set SetPanicOnFault in order to treat the
// fault as a panic, recover any panic, and return an error which will result
// in a retry with reset.
// Begin recovery preamble
panicOnFault := debug.SetPanicOnFault(true)
defer debug.SetPanicOnFault(panicOnFault)
defer func() {
if r := recover(); r != nil {
retdb = nil
reterr = errors.Tracef("panic: %v", r)
}
}()
// End recovery preamble
filename := filepath.Join(rootDataDirectory, "psiphon.boltdb")
if reset {
NoticeWarning("tryDatastoreOpenDB: reset")
os.Remove(filename)
}
newDB, err := bolt.Open(filename, 0600, &bolt.Options{Timeout: 1 * time.Second})
if err != nil {
return nil, errors.Trace(err)
}
// Run consistency checks on datastore and emit errors for diagnostics
// purposes. We assume this will complete quickly for typical size Psiphon
// datastores and wait for the check to complete before proceeding.
err = newDB.View(func(tx *bolt.Tx) error {
return tx.SynchronousCheck()
})
if err != nil {
return nil, errors.Trace(err)
}
err = newDB.Update(func(tx *bolt.Tx) error {
requiredBuckets := [][]byte{
datastoreServerEntriesBucket,
datastoreServerEntryTagsBucket,
datastoreServerEntryTombstoneTagsBucket,
datastoreUrlETagsBucket,
datastoreKeyValueBucket,
datastoreRemoteServerListStatsBucket,
datastoreFailedTunnelStatsBucket,
datastoreSLOKsBucket,
datastoreTacticsBucket,
datastoreSpeedTestSamplesBucket,
datastoreDialParametersBucket,
}
for _, bucket := range requiredBuckets {
_, err := tx.CreateBucketIfNotExists(bucket)
if err != nil {
return err
}
}
return nil
})
if err != nil {
return nil, errors.Trace(err)
}
// Cleanup obsolete buckets
err = newDB.Update(func(tx *bolt.Tx) error {
obsoleteBuckets := [][]byte{
[]byte("tunnelStats"),
[]byte("rankedServerEntries"),
[]byte("splitTunnelRouteETags"),
[]byte("splitTunnelRouteData"),
}
for _, obsoleteBucket := range obsoleteBuckets {
if tx.Bucket(obsoleteBucket) != nil {
err := tx.DeleteBucket(obsoleteBucket)
if err != nil {
NoticeWarning("DeleteBucket %s error: %s", obsoleteBucket, err)
// Continue, since this is not fatal
}
}
}
return nil
})
if err != nil {
return nil, errors.Trace(err)
}
return &datastoreDB{boltDB: newDB}, nil
}
var errDatastoreFailed = std_errors.New("datastore has failed")
func (db *datastoreDB) isDatastoreFailed() bool {
return atomic.LoadInt32(&db.isFailed) == 1
}
func (db *datastoreDB) setDatastoreFailed(r interface{}) {
atomic.StoreInt32(&db.isFailed, 1)
NoticeWarning("Datastore failed: %s", errors.Tracef("panic: %v", r))
}
func (db *datastoreDB) close() error {
// Limitation: there is no panic recover in this case. We assume boltDB.Close
// does not make mmap accesses and prefer to not continue with the datastore
// file in a locked or open state. We also assume that any locks aquired by
// boltDB.Close, held by transactions, will be released even if the
// transaction panics and the database is in the failed state.
return db.boltDB.Close()
}
func (db *datastoreDB) view(fn func(tx *datastoreTx) error) (reterr error) {
// Any bolt function that performs mmap buffer accesses can raise SIGBUS due
// to underlying storage changes, such as a truncation of the datastore file
// or removal or network attached storage, etc.
//
// To handle this, we temporarily set SetPanicOnFault in order to treat the
// fault as a panic, recover any panic to avoid crashing the process, and
// putting this datastoreDB instance into a failed state. All subsequent
// calls to this datastoreDBinstance or its related datastoreTx and
// datastoreBucket instances will fail.
// Begin recovery preamble
if db.isDatastoreFailed() {
return errDatastoreFailed
}
panicOnFault := debug.SetPanicOnFault(true)
defer debug.SetPanicOnFault(panicOnFault)
defer func() {
if r := recover(); r != nil {
db.setDatastoreFailed(r)
reterr = errDatastoreFailed
}
}()
// End recovery preamble
return db.boltDB.View(
func(tx *bolt.Tx) error {
err := fn(&datastoreTx{db: db, boltTx: tx})
if err != nil {
return errors.Trace(err)
}
return nil
})
}
func (db *datastoreDB) update(fn func(tx *datastoreTx) error) (reterr error) {
// Begin recovery preamble
if db.isDatastoreFailed() {
return errDatastoreFailed
}
panicOnFault := debug.SetPanicOnFault(true)
defer debug.SetPanicOnFault(panicOnFault)
defer func() {
if r := recover(); r != nil {
db.setDatastoreFailed(r)
reterr = errDatastoreFailed
}
}()
// End recovery preamble
return db.boltDB.Update(
func(tx *bolt.Tx) error {
err := fn(&datastoreTx{db: db, boltTx: tx})
if err != nil {
return errors.Trace(err)
}
return nil
})
}
func (tx *datastoreTx) bucket(name []byte) (retbucket *datastoreBucket) {
// Begin recovery preamble
if tx.db.isDatastoreFailed() {
return &datastoreBucket{db: tx.db, boltBucket: nil}
}
panicOnFault := debug.SetPanicOnFault(true)
defer debug.SetPanicOnFault(panicOnFault)
defer func() {
if r := recover(); r != nil {
tx.db.setDatastoreFailed(r)
retbucket = &datastoreBucket{db: tx.db, boltBucket: nil}
}
}()
// End recovery preamble
return &datastoreBucket{db: tx.db, boltBucket: tx.boltTx.Bucket(name)}
}
func (tx *datastoreTx) clearBucket(name []byte) (reterr error) {
// Begin recovery preamble
if tx.db.isDatastoreFailed() {
return errDatastoreFailed
}
panicOnFault := debug.SetPanicOnFault(true)
defer debug.SetPanicOnFault(panicOnFault)
defer func() {
if r := recover(); r != nil {
tx.db.setDatastoreFailed(r)
reterr = errDatastoreFailed
}
}()
// End recovery preamble
err := tx.boltTx.DeleteBucket(name)
if err != nil {
return errors.Trace(err)
}
_, err = tx.boltTx.CreateBucket(name)
if err != nil {
return errors.Trace(err)
}
return nil
}
func (b *datastoreBucket) get(key []byte) (retvalue []byte) {
// Begin recovery preamble
if b.db.isDatastoreFailed() {
return nil
}
panicOnFault := debug.SetPanicOnFault(true)
defer debug.SetPanicOnFault(panicOnFault)
defer func() {
if r := recover(); r != nil {
b.db.setDatastoreFailed(r)
retvalue = nil
}
}()
// End recovery preamble
return b.boltBucket.Get(key)
}
func (b *datastoreBucket) put(key, value []byte) (reterr error) {
// Begin recovery preamble
if b.db.isDatastoreFailed() {
return errDatastoreFailed
}
panicOnFault := debug.SetPanicOnFault(true)
defer debug.SetPanicOnFault(panicOnFault)
defer func() {
if r := recover(); r != nil {
b.db.setDatastoreFailed(r)
reterr = errDatastoreFailed
}
}()
// End recovery preamble
err := b.boltBucket.Put(key, value)
if err != nil {
return errors.Trace(err)
}
return nil
}
func (b *datastoreBucket) delete(key []byte) (reterr error) {
// Begin recovery preamble
if b.db.isDatastoreFailed() {
return errDatastoreFailed
}
panicOnFault := debug.SetPanicOnFault(true)
defer debug.SetPanicOnFault(panicOnFault)
defer func() {
if r := recover(); r != nil {
b.db.setDatastoreFailed(r)
reterr = errDatastoreFailed
}
}()
// End recovery preamble
err := b.boltBucket.Delete(key)
if err != nil {
return errors.Trace(err)
}
return nil
}
func (b *datastoreBucket) cursor() (retcursor datastoreCursor) {
// Begin recovery preamble
if b.db.isDatastoreFailed() {
return datastoreCursor{db: b.db, boltCursor: nil}
}
panicOnFault := debug.SetPanicOnFault(true)
defer debug.SetPanicOnFault(panicOnFault)
defer func() {
if r := recover(); r != nil {
b.db.setDatastoreFailed(r)
retcursor = datastoreCursor{db: b.db, boltCursor: nil}
}
}()
// End recovery preamble
return datastoreCursor{db: b.db, boltCursor: b.boltBucket.Cursor()}
}
func (c *datastoreCursor) firstKey() (retkey []byte) {
// Begin recovery preamble
if c.db.isDatastoreFailed() {
return nil
}
panicOnFault := debug.SetPanicOnFault(true)
defer debug.SetPanicOnFault(panicOnFault)
defer func() {
if r := recover(); r != nil {
c.db.setDatastoreFailed(r)
retkey = nil
}
}()
// End recovery preamble
key, _ := c.boltCursor.First()
return key
}
func (c *datastoreCursor) nextKey() (retkey []byte) {
// Begin recovery preamble
if c.db.isDatastoreFailed() {
return nil
}
panicOnFault := debug.SetPanicOnFault(true)
defer debug.SetPanicOnFault(panicOnFault)
defer func() {
if r := recover(); r != nil {
c.db.setDatastoreFailed(r)
retkey = nil
}
}()
// End recovery preamble
key, _ := c.boltCursor.Next()
return key
}
func (c *datastoreCursor) first() (retkey, retvalue []byte) {
// Begin recovery preamble
if c.db.isDatastoreFailed() {
return nil, nil
}
panicOnFault := debug.SetPanicOnFault(true)
defer debug.SetPanicOnFault(panicOnFault)
defer func() {
if r := recover(); r != nil {
c.db.setDatastoreFailed(r)
retkey = nil
retvalue = nil
}
}()
// End recovery preamble
return c.boltCursor.First()
}
func (c *datastoreCursor) next() (retkey, retvalue []byte) {
// Begin recovery preamble
if c.db.isDatastoreFailed() {
return nil, nil
}
panicOnFault := debug.SetPanicOnFault(true)
defer debug.SetPanicOnFault(panicOnFault)
defer func() {
if r := recover(); r != nil {
c.db.setDatastoreFailed(r)
retkey = nil
retvalue = nil
}
}()
// End recovery preamble
return c.boltCursor.Next()
}
func (c *datastoreCursor) close() {
// BoltDB doesn't close cursors.
}