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

Implement support for collections of collections marshalling #1226

Merged
merged 16 commits into from
Jun 12, 2021
Merged

Implement support for collections of collections marshalling #1226

Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
156e741
Refactor indexer naming to be nested-collection safe.
jkoritzinsky Jun 3, 2021
013cb74
Implement initial collections-of-collections/jagged array support.
jkoritzinsky Jun 3, 2021
4eebc40
Fixes for edge cases around HResult/Exception handling.
jkoritzinsky Jun 4, 2021
495bff9
Flip the edgeMap indices so we can use Array.IndexOf (which is optimi…
jkoritzinsky Jun 4, 2021
128cb9a
Comments and optimizations.
jkoritzinsky Jun 4, 2021
c3d0f5b
Add citation for algorithm,
jkoritzinsky Jun 4, 2021
7584958
Hoist elementIndex out of the loop.
jkoritzinsky Jun 4, 2021
d154d04
Encapsulate the edgeMap in a private struct type and add some simple …
jkoritzinsky Jun 4, 2021
7bff6ff
Make Topological sort more flexible for element ids
jkoritzinsky Jun 4, 2021
7f2ac8a
Use native index if managed index is unset to allow handling multiple…
jkoritzinsky Jun 4, 2021
eca53e7
Fix using the return value for passing collection size. Validate the …
jkoritzinsky Jun 4, 2021
81612c2
Change how we initialize the numRows array.
jkoritzinsky Jun 10, 2021
c4bc9c3
Fix cycle breaking in count info.
jkoritzinsky Jun 10, 2021
a159031
Update nested indexer creation for num elements expressions to handle…
jkoritzinsky Jun 10, 2021
749f85b
Add stress test for collections of collections that uses 0-11 nested …
jkoritzinsky Jun 10, 2021
65eb0a6
PR feedback.
jkoritzinsky Jun 11, 2021
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
35 changes: 35 additions & 0 deletions DllImportGenerator/DllImportGenerator.IntegrationTests/ArrayTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,11 @@ public partial class Arrays
[GeneratedDllImport(NativeExportsNE_Binary, EntryPoint = "and_all_members")]
[return:MarshalAs(UnmanagedType.U1)]
public static partial bool AndAllMembers(BoolStruct[] pArray, int length);

[GeneratedDllImport(NativeExportsNE_Binary, EntryPoint = "transpose_matrix")]
[return: MarshalUsing(CountElementName = "numColumns")]
[return: MarshalUsing(CountElementName = "numRows", ElementIndirectionLevel = 1)]
public static partial int[][] TransposeMatrix(int[][] matrix, int[] numRows, int numColumns);
}
}

Expand Down Expand Up @@ -273,6 +278,36 @@ public void ArrayWithSimpleNonBlittableTypeMarshalling(bool result)
Assert.Equal(result, NativeExportsNE.Arrays.AndAllMembers(boolValues, boolValues.Length));
}

[Fact]
public void ArraysOfArrays()
{
var random = new Random(42);
int numRows = random.Next(1, 5);
int numColumns = random.Next(1, 5);
int[][] matrix = new int[numRows][];
for (int i = 0; i < numRows; i++)
{
matrix[i] = new int[numColumns];
for (int j = 0; j < numColumns; j++)
{
matrix[i][j] = random.Next();
}
}

int[] numRowsArray = new int[numColumns];
numRowsArray.AsSpan().Fill(numRows);

int[][] transposed = NativeExportsNE.Arrays.TransposeMatrix(matrix, numRowsArray, numColumns);

for (int i = 0; i < numRows; i++)
{
for (int j = 0; j < numColumns; j++)
{
Assert.Equal(matrix[i][j], transposed[j][i]);
}
}
}

private static string ReverseChars(string value)
{
if (value == null)
Expand Down
77 changes: 77 additions & 0 deletions DllImportGenerator/DllImportGenerator.UnitTests/CodeSnippets.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1330,6 +1330,83 @@ public static partial void Method(
[MarshalUsing(CountElementName=""arr"")] ref int[] arr2
);
}
";

