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.

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

Array marshalling support #272

Merged
merged 20 commits into from
Nov 3, 2020
Merged
Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
5005abb
Simplify pattern matching syntax to improve readability.
jkoritzinsky Oct 20, 2020
ea0fbe4
Start work on the array marshaller.
jkoritzinsky Oct 21, 2020
74262b1
Merge branch 'DllImportGenerator' of github.com:dotnet/runtimelab int…
jkoritzinsky Oct 21, 2020
c33cfa0
Refactor conditional stackalloc codegen and make more progress on arr…
jkoritzinsky Oct 22, 2020
bed4ede
Finish first pass implementation of array marshalling.
jkoritzinsky Oct 23, 2020
cf26379
Add basic codegen tests for array marshalling.
jkoritzinsky Oct 26, 2020
3b3fb06
Add some tests for nested marshalling info for array elements.
jkoritzinsky Oct 26, 2020
63124a3
Add array execution tests
jkoritzinsky Oct 26, 2020
6a600ea
Merge branch 'feature/DllImportGenerator' of github.com:dotnet/runtim…
jkoritzinsky Oct 26, 2020
a7c315f
Regenerate solution file to get building locallly working again.
jkoritzinsky Oct 27, 2020
ff0e489
PR feedback.
jkoritzinsky Oct 27, 2020
ba474bd
Split array marshalling data from non-array marshalling data. Make it…
jkoritzinsky Oct 28, 2020
2b48568
Document optional features in Pipeline.md.
jkoritzinsky Oct 28, 2020
cede765
Update docs.
jkoritzinsky Oct 29, 2020
ba40d14
Add compile-fails test for SafeArray.
jkoritzinsky Oct 29, 2020
da1c0c7
Add non-blittable array by value marshalling test.
jkoritzinsky Oct 29, 2020
6e04af4
Use Span<T>(T[]) constructor instead of using the extension method an…
jkoritzinsky Oct 29, 2020
bc9b95f
Invert if condition.
jkoritzinsky Oct 29, 2020
955d99e
Merge branch 'feature/DllImportGenerator' of github.com:dotnet/runtim…
jkoritzinsky Nov 2, 2020
1423c6a
Add better null handling and add more comments.
jkoritzinsky Nov 2, 2020
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
149 changes: 149 additions & 0 deletions DllImportGenerator/DllImportGenerator.IntegrationTests/ArrayTests.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Runtime.InteropServices;
using System.Text;

using Xunit;

