services/keepstore/s3_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         "net/url"
  17         "os"
  18         "regexp"
  19         "strings"
  20         "sync"
  21         "sync/atomic"
  22         "time"
  23
  24         "git.arvados.org/arvados.git/sdk/go/arvados"
  25         "github.com/aws/aws-sdk-go-v2/aws"
  26         v4 "github.com/aws/aws-sdk-go-v2/aws/signer/v4"
  27         "github.com/aws/aws-sdk-go-v2/config"
  28         "github.com/aws/aws-sdk-go-v2/credentials"
  29         "github.com/aws/aws-sdk-go-v2/feature/s3/manager"
  30         "github.com/aws/aws-sdk-go-v2/service/s3"
  31         "github.com/aws/aws-sdk-go-v2/service/s3/types"
  32         "github.com/aws/smithy-go"
  33         "github.com/prometheus/client_golang/prometheus"
  34         "github.com/sirupsen/logrus"
  35 )
  36
  37 func init() {
  38         driver["S3"] = news3Volume
  39 }
  40
  41 const (
  42         s3DefaultReadTimeout        = arvados.Duration(10 * time.Minute)
  43         s3DefaultConnectTimeout     = arvados.Duration(time.Minute)
  44         maxClockSkew                = 600 * time.Second
  45         nearlyRFC1123               = "Mon, 2 Jan 2006 15:04:05 GMT"
  46         s3downloaderPartSize        = 6 * 1024 * 1024
  47         s3downloaderReadConcurrency = 11
  48         s3uploaderPartSize          = 5 * 1024 * 1024
  49         s3uploaderWriteConcurrency  = 5
  50 )
  51
  52 var (
  53         errS3TrashDisabled        = fmt.Errorf("trash function is disabled because Collections.BlobTrashLifetime=0 and DriverParameters.UnsafeDelete=false")
  54         s3AWSKeepBlockRegexp      = regexp.MustCompile(`^[0-9a-f]{32}$`)
  55         s3AWSZeroTime             time.Time
  56         defaultEndpointResolverV2 = s3.NewDefaultEndpointResolverV2()
  57
  58         // Returned by an aws.EndpointResolverWithOptions to indicate
  59         // that the default resolver should be used.
  60         errEndpointNotOverridden = &aws.EndpointNotFoundError{Err: errors.New("endpoint not overridden")}
  61 )
  62
  63 // s3Volume implements Volume using an S3 bucket.
  64 type s3Volume struct {
  65         arvados.S3VolumeDriverParameters
  66
  67         cluster    *arvados.Cluster
  68         volume     arvados.Volume
  69         logger     logrus.FieldLogger
  70         metrics    *volumeMetricsVecs
  71         bufferPool *bufferPool
  72         bucket     *s3Bucket
  73         region     string
  74         startOnce  sync.Once
  75
  76         overrideEndpoint *aws.Endpoint
  77 }
  78
  79 // s3bucket wraps s3.bucket and counts I/O and API usage stats. The
  80 // wrapped bucket can be replaced atomically with SetBucket in order
  81 // to update credentials.
  82 type s3Bucket struct {
  83         bucket string
  84         svc    *s3.Client
  85         stats  s3awsbucketStats
  86         mu     sync.Mutex
  87 }
  88
  89 func (v *s3Volume) isKeepBlock(s string) (string, bool) {
  90         if v.PrefixLength > 0 && len(s) == v.PrefixLength+33 && s[:v.PrefixLength] == s[v.PrefixLength+1:v.PrefixLength*2+1] {
  91                 s = s[v.PrefixLength+1:]
  92         }
  93         return s, s3AWSKeepBlockRegexp.MatchString(s)
  94 }
  95
  96 // Return the key used for a given loc. If PrefixLength==0 then
  97 // key("abcdef0123") is "abcdef0123", if PrefixLength==3 then key is
  98 // "abc/abcdef0123", etc.
  99 func (v *s3Volume) key(loc string) string {
 100         if v.PrefixLength > 0 && v.PrefixLength < len(loc)-1 {
 101                 return loc[:v.PrefixLength] + "/" + loc
 102         } else {
 103                 return loc
 104         }
 105 }
 106
 107 func news3Volume(params newVolumeParams) (volume, error) {
 108         v := &s3Volume{
 109                 cluster:    params.Cluster,
 110                 volume:     params.ConfigVolume,
 111                 metrics:    params.MetricsVecs,
 112                 bufferPool: params.BufferPool,
 113         }
 114         err := json.Unmarshal(params.ConfigVolume.DriverParameters, v)
 115         if err != nil {
 116                 return nil, err
 117         }
 118         v.logger = params.Logger.WithField("Volume", v.DeviceID())
 119         return v, v.check("")
 120 }
 121
 122 func (v *s3Volume) translateError(err error) error {
 123         if cerr := (interface{ CanceledError() bool })(nil); errors.As(err, &cerr) && cerr.CanceledError() {
 124                 // *aws.RequestCanceledError and *smithy.CanceledError
 125                 // implement this interface.
 126                 return context.Canceled
 127         }
 128         var aerr smithy.APIError
 129         if errors.As(err, &aerr) {
 130                 switch aerr.ErrorCode() {
 131                 case "NotFound", "NoSuchKey":
 132                         return os.ErrNotExist
 133                 }
 134         }
 135         return err
 136 }
 137
 138 // safeCopy calls CopyObjectRequest, and checks the response to make
 139 // sure the copy succeeded and updated the timestamp on the
 140 // destination object
 141 //
 142 // (If something goes wrong during the copy, the error will be
 143 // embedded in the 200 OK response)
 144 func (v *s3Volume) safeCopy(dst, src string) error {
 145         input := &s3.CopyObjectInput{
 146                 Bucket:      aws.String(v.bucket.bucket),
 147                 ContentType: aws.String("application/octet-stream"),
 148                 CopySource:  aws.String(v.bucket.bucket + "/" + src),
 149                 Key:         aws.String(dst),
 150         }
 151
 152         resp, err := v.bucket.svc.CopyObject(context.Background(), input)
 153
 154         err = v.translateError(err)
 155         if os.IsNotExist(err) {
 156                 return err
 157         } else if err != nil {
 158                 return fmt.Errorf("PutCopy(%q ← %q): %s", dst, v.bucket.bucket+"/"+src, err)
 159         } else if resp.CopyObjectResult.LastModified == nil {
 160                 return fmt.Errorf("PutCopy(%q ← %q): succeeded but did not return a timestamp", dst, v.bucket.bucket+"/"+src)
 161         } else if skew := time.Now().UTC().Sub(*resp.CopyObjectResult.LastModified); skew > maxClockSkew {
 162                 return fmt.Errorf("PutCopy succeeded but returned old timestamp %s (skew %v > max %v, now %s)", resp.CopyObjectResult.LastModified, skew, maxClockSkew, time.Now())
 163         }
 164         return nil
 165 }
 166
 167 func (v *s3Volume) check(ec2metadataHostname string) error {
 168         if v.Bucket == "" {
 169                 return errors.New("DriverParameters: Bucket must be provided")
 170         }
 171         if v.IndexPageSize == 0 {
 172                 v.IndexPageSize = 1000
 173         }
 174         if v.RaceWindow < 0 {
 175                 return errors.New("DriverParameters: RaceWindow must not be negative")
 176         }
 177
 178         if v.V2Signature {
 179                 return errors.New("DriverParameters: V2Signature is not supported")
 180         }
 181
 182         if v.Endpoint == "" && v.Region == "" {
 183                 return fmt.Errorf("AWS region or endpoint must be specified")
 184         } else if v.Endpoint != "" {
 185                 _, err := url.Parse(v.Endpoint)
 186                 if err != nil {
 187                         return fmt.Errorf("error parsing custom S3 endpoint %q: %w", v.Endpoint, err)
 188                 }
 189                 v.overrideEndpoint = &aws.Endpoint{
 190                         URL:               v.Endpoint,
 191                         HostnameImmutable: true,
 192                         Source:            aws.EndpointSourceCustom,
 193                 }
 194         }
 195         if v.Region == "" {
 196                 // Endpoint is already specified (otherwise we would
 197                 // have errored out above), but Region is also
 198                 // required by the aws sdk, in order to determine
 199                 // SignatureVersions.
 200                 v.Region = "us-east-1"
 201         }
 202
 203         // Zero timeouts mean "wait forever", which is a bad
 204         // default. Default to long timeouts instead.
 205         if v.ConnectTimeout == 0 {
 206                 v.ConnectTimeout = s3DefaultConnectTimeout
 207         }
 208         if v.ReadTimeout == 0 {
 209                 v.ReadTimeout = s3DefaultReadTimeout
 210         }
 211
 212         cfg, err := config.LoadDefaultConfig(context.TODO(),
 213                 config.WithRegion(v.Region),
 214                 config.WithCredentialsCacheOptions(func(o *aws.CredentialsCacheOptions) {
 215                         // (from aws-sdk-go-v2 comments) "allow the
 216                         // credentials to trigger refreshing prior to
 217                         // the credentials actually expiring. This is
 218                         // beneficial so race conditions with expiring
 219                         // credentials do not cause request to fail
 220                         // unexpectedly due to ExpiredTokenException
 221                         // exceptions."
 222                         //
 223                         // (from
 224                         // https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html)
 225                         // "We make new credentials available at least
 226                         // five minutes before the expiration of the
 227                         // old credentials."
 228                         o.ExpiryWindow = 5 * time.Minute
 229                 }),
 230                 func(o *config.LoadOptions) error {
 231                         if v.AccessKeyID == "" && v.SecretAccessKey == "" {
 232                                 // Use default sdk behavior (IAM / IMDS)
 233                                 return nil
 234                         }
 235                         v.logger.Debug("using static credentials")
 236                         o.Credentials = credentials.StaticCredentialsProvider{
 237                                 Value: aws.Credentials{
 238                                         AccessKeyID:     v.AccessKeyID,
 239                                         SecretAccessKey: v.SecretAccessKey,
 240                                         Source:          "Arvados configuration",
 241                                 },
 242                         }
 243                         return nil
 244                 },
 245                 func(o *config.LoadOptions) error {
 246                         if ec2metadataHostname != "" {
 247                                 o.EC2IMDSEndpoint = ec2metadataHostname
 248                         }
 249                         if v.overrideEndpoint != nil {
 250                                 o.EndpointResolverWithOptions = aws.EndpointResolverWithOptionsFunc(func(service, region string, options ...interface{}) (aws.Endpoint, error) {
 251                                         if service == "S3" {
 252                                                 return *v.overrideEndpoint, nil
 253                                         }
 254                                         return aws.Endpoint{}, errEndpointNotOverridden // use default resolver
 255                                 })
 256                         }
 257                         return nil
 258                 },
 259         )
 260         if err != nil {
 261                 return fmt.Errorf("error loading aws client config: %w", err)
 262         }
 263
 264         v.bucket = &s3Bucket{
 265                 bucket: v.Bucket,
 266                 svc: s3.NewFromConfig(cfg, func(o *s3.Options) {
 267                         if v.UsePathStyle {
 268                                 o.UsePathStyle = true
 269                         }
 270                 }),
 271         }
 272
 273         // Set up prometheus metrics
 274         lbls := prometheus.Labels{"device_id": v.DeviceID()}
 275         v.bucket.stats.opsCounters, v.bucket.stats.errCounters, v.bucket.stats.ioBytes = v.metrics.getCounterVecsFor(lbls)
 276
 277         return nil
 278 }
 279
 280 // DeviceID returns a globally unique ID for the storage bucket.
 281 func (v *s3Volume) DeviceID() string {
 282         return "s3://" + v.Endpoint + "/" + v.Bucket
 283 }
 284
 285 // EmptyTrash looks for trashed blocks that exceeded BlobTrashLifetime
 286 // and deletes them from the volume.
 287 func (v *s3Volume) EmptyTrash() {
 288         var bytesInTrash, blocksInTrash, bytesDeleted, blocksDeleted int64
 289
 290         // Define "ready to delete" as "...when EmptyTrash started".
 291         startT := time.Now()
 292
 293         emptyOneKey := func(trash *types.Object) {
 294                 key := strings.TrimPrefix(*trash.Key, "trash/")
 295                 loc, isblk := v.isKeepBlock(key)
 296                 if !isblk {
 297                         return
 298                 }
 299                 atomic.AddInt64(&bytesInTrash, *trash.Size)
 300                 atomic.AddInt64(&blocksInTrash, 1)
 301
 302                 trashT := *trash.LastModified
 303                 recent, err := v.head("recent/" + key)
 304                 if err != nil && os.IsNotExist(v.translateError(err)) {
 305                         v.logger.Warnf("EmptyTrash: found trash marker %q but no %q (%s); calling Untrash", *trash.Key, "recent/"+key, err)
 306                         err = v.BlockUntrash(loc)
 307                         if err != nil {
 308                                 v.logger.WithError(err).Errorf("EmptyTrash: Untrash(%q) failed", loc)
 309                         }
 310                         return
 311                 } else if err != nil {
 312                         v.logger.WithError(err).Warnf("EmptyTrash: HEAD %q failed", "recent/"+key)
 313                         return
 314                 }
 315                 if trashT.Sub(*recent.LastModified) < v.cluster.Collections.BlobSigningTTL.Duration() {
 316                         if age := startT.Sub(*recent.LastModified); age >= v.cluster.Collections.BlobSigningTTL.Duration()-time.Duration(v.RaceWindow) {
 317                                 // recent/key is too old to protect
 318                                 // loc from being Trashed again during
 319                                 // the raceWindow that starts if we
 320                                 // delete trash/X now.
 321                                 //
 322                                 // Note this means (TrashSweepInterval
 323                                 // < BlobSigningTTL - raceWindow) is
 324                                 // necessary to avoid starvation.
 325                                 v.logger.Infof("EmptyTrash: detected old race for %q, calling fixRace + Touch", loc)
 326                                 v.fixRace(key)
 327                                 v.BlockTouch(loc)
 328                                 return
 329                         }
 330                         _, err := v.head(key)
 331                         if os.IsNotExist(err) {
 332                                 v.logger.Infof("EmptyTrash: detected recent race for %q, calling fixRace", loc)
 333                                 v.fixRace(key)
 334                                 return
 335                         } else if err != nil {
 336                                 v.logger.WithError(err).Warnf("EmptyTrash: HEAD %q failed", loc)
 337                                 return
 338                         }
 339                 }
 340                 if startT.Sub(trashT) < v.cluster.Collections.BlobTrashLifetime.Duration() {
 341                         return
 342                 }
 343                 err = v.bucket.Del(*trash.Key)
 344                 if err != nil {
 345                         v.logger.WithError(err).Errorf("EmptyTrash: error deleting %q", *trash.Key)
 346                         return
 347                 }
 348                 atomic.AddInt64(&bytesDeleted, *trash.Size)
 349                 atomic.AddInt64(&blocksDeleted, 1)
 350
 351                 _, err = v.head(*trash.Key)
 352                 if err == nil {
 353                         v.logger.Warnf("EmptyTrash: HEAD %q succeeded immediately after deleting %q", loc, loc)
 354                         return
 355                 }
 356                 if !os.IsNotExist(v.translateError(err)) {
 357                         v.logger.WithError(err).Warnf("EmptyTrash: HEAD %q failed", key)
 358                         return
 359                 }
 360                 err = v.bucket.Del("recent/" + key)
 361                 if err != nil {
 362                         v.logger.WithError(err).Warnf("EmptyTrash: error deleting %q", "recent/"+key)
 363                 }
 364         }
 365
 366         var wg sync.WaitGroup
 367         todo := make(chan *types.Object, v.cluster.Collections.BlobDeleteConcurrency)
 368         for i := 0; i < v.cluster.Collections.BlobDeleteConcurrency; i++ {
 369                 wg.Add(1)
 370                 go func() {
 371                         defer wg.Done()
 372                         for key := range todo {
 373                                 emptyOneKey(key)
 374                         }
 375                 }()
 376         }
 377
 378         trashL := s3awsLister{
 379                 Logger:   v.logger,
 380                 Bucket:   v.bucket,
 381                 Prefix:   "trash/",
 382                 PageSize: v.IndexPageSize,
 383                 Stats:    &v.bucket.stats,
 384         }
 385         for trash := trashL.First(); trash != nil; trash = trashL.Next() {
 386                 todo <- trash
 387         }
 388         close(todo)
 389         wg.Wait()
 390
 391         if err := trashL.Error(); err != nil {
 392                 v.logger.WithError(err).Error("EmptyTrash: lister failed")
 393         }
 394         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)
 395 }
 396
 397 // fixRace(X) is called when "recent/X" exists but "X" doesn't
 398 // exist. If the timestamps on "recent/X" and "trash/X" indicate there
 399 // was a race between Put and Trash, fixRace recovers from the race by
 400 // Untrashing the block.
 401 func (v *s3Volume) fixRace(key string) bool {
 402         trash, err := v.head("trash/" + key)
 403         if err != nil {
 404                 if !os.IsNotExist(v.translateError(err)) {
 405                         v.logger.WithError(err).Errorf("fixRace: HEAD %q failed", "trash/"+key)
 406                 }
 407                 return false
 408         }
 409
 410         recent, err := v.head("recent/" + key)
 411         if err != nil {
 412                 v.logger.WithError(err).Errorf("fixRace: HEAD %q failed", "recent/"+key)
 413                 return false
 414         }
 415
 416         recentTime := *recent.LastModified
 417         trashTime := *trash.LastModified
 418         ageWhenTrashed := trashTime.Sub(recentTime)
 419         if ageWhenTrashed >= v.cluster.Collections.BlobSigningTTL.Duration() {
 420                 // No evidence of a race: block hasn't been written
 421                 // since it became eligible for Trash. No fix needed.
 422                 return false
 423         }
 424
 425         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)
 426         v.logger.Infof("fixRace: copying %q to %q to recover from race between Put/Touch and Trash", "recent/"+key, key)
 427         err = v.safeCopy(key, "trash/"+key)
 428         if err != nil {
 429                 v.logger.WithError(err).Error("fixRace: copy failed")
 430                 return false
 431         }
 432         return true
 433 }
 434
 435 func (v *s3Volume) head(key string) (result *s3.HeadObjectOutput, err error) {
 436         input := &s3.HeadObjectInput{
 437                 Bucket: aws.String(v.bucket.bucket),
 438                 Key:    aws.String(key),
 439         }
 440
 441         res, err := v.bucket.svc.HeadObject(context.Background(), input)
 442
 443         v.bucket.stats.TickOps("head")
 444         v.bucket.stats.Tick(&v.bucket.stats.Ops, &v.bucket.stats.HeadOps)
 445         v.bucket.stats.TickErr(err)
 446
 447         if err != nil {
 448                 return nil, v.translateError(err)
 449         }
 450         return res, nil
 451 }
 452
 453 // BlockRead reads a Keep block that has been stored as a block blob
 454 // in the S3 bucket.
 455 func (v *s3Volume) BlockRead(ctx context.Context, hash string, w io.WriterAt) error {
 456         key := v.key(hash)
 457         err := v.readWorker(ctx, key, w)
 458         if err != nil {
 459                 err = v.translateError(err)
 460                 if !os.IsNotExist(err) {
 461                         return err
 462                 }
 463
 464                 _, err = v.head("recent/" + key)
 465                 err = v.translateError(err)
 466                 if err != nil {
 467                         // If we can't read recent/X, there's no point in
 468                         // trying fixRace. Give up.
 469                         return err
 470                 }
 471                 if !v.fixRace(key) {
 472                         err = os.ErrNotExist
 473                         return err
 474                 }
 475
 476                 err = v.readWorker(ctx, key, w)
 477                 if err != nil {
 478                         v.logger.Warnf("reading %s after successful fixRace: %s", hash, err)
 479                         err = v.translateError(err)
 480                         return err
 481                 }
 482         }
 483         return nil
 484 }
 485
 486 func (v *s3Volume) readWorker(ctx context.Context, key string, dst io.WriterAt) error {
 487         downloader := manager.NewDownloader(v.bucket.svc, func(u *manager.Downloader) {
 488                 u.PartSize = s3downloaderPartSize
 489                 u.Concurrency = s3downloaderReadConcurrency
 490         })
 491         count, err := downloader.Download(ctx, dst, &s3.GetObjectInput{
 492                 Bucket: aws.String(v.bucket.bucket),
 493                 Key:    aws.String(key),
 494         })
 495         v.bucket.stats.TickOps("get")
 496         v.bucket.stats.Tick(&v.bucket.stats.Ops, &v.bucket.stats.GetOps)
 497         v.bucket.stats.TickErr(err)
 498         v.bucket.stats.TickInBytes(uint64(count))
 499         return v.translateError(err)
 500 }
 501
 502 func (v *s3Volume) writeObject(ctx context.Context, key string, r io.Reader) error {
 503         if r == nil {
 504                 // r == nil leads to a memory violation in func readFillBuf in
 505                 // aws-sdk-go-v2@v0.23.0/service/s3/s3manager/upload.go
 506                 r = bytes.NewReader(nil)
 507         }
 508
 509         uploadInput := s3.PutObjectInput{
 510                 Bucket: aws.String(v.bucket.bucket),
 511                 Key:    aws.String(key),
 512                 Body:   r,
 513         }
 514
 515         if loc, ok := v.isKeepBlock(key); ok {
 516                 var contentMD5 string
 517                 md5, err := hex.DecodeString(loc)
 518                 if err != nil {
 519                         return v.translateError(err)
 520                 }
 521                 contentMD5 = base64.StdEncoding.EncodeToString(md5)
 522                 uploadInput.ContentMD5 = &contentMD5
 523         }
 524
 525         // Experimentation indicated that using concurrency 5 yields the best
 526         // throughput, better than higher concurrency (10 or 13) by ~5%.
 527         // Defining u.BufferProvider = s3manager.NewBufferedReadSeekerWriteToPool(64 * 1024 * 1024)
 528         // is detrimental to throughput (minus ~15%).
 529         uploader := manager.NewUploader(v.bucket.svc, func(u *manager.Uploader) {
 530                 u.PartSize = s3uploaderPartSize
 531                 u.Concurrency = s3uploaderWriteConcurrency
 532         })
 533
 534         _, err := uploader.Upload(ctx, &uploadInput,
 535                 // Avoid precomputing SHA256 before sending.
 536                 manager.WithUploaderRequestOptions(s3.WithAPIOptions(v4.SwapComputePayloadSHA256ForUnsignedPayloadMiddleware)),
 537         )
 538
 539         v.bucket.stats.TickOps("put")
 540         v.bucket.stats.Tick(&v.bucket.stats.Ops, &v.bucket.stats.PutOps)
 541         v.bucket.stats.TickErr(err)
 542
 543         return v.translateError(err)
 544 }
 545
 546 // Put writes a block.
 547 func (v *s3Volume) BlockWrite(ctx context.Context, hash string, data []byte) error {
 548         // Do not use putWithPipe here; we want to pass an io.ReadSeeker to the S3
 549         // sdk to avoid memory allocation there. See #17339 for more information.
 550         rdr := bytes.NewReader(data)
 551         r := newCountingReaderAtSeeker(rdr, v.bucket.stats.TickOutBytes)
 552         key := v.key(hash)
 553         err := v.writeObject(ctx, key, r)
 554         if err != nil {
 555                 return err
 556         }
 557         return v.writeObject(ctx, "recent/"+key, nil)
 558 }
 559
 560 type s3awsLister struct {
 561         Logger            logrus.FieldLogger
 562         Bucket            *s3Bucket
 563         Prefix            string
 564         PageSize          int
 565         Stats             *s3awsbucketStats
 566         ContinuationToken string
 567         buf               []types.Object
 568         err               error
 569 }
 570
 571 // First fetches the first page and returns the first item. It returns
 572 // nil if the response is the empty set or an error occurs.
 573 func (lister *s3awsLister) First() *types.Object {
 574         lister.getPage()
 575         return lister.pop()
 576 }
 577
 578 // Next returns the next item, fetching the next page if necessary. It
 579 // returns nil if the last available item has already been fetched, or
 580 // an error occurs.
 581 func (lister *s3awsLister) Next() *types.Object {
 582         if len(lister.buf) == 0 && lister.ContinuationToken != "" {
 583                 lister.getPage()
 584         }
 585         return lister.pop()
 586 }
 587
 588 // Return the most recent error encountered by First or Next.
 589 func (lister *s3awsLister) Error() error {
 590         return lister.err
 591 }
 592
 593 func (lister *s3awsLister) getPage() {
 594         lister.Stats.TickOps("list")
 595         lister.Stats.Tick(&lister.Stats.Ops, &lister.Stats.ListOps)
 596
 597         var input *s3.ListObjectsV2Input
 598         if lister.ContinuationToken == "" {
 599                 input = &s3.ListObjectsV2Input{
 600                         Bucket:  aws.String(lister.Bucket.bucket),
 601                         MaxKeys: aws.Int32(int32(lister.PageSize)),
 602                         Prefix:  aws.String(lister.Prefix),
 603                 }
 604         } else {
 605                 input = &s3.ListObjectsV2Input{
 606                         Bucket:            aws.String(lister.Bucket.bucket),
 607                         MaxKeys:           aws.Int32(int32(lister.PageSize)),
 608                         Prefix:            aws.String(lister.Prefix),
 609                         ContinuationToken: &lister.ContinuationToken,
 610                 }
 611         }
 612
 613         resp, err := lister.Bucket.svc.ListObjectsV2(context.Background(), input)
 614         if err != nil {
 615                 var aerr smithy.APIError
 616                 if errors.As(err, &aerr) {
 617                         lister.err = aerr
 618                 } else {
 619                         lister.err = err
 620                 }
 621                 return
 622         }
 623
 624         if *resp.IsTruncated {
 625                 lister.ContinuationToken = *resp.NextContinuationToken
 626         } else {
 627                 lister.ContinuationToken = ""
 628         }
 629         lister.buf = make([]types.Object, 0, len(resp.Contents))
 630         for _, key := range resp.Contents {
 631                 if !strings.HasPrefix(*key.Key, lister.Prefix) {
 632                         lister.Logger.Warnf("s3awsLister: S3 Bucket.List(prefix=%q) returned key %q", lister.Prefix, *key.Key)
 633                         continue
 634                 }
 635                 lister.buf = append(lister.buf, key)
 636         }
 637 }
 638
 639 func (lister *s3awsLister) pop() (k *types.Object) {
 640         if len(lister.buf) > 0 {
 641                 k = &lister.buf[0]
 642                 lister.buf = lister.buf[1:]
 643         }
 644         return
 645 }
 646
 647 // Index writes a complete list of locators with the given prefix
 648 // for which Get() can retrieve data.
 649 func (v *s3Volume) Index(ctx context.Context, prefix string, writer io.Writer) error {
 650         prefix = v.key(prefix)
 651         // Use a merge sort to find matching sets of X and recent/X.
 652         dataL := s3awsLister{
 653                 Logger:   v.logger,
 654                 Bucket:   v.bucket,
 655                 Prefix:   prefix,
 656                 PageSize: v.IndexPageSize,
 657                 Stats:    &v.bucket.stats,
 658         }
 659         recentL := s3awsLister{
 660                 Logger:   v.logger,
 661                 Bucket:   v.bucket,
 662                 Prefix:   "recent/" + prefix,
 663                 PageSize: v.IndexPageSize,
 664                 Stats:    &v.bucket.stats,
 665         }
 666         for data, recent := dataL.First(), recentL.First(); data != nil && dataL.Error() == nil; data = dataL.Next() {
 667                 if ctx.Err() != nil {
 668                         return ctx.Err()
 669                 }
 670                 if *data.Key >= "g" {
 671                         // Conveniently, "recent/*" and "trash/*" are
 672                         // lexically greater than all hex-encoded data
 673                         // hashes, so stopping here avoids iterating
 674                         // over all of them needlessly with dataL.
 675                         break
 676                 }
 677                 loc, isblk := v.isKeepBlock(*data.Key)
 678                 if !isblk {
 679                         continue
 680                 }
 681
 682                 // stamp is the list entry we should use to report the
 683                 // last-modified time for this data block: it will be
 684                 // the recent/X entry if one exists, otherwise the
 685                 // entry for the data block itself.
 686                 stamp := data
 687
 688                 // Advance to the corresponding recent/X marker, if any
 689                 for recent != nil && recentL.Error() == nil {
 690                         if cmp := strings.Compare((*recent.Key)[7:], *data.Key); cmp < 0 {
 691                                 recent = recentL.Next()
 692                                 continue
 693                         } else if cmp == 0 {
 694                                 stamp = recent
 695                                 recent = recentL.Next()
 696                                 break
 697                         } else {
 698                                 // recent/X marker is missing: we'll
 699                                 // use the timestamp on the data
 700                                 // object.
 701                                 break
 702                         }
 703                 }
 704                 if err := recentL.Error(); err != nil {
 705                         return err
 706                 }
 707                 // We truncate sub-second precision here. Otherwise
 708                 // timestamps will never match the RFC1123-formatted
 709                 // Last-Modified values parsed by Mtime().
 710                 fmt.Fprintf(writer, "%s+%d %d\n", loc, *data.Size, stamp.LastModified.Unix()*1000000000)
 711         }
 712         return dataL.Error()
 713 }
 714
 715 // Mtime returns the stored timestamp for the given locator.
 716 func (v *s3Volume) Mtime(loc string) (time.Time, error) {
 717         key := v.key(loc)
 718         _, err := v.head(key)
 719         if err != nil {
 720                 return s3AWSZeroTime, v.translateError(err)
 721         }
 722         resp, err := v.head("recent/" + key)
 723         err = v.translateError(err)
 724         if os.IsNotExist(err) {
 725                 // The data object X exists, but recent/X is missing.
 726                 err = v.writeObject(context.Background(), "recent/"+key, nil)
 727                 if err != nil {
 728                         v.logger.WithError(err).Errorf("error creating %q", "recent/"+key)
 729                         return s3AWSZeroTime, v.translateError(err)
 730                 }
 731                 v.logger.Infof("Mtime: created %q to migrate existing block to new storage scheme", "recent/"+key)
 732                 resp, err = v.head("recent/" + key)
 733                 if err != nil {
 734                         v.logger.WithError(err).Errorf("HEAD failed after creating %q", "recent/"+key)
 735                         return s3AWSZeroTime, v.translateError(err)
 736                 }
 737         } else if err != nil {
 738                 // HEAD recent/X failed for some other reason.
 739                 return s3AWSZeroTime, err
 740         }
 741         return *resp.LastModified, err
 742 }
 743
 744 // InternalStats returns bucket I/O and API call counters.
 745 func (v *s3Volume) InternalStats() interface{} {
 746         return &v.bucket.stats
 747 }
 748
 749 // BlockTouch sets the timestamp for the given locator to the current time.
 750 func (v *s3Volume) BlockTouch(hash string) error {
 751         key := v.key(hash)
 752         _, err := v.head(key)
 753         err = v.translateError(err)
 754         if os.IsNotExist(err) && v.fixRace(key) {
 755                 // The data object got trashed in a race, but fixRace
 756                 // rescued it.
 757         } else if err != nil {
 758                 return err
 759         }
 760         err = v.writeObject(context.Background(), "recent/"+key, nil)
 761         return v.translateError(err)
 762 }
 763
 764 // checkRaceWindow returns a non-nil error if trash/key is, or might
 765 // be, in the race window (i.e., it's not safe to trash key).
 766 func (v *s3Volume) checkRaceWindow(key string) error {
 767         resp, err := v.head("trash/" + key)
 768         err = v.translateError(err)
 769         if os.IsNotExist(err) {
 770                 // OK, trash/X doesn't exist so we're not in the race
 771                 // window
 772                 return nil
 773         } else if err != nil {
 774                 // Error looking up trash/X. We don't know whether
 775                 // we're in the race window
 776                 return err
 777         }
 778         t := resp.LastModified
 779         safeWindow := t.Add(v.cluster.Collections.BlobTrashLifetime.Duration()).Sub(time.Now().Add(time.Duration(v.RaceWindow)))
 780         if safeWindow <= 0 {
 781                 // We can't count on "touch trash/X" to prolong
 782                 // trash/X's lifetime. The new timestamp might not
 783                 // become visible until now+raceWindow, and EmptyTrash
 784                 // is allowed to delete trash/X before then.
 785                 return fmt.Errorf("%s: same block is already in trash, and safe window ended %s ago", key, -safeWindow)
 786         }
 787         // trash/X exists, but it won't be eligible for deletion until
 788         // after now+raceWindow, so it's safe to overwrite it.
 789         return nil
 790 }
 791
 792 func (b *s3Bucket) Del(path string) error {
 793         input := &s3.DeleteObjectInput{
 794                 Bucket: aws.String(b.bucket),
 795                 Key:    aws.String(path),
 796         }
 797         _, err := b.svc.DeleteObject(context.Background(), input)
 798         b.stats.TickOps("delete")
 799         b.stats.Tick(&b.stats.Ops, &b.stats.DelOps)
 800         b.stats.TickErr(err)
 801         return err
 802 }
 803
 804 // Trash a Keep block.
 805 func (v *s3Volume) BlockTrash(loc string) error {
 806         if t, err := v.Mtime(loc); err != nil {
 807                 return err
 808         } else if time.Since(t) < v.cluster.Collections.BlobSigningTTL.Duration() {
 809                 return nil
 810         }
 811         key := v.key(loc)
 812         if v.cluster.Collections.BlobTrashLifetime == 0 {
 813                 if !v.UnsafeDelete {
 814                         return errS3TrashDisabled
 815                 }
 816                 return v.translateError(v.bucket.Del(key))
 817         }
 818         err := v.checkRaceWindow(key)
 819         if err != nil {
 820                 return err
 821         }
 822         err = v.safeCopy("trash/"+key, key)
 823         if err != nil {
 824                 return err
 825         }
 826         return v.translateError(v.bucket.Del(key))
 827 }
 828
 829 // BlockUntrash moves block from trash back into store
 830 func (v *s3Volume) BlockUntrash(hash string) error {
 831         key := v.key(hash)
 832         err := v.safeCopy(key, "trash/"+key)
 833         if err != nil {
 834                 return err
 835         }
 836         err = v.writeObject(context.Background(), "recent/"+key, nil)
 837         return v.translateError(err)
 838 }
 839
 840 type s3awsbucketStats struct {
 841         statsTicker
 842         Ops     uint64
 843         GetOps  uint64
 844         PutOps  uint64
 845         HeadOps uint64
 846         DelOps  uint64
 847         ListOps uint64
 848 }
 849
 850 func (s *s3awsbucketStats) TickErr(err error) {
 851         if err == nil {
 852                 return
 853         }
 854         errType := fmt.Sprintf("%T", err)
 855         if aerr := smithy.APIError(nil); errors.As(err, &aerr) {
 856                 if rerr := interface{ HTTPStatusCode() int }(nil); errors.As(err, &rerr) {
 857                         errType = errType + fmt.Sprintf(" %d %s", rerr.HTTPStatusCode(), aerr.ErrorCode())
 858                 } else {
 859                         errType = errType + fmt.Sprintf(" 000 %s", aerr.ErrorCode())
 860                 }
 861         }
 862         s.statsTicker.TickErr(err, errType)
 863 }