github.com/hasnat/dolt/go@v0.0.0-20210628190320-9eb5d843fbb7/store/nbs/mmap_table_reader.go

// Copyright 2019 Dolthub, 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.
//
// This file incorporates work covered by the following copyright and
// permission notice:
//
// Copyright 2016 Attic Labs, Inc. All rights reserved.
// Licensed under the Apache License, version 2.0:
// http://www.apache.org/licenses/LICENSE-2.0

package nbs

import (
	"context"
	"errors"
	"fmt"
	"io"
	"math"
	"os"
	"path/filepath"
	"strconv"
	"time"

	"github.com/dolthub/mmap-go"
)

type mmapTableReader struct {
	tableReader
	fc *fdCache
	h  addr
}

const (
	fileBlockSize = 1 << 12
)

var (
	maxInt = int64(math.MaxInt64)
)

func init() {
	if strconv.IntSize == 32 {
		maxInt = math.MaxInt32
	}
}

func newMmapTableReader(dir string, h addr, chunkCount uint32, indexCache *indexCache, fc *fdCache) (cs chunkSource, err error) {
	path := filepath.Join(dir, h.String())

	var index onHeapTableIndex
	found := false
	if indexCache != nil {
		indexCache.lockEntry(h)
		defer func() {
			unlockErr := indexCache.unlockEntry(h)

			if err == nil {
				err = unlockErr
			}
		}()
		index, found = indexCache.get(h)
	}

	if !found {
		f := func() (ti onHeapTableIndex, err error) {
			var f *os.File
			f, err = fc.RefFile(path)

			if err != nil {
				return
			}

			defer func() {
				unrefErr := fc.UnrefFile(path)

				if unrefErr != nil {
					err = unrefErr
				}
			}()

			var fi os.FileInfo
			fi, err = f.Stat()

			if err != nil {
				return
			}

			if fi.Size() < 0 {
				// Size returns the number of bytes for regular files and is system dependant for others (Some of which can be negative).
				err = fmt.Errorf("%s has invalid size: %d", path, fi.Size())
				return
			}

			// index. Mmap won't take an offset that's not page-aligned, so find the nearest page boundary preceding the index.
			indexOffset := fi.Size() - int64(footerSize) - int64(indexSize(chunkCount))
			aligned := indexOffset / mmapAlignment * mmapAlignment // Thanks, integer arithmetic!

			if fi.Size()-aligned > maxInt {
				err = fmt.Errorf("%s - size: %d alignment: %d> maxInt: %d", path, fi.Size(), aligned, maxInt)
				return
			}

			var mm mmap.MMap
			mm, err = mmap.MapRegion(f, int(fi.Size()-aligned), mmap.RDONLY, 0, aligned)

			if err != nil {
				return
			}

			defer func() {
				unmapErr := mm.Unmap()

				if unmapErr != nil {
					err = unmapErr
				}
			}()

			buff := []byte(mm)
			ti, err = parseTableIndex(buff[indexOffset-aligned:])

			if err != nil {
				return
			}

			if indexCache != nil {
				indexCache.put(h, ti)
			}

			return
		}

		var err error
		index, err = f()

		if err != nil {
			return nil, err
		}
	}

	if chunkCount != index.chunkCount {
		return nil, errors.New("unexpected chunk count")
	}

	return &mmapTableReader{
		newTableReader(index, &cacheReaderAt{path, fc}, fileBlockSize),
		fc,
		h,
	}, nil
}

func (mmtr *mmapTableReader) hash() (addr, error) {
	return mmtr.h, nil
}

func (mmtr *mmapTableReader) Close() error {
	return mmtr.tableReader.Close()
}

func (mmtr *mmapTableReader) Clone() chunkSource {
	return &mmapTableReader{mmtr.tableReader.Clone(), mmtr.fc, mmtr.h}
}

type cacheReaderAt struct {
	path string
	fc   *fdCache
}

func (cra *cacheReaderAt) ReadAtWithStats(ctx context.Context, p []byte, off int64, stats *Stats) (n int, err error) {
	var r io.ReaderAt
	t1 := time.Now()

	if r, err = cra.fc.RefFile(cra.path); err != nil {
		return
	}

	defer func() {
		stats.FileBytesPerRead.Sample(uint64(len(p)))
		stats.FileReadLatency.SampleTimeSince(t1)
	}()

	defer func() {
		unrefErr := cra.fc.UnrefFile(cra.path)

		if err == nil {
			err = unrefErr
		}
	}()

	return r.ReadAt(p, off)
}