namespace DllImportGenerator.IntegrationTests
{
partial class NativeExportsNE
{
public partial class Arrays
{
[GeneratedDllImport(nameof(NativeExportsNE), EntryPoint = "sum_int_array")]
public static partial int Sum(int[] values, int numValues);

[GeneratedDllImport(nameof(NativeExportsNE), EntryPoint = "sum_int_array_ref")]
public static partial int SumInArray(in int[] values, int numValues);

[GeneratedDllImport(nameof(NativeExportsNE), EntryPoint = "duplicate_int_array")]
public static partial void Duplicate([MarshalAs(UnmanagedType.LPArray, SizeParamIndex = 1)] ref int[] values, int numValues);

[GeneratedDllImport(nameof(NativeExportsNE), EntryPoint = "create_range_array")]
[return:MarshalAs(UnmanagedType.LPArray, SizeParamIndex = 2)]
public static partial int[] CreateRange(int start, int end, out int numValues);

[GeneratedDllImport(nameof(NativeExportsNE), EntryPoint = "sum_string_lengths")]
public static partial int SumStringLengths([MarshalAs(UnmanagedType.LPArray, ArraySubType = UnmanagedType.LPWStr)] string[] strArray);

[GeneratedDllImport(nameof(NativeExportsNE), EntryPoint = "reverse_strings")]
public static partial void ReverseStrings([MarshalAs(UnmanagedType.LPArray, ArraySubType = UnmanagedType.LPWStr, SizeParamIndex = 1)] ref string[] strArray, out int numElements);

[GeneratedDllImport(nameof(NativeExportsNE), EntryPoint = "get_long_bytes")]
[return:MarshalAs(UnmanagedType.LPArray, SizeConst = sizeof(long))]
public static partial byte[] GetLongBytes(long l);

[GeneratedDllImport(nameof(NativeExportsNE), EntryPoint = "append_int_to_array")]
public static partial void Append([MarshalAs(UnmanagedType.LPArray, SizeConst = 1, SizeParamIndex = 1)] ref int[] values, int numOriginalValues, int newValue);
}
}

public class ArrayTests
{
[Fact]
public void IntArrayMarshalledToNativeAsExpected()
{
var array = new [] { 1, 5, 79, 165, 32, 3 };
Assert.Equal(array.Sum(), NativeExportsNE.Arrays.Sum(array, array.Length));
}

[Fact]
public void ZeroLengthArrayMarshalledAsNonNull()
{
var array = new int[0];
Assert.Equal(0, NativeExportsNE.Arrays.Sum(array, array.Length));
}

[Fact]
public void IntArrayInParameter()
{
var array = new[] { 1, 5, 79, 165, 32, 3 };
Assert.Equal(array.Sum(), NativeExportsNE.Arrays.SumInArray(array, array.Length));
}

[Fact]
public void IntArrayRefParameter()
{
var array = new [] { 1, 5, 79, 165, 32, 3 };
var newArray = array;
NativeExportsNE.Arrays.Duplicate(ref newArray, array.Length);
Assert.Equal((IEnumerable<int>)array, newArray);
}

[Fact]
public void ArraysReturnedFromNative()
{
int start = 5;

int end = 20;

Assert.Equal(Enumerable.Range(start, end - start), NativeExportsNE.Arrays.CreateRange(start, end, out _));
}

[Fact]
public void NullArrayReturnedFromNative()
{
Assert.Null(NativeExportsNE.Arrays.CreateRange(1, 0, out _));
}

private static string[] GetStringArray()
{
return new []
{
"ABCdef 123$%^",
"🍜 !! 🍜 !!",
"🌲 木 🔥 火 🌾 土 🛡 金 🌊 水" ,
"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed vitae posuere mauris, sed ultrices leo. Suspendisse potenti. Mauris enim enim, blandit tincidunt consequat in, varius sit amet neque. Morbi eget porttitor ex. Duis mattis aliquet ante quis imperdiet. Duis sit.",
string.Empty,
null
};
}

[Fact]
public void ByValueArrayWithElementMarshalling()
{
var strings = GetStringArray();
Assert.Equal(strings.Sum(str => str?.Length ?? 0), NativeExportsNE.Arrays.SumStringLengths(strings));
}

[Fact]
public void ByRefArrayWithElementMarshalling()
{
var strings = GetStringArray();
var expectedStrings = strings.Select(s => ReverseChars(s)).ToArray();
NativeExportsNE.Arrays.ReverseStrings(ref strings, out _);

Assert.Equal((IEnumerable<string>)expectedStrings, strings);
}

[Fact]
public void ConstantSizeArray()
{
var longVal = 0x12345678ABCDEF10L;

Assert.Equal(longVal, MemoryMarshal.Read<long>(NativeExportsNE.Arrays.GetLongBytes(longVal)));
}

[Fact]
public void DynamicSizedArrayWithConstantComponent()
{
var array = new [] { 1, 5, 79, 165, 32, 3 };
int newValue = 42;
var newArray = array;
NativeExportsNE.Arrays.Append(ref newArray, array.Length, newValue);
Assert.Equal(array.Concat(new [] { newValue }), newArray);
}

private static string ReverseChars(string value)
{
if (value == null)
return null;

var chars = value.ToCharArray();
Array.Reverse(chars);
return new string(chars);
}
}
}
44 changes: 44 additions & 0 deletions DllImportGenerator/DllImportGenerator.UnitTests/CodeSnippets.cs
Original file line number Diff line number Diff line change
Expand Up @@ -402,5 +402,49 @@ struct MyStruct<T>
private T t;
private short s;
}";

public static string ArrayParametersAndModifiers(string elementType) => $@"
using System.Runtime.InteropServices;
partial class Test
{{
[GeneratedDllImport(""DoesNotExist"")]
[return:MarshalAs(UnmanagedType.LPArray, SizeConst=10)]
public static partial {elementType}[] Method(
{elementType}[] p,
in {elementType}[] pIn,
int pRefSize,
[MarshalAs(UnmanagedType.LPArray, SizeParamIndex=2)] ref {elementType}[] pRef,
[MarshalAs(UnmanagedType.LPArray, SizeParamIndex=5, SizeConst=4)] out {elementType}[] pOut,
out int pOutSize
);
}}";

public static string ArrayParametersAndModifiers<T>() => ArrayParametersAndModifiers(typeof(T).ToString());

public static string ArrayParameterWithSizeParam(string sizeParamType, bool isByRef) => $@"
using System.Runtime.InteropServices;
partial class Test
{{
[GeneratedDllImport(""DoesNotExist"")]
public static partial void Method(
{(isByRef ? "ref" : "")} {sizeParamType} pRefSize,
[MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)] ref int[] pRef
);
}}";

