Delete SCAN contract annotations #116182
Merged
Delete SCAN contract annotations #116182
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
These annotations were used by prefast plugin that analyzed contract consistency. This prefast plugin is not coming back.
There was a problem hiding this comment.
Pull Request Overview
This PR removes all SCAN_* and related static analysis annotations from exception handling and contract macros, consolidating contract headers and cleaning up annotation-only code.
- Deleted
SCAN_markers andANNOTATION_*usages across multiple VM and utilcode files. - Streamlined
staticcontract.hby replacing annotation-based contracts with empty macro definitions. - Fixed duplicate includes of
eecontract.hincommon.h.
Reviewed Changes
Copilot reviewed 31 out of 31 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/coreclr/vm/exceptmacros.h | Removed SCAN_EHMARKER* and ANNOTATION_NOTHROW macros |
| src/coreclr/vm/excep.h | Deleted SCAN_SCOPE_BEGIN/END around helper constructor |
| src/coreclr/vm/eecontract.cpp | Removed SCAN_IGNORE_* markers from DoChecks |
| src/coreclr/vm/crst.h | Deleted ANNOTATION_SPECIAL_HOLDER_CALLER_NEEDS_DYNAMIC_CONTRACT |
| src/coreclr/vm/crst.cpp | Removed SCAN_IGNORE_* macros in Enter |
| src/coreclr/vm/common.h | Added and de-duplicated #include "eecontract.h" |
| src/coreclr/vm/clrex.cpp | Removed SCAN_IGNORE_FAULT in exception path |
| src/coreclr/vm/assemblyspec.cpp | Deleted SCAN_IGNORE_FAULT in wrappers |
| src/coreclr/vm/appdomain.hpp | Removed ANNOTATION_SPECIAL_HOLDER_CALLER_NEEDS_DYNAMIC_CONTRACT |
| src/coreclr/utilcode/stacktrace.cpp | Cleaned SCAN_IGNORE_FAULT from image/dbghelp loads |
| src/coreclr/utilcode/pedecoder.cpp | Removed ANNOTATION_DEBUG_ONLY |
| src/coreclr/utilcode/log.cpp | Deleted SCAN_IGNORE_FAULT in logging functions |
| src/coreclr/utilcode/check.cpp | Removed SCAN_SCOPE_BEGIN and ANNOTATION_VIOLATION |
| src/coreclr/inc/staticcontract.h | Replaced annotation macros with empty STATIC_CONTRACT_* definitions |
| src/coreclr/inc/palclr.h | Deleted SCAN_EHMARKER* and throw markers in PAL_TRY |
| src/coreclr/inc/ostype.h | Removed static contract annotations from macros |
| src/coreclr/inc/ex.h | Removed SCAN_SCOPE_* and SCAN_EHMARKER in exception helpers |
| src/coreclr/inc/contract.h | Deleted SCAN_SCOPE_BEGIN/END in contract holders |
| src/coreclr/debug/ee/debugger.h | Removed SCAN_SCOPE_BEGIN/END in GC holder |
| src/coreclr/debug/ee/debugger.cpp | Removed SCAN_IGNORE_TRIGGER in debugger notifications |
jkoritzinsky
approved these changes
May 31, 2025
Open
3 tasks
jkoritzinsky
reviewed
Jun 7, 2025
jkoritzinsky
approved these changes
Jun 7, 2025
|
/ba-g timeout |
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.
These annotations were used by prefast plugin that analyzed contract consistency. This prefast plugin is not coming back.