Add free-list allocator information. - #42
Merged
Merged
Conversation
Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
alexandratran
approved these changes
Jul 21, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Updated the docs to reflect that the rv64im guest defaults to the free-list allocator .
Fixes: #38
Note
Low Risk
Documentation-only changes with no runtime, build, or host integration code modified.
Overview
Updates documentation so the rv64im guest is described as defaulting to the free-list allocator (with build-time selection), instead of implying a bump-only heap.
Architecture now explains allocator choice at build time, why the free-list default helps on allocation-heavy blocks, and that the bump allocator remains in source as a non-default option.
Glossary (
glossary.jsonand generatedglossary.mdx) revises the bump allocator entry and adds Free-list allocator.zkVM symbol reference generalizes runtime heap symbol wording and adds a note that default guest behavior uses the free-list allocator within
[ZKVM_HEAP_POS, ZKVM_HEAP_TOP)while the host symbol contract is unchanged.Reviewed by Cursor Bugbot for commit 75696db. Bugbot is set up for automated code reviews on this repo. Configure here.