wehub-resource-sync
248 lines
8.4 KiB
Go
248 lines
8.4 KiB
Go
// Copyright 2019-2025 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 (
|
|
"bytes"
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"io"
|
|
"net"
|
|
"os"
|
|
"strconv"
|
|
"strings"
|
|
"sync/atomic"
|
|
"syscall"
|
|
"time"
|
|
|
|
"github.com/aws/aws-sdk-go-v2/aws"
|
|
"github.com/aws/aws-sdk-go-v2/service/s3"
|
|
"github.com/cenkalti/backoff/v4"
|
|
"golang.org/x/sync/errgroup"
|
|
)
|
|
|
|
// s3ObjectReader is a wrapper for S3 that gives us some nice to haves for reading objects from S3.
|
|
// TODO: Bring all the multipart upload and remote-conjoin stuff in.
|
|
type s3ObjectReader struct {
|
|
s3 S3APIV2
|
|
bucket string
|
|
readRl chan struct{}
|
|
ns string
|
|
}
|
|
|
|
// httpEndRangeHeader returns a string for the HTTP range header value (eg "bytes=-42") to retrieve the last |length| bytes
|
|
// of the object. Intended to be used with the |readRange| method, to set Range of request.
|
|
func httpEndRangeHeader(length int) string {
|
|
return fmt.Sprintf("%s=-%d", s3RangePrefix, length)
|
|
}
|
|
|
|
// httpRangeHeader returns a string for the HTTP range header value (eg "bytes=23-42") for a range starting at |off|
|
|
// with a length of |length|. Intended to be used with the |readRange| method, to set Range of request.
|
|
func httpRangeHeader(off, length int64) string {
|
|
lastByte := off + length - 1 // insanely, the HTTP range header specifies ranges inclusively.
|
|
return fmt.Sprintf("%s=%d-%d", s3RangePrefix, off, lastByte)
|
|
}
|
|
|
|
func (s3or *s3ObjectReader) key(name string) string {
|
|
if s3or.ns != "" {
|
|
return s3or.ns + "/" + name
|
|
}
|
|
return name
|
|
}
|
|
|
|
// ReadAt gets the named object, and reads |len(p)| bytes into |p| starting at |off|. The number of bytes read is returned,
|
|
// along with an error if one occurs.
|
|
func (s3or *s3ObjectReader) ReadAt(ctx context.Context, name string, p []byte, off int64, stats *Stats) (n int, err error) {
|
|
t1 := time.Now()
|
|
|
|
defer func() {
|
|
stats.S3BytesPerRead.Sample(uint64(len(p)))
|
|
stats.S3ReadLatency.SampleTimeSince(t1)
|
|
}()
|
|
|
|
n, _, err = s3or.readRange(ctx, name, p, httpRangeHeader(off, int64(len(p))))
|
|
return
|
|
}
|
|
|
|
// reader gets the full object from S3 as a ReadCloser. Useful when downloading the entire object.
|
|
func (s3or *s3ObjectReader) reader(ctx context.Context, name string) (io.ReadCloser, error) {
|
|
input := &s3.GetObjectInput{
|
|
Bucket: aws.String(s3or.bucket),
|
|
Key: aws.String(s3or.key(name)),
|
|
}
|
|
result, err := s3or.s3.GetObject(ctx, input)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return result.Body, nil
|
|
}
|
|
|
|
// readRange implements the raw calls to S3 for the purpose of reading a range of bytes from an |name| object. Contents
|
|
// are read into |p| and the range is specified as a string, which you should get using the |httpRangeHeader| function.
|
|
// The return value is the number of bytes |n| read and the total size |sz| of the object. The size of the object comes from the Content-Range
|
|
// HTTP header, and can be used if manually breaking of the file into range chunks
|
|
func (s3or *s3ObjectReader) readRange(ctx context.Context, name string, p []byte, rangeHeader string) (n int, sz uint64, err error) {
|
|
read := func() (int, uint64, error) {
|
|
if s3or.readRl != nil {
|
|
s3or.readRl <- struct{}{}
|
|
defer func() {
|
|
<-s3or.readRl
|
|
}()
|
|
}
|
|
|
|
input := &s3.GetObjectInput{
|
|
Bucket: aws.String(s3or.bucket),
|
|
Key: aws.String(s3or.key(name)),
|
|
Range: aws.String(rangeHeader),
|
|
}
|
|
|
|
result, err := s3or.s3.GetObject(ctx, input)
|
|
if err != nil {
|
|
return 0, 0, err
|
|
}
|
|
defer result.Body.Close()
|
|
|
|
if *result.ContentLength != int64(len(p)) {
|
|
return 0, 0, fmt.Errorf("failed to read entire range, key: %v, len(p): %d, rangeHeader: %s, ContentLength: %d", s3or.key(name), len(p), rangeHeader, *result.ContentLength)
|
|
}
|
|
|
|
sz := uint64(0)
|
|
if result.ContentRange != nil {
|
|
i := strings.Index(*result.ContentRange, "/")
|
|
if i != -1 {
|
|
sz, err = strconv.ParseUint((*result.ContentRange)[i+1:], 10, 64)
|
|
if err != nil {
|
|
return 0, 0, err
|
|
}
|
|
}
|
|
}
|
|
n, err = io.ReadFull(result.Body, p)
|
|
return n, sz, err
|
|
}
|
|
|
|
n, sz, err = read()
|
|
// We hit the point of diminishing returns investigating #3255, so add retries. In conversations with AWS people, it's not surprising to get transient failures when talking to S3, though SDKs are intended to have their own retrying. The issue may be that, in Go, making the S3 request and reading the data are separate operations, and the SDK kind of can't do its own retrying to handle failures in the latter.
|
|
if isConnReset(err) {
|
|
// We are backing off here because its possible and likely that the rate of requests to S3 is the underlying issue.
|
|
b := backoff.NewExponentialBackOff()
|
|
b.InitialInterval = 128 * time.Millisecond
|
|
b.MaxInterval = 1024 * time.Millisecond
|
|
b.Multiplier = 2
|
|
b.Reset()
|
|
|
|
for ; isConnReset(err); n, sz, err = read() {
|
|
dur := b.NextBackOff()
|
|
time.Sleep(dur)
|
|
}
|
|
}
|
|
|
|
return n, sz, err
|
|
}
|
|
|
|
// readS3ObjectFromEnd reads the last |len(p)| bytes of the named object into |p|. The number of bytes read is returned,
|
|
func (s3or *s3ObjectReader) readS3ObjectFromEnd(ctx context.Context, name string, p []byte, stats *Stats) (n int, sz uint64, err error) {
|
|
defer func(t1 time.Time) {
|
|
stats.S3BytesPerRead.Sample(uint64(len(p)))
|
|
stats.S3ReadLatency.SampleTimeSince(t1)
|
|
}(time.Now())
|
|
|
|
if len(p) > maxS3ReadFromEndReqSize {
|
|
totalN := uint64(0)
|
|
// If we're bigger than 256MB, parallelize the read...
|
|
// Read the last |footerSize| bytes to get the size of the file. We know that all table files are at least this big.
|
|
n, sz, err := s3or.readRange(ctx, name, p[len(p)-footerSize:], httpEndRangeHeader(footerSize))
|
|
if err != nil {
|
|
return 0, sz, err
|
|
}
|
|
totalN += uint64(n)
|
|
eg, egctx := errgroup.WithContext(ctx)
|
|
start := 0
|
|
for start < len(p)-footerSize {
|
|
// Make parallel read requests of up to 128MB.
|
|
end := start + preferredS3ReadFromEndReqSize
|
|
if end > len(p)-footerSize {
|
|
end = len(p) - footerSize
|
|
}
|
|
bs := p[start:end]
|
|
rangeStart := sz - uint64(len(p)) + uint64(start)
|
|
eg.Go(func() error {
|
|
n, _, err := s3or.readRange(egctx, name, bs, httpRangeHeader(int64(rangeStart), int64(len(bs))))
|
|
if err != nil {
|
|
return err
|
|
}
|
|
atomic.AddUint64(&totalN, uint64(n))
|
|
return nil
|
|
})
|
|
start = end
|
|
}
|
|
err = eg.Wait()
|
|
if err != nil {
|
|
return 0, 0, err
|
|
}
|
|
return int(totalN), sz, nil
|
|
} else {
|
|
return s3or.readRange(ctx, name, p, httpEndRangeHeader(len(p)))
|
|
}
|
|
}
|
|
|
|
// objectExistsInChunkSource returns true if the object exists in the chunk source, and it verifies that
|
|
// the object signatures matches the |name|. A |name| which ends in .darc indicates an archive file, otherwise
|
|
// we verify the Noms magic number. True is returned if the object is legitimate, and false with an error if not.
|
|
func (s3or *s3ObjectReader) objectExistsInChunkSource(ctx context.Context, name string, stats *Stats) (bool, error) {
|
|
magic := make([]byte, magicNumberSize)
|
|
n, _, err := s3or.readS3ObjectFromEnd(ctx, name, magic, stats)
|
|
if err != nil {
|
|
return false, err
|
|
}
|
|
if n != len(magic) {
|
|
return false, errors.New("failed to read all data")
|
|
}
|
|
|
|
if strings.HasSuffix(name, ArchiveFileSuffix) {
|
|
// dolt magic number is a version byte + DOLTARC. We ignore the version byte here.
|
|
return bytes.Equal(magic[magicNumberSize-doltMagicSize:], []byte(doltMagicNumber)), nil
|
|
} else {
|
|
return bytes.Equal(magic, []byte(magicNumber)), nil
|
|
}
|
|
}
|
|
|
|
func isConnReset(err error) bool {
|
|
nErr, ok := err.(*net.OpError)
|
|
if !ok {
|
|
return false
|
|
}
|
|
scErr, ok := nErr.Err.(*os.SyscallError)
|
|
return ok && scErr.Err == syscall.ECONNRESET
|
|
}
|
|
|
|
type s3ReaderAtWithStats struct {
|
|
rdr *s3ObjectReader
|
|
name string
|
|
}
|
|
|
|
func (s s3ReaderAtWithStats) ReadAtWithStats(ctx context.Context, p []byte, off int64, stats *Stats) (n int, err error) {
|
|
return s.rdr.ReadAt(ctx, s.name, p, off, stats)
|
|
}
|
|
|
|
var _ ReaderAtWithStats = s3ReaderAtWithStats{}
|