org.apache.hadoop.hdfs.server.namenode.snapshot

Class INodeFileWithSnapshot

java.lang.Object

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

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

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

org.apache.hadoop.hdfs.server.namenode.snapshot.INodeFileWithSnapshot

All Implemented Interfaces:

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

@InterfaceAudience.Private
public class INodeFileWithSnapshot
extends INodeFile
implements FileWithSnapshot

Represent an INodeFile that is snapshotted.

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.snapshot.FileWithSnapshot

FileWithSnapshot.FileDiff, FileWithSnapshot.FileDiffList, FileWithSnapshot.Util

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
INodeFileWithSnapshot(INodeFile f)
INodeFileWithSnapshot(INodeFile f, FileWithSnapshot.FileDiffList diffs)

Method Summary

Methods

Modifier and Type	Method and Description
INodeFile	asINodeFile()
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.
void	deleteCurrentFile() Delete the file from the current tree
FileWithSnapshot.FileDiffList	getDiffs()
INodeFileAttributes	getSnapshotINode(Snapshot snapshot)
boolean	isCurrentFileDeleted() Is the current file deleted?
INodeFileWithSnapshot	recordModification(Snapshot latest, INodeMap inodeMap) This inode is being modified.
String	toDetailString()
INodeFileUnderConstructionWithSnapshot	toUnderConstruction(String clientName, String clientMachine, DatanodeDescriptor clientNode) Convert this file to an INodeFileUnderConstruction.

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

asFile, computeContentSummary, computeFileSize, computeFileSize, computeFileSize, computeFileSizeNotIncludingLastUcBlock, computeQuotaUsage, destroyAndCollectBlocks, diskspaceConsumed, diskspaceConsumed, dumpTreeRecursively, getBlockReplication, getBlocks, getFileReplication, getFileReplication, getHeaderLong, getLastBlock, getName, getPreferredBlockSize, isFile, isUnderConstruction, numBlocks, setBlock, setBlocks, setFileReplication, setFileReplication, valueOf, valueOf

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, 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

INodeFileWithSnapshot

public INodeFileWithSnapshot(INodeFile f)

INodeFileWithSnapshot

public INodeFileWithSnapshot(INodeFile f,
                     FileWithSnapshot.FileDiffList diffs)

Method Detail

toUnderConstruction

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

Description copied from class: INodeFile

Convert this file to an INodeFileUnderConstruction.

Overrides:

toUnderConstruction in class INodeFile

isCurrentFileDeleted

public boolean isCurrentFileDeleted()

Description copied from interface: FileWithSnapshot

Is the current file deleted?

Specified by:

isCurrentFileDeleted in interface FileWithSnapshot

deleteCurrentFile

public void deleteCurrentFile()

Description copied from interface: FileWithSnapshot

Delete the file from the current tree

Specified by:

deleteCurrentFile in interface FileWithSnapshot

getSnapshotINode

public INodeFileAttributes getSnapshotINode(Snapshot snapshot)

Overrides:

getSnapshotINode in class INodeFile

Returns:

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

recordModification

public INodeFileWithSnapshot 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.

Overrides:

recordModification in class INodeFile

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

asINodeFile

public INodeFile asINodeFile()

Specified by:

asINodeFile in interface FileWithSnapshot

Returns:

the INodeFile view of this object.

getDiffs

public FileWithSnapshot.FileDiffList getDiffs()

Specified by:

getDiffs in interface FileWithSnapshot

Returns:

the file diff list.

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.
 

Overrides:

cleanSubtree in class INodeFile

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

toDetailString

public String toDetailString()

Overrides:

toDetailString in class INode