public static string ArrayParameterWithSizeParam<T>(bool isByRef) => ArrayParameterWithSizeParam(typeof(T).ToString(), isByRef);


public static string ArrayParameterWithNestedMarshalInfo(string elementType, UnmanagedType nestedMarshalInfo) => $@"
using System.Runtime.InteropServices;
partial class Test
{{
[GeneratedDllImport(""DoesNotExist"")]
public static partial void Method(
[MarshalAs(UnmanagedType.LPArray, ArraySubType=UnmanagedType.{nestedMarshalInfo})] {elementType}[] pRef
);
}}";

public static string ArrayParameterWithNestedMarshalInfo<T>(UnmanagedType nestedMarshalType) => ArrayParameterWithNestedMarshalInfo(typeof(T).ToString(), nestedMarshalType);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ public static IEnumerable<object[]> CodeSnippetsToCompile()
// Unsupported UnmanagedType
yield return new object[] { CodeSnippets.MarshalAsParametersAndModifiers<char>(UnmanagedType.I1), 5, 0 };
yield return new object[] { CodeSnippets.MarshalAsParametersAndModifiers<char>(UnmanagedType.U1), 5, 0 };
yield return new object[] { CodeSnippets.MarshalAsParametersAndModifiers<int[]>(UnmanagedType.SafeArray), 10, 0 };

