sdk/go/arvados/fs_collection.go

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