sdk/go/arvados/fs_deferred.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         "log"
   9         "os"
  10         "sync"
  11         "time"
  12 )
  13
  14 func deferredCollectionFS(fs FileSystem, parent inode, coll Collection) inode {
  15         modTime := coll.ModifiedAt
  16         if modTime.IsZero() {
  17                 modTime = time.Now()
  18         }
  19         placeholder := &treenode{
  20                 fs:     fs,
  21                 parent: parent,
  22                 inodes: nil,
  23                 fileinfo: fileinfo{
  24                         name:    coll.Name,
  25                         modTime: modTime,
  26                         mode:    0755 | os.ModeDir,
  27                 },
  28         }
  29         return &deferrednode{wrapped: placeholder, create: func() inode {
  30                 err := fs.RequestAndDecode(&coll, "GET", "arvados/v1/collections/"+coll.UUID, nil, nil)
  31                 if err != nil {
  32                         log.Printf("BUG: unhandled error: %s", err)
  33                         return placeholder
  34                 }
  35                 cfs, err := coll.FileSystem(fs, fs)
  36                 if err != nil {
  37                         log.Printf("BUG: unhandled error: %s", err)
  38                         return placeholder
  39                 }
  40                 return cfs.(*collectionFileSystem).asChildNode(parent, coll.Name)
  41         }}
  42 }
  43
  44 // A deferrednode wraps an inode that's expensive to build. Initially,
  45 // it responds to basic directory functions by proxying to the given
  46 // placeholder. If a caller uses a read/write/lock operation,
  47 // deferrednode calls the create() func to create the real inode, and
  48 // proxies to the real inode from then on.
  49 //
  50 // In practice, this means a deferrednode's parent's directory listing
  51 // can be generated using only the placeholder, instead of waiting for
  52 // create().
  53 type deferrednode struct {
  54         wrapped inode
  55         create  func() inode
  56         mtx     sync.Mutex
  57         created bool
  58 }
  59
  60 func (dn *deferrednode) realinode() inode {
  61         dn.mtx.Lock()
  62         defer dn.mtx.Unlock()
  63         if !dn.created {
  64                 dn.wrapped = dn.create()
  65                 dn.created = true
  66         }
  67         return dn.wrapped
  68 }
  69
  70 func (dn *deferrednode) currentinode() inode {
  71         dn.mtx.Lock()
  72         defer dn.mtx.Unlock()
  73         return dn.wrapped
  74 }
  75
  76 func (dn *deferrednode) Read(p []byte, pos filenodePtr) (int, filenodePtr, error) {
  77         return dn.realinode().Read(p, pos)
  78 }
  79
  80 func (dn *deferrednode) Write(p []byte, pos filenodePtr) (int, filenodePtr, error) {
  81         return dn.realinode().Write(p, pos)
  82 }
  83
  84 func (dn *deferrednode) Child(name string, replace func(inode) (inode, error)) (inode, error) {
  85         return dn.realinode().Child(name, replace)
  86 }
  87
  88 // Sync is currently unimplemented, except when it's a no-op because
  89 // the real inode hasn't been created.
  90 func (dn *deferrednode) Sync() error {
  91         dn.mtx.Lock()
  92         defer dn.mtx.Unlock()
  93         if dn.created {
  94                 return ErrInvalidArgument
  95         } else {
  96                 return nil
  97         }
  98 }
  99
 100 func (dn *deferrednode) Truncate(size int64) error       { return dn.realinode().Truncate(size) }
 101 func (dn *deferrednode) SetParent(p inode, name string)  { dn.realinode().SetParent(p, name) }
 102 func (dn *deferrednode) IsDir() bool                     { return dn.currentinode().IsDir() }
 103 func (dn *deferrednode) Readdir() ([]os.FileInfo, error) { return dn.realinode().Readdir() }
 104 func (dn *deferrednode) Size() int64                     { return dn.currentinode().Size() }
 105 func (dn *deferrednode) FileInfo() os.FileInfo           { return dn.currentinode().FileInfo() }
 106 func (dn *deferrednode) Lock()                           { dn.realinode().Lock() }
 107 func (dn *deferrednode) Unlock()                         { dn.realinode().Unlock() }
 108 func (dn *deferrednode) RLock()                          { dn.realinode().RLock() }
 109 func (dn *deferrednode) RUnlock()                        { dn.realinode().RUnlock() }
 110 func (dn *deferrednode) FS() FileSystem                  { return dn.currentinode().FS() }
 111 func (dn *deferrednode) Parent() inode                   { return dn.currentinode().Parent() }