public static string CollectionsOfCollectionsStress => @"
using System.Runtime.InteropServices;
partial class Test
{
[GeneratedDllImport(""DoesNotExist"")]
public static partial void Method(
[MarshalUsing(CountElementName=""arr0"", ElementIndirectionLevel = 0)]
[MarshalUsing(CountElementName=""arr1"", ElementIndirectionLevel = 1)]
[MarshalUsing(CountElementName=""arr2"", ElementIndirectionLevel = 2)]
[MarshalUsing(CountElementName=""arr3"", ElementIndirectionLevel = 3)]
[MarshalUsing(CountElementName=""arr4"", ElementIndirectionLevel = 4)]
[MarshalUsing(CountElementName=""arr5"", ElementIndirectionLevel = 5)]
[MarshalUsing(CountElementName=""arr6"", ElementIndirectionLevel = 6)]
[MarshalUsing(CountElementName=""arr7"", ElementIndirectionLevel = 7)]
[MarshalUsing(CountElementName=""arr8"", ElementIndirectionLevel = 8)]
[MarshalUsing(CountElementName=""arr9"", ElementIndirectionLevel = 9)]
[MarshalUsing(CountElementName=""arr10"", ElementIndirectionLevel = 10)] ref int[][][][][][][][][][][] arr11,
[MarshalUsing(CountElementName=""arr0"", ElementIndirectionLevel = 0)]
[MarshalUsing(CountElementName=""arr1"", ElementIndirectionLevel = 1)]
[MarshalUsing(CountElementName=""arr2"", ElementIndirectionLevel = 2)]
[MarshalUsing(CountElementName=""arr3"", ElementIndirectionLevel = 3)]
[MarshalUsing(CountElementName=""arr4"", ElementIndirectionLevel = 4)]
[MarshalUsing(CountElementName=""arr5"", ElementIndirectionLevel = 5)]
[MarshalUsing(CountElementName=""arr6"", ElementIndirectionLevel = 6)]
[MarshalUsing(CountElementName=""arr7"", ElementIndirectionLevel = 7)]
[MarshalUsing(CountElementName=""arr8"", ElementIndirectionLevel = 8)]
[MarshalUsing(CountElementName=""arr9"", ElementIndirectionLevel = 9)]ref int[][][][][][][][][][] arr10,
[MarshalUsing(CountElementName=""arr0"", ElementIndirectionLevel = 0)]
[MarshalUsing(CountElementName=""arr1"", ElementIndirectionLevel = 1)]
[MarshalUsing(CountElementName=""arr2"", ElementIndirectionLevel = 2)]
[MarshalUsing(CountElementName=""arr3"", ElementIndirectionLevel = 3)]
[MarshalUsing(CountElementName=""arr4"", ElementIndirectionLevel = 4)]
[MarshalUsing(CountElementName=""arr5"", ElementIndirectionLevel = 5)]
[MarshalUsing(CountElementName=""arr6"", ElementIndirectionLevel = 6)]
[MarshalUsing(CountElementName=""arr7"", ElementIndirectionLevel = 7)]
[MarshalUsing(CountElementName=""arr8"", ElementIndirectionLevel = 8)]ref int[][][][][][][][][] arr9,
[MarshalUsing(CountElementName=""arr0"", ElementIndirectionLevel = 0)]
[MarshalUsing(CountElementName=""arr1"", ElementIndirectionLevel = 1)]
[MarshalUsing(CountElementName=""arr2"", ElementIndirectionLevel = 2)]
[MarshalUsing(CountElementName=""arr3"", ElementIndirectionLevel = 3)]
[MarshalUsing(CountElementName=""arr4"", ElementIndirectionLevel = 4)]
[MarshalUsing(CountElementName=""arr5"", ElementIndirectionLevel = 5)]
[MarshalUsing(CountElementName=""arr6"", ElementIndirectionLevel = 6)]
[MarshalUsing(CountElementName=""arr7"", ElementIndirectionLevel = 7)]ref int[][][][][][][][][] arr8,
[MarshalUsing(CountElementName=""arr0"", ElementIndirectionLevel = 0)]
[MarshalUsing(CountElementName=""arr1"", ElementIndirectionLevel = 1)]
[MarshalUsing(CountElementName=""arr2"", ElementIndirectionLevel = 2)]
[MarshalUsing(CountElementName=""arr3"", ElementIndirectionLevel = 3)]
[MarshalUsing(CountElementName=""arr4"", ElementIndirectionLevel = 4)]
[MarshalUsing(CountElementName=""arr5"", ElementIndirectionLevel = 5)]
[MarshalUsing(CountElementName=""arr6"", ElementIndirectionLevel = 6)]ref int[][][][][][][] arr7,
[MarshalUsing(CountElementName=""arr0"", ElementIndirectionLevel = 0)]
[MarshalUsing(CountElementName=""arr1"", ElementIndirectionLevel = 1)]
[MarshalUsing(CountElementName=""arr2"", ElementIndirectionLevel = 2)]
[MarshalUsing(CountElementName=""arr3"", ElementIndirectionLevel = 3)]
[MarshalUsing(CountElementName=""arr4"", ElementIndirectionLevel = 4)]
[MarshalUsing(CountElementName=""arr5"", ElementIndirectionLevel = 5)]ref int[][][][][][] arr6,
[MarshalUsing(CountElementName=""arr0"", ElementIndirectionLevel = 0)]
[MarshalUsing(CountElementName=""arr1"", ElementIndirectionLevel = 1)]
[MarshalUsing(CountElementName=""arr2"", ElementIndirectionLevel = 2)]
[MarshalUsing(CountElementName=""arr3"", ElementIndirectionLevel = 3)]
[MarshalUsing(CountElementName=""arr4"", ElementIndirectionLevel = 4)]ref int[][][][][] arr5,
[MarshalUsing(CountElementName=""arr0"", ElementIndirectionLevel = 0)]
[MarshalUsing(CountElementName=""arr1"", ElementIndirectionLevel = 1)]
[MarshalUsing(CountElementName=""arr2"", ElementIndirectionLevel = 2)]
[MarshalUsing(CountElementName=""arr3"", ElementIndirectionLevel = 3)]ref int[][][][] arr4,
[MarshalUsing(CountElementName=""arr0"", ElementIndirectionLevel = 0)]
[MarshalUsing(CountElementName=""arr1"", ElementIndirectionLevel = 1)]
[MarshalUsing(CountElementName=""arr2"", ElementIndirectionLevel = 2)]ref int[][][] arr3,
[MarshalUsing(CountElementName=""arr0"", ElementIndirectionLevel = 0)]
[MarshalUsing(CountElementName=""arr1"", ElementIndirectionLevel = 1)]ref int[][] arr2,
[MarshalUsing(CountElementName=""arr0"", ElementIndirectionLevel = 0)]ref int[] arr1,
ref int arr0
);
}
";
}
}
1 change: 1 addition & 0 deletions DllImportGenerator/DllImportGenerator.UnitTests/Compiles.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,7 @@ public static IEnumerable<object[]> CodeSnippetsToCompile()
yield return new[] { CodeSnippets.CustomCollectionCustomMarshallerParametersAndModifiers<UIntPtr>() };
yield return new[] { CodeSnippets.CustomCollectionCustomMarshallerReturnValueLength<int>() };
yield return new[] { CodeSnippets.GenericCollectionWithCustomElementMarshalling };
yield return new[] { CodeSnippets.CollectionsOfCollectionsStress };
}

