Merge branch 'feature/poi-unloading-v0' into ver/1.21.1

Author: ishland

c2me-rewrites-chunk-system/src/main/java/com/ishland/c2me/rewrites/chunksystem/common/Config.java

@@ -20,6 +20,20 @@ public class Config {
                      """)
             .getBoolean(false, false);
 
+    public static final boolean allowPOIUnloading = new ConfigSystem.ConfigAccessor()
+            .key("chunkSystem.allowPOIUnloading")
+            .comment("""
+                    Whether to allow POIs (Point of Interest) to be unloaded
+                    Unloaded POIs are reloaded on-demand or when the corresponding chunks are loaded again,
+                    which should not cause any behavior change
+                    \s
+                    Note:
+                    Vanilla never unloads POIs when chunks unload, causing small memory leaks
+                    These leaks adds up and eventually cause issues after generating millions of chunks
+                    in a single world instance
+                    """)
+            .getBoolean(true, false);
+
     public static void init() {
         // intentionally empty
     }

c2me-rewrites-chunk-system/src/main/java/com/ishland/c2me/rewrites/chunksystem/common/ducks/IPOIUnloading.java

@@ -0,0 +1,13 @@
+package com.ishland.c2me.rewrites.chunksystem.common.ducks;
+
+import net.minecraft.util.math.ChunkPos;
+
+public interface IPOIUnloading {
+
+    void c2me$unloadPoi(ChunkPos pos);
+
+    default boolean c2me$shouldUnloadPoi(ChunkPos pos) {
+        return false;
+    }
+
+}

c2me-rewrites-chunk-system/src/main/java/com/ishland/c2me/rewrites/chunksystem/common/statuses/ReadFromDisk.java

@@ -10,6 +10,7 @@
 import com.ishland.c2me.rewrites.chunksystem.common.ChunkState;
 import com.ishland.c2me.rewrites.chunksystem.common.Config;
 import com.ishland.c2me.rewrites.chunksystem.common.NewChunkStatus;
+import com.ishland.c2me.rewrites.chunksystem.common.ducks.IPOIUnloading;
 import com.ishland.c2me.rewrites.chunksystem.common.fapi.LifecycleEventInvoker;
 import com.ishland.flowsched.scheduler.ItemHolder;
 import com.ishland.flowsched.scheduler.KeyStatusPair;
@@ -142,6 +143,8 @@ public CompletionStage<Void> downgradeFromThis(ChunkLoadingContext context) {
                 listener.setChunkStatus(context.holder().getKey(), null);
             }
 
+            ((IPOIUnloading) ((IThreadedAnvilChunkStorage) context.tacs()).getPointOfInterestStorage()).c2me$unloadPoi(context.holder().getKey());
+
             context.holder().getItem().set(new ChunkState(null, null, null));
         }, ((IThreadedAnvilChunkStorage) context.tacs()).getMainThreadExecutor());
     }

c2me-rewrites-chunk-system/src/main/java/com/ishland/c2me/rewrites/chunksystem/common/statuses/ReadFromDiskAsync.java

@@ -18,6 +18,7 @@
 import com.ishland.c2me.rewrites.chunksystem.common.async_chunkio.ChunkIoMainThreadTaskUtils;
 import com.ishland.c2me.rewrites.chunksystem.common.async_chunkio.ProtoChunkExtension;
 import com.ishland.c2me.rewrites.chunksystem.common.async_chunkio.SerializingRegionBasedStorageExtension;
+import com.ishland.c2me.rewrites.chunksystem.common.ducks.IPOIUnloading;
 import com.ishland.c2me.rewrites.chunksystem.common.fapi.LifecycleEventInvoker;
 import com.ishland.flowsched.scheduler.ItemHolder;
 import com.ishland.flowsched.scheduler.KeyStatusPair;
@@ -167,6 +168,8 @@ public CompletionStage<Void> downgradeFromThis(ChunkLoadingContext context) {
                     ((IThreadedAnvilChunkStorage) context.tacs()).getWorldGenerationProgressListener().setChunkStatus(chunk.getPos(), null);
                     ((IThreadedAnvilChunkStorage) context.tacs()).getChunkToNextSaveTimeMs().remove(chunk.getPos().toLong());
 
+                    ((IPOIUnloading) ((IThreadedAnvilChunkStorage) context.tacs()).getPointOfInterestStorage()).c2me$unloadPoi(context.holder().getKey());
+
                     context.holder().getItem().set(new ChunkState(null, null, null));
                 }, ((IThreadedAnvilChunkStorage) context.tacs()).getMainThreadExecutor());
     }

c2me-rewrites-chunk-system/src/main/java/com/ishland/c2me/rewrites/chunksystem/mixin/MixinPointOfInterestStorage.java

@@ -0,0 +1,20 @@
+package com.ishland.c2me.rewrites.chunksystem.mixin;
+
+import com.ishland.c2me.rewrites.chunksystem.common.ducks.IPOIUnloading;
+import it.unimi.dsi.fastutil.longs.LongSet;
+import net.minecraft.util.math.ChunkPos;
+import net.minecraft.world.poi.PointOfInterestStorage;
+import org.spongepowered.asm.mixin.Final;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.Shadow;
+
+@Mixin(PointOfInterestStorage.class)
+public abstract class MixinPointOfInterestStorage implements IPOIUnloading {
+
+    @Shadow @Final private LongSet preloadedChunks;
+
+    @Override
+    public boolean c2me$shouldUnloadPoi(ChunkPos pos) {
+        return !this.preloadedChunks.contains(pos.toLong());
+    }
+}

c2me-rewrites-chunk-system/src/main/java/com/ishland/c2me/rewrites/chunksystem/mixin/MixinSerializingRegionBasedStorage.java

@@ -0,0 +1,39 @@
+package com.ishland.c2me.rewrites.chunksystem.mixin;
+
+import com.ishland.c2me.rewrites.chunksystem.common.Config;
+import com.ishland.c2me.rewrites.chunksystem.common.ducks.IPOIUnloading;
+import it.unimi.dsi.fastutil.longs.Long2ObjectMap;
+import net.minecraft.util.math.ChunkPos;
+import net.minecraft.util.math.ChunkSectionPos;
+import net.minecraft.world.HeightLimitView;
+import net.minecraft.world.storage.SerializingRegionBasedStorage;
+import org.spongepowered.asm.mixin.Final;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.Shadow;
+
+import java.util.Optional;
+
+@Mixin(SerializingRegionBasedStorage.class)
+public abstract class MixinSerializingRegionBasedStorage<R> implements IPOIUnloading {
+
+    @Shadow protected abstract void save(ChunkPos pos);
+
+    @Shadow @Final protected HeightLimitView world;
+
+    @Shadow @Final private Long2ObjectMap<Optional<R>> loadedElements;
+
+    @Override
+    public void c2me$unloadPoi(ChunkPos pos) {
+        if (!Config.allowPOIUnloading) return;
+
+        if (!this.c2me$shouldUnloadPoi(pos)) {
+            return;
+        }
+
+        this.save(pos);
+        for (int i = this.world.getBottomSectionCoord(); i < this.world.getTopSectionCoord(); i++) {
+            this.loadedElements.remove(ChunkSectionPos.asLong(pos.x, i, pos.z));
+        }
+    }
+
+}

c2me-rewrites-chunk-system/src/main/resources/c2me-rewrites-chunk-system.mixins.json

@@ -10,6 +10,8 @@
     "MixinChunkTicketManagerTicketDistanceLevelPropagator",
     "MixinMinecraftServer",
     "MixinNoiseChunkGenerator",
+    "MixinPointOfInterestStorage",
+    "MixinSerializingRegionBasedStorage",
     "MixinServerChunkManager",
     "MixinThreadedAnvilChunkStorage",
     "async_serialization.MixinBlender",