org.apache.hadoop.hdfs.server.namenode

Class INodeFile

java.lang.Object

org.apache.hadoop.hdfs.server.namenode.INode

org.apache.hadoop.hdfs.server.namenode.INodeWithAdditionalFields

org.apache.hadoop.hdfs.server.namenode.INodeFile

All Implemented Interfaces:

Comparable<byte[]>, BlockCollection, INodeAttributes, INodeFileAttributes, Diff.Element<byte[]>, LightWeightGSet.LinkedElement

Direct Known Subclasses:

INodeFileUnderConstruction, INodeFileWithSnapshot

@InterfaceAudience.Private
public class INodeFile
extends INodeWithAdditionalFields
implements INodeFileAttributes, BlockCollection

I-node for closed file.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hdfs.server.namenode.INode

INode.BlocksMapUpdateInfo

Nested classes/interfaces inherited from interface org.apache.hadoop.hdfs.server.namenode.INodeFileAttributes

INodeFileAttributes.SnapshotCopy

Field Summary

Fields inherited from class org.apache.hadoop.hdfs.server.namenode.INode

LOG

Constructor Summary

Constructors

Constructor and Description
INodeFile(INodeFile that)

Method Summary

Methods

Modifier and Type	Method and Description
INodeFile	asFile() Cast this inode to an INodeFile.
Quota.Counts	cleanSubtree(Snapshot snapshot, Snapshot prior, INode.BlocksMapUpdateInfo collectedBlocks, List<INode> removedINodes, boolean countDiffChange) Clean the subtree under this inode and collect the blocks from the descents for further block deletion/update.
Content.Counts	computeContentSummary(Content.Counts counts) Count subtree content summary with a Content.Counts.
long	computeFileSize() The same as computeFileSize(null).
long	computeFileSize(boolean includesLastUcBlock, boolean usePreferredBlockSize4LastUcBlock) Compute file size of the current file.
long	computeFileSize(Snapshot snapshot) Compute file size of the current file if the given snapshot is null; otherwise, get the file size from the given snapshot.
long	computeFileSizeNotIncludingLastUcBlock() Compute file size of the current file size but not including the last block if it is under construction.
Quota.Counts	computeQuotaUsage(Quota.Counts counts, boolean useCache, int lastSnapshotId) Count subtree Quota.NAMESPACE and Quota.DISKSPACE usages.
void	destroyAndCollectBlocks(INode.BlocksMapUpdateInfo collectedBlocks, List<INode> removedINodes) Destroy self and clear everything! If the INode is a file, this method collects its blocks for further block deletion.
long	diskspaceConsumed()
long	diskspaceConsumed(Snapshot lastSnapshot)
void	dumpTreeRecursively(PrintWriter out, StringBuilder prefix, Snapshot snapshot) Dump tree recursively.
short	getBlockReplication() Get block replication for the collection
BlockInfo[]	getBlocks() Get the blocks.
short	getFileReplication() The same as getFileReplication(null).
short	getFileReplication(Snapshot snapshot)
long	getHeaderLong()
BlockInfo	getLastBlock() Get the last block of the collection.
String	getName() Get the name of the collection.
long	getPreferredBlockSize() Get preferred block size for the collection
INodeFileAttributes	getSnapshotINode(Snapshot snapshot)
boolean	isFile() Check whether it's a file.
boolean	isUnderConstruction() Is this file under construction?
int	numBlocks()
INodeFile	recordModification(Snapshot latest, INodeMap inodeMap) This inode is being modified.
void	setBlock(int idx, BlockInfo blk) Set the block of the file at the given index.
void	setBlocks(BlockInfo[] blocks) Set the blocks.
void	setFileReplication(short replication) Set the replication factor of this file.
INodeFile	setFileReplication(short replication, Snapshot latest, INodeMap inodeMap) Set the replication factor of this file.
INodeFileUnderConstruction	toUnderConstruction(String clientName, String clientMachine, DatanodeDescriptor clientNode) Convert this file to an INodeFileUnderConstruction.
static INodeFile	valueOf(INode inode, String path) The same as valueOf(inode, path, false).
static INodeFile	valueOf(INode inode, String path, boolean acceptNull) Cast INode to INodeFile.

