sdk/go/arvados/fs_collection.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: Apache-2.0
   4
   5 package arvados
   6
   7 import (
   8         "bytes"
   9         "context"
  10         "encoding/json"
  11         "fmt"
  12         "io"
  13         "os"
  14         "path"
  15         "regexp"
  16         "sort"
  17         "strconv"
  18         "strings"
  19         "sync"
  20         "sync/atomic"
  21         "time"
  22 )
  23
  24 var (
  25         maxBlockSize      = 1 << 26
  26         concurrentWriters = 4 // max goroutines writing to Keep in background and during flush()
  27 )
  28
  29 // A CollectionFileSystem is a FileSystem that can be serialized as a
  30 // manifest and stored as a collection.
  31 type CollectionFileSystem interface {
  32         FileSystem
  33
  34         // Flush all file data to Keep and return a snapshot of the
  35         // filesystem suitable for saving as (Collection)ManifestText.
  36         // Prefix (normally ".") is a top level directory, effectively
  37         // prepended to all paths in the returned manifest.
  38         MarshalManifest(prefix string) (string, error)
  39
  40         // Total data bytes in all files.
  41         Size() int64
  42 }
  43
  44 type collectionFileSystem struct {
  45         fileSystem
  46         uuid           string
  47         replicas       int
  48         storageClasses []string
  49
  50         // PDH returned by the server as of last sync/load.
  51         loadedPDH atomic.Value
  52         // PDH of the locally generated manifest as of last
  53         // sync/load. This can differ from loadedPDH after loading a
  54         // version that was generated with different code and sorts
  55         // filenames differently than we do, for example.
  56         savedPDH atomic.Value
  57
  58         // guessSignatureTTL tracks a lower bound for the server's
  59         // configured BlobSigningTTL. The guess is initially zero, and
  60         // increases when we come across a signature with an expiry
  61         // time further in the future than the previous guess.
  62         //
  63         // When the guessed TTL is much smaller than the real TTL,
  64         // preemptive signature refresh is delayed or missed entirely,
  65         // which is OK.
  66         guessSignatureTTL time.Duration
  67         holdCheckChanges  time.Time
  68         lockCheckChanges  sync.Mutex
  69 }
  70
  71 // FileSystem returns a CollectionFileSystem for the collection.
  72 func (c *Collection) FileSystem(client apiClient, kc keepClient) (CollectionFileSystem, error) {
  73         modTime := c.ModifiedAt
  74         if modTime.IsZero() {
  75                 modTime = time.Now()
  76         }
  77         fs := &collectionFileSystem{
  78                 uuid:           c.UUID,
  79                 storageClasses: c.StorageClassesDesired,
  80                 fileSystem: fileSystem{
  81                         fsBackend: keepBackend{apiClient: client, keepClient: kc},
  82                         thr:       newThrottle(concurrentWriters),
  83                 },
  84         }
  85         fs.loadedPDH.Store(c.PortableDataHash)
  86         if r := c.ReplicationDesired; r != nil {
  87                 fs.replicas = *r
  88         }
  89         root := &dirnode{
  90                 fs: fs,
  91                 treenode: treenode{
  92                         fileinfo: fileinfo{
  93                                 name:    ".",
  94                                 mode:    os.ModeDir | 0755,
  95                                 modTime: modTime,
  96                                 sys:     func() interface{} { return c },
  97                         },
  98                         inodes: make(map[string]inode),
  99                 },
 100         }
 101         root.SetParent(root, ".")
 102         if err := root.loadManifest(c.ManifestText); err != nil {
 103                 return nil, err
 104         }
 105
 106         txt, err := root.marshalManifest(context.Background(), ".", false)
 107         if err != nil {
 108                 return nil, err
 109         }
 110         fs.savedPDH.Store(PortableDataHash(txt))
 111
 112         backdateTree(root, modTime)
 113         fs.root = root
 114         return fs, nil
 115 }
 116
 117 // caller must have lock (or guarantee no concurrent accesses somehow)
 118 func eachNode(n inode, ffunc func(*filenode), dfunc func(*dirnode)) {
 119         switch n := n.(type) {
 120         case *filenode:
 121                 if ffunc != nil {
 122                         ffunc(n)
 123                 }
 124         case *dirnode:
 125                 if dfunc != nil {
 126                         dfunc(n)
 127                 }
 128                 for _, n := range n.inodes {
 129                         eachNode(n, ffunc, dfunc)
 130                 }
 131         }
 132 }
 133
 134 // caller must have lock (or guarantee no concurrent accesses somehow)
 135 func backdateTree(n inode, modTime time.Time) {
 136         eachNode(n, func(fn *filenode) {
 137                 fn.fileinfo.modTime = modTime
 138         }, func(dn *dirnode) {
 139                 dn.fileinfo.modTime = modTime
 140         })
 141 }
 142
 143 // Approximate portion of signature TTL remaining, usually between 0
 144 // and 1, or negative if some signatures have expired.
 145 func (fs *collectionFileSystem) signatureTimeLeft() (float64, time.Duration) {
 146         var (
 147                 now      = time.Now()
 148                 earliest = now.Add(time.Hour * 24 * 7 * 365)
 149                 latest   time.Time
 150         )
 151         fs.fileSystem.root.RLock()
 152         eachNode(fs.root, func(fn *filenode) {
 153                 fn.Lock()
 154                 defer fn.Unlock()
 155                 for _, seg := range fn.segments {
 156                         seg, ok := seg.(storedSegment)
 157                         if !ok {
 158                                 continue
 159                         }
 160                         expiryTime, err := signatureExpiryTime(seg.locator)
 161                         if err != nil {
 162                                 continue
 163                         }
 164                         if expiryTime.Before(earliest) {
 165                                 earliest = expiryTime
 166                         }
 167                         if expiryTime.After(latest) {
 168                                 latest = expiryTime
 169                         }
 170                 }
 171         }, nil)
 172         fs.fileSystem.root.RUnlock()
 173
 174         if latest.IsZero() {
 175                 // No signatures == 100% of TTL remaining.
 176                 return 1, 1
 177         }
 178
 179         ttl := latest.Sub(now)
 180         fs.fileSystem.root.Lock()
 181         {
 182                 if ttl > fs.guessSignatureTTL {
 183                         // ttl is closer to the real TTL than
 184                         // guessSignatureTTL.
 185                         fs.guessSignatureTTL = ttl
 186                 } else {
 187                         // Use the previous best guess to compute the
 188                         // portion remaining (below, after unlocking
 189                         // mutex).
 190                         ttl = fs.guessSignatureTTL
 191                 }
 192         }
 193         fs.fileSystem.root.Unlock()
 194
 195         return earliest.Sub(now).Seconds() / ttl.Seconds(), ttl
 196 }
 197
 198 func (fs *collectionFileSystem) updateSignatures(newmanifest string) {
 199         newLoc := map[string]string{}
 200         for _, tok := range regexp.MustCompile(`\S+`).FindAllString(newmanifest, -1) {
 201                 if mBlkRe.MatchString(tok) {
 202                         newLoc[stripAllHints(tok)] = tok
 203                 }
 204         }
 205         fs.fileSystem.root.Lock()
 206         defer fs.fileSystem.root.Unlock()
 207         eachNode(fs.root, func(fn *filenode) {
 208                 fn.Lock()
 209                 defer fn.Unlock()
 210                 for idx, seg := range fn.segments {
 211                         seg, ok := seg.(storedSegment)
 212                         if !ok {
 213                                 continue
 214                         }
 215                         loc, ok := newLoc[stripAllHints(seg.locator)]
 216                         if !ok {
 217                                 continue
 218                         }
 219                         seg.locator = loc
 220                         fn.segments[idx] = seg
 221                 }
 222         }, nil)
 223 }
 224
 225 func (fs *collectionFileSystem) newNode(name string, perm os.FileMode, modTime time.Time) (node inode, err error) {
 226         if name == "" || name == "." || name == ".." {
 227                 return nil, ErrInvalidArgument
 228         }
 229         if perm.IsDir() {
 230                 return &dirnode{
 231                         fs: fs,
 232                         treenode: treenode{
 233                                 fileinfo: fileinfo{
 234                                         name:    name,
 235                                         mode:    perm | os.ModeDir,
 236                                         modTime: modTime,
 237                                 },
 238                                 inodes: make(map[string]inode),
 239                         },
 240                 }, nil
 241         }
 242         return &filenode{
 243                 fs: fs,
 244                 fileinfo: fileinfo{
 245                         name:    name,
 246                         mode:    perm & ^os.ModeDir,
 247                         modTime: modTime,
 248                 },
 249         }, nil
 250 }
 251
 252 func (fs *collectionFileSystem) Child(name string, replace func(inode) (inode, error)) (inode, error) {
 253         return fs.rootnode().Child(name, replace)
 254 }
 255
 256 func (fs *collectionFileSystem) FS() FileSystem {
 257         return fs
 258 }
 259
 260 func (fs *collectionFileSystem) FileInfo() os.FileInfo {
 261         return fs.rootnode().FileInfo()
 262 }
 263
 264 func (fs *collectionFileSystem) IsDir() bool {
 265         return true
 266 }
 267
 268 func (fs *collectionFileSystem) Lock() {
 269         fs.rootnode().Lock()
 270 }
 271
 272 func (fs *collectionFileSystem) Unlock() {
 273         fs.rootnode().Unlock()
 274 }
 275
 276 func (fs *collectionFileSystem) RLock() {
 277         fs.rootnode().RLock()
 278 }
 279
 280 func (fs *collectionFileSystem) RUnlock() {
 281         fs.rootnode().RUnlock()
 282 }
 283
 284 func (fs *collectionFileSystem) Parent() inode {
 285         return fs.rootnode().Parent()
 286 }
 287
 288 func (fs *collectionFileSystem) Read(_ []byte, ptr filenodePtr) (int, filenodePtr, error) {
 289         return 0, ptr, ErrInvalidOperation
 290 }
 291
 292 func (fs *collectionFileSystem) Write(_ []byte, ptr filenodePtr) (int, filenodePtr, error) {
 293         return 0, ptr, ErrInvalidOperation
 294 }
 295
 296 func (fs *collectionFileSystem) Readdir() ([]os.FileInfo, error) {
 297         return fs.rootnode().Readdir()
 298 }
 299
 300 func (fs *collectionFileSystem) SetParent(parent inode, name string) {
 301         fs.rootnode().SetParent(parent, name)
 302 }
 303
 304 func (fs *collectionFileSystem) Truncate(int64) error {
 305         return ErrInvalidOperation
 306 }
 307
 308 // Check for and incorporate upstream changes. If force==false, this
 309 // is a no-op except once every ttl/100 or so.
 310 //
 311 // Return value is true if new content was loaded from upstream and
 312 // any unsaved local changes have been discarded.
 313 func (fs *collectionFileSystem) checkChangesOnServer(force bool) (bool, error) {
 314         if fs.uuid == "" && fs.loadedPDH.Load() == "" {
 315                 return false, nil
 316         }
 317
 318         fs.lockCheckChanges.Lock()
 319         if !force && fs.holdCheckChanges.After(time.Now()) {
 320                 fs.lockCheckChanges.Unlock()
 321                 return false, nil
 322         }
 323         remain, ttl := fs.signatureTimeLeft()
 324         if remain > 0.01 {
 325                 fs.holdCheckChanges = time.Now().Add(ttl / 100)
 326         }
 327         fs.lockCheckChanges.Unlock()
 328
 329         if !force && remain >= 0.5 {
 330                 // plenty of time left on current signatures
 331                 return false, nil
 332         }
 333
 334         loadedPDH, _ := fs.loadedPDH.Load().(string)
 335         getparams := map[string]interface{}{"select": []string{"portable_data_hash", "manifest_text"}}
 336         if fs.uuid != "" {
 337                 var coll Collection
 338                 err := fs.RequestAndDecode(&coll, "GET", "arvados/v1/collections/"+fs.uuid, nil, getparams)
 339                 if err != nil {
 340                         return false, err
 341                 }
 342                 if coll.PortableDataHash != loadedPDH {
 343                         // collection has changed upstream since we
 344                         // last loaded or saved. Refresh local data,
 345                         // losing any unsaved local changes.
 346                         newfs, err := coll.FileSystem(fs.fileSystem.fsBackend, fs.fileSystem.fsBackend)
 347                         if err != nil {
 348                                 return false, err
 349                         }
 350                         snap, err := Snapshot(newfs, "/")
 351                         if err != nil {
 352                                 return false, err
 353                         }
 354                         err = Splice(fs, "/", snap)
 355                         if err != nil {
 356                                 return false, err
 357                         }
 358                         fs.loadedPDH.Store(coll.PortableDataHash)
 359                         fs.savedPDH.Store(newfs.(*collectionFileSystem).savedPDH.Load())
 360                         return true, nil
 361                 }
 362                 fs.updateSignatures(coll.ManifestText)
 363                 return false, nil
 364         }
 365         if loadedPDH != "" {
 366                 var coll Collection
 367                 err := fs.RequestAndDecode(&coll, "GET", "arvados/v1/collections/"+loadedPDH, nil, getparams)
 368                 if err != nil {
 369                         return false, err
 370                 }
 371                 fs.updateSignatures(coll.ManifestText)
 372         }
 373         return false, nil
 374 }
 375
 376 // Refresh signature on a single locator, if necessary. Assume caller
 377 // has lock. If an update is needed, and there are any storedSegments
 378 // whose signatures can be updated, start a background task to update
 379 // them asynchronously when the caller releases locks.
 380 func (fs *collectionFileSystem) refreshSignature(locator string) string {
 381         exp, err := signatureExpiryTime(locator)
 382         if err != nil || exp.Sub(time.Now()) > time.Minute {
 383                 // Synchronous update is not needed. Start an
 384                 // asynchronous update if needed.
 385                 go fs.checkChangesOnServer(false)
 386                 return locator
 387         }
 388         loadedPDH, _ := fs.loadedPDH.Load().(string)
 389         var manifests string
 390         for _, id := range []string{fs.uuid, loadedPDH} {
 391                 if id == "" {
 392                         continue
 393                 }
 394                 var coll Collection
 395                 err := fs.RequestAndDecode(&coll, "GET", "arvados/v1/collections/"+id, nil, map[string]interface{}{"select": []string{"portable_data_hash", "manifest_text"}})
 396                 if err != nil {
 397                         continue
 398                 }
 399                 manifests += coll.ManifestText
 400         }
 401         hash := stripAllHints(locator)
 402         for _, tok := range regexp.MustCompile(`\S+`).FindAllString(manifests, -1) {
 403                 if mBlkRe.MatchString(tok) {
 404                         if stripAllHints(tok) == hash {
 405                                 locator = tok
 406                                 break
 407                         }
 408                 }
 409         }
 410         go fs.updateSignatures(manifests)
 411         return locator
 412 }
 413
 414 func (fs *collectionFileSystem) Sync() error {
 415         refreshed, err := fs.checkChangesOnServer(true)
 416         if err != nil {
 417                 return err
 418         }
 419         if refreshed || fs.uuid == "" {
 420                 return nil
 421         }
 422         txt, err := fs.MarshalManifest(".")
 423         if err != nil {
 424                 return fmt.Errorf("sync failed: %s", err)
 425         }
 426         savingPDH := PortableDataHash(txt)
 427         if savingPDH == fs.savedPDH.Load() {
 428                 // No local changes since last save or initial load.
 429                 return nil
 430         }
 431         coll := Collection{
 432                 UUID:         fs.uuid,
 433                 ManifestText: txt,
 434         }
 435
 436         selectFields := []string{"uuid", "portable_data_hash"}
 437         fs.lockCheckChanges.Lock()
 438         remain, _ := fs.signatureTimeLeft()
 439         fs.lockCheckChanges.Unlock()
 440         if remain < 0.5 {
 441                 selectFields = append(selectFields, "manifest_text")
 442         }
 443
 444         err = fs.RequestAndDecode(&coll, "PUT", "arvados/v1/collections/"+fs.uuid, nil, map[string]interface{}{
 445                 "collection": map[string]string{
 446                         "manifest_text": coll.ManifestText,
 447                 },
 448                 "select": selectFields,
 449         })
 450         if err != nil {
 451                 return fmt.Errorf("sync failed: update %s: %w", fs.uuid, err)
 452         }
 453         fs.updateSignatures(coll.ManifestText)
 454         fs.loadedPDH.Store(coll.PortableDataHash)
 455         fs.savedPDH.Store(savingPDH)
 456         return nil
 457 }
 458
 459 func (fs *collectionFileSystem) Flush(path string, shortBlocks bool) error {
 460         node, err := rlookup(fs.fileSystem.root, path, nil)
 461         if err != nil {
 462                 return err
 463         }
 464         dn, ok := node.(*dirnode)
 465         if !ok {
 466                 return ErrNotADirectory
 467         }
 468         dn.Lock()
 469         defer dn.Unlock()
 470         names := dn.sortedNames()
 471         if path != "" {
 472                 // Caller only wants to flush the specified dir,
 473                 // non-recursively.  Drop subdirs from the list of
 474                 // names.
 475                 var filenames []string
 476                 for _, name := range names {
 477                         if _, ok := dn.inodes[name].(*filenode); ok {
 478                                 filenames = append(filenames, name)
 479                         }
 480                 }
 481                 names = filenames
 482         }
 483         for _, name := range names {
 484                 child := dn.inodes[name]
 485                 child.Lock()
 486                 defer child.Unlock()
 487         }
 488         return dn.flush(context.TODO(), names, flushOpts{sync: false, shortBlocks: shortBlocks})
 489 }
 490
 491 func (fs *collectionFileSystem) MemorySize() int64 {
 492         return fs.fileSystem.root.(*dirnode).MemorySize()
 493 }
 494
 495 func (fs *collectionFileSystem) MarshalManifest(prefix string) (string, error) {
 496         fs.fileSystem.root.Lock()
 497         defer fs.fileSystem.root.Unlock()
 498         return fs.fileSystem.root.(*dirnode).marshalManifest(context.TODO(), prefix, true)
 499 }
 500
 501 func (fs *collectionFileSystem) Size() int64 {
 502         return fs.fileSystem.root.(*dirnode).TreeSize()
 503 }
 504
 505 func (fs *collectionFileSystem) Snapshot() (inode, error) {
 506         return fs.fileSystem.root.Snapshot()
 507 }
 508
 509 func (fs *collectionFileSystem) Splice(r inode) error {
 510         return fs.fileSystem.root.Splice(r)
 511 }
 512
 513 // filenodePtr is an offset into a file that is (usually) efficient to
 514 // seek to. Specifically, if filenode.repacked==filenodePtr.repacked
 515 // then
 516 // filenode.segments[filenodePtr.segmentIdx][filenodePtr.segmentOff]
 517 // corresponds to file offset filenodePtr.off. Otherwise, it is
 518 // necessary to reexamine len(filenode.segments[0]) etc. to find the
 519 // correct segment and offset.
 520 type filenodePtr struct {
 521         off        int64
 522         segmentIdx int
 523         segmentOff int
 524         repacked   int64
 525 }
 526
 527 // seek returns a ptr that is consistent with both startPtr.off and
 528 // the current state of fn. The caller must already hold fn.RLock() or
 529 // fn.Lock().
 530 //
 531 // If startPtr is beyond EOF, ptr.segment* will indicate precisely
 532 // EOF.
 533 //
 534 // After seeking:
 535 //
 536 //      ptr.segmentIdx == len(filenode.segments) // i.e., at EOF
 537 //      ||
 538 //      filenode.segments[ptr.segmentIdx].Len() > ptr.segmentOff
 539 func (fn *filenode) seek(startPtr filenodePtr) (ptr filenodePtr) {
 540         ptr = startPtr
 541         if ptr.off < 0 {
 542                 // meaningless anyway
 543                 return
 544         } else if ptr.off >= fn.fileinfo.size {
 545                 ptr.segmentIdx = len(fn.segments)
 546                 ptr.segmentOff = 0
 547                 ptr.repacked = fn.repacked
 548                 return
 549         } else if ptr.repacked == fn.repacked {
 550                 // segmentIdx and segmentOff accurately reflect
 551                 // ptr.off, but might have fallen off the end of a
 552                 // segment
 553                 if ptr.segmentOff >= fn.segments[ptr.segmentIdx].Len() {
 554                         ptr.segmentIdx++
 555                         ptr.segmentOff = 0
 556                 }
 557                 return
 558         }
 559         defer func() {
 560                 ptr.repacked = fn.repacked
 561         }()
 562         if ptr.off >= fn.fileinfo.size {
 563                 ptr.segmentIdx, ptr.segmentOff = len(fn.segments), 0
 564                 return
 565         }
 566         // Recompute segmentIdx and segmentOff.  We have already
 567         // established fn.fileinfo.size > ptr.off >= 0, so we don't
 568         // have to deal with edge cases here.
 569         var off int64
 570         for ptr.segmentIdx, ptr.segmentOff = 0, 0; off < ptr.off; ptr.segmentIdx++ {
 571                 // This would panic (index out of range) if
 572                 // fn.fileinfo.size were larger than
 573                 // sum(fn.segments[i].Len()) -- but that can't happen
 574                 // because we have ensured fn.fileinfo.size is always
 575                 // accurate.
 576                 segLen := int64(fn.segments[ptr.segmentIdx].Len())
 577                 if off+segLen > ptr.off {
 578                         ptr.segmentOff = int(ptr.off - off)
 579                         break
 580                 }
 581                 off += segLen
 582         }
 583         return
 584 }
 585
 586 // filenode implements inode.
 587 type filenode struct {
 588         parent   inode
 589         fs       *collectionFileSystem
 590         fileinfo fileinfo
 591         segments []segment
 592         // number of times `segments` has changed in a
 593         // way that might invalidate a filenodePtr
 594         repacked int64
 595         memsize  int64 // bytes in memSegments
 596         sync.RWMutex
 597         nullnode
 598 }
 599
 600 // caller must have lock
 601 func (fn *filenode) appendSegment(e segment) {
 602         fn.segments = append(fn.segments, e)
 603         fn.fileinfo.size += int64(e.Len())
 604 }
 605
 606 func (fn *filenode) SetParent(p inode, name string) {
 607         fn.Lock()
 608         defer fn.Unlock()
 609         fn.parent = p
 610         fn.fileinfo.name = name
 611 }
 612
 613 func (fn *filenode) Parent() inode {
 614         fn.RLock()
 615         defer fn.RUnlock()
 616         return fn.parent
 617 }
 618
 619 func (fn *filenode) FS() FileSystem {
 620         return fn.fs
 621 }
 622
 623 func (fn *filenode) MemorySize() (size int64) {
 624         fn.RLock()
 625         defer fn.RUnlock()
 626         size = 64
 627         for _, seg := range fn.segments {
 628                 size += seg.memorySize()
 629         }
 630         return
 631 }
 632
 633 // Read reads file data from a single segment, starting at startPtr,
 634 // into p. startPtr is assumed not to be up-to-date. Caller must have
 635 // RLock or Lock.
 636 func (fn *filenode) Read(p []byte, startPtr filenodePtr) (n int, ptr filenodePtr, err error) {
 637         ptr = fn.seek(startPtr)
 638         if ptr.off < 0 {
 639                 err = ErrNegativeOffset
 640                 return
 641         }
 642         if ptr.segmentIdx >= len(fn.segments) {
 643                 err = io.EOF
 644                 return
 645         }
 646         if ss, ok := fn.segments[ptr.segmentIdx].(storedSegment); ok {
 647                 ss.locator = fn.fs.refreshSignature(ss.locator)
 648                 fn.segments[ptr.segmentIdx] = ss
 649         }
 650         n, err = fn.segments[ptr.segmentIdx].ReadAt(p, int64(ptr.segmentOff))
 651         if n > 0 {
 652                 ptr.off += int64(n)
 653                 ptr.segmentOff += n
 654                 if ptr.segmentOff == fn.segments[ptr.segmentIdx].Len() {
 655                         ptr.segmentIdx++
 656                         ptr.segmentOff = 0
 657                         if ptr.segmentIdx < len(fn.segments) && err == io.EOF {
 658                                 err = nil
 659                         }
 660                 }
 661         }
 662         return
 663 }
 664
 665 func (fn *filenode) Size() int64 {
 666         fn.RLock()
 667         defer fn.RUnlock()
 668         return fn.fileinfo.Size()
 669 }
 670
 671 func (fn *filenode) FileInfo() os.FileInfo {
 672         fn.RLock()
 673         defer fn.RUnlock()
 674         return fn.fileinfo
 675 }
 676
 677 func (fn *filenode) Truncate(size int64) error {
 678         fn.Lock()
 679         defer fn.Unlock()
 680         return fn.truncate(size)
 681 }
 682
 683 func (fn *filenode) truncate(size int64) error {
 684         if size == fn.fileinfo.size {
 685                 return nil
 686         }
 687         fn.repacked++
 688         if size < fn.fileinfo.size {
 689                 ptr := fn.seek(filenodePtr{off: size})
 690                 for i := ptr.segmentIdx; i < len(fn.segments); i++ {
 691                         if seg, ok := fn.segments[i].(*memSegment); ok {
 692                                 fn.memsize -= int64(seg.Len())
 693                         }
 694                 }
 695                 if ptr.segmentOff == 0 {
 696                         fn.segments = fn.segments[:ptr.segmentIdx]
 697                 } else {
 698                         fn.segments = fn.segments[:ptr.segmentIdx+1]
 699                         switch seg := fn.segments[ptr.segmentIdx].(type) {
 700                         case *memSegment:
 701                                 seg.Truncate(ptr.segmentOff)
 702                                 fn.memsize += int64(seg.Len())
 703                         default:
 704                                 fn.segments[ptr.segmentIdx] = seg.Slice(0, ptr.segmentOff)
 705                         }
 706                 }
 707                 fn.fileinfo.size = size
 708                 return nil
 709         }
 710         for size > fn.fileinfo.size {
 711                 grow := size - fn.fileinfo.size
 712                 var seg *memSegment
 713                 var ok bool
 714                 if len(fn.segments) == 0 {
 715                         seg = &memSegment{}
 716                         fn.segments = append(fn.segments, seg)
 717                 } else if seg, ok = fn.segments[len(fn.segments)-1].(*memSegment); !ok || seg.Len() >= maxBlockSize {
 718                         seg = &memSegment{}
 719                         fn.segments = append(fn.segments, seg)
 720                 }
 721                 if maxgrow := int64(maxBlockSize - seg.Len()); maxgrow < grow {
 722                         grow = maxgrow
 723                 }
 724                 seg.Truncate(seg.Len() + int(grow))
 725                 fn.fileinfo.size += grow
 726                 fn.memsize += grow
 727         }
 728         return nil
 729 }
 730
 731 // Write writes data from p to the file, starting at startPtr,
 732 // extending the file size if necessary. Caller must have Lock.
 733 func (fn *filenode) Write(p []byte, startPtr filenodePtr) (n int, ptr filenodePtr, err error) {
 734         if startPtr.off > fn.fileinfo.size {
 735                 if err = fn.truncate(startPtr.off); err != nil {
 736                         return 0, startPtr, err
 737                 }
 738         }
 739         ptr = fn.seek(startPtr)
 740         if ptr.off < 0 {
 741                 err = ErrNegativeOffset
 742                 return
 743         }
 744         for len(p) > 0 && err == nil {
 745                 cando := p
 746                 if len(cando) > maxBlockSize {
 747                         cando = cando[:maxBlockSize]
 748                 }
 749                 // Rearrange/grow fn.segments (and shrink cando if
 750                 // needed) such that cando can be copied to
 751                 // fn.segments[ptr.segmentIdx] at offset
 752                 // ptr.segmentOff.
 753                 cur := ptr.segmentIdx
 754                 prev := ptr.segmentIdx - 1
 755                 var curWritable bool
 756                 if cur < len(fn.segments) {
 757                         _, curWritable = fn.segments[cur].(*memSegment)
 758                 }
 759                 var prevAppendable bool
 760                 if prev >= 0 && fn.segments[prev].Len() < maxBlockSize {
 761                         _, prevAppendable = fn.segments[prev].(*memSegment)
 762                 }
 763                 if ptr.segmentOff > 0 && !curWritable {
 764                         // Split a non-writable block.
 765                         if max := fn.segments[cur].Len() - ptr.segmentOff; max <= len(cando) {
 766                                 // Truncate cur, and insert a new
 767                                 // segment after it.
 768                                 cando = cando[:max]
 769                                 fn.segments = append(fn.segments, nil)
 770                                 copy(fn.segments[cur+1:], fn.segments[cur:])
 771                         } else {
 772                                 // Split cur into two copies, truncate
 773                                 // the one on the left, shift the one
 774                                 // on the right, and insert a new
 775                                 // segment between them.
 776                                 fn.segments = append(fn.segments, nil, nil)
 777                                 copy(fn.segments[cur+2:], fn.segments[cur:])
 778                                 fn.segments[cur+2] = fn.segments[cur+2].Slice(ptr.segmentOff+len(cando), -1)
 779                         }
 780                         cur++
 781                         prev++
 782                         seg := &memSegment{}
 783                         seg.Truncate(len(cando))
 784                         fn.memsize += int64(len(cando))
 785                         fn.segments[cur] = seg
 786                         fn.segments[prev] = fn.segments[prev].Slice(0, ptr.segmentOff)
 787                         ptr.segmentIdx++
 788                         ptr.segmentOff = 0
 789                         fn.repacked++
 790                         ptr.repacked++
 791                 } else if curWritable {
 792                         if fit := int(fn.segments[cur].Len()) - ptr.segmentOff; fit < len(cando) {
 793                                 cando = cando[:fit]
 794                         }
 795                 } else {
 796                         if prevAppendable {
 797                                 // Shrink cando if needed to fit in
 798                                 // prev segment.
 799                                 if cangrow := maxBlockSize - fn.segments[prev].Len(); cangrow < len(cando) {
 800                                         cando = cando[:cangrow]
 801                                 }
 802                         }
 803
 804                         if cur == len(fn.segments) {
 805                                 // ptr is at EOF, filesize is changing.
 806                                 fn.fileinfo.size += int64(len(cando))
 807                         } else if el := fn.segments[cur].Len(); el <= len(cando) {
 808                                 // cando is long enough that we won't
 809                                 // need cur any more. shrink cando to
 810                                 // be exactly as long as cur
 811                                 // (otherwise we'd accidentally shift
 812                                 // the effective position of all
 813                                 // segments after cur).
 814                                 cando = cando[:el]
 815                                 copy(fn.segments[cur:], fn.segments[cur+1:])
 816                                 fn.segments = fn.segments[:len(fn.segments)-1]
 817                         } else {
 818                                 // shrink cur by the same #bytes we're growing prev
 819                                 fn.segments[cur] = fn.segments[cur].Slice(len(cando), -1)
 820                         }
 821
 822                         if prevAppendable {
 823                                 // Grow prev.
 824                                 ptr.segmentIdx--
 825                                 ptr.segmentOff = fn.segments[prev].Len()
 826                                 fn.segments[prev].(*memSegment).Truncate(ptr.segmentOff + len(cando))
 827                                 fn.memsize += int64(len(cando))
 828                                 ptr.repacked++
 829                                 fn.repacked++
 830                         } else {
 831                                 // Insert a segment between prev and
 832                                 // cur, and advance prev/cur.
 833                                 fn.segments = append(fn.segments, nil)
 834                                 if cur < len(fn.segments) {
 835                                         copy(fn.segments[cur+1:], fn.segments[cur:])
 836                                         ptr.repacked++
 837                                         fn.repacked++
 838                                 } else {
 839                                         // appending a new segment does
 840                                         // not invalidate any ptrs
 841                                 }
 842                                 seg := &memSegment{}
 843                                 seg.Truncate(len(cando))
 844                                 fn.memsize += int64(len(cando))
 845                                 fn.segments[cur] = seg
 846                         }
 847                 }
 848
 849                 // Finally we can copy bytes from cando to the current segment.
 850                 fn.segments[ptr.segmentIdx].(*memSegment).WriteAt(cando, ptr.segmentOff)
 851                 n += len(cando)
 852                 p = p[len(cando):]
 853
 854                 ptr.off += int64(len(cando))
 855                 ptr.segmentOff += len(cando)
 856                 if ptr.segmentOff >= maxBlockSize {
 857                         fn.pruneMemSegments()
 858                 }
 859                 if fn.segments[ptr.segmentIdx].Len() == ptr.segmentOff {
 860                         ptr.segmentOff = 0
 861                         ptr.segmentIdx++
 862                 }
 863
 864                 fn.fileinfo.modTime = time.Now()
 865         }
 866         return
 867 }
 868
 869 // Write some data out to disk to reduce memory use. Caller must have
 870 // write lock.
 871 func (fn *filenode) pruneMemSegments() {
 872         // TODO: share code with (*dirnode)flush()
 873         // TODO: pack/flush small blocks too, when fragmented
 874         for idx, seg := range fn.segments {
 875                 seg, ok := seg.(*memSegment)
 876                 if !ok || seg.Len() < maxBlockSize || seg.flushing != nil {
 877                         continue
 878                 }
 879                 // Setting seg.flushing guarantees seg.buf will not be
 880                 // modified in place: WriteAt and Truncate will
 881                 // allocate a new buf instead, if necessary.
 882                 idx, buf := idx, seg.buf
 883                 done := make(chan struct{})
 884                 seg.flushing = done
 885                 // If lots of background writes are already in
 886                 // progress, block here until one finishes, rather
 887                 // than pile up an unlimited number of buffered writes
 888                 // and network flush operations.
 889                 fn.fs.throttle().Acquire()
 890                 go func() {
 891                         defer close(done)
 892                         resp, err := fn.FS().BlockWrite(context.Background(), BlockWriteOptions{
 893                                 Data:           buf,
 894                                 Replicas:       fn.fs.replicas,
 895                                 StorageClasses: fn.fs.storageClasses,
 896                         })
 897                         fn.fs.throttle().Release()
 898                         fn.Lock()
 899                         defer fn.Unlock()
 900                         if seg.flushing != done {
 901                                 // A new seg.buf has been allocated.
 902                                 return
 903                         }
 904                         if err != nil {
 905                                 // TODO: stall (or return errors from)
 906                                 // subsequent writes until flushing
 907                                 // starts to succeed.
 908                                 return
 909                         }
 910                         if len(fn.segments) <= idx || fn.segments[idx] != seg || len(seg.buf) != len(buf) {
 911                                 // Segment has been dropped/moved/resized.
 912                                 return
 913                         }
 914                         fn.memsize -= int64(len(buf))
 915                         fn.segments[idx] = storedSegment{
 916                                 kc:      fn.FS(),
 917                                 locator: resp.Locator,
 918                                 size:    len(buf),
 919                                 offset:  0,
 920                                 length:  len(buf),
 921                         }
 922                 }()
 923         }
 924 }
 925
 926 // Block until all pending pruneMemSegments/flush work is
 927 // finished. Caller must NOT have lock.
 928 func (fn *filenode) waitPrune() {
 929         var pending []<-chan struct{}
 930         fn.Lock()
 931         for _, seg := range fn.segments {
 932                 if seg, ok := seg.(*memSegment); ok && seg.flushing != nil {
 933                         pending = append(pending, seg.flushing)
 934                 }
 935         }
 936         fn.Unlock()
 937         for _, p := range pending {
 938                 <-p
 939         }
 940 }
 941
 942 func (fn *filenode) Snapshot() (inode, error) {
 943         fn.RLock()
 944         defer fn.RUnlock()
 945         segments := make([]segment, 0, len(fn.segments))
 946         for _, seg := range fn.segments {
 947                 segments = append(segments, seg.Slice(0, seg.Len()))
 948         }
 949         return &filenode{
 950                 fileinfo: fn.fileinfo,
 951                 segments: segments,
 952         }, nil
 953 }
 954
 955 func (fn *filenode) Splice(repl inode) error {
 956         repl, err := repl.Snapshot()
 957         if err != nil {
 958                 return err
 959         }
 960         fn.parent.Lock()
 961         defer fn.parent.Unlock()
 962         fn.Lock()
 963         defer fn.Unlock()
 964         _, err = fn.parent.Child(fn.fileinfo.name, func(inode) (inode, error) { return repl, nil })
 965         if err != nil {
 966                 return err
 967         }
 968         switch repl := repl.(type) {
 969         case *dirnode:
 970                 repl.parent = fn.parent
 971                 repl.fileinfo.name = fn.fileinfo.name
 972                 repl.setTreeFS(fn.fs)
 973         case *filenode:
 974                 repl.parent = fn.parent
 975                 repl.fileinfo.name = fn.fileinfo.name
 976                 repl.fs = fn.fs
 977         default:
 978                 return fmt.Errorf("cannot splice snapshot containing %T: %w", repl, ErrInvalidArgument)
 979         }
 980         return nil
 981 }
 982
 983 type dirnode struct {
 984         fs *collectionFileSystem
 985         treenode
 986 }
 987
 988 func (dn *dirnode) FS() FileSystem {
 989         return dn.fs
 990 }
 991
 992 func (dn *dirnode) Child(name string, replace func(inode) (inode, error)) (inode, error) {
 993         if dn == dn.fs.rootnode() && name == ".arvados#collection" {
 994                 gn := &getternode{Getter: func() ([]byte, error) {
 995                         var coll Collection
 996                         var err error
 997                         coll.ManifestText, err = dn.fs.MarshalManifest(".")
 998                         if err != nil {
 999                                 return nil, err
1000                         }
1001                         coll.UUID = dn.fs.uuid
1002                         data, err := json.Marshal(&coll)
1003                         if err == nil {
1004                                 data = append(data, '\n')
1005                         }
1006                         return data, err
1007                 }}
1008                 gn.SetParent(dn, name)
1009                 return gn, nil
1010         }
1011         return dn.treenode.Child(name, replace)
1012 }
1013
1014 type fnSegmentRef struct {
1015         fn  *filenode
1016         idx int
1017 }
1018
1019 // commitBlock concatenates the data from the given filenode segments
1020 // (which must be *memSegments), writes the data out to Keep as a
1021 // single block, and replaces the filenodes' *memSegments with
1022 // storedSegments that reference the relevant portions of the new
1023 // block.
1024 //
1025 // bufsize is the total data size in refs. It is used to preallocate
1026 // the correct amount of memory when len(refs)>1.
1027 //
1028 // If sync is false, commitBlock returns right away, after starting a
1029 // goroutine to do the writes, reacquire the filenodes' locks, and
1030 // swap out the *memSegments. Some filenodes' segments might get
1031 // modified/rearranged in the meantime, in which case commitBlock
1032 // won't replace them.
1033 //
1034 // Caller must have write lock.
1035 func (dn *dirnode) commitBlock(ctx context.Context, refs []fnSegmentRef, bufsize int, sync bool) error {
1036         if len(refs) == 0 {
1037                 return nil
1038         }
1039         if err := ctx.Err(); err != nil {
1040                 return err
1041         }
1042         done := make(chan struct{})
1043         var block []byte
1044         segs := make([]*memSegment, 0, len(refs))
1045         offsets := make([]int, 0, len(refs)) // location of segment's data within block
1046         for _, ref := range refs {
1047                 seg := ref.fn.segments[ref.idx].(*memSegment)
1048                 if !sync && seg.flushingUnfinished() {
1049                         // Let the other flushing goroutine finish. If
1050                         // it fails, we'll try again next time.
1051                         close(done)
1052                         return nil
1053                 }
1054                 // In sync mode, we proceed regardless of
1055                 // whether another flush is in progress: It
1056                 // can't finish before we do, because we hold
1057                 // fn's lock until we finish our own writes.
1058                 seg.flushing = done
1059                 offsets = append(offsets, len(block))
1060                 if len(refs) == 1 {
1061                         block = seg.buf
1062                 } else if block == nil {
1063                         block = append(make([]byte, 0, bufsize), seg.buf...)
1064                 } else {
1065                         block = append(block, seg.buf...)
1066                 }
1067                 segs = append(segs, seg)
1068         }
1069         blocksize := len(block)
1070         dn.fs.throttle().Acquire()
1071         errs := make(chan error, 1)
1072         go func() {
1073                 defer close(done)
1074                 defer close(errs)
1075                 resp, err := dn.fs.BlockWrite(context.Background(), BlockWriteOptions{
1076                         Data:           block,
1077                         Replicas:       dn.fs.replicas,
1078                         StorageClasses: dn.fs.storageClasses,
1079                 })
1080                 dn.fs.throttle().Release()
1081                 if err != nil {
1082                         errs <- err
1083                         return
1084                 }
1085                 for idx, ref := range refs {
1086                         if !sync {
1087                                 ref.fn.Lock()
1088                                 // In async mode, fn's lock was
1089                                 // released while we were waiting for
1090                                 // PutB(); lots of things might have
1091                                 // changed.
1092                                 if len(ref.fn.segments) <= ref.idx {
1093                                         // file segments have
1094                                         // rearranged or changed in
1095                                         // some way
1096                                         ref.fn.Unlock()
1097                                         continue
1098                                 } else if seg, ok := ref.fn.segments[ref.idx].(*memSegment); !ok || seg != segs[idx] {
1099                                         // segment has been replaced
1100                                         ref.fn.Unlock()
1101                                         continue
1102                                 } else if seg.flushing != done {
1103                                         // seg.buf has been replaced
1104                                         ref.fn.Unlock()
1105                                         continue
1106                                 }
1107                         }
1108                         data := ref.fn.segments[ref.idx].(*memSegment).buf
1109                         ref.fn.segments[ref.idx] = storedSegment{
1110                                 kc:      dn.fs,
1111                                 locator: resp.Locator,
1112                                 size:    blocksize,
1113                                 offset:  offsets[idx],
1114                                 length:  len(data),
1115                         }
1116                         // atomic is needed here despite caller having
1117                         // lock: caller might be running concurrent
1118                         // commitBlock() goroutines using the same
1119                         // lock, writing different segments from the
1120                         // same file.
1121                         atomic.AddInt64(&ref.fn.memsize, -int64(len(data)))
1122                         if !sync {
1123                                 ref.fn.Unlock()
1124                         }
1125                 }
1126         }()
1127         if sync {
1128                 return <-errs
1129         }
1130         return nil
1131 }
1132
1133 type flushOpts struct {
1134         sync        bool
1135         shortBlocks bool
1136 }
1137
1138 // flush in-memory data and remote-cluster block references (for the
1139 // children with the given names, which must be children of dn) to
1140 // local-cluster persistent storage.
1141 //
1142 // Caller must have write lock on dn and the named children.
1143 //
1144 // If any children are dirs, they will be flushed recursively.
1145 func (dn *dirnode) flush(ctx context.Context, names []string, opts flushOpts) error {
1146         cg := newContextGroup(ctx)
1147         defer cg.Cancel()
1148
1149         goCommit := func(refs []fnSegmentRef, bufsize int) {
1150                 cg.Go(func() error {
1151                         return dn.commitBlock(cg.Context(), refs, bufsize, opts.sync)
1152                 })
1153         }
1154
1155         var pending []fnSegmentRef
1156         var pendingLen int = 0
1157         localLocator := map[string]string{}
1158         for _, name := range names {
1159                 switch node := dn.inodes[name].(type) {
1160                 case *dirnode:
1161                         grandchildNames := node.sortedNames()
1162                         for _, grandchildName := range grandchildNames {
1163                                 grandchild := node.inodes[grandchildName]
1164                                 grandchild.Lock()
1165                                 defer grandchild.Unlock()
1166                         }
1167                         cg.Go(func() error { return node.flush(cg.Context(), grandchildNames, opts) })
1168                 case *filenode:
1169                         for idx, seg := range node.segments {
1170                                 switch seg := seg.(type) {
1171                                 case storedSegment:
1172                                         loc, ok := localLocator[seg.locator]
1173                                         if !ok {
1174                                                 var err error
1175                                                 loc, err = dn.fs.LocalLocator(seg.locator)
1176                                                 if err != nil {
1177                                                         return err
1178                                                 }
1179                                                 localLocator[seg.locator] = loc
1180                                         }
1181                                         seg.locator = loc
1182                                         node.segments[idx] = seg
1183                                 case *memSegment:
1184                                         if seg.Len() > maxBlockSize/2 {
1185                                                 goCommit([]fnSegmentRef{{node, idx}}, seg.Len())
1186                                                 continue
1187                                         }
1188                                         if pendingLen+seg.Len() > maxBlockSize {
1189                                                 goCommit(pending, pendingLen)
1190                                                 pending = nil
1191                                                 pendingLen = 0
1192                                         }
1193                                         pending = append(pending, fnSegmentRef{node, idx})
1194                                         pendingLen += seg.Len()
1195                                 default:
1196                                         panic(fmt.Sprintf("can't sync segment type %T", seg))
1197                                 }
1198                         }
1199                 }
1200         }
1201         if opts.shortBlocks {
1202                 goCommit(pending, pendingLen)
1203         }
1204         return cg.Wait()
1205 }
1206
1207 func (dn *dirnode) MemorySize() (size int64) {
1208         dn.RLock()
1209         todo := make([]inode, 0, len(dn.inodes))
1210         for _, node := range dn.inodes {
1211                 todo = append(todo, node)
1212         }
1213         dn.RUnlock()
1214         size = 64
1215         for _, node := range todo {
1216                 size += node.MemorySize()
1217         }
1218         return
1219 }
1220
1221 // caller must have write lock.
1222 func (dn *dirnode) sortedNames() []string {
1223         names := make([]string, 0, len(dn.inodes))
1224         for name := range dn.inodes {
1225                 names = append(names, name)
1226         }
1227         sort.Strings(names)
1228         return names
1229 }
1230
1231 // caller must have write lock.
1232 func (dn *dirnode) marshalManifest(ctx context.Context, prefix string, flush bool) (string, error) {
1233         cg := newContextGroup(ctx)
1234         defer cg.Cancel()
1235
1236         if len(dn.inodes) == 0 {
1237                 if prefix == "." {
1238                         return "", nil
1239                 }
1240                 // Express the existence of an empty directory by
1241                 // adding an empty file named `\056`, which (unlike
1242                 // the more obvious spelling `.`) is accepted by the
1243                 // API's manifest validator.
1244                 return manifestEscape(prefix) + " d41d8cd98f00b204e9800998ecf8427e+0 0:0:\\056\n", nil
1245         }
1246
1247         names := dn.sortedNames()
1248
1249         // Wait for children to finish any pending write operations
1250         // before locking them.
1251         for _, name := range names {
1252                 node := dn.inodes[name]
1253                 if fn, ok := node.(*filenode); ok {
1254                         fn.waitPrune()
1255                 }
1256         }
1257
1258         var dirnames []string
1259         var filenames []string
1260         for _, name := range names {
1261                 node := dn.inodes[name]
1262                 node.Lock()
1263                 defer node.Unlock()
1264                 switch node := node.(type) {
1265                 case *dirnode:
1266                         dirnames = append(dirnames, name)
1267                 case *filenode:
1268                         filenames = append(filenames, name)
1269                 default:
1270                         panic(fmt.Sprintf("can't marshal inode type %T", node))
1271                 }
1272         }
1273
1274         subdirs := make([]string, len(dirnames))
1275         rootdir := ""
1276         for i, name := range dirnames {
1277                 i, name := i, name
1278                 cg.Go(func() error {
1279                         txt, err := dn.inodes[name].(*dirnode).marshalManifest(cg.Context(), prefix+"/"+name, flush)
1280                         subdirs[i] = txt
1281                         return err
1282                 })
1283         }
1284
1285         cg.Go(func() error {
1286                 var streamLen int64
1287                 type filepart struct {
1288                         name   string
1289                         offset int64
1290                         length int64
1291                 }
1292
1293                 var fileparts []filepart
1294                 var blocks []string
1295                 if !flush {
1296                         // skip flush -- will fail below if anything
1297                         // needed flushing
1298                 } else if err := dn.flush(cg.Context(), filenames, flushOpts{sync: true, shortBlocks: true}); err != nil {
1299                         return err
1300                 }
1301                 for _, name := range filenames {
1302                         node := dn.inodes[name].(*filenode)
1303                         if len(node.segments) == 0 {
1304                                 fileparts = append(fileparts, filepart{name: name})
1305                                 continue
1306                         }
1307                         for _, seg := range node.segments {
1308                                 switch seg := seg.(type) {
1309                                 case storedSegment:
1310                                         if len(blocks) > 0 && blocks[len(blocks)-1] == seg.locator {
1311                                                 streamLen -= int64(seg.size)
1312                                         } else {
1313                                                 blocks = append(blocks, seg.locator)
1314                                         }
1315                                         next := filepart{
1316                                                 name:   name,
1317                                                 offset: streamLen + int64(seg.offset),
1318                                                 length: int64(seg.length),
1319                                         }
1320                                         if prev := len(fileparts) - 1; prev >= 0 &&
1321                                                 fileparts[prev].name == name &&
1322                                                 fileparts[prev].offset+fileparts[prev].length == next.offset {
1323                                                 fileparts[prev].length += next.length
1324                                         } else {
1325                                                 fileparts = append(fileparts, next)
1326                                         }
1327                                         streamLen += int64(seg.size)
1328                                 default:
1329                                         // We haven't unlocked since
1330                                         // calling flush(sync=true).
1331                                         // Evidently the caller passed
1332                                         // flush==false but there were
1333                                         // local changes.
1334                                         return fmt.Errorf("can't marshal segment type %T", seg)
1335                                 }
1336                         }
1337                 }
1338                 var filetokens []string
1339                 for _, s := range fileparts {
1340                         filetokens = append(filetokens, fmt.Sprintf("%d:%d:%s", s.offset, s.length, manifestEscape(s.name)))
1341                 }
1342                 if len(filetokens) == 0 {
1343                         return nil
1344                 } else if len(blocks) == 0 {
1345                         blocks = []string{"d41d8cd98f00b204e9800998ecf8427e+0"}
1346                 }
1347                 rootdir = manifestEscape(prefix) + " " + strings.Join(blocks, " ") + " " + strings.Join(filetokens, " ") + "\n"
1348                 return nil
1349         })
1350         err := cg.Wait()
1351         return rootdir + strings.Join(subdirs, ""), err
1352 }
1353
1354 func (dn *dirnode) loadManifest(txt string) error {
1355         streams := bytes.Split([]byte(txt), []byte{'\n'})
1356         if len(streams[len(streams)-1]) != 0 {
1357                 return fmt.Errorf("line %d: no trailing newline", len(streams))
1358         }
1359         streams = streams[:len(streams)-1]
1360         segments := []storedSegment{}
1361         // streamoffset[n] is the position in the stream of the nth
1362         // block, i.e., ∑ segments[j].size ∀ 0≤j<n. We ensure
1363         // len(streamoffset) == len(segments) + 1.
1364         streamoffset := []int64{0}
1365         // To reduce allocs, we reuse a single "pathparts" slice
1366         // (pre-split on "/" separators) for the duration of this
1367         // func.
1368         var pathparts []string
1369         // To reduce allocs, we reuse a single "toks" slice of 3 byte
1370         // slices.
1371         var toks = make([][]byte, 3)
1372         // Similar to bytes.SplitN(token, []byte{c}, 3), but splits
1373         // into the toks slice rather than allocating a new one, and
1374         // returns the number of toks (1, 2, or 3).
1375         splitToToks := func(src []byte, c rune) int {
1376                 c1 := bytes.IndexRune(src, c)
1377                 if c1 < 0 {
1378                         toks[0] = src
1379                         return 1
1380                 }
1381                 toks[0], src = src[:c1], src[c1+1:]
1382                 c2 := bytes.IndexRune(src, c)
1383                 if c2 < 0 {
1384                         toks[1] = src
1385                         return 2
1386                 }
1387                 toks[1], toks[2] = src[:c2], src[c2+1:]
1388                 return 3
1389         }
1390         for i, stream := range streams {
1391                 lineno := i + 1
1392                 fnodeCache := make(map[string]*filenode)
1393                 var anyFileTokens bool
1394                 var segIdx int
1395                 segments = segments[:0]
1396                 streamoffset = streamoffset[:1]
1397                 pathparts = nil
1398                 streamparts := 0
1399                 for i, token := range bytes.Split(stream, []byte{' '}) {
1400                         if i == 0 {
1401                                 pathparts = strings.Split(manifestUnescape(string(token)), "/")
1402                                 streamparts = len(pathparts)
1403                                 continue
1404                         }
1405                         if !bytes.ContainsRune(token, ':') {
1406                                 if anyFileTokens {
1407                                         return fmt.Errorf("line %d: bad file segment %q", lineno, token)
1408                                 }
1409                                 if splitToToks(token, '+') < 2 {
1410                                         return fmt.Errorf("line %d: bad locator %q", lineno, token)
1411                                 }
1412                                 length, err := strconv.ParseInt(string(toks[1]), 10, 32)
1413                                 if err != nil || length < 0 {
1414                                         return fmt.Errorf("line %d: bad locator %q", lineno, token)
1415                                 }
1416                                 streamoffset = append(streamoffset, streamoffset[len(segments)]+int64(length))
1417                                 segments = append(segments, storedSegment{
1418                                         locator: string(token),
1419                                         size:    int(length),
1420                                         offset:  0,
1421                                         length:  int(length),
1422                                 })
1423                                 continue
1424                         } else if len(segments) == 0 {
1425                                 return fmt.Errorf("line %d: bad locator %q", lineno, token)
1426                         }
1427                         if splitToToks(token, ':') != 3 {
1428                                 return fmt.Errorf("line %d: bad file segment %q", lineno, token)
1429                         }
1430                         anyFileTokens = true
1431
1432                         offset, err := strconv.ParseInt(string(toks[0]), 10, 64)
1433                         if err != nil || offset < 0 {
1434                                 return fmt.Errorf("line %d: bad file segment %q", lineno, token)
1435                         }
1436                         length, err := strconv.ParseInt(string(toks[1]), 10, 64)
1437                         if err != nil || length < 0 {
1438                                 return fmt.Errorf("line %d: bad file segment %q", lineno, token)
1439                         }
1440                         fnode, cached := fnodeCache[string(toks[2])]
1441                         if !cached {
1442                                 if !bytes.ContainsAny(toks[2], `\/`) {
1443                                         // optimization for a common case
1444                                         pathparts = append(pathparts[:streamparts], string(toks[2]))
1445                                 } else {
1446                                         pathparts = append(pathparts[:streamparts], strings.Split(manifestUnescape(string(toks[2])), "/")...)
1447                                 }
1448                                 fnode, err = dn.createFileAndParents(pathparts)
1449                                 if err != nil {
1450                                         return fmt.Errorf("line %d: cannot use name %q with length %d: %s", lineno, toks[2], length, err)
1451                                 }
1452                                 fnodeCache[string(toks[2])] = fnode
1453                         }
1454                         if fnode == nil {
1455                                 // name matches an existing directory
1456                                 if length != 0 {
1457                                         return fmt.Errorf("line %d: cannot use name %q with length %d: is a directory", lineno, toks[2], length)
1458                                 }
1459                                 // Special case: an empty file used as
1460                                 // a marker to preserve an otherwise
1461                                 // empty directory in a manifest.
1462                                 continue
1463                         }
1464                         // Map the stream offset/range coordinates to
1465                         // block/offset/range coordinates and add
1466                         // corresponding storedSegments to the filenode
1467                         if segIdx < len(segments) && streamoffset[segIdx] <= offset && streamoffset[segIdx+1] > offset {
1468                                 // common case with an easy
1469                                 // optimization: start where the
1470                                 // previous segment ended
1471                         } else if guess := int(offset >> 26); guess >= 0 && guess < len(segments) && streamoffset[guess] <= offset && streamoffset[guess+1] > offset {
1472                                 // another common case with an easy
1473                                 // optimization: all blocks are 64 MiB
1474                                 // (or close enough)
1475                                 segIdx = guess
1476                         } else {
1477                                 // general case
1478                                 segIdx = sort.Search(len(segments), func(i int) bool {
1479                                         return streamoffset[i+1] > offset
1480                                 })
1481                         }
1482                         for ; segIdx < len(segments); segIdx++ {
1483                                 blkStart := streamoffset[segIdx]
1484                                 if blkStart >= offset+length {
1485                                         break
1486                                 }
1487                                 seg := &segments[segIdx]
1488                                 if seg.size == 0 {
1489                                         continue
1490                                 }
1491                                 var blkOff int
1492                                 if blkStart < offset {
1493                                         blkOff = int(offset - blkStart)
1494                                 }
1495                                 blkLen := seg.size - blkOff
1496                                 if blkStart+int64(seg.size) > offset+length {
1497                                         blkLen = int(offset + length - blkStart - int64(blkOff))
1498                                 }
1499                                 fnode.appendSegment(storedSegment{
1500                                         kc:      dn.fs,
1501                                         locator: seg.locator,
1502                                         size:    seg.size,
1503                                         offset:  blkOff,
1504                                         length:  blkLen,
1505                                 })
1506                         }
1507                         if segIdx == len(segments) && streamoffset[segIdx] < offset+length {
1508                                 return fmt.Errorf("line %d: invalid segment in %d-byte stream: %q", lineno, streamoffset[segIdx], token)
1509                         }
1510                 }
1511                 if !anyFileTokens {
1512                         return fmt.Errorf("line %d: no file segments", lineno)
1513                 } else if len(segments) == 0 {
1514                         return fmt.Errorf("line %d: no locators", lineno)
1515                 } else if streamparts == 0 {
1516                         return fmt.Errorf("line %d: no stream name", lineno)
1517                 }
1518         }
1519         return nil
1520 }
1521
1522 // only safe to call from loadManifest -- no locking.
1523 //
1524 // If path is a "parent directory exists" marker (the last path
1525 // component is "."), the returned values are both nil.
1526 //
1527 // Newly added nodes have modtime==0. Caller is responsible for fixing
1528 // them with backdateTree.
1529 func (dn *dirnode) createFileAndParents(names []string) (fn *filenode, err error) {
1530         var node inode = dn
1531         basename := names[len(names)-1]
1532         for _, name := range names[:len(names)-1] {
1533                 switch name {
1534                 case "", ".":
1535                         continue
1536                 case "..":
1537                         if node == dn {
1538                                 // can't be sure parent will be a *dirnode
1539                                 return nil, ErrInvalidArgument
1540                         }
1541                         node = node.Parent()
1542                         continue
1543                 }
1544                 node.Lock()
1545                 unlock := node.Unlock
1546                 node, err = node.Child(name, func(child inode) (inode, error) {
1547                         if child == nil {
1548                                 // note modtime will be fixed later in backdateTree()
1549                                 child, err := node.FS().newNode(name, 0755|os.ModeDir, time.Time{})
1550                                 if err != nil {
1551                                         return nil, err
1552                                 }
1553                                 child.SetParent(node, name)
1554                                 return child, nil
1555                         } else if !child.IsDir() {
1556                                 return child, ErrFileExists
1557                         } else {
1558                                 return child, nil
1559                         }
1560                 })
1561                 unlock()
1562                 if err != nil {
1563                         return
1564                 }
1565         }
1566         if basename == "." {
1567                 return
1568         } else if !permittedName(basename) {
1569                 err = fmt.Errorf("invalid file part %q in path %q", basename, names)
1570                 return
1571         }
1572         node.Lock()
1573         defer node.Unlock()
1574         _, err = node.Child(basename, func(child inode) (inode, error) {
1575                 switch child := child.(type) {
1576                 case nil:
1577                         child, err = node.FS().newNode(basename, 0755, time.Time{})
1578                         if err != nil {
1579                                 return nil, err
1580                         }
1581                         child.SetParent(node, basename)
1582                         fn = child.(*filenode)
1583                         return child, nil
1584                 case *filenode:
1585                         fn = child
1586                         return child, nil
1587                 case *dirnode:
1588                         return child, ErrIsDirectory
1589                 default:
1590                         return child, ErrInvalidArgument
1591                 }
1592         })
1593         return
1594 }
1595
1596 func (dn *dirnode) TreeSize() (bytes int64) {
1597         dn.RLock()
1598         defer dn.RUnlock()
1599         for _, i := range dn.inodes {
1600                 switch i := i.(type) {
1601                 case *filenode:
1602                         bytes += i.Size()
1603                 case *dirnode:
1604                         bytes += i.TreeSize()
1605                 }
1606         }
1607         return
1608 }
1609
1610 func (dn *dirnode) Snapshot() (inode, error) {
1611         return dn.snapshot()
1612 }
1613
1614 func (dn *dirnode) snapshot() (*dirnode, error) {
1615         dn.RLock()
1616         defer dn.RUnlock()
1617         snap := &dirnode{
1618                 treenode: treenode{
1619                         inodes:   make(map[string]inode, len(dn.inodes)),
1620                         fileinfo: dn.fileinfo,
1621                 },
1622         }
1623         for name, child := range dn.inodes {
1624                 dupchild, err := child.Snapshot()
1625                 if err != nil {
1626                         return nil, err
1627                 }
1628                 snap.inodes[name] = dupchild
1629                 dupchild.SetParent(snap, name)
1630         }
1631         return snap, nil
1632 }
1633
1634 func (dn *dirnode) Splice(repl inode) error {
1635         repl, err := repl.Snapshot()
1636         if err != nil {
1637                 return fmt.Errorf("cannot copy snapshot: %w", err)
1638         }
1639         switch repl := repl.(type) {
1640         default:
1641                 return fmt.Errorf("cannot splice snapshot containing %T: %w", repl, ErrInvalidArgument)
1642         case *dirnode:
1643                 dn.Lock()
1644                 defer dn.Unlock()
1645                 dn.inodes = repl.inodes
1646                 dn.setTreeFS(dn.fs)
1647         case *filenode:
1648                 dn.parent.Lock()
1649                 defer dn.parent.Unlock()
1650                 removing, err := dn.parent.Child(dn.fileinfo.name, nil)
1651                 if err != nil {
1652                         return fmt.Errorf("cannot use Splice to replace a top-level directory with a file: %w", ErrInvalidOperation)
1653                 } else if removing != dn {
1654                         // If ../thisdirname is not this dirnode, it
1655                         // must be an inode that wraps a dirnode, like
1656                         // a collectionFileSystem or deferrednode.
1657                         if deferred, ok := removing.(*deferrednode); ok {
1658                                 // More useful to report the type of
1659                                 // the wrapped node rather than just
1660                                 // *deferrednode. (We know the real
1661                                 // inode is already loaded because dn
1662                                 // is inside it.)
1663                                 removing = deferred.realinode()
1664                         }
1665                         return fmt.Errorf("cannot use Splice to attach a file at top level of %T: %w", removing, ErrInvalidOperation)
1666                 }
1667                 dn.Lock()
1668                 defer dn.Unlock()
1669                 _, err = dn.parent.Child(dn.fileinfo.name, func(inode) (inode, error) { return repl, nil })
1670                 if err != nil {
1671                         return fmt.Errorf("error replacing filenode: dn.parent.Child(): %w", err)
1672                 }
1673                 repl.fs = dn.fs
1674         }
1675         return nil
1676 }
1677
1678 func (dn *dirnode) setTreeFS(fs *collectionFileSystem) {
1679         dn.fs = fs
1680         for _, child := range dn.inodes {
1681                 switch child := child.(type) {
1682                 case *dirnode:
1683                         child.setTreeFS(fs)
1684                 case *filenode:
1685                         child.fs = fs
1686                 }
1687         }
1688 }
1689
1690 type segment interface {
1691         io.ReaderAt
1692         Len() int
1693         // Return a new segment with a subsection of the data from this
1694         // one. length<0 means length=Len()-off.
1695         Slice(off int, length int) segment
1696         memorySize() int64
1697 }
1698
1699 type memSegment struct {
1700         buf []byte
1701         // If flushing is not nil and not ready/closed, then a) buf is
1702         // being shared by a pruneMemSegments goroutine, and must be
1703         // copied on write; and b) the flushing channel will close
1704         // when the goroutine finishes, whether it succeeds or not.
1705         flushing <-chan struct{}
1706 }
1707
1708 func (me *memSegment) flushingUnfinished() bool {
1709         if me.flushing == nil {
1710                 return false
1711         }
1712         select {
1713         case <-me.flushing:
1714                 me.flushing = nil
1715                 return false
1716         default:
1717                 return true
1718         }
1719 }
1720
1721 func (me *memSegment) Len() int {
1722         return len(me.buf)
1723 }
1724
1725 func (me *memSegment) Slice(off, length int) segment {
1726         if length < 0 {
1727                 length = len(me.buf) - off
1728         }
1729         buf := make([]byte, length)
1730         copy(buf, me.buf[off:])
1731         return &memSegment{buf: buf}
1732 }
1733
1734 func (me *memSegment) Truncate(n int) {
1735         if n > cap(me.buf) || (me.flushing != nil && n > len(me.buf)) {
1736                 newsize := 1024
1737                 for newsize < n {
1738                         newsize = newsize << 2
1739                 }
1740                 newbuf := make([]byte, n, newsize)
1741                 copy(newbuf, me.buf)
1742                 me.buf, me.flushing = newbuf, nil
1743         } else {
1744                 // reclaim existing capacity, and zero reclaimed part
1745                 oldlen := len(me.buf)
1746                 me.buf = me.buf[:n]
1747                 for i := oldlen; i < n; i++ {
1748                         me.buf[i] = 0
1749                 }
1750         }
1751 }
1752
1753 func (me *memSegment) WriteAt(p []byte, off int) {
1754         if off+len(p) > len(me.buf) {
1755                 panic("overflowed segment")
1756         }
1757         if me.flushing != nil {
1758                 me.buf, me.flushing = append([]byte(nil), me.buf...), nil
1759         }
1760         copy(me.buf[off:], p)
1761 }
1762
1763 func (me *memSegment) ReadAt(p []byte, off int64) (n int, err error) {
1764         if off > int64(me.Len()) {
1765                 err = io.EOF
1766                 return
1767         }
1768         n = copy(p, me.buf[int(off):])
1769         if n < len(p) {
1770                 err = io.EOF
1771         }
1772         return
1773 }
1774
1775 func (me *memSegment) memorySize() int64 {
1776         return 64 + int64(len(me.buf))
1777 }
1778
1779 type storedSegment struct {
1780         kc      fsBackend
1781         locator string
1782         size    int // size of stored block (also encoded in locator)
1783         offset  int // position of segment within the stored block
1784         length  int // bytes in this segment (offset + length <= size)
1785 }
1786
1787 func (se storedSegment) Len() int {
1788         return se.length
1789 }
1790
1791 func (se storedSegment) Slice(n, size int) segment {
1792         se.offset += n
1793         se.length -= n
1794         if size >= 0 && se.length > size {
1795                 se.length = size
1796         }
1797         return se
1798 }
1799
1800 func (se storedSegment) ReadAt(p []byte, off int64) (n int, err error) {
1801         if off > int64(se.length) {
1802                 return 0, io.EOF
1803         }
1804         maxlen := se.length - int(off)
1805         if len(p) > maxlen {
1806                 p = p[:maxlen]
1807                 n, err = se.kc.ReadAt(se.locator, p, int(off)+se.offset)
1808                 if err == nil {
1809                         err = io.EOF
1810                 }
1811                 return
1812         }
1813         return se.kc.ReadAt(se.locator, p, int(off)+se.offset)
1814 }
1815
1816 func (se storedSegment) memorySize() int64 {
1817         return 64 + int64(len(se.locator))
1818 }
1819
1820 func canonicalName(name string) string {
1821         name = path.Clean("/" + name)
1822         if name == "/" || name == "./" {
1823                 name = "."
1824         } else if strings.HasPrefix(name, "/") {
1825                 name = "." + name
1826         }
1827         return name
1828 }
1829
1830 var manifestEscapeSeq = regexp.MustCompile(`\\([0-7]{3}|\\)`)
1831
1832 func manifestUnescapeFunc(seq string) string {
1833         if seq == `\\` {
1834                 return `\`
1835         }
1836         i, err := strconv.ParseUint(seq[1:], 8, 8)
1837         if err != nil {
1838                 // Invalid escape sequence: can't unescape.
1839                 return seq
1840         }
1841         return string([]byte{byte(i)})
1842 }
1843
1844 func manifestUnescape(s string) string {
1845         return manifestEscapeSeq.ReplaceAllStringFunc(s, manifestUnescapeFunc)
1846 }
1847
1848 var manifestEscapedChar = regexp.MustCompile(`[\000-\040:\s\\]`)
1849
1850 func manifestEscapeFunc(seq string) string {
1851         return fmt.Sprintf("\\%03o", byte(seq[0]))
1852 }
1853
1854 func manifestEscape(s string) string {
1855         return manifestEscapedChar.ReplaceAllStringFunc(s, manifestEscapeFunc)
1856 }