From ceed0f6c46736323bd1b077125ff4e217c649208 Mon Sep 17 00:00:00 2001 From: Andrew Wang Date: Tue, 8 Jul 2014 04:34:04 +0000 Subject: [PATCH] HDFS-6635. Refactor encryption zone functionality into new EncryptionZoneManager class. (wang) git-svn-id: https://svn.apache.org/repos/asf/hadoop/common/branches/fs-encryption@1608657 13f79535-47bb-0310-9956-ffa450edef68 --- .../hadoop-hdfs/CHANGES-fs-encryption.txt | 3 + .../namenode/EncryptionZoneManager.java | 180 ++++++++++++++++++ .../hdfs/server/namenode/FSDirectory.java | 132 ++----------- 3 files changed, 197 insertions(+), 118 deletions(-) create mode 100644 hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/hdfs/server/namenode/EncryptionZoneManager.java diff --git a/hadoop-hdfs-project/hadoop-hdfs/CHANGES-fs-encryption.txt b/hadoop-hdfs-project/hadoop-hdfs/CHANGES-fs-encryption.txt index 75eace4d86..e6db71fde4 100644 --- a/hadoop-hdfs-project/hadoop-hdfs/CHANGES-fs-encryption.txt +++ b/hadoop-hdfs-project/hadoop-hdfs/CHANGES-fs-encryption.txt @@ -39,6 +39,9 @@ fs-encryption (Unreleased) HDFS-6629. Not able to create symlinks after HDFS-6516 (umamaheswararao) + HDFS-6635. Refactor encryption zone functionality into new + EncryptionZoneManager class. (wang) + OPTIMIZATIONS BUG FIXES diff --git a/hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/hdfs/server/namenode/EncryptionZoneManager.java b/hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/hdfs/server/namenode/EncryptionZoneManager.java new file mode 100644 index 0000000000..a43273dfe3 --- /dev/null +++ b/hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/hdfs/server/namenode/EncryptionZoneManager.java @@ -0,0 +1,180 @@ +package org.apache.hadoop.hdfs.server.namenode; + +import java.io.IOException; +import java.util.EnumSet; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import com.google.common.base.Preconditions; +import com.google.common.collect.Lists; +import org.apache.hadoop.fs.UnresolvedLinkException; +import org.apache.hadoop.fs.XAttr; +import org.apache.hadoop.fs.XAttrSetFlag; +import org.apache.hadoop.hdfs.XAttrHelper; +import org.apache.hadoop.hdfs.protocol.EncryptionZone; +import org.apache.hadoop.hdfs.protocol.SnapshotAccessControlException; + + +import static org.apache.hadoop.hdfs.server.common.HdfsServerConstants + .CRYPTO_XATTR_ENCRYPTION_ZONE; + +/** + * Manages the list of encryption zones in the filesystem. Relies on the + * FSDirectory lock for synchronization. + */ +public class EncryptionZoneManager { + + /** + * EncryptionZoneInt is the internal representation of an encryption zone. The + * external representation of an EZ is embodied in an EncryptionZone and + * contains the EZ's pathname. + */ + private class EncryptionZoneInt { + private final String keyId; + private final long inodeId; + + EncryptionZoneInt(long inodeId, String keyId) { + this.keyId = keyId; + this.inodeId = inodeId; + } + + String getKeyId() { + return keyId; + } + + long getINodeId() { + return inodeId; + } + + String getFullPathName() { + return dir.getInode(inodeId).getFullPathName(); + } + } + + private final Map encryptionZones; + + private final FSDirectory dir; + + /** + * Construct a new EncryptionZoneManager. + * + * @param dir Enclosing FSDirectory + */ + public EncryptionZoneManager(FSDirectory dir) { + this.dir = dir; + encryptionZones = new HashMap(); + } + + /** + * Add a new encryption zone. + * + * @param inodeId of the encryption zone + * @param keyId encryption zone key id + */ + void addEncryptionZone(Long inodeId, String keyId) { + final EncryptionZoneInt ez = new EncryptionZoneInt(inodeId, keyId); + encryptionZones.put(inodeId, ez); + } + + void removeEncryptionZone(Long inodeId) { + encryptionZones.remove(inodeId); + } + + /** + * Returns true if an IIP is within an encryption zone. + */ + boolean isInAnEZ(INodesInPath iip) + throws UnresolvedLinkException, SnapshotAccessControlException { + return (getEncryptionZoneForPath(iip) != null); + } + + private EncryptionZoneInt getEncryptionZoneForPath(INodesInPath iip) { + Preconditions.checkNotNull(iip); + final INode[] inodes = iip.getINodes(); + for (int i = inodes.length - 1; i >= 0; i--) { + final INode inode = inodes[i]; + if (inode != null) { + final EncryptionZoneInt ezi = encryptionZones.get(inode.getId()); + if (ezi != null) { + return ezi; + } + } + } + return null; + } + + /** + * Throws an exception if the provided inode cannot be renamed into the + * destination because of differing encryption zones. + * + * @param srcIIP source IIP + * @param dstIIP destination IIP + * @param src source path, used for debugging + * @throws IOException if the src cannot be renamed to the dst + */ + void checkMoveValidity(INodesInPath srcIIP, INodesInPath dstIIP, String src) + throws IOException { + final boolean srcInEZ = (getEncryptionZoneForPath(srcIIP) != null); + final boolean dstInEZ = (getEncryptionZoneForPath(dstIIP) != null); + if (srcInEZ) { + if (!dstInEZ) { + throw new IOException(src + " can't be moved from an encryption zone."); + } + } else { + if (dstInEZ) { + throw new IOException(src + " can't be moved into an encryption zone."); + } + } + + if (srcInEZ || dstInEZ) { + final EncryptionZoneInt srcEZI = getEncryptionZoneForPath(srcIIP); + final EncryptionZoneInt dstEZI = getEncryptionZoneForPath(dstIIP); + Preconditions.checkArgument(srcEZI != null, "couldn't find src EZ?"); + Preconditions.checkArgument(dstEZI != null, "couldn't find dst EZ?"); + if (srcEZI != dstEZI) { + final String srcEZPath = srcEZI.getFullPathName(); + final String dstEZPath = dstEZI.getFullPathName(); + final StringBuilder sb = new StringBuilder(src); + sb.append(" can't be moved from encryption zone "); + sb.append(srcEZPath); + sb.append(" to encryption zone "); + sb.append(dstEZPath); + sb.append("."); + throw new IOException(sb.toString()); + } + } + } + + XAttr createEncryptionZone(String src, String keyId) throws IOException { + if (dir.isNonEmptyDirectory(src)) { + throw new IOException( + "Attempt to create an encryption zone for a non-empty directory."); + } + + final INodesInPath srcIIP = dir.getINodesInPath4Write(src, false); + final EncryptionZoneInt ezi = getEncryptionZoneForPath(srcIIP); + if (ezi != null) { + throw new IOException("Directory " + src + + " is already in an encryption zone. (" + ezi.getFullPathName() + ")"); + } + + final XAttr keyIdXAttr = + XAttrHelper.buildXAttr(CRYPTO_XATTR_ENCRYPTION_ZONE, keyId.getBytes()); + final List xattrs = Lists.newArrayListWithCapacity(1); + xattrs.add(keyIdXAttr); + final INode inode = + dir.unprotectedSetXAttrs(src, xattrs, EnumSet.of(XAttrSetFlag.CREATE)); + addEncryptionZone(inode.getId(), keyId); + return keyIdXAttr; + } + + List listEncryptionZones() throws IOException { + final List ret = + Lists.newArrayListWithExpectedSize(encryptionZones.size()); + for (EncryptionZoneInt ezi : encryptionZones.values()) { + ret.add(new EncryptionZone(ezi.getFullPathName(), ezi.getKeyId())); + } + return ret; + } +} diff --git a/hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/hdfs/server/namenode/FSDirectory.java b/hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/hdfs/server/namenode/FSDirectory.java index ec015d94f1..81dcf9ef95 100644 --- a/hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/hdfs/server/namenode/FSDirectory.java +++ b/hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/hdfs/server/namenode/FSDirectory.java @@ -27,10 +27,8 @@ import java.util.ArrayList; import java.util.Arrays; import java.util.EnumSet; -import java.util.HashMap; import java.util.List; import java.util.ListIterator; -import java.util.Map; import java.util.concurrent.locks.ReentrantReadWriteLock; import com.google.protobuf.InvalidProtocolBufferException; @@ -139,35 +137,6 @@ private static INodeDirectorySnapshottable createRoot(FSNamesystem namesystem) { private long yieldCount = 0; // keep track of lock yield count. private final int inodeXAttrsLimit; //inode xattrs max limit - /* - * EncryptionZoneInt is the internal representation of an encryption - * zone. The external representation of an EZ is embodied in an - * EncryptionZone and contains the EZ's pathname. - */ - private class EncryptionZoneInt { - private final String keyId; - private final long inodeId; - - EncryptionZoneInt(String keyId, long inodeId) { - this.keyId = keyId; - this.inodeId = inodeId; - } - - String getKeyId() { - return keyId; - } - - long getINodeId() { - return inodeId; - } - - String getFullPathName() { - return getInode(inodeId).getFullPathName(); - } - } - - private final Map encryptionZones; - // lock to protect the directory and BlockMap private final ReentrantReadWriteLock dirLock; @@ -204,6 +173,8 @@ public int getWriteHoldCount() { return this.dirLock.getWriteHoldCount(); } + final EncryptionZoneManager ezManager; + /** * Caches frequently used file names used in {@link INode} to reuse * byte[] objects and reduce heap usage. @@ -252,7 +223,8 @@ public int getWriteHoldCount() { + " times"); nameCache = new NameCache(threshold); namesystem = ns; - encryptionZones = new HashMap(); + + ezManager = new EncryptionZoneManager(this); } private FSNamesystem getFSNamesystem() { @@ -550,7 +522,7 @@ boolean unprotectedRenameTo(String src, String dst, long timestamp) return false; } - checkEncryptionZoneMoveValidity(srcIIP, dstIIP, src); + ezManager.checkMoveValidity(srcIIP, dstIIP, src); // Ensure dst has quota to accommodate rename verifyFsLimitsForRename(srcIIP, dstIIP); verifyQuotaForRename(srcIIP.getINodes(), dstIIP.getINodes()); @@ -629,7 +601,7 @@ boolean unprotectedRenameTo(String src, String dst, long timestamp, throw new IOException(error); } - checkEncryptionZoneMoveValidity(srcIIP, dstIIP, src); + ezManager.checkMoveValidity(srcIIP, dstIIP, src); final INode dstInode = dstIIP.getLastINode(); List snapshottableDirs = new ArrayList(); @@ -937,61 +909,12 @@ boolean isInAnEZ(INodesInPath iip) throws UnresolvedLinkException, SnapshotAccessControlException { readLock(); try { - return (getEncryptionZoneForPath(iip) != null); + return ezManager.isInAnEZ(iip); } finally { readUnlock(); } } - private EncryptionZoneInt getEncryptionZoneForPath(INodesInPath iip) { - Preconditions.checkNotNull(iip); - final INode[] inodes = iip.getINodes(); - for (int i = inodes.length -1; i >= 0; i--) { - final INode inode = inodes[i]; - if (inode != null) { - final EncryptionZoneInt ezi = encryptionZones.get(inode.getId()); - if (ezi != null) { - return ezi; - } - } - } - return null; - } - - private void checkEncryptionZoneMoveValidity(INodesInPath srcIIP, - INodesInPath dstIIP, String src) - throws IOException { - final boolean srcInEZ = (getEncryptionZoneForPath(srcIIP) != null); - final boolean dstInEZ = (getEncryptionZoneForPath(dstIIP) != null); - if (srcInEZ) { - if (!dstInEZ) { - throw new IOException(src + " can't be moved from an encryption zone."); - } - } else { - if (dstInEZ) { - throw new IOException(src + " can't be moved into an encryption zone."); - } - } - - if (srcInEZ || dstInEZ) { - final EncryptionZoneInt srcEZI = getEncryptionZoneForPath(srcIIP); - final EncryptionZoneInt dstEZI = getEncryptionZoneForPath(dstIIP); - Preconditions.checkArgument(srcEZI != null, "couldn't find src EZ?"); - Preconditions.checkArgument(dstEZI != null, "couldn't find dst EZ?"); - if (srcEZI != dstEZI) { - final String srcEZPath = srcEZI.getFullPathName(); - final String dstEZPath = dstEZI.getFullPathName(); - final StringBuilder sb = new StringBuilder(src); - sb.append(" can't be moved from encryption zone "); - sb.append(srcEZPath); - sb.append(" to encryption zone "); - sb.append(dstEZPath); - sb.append("."); - throw new IOException(sb.toString()); - } - } - } - /** * Set file replication * @@ -2157,8 +2080,8 @@ public final void addToInodeMap(INode inode) { for (XAttr xattr : xattrs) { final String xaName = XAttrHelper.getPrefixName(xattr); if (CRYPTO_XATTR_ENCRYPTION_ZONE.equals(xaName)) { - encryptionZones.put(inode.getId(), new EncryptionZoneInt( - new String(xattr.getValue()), inode.getId())); + ezManager.addEncryptionZone(inode.getId(), + new String(xattr.getValue())); } } } @@ -2174,7 +2097,7 @@ public final void removeFromInodeMap(List inodes) { for (INode inode : inodes) { if (inode != null && inode instanceof INodeWithAdditionalFields) { inodeMap.remove(inode); - encryptionZones.remove(inode.getId()); + ezManager.removeEncryptionZone(inode.getId()); } } } @@ -2700,27 +2623,7 @@ XAttr createEncryptionZone(String src, String keyId) throws IOException { writeLock(); try { - if (isNonEmptyDirectory(src)) { - throw new IOException( - "Attempt to create an encryption zone for a non-empty directory."); - } - - final INodesInPath srcIIP = getINodesInPath4Write(src, false); - final EncryptionZoneInt ezi = getEncryptionZoneForPath(srcIIP); - if (ezi != null) { - throw new IOException("Directory " + src + - " is already in an encryption zone. (" + ezi.getFullPathName() + ")"); - } - - final XAttr keyIdXAttr = - XAttrHelper.buildXAttr(CRYPTO_XATTR_ENCRYPTION_ZONE, keyId.getBytes()); - final List xattrs = Lists.newArrayListWithCapacity(1); - xattrs.add(keyIdXAttr); - final INode inode = unprotectedSetXAttrs(src, xattrs, - EnumSet.of(XAttrSetFlag.CREATE)); - encryptionZones.put(inode.getId(), - new EncryptionZoneInt(keyId, inode.getId())); - return keyIdXAttr; + return ezManager.createEncryptionZone(src, keyId); } finally { writeUnlock(); } @@ -2729,12 +2632,7 @@ XAttr createEncryptionZone(String src, String keyId) List listEncryptionZones() throws IOException { readLock(); try { - final List ret = - Lists.newArrayListWithExpectedSize(encryptionZones.size()); - for (EncryptionZoneInt ezi : encryptionZones.values()) { - ret.add(new EncryptionZone(ezi.getFullPathName(), ezi.getKeyId())); - } - return ret; + return ezManager.listEncryptionZones(); } finally { readUnlock(); } @@ -2823,9 +2721,7 @@ INode unprotectedSetXAttrs(final String src, final List xAttrs, for (XAttr xattr : newXAttrs) { final String xaName = XAttrHelper.getPrefixName(xattr); if (CRYPTO_XATTR_ENCRYPTION_ZONE.equals(xaName)) { - final EncryptionZoneInt ez = - new EncryptionZoneInt(new String(xattr.getValue()), inode.getId()); - encryptionZones.put(inode.getId(), ez); + ezManager.addEncryptionZone(inode.getId(), new String(xattr.getValue())); } } @@ -3084,7 +2980,7 @@ private INode getINode4Write(String src, boolean resolveLink) * @throws UnresolvedLinkException if symlink can't be resolved * @throws SnapshotAccessControlException if path is in RO snapshot */ - private INodesInPath getINodesInPath4Write(String src, boolean resolveLink) + INodesInPath getINodesInPath4Write(String src, boolean resolveLink) throws UnresolvedLinkException, SnapshotAccessControlException { final byte[][] components = INode.getPathComponents(src); INodesInPath inodesInPath = INodesInPath.resolve(rootDir, components,