Module org.apache.lucene.core

Package org.apache.lucene.store

Class ByteBufferGuard

java.lang.Object

org.apache.lucene.store.ByteBufferGuard

final class ByteBufferGuard
extends Object

A guard that is created for every ByteBufferIndexInput that tries on best effort to reject any access to the ByteBuffer behind, once it is unmapped. A single instance of this is used for the original and all clones, so once the original is closed and unmapped all clones also throw AlreadyClosedException, triggered by a NullPointerException.

This code tries to hopefully flush any CPU caches using a store-store barrier. It also yields the current thread to give other threads a chance to finish in-flight requests...

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static interface	ByteBufferGuard.BufferCleaner	Pass in an implementation of this interface to cleanup ByteBuffers.

Field Summary

Fields

Modifier and Type	Field	Description
private final ByteBufferGuard.BufferCleaner	cleaner
private boolean	invalidated	Not volatile; see comments on visibility below!
private final String	resourceDescription

Constructor Summary

Constructors

Constructor	Description
ByteBufferGuard(String resourceDescription, ByteBufferGuard.BufferCleaner cleaner)	Creates an instance to be used for a single ByteBufferIndexInput which must be shared by all of its clones.

Method Summary

Modifier and Type	Method	Description
private void	ensureValid()
byte	getByte(ByteBuffer receiver)
byte	getByte(ByteBuffer receiver, int pos)
void	getBytes(ByteBuffer receiver, byte[] dst, int offset, int length)
void	getFloats(FloatBuffer receiver, float[] dst, int offset, int length)
int	getInt(ByteBuffer receiver)
int	getInt(ByteBuffer receiver, int pos)
void	getInts(IntBuffer receiver, int[] dst, int offset, int length)
long	getLong(ByteBuffer receiver)
long	getLong(ByteBuffer receiver, int pos)
void	getLongs(LongBuffer receiver, long[] dst, int offset, int length)
short	getShort(ByteBuffer receiver)
short	getShort(ByteBuffer receiver, int pos)
void	invalidateAndUnmap(ByteBuffer... bufs)	Invalidates this guard and unmaps (if supported).
boolean	isInvalidated()

Methods inherited from class java.lang.Object

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

Field Details

resourceDescription

private final String resourceDescription

cleaner

private final ByteBufferGuard.BufferCleaner cleaner

invalidated

private boolean invalidated

Not volatile; see comments on visibility below!

Constructor Details

ByteBufferGuard

public ByteBufferGuard(String resourceDescription,
 ByteBufferGuard.BufferCleaner cleaner)

Creates an instance to be used for a single ByteBufferIndexInput which must be shared by all of its clones.

Method Details

invalidateAndUnmap

public void invalidateAndUnmap(ByteBuffer... bufs)
                        throws IOException

Invalidates this guard and unmaps (if supported).

Throws:

IOException

isInvalidated

public boolean isInvalidated()

ensureValid

private void ensureValid()

getBytes

public void getBytes(ByteBuffer receiver,
 byte[] dst,
 int offset,
 int length)

getByte

public byte getByte(ByteBuffer receiver)

getShort

public short getShort(ByteBuffer receiver)

getInt

public int getInt(ByteBuffer receiver)

getLong

public long getLong(ByteBuffer receiver)

getByte

public byte getByte(ByteBuffer receiver,
 int pos)

getShort

public short getShort(ByteBuffer receiver,
 int pos)

getInt

public int getInt(ByteBuffer receiver,
 int pos)

getLong

public long getLong(ByteBuffer receiver,
 int pos)

getLongs

public void getLongs(LongBuffer receiver,
 long[] dst,
 int offset,
 int length)

getInts

public void getInts(IntBuffer receiver,
 int[] dst,
 int offset,
 int length)

getFloats

public void getFloats(FloatBuffer receiver,
 float[] dst,
 int offset,
 int length)