Methods inherited from class org.apache.hadoop.hdfs.server.namenode.INodeWithAdditionalFields

getFsPermissionShort, getId, getLocalNameBytes, getNext, getPermissionLong, setAccessTime, setLocalName, setModificationTime, setNext, updateModificationTime

Methods inherited from class org.apache.hadoop.hdfs.server.namenode.INode

addSpaceConsumed, asDirectory, asReference, asSymlink, clear, compareTo, computeContentSummary, computeQuotaUsage, computeQuotaUsage, dumpTreeRecursively, dumpTreeRecursively, equals, getAccessTime, getDsQuota, getFsPermission, getFullPathName, getGroupName, getKey, getLocalName, getModificationTime, getNsQuota, getObjectString, getParent, getParentReference, getParentString, getUserName, hashCode, isAncestorDirectory, isDirectory, isInLatestSnapshot, isQuotaSet, isReference, isSymlink, setAccessTime, setModificationTime, setParent, setParentReference, shouldRecordInSrcSnapshot, toDetailString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.hdfs.server.namenode.INodeAttributes

getAccessTime, getFsPermission, getFsPermissionShort, getGroupName, getLocalNameBytes, getModificationTime, getPermissionLong, getUserName

Methods inherited from interface org.apache.hadoop.hdfs.server.blockmanagement.BlockCollection

computeContentSummary

Constructor Detail

INodeFile

public INodeFile(INodeFile that)

Method Detail

valueOf

public static INodeFile valueOf(INode inode,
                String path)
                         throws FileNotFoundException

The same as valueOf(inode, path, false).

Throws:

FileNotFoundException

valueOf

public static INodeFile valueOf(INode inode,
                String path,
                boolean acceptNull)
                         throws FileNotFoundException

Cast INode to INodeFile.

Throws:

FileNotFoundException

isFile

public final boolean isFile()

Description copied from class: INode

Check whether it's a file.

Overrides:

isFile in class INode

Returns:

true unconditionally.

asFile

public final INodeFile asFile()

Description copied from class: INode

Cast this inode to an INodeFile.

Overrides:

asFile in class INode

Returns:

this object.

isUnderConstruction

public boolean isUnderConstruction()

Is this file under construction?

toUnderConstruction

public INodeFileUnderConstruction toUnderConstruction(String clientName,
                                             String clientMachine,
                                             DatanodeDescriptor clientNode)

Convert this file to an INodeFileUnderConstruction.

getSnapshotINode

public INodeFileAttributes getSnapshotINode(Snapshot snapshot)

Overrides:

getSnapshotINode in class INode

Returns:

if the given snapshot is null, return this; otherwise return the corresponding snapshot inode.

recordModification

public INodeFile recordModification(Snapshot latest,
                           INodeMap inodeMap)
                             throws QuotaExceededException

Description copied from class: INode

This inode is being modified. The previous version of the inode needs to be recorded in the latest snapshot.

Parameters:

latest - the latest snapshot that has been taken. Note that it is null if no snapshots have been taken.

inodeMap - while recording modification, the inode or its parent may get replaced, and the inodeMap needs to be updated.

Returns:

The current inode, which usually is the same object of this inode. However, in some cases, this inode may be replaced with a new inode for maintaining snapshots. The current inode is then the new inode.

Throws:

QuotaExceededException

getFileReplication

public final short getFileReplication(Snapshot snapshot)

Returns:

the replication factor of the file.

getFileReplication

public final short getFileReplication()

The same as getFileReplication(null).

Specified by:

getFileReplication in interface INodeFileAttributes

Returns:

the file replication.

getBlockReplication

public final short getBlockReplication()

Description copied from interface: BlockCollection

Get block replication for the collection

Specified by:

