Experimental compressed memory cache

orebfuscator-common/src/main/java/net/imprex/orebfuscator/config/AdvancedConfig.java

@@ -2,15 +2,15 @@
 
 public interface AdvancedConfig {
 
-	int maxMillisecondsPerTick();
-
-	int obfuscationWorkerThreads();
+	int obfuscationThreads();
 
 	boolean hasObfuscationTimeout();
 
-	int obfuscationTimeout();
+	long obfuscationTimeout();
+
+	int maxMillisecondsPerTick();
 
-	int proximityHiderThreads();
+	int proximityThreads();
 
 	int proximityDefaultBucketSize();
 

orebfuscator-common/src/main/java/net/imprex/orebfuscator/config/CacheConfig.java

@@ -8,19 +8,19 @@ public interface CacheConfig {
 
 	boolean enabled();
 
+	int maximumSize();
+
+	long expireAfterAccess();
+
+	boolean enableDiskCache();
+
 	Path baseDirectory();
 
 	Path regionFile(ChunkPosition chunkPosition);
 
 	int maximumOpenRegionFiles();
 
 	long deleteRegionFilesAfterAccess();
-
-	boolean enableDiskCache();
-
-	int maximumSize();
-
-	long expireAfterAccess();
 
 	int maximumTaskQueueSize();
 }

orebfuscator-common/src/main/java/net/imprex/orebfuscator/util/JavaVersion.java

@@ -14,7 +14,7 @@ private static int javaMajorVersion() {
 
 	/**
 	 * taken from:
-	 * https://github.com/netty/netty/blob/4.1/common/src/main/java/io/netty/util/internal/PlatformDependent0.java#L1011
+	 * https://github.com/netty/netty/blob/7ad2b91515b3affaeadb4b2975cd6d2a8342c403/common/src/main/java/io/netty/util/internal/PlatformDependent0.java#L1037
 	 */
 	private static int majorVersion(final String javaSpecVersion) {
         final String[] components = javaSpecVersion.split("\\.");

orebfuscator-common/src/main/java/net/imprex/orebfuscator/util/WeightedIntRandom.java

@@ -16,7 +16,7 @@ public static Builder builder() {
     private final int weight;
 
     /**
-     * Flat int array where each entry has a value of one
+     * Flat int array where each entry has a probability of one
      *
      * @implNote use flat int array instead of treemap cause O(N*log(N)) is too
      * slow since this is the second hottest code path

orebfuscator-nms/orebfuscator-nms-v1_16_R1/src/main/java/net/imprex/orebfuscator/nms/v1_16_R1/RegionFileCache.java

@@ -24,7 +24,7 @@ public class RegionFileCache extends AbstractRegionFileCache<RegionFile> {
 	@Override
 	protected RegionFile createRegionFile(Path path) throws IOException {
 		boolean isSyncChunkWrites = ((CraftServer) Bukkit.getServer()).getServer().isSyncChunkWrites();
-		return new RegionFile(path, path.getParent(), RegionFileCompression.b, isSyncChunkWrites);
+		return new RegionFile(path, path.getParent(), RegionFileCompression.c, isSyncChunkWrites);
 	}
 
 	@Override

orebfuscator-nms/orebfuscator-nms-v1_16_R2/src/main/java/net/imprex/orebfuscator/nms/v1_16_R2/RegionFileCache.java

@@ -24,7 +24,7 @@ public class RegionFileCache extends AbstractRegionFileCache<RegionFile> {
 	@Override
 	protected RegionFile createRegionFile(Path path) throws IOException {
 		boolean isSyncChunkWrites = ((CraftServer) Bukkit.getServer()).getServer().isSyncChunkWrites();
-		return new RegionFile(path, path.getParent(), RegionFileCompression.b, isSyncChunkWrites);
+		return new RegionFile(path, path.getParent(), RegionFileCompression.c, isSyncChunkWrites);
 	}
 
 	@Override

orebfuscator-nms/orebfuscator-nms-v1_16_R3/src/main/java/net/imprex/orebfuscator/nms/v1_16_R3/RegionFileCache.java

@@ -24,7 +24,7 @@ public class RegionFileCache extends AbstractRegionFileCache<RegionFile> {
 	@Override
 	protected RegionFile createRegionFile(Path path) throws IOException {
 		boolean isSyncChunkWrites = ((CraftServer) Bukkit.getServer()).getServer().isSyncChunkWrites();
-		return new RegionFile(path, path.getParent(), RegionFileCompression.b, isSyncChunkWrites);
+		return new RegionFile(path, path.getParent(), RegionFileCompression.c, isSyncChunkWrites);
 	}
 
 	@Override

orebfuscator-nms/orebfuscator-nms-v1_17_R1/src/main/java/net/imprex/orebfuscator/nms/v1_17_R1/RegionFileCache.java

@@ -24,7 +24,7 @@ public class RegionFileCache extends AbstractRegionFileCache<RegionFile> {
 	@Override
 	protected RegionFile createRegionFile(Path path) throws IOException {
 		boolean isSyncChunkWrites = ((CraftServer) Bukkit.getServer()).getServer().forceSynchronousWrites();
-		return new RegionFile(path, path.getParent(), RegionFileVersion.VERSION_DEFLATE, isSyncChunkWrites);
+		return new RegionFile(path, path.getParent(), RegionFileVersion.VERSION_NONE, isSyncChunkWrites);
 	}
 
 	@Override

orebfuscator-nms/orebfuscator-nms-v1_18_R1/src/main/java/net/imprex/orebfuscator/nms/v1_18_R1/RegionFileCache.java

@@ -24,7 +24,7 @@ public class RegionFileCache extends AbstractRegionFileCache<RegionFile> {
 	@Override
 	protected RegionFile createRegionFile(Path path) throws IOException {
 		boolean isSyncChunkWrites = ((CraftServer) Bukkit.getServer()).getServer().forceSynchronousWrites();
-		return new RegionFile(path, path.getParent(), RegionFileVersion.VERSION_DEFLATE, isSyncChunkWrites);
+		return new RegionFile(path, path.getParent(), RegionFileVersion.VERSION_NONE, isSyncChunkWrites);
 	}
 
 	@Override

orebfuscator-nms/orebfuscator-nms-v1_18_R2/src/main/java/net/imprex/orebfuscator/nms/v1_18_R2/RegionFileCache.java

@@ -24,7 +24,7 @@ public class RegionFileCache extends AbstractRegionFileCache<RegionFile> {
 	@Override
 	protected RegionFile createRegionFile(Path path) throws IOException {
 		boolean isSyncChunkWrites = ((CraftServer) Bukkit.getServer()).getServer().forceSynchronousWrites();
-		return new RegionFile(path, path.getParent(), RegionFileVersion.VERSION_DEFLATE, isSyncChunkWrites);
+		return new RegionFile(path, path.getParent(), RegionFileVersion.VERSION_NONE, isSyncChunkWrites);
 	}
 
 	@Override

orebfuscator-nms/orebfuscator-nms-v1_19_R1/src/main/java/net/imprex/orebfuscator/nms/v1_19_R1/RegionFileCache.java

@@ -24,7 +24,7 @@ public class RegionFileCache extends AbstractRegionFileCache<RegionFile> {
 	@Override
 	protected RegionFile createRegionFile(Path path) throws IOException {
 		boolean isSyncChunkWrites = ((CraftServer) Bukkit.getServer()).getServer().forceSynchronousWrites();
-		return new RegionFile(path, path.getParent(), RegionFileVersion.VERSION_DEFLATE, isSyncChunkWrites);
+		return new RegionFile(path, path.getParent(), RegionFileVersion.VERSION_NONE, isSyncChunkWrites);
 	}
 
 	@Override

orebfuscator-nms/orebfuscator-nms-v1_19_R2/src/main/java/net/imprex/orebfuscator/nms/v1_19_R2/RegionFileCache.java

@@ -24,7 +24,7 @@ public class RegionFileCache extends AbstractRegionFileCache<RegionFile> {
 	@Override
 	protected RegionFile createRegionFile(Path path) throws IOException {
 		boolean isSyncChunkWrites = ((CraftServer) Bukkit.getServer()).getServer().forceSynchronousWrites();
-		return new RegionFile(path, path.getParent(), RegionFileVersion.VERSION_DEFLATE, isSyncChunkWrites);
+		return new RegionFile(path, path.getParent(), RegionFileVersion.VERSION_NONE, isSyncChunkWrites);
 	}
 
 	@Override

orebfuscator-nms/orebfuscator-nms-v1_19_R3/src/main/java/net/imprex/orebfuscator/nms/v1_19_R3/RegionFileCache.java

@@ -24,7 +24,7 @@ public class RegionFileCache extends AbstractRegionFileCache<RegionFile> {
 	@Override
 	protected RegionFile createRegionFile(Path path) throws IOException {
 		boolean isSyncChunkWrites = ((CraftServer) Bukkit.getServer()).getServer().forceSynchronousWrites();
-		return new RegionFile(path, path.getParent(), RegionFileVersion.VERSION_DEFLATE, isSyncChunkWrites);
+		return new RegionFile(path, path.getParent(), RegionFileVersion.VERSION_NONE, isSyncChunkWrites);
 	}
 
 	@Override

orebfuscator-nms/orebfuscator-nms-v1_20_R1/src/main/java/net/imprex/orebfuscator/nms/v1_20_R1/RegionFileCache.java

@@ -24,7 +24,7 @@ public class RegionFileCache extends AbstractRegionFileCache<RegionFile> {
 	@Override
 	protected RegionFile createRegionFile(Path path) throws IOException {
 		boolean isSyncChunkWrites = ((CraftServer) Bukkit.getServer()).getServer().forceSynchronousWrites();
-		return new RegionFile(path, path.getParent(), RegionFileVersion.VERSION_DEFLATE, isSyncChunkWrites);
+		return new RegionFile(path, path.getParent(), RegionFileVersion.VERSION_NONE, isSyncChunkWrites);
 	}
 
 	@Override

orebfuscator-nms/orebfuscator-nms-v1_20_R2/src/main/java/net/imprex/orebfuscator/nms/v1_20_R2/RegionFileCache.java

@@ -24,7 +24,7 @@ public class RegionFileCache extends AbstractRegionFileCache<RegionFile> {
 	@Override
 	protected RegionFile createRegionFile(Path path) throws IOException {
 		boolean isSyncChunkWrites = ((CraftServer) Bukkit.getServer()).getServer().forceSynchronousWrites();
-		return new RegionFile(path, path.getParent(), RegionFileVersion.VERSION_DEFLATE, isSyncChunkWrites);
+		return new RegionFile(path, path.getParent(), RegionFileVersion.VERSION_NONE, isSyncChunkWrites);
 	}
 
 	@Override

orebfuscator-nms/orebfuscator-nms-v1_20_R3/src/main/java/net/imprex/orebfuscator/nms/v1_20_R3/RegionFileCache.java

@@ -24,7 +24,7 @@ public class RegionFileCache extends AbstractRegionFileCache<RegionFile> {
 	@Override
 	protected RegionFile createRegionFile(Path path) throws IOException {
 		boolean isSyncChunkWrites = ((CraftServer) Bukkit.getServer()).getServer().forceSynchronousWrites();
-		return new RegionFile(path, path.getParent(), RegionFileVersion.VERSION_DEFLATE, isSyncChunkWrites);
+		return new RegionFile(path, path.getParent(), RegionFileVersion.VERSION_NONE, isSyncChunkWrites);
 	}
 
 	@Override

orebfuscator-nms/orebfuscator-nms-v1_20_R4/src/main/java/net/imprex/orebfuscator/nms/v1_20_R4/RegionFileCache.java

@@ -24,7 +24,7 @@ public class RegionFileCache extends AbstractRegionFileCache<RegionFile> {
 	@Override
 	protected RegionFile createRegionFile(Path path) throws IOException {
 		boolean isSyncChunkWrites = ((CraftServer) Bukkit.getServer()).getServer().forceSynchronousWrites();
-		return new RegionFile(null, path, path.getParent(), RegionFileVersion.VERSION_DEFLATE, isSyncChunkWrites);
+		return new RegionFile(null, path, path.getParent(), RegionFileVersion.VERSION_NONE, isSyncChunkWrites);
 	}
 
 	@Override

orebfuscator-nms/orebfuscator-nms-v1_21_R1/src/main/java/net/imprex/orebfuscator/nms/v1_21_R1/RegionFileCache.java

@@ -24,7 +24,7 @@ public class RegionFileCache extends AbstractRegionFileCache<RegionFile> {
 	@Override
 	protected RegionFile createRegionFile(Path path) throws IOException {
 		boolean isSyncChunkWrites = ((CraftServer) Bukkit.getServer()).getServer().forceSynchronousWrites();
-		return new RegionFile(null, path, path.getParent(), RegionFileVersion.VERSION_DEFLATE, isSyncChunkWrites);
+		return new RegionFile(null, path, path.getParent(), RegionFileVersion.VERSION_NONE, isSyncChunkWrites);
 	}
 
 	@Override

orebfuscator-plugin/pom.xml

@@ -26,6 +26,12 @@
 				<configuration>
 					<minimizeJar>true</minimizeJar>
 					<filters>
+						<filter>
+							<artifact>*:lz4-java</artifact>
+							<includes>
+								<include>**</include>
+							</includes>
+						</filter>
 						<filter>
 							<artifact>*:*</artifact>
 							<excludeDefaults>false</excludeDefaults>
@@ -43,6 +49,10 @@
 							<pattern>org.joml</pattern>
 							<shadedPattern>net.imprex.shaded.org.joml</shadedPattern>
 						</relocation>
+						<relocation>
+							<pattern>net.jpountz</pattern>
+							<shadedPattern>net.imprex.shaded.net.jpountz</shadedPattern>
+						</relocation>
 					</relocations>
 				</configuration>
 			</plugin>
@@ -85,6 +95,12 @@
 			<version>${dependency.bstats.version}</version>
 			<scope>compile</scope>
 		</dependency>
+		<dependency>
+			<groupId>org.lz4</groupId>
+			<artifactId>lz4-java</artifactId>
+			<version>${dependency.lz4.version}</version>
+			<scope>compile</scope>
+		</dependency>
 
 		<!-- Orebfuscator -->
 		<dependency>

orebfuscator-plugin/src/main/java/net/imprex/orebfuscator/Orebfuscator.java

@@ -27,6 +27,7 @@ public class Orebfuscator extends JavaPlugin implements Listener {
 
 	private final Thread mainThread = Thread.currentThread();
 
+	private OrebfuscatorStatistics statistics;
 	private OrebfuscatorConfig config;
 	private OrebfuscatorPlayerMap playerMap;
 	private UpdateSystem updateSystem;
@@ -54,6 +55,8 @@ public void onEnable() {
 				throw new RuntimeException("ProtocolLib can't be found or is disabled! Orebfuscator can't be enabled.");
 			}
 
+			this.statistics = new OrebfuscatorStatistics();
+
 			// Load configurations
 			this.config = new OrebfuscatorConfig(this);
 
@@ -138,6 +141,10 @@ public boolean isGameThread() {
 		return Thread.currentThread() == this.mainThread;
 	}
 
+	public OrebfuscatorStatistics getStatistics() {
+		return statistics;
+	}
+
 	public OrebfuscatorConfig getOrebfuscatorConfig() {
 		return this.config;
 	}

orebfuscator-plugin/src/main/java/net/imprex/orebfuscator/OrebfuscatorCommand.java

@@ -62,6 +62,7 @@ public boolean onCommand(CommandSender sender, Command command, String label, St
 
 		if (args.length == 0) {
 			sender.sendMessage("You are using " + this.orebfuscator.toString());
+			sender.sendMessage(this.orebfuscator.getStatistics().toString());
 		} else if (args[0].equalsIgnoreCase("dump")) {
 			TemporalAccessor now = OffsetDateTime.now(ZoneOffset.UTC);
 
@@ -77,6 +78,8 @@ public boolean onCommand(CommandSender sender, Command command, String label, St
 			versions.addProperty("orebfuscator", orebfuscator.toString());
 			root.add("versions", versions);
 
+			root.add("statistics", orebfuscator.getStatistics().toJson());
+
 			JsonObject plugins = new JsonObject();
 			for (Plugin bukkitPlugin : Bukkit.getPluginManager().getPlugins()) {
 				PluginDescriptionFile description = bukkitPlugin.getDescription();

orebfuscator-plugin/src/main/java/net/imprex/orebfuscator/OrebfuscatorStatistics.java

@@ -0,0 +1,94 @@
+package net.imprex.orebfuscator;
+
+import java.util.Objects;
+import java.util.concurrent.atomic.AtomicLong;
+import java.util.function.IntSupplier;
+
+import com.google.gson.JsonObject;
+
+public class OrebfuscatorStatistics {
+
+	private static String formatPrecent(double percent) {
+		return String.format("%.2f%%", percent * 100);
+	}
+
+	private static String formatBytes(long bytes) {
+		if (bytes > 1073741824L) {
+			return String.format("%.1f GiB", bytes / 1073741824d);
+		} else if (bytes > 1048576L) {
+			return String.format("%.1f MiB", bytes / 1048576d);
+		} else if (bytes > 1024L) {
+			return String.format("%.1f KiB", bytes / 1024d);
+		} else {
+			return String.format("%d B", bytes);
+		}
+	}
+
+	private final AtomicLong cacheHitCountMemory = new AtomicLong(0);
+	private final AtomicLong cacheHitCountDisk = new AtomicLong(0);
+	private final AtomicLong cacheMissCount = new AtomicLong(0);
+	private final AtomicLong cacheEstimatedSize = new AtomicLong(0);
+	private IntSupplier diskCacheQueueLength = () -> 0;
+	private IntSupplier obfuscationQueueLength = () -> 0;
+
+	public void onCacheHitMemory() {
+		this.cacheHitCountMemory.incrementAndGet();
+	}
+
+	public void onCacheHitDisk() {
+		this.cacheHitCountDisk.incrementAndGet();
+	}
+
+	public void onCacheMiss() {
+		this.cacheMissCount.incrementAndGet();
+	}
+
+	public void onCacheSizeChange(int delta) {
+		this.cacheEstimatedSize.addAndGet(delta);
+	}
+
+	public void setDiskCacheQueueLengthSupplier(IntSupplier supplier) {
+		this.diskCacheQueueLength = Objects.requireNonNull(supplier);
+	}
+
+	public void setObfuscationQueueLengthSupplier(IntSupplier supplier) {
+		this.obfuscationQueueLength = Objects.requireNonNull(supplier);
+	}
+
+	@Override
+	public String toString() {
+		long cacheHitCountMemory = this.cacheHitCountMemory.get();
+		long cacheHitCountDisk = this.cacheHitCountDisk.get();
+		long cacheMissCount = this.cacheMissCount.get();
+		long cacheEstimatedSize = this.cacheEstimatedSize.get();
+		long diskCacheQueueLength = this.diskCacheQueueLength.getAsInt();
+		long obfuscationQueueLength = this.obfuscationQueueLength.getAsInt();
+
+		double totalCacheRequest = (double) (cacheHitCountMemory + cacheHitCountDisk + cacheMissCount);
+		double memoryCacheHitRate = (double) cacheHitCountMemory / totalCacheRequest;
+		double diskCacheHitRate = (double) cacheHitCountDisk / totalCacheRequest;
+
+		StringBuilder builder = new StringBuilder("Here are some useful statistics:\n");
+
+		builder.append(" - memoryCacheHitRate: ").append(formatPrecent(memoryCacheHitRate)).append('\n');
+		builder.append(" - diskCacheHitRate: ").append(formatPrecent(diskCacheHitRate)).append('\n');
+		builder.append(" - memoryCacheEstimatedSize: ").append(formatBytes(cacheEstimatedSize)).append('\n');
+		builder.append(" - diskCacheQueueLength: ").append(diskCacheQueueLength).append('\n');
+		builder.append(" - obfuscationQueueLength: ").append(obfuscationQueueLength).append('\n');
+
+		return builder.toString();
+	}
+
+	public JsonObject toJson() {
+		JsonObject object = new JsonObject();
+
+		object.addProperty("cacheHitCountMemory", this.cacheHitCountMemory.get());
+		object.addProperty("cacheHitCountDisk", this.cacheHitCountDisk.get());
+		object.addProperty("cacheMissCount", this.cacheMissCount.get());
+		object.addProperty("cacheEstimatedSize", this.cacheEstimatedSize.get());
+		object.addProperty("diskCacheQueueLength", this.diskCacheQueueLength.getAsInt());
+		object.addProperty("obfuscationQueueLength", this.obfuscationQueueLength.getAsInt());
+
+		return object;
+	}
+}