rename all remaining packages to internal/ (#12418)

This is to ensure that there are no projects
that try to import `minio/minio/pkg` into
their own repo. Any such common packages should
go to `https://github.com/minio/pkg`

internal/ioutil/append-file_nix.go

@@ -0,0 +1,46 @@
+// +build !windows
+
+// Copyright (c) 2015-2021 MinIO, Inc.
+//
+// This file is part of MinIO Object Storage stack
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+package ioutil
+
+import (
+	"io"
+	"os"
+)
+
+// AppendFile - appends the file "src" to the file "dst"
+func AppendFile(dst string, src string, osync bool) error {
+	flags := os.O_WRONLY | os.O_APPEND | os.O_CREATE
+	if osync {
+		flags = flags | os.O_SYNC
+	}
+	appendFile, err := os.OpenFile(dst, flags, 0666)
+	if err != nil {
+		return err
+	}
+	defer appendFile.Close()
+
+	srcFile, err := os.Open(src)
+	if err != nil {
+		return err
+	}
+	defer srcFile.Close()
+	_, err = io.Copy(appendFile, srcFile)
+	return err
+}

internal/ioutil/append-file_windows.go

@@ -0,0 +1,42 @@
+// Copyright (c) 2015-2021 MinIO, Inc.
+//
+// This file is part of MinIO Object Storage stack
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+package ioutil
+
+import (
+	"io"
+	"os"
+
+	"github.com/minio/minio/internal/lock"
+)
+
+// AppendFile - appends the file "src" to the file "dst"
+func AppendFile(dst string, src string, osync bool) error {
+	appendFile, err := lock.Open(dst, os.O_WRONLY|os.O_APPEND|os.O_CREATE, 0644)
+	if err != nil {
+		return err
+	}
+	defer appendFile.Close()
+
+	srcFile, err := lock.Open(src, os.O_RDONLY, 0644)
+	if err != nil {
+		return err
+	}
+	defer srcFile.Close()
+	_, err = io.Copy(appendFile, srcFile)
+	return err
+}

internal/ioutil/ioutil.go

@@ -0,0 +1,300 @@
+// Copyright (c) 2015-2021 MinIO, Inc.
+//
+// This file is part of MinIO Object Storage stack
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+// Package ioutil implements some I/O utility functions which are not covered
+// by the standard library.
+package ioutil
+
+import (
+	"bytes"
+	"context"
+	"io"
+	"os"
+	"time"
+
+	"github.com/minio/minio/internal/disk"
+)
+
+// WriteOnCloser implements io.WriteCloser and always
+// executes at least one write operation if it is closed.
+//
+// This can be useful within the context of HTTP. At least
+// one write operation must happen to send the HTTP headers
+// to the peer.
+type WriteOnCloser struct {
+	io.Writer
+	hasWritten bool
+}
+
+func (w *WriteOnCloser) Write(p []byte) (int, error) {
+	w.hasWritten = true
+	return w.Writer.Write(p)
+}
+
+// Close closes the WriteOnCloser. It behaves like io.Closer.
+func (w *WriteOnCloser) Close() error {
+	if !w.hasWritten {
+		_, err := w.Write(nil)
+		if err != nil {
+			return err
+		}
+	}
+	if closer, ok := w.Writer.(io.Closer); ok {
+		return closer.Close()
+	}
+	return nil
+}
+
+// HasWritten returns true if at least one write operation was performed.
+func (w *WriteOnCloser) HasWritten() bool { return w.hasWritten }
+
+// WriteOnClose takes an io.Writer and returns an ioutil.WriteOnCloser.
+func WriteOnClose(w io.Writer) *WriteOnCloser {
+	return &WriteOnCloser{w, false}
+}
+
+type ioret struct {
+	n   int
+	err error
+}
+
+// DeadlineWriter deadline writer with context
+type DeadlineWriter struct {
+	io.WriteCloser
+	timeout time.Duration
+	err     error
+}
+
+// NewDeadlineWriter wraps a writer to make it respect given deadline
+// value per Write(). If there is a blocking write, the returned Writer
+// will return whenever the timer hits (the return values are n=0
+// and err=context.Canceled.)
+func NewDeadlineWriter(w io.WriteCloser, timeout time.Duration) io.WriteCloser {
+	return &DeadlineWriter{WriteCloser: w, timeout: timeout}
+}
+
+func (w *DeadlineWriter) Write(buf []byte) (int, error) {
+	if w.err != nil {
+		return 0, w.err
+	}
+
+	c := make(chan ioret, 1)
+	t := time.NewTimer(w.timeout)
+	defer t.Stop()
+
+	go func() {
+		n, err := w.WriteCloser.Write(buf)
+		c <- ioret{n, err}
+		close(c)
+	}()
+
+	select {
+	case r := <-c:
+		w.err = r.err
+		return r.n, r.err
+	case <-t.C:
+		w.err = context.Canceled
+		return 0, context.Canceled
+	}
+}
+
+// Close closer interface to close the underlying closer
+func (w *DeadlineWriter) Close() error {
+	return w.WriteCloser.Close()
+}
+
+// LimitWriter implements io.WriteCloser.
+//
+// This is implemented such that we want to restrict
+// an enscapsulated writer upto a certain length
+// and skip a certain number of bytes.
+type LimitWriter struct {
+	io.Writer
+	skipBytes int64
+	wLimit    int64
+}
+
+// Write implements the io.Writer interface limiting upto
+// configured length, also skips the first N bytes.
+func (w *LimitWriter) Write(p []byte) (n int, err error) {
+	n = len(p)
+	var n1 int
+	if w.skipBytes > 0 {
+		if w.skipBytes >= int64(len(p)) {
+			w.skipBytes = w.skipBytes - int64(len(p))
+			return n, nil
+		}
+		p = p[w.skipBytes:]
+		w.skipBytes = 0
+	}
+	if w.wLimit == 0 {
+		return n, nil
+	}
+	if w.wLimit < int64(len(p)) {
+		n1, err = w.Writer.Write(p[:w.wLimit])
+		w.wLimit = w.wLimit - int64(n1)
+		return n, err
+	}
+	n1, err = w.Writer.Write(p)
+	w.wLimit = w.wLimit - int64(n1)
+	return n, err
+}
+
+// Close closes the LimitWriter. It behaves like io.Closer.
+func (w *LimitWriter) Close() error {
+	if closer, ok := w.Writer.(io.Closer); ok {
+		return closer.Close()
+	}
+	return nil
+}
+
+// LimitedWriter takes an io.Writer and returns an ioutil.LimitWriter.
+func LimitedWriter(w io.Writer, skipBytes int64, limit int64) *LimitWriter {
+	return &LimitWriter{w, skipBytes, limit}
+}
+
+type nopCloser struct {
+	io.Writer
+}
+
+func (nopCloser) Close() error { return nil }
+
+// NopCloser returns a WriteCloser with a no-op Close method wrapping
+// the provided Writer w.
+func NopCloser(w io.Writer) io.WriteCloser {
+	return nopCloser{w}
+}
+
+// SkipReader skips a given number of bytes and then returns all
+// remaining data.
+type SkipReader struct {
+	io.Reader
+
+	skipCount int64
+}
+
+func (s *SkipReader) Read(p []byte) (int, error) {
+	l := int64(len(p))
+	if l == 0 {
+		return 0, nil
+	}
+	for s.skipCount > 0 {
+		if l > s.skipCount {
+			l = s.skipCount
+		}
+		n, err := s.Reader.Read(p[:l])
+		if err != nil {
+			return 0, err
+		}
+		s.skipCount -= int64(n)
+	}
+	return s.Reader.Read(p)
+}
+
+// NewSkipReader - creates a SkipReader
+func NewSkipReader(r io.Reader, n int64) io.Reader {
+	return &SkipReader{r, n}
+}
+
+// SameFile returns if the files are same.
+func SameFile(fi1, fi2 os.FileInfo) bool {
+	if !os.SameFile(fi1, fi2) {
+		return false
+	}
+	if !fi1.ModTime().Equal(fi2.ModTime()) {
+		return false
+	}
+	if fi1.Mode() != fi2.Mode() {
+		return false
+	}
+	if fi1.Size() != fi2.Size() {
+		return false
+	}
+	return true
+}
+
+// DirectIO alignment needs to be 4K. Defined here as
+// directio.AlignSize is defined as 0 in MacOS causing divide by 0 error.
+const directioAlignSize = 4096
+
+// CopyAligned - copies from reader to writer using the aligned input
+// buffer, it is expected that input buffer is page aligned to
+// 4K page boundaries. Without passing aligned buffer may cause
+// this function to return error.
+//
+// This code is similar in spirit to io.Copy but it is only to be
+// used with DIRECT I/O based file descriptor and it is expected that
+// input writer *os.File not a generic io.Writer. Make sure to have
+// the file opened for writes with syscall.O_DIRECT flag.
+func CopyAligned(w *os.File, r io.Reader, alignedBuf []byte, totalSize int64) (int64, error) {
+	// Writes remaining bytes in the buffer.
+	writeUnaligned := func(w *os.File, buf []byte) (remainingWritten int64, err error) {
+		// Disable O_DIRECT on fd's on unaligned buffer
+		// perform an amortized Fdatasync(fd) on the fd at
+		// the end, this is performed by the caller before
+		// closing 'w'.
+		if err = disk.DisableDirectIO(w); err != nil {
+			return remainingWritten, err
+		}
+		return io.Copy(w, bytes.NewReader(buf))
+	}
+
+	var written int64
+	for {
+		buf := alignedBuf
+		if totalSize != -1 {
+			remaining := totalSize - written
+			if remaining < int64(len(buf)) {
+				buf = buf[:remaining]
+			}
+		}
+		nr, err := io.ReadFull(r, buf)
+		eof := err == io.EOF || err == io.ErrUnexpectedEOF
+		if err != nil && !eof {
+			return written, err
+		}
+		buf = buf[:nr]
+		var nw int64
+		if len(buf)%directioAlignSize == 0 {
+			var n int
+			// buf is aligned for directio write()
+			n, err = w.Write(buf)
+			nw = int64(n)
+		} else {
+			// buf is not aligned, hence use writeUnaligned()
+			nw, err = writeUnaligned(w, buf)
+		}
+		if nw > 0 {
+			written += nw
+		}
+		if err != nil {
+			return written, err
+		}
+		if nw != int64(len(buf)) {
+			return written, io.ErrShortWrite
+		}
+
+		if totalSize != -1 {
+			if written == totalSize {
+				return written, nil
+			}
+		}
+		if eof {
+			return written, nil
+		}
+	}
+}

internal/ioutil/ioutil_test.go

@@ -0,0 +1,172 @@
+// Copyright (c) 2015-2021 MinIO, Inc.
+//
+// This file is part of MinIO Object Storage stack
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+package ioutil
+
+import (
+	"bytes"
+	"context"
+	"io"
+	goioutil "io/ioutil"
+	"os"
+	"testing"
+	"time"
+)
+
+type sleepWriter struct {
+	timeout time.Duration
+}
+
+func (w *sleepWriter) Write(p []byte) (n int, err error) {
+	time.Sleep(w.timeout)
+	return len(p), nil
+}
+
+func (w *sleepWriter) Close() error {
+	return nil
+}
+
+func TestDeadlineWriter(t *testing.T) {
+	w := NewDeadlineWriter(&sleepWriter{timeout: 500 * time.Millisecond}, 450*time.Millisecond)
+	_, err := w.Write([]byte("1"))
+	w.Close()
+	if err != context.Canceled {
+		t.Error("DeadlineWriter shouldn't be successful - should return context.Canceled")
+	}
+	_, err = w.Write([]byte("1"))
+	if err != context.Canceled {
+		t.Error("DeadlineWriter shouldn't be successful - should return context.Canceled")
+	}
+	w = NewDeadlineWriter(&sleepWriter{timeout: 100 * time.Millisecond}, 600*time.Millisecond)
+	n, err := w.Write([]byte("abcd"))
+	w.Close()
+	if err != nil {
+		t.Errorf("DeadlineWriter should succeed but failed with %s", err)
+	}
+	if n != 4 {
+		t.Errorf("DeadlineWriter should succeed but should have only written 4 bytes, but returned %d instead", n)
+	}
+}
+
+func TestCloseOnWriter(t *testing.T) {
+	writer := WriteOnClose(goioutil.Discard)
+	if writer.HasWritten() {
+		t.Error("WriteOnCloser must not be marked as HasWritten")
+	}
+	writer.Write(nil)
+	if !writer.HasWritten() {
+		t.Error("WriteOnCloser must be marked as HasWritten")
+	}
+
+	writer = WriteOnClose(goioutil.Discard)
+	writer.Close()
+	if !writer.HasWritten() {
+		t.Error("WriteOnCloser must be marked as HasWritten")
+	}
+}
+
+// Test for AppendFile.
+func TestAppendFile(t *testing.T) {
+	f, err := goioutil.TempFile("", "")
+	if err != nil {
+		t.Fatal(err)
+	}
+	name1 := f.Name()
+	defer os.Remove(name1)
+	f.WriteString("aaaaaaaaaa")
+	f.Close()
+
+	f, err = goioutil.TempFile("", "")
+	if err != nil {
+		t.Fatal(err)
+	}
+	name2 := f.Name()
+	defer os.Remove(name2)
+	f.WriteString("bbbbbbbbbb")
+	f.Close()
+
+	if err = AppendFile(name1, name2, false); err != nil {
+		t.Error(err)
+	}
+
+	b, err := goioutil.ReadFile(name1)
+	if err != nil {
+		t.Error(err)
+	}
+
+	expected := "aaaaaaaaaabbbbbbbbbb"
+	if string(b) != expected {
+		t.Errorf("AppendFile() failed, expected: %s, got %s", expected, string(b))
+	}
+}
+
+func TestSkipReader(t *testing.T) {
+	testCases := []struct {
+		src      io.Reader
+		skipLen  int64
+		expected string
+	}{
+		{bytes.NewBuffer([]byte("")), 0, ""},
+		{bytes.NewBuffer([]byte("")), 1, ""},
+		{bytes.NewBuffer([]byte("abc")), 0, "abc"},
+		{bytes.NewBuffer([]byte("abc")), 1, "bc"},
+		{bytes.NewBuffer([]byte("abc")), 2, "c"},
+		{bytes.NewBuffer([]byte("abc")), 3, ""},
+		{bytes.NewBuffer([]byte("abc")), 4, ""},
+	}
+	for i, testCase := range testCases {
+		r := NewSkipReader(testCase.src, testCase.skipLen)
+		b, err := goioutil.ReadAll(r)
+		if err != nil {
+			t.Errorf("Case %d: Unexpected err %v", i, err)
+		}
+		if string(b) != testCase.expected {
+			t.Errorf("Case %d: Got wrong result: %v", i, string(b))
+		}
+	}
+}
+
+func TestSameFile(t *testing.T) {
+	f, err := goioutil.TempFile("", "")
+	if err != nil {
+		t.Errorf("Error creating tmp file: %v", err)
+	}
+	tmpFile := f.Name()
+	f.Close()
+	defer os.Remove(f.Name())
+	fi1, err := os.Stat(tmpFile)
+	if err != nil {
+		t.Fatalf("Error Stat(): %v", err)
+	}
+	fi2, err := os.Stat(tmpFile)
+	if err != nil {
+		t.Fatalf("Error Stat(): %v", err)
+	}
+	if !SameFile(fi1, fi2) {
+		t.Fatal("Expected the files to be same")
+	}
+	if err = goioutil.WriteFile(tmpFile, []byte("aaa"), 0644); err != nil {
+		t.Fatal(err)
+	}
+	fi2, err = os.Stat(tmpFile)
+	if err != nil {
+		t.Fatalf("Error Stat(): %v", err)
+	}
+	if SameFile(fi1, fi2) {
+		t.Fatal("Expected the files not to be same")
+	}
+}

internal/ioutil/read_file.go

@@ -0,0 +1,39 @@
+// Copyright (c) 2015-2021 MinIO, Inc.
+//
+// This file is part of MinIO Object Storage stack
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+package ioutil
+
+import (
+	"io"
+	"os"
+)
+
+// ReadFile reads the named file and returns the contents.
+// A successful call returns err == nil, not err == EOF.
+// Because ReadFile reads the whole file, it does not treat an EOF from Read
+// as an error to be reported.
+//
+// passes NOATIME flag for reads on Unix systems to avoid atime updates.
+func ReadFile(name string) ([]byte, error) {
+	f, err := os.OpenFile(name, readMode, 0)
+	if err != nil {
+		return nil, err
+	}
+	defer f.Close()
+
+	return io.ReadAll(f)
+}

internal/ioutil/read_file_noatime_notsupported.go

@@ -0,0 +1,24 @@
+// +build windows darwin freebsd
+
+// Copyright (c) 2015-2021 MinIO, Inc.
+//
+// This file is part of MinIO Object Storage stack
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+package ioutil
+
+import "os"
+
+var readMode = os.O_RDONLY

internal/ioutil/read_file_noatime_supported.go

@@ -0,0 +1,26 @@
+// +build !windows,!darwin,!freebsd
+
+// Copyright (c) 2015-2021 MinIO, Inc.
+//
+// This file is part of MinIO Object Storage stack
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+package ioutil
+
+import (
+	"os"
+)
+
+var readMode = os.O_RDONLY | 0x40000 // read with O_NOATIME

internal/ioutil/wait_pipe.go

@@ -0,0 +1,64 @@
+// Copyright (c) 2015-2021 MinIO, Inc.
+//
+// This file is part of MinIO Object Storage stack
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+package ioutil
+
+import (
+	"io"
+	"sync"
+)
+
+// PipeWriter is similar to io.PipeWriter with wait group
+type PipeWriter struct {
+	*io.PipeWriter
+	done func()
+}
+
+// CloseWithError close with supplied error the writer end.
+func (w *PipeWriter) CloseWithError(err error) error {
+	err = w.PipeWriter.CloseWithError(err)
+	w.done()
+	return err
+}
+
+// PipeReader is similar to io.PipeReader with wait group
+type PipeReader struct {
+	*io.PipeReader
+	wait func()
+}
+
+// CloseWithError close with supplied error the reader end
+func (r *PipeReader) CloseWithError(err error) error {
+	err = r.PipeReader.CloseWithError(err)
+	r.wait()
+	return err
+}
+
+// WaitPipe implements wait-group backend io.Pipe to provide
+// synchronization between read() end with write() end.
+func WaitPipe() (*PipeReader, *PipeWriter) {
+	r, w := io.Pipe()
+	var wg sync.WaitGroup
+	wg.Add(1)
+	return &PipeReader{
+			PipeReader: r,
+			wait:       wg.Wait,
+		}, &PipeWriter{
+			PipeWriter: w,
+			done:       wg.Done,
+		}
+}