ziti/controller/db/db.go

/*
	Copyright NetFoundry, Inc.

	Licensed under the Apache License, Version 2.0 (the "License");
	you may not use this file except in compliance with the License.
	You may obtain a copy of the License at

	https://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing, software
	distributed under the License is distributed on an "AS IS" BASIS,
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	See the License for the specific language governing permissions and
	limitations under the License.
*/

package db

import (
	"errors"
	"fmt"
	"github.com/michaelquigley/pfxlog"
	"github.com/sirupsen/logrus"
	"go.etcd.io/bbolt"
	"os"
	"reflect"
	"runtime"
	"time"
)

type Db struct {
	db *bbolt.DB
}

func Open(path string, trace bool) (*Db, error) {
	// Only wait 1 second if database file can't be locked, as it most likely means another controller is running
	options := *bbolt.DefaultOptions
	options.Timeout = time.Second

	db, err := bbolt.Open(path, 0600, &options)
	if err != nil {
		return nil, fmt.Errorf("unable to open controller database [%s] (%s)", path, err)
	}

	if trace {
		db.TraceUpdateEnter = traceUpdateEnter
		db.TraceUpdateExit = traceUpdateExit
		db.TraceViewEnter = traceViewEnter
		db.TraceViewExit = traceViewExit
		db.TraceBatchEnter = traceBatchEnter
		db.TraceBatchExit = traceBatchExit
	}

	if err := db.Update(createRoots); err != nil {
		return nil, err
	}
	return &Db{db: db}, nil
}

func (db *Db) Close() error {
	return db.db.Close()
}

func (db *Db) Update(fn func(tx *bbolt.Tx) error) error {
	return db.db.Update(fn)
}

func (db *Db) Batch(fn func(tx *bbolt.Tx) error) error {
	return db.db.Batch(fn)
}

func (db *Db) View(fn func(tx *bbolt.Tx) error) error {
	return db.db.View(fn)
}

func (db *Db) Stats() bbolt.Stats {
	return db.db.Stats()
}

func (db *Db) RootBucket(tx *bbolt.Tx) (*bbolt.Bucket, error) {
	ziti := tx.Bucket([]byte("ziti"))
	if ziti == nil {
		return nil, errors.New("db missing 'ziti' root")
	}
	return ziti, nil
}

func (db *Db) Snapshot(tx *bbolt.Tx) error {
	path := db.db.Path()
	path += "-" + time.Now().Format("20060102-150405")

	_, err := os.Stat(path)
	if err != nil {
		if !os.IsNotExist(err) {
			return err
		}
	} else {
		pfxlog.Logger().Infof("bolt db backup already made: %v", path)
		return nil
	}

	file, err := os.OpenFile(path, os.O_WRONLY|os.O_CREATE, 0600)
	if err != nil {
		return err
	}
	defer func() {
		if err = file.Close(); err != nil {
			pfxlog.Logger().Errorf("failed to close backup database file %v (%v)", path, err)
		}
	}()

	_, err = tx.WriteTo(file)
	if err != nil {
		pfxlog.Logger().Infof("created bolt db backup: %v", path)
	}
	return err
}

func createRoots(tx *bbolt.Tx) error {
	if ziti, err := tx.CreateBucketIfNotExists([]byte("ziti")); err == nil {
		if _, err := ziti.CreateBucketIfNotExists([]byte("services")); err != nil {
			return err
		}
		if _, err := ziti.CreateBucketIfNotExists([]byte("routers")); err != nil {
			return err
		}
	}
	return nil
}

func traceUpdateEnter(tx *bbolt.Tx, fn func(tx *bbolt.Tx) error) {
	logrus.Infof("Enter Update (tx:%d) [%s]", tx.ID(), runtime.FuncForPC(reflect.ValueOf(fn).Pointer()).Name())
}

func traceUpdateExit(tx *bbolt.Tx, fn func(tx *bbolt.Tx) error) {
	logrus.Infof("Exit Update (tx:%d) [%s]", tx.ID(), runtime.FuncForPC(reflect.ValueOf(fn).Pointer()).Name())
}

func traceViewEnter(tx *bbolt.Tx, fn func(tx *bbolt.Tx) error) {
	logrus.Infof("Enter View (tx:%d) [%s]", tx.ID(), runtime.FuncForPC(reflect.ValueOf(fn).Pointer()).Name())
}

func traceViewExit(tx *bbolt.Tx, fn func(tx *bbolt.Tx) error) {
	logrus.Infof("Exit View (tx:%d) [%s]", tx.ID(), runtime.FuncForPC(reflect.ValueOf(fn).Pointer()).Name())
}

func traceBatchEnter(tx *bbolt.Tx, fn func(tx *bbolt.Tx) error) {
	logrus.Infof("Enter Batch (tx:%d) [%s]", tx.ID(), runtime.FuncForPC(reflect.ValueOf(fn).Pointer()).Name())
}

func traceBatchExit(tx *bbolt.Tx, fn func(tx *bbolt.Tx) error) {
	logrus.Infof("Exit Batch (tx:%d) [%s]", tx.ID(), runtime.FuncForPC(reflect.ValueOf(fn).Pointer()).Name())
}