alluxio.master.metastore.heap

Class HeapInodeStore

java.lang.Object

alluxio.master.metastore.heap.HeapInodeStore

All Implemented Interfaces:

Checkpointed, InodeStore, ReadOnlyInodeStore, Closeable, AutoCloseable

@ThreadSafe
public class HeapInodeStore
extends Object
implements InodeStore

FileStore implementation using on-heap data structures.

Nested Class Summary

Nested classes/interfaces inherited from interface alluxio.master.metastore.InodeStore

InodeStore.Factory, InodeStore.WriteBatch

Constructor Summary

Constructors

Constructor and Description
HeapInodeStore() Construct a heap inode store.

Method Summary

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.
CheckpointName	getCheckpointName()
Optional<Inode>	getChild(Long inodeId, String child, ReadOption option)
Optional<Long>	getChildId(Long inodeId, String child, ReadOption option)
CloseableIterator<Long>	getChildIds(Long inodeId, ReadOption option) Returns an iterable for the ids of the children of the given directory.
CloseableIterator<? extends Inode>	getChildren(Long inodeId, ReadOption option) Returns an iterator over the children of the specified inode.
Optional<MutableInode<?>>	getMutable(long id, ReadOption option) Gets a mutable representation of the specified inode.
boolean	hasChildren(InodeDirectoryView dir, 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.
static Iterator<Long>	sortedMapToIterator(SortedMap<String,Long> childrenMap, ReadOption option) Helper function that returns an iterator over the sorted map using the given read options.
void	writeInode(MutableInode<?> inode) Adds the given inode, or overwrites it if it already exists.
void	writeNewInode(MutableInode<?> inode) Adds a new inode.
void	writeToCheckpoint(OutputStream output) Writes a checkpoint of all state to the given output stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface alluxio.master.metastore.InodeStore

addChild, close, createWriteBatch, get, getInodePathString, getMutable, remove, removeInodeAndParentEdge, supportsBatchWrite

Methods inherited from interface alluxio.master.metastore.ReadOnlyInodeStore

get, getChild, getChild, getChild, getChildId, getChildId, getChildIds, getChildIds, getChildren, getChildren, getChildren, getChildrenFrom, getChildrenPrefix, getChildrenPrefixFrom, hasChildren

Constructor Detail

HeapInodeStore

public HeapInodeStore()

Construct a heap inode store.

Method Detail

remove

public void remove(Long inodeId)

Description copied from interface: InodeStore

Removes an inode from the inode store. This does *not* remove the edge leading to the inode. This method requires an inode lock manager read or write lock on the removed inode.

Specified by:

remove in interface InodeStore

Parameters:

inodeId - an inode to remove

writeNewInode

public void writeNewInode(MutableInode<?> inode)

Description copied from interface: InodeStore

Adds a new inode. This method is similar to InodeStore.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.

Specified by:

writeNewInode in interface InodeStore

Parameters:

inode - the inode to write

writeInode

public void writeInode(MutableInode<?> inode)

Description copied from interface: InodeStore

Adds the given inode, or overwrites it if it already exists. If it is known that the inode is new, prefer InodeStore.writeNewInode(MutableInode). This method requires an inode lock manager read or write lock on the written inode.

Specified by:

writeInode in interface InodeStore

Parameters:

inode - the inode to write

addChild

public void addChild(long parentId,
                     String childName,
                     Long childId)

Description copied from interface: InodeStore

Makes an inode the child of the specified parent. This method requires an inode lock manager read or write locks on the added edge.

Specified by:

addChild in interface InodeStore

Parameters:

parentId - the parent id

childName - the child name

childId - the child inode id

removeChild

public void removeChild(long parentId,
                        String name)

Description copied from interface: InodeStore

Removes a child from a parent inode. This method requires an inode lock manager read or write locks on the removed edge.

Specified by:

removeChild in interface InodeStore

Parameters:

parentId - the parent inode id

name - the child name

getMutable

public Optional<MutableInode<?>> getMutable(long id,
                                            ReadOption option)

Description copied from interface: InodeStore

Gets a mutable representation of the specified inode. Mutating the returned inode requires holding an inode lock manager read or write lock on the inode.

Specified by:

getMutable in interface InodeStore

Parameters:

id - an inode id

option - read options

Returns:

the inode with the given id, if it exists

getChildren

public CloseableIterator<? extends Inode> getChildren(Long inodeId,
                                                      ReadOption option)

Description copied from interface: ReadOnlyInodeStore

Returns an iterator over the children of the specified inode. The iterator is weakly consistent. It can operate in the presence of concurrent modification, but it is undefined whether concurrently removed inodes will be excluded or whether concurrently added inodes will be included.

Specified by:

getChildren in interface ReadOnlyInodeStore

Parameters:

inodeId - an inode id

option - the options

Returns:

an iterable over the children of the inode with the given id

getChildId

public Optional<Long> getChildId(Long inodeId,
                                 String child,
                                 ReadOption option)

Specified by:

getChildId in interface ReadOnlyInodeStore

Parameters:

inodeId - an inode id

child - an inode name

option - the options

Returns:

the id of the child of the inode with the given name

getChild

public Optional<Inode> getChild(Long inodeId,
                                String child,
                                ReadOption option)

Specified by:

getChild in interface ReadOnlyInodeStore

Parameters:

inodeId - an inode id

child - an inode name

option - the options

Returns:

the child of the inode with the given name

hasChildren

public boolean hasChildren(InodeDirectoryView dir,
                           ReadOption option)

Specified by:

hasChildren in interface ReadOnlyInodeStore

Parameters:

dir - an inode directory

option - the options

Returns:

whether the inode has any children

allEdges

public Set<EdgeEntry> allEdges()

Specified by:

allEdges in interface ReadOnlyInodeStore

Returns:

all edges in the inode store

allInodes

public Set<MutableInode<?>> allInodes()

Specified by:

allInodes in interface ReadOnlyInodeStore

Returns:

all inodes in the inode store

clear

public void clear()

Description copied from interface: InodeStore

Removes all inodes and edges.

Specified by:

clear in interface InodeStore

writeToCheckpoint

public void writeToCheckpoint(OutputStream output)
                       throws IOException,
                              InterruptedException

Description copied from interface: Checkpointed

Writes a checkpoint of all state to the given output stream. Implementations should make an effort to throw InterruptedException if they get interrupted while running.

Specified by:

writeToCheckpoint in interface Checkpointed

Parameters:

output - the output stream to write to

Throws:

IOException

InterruptedException

restoreFromCheckpoint

public void restoreFromCheckpoint(CheckpointInputStream input)
                           throws IOException

Description copied from interface: Checkpointed

Restores state from a checkpoint.

Specified by:

restoreFromCheckpoint in interface Checkpointed

Parameters:

input - an input stream with checkpoint data

Throws:

IOException

getCheckpointName

public CheckpointName getCheckpointName()

Specified by:

getCheckpointName in interface Checkpointed

Returns:

a name for this checkpointed class

getChildIds

public CloseableIterator<Long> getChildIds(Long inodeId,
                                           ReadOption option)

Description copied from interface: ReadOnlyInodeStore

Returns an iterable for the ids of the children of the given directory.

Specified by:

getChildIds in interface ReadOnlyInodeStore

Parameters:

inodeId - an inode id to list child ids for

option - the options

Returns:

the child ids iterable

sortedMapToIterator

public static Iterator<Long> sortedMapToIterator(SortedMap<String,Long> childrenMap,
                                                 ReadOption option)

Helper function that returns an iterator over the sorted map using the given read options.

Parameters:

childrenMap - the map to create the iterator from

option - the read options to use

Returns:

the iterator over the map