Increasing memory usage when using the Equipment Status HUD

[alerouzic]

Hello there !

I've been recently using your mod (which is great!) and found out that I started to have issues with my memory and CPU usage.

I did notice that after some time (1/2 hours) my game was running out of memory, fluctuating a lot at the highest limit (2GB here). I also suspected an abnormal amount of GC, which was confirmed when I started to see my CPU ramping a lot in this situation. After some testing, It seems to be related to the Equipment Status HUD feature and on how object' lifecycle are handled (EquipmentInfoStack class).

Setup

• Win 11
• JRE 20
• Minecraft with Fabric mod loader 1.20.1
• simple-hud-enhanced+1.20-1.20.1-v3.1.0.jar

Testing With jvisualvm I've started to monitor my game and see if I could find a suspicious class using a lot of memory.

First test, with the option activated, we can see an increase in my memory usage, and a lot of live object for the EquipmentInfoStack. context: was playing as usual on an SMP server for 1+ hour

  

Second test, with the EquipmentStatus HUD option deactivated (didn't changed anything else on my setup). context: was afk on the same SMP server for 1+ hour

  

Expected behaviour Using the Equipment Status HUD option should not cause indefinite increase in memory usage.

Additional context Feel free to ask me anything, I hope I didn't forget anything :) Regards,

[SoRadGaming]

Thanks for this amazing detailed bug report. I observed this, too, ~and just found the issue: my code constantly adds armour or items the payer is holding to a list controlled by EquipmentInfoStack Class. I just keep adding to it, and it never gets unallocated. In theory, if you keep cycling items, this should speed up the process of data allocation.~

But the only thing that makes me doubt it is that this class should not run if you disable the option in settings. (Yeah not the Issue)

// Draw Equipment Status
        if (config.toggleEquipmentStatus) {
            Equipment equipment = new Equipment(context, config);
            equipment.init();
        }

public void init() {
        // Get Armour and Hand Item from Inventory and Offhand
        equipmentInfo = new ArrayList<>(
                Arrays.asList(
                        new EquipmentInfoStack(this.player.getInventory().getArmorStack(3)),
                        new EquipmentInfoStack(this.player.getInventory().getArmorStack(2)),
                        new EquipmentInfoStack(this.player.getInventory().getArmorStack(1)),
                        new EquipmentInfoStack(this.player.getInventory().getArmorStack(0)),
                        new EquipmentInfoStack(this.player.getOffHandStack()),
                        new EquipmentInfoStack(this.player.getMainHandStack())
                )
        );

        // Remove Air Blocks from the list
        equipmentInfo.removeIf(equipment -> equipment.getItem().getItem().equals(Blocks.AIR.asItem()));

        // Check showNonTools
        if (!config.equipmentStatus.showNonTools) {
            equipmentInfo.removeIf(equipment -> equipment.getItem().getItem().getMaxDamage() == 0);
        }

        if (config.equipmentStatus.showDurability) {
            // Draw Durability
            getDurability();
        }

        // Draw Items
        draw();
    }

Note: I am working on text scaling, I am going to finish the new scaling text code and then create a potential fix for this issue.

[alerouzic]

Hey !

I've been reading some of the code, and I think the problem comes from the parent object named Equipment, we can confirm this with my previous screens where we can see the number of instances increasing for Equipment (test 1 with the option active).

Just an hypothesis here, but could the non-deletion of these instances be linked to the context parameter in the constructor of Equipment ? Can it, somehow, avoid the deletion of Equipment instances ?

Looking forward to hearing more about your findings when you will work on this issue 👀

[SoRadGaming]

It seems my v4.0.0 Update has worked without much issue. I will now spend all the time that I allocate to open source on this. Will start testing in the coming days. Ill write when I have an update.

[SoRadGaming]

Please Test this new update to check if the issue is fixed. (jar is in the PR Page)

[alerouzic]

Hello there,

Sorry I wasn't able to get back to you sooner, I was on holidays.

I just tested the new version (4.1.0), but it seems that the problem persists 👀 Please find my new tests enclosed. On my side I will not be able to test future binaries since I'm very busy :(

Regards

FIRST TEST: 1GB memory, Equipment HUD ENABLED, 1 hour AFK

  

SECOND TEST: 1GB memory, Equipment HUD DISABLED, 1 hour AFK

  

[SoRadGaming]

I finally found the issue; it seems v4.1.0 has improved but has not been fixed. The Equipment class extends the Hud class which causes its instances never to be garbage collected.

Here is the jar With the Fix; in my testing, it seems to have fixed the problem. simple-hud-enhanced+1.20-1.20.2-v4.2.0.zip

[alerouzic]

Yup, the memory leak seems to be fixed, I now have an expected memory curve with my game !

Thanks for the fix <3

[SoRadGaming]

I will release the update and some improved async code (still in progress); thanks for all the help. What do you prefer as a contributor name, Antonio or alerouzic?

[alerouzic]

alerouzic is fine 👍