mirror of https://github.com/minio/minio.git
1202 lines
28 KiB
Go
1202 lines
28 KiB
Go
/*
|
|
* Minio Cloud Storage, (C) 2016, 2017, 2018 Minio, 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
|
|
*
|
|
* http://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 cmd
|
|
|
|
import (
|
|
"context"
|
|
"encoding/hex"
|
|
"io"
|
|
"io/ioutil"
|
|
"os"
|
|
slashpath "path"
|
|
"path/filepath"
|
|
"runtime"
|
|
"strings"
|
|
"sync"
|
|
"sync/atomic"
|
|
"syscall"
|
|
"time"
|
|
|
|
humanize "github.com/dustin/go-humanize"
|
|
"github.com/minio/minio/cmd/logger"
|
|
"github.com/minio/minio/pkg/disk"
|
|
"github.com/minio/minio/pkg/mountinfo"
|
|
)
|
|
|
|
const (
|
|
diskMinFreeSpace = 900 * humanize.MiByte // Min 900MiB free space.
|
|
diskMinTotalSpace = diskMinFreeSpace // Min 900MiB total space.
|
|
maxAllowedIOError = 5
|
|
)
|
|
|
|
// isValidVolname verifies a volname name in accordance with object
|
|
// layer requirements.
|
|
func isValidVolname(volname string) bool {
|
|
if len(volname) < 3 {
|
|
return false
|
|
}
|
|
|
|
if runtime.GOOS == "windows" {
|
|
// Volname shouldn't have reserved characters in Windows.
|
|
return !strings.ContainsAny(volname, `\:*?\"<>|`)
|
|
}
|
|
|
|
return true
|
|
}
|
|
|
|
// posix - implements StorageAPI interface.
|
|
type posix struct {
|
|
// Disk usage metrics
|
|
totalUsed uint64 // ref: https://golang.org/pkg/sync/atomic/#pkg-note-BUG
|
|
ioErrCount int32 // ref: https://golang.org/pkg/sync/atomic/#pkg-note-BUG
|
|
|
|
diskPath string
|
|
pool sync.Pool
|
|
connected bool
|
|
|
|
diskMount bool // indicates if the path is an actual mount.
|
|
|
|
// Disk usage metrics
|
|
stopUsageCh chan struct{}
|
|
}
|
|
|
|
// checkPathLength - returns error if given path name length more than 255
|
|
func checkPathLength(pathName string) error {
|
|
// Apple OS X path length is limited to 1016
|
|
if runtime.GOOS == "darwin" && len(pathName) > 1016 {
|
|
return errFileNameTooLong
|
|
}
|
|
|
|
// Convert any '\' to '/'.
|
|
pathName = filepath.ToSlash(pathName)
|
|
|
|
// Check each path segment length is > 255
|
|
for len(pathName) > 0 && pathName != "." && pathName != "/" {
|
|
dir, file := slashpath.Dir(pathName), slashpath.Base(pathName)
|
|
|
|
if len(file) > 255 {
|
|
return errFileNameTooLong
|
|
}
|
|
|
|
pathName = dir
|
|
} // Success.
|
|
return nil
|
|
}
|
|
|
|
func getValidPath(path string) (string, error) {
|
|
if path == "" {
|
|
return path, errInvalidArgument
|
|
}
|
|
|
|
var err error
|
|
// Disallow relative paths, figure out absolute paths.
|
|
path, err = filepath.Abs(path)
|
|
if err != nil {
|
|
return path, err
|
|
}
|
|
|
|
fi, err := os.Stat(path)
|
|
if err != nil && !os.IsNotExist(err) {
|
|
return path, err
|
|
}
|
|
if os.IsNotExist(err) {
|
|
// Disk not found create it.
|
|
if err = os.MkdirAll(path, 0777); err != nil {
|
|
return path, err
|
|
}
|
|
}
|
|
if fi != nil && !fi.IsDir() {
|
|
return path, syscall.ENOTDIR
|
|
}
|
|
|
|
di, err := getDiskInfo(path)
|
|
if err != nil {
|
|
return path, err
|
|
}
|
|
if err = checkDiskMinTotal(di); err != nil {
|
|
return path, err
|
|
}
|
|
|
|
// check if backend is writable.
|
|
file, err := os.Create(pathJoin(path, ".writable-check.tmp"))
|
|
if err != nil {
|
|
return path, err
|
|
}
|
|
defer os.Remove(pathJoin(path, ".writable-check.tmp"))
|
|
file.Close()
|
|
|
|
return path, nil
|
|
}
|
|
|
|
// isDirEmpty - returns whether given directory is empty or not.
|
|
func isDirEmpty(dirname string) bool {
|
|
f, err := os.Open((dirname))
|
|
if err != nil {
|
|
if !os.IsNotExist(err) {
|
|
logger.LogIf(context.Background(), err)
|
|
}
|
|
|
|
return false
|
|
}
|
|
defer f.Close()
|
|
// List one entry.
|
|
_, err = f.Readdirnames(1)
|
|
if err != io.EOF {
|
|
if !os.IsNotExist(err) {
|
|
logger.LogIf(context.Background(), err)
|
|
}
|
|
|
|
return false
|
|
}
|
|
// Returns true if we have reached EOF, directory is indeed empty.
|
|
return true
|
|
}
|
|
|
|
// Initialize a new storage disk.
|
|
func newPosix(path string) (*posix, error) {
|
|
var err error
|
|
if path, err = getValidPath(path); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
p := &posix{
|
|
connected: true,
|
|
diskPath: path,
|
|
// 1MiB buffer pool for posix internal operations.
|
|
pool: sync.Pool{
|
|
New: func() interface{} {
|
|
b := make([]byte, readSizeV1)
|
|
return &b
|
|
},
|
|
},
|
|
stopUsageCh: make(chan struct{}),
|
|
diskMount: mountinfo.IsLikelyMountPoint(path),
|
|
}
|
|
|
|
if !p.diskMount {
|
|
go p.diskUsage(globalServiceDoneCh)
|
|
}
|
|
|
|
// Success.
|
|
return p, nil
|
|
}
|
|
|
|
// getDiskInfo returns given disk information.
|
|
func getDiskInfo(diskPath string) (di disk.Info, err error) {
|
|
if err = checkPathLength(diskPath); err == nil {
|
|
di, err = disk.GetInfo(diskPath)
|
|
}
|
|
|
|
if os.IsNotExist(err) {
|
|
err = errDiskNotFound
|
|
}
|
|
|
|
return di, err
|
|
}
|
|
|
|
// List of operating systems where we ignore disk space
|
|
// verification.
|
|
var ignoreDiskFreeOS = []string{
|
|
globalWindowsOSName,
|
|
globalNetBSDOSName,
|
|
globalSolarisOSName,
|
|
}
|
|
|
|
// check if disk total has minimum required size.
|
|
func checkDiskMinTotal(di disk.Info) (err error) {
|
|
// Remove 5% from total space for cumulative disk space
|
|
// used for journalling, inodes etc.
|
|
totalDiskSpace := float64(di.Total) * 0.95
|
|
if int64(totalDiskSpace) <= diskMinTotalSpace {
|
|
return errMinDiskSize
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// check if disk free has minimum required size.
|
|
func checkDiskMinFree(di disk.Info) error {
|
|
// Remove 5% from free space for cumulative disk space used for journalling, inodes etc.
|
|
availableDiskSpace := float64(di.Free) * 0.95
|
|
if int64(availableDiskSpace) <= diskMinFreeSpace {
|
|
return errDiskFull
|
|
}
|
|
|
|
// Success.
|
|
return nil
|
|
}
|
|
|
|
// checkDiskFree verifies if disk path has sufficient minimum free disk space and files.
|
|
func checkDiskFree(diskPath string, neededSpace int64) (err error) {
|
|
// We don't validate disk space or inode utilization on windows.
|
|
// Each windows call to 'GetVolumeInformationW' takes around
|
|
// 3-5seconds. And StatDISK is not supported by Go for solaris
|
|
// and netbsd.
|
|
if contains(ignoreDiskFreeOS, runtime.GOOS) {
|
|
return nil
|
|
}
|
|
|
|
var di disk.Info
|
|
di, err = getDiskInfo((diskPath))
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if err = checkDiskMinFree(di); err != nil {
|
|
return err
|
|
}
|
|
|
|
// Check if we have enough space to store data
|
|
if neededSpace > int64(float64(di.Free)*0.95) {
|
|
return errDiskFull
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// Implements stringer compatible interface.
|
|
func (s *posix) String() string {
|
|
return s.diskPath
|
|
}
|
|
|
|
func (s *posix) Close() error {
|
|
close(s.stopUsageCh)
|
|
s.connected = false
|
|
return nil
|
|
}
|
|
|
|
func (s *posix) IsOnline() bool {
|
|
return s.connected
|
|
}
|
|
|
|
// DiskInfo is an extended type which returns current
|
|
// disk usage per path.
|
|
type DiskInfo struct {
|
|
Total uint64
|
|
Free uint64
|
|
Used uint64
|
|
}
|
|
|
|
// DiskInfo provides current information about disk space usage,
|
|
// total free inodes and underlying filesystem.
|
|
func (s *posix) DiskInfo() (info DiskInfo, err error) {
|
|
di, err := getDiskInfo(s.diskPath)
|
|
if err != nil {
|
|
return info, err
|
|
}
|
|
used := di.Total - di.Free
|
|
if !s.diskMount {
|
|
used = atomic.LoadUint64(&s.totalUsed)
|
|
}
|
|
return DiskInfo{
|
|
Total: di.Total,
|
|
Free: di.Free,
|
|
Used: used,
|
|
}, nil
|
|
|
|
}
|
|
|
|
// getVolDir - will convert incoming volume names to
|
|
// corresponding valid volume names on the backend in a platform
|
|
// compatible way for all operating systems. If volume is not found
|
|
// an error is generated.
|
|
func (s *posix) getVolDir(volume string) (string, error) {
|
|
if volume == "" || volume == "." || volume == ".." {
|
|
return "", errVolumeNotFound
|
|
}
|
|
volumeDir := pathJoin(s.diskPath, volume)
|
|
return volumeDir, nil
|
|
}
|
|
|
|
// checkDiskFound - validates if disk is available,
|
|
// returns errDiskNotFound if not found.
|
|
func (s *posix) checkDiskFound() (err error) {
|
|
if !s.IsOnline() {
|
|
return errDiskNotFound
|
|
}
|
|
_, err = os.Stat(s.diskPath)
|
|
if err != nil {
|
|
if os.IsNotExist(err) {
|
|
return errDiskNotFound
|
|
} else if isSysErrTooLong(err) {
|
|
return errFileNameTooLong
|
|
} else if isSysErrIO(err) {
|
|
return errFaultyDisk
|
|
}
|
|
return err
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// diskUsage returns du information for the posix path, in a continuous routine.
|
|
func (s *posix) diskUsage(doneCh chan struct{}) {
|
|
ticker := time.NewTicker(globalUsageCheckInterval)
|
|
defer ticker.Stop()
|
|
|
|
usageFn := func(ctx context.Context, entry string) error {
|
|
if globalHTTPServer != nil {
|
|
// Wait at max 1 minute for an inprogress request
|
|
// before proceeding to count the usage.
|
|
waitCount := 60
|
|
// Any requests in progress, delay the usage.
|
|
for globalHTTPServer.GetRequestCount() > 0 && waitCount > 0 {
|
|
waitCount--
|
|
time.Sleep(1 * time.Second)
|
|
}
|
|
}
|
|
|
|
select {
|
|
case <-doneCh:
|
|
return errWalkAbort
|
|
case <-s.stopUsageCh:
|
|
return errWalkAbort
|
|
default:
|
|
fi, err := os.Stat(entry)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
atomic.AddUint64(&s.totalUsed, uint64(fi.Size()))
|
|
return nil
|
|
}
|
|
}
|
|
|
|
// Return this routine upon errWalkAbort, continue for any other error on purpose
|
|
// so that we can start the routine freshly in another 12 hours.
|
|
if err := getDiskUsage(context.Background(), s.diskPath, usageFn); err == errWalkAbort {
|
|
return
|
|
}
|
|
|
|
for {
|
|
select {
|
|
case <-s.stopUsageCh:
|
|
return
|
|
case <-doneCh:
|
|
return
|
|
case <-time.After(globalUsageCheckInterval):
|
|
var usage uint64
|
|
usageFn = func(ctx context.Context, entry string) error {
|
|
if globalHTTPServer != nil {
|
|
// Wait at max 1 minute for an inprogress request
|
|
// before proceeding to count the usage.
|
|
waitCount := 60
|
|
// Any requests in progress, delay the usage.
|
|
for globalHTTPServer.GetRequestCount() > 0 && waitCount > 0 {
|
|
waitCount--
|
|
time.Sleep(1 * time.Second)
|
|
}
|
|
}
|
|
|
|
select {
|
|
case <-s.stopUsageCh:
|
|
return errWalkAbort
|
|
default:
|
|
fi, err := os.Stat(entry)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
usage = usage + uint64(fi.Size())
|
|
return nil
|
|
}
|
|
}
|
|
|
|
if err := getDiskUsage(context.Background(), s.diskPath, usageFn); err != nil {
|
|
continue
|
|
}
|
|
|
|
atomic.StoreUint64(&s.totalUsed, usage)
|
|
}
|
|
}
|
|
}
|
|
|
|
// Make a volume entry.
|
|
func (s *posix) MakeVol(volume string) (err error) {
|
|
defer func() {
|
|
if err == errFaultyDisk {
|
|
atomic.AddInt32(&s.ioErrCount, 1)
|
|
}
|
|
}()
|
|
|
|
if atomic.LoadInt32(&s.ioErrCount) > maxAllowedIOError {
|
|
return errFaultyDisk
|
|
}
|
|
|
|
if err = s.checkDiskFound(); err != nil {
|
|
return err
|
|
}
|
|
|
|
if !isValidVolname(volume) {
|
|
return errInvalidArgument
|
|
}
|
|
|
|
volumeDir, err := s.getVolDir(volume)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if _, err := os.Stat(volumeDir); err != nil {
|
|
// Volume does not exist we proceed to create.
|
|
if os.IsNotExist(err) {
|
|
// Make a volume entry, with mode 0777 mkdir honors system umask.
|
|
err = os.MkdirAll(volumeDir, 0777)
|
|
}
|
|
if os.IsPermission(err) {
|
|
return errDiskAccessDenied
|
|
} else if isSysErrIO(err) {
|
|
return errFaultyDisk
|
|
}
|
|
return err
|
|
}
|
|
|
|
// Stat succeeds we return errVolumeExists.
|
|
return errVolumeExists
|
|
}
|
|
|
|
// ListVols - list volumes.
|
|
func (s *posix) ListVols() (volsInfo []VolInfo, err error) {
|
|
defer func() {
|
|
if err == errFaultyDisk {
|
|
atomic.AddInt32(&s.ioErrCount, 1)
|
|
}
|
|
}()
|
|
|
|
if atomic.LoadInt32(&s.ioErrCount) > maxAllowedIOError {
|
|
return nil, errFaultyDisk
|
|
}
|
|
|
|
if err = s.checkDiskFound(); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
volsInfo, err = listVols(s.diskPath)
|
|
if err != nil {
|
|
if isSysErrIO(err) {
|
|
return nil, errFaultyDisk
|
|
}
|
|
return nil, err
|
|
}
|
|
for i, vol := range volsInfo {
|
|
volInfo := VolInfo{
|
|
Name: vol.Name,
|
|
Created: vol.Created,
|
|
}
|
|
volsInfo[i] = volInfo
|
|
}
|
|
return volsInfo, nil
|
|
}
|
|
|
|
// List all the volumes from diskPath.
|
|
func listVols(dirPath string) ([]VolInfo, error) {
|
|
if err := checkPathLength(dirPath); err != nil {
|
|
return nil, err
|
|
}
|
|
entries, err := readDir(dirPath)
|
|
if err != nil {
|
|
return nil, errDiskNotFound
|
|
}
|
|
var volsInfo []VolInfo
|
|
for _, entry := range entries {
|
|
if !hasSuffix(entry, slashSeparator) || !isValidVolname(slashpath.Clean(entry)) {
|
|
// Skip if entry is neither a directory not a valid volume name.
|
|
continue
|
|
}
|
|
var fi os.FileInfo
|
|
fi, err = os.Stat(pathJoin(dirPath, entry))
|
|
if err != nil {
|
|
// If the file does not exist, skip the entry.
|
|
if os.IsNotExist(err) {
|
|
continue
|
|
} else if isSysErrIO(err) {
|
|
return nil, errFaultyDisk
|
|
}
|
|
return nil, err
|
|
}
|
|
volsInfo = append(volsInfo, VolInfo{
|
|
Name: fi.Name(),
|
|
// As os.Stat() doesn't carry other than ModTime(), use
|
|
// ModTime() as CreatedTime.
|
|
Created: fi.ModTime(),
|
|
})
|
|
}
|
|
return volsInfo, nil
|
|
}
|
|
|
|
// StatVol - get volume info.
|
|
func (s *posix) StatVol(volume string) (volInfo VolInfo, err error) {
|
|
defer func() {
|
|
if err == errFaultyDisk {
|
|
atomic.AddInt32(&s.ioErrCount, 1)
|
|
}
|
|
}()
|
|
|
|
if atomic.LoadInt32(&s.ioErrCount) > maxAllowedIOError {
|
|
return VolInfo{}, errFaultyDisk
|
|
}
|
|
|
|
if err = s.checkDiskFound(); err != nil {
|
|
return VolInfo{}, err
|
|
}
|
|
|
|
// Verify if volume is valid and it exists.
|
|
volumeDir, err := s.getVolDir(volume)
|
|
if err != nil {
|
|
return VolInfo{}, err
|
|
}
|
|
// Stat a volume entry.
|
|
var st os.FileInfo
|
|
st, err = os.Stat(volumeDir)
|
|
if err != nil {
|
|
if os.IsNotExist(err) {
|
|
return VolInfo{}, errVolumeNotFound
|
|
} else if isSysErrIO(err) {
|
|
return VolInfo{}, errFaultyDisk
|
|
}
|
|
return VolInfo{}, err
|
|
}
|
|
// As os.Stat() doesn't carry other than ModTime(), use ModTime()
|
|
// as CreatedTime.
|
|
createdTime := st.ModTime()
|
|
return VolInfo{
|
|
Name: volume,
|
|
Created: createdTime,
|
|
}, nil
|
|
}
|
|
|
|
// DeleteVol - delete a volume.
|
|
func (s *posix) DeleteVol(volume string) (err error) {
|
|
defer func() {
|
|
if err == errFaultyDisk {
|
|
atomic.AddInt32(&s.ioErrCount, 1)
|
|
}
|
|
}()
|
|
|
|
if atomic.LoadInt32(&s.ioErrCount) > maxAllowedIOError {
|
|
return errFaultyDisk
|
|
}
|
|
|
|
if err = s.checkDiskFound(); err != nil {
|
|
return err
|
|
}
|
|
|
|
// Verify if volume is valid and it exists.
|
|
volumeDir, err := s.getVolDir(volume)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
err = os.Remove((volumeDir))
|
|
if err != nil {
|
|
if os.IsNotExist(err) {
|
|
return errVolumeNotFound
|
|
} else if isSysErrNotEmpty(err) {
|
|
return errVolumeNotEmpty
|
|
} else if os.IsPermission(err) {
|
|
return errDiskAccessDenied
|
|
} else if isSysErrIO(err) {
|
|
return errFaultyDisk
|
|
}
|
|
return err
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// ListDir - return all the entries at the given directory path.
|
|
// If an entry is a directory it will be returned with a trailing "/".
|
|
func (s *posix) ListDir(volume, dirPath string, count int) (entries []string, err error) {
|
|
defer func() {
|
|
if err == errFaultyDisk {
|
|
atomic.AddInt32(&s.ioErrCount, 1)
|
|
}
|
|
}()
|
|
|
|
if atomic.LoadInt32(&s.ioErrCount) > maxAllowedIOError {
|
|
return nil, errFaultyDisk
|
|
}
|
|
|
|
if err = s.checkDiskFound(); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// Verify if volume is valid and it exists.
|
|
volumeDir, err := s.getVolDir(volume)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
// Stat a volume entry.
|
|
_, err = os.Stat((volumeDir))
|
|
if err != nil {
|
|
if os.IsNotExist(err) {
|
|
return nil, errVolumeNotFound
|
|
} else if isSysErrIO(err) {
|
|
return nil, errFaultyDisk
|
|
}
|
|
return nil, err
|
|
}
|
|
|
|
dirPath = pathJoin(volumeDir, dirPath)
|
|
if count > 0 {
|
|
return readDirN(dirPath, count)
|
|
}
|
|
return readDir(dirPath)
|
|
}
|
|
|
|
// ReadAll reads from r until an error or EOF and returns the data it read.
|
|
// A successful call returns err == nil, not err == EOF. Because ReadAll is
|
|
// defined to read from src until EOF, it does not treat an EOF from Read
|
|
// as an error to be reported.
|
|
// This API is meant to be used on files which have small memory footprint, do
|
|
// not use this on large files as it would cause server to crash.
|
|
func (s *posix) ReadAll(volume, path string) (buf []byte, err error) {
|
|
defer func() {
|
|
if err == errFaultyDisk {
|
|
atomic.AddInt32(&s.ioErrCount, 1)
|
|
}
|
|
}()
|
|
|
|
if atomic.LoadInt32(&s.ioErrCount) > maxAllowedIOError {
|
|
return nil, errFaultyDisk
|
|
}
|
|
|
|
if err = s.checkDiskFound(); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
volumeDir, err := s.getVolDir(volume)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
// Stat a volume entry.
|
|
_, err = os.Stat((volumeDir))
|
|
if err != nil {
|
|
if os.IsNotExist(err) {
|
|
return nil, errVolumeNotFound
|
|
} else if isSysErrIO(err) {
|
|
return nil, errFaultyDisk
|
|
}
|
|
return nil, err
|
|
}
|
|
|
|
// Validate file path length, before reading.
|
|
filePath := pathJoin(volumeDir, path)
|
|
if err = checkPathLength((filePath)); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// Open the file for reading.
|
|
buf, err = ioutil.ReadFile((filePath))
|
|
if err != nil {
|
|
if os.IsNotExist(err) {
|
|
return nil, errFileNotFound
|
|
} else if os.IsPermission(err) {
|
|
return nil, errFileAccessDenied
|
|
} else if pathErr, ok := err.(*os.PathError); ok {
|
|
switch pathErr.Err {
|
|
case syscall.ENOTDIR, syscall.EISDIR:
|
|
return nil, errFileNotFound
|
|
default:
|
|
if isSysErrHandleInvalid(pathErr.Err) {
|
|
// This case is special and needs to be handled for windows.
|
|
return nil, errFileNotFound
|
|
}
|
|
}
|
|
return nil, pathErr
|
|
} else if isSysErrIO(err) {
|
|
return nil, errFaultyDisk
|
|
}
|
|
return nil, err
|
|
}
|
|
return buf, nil
|
|
}
|
|
|
|
// ReadFile reads exactly len(buf) bytes into buf. It returns the
|
|
// number of bytes copied. The error is EOF only if no bytes were
|
|
// read. On return, n == len(buf) if and only if err == nil. n == 0
|
|
// for io.EOF.
|
|
//
|
|
// If an EOF happens after reading some but not all the bytes,
|
|
// ReadFile returns ErrUnexpectedEOF.
|
|
//
|
|
// If the BitrotVerifier is not nil or not verified ReadFile
|
|
// tries to verify whether the disk has bitrot.
|
|
//
|
|
// Additionally ReadFile also starts reading from an offset. ReadFile
|
|
// semantics are same as io.ReadFull.
|
|
func (s *posix) ReadFile(volume, path string, offset int64, buffer []byte, verifier *BitrotVerifier) (n int64, err error) {
|
|
defer func() {
|
|
if err == errFaultyDisk {
|
|
atomic.AddInt32(&s.ioErrCount, 1)
|
|
}
|
|
}()
|
|
|
|
if atomic.LoadInt32(&s.ioErrCount) > maxAllowedIOError {
|
|
return 0, errFaultyDisk
|
|
}
|
|
|
|
if err = s.checkDiskFound(); err != nil {
|
|
return 0, err
|
|
}
|
|
|
|
volumeDir, err := s.getVolDir(volume)
|
|
if err != nil {
|
|
return 0, err
|
|
}
|
|
// Stat a volume entry.
|
|
_, err = os.Stat((volumeDir))
|
|
if err != nil {
|
|
if os.IsNotExist(err) {
|
|
return 0, errVolumeNotFound
|
|
} else if isSysErrIO(err) {
|
|
return 0, errFaultyDisk
|
|
}
|
|
return 0, err
|
|
}
|
|
|
|
// Validate effective path length before reading.
|
|
filePath := pathJoin(volumeDir, path)
|
|
if err = checkPathLength((filePath)); err != nil {
|
|
return 0, err
|
|
}
|
|
|
|
// Open the file for reading.
|
|
file, err := os.Open((filePath))
|
|
if err != nil {
|
|
if os.IsNotExist(err) {
|
|
return 0, errFileNotFound
|
|
} else if os.IsPermission(err) {
|
|
return 0, errFileAccessDenied
|
|
} else if isSysErrNotDir(err) {
|
|
return 0, errFileAccessDenied
|
|
} else if isSysErrIO(err) {
|
|
return 0, errFaultyDisk
|
|
}
|
|
return 0, err
|
|
}
|
|
|
|
// Close the file descriptor.
|
|
defer file.Close()
|
|
|
|
st, err := file.Stat()
|
|
if err != nil {
|
|
return 0, err
|
|
}
|
|
|
|
// Verify it is a regular file, otherwise subsequent Seek is
|
|
// undefined.
|
|
if !st.Mode().IsRegular() {
|
|
return 0, errIsNotRegular
|
|
}
|
|
|
|
if verifier != nil {
|
|
bufp := s.pool.Get().(*[]byte)
|
|
defer s.pool.Put(bufp)
|
|
|
|
if offset != 0 {
|
|
if _, err = io.CopyBuffer(verifier, io.LimitReader(file, offset), *bufp); err != nil {
|
|
return 0, err
|
|
}
|
|
}
|
|
if _, err = file.Read(buffer); err != nil {
|
|
return 0, err
|
|
}
|
|
if _, err = verifier.Write(buffer); err != nil {
|
|
return 0, err
|
|
}
|
|
if _, err = io.CopyBuffer(verifier, file, *bufp); err != nil {
|
|
return 0, err
|
|
}
|
|
if !verifier.Verify() {
|
|
return 0, hashMismatchError{hex.EncodeToString(verifier.sum), hex.EncodeToString(verifier.Sum(nil))}
|
|
}
|
|
return int64(len(buffer)), err
|
|
}
|
|
|
|
m, err := file.ReadAt(buffer, offset)
|
|
if m > 0 && m < len(buffer) {
|
|
err = io.ErrUnexpectedEOF
|
|
}
|
|
return int64(m), err
|
|
}
|
|
|
|
func (s *posix) createFile(volume, path string) (f *os.File, err error) {
|
|
defer func() {
|
|
if err == errFaultyDisk {
|
|
atomic.AddInt32(&s.ioErrCount, 1)
|
|
}
|
|
}()
|
|
|
|
if atomic.LoadInt32(&s.ioErrCount) > maxAllowedIOError {
|
|
return nil, errFaultyDisk
|
|
}
|
|
|
|
if err = s.checkDiskFound(); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
volumeDir, err := s.getVolDir(volume)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
// Stat a volume entry.
|
|
_, err = os.Stat((volumeDir))
|
|
if err != nil {
|
|
if os.IsNotExist(err) {
|
|
return nil, errVolumeNotFound
|
|
} else if isSysErrIO(err) {
|
|
return nil, errFaultyDisk
|
|
}
|
|
return nil, err
|
|
}
|
|
|
|
filePath := pathJoin(volumeDir, path)
|
|
if err = checkPathLength((filePath)); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// Verify if the file already exists and is not of regular type.
|
|
var st os.FileInfo
|
|
if st, err = os.Stat(filePath); err == nil {
|
|
if !st.Mode().IsRegular() {
|
|
return nil, errIsNotRegular
|
|
}
|
|
} else {
|
|
// Create top level directories if they don't exist.
|
|
// with mode 0777 mkdir honors system umask.
|
|
if err = mkdirAll(slashpath.Dir(filePath), 0777); err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
|
|
w, err := os.OpenFile(filePath, os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0666)
|
|
if err != nil {
|
|
// File path cannot be verified since one of the parents is a file.
|
|
if isSysErrNotDir(err) {
|
|
return nil, errFileAccessDenied
|
|
} else if os.IsPermission(err) {
|
|
return nil, errFileAccessDenied
|
|
} else if isSysErrIO(err) {
|
|
return nil, errFaultyDisk
|
|
}
|
|
return nil, err
|
|
}
|
|
|
|
return w, nil
|
|
}
|
|
|
|
// PrepareFile - run prior actions before creating a new file for optimization purposes
|
|
// Currently we use fallocate when available to avoid disk fragmentation as much as possible
|
|
func (s *posix) PrepareFile(volume, path string, fileSize int64) (err error) {
|
|
// It doesn't make sense to create a negative-sized file
|
|
if fileSize <= 0 {
|
|
return errInvalidArgument
|
|
}
|
|
|
|
defer func() {
|
|
if err == errFaultyDisk {
|
|
atomic.AddInt32(&s.ioErrCount, 1)
|
|
}
|
|
}()
|
|
|
|
if atomic.LoadInt32(&s.ioErrCount) > maxAllowedIOError {
|
|
return errFaultyDisk
|
|
}
|
|
|
|
// Validate if disk is indeed free.
|
|
if err = checkDiskFree(s.diskPath, fileSize); err != nil {
|
|
if isSysErrIO(err) {
|
|
return errFaultyDisk
|
|
}
|
|
return err
|
|
}
|
|
|
|
// Create file if not found
|
|
w, err := s.createFile(volume, path)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// Close upon return.
|
|
defer w.Close()
|
|
|
|
// Allocate needed disk space to append data
|
|
e := Fallocate(int(w.Fd()), 0, fileSize)
|
|
|
|
// Ignore errors when Fallocate is not supported in the current system
|
|
if e != nil && !isSysErrNoSys(e) && !isSysErrOpNotSupported(e) {
|
|
switch {
|
|
case isSysErrNoSpace(e):
|
|
err = errDiskFull
|
|
case isSysErrIO(e):
|
|
err = errFaultyDisk
|
|
default:
|
|
// For errors: EBADF, EINTR, EINVAL, ENODEV, EPERM, ESPIPE and ETXTBSY
|
|
// Appending was failed anyway, returns unexpected error
|
|
err = errUnexpected
|
|
}
|
|
return err
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// AppendFile - append a byte array at path, if file doesn't exist at
|
|
// path this call explicitly creates it.
|
|
func (s *posix) AppendFile(volume, path string, buf []byte) (err error) {
|
|
defer func() {
|
|
if err == errFaultyDisk {
|
|
atomic.AddInt32(&s.ioErrCount, 1)
|
|
}
|
|
}()
|
|
|
|
if atomic.LoadInt32(&s.ioErrCount) > maxAllowedIOError {
|
|
return errFaultyDisk
|
|
}
|
|
|
|
// Create file if not found
|
|
w, err := s.createFile(volume, path)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
_, err = w.Write(buf)
|
|
w.Close()
|
|
return err
|
|
}
|
|
|
|
// StatFile - get file info.
|
|
func (s *posix) StatFile(volume, path string) (file FileInfo, err error) {
|
|
defer func() {
|
|
if err == errFaultyDisk {
|
|
atomic.AddInt32(&s.ioErrCount, 1)
|
|
}
|
|
}()
|
|
|
|
if atomic.LoadInt32(&s.ioErrCount) > maxAllowedIOError {
|
|
return FileInfo{}, errFaultyDisk
|
|
}
|
|
|
|
if err = s.checkDiskFound(); err != nil {
|
|
return FileInfo{}, err
|
|
}
|
|
|
|
volumeDir, err := s.getVolDir(volume)
|
|
if err != nil {
|
|
return FileInfo{}, err
|
|
}
|
|
// Stat a volume entry.
|
|
_, err = os.Stat((volumeDir))
|
|
if err != nil {
|
|
if os.IsNotExist(err) {
|
|
return FileInfo{}, errVolumeNotFound
|
|
}
|
|
return FileInfo{}, err
|
|
}
|
|
|
|
filePath := slashpath.Join(volumeDir, path)
|
|
if err = checkPathLength((filePath)); err != nil {
|
|
return FileInfo{}, err
|
|
}
|
|
st, err := os.Stat((filePath))
|
|
if err != nil {
|
|
// File is really not found.
|
|
if os.IsNotExist(err) {
|
|
return FileInfo{}, errFileNotFound
|
|
} else if isSysErrIO(err) {
|
|
return FileInfo{}, errFaultyDisk
|
|
} else if isSysErrNotDir(err) {
|
|
// File path cannot be verified since one of the parents is a file.
|
|
return FileInfo{}, errFileNotFound
|
|
}
|
|
|
|
// Return all errors here.
|
|
return FileInfo{}, err
|
|
}
|
|
// If its a directory its not a regular file.
|
|
if st.Mode().IsDir() {
|
|
return FileInfo{}, errFileNotFound
|
|
}
|
|
return FileInfo{
|
|
Volume: volume,
|
|
Name: path,
|
|
ModTime: st.ModTime(),
|
|
Size: st.Size(),
|
|
Mode: st.Mode(),
|
|
}, nil
|
|
}
|
|
|
|
// deleteFile deletes a file path if its empty. If it's successfully deleted,
|
|
// it will recursively move up the tree, deleting empty parent directories
|
|
// until it finds one with files in it. Returns nil for a non-empty directory.
|
|
func deleteFile(basePath, deletePath string) error {
|
|
if basePath == deletePath {
|
|
return nil
|
|
}
|
|
|
|
// Attempt to remove path.
|
|
if err := os.Remove((deletePath)); err != nil {
|
|
// Ignore errors if the directory is not empty. The server relies on
|
|
// this functionality, and sometimes uses recursion that should not
|
|
// error on parent directories.
|
|
if isSysErrNotEmpty(err) {
|
|
return nil
|
|
}
|
|
|
|
if os.IsNotExist(err) {
|
|
return errFileNotFound
|
|
} else if os.IsPermission(err) {
|
|
return errFileAccessDenied
|
|
} else if isSysErrIO(err) {
|
|
return errFaultyDisk
|
|
}
|
|
return err
|
|
}
|
|
|
|
// Trailing slash is removed when found to ensure
|
|
// slashpath.Dir() to work as intended.
|
|
deletePath = strings.TrimSuffix(deletePath, slashSeparator)
|
|
deletePath = slashpath.Dir(deletePath)
|
|
|
|
// Delete parent directory. Errors for parent directories shouldn't trickle down.
|
|
deleteFile(basePath, deletePath)
|
|
|
|
return nil
|
|
}
|
|
|
|
// DeleteFile - delete a file at path.
|
|
func (s *posix) DeleteFile(volume, path string) (err error) {
|
|
defer func() {
|
|
if err == errFaultyDisk {
|
|
atomic.AddInt32(&s.ioErrCount, 1)
|
|
}
|
|
}()
|
|
|
|
if atomic.LoadInt32(&s.ioErrCount) > maxAllowedIOError {
|
|
return errFaultyDisk
|
|
}
|
|
|
|
if err = s.checkDiskFound(); err != nil {
|
|
return err
|
|
}
|
|
|
|
volumeDir, err := s.getVolDir(volume)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
// Stat a volume entry.
|
|
_, err = os.Stat((volumeDir))
|
|
if err != nil {
|
|
if os.IsNotExist(err) {
|
|
return errVolumeNotFound
|
|
} else if isSysErrIO(err) {
|
|
return errFaultyDisk
|
|
}
|
|
return err
|
|
}
|
|
|
|
// Following code is needed so that we retain "/" suffix if any in
|
|
// path argument.
|
|
filePath := pathJoin(volumeDir, path)
|
|
if err = checkPathLength((filePath)); err != nil {
|
|
return err
|
|
}
|
|
|
|
// Delete file and delete parent directory as well if its empty.
|
|
return deleteFile(volumeDir, filePath)
|
|
}
|
|
|
|
// RenameFile - rename source path to destination path atomically.
|
|
func (s *posix) RenameFile(srcVolume, srcPath, dstVolume, dstPath string) (err error) {
|
|
defer func() {
|
|
if err == errFaultyDisk {
|
|
atomic.AddInt32(&s.ioErrCount, 1)
|
|
}
|
|
}()
|
|
|
|
if atomic.LoadInt32(&s.ioErrCount) > maxAllowedIOError {
|
|
return errFaultyDisk
|
|
}
|
|
|
|
if err = s.checkDiskFound(); err != nil {
|
|
return err
|
|
}
|
|
|
|
srcVolumeDir, err := s.getVolDir(srcVolume)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
dstVolumeDir, err := s.getVolDir(dstVolume)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
// Stat a volume entry.
|
|
_, err = os.Stat(srcVolumeDir)
|
|
if err != nil {
|
|
if os.IsNotExist(err) {
|
|
return errVolumeNotFound
|
|
} else if isSysErrIO(err) {
|
|
return errFaultyDisk
|
|
}
|
|
return err
|
|
}
|
|
_, err = os.Stat(dstVolumeDir)
|
|
if err != nil {
|
|
if os.IsNotExist(err) {
|
|
return errVolumeNotFound
|
|
} else if isSysErrIO(err) {
|
|
return errFaultyDisk
|
|
}
|
|
}
|
|
|
|
srcIsDir := hasSuffix(srcPath, slashSeparator)
|
|
dstIsDir := hasSuffix(dstPath, slashSeparator)
|
|
// Either src and dst have to be directories or files, else return error.
|
|
if !(srcIsDir && dstIsDir || !srcIsDir && !dstIsDir) {
|
|
return errFileAccessDenied
|
|
}
|
|
srcFilePath := slashpath.Join(srcVolumeDir, srcPath)
|
|
if err = checkPathLength(srcFilePath); err != nil {
|
|
return err
|
|
}
|
|
dstFilePath := slashpath.Join(dstVolumeDir, dstPath)
|
|
if err = checkPathLength(dstFilePath); err != nil {
|
|
return err
|
|
}
|
|
if srcIsDir {
|
|
// If source is a directory, we expect the destination to be non-existent but we
|
|
// we still need to allow overwriting an empty directory since it represents
|
|
// an object empty directory.
|
|
_, err = os.Stat(dstFilePath)
|
|
if isSysErrIO(err) {
|
|
return errFaultyDisk
|
|
}
|
|
if err == nil && !isDirEmpty(dstFilePath) {
|
|
return errFileAccessDenied
|
|
}
|
|
if !os.IsNotExist(err) {
|
|
return err
|
|
}
|
|
}
|
|
|
|
if err = renameAll(srcFilePath, dstFilePath); err != nil {
|
|
if isSysErrIO(err) {
|
|
return errFaultyDisk
|
|
}
|
|
return err
|
|
}
|
|
|
|
// Remove parent dir of the source file if empty
|
|
if parentDir := slashpath.Dir(srcFilePath); isDirEmpty(parentDir) {
|
|
deleteFile(srcVolumeDir, parentDir)
|
|
}
|
|
|
|
return nil
|
|
}
|