Merge pull request #371 from jchung01/memory-leaks

Fix memory leaks for CB Multipart, MrTJPCore, Thaumic Wonders

Author: ACGaming

README.md

@@ -208,30 +208,34 @@ All changes are toggleable via config files.
 ### **⚙️ MOD INTEGRATION**
 
 * **AbyssalCraft**
-    * **Optimized Item Transport:** Makes an optimization to reduce tick overhead of AbyssalCraft's item transport system
+    * **Optimized Item Transport:** Optimizes AbyssalCraft's item transport system to reduce tick overhead
 * **Actually Additions**
     * **Duplication Fixes:** Fixes various duplication exploits
 * **Advent of Ascension**
-    * **Inventory-less GUI Compatibility:** Fixes AoA player ticking in certain GUIs without player inventories (i.e. Flux Networks GUI)
+    * **Inventory-less GUI Compatibility:** Fixes AoA player ticking in certain GUIs without player inventories (i.e. Flux Networks, Nuclearcraft)
 * **Arcane Archives**
     * **Duplication Fixes:** Fixes various duplication exploits
-* **Blood Magic**
-    * **Duplication Fixes:** Fixes various duplication exploits
-    * **Optimized Hellfire Forge:** Optimizes the Hellfire/Soul Forge to reduce tick time
-    * **World Unload Memory Leak Fix:** Fixes memory leak related to unloading worlds/switching dimensions
 * **Binnie's Mods**
     * **Gather Windfall:** Allows Forestry farms to pick up ExtraTrees fruit
 * **Biomes O' Plenty**
     * **Hot Spring Water:** Fixes rapid inflection of regeneration effects in hot spring water
+* **Blood Magic**
+    * **Duplication Fixes:** Fixes various duplication exploits
+    * **Optimized Hellfire Forge:** Optimizes the Hellfire/Soul Forge to reduce tick time
+    * **World Unload Memory Leak Fix:** Fixes memory leak when unloading worlds/switching dimensions
 * **Botania**
     * **Duplication Fixes:** Fixes various duplication exploits
     * **Fancy Skybox:** Enables the Botania Garden of Glass skybox for custom dimensions
+* **CB Multipart**
+  * **Memory Leak Fix:** Fixes a memory leak associated with EntityPlayer
 * **Chisel**
     * **Duplication Fixes:** Fixes various duplication exploits
-* **CoFH Core**
-    * **Vorpal Enchantment Damage:** Sets the damage multiplier of the Vorpal enchantment
 * **Chocolate Quest Repoured**
     * **Legacy Golden Feather:** Restores the golden feather behavior from the original Better Dungeons mod
