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