2960: Fix some needlessly exported identifiers.
[arvados.git] / services / keepstore / s3aws_volume.go
index 8d999e7472ff14f03985e80a2b774632eebe7346..8e93eed12c839175ba050b18e5772161ad82bd47 100644 (file)
@@ -2,7 +2,7 @@
 //
 // SPDX-License-Identifier: AGPL-3.0
 
-package main
+package keepstore
 
 import (
        "bytes"
@@ -33,19 +33,41 @@ import (
        "github.com/sirupsen/logrus"
 )
 
-// S3AWSVolume implements Volume using an S3 bucket.
-type S3AWSVolume struct {
+func init() {
+       driver["S3"] = news3Volume
+}
+
+const (
+       s3DefaultReadTimeout        = arvados.Duration(10 * time.Minute)
+       s3DefaultConnectTimeout     = arvados.Duration(time.Minute)
+       maxClockSkew                = 600 * time.Second
+       nearlyRFC1123               = "Mon, 2 Jan 2006 15:04:05 GMT"
+       s3downloaderPartSize        = 5 * 1024 * 1024
+       s3downloaderReadConcurrency = 13
+       s3uploaderPartSize          = 5 * 1024 * 1024
+       s3uploaderWriteConcurrency  = 5
+)
+
+var (
+       errS3TrashDisabled   = fmt.Errorf("trash function is disabled because Collections.BlobTrashLifetime=0 and DriverParameters.UnsafeDelete=false")
+       s3AWSKeepBlockRegexp = regexp.MustCompile(`^[0-9a-f]{32}$`)
+       s3AWSZeroTime        time.Time
+)
+
+// s3Volume implements Volume using an S3 bucket.
+type s3Volume struct {
        arvados.S3VolumeDriverParameters
        AuthToken      string    // populated automatically when IAMRole is used
        AuthExpiration time.Time // populated automatically when IAMRole is used
 
-       cluster   *arvados.Cluster
-       volume    arvados.Volume
-       logger    logrus.FieldLogger
-       metrics   *volumeMetricsVecs
-       bucket    *s3AWSbucket
-       region    string
-       startOnce sync.Once
+       cluster    *arvados.Cluster
+       volume     arvados.Volume
+       logger     logrus.FieldLogger
+       metrics    *volumeMetricsVecs
+       bufferPool *bufferPool
+       bucket     *s3AWSbucket
+       region     string
+       startOnce  sync.Once
 }
 
 // s3bucket wraps s3.bucket and counts I/O and API usage stats. The
@@ -58,63 +80,59 @@ type s3AWSbucket struct {
        mu     sync.Mutex
 }
 
-// chooseS3VolumeDriver distinguishes between the old goamz driver and
-// aws-sdk-go based on the UseAWSS3v2Driver feature flag
-func chooseS3VolumeDriver(cluster *arvados.Cluster, volume arvados.Volume, logger logrus.FieldLogger, metrics *volumeMetricsVecs) (Volume, error) {
-       v := &S3Volume{cluster: cluster, volume: volume, metrics: metrics}
-       err := json.Unmarshal(volume.DriverParameters, v)
-       if err != nil {
-               return nil, err
-       }
-       if v.UseAWSS3v2Driver {
-               logger.Debugln("Using AWS S3 v2 driver")
-               return newS3AWSVolume(cluster, volume, logger, metrics)
+func (v *s3Volume) isKeepBlock(s string) (string, bool) {
+       if v.PrefixLength > 0 && len(s) == v.PrefixLength+33 && s[:v.PrefixLength] == s[v.PrefixLength+1:v.PrefixLength*2+1] {
+               s = s[v.PrefixLength+1:]
        }
-       logger.Debugln("Using goamz S3 driver")
-       return newS3Volume(cluster, volume, logger, metrics)
+       return s, s3AWSKeepBlockRegexp.MatchString(s)
 }
 
-const (
-       PartSize         = 5 * 1024 * 1024
-       ReadConcurrency  = 13
-       WriteConcurrency = 5
-)
-
-var s3AWSKeepBlockRegexp = regexp.MustCompile(`^[0-9a-f]{32}$`)
-var s3AWSZeroTime time.Time
-
-func (v *S3AWSVolume) isKeepBlock(s string) bool {
-       return s3AWSKeepBlockRegexp.MatchString(s)
+// Return the key used for a given loc. If PrefixLength==0 then
+// key("abcdef0123") is "abcdef0123", if PrefixLength==3 then key is
+// "abc/abcdef0123", etc.
+func (v *s3Volume) key(loc string) string {
+       if v.PrefixLength > 0 && v.PrefixLength < len(loc)-1 {
+               return loc[:v.PrefixLength] + "/" + loc
+       } else {
+               return loc
+       }
 }
 
-func newS3AWSVolume(cluster *arvados.Cluster, volume arvados.Volume, logger logrus.FieldLogger, metrics *volumeMetricsVecs) (Volume, error) {
-       v := &S3AWSVolume{cluster: cluster, volume: volume, metrics: metrics}
-       err := json.Unmarshal(volume.DriverParameters, v)
+func news3Volume(params newVolumeParams) (volume, error) {
+       v := &s3Volume{
+               cluster:    params.Cluster,
+               volume:     params.ConfigVolume,
+               metrics:    params.MetricsVecs,
+               bufferPool: params.BufferPool,
+       }
+       err := json.Unmarshal(params.ConfigVolume.DriverParameters, v)
        if err != nil {
                return nil, err
        }
-       v.logger = logger.WithField("Volume", v.String())
+       v.logger = params.Logger.WithField("Volume", v.DeviceID())
        return v, v.check("")
 }
 
-func (v *S3AWSVolume) translateError(err error) error {
-       if aerr, ok := err.(awserr.Error); ok {
-               switch aerr.Code() {
-               case "NotFound":
+func (v *s3Volume) translateError(err error) error {
+       if _, ok := err.(*aws.RequestCanceledError); ok {
+               return context.Canceled
+       } else if aerr, ok := err.(awserr.Error); ok {
+               if aerr.Code() == "NotFound" {
                        return os.ErrNotExist
-               case "NoSuchKey":
+               } else if aerr.Code() == "NoSuchKey" {
                        return os.ErrNotExist
                }
        }
        return err
 }
 
-// safeCopy calls CopyObjectRequest, and checks the response to make sure the
-// copy succeeded and updated the timestamp on the destination object
+// safeCopy calls CopyObjectRequest, and checks the response to make
+// sure the copy succeeded and updated the timestamp on the
+// destination object
 //
-// (If something goes wrong during the copy, the error will be embedded in the
-// 200 OK response)
-func (v *S3AWSVolume) safeCopy(dst, src string) error {
+// (If something goes wrong during the copy, the error will be
+// embedded in the 200 OK response)
+func (v *s3Volume) safeCopy(dst, src string) error {
        input := &s3.CopyObjectInput{
                Bucket:      aws.String(v.bucket.bucket),
                ContentType: aws.String("application/octet-stream"),
@@ -140,7 +158,7 @@ func (v *S3AWSVolume) safeCopy(dst, src string) error {
        return nil
 }
 
-func (v *S3AWSVolume) check(ec2metadataHostname string) error {
+func (v *s3Volume) check(ec2metadataHostname string) error {
        if v.Bucket == "" {
                return errors.New("DriverParameters: Bucket must be provided")
        }
@@ -166,19 +184,25 @@ func (v *S3AWSVolume) check(ec2metadataHostname string) error {
                        if v.Endpoint != "" && service == "s3" {
                                return aws.Endpoint{
                                        URL:           v.Endpoint,
-                                       SigningRegion: v.Region,
+                                       SigningRegion: region,
                                }, nil
                        } else if service == "ec2metadata" && ec2metadataHostname != "" {
                                return aws.Endpoint{
                                        URL: ec2metadataHostname,
                                }, nil
+                       } else {
+                               return defaultResolver.ResolveEndpoint(service, region)
                        }
-
-                       return defaultResolver.ResolveEndpoint(service, region)
                }
                cfg.EndpointResolver = aws.EndpointResolverFunc(myCustomResolver)
        }
-
+       if v.Region == "" {
+               // Endpoint is already specified (otherwise we would
+               // have errored out above), but Region is also
+               // required by the aws sdk, in order to determine
+               // SignatureVersions.
+               v.Region = "us-east-1"
+       }
        cfg.Region = v.Region
 
        // Zero timeouts mean "wait forever", which is a bad
@@ -192,7 +216,7 @@ func (v *S3AWSVolume) check(ec2metadataHostname string) error {
 
        creds := aws.NewChainProvider(
                []aws.CredentialsProvider{
-                       aws.NewStaticCredentialsProvider(v.AccessKey, v.SecretKey, v.AuthToken),
+                       aws.NewStaticCredentialsProvider(v.AccessKeyID, v.SecretAccessKey, v.AuthToken),
                        ec2rolecreds.New(ec2metadata.New(cfg)),
                })
 
@@ -204,108 +228,50 @@ func (v *S3AWSVolume) check(ec2metadataHostname string) error {
        }
 
        // Set up prometheus metrics
-       lbls := prometheus.Labels{"device_id": v.GetDeviceID()}
+       lbls := prometheus.Labels{"device_id": v.DeviceID()}
        v.bucket.stats.opsCounters, v.bucket.stats.errCounters, v.bucket.stats.ioBytes = v.metrics.getCounterVecsFor(lbls)
 
        return nil
 }
 
-// String implements fmt.Stringer.
-func (v *S3AWSVolume) String() string {
-       return fmt.Sprintf("s3-bucket:%+q", v.Bucket)
-}
-
-// GetDeviceID returns a globally unique ID for the storage bucket.
-func (v *S3AWSVolume) GetDeviceID() string {
+// DeviceID returns a globally unique ID for the storage bucket.
+func (v *s3Volume) DeviceID() string {
        return "s3://" + v.Endpoint + "/" + v.Bucket
 }
 
-// Compare the given data with the stored data.
-func (v *S3AWSVolume) Compare(ctx context.Context, loc string, expect []byte) error {
-       errChan := make(chan error, 1)
-       go func() {
-               _, err := v.Head("recent/" + loc)
-               errChan <- err
-       }()
-       var err error
-       select {
-       case <-ctx.Done():
-               return ctx.Err()
-       case err = <-errChan:
-       }
-       if err != nil {
-               // Checking for "loc" itself here would interfere with
-               // future GET requests.
-               //
-               // On AWS, if X doesn't exist, a HEAD or GET request
-               // for X causes X's non-existence to be cached. Thus,
-               // if we test for X, then create X and return a
-               // signature to our client, the client might still get
-               // 404 from all keepstores when trying to read it.
-               //
-               // To avoid this, we avoid doing HEAD X or GET X until
-               // we know X has been written.
-               //
-               // Note that X might exist even though recent/X
-               // doesn't: for example, the response to HEAD recent/X
-               // might itself come from a stale cache. In such
-               // cases, we will return a false negative and
-               // PutHandler might needlessly create another replica
-               // on a different volume. That's not ideal, but it's
-               // better than passing the eventually-consistent
-               // problem on to our clients.
-               return v.translateError(err)
-       }
-
-       input := &s3.GetObjectInput{
-               Bucket: aws.String(v.bucket.bucket),
-               Key:    aws.String(loc),
-       }
-
-       req := v.bucket.svc.GetObjectRequest(input)
-       result, err := req.Send(ctx)
-       if err != nil {
-               return v.translateError(err)
-       }
-       return v.translateError(compareReaderWithBuf(ctx, result.Body, expect, loc[:32]))
-}
-
 // EmptyTrash looks for trashed blocks that exceeded BlobTrashLifetime
 // and deletes them from the volume.
-func (v *S3AWSVolume) EmptyTrash() {
-       if v.cluster.Collections.BlobDeleteConcurrency < 1 {
-               return
-       }
-
+func (v *s3Volume) EmptyTrash() {
        var bytesInTrash, blocksInTrash, bytesDeleted, blocksDeleted int64
 
        // Define "ready to delete" as "...when EmptyTrash started".
        startT := time.Now()
 
        emptyOneKey := func(trash *s3.Object) {
-               loc := strings.TrimPrefix(*trash.Key, "trash/")
-               if !v.isKeepBlock(loc) {
+               key := strings.TrimPrefix(*trash.Key, "trash/")
+               loc, isblk := v.isKeepBlock(key)
+               if !isblk {
                        return
                }
                atomic.AddInt64(&bytesInTrash, *trash.Size)
                atomic.AddInt64(&blocksInTrash, 1)
 
-               trashT := *(trash.LastModified)
-               recent, err := v.Head("recent/" + loc)
+               trashT := *trash.LastModified
+               recent, err := v.head("recent/" + key)
                if err != nil && os.IsNotExist(v.translateError(err)) {
-                       v.logger.Warnf("EmptyTrash: found trash marker %q but no %q (%s); calling Untrash", trash.Key, "recent/"+loc, err)
-                       err = v.Untrash(loc)
+                       v.logger.Warnf("EmptyTrash: found trash marker %q but no %q (%s); calling Untrash", *trash.Key, "recent/"+key, err)
+                       err = v.BlockUntrash(loc)
                        if err != nil {
                                v.logger.WithError(err).Errorf("EmptyTrash: Untrash(%q) failed", loc)
                        }
                        return
                } else if err != nil {
-                       v.logger.WithError(err).Warnf("EmptyTrash: HEAD %q failed", "recent/"+loc)
+                       v.logger.WithError(err).Warnf("EmptyTrash: HEAD %q failed", "recent/"+key)
                        return
                }
                if trashT.Sub(*recent.LastModified) < v.cluster.Collections.BlobSigningTTL.Duration() {
                        if age := startT.Sub(*recent.LastModified); age >= v.cluster.Collections.BlobSigningTTL.Duration()-time.Duration(v.RaceWindow) {
-                               // recent/loc is too old to protect
+                               // recent/key is too old to protect
                                // loc from being Trashed again during
                                // the raceWindow that starts if we
                                // delete trash/X now.
@@ -314,14 +280,14 @@ func (v *S3AWSVolume) EmptyTrash() {
                                // < BlobSigningTTL - raceWindow) is
                                // necessary to avoid starvation.
                                v.logger.Infof("EmptyTrash: detected old race for %q, calling fixRace + Touch", loc)
-                               v.fixRace(loc)
-                               v.Touch(loc)
+                               v.fixRace(key)
+                               v.BlockTouch(loc)
                                return
                        }
-                       _, err := v.Head(loc)
+                       _, err := v.head(key)
                        if os.IsNotExist(err) {
                                v.logger.Infof("EmptyTrash: detected recent race for %q, calling fixRace", loc)
-                               v.fixRace(loc)
+                               v.fixRace(key)
                                return
                        } else if err != nil {
                                v.logger.WithError(err).Warnf("EmptyTrash: HEAD %q failed", loc)
@@ -339,18 +305,18 @@ func (v *S3AWSVolume) EmptyTrash() {
                atomic.AddInt64(&bytesDeleted, *trash.Size)
                atomic.AddInt64(&blocksDeleted, 1)
 
-               _, err = v.Head(loc)
+               _, err = v.head(*trash.Key)
                if err == nil {
                        v.logger.Warnf("EmptyTrash: HEAD %q succeeded immediately after deleting %q", loc, loc)
                        return
                }
                if !os.IsNotExist(v.translateError(err)) {
-                       v.logger.WithError(err).Warnf("EmptyTrash: HEAD %q failed", loc)
+                       v.logger.WithError(err).Warnf("EmptyTrash: HEAD %q failed", key)
                        return
                }
-               err = v.bucket.Del("recent/" + loc)
+               err = v.bucket.Del("recent/" + key)
                if err != nil {
-                       v.logger.WithError(err).Warnf("EmptyTrash: error deleting %q", "recent/"+loc)
+                       v.logger.WithError(err).Warnf("EmptyTrash: error deleting %q", "recent/"+key)
                }
        }
 
@@ -382,25 +348,25 @@ func (v *S3AWSVolume) EmptyTrash() {
        if err := trashL.Error(); err != nil {
                v.logger.WithError(err).Error("EmptyTrash: lister failed")
        }
-       v.logger.Infof("EmptyTrash: stats for %v: Deleted %v bytes in %v blocks. Remaining in trash: %v bytes in %v blocks.", v.String(), bytesDeleted, blocksDeleted, bytesInTrash-bytesDeleted, blocksInTrash-blocksDeleted)
+       v.logger.Infof("EmptyTrash: stats for %v: Deleted %v bytes in %v blocks. Remaining in trash: %v bytes in %v blocks.", v.DeviceID(), bytesDeleted, blocksDeleted, bytesInTrash-bytesDeleted, blocksInTrash-blocksDeleted)
 }
 
 // fixRace(X) is called when "recent/X" exists but "X" doesn't
-// exist. If the timestamps on "recent/"+loc and "trash/"+loc indicate
-// there was a race between Put and Trash, fixRace recovers from the
-// race by Untrashing the block.
-func (v *S3AWSVolume) fixRace(loc string) bool {
-       trash, err := v.Head("trash/" + loc)
+// exist. If the timestamps on "recent/X" and "trash/X" indicate there
+// was a race between Put and Trash, fixRace recovers from the race by
+// Untrashing the block.
+func (v *s3Volume) fixRace(key string) bool {
+       trash, err := v.head("trash/" + key)
        if err != nil {
                if !os.IsNotExist(v.translateError(err)) {
-                       v.logger.WithError(err).Errorf("fixRace: HEAD %q failed", "trash/"+loc)
+                       v.logger.WithError(err).Errorf("fixRace: HEAD %q failed", "trash/"+key)
                }
                return false
        }
 
-       recent, err := v.Head("recent/" + loc)
+       recent, err := v.head("recent/" + key)
        if err != nil {
-               v.logger.WithError(err).Errorf("fixRace: HEAD %q failed", "recent/"+loc)
+               v.logger.WithError(err).Errorf("fixRace: HEAD %q failed", "recent/"+key)
                return false
        }
 
@@ -413,9 +379,9 @@ func (v *S3AWSVolume) fixRace(loc string) bool {
                return false
        }
 
-       v.logger.Infof("fixRace: %q: trashed at %s but touched at %s (age when trashed = %s < %s)", loc, trashTime, recentTime, ageWhenTrashed, v.cluster.Collections.BlobSigningTTL)
-       v.logger.Infof("fixRace: copying %q to %q to recover from race between Put/Touch and Trash", "recent/"+loc, loc)
-       err = v.safeCopy(loc, "trash/"+loc)
+       v.logger.Infof("fixRace: %q: trashed at %s but touched at %s (age when trashed = %s < %s)", key, trashTime, recentTime, ageWhenTrashed, v.cluster.Collections.BlobSigningTTL)
+       v.logger.Infof("fixRace: copying %q to %q to recover from race between Put/Touch and Trash", "recent/"+key, key)
+       err = v.safeCopy(key, "trash/"+key)
        if err != nil {
                v.logger.WithError(err).Error("fixRace: copy failed")
                return false
@@ -423,10 +389,10 @@ func (v *S3AWSVolume) fixRace(loc string) bool {
        return true
 }
 
-func (v *S3AWSVolume) Head(loc string) (result *s3.HeadObjectOutput, err error) {
+func (v *s3Volume) head(key string) (result *s3.HeadObjectOutput, err error) {
        input := &s3.HeadObjectInput{
                Bucket: aws.String(v.bucket.bucket),
-               Key:    aws.String(loc),
+               Key:    aws.String(key),
        }
 
        req := v.bucket.svc.HeadObjectRequest(input)
@@ -443,81 +409,71 @@ func (v *S3AWSVolume) Head(loc string) (result *s3.HeadObjectOutput, err error)
        return
 }
 
-// Get a block: copy the block data into buf, and return the number of
-// bytes copied.
-func (v *S3AWSVolume) Get(ctx context.Context, loc string, buf []byte) (int, error) {
-       return getWithPipe(ctx, loc, buf, v)
-}
-
-func (v *S3AWSVolume) readWorker(ctx context.Context, loc string) (rdr io.ReadCloser, err error) {
-       buf := make([]byte, 0, 67108864)
-       awsBuf := aws.NewWriteAtBuffer(buf)
-
-       downloader := s3manager.NewDownloaderWithClient(v.bucket.svc, func(u *s3manager.Downloader) {
-               u.PartSize = PartSize
-               u.Concurrency = ReadConcurrency
-       })
-
-       v.logger.Debugf("Partsize: %d; Concurrency: %d\n", downloader.PartSize, downloader.Concurrency)
-
-       _, err = downloader.DownloadWithContext(ctx, awsBuf, &s3.GetObjectInput{
-               Bucket: aws.String(v.bucket.bucket),
-               Key:    aws.String(loc),
-       })
-       v.bucket.stats.TickOps("get")
-       v.bucket.stats.Tick(&v.bucket.stats.Ops, &v.bucket.stats.GetOps)
-       v.bucket.stats.TickErr(err)
+// BlockRead reads a Keep block that has been stored as a block blob
+// in the S3 bucket.
+func (v *s3Volume) BlockRead(ctx context.Context, hash string, writeTo io.Writer) (int, error) {
+       key := v.key(hash)
+       buf, err := v.bufferPool.GetContext(ctx)
        if err != nil {
-               return nil, v.translateError(err)
+               return 0, err
        }
-       buf = awsBuf.Bytes()
-
-       rdr = NewCountingReader(bytes.NewReader(buf), v.bucket.stats.TickInBytes)
-       return
-}
+       defer v.bufferPool.Put(buf)
 
-// ReadBlock implements BlockReader.
-func (v *S3AWSVolume) ReadBlock(ctx context.Context, loc string, w io.Writer) error {
-       rdr, err := v.readWorker(ctx, loc)
-
-       if err == nil {
-               _, err2 := io.Copy(w, rdr)
-               if err2 != nil {
-                       return err2
+       streamer := newStreamWriterAt(writeTo, 65536, buf)
+       defer streamer.Close()
+       err = v.readWorker(ctx, key, streamer)
+       if err != nil {
+               err = v.translateError(err)
+               if !os.IsNotExist(err) {
+                       return 0, err
+               }
+               if streamer.WroteAt() > 0 {
+                       return 0, errors.New("bug? readWorker returned ErrNotExist after writing to streamer")
                }
-               return err
-       }
 
-       err = v.translateError(err)
-       if !os.IsNotExist(err) {
-               return err
-       }
+               _, err = v.head("recent/" + key)
+               err = v.translateError(err)
+               if err != nil {
+                       // If we can't read recent/X, there's no point in
+                       // trying fixRace. Give up.
+                       return 0, err
+               }
+               if !v.fixRace(key) {
+                       err = os.ErrNotExist
+                       return 0, err
+               }
 
-       _, err = v.Head("recent/" + loc)
-       err = v.translateError(err)
-       if err != nil {
-               // If we can't read recent/X, there's no point in
-               // trying fixRace. Give up.
-               return err
-       }
-       if !v.fixRace(loc) {
-               err = os.ErrNotExist
-               return err
+               err = v.readWorker(ctx, key, streamer)
+               if err != nil {
+                       v.logger.Warnf("reading %s after successful fixRace: %s", hash, err)
+                       err = v.translateError(err)
+                       return 0, err
+               }
        }
-
-       rdr, err = v.readWorker(ctx, loc)
+       err = streamer.Close()
        if err != nil {
-               v.logger.Warnf("reading %s after successful fixRace: %s", loc, err)
-               err = v.translateError(err)
-               return err
+               return 0, v.translateError(err)
        }
+       return streamer.Wrote(), nil
+}
 
-       _, err = io.Copy(w, rdr)
-
-       return err
+func (v *s3Volume) readWorker(ctx context.Context, key string, dst io.WriterAt) error {
+       downloader := s3manager.NewDownloaderWithClient(v.bucket.svc, func(u *s3manager.Downloader) {
+               u.PartSize = s3downloaderPartSize
+               u.Concurrency = s3downloaderReadConcurrency
+       })
+       count, err := downloader.DownloadWithContext(ctx, dst, &s3.GetObjectInput{
+               Bucket: aws.String(v.bucket.bucket),
+               Key:    aws.String(key),
+       })
+       v.bucket.stats.TickOps("get")
+       v.bucket.stats.Tick(&v.bucket.stats.Ops, &v.bucket.stats.GetOps)
+       v.bucket.stats.TickErr(err)
+       v.bucket.stats.TickInBytes(uint64(count))
+       return v.translateError(err)
 }
 
-func (v *S3AWSVolume) writeObject(ctx context.Context, name string, r io.Reader) error {
+func (v *s3Volume) writeObject(ctx context.Context, key string, r io.Reader) error {
        if r == nil {
                // r == nil leads to a memory violation in func readFillBuf in
                // aws-sdk-go-v2@v0.23.0/service/s3/s3manager/upload.go
@@ -526,15 +482,15 @@ func (v *S3AWSVolume) writeObject(ctx context.Context, name string, r io.Reader)
 
        uploadInput := s3manager.UploadInput{
                Bucket: aws.String(v.bucket.bucket),
-               Key:    aws.String(name),
+               Key:    aws.String(key),
                Body:   r,
        }
 
-       if len(name) == 32 {
+       if loc, ok := v.isKeepBlock(key); ok {
                var contentMD5 string
-               md5, err := hex.DecodeString(name)
+               md5, err := hex.DecodeString(loc)
                if err != nil {
-                       return err
+                       return v.translateError(err)
                }
                contentMD5 = base64.StdEncoding.EncodeToString(md5)
                uploadInput.ContentMD5 = &contentMD5
@@ -543,10 +499,10 @@ func (v *S3AWSVolume) writeObject(ctx context.Context, name string, r io.Reader)
        // Experimentation indicated that using concurrency 5 yields the best
        // throughput, better than higher concurrency (10 or 13) by ~5%.
        // Defining u.BufferProvider = s3manager.NewBufferedReadSeekerWriteToPool(64 * 1024 * 1024)
-       // is detrimental to througput (minus ~15%).
+       // is detrimental to throughput (minus ~15%).
        uploader := s3manager.NewUploaderWithClient(v.bucket.svc, func(u *s3manager.Uploader) {
-               u.PartSize = PartSize
-               u.Concurrency = WriteConcurrency
+               u.PartSize = s3uploaderPartSize
+               u.Concurrency = s3uploaderWriteConcurrency
        })
 
        // Unlike the goamz S3 driver, we don't need to precompute ContentSHA256:
@@ -563,26 +519,21 @@ func (v *S3AWSVolume) writeObject(ctx context.Context, name string, r io.Reader)
        v.bucket.stats.Tick(&v.bucket.stats.Ops, &v.bucket.stats.PutOps)
        v.bucket.stats.TickErr(err)
 
-       return err
+       return v.translateError(err)
 }
 
 // Put writes a block.
-func (v *S3AWSVolume) Put(ctx context.Context, loc string, block []byte) error {
-       return putWithPipe(ctx, loc, block, v)
-}
-
-// WriteBlock implements BlockWriter.
-func (v *S3AWSVolume) WriteBlock(ctx context.Context, loc string, rdr io.Reader) error {
-       if v.volume.ReadOnly {
-               return MethodDisabledError
-       }
-
-       r := NewCountingReader(rdr, v.bucket.stats.TickOutBytes)
-       err := v.writeObject(ctx, loc, r)
+func (v *s3Volume) BlockWrite(ctx context.Context, hash string, data []byte) error {
+       // Do not use putWithPipe here; we want to pass an io.ReadSeeker to the S3
+       // sdk to avoid memory allocation there. See #17339 for more information.
+       rdr := bytes.NewReader(data)
+       r := newCountingReaderAtSeeker(rdr, v.bucket.stats.TickOutBytes)
+       key := v.key(hash)
+       err := v.writeObject(ctx, key, r)
        if err != nil {
                return err
        }
-       return v.writeObject(ctx, "recent/"+loc, nil)
+       return v.writeObject(ctx, "recent/"+key, nil)
 }
 
 type s3awsLister struct {
@@ -672,9 +623,10 @@ func (lister *s3awsLister) pop() (k *s3.Object) {
        return
 }
 
-// IndexTo writes a complete list of locators with the given prefix
+// Index writes a complete list of locators with the given prefix
 // for which Get() can retrieve data.
-func (v *S3AWSVolume) IndexTo(prefix string, writer io.Writer) error {
+func (v *s3Volume) Index(ctx context.Context, prefix string, writer io.Writer) error {
+       prefix = v.key(prefix)
        // Use a merge sort to find matching sets of X and recent/X.
        dataL := s3awsLister{
                Logger:   v.logger,
@@ -691,6 +643,9 @@ func (v *S3AWSVolume) IndexTo(prefix string, writer io.Writer) error {
                Stats:    &v.bucket.stats,
        }
        for data, recent := dataL.First(), recentL.First(); data != nil && dataL.Error() == nil; data = dataL.Next() {
+               if ctx.Err() != nil {
+                       return ctx.Err()
+               }
                if *data.Key >= "g" {
                        // Conveniently, "recent/*" and "trash/*" are
                        // lexically greater than all hex-encoded data
@@ -698,7 +653,8 @@ func (v *S3AWSVolume) IndexTo(prefix string, writer io.Writer) error {
                        // over all of them needlessly with dataL.
                        break
                }
-               if !v.isKeepBlock(*data.Key) {
+               loc, isblk := v.isKeepBlock(*data.Key)
+               if !isblk {
                        continue
                }
 
@@ -730,30 +686,31 @@ func (v *S3AWSVolume) IndexTo(prefix string, writer io.Writer) error {
                // We truncate sub-second precision here. Otherwise
                // timestamps will never match the RFC1123-formatted
                // Last-Modified values parsed by Mtime().
-               fmt.Fprintf(writer, "%s+%d %d\n", *data.Key, *data.Size, stamp.LastModified.Unix()*1000000000)
+               fmt.Fprintf(writer, "%s+%d %d\n", loc, *data.Size, stamp.LastModified.Unix()*1000000000)
        }
        return dataL.Error()
 }
 
 // Mtime returns the stored timestamp for the given locator.
-func (v *S3AWSVolume) Mtime(loc string) (time.Time, error) {
-       _, err := v.Head(loc)
+func (v *s3Volume) Mtime(loc string) (time.Time, error) {
+       key := v.key(loc)
+       _, err := v.head(key)
        if err != nil {
                return s3AWSZeroTime, v.translateError(err)
        }
-       resp, err := v.Head("recent/" + loc)
+       resp, err := v.head("recent/" + key)
        err = v.translateError(err)
        if os.IsNotExist(err) {
                // The data object X exists, but recent/X is missing.
-               err = v.writeObject(context.Background(), "recent/"+loc, nil)
+               err = v.writeObject(context.Background(), "recent/"+key, nil)
                if err != nil {
-                       v.logger.WithError(err).Errorf("error creating %q", "recent/"+loc)
+                       v.logger.WithError(err).Errorf("error creating %q", "recent/"+key)
                        return s3AWSZeroTime, v.translateError(err)
                }
-               v.logger.Infof("Mtime: created %q to migrate existing block to new storage scheme", "recent/"+loc)
-               resp, err = v.Head("recent/" + loc)
+               v.logger.Infof("Mtime: created %q to migrate existing block to new storage scheme", "recent/"+key)
+               resp, err = v.head("recent/" + key)
                if err != nil {
-                       v.logger.WithError(err).Errorf("HEAD failed after creating %q", "recent/"+loc)
+                       v.logger.WithError(err).Errorf("HEAD failed after creating %q", "recent/"+key)
                        return s3AWSZeroTime, v.translateError(err)
                }
        } else if err != nil {
@@ -763,43 +720,30 @@ func (v *S3AWSVolume) Mtime(loc string) (time.Time, error) {
        return *resp.LastModified, err
 }
 
-// Status returns a *VolumeStatus representing the current in-use
-// storage capacity and a fake available capacity that doesn't make
-// the volume seem full or nearly-full.
-func (v *S3AWSVolume) Status() *VolumeStatus {
-       return &VolumeStatus{
-               DeviceNum: 1,
-               BytesFree: BlockSize * 1000,
-               BytesUsed: 1,
-       }
-}
-
 // InternalStats returns bucket I/O and API call counters.
-func (v *S3AWSVolume) InternalStats() interface{} {
+func (v *s3Volume) InternalStats() interface{} {
        return &v.bucket.stats
 }
 
-// Touch sets the timestamp for the given locator to the current time.
-func (v *S3AWSVolume) Touch(loc string) error {
-       if v.volume.ReadOnly {
-               return MethodDisabledError
-       }
-       _, err := v.Head(loc)
+// BlockTouch sets the timestamp for the given locator to the current time.
+func (v *s3Volume) BlockTouch(hash string) error {
+       key := v.key(hash)
+       _, err := v.head(key)
        err = v.translateError(err)
-       if os.IsNotExist(err) && v.fixRace(loc) {
+       if os.IsNotExist(err) && v.fixRace(key) {
                // The data object got trashed in a race, but fixRace
                // rescued it.
        } else if err != nil {
                return err
        }
-       err = v.writeObject(context.Background(), "recent/"+loc, nil)
+       err = v.writeObject(context.Background(), "recent/"+key, nil)
        return v.translateError(err)
 }
 
-// checkRaceWindow returns a non-nil error if trash/loc is, or might
-// be, in the race window (i.e., it's not safe to trash loc).
-func (v *S3AWSVolume) checkRaceWindow(loc string) error {
-       resp, err := v.Head("trash/" + loc)
+// checkRaceWindow returns a non-nil error if trash/key is, or might
+// be, in the race window (i.e., it's not safe to trash key).
+func (v *s3Volume) checkRaceWindow(key string) error {
+       resp, err := v.head("trash/" + key)
        err = v.translateError(err)
        if os.IsNotExist(err) {
                // OK, trash/X doesn't exist so we're not in the race
@@ -817,7 +761,7 @@ func (v *S3AWSVolume) checkRaceWindow(loc string) error {
                // trash/X's lifetime. The new timestamp might not
                // become visible until now+raceWindow, and EmptyTrash
                // is allowed to delete trash/X before then.
-               return fmt.Errorf("same block is already in trash, and safe window ended %s ago", -safeWindow)
+               return fmt.Errorf("%s: same block is already in trash, and safe window ended %s ago", key, -safeWindow)
        }
        // trash/X exists, but it won't be eligible for deletion until
        // after now+raceWindow, so it's safe to overwrite it.
@@ -831,7 +775,6 @@ func (b *s3AWSbucket) Del(path string) error {
        }
        req := b.svc.DeleteObjectRequest(input)
        _, err := req.Send(context.Background())
-       //err := b.Bucket().Del(path)
        b.stats.TickOps("delete")
        b.stats.Tick(&b.stats.Ops, &b.stats.DelOps)
        b.stats.TickErr(err)
@@ -839,39 +782,38 @@ func (b *s3AWSbucket) Del(path string) error {
 }
 
 // Trash a Keep block.
-func (v *S3AWSVolume) Trash(loc string) error {
-       if v.volume.ReadOnly {
-               return MethodDisabledError
-       }
+func (v *s3Volume) BlockTrash(loc string) error {
        if t, err := v.Mtime(loc); err != nil {
                return err
        } else if time.Since(t) < v.cluster.Collections.BlobSigningTTL.Duration() {
                return nil
        }
+       key := v.key(loc)
        if v.cluster.Collections.BlobTrashLifetime == 0 {
                if !v.UnsafeDelete {
-                       return ErrS3TrashDisabled
+                       return errS3TrashDisabled
                }
-               return v.translateError(v.bucket.Del(loc))
+               return v.translateError(v.bucket.Del(key))
        }
-       err := v.checkRaceWindow(loc)
+       err := v.checkRaceWindow(key)
        if err != nil {
                return err
        }
-       err = v.safeCopy("trash/"+loc, loc)
+       err = v.safeCopy("trash/"+key, key)
        if err != nil {
                return err
        }
-       return v.translateError(v.bucket.Del(loc))
+       return v.translateError(v.bucket.Del(key))
 }
 
-// Untrash moves block from trash back into store
-func (v *S3AWSVolume) Untrash(loc string) error {
-       err := v.safeCopy(loc, "trash/"+loc)
+// BlockUntrash moves block from trash back into store
+func (v *s3Volume) BlockUntrash(hash string) error {
+       key := v.key(hash)
+       err := v.safeCopy(key, "trash/"+key)
        if err != nil {
                return err
        }
-       err = v.writeObject(context.Background(), "recent/"+loc, nil)
+       err = v.writeObject(context.Background(), "recent/"+key, nil)
        return v.translateError(err)
 }