Unexport some internal implemtnation details

:wq

@@ -1,374 +0,0 @@
-package bitcask
-
-import (
-	"fmt"
-	"hash/crc32"
-	"io"
-	"io/ioutil"
-	"os"
-	"path/filepath"
-	"strings"
-
-	"github.com/gofrs/flock"
-	"github.com/prologic/trie"
-)
-
-type Bitcask struct {
-	*flock.Flock
-
-	config    config
-	path      string
-	curr      *Datafile
-	keydir    *Keydir
-	datafiles []*Datafile
-	trie      *trie.Trie
-
-	maxDatafileSize int64
-}
-
-func (b *Bitcask) Close() error {
-	defer func() {
-		b.Flock.Unlock()
-		os.Remove(b.Flock.Path())
-	}()
-
-	for _, df := range b.datafiles {
-		df.Close()
-	}
-	return b.curr.Close()
-}
-
-func (b *Bitcask) Sync() error {
-	return b.curr.Sync()
-}
-
-func (b *Bitcask) Get(key string) ([]byte, error) {
-	var df *Datafile
-
-	item, ok := b.keydir.Get(key)
-	if !ok {
-		return nil, fmt.Errorf("error: key not found %s", key)
-	}
-
-	if item.FileID == b.curr.id {
-		df = b.curr
-	} else {
-		df = b.datafiles[item.FileID]
-	}
-
-	e, err := df.ReadAt(item.Offset)
-	if err != nil {
-		return nil, err
-	}
-
-	checksum := crc32.ChecksumIEEE(e.Value)
-	if checksum != e.Checksum {
-		return nil, fmt.Errorf("error: checksum falied %s %d != %d", key, e.Checksum, checksum)
-	}
-
-	return e.Value, nil
-}
-
-func (b *Bitcask) Put(key string, value []byte) error {
-	if len(key) > b.config.MaxKeySize {
-		return fmt.Errorf("error: key too large %d > %d", len(key), b.config.MaxKeySize)
-	}
-	if len(value) > b.config.MaxValueSize {
-		return fmt.Errorf("error: value too large %d > %d", len(value), b.config.MaxValueSize)
-	}
-
-	offset, err := b.put(key, value)
-	if err != nil {
-		return err
-	}
-
-	item := b.keydir.Add(key, b.curr.id, offset)
-	b.trie.Add(key, item)
-
-	return nil
-}
-
-func (b *Bitcask) Delete(key string) error {
-	_, err := b.put(key, []byte{})
-	if err != nil {
-		return err
-	}
-
-	b.keydir.Delete(key)
-	b.trie.Remove(key)
-
-	return nil
-}
-
-func (b *Bitcask) Scan(prefix string, f func(key string) error) error {
-	keys := b.trie.PrefixSearch(prefix)
-	for _, key := range keys {
-		if err := f(key); err != nil {
-			return err
-		}
-	}
-	return nil
-}
-
-func (b *Bitcask) Fold(f func(key string) error) error {
-	for key := range b.keydir.Keys() {
-		if err := f(key); err != nil {
-			return err
-		}
-	}
-	return nil
-}
-
-func (b *Bitcask) put(key string, value []byte) (int64, error) {
-	size, err := b.curr.Size()
-	if err != nil {
-		return -1, err
-	}
-
-	if size >= b.maxDatafileSize {
-		err := b.curr.Close()
-		if err != nil {
-			return -1, err
-		}
-
-		df, err := NewDatafile(b.path, b.curr.id, true)
-		if err != nil {
-			return -1, err
-		}
-
-		b.datafiles = append(b.datafiles, df)
-
-		id := b.curr.id + 1
-		curr, err := NewDatafile(b.path, id, false)
-		if err != nil {
-			return -1, err
-		}
-		b.curr = curr
-	}
-
-	e := NewEntry(key, value)
-	return b.curr.Write(e)
-}
-
-func (b *Bitcask) setMaxDatafileSize(size int64) error {
-	b.maxDatafileSize = size
-	return nil
-}
-
-func Merge(path string, force bool) error {
-	fns, err := getDatafiles(path)
-	if err != nil {
-		return err
-	}
-
-	ids, err := parseIds(fns)
-	if err != nil {
-		return err
-	}
-
-	// Do not merge if we only have 1 Datafile
-	if len(ids) <= 1 {
-		return nil
-	}
-
-	// Don't merge the Active Datafile (the last one)
-	fns = fns[:len(fns)-1]
-	ids = ids[:len(ids)-1]
-
-	temp, err := ioutil.TempDir("", "bitcask")
-	if err != nil {
-		return err
-	}
-
-	for i, fn := range fns {
-		// Don't merge Datafiles whose .hint files we've already generated
-		// (they are already merged); unless we set the force flag to true
-		// (forcing a re-merge).
-		if filepath.Ext(fn) == ".hint" && !force {
-			// Already merged
-			continue
-		}
-
-		id := ids[i]
-
-		keydir := NewKeydir()
-
-		df, err := NewDatafile(path, id, true)
-		if err != nil {
-			return err
-		}
-		defer df.Close()
-
-		for {
-			e, err := df.Read()
-			if err != nil {
-				if err == io.EOF {
-					break
-				}
-				return err
-			}
-
-			// Tombstone value  (deleted key)
-			if len(e.Value) == 0 {
-				keydir.Delete(e.Key)
-				continue
-			}
-
-			keydir.Add(e.Key, ids[i], e.Offset)
-		}
-
-		tempdf, err := NewDatafile(temp, id, false)
-		if err != nil {
-			return err
-		}
-		defer tempdf.Close()
-
-		for key := range keydir.Keys() {
-			item, _ := keydir.Get(key)
-			e, err := df.ReadAt(item.Offset)
-			if err != nil {
-				return err
-			}
-
-			_, err = tempdf.Write(e)
-			if err != nil {
-				return err
-			}
-		}
-
-		err = tempdf.Close()
-		if err != nil {
-			return err
-		}
-
-		err = df.Close()
-		if err != nil {
-			return err
-		}
-
-		err = os.Rename(tempdf.Name(), df.Name())
-		if err != nil {
-			return err
-		}
-
-		hint := strings.TrimSuffix(df.Name(), ".data") + ".hint"
-		err = keydir.Save(hint)
-		if err != nil {
-			return err
-		}
-	}
-
-	return nil
-}
-
-func Open(path string, options ...option) (*Bitcask, error) {
-	if err := os.MkdirAll(path, 0755); err != nil {
-		return nil, err
-	}
-
-	err := Merge(path, false)
-	if err != nil {
-		return nil, err
-	}
-
-	fns, err := getDatafiles(path)
-	if err != nil {
-		return nil, err
-	}
-
-	ids, err := parseIds(fns)
-	if err != nil {
-		return nil, err
-	}
-
-	var datafiles []*Datafile
-
-	keydir := NewKeydir()
-	trie := trie.New()
-
-	for i, fn := range fns {
-		df, err := NewDatafile(path, ids[i], true)
-		if err != nil {
-			return nil, err
-		}
-		datafiles = append(datafiles, df)
-
-		if filepath.Ext(fn) == ".hint" {
-			f, err := os.Open(filepath.Join(path, fn))
-			if err != nil {
-				return nil, err
-			}
-			defer f.Close()
-
-			hint, err := NewKeydirFromBytes(f)
-			if err != nil {
-				return nil, err
-			}
-
-			for key := range hint.Keys() {
-				item, _ := hint.Get(key)
-				_ = keydir.Add(key, item.FileID, item.Offset)
-				trie.Add(key, item)
-			}
-		} else {
-			for {
-				e, err := df.Read()
-				if err != nil {
-					if err == io.EOF {
-						break
-					}
-					return nil, err
-				}
-
-				// Tombstone value  (deleted key)
-				if len(e.Value) == 0 {
-					keydir.Delete(e.Key)
-					continue
-				}
-
-				item := keydir.Add(e.Key, ids[i], e.Offset)
-				trie.Add(e.Key, item)
-			}
-		}
-	}
-
-	var id int
-	if len(ids) > 0 {
-		id = ids[(len(ids) - 1)]
-	}
-
-	curr, err := NewDatafile(path, id, false)
-	if err != nil {
-		return nil, err
-	}
-
-	bitcask := &Bitcask{
-		Flock:     flock.New(filepath.Join(path, "lock")),
-		config:    NewDefaultConfig(),
-		path:      path,
-		curr:      curr,
-		keydir:    keydir,
-		datafiles: datafiles,
-		trie:      trie,
-
-		maxDatafileSize: DefaultMaxDatafileSize,
-	}
-
-	for _, opt := range options {
-		err = opt(bitcask.config)
-		if err != nil {
-			return nil, err
-		}
-	}
-
-	locked, err := bitcask.Flock.TryLock()
-	if err != nil {
-		return nil, err
-	}
-
-	if !locked {
-		return nil, fmt.Errorf("error: database locked %s", path)
-	}
-
-	return bitcask, nil
-}

