ClangPlugins: Warn on Handle/SafeFunction members in GC allocated objects; Verify JS_CELL-like macros #24422
Conversation
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
github-actions
bot
added
the
馃憖 pr-needs-review
mattco98
force-pushed
the
clang-plugins-bad-field-types
branch
from
627f977
to
f310ee7
Compare
ADKaster
reviewed
May 23, 2024
Like a CMake flag that ends up adding Note to self: need to change the plugin names use underscores instead of dashes to be able to use |
mattco98
force-pushed
the
clang-plugins-bad-field-types
branch
from
f310ee7
to
d00ea71
Compare
This makes it more clear what it is used for
This allows arguments to be passed to them from the command line
GC-allocated objects should never have JS::SafeFunction/JS::Handle fields. For now the plugin only emits warnings here, as there are many cases of this occurring in the codebase that aren't trivial to fix. It is also behind a CMake flag since it is a _very_ loud warning.
mattco98
force-pushed
the
clang-plugins-bad-field-types
branch
from
d00ea71
to
54f4a0d
Compare
ADKaster
approved these changes
May 30, 2024
github-actions
bot
removed
the
馃憖 pr-needs-review
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 plugins now detect if a GC-allocated class contains a field with a
Handle/SafeFunctiontype. Unfortunately there are many occurrences of this in the code base, so for now I've left it as a warning with a FIXME to change it to an error later. It is also very noisy at the moment, but that is because many warnings are emitted for each field occurrence. Not quite sure how to fix this, but in the mean time it can serve as motivation to change the field types 馃槂The plugins now also verify that the JS_CELL-like macros are used properly. This includes
JS_CELL,JS_OBJECT,JS_ENVIRONMENT,JS_PROTOTYPE_OBJECT, andWEB_PLATFORM_OBJECT. For these macros, the first argument must exactly match the class name in the declaration, and the second argument must exactly match the parent name (namespaces included).Closes #23900, closes #23881, closes #23880