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