@ThreadSafe public final class CachingInodeStore extends Object implements InodeStore, Closeable
We call the other inode store the backing store. Backing store operations are much slower than on-heap operations, so we aim to serve as many requests as possible from the cache.
When the inode tree fits completely within the cache, we never interact with the backing store,
so performance should be similar to HeapInodeStore. Once the cache reaches the high
watermark, we begin evicting metadata to the backing store, and performance becomes dependent on
cache hit rate and backing store performance.
The CachingInodeStore uses 3 caches: an inode cache, and edge cache, and a listing cache. The inode cache stores inode metadata such as inode names, permissions, and sizes. The edge cache stores edge metadata, i.e. which inodes are children of which other inodes. The listing cache caches the results of calling getChildren.
See the javadoc for InodeCache, EdgeCache, and ListingCache for details
about their inner workings.
InodeStore.Factory, InodeStore.WriteBatch| Constructor and Description |
|---|
CachingInodeStore(InodeStore backingStore,
InodeLockManager lockManager) |
| Modifier and Type | Method and Description |
|---|---|
void |
addChild(long parentId,
String childName,
Long childId)
Makes an inode the child of the specified parent.
|
Set<EdgeEntry> |
allEdges() |
Set<MutableInode<?>> |
allInodes() |
void |
clear()
Removes all inodes and edges.
|
void |
close() |
CheckpointName |
getCheckpointName() |
Optional<Inode> |
getChild(Long inodeId,
String name,
ReadOption option) |
Optional<Long> |
getChildId(Long inodeId,
String name,
ReadOption option) |
CloseableIterator<Long> |
getChildIds(Long inodeId,
ReadOption option)
Returns an iterable for the ids of the children of the given directory.
|
Optional<MutableInode<?>> |
getMutable(long id,
ReadOption option)
Gets a mutable representation of the specified inode.
|
boolean |
hasChildren(InodeDirectoryView inode,
ReadOption option) |
void |
remove(Long inodeId)
Removes an inode from the inode store.
|
void |
removeChild(long parentId,
String name)
Removes a child from a parent inode.
|
void |
restoreFromCheckpoint(CheckpointInputStream input)
Restores state from a checkpoint.
|
CompletableFuture<Void> |
restoreFromCheckpoint(File directory,
ExecutorService executorService)
Restores state from a checkpoint asynchronously.
|
void |
writeInode(MutableInode<?> inode)
Adds the given inode, or overwrites it if it already exists.
|
void |
writeNewInode(MutableInode<?> inode)
Adds a new inode.
|
CompletableFuture<Void> |
writeToCheckpoint(File directory,
ExecutorService executorService)
Writes a checkpoint to the specified directory asynchronously using the provided executor.
|
void |
writeToCheckpoint(OutputStream output)
Writes a checkpoint of all state to the given output stream.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddChild, createWriteBatch, get, getInodePathString, getMutable, remove, removeInodeAndParentEdge, supportsBatchWriteget, getChild, getChild, getChild, getChildId, getChildId, getChildIds, getChildIds, getChildren, getChildren, getChildren, getChildren, getChildrenFrom, getChildrenPrefix, getChildrenPrefixFrom, hasChildrenpublic CachingInodeStore(InodeStore backingStore, InodeLockManager lockManager)
backingStore - the backing inode storelockManager - inode lock managerpublic Optional<MutableInode<?>> getMutable(long id, ReadOption option)
InodeStoregetMutable in interface InodeStoreid - an inode idoption - read optionspublic void remove(Long inodeId)
InodeStoreremove in interface InodeStoreinodeId - an inode to removepublic void writeInode(MutableInode<?> inode)
InodeStoreInodeStore.writeNewInode(MutableInode).
This method requires an inode lock manager read or write lock on the written inode.writeInode in interface InodeStoreinode - the inode to writepublic void writeNewInode(MutableInode<?> inode)
InodeStoreInodeStore.writeInode(MutableInode), but with an added information that
the inode is new. This allows some inode stores to perform extra optimizations.
This method requires an inode lock manager read or write lock on the written inode.writeNewInode in interface InodeStoreinode - the inode to writepublic void clear()
InodeStoreclear in interface InodeStorepublic void addChild(long parentId,
String childName,
Long childId)
InodeStoreaddChild in interface InodeStoreparentId - the parent idchildName - the child namechildId - the child inode idpublic void removeChild(long parentId,
String name)
InodeStoreremoveChild in interface InodeStoreparentId - the parent inode idname - the child namepublic CloseableIterator<Long> getChildIds(Long inodeId, ReadOption option)
ReadOnlyInodeStoregetChildIds in interface ReadOnlyInodeStoreinodeId - an inode id to list child ids foroption - the optionspublic Optional<Long> getChildId(Long inodeId, String name, ReadOption option)
getChildId in interface ReadOnlyInodeStoreinodeId - an inode idname - an inode nameoption - the optionspublic Optional<Inode> getChild(Long inodeId, String name, ReadOption option)
getChild in interface ReadOnlyInodeStoreinodeId - an inode idname - an inode nameoption - the optionspublic boolean hasChildren(InodeDirectoryView inode, ReadOption option)
hasChildren in interface ReadOnlyInodeStoreinode - an inode directoryoption - the optionspublic Set<EdgeEntry> allEdges()
allEdges in interface ReadOnlyInodeStorepublic Set<MutableInode<?>> allInodes()
allInodes in interface ReadOnlyInodeStorepublic void close()
close in interface InodeStoreclose in interface Closeableclose in interface AutoCloseablepublic CheckpointName getCheckpointName()
getCheckpointName in interface Checkpointedpublic CompletableFuture<Void> writeToCheckpoint(File directory, ExecutorService executorService)
CheckpointedwriteToCheckpoint in interface Checkpointeddirectory - where the checkpoint will be writtenexecutorService - to use when running tasks asynchronouslypublic void writeToCheckpoint(OutputStream output) throws IOException, InterruptedException
CheckpointedInterruptedException if they get
interrupted while running.writeToCheckpoint in interface Checkpointedoutput - the output stream to write toIOExceptionInterruptedExceptionpublic CompletableFuture<Void> restoreFromCheckpoint(File directory, ExecutorService executorService)
CheckpointedrestoreFromCheckpoint in interface Checkpointeddirectory - where the checkpoint will be locatedexecutorService - to use when running asynchronous taskspublic void restoreFromCheckpoint(CheckpointInputStream input) throws IOException
CheckpointedrestoreFromCheckpoint in interface Checkpointedinput - an input stream with checkpoint dataIOExceptionCopyright © 2023. All Rights Reserved.