Skip to content

Commit

Permalink
Tests for calling convention bits on NativeAOT.
Browse files Browse the repository at this point in the history
  • Loading branch information
@AaronRobinsonMSFT
AaronRobinsonMSFT committed Jun 12, 2023
1 parent 5b67d04 commit 3663bad
Show file tree
Hide file tree
Showing 2 changed files with 87 additions and 44 deletions.
112 changes: 70 additions & 42 deletions src/coreclr/tools/Common/TypeSystem/IL/UnsafeAccessors.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -227,51 +227,13 @@ private static bool DoesMethodMatchUnsafeAccessorDeclaration(ref GenerationConte
// If we are, do it first.
if (!ignoreCustomModifiers)
{
// One signature has custom modifiers the other doesn't, no match.
if (declSig.HasEmbeddedSignatureData != maybeSig.HasEmbeddedSignatureData)
// Compare custom modifiers on the signatures.
var declCustomMod = declSig.GetEmbeddedSignatureData(EmbeddedSignatureDataKind.RequiredCustomModifier, EmbeddedSignatureDataKind.OptionalCustomModifier) ?? Array.Empty<EmbeddedSignatureData>();
var maybeCustomMod = maybeSig.GetEmbeddedSignatureData(EmbeddedSignatureDataKind.RequiredCustomModifier, EmbeddedSignatureDataKind.OptionalCustomModifier) ?? Array.Empty<EmbeddedSignatureData>();
if (!CompareEmbeddedData(context.Kind, declCustomMod, maybeCustomMod))
{
return false;
}

// Get all custom modifiers on the signatures.
var declData = declSig.GetEmbeddedSignatureData(EmbeddedSignatureDataKind.RequiredCustomModifier, EmbeddedSignatureDataKind.OptionalCustomModifier);
var maybeData = maybeSig.GetEmbeddedSignatureData(EmbeddedSignatureDataKind.RequiredCustomModifier, EmbeddedSignatureDataKind.OptionalCustomModifier);
if (declData.Length != maybeData.Length)
{
return false;
}

// Validate the custom modifiers match precisely.
for (int i = 0; i < declData.Length; ++i)
{
EmbeddedSignatureData dd = declData[i];
EmbeddedSignatureData md = maybeData[i];
if (dd.kind != md.kind || dd.type != md.type)
{
return false;
}

// The indices on non-constructor declarations require
// some slight modification since there is always an extra
// argument in the declaration compared to the target.
string declIndex = dd.index;
if (context.Kind != UnsafeAccessorKind.Constructor)
{
// Decrement the second to last index by one to
// account for the difference in declarations.
string[] tmp = declIndex.Split('.');
int toUpdate = tmp.Length < 2 ? 0 : tmp.Length - 2;
int idx = int.Parse(tmp[toUpdate], CultureInfo.InvariantCulture);
idx--;
tmp[toUpdate] = idx.ToString();
declIndex = string.Join(".", tmp);
}

if (declIndex != md.index)
{
return false;
}
}
}

// Validate calling convention.
Expand All @@ -281,6 +243,14 @@ private static bool DoesMethodMatchUnsafeAccessorDeclaration(ref GenerationConte
return false;
}

// Compare unmanaged callconv on the signatures.
var declUnmanaged = declSig.GetEmbeddedSignatureData(EmbeddedSignatureDataKind.UnmanagedCallConv) ?? Array.Empty<EmbeddedSignatureData>();
var maybeUnmanaged = maybeSig.GetEmbeddedSignatureData(EmbeddedSignatureDataKind.UnmanagedCallConv) ?? Array.Empty<EmbeddedSignatureData>();
if (!CompareEmbeddedData(context.Kind, declUnmanaged, maybeUnmanaged))
{
return false;
}

// Validate argument count and return type
if (context.Kind == UnsafeAccessorKind.Constructor)
{
Expand Down Expand Up @@ -330,6 +300,64 @@ private static bool DoesMethodMatchUnsafeAccessorDeclaration(ref GenerationConte
}

return true;

static bool CompareEmbeddedData(
UnsafeAccessorKind kind,
EmbeddedSignatureData[] declData,
EmbeddedSignatureData[] maybeData)
{
if (declData.Length != maybeData.Length)
{
return false;
}

// Validate the custom modifiers match precisely.
for (int i = 0; i < declData.Length; ++i)
{
EmbeddedSignatureData dd = declData[i];
EmbeddedSignatureData md = maybeData[i];
if (dd.kind != md.kind || dd.type != md.type)
{
return false;
}

// The indices on non-constructor declarations require
// some slight modification since there is always an extra
// argument in the declaration compared to the target.
string declIndex = dd.index;
if (kind != UnsafeAccessorKind.Constructor)
{
string unmanagedCallConvMaybe = string.Empty;

// Check for and drop the unmanaged calling convention
// value suffix to add it back after updating below.
if (declIndex.Contains('|'))
{
Debug.Assert(dd.kind == EmbeddedSignatureDataKind.UnmanagedCallConv);
var tmp = declIndex.Split('|');
Debug.Assert(tmp.Length == 2);
declIndex = tmp[0];
unmanagedCallConvMaybe = "|" + tmp[1];
}

// Decrement the second to last index by one to
// account for the difference in declarations.
string[] lvls = declIndex.Split('.');
int toUpdate = lvls.Length < 2 ? 0 : lvls.Length - 2;
int idx = int.Parse(lvls[toUpdate], CultureInfo.InvariantCulture);
idx--;
lvls[toUpdate] = idx.ToString();
declIndex = string.Join(".", lvls) + unmanagedCallConvMaybe;
}

if (declIndex != md.index)
{
return false;
}
}

return true;
}
}

private static bool TrySetTargetMethod(ref GenerationContext context, string name, out bool isAmbiguous, bool ignoreCustomModifiers = true)
Expand Down
19 changes: 17 additions & 2 deletions src/tests/baseservices/compilerservices/UnsafeAccessors/UnsafeAccessorsTests.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ class UserDataClass
public const string MethodVoidName = nameof(_mvv);
public const string MethodNameAmbiguous = nameof(_Ambiguous);
public const string MethodPointerName = nameof(_Pointer);
public const string MethodCallConvBitsName = nameof(_CallConvBits);

private static string _F = PrivateStatic;
private string _f;
Expand All @@ -43,11 +44,15 @@ private void _mvv() {}
private string Prop { get; init; }

// Used to validate ambiguity is handled via custom modifiers.
private string _Ambiguous(delegate* unmanaged[Cdecl, MemberFunction]<void> fptr) { return nameof(CallConvCdecl); }
private string _Ambiguous(delegate* unmanaged[Stdcall, MemberFunction]<void> fptr) { return nameof(CallConvStdcall); }
private string _Ambiguous(delegate* unmanaged[Cdecl, MemberFunction]<void> fptr) => nameof(CallConvCdecl);
private string _Ambiguous(delegate* unmanaged[Stdcall, MemberFunction]<void> fptr) => nameof(CallConvStdcall);

// Used to validate pointer values.
private static string _Pointer(void* ptr) => "void*";

// Used to validate the embedded callconv bits (non-unmanaged bit) in
// ECMA-335 signatures for methods.
private static string _CallConvBits(delegate* unmanaged[Cdecl]<void> fptr) => nameof(CallConvCdecl);
}

