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