alluxio.master.file.meta

Class InodeTree

java.lang.Object

alluxio.master.file.meta.InodeTree

All Implemented Interfaces:

JournalEntryIterable

@NotThreadSafe
public class InodeTree
extends Object
implements JournalEntryIterable

Represents the tree of Inodes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InodeTree.CreatePathResult Represents the results of creating a path in the inode tree.
static class	InodeTree.LockMode The type of lock to lock inode paths with.

Field Summary

Fields

Modifier and Type	Field and Description
static long	NO_PARENT Value to be used for an inode with no parent.

Constructor Summary

Constructors

Constructor and Description
InodeTree(ContainerIdGenerable containerIdGenerator, InodeDirectoryIdGenerator directoryIdGenerator, MountTable mountTable)

Method Summary

Modifier and Type	Method and Description
void	addInodeDirectoryFromJournal(File.InodeDirectoryEntry entry) Adds the directory represented by the entry parameter into the inode tree.
void	addInodeFileFromJournal(File.InodeFileEntry entry) Adds the file represented by the entry parameter into the inode tree.
InodeTree.CreatePathResult	createPath(RpcContext rpcContext, LockedInodePath inodePath, CreatePathOptions<?> options) Creates a file or directory at path.
void	deleteInode(RpcContext rpcContext, LockedInodePath inodePath, long opTimeMs, DeleteOptions deleteOptions) Deletes a single inode from the inode tree by removing it from the parent inode.
void	ensureFullInodePath(LockedInodePath inodePath, InodeTree.LockMode lockMode) Attempts to extend an existing LockedInodePath to reach the target inode (the last inode for the full path).
boolean	equals(Object o)
Iterator<Journal.JournalEntry>	getJournalEntryIterator()
AlluxioURI	getPath(Inode<?> inode) Returns the path for a particular inode.
Set<Long>	getPinIdSet()
int	getPinnedSize()
InodeDirectory	getRoot()
String	getRootUserName()
int	getSize()
int	hashCode()
void	initializeRoot(String owner, String group, Mode mode, JournalContext context) Initializes the root of the inode tree.
boolean	inodeIdExists(long id)
boolean	inodePathExists(AlluxioURI uri)
boolean	isRootId(long fileId)
LockedInodePath	lockChildPath(LockedInodePath inodePath, InodeTree.LockMode lockMode, Inode<?> childInode, String[] pathComponents) Lock from a specific poiint in the tree to the immediate child, and return a lockedInodePath.
LockedInodePath	lockDescendantPath(LockedInodePath inodePath, InodeTree.LockMode lockMode, AlluxioURI descendantUri) Locks from a specific point in the tree to the descendant, and return a lockedInodePath.
LockedInodePathList	lockDescendants(LockedInodePath inodePath, InodeTree.LockMode lockMode) Locks all descendants of a particular LockedInodePath.
LockedInodePath	lockFullInodePath(AlluxioURI path, InodeTree.LockMode lockMode) Locks existing inodes on the specified path, in the specified InodeTree.LockMode.
LockedInodePath	lockFullInodePath(long id, InodeTree.LockMode lockMode) Locks existing inodes on the path to the inode specified by an id, in the specified InodeTree.LockMode.
LockedInodePath	lockInodePath(AlluxioURI path, InodeTree.LockMode lockMode) Locks existing inodes on the specified path, in the specified InodeTree.LockMode.
InodePathPair	lockInodePathPair(AlluxioURI path1, InodeTree.LockMode lockMode1, AlluxioURI path2, InodeTree.LockMode lockMode2) Locks existing inodes on the two specified paths.
long	reinitializeFile(LockedInodePath inodePath, long blockSizeBytes, long ttl, TtlAction ttlAction) Reinitializes the block size and TTL of an existing open file.
void	reset() Resets the inode tree.
void	setPinned(LockedInodePath inodePath, boolean pinned) Sets the pinned state of an inode.
void	setPinned(LockedInodePath inodePath, boolean pinned, long opTimeMs) Sets the pinned state of an inode.
void	syncPersistDirectory(RpcContext rpcContext, InodeDirectory dir) Synchronously persists an InodeDirectory to the UFS.

Methods inherited from class java.lang.Object

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

Field Detail

NO_PARENT

public static final long NO_PARENT

Value to be used for an inode with no parent.

See Also:

Constant Field Values

Constructor Detail

InodeTree

public InodeTree(ContainerIdGenerable containerIdGenerator,
                 InodeDirectoryIdGenerator directoryIdGenerator,
                 MountTable mountTable)

Parameters:

containerIdGenerator - the container id generator to use to get new container ids

directoryIdGenerator - the directory id generator to use to get new directory ids

mountTable - the mount table to manage the file system mount points

Method Detail

initializeRoot

public void initializeRoot(String owner,
                           String group,
                           Mode mode,
                           JournalContext context)
                    throws UnavailableException

Initializes the root of the inode tree.

Parameters:

owner - the root owner

group - the root group

mode - the root mode

context - the journal context to journal the initialization to

Throws:

UnavailableException

