minio/pkg/storage/donut/fragment/fragment1/fragment.go

/*
 * Mini Object Storage, (C) 2015 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 fragment

import (
	"bytes"
	"encoding/binary"
	"errors"
	"io"

	"github.com/minio-io/minio/pkg/utils/checksum/crc32c"
	"github.com/minio-io/minio/pkg/utils/crypto/sha512"
)

/*

       DONUT v1 Spec
   **********************
   BlockStart      uint32              // Magic="MINI"=1229867341
   VersionMajor    uint32
   Reserved        uint64
   DataLen         uint64
   HeaderCrc32c    uint32
   BlockData       uint32              // Magic="DATA"=1096040772
   Data            io.Reader           // matches length
   HeaderCrc32c    uint32
   DataSha512      [64]byte
   BlockLen        uint64              // length of entire frame, inclusive of MINI and INIM
   BlockEnd        uint32              // Magic="INIM"=1296649801

*/

// Magic list
var (
	MagicMINI = binary.LittleEndian.Uint32([]byte{'M', 'I', 'N', 'I'})
	MagicDATA = binary.LittleEndian.Uint32([]byte{'D', 'A', 'T', 'A'})
	MagicINIM = binary.LittleEndian.Uint32([]byte{'I', 'N', 'I', 'M'})
)

// DonutFrameHeader -
// --------------
//   BlockStart      uint32
//   VersionMajor    uint32
//   Reserved        uint64
//   DataLen         uint64
// --------------
type DonutFrameHeader struct {
	MagicMINI  uint32
	Version    uint32
	Reserved   uint64
	DataLength uint64
}

// Crc32c checksum
type Crc32c uint32

// Sha512 checksum
type Sha512 [sha512.Size]byte

// DonutFrameFooter -
// --------------
//   DataSha512      [64]byte
//   BlockLen        uint64
//   BlockEnd        uint32
// --------------
type DonutFrameFooter struct {
	DataSha512   Sha512
	OffsetToMINI uint64
	MagicINIM    uint32
}

// Data buffer
type Data bytes.Buffer

// Write - write donut format to input io.Writer, returns error upon any failure
func Write(target io.Writer, reader io.Reader, length uint64) error {
	// write header
	header := DonutFrameHeader{
		MagicMINI:  MagicMINI,
		Version:    1,
		Reserved:   0,
		DataLength: length,
	}
	var headerBytes bytes.Buffer
	binary.Write(&headerBytes, binary.LittleEndian, header)
	headerCrc := crc32c.Sum32(headerBytes.Bytes())

	binary.Write(&headerBytes, binary.LittleEndian, headerCrc)
	binary.Write(&headerBytes, binary.LittleEndian, MagicDATA)
	// write header
	headerLen, err := io.Copy(target, &headerBytes)
	if err != nil {
		return err
	}
	// write DATA
	// create sha512 tee
	sumReader, sumWriter := io.Pipe()
	defer sumWriter.Close()
	checksumChannel := make(chan checksumValue)
	go generateChecksum(sumReader, checksumChannel)
	teeReader := io.TeeReader(reader, sumWriter)
	dataLength, err := io.Copy(target, teeReader)
	if err != nil {
		return err
	}
	if uint64(dataLength) != length {
		return errors.New("Specified data length and amount written mismatched")
	}
	sumWriter.Close()
	dataChecksum := <-checksumChannel
	if dataChecksum.err != nil {
		return dataChecksum.err
	}
	// generate footer
	frameFooter := DonutFrameFooter{
		DataSha512:   dataChecksum.checksum,
		OffsetToMINI: length + uint64(headerLen) + uint64(80), /*footer size*/
		MagicINIM:    MagicINIM,
	}
	var frameFooterBytes bytes.Buffer
	binary.Write(&frameFooterBytes, binary.LittleEndian, frameFooter)
	// write footer crc
	footerChecksum := crc32c.Sum32(frameFooterBytes.Bytes())
	if err := binary.Write(target, binary.LittleEndian, footerChecksum); err != nil {
		return err
	}
	// write write footer
	_, err = io.Copy(target, &frameFooterBytes)
	if err != nil {
		return err
	}
	return nil
}

// Reads a donut fragment
func Read(reader io.Reader) (io.Reader, error) {
	header, err := ReadHeader(reader)
	if err != nil {
		return nil, err
	}

	sumReader, sumWriter := io.Pipe()

	teeReader := io.TeeReader(reader, sumWriter)

	defer sumWriter.Close()
	checksumChannel := make(chan checksumValue)
	go generateChecksum(sumReader, checksumChannel)

	data := make([]byte, header.DataLength)
	teeReader.Read(data)
	sumWriter.Close()

	// read crc
	footerBuffer := make([]byte, 80)
	reader.Read(footerBuffer)
	expectedCrc := binary.LittleEndian.Uint32(footerBuffer[:4])

	actualCrc := crc32c.Sum32(footerBuffer[4:])
	if expectedCrc != actualCrc {
		// TODO perhaps we should return data and still report error?
		return nil, errors.New("Expected CRC doesn't match for footer")
	}

	footer := DonutFrameFooter{}
	err = binary.Read(bytes.NewBuffer(footerBuffer[4:]), binary.LittleEndian, &footer)
	if err != nil {
		return nil, err
	}

	return bytes.NewBuffer(data), nil
}

// Reads the header of a donut
func ReadHeader(reader io.Reader) (header DonutFrameHeader, err error) {
	headerSlice := make([]byte, 32)
	headerLength, err := reader.Read(headerSlice)
	if err != nil {
		return header, err
	}
	if headerLength != 32 {
		return header, errors.New("EOF found while reading donut header")
	}
	actualCrc := crc32c.Sum32(headerSlice[:24])

	expectedCrc := binary.LittleEndian.Uint32(headerSlice[24:28])

	if actualCrc != expectedCrc {
		return header, errors.New("CRC for donut did not match")
	}

	err = binary.Read(bytes.NewBuffer(headerSlice[0:24]), binary.LittleEndian, &header)

	return header, nil
}

type checksumValue struct {
	checksum Sha512
	err      error
}

func generateChecksum(reader io.Reader, c chan<- checksumValue) {
	checksum, err := sha512.SumStream(reader)
	result := checksumValue{
		checksum: checksum,
		err:      err,
	}
	c <- result
}