Package org.apache.hadoop.hdfs.server.namenode

Class FSImageSerialization

java.lang.Object

org.apache.hadoop.hdfs.server.namenode.FSImageSerialization

@Private
@Evolving
public class FSImageSerialization
extends java.lang.Object

Static utility functions for serializing various pieces of data in the correct format for the FSImage file. Some members are currently public for the benefit of the Offline Image Viewer which is located outside of this package. These members should be made package-protected when the OIV is refactored.

Method Summary

Modifier and Type	Method	Description
static byte	readByte(java.io.DataInput in)
static byte[]	readBytes(java.io.DataInput in)
static org.apache.hadoop.hdfs.protocol.CacheDirectiveInfo	readCacheDirectiveInfo(java.io.DataInput in)
static org.apache.hadoop.hdfs.protocol.CacheDirectiveInfo	readCacheDirectiveInfo(XMLUtils.Stanza st)
static org.apache.hadoop.hdfs.protocol.CachePoolInfo	readCachePoolInfo(java.io.DataInput in)
static org.apache.hadoop.hdfs.protocol.CachePoolInfo	readCachePoolInfo(XMLUtils.Stanza st)
static org.apache.hadoop.hdfs.protocol.Block[]	readCompactBlockArray(java.io.DataInput in, int logVersion)
static org.apache.hadoop.hdfs.protocol.ErasureCodingPolicy	readErasureCodingPolicy(java.io.DataInput in)
static byte[]	readLocalName(java.io.DataInput in)
static byte[][]	readPathComponents(java.io.DataInput in)	Reading the path from the image and converting it to byte[][] directly this saves us an array copy and conversions to and from String
static java.lang.String	readString(java.io.DataInput in)
static void	saveINode2Image(INode node, java.io.DataOutput out, boolean writeUnderConstruction, SnapshotFSImageFormat.ReferenceMap referenceMap)	Save one inode's attributes to the image.
static void	writeBytes(byte[] data, java.io.DataOutput out)
static void	writeCacheDirectiveInfo(java.io.DataOutputStream out, org.apache.hadoop.hdfs.protocol.CacheDirectiveInfo directive)
static void	writeCacheDirectiveInfo(org.xml.sax.ContentHandler contentHandler, org.apache.hadoop.hdfs.protocol.CacheDirectiveInfo directive)
static void	writeCachePoolInfo(java.io.DataOutputStream out, org.apache.hadoop.hdfs.protocol.CachePoolInfo info)
static void	writeCachePoolInfo(org.xml.sax.ContentHandler contentHandler, org.apache.hadoop.hdfs.protocol.CachePoolInfo info)
static void	writeCompactBlockArray(org.apache.hadoop.hdfs.protocol.Block[] blocks, java.io.DataOutputStream out)	Write an array of blocks as compactly as possible.
static void	writeErasureCodingPolicy(java.io.DataOutputStream out, org.apache.hadoop.hdfs.protocol.ErasureCodingPolicy ecPolicy)
static void	writeINodeDirectory(INodeDirectory node, java.io.DataOutput out)	Serialize a INodeDirectory
static void	writeINodeDirectoryAttributes(INodeDirectoryAttributes a, java.io.DataOutput out)	Serialize a INodeDirectory
static void	writeINodeFile(INodeFile file, java.io.DataOutput out, boolean writeUnderConstruction)	Serialize a INodeFile node
static void	writeINodeFileAttributes(INodeFileAttributes file, java.io.DataOutput out)	Serialize an INodeFileAttributes.
static void	writeString(java.lang.String str, java.io.DataOutput out)

Methods inherited from class java.lang.Object

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

Method Detail

writeINodeFile

public static void writeINodeFile(INodeFile file,
                                  java.io.DataOutput out,
                                  boolean writeUnderConstruction)
                           throws java.io.IOException

Serialize a INodeFile node

Parameters:

file - The INodeFile to write

out - The DataOutputStream where the fields are written

writeUnderConstruction - Whether to write under construction information

Throws:

java.io.IOException

writeINodeFileAttributes

public static void writeINodeFileAttributes(INodeFileAttributes file,
                                            java.io.DataOutput out)
                                     throws java.io.IOException

Serialize an INodeFileAttributes.

Throws:

java.io.IOException

writeINodeDirectory

public static void writeINodeDirectory(INodeDirectory node,
                                       java.io.DataOutput out)
                                throws java.io.IOException

Serialize a INodeDirectory

Parameters:

node - The node to write

out - The DataOutput where the fields are written

Throws:

java.io.IOException

writeINodeDirectoryAttributes

public static void writeINodeDirectoryAttributes(INodeDirectoryAttributes a,
                                                 java.io.DataOutput out)
                                          throws java.io.IOException

Serialize a INodeDirectory

