-
Notifications
You must be signed in to change notification settings - Fork 0
/
database.go
126 lines (108 loc) · 3.71 KB
/
database.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
package consensus
// database.go contains functions to initialize the database and report
// inconsistencies. All of the database-specific logic belongs here.
import (
"errors"
"fmt"
"os"
"SiaPrime/build"
"SiaPrime/encoding"
"SiaPrime/persist"
"gitlab.com/NebulousLabs/bolt"
)
var (
dbMetadata = persist.Metadata{
Header: "Consensus Set Database",
Version: "0.5.0",
}
errDBInconsistent = errors.New("database guard indicates inconsistency within database")
errNilBucket = errors.New("using a bucket that does not exist")
errNilItem = errors.New("requested item does not exist")
errNonEmptyBucket = errors.New("cannot remove a map with objects still in it")
errRepeatInsert = errors.New("attempting to add an already existing item to the consensus set")
)
type (
// dbBucket represents a collection of key/value pairs inside the database.
dbBucket interface {
Get(key []byte) []byte
}
// dbTx represents a read-only transaction on the database that can be used
// for retrieving values.
dbTx interface {
Bucket(name []byte) dbBucket
}
// boltTxWrapper wraps a bolt.Tx so that it matches the dbTx interface. The
// wrap is necessary because bolt.Tx.Bucket() returns a fixed type
// (bolt.Bucket), but we want it to return an interface (dbBucket).
boltTxWrapper struct {
tx *bolt.Tx
}
)
// Bucket returns the dbBucket associated with the given bucket name.
func (b boltTxWrapper) Bucket(name []byte) dbBucket {
return b.tx.Bucket(name)
}
// replaceDatabase backs up the existing database and creates a new one.
func (cs *ConsensusSet) replaceDatabase(filename string) error {
// Rename the existing database and create a new one.
fmt.Println("Outdated consensus database... backing up and replacing")
err := os.Rename(filename, filename+".bck")
if err != nil {
return errors.New("error while backing up consensus database: " + err.Error())
}
// Try again to create a new database, this time without checking for an
// outdated database error.
cs.db, err = persist.OpenDatabase(dbMetadata, filename)
if err != nil {
return errors.New("error opening consensus database: " + err.Error())
}
return nil
}
// openDB loads the set database and populates it with the necessary buckets
func (cs *ConsensusSet) openDB(filename string) (err error) {
cs.db, err = persist.OpenDatabase(dbMetadata, filename)
if err == persist.ErrBadVersion {
return cs.replaceDatabase(filename)
}
if err != nil {
return errors.New("error opening consensus database: " + err.Error())
}
return nil
}
// initDB is run if there is no existing consensus database, creating a
// database with all the required buckets and sane initial values.
func (cs *ConsensusSet) initDB(tx *bolt.Tx) error {
// If the database has already been initialized, there is nothing to do.
// Initialization can be detected by looking for the presence of the siafund
// pool bucket. (legacy design chioce - ultimately probably not the best way
// ot tell).
if tx.Bucket(SiafundPool) != nil {
return nil
}
// Create the compononents of the database.
err := cs.createConsensusDB(tx)
if err != nil {
return err
}
err = cs.createChangeLog(tx)
if err != nil {
return err
}
// Place a 'false' in the consistency bucket to indicate that no
// inconsistencies have been found.
err = tx.Bucket(Consistency).Put(Consistency, encoding.Marshal(false))
if err != nil {
return err
}
return nil
}
// markInconsistency flags the database to indicate that inconsistency has been
// detected.
func markInconsistency(tx *bolt.Tx) {
// Place a 'true' in the consistency bucket to indicate that
// inconsistencies have been found.
err := tx.Bucket(Consistency).Put(Consistency, encoding.Marshal(true))
if build.DEBUG && err != nil {
panic(err)
}
}