+* **CoFH Core**
+    * **Vorpal Enchantment Damage:** Sets the damage multiplier of the Vorpal enchantment
+* **Compact Machines**
+    * **Invisible Wall Render Fix:** Fixes some compact machine walls being invisible if [Nothirium](https://www.curseforge.com/minecraft/mc-mods/nothirium) 0.2.x (and up) or [Vintagium](https://github.com/Asek3/sodium-1.12) is installed
 * **Elementary Staffs**
     * **Electric Staff Port:** Reintroduces the 1.5 electric staff behavior along with some subtle particles
 * **Elenai Dodge 2**
@@ -262,18 +266,20 @@ All changes are toggleable via config files.
     * **Duplication Fixes:** Fixes various duplication exploits
 * **Mob Stages**
     * **Spawning Rules Fixes:** Fixes mob replacement ignoring entity spawning rules
+* **MrTJPCore**
+    * **Memory Leak Fix:** Fixes a memory leak associated with EntityPlayer
 * **Nether Chest**
     * **Duplication Fixes:** Fixes various duplication exploits
 * **Netherrocks**
     * **Right Click Harvesting Fix:** Prevents crashing with mods implementing right click crop harvesting
 * **NuclearCraft**
-    * **Radiation Environment Map:** Changes the data table of the radiation environment handler to improve performance
+    * **Radiation Environment Map:** Changes the data table of the radiation environment handler to improve tick time
 * **ProjectRed**
     * **Duplication Fixes:** Fixes various duplication exploits
 * **Quark**
     * **Duplication Fixes:** Fixes various duplication exploits
 * **Roost**
-    * **Early Register CT Chickens:** Improves load time by registering CT chickens early for Roost to detect them
+    * **Early Register CT Chickens:** Improves load time by registering ContentTweaker chickens early for Roost to detect them
 * **Simple Difficulty**
     * **Iron Canteen Interaction Fix:** Fixes the interaction of iron canteens with rain collectors
 * **Simply Jetpacks**
@@ -299,6 +305,7 @@ All changes are toggleable via config files.
     * **Wisp Particles:** Increases particle size of wisps similar to legacy versions
 * **Thaumic Wonders**
     * **Duplication Fixes:** Fixes various duplication exploits
+    * **Memory Leak Fix:** Fixes a client-side memory leak when wearing Void Fortress armor
 * **The Erebus**
     * **Preserved Blocks Fix:** Prevents HWYLA/TOP crashes with preserved blocks
 * **The Farlanders**
@@ -313,6 +320,6 @@ All changes are toggleable via config files.
     * **Offhand Shuriken:** Suppresses special abilities of long swords and rapiers when shurikens are wielded in the offhand
     * **Ore Dictionary Cache:** Caches all ore dictionary smelting recipes to speed up game loading
     * **Projectile Despawning:** Despawns unbreakable projectiles faster to improve framerates
-    * **Tool Customization:** Sets the attack damage cutoff at which diminishing returns start and sets the rate at which a tool's attack damage incrementally decays depending on its damage cutoff for any Tinkers' tool
+    * **Tool Customization:** Sets the attack damage cutoff at which diminishing returns start for any Tinkers' tool and sets the rate at which a tool's attack damage incrementally decays depending on its damage cutoff
 * **Tiny Progressions**
     * **Duplication Fixes:** Fixes various duplication exploits

build.gradle

@@ -175,7 +175,7 @@ dependencies {
     compileOnly 'curse.maven:endercore-231868:2972849'
     compileOnly 'curse.maven:enderio-64578:2989201'
     compileOnly 'curse.maven:extrautilities-225561:2678374'
-    compileOnly 'curse.maven:forgemultipartcbe-258426:2755790'
+    compileOnly 'curse.maven:forgemultipartcbe-258426:2755790' // aka "CB Multipart"
     compileOnly 'curse.maven:guideapi-228832:2645992'
     compileOnly 'curse.maven:industrialcraft-242638:3078604'
     compileOnly 'curse.maven:ironbackpacks-227049:2564573'

src/main/java/mod/acgaming/universaltweaks/config/UTConfigMods.java

@@ -43,6 +43,10 @@ public class UTConfigMods
     @Config.Name("Botania")
     public static final BotaniaCategory BOTANIA = new BotaniaCategory();
 
+    @Config.LangKey("cfg.universaltweaks.modintegration.cbmultipart")
+    @Config.Name("CB Multipart/Forge Multipart CBE")
+    public static final CBMultipartCategory CB_MULTIPART = new CBMultipartCategory();
+
     @Config.LangKey("cfg.universaltweaks.modintegration.chisel")
     @Config.Name("Chisel")
     public static final ChiselCategory CHISEL = new ChiselCategory();
@@ -111,6 +115,10 @@ public class UTConfigMods
     @Config.Name("Mob Stages")
     public static final MobStagesCategory MOB_STAGES = new MobStagesCategory();
 
+    @Config.LangKey("cfg.universaltweaks.modintegration.mrtjpcore")
+    @Config.Name("MrTJPCore")
+    public static final MrTJPCoreCategory MRTJPCORE = new MrTJPCoreCategory();
+
     @Config.LangKey("cfg.universaltweaks.modintegration.netherchest")
     @Config.Name("Nether Chest")
     public static final NetherChestCategory NETHER_CHEST = new NetherChestCategory();
@@ -195,7 +203,7 @@ public static class AbyssalCraftCategory
     {
         @Config.RequiresMcRestart
         @Config.Name("Optimized Item Transport")
-        @Config.Comment("Makes an optimization to reduce tick overhead of AbyssalCraft's item transport system")
+        @Config.Comment("Optimizes AbyssalCraft's item transport system to reduce tick overhead")
         public boolean utOptimizedItemTransferToggle = true;
     }
 
@@ -219,7 +227,7 @@ public static class AOACategory
     {
         @Config.RequiresMcRestart
         @Config.Name("Inventory-less GUI Compatibility")
-        @Config.Comment("Fixes AoA player ticking in certain GUIs without player inventories (i.e. Flux Networks GUI)")
+        @Config.Comment("Fixes AoA player ticking in certain GUIs without player inventories (i.e. Flux Networks, Nuclearcraft)")
         public boolean utFixPlayerTickInInventorylessGui = false;
     }
 
@@ -240,7 +248,7 @@ public static class BloodMagicCategory
 
         @Config.RequiresMcRestart
         @Config.Name("World Unload Memory Leak Fix")
-        @Config.Comment("Fixes memory leak related to unloading worlds/switching dimensions")
+        @Config.Comment("Fixes memory leak when unloading worlds/switching dimensions")
         public boolean utBMWorldUnloadToggle = true;
 
         @Config.RequiresMcRestart
@@ -267,6 +275,14 @@ public static class BotaniaCategory
         public boolean utDuplicationFixesToggle = true;
     }
 
+    public static class CBMultipartCategory
+    {
+        @Config.RequiresMcRestart
+        @Config.Name("Memory Leak Fix")
+        @Config.Comment("Fixes a memory leak associated with EntityPlayer")
+        public boolean utMemoryLeakFixToggle = true;
+    }
+
     public static class ChiselCategory
     {
         @Config.RequiresMcRestart
@@ -294,7 +310,7 @@ public static class CompactMachinesCoreCategory
     {
         @Config.RequiresMcRestart
         @Config.Name("Invisible Wall Render Fix")
-        @Config.Comment("Fixes some compact machine walls being invisible if Nothirium 0.2.x+ or Vintagium is installed")
+        @Config.Comment("Fixes some compact machine walls being invisible if Nothirium 0.2.x (and up) or Vintagium is installed")
         public boolean utCMRenderFixToggle = true;
     }
 
@@ -460,6 +476,14 @@ public static class MobStagesCategory
         public boolean utSpawningRules = true;
     }
 
+    public static class MrTJPCoreCategory
+    {
+        @Config.RequiresMcRestart
+        @Config.Name("Memory Leak Fix")
+        @Config.Comment("Fixes a memory leak associated with EntityPlayer")
+        public boolean utMemoryLeakFixToggle = true;
+    }
+
     public static class NetherChestCategory
     {
         @Config.RequiresMcRestart
@@ -482,7 +506,7 @@ public static class NuclearCraftCategory
         @Config.Name("Radiation Environment Map")
         @Config.Comment
             ({
-                "Changes the data table of the radiation environment handler to improve performance",
+                "Changes the data table of the radiation environment handler to improve tick time",
                 "CONCURRENT_HASHMAP:        NuclearCraft default",
                 "CONCURRENT_LINKED_HASHMAP: Keeps order of radiation environment info to improve iteration - Better performance",
                 "CONCURRENT_LINKED_QUEUE:   Uses a queue to avoid iteration - Best performance"
@@ -519,7 +543,7 @@ public static class RoostCategory
         @Config.Name("ContentTweaker: Early Register CT Chickens")
         @Config.Comment
             ({
-                "Improves load time by registering CT chickens early for Roost to detect them",
+                "Improves load time by registering ContentTweaker chickens early for Roost to detect them",
                 "Note: If you would like to use ContentTweaker's MaterialSystem Parts for the layed item, in your script you must:",
                 "1) Use '#loader finalize_contenttweaker', not '#loader contenttweaker'",
                 "2) Use the Material Part Bracket Handler to reference the item"
@@ -718,6 +742,11 @@ public static class ThaumicWondersCategory
         @Config.Name("Duplication Fixes")
         @Config.Comment("Fixes various duplication exploits")
         public boolean utDuplicationFixesToggle = true;
+
+        @Config.RequiresMcRestart
+        @Config.Name("Memory Leak Fix")
+        @Config.Comment("Fixes a client-side memory leak when wearing Void Fortress armor")
+        public boolean utMemoryLeakFixToggle = true;
     }
 
     public static class TheFarlandersCategory

src/main/java/mod/acgaming/universaltweaks/core/UTMixinLoader.java

@@ -18,11 +18,13 @@ public List<String> getMixinConfigs()
         if (UTLoadingPlugin.isClient)
         {
             configs.add("mixins.mods.aoa3.json");
+            configs.add("mixins.mods.cbmultipart.client.json");
             configs.add("mixins.mods.compactmachines.json");
             configs.add("mixins.mods.crafttweaker.json");
             configs.add("mixins.mods.roost.json");
             configs.add("mixins.mods.storagedrawers.client.json");
             configs.add("mixins.mods.thaumcraft.entities.client.json");
+            configs.add("mixins.mods.thaumicwonders.client.json");
         }
         // COMMON
         configs.add("mixins.mods.abyssalcraft.json");
@@ -33,6 +35,7 @@ public List<String> getMixinConfigs()
         configs.add("mixins.mods.bloodmagic.json");
         configs.add("mixins.mods.botania.dupes.json");
         configs.add("mixins.mods.botania.json");
+        configs.add("mixins.mods.cbmultipart.json");
         configs.add("mixins.mods.ceramics.json");
         configs.add("mixins.mods.chisel.tcomplement.dupes.json");
         configs.add("mixins.mods.cofhcore.json");
@@ -54,6 +57,7 @@ public List<String> getMixinConfigs()
         configs.add("mixins.mods.itemstages.json");
         configs.add("mixins.mods.mekanism.dupes.json");
         configs.add("mixins.mods.mobstages.json");
+        configs.add("mixins.mods.mrtjpcore.json");
         configs.add("mixins.mods.netherchest.dupes.json");
         configs.add("mixins.mods.netherrocks.json");
         configs.add("mixins.mods.nuclearcraft.json");
@@ -90,6 +94,8 @@ public boolean shouldMixinConfigQueue(String mixinConfig)
             {
                 case "mixins.mods.aoa3.json":
                     return Loader.isModLoaded("aoa3") && (Loader.isModLoaded("fluxnetworks") || Loader.isModLoaded("nuclearcraft"));
+                case "mixins.mods.cbmultipart.client.json":
+                    return Loader.isModLoaded("forgemultipartcbe") && UTConfigMods.CB_MULTIPART.utMemoryLeakFixToggle;
                 case "mixins.mods.compactmachines.json":
                     return Loader.isModLoaded("compactmachines3") && UTConfigMods.COMPACT_MACHINES.utCMRenderFixToggle;
                 case "mixins.mods.crafttweaker.json":
@@ -100,6 +106,8 @@ public boolean shouldMixinConfigQueue(String mixinConfig)
                     return Loader.isModLoaded("storagedrawers");
                 case "mixins.mods.thaumcraft.entities.client.json":
                     return Loader.isModLoaded("thaumcraft");
+                case "mixins.mods.thaumicwonders.client.json":
+                    return Loader.isModLoaded("thaumicwonders") && UTConfigMods.THAUMIC_WONDERS.utMemoryLeakFixToggle;
             }
         }
         switch (mixinConfig)
@@ -120,6 +128,8 @@ public boolean shouldMixinConfigQueue(String mixinConfig)
                 return Loader.isModLoaded("botania");
             case "mixins.mods.botania.dupes.json":
                 return Loader.isModLoaded("botania") && UTConfigMods.BOTANIA.utDuplicationFixesToggle;
+            case "mixins.mods.cbmultipart.json":
+                return Loader.isModLoaded("forgemultipartcbe") && UTConfigMods.CB_MULTIPART.utMemoryLeakFixToggle;
             case "mixins.mods.ceramics.json":
                 return Loader.isModLoaded("ceramics");
             case "mixins.mods.cofhcore.json":
@@ -160,6 +170,8 @@ public boolean shouldMixinConfigQueue(String mixinConfig)
                 return Loader.isModLoaded("mekanism") && UTConfigMods.MEKANISM.utDuplicationFixesToggle;
             case "mixins.mods.mobstages.json":
                 return Loader.isModLoaded("mobstages");
+            case "mixins.mods.mrtjpcore.json":
+                return Loader.isModLoaded("mrtjpcore") && UTConfigMods.MRTJPCORE.utMemoryLeakFixToggle;
             case "mixins.mods.netherchest.dupes.json":
                 return Loader.isModLoaded("netherchest") && UTConfigMods.NETHER_CHEST.utDuplicationFixesToggle;
             case "mixins.mods.netherrocks.json":

src/main/java/mod/acgaming/universaltweaks/mods/cbmultipart/mixin/UTControlKeyHandlerMixin.java

@@ -0,0 +1,19 @@
+package mod.acgaming.universaltweaks.mods.cbmultipart.mixin;
+
+import net.minecraft.entity.player.EntityPlayer;
+
+import codechicken.multipart.ControlKeyHandler$;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.injection.At;
+import org.spongepowered.asm.mixin.injection.ModifyArg;
+
+// Courtesy of jchung01
+@Mixin(value = ControlKeyHandler$.class, remap = false)
+public class UTControlKeyHandlerMixin
+{
+    @ModifyArg(method = "tick", at = @At(value = "INVOKE", target = "Lscala/collection/mutable/Map;put(Ljava/lang/Object;Ljava/lang/Object;)Lscala/Option;"), index = 0)
+    private Object utPutWithUUID(Object playerObj)
+    {
+        return ((EntityPlayer) playerObj).getUniqueID();
+    }
+}

src/main/java/mod/acgaming/universaltweaks/mods/cbmultipart/mixin/UTControlKeyValueMixin.java

@@ -0,0 +1,48 @@
+package mod.acgaming.universaltweaks.mods.cbmultipart.mixin;
+
+import java.util.UUID;
+
+import net.minecraft.entity.player.EntityPlayer;
+
+import codechicken.multipart.ControlKeyModifer;
+import codechicken.multipart.ControlKeyModifer$;
+import org.spongepowered.asm.mixin.Final;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.Mutable;
+import org.spongepowered.asm.mixin.Shadow;
+import org.spongepowered.asm.mixin.Unique;
+import org.spongepowered.asm.mixin.injection.At;
+import org.spongepowered.asm.mixin.injection.Inject;
+import org.spongepowered.asm.mixin.injection.ModifyArg;
+import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
+
+// Courtesy of jchung01
+/**
+ * Note: To my knowledge, {@link ControlKeyModifer#isControlDown(EntityPlayer)} is never called in any mod, so this mixin isn't very useful.
+ */
+@Mixin(value = ControlKeyModifer.ControlKeyValue.class, remap = false)
+public class UTControlKeyValueMixin
+{
+    @Final
+    @Mutable
+    @Shadow
+    private EntityPlayer p;
+    @Unique
+    private UUID universalTweaks$id;
+
+    @Inject(method = "<init>", at = @At(value = "RETURN"))
+    private void utSetUUID(EntityPlayer p, CallbackInfo ci)
+    {
+        universalTweaks$id = p.getUniqueID();
+        this.p = null;
+    }
+
+    /**
+     * @see ControlKeyModifer$#isControlDown(EntityPlayer) for where this is called
+     */
+    @ModifyArg(method = "isControlDown", at = @At(value = "INVOKE", target = "Lscala/collection/mutable/Map;apply(Ljava/lang/Object;)Ljava/lang/Object;"))
+    private Object utGetByUUID(Object thisPlayer)
+    {
+        return universalTweaks$id;
+    }
+}

src/main/java/mod/acgaming/universaltweaks/mods/cbmultipart/mixin/UTMultipartSPHMixin.java

@@ -0,0 +1,19 @@
+package mod.acgaming.universaltweaks.mods.cbmultipart.mixin;
+
+import net.minecraft.entity.player.EntityPlayer;
+
+import codechicken.multipart.handler.MultipartSPH$;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.injection.At;
+import org.spongepowered.asm.mixin.injection.ModifyArg;
+
+// Courtesy of jchung01
+@Mixin(value = MultipartSPH$.class, remap = false)
+public class UTMultipartSPHMixin
+{
+    @ModifyArg(method = "handlePacket", at = @At(value = "INVOKE", target = "Lscala/collection/mutable/Map;put(Ljava/lang/Object;Ljava/lang/Object;)Lscala/Option;"), index = 0)
+    private Object utPutWithUUID(Object senderObj)
+    {
+        return ((EntityPlayer) senderObj).getUniqueID();
+    }
+}

src/main/java/mod/acgaming/universaltweaks/mods/mrtjpcore/mixin/UTKeyTrackingMixin.java

@@ -0,0 +1,27 @@
+package mod.acgaming.universaltweaks.mods.mrtjpcore.mixin;
+
+import net.minecraft.entity.player.EntityPlayer;
+
+import mrtjp.core.data.KeyTracking$;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.injection.At;
+import org.spongepowered.asm.mixin.injection.ModifyArg;
+
+// Courtesy of jchung01
+@Mixin(value = KeyTracking$.class, remap = false)
+public class UTKeyTrackingMixin
+{
+    @ModifyArg(method = "updatePlayerKey", at = @At(value = "INVOKE", target = "Lscala/Predef$;ArrowAssoc(Ljava/lang/Object;)Ljava/lang/Object;"))
+    private Object utUpdateUUIDKey(Object playerObj)
+    {
+        // Set key as UUID, not EntityPlayer
+        return ((EntityPlayer) playerObj).getUniqueID();
+    }
+
+    @ModifyArg(method = "isKeyDown", at = @At(value = "INVOKE", target = "Lscala/collection/MapLike;apply(Ljava/lang/Object;)Ljava/lang/Object;"), index = 0)
+    private Object utIsKeyDownForUUID(Object playerObj)
+    {
+        // Get value using UUID key
+        return ((EntityPlayer) playerObj).getUniqueID();
+    }
+}