getRootUserName

@Nullable
public String getRootUserName()

Returns:

username of root of inode tree, null if the inode tree is not initialized

getSize

public int getSize()

Returns:

the number of total inodes

getPinnedSize

public int getPinnedSize()

Returns:

the number of pinned inodes

inodeIdExists

public boolean inodeIdExists(long id)

Parameters:

id - the id to get the inode for

Returns:

whether the inode exists

inodePathExists

public boolean inodePathExists(AlluxioURI uri)

Parameters:

uri - the AlluxioURI to check for existence

Returns:

whether the inode exists

lockInodePath

public LockedInodePath lockInodePath(AlluxioURI path,
                                     InodeTree.LockMode lockMode)
                              throws InvalidPathException

Locks existing inodes on the specified path, in the specified InodeTree.LockMode. The target inode is not required to exist.

Parameters:

path - the path to lock

lockMode - the InodeTree.LockMode to lock the inodes with

Returns:

the LockedInodePath representing the locked path of inodes

Throws:

InvalidPathException - if the path is invalid

lockInodePathPair

public InodePathPair lockInodePathPair(AlluxioURI path1,
                                       InodeTree.LockMode lockMode1,
                                       AlluxioURI path2,
                                       InodeTree.LockMode lockMode2)
                                throws InvalidPathException

Locks existing inodes on the two specified paths. The two paths will be locked in the correct order. The target inodes are not required to exist.

Parameters:

path1 - the first path to lock

lockMode1 - the InodeTree.LockMode of the first path

path2 - the second path to lock

lockMode2 - the InodeTree.LockMode of the second path

Returns:

a InodePathPair representing the two locked paths

Throws:

InvalidPathException - if a path is invalid

lockFullInodePath

public LockedInodePath lockFullInodePath(AlluxioURI path,
                                         InodeTree.LockMode lockMode)
                                  throws InvalidPathException,
                                         FileDoesNotExistException

Locks existing inodes on the specified path, in the specified InodeTree.LockMode. The target inode must exist.

Parameters:

path - the AlluxioURI path to lock

lockMode - the InodeTree.LockMode to lock the inodes with

Returns:

the LockedInodePath representing the locked path of inodes

Throws:

InvalidPathException - if the path is invalid

FileDoesNotExistException - if the target inode does not exist

lockFullInodePath

public LockedInodePath lockFullInodePath(long id,
                                         InodeTree.LockMode lockMode)
                                  throws FileDoesNotExistException

Locks existing inodes on the path to the inode specified by an id, in the specified InodeTree.LockMode. The target inode must exist. This may require multiple traversals of the tree, so may be inefficient.

Parameters:

id - the inode id

lockMode - the InodeTree.LockMode to lock the inodes with

Returns:

the LockedInodePath representing the locked path of inodes

Throws:

FileDoesNotExistException - if the target inode does not exist

ensureFullInodePath

public void ensureFullInodePath(LockedInodePath inodePath,
                                InodeTree.LockMode lockMode)
                         throws InvalidPathException,
                                FileDoesNotExistException

Attempts to extend an existing LockedInodePath to reach the target inode (the last inode for the full path). If the target inode does not exist, an exception will be thrown.

Parameters:

inodePath - the LockedInodePath to extend to the target inode

lockMode - the InodeTree.LockMode to lock the inodes with

Throws:

InvalidPathException - if the path is invalid

FileDoesNotExistException - if the target inode does not exist

getPath

public AlluxioURI getPath(Inode<?> inode)
                   throws FileDoesNotExistException

Returns the path for a particular inode. The inode and the path to the inode must already be locked.

Parameters:

inode - the Inode to get the path for

Returns:

the AlluxioURI for the path of the inode

Throws:

FileDoesNotExistException - if the path does not exist

getRoot

public InodeDirectory getRoot()

Returns:

the root inode

createPath

public InodeTree.CreatePathResult createPath(RpcContext rpcContext,
                                             LockedInodePath inodePath,
                                             CreatePathOptions<?> options)
                                      throws FileAlreadyExistsException,
                                             BlockInfoException,
                                             InvalidPathException,
                                             IOException,
                                             FileDoesNotExistException

Creates a file or directory at path.

Parameters:

rpcContext - the rpc context

inodePath - the path

options - method options

Returns:

a InodeTree.CreatePathResult representing the modified inodes and created inodes during path creation

Throws:

FileAlreadyExistsException - when there is already a file at path if we want to create a directory there

BlockInfoException - when blockSizeBytes is invalid

InvalidPathException - when path is invalid, for example, (1) when there is nonexistent necessary parent directories and recursive is false, (2) when one of the necessary parent directories is actually a file

FileDoesNotExistException - if the parent of the path does not exist and the recursive option is false

IOException

reinitializeFile

public long reinitializeFile(LockedInodePath inodePath,
                             long blockSizeBytes,
                             long ttl,
                             TtlAction ttlAction)
                      throws InvalidPathException,
                             FileDoesNotExistException

Reinitializes the block size and TTL of an existing open file.

Parameters:

