-
-
Notifications
You must be signed in to change notification settings - Fork 21
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Clarify linear memory use in all-your-base #85
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
30 changes: 28 additions & 2 deletions
30
exercises/practice/all-your-base/.docs/instructions.append.md
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,31 @@ | ||
# Instruction append | ||
|
||
## Reserved Addresses | ||
## WebAssembly-specific Notes | ||
|
||
All input is provided as parameters, so no addresses in the linear memory are reserved. | ||
The function signature for the WebAssembly export `convert` is as follows: | ||
|
||
```wasm | ||
(func (export "convert") | ||
(param $arrOffset i32) | ||
(param $arrLength i32) | ||
(param $inputBase i32) | ||
(param $outputBase i32) | ||
(result i32 i32 i32) | ||
) | ||
``` | ||
|
||
The first two parameters `$arrOffset` and `$arrLength` express the base offset and length of an array of 32-bit signed integers. The length parameter is sized in number of elements in the array, not bytes. Prior to calling this function, the caller writes this array into the WebAssembly linear memory beginning at offset `$arrOffset`. WebAssembly linear memory is always expressed in little-endian. | ||
|
||
Thus the caller would thus encoded the array `[1,2]` as the following eight byte sequence. | ||
|
||
``` | ||
| 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | | ||
| ---- arr[0] ----- | ---- arr[1] ----- | | ||
,0x01,0x00,0x00,0x00,0x02,0x00,0x00,0x00, | ||
``` | ||
|
||
The parameters `$inputBase` and `$outputBase` do not involve linear memory. | ||
|
||
The result type is `(i32 i32 i32)`. The first two values are the `offset` and `length` of your output in linear memory. If you so choose, you may overwrite the addresses of linear memory used for the input. The third return value is an i32 status code used for error handling. | ||
|
||
If the third return value expresses an error state, the unit tests do not read the first two return values. |
This file contains 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This might be worth doing for all exercises!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I concur! I'll add a note to consider doing this as a follow-on.