[StructLayout(LayoutKind.Sequential)]
Expand Down Expand Up @@ -347,6 +352,10 @@ public static void Verify_InvalidTargetUnsafeAccessor()
isNativeAot ? null : UserDataClass.MethodPointerName,
() => CallPointerMethod(null, null));

AssertExtensions.ThrowsMissingMemberException<MissingMethodException>(
isNativeAot ? null : UserDataClass.MethodCallConvBitsName,
() => CallCallConvBitsMethod(null, null));

Assert.Throws<AmbiguousMatchException>(
() => CallAmbiguousMethod(CallPrivateConstructorClass(), null));

Expand All @@ -366,6 +375,12 @@ public static void Verify_InvalidTargetUnsafeAccessor()
[UnsafeAccessor(UnsafeAccessorKind.StaticMethod, Name=UserDataClass.MethodPointerName)]
extern static string CallPointerMethod(UserDataClass d, delegate* unmanaged[Stdcall]<void> fptr);

// This is used to validate the ECMA-335 calling convention bits are checked
// before checking the custom modifiers that encode the calling conventions
// when there is more than one or one option doesn't have an existing bit.
[UnsafeAccessor(UnsafeAccessorKind.Method, Name=UserDataClass.MethodCallConvBitsName)]
extern static string CallCallConvBitsMethod(UserDataClass d, delegate* unmanaged[Cdecl, SuppressGCTransition]<void> fptr);

// This is an ambiguous match since there are two methods each with two custom modifiers.
// Therefore the default "ignore custom modifiers" logic fails. The fallback is for a
// precise match and that also fails because the custom modifiers don't match precisely.
Expand Down

0 comments on commit 3663bad

Please sign in to comment.