inodePath - the path to the file

blockSizeBytes - the new block size

ttl - the ttl

ttlAction - action to perform after TTL expiry

Returns:

the file id

Throws:

InvalidPathException - if the path is invalid

FileDoesNotExistException - if the path does not exist

lockDescendantPath

public LockedInodePath lockDescendantPath(LockedInodePath inodePath,
                                          InodeTree.LockMode lockMode,
                                          AlluxioURI descendantUri)
                                   throws InvalidPathException

Locks from a specific point in the tree to the descendant, and return a lockedInodePath.

Parameters:

inodePath - the root to start locking

lockMode - the lock type to use

descendantUri - the path to the descendant that we are locking

Returns:

an InodeLockList representing the list of descendants that got locked as a result of this call.

Throws:

FileDoesNotExistException - if inode does not exist

InvalidPathException

lockChildPath

public LockedInodePath lockChildPath(LockedInodePath inodePath,
                                     InodeTree.LockMode lockMode,
                                     Inode<?> childInode,
                                     String[] pathComponents)
                              throws FileDoesNotExistException,
                                     InvalidPathException

Lock from a specific poiint in the tree to the immediate child, and return a lockedInodePath.

Parameters:

inodePath - the root to start locking

lockMode - the lock type to use

childInode - the inode of the child that we are locking

pathComponents - the array of pre-parsed path components, or null to parse pathComponents from the uri

Returns:

an InodeLockList representing the list of descendants that got locked as a result of this call.

Throws:

FileDoesNotExistException - if the inode does not exist

InvalidPathException - if the path is invalid

lockDescendants

public LockedInodePathList lockDescendants(LockedInodePath inodePath,
                                           InodeTree.LockMode lockMode)

Locks all descendants of a particular LockedInodePath. Any directory inode precedes its descendants in the list.

Parameters:

inodePath - the root LockedInodePath to retrieve all descendants from

lockMode - the lock type to use

Returns:

an InodeLockList representing the list of all descendants

deleteInode

public void deleteInode(RpcContext rpcContext,
                        LockedInodePath inodePath,
                        long opTimeMs,
                        DeleteOptions deleteOptions)
                 throws FileDoesNotExistException

Deletes a single inode from the inode tree by removing it from the parent inode.

Parameters:

rpcContext - the rpc context

inodePath - the LockedInodePath to delete

opTimeMs - the operation time

deleteOptions - the delete options

Throws:

FileDoesNotExistException - if the Inode cannot be retrieved

setPinned

public void setPinned(LockedInodePath inodePath,
                      boolean pinned,
                      long opTimeMs)
               throws FileDoesNotExistException

Sets the pinned state of an inode. If the inode is a directory, the pinned state will be set recursively.

Parameters:

inodePath - the LockedInodePath to set the pinned state for

pinned - the pinned state to set for the inode (and possible descendants)

opTimeMs - the operation time

Throws:

FileDoesNotExistException - if inode does not exist

setPinned

public void setPinned(LockedInodePath inodePath,
                      boolean pinned)
               throws FileDoesNotExistException,
                      InvalidPathException

Sets the pinned state of an inode. If the inode is a directory, the pinned state will be set recursively.

Parameters:

inodePath - the LockedInodePath to set the pinned state for

pinned - the pinned state to set for the inode (and possible descendants)

Throws:

FileDoesNotExistException - if inode does not exist

InvalidPathException

getPinIdSet

public Set<Long> getPinIdSet()

Returns:

the set of file ids which are pinned

isRootId

public boolean isRootId(long fileId)

Parameters:

fileId - the file id to check

Returns:

true if the given file id is the root id

getJournalEntryIterator

public Iterator<Journal.JournalEntry> getJournalEntryIterator()

Specified by:

getJournalEntryIterator in interface JournalEntryIterable

Returns:

an Iterator that iterates all the journal entries

addInodeFileFromJournal

public void addInodeFileFromJournal(File.InodeFileEntry entry)

Adds the file represented by the entry parameter into the inode tree.

Parameters:

entry - the journal entry representing an inode

addInodeDirectoryFromJournal

public void addInodeDirectoryFromJournal(File.InodeDirectoryEntry entry)
                                  throws AccessControlException

Adds the directory represented by the entry parameter into the inode tree. If the inode entry represents the root inode, the tree is "reset", and all state is cleared.

Parameters:

entry - the journal entry representing an inode

Throws:

AccessControlException - when owner of mRoot is not the owner of root journal entry

reset

public void reset()

Resets the inode tree.

syncPersistDirectory

public void syncPersistDirectory(RpcContext rpcContext,
                                 InodeDirectory dir)
                          throws IOException,
                                 InvalidPathException,
                                 FileDoesNotExistException

Synchronously persists an InodeDirectory to the UFS. If concurrent calls are made, only one thread will persist to UFS, and the others will wait until it is persisted.

Parameters:

rpcContext - the rpc context

dir - the InodeDirectory to persist

Throws:

InvalidPathException - if the path for the inode is invalid

FileDoesNotExistException - if the path for the inode is invalid

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object