alluxio.master.file.meta

Class InodeTreePersistentState

java.lang.Object

alluxio.master.file.meta.InodeTreePersistentState

All Implemented Interfaces:

Checkpointed, Journaled, JournalEntryIterable

public class InodeTreePersistentState
extends Object
implements Journaled

Class for managing persistent inode tree state. This class owns all persistent inode tree state, and all inode tree modifications must go through this class. To modify the inode tree, create a journal entry and call one of the applyAndJournal methods.

Constructor Summary

Constructors

Constructor and Description
InodeTreePersistentState(InodeStore inodeStore, InodeLockManager lockManager, TtlBucketList ttlBucketList)

Method Summary

Modifier and Type	Method and Description
void	applyAndJournal(java.util.function.Supplier<JournalContext> context, File.DeleteFileEntry entry) Deletes an inode (may be either a file or directory).
long	applyAndJournal(java.util.function.Supplier<JournalContext> context, File.NewBlockEntry entry) Allocates and returns the next block ID for the indicated inode.
void	applyAndJournal(java.util.function.Supplier<JournalContext> context, File.RenameEntry entry) Renames an inode.
void	applyAndJournal(java.util.function.Supplier<JournalContext> context, File.SetAclEntry entry) Sets an ACL for an inode.
void	applyAndJournal(java.util.function.Supplier<JournalContext> context, File.UpdateInodeDirectoryEntry entry) Updates an inode directory's state.
void	applyAndJournal(java.util.function.Supplier<JournalContext> context, File.UpdateInodeEntry entry) Updates an inode's state.
void	applyAndJournal(java.util.function.Supplier<JournalContext> context, File.UpdateInodeFileEntry entry) Updates an inode file's state.
void	applyAndJournal(java.util.function.Supplier<JournalContext> context, MutableInode<?> inode, String path) Adds an inode to the inode tree.
File.UpdateInodeEntry	applyInodeAccessTime(long inodeId, long accessTime) Updates last access time for Inode without journaling.
void	cacheOperation(OperationId opId) Used to mark an operation as complete in retry-cache.
CheckpointName	getCheckpointName()
Map<Long,Number>	getFileSizeHistogram()
long	getInodeCount()
CloseableIterator<Journal.JournalEntry>	getJournalEntryIterator()
Set<Long>	getPinnedInodeFileIds()
Set<Long>	getReplicationLimitedFileIds()
InodeDirectory	getRoot()
Set<Long>	getToBePersistedIds()
TtlBucketList	getTtlBuckets()
boolean	isOperationComplete(OperationId opId) Whether given operation is still cached in retry-cache.
boolean	processJournalEntry(Journal.JournalEntry entry) Attempts to apply a journal entry.
void	resetState() Resets the object's journaled state.
void	restoreFromCheckpoint(CheckpointInputStream input) Restores state from a checkpoint.
CompletableFuture<Void>	restoreFromCheckpoint(File directory, ExecutorService executorService) Restores state from a checkpoint asynchronously.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.master.journal.Journaled

applyAndJournal

Constructor Detail

InodeTreePersistentState

public InodeTreePersistentState(InodeStore inodeStore,
                                InodeLockManager lockManager,
                                TtlBucketList ttlBucketList)

Parameters:

inodeStore - file store which holds inode metadata

lockManager - manager for inode locks

ttlBucketList - reference to the ttl bucket list so that the list can be updated when the inode tree is modified

Method Detail

isOperationComplete

public boolean isOperationComplete(@Nullable
                                   OperationId opId)

Whether given operation is still cached in retry-cache.

Parameters:

opId - the operation id

Returns:

true if given op is marked complete

cacheOperation

public void cacheOperation(@Nullable
                           OperationId opId)

Used to mark an operation as complete in retry-cache.

Parameters:

opId - the operation id

getReplicationLimitedFileIds

public Set<Long> getReplicationLimitedFileIds()

Returns:

an unmodifiable view of the replication limited file ids

getRoot

public InodeDirectory getRoot()

Returns:

the root of the inode tree

getPinnedInodeFileIds

public Set<Long> getPinnedInodeFileIds()

Returns:

the pinned inode file ids;

getInodeCount

public long getInodeCount()

Returns:

the number of inodes in the tree

getFileSizeHistogram

public Map<Long,Number> getFileSizeHistogram()

Returns:

the file size distribution in the tree

getToBePersistedIds

public Set<Long> getToBePersistedIds()

Returns:

an unmodifiable view of the files with persistence state PersistenceState.TO_BE_PERSISTED

getTtlBuckets

public TtlBucketList getTtlBuckets()

