server: Move all the top level files into cmd folder. (#2490)

This change brings a change which was done for the 'mc' package to allow for clean repo and have a cleaner github drop in experience.
2026-08-09 07:43:29 +03:00 · 2016-08-18 16:23:42 -07:00
parent 73d1a46f3e
commit bccf549463
187 changed files with 425 additions and 419 deletions
@@ -0,0 +1,366 @@
+/*
+ * Minio Cloud Storage, (C) 2016 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 (
+	"encoding/json"
+	"path"
+	"sort"
+	"sync"
+	"time"
+)
+
+const (
+	// Erasure related constants.
+	erasureAlgorithmKlauspost = "klauspost/reedsolomon/vandermonde"
+)
+
+// objectPartInfo Info of each part kept in the multipart metadata
+// file after CompleteMultipartUpload() is called.
+type objectPartInfo struct {
+	Number int    `json:"number"`
+	Name   string `json:"name"`
+	ETag   string `json:"etag"`
+	Size   int64  `json:"size"`
+}
+
+// byObjectPartNumber is a collection satisfying sort.Interface.
+type byObjectPartNumber []objectPartInfo
+
+func (t byObjectPartNumber) Len() int           { return len(t) }
+func (t byObjectPartNumber) Swap(i, j int)      { t[i], t[j] = t[j], t[i] }
+func (t byObjectPartNumber) Less(i, j int) bool { return t[i].Number < t[j].Number }
+
+// checkSumInfo - carries checksums of individual scattered parts per disk.
+type checkSumInfo struct {
+	Name      string `json:"name"`
+	Algorithm string `json:"algorithm"`
+	Hash      string `json:"hash"`
+}
+
+// Constant indicates current bit-rot algo used when creating objects.
+const (
+	bitRotAlgo = "blake2b"
+)
+
+// erasureInfo - carries erasure coding related information, block
+// distribution and checksums.
+type erasureInfo struct {
+	Algorithm    string         `json:"algorithm"`
+	DataBlocks   int            `json:"data"`
+	ParityBlocks int            `json:"parity"`
+	BlockSize    int64          `json:"blockSize"`
+	Index        int            `json:"index"`
+	Distribution []int          `json:"distribution"`
+	Checksum     []checkSumInfo `json:"checksum,omitempty"`
+}
+
+// AddCheckSum - add checksum of a part.
+func (e *erasureInfo) AddCheckSumInfo(ckSumInfo checkSumInfo) {
+	for i, sum := range e.Checksum {
+		if sum.Name == ckSumInfo.Name {
+			e.Checksum[i] = ckSumInfo
+			return
+		}
+	}
+	e.Checksum = append(e.Checksum, ckSumInfo)
+}
+
+// GetCheckSumInfo - get checksum of a part.
+func (e erasureInfo) GetCheckSumInfo(partName string) (ckSum checkSumInfo, err error) {
+	// Return the checksum.
+	for _, sum := range e.Checksum {
+		if sum.Name == partName {
+			return sum, nil
+		}
+	}
+	return checkSumInfo{}, errUnexpected
+}
+
+// statInfo - carries stat information of the object.
+type statInfo struct {
+	Size    int64     `json:"size"`    // Size of the object `xl.json`.
+	ModTime time.Time `json:"modTime"` // ModTime of the object `xl.json`.
+}
+
+// A xlMetaV1 represents `xl.json` metadata header.
+type xlMetaV1 struct {
+	Version string   `json:"version"` // Version of the current `xl.json`.
+	Format  string   `json:"format"`  // Format of the current `xl.json`.
+	Stat    statInfo `json:"stat"`    // Stat of the current object `xl.json`.
+	// Erasure coded info for the current object `xl.json`.
+	Erasure erasureInfo `json:"erasure"`
+	// Minio release tag for current object `xl.json`.
+	Minio struct {
+		Release string `json:"release"`
+	} `json:"minio"`
+	// Metadata map for current object `xl.json`.
+	Meta map[string]string `json:"meta,omitempty"`
+	// Captures all the individual object `xl.json`.
+	Parts []objectPartInfo `json:"parts,omitempty"`
+}
+
+// newXLMetaV1 - initializes new xlMetaV1, adds version, allocates a fresh erasure info.
+func newXLMetaV1(object string, dataBlocks, parityBlocks int) (xlMeta xlMetaV1) {
+	xlMeta = xlMetaV1{}
+	xlMeta.Version = "1.0.0"
+	xlMeta.Format = "xl"
+	xlMeta.Minio.Release = ReleaseTag
+	xlMeta.Erasure = erasureInfo{
+		Algorithm:    erasureAlgorithmKlauspost,
+		DataBlocks:   dataBlocks,
+		ParityBlocks: parityBlocks,
+		BlockSize:    blockSizeV1,
+		Distribution: hashOrder(object, dataBlocks+parityBlocks),
+	}
+	return xlMeta
+}
+
+// IsValid - tells if the format is sane by validating the version
+// string and format style.
+func (m xlMetaV1) IsValid() bool {
+	return m.Version == "1.0.0" && m.Format == "xl"
+}
+
+// ObjectPartIndex - returns the index of matching object part number.
+func (m xlMetaV1) ObjectPartIndex(partNumber int) (index int) {
+	for i, part := range m.Parts {
+		if partNumber == part.Number {
+			index = i
+			return index
+		}
+	}
+	return -1
+}
+
+// AddObjectPart - add a new object part in order.
+func (m *xlMetaV1) AddObjectPart(partNumber int, partName string, partETag string, partSize int64) {
+	partInfo := objectPartInfo{
+		Number: partNumber,
+		Name:   partName,
+		ETag:   partETag,
+		Size:   partSize,
+	}
+
+	// Update part info if it already exists.
+	for i, part := range m.Parts {
+		if partNumber == part.Number {
+			m.Parts[i] = partInfo
+			return
+		}
+	}
+
+	// Proceed to include new part info.
+	m.Parts = append(m.Parts, partInfo)
+
+	// Parts in xlMeta should be in sorted order by part number.
+	sort.Sort(byObjectPartNumber(m.Parts))
+}
+
+// ObjectToPartOffset - translate offset of an object to offset of its individual part.
+func (m xlMetaV1) ObjectToPartOffset(offset int64) (partIndex int, partOffset int64, err error) {
+	if offset == 0 {
+		// Special case - if offset is 0, then partIndex and partOffset are always 0.
+		return 0, 0, nil
+	}
+	partOffset = offset
+	// Seek until object offset maps to a particular part offset.
+	for i, part := range m.Parts {
+		partIndex = i
+		// Offset is smaller than size we have reached the proper part offset.
+		if partOffset < part.Size {
+			return partIndex, partOffset, nil
+		}
+		// Continue to towards the next part.
+		partOffset -= part.Size
+	}
+	// Offset beyond the size of the object return InvalidRange.
+	return 0, 0, InvalidRange{}
+}
+
+// pickValidXLMeta - picks one valid xlMeta content and returns from a
+// slice of xlmeta content. If no value is found this function panics
+// and dies.
+func pickValidXLMeta(metaArr []xlMetaV1, modTime time.Time) xlMetaV1 {
+	// Pick latest valid metadata.
+	for _, meta := range metaArr {
+		if meta.IsValid() && meta.Stat.ModTime == modTime {
+			return meta
+		}
+	}
+	panic("Unable to look for valid XL metadata content")
+}
+
+// list of all errors that can be ignored in a metadata operation.
+var objMetadataOpIgnoredErrs = []error{
+	errDiskNotFound,
+	errDiskAccessDenied,
+	errFaultyDisk,
+	errVolumeNotFound,
+	errFileAccessDenied,
+	errFileNotFound,
+}
+
+// readXLMetadata - returns the object metadata `xl.json` content from
+// one of the disks picked at random.
+func (xl xlObjects) readXLMetadata(bucket, object string) (xlMeta xlMetaV1, err error) {
+	for _, disk := range xl.getLoadBalancedDisks() {
+		if disk == nil {
+			continue
+		}
+		xlMeta, err = readXLMeta(disk, bucket, object)
+		if err == nil {
+			return xlMeta, nil
+		}
+		// For any reason disk or bucket is not available continue
+		// and read from other disks.
+		if isErrIgnored(err, objMetadataOpIgnoredErrs) {
+			continue
+		}
+		break
+	}
+	// Return error here.
+	return xlMetaV1{}, err
+}
+
+// deleteXLMetadata - deletes `xl.json` on a single disk.
+func deleteXLMetdata(disk StorageAPI, bucket, prefix string) error {
+	jsonFile := path.Join(prefix, xlMetaJSONFile)
+	return disk.DeleteFile(bucket, jsonFile)
+}
+
+// writeXLMetadata - writes `xl.json` to a single disk.
+func writeXLMetadata(disk StorageAPI, bucket, prefix string, xlMeta xlMetaV1) error {
+	jsonFile := path.Join(prefix, xlMetaJSONFile)
+
+	// Marshal json.
+	metadataBytes, err := json.Marshal(&xlMeta)
+	if err != nil {
+		return err
+	}
+	// Persist marshalled data.
+	return disk.AppendFile(bucket, jsonFile, metadataBytes)
+}
+
+// deleteAllXLMetadata - deletes all partially written `xl.json` depending on errs.
+func deleteAllXLMetadata(disks []StorageAPI, bucket, prefix string, errs []error) {
+	var wg = &sync.WaitGroup{}
+	// Delete all the `xl.json` left over.
+	for index, disk := range disks {
+		if disk == nil {
+			continue
+		}
+		// Undo rename object in parallel.
+		wg.Add(1)
+		go func(index int, disk StorageAPI) {
+			defer wg.Done()
+			if errs[index] != nil {
+				return
+			}
+			_ = deleteXLMetdata(disk, bucket, prefix)
+		}(index, disk)
+	}
+	wg.Wait()
+}
+
+// writeUniqueXLMetadata - writes unique `xl.json` content for each disk in order.
+func writeUniqueXLMetadata(disks []StorageAPI, bucket, prefix string, xlMetas []xlMetaV1, quorum int) error {
+	var wg = &sync.WaitGroup{}
+	var mErrs = make([]error, len(disks))
+
+	// Start writing `xl.json` to all disks in parallel.
+	for index, disk := range disks {
+		if disk == nil {
+			mErrs[index] = errDiskNotFound
+			continue
+		}
+		wg.Add(1)
+		// Write `xl.json` in a routine.
+		go func(index int, disk StorageAPI) {
+			defer wg.Done()
+
+			// Pick one xlMeta for a disk at index.
+			xlMetas[index].Erasure.Index = index + 1
+
+			// Write unique `xl.json` for a disk at index.
+			err := writeXLMetadata(disk, bucket, prefix, xlMetas[index])
+			if err != nil {
+				mErrs[index] = err
+			}
+		}(index, disk)
+	}
+
+	// Wait for all the routines.
+	wg.Wait()
+
+	// Do we have write quorum?.
+	if !isDiskQuorum(mErrs, quorum) {
+		// Delete all `xl.json` successfully renamed.
+		deleteAllXLMetadata(disks, bucket, prefix, mErrs)
+		return errXLWriteQuorum
+	}
+
+	return reduceErrs(mErrs, []error{
+		errDiskNotFound,
+		errFaultyDisk,
+		errDiskAccessDenied,
+	})
+}
+
+// writeSameXLMetadata - write `xl.json` on all disks in order.
+func writeSameXLMetadata(disks []StorageAPI, bucket, prefix string, xlMeta xlMetaV1, writeQuorum, readQuorum int) error {
+	var wg = &sync.WaitGroup{}
+	var mErrs = make([]error, len(disks))
+
+	// Start writing `xl.json` to all disks in parallel.
+	for index, disk := range disks {
+		if disk == nil {
+			mErrs[index] = errDiskNotFound
+			continue
+		}
+		wg.Add(1)
+		// Write `xl.json` in a routine.
+		go func(index int, disk StorageAPI, metadata xlMetaV1) {
+			defer wg.Done()
+
+			// Save the disk order index.
+			metadata.Erasure.Index = index + 1
+
+			// Write xl metadata.
+			err := writeXLMetadata(disk, bucket, prefix, metadata)
+			if err != nil {
+				mErrs[index] = err
+			}
+		}(index, disk, xlMeta)
+	}
+
+	// Wait for all the routines.
+	wg.Wait()
+
+	// Do we have write Quorum?.
+	if !isDiskQuorum(mErrs, writeQuorum) {
+		// Delete all `xl.json` successfully renamed.
+		deleteAllXLMetadata(disks, bucket, prefix, mErrs)
+		return errXLWriteQuorum
+	}
+
+	return reduceErrs(mErrs, []error{
+		errDiskNotFound,
+		errFaultyDisk,
+		errDiskAccessDenied,
+	})
+}