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         "context"
   9         "encoding/json"
  10         "fmt"
  11         "io"
  12         "os"
  13         "path"
  14         "regexp"
  15         "sort"
  16         "strconv"
  17         "strings"
  18         "sync"
  19         "sync/atomic"
  20         "time"
  21 )
  22
  23 var (
  24         maxBlockSize      = 1 << 26
  25         concurrentWriters = 4 // max goroutines writing to Keep in background and during flush()
  26 )
  27
  28 // A CollectionFileSystem is a FileSystem that can be serialized as a
  29 // manifest and stored as a collection.
  30 type CollectionFileSystem interface {
  31         FileSystem
  32
  33         // Flush all file data to Keep and return a snapshot of the
  34         // filesystem suitable for saving as (Collection)ManifestText.
  35         // Prefix (normally ".") is a top level directory, effectively
  36         // prepended to all paths in the returned manifest.
  37         MarshalManifest(prefix string) (string, error)
  38
  39         // Total data bytes in all files.
  40         Size() int64
  41
  42         // Memory consumed by buffered file data.
  43         memorySize() int64
  44 }
  45
  46 type collectionFileSystem struct {
  47         fileSystem
  48         uuid string
  49 }
  50
  51 // FileSystem returns a CollectionFileSystem for the collection.
  52 func (c *Collection) FileSystem(client apiClient, kc keepClient) (CollectionFileSystem, error) {
  53         var modTime time.Time
  54         if c.ModifiedAt == nil {
  55                 modTime = time.Now()
  56         } else {
  57                 modTime = *c.ModifiedAt
  58         }
  59         fs := &collectionFileSystem{
  60                 uuid: c.UUID,
  61                 fileSystem: fileSystem{
  62                         fsBackend: keepBackend{apiClient: client, keepClient: kc},
  63                         thr:       newThrottle(concurrentWriters),
  64                 },
  65         }
  66         root := &dirnode{
  67                 fs: fs,
  68                 treenode: treenode{
  69                         fileinfo: fileinfo{
  70                                 name:    ".",
  71                                 mode:    os.ModeDir | 0755,
  72                                 modTime: modTime,
  73                         },
  74                         inodes: make(map[string]inode),
  75                 },
  76         }
  77         root.SetParent(root, ".")
  78         if err := root.loadManifest(c.ManifestText); err != nil {
  79                 return nil, err
  80         }
  81         backdateTree(root, modTime)
  82         fs.root = root
  83         return fs, nil
  84 }
  85
  86 func backdateTree(n inode, modTime time.Time) {
  87         switch n := n.(type) {
  88         case *filenode:
  89                 n.fileinfo.modTime = modTime
  90         case *dirnode:
  91                 n.fileinfo.modTime = modTime
  92                 for _, n := range n.inodes {
  93                         backdateTree(n, modTime)
  94                 }
  95         }
  96 }
  97
  98 func (fs *collectionFileSystem) newNode(name string, perm os.FileMode, modTime time.Time) (node inode, err error) {
  99         if name == "" || name == "." || name == ".." {
 100                 return nil, ErrInvalidArgument
 101         }
 102         if perm.IsDir() {
 103                 return &dirnode{
 104                         fs: fs,
 105                         treenode: treenode{
 106                                 fileinfo: fileinfo{
 107                                         name:    name,
 108                                         mode:    perm | os.ModeDir,
 109                                         modTime: modTime,
 110                                 },
 111                                 inodes: make(map[string]inode),
 112                         },
 113                 }, nil
 114         } else {
 115                 return &filenode{
 116                         fs: fs,
 117                         fileinfo: fileinfo{
 118                                 name:    name,
 119                                 mode:    perm & ^os.ModeDir,
 120                                 modTime: modTime,
 121                         },
 122                 }, nil
 123         }
 124 }
 125
 126 func (fs *collectionFileSystem) Sync() error {
 127         if fs.uuid == "" {
 128                 return nil
 129         }
 130         txt, err := fs.MarshalManifest(".")
 131         if err != nil {
 132                 return fmt.Errorf("sync failed: %s", err)
 133         }
 134         coll := &Collection{
 135                 UUID:         fs.uuid,
 136                 ManifestText: txt,
 137         }
 138         err = fs.RequestAndDecode(nil, "PUT", "arvados/v1/collections/"+fs.uuid, fs.UpdateBody(coll), map[string]interface{}{"select": []string{"uuid"}})
 139         if err != nil {
 140                 return fmt.Errorf("sync failed: update %s: %s", fs.uuid, err)
 141         }
 142         return nil
 143 }
 144
 145 func (fs *collectionFileSystem) Flush(path string, shortBlocks bool) error {
 146         node, err := rlookup(fs.fileSystem.root, path)
 147         if err != nil {
 148                 return err
 149         }
 150         dn, ok := node.(*dirnode)
 151         if !ok {
 152                 return ErrNotADirectory
 153         }
 154         dn.Lock()
 155         defer dn.Unlock()
 156         names := dn.sortedNames()
 157         if path != "" {
 158                 // Caller only wants to flush the specified dir,
 159                 // non-recursively.  Drop subdirs from the list of
 160                 // names.
 161                 var filenames []string
 162                 for _, name := range names {
 163                         if _, ok := dn.inodes[name].(*filenode); ok {
 164                                 filenames = append(filenames, name)
 165                         }
 166                 }
 167                 names = filenames
 168         }
 169         for _, name := range names {
 170                 child := dn.inodes[name]
 171                 child.Lock()
 172                 defer child.Unlock()
 173         }
 174         return dn.flush(context.TODO(), names, flushOpts{sync: false, shortBlocks: shortBlocks})
 175 }
 176
 177 func (fs *collectionFileSystem) memorySize() int64 {
 178         fs.fileSystem.root.Lock()
 179         defer fs.fileSystem.root.Unlock()
 180         return fs.fileSystem.root.(*dirnode).memorySize()
 181 }
 182
 183 func (fs *collectionFileSystem) MarshalManifest(prefix string) (string, error) {
 184         fs.fileSystem.root.Lock()
 185         defer fs.fileSystem.root.Unlock()
 186         return fs.fileSystem.root.(*dirnode).marshalManifest(context.TODO(), prefix)
 187 }
 188
 189 func (fs *collectionFileSystem) Size() int64 {
 190         return fs.fileSystem.root.(*dirnode).TreeSize()
 191 }
 192
 193 // filenodePtr is an offset into a file that is (usually) efficient to
 194 // seek to. Specifically, if filenode.repacked==filenodePtr.repacked
 195 // then
 196 // filenode.segments[filenodePtr.segmentIdx][filenodePtr.segmentOff]
 197 // corresponds to file offset filenodePtr.off. Otherwise, it is
 198 // necessary to reexamine len(filenode.segments[0]) etc. to find the
 199 // correct segment and offset.
 200 type filenodePtr struct {
 201         off        int64
 202         segmentIdx int
 203         segmentOff int
 204         repacked   int64
 205 }
 206
 207 // seek returns a ptr that is consistent with both startPtr.off and
 208 // the current state of fn. The caller must already hold fn.RLock() or
 209 // fn.Lock().
 210 //
 211 // If startPtr is beyond EOF, ptr.segment* will indicate precisely
 212 // EOF.
 213 //
 214 // After seeking:
 215 //
 216 //     ptr.segmentIdx == len(filenode.segments) // i.e., at EOF
 217 //     ||
 218 //     filenode.segments[ptr.segmentIdx].Len() > ptr.segmentOff
 219 func (fn *filenode) seek(startPtr filenodePtr) (ptr filenodePtr) {
 220         ptr = startPtr
 221         if ptr.off < 0 {
 222                 // meaningless anyway
 223                 return
 224         } else if ptr.off >= fn.fileinfo.size {
 225                 ptr.segmentIdx = len(fn.segments)
 226                 ptr.segmentOff = 0
 227                 ptr.repacked = fn.repacked
 228                 return
 229         } else if ptr.repacked == fn.repacked {
 230                 // segmentIdx and segmentOff accurately reflect
 231                 // ptr.off, but might have fallen off the end of a
 232                 // segment
 233                 if ptr.segmentOff >= fn.segments[ptr.segmentIdx].Len() {
 234                         ptr.segmentIdx++
 235                         ptr.segmentOff = 0
 236                 }
 237                 return
 238         }
 239         defer func() {
 240                 ptr.repacked = fn.repacked
 241         }()
 242         if ptr.off >= fn.fileinfo.size {
 243                 ptr.segmentIdx, ptr.segmentOff = len(fn.segments), 0
 244                 return
 245         }
 246         // Recompute segmentIdx and segmentOff.  We have already
 247         // established fn.fileinfo.size > ptr.off >= 0, so we don't
 248         // have to deal with edge cases here.
 249         var off int64
 250         for ptr.segmentIdx, ptr.segmentOff = 0, 0; off < ptr.off; ptr.segmentIdx++ {
 251                 // This would panic (index out of range) if
 252                 // fn.fileinfo.size were larger than
 253                 // sum(fn.segments[i].Len()) -- but that can't happen
 254                 // because we have ensured fn.fileinfo.size is always
 255                 // accurate.
 256                 segLen := int64(fn.segments[ptr.segmentIdx].Len())
 257                 if off+segLen > ptr.off {
 258                         ptr.segmentOff = int(ptr.off - off)
 259                         break
 260                 }
 261                 off += segLen
 262         }
 263         return
 264 }
 265
 266 // filenode implements inode.
 267 type filenode struct {
 268         parent   inode
 269         fs       FileSystem
 270         fileinfo fileinfo
 271         segments []segment
 272         // number of times `segments` has changed in a
 273         // way that might invalidate a filenodePtr
 274         repacked int64
 275         memsize  int64 // bytes in memSegments
 276         sync.RWMutex
 277         nullnode
 278 }
 279
 280 // caller must have lock
 281 func (fn *filenode) appendSegment(e segment) {
 282         fn.segments = append(fn.segments, e)
 283         fn.fileinfo.size += int64(e.Len())
 284 }
 285
 286 func (fn *filenode) SetParent(p inode, name string) {
 287         fn.Lock()
 288         defer fn.Unlock()
 289         fn.parent = p
 290         fn.fileinfo.name = name
 291 }
 292
 293 func (fn *filenode) Parent() inode {
 294         fn.RLock()
 295         defer fn.RUnlock()
 296         return fn.parent
 297 }
 298
 299 func (fn *filenode) FS() FileSystem {
 300         return fn.fs
 301 }
 302
 303 // Read reads file data from a single segment, starting at startPtr,
 304 // into p. startPtr is assumed not to be up-to-date. Caller must have
 305 // RLock or Lock.
 306 func (fn *filenode) Read(p []byte, startPtr filenodePtr) (n int, ptr filenodePtr, err error) {
 307         ptr = fn.seek(startPtr)
 308         if ptr.off < 0 {
 309                 err = ErrNegativeOffset
 310                 return
 311         }
 312         if ptr.segmentIdx >= len(fn.segments) {
 313                 err = io.EOF
 314                 return
 315         }
 316         n, err = fn.segments[ptr.segmentIdx].ReadAt(p, int64(ptr.segmentOff))
 317         if n > 0 {
 318                 ptr.off += int64(n)
 319                 ptr.segmentOff += n
 320                 if ptr.segmentOff == fn.segments[ptr.segmentIdx].Len() {
 321                         ptr.segmentIdx++
 322                         ptr.segmentOff = 0
 323                         if ptr.segmentIdx < len(fn.segments) && err == io.EOF {
 324                                 err = nil
 325                         }
 326                 }
 327         }
 328         return
 329 }
 330
 331 func (fn *filenode) Size() int64 {
 332         fn.RLock()
 333         defer fn.RUnlock()
 334         return fn.fileinfo.Size()
 335 }
 336
 337 func (fn *filenode) FileInfo() os.FileInfo {
 338         fn.RLock()
 339         defer fn.RUnlock()
 340         return fn.fileinfo
 341 }
 342
 343 func (fn *filenode) Truncate(size int64) error {
 344         fn.Lock()
 345         defer fn.Unlock()
 346         return fn.truncate(size)
 347 }
 348
 349 func (fn *filenode) truncate(size int64) error {
 350         if size == fn.fileinfo.size {
 351                 return nil
 352         }
 353         fn.repacked++
 354         if size < fn.fileinfo.size {
 355                 ptr := fn.seek(filenodePtr{off: size})
 356                 for i := ptr.segmentIdx; i < len(fn.segments); i++ {
 357                         if seg, ok := fn.segments[i].(*memSegment); ok {
 358                                 fn.memsize -= int64(seg.Len())
 359                         }
 360                 }
 361                 if ptr.segmentOff == 0 {
 362                         fn.segments = fn.segments[:ptr.segmentIdx]
 363                 } else {
 364                         fn.segments = fn.segments[:ptr.segmentIdx+1]
 365                         switch seg := fn.segments[ptr.segmentIdx].(type) {
 366                         case *memSegment:
 367                                 seg.Truncate(ptr.segmentOff)
 368                                 fn.memsize += int64(seg.Len())
 369                         default:
 370                                 fn.segments[ptr.segmentIdx] = seg.Slice(0, ptr.segmentOff)
 371                         }
 372                 }
 373                 fn.fileinfo.size = size
 374                 return nil
 375         }
 376         for size > fn.fileinfo.size {
 377                 grow := size - fn.fileinfo.size
 378                 var seg *memSegment
 379                 var ok bool
 380                 if len(fn.segments) == 0 {
 381                         seg = &memSegment{}
 382                         fn.segments = append(fn.segments, seg)
 383                 } else if seg, ok = fn.segments[len(fn.segments)-1].(*memSegment); !ok || seg.Len() >= maxBlockSize {
 384                         seg = &memSegment{}
 385                         fn.segments = append(fn.segments, seg)
 386                 }
 387                 if maxgrow := int64(maxBlockSize - seg.Len()); maxgrow < grow {
 388                         grow = maxgrow
 389                 }
 390                 seg.Truncate(seg.Len() + int(grow))
 391                 fn.fileinfo.size += grow
 392                 fn.memsize += grow
 393         }
 394         return nil
 395 }
 396
 397 // Write writes data from p to the file, starting at startPtr,
 398 // extending the file size if necessary. Caller must have Lock.
 399 func (fn *filenode) Write(p []byte, startPtr filenodePtr) (n int, ptr filenodePtr, err error) {
 400         if startPtr.off > fn.fileinfo.size {
 401                 if err = fn.truncate(startPtr.off); err != nil {
 402                         return 0, startPtr, err
 403                 }
 404         }
 405         ptr = fn.seek(startPtr)
 406         if ptr.off < 0 {
 407                 err = ErrNegativeOffset
 408                 return
 409         }
 410         for len(p) > 0 && err == nil {
 411                 cando := p
 412                 if len(cando) > maxBlockSize {
 413                         cando = cando[:maxBlockSize]
 414                 }
 415                 // Rearrange/grow fn.segments (and shrink cando if
 416                 // needed) such that cando can be copied to
 417                 // fn.segments[ptr.segmentIdx] at offset
 418                 // ptr.segmentOff.
 419                 cur := ptr.segmentIdx
 420                 prev := ptr.segmentIdx - 1
 421                 var curWritable bool
 422                 if cur < len(fn.segments) {
 423                         _, curWritable = fn.segments[cur].(*memSegment)
 424                 }
 425                 var prevAppendable bool
 426                 if prev >= 0 && fn.segments[prev].Len() < maxBlockSize {
 427                         _, prevAppendable = fn.segments[prev].(*memSegment)
 428                 }
 429                 if ptr.segmentOff > 0 && !curWritable {
 430                         // Split a non-writable block.
 431                         if max := fn.segments[cur].Len() - ptr.segmentOff; max <= len(cando) {
 432                                 // Truncate cur, and insert a new
 433                                 // segment after it.
 434                                 cando = cando[:max]
 435                                 fn.segments = append(fn.segments, nil)
 436                                 copy(fn.segments[cur+1:], fn.segments[cur:])
 437                         } else {
 438                                 // Split cur into two copies, truncate
 439                                 // the one on the left, shift the one
 440                                 // on the right, and insert a new
 441                                 // segment between them.
 442                                 fn.segments = append(fn.segments, nil, nil)
 443                                 copy(fn.segments[cur+2:], fn.segments[cur:])
 444                                 fn.segments[cur+2] = fn.segments[cur+2].Slice(ptr.segmentOff+len(cando), -1)
 445                         }
 446                         cur++
 447                         prev++
 448                         seg := &memSegment{}
 449                         seg.Truncate(len(cando))
 450                         fn.memsize += int64(len(cando))
 451                         fn.segments[cur] = seg
 452                         fn.segments[prev] = fn.segments[prev].Slice(0, ptr.segmentOff)
 453                         ptr.segmentIdx++
 454                         ptr.segmentOff = 0
 455                         fn.repacked++
 456                         ptr.repacked++
 457                 } else if curWritable {
 458                         if fit := int(fn.segments[cur].Len()) - ptr.segmentOff; fit < len(cando) {
 459                                 cando = cando[:fit]
 460                         }
 461                 } else {
 462                         if prevAppendable {
 463                                 // Shrink cando if needed to fit in
 464                                 // prev segment.
 465                                 if cangrow := maxBlockSize - fn.segments[prev].Len(); cangrow < len(cando) {
 466                                         cando = cando[:cangrow]
 467                                 }
 468                         }
 469
 470                         if cur == len(fn.segments) {
 471                                 // ptr is at EOF, filesize is changing.
 472                                 fn.fileinfo.size += int64(len(cando))
 473                         } else if el := fn.segments[cur].Len(); el <= len(cando) {
 474                                 // cando is long enough that we won't
 475                                 // need cur any more. shrink cando to
 476                                 // be exactly as long as cur
 477                                 // (otherwise we'd accidentally shift
 478                                 // the effective position of all
 479                                 // segments after cur).
 480                                 cando = cando[:el]
 481                                 copy(fn.segments[cur:], fn.segments[cur+1:])
 482                                 fn.segments = fn.segments[:len(fn.segments)-1]
 483                         } else {
 484                                 // shrink cur by the same #bytes we're growing prev
 485                                 fn.segments[cur] = fn.segments[cur].Slice(len(cando), -1)
 486                         }
 487
 488                         if prevAppendable {
 489                                 // Grow prev.
 490                                 ptr.segmentIdx--
 491                                 ptr.segmentOff = fn.segments[prev].Len()
 492                                 fn.segments[prev].(*memSegment).Truncate(ptr.segmentOff + len(cando))
 493                                 fn.memsize += int64(len(cando))
 494                                 ptr.repacked++
 495                                 fn.repacked++
 496                         } else {
 497                                 // Insert a segment between prev and
 498                                 // cur, and advance prev/cur.
 499                                 fn.segments = append(fn.segments, nil)
 500                                 if cur < len(fn.segments) {
 501                                         copy(fn.segments[cur+1:], fn.segments[cur:])
 502                                         ptr.repacked++
 503                                         fn.repacked++
 504                                 } else {
 505                                         // appending a new segment does
 506                                         // not invalidate any ptrs
 507                                 }
 508                                 seg := &memSegment{}
 509                                 seg.Truncate(len(cando))
 510                                 fn.memsize += int64(len(cando))
 511                                 fn.segments[cur] = seg
 512                                 cur++
 513                                 prev++
 514                         }
 515                 }
 516
 517                 // Finally we can copy bytes from cando to the current segment.
 518                 fn.segments[ptr.segmentIdx].(*memSegment).WriteAt(cando, ptr.segmentOff)
 519                 n += len(cando)
 520                 p = p[len(cando):]
 521
 522                 ptr.off += int64(len(cando))
 523                 ptr.segmentOff += len(cando)
 524                 if ptr.segmentOff >= maxBlockSize {
 525                         fn.pruneMemSegments()
 526                 }
 527                 if fn.segments[ptr.segmentIdx].Len() == ptr.segmentOff {
 528                         ptr.segmentOff = 0
 529                         ptr.segmentIdx++
 530                 }
 531
 532                 fn.fileinfo.modTime = time.Now()
 533         }
 534         return
 535 }
 536
 537 // Write some data out to disk to reduce memory use. Caller must have
 538 // write lock.
 539 func (fn *filenode) pruneMemSegments() {
 540         // TODO: share code with (*dirnode)flush()
 541         // TODO: pack/flush small blocks too, when fragmented
 542         for idx, seg := range fn.segments {
 543                 seg, ok := seg.(*memSegment)
 544                 if !ok || seg.Len() < maxBlockSize || seg.flushing != nil {
 545                         continue
 546                 }
 547                 // Setting seg.flushing guarantees seg.buf will not be
 548                 // modified in place: WriteAt and Truncate will
 549                 // allocate a new buf instead, if necessary.
 550                 idx, buf := idx, seg.buf
 551                 done := make(chan struct{})
 552                 seg.flushing = done
 553                 // If lots of background writes are already in
 554                 // progress, block here until one finishes, rather
 555                 // than pile up an unlimited number of buffered writes
 556                 // and network flush operations.
 557                 fn.fs.throttle().Acquire()
 558                 go func() {
 559                         defer close(done)
 560                         locator, _, err := fn.FS().PutB(buf)
 561                         fn.fs.throttle().Release()
 562                         fn.Lock()
 563                         defer fn.Unlock()
 564                         if seg.flushing != done {
 565                                 // A new seg.buf has been allocated.
 566                                 return
 567                         }
 568                         seg.flushing = nil
 569                         if err != nil {
 570                                 // TODO: stall (or return errors from)
 571                                 // subsequent writes until flushing
 572                                 // starts to succeed.
 573                                 return
 574                         }
 575                         if len(fn.segments) <= idx || fn.segments[idx] != seg || len(seg.buf) != len(buf) {
 576                                 // Segment has been dropped/moved/resized.
 577                                 return
 578                         }
 579                         fn.memsize -= int64(len(buf))
 580                         fn.segments[idx] = storedSegment{
 581                                 kc:      fn.FS(),
 582                                 locator: locator,
 583                                 size:    len(buf),
 584                                 offset:  0,
 585                                 length:  len(buf),
 586                         }
 587                 }()
 588         }
 589 }
 590
 591 // Block until all pending pruneMemSegments/flush work is
 592 // finished. Caller must NOT have lock.
 593 func (fn *filenode) waitPrune() {
 594         var pending []<-chan struct{}
 595         fn.Lock()
 596         for _, seg := range fn.segments {
 597                 if seg, ok := seg.(*memSegment); ok && seg.flushing != nil {
 598                         pending = append(pending, seg.flushing)
 599                 }
 600         }
 601         fn.Unlock()
 602         for _, p := range pending {
 603                 <-p
 604         }
 605 }
 606
 607 type dirnode struct {
 608         fs *collectionFileSystem
 609         treenode
 610 }
 611
 612 func (dn *dirnode) FS() FileSystem {
 613         return dn.fs
 614 }
 615
 616 func (dn *dirnode) Child(name string, replace func(inode) (inode, error)) (inode, error) {
 617         if dn == dn.fs.rootnode() && name == ".arvados#collection" {
 618                 gn := &getternode{Getter: func() ([]byte, error) {
 619                         var coll Collection
 620                         var err error
 621                         coll.ManifestText, err = dn.fs.MarshalManifest(".")
 622                         if err != nil {
 623                                 return nil, err
 624                         }
 625                         data, err := json.Marshal(&coll)
 626                         if err == nil {
 627                                 data = append(data, '\n')
 628                         }
 629                         return data, err
 630                 }}
 631                 gn.SetParent(dn, name)
 632                 return gn, nil
 633         }
 634         return dn.treenode.Child(name, replace)
 635 }
 636
 637 type fnSegmentRef struct {
 638         fn  *filenode
 639         idx int
 640 }
 641
 642 // commitBlock concatenates the data from the given filenode segments
 643 // (which must be *memSegments), writes the data out to Keep as a
 644 // single block, and replaces the filenodes' *memSegments with
 645 // storedSegments that reference the relevant portions of the new
 646 // block.
 647 //
 648 // bufsize is the total data size in refs. It is used to preallocate
 649 // the correct amount of memory when len(refs)>1.
 650 //
 651 // If sync is false, commitBlock returns right away, after starting a
 652 // goroutine to do the writes, reacquire the filenodes' locks, and
 653 // swap out the *memSegments. Some filenodes' segments might get
 654 // modified/rearranged in the meantime, in which case commitBlock
 655 // won't replace them.
 656 //
 657 // Caller must have write lock.
 658 func (dn *dirnode) commitBlock(ctx context.Context, refs []fnSegmentRef, bufsize int, sync bool) error {
 659         if len(refs) == 0 {
 660                 return nil
 661         }
 662         if err := ctx.Err(); err != nil {
 663                 return err
 664         }
 665         done := make(chan struct{})
 666         var block []byte
 667         segs := make([]*memSegment, 0, len(refs))
 668         offsets := make([]int, 0, len(refs)) // location of segment's data within block
 669         for _, ref := range refs {
 670                 seg := ref.fn.segments[ref.idx].(*memSegment)
 671                 if seg.flushing != nil && !sync {
 672                         // Let the other flushing goroutine finish. If
 673                         // it fails, we'll try again next time.
 674                         return nil
 675                 } else {
 676                         // In sync mode, we proceed regardless of
 677                         // whether another flush is in progress: It
 678                         // can't finish before we do, because we hold
 679                         // fn's lock until we finish our own writes.
 680                 }
 681                 seg.flushing = done
 682                 offsets = append(offsets, len(block))
 683                 if len(refs) == 1 {
 684                         block = seg.buf
 685                 } else if block == nil {
 686                         block = append(make([]byte, 0, bufsize), seg.buf...)
 687                 } else {
 688                         block = append(block, seg.buf...)
 689                 }
 690                 segs = append(segs, seg)
 691         }
 692         blocksize := len(block)
 693         dn.fs.throttle().Acquire()
 694         errs := make(chan error, 1)
 695         go func() {
 696                 defer close(done)
 697                 defer close(errs)
 698                 locator, _, err := dn.fs.PutB(block)
 699                 dn.fs.throttle().Release()
 700                 {
 701                         defer func() {
 702                                 for _, seg := range segs {
 703                                         if seg.flushing == done {
 704                                                 seg.flushing = nil
 705                                         }
 706                                 }
 707                         }()
 708                 }
 709                 if err != nil {
 710                         errs <- err
 711                         return
 712                 }
 713                 for idx, ref := range refs {
 714                         if !sync {
 715                                 ref.fn.Lock()
 716                                 // In async mode, fn's lock was
 717                                 // released while we were waiting for
 718                                 // PutB(); lots of things might have
 719                                 // changed.
 720                                 if len(ref.fn.segments) <= ref.idx {
 721                                         // file segments have
 722                                         // rearranged or changed in
 723                                         // some way
 724                                         ref.fn.Unlock()
 725                                         continue
 726                                 } else if seg, ok := ref.fn.segments[ref.idx].(*memSegment); !ok || seg != segs[idx] {
 727                                         // segment has been replaced
 728                                         ref.fn.Unlock()
 729                                         continue
 730                                 } else if seg.flushing != done {
 731                                         // seg.buf has been replaced
 732                                         ref.fn.Unlock()
 733                                         continue
 734                                 }
 735                         }
 736                         data := ref.fn.segments[ref.idx].(*memSegment).buf
 737                         ref.fn.segments[ref.idx] = storedSegment{
 738                                 kc:      dn.fs,
 739                                 locator: locator,
 740                                 size:    blocksize,
 741                                 offset:  offsets[idx],
 742                                 length:  len(data),
 743                         }
 744                         // atomic is needed here despite caller having
 745                         // lock: caller might be running concurrent
 746                         // commitBlock() goroutines using the same
 747                         // lock, writing different segments from the
 748                         // same file.
 749                         atomic.AddInt64(&ref.fn.memsize, -int64(len(data)))
 750                         if !sync {
 751                                 ref.fn.Unlock()
 752                         }
 753                 }
 754         }()
 755         if sync {
 756                 return <-errs
 757         } else {
 758                 return nil
 759         }
 760 }
 761
 762 type flushOpts struct {
 763         sync        bool
 764         shortBlocks bool
 765 }
 766
 767 // flush in-memory data and remote-cluster block references (for the
 768 // children with the given names, which must be children of dn) to
 769 // local-cluster persistent storage.
 770 //
 771 // Caller must have write lock on dn and the named children.
 772 //
 773 // If any children are dirs, they will be flushed recursively.
 774 func (dn *dirnode) flush(ctx context.Context, names []string, opts flushOpts) error {
 775         cg := newContextGroup(ctx)
 776         defer cg.Cancel()
 777
 778         goCommit := func(refs []fnSegmentRef, bufsize int) {
 779                 cg.Go(func() error {
 780                         return dn.commitBlock(cg.Context(), refs, bufsize, opts.sync)
 781                 })
 782         }
 783
 784         var pending []fnSegmentRef
 785         var pendingLen int = 0
 786         localLocator := map[string]string{}
 787         for _, name := range names {
 788                 switch node := dn.inodes[name].(type) {
 789                 case *dirnode:
 790                         grandchildNames := node.sortedNames()
 791                         for _, grandchildName := range grandchildNames {
 792                                 grandchild := node.inodes[grandchildName]
 793                                 grandchild.Lock()
 794                                 defer grandchild.Unlock()
 795                         }
 796                         cg.Go(func() error { return node.flush(cg.Context(), grandchildNames, opts) })
 797                 case *filenode:
 798                         for idx, seg := range node.segments {
 799                                 switch seg := seg.(type) {
 800                                 case storedSegment:
 801                                         loc, ok := localLocator[seg.locator]
 802                                         if !ok {
 803                                                 var err error
 804                                                 loc, err = dn.fs.LocalLocator(seg.locator)
 805                                                 if err != nil {
 806                                                         return err
 807                                                 }
 808                                                 localLocator[seg.locator] = loc
 809                                         }
 810                                         seg.locator = loc
 811                                         node.segments[idx] = seg
 812                                 case *memSegment:
 813                                         if seg.Len() > maxBlockSize/2 {
 814                                                 goCommit([]fnSegmentRef{{node, idx}}, seg.Len())
 815                                                 continue
 816                                         }
 817                                         if pendingLen+seg.Len() > maxBlockSize {
 818                                                 goCommit(pending, pendingLen)
 819                                                 pending = nil
 820                                                 pendingLen = 0
 821                                         }
 822                                         pending = append(pending, fnSegmentRef{node, idx})
 823                                         pendingLen += seg.Len()
 824                                 default:
 825                                         panic(fmt.Sprintf("can't sync segment type %T", seg))
 826                                 }
 827                         }
 828                 }
 829         }
 830         if opts.shortBlocks {
 831                 goCommit(pending, pendingLen)
 832         }
 833         return cg.Wait()
 834 }
 835
 836 // caller must have write lock.
 837 func (dn *dirnode) memorySize() (size int64) {
 838         for _, name := range dn.sortedNames() {
 839                 node := dn.inodes[name]
 840                 node.Lock()
 841                 defer node.Unlock()
 842                 switch node := node.(type) {
 843                 case *dirnode:
 844                         size += node.memorySize()
 845                 case *filenode:
 846                         for _, seg := range node.segments {
 847                                 switch seg := seg.(type) {
 848                                 case *memSegment:
 849                                         size += int64(seg.Len())
 850                                 }
 851                         }
 852                 }
 853         }
 854         return
 855 }
 856
 857 // caller must have write lock.
 858 func (dn *dirnode) sortedNames() []string {
 859         names := make([]string, 0, len(dn.inodes))
 860         for name := range dn.inodes {
 861                 names = append(names, name)
 862         }
 863         sort.Strings(names)
 864         return names
 865 }
 866
 867 // caller must have write lock.
 868 func (dn *dirnode) marshalManifest(ctx context.Context, prefix string) (string, error) {
 869         cg := newContextGroup(ctx)
 870         defer cg.Cancel()
 871
 872         if len(dn.inodes) == 0 {
 873                 if prefix == "." {
 874                         return "", nil
 875                 }
 876                 // Express the existence of an empty directory by
 877                 // adding an empty file named `\056`, which (unlike
 878                 // the more obvious spelling `.`) is accepted by the
 879                 // API's manifest validator.
 880                 return manifestEscape(prefix) + " d41d8cd98f00b204e9800998ecf8427e+0 0:0:\\056\n", nil
 881         }
 882
 883         names := dn.sortedNames()
 884
 885         // Wait for children to finish any pending write operations
 886         // before locking them.
 887         for _, name := range names {
 888                 node := dn.inodes[name]
 889                 if fn, ok := node.(*filenode); ok {
 890                         fn.waitPrune()
 891                 }
 892         }
 893
 894         var dirnames []string
 895         var filenames []string
 896         for _, name := range names {
 897                 node := dn.inodes[name]
 898                 node.Lock()
 899                 defer node.Unlock()
 900                 switch node := node.(type) {
 901                 case *dirnode:
 902                         dirnames = append(dirnames, name)
 903                 case *filenode:
 904                         filenames = append(filenames, name)
 905                 default:
 906                         panic(fmt.Sprintf("can't marshal inode type %T", node))
 907                 }
 908         }
 909
 910         subdirs := make([]string, len(dirnames))
 911         rootdir := ""
 912         for i, name := range dirnames {
 913                 i, name := i, name
 914                 cg.Go(func() error {
 915                         txt, err := dn.inodes[name].(*dirnode).marshalManifest(cg.Context(), prefix+"/"+name)
 916                         subdirs[i] = txt
 917                         return err
 918                 })
 919         }
 920
 921         cg.Go(func() error {
 922                 var streamLen int64
 923                 type filepart struct {
 924                         name   string
 925                         offset int64
 926                         length int64
 927                 }
 928
 929                 var fileparts []filepart
 930                 var blocks []string
 931                 if err := dn.flush(cg.Context(), filenames, flushOpts{sync: true, shortBlocks: true}); err != nil {
 932                         return err
 933                 }
 934                 for _, name := range filenames {
 935                         node := dn.inodes[name].(*filenode)
 936                         if len(node.segments) == 0 {
 937                                 fileparts = append(fileparts, filepart{name: name})
 938                                 continue
 939                         }
 940                         for _, seg := range node.segments {
 941                                 switch seg := seg.(type) {
 942                                 case storedSegment:
 943                                         if len(blocks) > 0 && blocks[len(blocks)-1] == seg.locator {
 944                                                 streamLen -= int64(seg.size)
 945                                         } else {
 946                                                 blocks = append(blocks, seg.locator)
 947                                         }
 948                                         next := filepart{
 949                                                 name:   name,
 950                                                 offset: streamLen + int64(seg.offset),
 951                                                 length: int64(seg.length),
 952                                         }
 953                                         if prev := len(fileparts) - 1; prev >= 0 &&
 954                                                 fileparts[prev].name == name &&
 955                                                 fileparts[prev].offset+fileparts[prev].length == next.offset {
 956                                                 fileparts[prev].length += next.length
 957                                         } else {
 958                                                 fileparts = append(fileparts, next)
 959                                         }
 960                                         streamLen += int64(seg.size)
 961                                 default:
 962                                         // This can't happen: we
 963                                         // haven't unlocked since
 964                                         // calling flush(sync=true).
 965                                         panic(fmt.Sprintf("can't marshal segment type %T", seg))
 966                                 }
 967                         }
 968                 }
 969                 var filetokens []string
 970                 for _, s := range fileparts {
 971                         filetokens = append(filetokens, fmt.Sprintf("%d:%d:%s", s.offset, s.length, manifestEscape(s.name)))
 972                 }
 973                 if len(filetokens) == 0 {
 974                         return nil
 975                 } else if len(blocks) == 0 {
 976                         blocks = []string{"d41d8cd98f00b204e9800998ecf8427e+0"}
 977                 }
 978                 rootdir = manifestEscape(prefix) + " " + strings.Join(blocks, " ") + " " + strings.Join(filetokens, " ") + "\n"
 979                 return nil
 980         })
 981         err := cg.Wait()
 982         return rootdir + strings.Join(subdirs, ""), err
 983 }
 984
 985 func (dn *dirnode) loadManifest(txt string) error {
 986         var dirname string
 987         streams := strings.Split(txt, "\n")
 988         if streams[len(streams)-1] != "" {
 989                 return fmt.Errorf("line %d: no trailing newline", len(streams))
 990         }
 991         streams = streams[:len(streams)-1]
 992         segments := []storedSegment{}
 993         for i, stream := range streams {
 994                 lineno := i + 1
 995                 var anyFileTokens bool
 996                 var pos int64
 997                 var segIdx int
 998                 segments = segments[:0]
 999                 for i, token := range strings.Split(stream, " ") {
1000                         if i == 0 {
1001                                 dirname = manifestUnescape(token)
1002                                 continue
1003                         }
1004                         if !strings.Contains(token, ":") {
1005                                 if anyFileTokens {
1006                                         return fmt.Errorf("line %d: bad file segment %q", lineno, token)
1007                                 }
1008                                 toks := strings.SplitN(token, "+", 3)
1009                                 if len(toks) < 2 {
1010                                         return fmt.Errorf("line %d: bad locator %q", lineno, token)
1011                                 }
1012                                 length, err := strconv.ParseInt(toks[1], 10, 32)
1013                                 if err != nil || length < 0 {
1014                                         return fmt.Errorf("line %d: bad locator %q", lineno, token)
1015                                 }
1016                                 segments = append(segments, storedSegment{
1017                                         locator: token,
1018                                         size:    int(length),
1019                                         offset:  0,
1020                                         length:  int(length),
1021                                 })
1022                                 continue
1023                         } else if len(segments) == 0 {
1024                                 return fmt.Errorf("line %d: bad locator %q", lineno, token)
1025                         }
1026
1027                         toks := strings.SplitN(token, ":", 3)
1028                         if len(toks) != 3 {
1029                                 return fmt.Errorf("line %d: bad file segment %q", lineno, token)
1030                         }
1031                         anyFileTokens = true
1032
1033                         offset, err := strconv.ParseInt(toks[0], 10, 64)
1034                         if err != nil || offset < 0 {
1035                                 return fmt.Errorf("line %d: bad file segment %q", lineno, token)
1036                         }
1037                         length, err := strconv.ParseInt(toks[1], 10, 64)
1038                         if err != nil || length < 0 {
1039                                 return fmt.Errorf("line %d: bad file segment %q", lineno, token)
1040                         }
1041                         name := dirname + "/" + manifestUnescape(toks[2])
1042                         fnode, err := dn.createFileAndParents(name)
1043                         if fnode == nil && err == nil && length == 0 {
1044                                 // Special case: an empty file used as
1045                                 // a marker to preserve an otherwise
1046                                 // empty directory in a manifest.
1047                                 continue
1048                         }
1049                         if err != nil || (fnode == nil && length != 0) {
1050                                 return fmt.Errorf("line %d: cannot use path %q with length %d: %s", lineno, name, length, err)
1051                         }
1052                         // Map the stream offset/range coordinates to
1053                         // block/offset/range coordinates and add
1054                         // corresponding storedSegments to the filenode
1055                         if pos > offset {
1056                                 // Can't continue where we left off.
1057                                 // TODO: binary search instead of
1058                                 // rewinding all the way (but this
1059                                 // situation might be rare anyway)
1060                                 segIdx, pos = 0, 0
1061                         }
1062                         for next := int64(0); segIdx < len(segments); segIdx++ {
1063                                 seg := segments[segIdx]
1064                                 next = pos + int64(seg.Len())
1065                                 if next <= offset || seg.Len() == 0 {
1066                                         pos = next
1067                                         continue
1068                                 }
1069                                 if pos >= offset+length {
1070                                         break
1071                                 }
1072                                 var blkOff int
1073                                 if pos < offset {
1074                                         blkOff = int(offset - pos)
1075                                 }
1076                                 blkLen := seg.Len() - blkOff
1077                                 if pos+int64(blkOff+blkLen) > offset+length {
1078                                         blkLen = int(offset + length - pos - int64(blkOff))
1079                                 }
1080                                 fnode.appendSegment(storedSegment{
1081                                         kc:      dn.fs,
1082                                         locator: seg.locator,
1083                                         size:    seg.size,
1084                                         offset:  blkOff,
1085                                         length:  blkLen,
1086                                 })
1087                                 if next > offset+length {
1088                                         break
1089                                 } else {
1090                                         pos = next
1091                                 }
1092                         }
1093                         if segIdx == len(segments) && pos < offset+length {
1094                                 return fmt.Errorf("line %d: invalid segment in %d-byte stream: %q", lineno, pos, token)
1095                         }
1096                 }
1097                 if !anyFileTokens {
1098                         return fmt.Errorf("line %d: no file segments", lineno)
1099                 } else if len(segments) == 0 {
1100                         return fmt.Errorf("line %d: no locators", lineno)
1101                 } else if dirname == "" {
1102                         return fmt.Errorf("line %d: no stream name", lineno)
1103                 }
1104         }
1105         return nil
1106 }
1107
1108 // only safe to call from loadManifest -- no locking.
1109 //
1110 // If path is a "parent directory exists" marker (the last path
1111 // component is "."), the returned values are both nil.
1112 func (dn *dirnode) createFileAndParents(path string) (fn *filenode, err error) {
1113         var node inode = dn
1114         names := strings.Split(path, "/")
1115         basename := names[len(names)-1]
1116         for _, name := range names[:len(names)-1] {
1117                 switch name {
1118                 case "", ".":
1119                         continue
1120                 case "..":
1121                         if node == dn {
1122                                 // can't be sure parent will be a *dirnode
1123                                 return nil, ErrInvalidArgument
1124                         }
1125                         node = node.Parent()
1126                         continue
1127                 }
1128                 node, err = node.Child(name, func(child inode) (inode, error) {
1129                         if child == nil {
1130                                 child, err := node.FS().newNode(name, 0755|os.ModeDir, node.Parent().FileInfo().ModTime())
1131                                 if err != nil {
1132                                         return nil, err
1133                                 }
1134                                 child.SetParent(node, name)
1135                                 return child, nil
1136                         } else if !child.IsDir() {
1137                                 return child, ErrFileExists
1138                         } else {
1139                                 return child, nil
1140                         }
1141                 })
1142                 if err != nil {
1143                         return
1144                 }
1145         }
1146         if basename == "." {
1147                 return
1148         } else if !permittedName(basename) {
1149                 err = fmt.Errorf("invalid file part %q in path %q", basename, path)
1150                 return
1151         }
1152         _, err = node.Child(basename, func(child inode) (inode, error) {
1153                 switch child := child.(type) {
1154                 case nil:
1155                         child, err = node.FS().newNode(basename, 0755, node.FileInfo().ModTime())
1156                         if err != nil {
1157                                 return nil, err
1158                         }
1159                         child.SetParent(node, basename)
1160                         fn = child.(*filenode)
1161                         return child, nil
1162                 case *filenode:
1163                         fn = child
1164                         return child, nil
1165                 case *dirnode:
1166                         return child, ErrIsDirectory
1167                 default:
1168                         return child, ErrInvalidArgument
1169                 }
1170         })
1171         return
1172 }
1173
1174 func (dn *dirnode) TreeSize() (bytes int64) {
1175         dn.RLock()
1176         defer dn.RUnlock()
1177         for _, i := range dn.inodes {
1178                 switch i := i.(type) {
1179                 case *filenode:
1180                         bytes += i.Size()
1181                 case *dirnode:
1182                         bytes += i.TreeSize()
1183                 }
1184         }
1185         return
1186 }
1187
1188 type segment interface {
1189         io.ReaderAt
1190         Len() int
1191         // Return a new segment with a subsection of the data from this
1192         // one. length<0 means length=Len()-off.
1193         Slice(off int, length int) segment
1194 }
1195
1196 type memSegment struct {
1197         buf []byte
1198         // If flushing is not nil, then a) buf is being shared by a
1199         // pruneMemSegments goroutine, and must be copied on write;
1200         // and b) the flushing channel will close when the goroutine
1201         // finishes, whether it succeeds or not.
1202         flushing <-chan struct{}
1203 }
1204
1205 func (me *memSegment) Len() int {
1206         return len(me.buf)
1207 }
1208
1209 func (me *memSegment) Slice(off, length int) segment {
1210         if length < 0 {
1211                 length = len(me.buf) - off
1212         }
1213         buf := make([]byte, length)
1214         copy(buf, me.buf[off:])
1215         return &memSegment{buf: buf}
1216 }
1217
1218 func (me *memSegment) Truncate(n int) {
1219         if n > cap(me.buf) || (me.flushing != nil && n > len(me.buf)) {
1220                 newsize := 1024
1221                 for newsize < n {
1222                         newsize = newsize << 2
1223                 }
1224                 newbuf := make([]byte, n, newsize)
1225                 copy(newbuf, me.buf)
1226                 me.buf, me.flushing = newbuf, nil
1227         } else {
1228                 // reclaim existing capacity, and zero reclaimed part
1229                 oldlen := len(me.buf)
1230                 me.buf = me.buf[:n]
1231                 for i := oldlen; i < n; i++ {
1232                         me.buf[i] = 0
1233                 }
1234         }
1235 }
1236
1237 func (me *memSegment) WriteAt(p []byte, off int) {
1238         if off+len(p) > len(me.buf) {
1239                 panic("overflowed segment")
1240         }
1241         if me.flushing != nil {
1242                 me.buf, me.flushing = append([]byte(nil), me.buf...), nil
1243         }
1244         copy(me.buf[off:], p)
1245 }
1246
1247 func (me *memSegment) ReadAt(p []byte, off int64) (n int, err error) {
1248         if off > int64(me.Len()) {
1249                 err = io.EOF
1250                 return
1251         }
1252         n = copy(p, me.buf[int(off):])
1253         if n < len(p) {
1254                 err = io.EOF
1255         }
1256         return
1257 }
1258
1259 type storedSegment struct {
1260         kc      fsBackend
1261         locator string
1262         size    int // size of stored block (also encoded in locator)
1263         offset  int // position of segment within the stored block
1264         length  int // bytes in this segment (offset + length <= size)
1265 }
1266
1267 func (se storedSegment) Len() int {
1268         return se.length
1269 }
1270
1271 func (se storedSegment) Slice(n, size int) segment {
1272         se.offset += n
1273         se.length -= n
1274         if size >= 0 && se.length > size {
1275                 se.length = size
1276         }
1277         return se
1278 }
1279
1280 func (se storedSegment) ReadAt(p []byte, off int64) (n int, err error) {
1281         if off > int64(se.length) {
1282                 return 0, io.EOF
1283         }
1284         maxlen := se.length - int(off)
1285         if len(p) > maxlen {
1286                 p = p[:maxlen]
1287                 n, err = se.kc.ReadAt(se.locator, p, int(off)+se.offset)
1288                 if err == nil {
1289                         err = io.EOF
1290                 }
1291                 return
1292         }
1293         return se.kc.ReadAt(se.locator, p, int(off)+se.offset)
1294 }
1295
1296 func canonicalName(name string) string {
1297         name = path.Clean("/" + name)
1298         if name == "/" || name == "./" {
1299                 name = "."
1300         } else if strings.HasPrefix(name, "/") {
1301                 name = "." + name
1302         }
1303         return name
1304 }
1305
1306 var manifestEscapeSeq = regexp.MustCompile(`\\([0-7]{3}|\\)`)
1307
1308 func manifestUnescapeFunc(seq string) string {
1309         if seq == `\\` {
1310                 return `\`
1311         }
1312         i, err := strconv.ParseUint(seq[1:], 8, 8)
1313         if err != nil {
1314                 // Invalid escape sequence: can't unescape.
1315                 return seq
1316         }
1317         return string([]byte{byte(i)})
1318 }
1319
1320 func manifestUnescape(s string) string {
1321         return manifestEscapeSeq.ReplaceAllStringFunc(s, manifestUnescapeFunc)
1322 }
1323
1324 var manifestEscapedChar = regexp.MustCompile(`[\000-\040:\s\\]`)
1325
1326 func manifestEscapeFunc(seq string) string {
1327         return fmt.Sprintf("\\%03o", byte(seq[0]))
1328 }
1329
1330 func manifestEscape(s string) string {
1331         return manifestEscapedChar.ReplaceAllStringFunc(s, manifestEscapeFunc)
1332 }