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