org.apache.hadoop.hbase.io

Class FSDataInputStreamWrapper

java.lang.Object

org.apache.hadoop.hbase.io.FSDataInputStreamWrapper

All Implemented Interfaces:

Closeable, AutoCloseable

@InterfaceAudience.Private
public class FSDataInputStreamWrapper
extends Object
implements Closeable

Wrapper for input stream(s) that takes care of the interaction of FS and HBase checksums, as well as closing streams. Initialization is not thread-safe, but normal operation is; see method comments.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.hadoop.fs.Path	readerPath

Constructor Summary

Constructors

Constructor and Description
FSDataInputStreamWrapper(org.apache.hadoop.fs.FileSystem fs, FileLink link, boolean dropBehind, long readahead)
FSDataInputStreamWrapper(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path path)
FSDataInputStreamWrapper(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path path, boolean dropBehind, long readahead)
FSDataInputStreamWrapper(org.apache.hadoop.fs.FSDataInputStream fsdis) For use in tests.
FSDataInputStreamWrapper(org.apache.hadoop.fs.FSDataInputStream fsdis, org.apache.hadoop.fs.FSDataInputStream noChecksum) For use in tests.

Method Summary

Modifier and Type	Method and Description
void	checksumOk() Report that checksum was ok, so we may ponder going back to HBase checksum.
void	close() CloseClose stream(s) if necessary.
org.apache.hadoop.fs.FSDataInputStream	fallbackToFsChecksum(int offCount) Read from non-checksum stream failed, fall back to FS checksum.
HFileSystem	getHfs()
static long	getLocalBytesRead()
org.apache.hadoop.fs.Path	getReaderPath()
static long	getShortCircuitBytesRead()
org.apache.hadoop.fs.FSDataInputStream	getStream(boolean useHBaseChecksum) Get the stream to use.
static long	getTotalBytesRead()
static long	getZeroCopyBytesRead()
void	prepareForBlockReader(boolean forceNoHBaseChecksum) Prepares the streams for block reader.
boolean	shouldUseHBaseChecksum() Returns Whether we are presently using HBase checksum.
void	unbuffer() This will free sockets and file descriptors held by the stream only when the stream implements org.apache.hadoop.fs.CanUnbuffer.

Methods inherited from class java.lang.Object

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

Field Detail

readerPath

protected org.apache.hadoop.fs.Path readerPath

Constructor Detail

FSDataInputStreamWrapper

public FSDataInputStreamWrapper(org.apache.hadoop.fs.FileSystem fs,
                                org.apache.hadoop.fs.Path path)
                         throws IOException

Throws:

IOException

FSDataInputStreamWrapper

public FSDataInputStreamWrapper(org.apache.hadoop.fs.FileSystem fs,
                                org.apache.hadoop.fs.Path path,
                                boolean dropBehind,
                                long readahead)
                         throws IOException

Throws:

IOException

FSDataInputStreamWrapper

public FSDataInputStreamWrapper(org.apache.hadoop.fs.FileSystem fs,
                                FileLink link,
                                boolean dropBehind,
                                long readahead)
                         throws IOException

Throws:

IOException

FSDataInputStreamWrapper

public FSDataInputStreamWrapper(org.apache.hadoop.fs.FSDataInputStream fsdis)

For use in tests.

FSDataInputStreamWrapper

public FSDataInputStreamWrapper(org.apache.hadoop.fs.FSDataInputStream fsdis,
                                org.apache.hadoop.fs.FSDataInputStream noChecksum)

For use in tests.

Method Detail

prepareForBlockReader

public void prepareForBlockReader(boolean forceNoHBaseChecksum)
                           throws IOException

Prepares the streams for block reader. NOT THREAD SAFE. Must be called once, after any reads finish and before any other reads start (what happens in reality is we read the tail, then call this based on what's in the tail, then read blocks).

Parameters:

forceNoHBaseChecksum - Force not using HBase checksum.

Throws:

IOException

shouldUseHBaseChecksum

public boolean shouldUseHBaseChecksum()

Returns Whether we are presently using HBase checksum.

getStream

public org.apache.hadoop.fs.FSDataInputStream getStream(boolean useHBaseChecksum)

Get the stream to use. Thread-safe.

Parameters:

useHBaseChecksum - must be the value that shouldUseHBaseChecksum has returned at some point in the past, otherwise the result is undefined.

fallbackToFsChecksum

public org.apache.hadoop.fs.FSDataInputStream fallbackToFsChecksum(int offCount)
                                                            throws IOException

Read from non-checksum stream failed, fall back to FS checksum. Thread-safe.

Parameters:

offCount - For how many checksumOk calls to turn off the HBase checksum.

Throws:

IOException

checksumOk

public void checksumOk()

Report that checksum was ok, so we may ponder going back to HBase checksum.

getTotalBytesRead

public static long getTotalBytesRead()

getLocalBytesRead

public static long getLocalBytesRead()

getShortCircuitBytesRead

public static long getShortCircuitBytesRead()

getZeroCopyBytesRead

public static long getZeroCopyBytesRead()

close

public void close()

CloseClose stream(s) if necessary.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

getHfs

public HFileSystem getHfs()

unbuffer

public void unbuffer()

This will free sockets and file descriptors held by the stream only when the stream implements org.apache.hadoop.fs.CanUnbuffer. NOT THREAD SAFE. Must be called only when all the clients using this stream to read the blocks have finished reading. If by chance the stream is unbuffered and there are clients still holding this stream for read then on next client read request a new socket will be opened by Datanode without client knowing about it and will serve its read request. Note: If this socket is idle for some time then the DataNode will close the socket and the socket will move into CLOSE_WAIT state and on the next client request on this stream, the current socket will be closed and a new socket will be opened to serve the requests.

getReaderPath

public org.apache.hadoop.fs.Path getReaderPath()