Parameters:

a - The node to write

out - The DataOutput where the fields are written

Throws:

java.io.IOException

saveINode2Image

public static void saveINode2Image(INode node,
                                   java.io.DataOutput out,
                                   boolean writeUnderConstruction,
                                   SnapshotFSImageFormat.ReferenceMap referenceMap)
                            throws java.io.IOException

Save one inode's attributes to the image.

Throws:

java.io.IOException

readString

public static java.lang.String readString(java.io.DataInput in)
                                   throws java.io.IOException

Throws:

java.io.IOException

writeString

public static void writeString(java.lang.String str,
                               java.io.DataOutput out)
                        throws java.io.IOException

Throws:

java.io.IOException

readBytes

public static byte[] readBytes(java.io.DataInput in)
                        throws java.io.IOException

Throws:

java.io.IOException

readByte

public static byte readByte(java.io.DataInput in)
                     throws java.io.IOException

Throws:

java.io.IOException

readPathComponents

public static byte[][] readPathComponents(java.io.DataInput in)
                                   throws java.io.IOException

Reading the path from the image and converting it to byte[][] directly this saves us an array copy and conversions to and from String

Parameters:

in - input to read from

Returns:

the array each element of which is a byte[] representation of a path component

Throws:

java.io.IOException

readLocalName

public static byte[] readLocalName(java.io.DataInput in)
                            throws java.io.IOException

Throws:

java.io.IOException

writeBytes

public static void writeBytes(byte[] data,
                              java.io.DataOutput out)
                       throws java.io.IOException

Throws:

java.io.IOException

writeCompactBlockArray

public static void writeCompactBlockArray(org.apache.hadoop.hdfs.protocol.Block[] blocks,
                                          java.io.DataOutputStream out)
                                   throws java.io.IOException

Write an array of blocks as compactly as possible. This uses delta-encoding for the generation stamp and size, following the principle that genstamp increases relatively slowly, and size is equal for all but the last block of a file.

Throws:

java.io.IOException

readCompactBlockArray

public static org.apache.hadoop.hdfs.protocol.Block[] readCompactBlockArray(java.io.DataInput in,
                                                                            int logVersion)
                                                                     throws java.io.IOException

Throws:

java.io.IOException

writeCacheDirectiveInfo

public static void writeCacheDirectiveInfo(java.io.DataOutputStream out,
                                           org.apache.hadoop.hdfs.protocol.CacheDirectiveInfo directive)
                                    throws java.io.IOException

Throws:

java.io.IOException

readCacheDirectiveInfo

public static org.apache.hadoop.hdfs.protocol.CacheDirectiveInfo readCacheDirectiveInfo(java.io.DataInput in)
                                                                                 throws java.io.IOException

Throws:

java.io.IOException

readCacheDirectiveInfo

public static org.apache.hadoop.hdfs.protocol.CacheDirectiveInfo readCacheDirectiveInfo(XMLUtils.Stanza st)
                                                                                 throws XMLUtils.InvalidXmlException

Throws:

XMLUtils.InvalidXmlException

writeCacheDirectiveInfo

public static void writeCacheDirectiveInfo(org.xml.sax.ContentHandler contentHandler,
                                           org.apache.hadoop.hdfs.protocol.CacheDirectiveInfo directive)
                                    throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

writeCachePoolInfo

public static void writeCachePoolInfo(java.io.DataOutputStream out,
                                      org.apache.hadoop.hdfs.protocol.CachePoolInfo info)
                               throws java.io.IOException

Throws:

java.io.IOException

readCachePoolInfo

public static org.apache.hadoop.hdfs.protocol.CachePoolInfo readCachePoolInfo(java.io.DataInput in)
                                                                       throws java.io.IOException

Throws:

java.io.IOException

writeCachePoolInfo

public static void writeCachePoolInfo(org.xml.sax.ContentHandler contentHandler,
                                      org.apache.hadoop.hdfs.protocol.CachePoolInfo info)
                               throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

readCachePoolInfo

public static org.apache.hadoop.hdfs.protocol.CachePoolInfo readCachePoolInfo(XMLUtils.Stanza st)
                                                                       throws XMLUtils.InvalidXmlException

Throws:

XMLUtils.InvalidXmlException

writeErasureCodingPolicy

public static void writeErasureCodingPolicy(java.io.DataOutputStream out,
                                            org.apache.hadoop.hdfs.protocol.ErasureCodingPolicy ecPolicy)
                                     throws java.io.IOException

Throws:

java.io.IOException

readErasureCodingPolicy

public static org.apache.hadoop.hdfs.protocol.ErasureCodingPolicy readErasureCodingPolicy(java.io.DataInput in)
                                                                                   throws java.io.IOException

Throws:

java.io.IOException