Makefile

@@ -13,11 +13,11 @@ dev: build
 build: clean generate
 	@go build \
 		-tags "netgo static_build" -installsuffix netgo \
-		-ldflags "-w -X $(shell go list).Version=$(VERSION) -X $(shell go list).Commit=$(COMMIT)" \
+		-ldflags "-w -X $(shell go list)/internal.Version=$(VERSION) -X $(shell go list)/internal.Commit=$(COMMIT)" \
 		./cmd/bitcask/...
 	@go build \
 		-tags "netgo static_build" -installsuffix netgo \
-		-ldflags "-w -X $(shell go list).Version=$(VERSION) -X $(shell go list).Commit=$(COMMIT)" \
+		-ldflags "-w -X $(shell go list)/internal.Version=$(VERSION) -X $(shell go list)/internal.Commit=$(COMMIT)" \
 		./cmd/bitcaskd/...
 
 generate:

bitcask.go

@@ -11,6 +11,8 @@ import (
 
 	"github.com/gofrs/flock"
 	"github.com/prologic/trie"
+
+	"github.com/prologic/bitcask/internal"
 )
 
 type Bitcask struct {
@@ -18,9 +20,9 @@ type Bitcask struct {
 
 	config    *config
 	path      string
-	curr      *Datafile
-	keydir    *Keydir
-	datafiles []*Datafile
+	curr      *internal.Datafile
+	keydir    *internal.Keydir
+	datafiles []*internal.Datafile
 	trie      *trie.Trie
 
 	maxDatafileSize int64
@@ -43,14 +45,14 @@ func (b *Bitcask) Sync() error {
 }
 
 func (b *Bitcask) Get(key string) ([]byte, error) {
-	var df *Datafile
+	var df *internal.Datafile
 
 	item, ok := b.keydir.Get(key)
 	if !ok {
 		return nil, fmt.Errorf("error: key not found %s", key)
 	}
 
-	if item.FileID == b.curr.id {
+	if item.FileID == b.curr.FileID() {
 		df = b.curr
 	} else {
 		df = b.datafiles[item.FileID]
@@ -82,7 +84,7 @@ func (b *Bitcask) Put(key string, value []byte) error {
 		return err
 	}
 
-	item := b.keydir.Add(key, b.curr.id, offset)
+	item := b.keydir.Add(key, b.curr.FileID(), offset)
 	b.trie.Add(key, item)
 
 	return nil
@@ -131,22 +133,22 @@ func (b *Bitcask) put(key string, value []byte) (int64, error) {
 			return -1, err
 		}
 
-		df, err := NewDatafile(b.path, b.curr.id, true)
+		df, err := internal.NewDatafile(b.path, b.curr.FileID(), true)
 		if err != nil {
 			return -1, err
 		}
 
 		b.datafiles = append(b.datafiles, df)
 
-		id := b.curr.id + 1
-		curr, err := NewDatafile(b.path, id, false)
+		id := b.curr.FileID() + 1
+		curr, err := internal.NewDatafile(b.path, id, false)
 		if err != nil {
 			return -1, err
 		}
 		b.curr = curr
 	}
 
-	e := NewEntry(key, value)
+	e := internal.NewEntry(key, value)
 	return b.curr.Write(e)
 }
 
@@ -156,12 +158,12 @@ func (b *Bitcask) setMaxDatafileSize(size int64) error {
 }
 
 func Merge(path string, force bool) error {
-	fns, err := getDatafiles(path)
+	fns, err := internal.GetDatafiles(path)
 	if err != nil {
 		return err
 	}
 
-	ids, err := parseIds(fns)
+	ids, err := internal.ParseIds(fns)
 	if err != nil {
 		return err
 	}
@@ -191,9 +193,9 @@ func Merge(path string, force bool) error {
 
 		id := ids[i]
 
-		keydir := NewKeydir()
+		keydir := internal.NewKeydir()
 
-		df, err := NewDatafile(path, id, true)
+		df, err := internal.NewDatafile(path, id, true)
 		if err != nil {
 			return err
 		}
@@ -217,7 +219,7 @@ func Merge(path string, force bool) error {
 			keydir.Add(e.Key, ids[i], e.Offset)
 		}
 
-		tempdf, err := NewDatafile(temp, id, false)
+		tempdf, err := internal.NewDatafile(temp, id, false)
 		if err != nil {
 			return err
 		}
@@ -271,23 +273,23 @@ func Open(path string, options ...option) (*Bitcask, error) {
 		return nil, err
 	}
 
-	fns, err := getDatafiles(path)
+	fns, err := internal.GetDatafiles(path)
 	if err != nil {
 		return nil, err
 	}
 
-	ids, err := parseIds(fns)
+	ids, err := internal.ParseIds(fns)
 	if err != nil {
 		return nil, err
 	}
 
-	var datafiles []*Datafile
+	var datafiles []*internal.Datafile
 
-	keydir := NewKeydir()
+	keydir := internal.NewKeydir()
 	trie := trie.New()
 
 	for i, fn := range fns {
-		df, err := NewDatafile(path, ids[i], true)
+		df, err := internal.NewDatafile(path, ids[i], true)
 		if err != nil {
 			return nil, err
 		}
@@ -300,7 +302,7 @@ func Open(path string, options ...option) (*Bitcask, error) {
 			}
 			defer f.Close()
 
-			hint, err := NewKeydirFromBytes(f)
+			hint, err := internal.NewKeydirFromBytes(f)
 			if err != nil {
 				return nil, err
 			}
@@ -337,7 +339,7 @@ func Open(path string, options ...option) (*Bitcask, error) {
 		id = ids[(len(ids) - 1)]
 	}
 
-	curr, err := NewDatafile(path, id, false)
+	curr, err := internal.NewDatafile(path, id, false)
 	if err != nil {
 		return nil, err
 	}

cmd/bitcask/root.go

@@ -8,13 +8,13 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 
-	"github.com/prologic/bitcask"
+	"github.com/prologic/bitcask/internal"
 )
 
 // RootCmd represents the base command when called without any subcommands
 var RootCmd = &cobra.Command{
 	Use:     "bitcask",
-	Version: bitcask.FullVersion(),
+	Version: internal.FullVersion(),
 	Short:   "Command-line tools for bitcask",
 	Long: `This is the command-line tool to interact with a bitcask database.
 

cmd/bitcaskd/main.go

@@ -10,6 +10,7 @@ import (
 	"github.com/tidwall/redcon"
 
 	"github.com/prologic/bitcask"
+	"github.com/prologic/bitcask/internal"
 )
 
 var (
@@ -43,7 +44,7 @@ func main() {
 	}
 
 	if version {
-		fmt.Printf("bitcaskd version %s", bitcask.FullVersion())
+		fmt.Printf("bitcaskd version %s", internal.FullVersion())
 		os.Exit(0)
 	}
 
@@ -60,7 +61,7 @@ func main() {
 		os.Exit(1)
 	}
 
-	log.WithField("bind", bind).WithField("path", path).Infof("starting bitcaskd v%s", bitcask.FullVersion())
+	log.WithField("bind", bind).WithField("path", path).Infof("starting bitcaskd v%s", internal.FullVersion())
 
 	err = redcon.ListenAndServe(bind,
 		func(conn redcon.Conn, cmd redcon.Command) {

internal/datafile.go

@@ -1,4 +1,4 @@
-package bitcask
+package internal
 
 import (
 	"fmt"
@@ -8,8 +8,8 @@ import (
 
 	"github.com/pkg/errors"
 
-	pb "github.com/prologic/bitcask/proto"
-	"github.com/prologic/bitcask/streampb"
+	pb "github.com/prologic/bitcask/internal/proto"
+	"github.com/prologic/bitcask/internal/streampb"
 )
 
 const (
@@ -71,6 +71,10 @@ func NewDatafile(path string, id int, readonly bool) (*Datafile, error) {
 	}, nil
 }
 
+func (df *Datafile) FileID() int {
+	return df.id
+}
+
 func (df *Datafile) Name() string {
 	return df.r.Name()
 }

internal/entry.go

@@ -1,9 +1,9 @@
-package bitcask
+package internal
 
 import (
 	"hash/crc32"
 
-	pb "github.com/prologic/bitcask/proto"
+	pb "github.com/prologic/bitcask/internal/proto"
 )
 
 func NewEntry(key string, value []byte) pb.Entry {

internal/keydir.go

@@ -1,4 +1,4 @@
-package bitcask
+package internal
 
 import (
 	"bytes"

internal/utils.go

@@ -1,4 +1,4 @@
-package bitcask
+package internal
 
 import (
 	"fmt"
@@ -8,7 +8,7 @@ import (
 	"strings"
 )
 
-func getDatafiles(path string) ([]string, error) {
+func GetDatafiles(path string) ([]string, error) {
 	fns, err := filepath.Glob(fmt.Sprintf("%s/*.data", path))
 	if err != nil {
 		return nil, err
@@ -17,7 +17,7 @@ func getDatafiles(path string) ([]string, error) {
 	return fns, nil
 }
 
-func parseIds(fns []string) ([]int, error) {
+func ParseIds(fns []string) ([]int, error) {
 	var ids []int
 	for _, fn := range fns {
 		fn = filepath.Base(fn)

internal/version.go

@@ -1,4 +1,4 @@
-package bitcask
+package internal
 
 import (
 	"fmt"

internal/version_test.go

@@ -1,4 +1,4 @@
-package bitcask
+package internal
 
 import (
 	"fmt"