610 lines
16 KiB
Go
610 lines
16 KiB
Go
package tq
|
|
|
|
import (
|
|
"sort"
|
|
"sync"
|
|
|
|
"github.com/git-lfs/git-lfs/api"
|
|
"github.com/git-lfs/git-lfs/config"
|
|
"github.com/git-lfs/git-lfs/errors"
|
|
"github.com/git-lfs/git-lfs/progress"
|
|
"github.com/rubyist/tracerx"
|
|
)
|
|
|
|
const (
|
|
defaultBatchSize = 100
|
|
)
|
|
|
|
type retryCounter struct {
|
|
MaxRetries int `git:"lfs.transfer.maxretries"`
|
|
|
|
// cmu guards count
|
|
cmu sync.Mutex
|
|
// count maps OIDs to number of retry attempts
|
|
count map[string]int
|
|
}
|
|
|
|
// newRetryCounter instantiates a new *retryCounter. It parses the gitconfig
|
|
// value: `lfs.transfer.maxretries`, and falls back to defaultMaxRetries if none
|
|
// was provided.
|
|
//
|
|
// If it encountered an error in Unmarshaling the *config.Configuration, it will
|
|
// be returned, otherwise nil.
|
|
func newRetryCounter() *retryCounter {
|
|
return &retryCounter{
|
|
MaxRetries: defaultMaxRetries,
|
|
count: make(map[string]int),
|
|
}
|
|
}
|
|
|
|
// Increment increments the number of retries for a given OID. It is safe to
|
|
// call across multiple goroutines.
|
|
func (r *retryCounter) Increment(oid string) {
|
|
r.cmu.Lock()
|
|
defer r.cmu.Unlock()
|
|
|
|
r.count[oid]++
|
|
}
|
|
|
|
// CountFor returns the current number of retries for a given OID. It is safe to
|
|
// call across multiple goroutines.
|
|
func (r *retryCounter) CountFor(oid string) int {
|
|
r.cmu.Lock()
|
|
defer r.cmu.Unlock()
|
|
|
|
return r.count[oid]
|
|
}
|
|
|
|
// CanRetry returns the current number of retries, and whether or not it exceeds
|
|
// the maximum number of retries (see: retryCounter.MaxRetries).
|
|
func (r *retryCounter) CanRetry(oid string) (int, bool) {
|
|
count := r.CountFor(oid)
|
|
return count, count < r.MaxRetries
|
|
}
|
|
|
|
// Batch implements the sort.Interface interface and enables sorting on a slice
|
|
// of `*Transfer`s by object size.
|
|
//
|
|
// This interface is implemented here so that the largest objects can be
|
|
// processed first. Since adding a new batch is unable to occur until the
|
|
// current batch has finished processing, this enables us to reduce the risk of
|
|
// a single worker getting tied up on a large item at the end of a batch while
|
|
// all other workers are sitting idle.
|
|
type Batch []*objectTuple
|
|
|
|
func (b Batch) ApiObjects() []*api.ObjectResource {
|
|
transfers := make([]*api.ObjectResource, 0, len(b))
|
|
for _, t := range b {
|
|
transfers = append(transfers, tupleToApiObject(t))
|
|
}
|
|
|
|
return transfers
|
|
}
|
|
|
|
func tupleToApiObject(t *objectTuple) *api.ObjectResource {
|
|
return &api.ObjectResource{Oid: t.Oid, Size: t.Size}
|
|
}
|
|
|
|
func (b Batch) Len() int { return len(b) }
|
|
func (b Batch) Less(i, j int) bool { return b[i].Size < b[j].Size }
|
|
func (b Batch) Swap(i, j int) { b[i], b[j] = b[j], b[i] }
|
|
|
|
// TransferQueue organises the wider process of uploading and downloading,
|
|
// including calling the API, passing the actual transfer request to transfer
|
|
// adapters, and dealing with progress, errors and retries.
|
|
type TransferQueue struct {
|
|
direction Direction
|
|
adapter Adapter
|
|
adapterInProgress bool
|
|
adapterInitMutex sync.Mutex
|
|
dryRun bool
|
|
meter progress.Meter
|
|
errors []error
|
|
transfers map[string]*objectTuple
|
|
batchSize int
|
|
bufferDepth int
|
|
// Channel for processing (and buffering) incoming items
|
|
incoming chan *objectTuple
|
|
errorc chan error // Channel for processing errors
|
|
watchers []chan string
|
|
trMutex *sync.Mutex
|
|
startProgress sync.Once
|
|
collectorWait sync.WaitGroup
|
|
errorwait sync.WaitGroup
|
|
// wait is used to keep track of pending transfers. It is incremented
|
|
// once per unique OID on Add(), and is decremented when that transfer
|
|
// is marked as completed or failed, but not retried.
|
|
wait sync.WaitGroup
|
|
manifest *Manifest
|
|
rc *retryCounter
|
|
}
|
|
|
|
type objectTuple struct {
|
|
Name, Path, Oid string
|
|
Size int64
|
|
}
|
|
|
|
type Option func(*TransferQueue)
|
|
|
|
func DryRun(dryRun bool) Option {
|
|
return func(tq *TransferQueue) {
|
|
tq.dryRun = dryRun
|
|
}
|
|
}
|
|
|
|
func WithProgress(m progress.Meter) Option {
|
|
return func(tq *TransferQueue) {
|
|
tq.meter = m
|
|
}
|
|
}
|
|
|
|
func WithBatchSize(size int) Option {
|
|
return func(tq *TransferQueue) { tq.batchSize = size }
|
|
}
|
|
|
|
func WithBufferDepth(depth int) Option {
|
|
return func(tq *TransferQueue) { tq.bufferDepth = depth }
|
|
}
|
|
|
|
// NewTransferQueue builds a TransferQueue, direction and underlying mechanism determined by adapter
|
|
func NewTransferQueue(dir Direction, manifest *Manifest, options ...Option) *TransferQueue {
|
|
q := &TransferQueue{
|
|
direction: dir,
|
|
errorc: make(chan error),
|
|
transfers: make(map[string]*objectTuple),
|
|
trMutex: &sync.Mutex{},
|
|
manifest: manifest,
|
|
rc: newRetryCounter(),
|
|
}
|
|
|
|
for _, opt := range options {
|
|
opt(q)
|
|
}
|
|
|
|
q.rc.MaxRetries = q.manifest.maxRetries
|
|
|
|
if q.batchSize <= 0 {
|
|
q.batchSize = defaultBatchSize
|
|
}
|
|
if q.bufferDepth <= 0 {
|
|
q.bufferDepth = q.batchSize
|
|
}
|
|
|
|
q.incoming = make(chan *objectTuple, q.bufferDepth)
|
|
|
|
if q.meter == nil {
|
|
q.meter = progress.Noop()
|
|
}
|
|
|
|
q.collectorWait.Add(1)
|
|
q.errorwait.Add(1)
|
|
q.run()
|
|
|
|
return q
|
|
}
|
|
|
|
// Add adds a *Transfer to the transfer queue. It only increments the amount
|
|
// of waiting the TransferQueue has to do if the *Transfer "t" is new.
|
|
func (q *TransferQueue) Add(name, path, oid string, size int64) {
|
|
t := &objectTuple{
|
|
Name: name,
|
|
Path: path,
|
|
Oid: oid,
|
|
Size: size,
|
|
}
|
|
|
|
if isNew := q.remember(t); !isNew {
|
|
tracerx.Printf("already transferring %q, skipping duplicate", t.Oid)
|
|
return
|
|
}
|
|
|
|
q.incoming <- t
|
|
}
|
|
|
|
// remember remembers the *Transfer "t" if the *TransferQueue doesn't already
|
|
// know about a Transfer with the same OID.
|
|
//
|
|
// It returns if the value is new or not.
|
|
func (q *TransferQueue) remember(t *objectTuple) bool {
|
|
q.trMutex.Lock()
|
|
defer q.trMutex.Unlock()
|
|
|
|
if _, ok := q.transfers[t.Oid]; !ok {
|
|
q.wait.Add(1)
|
|
q.transfers[t.Oid] = t
|
|
|
|
return true
|
|
}
|
|
return false
|
|
}
|
|
|
|
// collectBatches collects batches in a loop, prioritizing failed items from the
|
|
// previous before adding new items. The process works as follows:
|
|
//
|
|
// 1. Create a new batch, of size `q.batchSize`, and containing no items
|
|
// 2. While the batch contains less items than `q.batchSize` AND the channel
|
|
// is open, read one item from the `q.incoming` channel.
|
|
// a. If the read was a channel close, go to step 4.
|
|
// b. If the read was a TransferTransferable item, go to step 3.
|
|
// 3. Append the item to the batch.
|
|
// 4. Sort the batch by descending object size, make a batch API call, send
|
|
// the items to the `*adapterBase`.
|
|
// 5. Process the worker results, incrementing and appending retries if
|
|
// possible.
|
|
// 6. If the `q.incoming` channel is open, go to step 2.
|
|
// 7. If the next batch is empty AND the `q.incoming` channel is closed,
|
|
// terminate immediately.
|
|
//
|
|
// collectBatches runs in its own goroutine.
|
|
func (q *TransferQueue) collectBatches() {
|
|
defer q.collectorWait.Done()
|
|
|
|
var closing bool
|
|
batch := q.makeBatch()
|
|
|
|
for {
|
|
for !closing && (len(batch) < q.batchSize) {
|
|
t, ok := <-q.incoming
|
|
if !ok {
|
|
closing = true
|
|
break
|
|
}
|
|
|
|
batch = append(batch, t)
|
|
}
|
|
|
|
// Before enqueuing the next batch, sort by descending object
|
|
// size.
|
|
sort.Sort(sort.Reverse(batch))
|
|
|
|
retries, err := q.enqueueAndCollectRetriesFor(batch)
|
|
if err != nil {
|
|
q.errorc <- err
|
|
}
|
|
|
|
if closing && len(retries) == 0 {
|
|
break
|
|
}
|
|
|
|
batch = retries
|
|
}
|
|
}
|
|
|
|
// enqueueAndCollectRetriesFor makes a Batch API call and returns a "next" batch
|
|
// containing all of the objects that failed from the previous batch and had
|
|
// retries availale to them.
|
|
//
|
|
// If an error was encountered while making the API request, _all_ of the items
|
|
// from the previous batch (that have retries available to them) will be
|
|
// returned immediately, along with the error that was encountered.
|
|
//
|
|
// enqueueAndCollectRetriesFor blocks until the entire Batch "batch" has been
|
|
// processed.
|
|
func (q *TransferQueue) enqueueAndCollectRetriesFor(batch Batch) (Batch, error) {
|
|
cfg := config.Config
|
|
|
|
next := q.makeBatch()
|
|
transferAdapterNames := q.manifest.GetAdapterNames(q.direction)
|
|
|
|
tracerx.Printf("tq: sending batch of size %d", len(batch))
|
|
|
|
objs, adapterName, err := api.Batch(
|
|
cfg, batch.ApiObjects(), q.transferKind(), transferAdapterNames,
|
|
)
|
|
if err != nil {
|
|
// If there was an error making the batch API call, mark all of
|
|
// the objects for retry, and return them along with the error
|
|
// that was encountered. If any of the objects couldn't be
|
|
// retried, they will be marked as failed.
|
|
for _, t := range batch {
|
|
if q.canRetryObject(t.Oid, err) {
|
|
q.rc.Increment(t.Oid)
|
|
|
|
next = append(next, t)
|
|
} else {
|
|
q.wait.Done()
|
|
}
|
|
}
|
|
|
|
return next, err
|
|
}
|
|
|
|
q.useAdapter(adapterName)
|
|
q.startProgress.Do(q.meter.Start)
|
|
|
|
toTransfer := make([]*Transfer, 0, len(objs))
|
|
|
|
for _, o := range objs {
|
|
if o.Error != nil {
|
|
q.errorc <- errors.Wrapf(o.Error, "[%v] %v", o.Oid, o.Error.Message)
|
|
q.Skip(o.Size)
|
|
q.wait.Done()
|
|
|
|
continue
|
|
}
|
|
|
|
q.trMutex.Lock()
|
|
t, ok := q.transfers[o.Oid]
|
|
q.trMutex.Unlock()
|
|
if !ok {
|
|
// If we couldn't find any associated
|
|
// Transfer object, then we give up on the
|
|
// transfer by telling the progress meter to
|
|
// skip the number of bytes in "o".
|
|
q.errorc <- errors.Errorf("[%v] The server returned an unknown OID.", o.Oid)
|
|
|
|
q.Skip(o.Size)
|
|
q.wait.Done()
|
|
} else {
|
|
tr := newTransfer(t.Name, o, t.Path)
|
|
|
|
if _, err := tr.Actions.Get(q.transferKind()); err != nil {
|
|
// XXX(taylor): duplication
|
|
if q.canRetryObject(tr.Oid, err) {
|
|
q.rc.Increment(tr.Oid)
|
|
count := q.rc.CountFor(tr.Oid)
|
|
|
|
tracerx.Printf("tq: enqueue retry #%d for %q (size: %d)", count, tr.Oid, tr.Size)
|
|
next = append(next, t)
|
|
} else {
|
|
if !IsActionMissingError(err) {
|
|
q.errorc <- errors.Errorf("[%v] %v", tr.Name, err)
|
|
}
|
|
|
|
q.Skip(o.Size)
|
|
q.wait.Done()
|
|
}
|
|
|
|
} else {
|
|
q.meter.StartTransfer(t.Name)
|
|
toTransfer = append(toTransfer, tr)
|
|
}
|
|
}
|
|
}
|
|
|
|
retries := q.addToAdapter(toTransfer)
|
|
for t := range retries {
|
|
q.rc.Increment(t.Oid)
|
|
count := q.rc.CountFor(t.Oid)
|
|
|
|
tracerx.Printf("tq: enqueue retry #%d for %q (size: %d)", count, t.Oid, t.Size)
|
|
|
|
next = append(next, t)
|
|
}
|
|
|
|
return next, nil
|
|
}
|
|
|
|
// makeBatch returns a new, empty batch, with a capacity equal to the maximum
|
|
// batch size designated by the `*TransferQueue`.
|
|
func (q *TransferQueue) makeBatch() Batch { return make(Batch, 0, q.batchSize) }
|
|
|
|
// addToAdapter adds the given "pending" transfers to the transfer adapters and
|
|
// returns a channel of Transfers that are to be retried in the next batch.
|
|
// After all of the items in the batch have been processed, the channel is
|
|
// closed.
|
|
//
|
|
// addToAdapter returns immediately, and does not block.
|
|
func (q *TransferQueue) addToAdapter(pending []*Transfer) <-chan *objectTuple {
|
|
retries := make(chan *objectTuple, len(pending))
|
|
|
|
if err := q.ensureAdapterBegun(); err != nil {
|
|
close(retries)
|
|
|
|
q.errorc <- err
|
|
for _, t := range pending {
|
|
q.Skip(t.Size)
|
|
q.wait.Done()
|
|
}
|
|
|
|
return retries
|
|
}
|
|
|
|
go func() {
|
|
defer close(retries)
|
|
|
|
var results <-chan TransferResult
|
|
if q.dryRun {
|
|
results = q.makeDryRunResults(pending)
|
|
} else {
|
|
results = q.adapter.Add(pending...)
|
|
}
|
|
|
|
for res := range results {
|
|
q.handleTransferResult(res, retries)
|
|
}
|
|
}()
|
|
|
|
return retries
|
|
}
|
|
|
|
// makeDryRunResults returns a channel populated immediately with "successful"
|
|
// results for all of the given transfers in "ts".
|
|
func (q *TransferQueue) makeDryRunResults(ts []*Transfer) <-chan TransferResult {
|
|
results := make(chan TransferResult, len(ts))
|
|
for _, t := range ts {
|
|
results <- TransferResult{t, nil}
|
|
}
|
|
|
|
close(results)
|
|
|
|
return results
|
|
}
|
|
|
|
// handleTransferResult observes the transfer result, sending it on the retries
|
|
// channel if it was able to be retried.
|
|
func (q *TransferQueue) handleTransferResult(
|
|
res TransferResult, retries chan<- *objectTuple,
|
|
) {
|
|
oid := res.Transfer.Oid
|
|
|
|
if res.Error != nil {
|
|
// If there was an error encountered when processing the
|
|
// transfer (res.Transfer), handle the error as is appropriate:
|
|
|
|
if q.canRetryObject(oid, res.Error) {
|
|
// If the object can be retried, send it on the retries
|
|
// channel, where it will be read at the call-site and
|
|
// its retry count will be incremented.
|
|
tracerx.Printf("tq: retrying object %s", oid)
|
|
|
|
q.trMutex.Lock()
|
|
t, ok := q.transfers[oid]
|
|
q.trMutex.Unlock()
|
|
|
|
if ok {
|
|
retries <- t
|
|
} else {
|
|
q.errorc <- res.Error
|
|
}
|
|
} else {
|
|
// If the error wasn't retriable, OR the object has
|
|
// exceeded its retry budget, it will be NOT be sent to
|
|
// the retry channel, and the error will be reported
|
|
// immediately.
|
|
q.errorc <- res.Error
|
|
q.wait.Done()
|
|
}
|
|
} else {
|
|
// Otherwise, if the transfer was successful, notify all of the
|
|
// watchers, and mark it as finished.
|
|
for _, c := range q.watchers {
|
|
c <- oid
|
|
}
|
|
|
|
q.meter.FinishTransfer(res.Transfer.Name)
|
|
q.wait.Done()
|
|
}
|
|
}
|
|
|
|
func (q *TransferQueue) useAdapter(name string) {
|
|
q.adapterInitMutex.Lock()
|
|
defer q.adapterInitMutex.Unlock()
|
|
|
|
if q.adapter != nil {
|
|
if q.adapter.Name() == name {
|
|
// re-use, this is the normal path
|
|
return
|
|
}
|
|
// If the adapter we're using isn't the same as the one we've been
|
|
// told to use now, must wait for the current one to finish then switch
|
|
// This will probably never happen but is just in case server starts
|
|
// changing adapter support in between batches
|
|
q.finishAdapter()
|
|
}
|
|
q.adapter = q.manifest.NewAdapterOrDefault(name, q.direction)
|
|
}
|
|
|
|
func (q *TransferQueue) finishAdapter() {
|
|
if q.adapterInProgress {
|
|
q.adapter.End()
|
|
q.adapterInProgress = false
|
|
q.adapter = nil
|
|
}
|
|
}
|
|
|
|
func (q *TransferQueue) Skip(size int64) {
|
|
q.meter.Skip(size)
|
|
}
|
|
|
|
func (q *TransferQueue) transferKind() string {
|
|
if q.direction == Download {
|
|
return "download"
|
|
} else {
|
|
return "upload"
|
|
}
|
|
}
|
|
|
|
func (q *TransferQueue) ensureAdapterBegun() error {
|
|
q.adapterInitMutex.Lock()
|
|
defer q.adapterInitMutex.Unlock()
|
|
|
|
if q.adapterInProgress {
|
|
return nil
|
|
}
|
|
|
|
// Progress callback - receives byte updates
|
|
cb := func(name string, total, read int64, current int) error {
|
|
q.meter.TransferBytes(q.transferKind(), name, read, total, current)
|
|
return nil
|
|
}
|
|
|
|
tracerx.Printf("tq: starting transfer adapter %q", q.adapter.Name())
|
|
err := q.adapter.Begin(q.manifest.ConcurrentTransfers(), cb)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
q.adapterInProgress = true
|
|
|
|
return nil
|
|
}
|
|
|
|
// Wait waits for the queue to finish processing all transfers. Once Wait is
|
|
// called, Add will no longer add transfers to the queue. Any failed
|
|
// transfers will be automatically retried once.
|
|
func (q *TransferQueue) Wait() {
|
|
close(q.incoming)
|
|
|
|
q.wait.Wait()
|
|
q.collectorWait.Wait()
|
|
|
|
q.finishAdapter()
|
|
close(q.errorc)
|
|
|
|
for _, watcher := range q.watchers {
|
|
close(watcher)
|
|
}
|
|
|
|
q.meter.Finish()
|
|
q.errorwait.Wait()
|
|
}
|
|
|
|
// Watch returns a channel where the queue will write the OID of each transfer
|
|
// as it completes. The channel will be closed when the queue finishes processing.
|
|
func (q *TransferQueue) Watch() chan string {
|
|
c := make(chan string, q.batchSize)
|
|
q.watchers = append(q.watchers, c)
|
|
return c
|
|
}
|
|
|
|
// This goroutine collects errors returned from transfers
|
|
func (q *TransferQueue) errorCollector() {
|
|
for err := range q.errorc {
|
|
q.errors = append(q.errors, err)
|
|
}
|
|
q.errorwait.Done()
|
|
}
|
|
|
|
// run starts the transfer queue, doing individual or batch transfers depending
|
|
// on the Config.BatchTransfer() value. run will transfer files sequentially or
|
|
// concurrently depending on the Config.ConcurrentTransfers() value.
|
|
func (q *TransferQueue) run() {
|
|
tracerx.Printf("tq: running as batched queue, batch size of %d", q.batchSize)
|
|
|
|
go q.errorCollector()
|
|
go q.collectBatches()
|
|
}
|
|
|
|
// canRetry returns whether or not the given error "err" is retriable.
|
|
func (q *TransferQueue) canRetry(err error) bool {
|
|
return errors.IsRetriableError(err)
|
|
}
|
|
|
|
// canRetryObject returns whether the given error is retriable for the object
|
|
// given by "oid". If the an OID has met its retry limit, then it will not be
|
|
// able to be retried again. If so, canRetryObject returns whether or not that
|
|
// given error "err" is retriable.
|
|
func (q *TransferQueue) canRetryObject(oid string, err error) bool {
|
|
if count, ok := q.rc.CanRetry(oid); !ok {
|
|
tracerx.Printf("tq: refusing to retry %q, too many retries (%d)", oid, count)
|
|
return false
|
|
}
|
|
|
|
return q.canRetry(err)
|
|
}
|
|
|
|
// Errors returns any errors encountered during transfer.
|
|
func (q *TransferQueue) Errors() []error {
|
|
return q.errors
|
|
}
|