Class RegionFile

java.lang.Object

net.minecraft.world.level.chunk.storage.RegionFile

All Implemented Interfaces:

AutoCloseable

public class RegionFile
extends Object
implements AutoCloseable

This class handles a single region (or anvil) file and all files for single chunks at chunk positions for that one region file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	RegionFile.ChunkBuffer
private static interface	RegionFile.CommitOp

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	CHUNK_HEADER_SIZE
private static final int	CHUNK_NOT_PRESENT
private static final int	EXTERNAL_CHUNK_THRESHOLD
private static final String	EXTERNAL_FILE_EXTENSION
private static final int	EXTERNAL_STREAM_FLAG
private final Path	externalFileDir
private final FileChannel	file
private final ByteBuffer	header
private static final int	HEADER_OFFSET
private final RegionStorageInfo	info
private static final org.slf4j.Logger	LOGGER
private final IntBuffer	offsets
private static final ByteBuffer	PADDING_BUFFER
private final Path	path
private static final int	SECTOR_BYTES
protected static final int	SECTOR_INTS
private final IntBuffer	timestamps
protected final RegionBitmap	usedSectors
private final RegionFileVersion	version

Constructor Summary

Constructors

Constructor	Description
RegionFile(RegionStorageInfo info, Path path, Path externalFileDir, boolean sync)
RegionFile(RegionStorageInfo info, Path path, Path externalFileDir, RegionFileVersion version, boolean sync)

Method Summary

Modifier and Type	Method	Description
void	clear(ChunkPos pos)
void	close()
private @Nullable DataInputStream	createChunkInputStream(ChunkPos pos, byte versionId, InputStream chunkStream)
private @Nullable DataInputStream	createExternalChunkInputStream(ChunkPos pos, byte versionId)
private ByteBuffer	createExternalStub()
private static ByteArrayInputStream	createStream(ByteBuffer buffer, int length)
boolean	doesChunkExist(ChunkPos pos)
void	flush()
@Nullable DataInputStream	getChunkDataInputStream(ChunkPos pos)
DataOutputStream	getChunkDataOutputStream(ChunkPos pos)	Creates a new InputStream for a chunk stored in a separate file.
private Path	getExternalChunkPath(ChunkPos pos)	Gets the path to store a chunk that can not be stored within the region file because it's larger than 1 MiB.
private static byte	getExternalChunkVersion(byte version)
private static int	getNumSectors(int offset)	Gets the amount of 4 KiB sectors used to store a chunk.
private int	getOffset(ChunkPos pos)
private static int	getOffsetIndex(ChunkPos pos)	Gets the offset within the region file where the chunk metadata for a chunk can be found.
Path	getPath()
private static int	getSectorNumber(int offset)	Gets the offset in 4 KiB sectors from the start of the region file, where the data for a chunk starts.
private static int	getTimestamp()
boolean	hasChunk(ChunkPos pos)
private static boolean	isExternalStreamChunk(byte version)
private int	packSectorOffset(int index, int size)	Packs the offset in 4 KiB sectors from the region file start and the amount of 4 KiB sectors used to store a chunk into one int.
private void	padToFullSector()
private static int	sizeToSectors(int size)	Gets the amount of sectors required to store chunk data of a certain size in bytes.
protected void	write(ChunkPos pos, ByteBuffer data)
private void	writeHeader()
private RegionFile.CommitOp	writeToExternalFile(Path path, ByteBuffer data)	Writes a chunk to a separate file with only that chunk.

Methods inherited from class Object

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

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

SECTOR_BYTES

private static final int SECTOR_BYTES

See Also:

• Constant Field Values

SECTOR_INTS

protected static final int SECTOR_INTS

See Also:

• Constant Field Values

CHUNK_HEADER_SIZE

private static final int CHUNK_HEADER_SIZE

See Also:

• Constant Field Values

HEADER_OFFSET

private static final int HEADER_OFFSET

See Also:

• Constant Field Values

PADDING_BUFFER

private static final ByteBuffer PADDING_BUFFER

EXTERNAL_FILE_EXTENSION

private static final String EXTERNAL_FILE_EXTENSION

