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
|
/*
* Copyright (c) 2021. Ant Financial. All rights reserved.
* Copyright (c) 2022. Nydus Developers. All rights reserved.
*
* SPDX-License-Identifier: Apache-2.0
*/
package store
import (
"context"
"encoding/json"
"os"
"path/filepath"
"time"
"github.com/containerd/containerd/log"
"github.com/containerd/nydus-snapshotter/pkg/daemon"
"github.com/containerd/nydus-snapshotter/pkg/errdefs"
"github.com/containerd/nydus-snapshotter/pkg/rafs"
"github.com/pkg/errors"
bolt "go.etcd.io/bbolt"
)
const (
databaseFileName = "nydus.db"
)
// Bucket names:
// Buckets hierarchy:
// - v1:
// - daemons
// - instances
var (
v1RootBucket = []byte("v1")
// Nydusd daemon instances.
// A daemon may host one (dedicated mode) or more (shared mode) RAFS filesystem instances.
versionKey = []byte("version")
daemonsBucket = []byte("daemons")
// RAFS filesystem instances.
// A RAFS filesystem may have associated daemon or not.
instancesBucket = []byte("instances")
)
// Database keeps infos that need to survive among snapshotter restart
type Database struct {
db *bolt.DB
}
// NewDatabase creates a new or open existing database file
func NewDatabase(rootDir string) (*Database, error) {
f := filepath.Join(rootDir, databaseFileName)
if err := ensureDirectory(filepath.Dir(f)); err != nil {
return nil, err
}
opts := bolt.Options{Timeout: time.Second * 4}
db, err := bolt.Open(f, 0600, &opts)
if err != nil {
return nil, err
}
d := &Database{db: db}
if err := d.initDatabase(); err != nil {
return nil, errors.Wrap(err, "failed to initialize database")
}
return d, nil
}
func ensureDirectory(dir string) error {
if _, err := os.Stat(dir); os.IsNotExist(err) {
return os.MkdirAll(dir, 0700)
}
return nil
}
func getDaemonsBucket(tx *bolt.Tx) *bolt.Bucket {
bucket := tx.Bucket(v1RootBucket)
return bucket.Bucket(daemonsBucket)
}
func getInstancesBucket(tx *bolt.Tx) *bolt.Bucket {
bucket := tx.Bucket(v1RootBucket)
return bucket.Bucket(instancesBucket)
}
func updateObject(bucket *bolt.Bucket, key string, obj interface{}) error {
keyBytes := []byte(key)
value, err := json.Marshal(obj)
if err != nil {
return errors.Wrapf(err, "marshall key %s", key)
}
if err := bucket.Put(keyBytes, value); err != nil {
return errors.Wrapf(err, "put key %s", key)
}
return nil
}
func putObject(bucket *bolt.Bucket, key string, obj interface{}) error {
keyBytes := []byte(key)
if bucket.Get(keyBytes) != nil {
return errors.Errorf("object with key %q already exists", key)
}
value, err := json.Marshal(obj)
if err != nil {
return errors.Wrapf(err, "marshall %s", key)
}
if err := bucket.Put(keyBytes, value); err != nil {
return errors.Wrapf(err, "put key %s", key)
}
return nil
}
// A basic wrapper to retrieve a object from bucket.
func getObject(bucket *bolt.Bucket, key string, obj interface{}) error {
if obj == nil {
return errdefs.ErrInvalidArgument
}
value := bucket.Get([]byte(key))
if value == nil {
return errdefs.ErrNotFound
}
if err := json.Unmarshal(value, obj); err != nil {
return errors.Wrapf(err, "unmarshall %s", key)
}
return nil
}
func (db *Database) initDatabase() error {
var notV1 = false
var version string
err := db.db.Update(func(tx *bolt.Tx) error {
bk := tx.Bucket(v1RootBucket)
if bk == nil {
notV1 = true
}
// Must create v1 bucket
bk, err := tx.CreateBucketIfNotExists(v1RootBucket)
if err != nil {
return err
}
if _, err := bk.CreateBucketIfNotExists(daemonsBucket); err != nil {
return errors.Wrapf(err, "bucket %s", daemonsBucket)
}
if _, err := bk.CreateBucketIfNotExists(instancesBucket); err != nil {
return errors.Wrapf(err, "bucket %s", instancesBucket)
}
if val := bk.Get(versionKey); val == nil {
version = "v1.0"
} else {
version = string(val)
}
return nil
})
if err != nil {
return err
}
if notV1 {
if err := db.tryTranslateRecords(); err != nil && !errors.Is(err, errdefs.ErrNotFound) {
return errors.Wrapf(err, "convert old database")
}
}
if version == "v1.0" {
if err := db.tryUpgradeRecords(version); err != nil && !errors.Is(err, errdefs.ErrNotFound) {
return errors.Wrapf(err, "convert old database")
}
}
return nil
}
func (db *Database) Close() error {
err := db.db.Close()
if err != nil {
return errors.Wrapf(err, "failed to close boltdb")
}
return nil
}
func (db *Database) SaveDaemon(ctx context.Context, d *daemon.Daemon) error {
return db.db.Update(func(tx *bolt.Tx) error {
bucket := getDaemonsBucket(tx)
var existing daemon.ConfigState
if err := getObject(bucket, d.ID(), &existing); err == nil {
return errdefs.ErrAlreadyExists
}
return putObject(bucket, d.ID(), d.States)
})
}
func (db *Database) UpdateDaemon(ctx context.Context, d *daemon.Daemon) error {
return db.db.Update(func(tx *bolt.Tx) error {
bucket := getDaemonsBucket(tx)
var existing daemon.ConfigState
if err := getObject(bucket, d.ID(), &existing); err != nil {
return err
}
return updateObject(bucket, d.ID(), d.States)
})
}
func (db *Database) DeleteDaemon(ctx context.Context, id string) error {
return db.db.Update(func(tx *bolt.Tx) error {
bucket := getDaemonsBucket(tx)
if err := bucket.Delete([]byte(id)); err != nil {
return errors.Wrapf(err, "delete daemon %s", id)
}
return nil
})
}
// Cleanup deletes all daemon records
func (db *Database) CleanupDaemons(ctx context.Context) error {
return db.db.Update(func(tx *bolt.Tx) error {
bucket := getDaemonsBucket(tx)
return bucket.ForEach(func(k, _ []byte) error {
return bucket.Delete(k)
})
})
}
func (db *Database) WalkDaemons(ctx context.Context, cb func(info *daemon.ConfigState) error) error {
return db.db.View(func(tx *bolt.Tx) error {
bucket := getDaemonsBucket(tx)
return bucket.ForEach(func(key, value []byte) error {
states := &daemon.ConfigState{}
if err := json.Unmarshal(value, states); err != nil {
return errors.Wrapf(err, "unmarshal %s", key)
}
return cb(states)
})
})
}
// WalkDaemons iterates all daemon records and invoke callback on each
func (db *Database) WalkRafsInstances(ctx context.Context, cb func(r *rafs.Rafs) error) error {
return db.db.View(func(tx *bolt.Tx) error {
bucket := getInstancesBucket(tx)
return bucket.ForEach(func(key, value []byte) error {
instance := &rafs.Rafs{}
if err := json.Unmarshal(value, instance); err != nil {
return errors.Wrapf(err, "unmarshal %s", key)
}
return cb(instance)
})
})
}
func (db *Database) AddRafsInstance(ctx context.Context, instance *rafs.Rafs) error {
return db.db.Update(func(tx *bolt.Tx) error {
bucket := getInstancesBucket(tx)
return putObject(bucket, instance.SnapshotID, instance)
})
}
func (db *Database) DeleteRafsInstance(ctx context.Context, snapshotID string) error {
return db.db.Update(func(tx *bolt.Tx) error {
bucket := getInstancesBucket(tx)
if err := bucket.Delete([]byte(snapshotID)); err != nil {
return errors.Wrapf(err, "instance snapshot ID %s", snapshotID)
}
return nil
})
}
func (db *Database) NextInstanceSeq() (uint64, error) {
tx, err := db.db.Begin(true)
if err != nil {
return 0, errors.New("failed to start transaction")
}
defer func() {
if err != nil {
if err := tx.Rollback(); err != nil {
log.L.WithError(err).Errorf("Rollback error when getting next sequence")
}
}
}()
bk := getInstancesBucket(tx)
if bk == nil {
return 0, errdefs.ErrNotFound
}
seq, err := bk.NextSequence()
if err != nil {
return 0, err
}
if err := tx.Commit(); err != nil {
return 0, err
}
return seq, nil
}
|