-
Notifications
You must be signed in to change notification settings - Fork 5.6k
Add unsafe evolution migration code fixers #130611
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
Closed
Closed
Changes from 2 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
8b667be
Add unsafe evolution migration code fixers
EgorBo 83f8602
Address unsafe migration review feedback
EgorBo efeee2b
Address additional unsafe migration feedback
EgorBo 9c5a442
Gate unsafe migration code fixes
EgorBo f90cd87
Merge branch 'main' into unsafe-migrator-3
EgorBo e7f900d
Merge branch 'main' of https://github.com/dotnet/runtime into unsafe-…
EgorBo a0ccc16
Address unsafe migration code fixer review feedback
EgorBo aef2408
Fix unsafe usage migration to avoid invalid code
EgorBo 593785f
Address unsafe migration review feedback
EgorBo df9b4fe
Preserve inline variable comments when splitting event fields
EgorBo 74d7482
Simplify unsafe migration code fixers
EgorBo 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
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
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
132 changes: 132 additions & 0 deletions
132
src/tools/illink/src/ILLink.CodeFix/UnsafeCodeFixHelpers.cs
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| // Copyright (c) .NET Foundation and contributors. All rights reserved. | ||
| // Licensed under the MIT license. See LICENSE file in the project root for full license information. | ||
|
|
||
| #if DEBUG | ||
| using System.Linq; | ||
| using System.Threading; | ||
| using System.Threading.Tasks; | ||
| using ILLink.RoslynAnalyzer; | ||
| using Microsoft.CodeAnalysis; | ||
| using Microsoft.CodeAnalysis.CSharp; | ||
| using Microsoft.CodeAnalysis.CSharp.Syntax; | ||
| using Microsoft.CodeAnalysis.Editing; | ||
| using Microsoft.CodeAnalysis.Formatting; | ||
|
|
||
| namespace ILLink.CodeFix | ||
| { | ||
| internal static class UnsafeCodeFixHelpers | ||
| { | ||
| private const string SafetyComment = "// SAFETY: Audit"; | ||
| private const string SafetyDocumentation = "/// <safety>TODO: Audit.</safety>"; | ||
| private const string UnsafeExpressionPlaceholder = "__unsafe_operand__"; | ||
|
|
||
| public static async Task<Document> ApplyDeclarationUpdatesAsync( | ||
| Document document, | ||
| CancellationToken cancellationToken) | ||
| { | ||
| if (await document.GetSemanticModelAsync(cancellationToken).ConfigureAwait(false) is not { } semanticModel || | ||
| await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false) is not { } root) | ||
| { | ||
| return document; | ||
| } | ||
|
|
||
| var updates = UnsafeMigrationAnalysis.GetDeclarationUpdates(semanticModel, cancellationToken); | ||
| if (updates.IsEmpty) | ||
| return document; | ||
|
|
||
| var annotations = updates.ToDictionary( | ||
| static update => update.Declaration, | ||
| static _ => new SyntaxAnnotation()); | ||
|
|
||
| SyntaxNode changedRoot = root.ReplaceNodes( | ||
| annotations.Keys, | ||
| (original, rewritten) => rewritten.WithAdditionalAnnotations(annotations[original])); | ||
|
|
||
| SyntaxGenerator generator = SyntaxGenerator.GetGenerator(document); | ||
| foreach (var update in updates) | ||
| { | ||
| SyntaxNode declaration = changedRoot.GetAnnotatedNodes(annotations[update.Declaration]).Single(); | ||
| SyntaxNode replacement = declaration; | ||
|
|
||
| if (update.AddUnsafeModifier && !UnsafeMigrationAnalysis.HasUnsafeModifier(declaration)) | ||
| replacement = AddUnsafeModifier(replacement, generator); | ||
|
|
||
| if (update.AddSafetyDocumentation && !UnsafeMigrationAnalysis.HasSafetyDocumentation(replacement)) | ||
| replacement = AddSafetyDocumentation(replacement); | ||
|
|
||
| changedRoot = changedRoot.ReplaceNode(declaration, replacement); | ||
| } | ||
|
|
||
| return document.WithSyntaxRoot(changedRoot); | ||
| } | ||
|
|
||
| private static SyntaxNode AddUnsafeModifier( | ||
| SyntaxNode declaration, | ||
| SyntaxGenerator generator) | ||
| => declaration is AccessorDeclarationSyntax accessor | ||
| ? accessor | ||
| .WithModifiers(accessor.Modifiers.Insert( | ||
| 0, | ||
| SyntaxFactory.Token(SyntaxKind.UnsafeKeyword) | ||
| .WithTrailingTrivia(SyntaxFactory.Space))) | ||
| .WithKeyword(accessor.Keyword.WithLeadingTrivia(SyntaxFactory.TriviaList())) | ||
| .WithLeadingTrivia(accessor.GetLeadingTrivia()) | ||
| : generator.WithModifiers( | ||
| declaration, | ||
| generator.GetModifiers(declaration).WithIsUnsafe(true)) | ||
| .WithLeadingTrivia(declaration.GetLeadingTrivia()); | ||
|
EgorBo marked this conversation as resolved.
Outdated
|
||
|
|
||
| public static UnsafeStatementSyntax CreateUnsafeStatement(params StatementSyntax[] statements) | ||
| { | ||
| if (statements.Length > 0) | ||
| { | ||
| statements[0] = statements[0].WithLeadingTrivia( | ||
| CreateSafetyCommentTrivia().AddRange(statements[0].GetLeadingTrivia())); | ||
| } | ||
|
|
||
| return SyntaxFactory.UnsafeStatement(SyntaxFactory.Block(statements)) | ||
| .WithAdditionalAnnotations(Formatter.Annotation); | ||
| } | ||
|
|
||
| public static ExpressionSyntax? CreateUnsafeExpression(ExpressionSyntax expression) | ||
| { | ||
| ExpressionSyntax template = SyntaxFactory.ParseExpression( | ||
| $"unsafe(/* SAFETY: Audit */{UnsafeExpressionPlaceholder})"); | ||
|
|
||
| if (template.ContainsDiagnostics) | ||
| return null; | ||
|
|
||
| IdentifierNameSyntax? placeholder = template.DescendantNodesAndSelf() | ||
| .OfType<IdentifierNameSyntax>() | ||
| .SingleOrDefault(static identifier => identifier.Identifier.ValueText == UnsafeExpressionPlaceholder); | ||
|
|
||
| if (placeholder is null) | ||
| return null; | ||
|
|
||
| return template.ReplaceNode(placeholder, expression.WithoutTrivia()) | ||
| .WithTriviaFrom(expression); | ||
|
EgorBo marked this conversation as resolved.
Outdated
|
||
| } | ||
|
|
||
| public static bool ContainsDirectives(SyntaxNode node) | ||
| => node.DescendantTrivia(descendIntoTrivia: true).Any(static trivia => trivia.IsDirective); | ||
|
|
||
| private static SyntaxNode AddSafetyDocumentation(SyntaxNode declaration) | ||
| { | ||
| SyntaxTriviaList leadingTrivia = declaration.GetLeadingTrivia(); | ||
| SyntaxTriviaList indentation = SyntaxFactory.TriviaList( | ||
| leadingTrivia | ||
| .Reverse() | ||
| .TakeWhile(static trivia => trivia.IsKind(SyntaxKind.WhitespaceTrivia)) | ||
| .Reverse()); | ||
| SyntaxTriviaList documentation = SyntaxFactory.ParseLeadingTrivia($"{SafetyDocumentation}\r\n"); | ||
| return declaration.WithLeadingTrivia( | ||
| leadingTrivia | ||
| .AddRange(documentation) | ||
| .AddRange(indentation)); | ||
| } | ||
|
|
||
| private static SyntaxTriviaList CreateSafetyCommentTrivia() | ||
| => SyntaxFactory.ParseLeadingTrivia($"{SafetyComment}\r\n"); | ||
| } | ||
| } | ||
| #endif | ||
83 changes: 83 additions & 0 deletions
83
src/tools/illink/src/ILLink.CodeFix/UnsafeModifierMigrationCodeFixProvider.cs
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| // Copyright (c) .NET Foundation and contributors. All rights reserved. | ||
| // Licensed under the MIT license. See LICENSE file in the project root for full license information. | ||
|
|
||
| #if DEBUG | ||
| using System.Collections.Immutable; | ||
| using System.Composition; | ||
| using System.Linq; | ||
| using System.Threading; | ||
| using System.Threading.Tasks; | ||
| using ILLink.CodeFixProvider; | ||
| using ILLink.RoslynAnalyzer; | ||
| using ILLink.Shared; | ||
| using Microsoft.CodeAnalysis; | ||
| using Microsoft.CodeAnalysis.CodeActions; | ||
| using Microsoft.CodeAnalysis.CodeFixes; | ||
| using Microsoft.CodeAnalysis.Editing; | ||
|
|
||
| namespace ILLink.CodeFix | ||
| { | ||
| [ExportCodeFixProvider(LanguageNames.CSharp, Name = nameof(UnsafeModifierMigrationCodeFixProvider)), Shared] | ||
| public sealed class UnsafeModifierMigrationCodeFixProvider : Microsoft.CodeAnalysis.CodeFixes.CodeFixProvider | ||
| { | ||
| private static LocalizableString CodeFixTitle => new LocalizableResourceString( | ||
| nameof(Resources.UnsafeModifierMigrationCodeFixTitle), | ||
| Resources.ResourceManager, | ||
| typeof(Resources)); | ||
|
|
||
| public override ImmutableArray<string> FixableDiagnosticIds => [DiagnosticId.UnsafeModifierMigration.AsString()]; | ||
|
|
||
| public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer; | ||
|
|
||
| public override Task RegisterCodeFixesAsync(CodeFixContext context) | ||
| { | ||
| string title = CodeFixTitle.ToString(); | ||
| context.RegisterCodeFix( | ||
| CodeAction.Create( | ||
| title, | ||
| cancellationToken => RemoveUnsafeModifiersAsync(context.Document, cancellationToken), | ||
| title), | ||
| context.Diagnostics); | ||
|
|
||
| return Task.CompletedTask; | ||
| } | ||
|
EgorBo marked this conversation as resolved.
Outdated
|
||
|
|
||
| private static async Task<Document> RemoveUnsafeModifiersAsync( | ||
| Document document, | ||
| CancellationToken cancellationToken) | ||
| { | ||
| if (await document.GetSemanticModelAsync(cancellationToken).ConfigureAwait(false) is not { } semanticModel || | ||
| await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false) is not { } root) | ||
| { | ||
| return document; | ||
| } | ||
|
|
||
| var removals = UnsafeMigrationAnalysis.GetModifierRemovals(semanticModel, cancellationToken); | ||
| if (removals.IsEmpty) | ||
| return document; | ||
|
|
||
| var annotations = removals.ToDictionary( | ||
| static removal => removal.Declaration, | ||
| static _ => new SyntaxAnnotation()); | ||
|
|
||
| SyntaxNode changedRoot = root.ReplaceNodes( | ||
| annotations.Keys, | ||
| (original, rewritten) => rewritten.WithAdditionalAnnotations(annotations[original])); | ||
|
|
||
| SyntaxGenerator generator = SyntaxGenerator.GetGenerator(document); | ||
| foreach (SyntaxAnnotation annotation in annotations.Values) | ||
| { | ||
| SyntaxNode declaration = changedRoot.GetAnnotatedNodes(annotation).Single(); | ||
| SyntaxNode replacement = generator.WithModifiers( | ||
| declaration, | ||
| generator.GetModifiers(declaration).WithIsUnsafe(false)) | ||
| .WithLeadingTrivia(declaration.GetLeadingTrivia()); | ||
|
|
||
| changedRoot = changedRoot.ReplaceNode(declaration, replacement); | ||
| } | ||
|
|
||
| return document.WithSyntaxRoot(changedRoot); | ||
| } | ||
| } | ||
| } | ||
| #endif | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.