getBlockReplication in interface BlockCollection

Returns:

block replication value

setFileReplication

public final void setFileReplication(short replication)

Set the replication factor of this file.

setFileReplication

public final INodeFile setFileReplication(short replication,
                           Snapshot latest,
                           INodeMap inodeMap)
                                   throws QuotaExceededException

Set the replication factor of this file.

Throws:

QuotaExceededException

getPreferredBlockSize

public long getPreferredBlockSize()

Description copied from interface: BlockCollection

Get preferred block size for the collection

Specified by:

getPreferredBlockSize in interface BlockCollection

Specified by:

getPreferredBlockSize in interface INodeFileAttributes

Returns:

preferred block size (in bytes) of the file.

getHeaderLong

public long getHeaderLong()

Specified by:

getHeaderLong in interface INodeFileAttributes

Returns:

the header as a long.

getBlocks

public BlockInfo[] getBlocks()

Description copied from interface: BlockCollection

Get the blocks.

Specified by:

getBlocks in interface BlockCollection

Returns:

the blocks of the file.

setBlock

public void setBlock(int idx,
            BlockInfo blk)

Set the block of the file at the given index.

setBlocks

public void setBlocks(BlockInfo[] blocks)

Set the blocks.

cleanSubtree

public Quota.Counts cleanSubtree(Snapshot snapshot,
                        Snapshot prior,
                        INode.BlocksMapUpdateInfo collectedBlocks,
                        List<INode> removedINodes,
                        boolean countDiffChange)
                          throws QuotaExceededException

Description copied from class: INode

Clean the subtree under this inode and collect the blocks from the descents for further block deletion/update. The current inode can either resides in the current tree or be stored as a snapshot copy.

 In general, we have the following rules. 
 1. When deleting a file/directory in the current tree, we have different 
 actions according to the type of the node to delete. 
 
 1.1 The current inode (this) is an INodeFile. 
 1.1.1 If prior is null, there is no snapshot taken on ancestors 
 before. Thus we simply destroy (i.e., to delete completely, no need to save 
 snapshot copy) the current INode and collect its blocks for further 
 cleansing.
 1.1.2 Else do nothing since the current INode will be stored as a snapshot
 copy.
 
 1.2 The current inode is an INodeDirectory.
 1.2.1 If prior is null, there is no snapshot taken on ancestors 
 before. Similarly, we destroy the whole subtree and collect blocks.
 1.2.2 Else do nothing with the current INode. Recursively clean its 
 children.
 
 1.3 The current inode is a FileWithSnapshot.
 Call recordModification(..) to capture the current states.
 Mark the INode as deleted.
 
 1.4 The current inode is a INodeDirectoryWithSnapshot.
 Call recordModification(..) to capture the current states. 
 Destroy files/directories created after the latest snapshot 
 (i.e., the inodes stored in the created list of the latest snapshot).
 Recursively clean remaining children. 

 2. When deleting a snapshot.
 2.1 To clean INodeFile: do nothing.
 2.2 To clean INodeDirectory: recursively clean its children.
 2.3 To clean FileWithSnapshot: delete the corresponding snapshot in
 its diff list.
 2.4 To clean INodeDirectoryWithSnapshot: delete the corresponding 
 snapshot in its diff list. Recursively clean its children.
 

Specified by:

cleanSubtree in class INode

Parameters:

snapshot - The snapshot to delete. Null means to delete the current file/directory.

prior - The latest snapshot before the to-be-deleted snapshot. When deleting a current inode, this parameter captures the latest snapshot.

collectedBlocks - blocks collected from the descents for further block deletion/update will be added to the given map.

removedINodes - INodes collected from the descents for further cleaning up of inodeMap

Returns:

quota usage delta when deleting a snapshot

Throws:

QuotaExceededException

destroyAndCollectBlocks

public void destroyAndCollectBlocks(INode.BlocksMapUpdateInfo collectedBlocks,
                           List<INode> removedINodes)

Description copied from class: INode