See Also:

• Constant Field Values

EXTERNAL_STREAM_FLAG

private static final int EXTERNAL_STREAM_FLAG

See Also:

• Constant Field Values

EXTERNAL_CHUNK_THRESHOLD

private static final int EXTERNAL_CHUNK_THRESHOLD

See Also:

• Constant Field Values

CHUNK_NOT_PRESENT

private static final int CHUNK_NOT_PRESENT

See Also:

• Constant Field Values

info

private final RegionStorageInfo info

path

private final Path path

file

private final FileChannel file

externalFileDir

private final Path externalFileDir

version

private final RegionFileVersion version

header

private final ByteBuffer header

offsets

private final IntBuffer offsets

timestamps

private final IntBuffer timestamps

usedSectors

protected final RegionBitmap usedSectors

Constructor Details

RegionFile

public RegionFile(RegionStorageInfo info,
 Path path,
 Path externalFileDir,
 boolean sync)
           throws IOException

Throws:

IOException

RegionFile

public RegionFile(RegionStorageInfo info,
 Path path,
 Path externalFileDir,
 RegionFileVersion version,
 boolean sync)
           throws IOException

Throws:

IOException

Method Details

getPath

public Path getPath()

getExternalChunkPath

private Path getExternalChunkPath(ChunkPos pos)

Gets the path to store a chunk that can not be stored within the region file because it's larger than 1 MiB.

getChunkDataInputStream

public @Nullable DataInputStream getChunkDataInputStream(ChunkPos pos)
                                                  throws IOException

Throws:

IOException

getTimestamp

private static int getTimestamp()

isExternalStreamChunk

private static boolean isExternalStreamChunk(byte version)

getExternalChunkVersion

private static byte getExternalChunkVersion(byte version)

createChunkInputStream

private @Nullable DataInputStream createChunkInputStream(ChunkPos pos,
 byte versionId,
 InputStream chunkStream)
                                                  throws IOException

Throws:

IOException

createExternalChunkInputStream

private @Nullable DataInputStream createExternalChunkInputStream(ChunkPos pos,
 byte versionId)
                                                          throws IOException

Throws:

IOException

createStream

private static ByteArrayInputStream createStream(ByteBuffer buffer,
 int length)

packSectorOffset

private int packSectorOffset(int index,
 int size)

Packs the offset in 4 KiB sectors from the region file start and the amount of 4 KiB sectors used to store a chunk into one int.

getNumSectors

private static int getNumSectors(int offset)

Gets the amount of 4 KiB sectors used to store a chunk.

getSectorNumber

private static int getSectorNumber(int offset)

Gets the offset in 4 KiB sectors from the start of the region file, where the data for a chunk starts.

sizeToSectors

private static int sizeToSectors(int size)

Gets the amount of sectors required to store chunk data of a certain size in bytes.

doesChunkExist

public boolean doesChunkExist(ChunkPos pos)

getChunkDataOutputStream

public DataOutputStream getChunkDataOutputStream(ChunkPos pos)
                                          throws IOException

Creates a new InputStream for a chunk stored in a separate file.

Throws:

IOException

flush

public void flush()
           throws IOException

Throws:

IOException

clear

public void clear(ChunkPos pos)
           throws IOException

Throws:

IOException

write

protected void write(ChunkPos pos,
 ByteBuffer data)
              throws IOException

Throws:

IOException

createExternalStub

private ByteBuffer createExternalStub()

writeToExternalFile

private RegionFile.CommitOp writeToExternalFile(Path path,
 ByteBuffer data)
                                         throws IOException

Writes a chunk to a separate file with only that chunk. This is used for chunks larger than 1 MiB

Throws:

IOException

writeHeader

private void writeHeader()
                  throws IOException

Throws:

IOException

getOffset

private int getOffset(ChunkPos pos)

hasChunk

public boolean hasChunk(ChunkPos pos)

getOffsetIndex

private static int getOffsetIndex(ChunkPos pos)

Gets the offset within the region file where the chunk metadata for a chunk can be found.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException

padToFullSector

private void padToFullSector()
                      throws IOException

Throws:

IOException