cachingfs

Documentation

Index

• Constants
• type CachingFS
  • func NewCachingFS(lookupEntryTimeout time.Duration, getattrTimeout time.Duration) (CachingFS, error)

Constants

const (
	// Sizes of the files according to the file system.
	FooSize = 123
	BarSize = 456
)

Types

type CachingFS

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)
}

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.

func NewCachingFS

func NewCachingFS(
	lookupEntryTimeout time.Duration,
	getattrTimeout time.Duration) (CachingFS, error)

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.)