alluxio.master.file.meta

Class InodeLockList

java.lang.Object

alluxio.master.file.meta.InodeLockList

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

CompositeInodeLockList

@ThreadSafe
public class InodeLockList
extends Object
implements AutoCloseable

Manages the locks for a list of Inode.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Inode<?>>	mInodes
protected List<InodeTree.LockMode>	mLockModes

Constructor Summary

Constructors

Constructor and Description
InodeLockList() Creates a new instance of InodeLockList.

Method Summary

Modifier and Type	Method and Description
void	close()
void	downgradeLast() Downgrades the last inode that was locked, if the inode was previously WRITE locked.
List<Inode<?>>	getInodes()
boolean	isEmpty()
void	lockRead(Inode<?> inode) Locks the given inode in read mode, and adds it to this lock list.
void	lockReadAndCheckNameAndParent(Inode<?> inode, Inode parent, String name) Locks the given inode in read mode, and adds it to this lock list.
void	lockReadAndCheckParent(Inode<?> inode, Inode parent) Locks the given inode in read mode, and adds it to this lock list.
void	lockWrite(Inode<?> inode) Locks the given inode in write mode, and adds it to this lock list.
void	lockWriteAndCheckNameAndParent(Inode<?> inode, Inode parent, String name) Locks the given inode in write mode, and adds it to this lock list.
void	lockWriteAndCheckParent(Inode<?> inode, Inode parent) Locks the given inode in write mode, and adds it to this lock list.
void	unlockLast() Unlocks the last inode that was locked.

Methods inherited from class java.lang.Object

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

Field Detail

mInodes

protected List<Inode<?>> mInodes

mLockModes

protected List<InodeTree.LockMode> mLockModes

Constructor Detail

InodeLockList

public InodeLockList()

Creates a new instance of InodeLockList.

Method Detail

lockRead

public void lockRead(Inode<?> inode)

Locks the given inode in read mode, and adds it to this lock list. This call should only be used when locking the root or an inode by id and not path or parent.

Parameters:

inode - the inode to lock

lockReadAndCheckParent

public void lockReadAndCheckParent(Inode<?> inode,
                                   Inode parent)
                            throws InvalidPathException

Locks the given inode in read mode, and adds it to this lock list. This method ensures the parent is the expected parent inode. NOTE: This method assumes that the inode path to the parent has been read locked.

Parameters:

inode - the inode to lock

parent - the expected parent inode

Throws:

InvalidPathException - if the inode is no long consistent with the caller's expectations

lockReadAndCheckNameAndParent

public void lockReadAndCheckNameAndParent(Inode<?> inode,
                                          Inode parent,
                                          String name)
                                   throws InvalidPathException

Locks the given inode in read mode, and adds it to this lock list. This method ensures the parent is the expected parent inode, and the name of the inode is the expected name. NOTE: This method assumes that the inode path to the parent has been read locked.

Parameters:

inode - the inode to lock

parent - the expected parent inode

name - the expected name of the inode to be locked

Throws:

InvalidPathException - if the inode is not consistent with the caller's expectations

unlockLast

public void unlockLast()

Unlocks the last inode that was locked.

downgradeLast

public void downgradeLast()

Downgrades the last inode that was locked, if the inode was previously WRITE locked. If the inode was previously READ locked, no additional locking will occur.

lockWrite

public void lockWrite(Inode<?> inode)

Locks the given inode in write mode, and adds it to this lock list. This call should only be used when locking the root or an inode by id and not path or parent.

Parameters:

inode - the inode to lock

lockWriteAndCheckParent

public void lockWriteAndCheckParent(Inode<?> inode,
                                    Inode parent)
                             throws InvalidPathException

Locks the given inode in write mode, and adds it to this lock list. This method ensures the parent is the expected parent inode. NOTE: This method assumes that the inode path to the parent has been read locked.

Parameters:

inode - the inode to lock

parent - the expected parent inode

Throws:

InvalidPathException - if the inode is not consistent with the caller's expectations

lockWriteAndCheckNameAndParent

public void lockWriteAndCheckNameAndParent(Inode<?> inode,
                                           Inode parent,
                                           String name)
                                    throws InvalidPathException

Locks the given inode in write mode, and adds it to this lock list. This method ensures the parent is the expected parent inode, and the name of the inode is the expected name. NOTE: This method assumes that the inode path to the parent has been read locked.

Parameters:

inode - the inode to lock

parent - the expected parent inode

name - the expected name of the inode to be locked

Throws:

InvalidPathException - if the inode is not consistent with the caller's expectations

getInodes

public List<Inode<?>> getInodes()

Returns:

a copy of the the list of inodes locked in this lock list, in order of when the inodes were locked

isEmpty

public boolean isEmpty()

Returns:

true if the locklist is empty

close

public void close()

Specified by:

close in interface AutoCloseable