rclone/lib/file/preallocate_unix.go

//go:build linux

package file

import (
	"os"
	"sync"
	"sync/atomic"
	"syscall"

	"github.com/rclone/rclone/fs"
	"golang.org/x/sys/unix"
)

var (
	fallocFlags = [...]uint32{
		unix.FALLOC_FL_KEEP_SIZE,                             // Default
		unix.FALLOC_FL_KEEP_SIZE | unix.FALLOC_FL_PUNCH_HOLE, // for ZFS #3066
	}
	fallocFlagsIndex atomic.Int32
	preAllocateMu    sync.Mutex
)

// PreallocateImplemented is a constant indicating whether the
// implementation of Preallocate actually does anything.
const PreallocateImplemented = true

// PreAllocate the file for performance reasons
func PreAllocate(size int64, out *os.File) (err error) {
	if size <= 0 {
		return nil
	}

	preAllocateMu.Lock()
	defer preAllocateMu.Unlock()

	for {

		index := fallocFlagsIndex.Load()
	again:
		if index >= int32(len(fallocFlags)) {
			return nil // Fallocate is disabled
		}
		flags := fallocFlags[index]
		err = unix.Fallocate(int(out.Fd()), flags, 0, size)
		if err == unix.ENOTSUP {
			// Try the next flags combination
			index++
			fallocFlagsIndex.Store(index)
			fs.Debugf(nil, "preAllocate: got error on fallocate, trying combination %d/%d: %v", index, len(fallocFlags), err)
			goto again

		}
		// Wrap important errors
		if err == unix.ENOSPC {
			return ErrDiskFull
		}
		if err != syscall.EINTR {
			break
		}
	}
	return err
}

// SetSparseImplemented is a constant indicating whether the
// implementation of SetSparse actually does anything.
const SetSparseImplemented = false

// SetSparse makes the file be a sparse file
func SetSparse(out *os.File) error {
	return nil
}