services/keepstore/s3aws_volume.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 package main
   6
   7 import (
   8         "bytes"
   9         "context"
  10         "encoding/base64"
  11         "encoding/hex"
  12         "encoding/json"
  13         "errors"
  14         "fmt"
  15         "io"
  16         "os"
  17         "regexp"
  18         "strings"
  19         "sync"
  20         "sync/atomic"
  21         "time"
  22
  23         "git.arvados.org/arvados.git/sdk/go/arvados"
  24         "github.com/aws/aws-sdk-go-v2/aws"
  25         "github.com/aws/aws-sdk-go-v2/aws/awserr"
  26         "github.com/aws/aws-sdk-go-v2/aws/defaults"
  27         "github.com/aws/aws-sdk-go-v2/aws/ec2metadata"
  28         "github.com/aws/aws-sdk-go-v2/aws/ec2rolecreds"
  29         "github.com/aws/aws-sdk-go-v2/aws/endpoints"
  30         "github.com/aws/aws-sdk-go-v2/service/s3"
  31         "github.com/aws/aws-sdk-go-v2/service/s3/s3manager"
  32         "github.com/prometheus/client_golang/prometheus"
  33         "github.com/sirupsen/logrus"
  34 )
  35
  36 // S3Volume implements Volume using an S3 bucket.
  37 type S3AWSVolume struct {
  38         arvados.S3VolumeDriverParameters
  39         AuthToken      string    // populated automatically when IAMRole is used
  40         AuthExpiration time.Time // populated automatically when IAMRole is used
  41
  42         cluster   *arvados.Cluster
  43         volume    arvados.Volume
  44         logger    logrus.FieldLogger
  45         metrics   *volumeMetricsVecs
  46         bucket    *s3AWSbucket
  47         region    string
  48         startOnce sync.Once
  49 }
  50
  51 // s3bucket wraps s3.bucket and counts I/O and API usage stats. The
  52 // wrapped bucket can be replaced atomically with SetBucket in order
  53 // to update credentials.
  54 type s3AWSbucket struct {
  55         bucket string
  56         svc    *s3.Client
  57         stats  s3awsbucketStats
  58         mu     sync.Mutex
  59 }
  60
  61 // chooseS3VolumeDriver distinguishes between the old goamz driver and
  62 // aws-sdk-go based on the AlternateDriver feature flag
  63 func chooseS3VolumeDriver(cluster *arvados.Cluster, volume arvados.Volume, logger logrus.FieldLogger, metrics *volumeMetricsVecs) (Volume, error) {
  64         v := &S3Volume{cluster: cluster, volume: volume, metrics: metrics}
  65         err := json.Unmarshal(volume.DriverParameters, &v)
  66         if err != nil {
  67                 return nil, err
  68         }
  69         if v.AlternateDriver {
  70                 logger.Debugln("Using alternate S3 driver (aws-go)")
  71                 return newS3AWSVolume(cluster, volume, logger, metrics)
  72         } else {
  73                 logger.Debugln("Using standard S3 driver (goamz)")
  74                 return newS3Volume(cluster, volume, logger, metrics)
  75         }
  76 }
  77
  78 var s3AWSKeepBlockRegexp = regexp.MustCompile(`^[0-9a-f]{32}$`)
  79 var s3AWSZeroTime time.Time
  80
  81 func (v *S3AWSVolume) isKeepBlock(s string) bool {
  82         return s3AWSKeepBlockRegexp.MatchString(s)
  83 }
  84
  85 func newS3AWSVolume(cluster *arvados.Cluster, volume arvados.Volume, logger logrus.FieldLogger, metrics *volumeMetricsVecs) (Volume, error) {
  86         logger.Debugln("in newS3AWSVolume")
  87         v := &S3AWSVolume{cluster: cluster, volume: volume, metrics: metrics}
  88         err := json.Unmarshal(volume.DriverParameters, &v)
  89         if err != nil {
  90                 return nil, err
  91         }
  92         v.logger = logger.WithField("Volume", v.String())
  93         v.logger.Debugln("in newS3AWSVolume after volume set")
  94         return v, v.check("")
  95 }
  96
  97 func (v *S3AWSVolume) translateError(err error) error {
  98         if aerr, ok := err.(awserr.Error); ok {
  99                 switch aerr.Code() {
 100                 case "NotFound":
 101                         return os.ErrNotExist
 102                 case "NoSuchKey":
 103                         return os.ErrNotExist
 104                 }
 105         }
 106         return err
 107 }
 108
 109 // safeCopy calls CopyObjectRequest, and checks the response to make sure the
 110 // copy succeeded and updated the timestamp on the destination object
 111 //
 112 // (If something goes wrong during the copy, the error will be embedded in the
 113 // 200 OK response)
 114 func (v *S3AWSVolume) safeCopy(dst, src string) error {
 115         input := &s3.CopyObjectInput{
 116                 Bucket:      aws.String(v.bucket.bucket),
 117                 ContentType: aws.String("application/octet-stream"),
 118                 CopySource:  aws.String(v.bucket.bucket + "/" + src),
 119                 Key:         aws.String(dst),
 120         }
 121
 122         req := v.bucket.svc.CopyObjectRequest(input)
 123         resp, err := req.Send(context.Background())
 124
 125         err = v.translateError(err)
 126         if os.IsNotExist(err) {
 127                 return err
 128         } else if err != nil {
 129                 return fmt.Errorf("PutCopy(%q ← %q): %s", dst, v.bucket.bucket+"/"+src, err)
 130         }
 131
 132         if resp.CopyObjectResult.LastModified == nil {
 133                 return fmt.Errorf("PutCopy succeeded but did not return a timestamp: %q: %s", resp.CopyObjectResult.LastModified, err)
 134         } else if time.Now().Sub(*resp.CopyObjectResult.LastModified) > maxClockSkew {
 135                 return fmt.Errorf("PutCopy succeeded but returned an old timestamp: %q: %s", resp.CopyObjectResult.LastModified, resp.CopyObjectResult.LastModified)
 136         }
 137         return nil
 138 }
 139
 140 func (v *S3AWSVolume) check(ec2metadataHostname string) error {
 141         if v.Bucket == "" {
 142                 return errors.New("DriverParameters: Bucket must be provided")
 143         }
 144         if v.IndexPageSize == 0 {
 145                 v.IndexPageSize = 1000
 146         }
 147         if v.RaceWindow < 0 {
 148                 return errors.New("DriverParameters: RaceWindow must not be negative")
 149         }
 150
 151         defaultResolver := endpoints.NewDefaultResolver()
 152
 153         cfg := defaults.Config()
 154
 155         if v.Endpoint == "" && v.Region == "" {
 156                 return fmt.Errorf("AWS region or endpoint must be specified")
 157         } else if v.Endpoint != "" || ec2metadataHostname != "" {
 158                 myCustomResolver := func(service, region string) (aws.Endpoint, error) {
 159                         if v.Endpoint != "" && service == "s3" {
 160                                 return aws.Endpoint{
 161                                         URL:           v.Endpoint,
 162                                         SigningRegion: v.Region,
 163                                 }, nil
 164                         } else if service == "ec2metadata" && ec2metadataHostname != "" {
 165                                 return aws.Endpoint{
 166                                         URL: ec2metadataHostname,
 167                                 }, nil
 168                         }
 169
 170                         return defaultResolver.ResolveEndpoint(service, region)
 171                 }
 172                 cfg.EndpointResolver = aws.EndpointResolverFunc(myCustomResolver)
 173         }
 174
 175         cfg.Region = v.Region
 176
 177         // Zero timeouts mean "wait forever", which is a bad
 178         // default. Default to long timeouts instead.
 179         if v.ConnectTimeout == 0 {
 180                 v.ConnectTimeout = s3DefaultConnectTimeout
 181         }
 182         if v.ReadTimeout == 0 {
 183                 v.ReadTimeout = s3DefaultReadTimeout
 184         }
 185
 186         creds := aws.NewChainProvider(
 187                 []aws.CredentialsProvider{
 188                         aws.NewStaticCredentialsProvider(v.AccessKey, v.SecretKey, v.AuthToken),
 189                         ec2rolecreds.New(ec2metadata.New(cfg)),
 190                 })
 191
 192         cfg.Credentials = creds
 193
 194         v.bucket = &s3AWSbucket{
 195                 bucket: v.Bucket,
 196                 svc:    s3.New(cfg),
 197         }
 198
 199         // Set up prometheus metrics
 200         lbls := prometheus.Labels{"device_id": v.GetDeviceID()}
 201         v.bucket.stats.opsCounters, v.bucket.stats.errCounters, v.bucket.stats.ioBytes = v.metrics.getCounterVecsFor(lbls)
 202
 203         return nil
 204 }
 205
 206 // String implements fmt.Stringer.
 207 func (v *S3AWSVolume) String() string {
 208         return fmt.Sprintf("s3-bucket:%+q", v.Bucket)
 209 }
 210
 211 // GetDeviceID returns a globally unique ID for the storage bucket.
 212 func (v *S3AWSVolume) GetDeviceID() string {
 213         return "s3://" + v.Endpoint + "/" + v.Bucket
 214 }
 215
 216 // Compare the given data with the stored data.
 217 func (v *S3AWSVolume) Compare(ctx context.Context, loc string, expect []byte) error {
 218         errChan := make(chan error, 1)
 219         go func() {
 220                 _, err := v.Head("recent/" + loc)
 221                 errChan <- err
 222         }()
 223         var err error
 224         select {
 225         case <-ctx.Done():
 226                 return ctx.Err()
 227         case err = <-errChan:
 228         }
 229         if err != nil {
 230                 // Checking for "loc" itself here would interfere with
 231                 // future GET requests.
 232                 //
 233                 // On AWS, if X doesn't exist, a HEAD or GET request
 234                 // for X causes X's non-existence to be cached. Thus,
 235                 // if we test for X, then create X and return a
 236                 // signature to our client, the client might still get
 237                 // 404 from all keepstores when trying to read it.
 238                 //
 239                 // To avoid this, we avoid doing HEAD X or GET X until
 240                 // we know X has been written.
 241                 //
 242                 // Note that X might exist even though recent/X
 243                 // doesn't: for example, the response to HEAD recent/X
 244                 // might itself come from a stale cache. In such
 245                 // cases, we will return a false negative and
 246                 // PutHandler might needlessly create another replica
 247                 // on a different volume. That's not ideal, but it's
 248                 // better than passing the eventually-consistent
 249                 // problem on to our clients.
 250                 return v.translateError(err)
 251         }
 252
 253         input := &s3.GetObjectInput{
 254                 Bucket: aws.String(v.bucket.bucket),
 255                 Key:    aws.String(loc),
 256         }
 257
 258         req := v.bucket.svc.GetObjectRequest(input)
 259         result, err := req.Send(ctx)
 260         if err != nil {
 261                 return v.translateError(err)
 262         }
 263         return v.translateError(compareReaderWithBuf(ctx, result.Body, expect, loc[:32]))
 264 }
 265
 266 // EmptyTrash looks for trashed blocks that exceeded BlobTrashLifetime
 267 // and deletes them from the volume.
 268 func (v *S3AWSVolume) EmptyTrash() {
 269         if v.cluster.Collections.BlobDeleteConcurrency < 1 {
 270                 return
 271         }
 272
 273         var bytesInTrash, blocksInTrash, bytesDeleted, blocksDeleted int64
 274
 275         // Define "ready to delete" as "...when EmptyTrash started".
 276         startT := time.Now()
 277
 278         emptyOneKey := func(trash *s3.Object) {
 279                 v.logger.Warnf("EmptyTrash: looking for trash marker %s with last modified date %s", *trash.Key, *trash.LastModified)
 280                 loc := strings.TrimPrefix(*trash.Key, "trash/")
 281                 if !v.isKeepBlock(loc) {
 282                         return
 283                 }
 284                 atomic.AddInt64(&bytesInTrash, *trash.Size)
 285                 atomic.AddInt64(&blocksInTrash, 1)
 286
 287                 trashT := *(trash.LastModified)
 288                 v.logger.Infof("HEEEEEEE trashT key: %s, type: %T val: %s, startT is %s", *trash.Key, trashT, trashT, startT)
 289                 recent, err := v.Head("recent/" + loc)
 290                 if err != nil && os.IsNotExist(v.translateError(err)) {
 291                         v.logger.Warnf("EmptyTrash: found trash marker %q but no %q (%s); calling Untrash", trash.Key, "recent/"+loc, err)
 292                         err = v.Untrash(loc)
 293                         if err != nil {
 294                                 v.logger.WithError(err).Errorf("EmptyTrash: Untrash(%q) failed", loc)
 295                         }
 296                         return
 297                 } else if err != nil {
 298                         v.logger.WithError(err).Warnf("EmptyTrash: HEAD %q failed", "recent/"+loc)
 299                         return
 300                 }
 301                 v.logger.Infof("recent.LastModified type: %T val: %s", recent.LastModified, recent.LastModified)
 302                 if trashT.Sub(*recent.LastModified) < v.cluster.Collections.BlobSigningTTL.Duration() {
 303                         v.logger.Infof("HERE! recent.lastmodified is smaller than blobsigningttl")
 304                         if age := startT.Sub(*recent.LastModified); age >= v.cluster.Collections.BlobSigningTTL.Duration()-time.Duration(v.RaceWindow) {
 305                                 // recent/loc is too old to protect
 306                                 // loc from being Trashed again during
 307                                 // the raceWindow that starts if we
 308                                 // delete trash/X now.
 309                                 //
 310                                 // Note this means (TrashSweepInterval
 311                                 // < BlobSigningTTL - raceWindow) is
 312                                 // necessary to avoid starvation.
 313                                 v.logger.Infof("EmptyTrash: detected old race for %q, calling fixRace + Touch", loc)
 314                                 v.fixRace(loc)
 315                                 v.Touch(loc)
 316                                 return
 317                         }
 318                         _, err := v.Head(loc)
 319                         if os.IsNotExist(err) {
 320                                 v.logger.Infof("EmptyTrash: detected recent race for %q, calling fixRace", loc)
 321                                 v.fixRace(loc)
 322                                 return
 323                         } else if err != nil {
 324                                 v.logger.WithError(err).Warnf("EmptyTrash: HEAD %q failed", loc)
 325                                 return
 326                         }
 327                 }
 328                 if startT.Sub(trashT) < v.cluster.Collections.BlobTrashLifetime.Duration() {
 329                         v.logger.Infof("HERE! trashT for %s is smaller than blobtrashlifetime: %s < %s", *trash.Key, startT.Sub(trashT), v.cluster.Collections.BlobTrashLifetime.Duration())
 330                         return
 331                 }
 332                 err = v.bucket.Del(*trash.Key)
 333                 if err != nil {
 334                         v.logger.WithError(err).Errorf("EmptyTrash: error deleting %q", *trash.Key)
 335                         return
 336                 }
 337                 atomic.AddInt64(&bytesDeleted, *trash.Size)
 338                 atomic.AddInt64(&blocksDeleted, 1)
 339
 340                 v.logger.Infof("HERE! trash.Key %s should have been deleted", *trash.Key)
 341                 _, err = v.Head(loc)
 342                 if err == nil {
 343                         v.logger.Warnf("EmptyTrash: HEAD %q succeeded immediately after deleting %q", loc, loc)
 344                         return
 345                 }
 346                 if !os.IsNotExist(v.translateError(err)) {
 347                         v.logger.WithError(err).Warnf("EmptyTrash: HEAD %q failed", loc)
 348                         return
 349                 }
 350                 err = v.bucket.Del("recent/" + loc)
 351                 if err != nil {
 352                         v.logger.WithError(err).Warnf("EmptyTrash: error deleting %q", "recent/"+loc)
 353                 }
 354                 v.logger.Infof("HERE! recent/%s should have been deleted", loc)
 355         }
 356
 357         var wg sync.WaitGroup
 358         todo := make(chan *s3.Object, v.cluster.Collections.BlobDeleteConcurrency)
 359         for i := 0; i < v.cluster.Collections.BlobDeleteConcurrency; i++ {
 360                 wg.Add(1)
 361                 go func() {
 362                         defer wg.Done()
 363                         for key := range todo {
 364                                 emptyOneKey(key)
 365                         }
 366                 }()
 367         }
 368
 369         trashL := s3awsLister{
 370                 Logger:   v.logger,
 371                 Bucket:   v.bucket,
 372                 Prefix:   "trash/",
 373                 PageSize: v.IndexPageSize,
 374                 Stats:    &v.bucket.stats,
 375         }
 376         for trash := trashL.First(); trash != nil; trash = trashL.Next() {
 377                 todo <- trash
 378         }
 379         close(todo)
 380         wg.Wait()
 381
 382         if err := trashL.Error(); err != nil {
 383                 v.logger.WithError(err).Error("EmptyTrash: lister failed")
 384         }
 385         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)
 386 }
 387
 388 // fixRace(X) is called when "recent/X" exists but "X" doesn't
 389 // exist. If the timestamps on "recent/"+loc and "trash/"+loc indicate
 390 // there was a race between Put and Trash, fixRace recovers from the
 391 // race by Untrashing the block.
 392 func (v *S3AWSVolume) fixRace(loc string) bool {
 393         trash, err := v.Head("trash/" + loc)
 394         if err != nil {
 395                 if !os.IsNotExist(v.translateError(err)) {
 396                         v.logger.WithError(err).Errorf("fixRace: HEAD %q failed", "trash/"+loc)
 397                 }
 398                 return false
 399         }
 400
 401         recent, err := v.Head("recent/" + loc)
 402         if err != nil {
 403                 v.logger.WithError(err).Errorf("fixRace: HEAD %q failed", "recent/"+loc)
 404                 return false
 405         }
 406
 407         recentTime := *recent.LastModified
 408         trashTime := *trash.LastModified
 409         ageWhenTrashed := trashTime.Sub(recentTime)
 410         if ageWhenTrashed >= v.cluster.Collections.BlobSigningTTL.Duration() {
 411                 // No evidence of a race: block hasn't been written
 412                 // since it became eligible for Trash. No fix needed.
 413                 return false
 414         }
 415
 416         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)
 417         v.logger.Infof("fixRace: copying %q to %q to recover from race between Put/Touch and Trash", "recent/"+loc, loc)
 418         err = v.safeCopy(loc, "trash/"+loc)
 419         if err != nil {
 420                 v.logger.WithError(err).Error("fixRace: copy failed")
 421                 return false
 422         }
 423         return true
 424 }
 425
 426 func (v *S3AWSVolume) Head(loc string) (result *s3.HeadObjectOutput, err error) {
 427         input := &s3.HeadObjectInput{
 428                 Bucket: aws.String(v.bucket.bucket),
 429                 Key:    aws.String(loc),
 430         }
 431
 432         req := v.bucket.svc.HeadObjectRequest(input)
 433         res, err := req.Send(context.TODO())
 434
 435         v.bucket.stats.TickOps("head")
 436         v.bucket.stats.Tick(&v.bucket.stats.Ops, &v.bucket.stats.HeadOps)
 437         v.bucket.stats.TickErr(err)
 438
 439         if err != nil {
 440                 return nil, v.translateError(err)
 441         }
 442         result = res.HeadObjectOutput
 443         return
 444 }
 445
 446 // Get a block: copy the block data into buf, and return the number of
 447 // bytes copied.
 448 func (v *S3AWSVolume) Get(ctx context.Context, loc string, buf []byte) (int, error) {
 449         return getWithPipe(ctx, loc, buf, v)
 450 }
 451
 452 func (v *S3AWSVolume) readWorker(ctx context.Context, loc string) (rdr io.ReadCloser, err error) {
 453         buf := make([]byte, 0, 67108864)
 454         awsBuf := aws.NewWriteAtBuffer(buf)
 455
 456         downloader := s3manager.NewDownloaderWithClient(v.bucket.svc, func(u *s3manager.Downloader) {
 457                 u.PartSize = 5 * 1024 * 1024
 458                 u.Concurrency = 13
 459         })
 460
 461         v.logger.Debugf("Partsize: %d; Concurrency: %d\n", downloader.PartSize, downloader.Concurrency)
 462
 463         _, err = downloader.DownloadWithContext(ctx, awsBuf, &s3.GetObjectInput{
 464                 Bucket: aws.String(v.bucket.bucket),
 465                 Key:    aws.String(loc),
 466         })
 467         v.bucket.stats.TickOps("get")
 468         v.bucket.stats.Tick(&v.bucket.stats.Ops, &v.bucket.stats.GetOps)
 469         v.bucket.stats.TickErr(err)
 470         if err != nil {
 471                 return nil, v.translateError(err)
 472         }
 473         buf = awsBuf.Bytes()
 474
 475         rdr = NewCountingReader(bytes.NewReader(buf), v.bucket.stats.TickInBytes)
 476         return
 477 }
 478
 479 // ReadBlock implements BlockReader.
 480 func (v *S3AWSVolume) ReadBlock(ctx context.Context, loc string, w io.Writer) error {
 481         rdr, err := v.readWorker(ctx, loc)
 482
 483         if err == nil {
 484                 _, err2 := io.Copy(w, rdr)
 485                 if err2 != nil {
 486                         return err2
 487                 }
 488                 return err
 489         }
 490
 491         err = v.translateError(err)
 492         if !os.IsNotExist(err) {
 493                 return err
 494         }
 495
 496         _, err = v.Head("recent/" + loc)
 497         err = v.translateError(err)
 498         if err != nil {
 499                 // If we can't read recent/X, there's no point in
 500                 // trying fixRace. Give up.
 501                 return err
 502         }
 503         if !v.fixRace(loc) {
 504                 err = os.ErrNotExist
 505                 return err
 506         }
 507
 508         rdr, err = v.readWorker(ctx, loc)
 509         if err != nil {
 510                 v.logger.Warnf("reading %s after successful fixRace: %s", loc, err)
 511                 err = v.translateError(err)
 512                 return err
 513         }
 514
 515         _, err = io.Copy(w, rdr)
 516
 517         return err
 518 }
 519
 520 func (b *s3AWSbucket) PutReader(path string, r io.Reader, length int64, contType string, contentMD5 string, contentSHA256 string) error {
 521         if length == 0 {
 522                 // aws-sdk-go will only send Content-Length: 0 when reader
 523                 // is nil due to net.http.Request.ContentLength
 524                 // behavior.  Otherwise, Content-Length header is
 525                 // omitted which will cause some S3 services
 526                 // (including AWS and Ceph RadosGW) to fail to create
 527                 // empty objects.
 528                 r = bytes.NewReader([]byte{})
 529         } else {
 530                 r = NewCountingReader(r, b.stats.TickOutBytes)
 531         }
 532         uploader := s3manager.NewUploaderWithClient(b.svc)
 533         _, err := uploader.Upload(&s3manager.UploadInput{
 534                 Bucket: aws.String(b.bucket),
 535                 Key:    aws.String(path),
 536                 Body:   r,
 537         }, s3manager.WithUploaderRequestOptions(func(r *aws.Request) {
 538                 r.HTTPRequest.Header.Set("X-Amz-Content-Sha256", "UNSIGNED-PAYLOAD")
 539         }))
 540
 541         b.stats.TickOps("put")
 542         b.stats.Tick(&b.stats.Ops, &b.stats.PutOps)
 543         b.stats.TickErr(err)
 544         return err
 545 }
 546
 547 // Put writes a block.
 548 func (v *S3AWSVolume) Put(ctx context.Context, loc string, block []byte) error {
 549         return putWithPipe(ctx, loc, block, v)
 550 }
 551
 552 // WriteBlock implements BlockWriter.
 553 func (v *S3AWSVolume) WriteBlock(ctx context.Context, loc string, rdr io.Reader) error {
 554         if v.volume.ReadOnly {
 555                 return MethodDisabledError
 556         }
 557
 558         r := NewCountingReader(rdr, v.bucket.stats.TickOutBytes)
 559         uploadInput := s3manager.UploadInput{
 560                 Bucket: aws.String(v.bucket.bucket),
 561                 Key:    aws.String(loc),
 562                 Body:   r,
 563         }
 564
 565         //var contentMD5, contentSHA256 string
 566         var contentMD5 string
 567         md5, err := hex.DecodeString(loc)
 568         if err != nil {
 569                 return err
 570         }
 571         contentMD5 = base64.StdEncoding.EncodeToString(md5)
 572         // See if this is the empty block
 573         if contentMD5 != "d41d8cd98f00b204e9800998ecf8427e" {
 574                 uploadInput.ContentMD5 = &contentMD5
 575         }
 576
 577         // Some experimentation indicated that using concurrency 5 yields the best
 578         // throughput, better than higher concurrency (10 or 13) by ~5%.
 579         // Defining u.BufferProvider = s3manager.NewBufferedReadSeekerWriteToPool(64 * 1024 * 1024)
 580         // is detrimental to througput (minus ~15%).
 581         uploader := s3manager.NewUploaderWithClient(v.bucket.svc, func(u *s3manager.Uploader) {
 582                 u.PartSize = 5 * 1024 * 1024
 583                 u.Concurrency = 5
 584         })
 585
 586         // Unlike the goamz S3 driver, we don't need to precompute ContentSHA256:
 587         // the aws-sdk-go v2 SDK uses a ReadSeeker to avoid having to copy the
 588         // block, so there is no extra memory use to be concerned about. See
 589         // makeSha256Reader in aws/signer/v4/v4.go. In fact, we explicitly disable
 590         // calculating the Sha-256 because we don't need it; we already use md5sum
 591         // hashes that match the name of the block.
 592         _, err = uploader.UploadWithContext(ctx, &uploadInput, s3manager.WithUploaderRequestOptions(func(r *aws.Request) {
 593                 r.HTTPRequest.Header.Set("X-Amz-Content-Sha256", "UNSIGNED-PAYLOAD")
 594         }))
 595
 596         v.bucket.stats.TickOps("put")
 597         v.bucket.stats.Tick(&v.bucket.stats.Ops, &v.bucket.stats.PutOps)
 598         v.bucket.stats.TickErr(err)
 599         if err != nil {
 600                 return err
 601         }
 602
 603         empty := bytes.NewReader([]byte{})
 604         _, err = uploader.UploadWithContext(ctx, &s3manager.UploadInput{
 605                 Bucket: aws.String(v.bucket.bucket),
 606                 Key:    aws.String("recent/" + loc),
 607                 Body:   empty,
 608         }, s3manager.WithUploaderRequestOptions(func(r *aws.Request) {
 609                 r.HTTPRequest.Header.Set("X-Amz-Content-Sha256", "UNSIGNED-PAYLOAD")
 610         }))
 611         v.bucket.stats.TickOps("put")
 612         v.bucket.stats.Tick(&v.bucket.stats.Ops, &v.bucket.stats.PutOps)
 613         v.bucket.stats.TickErr(err)
 614
 615         return err
 616 }
 617
 618 type s3awsLister struct {
 619         Logger            logrus.FieldLogger
 620         Bucket            *s3AWSbucket //*s3.Bucket
 621         Prefix            string
 622         PageSize          int
 623         Stats             *s3awsbucketStats
 624         ContinuationToken string
 625         buf               []s3.Object
 626         err               error
 627 }
 628
 629 // First fetches the first page and returns the first item. It returns
 630 // nil if the response is the empty set or an error occurs.
 631 func (lister *s3awsLister) First() *s3.Object {
 632         lister.getPage()
 633         return lister.pop()
 634 }
 635
 636 // Next returns the next item, fetching the next page if necessary. It
 637 // returns nil if the last available item has already been fetched, or
 638 // an error occurs.
 639 func (lister *s3awsLister) Next() *s3.Object {
 640         if len(lister.buf) == 0 && lister.ContinuationToken != "" {
 641                 lister.getPage()
 642         }
 643         return lister.pop()
 644 }
 645
 646 // Return the most recent error encountered by First or Next.
 647 func (lister *s3awsLister) Error() error {
 648         return lister.err
 649 }
 650
 651 func (lister *s3awsLister) getPage() {
 652         lister.Stats.TickOps("list")
 653         lister.Stats.Tick(&lister.Stats.Ops, &lister.Stats.ListOps)
 654
 655         var input *s3.ListObjectsV2Input
 656         if lister.ContinuationToken == "" {
 657                 input = &s3.ListObjectsV2Input{
 658                         Bucket:  aws.String(lister.Bucket.bucket),
 659                         MaxKeys: aws.Int64(int64(lister.PageSize)),
 660                         Prefix:  aws.String(lister.Prefix),
 661                 }
 662         } else {
 663                 input = &s3.ListObjectsV2Input{
 664                         Bucket:            aws.String(lister.Bucket.bucket),
 665                         MaxKeys:           aws.Int64(int64(lister.PageSize)),
 666                         Prefix:            aws.String(lister.Prefix),
 667                         ContinuationToken: &lister.ContinuationToken,
 668                 }
 669         }
 670
 671         req := lister.Bucket.svc.ListObjectsV2Request(input)
 672         resp, err := req.Send(context.Background())
 673         if err != nil {
 674                 if aerr, ok := err.(awserr.Error); ok {
 675                         lister.err = aerr
 676                 } else {
 677                         lister.err = err
 678                 }
 679                 return
 680         }
 681
 682         if *resp.IsTruncated {
 683                 lister.ContinuationToken = *resp.NextContinuationToken
 684         } else {
 685                 lister.ContinuationToken = ""
 686         }
 687         lister.buf = make([]s3.Object, 0, len(resp.Contents))
 688         for _, key := range resp.Contents {
 689                 if !strings.HasPrefix(*key.Key, lister.Prefix) {
 690                         lister.Logger.Warnf("s3awsLister: S3 Bucket.List(prefix=%q) returned key %q", lister.Prefix, *key.Key)
 691                         continue
 692                 }
 693                 lister.buf = append(lister.buf, key)
 694         }
 695 }
 696
 697 func (lister *s3awsLister) pop() (k *s3.Object) {
 698         if len(lister.buf) > 0 {
 699                 k = &lister.buf[0]
 700                 lister.buf = lister.buf[1:]
 701         }
 702         return
 703 }
 704
 705 // IndexTo writes a complete list of locators with the given prefix
 706 // for which Get() can retrieve data.
 707 func (v *S3AWSVolume) IndexTo(prefix string, writer io.Writer) error {
 708         // Use a merge sort to find matching sets of X and recent/X.
 709         dataL := s3awsLister{
 710                 Logger:   v.logger,
 711                 Bucket:   v.bucket,
 712                 Prefix:   prefix,
 713                 PageSize: v.IndexPageSize,
 714                 Stats:    &v.bucket.stats,
 715         }
 716         recentL := s3awsLister{
 717                 Logger:   v.logger,
 718                 Bucket:   v.bucket,
 719                 Prefix:   "recent/" + prefix,
 720                 PageSize: v.IndexPageSize,
 721                 Stats:    &v.bucket.stats,
 722         }
 723         for data, recent := dataL.First(), recentL.First(); data != nil && dataL.Error() == nil; data = dataL.Next() {
 724                 if *data.Key >= "g" {
 725                         // Conveniently, "recent/*" and "trash/*" are
 726                         // lexically greater than all hex-encoded data
 727                         // hashes, so stopping here avoids iterating
 728                         // over all of them needlessly with dataL.
 729                         break
 730                 }
 731                 if !v.isKeepBlock(*data.Key) {
 732                         continue
 733                 }
 734
 735                 // stamp is the list entry we should use to report the
 736                 // last-modified time for this data block: it will be
 737                 // the recent/X entry if one exists, otherwise the
 738                 // entry for the data block itself.
 739                 stamp := data
 740
 741                 // Advance to the corresponding recent/X marker, if any
 742                 for recent != nil && recentL.Error() == nil {
 743                         if cmp := strings.Compare((*recent.Key)[7:], *data.Key); cmp < 0 {
 744                                 recent = recentL.Next()
 745                                 continue
 746                         } else if cmp == 0 {
 747                                 stamp = recent
 748                                 recent = recentL.Next()
 749                                 break
 750                         } else {
 751                                 // recent/X marker is missing: we'll
 752                                 // use the timestamp on the data
 753                                 // object.
 754                                 break
 755                         }
 756                 }
 757                 if err := recentL.Error(); err != nil {
 758                         return err
 759                 }
 760                 fmt.Fprintf(writer, "%s+%d %d\n", *data.Key, *data.Size, stamp.LastModified.UnixNano())
 761         }
 762         return dataL.Error()
 763 }
 764
 765 // Mtime returns the stored timestamp for the given locator.
 766 func (v *S3AWSVolume) Mtime(loc string) (time.Time, error) {
 767         _, err := v.Head(loc)
 768         if err != nil {
 769                 return s3AWSZeroTime, v.translateError(err)
 770         }
 771         resp, err := v.Head("recent/" + loc)
 772         err = v.translateError(err)
 773         if os.IsNotExist(err) {
 774                 // The data object X exists, but recent/X is missing.
 775                 err = v.bucket.PutReader("recent/"+loc, nil, 0, "application/octet-stream", "", "")
 776                 if err != nil {
 777                         v.logger.WithError(err).Errorf("error creating %q", "recent/"+loc)
 778                         return s3AWSZeroTime, v.translateError(err)
 779                 }
 780                 v.logger.Infof("created %q to migrate existing block to new storage scheme", "recent/"+loc)
 781                 resp, err = v.Head("recent/" + loc)
 782                 if err != nil {
 783                         v.logger.WithError(err).Errorf("HEAD failed after creating %q", "recent/"+loc)
 784                         return s3AWSZeroTime, v.translateError(err)
 785                 }
 786         } else if err != nil {
 787                 // HEAD recent/X failed for some other reason.
 788                 return s3AWSZeroTime, err
 789         }
 790         return *resp.LastModified, err
 791 }
 792
 793 // Status returns a *VolumeStatus representing the current in-use
 794 // storage capacity and a fake available capacity that doesn't make
 795 // the volume seem full or nearly-full.
 796 func (v *S3AWSVolume) Status() *VolumeStatus {
 797         return &VolumeStatus{
 798                 DeviceNum: 1,
 799                 BytesFree: BlockSize * 1000,
 800                 BytesUsed: 1,
 801         }
 802 }
 803
 804 // InternalStats returns bucket I/O and API call counters.
 805 func (v *S3AWSVolume) InternalStats() interface{} {
 806         return &v.bucket.stats
 807 }
 808
 809 // Touch sets the timestamp for the given locator to the current time.
 810 func (v *S3AWSVolume) Touch(loc string) error {
 811         if v.volume.ReadOnly {
 812                 return MethodDisabledError
 813         }
 814         _, err := v.Head(loc)
 815         err = v.translateError(err)
 816         if os.IsNotExist(err) && v.fixRace(loc) {
 817                 // The data object got trashed in a race, but fixRace
 818                 // rescued it.
 819         } else if err != nil {
 820                 return err
 821         }
 822         err = v.bucket.PutReader("recent/"+loc, nil, 0, "application/octet-stream", "", "")
 823         return v.translateError(err)
 824 }
 825
 826 // checkRaceWindow returns a non-nil error if trash/loc is, or might
 827 // be, in the race window (i.e., it's not safe to trash loc).
 828 func (v *S3AWSVolume) checkRaceWindow(loc string) error {
 829         resp, err := v.Head("trash/" + loc)
 830         err = v.translateError(err)
 831         if os.IsNotExist(err) {
 832                 // OK, trash/X doesn't exist so we're not in the race
 833                 // window
 834                 return nil
 835         } else if err != nil {
 836                 // Error looking up trash/X. We don't know whether
 837                 // we're in the race window
 838                 return err
 839         }
 840         t := resp.LastModified
 841         safeWindow := t.Add(v.cluster.Collections.BlobTrashLifetime.Duration()).Sub(time.Now().Add(time.Duration(v.RaceWindow)))
 842         if safeWindow <= 0 {
 843                 // We can't count on "touch trash/X" to prolong
 844                 // trash/X's lifetime. The new timestamp might not
 845                 // become visible until now+raceWindow, and EmptyTrash
 846                 // is allowed to delete trash/X before then.
 847                 return fmt.Errorf("same block is already in trash, and safe window ended %s ago", -safeWindow)
 848         }
 849         // trash/X exists, but it won't be eligible for deletion until
 850         // after now+raceWindow, so it's safe to overwrite it.
 851         return nil
 852 }
 853
 854 func (b *s3AWSbucket) Del(path string) error {
 855         input := &s3.DeleteObjectInput{
 856                 Bucket: aws.String(b.bucket),
 857                 Key:    aws.String(path),
 858         }
 859         req := b.svc.DeleteObjectRequest(input)
 860         _, err := req.Send(context.Background())
 861         //err := b.Bucket().Del(path)
 862         b.stats.TickOps("delete")
 863         b.stats.Tick(&b.stats.Ops, &b.stats.DelOps)
 864         b.stats.TickErr(err)
 865         return err
 866 }
 867
 868 // Trash a Keep block.
 869 func (v *S3AWSVolume) Trash(loc string) error {
 870         if v.volume.ReadOnly {
 871                 return MethodDisabledError
 872         }
 873         if t, err := v.Mtime(loc); err != nil {
 874                 return err
 875         } else if time.Since(t) < v.cluster.Collections.BlobSigningTTL.Duration() {
 876                 return nil
 877         }
 878         if v.cluster.Collections.BlobTrashLifetime == 0 {
 879                 if !v.UnsafeDelete {
 880                         return ErrS3TrashDisabled
 881                 }
 882                 return v.translateError(v.bucket.Del(loc))
 883         }
 884         err := v.checkRaceWindow(loc)
 885         if err != nil {
 886                 return err
 887         }
 888         err = v.safeCopy("trash/"+loc, loc)
 889         if err != nil {
 890                 return err
 891         }
 892         return v.translateError(v.bucket.Del(loc))
 893 }
 894
 895 // Untrash moves block from trash back into store
 896 func (v *S3AWSVolume) Untrash(loc string) error {
 897         err := v.safeCopy(loc, "trash/"+loc)
 898         if err != nil {
 899                 return err
 900         }
 901         err = v.bucket.PutReader("recent/"+loc, nil, 0, "application/octet-stream", "", "")
 902         return v.translateError(err)
 903 }
 904
 905 type s3awsbucketStats struct {
 906         statsTicker
 907         Ops     uint64
 908         GetOps  uint64
 909         PutOps  uint64
 910         HeadOps uint64
 911         DelOps  uint64
 912         ListOps uint64
 913 }
 914
 915 func (s *s3awsbucketStats) TickErr(err error) {
 916         if err == nil {
 917                 return
 918         }
 919         errType := fmt.Sprintf("%T", err)
 920         if aerr, ok := err.(awserr.Error); ok {
 921                 if reqErr, ok := err.(awserr.RequestFailure); ok {
 922                         // A service error occurred
 923                         errType = errType + fmt.Sprintf(" %d %s", reqErr.StatusCode(), aerr.Code())
 924                 } else {
 925                         errType = errType + fmt.Sprintf(" 000 %s", aerr.Code())
 926                 }
 927         }
 928         s.statsTicker.TickErr(err, errType)
 929 }