/usr/share/gocode/src/github.com/jacobsa/fuse/samples/cachingfs/caching_fs.go is in golang-github-jacobsa-fuse-dev 0.0~git20150806.0.9a7512a-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 | // Copyright 2015 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package cachingfs
import (
"crypto/rand"
"fmt"
"io"
"os"
"time"
"golang.org/x/net/context"
"github.com/jacobsa/fuse"
"github.com/jacobsa/fuse/fuseops"
"github.com/jacobsa/fuse/fuseutil"
"github.com/jacobsa/syncutil"
)
const (
// Sizes of the files according to the file system.
FooSize = 123
BarSize = 456
)
// A file system with a fixed structure that looks like this:
//
// foo
// dir/
// bar
//
// The file system is configured with durations that specify how long to allow
// inode entries and attributes to be cached, used when responding to fuse
// requests. It also exposes methods for renumbering inodes and updating mtimes
// that are useful in testing that these durations are honored.
//
// Each file responds to reads with random contents. SetKeepCache can be used
// to control whether the response to OpenFileOp tells the kernel to keep the
// file's data in the page cache or not.
type CachingFS interface {
fuseutil.FileSystem
// Return the current inode ID of the file/directory with the given name.
FooID() fuseops.InodeID
DirID() fuseops.InodeID
BarID() fuseops.InodeID
// Cause the inode IDs to change to values that have never before been used.
RenumberInodes()
// Cause further queries for the attributes of inodes to use the supplied
// time as the inode's mtime.
SetMtime(mtime time.Time)
// Instruct the file system whether or not to reply to OpenFileOp with
// FOPEN_KEEP_CACHE set.
SetKeepCache(keep bool)
}
// Create a file system that issues cacheable responses according to the
// following rules:
//
// * LookUpInodeResponse.Entry.EntryExpiration is set according to
// lookupEntryTimeout.
//
// * GetInodeAttributesResponse.AttributesExpiration is set according to
// getattrTimeout.
//
// * Nothing else is marked cacheable. (In particular, the attributes
// returned by LookUpInode are not cacheable.)
//
func NewCachingFS(
lookupEntryTimeout time.Duration,
getattrTimeout time.Duration) (fs CachingFS, err error) {
roundUp := func(n fuseops.InodeID) fuseops.InodeID {
return numInodes * ((n + numInodes - 1) / numInodes)
}
cfs := &cachingFS{
lookupEntryTimeout: lookupEntryTimeout,
getattrTimeout: getattrTimeout,
baseID: roundUp(fuseops.RootInodeID + 1),
mtime: time.Now(),
}
cfs.mu = syncutil.NewInvariantMutex(cfs.checkInvariants)
fs = cfs
return
}
const (
// Inode IDs are issued such that "foo" always receives an ID that is
// congruent to fooOffset modulo numInodes, etc.
fooOffset = iota
dirOffset
barOffset
numInodes
)
type cachingFS struct {
fuseutil.NotImplementedFileSystem
/////////////////////////
// Constant data
/////////////////////////
lookupEntryTimeout time.Duration
getattrTimeout time.Duration
/////////////////////////
// Mutable state
/////////////////////////
mu syncutil.InvariantMutex
// GUARDED_BY(mu)
keepPageCache bool
// The current ID of the lowest numbered non-root inode.
//
// INVARIANT: baseID > fuseops.RootInodeID
// INVARIANT: baseID % numInodes == 0
//
// GUARDED_BY(mu)
baseID fuseops.InodeID
// GUARDED_BY(mu)
mtime time.Time
}
////////////////////////////////////////////////////////////////////////
// Helpers
////////////////////////////////////////////////////////////////////////
func (fs *cachingFS) checkInvariants() {
// INVARIANT: baseID > fuseops.RootInodeID
// INVARIANT: baseID % numInodes == 0
if fs.baseID <= fuseops.RootInodeID || fs.baseID%numInodes != 0 {
panic(fmt.Sprintf("Bad baseID: %v", fs.baseID))
}
}
// LOCKS_REQUIRED(fs.mu)
func (fs *cachingFS) fooID() fuseops.InodeID {
return fs.baseID + fooOffset
}
// LOCKS_REQUIRED(fs.mu)
func (fs *cachingFS) dirID() fuseops.InodeID {
return fs.baseID + dirOffset
}
// LOCKS_REQUIRED(fs.mu)
func (fs *cachingFS) barID() fuseops.InodeID {
return fs.baseID + barOffset
}
// LOCKS_REQUIRED(fs.mu)
func (fs *cachingFS) rootAttrs() fuseops.InodeAttributes {
return fuseops.InodeAttributes{
Mode: os.ModeDir | 0777,
Mtime: fs.mtime,
}
}
// LOCKS_REQUIRED(fs.mu)
func (fs *cachingFS) fooAttrs() fuseops.InodeAttributes {
return fuseops.InodeAttributes{
Nlink: 1,
Size: FooSize,
Mode: 0777,
Mtime: fs.mtime,
}
}
// LOCKS_REQUIRED(fs.mu)
func (fs *cachingFS) dirAttrs() fuseops.InodeAttributes {
return fuseops.InodeAttributes{
Nlink: 1,
Mode: os.ModeDir | 0777,
Mtime: fs.mtime,
}
}
// LOCKS_REQUIRED(fs.mu)
func (fs *cachingFS) barAttrs() fuseops.InodeAttributes {
return fuseops.InodeAttributes{
Nlink: 1,
Size: BarSize,
Mode: 0777,
Mtime: fs.mtime,
}
}
////////////////////////////////////////////////////////////////////////
// Public interface
////////////////////////////////////////////////////////////////////////
// LOCKS_EXCLUDED(fs.mu)
func (fs *cachingFS) FooID() fuseops.InodeID {
fs.mu.Lock()
defer fs.mu.Unlock()
return fs.fooID()
}
// LOCKS_EXCLUDED(fs.mu)
func (fs *cachingFS) DirID() fuseops.InodeID {
fs.mu.Lock()
defer fs.mu.Unlock()
return fs.dirID()
}
// LOCKS_EXCLUDED(fs.mu)
func (fs *cachingFS) BarID() fuseops.InodeID {
fs.mu.Lock()
defer fs.mu.Unlock()
return fs.barID()
}
// LOCKS_EXCLUDED(fs.mu)
func (fs *cachingFS) RenumberInodes() {
fs.mu.Lock()
defer fs.mu.Unlock()
fs.baseID += numInodes
}
// LOCKS_EXCLUDED(fs.mu)
func (fs *cachingFS) SetMtime(mtime time.Time) {
fs.mu.Lock()
defer fs.mu.Unlock()
fs.mtime = mtime
}
// LOCKS_EXCLUDED(fs.mu)
func (fs *cachingFS) SetKeepCache(keep bool) {
fs.mu.Lock()
defer fs.mu.Unlock()
fs.keepPageCache = keep
}
////////////////////////////////////////////////////////////////////////
// FileSystem methods
////////////////////////////////////////////////////////////////////////
// LOCKS_EXCLUDED(fs.mu)
func (fs *cachingFS) LookUpInode(
ctx context.Context,
op *fuseops.LookUpInodeOp) (err error) {
fs.mu.Lock()
defer fs.mu.Unlock()
// Find the ID and attributes.
var id fuseops.InodeID
var attrs fuseops.InodeAttributes
switch op.Name {
case "foo":
// Parent must be the root.
if op.Parent != fuseops.RootInodeID {
err = fuse.ENOENT
return
}
id = fs.fooID()
attrs = fs.fooAttrs()
case "dir":
// Parent must be the root.
if op.Parent != fuseops.RootInodeID {
err = fuse.ENOENT
return
}
id = fs.dirID()
attrs = fs.dirAttrs()
case "bar":
// Parent must be dir.
if op.Parent == fuseops.RootInodeID || op.Parent%numInodes != dirOffset {
err = fuse.ENOENT
return
}
id = fs.barID()
attrs = fs.barAttrs()
default:
err = fuse.ENOENT
return
}
// Fill in the response.
op.Entry.Child = id
op.Entry.Attributes = attrs
op.Entry.EntryExpiration = time.Now().Add(fs.lookupEntryTimeout)
return
}
// LOCKS_EXCLUDED(fs.mu)
func (fs *cachingFS) GetInodeAttributes(
ctx context.Context,
op *fuseops.GetInodeAttributesOp) (err error) {
fs.mu.Lock()
defer fs.mu.Unlock()
// Figure out which inode the request is for.
var attrs fuseops.InodeAttributes
switch {
case op.Inode == fuseops.RootInodeID:
attrs = fs.rootAttrs()
case op.Inode%numInodes == fooOffset:
attrs = fs.fooAttrs()
case op.Inode%numInodes == dirOffset:
attrs = fs.dirAttrs()
case op.Inode%numInodes == barOffset:
attrs = fs.barAttrs()
}
// Fill in the response.
op.Attributes = attrs
op.AttributesExpiration = time.Now().Add(fs.getattrTimeout)
return
}
func (fs *cachingFS) OpenDir(
ctx context.Context,
op *fuseops.OpenDirOp) (err error) {
return
}
func (fs *cachingFS) OpenFile(
ctx context.Context,
op *fuseops.OpenFileOp) (err error) {
fs.mu.Lock()
defer fs.mu.Unlock()
op.KeepPageCache = fs.keepPageCache
return
}
func (fs *cachingFS) ReadFile(
ctx context.Context,
op *fuseops.ReadFileOp) (err error) {
op.BytesRead, err = io.ReadFull(rand.Reader, op.Dst)
return
}
|