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