295301a44c
* Add configuration options for FileMode Add two additional configuration values, and their corresponding default values: * DirFileModeBeforeUmask - Dir FileMode is used on all directories created. DefaultDirFileModeBeforeUmask is 0700. * FileFileModeBeforeUmask - File FileMode is used on all files created, except for the "lock" file (managed by the Flock library). DefaultFileFileModeBeforeUmask is 0600. When using these bits of configuration, keep in mind these FileMode values are set BEFORE any umask rules are applied. For example, if the user's umask is 022, setting DirFileFileModeBeforeUmask to 777 will result in directories with FileMode set to 755 (this umask prevents the write bit from being applied to group and world permissions). * moving defer statements after checking for errors use os.ModePerm const instead of os.FileMode(777) * fix spelling/grammar * skip these tests for Windows as they appear to break - Windows is less POSIX-y than it claims * ignore "lock" file for default case too -- this was incorrectly passing before including this, as my local dev station has umask 022
103 lines
2.8 KiB
Go
103 lines
2.8 KiB
Go
package bitcask
|
|
|
|
import (
|
|
"os"
|
|
|
|
"github.com/prologic/bitcask/internal/config"
|
|
)
|
|
|
|
const (
|
|
// DefaultDirFileModeBeforeUmask is the default os.FileMode used when creating directories
|
|
DefaultDirFileModeBeforeUmask = os.FileMode(0700)
|
|
|
|
// DefaultFileFileModeBeforeUmask is the default os.FileMode used when creating files
|
|
DefaultFileFileModeBeforeUmask = os.FileMode(0600)
|
|
|
|
// DefaultMaxDatafileSize is the default maximum datafile size in bytes
|
|
DefaultMaxDatafileSize = 1 << 20 // 1MB
|
|
|
|
// DefaultMaxKeySize is the default maximum key size in bytes
|
|
DefaultMaxKeySize = uint32(64) // 64 bytes
|
|
|
|
// DefaultMaxValueSize is the default value size in bytes
|
|
DefaultMaxValueSize = uint64(1 << 16) // 65KB
|
|
|
|
// DefaultSync is the default file synchronization action
|
|
DefaultSync = false
|
|
|
|
// DefaultAutoRecovery is the default auto-recovery action.
|
|
)
|
|
|
|
// Option is a function that takes a config struct and modifies it
|
|
type Option func(*config.Config) error
|
|
|
|
// WithAutoRecovery sets auto recovery of data and index file recreation.
|
|
// IMPORTANT: This flag MUST BE used only if a proper backup was made of all
|
|
// the existing datafiles.
|
|
func WithAutoRecovery(enabled bool) Option {
|
|
return func(cfg *config.Config) error {
|
|
cfg.AutoRecovery = enabled
|
|
return nil
|
|
}
|
|
}
|
|
|
|
// WithDirFileModeBeforeUmask sets the FileMode used for each new file created.
|
|
func WithDirFileModeBeforeUmask(mode os.FileMode) Option {
|
|
return func(cfg *config.Config) error {
|
|
cfg.DirFileModeBeforeUmask = mode
|
|
return nil
|
|
}
|
|
}
|
|
|
|
// WithFileFileModeBeforeUmask sets the FileMode used for each new file created.
|
|
func WithFileFileModeBeforeUmask(mode os.FileMode) Option {
|
|
return func(cfg *config.Config) error {
|
|
cfg.FileFileModeBeforeUmask = mode
|
|
return nil
|
|
}
|
|
}
|
|
|
|
// WithMaxDatafileSize sets the maximum datafile size option
|
|
func WithMaxDatafileSize(size int) Option {
|
|
return func(cfg *config.Config) error {
|
|
cfg.MaxDatafileSize = size
|
|
return nil
|
|
}
|
|
}
|
|
|
|
// WithMaxKeySize sets the maximum key size option
|
|
func WithMaxKeySize(size uint32) Option {
|
|
return func(cfg *config.Config) error {
|
|
cfg.MaxKeySize = size
|
|
return nil
|
|
}
|
|
}
|
|
|
|
// WithMaxValueSize sets the maximum value size option
|
|
func WithMaxValueSize(size uint64) Option {
|
|
return func(cfg *config.Config) error {
|
|
cfg.MaxValueSize = size
|
|
return nil
|
|
}
|
|
}
|
|
|
|
// WithSync causes Sync() to be called on every key/value written increasing
|
|
// durability and safety at the expense of performance
|
|
func WithSync(sync bool) Option {
|
|
return func(cfg *config.Config) error {
|
|
cfg.Sync = sync
|
|
return nil
|
|
}
|
|
}
|
|
|
|
func newDefaultConfig() *config.Config {
|
|
return &config.Config{
|
|
MaxDatafileSize: DefaultMaxDatafileSize,
|
|
MaxKeySize: DefaultMaxKeySize,
|
|
MaxValueSize: DefaultMaxValueSize,
|
|
Sync: DefaultSync,
|
|
DirFileModeBeforeUmask: DefaultDirFileModeBeforeUmask,
|
|
FileFileModeBeforeUmask: DefaultFileFileModeBeforeUmask,
|
|
}
|
|
}
|