// Unsupported MarshalAsAttribute usage
// * UnmanagedType.CustomMarshaler, MarshalTypeRef, MarshalType, MarshalCookie
Expand Down
55 changes: 40 additions & 15 deletions DllImportGenerator/DllImportGenerator.UnitTests/Compiles.cs
Original file line number Diff line number Diff line change
Expand Up @@ -33,21 +33,39 @@ public static IEnumerable<object[]> CodeSnippetsToCompile_NoDiagnostics()
yield return new[] { CodeSnippets.BasicParametersAndModifiers<bool>() };
yield return new[] { CodeSnippets.BasicParametersAndModifiers<IntPtr>() };
yield return new[] { CodeSnippets.BasicParametersAndModifiers<UIntPtr>() };
//yield return new[] { CodeSnippets.BasicParametersAndModifiers<byte[]>() };
//yield return new[] { CodeSnippets.BasicParametersAndModifiers<sbyte[]>() };
//yield return new[] { CodeSnippets.BasicParametersAndModifiers<short[]>() };
//yield return new[] { CodeSnippets.BasicParametersAndModifiers<ushort[]>() };
//yield return new[] { CodeSnippets.BasicParametersAndModifiers<int[]>() };
//yield return new[] { CodeSnippets.BasicParametersAndModifiers<uint[]>() };
//yield return new[] { CodeSnippets.BasicParametersAndModifiers<long[]>() };
//yield return new[] { CodeSnippets.BasicParametersAndModifiers<ulong[]>() };
//yield return new[] { CodeSnippets.BasicParametersAndModifiers<float[]>() };
//yield return new[] { CodeSnippets.BasicParametersAndModifiers<double[]>() };
//yield return new[] { CodeSnippets.BasicParametersAndModifiers<bool[]>() };
//yield return new[] { CodeSnippets.BasicParametersAndModifiers<char[]>() };
//yield return new[] { CodeSnippets.BasicParametersAndModifiers<string[]>() };
//yield return new[] { CodeSnippets.BasicParametersAndModifiers<IntPtr[]>() };
//yield return new[] { CodeSnippets.BasicParametersAndModifiers<UIntPtr[]>() };
yield return new[] { CodeSnippets.ArrayParametersAndModifiers<byte>() };
yield return new[] { CodeSnippets.ArrayParametersAndModifiers<sbyte>() };
yield return new[] { CodeSnippets.ArrayParametersAndModifiers<short>() };
yield return new[] { CodeSnippets.ArrayParametersAndModifiers<ushort>() };
yield return new[] { CodeSnippets.ArrayParametersAndModifiers<int>() };
yield return new[] { CodeSnippets.ArrayParametersAndModifiers<uint>() };
yield return new[] { CodeSnippets.ArrayParametersAndModifiers<long>() };
yield return new[] { CodeSnippets.ArrayParametersAndModifiers<ulong>() };
yield return new[] { CodeSnippets.ArrayParametersAndModifiers<float>() };
yield return new[] { CodeSnippets.ArrayParametersAndModifiers<double>() };
yield return new[] { CodeSnippets.ArrayParametersAndModifiers<bool>() };
yield return new[] { CodeSnippets.ArrayParametersAndModifiers<IntPtr>() };
yield return new[] { CodeSnippets.ArrayParametersAndModifiers<UIntPtr>() };
yield return new[] { CodeSnippets.ArrayParameterWithSizeParam<byte>(isByRef: false) };
yield return new[] { CodeSnippets.ArrayParameterWithSizeParam<sbyte>(isByRef: false) };
yield return new[] { CodeSnippets.ArrayParameterWithSizeParam<short>(isByRef: false) };
yield return new[] { CodeSnippets.ArrayParameterWithSizeParam<ushort>(isByRef: false) };
yield return new[] { CodeSnippets.ArrayParameterWithSizeParam<int>(isByRef: false) };
yield return new[] { CodeSnippets.ArrayParameterWithSizeParam<uint>(isByRef: false) };
yield return new[] { CodeSnippets.ArrayParameterWithSizeParam<long>(isByRef: false) };
yield return new[] { CodeSnippets.ArrayParameterWithSizeParam<ulong>(isByRef: false) };
yield return new[] { CodeSnippets.ArrayParameterWithSizeParam<IntPtr>(isByRef: false) };
yield return new[] { CodeSnippets.ArrayParameterWithSizeParam<UIntPtr>(isByRef: false) };
yield return new[] { CodeSnippets.ArrayParameterWithSizeParam<byte>(isByRef: true) };
yield return new[] { CodeSnippets.ArrayParameterWithSizeParam<sbyte>(isByRef: true) };
yield return new[] { CodeSnippets.ArrayParameterWithSizeParam<short>(isByRef: true) };
yield return new[] { CodeSnippets.ArrayParameterWithSizeParam<ushort>(isByRef: true) };
yield return new[] { CodeSnippets.ArrayParameterWithSizeParam<int>(isByRef: true) };
yield return new[] { CodeSnippets.ArrayParameterWithSizeParam<uint>(isByRef: true) };
yield return new[] { CodeSnippets.ArrayParameterWithSizeParam<long>(isByRef: true) };
yield return new[] { CodeSnippets.ArrayParameterWithSizeParam<ulong>(isByRef: true) };
yield return new[] { CodeSnippets.ArrayParameterWithSizeParam<IntPtr>(isByRef: true) };
yield return new[] { CodeSnippets.ArrayParameterWithSizeParam<UIntPtr>(isByRef: true) };
yield return new[] { CodeSnippets.BasicParametersAndModifiersWithCharSet<char>(CharSet.Unicode) };
yield return new[] { CodeSnippets.BasicParametersAndModifiersWithCharSet<string>(CharSet.Unicode) };
//yield return new[] { CodeSnippets.BasicParametersAndModifiersWithCharSet<string>(CharSet.Ansi) };
Expand All @@ -61,6 +79,8 @@ public static IEnumerable<object[]> CodeSnippetsToCompile_NoDiagnostics()
yield return new[] { CodeSnippets.MarshalAsParametersAndModifiers<string>(UnmanagedType.LPTStr) };
yield return new[] { CodeSnippets.MarshalAsParametersAndModifiers<string>(UnmanagedType.LPUTF8Str) };
//yield return new[] { CodeSnippets.MarshalAsParametersAndModifiers<string>(UnmanagedType.LPStr) };
yield return new[] { CodeSnippets.ArrayParameterWithNestedMarshalInfo<string>(UnmanagedType.LPWStr) };
yield return new[] { CodeSnippets.ArrayParameterWithNestedMarshalInfo<string>(UnmanagedType.LPUTF8Str) };
//yield return new[] { CodeSnippets.EnumParameters };
yield return new[] { CodeSnippets.PreserveSigFalseVoidReturn };
yield return new[] { CodeSnippets.PreserveSigFalse<byte>() };
Expand Down Expand Up @@ -115,11 +135,16 @@ public static IEnumerable<object[]> CodeSnippetsToCompile_WithDiagnostics()
yield return new[] { CodeSnippets.BasicParametersAndModifiers<string[]>() };
yield return new[] { CodeSnippets.BasicParametersAndModifiers<IntPtr[]>() };
yield return new[] { CodeSnippets.BasicParametersAndModifiers<UIntPtr[]>() };

yield return new[] { CodeSnippets.ArrayParameterWithSizeParam<float>(isByRef: false) };
yield return new[] { CodeSnippets.ArrayParameterWithSizeParam<double>(isByRef: false) };
yield return new[] { CodeSnippets.ArrayParameterWithSizeParam<bool>(isByRef: false) };

