582b164c46
* mod: bump btcwallet version to accept db timeout * btcwallet: add DBTimeOut in config * kvdb: add database timeout option for bbolt This commit adds a DBTimeout option in bbolt config. The relevant functions walletdb.Open/Create are updated to use this config. In addition, the bolt compacter also applies the new timeout option. * channeldb: add DBTimeout in db options This commit adds the DBTimeout option for channeldb. A new unit test file is created to test the default options. In addition, the params used in kvdb.Create inside channeldb_test is updated with a DefaultDBTimeout value. * contractcourt+routing: use DBTimeout in kvdb This commit touches multiple test files in contractcourt and routing. The call of function kvdb.Create and kvdb.Open are now updated with the new param DBTimeout, using the default value kvdb.DefaultDBTimeout. * lncfg: add DBTimeout option in db config The DBTimeout option is added to db config. A new unit test is added to check the default DB config is created as expected. * migration: add DBTimeout param in kvdb.Create/kvdb.Open * keychain: update tests to use DBTimeout param * htlcswitch+chainreg: add DBTimeout option * macaroons: support DBTimeout config in creation This commit adds the DBTimeout during the creation of macaroons.db. The usage of kvdb.Create and kvdb.Open in its tests are updated with a timeout value using kvdb.DefaultDBTimeout. * walletunlocker: add dbTimeout option in UnlockerService This commit adds a new param, dbTimeout, during the creation of UnlockerService. This param is then passed to wallet.NewLoader inside various service calls, specifying a timeout value to be used when opening the bbolt. In addition, the macaroonService is also called with this dbTimeout param. * watchtower/wtdb: add dbTimeout param during creation This commit adds the dbTimeout param for the creation of both watchtower.db and wtclient.db. * multi: add db timeout param for walletdb.Create This commit adds the db timeout param for the function call walletdb.Create. It touches only the test files found in chainntnfs, lnwallet, and routing. * lnd: pass DBTimeout config to relevant services This commit enables lnd to pass the DBTimeout config to the following services/config/functions, - chainControlConfig - walletunlocker - wallet.NewLoader - macaroons - watchtower In addition, the usage of wallet.Create is updated too. * sample-config: add dbtimeout option
102 lines
2.7 KiB
Go
102 lines
2.7 KiB
Go
package wtdb
|
|
|
|
import (
|
|
"encoding/binary"
|
|
"errors"
|
|
"os"
|
|
"path/filepath"
|
|
"time"
|
|
|
|
"github.com/lightningnetwork/lnd/channeldb/kvdb"
|
|
)
|
|
|
|
const (
|
|
// dbFilePermission requests read+write access to the db file.
|
|
dbFilePermission = 0600
|
|
)
|
|
|
|
var (
|
|
// metadataBkt stores all the meta information concerning the state of
|
|
// the database.
|
|
metadataBkt = []byte("metadata-bucket")
|
|
|
|
// dbVersionKey is a static key used to retrieve the database version
|
|
// number from the metadataBkt.
|
|
dbVersionKey = []byte("version")
|
|
|
|
// ErrUninitializedDB signals that top-level buckets for the database
|
|
// have not been initialized.
|
|
ErrUninitializedDB = errors.New("db not initialized")
|
|
|
|
// ErrNoDBVersion signals that the database contains no version info.
|
|
ErrNoDBVersion = errors.New("db has no version")
|
|
|
|
// byteOrder is the default endianness used when serializing integers.
|
|
byteOrder = binary.BigEndian
|
|
)
|
|
|
|
// fileExists returns true if the file exists, and false otherwise.
|
|
func fileExists(path string) bool {
|
|
if _, err := os.Stat(path); err != nil {
|
|
if os.IsNotExist(err) {
|
|
return false
|
|
}
|
|
}
|
|
|
|
return true
|
|
}
|
|
|
|
// createDBIfNotExist opens the boltdb database at dbPath/name, creating one if
|
|
// one doesn't exist. The boolean returned indicates if the database did not
|
|
// exist before, or if it has been created but no version metadata exists within
|
|
// it.
|
|
func createDBIfNotExist(dbPath, name string,
|
|
dbTimeout time.Duration) (kvdb.Backend, bool, error) {
|
|
|
|
path := filepath.Join(dbPath, name)
|
|
|
|
// If the database file doesn't exist, this indicates we much initialize
|
|
// a fresh database with the latest version.
|
|
firstInit := !fileExists(path)
|
|
if firstInit {
|
|
// Ensure all parent directories are initialized.
|
|
err := os.MkdirAll(dbPath, 0700)
|
|
if err != nil {
|
|
return nil, false, err
|
|
}
|
|
}
|
|
|
|
// Specify bbolt freelist options to reduce heap pressure in case the
|
|
// freelist grows to be very large.
|
|
bdb, err := kvdb.Create(
|
|
kvdb.BoltBackendName, path, true, dbTimeout,
|
|
)
|
|
if err != nil {
|
|
return nil, false, err
|
|
}
|
|
|
|
// If the file existed previously, we'll now check to see that the
|
|
// metadata bucket is properly initialized. It could be the case that
|
|
// the database was created, but we failed to actually populate any
|
|
// metadata. If the metadata bucket does not actually exist, we'll
|
|
// set firstInit to true so that we can treat is initialize the bucket.
|
|
if !firstInit {
|
|
var metadataExists bool
|
|
err = kvdb.View(bdb, func(tx kvdb.RTx) error {
|
|
metadataExists = tx.ReadBucket(metadataBkt) != nil
|
|
return nil
|
|
}, func() {
|
|
metadataExists = false
|
|
})
|
|
if err != nil {
|
|
return nil, false, err
|
|
}
|
|
|
|
if !metadataExists {
|
|
firstInit = true
|
|
}
|
|
}
|
|
|
|
return bdb, firstInit, nil
|
|
}
|