services/keepstore/keepstore.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 // Package keepstore implements the keepstore service component and
   6 // back-end storage drivers.
   7 //
   8 // It is an internal module, only intended to be imported by
   9 // /cmd/arvados-server and other server-side components in this
  10 // repository.
  11 package keepstore
  12
  13 import (
  14         "bytes"
  15         "context"
  16         "crypto/md5"
  17         "errors"
  18         "fmt"
  19         "io"
  20         "net/http"
  21         "os"
  22         "sort"
  23         "strconv"
  24         "strings"
  25         "sync"
  26         "sync/atomic"
  27         "time"
  28
  29         "git.arvados.org/arvados.git/sdk/go/arvados"
  30         "git.arvados.org/arvados.git/sdk/go/arvadosclient"
  31         "git.arvados.org/arvados.git/sdk/go/auth"
  32         "git.arvados.org/arvados.git/sdk/go/ctxlog"
  33         "git.arvados.org/arvados.git/sdk/go/httpserver"
  34         "git.arvados.org/arvados.git/sdk/go/keepclient"
  35         "github.com/prometheus/client_golang/prometheus"
  36         "github.com/sirupsen/logrus"
  37 )
  38
  39 // Maximum size of a keep block is 64 MiB.
  40 const BlockSize = 1 << 26
  41
  42 var (
  43         errChecksum          = httpserver.ErrorWithStatus(errors.New("checksum mismatch in stored data"), http.StatusBadGateway)
  44         errNoTokenProvided   = httpserver.ErrorWithStatus(errors.New("no token provided in Authorization header"), http.StatusUnauthorized)
  45         errMethodNotAllowed  = httpserver.ErrorWithStatus(errors.New("method not allowed"), http.StatusMethodNotAllowed)
  46         errVolumeUnavailable = httpserver.ErrorWithStatus(errors.New("volume unavailable"), http.StatusServiceUnavailable)
  47         errCollision         = httpserver.ErrorWithStatus(errors.New("hash collision"), http.StatusInternalServerError)
  48         errExpiredSignature  = httpserver.ErrorWithStatus(errors.New("expired signature"), http.StatusUnauthorized)
  49         errInvalidSignature  = httpserver.ErrorWithStatus(errors.New("invalid signature"), http.StatusBadRequest)
  50         errInvalidLocator    = httpserver.ErrorWithStatus(errors.New("invalid locator"), http.StatusBadRequest)
  51         errFull              = httpserver.ErrorWithStatus(errors.New("insufficient storage"), http.StatusInsufficientStorage)
  52         errTooLarge          = httpserver.ErrorWithStatus(errors.New("request entity too large"), http.StatusRequestEntityTooLarge)
  53         driver               = make(map[string]volumeDriver)
  54 )
  55
  56 type indexOptions struct {
  57         MountUUID string
  58         Prefix    string
  59         WriteTo   io.Writer
  60 }
  61
  62 type mount struct {
  63         arvados.KeepMount
  64         volume
  65         priority int
  66 }
  67
  68 type keepstore struct {
  69         cluster    *arvados.Cluster
  70         logger     logrus.FieldLogger
  71         serviceURL arvados.URL
  72         mounts     map[string]*mount
  73         mountsR    []*mount
  74         mountsW    []*mount
  75         bufferPool *bufferPool
  76
  77         iostats map[volume]*ioStats
  78
  79         remoteClients    map[string]*keepclient.KeepClient
  80         remoteClientsMtx sync.Mutex
  81 }
  82
  83 func newKeepstore(ctx context.Context, cluster *arvados.Cluster, token string, reg *prometheus.Registry, serviceURL arvados.URL) (*keepstore, error) {
  84         logger := ctxlog.FromContext(ctx)
  85
  86         if cluster.API.MaxConcurrentRequests > 0 && cluster.API.MaxConcurrentRequests < cluster.API.MaxKeepBlobBuffers {
  87                 logger.Warnf("Possible configuration mistake: not useful to set API.MaxKeepBlobBuffers (%d) higher than API.MaxConcurrentRequests (%d)", cluster.API.MaxKeepBlobBuffers, cluster.API.MaxConcurrentRequests)
  88         }
  89
  90         if cluster.Collections.BlobSigningKey != "" {
  91         } else if cluster.Collections.BlobSigning {
  92                 return nil, errors.New("cannot enable Collections.BlobSigning with no Collections.BlobSigningKey")
  93         } else {
  94                 logger.Warn("Running without a blob signing key. Block locators returned by this server will not be signed, and will be rejected by a server that enforces permissions. To fix this, configure Collections.BlobSigning and Collections.BlobSigningKey.")
  95         }
  96
  97         if cluster.API.MaxKeepBlobBuffers <= 0 {
  98                 return nil, fmt.Errorf("API.MaxKeepBlobBuffers must be greater than zero")
  99         }
 100         bufferPool := newBufferPool(logger, cluster.API.MaxKeepBlobBuffers, reg)
 101
 102         ks := &keepstore{
 103                 cluster:       cluster,
 104                 logger:        logger,
 105                 serviceURL:    serviceURL,
 106                 bufferPool:    bufferPool,
 107                 remoteClients: make(map[string]*keepclient.KeepClient),
 108         }
 109
 110         err := ks.setupMounts(newVolumeMetricsVecs(reg))
 111         if err != nil {
 112                 return nil, err
 113         }
 114
 115         return ks, nil
 116 }
 117
 118 func (ks *keepstore) setupMounts(metrics *volumeMetricsVecs) error {
 119         ks.mounts = make(map[string]*mount)
 120         if len(ks.cluster.Volumes) == 0 {
 121                 return errors.New("no volumes configured")
 122         }
 123         for uuid, cfgvol := range ks.cluster.Volumes {
 124                 va, ok := cfgvol.AccessViaHosts[ks.serviceURL]
 125                 if !ok && len(cfgvol.AccessViaHosts) > 0 {
 126                         continue
 127                 }
 128                 dri, ok := driver[cfgvol.Driver]
 129                 if !ok {
 130                         return fmt.Errorf("volume %s: invalid driver %q", uuid, cfgvol.Driver)
 131                 }
 132                 vol, err := dri(newVolumeParams{
 133                         UUID:         uuid,
 134                         Cluster:      ks.cluster,
 135                         ConfigVolume: cfgvol,
 136                         Logger:       ks.logger,
 137                         MetricsVecs:  metrics,
 138                         BufferPool:   ks.bufferPool,
 139                 })
 140                 if err != nil {
 141                         return fmt.Errorf("error initializing volume %s: %s", uuid, err)
 142                 }
 143                 sc := cfgvol.StorageClasses
 144                 if len(sc) == 0 {
 145                         sc = map[string]bool{"default": true}
 146                 }
 147                 repl := cfgvol.Replication
 148                 if repl < 1 {
 149                         repl = 1
 150                 }
 151                 pri := 0
 152                 for class, in := range cfgvol.StorageClasses {
 153                         p := ks.cluster.StorageClasses[class].Priority
 154                         if in && p > pri {
 155                                 pri = p
 156                         }
 157                 }
 158                 mnt := &mount{
 159                         volume:   vol,
 160                         priority: pri,
 161                         KeepMount: arvados.KeepMount{
 162                                 UUID:           uuid,
 163                                 DeviceID:       vol.DeviceID(),
 164                                 AllowWrite:     !va.ReadOnly && !cfgvol.ReadOnly,
 165                                 AllowTrash:     !va.ReadOnly && (!cfgvol.ReadOnly || cfgvol.AllowTrashWhenReadOnly),
 166                                 Replication:    repl,
 167                                 StorageClasses: sc,
 168                         },
 169                 }
 170                 ks.mounts[uuid] = mnt
 171                 ks.logger.Printf("started volume %s (%s), AllowWrite=%v, AllowTrash=%v", uuid, vol.DeviceID(), mnt.AllowWrite, mnt.AllowTrash)
 172         }
 173         if len(ks.mounts) == 0 {
 174                 return fmt.Errorf("no volumes configured for %s", ks.serviceURL)
 175         }
 176
 177         ks.mountsR = nil
 178         ks.mountsW = nil
 179         for _, mnt := range ks.mounts {
 180                 ks.mountsR = append(ks.mountsR, mnt)
 181                 if mnt.AllowWrite {
 182                         ks.mountsW = append(ks.mountsW, mnt)
 183                 }
 184         }
 185         // Sorting mounts by UUID makes behavior more predictable, and
 186         // is convenient for testing -- for example, "index all
 187         // volumes" and "trash block on all volumes" will visit
 188         // volumes in predictable order.
 189         sort.Slice(ks.mountsR, func(i, j int) bool { return ks.mountsR[i].UUID < ks.mountsR[j].UUID })
 190         sort.Slice(ks.mountsW, func(i, j int) bool { return ks.mountsW[i].UUID < ks.mountsW[j].UUID })
 191         return nil
 192 }
 193
 194 // checkLocatorSignature checks that locator has a valid signature.
 195 // If the BlobSigning config is false, it returns nil even if the
 196 // signature is invalid or missing.
 197 func (ks *keepstore) checkLocatorSignature(ctx context.Context, locator string) error {
 198         if !ks.cluster.Collections.BlobSigning {
 199                 return nil
 200         }
 201         token := ctxToken(ctx)
 202         if token == "" {
 203                 return errNoTokenProvided
 204         }
 205         err := arvados.VerifySignature(locator, token, ks.cluster.Collections.BlobSigningTTL.Duration(), []byte(ks.cluster.Collections.BlobSigningKey))
 206         if err == arvados.ErrSignatureExpired {
 207                 return errExpiredSignature
 208         } else if err != nil {
 209                 return errInvalidSignature
 210         }
 211         return nil
 212 }
 213
 214 // signLocator signs the locator for the given token, if possible.
 215 // Note this signs if the BlobSigningKey config is available, even if
 216 // the BlobSigning config is false.
 217 func (ks *keepstore) signLocator(token, locator string) string {
 218         if token == "" || len(ks.cluster.Collections.BlobSigningKey) == 0 {
 219                 return locator
 220         }
 221         ttl := ks.cluster.Collections.BlobSigningTTL.Duration()
 222         return arvados.SignLocator(locator, token, time.Now().Add(ttl), ttl, []byte(ks.cluster.Collections.BlobSigningKey))
 223 }
 224
 225 func (ks *keepstore) BlockRead(ctx context.Context, opts arvados.BlockReadOptions) (n int, err error) {
 226         li, err := parseLocator(opts.Locator)
 227         if err != nil {
 228                 return 0, err
 229         }
 230         out := opts.WriteTo
 231         if rw, ok := out.(http.ResponseWriter); ok && li.size > 0 {
 232                 out = &setSizeOnWrite{ResponseWriter: rw, size: li.size}
 233         }
 234         if li.remote && !li.signed {
 235                 return ks.blockReadRemote(ctx, opts)
 236         }
 237         if err := ks.checkLocatorSignature(ctx, opts.Locator); err != nil {
 238                 return 0, err
 239         }
 240         hashcheck := md5.New()
 241         if li.size > 0 {
 242                 out = newHashCheckWriter(out, hashcheck, int64(li.size), li.hash)
 243         } else {
 244                 out = io.MultiWriter(out, hashcheck)
 245         }
 246         var errToCaller error = os.ErrNotExist
 247         for _, mnt := range ks.rendezvous(li.hash, ks.mountsR) {
 248                 if ctx.Err() != nil {
 249                         return 0, ctx.Err()
 250                 }
 251                 n, err = mnt.BlockRead(ctx, li.hash, out)
 252                 if err == nil && li.size > 0 && n != li.size {
 253                         // If the backend read fewer bytes than
 254                         // expected but returns no error, we can
 255                         // classify this as a checksum error (even
 256                         // though hashCheckWriter doesn't know that
 257                         // yet, it's just waiting for the next
 258                         // write). If our caller is serving a GET
 259                         // request it's too late to do anything about
 260                         // it anyway, but if it's a HEAD request the
 261                         // caller can still change the response status
 262                         // code.
 263                         return n, errChecksum
 264                 }
 265                 if err == nil && li.size == 0 {
 266                         // hashCheckingWriter isn't in use because we
 267                         // don't know the expected size. All we can do
 268                         // is check after writing all the data, and
 269                         // trust the caller is doing a HEAD request so
 270                         // it's not too late to set an error code in
 271                         // the response header.
 272                         if hash := fmt.Sprintf("%x", hashcheck.Sum(nil)); hash != li.hash {
 273                                 return n, errChecksum
 274                         }
 275                 }
 276                 if rw, ok := opts.WriteTo.(http.ResponseWriter); ok && li.size == 0 && err == nil {
 277                         // We didn't set the content-length header
 278                         // above because we didn't know the block size
 279                         // until now.
 280                         rw.Header().Set("Content-Length", fmt.Sprintf("%d", n))
 281                 }
 282                 if n > 0 || err == nil {
 283                         // success, or there's an error but we can't
 284                         // retry because we've already sent some data.
 285                         return n, err
 286                 }
 287                 if !os.IsNotExist(err) {
 288                         // If some volume returns a transient error,
 289                         // return it to the caller instead of "Not
 290                         // found" so it can retry.
 291                         errToCaller = err
 292                 }
 293         }
 294         return 0, errToCaller
 295 }
 296
 297 func (ks *keepstore) blockReadRemote(ctx context.Context, opts arvados.BlockReadOptions) (int, error) {
 298         ks.logger.Infof("blockReadRemote(%s)", opts.Locator)
 299         token := ctxToken(ctx)
 300         if token == "" {
 301                 return 0, errNoTokenProvided
 302         }
 303         var remoteClient *keepclient.KeepClient
 304         var parts []string
 305         var size int
 306         for i, part := range strings.Split(opts.Locator, "+") {
 307                 switch {
 308                 case i == 0:
 309                         // don't try to parse hash part as hint
 310                 case strings.HasPrefix(part, "A"):
 311                         // drop local permission hint
 312                         continue
 313                 case len(part) > 7 && part[0] == 'R' && part[6] == '-':
 314                         remoteID := part[1:6]
 315                         remote, ok := ks.cluster.RemoteClusters[remoteID]
 316                         if !ok {
 317                                 return 0, httpserver.ErrorWithStatus(errors.New("remote cluster not configured"), http.StatusBadRequest)
 318                         }
 319                         kc, err := ks.remoteClient(remoteID, remote, token)
 320                         if err == auth.ErrObsoleteToken {
 321                                 return 0, httpserver.ErrorWithStatus(err, http.StatusBadRequest)
 322                         } else if err != nil {
 323                                 return 0, err
 324                         }
 325                         remoteClient = kc
 326                         part = "A" + part[7:]
 327                 case len(part) > 0 && part[0] >= '0' && part[0] <= '9':
 328                         size, _ = strconv.Atoi(part)
 329                 }
 330                 parts = append(parts, part)
 331         }
 332         if remoteClient == nil {
 333                 return 0, httpserver.ErrorWithStatus(errors.New("invalid remote hint"), http.StatusBadRequest)
 334         }
 335         locator := strings.Join(parts, "+")
 336         if opts.LocalLocator == nil {
 337                 // Read from remote cluster and stream response back
 338                 // to caller
 339                 if rw, ok := opts.WriteTo.(http.ResponseWriter); ok && size > 0 {
 340                         rw.Header().Set("Content-Length", fmt.Sprintf("%d", size))
 341                 }
 342                 return remoteClient.BlockRead(ctx, arvados.BlockReadOptions{
 343                         Locator: locator,
 344                         WriteTo: opts.WriteTo,
 345                 })
 346         }
 347         // We must call LocalLocator before writing any data to
 348         // opts.WriteTo, otherwise the caller can't put the local
 349         // locator in a response header.  So we copy into memory,
 350         // generate the local signature, then copy from memory to
 351         // opts.WriteTo.
 352         buf, err := ks.bufferPool.GetContext(ctx)
 353         if err != nil {
 354                 return 0, err
 355         }
 356         defer ks.bufferPool.Put(buf)
 357         writebuf := bytes.NewBuffer(buf[:0])
 358         ks.logger.Infof("blockReadRemote(%s): remote read(%s)", opts.Locator, locator)
 359         _, err = remoteClient.BlockRead(ctx, arvados.BlockReadOptions{
 360                 Locator: locator,
 361                 WriteTo: writebuf,
 362         })
 363         if err != nil {
 364                 return 0, err
 365         }
 366         resp, err := ks.BlockWrite(ctx, arvados.BlockWriteOptions{
 367                 Hash: locator,
 368                 Data: writebuf.Bytes(),
 369         })
 370         if err != nil {
 371                 return 0, err
 372         }
 373         opts.LocalLocator(resp.Locator)
 374         if rw, ok := opts.WriteTo.(http.ResponseWriter); ok {
 375                 rw.Header().Set("Content-Length", fmt.Sprintf("%d", writebuf.Len()))
 376         }
 377         n, err := io.Copy(opts.WriteTo, bytes.NewReader(writebuf.Bytes()))
 378         return int(n), err
 379 }
 380
 381 func (ks *keepstore) remoteClient(remoteID string, remoteCluster arvados.RemoteCluster, token string) (*keepclient.KeepClient, error) {
 382         ks.remoteClientsMtx.Lock()
 383         kc, ok := ks.remoteClients[remoteID]
 384         ks.remoteClientsMtx.Unlock()
 385         if !ok {
 386                 c := &arvados.Client{
 387                         APIHost:   remoteCluster.Host,
 388                         AuthToken: "xxx",
 389                         Insecure:  remoteCluster.Insecure,
 390                 }
 391                 ac, err := arvadosclient.New(c)
 392                 if err != nil {
 393                         return nil, err
 394                 }
 395                 kc, err = keepclient.MakeKeepClient(ac)
 396                 if err != nil {
 397                         return nil, err
 398                 }
 399                 kc.DiskCacheSize = keepclient.DiskCacheDisabled
 400
 401                 ks.remoteClientsMtx.Lock()
 402                 ks.remoteClients[remoteID] = kc
 403                 ks.remoteClientsMtx.Unlock()
 404         }
 405         accopy := *kc.Arvados
 406         accopy.ApiToken = token
 407         kccopy := kc.Clone()
 408         kccopy.Arvados = &accopy
 409         token, err := auth.SaltToken(token, remoteID)
 410         if err != nil {
 411                 return nil, err
 412         }
 413         kccopy.Arvados.ApiToken = token
 414         return kccopy, nil
 415 }
 416
 417 // BlockWrite writes a block to one or more volumes.
 418 func (ks *keepstore) BlockWrite(ctx context.Context, opts arvados.BlockWriteOptions) (arvados.BlockWriteResponse, error) {
 419         var resp arvados.BlockWriteResponse
 420         var hash string
 421         if opts.Data == nil {
 422                 buf, err := ks.bufferPool.GetContext(ctx)
 423                 if err != nil {
 424                         return resp, err
 425                 }
 426                 defer ks.bufferPool.Put(buf)
 427                 w := bytes.NewBuffer(buf[:0])
 428                 h := md5.New()
 429                 limitedReader := &io.LimitedReader{R: opts.Reader, N: BlockSize}
 430                 n, err := io.Copy(io.MultiWriter(w, h), limitedReader)
 431                 if err != nil {
 432                         return resp, err
 433                 }
 434                 if limitedReader.N == 0 {
 435                         // Data size is either exactly BlockSize, or too big.
 436                         n, err := opts.Reader.Read(make([]byte, 1))
 437                         if n > 0 {
 438                                 return resp, httpserver.ErrorWithStatus(err, http.StatusRequestEntityTooLarge)
 439                         }
 440                         if err != io.EOF {
 441                                 return resp, err
 442                         }
 443                 }
 444                 opts.Data = buf[:n]
 445                 if opts.DataSize != 0 && int(n) != opts.DataSize {
 446                         return resp, httpserver.ErrorWithStatus(fmt.Errorf("content length %d did not match specified data size %d", n, opts.DataSize), http.StatusBadRequest)
 447                 }
 448                 hash = fmt.Sprintf("%x", h.Sum(nil))
 449         } else {
 450                 hash = fmt.Sprintf("%x", md5.Sum(opts.Data))
 451         }
 452         if opts.Hash != "" && !strings.HasPrefix(opts.Hash, hash) {
 453                 return resp, httpserver.ErrorWithStatus(fmt.Errorf("content hash %s did not match specified locator %s", hash, opts.Hash), http.StatusBadRequest)
 454         }
 455         rvzmounts := ks.rendezvous(hash, ks.mountsW)
 456         result := newPutProgress(opts.StorageClasses)
 457         for _, mnt := range rvzmounts {
 458                 if !result.Want(mnt) {
 459                         continue
 460                 }
 461                 cmp := &checkEqual{Expect: opts.Data}
 462                 if _, err := mnt.BlockRead(ctx, hash, cmp); err == nil {
 463                         if !cmp.Equal() {
 464                                 return resp, errCollision
 465                         }
 466                         err := mnt.BlockTouch(hash)
 467                         if err == nil {
 468                                 result.Add(mnt)
 469                         }
 470                 }
 471         }
 472         var allFull atomic.Bool
 473         allFull.Store(true)
 474         // pending tracks what result will be if all outstanding
 475         // writes succeed.
 476         pending := result.Copy()
 477         cond := sync.NewCond(new(sync.Mutex))
 478         cond.L.Lock()
 479         var wg sync.WaitGroup
 480 nextmnt:
 481         for _, mnt := range rvzmounts {
 482                 for {
 483                         if result.Done() || ctx.Err() != nil {
 484                                 break nextmnt
 485                         }
 486                         if !result.Want(mnt) {
 487                                 continue nextmnt
 488                         }
 489                         if pending.Want(mnt) {
 490                                 break
 491                         }
 492                         // This mount might not be needed, depending
 493                         // on the outcome of pending writes. Wait for
 494                         // a pending write to finish, then check
 495                         // again.
 496                         cond.Wait()
 497                 }
 498                 mnt := mnt
 499                 logger := ks.logger.WithField("mount", mnt.UUID)
 500                 pending.Add(mnt)
 501                 wg.Add(1)
 502                 go func() {
 503                         defer wg.Done()
 504                         logger.Debug("start write")
 505                         err := mnt.BlockWrite(ctx, hash, opts.Data)
 506                         cond.L.Lock()
 507                         defer cond.L.Unlock()
 508                         defer cond.Broadcast()
 509                         if err != nil {
 510                                 logger.Debug("write failed")
 511                                 pending.Sub(mnt)
 512                                 if err != errFull {
 513                                         allFull.Store(false)
 514                                 }
 515                         } else {
 516                                 result.Add(mnt)
 517                                 pending.Sub(mnt)
 518                         }
 519                 }()
 520         }
 521         cond.L.Unlock()
 522         wg.Wait()
 523         if ctx.Err() != nil {
 524                 return resp, ctx.Err()
 525         }
 526         if result.Done() || result.totalReplication > 0 {
 527                 resp = arvados.BlockWriteResponse{
 528                         Locator:        ks.signLocator(ctxToken(ctx), fmt.Sprintf("%s+%d", hash, len(opts.Data))),
 529                         Replicas:       result.totalReplication,
 530                         StorageClasses: result.classDone,
 531                 }
 532                 return resp, nil
 533         }
 534         if allFull.Load() {
 535                 return resp, errFull
 536         }
 537         return resp, errVolumeUnavailable
 538 }
 539
 540 // rendezvous sorts the given mounts by descending priority, then by
 541 // rendezvous order for the given locator.
 542 func (*keepstore) rendezvous(locator string, mnts []*mount) []*mount {
 543         hash := locator
 544         if len(hash) > 32 {
 545                 hash = hash[:32]
 546         }
 547         // copy the provided []*mount before doing an in-place sort
 548         mnts = append([]*mount(nil), mnts...)
 549         weight := make(map[*mount]string)
 550         for _, mnt := range mnts {
 551                 uuidpart := mnt.UUID
 552                 if len(uuidpart) == 27 {
 553                         // strip zzzzz-yyyyy- prefixes
 554                         uuidpart = uuidpart[12:]
 555                 }
 556                 weight[mnt] = fmt.Sprintf("%x", md5.Sum([]byte(hash+uuidpart)))
 557         }
 558         sort.Slice(mnts, func(i, j int) bool {
 559                 if p := mnts[i].priority - mnts[j].priority; p != 0 {
 560                         return p > 0
 561                 }
 562                 return weight[mnts[i]] < weight[mnts[j]]
 563         })
 564         return mnts
 565 }
 566
 567 // checkEqual reports whether the data written to it (via io.Writer
 568 // interface) is equal to the expected data.
 569 //
 570 // Expect should not be changed after the first Write.
 571 type checkEqual struct {
 572         Expect     []byte
 573         equalUntil int
 574 }
 575
 576 func (ce *checkEqual) Equal() bool {
 577         return ce.equalUntil == len(ce.Expect)
 578 }
 579
 580 func (ce *checkEqual) Write(p []byte) (int, error) {
 581         endpos := ce.equalUntil + len(p)
 582         if ce.equalUntil >= 0 && endpos <= len(ce.Expect) && bytes.Equal(p, ce.Expect[ce.equalUntil:endpos]) {
 583                 ce.equalUntil = endpos
 584         } else {
 585                 ce.equalUntil = -1
 586         }
 587         return len(p), nil
 588 }
 589
 590 func (ks *keepstore) BlockUntrash(ctx context.Context, locator string) error {
 591         li, err := parseLocator(locator)
 592         if err != nil {
 593                 return err
 594         }
 595         var errToCaller error = os.ErrNotExist
 596         for _, mnt := range ks.mountsW {
 597                 if ctx.Err() != nil {
 598                         return ctx.Err()
 599                 }
 600                 err := mnt.BlockUntrash(li.hash)
 601                 if err == nil {
 602                         errToCaller = nil
 603                 } else if !os.IsNotExist(err) && errToCaller != nil {
 604                         errToCaller = err
 605                 }
 606         }
 607         return errToCaller
 608 }
 609
 610 func (ks *keepstore) BlockTouch(ctx context.Context, locator string) error {
 611         li, err := parseLocator(locator)
 612         if err != nil {
 613                 return err
 614         }
 615         var errToCaller error = os.ErrNotExist
 616         for _, mnt := range ks.mountsW {
 617                 if ctx.Err() != nil {
 618                         return ctx.Err()
 619                 }
 620                 err := mnt.BlockTouch(li.hash)
 621                 if err == nil {
 622                         return nil
 623                 }
 624                 if !os.IsNotExist(err) {
 625                         errToCaller = err
 626                 }
 627         }
 628         return errToCaller
 629 }
 630
 631 func (ks *keepstore) BlockTrash(ctx context.Context, locator string) error {
 632         if !ks.cluster.Collections.BlobTrash {
 633                 return errMethodNotAllowed
 634         }
 635         li, err := parseLocator(locator)
 636         if err != nil {
 637                 return err
 638         }
 639         var errToCaller error = os.ErrNotExist
 640         for _, mnt := range ks.mounts {
 641                 if !mnt.AllowTrash {
 642                         continue
 643                 }
 644                 if ctx.Err() != nil {
 645                         return ctx.Err()
 646                 }
 647                 t, err := mnt.Mtime(li.hash)
 648                 if err == nil && time.Now().Sub(t) > ks.cluster.Collections.BlobSigningTTL.Duration() {
 649                         err = mnt.BlockTrash(li.hash)
 650                 }
 651                 if os.IsNotExist(errToCaller) || (errToCaller == nil && !os.IsNotExist(err)) {
 652                         errToCaller = err
 653                 }
 654         }
 655         return errToCaller
 656 }
 657
 658 func (ks *keepstore) Mounts() []*mount {
 659         return ks.mountsR
 660 }
 661
 662 func (ks *keepstore) Index(ctx context.Context, opts indexOptions) error {
 663         mounts := ks.mountsR
 664         if opts.MountUUID != "" {
 665                 mnt, ok := ks.mounts[opts.MountUUID]
 666                 if !ok {
 667                         return os.ErrNotExist
 668                 }
 669                 mounts = []*mount{mnt}
 670         }
 671         for _, mnt := range mounts {
 672                 err := mnt.Index(ctx, opts.Prefix, opts.WriteTo)
 673                 if err != nil {
 674                         return err
 675                 }
 676         }
 677         return nil
 678 }
 679
 680 func ctxToken(ctx context.Context) string {
 681         if c, ok := auth.FromContext(ctx); ok && len(c.Tokens) > 0 {
 682                 return c.Tokens[0]
 683         } else {
 684                 return ""
 685         }
 686 }
 687
 688 type locatorInfo struct {
 689         hash   string
 690         size   int
 691         remote bool
 692         signed bool
 693 }
 694
 695 func parseLocator(loc string) (locatorInfo, error) {
 696         var li locatorInfo
 697         for i, part := range strings.Split(loc, "+") {
 698                 if i == 0 {
 699                         if len(part) != 32 {
 700                                 return li, errInvalidLocator
 701                         }
 702                         li.hash = part
 703                         continue
 704                 }
 705                 if i == 1 {
 706                         if size, err := strconv.Atoi(part); err == nil {
 707                                 li.size = size
 708                                 continue
 709                         }
 710                 }
 711                 if len(part) == 0 {
 712                         return li, errInvalidLocator
 713                 }
 714                 if part[0] == 'A' {
 715                         li.signed = true
 716                 }
 717                 if part[0] == 'R' {
 718                         li.remote = true
 719                 }
 720                 if part[0] >= '0' && part[0] <= '9' {
 721                         // size, if present at all, must come first
 722                         return li, errInvalidLocator
 723                 }
 724         }
 725         return li, nil
 726 }