Text format #16
Open
Text format #16
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
kripken
reviewed
Jun 12, 2025
Comment on lines
56
to
59
| @metadata.code.compilation_order( | ||
| (priority 1) | ||
| (hotness 100) | ||
| ) |
There was a problem hiding this comment.
Looks like the current branch hints have this form:
(@metadata.code.branch_hint "\01")
(..instruction attached to..)Perhaps we can follow that? That is,
Suggested change
| @metadata.code.compilation_order( | |
| (priority 1) | |
| (hotness 100) | |
| ) | |
| (@metadata.code.compilation_order | |
| (priority 1) | |
| (hotness 100) | |
| ) |
There was a problem hiding this comment.
Oh, of course. I misremembered the syntax.
tlively
reviewed
Jun 12, 2025
| @@ -37,7 +37,7 @@ The following contains a list of hints to be included in the first version of th | |||
| The section `metadata.code.compilation_order` contains the order in which functions should be compiled in order to minimize wait times until the compilation is completed. This is especially relevant during instantiation and startup but might also be relevant later. | |||
| * *byte offset* |U32| with value 0 (function level only) | |||
| * *hint length* |U32| in bytes | |||
| * *compilation order* |U32| starting at 0 (functions with the same order value will be compiled in an arbitrary order but before functions with a higher order value) | |||
| * *compilation priority* |U32| starting at 0 (functions with the same order value will be compiled in an arbitrary order but before functions with a higher order value) | |||
There was a problem hiding this comment.
Suggested change
| * *compilation priority* |U32| starting at 0 (functions with the same order value will be compiled in an arbitrary order but before functions with a higher order value) | |
| * *compilation priority* |U32| starting at 0 (functions with the same priority value will be compiled in an arbitrary order but before functions with a higher priority value) |
Should the hint itself be renamed to metadata.code.compilation_priority?
| ``` | ||
| according to the formula above. | ||
|
|
||
| Alternatively to `freq` followed by a numeric value, one can provide `never_opt` and `always_opt` with binary representations of `"\00"` and `"\7f"` respectively. |
There was a problem hiding this comment.
Just to bikeshed a bit, what do you think about never and always instead of never_opt and always_opt?
|
|
||
| The text representation allows for multiple targets | ||
| ``` | ||
| (@metadata.code.call_targets (target $func1 0.73) (target $func2 0.21)) |
There was a problem hiding this comment.
It may be good to give a grammar here, something like
calltargetannot ::= ... | '(' '@metadata.code.call_targets' <target>* ')'
target ::= '(' 'target' funcidx freq ')'
freq ::= f32
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.
Alternatively to the binary representation as a string value, one can use a human readable syntax to express compilation hints. These hints will have the same binary representation int eh module and can therefore also be translated into the string format if conversion tools don't support the alternative format.
This implements the suggestion from issue #14.