fix: free memory used by proposals in firewood #1173
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Problem: Previously, when the database is closing, coreth would not free the memory used by the proposals in firewood. This is relying on an internal implementation detail of firewood but it is a violation of the firewood API contract. In the [future], this will lead to memory leaks. Solution: This change adds a method to the ProposalContext that the db uses to recursively free the proposal but skip the proposal map removal as it is redundant when closing the database. [future]: ava-labs/firewood#1221
alarso16
requested changes
Sep 2, 2025
alarso16
approved these changes
Sep 5, 2025
JonathanOppenheimer
approved these changes
Sep 5, 2025
JonathanOppenheimer
approved these changes
Sep 9, 2025
StephenButtolph
approved these changes
Sep 12, 2025
StephenButtolph
deleted the
brandon.leblanc/prevent-firewood-memory-leak
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why this should be merged
Previously, when the database is closing, coreth would not free the memory used by the proposals in firewood. This is relying on an internal implementation detail of firewood but it is a violation of the firewood API contract. In the future, this will lead to memory leaks.
The Go garbage collector will be unable to free this memory because it is not owned by Go but instead the C/Rust layer.
How this works
This change reuses the dereference method and calls it for all cached proposals.
How this was tested
Existing integration tests cover this path well.
Need to be documented?
No
Need to update RELEASES.md?