package io.nanachiyo0721.shiroha.data; import ca.spottedleaf.concurrentutil.util.ConcurrentUtil; import ca.spottedleaf.moonrise.patches.chunk_system.io.MoonriseRegionFileIO; import com.github.luben.zstd.Zstd; import com.github.luben.zstd.ZstdInputStream; import io.nanachiyo0721.shiroha.utils.BufferedLinearRegionFileFlusher; import net.jpountz.lz4.LZ4Compressor; import net.jpountz.lz4.LZ4Factory; import net.jpountz.lz4.LZ4FastDecompressor; import net.jpountz.xxhash.XXHash32; import net.jpountz.xxhash.XXHashFactory; import net.minecraft.nbt.CompoundTag; import net.minecraft.world.level.ChunkPos; import net.minecraft.world.level.chunk.storage.RegionFile; import net.minecraft.world.level.chunk.storage.RegionFileStorage; import net.openhft.hashing.LongHashFunction; import org.apache.commons.lang3.Validate; import org.jetbrains.annotations.Contract; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; import org.jspecify.annotations.NonNull; import java.io.*; import java.lang.invoke.VarHandle; import java.nio.ByteBuffer; import java.nio.channels.FileChannel; import java.nio.file.Files; import java.nio.file.Path; import java.nio.file.StandardCopyOption; import java.nio.file.StandardOpenOption; import java.util.concurrent.atomic.AtomicLong; import java.util.concurrent.locks.ReadWriteLock; import java.util.concurrent.locks.ReentrantReadWriteLock; /** * Lock hierarchy (always acquire top to bottom, never the reverse): *
    *
  1. {@code syncLock} — serializes master file syncs against close
  2. *
  3. {@code Bucket.lock} — per-bucket lazy-load guard
  4. *
  5. {@code masterFileLock} — master file read / append / replace
  6. *
  7. {@code regionObjectLock} — in-memory sector table + swap file channel
  8. *
* The atomic flags (closed / synced / beingSynced / lastWritten) and the bucket * epochs are lock-free and may be touched while holding any (or no) lock. */ public class BufferedLinearRegionFile implements io.nanachiyo0721.shiroha.data.RegionFile { private static final double SWAP_FILE_AUTO_COMPACT_PERCENT = 3.0 / 5.0; // 60 % private static final long SWAP_FILE_AUTO_COMPACT_SIZE = 1024 * 1024; // 1 MiB // master file WAL appends leave the replaced bucket records behind as garbage; once // it piles up past this threshold the next sync compacts via a full tmp-file rewrite private static final double MASTER_FILE_AUTO_COMPACT_PERCENT = SWAP_FILE_AUTO_COMPACT_PERCENT; private static final long MASTER_FILE_AUTO_COMPACT_SIZE = SWAP_FILE_AUTO_COMPACT_SIZE; private static final long SWAP_FILE_SUPER_BLOCK = 0x1145141919810L; private static final int SWAP_FILE_HASH_SEED = 0x0721; // ~(∠・ω< )⌒★ private static final byte SWAP_FILE_VERSION = 0x02; // ver 2.0 private static final long MASTER_FILE_SUPER_BLOCK = -0x200812250269L; private static final byte MASTER_FILE_VERSION = 0x02; // ver 2.0 private static final byte MASTER_FILE_VERSION_BUCKET = 0x03; // ver 3.0 private static final long LINEAR_FILE_SUPER_BLOCK = 0xc3ff13183cca9d9aL; private static final int BUCKET_SHIFT = 6; private static final int BUCKET_SIZE = 1 << BUCKET_SHIFT; private static final int BUCKET_COUNT = 1024 / BUCKET_SIZE; private static final long MAX_SIZE_PER_CHUNK = RegionFile.MAX_CHUNK_SIZE; private static final StandardOpenOption[] SWAP_FILE_CHANNEL_OPTIONS = new StandardOpenOption[]{ StandardOpenOption.CREATE, StandardOpenOption.WRITE, StandardOpenOption.READ, StandardOpenOption.DELETE_ON_CLOSE }; private static final class Bucket { private final Object lock = new Object(); private final AtomicLong writeEpoch = new AtomicLong(); private final AtomicLong syncedEpoch = new AtomicLong(); private volatile boolean loaded = false; } private final Bucket[] buckets = new Bucket[BUCKET_COUNT]; private final Path masterFilePath; private final Path swapFilePath; // outermost lock: serializes syncToMasterFile() against closeInternal(), so the // swap channel can never be torn down while a sync is still reading from it private final Object syncLock = new Object(); private final ReadWriteLock regionObjectLock = new ReentrantReadWriteLock(); private final XXHash32 xxHash32 = XXHashFactory.fastestInstance().hash32(); private Sector[] sectors = new Sector[1024]; private long currentAcquiredIndex = this.headerSize(); private int xxHash32Seed = SWAP_FILE_HASH_SEED; private FileChannel swapFileChannel; private final byte compressionLevel; private final LinearMasterFileParser masterFileParser = new LinearMasterFileParser(); private final CompressingOps compressingOps = new CompressingOps(); // managed by VarHandles following private boolean closed = false; private boolean beingSynced = false; private boolean synced = false; private long lastWritten = System.nanoTime(); private static final VarHandle CLOSED_HANDLE = ConcurrentUtil.getVarHandle(BufferedLinearRegionFile.class, "closed", boolean.class); private static final VarHandle SYNCED_HANDLE = ConcurrentUtil.getVarHandle(BufferedLinearRegionFile.class, "synced", boolean.class); private static final VarHandle BEING_SYNCED_HANDLE = ConcurrentUtil.getVarHandle(BufferedLinearRegionFile.class, "beingSynced", boolean.class); private static final VarHandle LAST_WRITTEN_HANDLE = ConcurrentUtil.getVarHandle(BufferedLinearRegionFile.class, "lastWritten", long.class); private final BufferedLinearRegionFileFlusher flusher; public BufferedLinearRegionFile(Path masterFilePath, int compressionLevel, @NotNull BufferedLinearRegionFileFlusher flusher) throws IOException { this.masterFilePath = masterFilePath; this.swapFilePath = Path.of(this.masterFilePath.toString() + ".swp"); Validate.inclusiveBetween(1, 22, compressionLevel); for (int i = 0; i < this.buckets.length; i++) { this.buckets[i] = new Bucket(); } this.compressionLevel = (byte) compressionLevel; this.cleanUpSwapFile(); this.initSwapFile(); this.tryLoadOldBlinearMasterFileData(); this.flusher = flusher; this.flusher.addFile(this); } private static void writeFullyAt(FileChannel channel, @NonNull ByteBuffer buf, long startOffset) throws IOException { long offset = startOffset; while (buf.hasRemaining()) { offset += channel.write(buf, offset); } } private static void readFullyAt(FileChannel channel, @NonNull ByteBuffer buf, long startOffset) throws IOException { long offset = startOffset; while (buf.hasRemaining()) { final int read = channel.read(buf, offset); if (read < 0) throw new EOFException("Unexpected EOF at offset " + offset); offset += read; } } private static void transferFully(FileChannel source, long sourceOffset, long count, FileChannel target, long targetOffset) throws IOException { target.position(targetOffset); long transferred = 0; while (transferred < count) { transferred += source.transferTo(sourceOffset + transferred, count - transferred, target); } } // replaces target with source, deleting source if both attempts fail private static void atomicReplace(Path source, Path target) throws IOException { try { Files.move(source, target, StandardCopyOption.REPLACE_EXISTING, StandardCopyOption.ATOMIC_MOVE); } catch (Throwable e) { // atomic move might be unsupported on some file systems, so give it an attempt to retry without atomic move try { Files.move(source, target, StandardCopyOption.REPLACE_EXISTING); } catch (Throwable ex) { e.addSuppressed(ex); // delete file that failed to replace Files.deleteIfExists(source); throw new IOException("Failed to replace " + target + "!", e); } } } private void cleanUpSwapFile() throws IOException { Files.deleteIfExists(this.swapFilePath); } private void ensureBucketLoaded(int chunkIndex) throws IOException { final int bucketIndex = chunkIndex >> BUCKET_SHIFT; final Bucket bucket = this.buckets[bucketIndex]; if (bucket.loaded) { // volatile fast path return; } // bucket lock -> master read lock -> swap write lock synchronized (bucket.lock) { if (bucket.loaded) { return; } this.masterFileParser.loadBucketsFor(this.masterFilePath, bucketIndex); bucket.loaded = true; } } // used by the legacy parsers: their data goes through the write path directly, // so the bucket must be flagged loaded first to avoid a recursive lazy-load private void markBucketLoaded(int chunkIndex) { final Bucket bucket = this.buckets[chunkIndex >> BUCKET_SHIFT]; synchronized (bucket.lock) { bucket.loaded = true; } } private void markBucketDirty(int chunkIndex) { this.buckets[chunkIndex >> BUCKET_SHIFT].writeEpoch.incrementAndGet(); } private long getBucketWriteEpoch(int bucketIndex) { return this.buckets[bucketIndex].writeEpoch.get(); } private void markBucketSynced(int bucketIndex, long syncedEpoch) { this.buckets[bucketIndex].syncedEpoch.accumulateAndGet(syncedEpoch, Math::max); } private boolean isBucketDirty(int bucketIndex) { final Bucket bucket = this.buckets[bucketIndex]; return bucket.writeEpoch.get() != bucket.syncedEpoch.get(); } public boolean markAsBeingSynced() { return BEING_SYNCED_HANDLE.compareAndSet(this, false, true); } public long getLastWritten() { return (long) LAST_WRITTEN_HANDLE.getVolatile(this); } public boolean shouldSync() { return !((boolean) SYNCED_HANDLE.getVolatile(this)); } public boolean softReadLock() { // not done close logic yet return this.regionObjectLock.readLock().tryLock(); } public void releaseReadLock() { this.regionObjectLock.readLock().unlock(); } public boolean isClosedRaw() { return (boolean) CLOSED_HANDLE.getVolatile(this); } public boolean isClosed() { this.regionObjectLock.readLock().lock(); try { return (boolean) CLOSED_HANDLE.getVolatile(this); } finally { this.regionObjectLock.readLock().unlock(); } } public void syncIfNeeded() throws IOException { try { this.syncToMasterFile(); } finally { BEING_SYNCED_HANDLE.setVolatile(this, false); // mark as not being synced } } private void syncToMasterFile() throws IOException { // serialized against close: the swap channel cannot go away under a running sync synchronized (this.syncLock) { // skip if closed already if (this.isClosedRaw()) { return; } // fast skip when there is nothing to sync; writers flip the flag back // via markAsToSync() which triggers the next round if (!SYNCED_HANDLE.compareAndSet(this, false, true)) { return; } try { this.masterFileParser.sync(this.masterFilePath); } catch (Throwable e) { // set back SYNCED_HANDLE.setVolatile(this, false); throw new IOException("Failed to sync to master file!", e); } } } private void tryLoadOldBlinearMasterFileData() throws IOException { this.masterFileParser.tryParseMainFileOld(this.masterFilePath); } private void initSwapFile() throws IOException { this.swapFileChannel = FileChannel.open( this.swapFilePath, SWAP_FILE_CHANNEL_OPTIONS ); // fill default sectors for (int i = 0; i < 1024; i++) { this.sectors[i] = new Sector(i, this.headerSize(), 0); } } private void recalculateAcquiredIndex() { long newValue = this.headerSize(); for (Sector sector : this.sectors) { if (sector.hasData()) { newValue = Math.max(newValue, sector.offset + sector.length); } } this.currentAcquiredIndex = newValue; } private void writeSwapFileHeaders(boolean forceFile, boolean forceMeta) throws IOException { final ByteBuffer buffer = ByteBuffer.allocate(this.headerSize()); buffer.putLong(SWAP_FILE_SUPER_BLOCK); // Magic buffer.put(SWAP_FILE_VERSION); // Version buffer.putInt(this.xxHash32Seed); // XXHash32 seed buffer.putLong(this.currentAcquiredIndex); // Acquired index for (Sector sector : this.sectors) { // encode each sector buffer.put(sector.getEncoded()); } buffer.flip(); writeFullyAt(this.swapFileChannel, buffer, 0); if (forceFile) { this.swapFileChannel.force(forceMeta); } } private int sectorSize() { return this.sectors.length * Sector.sizeOfSingle(); } private int headerSize() { int result = 0; result += Long.BYTES; // Magic result += Byte.BYTES; // Version result += Integer.BYTES; // XXHash32 seed result += Long.BYTES; // Acquired index result += this.sectorSize(); // Sectors return result; } private void flushInternal() throws IOException { boolean initiallySyncRequired; this.regionObjectLock.writeLock().lock(); try { if (this.isClosedRaw()) { return; } long liveSize = 0; for (Sector sector : this.sectors) { // skip no data sectors if (!sector.hasData()) { continue; } liveSize += sector.length; } // everything acquired but not covered by a live sector is garbage final long spareSize = this.currentAcquiredIndex - this.headerSize() - liveSize; final boolean compactRequested = spareSize > SWAP_FILE_AUTO_COMPACT_SIZE && (double) spareSize > ((double) liveSize) * SWAP_FILE_AUTO_COMPACT_PERCENT; // try auto compact to clean the garbage area if (compactRequested) { // do compact this.compactSwapFile(); } // prevent syncing after compact because it could be time costing sometimes initiallySyncRequired = !Files.exists(this.masterFilePath) && !compactRequested; } finally { this.regionObjectLock.writeLock().unlock(); } if (initiallySyncRequired) { this.syncToMasterFile(); } } private void closeInternal() throws IOException { synchronized (this.syncLock) { if (this.isClosedRaw()) { // already closed (possibly by a compact disaster path): just make sure // both channels are really gone — close is idempotent this.regionObjectLock.writeLock().lock(); try { this.swapFileChannel.close(); } finally { this.regionObjectLock.writeLock().unlock(); } this.masterFileParser.close(); return; } // final sync so no buffered data is lost; holding syncLock also guarantees no // concurrent flusher sync is still running when we tear down below. // if this throws we deliberately stay open: the flusher can retry the sync // later, and the not-yet-synced swap data is not dropped on the floor this.syncToMasterFile(); IOException failure = null; this.regionObjectLock.writeLock().lock(); try { this.markClosed(); this.swapFileChannel.close(); } catch (IOException e) { failure = e; } finally { this.regionObjectLock.writeLock().unlock(); } try { // acquired after the region lock is fully released, never inside it (lock hierarchy) this.masterFileParser.close(); } catch (IOException e) { if (failure == null) failure = e; else failure.addSuppressed(e); } if (failure != null) { throw failure; } } } private void markClosed() { // lenient CAS: the disaster path of compactSwapFile() may have closed us already if (CLOSED_HANDLE.compareAndSet(this, false, true)) { this.flusher.removeFile(this); } } private void compactSwapFile() throws IOException { this.writeSwapFileHeaders(true, true); // save headers for compact final Sector[] newSectorsToBeReplaced = new Sector[this.sectors.length]; for (int i = 0; i < this.sectors.length; i++) { final Sector old = this.sectors[i]; if (old.hasData()) { newSectorsToBeReplaced[i] = old; continue; } // note: // we reset length to 0 and this would make length <= newLength(which is >= 0) is always true. // so that the following write operation wouldn't override the data of other sectors // see the write method in Sector class newSectorsToBeReplaced[i] = new Sector(i, 0, 0); } long newAcquiredIndex; final Path targetTemp = Path.of(this.swapFilePath + ".tmp"); try (FileChannel tempChannel = FileChannel.open( targetTemp, StandardOpenOption.CREATE_NEW, StandardOpenOption.WRITE, StandardOpenOption.READ, StandardOpenOption.TRUNCATE_EXISTING )) { long offsetPointer = this.headerSize(); for (Sector sector : newSectorsToBeReplaced) { // skip cleared or no data-contained sectors if (!sector.hasData()) { continue; } // transfer to target transferFully(this.swapFileChannel, sector.offset, sector.length, tempChannel, offsetPointer); // recalculate the offset and length final Sector newRecalculated = new Sector(sector.index, offsetPointer, sector.length); newRecalculated.hasData = true; offsetPointer += sector.length; newSectorsToBeReplaced[sector.index] = newRecalculated; // update sector infos } tempChannel.force(true); newAcquiredIndex = offsetPointer; } catch (Throwable ex) { // recalculate acquired index this.recalculateAcquiredIndex(); // delete the target temp file Files.deleteIfExists(targetTemp); // fast-fail // note: we don't block new write operations here as this is recoverable throw new IOException("Failed to compact swap file!", ex); } this.swapFileChannel.close(); // replace swap file try { atomicReplace(targetTemp, this.swapFilePath); } catch (Throwable e) { // recalculate acquired index this.recalculateAcquiredIndex(); // reopen closed channel this.reopenSwapFileChannel(); // fast-fail this.markClosed(); // prevent new writing & sync operations throw new IOException("Failed to replace original swap file!", e); } try { // reopen file channel this.reopenSwapFileChannel(); // replace with recalculated file headers this.sectors = newSectorsToBeReplaced; this.currentAcquiredIndex = newAcquiredIndex; // flush to file this.writeSwapFileHeaders(true, true); } catch (Throwable ex) { // we are totally failed here, // directly mark as closed as the swap file is already replaced, and we failed to update the // data which is still in the memory // // which means we might write any data into any incorrect indexed sectors which will blow the whole data this.markClosed(); throw new IOException(ex); } } private void reopenSwapFileChannel() throws IOException { if (this.swapFileChannel.isOpen()) { this.swapFileChannel.close(); } this.swapFileChannel = FileChannel.open( this.swapFilePath, SWAP_FILE_CHANNEL_OPTIONS ); } private void writeChunkDataRaw(int index, ByteBuffer chunkData, boolean skipSync) throws IOException { final ByteBuffer committed = this.compressingOps.compress(chunkData); // run compression out of lock this.regionObjectLock.writeLock().lock(); try { final Sector sector = this.sectors[index]; sector.store(committed, this.swapFileChannel); if (!skipSync) { this.markBucketDirty(index); } } finally { this.regionObjectLock.writeLock().unlock(); } if (skipSync) { return; } this.markAsToSync(); } private @Nullable ByteBuffer readChunkDataRaw(int index) throws IOException { final ByteBuffer raw; this.regionObjectLock.readLock().lock(); try { final Sector sector = this.sectors[index]; if (!sector.hasData()) { return null; } raw = sector.read(this.swapFileChannel); } finally { this.regionObjectLock.readLock().unlock(); } return this.compressingOps.decompress(raw); } private void clearChunkData(int index) throws IOException { this.ensureBucketLoaded(index); this.regionObjectLock.writeLock().lock(); try { final Sector sector = this.sectors[index]; sector.clear(); this.markBucketDirty(index); } finally { this.regionObjectLock.writeLock().unlock(); } this.markAsToSync(); } private void markAsToSync() { SYNCED_HANDLE.setVolatile(this, false); // mark as unsynced LAST_WRITTEN_HANDLE.setVolatile(this, System.nanoTime()); // update last written time } private static int getChunkIndex(int x, int z) { return (x & 31) + ((z & 31) << 5); } private boolean hasData(int index) throws IOException { this.ensureBucketLoaded(index); this.regionObjectLock.readLock().lock(); try { return this.sectors[index].hasData(); } finally { this.regionObjectLock.readLock().unlock(); } } private void writeChunk(int x, int z, @NotNull ByteBuffer data) throws IOException { final int chunkIndex = getChunkIndex(x, z); this.ensureBucketLoaded(chunkIndex); if (data.remaining() > MAX_SIZE_PER_CHUNK) { throw new RegionFileStorage.RegionFileSizeException("Writing too large chunk, limit : " + MAX_SIZE_PER_CHUNK + " but got : " + data.remaining()); } final int oldPositionOfData = data.position(); final int xxHash32OfData = this.xxHash32.hash(data, this.xxHash32Seed); data.position(oldPositionOfData); // uncompressed length(int) + timestamp(long) + xxhash32(int) final ByteBuffer chunkSectionBuilder = ByteBuffer.allocate(data.remaining() + 4 + 8 + 4); chunkSectionBuilder.putInt(data.remaining()); // Length(int) chunkSectionBuilder.putLong(System.currentTimeMillis()); // Timestamp(long) chunkSectionBuilder.putInt(xxHash32OfData); // xxHash32 of the original data(int) chunkSectionBuilder.put(data); // Data(bytes) chunkSectionBuilder.flip(); this.writeChunkDataRaw(chunkIndex, chunkSectionBuilder, false); } private @Nullable ByteBuffer readChunk(int x, int z) throws IOException { final int chunkIndex = getChunkIndex(x, z); this.ensureBucketLoaded(chunkIndex); final ByteBuffer data = this.readChunkDataRaw(chunkIndex); if (data == null) { return null; } final int length = data.getInt(); // compressed length(int) final long timestamp = data.getLong(); // TODO use this timestamp(long) for something? final int dataXXHash32 = data.getInt(); // XXHash32 for validation(int) final IOException xxHash32CheckFailedEx = this.checkXXHash32(dataXXHash32, data); if (xxHash32CheckFailedEx != null) { throw xxHash32CheckFailedEx; // prevent from loading } return data; } private @Nullable IOException checkXXHash32(long originalXXHash32, @NotNull ByteBuffer input) { final int oldPositionOfInput = input.position(); final int currentXXHash32 = this.xxHash32.hash(input, this.xxHash32Seed); input.position(oldPositionOfInput); if (originalXXHash32 != currentXXHash32) { return new IOException("XXHash32 check failed ! Expected: " + originalXXHash32 + ",but got: " + currentXXHash32); } return null; } @Override public Path getPath() { return this.masterFilePath; } @Override public DataInputStream getChunkDataInputStream(@NotNull ChunkPos pos) throws IOException { final ByteBuffer data = this.readChunk(pos.x(), pos.z()); if (data == null) { return null; } return new DataInputStream(new ByteBufferInputStream(data)); } @Override public boolean doesChunkExist(@NotNull ChunkPos pos) throws IOException { return this.hasData(getChunkIndex(pos.x(), pos.z())); } @Override public DataOutputStream getChunkDataOutputStream(ChunkPos pos) { return new DataOutputStream(new ChunkBufferHelper(pos)); } @Override public void clear(@NotNull ChunkPos pos) throws IOException { this.clearChunkData(getChunkIndex(pos.x(), pos.z())); } @Override public boolean hasChunk(@NotNull ChunkPos pos) { try { return this.hasData(getChunkIndex(pos.x(), pos.z())); } catch (IOException e) { throw new RuntimeException(e); } } @Override public void write(@NotNull ChunkPos pos, ByteBuffer buf) throws IOException { this.writeChunk(pos.x(), pos.z(), buf); } // MCC 的玩意,这东西也用不上给Linear了() @Override public CompoundTag getOversizedData(int x, int z) { return null; } @Override public boolean isOversized(int x, int z) { return false; } @Override public boolean recalculateHeader() { return false; } @Override public void setOversized(int x, int z, boolean oversized) { } // MCC end @Override public MoonriseRegionFileIO.RegionDataController.WriteData moonrise$startWrite(CompoundTag data, ChunkPos pos) { final DataOutputStream out = this.getChunkDataOutputStream(pos); return new MoonriseRegionFileIO.RegionDataController.WriteData( data, MoonriseRegionFileIO.RegionDataController.WriteData.WriteResult.WRITE, out, regionFile -> out.close() ); } @Override public void flush() throws IOException { this.flushInternal(); } @Override public void close() throws IOException { this.closeInternal(); } public static class ByteBufferInputStream extends InputStream { protected final ByteBuffer internal; public ByteBufferInputStream(ByteBuffer buf) { this.internal = buf; } @Override public int available() { return this.internal.remaining(); } @Override public int read() throws IOException { return this.internal.hasRemaining() ? (this.internal.get() & 0xFF) : -1; } @Override public int read(byte @NotNull [] bytes, int off, int len) throws IOException { if (!this.internal.hasRemaining()) return -1; len = Math.min(len, this.internal.remaining()); this.internal.get(bytes, off, len); return len; } } // here we use this tool to prevent the swap file goes too large // sometimes when a region contains all chunks, it might be very huge without any compressions(around 100MiB) private static class CompressingOps { private final LZ4Compressor lz4Compressor = LZ4Factory.fastestInstance().fastCompressor(); private final LZ4FastDecompressor lz4Decompressor = LZ4Factory.fastestInstance().fastDecompressor(); public @NotNull ByteBuffer compress(@NotNull ByteBuffer in) { final int bufferLenToAllocate = this.lz4Compressor.maxCompressedLength(in.remaining()); final ByteBuffer result = ByteBuffer.allocate(bufferLenToAllocate + 4); result.putInt(in.remaining()); this.lz4Compressor.compress(in, result); return result.flip(); } public @NotNull ByteBuffer decompress(@NotNull ByteBuffer flippedIn) { final int originalLen = flippedIn.getInt(); final byte[] raw = new byte[flippedIn.remaining()]; flippedIn.get(raw); final byte[] decompressed = new byte[originalLen]; this.lz4Decompressor.decompress(raw, decompressed); return ByteBuffer.wrap(decompressed); } } public class Sector { private final int index; private long offset; private long length; private boolean hasData = false; private Sector(int index, long offset, long length) { this.index = index; this.offset = offset; this.length = length; } public @NotNull ByteBuffer read(@NotNull FileChannel channel) throws IOException { final ByteBuffer result = ByteBuffer.allocate((int) this.length); readFullyAt(channel, result, this.offset); result.flip(); return result; } public void store(@NotNull ByteBuffer newData, @NotNull FileChannel channel) throws IOException { final long oldLength = this.length; final long newDataLength = newData.remaining(); this.hasData = true; this.length = newDataLength; // data is smaller or its length equals to the local buffer we hold, write it directly if (newDataLength <= oldLength) { writeFullyAt(channel, newData, this.offset); return; } // or we will append to the end of file this.offset = BufferedLinearRegionFile.this.currentAcquiredIndex; BufferedLinearRegionFile.this.currentAcquiredIndex += this.length; writeFullyAt(channel, newData, this.offset); } private @NotNull ByteBuffer getEncoded() { final ByteBuffer buffer = ByteBuffer.allocate(sizeOfSingle()); buffer.putLong(this.offset); buffer.putLong(this.length); buffer.put((byte) (this.hasData ? 1 : 0)); buffer.flip(); return buffer; } public void restoreFrom(@NotNull ByteBuffer buffer) { this.offset = buffer.getLong(); this.length = buffer.getLong(); this.hasData = buffer.get() == 1; if (this.length < 0 || this.offset < 0) { throw new IllegalStateException("Invalid sector data: " + this); } } public void clear() { this.hasData = false; } public boolean hasData() { return this.hasData; } static int sizeOfSingle() { // offset + length hasData return Long.BYTES * 2 + 1; } } private class ChunkBufferHelper extends ByteArrayOutputStream { private final ChunkPos pos; private ChunkBufferHelper(ChunkPos pos) { this.pos = pos; } @Override public void close() throws IOException { ByteBuffer bytebuffer = ByteBuffer.wrap(this.buf, 0, this.count); BufferedLinearRegionFile.this.writeChunk(this.pos.x(), this.pos.z(), bytebuffer); BufferedLinearRegionFile.this.flushInternal(); } } private class LinearMasterFileParser { // V3 bucketed format layout: // [0, 14): header — superblock(8) + version(1) + compressionLevel(1) + xxHash32Seed(4) // [14, 142): position table — BUCKET_COUNT(16) × long(8) each; 0 = no data for that bucket // [142, EOF): bucket records — originalLen(int) + compressedLen(int) + compressedData private static final int V3_HEADER_SIZE = 14; private static final long V3_POS_TABLE_OFFSET = V3_HEADER_SIZE; private static final int V3_POS_TABLE_SIZE = BUCKET_COUNT * Long.BYTES; // 128 private static final long V3_DATA_AREA_OFFSET = V3_POS_TABLE_OFFSET + V3_POS_TABLE_SIZE; // 142 private static final int V3_RECORD_HEADER_SIZE = Integer.BYTES * 2; // originalLen + compressedLen private final ReadWriteLock masterFileLock = new ReentrantReadWriteLock(); // WAL(append) state, guarded by masterFileLock: null until the first sync after // open has fully rewritten the master file; afterwards syncs only append changed // buckets to the tail and update the position table in place. // recordSizes mirrors positionTable (size of each live record) so the garbage // ratio can be computed without touching the disk private @Nullable FileChannel appendChannel; private long[] positionTable; private long[] recordSizes; private long appendOffset; // a consistent snapshot of one bucket taken from the swap file; // payload == null means the bucket holds no chunks at all private record BucketRecord(long epoch, byte @Nullable [] payload) { } // must be called under syncLock (see syncToMasterFile) public void sync(@NotNull Path mainFile) throws IOException { this.masterFileLock.writeLock().lock(); try { // full rewrite on the first sync after open, and afterwards whenever the // appended garbage passed the auto-compact threshold: writes a tmp file, // then atomically replaces the master file with it if (this.appendChannel == null || this.shouldCompactMasterFile()) { this.rewriteFully(mainFile); } else { // WAL-style otherwise: only append the dirty buckets this.appendDirtyBuckets(); } } finally { this.masterFileLock.writeLock().unlock(); } } // only valid in WAL mode (appendChannel != null); mirrors the swap file heuristic private boolean shouldCompactMasterFile() { long liveSize = 0; for (final long size : this.recordSizes) { liveSize += size; } final long spareSize = this.appendOffset - V3_DATA_AREA_OFFSET - liveSize; return spareSize > MASTER_FILE_AUTO_COMPACT_SIZE && (double) spareSize > ((double) liveSize) * MASTER_FILE_AUTO_COMPACT_PERCENT; } private void rewriteFully(@NotNull Path mainFile) throws IOException { // a compacting rewrite replaces the whole file, so drop the old append channel // first; if anything below fails, the next sync just retries via this path if (this.appendChannel != null) { this.appendChannel.close(); this.appendChannel = null; } final Path tmpFilePath = Path.of(mainFile + ".tmp"); final long[] syncedBucketEpochs = new long[BUCKET_COUNT]; final long[] newPositionTable = new long[BUCKET_COUNT]; final long[] newRecordSizes = new long[BUCKET_COUNT]; final long newAppendOffset; // open the old file to copy the non-dirty buckets over try (FileChannel oldChannel = this.openV3MasterFile(mainFile)) { final long[] oldPositionTable = oldChannel == null ? null : this.parseOffsetTable(oldChannel); try (FileChannel outChannel = FileChannel.open(tmpFilePath, StandardOpenOption.CREATE, StandardOpenOption.WRITE, StandardOpenOption.TRUNCATE_EXISTING)) { this.writeV3Header(outChannel); // position table placeholder (all zeros, filled in at the end) writeFullyAt(outChannel, ByteBuffer.allocate(V3_POS_TABLE_SIZE), V3_POS_TABLE_OFFSET); long dataOffset = V3_DATA_AREA_OFFSET; for (int bucketIndex = 0; bucketIndex < BUCKET_COUNT; bucketIndex++) { if (BufferedLinearRegionFile.this.isBucketDirty(bucketIndex)) { final BucketRecord record = this.buildBucketRecord(bucketIndex); if (record.payload() != null) { writeFullyAt(outChannel, ByteBuffer.wrap(record.payload()), dataOffset); newPositionTable[bucketIndex] = dataOffset; newRecordSizes[bucketIndex] = record.payload().length; dataOffset += record.payload().length; } // else: the bucket is empty now, its table entry stays 0 syncedBucketEpochs[bucketIndex] = record.epoch(); } else if (oldPositionTable != null && oldPositionTable[bucketIndex] != 0) { // not dirty: copy the record bytes straight from the old file final long oldOffset = oldPositionTable[bucketIndex]; final ByteBuffer lens = this.readRecordLengths(oldChannel, oldOffset); lens.getInt(); // skip originalLen final long recordSize = V3_RECORD_HEADER_SIZE + (long) lens.getInt(); transferFully(oldChannel, oldOffset, recordSize, outChannel, dataOffset); newPositionTable[bucketIndex] = dataOffset; newRecordSizes[bucketIndex] = recordSize; dataOffset += recordSize; } } // write the finalized position table writeFullyAt(outChannel, this.encodePositionTable(newPositionTable), V3_POS_TABLE_OFFSET); outChannel.force(true); newAppendOffset = dataOffset; } } atomicReplace(tmpFilePath, mainFile); // enter WAL mode: keep the freshly written master file open for appending syncs this.appendChannel = FileChannel.open(mainFile, StandardOpenOption.READ, StandardOpenOption.WRITE); this.positionTable = newPositionTable; this.recordSizes = newRecordSizes; this.appendOffset = newAppendOffset; this.markBucketsSynced(syncedBucketEpochs); } private void appendDirtyBuckets() throws IOException { final FileChannel channel = this.appendChannel; final long[] syncedBucketEpochs = new long[BUCKET_COUNT]; final long[] newPositionTable = this.positionTable.clone(); final long[] newRecordSizes = this.recordSizes.clone(); long dataOffset = this.appendOffset; boolean anyDirty = false; for (int bucketIndex = 0; bucketIndex < BUCKET_COUNT; bucketIndex++) { if (!BufferedLinearRegionFile.this.isBucketDirty(bucketIndex)) { continue; } final BucketRecord record = this.buildBucketRecord(bucketIndex); if (record.payload() != null) { writeFullyAt(channel, ByteBuffer.wrap(record.payload()), dataOffset); newPositionTable[bucketIndex] = dataOffset; newRecordSizes[bucketIndex] = record.payload().length; dataOffset += record.payload().length; } else { // the bucket is empty now newPositionTable[bucketIndex] = 0; newRecordSizes[bucketIndex] = 0; } syncedBucketEpochs[bucketIndex] = record.epoch(); anyDirty = true; } if (!anyDirty) { return; } // make the appended records durable before the position table may point at them channel.force(false); // commit the new tail first: even a torn position table write can then never // cause a later append to overwrite records the on-disk table already references this.appendOffset = dataOffset; writeFullyAt(channel, this.encodePositionTable(newPositionTable), V3_POS_TABLE_OFFSET); channel.force(true); this.positionTable = newPositionTable; this.recordSizes = newRecordSizes; this.markBucketsSynced(syncedBucketEpochs); } // snapshots one bucket under a short read lock (raw sector bytes only); // LZ4 decompression and zstd compression both run outside any lock so // writers are only blocked while the raw bytes are copied private @NotNull BucketRecord buildBucketRecord(int bucketIndex) throws IOException { final int baseChunkIndex = bucketIndex << BUCKET_SHIFT; final ByteBuffer[] rawSectors = new ByteBuffer[BUCKET_SIZE]; final long epoch; BufferedLinearRegionFile.this.regionObjectLock.readLock().lock(); try { // the epoch is taken before the data: writes completing afterwards bump // it further, so they simply get picked up by the next sync round epoch = BufferedLinearRegionFile.this.getBucketWriteEpoch(bucketIndex); for (int i = 0; i < BUCKET_SIZE; i++) { final Sector sector = BufferedLinearRegionFile.this.sectors[baseChunkIndex + i]; rawSectors[i] = sector.hasData() ? sector.read(BufferedLinearRegionFile.this.swapFileChannel) : null; } } finally { BufferedLinearRegionFile.this.regionObjectLock.readLock().unlock(); } final ByteArrayOutputStream rawBuf = new ByteArrayOutputStream(); final DataOutputStream rawOut = new DataOutputStream(rawBuf); boolean hasAny = false; for (int i = 0; i < BUCKET_SIZE; i++) { final ByteBuffer rawSector = rawSectors[i]; // note: null -> no data contained if (rawSector == null) { rawOut.writeInt(0); continue; } final ByteBuffer chunkData = BufferedLinearRegionFile.this.compressingOps.decompress(rawSector); final byte[] arr = new byte[chunkData.remaining()]; chunkData.get(arr); rawOut.writeInt(arr.length); rawOut.write(arr); hasAny = true; } rawOut.flush(); if (!hasAny) { return new BucketRecord(epoch, null); } final byte[] raw = rawBuf.toByteArray(); final byte[] compressed = Zstd.compress(raw, BufferedLinearRegionFile.this.compressionLevel); final ByteBuffer payload = ByteBuffer.allocate(V3_RECORD_HEADER_SIZE + compressed.length); payload.putInt(raw.length); // original (uncompressed) length payload.putInt(compressed.length); // compressed length payload.put(compressed); return new BucketRecord(epoch, payload.array()); } private void markBucketsSynced(long[] syncedBucketEpochs) { for (int i = 0; i < syncedBucketEpochs.length; i++) { // note: a dirty bucket always has a write epoch >= 1, so 0 = untouched if (syncedBucketEpochs[i] != 0L) { BufferedLinearRegionFile.this.markBucketSynced(i, syncedBucketEpochs[i]); } } } // opens the master file for reading if it exists and is a valid V3 bucketed file, else null private @Nullable FileChannel openV3MasterFile(@NotNull Path mainFile) throws IOException { if (!Files.exists(mainFile)) { return null; } final FileChannel channel = FileChannel.open(mainFile, StandardOpenOption.READ); try { if (channel.size() >= V3_DATA_AREA_OFFSET) { final ByteBuffer header = ByteBuffer.allocate(V3_HEADER_SIZE); readFullyAt(channel, header, 0); header.flip(); if (header.getLong() == MASTER_FILE_SUPER_BLOCK && header.get() == MASTER_FILE_VERSION_BUCKET) { return channel; } } } catch (Throwable e) { try { channel.close(); } catch (IOException e2) { e.addSuppressed(e2); } throw e; } channel.close(); return null; } private void writeV3Header(@NotNull FileChannel channel) throws IOException { final ByteBuffer header = ByteBuffer.allocate(V3_HEADER_SIZE); header.putLong(MASTER_FILE_SUPER_BLOCK); header.put(MASTER_FILE_VERSION_BUCKET); header.put(BufferedLinearRegionFile.this.compressionLevel); header.putInt(BufferedLinearRegionFile.this.xxHash32Seed); header.flip(); writeFullyAt(channel, header, 0); } private @NotNull ByteBuffer encodePositionTable(long[] table) { final ByteBuffer buf = ByteBuffer.allocate(V3_POS_TABLE_SIZE); for (final long pos : table) { buf.putLong(pos); } return buf.flip(); } private @NotNull ByteBuffer readRecordLengths(@NotNull FileChannel channel, long recordOffset) throws IOException { final ByteBuffer lens = ByteBuffer.allocate(V3_RECORD_HEADER_SIZE); readFullyAt(channel, lens, recordOffset); return lens.flip(); } public void close() throws IOException { this.masterFileLock.writeLock().lock(); try { if (this.appendChannel != null) { this.appendChannel.close(); this.appendChannel = null; } } finally { this.masterFileLock.writeLock().unlock(); } } private void loadBucketsFor(@NotNull Path file, int bucketIndex) throws IOException { final int beginChunkIndex = bucketIndex << BUCKET_SHIFT; this.masterFileLock.readLock().lock(); try { final ByteBuffer decompressed; if (this.appendChannel != null) { // WAL mode: reuse the always-open channel and the cached position table decompressed = this.readBucketData(this.appendChannel, this.positionTable[bucketIndex]); } else { if (!Files.exists(file)) { return; } try (FileChannel channel = FileChannel.open(file, StandardOpenOption.READ)) { if (channel.size() < V3_DATA_AREA_OFFSET) { return; } this.checkV3Header(channel); decompressed = this.readBucketData(channel, this.parseOffsetTable(channel)[bucketIndex]); } } if (decompressed != null) { this.loadChunksFromBucketData(decompressed, beginChunkIndex); } } finally { this.masterFileLock.readLock().unlock(); } } private void checkV3Header(@NotNull FileChannel channel) throws IOException { final ByteBuffer headerBuf = ByteBuffer.allocate(V3_HEADER_SIZE); readFullyAt(channel, headerBuf, 0); headerBuf.flip(); final long superblock = headerBuf.getLong(); if (superblock != MASTER_FILE_SUPER_BLOCK) throw new IOException("Invalid superblock " + superblock + "!"); final byte version = headerBuf.get(); if (version != MASTER_FILE_VERSION_BUCKET) throw new IOException("Unknown version: " + version); // compressionLevel and hashSeed are not used here } // reads and decompresses one bucket record; null when the table entry is empty private @Nullable ByteBuffer readBucketData(@NotNull FileChannel channel, long recordOffset) throws IOException { if (recordOffset == 0) { return null; } final ByteBuffer lens = this.readRecordLengths(channel, recordOffset); final int originalLen = lens.getInt(); final int compressedLen = lens.getInt(); final byte[] compressedData = new byte[compressedLen]; readFullyAt(channel, ByteBuffer.wrap(compressedData), recordOffset + V3_RECORD_HEADER_SIZE); return ByteBuffer.wrap(Zstd.decompress(compressedData, originalLen)); } private long @NonNull [] parseOffsetTable(FileChannel channel) throws IOException { final ByteBuffer buf = ByteBuffer.allocate(V3_POS_TABLE_SIZE); readFullyAt(channel, buf, V3_POS_TABLE_OFFSET); buf.flip(); final long[] table = new long[BUCKET_COUNT]; for (int i = 0; i < BUCKET_COUNT; i++) { table[i] = buf.getLong(); } return table; } private void loadChunksFromBucketData(ByteBuffer decompressed, int beginChunkIndex) throws IOException { for (int chunkIndex = beginChunkIndex; chunkIndex < beginChunkIndex + BUCKET_SIZE; chunkIndex++) { final int chunkSectionDataSize = decompressed.getInt(); if (chunkSectionDataSize <= 0) continue; final byte[] chunkSectionData = new byte[chunkSectionDataSize]; decompressed.get(chunkSectionData); BufferedLinearRegionFile.this.writeChunkDataRaw(chunkIndex, ByteBuffer.wrap(chunkSectionData), true); } } private void parseLinearV2(@NonNull DataInputStream ioStream, Path file) throws IOException { try (ioStream) { ioStream.readLong(); // Skip newestTimestamp (Long) byte gridSize = ioStream.readByte(); if (gridSize != 1 && gridSize != 2 && gridSize != 4 && gridSize != 8 && gridSize != 16 && gridSize != 32) throw new RuntimeException("Invalid grid size: " + gridSize + " file " + file); int bucketSize = 32 / gridSize; ioStream.readInt(); // Skip region_x (Int) ioStream.readInt(); // Skip region_z (Int) ioStream.skipBytes(128); // Skip existence bitmap // Skip NBT features while (true) { byte featureNameLength = ioStream.readByte(); if (featureNameLength == 0) break; byte[] featureNameBytes = new byte[featureNameLength]; ioStream.readFully(featureNameBytes); ioStream.readInt(); // featureValue } // Read bucket metadata int totalBuckets = gridSize * gridSize; int[] bucketSizes = new int[totalBuckets]; byte[] bucketCompressionLevels = new byte[totalBuckets]; long[] bucketHashes = new long[totalBuckets]; for (int i = 0; i < totalBuckets; i++) { bucketSizes[i] = ioStream.readInt(); bucketCompressionLevels[i] = ioStream.readByte(); bucketHashes[i] = ioStream.readLong(); } // Read and decompress each bucket, load chunks into swap for (int bx = 0; bx < gridSize; bx++) { for (int bz = 0; bz < gridSize; bz++) { int bucketIdx = bx * gridSize + bz; if (bucketSizes[bucketIdx] <= 0) continue; byte[] compressedBucket = new byte[bucketSizes[bucketIdx]]; ioStream.readFully(compressedBucket); long rawHash = LongHashFunction.xx().hashBytes(compressedBucket); if (rawHash != bucketHashes[bucketIdx]) { throw new IOException("Region file hash incorrect for bucket " + bucketIdx + " in " + file); } ByteArrayInputStream bucketByteStream = new ByteArrayInputStream(compressedBucket); ZstdInputStream zstdStream = new ZstdInputStream(bucketByteStream); ByteBuffer bucketBuffer = ByteBuffer.wrap(zstdStream.readAllBytes()); zstdStream.close(); for (int cx = 0; cx < bucketSize; cx++) { for (int cz = 0; cz < bucketSize; cz++) { int chunkX = bx * bucketSize + cx; int chunkZ = bz * bucketSize + cz; int chunkIndex = chunkX + chunkZ * 32; int chunkSize = bucketBuffer.getInt(); long timestamp = bucketBuffer.getLong(); if (chunkSize > 0) { // chunkSize includes the 8 bytes of timestamp already written int dataLen = chunkSize - 8; byte[] chunkData = new byte[dataLen]; bucketBuffer.get(chunkData); // Mark bucket as loaded. writeChunk() bumps the bucket epoch so it gets synced to the new master format. BufferedLinearRegionFile.this.markBucketLoaded(chunkIndex); // Use writeChunk to go through the full path (adds length + timestamp + xxhash header) BufferedLinearRegionFile.this.writeChunk(chunkX, chunkZ, ByteBuffer.wrap(chunkData)); } } } } } // Footer validation long footerSuperBlock = ioStream.readLong(); if (footerSuperBlock != LINEAR_FILE_SUPER_BLOCK) { throw new IOException("Footer superblock invalid " + file); } } } private boolean tryParseBlinearV2(@NotNull DataInputStream ioStream, Path file) throws IOException { final byte version = ioStream.readByte(); // we will parse dynamically (V3) if (version == MASTER_FILE_VERSION_BUCKET) { ioStream.close(); return false; } if (version != MASTER_FILE_VERSION) throw new RuntimeException("Invalid version: " + version + " in " + file); // Skip newestTimestamp (Long) + Compression level (Byte): Unused. ioStream.skipBytes(9); try (final ZstdInputStream decompressStream = new ZstdInputStream(ioStream)) { // only used as a helper stream // the parent stream will be closed in the try-catch block upper final DataInputStream decompressedStreamHelper = new DataInputStream(decompressStream); for (int index = 0; index < 1024; index++) { int size = decompressedStreamHelper.readInt(); // len if (size > 0) { byte[] sectorData = new byte[size]; decompressedStreamHelper.readFully(sectorData, 0, size); // data final ByteBuffer sectorDataNioBuffer = ByteBuffer.wrap(sectorData); BufferedLinearRegionFile.this.markBucketLoaded(index); BufferedLinearRegionFile.this.writeChunkDataRaw(index, sectorDataNioBuffer, false); } } } return true; } @Contract(value = "_ -> new", pure = true) public static int @NotNull [] coordinatesFromIndex(int chunkIndex) { int x = chunkIndex & 31; int z = (chunkIndex >> 5) & 31; return new int[]{x, z}; } private void parseLinearV1(@NotNull DataInputStream ioStream) throws IOException { // Skip newestTimestamp (Long) + Compression level (Byte) + Chunk count (Short): Unused. ioStream.skipBytes(11); // Skip chunk data len(Int)(Unused). ioStream.skipBytes(4); // Skip data hash (Long): Unused. ioStream.skipBytes(8); try (final ZstdInputStream decompressedStream = new ZstdInputStream(ioStream)) { // only used as a helper stream // the parent stream will be closed in the try-catch block upper final DataInputStream bufferHelper = new DataInputStream(decompressedStream); final int[] chunkStarts = new int[1024]; for (int i = 0; i < 1024; i++) { chunkStarts[i] = bufferHelper.readInt(); bufferHelper.skipBytes(4); // Skip timestamps (Int): Unused. } for (int i = 0; i < 1024; i++) { if (chunkStarts[i] > 0) { int size = chunkStarts[i]; byte[] chunkData = new byte[size]; bufferHelper.readFully(chunkData); final ByteBuffer chunkDataNioBuffer = ByteBuffer.wrap(chunkData); final int[] posByAxis = coordinatesFromIndex(i); final int x = posByAxis[0]; final int z = posByAxis[1]; BufferedLinearRegionFile.this.markBucketLoaded(i); BufferedLinearRegionFile.this.writeChunk(x, z, chunkDataNioBuffer); } } } } // won't and need not to hold any region locks as we are calling this in a safe point (initially newed) public void tryParseMainFileOld(@NotNull Path mainFilePath) throws IOException { final File file = mainFilePath.toFile(); if (!file.exists() || !file.canRead()) { return; } // those streams will be closed in the parse logic, or we will close it manually final FileInputStream fileStream = new FileInputStream(file); final DataInputStream rawDataStream = new DataInputStream(fileStream); boolean oldParsed = false; final long superBlock; try { superBlock = rawDataStream.readLong(); if (superBlock == MASTER_FILE_SUPER_BLOCK) { oldParsed = this.tryParseBlinearV2(rawDataStream, mainFilePath); // false -> v3 -> closed in parse block if (!oldParsed) { return; } } if (superBlock == LINEAR_FILE_SUPER_BLOCK) { final byte version = rawDataStream.readByte(); if (version == 1 || version == 2) { this.parseLinearV1(rawDataStream); oldParsed = true; } if (version == 3) { this.parseLinearV2(rawDataStream, mainFilePath); oldParsed = true; } } } catch (Throwable ex) { try { rawDataStream.close(); } catch (IOException ex2) { ex.addSuppressed(ex2); } throw new IOException("Failed to parse master file: " + mainFilePath, ex); } // old parsed, remove the original file, and we will recreate it as we sync if (oldParsed) { // immediately do sync operation BufferedLinearRegionFile.this.syncToMasterFile(); return; } // anyone non-matched, close stream and throw the error rawDataStream.close(); throw new IOException("Unknown or unsupported super block : " + superBlock); } } }