[Theory]
Expand Down
6 changes: 6 additions & 0 deletions DllImportGenerator/DllImportGenerator/Analyzers/ManualTypeMarshallingAnalyzer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,12 @@ public void AnalyzeReturnType(SymbolAnalysisContext context)

private void AnalyzeNativeMarshalerType(SymbolAnalysisContext context, ITypeSymbol type, AttributeData nativeMarshalerAttributeData, bool validateManagedGetPinnableReference, bool validateAllScenarioSupport)
{
if (nativeMarshalerAttributeData.ConstructorArguments.Length == 0)
{
// This is a MarshalUsing with just count information.
return;
}

if (nativeMarshalerAttributeData.ConstructorArguments[0].IsNull)
{
context.ReportDiagnostic(
Expand Down
38 changes: 28 additions & 10 deletions DllImportGenerator/DllImportGenerator/ContiguousCollectionElementMarshallingCodeContext.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;

using System.Text;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;
Expand All @@ -12,14 +12,14 @@ namespace Microsoft.Interop
{
internal sealed class ContiguousCollectionElementMarshallingCodeContext : StubCodeContext
{
private readonly string indexerIdentifier;
private readonly string nativeSpanIdentifier;
private readonly StubCodeContext parentContext;

public override bool SingleFrameSpansNativeContext => false;

public override bool AdditionalTemporaryStateLivesAcrossStages => false;

public string IndexerIdentifier { get; }
AaronRobinsonMSFT marked this conversation as resolved.
Show resolved Hide resolved

/// <summary>
/// Create a <see cref="StubCodeContext"/> for marshalling elements of an collection.
/// </summary>
Expand All @@ -29,14 +29,13 @@ internal sealed class ContiguousCollectionElementMarshallingCodeContext : StubCo
/// <param name="parentContext">The parent context.</param>
public ContiguousCollectionElementMarshallingCodeContext(
Stage currentStage,
string indexerIdentifier,
string nativeSpanIdentifier,
StubCodeContext parentContext)
{
CurrentStage = currentStage;
this.indexerIdentifier = indexerIdentifier;
IndexerIdentifier = CalculateIndexerIdentifierBasedOnParentContext(parentContext);
this.nativeSpanIdentifier = nativeSpanIdentifier;
this.parentContext = parentContext;
ParentContext = parentContext;
}

/// <summary>
Expand All @@ -46,22 +45,41 @@ public ContiguousCollectionElementMarshallingCodeContext(
/// <returns>Managed and native identifiers</returns>
public override (string managed, string native) GetIdentifiers(TypePositionInfo info)
{
var (_, native) = parentContext.GetIdentifiers(info);
var (_, native) = ParentContext!.GetIdentifiers(info);
return (
$"{native}.ManagedValues[{indexerIdentifier}]",
$"{nativeSpanIdentifier}[{indexerIdentifier}]"
$"{native}.ManagedValues[{IndexerIdentifier}]",
$"{nativeSpanIdentifier}[{IndexerIdentifier}]"
);
}

public override string GetAdditionalIdentifier(TypePositionInfo info, string name)
{
return $"{nativeSpanIdentifier}__{indexerIdentifier}__{name}";
return $"{nativeSpanIdentifier}__{IndexerIdentifier}__{name}";
}

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;
}

private static string CalculateIndexerIdentifierBasedOnParentContext(StubCodeContext? parentContext)
{
int i = 0;
while (parentContext is StubCodeContext context)
{
if (context is ContiguousCollectionElementMarshallingCodeContext)
{
i++;
}
parentContext = context.ParentContext;
}

// Follow a progression of indexers of the following form:
// __i, __j, __k, __ii, __jj, __kk, etc.
StringBuilder indexerIdentifier = new StringBuilder("__");
indexerIdentifier.Append((char)('i' + (i % 3)), 1 + (i / 3));
AaronRobinsonMSFT marked this conversation as resolved.
Show resolved Hide resolved
return indexerIdentifier.ToString();
}
}
}
27 changes: 8 additions & 19 deletions DllImportGenerator/DllImportGenerator/Marshalling/ICustomNativeTypeMarshallingStrategy.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,26 +127,24 @@ public IEnumerable<StatementSyntax> GeneratePinStatements(TypePositionInfo info,
/// </summary>
internal class CustomNativeTypeWithValuePropertyStubContext : StubCodeContext
{
private readonly StubCodeContext parentContext;

public CustomNativeTypeWithValuePropertyStubContext(StubCodeContext parentContext)
{
this.parentContext = parentContext;
ParentContext = parentContext;
CurrentStage = parentContext.CurrentStage;
}

public override bool SingleFrameSpansNativeContext => parentContext.SingleFrameSpansNativeContext;
public override bool SingleFrameSpansNativeContext => ParentContext!.SingleFrameSpansNativeContext;
AaronRobinsonMSFT marked this conversation as resolved.
Show resolved Hide resolved

public override bool AdditionalTemporaryStateLivesAcrossStages => parentContext.AdditionalTemporaryStateLivesAcrossStages;
public override bool AdditionalTemporaryStateLivesAcrossStages => ParentContext!.AdditionalTemporaryStateLivesAcrossStages;

public override TypePositionInfo? GetTypePositionInfoForManagedIndex(int index)
{
return parentContext.GetTypePositionInfoForManagedIndex(index);
return ParentContext!.GetTypePositionInfoForManagedIndex(index);
}

public override (string managed, string native) GetIdentifiers(TypePositionInfo info)
{
return (parentContext.GetIdentifiers(info).managed, MarshallerHelpers.GetMarshallerIdentifier(info, parentContext));
return (ParentContext!.GetIdentifiers(info).managed, MarshallerHelpers.GetMarshallerIdentifier(info, ParentContext));
}
}

Expand Down Expand Up @@ -859,8 +857,6 @@ public bool UsesNativeIdentifier(TypePositionInfo info, StubCodeContext context)
/// </summary>
internal sealed class ContiguousNonBlittableElementCollectionMarshalling : ICustomNativeTypeMarshallingStrategy
{
private const string IndexerIdentifier = "__i";

private readonly ICustomNativeTypeMarshallingStrategy innerMarshaller;
private readonly IMarshallingGenerator elementMarshaller;
private readonly TypePositionInfo elementInfo;
Expand All @@ -874,15 +870,10 @@ public ContiguousNonBlittableElementCollectionMarshalling(ICustomNativeTypeMarsh
this.elementInfo = elementInfo;
}

private string GetNativeSpanIdentifier(TypePositionInfo info, StubCodeContext context)
{
return context.GetAdditionalIdentifier(info, "nativeSpan");
}

private LocalDeclarationStatementSyntax GenerateNativeSpanDeclaration(TypePositionInfo info, StubCodeContext context)
{
string nativeIdentifier = context.GetIdentifiers(info).native;
string nativeSpanIdentifier = GetNativeSpanIdentifier(info, context);
string nativeSpanIdentifier = MarshallerHelpers.GetNativeSpanIdentifier(info, context);
return LocalDeclarationStatement(VariableDeclaration(
GenericName(
Identifier(TypeNames.System_Span),
Expand Down Expand Up @@ -915,15 +906,13 @@ private LocalDeclarationStatementSyntax GenerateNativeSpanDeclaration(TypePositi
private StatementSyntax GenerateContentsMarshallingStatement(TypePositionInfo info, StubCodeContext context, bool useManagedSpanForLength)
{
string nativeIdentifier = context.GetIdentifiers(info).native;
string nativeSpanIdentifier = GetNativeSpanIdentifier(info, context);
string nativeSpanIdentifier = MarshallerHelpers.GetNativeSpanIdentifier(info, context);
var elementSetupSubContext = new ContiguousCollectionElementMarshallingCodeContext(
StubCodeContext.Stage.Setup,
IndexerIdentifier,
nativeSpanIdentifier,
context);
var elementSubContext = new ContiguousCollectionElementMarshallingCodeContext(
context.CurrentStage,
IndexerIdentifier,
nativeSpanIdentifier,
context);

Expand Down Expand Up @@ -956,7 +945,7 @@ private StatementSyntax GenerateContentsMarshallingStatement(TypePositionInfo in
// Iterate through the elements of the native collection to unmarshal them
return Block(
GenerateNativeSpanDeclaration(info, context),
MarshallerHelpers.GetForLoop(collectionIdentifierForLength, IndexerIdentifier)
MarshallerHelpers.GetForLoop(collectionIdentifierForLength, elementSubContext.IndexerIdentifier)
.WithStatement(marshallingStatement));
}
return EmptyStatement();
Expand Down
Loading