Returns:

the list of TTL buckets for tracking inode TTLs

applyAndJournal

public void applyAndJournal(java.util.function.Supplier<JournalContext> context,
                            File.DeleteFileEntry entry)

Deletes an inode (may be either a file or directory).

Parameters:

context - journal context supplier

entry - delete file entry

applyAndJournal

public long applyAndJournal(java.util.function.Supplier<JournalContext> context,
                            File.NewBlockEntry entry)

Allocates and returns the next block ID for the indicated inode.

Parameters:

context - journal context supplier

entry - new block entry

Returns:

the new block id

applyAndJournal

public void applyAndJournal(java.util.function.Supplier<JournalContext> context,
                            File.RenameEntry entry)

Renames an inode.

Parameters:

context - journal context supplier

entry - rename entry

applyAndJournal

public void applyAndJournal(java.util.function.Supplier<JournalContext> context,
                            File.SetAclEntry entry)

Sets an ACL for an inode.

Parameters:

context - journal context supplier

entry - set acl entry

applyAndJournal

public void applyAndJournal(java.util.function.Supplier<JournalContext> context,
                            File.UpdateInodeEntry entry)

Updates an inode's state. This is used for state common to both files and directories.

Parameters:

context - journal context supplier

entry - update inode entry

applyAndJournal

public void applyAndJournal(java.util.function.Supplier<JournalContext> context,
                            File.UpdateInodeDirectoryEntry entry)

Updates an inode directory's state.

Parameters:

context - journal context supplier

entry - update inode directory entry

applyAndJournal

public void applyAndJournal(java.util.function.Supplier<JournalContext> context,
                            File.UpdateInodeFileEntry entry)

Updates an inode file's state.

Parameters:

context - journal context supplier

entry - update inode file entry

applyAndJournal

public void applyAndJournal(java.util.function.Supplier<JournalContext> context,
                            MutableInode<?> inode,
                            String path)

Adds an inode to the inode tree.

Parameters:

context - journal context supplier

inode - an inode to add and create a journal entry for

path - path of the new inode

applyInodeAccessTime

public File.UpdateInodeEntry applyInodeAccessTime(long inodeId,
                                                  long accessTime)

Updates last access time for Inode without journaling. The caller should apply the journal entry separately.

Parameters:

inodeId - the id of the target inode

accessTime - the new value for last access time

Returns:

the journal entry that represents the update

processJournalEntry

public boolean processJournalEntry(Journal.JournalEntry entry)

Description copied from interface: Journaled

Attempts to apply a journal entry.

Specified by:

processJournalEntry in interface Journaled

Parameters:

entry - the entry to apply

Returns:

whether the entry type is supported by this journaled object

resetState

public void resetState()

Description copied from interface: Journaled

Resets the object's journaled state.

Specified by:

resetState in interface Journaled

writeToCheckpoint

public CompletableFuture<Void> writeToCheckpoint(File directory,
                                                 ExecutorService executorService)

Description copied from interface: Checkpointed

Writes a checkpoint to the specified directory asynchronously using the provided executor.

Specified by:

writeToCheckpoint in interface Checkpointed

Parameters:

directory - where the checkpoint will be written

executorService - to use when running tasks asynchronously

Returns:

a future that processes the computation

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

Specified by:

writeToCheckpoint in interface Journaled

Parameters:

output - the output stream to write to

Throws:

IOException

InterruptedException

restoreFromCheckpoint

public CompletableFuture<Void> restoreFromCheckpoint(File directory,
                                                     ExecutorService executorService)

Description copied from interface: Checkpointed

Restores state from a checkpoint asynchronously.

Specified by:

restoreFromCheckpoint in interface Checkpointed

Parameters:

directory - where the checkpoint will be located

executorService - to use when running asynchronous tasks

Returns:

a future to track the progress

restoreFromCheckpoint

public void restoreFromCheckpoint(CheckpointInputStream input)
                           throws IOException

Description copied from interface: Checkpointed

Restores state from a checkpoint.

Specified by:

restoreFromCheckpoint in interface Checkpointed

Specified by:

restoreFromCheckpoint in interface Journaled

Parameters:

input - an input stream with checkpoint data

Throws:

IOException

getJournalEntryIterator

public CloseableIterator<Journal.JournalEntry> getJournalEntryIterator()

Specified by:

getJournalEntryIterator in interface JournalEntryIterable

Returns:

an CloseableIterator that iterates all the journal entries

getCheckpointName

public CheckpointName getCheckpointName()

Specified by:

getCheckpointName in interface Checkpointed

Returns:

a name for this checkpointed class