Add a string lowering mode disallowing non-UTF-8 strings #6861
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
The best way to lower strings is via the "magic imports" API that uses the names of imported string globals as their values. This approach only works for valid UTF-8 strings, though. The existing string-lowering-magic-imports pass falls back to putting non-UTF-8 strings in a JSON custom section, but this requires the runtime to support that custom section for correctness. To help catch errors early when runtimes do not support the strings custom section, add a new pass that uses magic imports and raises an error if there are any invalid strings.
kripken
reviewed
Aug 21, 2024
Member
kripken
left a comment
kripken
left a comment
There was a problem hiding this comment.
lgtm % suggestion to make the new mode depend on magic imports being set, which seems a bit simpler.
src/passes/StringLowering.cpp
Outdated
| StringLowering(bool useMagicImports = false) | ||
| : useMagicImports(useMagicImports) {} | ||
| // Whether to throw a fatal error on non-UTF8 strings that would not be able | ||
| // to use the "magic import" mechanism. |
Member
There was a problem hiding this comment.
Suggested change
| // to use the "magic import" mechanism. | |
| // to use the "magic import" mechanism. This is only relevant when useMagicImports. |
src/passes/StringLowering.cpp
Outdated
| bool assertUTF8; | ||
|
|
||
| StringLowering(bool useMagicImports = false, bool assertUTF8 = false) | ||
| : useMagicImports(useMagicImports), assertUTF8(assertUTF8) {} |
Member
There was a problem hiding this comment.
Suggested change
| : useMagicImports(useMagicImports), assertUTF8(assertUTF8) {} | |
| : useMagicImports(useMagicImports), assertUTF8(assertUTF8) { | |
| // if we assert UTF8, we must have enabled magic imports. | |
| assert(!assertUTF8 || useMagicImports); | |
| } |
src/passes/StringLowering.cpp
Outdated
| global->module = "'"; | ||
| global->base = Name(utf8.str()); | ||
| } else { | ||
| if (useMagicImports && assertUTF8) { |
Member
There was a problem hiding this comment.
Suggested change
| if (useMagicImports && assertUTF8) { | |
| if (assertUTF8) { |
kripken
approved these changes
Aug 21, 2024
Closed
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.
The best way to lower strings is via the "magic imports" API that uses
the names of imported string globals as their values. This approach only
works for valid UTF-8 strings, though. The existing
string-lowering-magic-imports pass falls back to putting non-UTF-8
strings in a JSON custom section, but this requires the runtime to
support that custom section for correctness. To help catch errors early
when runtimes do not support the strings custom section, add a new pass
that uses magic imports and raises an error if there are any invalid
strings.