Destroy self and clear everything! If the INode is a file, this method collects its blocks for further block deletion. If the INode is a directory, the method goes down the subtree and collects blocks from the descents, and clears its parent/children references as well. The method also clears the diff list if the INode contains snapshot diff list.

Specified by:

destroyAndCollectBlocks in class INode

Parameters:

collectedBlocks - blocks collected from the descents for further block deletion/update will be added to this map.

removedINodes - INodes collected from the descents for further cleaning up of inodeMap

getName

public String getName()

Description copied from interface: BlockCollection

Get the name of the collection.

Specified by:

getName in interface BlockCollection

computeQuotaUsage

public final Quota.Counts computeQuotaUsage(Quota.Counts counts,
                             boolean useCache,
                             int lastSnapshotId)

Description copied from class: INode

Count subtree Quota.NAMESPACE and Quota.DISKSPACE usages. With the existence of INodeReference, the same inode and its subtree may be referred by multiple INodeReference.WithName nodes and a INodeReference.DstReference node. To avoid circles while quota usage computation, we have the following rules:

 1. For a INodeReference.DstReference node, since the node must be in the current
 tree (or has been deleted as the end point of a series of rename 
 operations), we compute the quota usage of the referred node (and its 
 subtree) in the regular manner, i.e., including every inode in the current
 tree and in snapshot copies, as well as the size of diff list.
 
 2. For a INodeReference.WithName node, since the node must be in a snapshot, we 
 only count the quota usage for those nodes that still existed at the 
 creation time of the snapshot associated with the INodeReference.WithName node.
 We do not count in the size of the diff list.  
 

Specified by:

computeQuotaUsage in class INode

Parameters:

counts - The subtree counts for returning.

useCache - Whether to use cached quota usage. Note that INodeReference.WithName node never uses cache for its subtree.

lastSnapshotId - Snapshot.INVALID_ID indicates the computation is in the current tree. Otherwise the id indicates the computation range for a INodeReference.WithName node.

Returns:

The same objects as the counts parameter.

computeContentSummary

public final Content.Counts computeContentSummary(Content.Counts counts)

Description copied from class: INode

Count subtree content summary with a Content.Counts.

Specified by:

computeContentSummary in class INode

Parameters:

counts - The subtree counts for returning.

Returns:

The same objects as the counts parameter.

computeFileSize

public final long computeFileSize()

The same as computeFileSize(null).

computeFileSize

public final long computeFileSize(Snapshot snapshot)

Compute file size of the current file if the given snapshot is null; otherwise, get the file size from the given snapshot.

computeFileSizeNotIncludingLastUcBlock

public final long computeFileSizeNotIncludingLastUcBlock()

Compute file size of the current file size but not including the last block if it is under construction.

computeFileSize

public final long computeFileSize(boolean includesLastUcBlock,
                   boolean usePreferredBlockSize4LastUcBlock)

Compute file size of the current file.

Parameters:

includesLastUcBlock - If the last block is under construction, should it be included?

usePreferredBlockSize4LastUcBlock - If the last block is under construction, should we use actual block size or preferred block size? Note that usePreferredBlockSize4LastUcBlock is ignored if includesLastUcBlock == false.

Returns:

file size

diskspaceConsumed

public final long diskspaceConsumed()

diskspaceConsumed

public final long diskspaceConsumed(Snapshot lastSnapshot)

getLastBlock

public BlockInfo getLastBlock()
                       throws IOException

Description copied from interface: BlockCollection

Get the last block of the collection.

Specified by:

getLastBlock in interface BlockCollection

Throws:

IOException

numBlocks

public int numBlocks()

Specified by:

numBlocks in interface BlockCollection

Returns:

the number of blocks

dumpTreeRecursively

public void dumpTreeRecursively(PrintWriter out,
                       StringBuilder prefix,
                       Snapshot snapshot)

Description copied from class: INode

Dump tree recursively.

Overrides:

dumpTreeRecursively in class INode

prefix - The prefix string that each line should print.