yield return new[] { CodeSnippets.BasicParametersAndModifiersWithCharSet<string>(CharSet.Ansi) };
yield return new[] { CodeSnippets.BasicParametersAndModifiersWithCharSet<string>(CharSet.Auto) };

yield return new[] { CodeSnippets.MarshalAsParametersAndModifiers<string>(UnmanagedType.LPStr) };
yield return new[] { CodeSnippets.ArrayParameterWithNestedMarshalInfo<string>(UnmanagedType.LPStr) };

yield return new[] { CodeSnippets.EnumParameters };

Expand Down
11 changes: 6 additions & 5 deletions DllImportGenerator/DllImportGenerator.sln
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Demo", "Demo\Demo.csproj",
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Ancillary.Interop", "Ancillary.Interop\Ancillary.Interop.csproj", "{E59F0B6A-1137-4179-A91D-33464A775DEB}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "TestAssets", "TestAssets", "{2CFB9A7A-4AAF-4B6A-8CC8-540F64C3B45F}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "NativeExports", "TestAssets\NativeExports\NativeExports.csproj", "{32FDA079-0E9F-4A36-ADA5-6593B67A54AC}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DllImportGenerator.IntegrationTests", "DllImportGenerator.IntegrationTests\DllImportGenerator.IntegrationTests.csproj", "{162C204A-ED59-4EF3-A5FA-E58CC06FAB4D}"
Expand All @@ -22,7 +20,10 @@ EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "PInvokeDump", "Tools\PInvokeDump\PInvokeDump.csproj", "{6FD4AF19-0CAA-413C-A2BD-C888AA2E8CFB}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Benchmarking", "Tools\Benchmarking\Benchmarking.csproj", "{927F1081-FFE6-4897-9030-D9023F7EE604}"
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SharedTypes", "TestAssets\SharedTypes\SharedTypes.csproj", "{D42D99E6-DA2B-48D5-BEED-F093A8E600BE}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SharedTypes", "TestAssets\SharedTypes\SharedTypes.csproj", "{D42D99E6-DA2B-48D5-BEED-F093A8E600BE}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "TestAssets", "TestAssets", "{C7134A89-8852-4FBE-B426-EFE007C4A819}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Expand Down Expand Up @@ -71,10 +72,10 @@ Global
HideSolutionNode = FALSE
EndGlobalSection
GlobalSection(NestedProjects) = preSolution
{32FDA079-0E9F-4A36-ADA5-6593B67A54AC} = {2CFB9A7A-4AAF-4B6A-8CC8-540F64C3B45F}
{32FDA079-0E9F-4A36-ADA5-6593B67A54AC} = {C7134A89-8852-4FBE-B426-EFE007C4A819}
{6FD4AF19-0CAA-413C-A2BD-C888AA2E8CFB} = {69D56AC9-232B-4E76-B6C1-33A7B06B6855}
{927F1081-FFE6-4897-9030-D9023F7EE604} = {69D56AC9-232B-4E76-B6C1-33A7B06B6855}
{D42D99E6-DA2B-48D5-BEED-F093A8E600BE} = {2CFB9A7A-4AAF-4B6A-8CC8-540F64C3B45F}
{D42D99E6-DA2B-48D5-BEED-F093A8E600BE} = {C7134A89-8852-4FBE-B426-EFE007C4A819}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {5344B739-3A02-402A-8777-0D54DEC4F3BA}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;

using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using static Microsoft.CodeAnalysis.CSharp.SyntaxFactory;

namespace Microsoft.Interop
{
internal sealed class ArrayMarshallingCodeContext : StubCodeContext
{
private readonly string indexerIdentifier;
private readonly StubCodeContext parentContext;

public override bool PinningSupported => false;

public override bool StackSpaceUsable => false;

public override bool CanUseAdditionalTemporaryState => false;

public ArrayMarshallingCodeContext(Stage currentStage, string indexerIdentifier, StubCodeContext parentContext)
{
CurrentStage = currentStage;
this.indexerIdentifier = indexerIdentifier;
this.parentContext = parentContext;
}

/// <summary>
/// Get managed and native instance identifiers for the <paramref name="info"/>
/// </summary>
/// <param name="info">Object for which to get identifiers</param>
/// <returns>Managed and native identifiers</returns>
public override (string managed, string native) GetIdentifiers(TypePositionInfo info)
{
var (managed, native) = parentContext.GetIdentifiers(info);
return ($"{managed}[{indexerIdentifier}]", $"{native}[{indexerIdentifier}]");
}

public override TypePositionInfo? GetTypePositionInfoForManagedIndex(int index)
{
// We don't have parameters to look at when we're in the middle of marshalling an array.
return null;
}
}
}
Loading