Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Fix bug in virtual annotation logic for RequiresUnreferencedCode #100707

Merged
merged 3 commits into from
Apr 8, 2024
Merged

Fix bug in virtual annotation logic for RequiresUnreferencedCode #100707

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c0dfc83
Fix bug in virtual annotation logic for RequiresUnreferencedCode
sbomer Apr 5, 2024
f3db65a
Apply suggestions from code review
sbomer Apr 5, 2024
73366fd
Use tabs
sbomer Apr 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions src/tools/illink/src/linker/Linker.Steps/ValidateVirtualMethodAnnotationsStep.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,11 @@ protected override void Process ()
void ValidateMethodRequiresUnreferencedCodeAreSame (MethodDefinition method, MethodDefinition baseMethod)
{
var annotations = Context.Annotations;
bool methodHasAttribute = annotations.IsInRequiresUnreferencedCodeScope (method, out _);
if (methodHasAttribute != annotations.IsInRequiresUnreferencedCodeScope (baseMethod, out _)) {
string message = MessageFormat.FormatRequiresAttributeMismatch (methodHasAttribute,
baseMethod.DeclaringType.IsInterface, nameof (RequiresUnreferencedCodeAttribute), method.GetDisplayName (), baseMethod.GetDisplayName ());
bool methodSatisfies = annotations.IsInRequiresUnreferencedCodeScope (method, out _);
bool baseRequires = annotations.DoesMethodRequireUnreferencedCode (baseMethod, out _);
if ((baseRequires && !methodSatisfies) || (!baseRequires && annotations.DoesMethodRequireUnreferencedCode (method, out _))) {
string message = MessageFormat.FormatRequiresAttributeMismatch (methodSatisfies,
baseMethod.DeclaringType.IsInterface, nameof (RequiresUnreferencedCodeAttribute), method.GetDisplayName (), baseMethod.GetDisplayName ());
sbomer marked this conversation as resolved.
Show resolved Hide resolved
Context.LogWarning (method, DiagnosticId.RequiresUnreferencedCodeAttributeMismatch, message);
}
}
Expand Down
56 changes: 56 additions & 0 deletions ...st/Mono.Linker.Tests.Cases/DataFlow/VirtualMethodHierarchyDataflowAnnotationValidation.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ public static void Main ()
StaticInterfaceMethods.Test ();
BaseInPreservedScope.Test ();
DirectCall.Test ();
RequiresAndDynamicallyAccessedMembersValidation.Test ();
}

static void RequirePublicMethods ([DynamicallyAccessedMembers (DynamicallyAccessedMemberTypes.PublicMethods)] Type type)
Expand Down Expand Up @@ -1019,6 +1020,61 @@ public static void Test ()
CallStaticGvm<ImplIGvmBase> ();
}
}

class RequiresAndDynamicallyAccessedMembersValidation
{
// These tests have both DynamicallyAccessedMembers annotations and Requires annotations.
// This is to reproduce a bug where the virtual method annotations would be validated due to
// the presence of DynamicallyAccessedMembers, but the logic for checking Requires annotations
// was incorrect. The bug didn't manifest with just Requires annotations because the methods wouldn't
// be validated at all for Requires on type.

class BaseMethodWithRequires
{
[RequiresUnreferencedCode (nameof (MethodWithRequires))]
[RequiresDynamicCode (nameof (MethodWithRequires))]
public virtual void MethodWithRequires ([DynamicallyAccessedMembers (DynamicallyAccessedMemberTypes.All)] Type t) {}
}

[RequiresUnreferencedCode (nameof (DerivedTypeWithRequires_BaseMethodWithRequires))]
[RequiresDynamicCode (nameof (DerivedTypeWithRequires_BaseMethodWithRequires))]
class DerivedTypeWithRequires_BaseMethodWithRequires : BaseMethodWithRequires
{
public override void MethodWithRequires ([DynamicallyAccessedMembers (DynamicallyAccessedMemberTypes.All)] Type t) {}
}

[ExpectedWarning ("IL2026", nameof (DerivedTypeWithRequires_BaseMethodWithRequires))]
[ExpectedWarning ("IL2026", nameof (DerivedTypeWithRequires_BaseMethodWithRequires.MethodWithRequires))]
[ExpectedWarning ("IL3050", nameof (DerivedTypeWithRequires_BaseMethodWithRequires), ProducedBy = Tool.NativeAot | Tool.Analyzer)]
[ExpectedWarning ("IL3050", nameof (DerivedTypeWithRequires_BaseMethodWithRequires.MethodWithRequires), ProducedBy = Tool.NativeAot | Tool.Analyzer)]
static void Test_DerivedTypeWithRequires_BaseMethodWithRequires ()
{
new DerivedTypeWithRequires_BaseMethodWithRequires ().MethodWithRequires (typeof (int));
}

class BaseMethodWithoutRequires
{
public virtual void MethodWithoutRequires ([DynamicallyAccessedMembers (DynamicallyAccessedMemberTypes.All)] Type t) {}
}

[RequiresUnreferencedCode (nameof (DerivedTypeWithRequires_BaseMethodWithoutRequires))]
class DerivedTypeWithRequires_BaseMethodWithoutRequires : BaseMethodWithoutRequires
{
public override void MethodWithoutRequires ([DynamicallyAccessedMembers (DynamicallyAccessedMemberTypes.All)] Type t) {}
}

[ExpectedWarning ("IL2026", nameof (DerivedTypeWithRequires_BaseMethodWithoutRequires))]
static void Test_DerivedTypeWithRequires_BaseMethodWithoutRequires ()
{
new DerivedTypeWithRequires_BaseMethodWithoutRequires ().MethodWithoutRequires (typeof (int));
}

public static void Test ()
{
Test_DerivedTypeWithRequires_BaseMethodWithRequires ();
Test_DerivedTypeWithRequires_BaseMethodWithoutRequires ();
}
}
}
}

Expand Down
Loading