Document how to set memory limits
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 48/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- java, wasm
- Domain
- documentation
Research direction
Start with the Resource Limits, Security Model, and Advanced Wasm Memory Customization pages, then inspect MemoryLimits, Instance.Builder#withMemoryLimits, ImportMemory, MemoryImport, TableLimits, and the referenced Instance.java code. Confirm how limits apply to multiple memories and array allocation instructions, then document the supported configuration with an example and link the Resource Limits page from the Security Model page.
Written by the indexing model from the issue text.
Description
If possible, could you please extend the documentation regarding how to set memory limits? Currently the documentation just says "set limits" but without telling how exactly.
- Describe it and add an example to the Resource Limits page
- Link to it from the Security Model page ("Memory growth limits"), similar to the existing "CPU Limits" link
- Possibly extend the Advanced Wasm Memory Customization page
The documentation regarding CPU limits is already pretty good, but for memory limits it is not directly clear how to apply them.
If I understand it correctly the main class is MemoryLimits, and it can be applied with Instance.Builder#withMemoryLimits. But what I don't fully understand yet is:
- Are there other places to consider?
E.g. there isImportMemoryandMemoryImport, but I assume they are only relevant when you are actually importing memory? - There is also
TableLimits; is that relevant here as well? - The limit specified using
withMemoryLimitsonly seems to apply to memory index 0, is that intentional and does that mean the other memories are not restricted (besides thelimitwhich is specified in the Wasm code itself)? - The instructions
array.new,array.new_default,array.new_fixed,array.new_dataandarray.new_elemcreate anew long[len]and don't seem to be restricted at all?
- Dominant language
- Java
- Stars
- 306
- Forks
- 20
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 35
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from bytecodealliance/endive
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
bytecodealliance/endive#211 ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
bytecodealliance/endive#203 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
bytecodealliance/endive#202 · 2 comments ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 55/100
bytecodealliance/endive#201 · 4 comments ·
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
bytecodealliance/endive#181 · 3 comments · 1 reaction ·
Maintainers usually reply within 1 day
All issues in bytecodealliance/endive
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
MaikuB/flutter_appauth#683 ·
-
type: possible bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
grimmory-tools/grimmory#2850 · 1 comment ·
Maintainers usually reply within 1 day