Skip to content

Commit

Permalink
feat(storage/transfermanager): automatically shard downloads (#10379)
Browse files Browse the repository at this point in the history
This is missing a few components that should be added in follow ups:
- checksums
- transcoding test
  • Loading branch information
BrennaEpp authored Jun 25, 2024
1 parent 9ac350d commit 05816f9
Show file tree
Hide file tree
Showing 7 changed files with 987 additions and 163 deletions.
71 changes: 71 additions & 0 deletions storage/transfermanager/download_buffer.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
// Copyright 2024 Google LLC
//
// 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 transfermanager

import (
"sync"
)

// NewDownloadBuffer initializes a DownloadBuffer using buf as the underlying
// buffer. Preferred way to create a DownloadBuffer as it does not need to grow
// the buffer if len(buf) is larger than or equal to the object length or range
// being downloaded to.
func NewDownloadBuffer(buf []byte) *DownloadBuffer {
return &DownloadBuffer{bytes: buf}
}

// DownloadBuffer satisfies the io.WriterAt interface, allowing you to use it as
// a buffer to download to when using [Downloader]. DownloadBuffer is thread-safe
// as long as the ranges being written to do not overlap.
type DownloadBuffer struct {
bytes []byte
mu sync.Mutex
}

// WriteAt writes len(p) bytes from p to the underlying buffer at offset off,
// growing the buffer if needed. It returns the number of bytes written from p
// and any error encountered that caused the write to stop early.
// WriteAt is thread-safe as long as the ranges being written to do not overlap.
// The supplied slice p is not retained.
func (db *DownloadBuffer) WriteAt(p []byte, off int64) (n int, err error) {
requiredLength := int64(len(p)) + off

// Our buffer isn't big enough, let's grow it.
if int64(cap(db.bytes)) < requiredLength {
expandedBuff := make([]byte, requiredLength)

db.mu.Lock()
copy(expandedBuff, db.bytes)
db.bytes = expandedBuff
} else {
db.mu.Lock()
}

// Buffer should now have the capacity to hold the new bytes, if it didn't
// before, so we can copy directly to it.
copy(db.bytes[off:], p)
db.mu.Unlock()

return len(p), nil
}

// Bytes returns the slice of bytes written to DownloadBuffer. The slice aliases
// the buffer content at least until the next buffer modification, so
// immediate changes to the slice will affect the result of future reads.
func (db *DownloadBuffer) Bytes() []byte {
db.mu.Lock()
defer db.mu.Unlock()
return db.bytes
}
Loading

0 comments on commit 05816f9

Please sign in to comment.