6f53ecc1ae
Use runtime.GOMAXPROCS(0) as worker count for CPU-bound tasks, repo.Connections() for IO-bound task and a combination if a task can be both. Streaming packs is treated as IO-bound as adding more worker cannot provide a speedup. Typical IO-bound tasks are download / uploading / deleting files. Decoding / Encoding / Verifying are usually CPU-bound. Several tasks are a combination of both, e.g. for combined download and decode functions. In the latter case add both limits together. As the backends have their own concurrency limits restic still won't download more than repo.Connections() files in parallel, but the additional workers can decode already downloaded data in parallel.
98 lines
3.4 KiB
Go
98 lines
3.4 KiB
Go
package restic
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/restic/restic/internal/crypto"
|
|
"github.com/restic/restic/internal/ui/progress"
|
|
"golang.org/x/sync/errgroup"
|
|
)
|
|
|
|
// Repository stores data in a backend. It provides high-level functions and
|
|
// transparently encrypts/decrypts data.
|
|
type Repository interface {
|
|
|
|
// Backend returns the backend used by the repository
|
|
Backend() Backend
|
|
// Connections returns the maximum number of concurrent backend operations
|
|
Connections() uint
|
|
|
|
Key() *crypto.Key
|
|
|
|
Index() MasterIndex
|
|
LoadIndex(context.Context) error
|
|
SetIndex(MasterIndex) error
|
|
LookupBlobSize(ID, BlobType) (uint, bool)
|
|
|
|
Config() Config
|
|
|
|
// List calls the function fn for each file of type t in the repository.
|
|
// When an error is returned by fn, processing stops and List() returns the
|
|
// error.
|
|
//
|
|
// The function fn is called in the same Goroutine List() was called from.
|
|
List(ctx context.Context, t FileType, fn func(ID, int64) error) error
|
|
|
|
// ListPack returns the list of blobs saved in the pack id and the length of
|
|
// the the pack header.
|
|
ListPack(context.Context, ID, int64) ([]Blob, uint32, error)
|
|
|
|
// StartPackUploader start goroutines to upload new pack files. The errgroup
|
|
// is used to immediately notify about an upload error. Flush() will also return
|
|
// that error.
|
|
StartPackUploader(ctx context.Context, wg *errgroup.Group)
|
|
Flush(context.Context) error
|
|
|
|
SaveUnpacked(context.Context, FileType, []byte) (ID, error)
|
|
SaveJSONUnpacked(context.Context, FileType, interface{}) (ID, error)
|
|
|
|
LoadJSONUnpacked(ctx context.Context, t FileType, id ID, dest interface{}) error
|
|
// LoadUnpacked loads and decrypts the file with the given type and ID,
|
|
// using the supplied buffer (which must be empty). If the buffer is nil, a
|
|
// new buffer will be allocated and returned.
|
|
LoadUnpacked(ctx context.Context, buf []byte, t FileType, id ID) (data []byte, err error)
|
|
|
|
LoadBlob(context.Context, BlobType, ID, []byte) ([]byte, error)
|
|
SaveBlob(context.Context, BlobType, []byte, ID, bool) (ID, bool, int, error)
|
|
|
|
LoadTree(context.Context, ID) (*Tree, error)
|
|
SaveTree(context.Context, *Tree) (ID, error)
|
|
}
|
|
|
|
// Lister allows listing files in a backend.
|
|
type Lister interface {
|
|
List(context.Context, FileType, func(FileInfo) error) error
|
|
}
|
|
|
|
// LoadJSONUnpackeder allows loading a JSON file not stored in a pack file
|
|
type LoadJSONUnpackeder interface {
|
|
// Connections returns the maximum number of concurrent backend operations
|
|
Connections() uint
|
|
LoadJSONUnpacked(ctx context.Context, t FileType, id ID, dest interface{}) error
|
|
}
|
|
|
|
// SaverUnpacked allows saving a blob not stored in a pack file
|
|
type SaverUnpacked interface {
|
|
// Connections returns the maximum number of concurrent backend operations
|
|
Connections() uint
|
|
SaveUnpacked(context.Context, FileType, []byte) (ID, error)
|
|
}
|
|
|
|
type PackBlobs struct {
|
|
PackID ID
|
|
Blobs []Blob
|
|
}
|
|
|
|
// MasterIndex keeps track of the blobs are stored within files.
|
|
type MasterIndex interface {
|
|
Has(BlobHandle) bool
|
|
Lookup(BlobHandle) []PackedBlob
|
|
|
|
// Each returns a channel that yields all blobs known to the index. When
|
|
// the context is cancelled, the background goroutine terminates. This
|
|
// blocks any modification of the index.
|
|
Each(ctx context.Context) <-chan PackedBlob
|
|
ListPacks(ctx context.Context, packs IDSet) <-chan PackBlobs
|
|
|
|
Save(ctx context.Context, repo SaverUnpacked, packBlacklist IDSet, extraObsolete IDs, p *progress.Counter) (obsolete IDSet, err error)
|
|
}
|