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