Skip to content

Only call Free in unmanaged->managed stubs when ownership has been transfered to the callee#86415

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

Merged
jkoritzinsky merged 9 commits into from
May 23, 2023
Merged

Only call Free in unmanaged->managed stubs when ownership has been transfered to the callee #86415

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
616d53f
Only call Free in unmanaged->managed stubs when ownership has been tr…
jkoritzinsky May 17, 2023
53ea459
Add missing condition
jkoritzinsky May 17, 2023
0d8cf4c
Fix ref parameter marshalling and by-value collection marshalling. Di…
jkoritzinsky May 19, 2023
c3a6fe4
Add test for by-ref collections
jkoritzinsky May 19, 2023
e6c5b22
Fix by-ref collection ownership.
jkoritzinsky May 19, 2023
fcefc57
Fix compilation of stateless by-value out marshalling for unmanaged-t…
jkoritzinsky May 19, 2023
6bb51e1
Add tests for stateful marshaller shapes and update behavior to match…
jkoritzinsky May 22, 2023
32ff447
Fix test failures and remove duplicate test runs.
jkoritzinsky May 22, 2023
14c023b
Uncomment code
jkoritzinsky May 22, 2023
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
1 change: 1 addition & 0 deletions ...s/gen/Microsoft.Interop.SourceGeneration/LinearCollectionElementMarshallingCodeContext.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ public LinearCollectionElementMarshallingCodeContext(
_managedSpanIdentifier = managedSpanIdentifier;
_nativeSpanIdentifier = nativeSpanIdentifier;
ParentContext = parentContext;
Direction = ParentContext.Direction;
}

public override (TargetFramework framework, Version version) GetTargetFramework()
Expand Down
94 changes: 90 additions & 4 deletions ...rosoft.Interop.SourceGeneration/Marshalling/AttributedMarshallingModelGeneratorFactory.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -244,8 +244,22 @@ private IMarshallingGenerator CreateCustomNativeTypeMarshaller(TypePositionInfo
if (marshallerData.Shape.HasFlag(MarshallerShape.CallerAllocatedBuffer))
marshallingStrategy = new StatelessCallerAllocatedBufferMarshalling(marshallingStrategy, marshallerData.MarshallerType.Syntax, marshallerData.BufferElementType.Syntax, isLinearCollectionMarshalling: false);

if (marshallerData.Shape.HasFlag(MarshallerShape.Free))
FreeStrategy freeStrategy = GetFreeStrategy(info, context);

if (freeStrategy == FreeStrategy.FreeOriginal)
{
marshallingStrategy = new StatelessUnmanagedToManagedOwnershipTracking(marshallingStrategy);
}

if (freeStrategy != FreeStrategy.NoFree && marshallerData.Shape.HasFlag(MarshallerShape.Free))
{
marshallingStrategy = new StatelessFreeMarshalling(marshallingStrategy, marshallerData.MarshallerType.Syntax);
}

if (freeStrategy == FreeStrategy.FreeOriginal)
{
marshallingStrategy = new FreeOwnedOriginalValueMarshalling(marshallingStrategy);
}
}

IMarshallingGenerator marshallingGenerator = new CustomTypeMarshallingGenerator(marshallingStrategy, enableByValueContentsMarshalling: false);
Expand DownExpand Up@@ -311,19 +325,42 @@ private IMarshallingGenerator CreateNativeCollectionMarshaller(
marshallingStrategy = new StatefulCallerAllocatedBufferMarshalling(marshallingStrategy, marshallerTypeSyntax, bufferElementTypeSyntax);
}

FreeStrategy freeStrategy = GetFreeStrategy(info, context);
IElementsMarshallingCollectionSource collectionSource = new StatefulLinearCollectionSource();
IElementsMarshalling elementsMarshalling = CreateElementsMarshalling(marshallerData, elementInfo, elementMarshaller, unmanagedElementType, collectionSource);

marshallingStrategy = new StatefulLinearCollectionMarshalling(marshallingStrategy, marshallerData.Shape, numElementsExpression, elementsMarshalling);
if (freeStrategy == FreeStrategy.FreeOriginal)
{
marshallingStrategy = new StatelessUnmanagedToManagedOwnershipTracking(marshallingStrategy);
}

marshallingStrategy = new StatefulLinearCollectionMarshalling(marshallingStrategy, marshallerData.Shape, numElementsExpression, elementsMarshalling, freeStrategy != FreeStrategy.NoFree);

if (freeStrategy == FreeStrategy.FreeOriginal)
{
marshallingStrategy = new FreeOwnedOriginalValueMarshalling(marshallingStrategy);
}

if (marshallerData.Shape.HasFlag(MarshallerShape.Free))
{
marshallingStrategy = new StatefulFreeMarshalling(marshallingStrategy);
}
}
else
{
marshallingStrategy = new StatelessLinearCollectionSpaceAllocator(marshallerTypeSyntax, nativeType, marshallerData.Shape, numElementsExpression);

FreeStrategy freeStrategy = GetFreeStrategy(info, context);

IElementsMarshallingCollectionSource collectionSource = new StatelessLinearCollectionSource(marshallerTypeSyntax);
if (freeStrategy == FreeStrategy.FreeOriginal)
{
marshallingStrategy = new StatelessUnmanagedToManagedOwnershipTracking(marshallingStrategy);
}

IElementsMarshalling elementsMarshalling = CreateElementsMarshalling(marshallerData, elementInfo, elementMarshaller, unmanagedElementType, collectionSource);

marshallingStrategy = new StatelessLinearCollectionMarshalling(marshallingStrategy, elementsMarshalling, nativeType, marshallerData.Shape);
marshallingStrategy = new StatelessLinearCollectionMarshalling(marshallingStrategy, elementsMarshalling, nativeType, marshallerData.Shape, freeStrategy != FreeStrategy.NoFree);

if (marshallerData.Shape.HasFlag(MarshallerShape.CallerAllocatedBuffer))
{
Expand All@@ -334,8 +371,15 @@ private IMarshallingGenerator CreateNativeCollectionMarshaller(
marshallingStrategy = new StatelessCallerAllocatedBufferMarshalling(marshallingStrategy, marshallerTypeSyntax, bufferElementTypeSyntax, isLinearCollectionMarshalling: true);
}

if (marshallerData.Shape.HasFlag(MarshallerShape.Free))
if (freeStrategy != FreeStrategy.NoFree && marshallerData.Shape.HasFlag(MarshallerShape.Free))
{
marshallingStrategy = new StatelessFreeMarshalling(marshallingStrategy, marshallerTypeSyntax);
}

if (freeStrategy == FreeStrategy.FreeOriginal)
{
marshallingStrategy = new FreeOwnedOriginalValueMarshalling(marshallingStrategy);
}
}

IMarshallingGenerator marshallingGenerator = new CustomTypeMarshallingGenerator(
Expand All@@ -351,6 +395,48 @@ private IMarshallingGenerator CreateNativeCollectionMarshaller(
return marshallingGenerator;
}

private enum FreeStrategy
{
/// <summary>
/// Free the unmanaged value stored in the native identifier.
/// </summary>
FreeNative,
/// <summary>
/// Free the unmanaged value originally passed into the stub.
/// </summary>
FreeOriginal,
/// <summary>
/// Do not free the unmanaged value, we don't own it.
/// </summary>
NoFree
}

private static FreeStrategy GetFreeStrategy(TypePositionInfo info, StubCodeContext context)
{
// When marshalling from managed to unmanaged, we always own the value in the native identifier.
if (context.Direction == MarshalDirection.ManagedToUnmanaged)
{
return FreeStrategy.FreeNative;
}

// When we're in a case where we don't have state across stages, the parent stub context that can track the state
// will only call our Cleanup stage when we own the value in the native identifier.
if (!context.AdditionalTemporaryStateLivesAcrossStages)
{
return FreeStrategy.FreeNative;
}

// In an unmanaged-to-managed stub where a value is passed by 'ref',
// we own the original value once we replace it with the new value we're passing out to the caller.
if (info.RefKind == RefKind.Ref)
{
return FreeStrategy.FreeOriginal;
}

// In an unmanaged-to-managed stub, we don't take ownership of the value when it isn't passed by 'ref'.
return FreeStrategy.NoFree;
}

private static IElementsMarshalling CreateElementsMarshalling(CustomTypeMarshallerData marshallerData, TypePositionInfo elementInfo, IMarshallingGenerator elementMarshaller, TypeSyntax unmanagedElementType, IElementsMarshallingCollectionSource collectionSource)
{
IElementsMarshalling elementsMarshalling;
Expand Down
16 changes: 9 additions & 7 deletions ...InteropServices/gen/Microsoft.Interop.SourceGeneration/Marshalling/ElementsMarshalling.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,9 +22,9 @@ internal interface IElementsMarshallingCollectionSource

internal interface IElementsMarshalling
{
StatementSyntax GenerateByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context);
StatementSyntax GenerateManagedToUnmanagedByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context);
StatementSyntax GenerateMarshalStatement(TypePositionInfo info, StubCodeContext context);
StatementSyntax GenerateByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context);
StatementSyntax GenerateManagedToUnmanagedByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context);
StatementSyntax GenerateUnmarshalStatement(TypePositionInfo info, StubCodeContext context);
StatementSyntax GenerateElementCleanupStatement(TypePositionInfo info, StubCodeContext context);
}
Expand All@@ -45,7 +45,7 @@ public BlittableElementsMarshalling(TypeSyntax managedElementType, TypeSyntax un
_collectionSource = collectionSource;
}

public StatementSyntax GenerateByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
public StatementSyntax GenerateManagedToUnmanagedByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
{
// If the parameter is marshalled by-value [Out], then we don't marshal the contents of the collection.
// We do clear the span, so that if the invoke target doesn't fill it, we aren't left with undefined content.
Expand DownExpand Up@@ -73,7 +73,7 @@ public StatementSyntax GenerateMarshalStatement(TypePositionInfo info, StubCodeC
Argument(destination)));
}

public StatementSyntax GenerateByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
public StatementSyntax GenerateManagedToUnmanagedByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
{
ExpressionSyntax source = CastToManagedIfNecessary(_collectionSource.GetUnmanagedValuesDestination(info, context));

Expand DownExpand Up@@ -175,7 +175,7 @@ public NonBlittableElementsMarshalling(
_collectionSource = collectionSource;
}

public StatementSyntax GenerateByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
public StatementSyntax GenerateManagedToUnmanagedByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
{
// If the parameter is marshalled by-value [Out], then we don't marshal the contents of the collection.
// We do clear the span, so that if the invoke target doesn't fill it, we aren't left with undefined content.
Expand DownExpand Up@@ -259,7 +259,7 @@ public StatementSyntax GenerateUnmarshalStatement(TypePositionInfo info, StubCod
StubCodeContext.Stage.Unmarshal));
}

public StatementSyntax GenerateByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
public StatementSyntax GenerateManagedToUnmanagedByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
{
// Use ManagedSource and NativeDestination spans for by-value marshalling since we're just marshalling back the contents,
// not the array itself.
Expand DownExpand Up@@ -356,7 +356,9 @@ public StatementSyntax GenerateElementCleanupStatement(TypePositionInfo info, St
VariableDeclarator(
Identifier(nativeSpanIdentifier))
.WithInitializer(EqualsValueClause(
_collectionSource.GetUnmanagedValuesDestination(info, context)))))),
context.Direction == MarshalDirection.ManagedToUnmanaged
? _collectionSource.GetUnmanagedValuesDestination(info, context)
: _collectionSource.GetUnmanagedValuesSource(info, context)))))),
contentsCleanupStatements);
}

Expand Down
2 changes: 1 addition & 1 deletion ...en/Microsoft.Interop.SourceGeneration/Marshalling/MarshalAsMarshallingGeneratorFactory.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -88,7 +88,7 @@ public IMarshallingGenerator Create(
return s_delegate;

case { MarshallingAttributeInfo: SafeHandleMarshallingInfo(_, bool isAbstract) }:
if (!context.AdditionalTemporaryStateLivesAcrossStages)
if (!context.AdditionalTemporaryStateLivesAcrossStages || context.Direction != MarshalDirection.ManagedToUnmanaged)
{
throw new MarshallingNotSupportedException(info, context);
}
Expand Down
77 changes: 60 additions & 17 deletions ...ervices/gen/Microsoft.Interop.SourceGeneration/Marshalling/StatefulMarshallingStrategy.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -372,40 +372,36 @@ internal sealed class StatefulLinearCollectionMarshalling : ICustomTypeMarshalli
private readonly MarshallerShape _shape;
private readonly ExpressionSyntax _numElementsExpression;
private readonly IElementsMarshalling _elementsMarshalling;
private readonly bool _cleanupElements;

public StatefulLinearCollectionMarshalling(
ICustomTypeMarshallingStrategy innerMarshaller,
MarshallerShape shape,
ExpressionSyntax numElementsExpression,
IElementsMarshalling elementsMarshalling)
IElementsMarshalling elementsMarshalling,
bool cleanupElements)
{
_innerMarshaller = innerMarshaller;
_shape = shape;
_numElementsExpression = numElementsExpression;
_elementsMarshalling = elementsMarshalling;
_cleanupElements = cleanupElements;
}

public ManagedTypeInfo AsNativeType(TypePositionInfo info) => _innerMarshaller.AsNativeType(info);
public IEnumerable<StatementSyntax> GenerateCleanupStatements(TypePositionInfo info, StubCodeContext context)
{
if (!_cleanupElements)
{
yield break;
}

StatementSyntax elementCleanup = _elementsMarshalling.GenerateElementCleanupStatement(info, context);

if (!elementCleanup.IsKind(SyntaxKind.EmptyStatement))
{
yield return elementCleanup;
}

if (!_shape.HasFlag(MarshallerShape.Free))
yield break;

string marshaller = StatefulValueMarshalling.GetMarshallerIdentifier(info, context);
// <marshaller>.Free();
yield return ExpressionStatement(
InvocationExpression(
MemberAccessExpression(SyntaxKind.SimpleMemberAccessExpression,
IdentifierName(marshaller),
IdentifierName(ShapeMemberNames.Free)),
ArgumentList()));
}
public IEnumerable<StatementSyntax> GenerateGuaranteedUnmarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateGuaranteedUnmarshalStatements(info, context);

Expand All@@ -419,9 +415,9 @@ public IEnumerable<StatementSyntax> GenerateMarshalStatements(TypePositionInfo i
yield return statement;
}

if (!info.IsByRef && info.ByValueContentsMarshalKind == ByValueContentsMarshalKind.Out)
if (context.Direction == MarshalDirection.ManagedToUnmanaged && !info.IsByRef && info.ByValueContentsMarshalKind == ByValueContentsMarshalKind.Out)
{
yield return _elementsMarshalling.GenerateByValueOutMarshalStatement(info, context);
yield return _elementsMarshalling.GenerateManagedToUnmanagedByValueOutMarshalStatement(info, context);
yield break;
}

Expand All@@ -437,9 +433,10 @@ public IEnumerable<StatementSyntax> GenerateUnmarshalStatements(TypePositionInfo
{
string numElementsIdentifier = MarshallerHelpers.GetNumElementsIdentifier(info, context);

if (!info.IsByRef && info.ByValueContentsMarshalKind.HasFlag(ByValueContentsMarshalKind.Out))
if (context.Direction == MarshalDirection.ManagedToUnmanaged && !info.IsByRef && info.ByValueContentsMarshalKind.HasFlag(ByValueContentsMarshalKind.Out))
{
yield return _elementsMarshalling.GenerateByValueOutUnmarshalStatement(info, context);
yield return _elementsMarshalling.GenerateManagedToUnmanagedByValueOutUnmarshalStatement(info, context);
yield break;
}

if (!_shape.HasFlag(MarshallerShape.ToManaged))
Expand DownExpand Up@@ -469,4 +466,50 @@ public IEnumerable<StatementSyntax> GenerateUnmarshalStatements(TypePositionInfo

public bool UsesNativeIdentifier(TypePositionInfo info, StubCodeContext context) => true;
}

/// <summary>
/// Marshaller that enables calling the Free method on a stateful marshaller.
/// </summary>
internal sealed class StatefulFreeMarshalling : ICustomTypeMarshallingStrategy
{
private readonly ICustomTypeMarshallingStrategy _innerMarshaller;

public StatefulFreeMarshalling(ICustomTypeMarshallingStrategy innerMarshaller)
{
_innerMarshaller = innerMarshaller;
}

public ManagedTypeInfo AsNativeType(TypePositionInfo info) => _innerMarshaller.AsNativeType(info);

public IEnumerable<StatementSyntax> GenerateCleanupStatements(TypePositionInfo info, StubCodeContext context)
{
foreach (var statement in _innerMarshaller.GenerateCleanupStatements(info, context))
{
yield return statement;
}

string marshaller = StatefulValueMarshalling.GetMarshallerIdentifier(info, context);
// <marshaller>.Free();
yield return ExpressionStatement(
InvocationExpression(
MemberAccessExpression(SyntaxKind.SimpleMemberAccessExpression,
IdentifierName(marshaller),
IdentifierName(ShapeMemberNames.Free)),
ArgumentList()));
}
public IEnumerable<StatementSyntax> GenerateGuaranteedUnmarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateGuaranteedUnmarshalStatements(info, context);

public IEnumerable<StatementSyntax> GenerateMarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateMarshalStatements(info, context);

public IEnumerable<StatementSyntax> GenerateNotifyForSuccessfulInvokeStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateNotifyForSuccessfulInvokeStatements(info, context);
public IEnumerable<StatementSyntax> GeneratePinnedMarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GeneratePinnedMarshalStatements(info, context);
public IEnumerable<StatementSyntax> GeneratePinStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GeneratePinStatements(info, context);
public IEnumerable<StatementSyntax> GenerateSetupStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateSetupStatements(info, context);

public IEnumerable<StatementSyntax> GenerateUnmarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateUnmarshalStatements(info, context);

public IEnumerable<StatementSyntax> GenerateUnmarshalCaptureStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateUnmarshalCaptureStatements(info, context);

public bool UsesNativeIdentifier(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.UsesNativeIdentifier(info, context);
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Only call Free in unmanaged->managed stubs when ownership has been transfered to the callee by jkoritzinsky · Pull Request #86415 · dotnet/runtime · GitHub
Skip to content
Only call Free in unmanaged->managed stubs when ownership has been transfered to the callee#86415

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

 Merged

jkoritzinsky
merged 9 commits into

from

May 23, 2023
 Merged


Only call Free in unmanaged->managed stubs when ownership has been transfered to the callee
#86415
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
616d53f

Only call Free in unmanaged->managed stubs when ownership has been tr…


jkoritzinsky May 17, 2023
53ea459

Add missing condition


jkoritzinsky May 17, 2023
0d8cf4c

Fix ref parameter marshalling and by-value collection marshalling. Di…


jkoritzinsky May 19, 2023
c3a6fe4

Add test for by-ref collections


jkoritzinsky May 19, 2023
e6c5b22

Fix by-ref collection ownership.


jkoritzinsky May 19, 2023
fcefc57

Fix compilation of stateless by-value out marshalling for unmanaged-t…


jkoritzinsky May 19, 2023
6bb51e1

Add tests for stateful marshaller shapes and update behavior to match…


jkoritzinsky May 22, 2023
32ff447

Fix test failures and remove duplicate test runs.


jkoritzinsky May 22, 2023
14c023b

Uncomment code


jkoritzinsky May 22, 2023

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


1 change: 1 addition & 0 deletions
...s/gen/Microsoft.Interop.SourceGeneration/LinearCollectionElementMarshallingCodeContext.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ public LinearCollectionElementMarshallingCodeContext(
 _managedSpanIdentifier = managedSpanIdentifier;
 _nativeSpanIdentifier = nativeSpanIdentifier;
 ParentContext = parentContext;
 Direction = ParentContext.Direction;
 }

 public override (TargetFramework framework, Version version) GetTargetFramework()
Expand Down

94 changes: 90 additions & 4 deletions
...rosoft.Interop.SourceGeneration/Marshalling/AttributedMarshallingModelGeneratorFactory.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -244,8 +244,22 @@ private IMarshallingGenerator CreateCustomNativeTypeMarshaller(TypePositionInfo
 if (marshallerData.Shape.HasFlag(MarshallerShape.CallerAllocatedBuffer))
 marshallingStrategy = new StatelessCallerAllocatedBufferMarshalling(marshallingStrategy, marshallerData.MarshallerType.Syntax, marshallerData.BufferElementType.Syntax, isLinearCollectionMarshalling: false);

 if (marshallerData.Shape.HasFlag(MarshallerShape.Free))
 FreeStrategy freeStrategy = GetFreeStrategy(info, context);

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new StatelessUnmanagedToManagedOwnershipTracking(marshallingStrategy);
 }

 if (freeStrategy != FreeStrategy.NoFree && marshallerData.Shape.HasFlag(MarshallerShape.Free))
 {
 marshallingStrategy = new StatelessFreeMarshalling(marshallingStrategy, marshallerData.MarshallerType.Syntax);
 }

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new FreeOwnedOriginalValueMarshalling(marshallingStrategy);
 }
 }

 IMarshallingGenerator marshallingGenerator = new CustomTypeMarshallingGenerator(marshallingStrategy, enableByValueContentsMarshalling: false);
Expand DownExpand Up@@ -311,19 +325,42 @@ private IMarshallingGenerator CreateNativeCollectionMarshaller(
 marshallingStrategy = new StatefulCallerAllocatedBufferMarshalling(marshallingStrategy, marshallerTypeSyntax, bufferElementTypeSyntax);
 }

 FreeStrategy freeStrategy = GetFreeStrategy(info, context);
 IElementsMarshallingCollectionSource collectionSource = new StatefulLinearCollectionSource();
 IElementsMarshalling elementsMarshalling = CreateElementsMarshalling(marshallerData, elementInfo, elementMarshaller, unmanagedElementType, collectionSource);

 marshallingStrategy = new StatefulLinearCollectionMarshalling(marshallingStrategy, marshallerData.Shape, numElementsExpression, elementsMarshalling);
 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new StatelessUnmanagedToManagedOwnershipTracking(marshallingStrategy);
 }

 marshallingStrategy = new StatefulLinearCollectionMarshalling(marshallingStrategy, marshallerData.Shape, numElementsExpression, elementsMarshalling, freeStrategy != FreeStrategy.NoFree);

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new FreeOwnedOriginalValueMarshalling(marshallingStrategy);
 }

 if (marshallerData.Shape.HasFlag(MarshallerShape.Free))
 {
 marshallingStrategy = new StatefulFreeMarshalling(marshallingStrategy);
 }
 }
 else
 {
 marshallingStrategy = new StatelessLinearCollectionSpaceAllocator(marshallerTypeSyntax, nativeType, marshallerData.Shape, numElementsExpression);

 FreeStrategy freeStrategy = GetFreeStrategy(info, context);

 IElementsMarshallingCollectionSource collectionSource = new StatelessLinearCollectionSource(marshallerTypeSyntax);
 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new StatelessUnmanagedToManagedOwnershipTracking(marshallingStrategy);
 }

 IElementsMarshalling elementsMarshalling = CreateElementsMarshalling(marshallerData, elementInfo, elementMarshaller, unmanagedElementType, collectionSource);

 marshallingStrategy = new StatelessLinearCollectionMarshalling(marshallingStrategy, elementsMarshalling, nativeType, marshallerData.Shape);
 marshallingStrategy = new StatelessLinearCollectionMarshalling(marshallingStrategy, elementsMarshalling, nativeType, marshallerData.Shape, freeStrategy != FreeStrategy.NoFree);

 if (marshallerData.Shape.HasFlag(MarshallerShape.CallerAllocatedBuffer))
 {
Expand All@@ -334,8 +371,15 @@ private IMarshallingGenerator CreateNativeCollectionMarshaller(
 marshallingStrategy = new StatelessCallerAllocatedBufferMarshalling(marshallingStrategy, marshallerTypeSyntax, bufferElementTypeSyntax, isLinearCollectionMarshalling: true);
 }

 if (marshallerData.Shape.HasFlag(MarshallerShape.Free))
 if (freeStrategy != FreeStrategy.NoFree && marshallerData.Shape.HasFlag(MarshallerShape.Free))
 {
 marshallingStrategy = new StatelessFreeMarshalling(marshallingStrategy, marshallerTypeSyntax);
 }

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new FreeOwnedOriginalValueMarshalling(marshallingStrategy);
 }
 }

 IMarshallingGenerator marshallingGenerator = new CustomTypeMarshallingGenerator(
Expand All@@ -351,6 +395,48 @@ private IMarshallingGenerator CreateNativeCollectionMarshaller(
 return marshallingGenerator;
 }

 private enum FreeStrategy
 {
 /// <summary>
 /// Free the unmanaged value stored in the native identifier.
 /// </summary>
 FreeNative,
 /// <summary>
 /// Free the unmanaged value originally passed into the stub.
 /// </summary>
 FreeOriginal,
 /// <summary>
 /// Do not free the unmanaged value, we don't own it.
 /// </summary>
 NoFree
 }

 private static FreeStrategy GetFreeStrategy(TypePositionInfo info, StubCodeContext context)
 {
 // When marshalling from managed to unmanaged, we always own the value in the native identifier.
 if (context.Direction == MarshalDirection.ManagedToUnmanaged)
 {
 return FreeStrategy.FreeNative;
 }

 // When we're in a case where we don't have state across stages, the parent stub context that can track the state
 // will only call our Cleanup stage when we own the value in the native identifier.
 if (!context.AdditionalTemporaryStateLivesAcrossStages)
 {
 return FreeStrategy.FreeNative;
 }

 // In an unmanaged-to-managed stub where a value is passed by 'ref',
 // we own the original value once we replace it with the new value we're passing out to the caller.
 if (info.RefKind == RefKind.Ref)
 {
 return FreeStrategy.FreeOriginal;
 }

 // In an unmanaged-to-managed stub, we don't take ownership of the value when it isn't passed by 'ref'.
 return FreeStrategy.NoFree;
 }

 private static IElementsMarshalling CreateElementsMarshalling(CustomTypeMarshallerData marshallerData, TypePositionInfo elementInfo, IMarshallingGenerator elementMarshaller, TypeSyntax unmanagedElementType, IElementsMarshallingCollectionSource collectionSource)
 {
 IElementsMarshalling elementsMarshalling;
Expand Down

16 changes: 9 additions & 7 deletions
...InteropServices/gen/Microsoft.Interop.SourceGeneration/Marshalling/ElementsMarshalling.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,9 +22,9 @@ internal interface IElementsMarshallingCollectionSource

 internal interface IElementsMarshalling
 {
 StatementSyntax GenerateByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateManagedToUnmanagedByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateMarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateManagedToUnmanagedByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateUnmarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateElementCleanupStatement(TypePositionInfo info, StubCodeContext context);
 }
Expand All@@ -45,7 +45,7 @@ public BlittableElementsMarshalling(TypeSyntax managedElementType, TypeSyntax un
 _collectionSource = collectionSource;
 }

 public StatementSyntax GenerateByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 // If the parameter is marshalled by-value [Out], then we don't marshal the contents of the collection.
 // We do clear the span, so that if the invoke target doesn't fill it, we aren't left with undefined content.
Expand DownExpand Up@@ -73,7 +73,7 @@ public StatementSyntax GenerateMarshalStatement(TypePositionInfo info, StubCodeC
 Argument(destination)));
 }

 public StatementSyntax GenerateByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 ExpressionSyntax source = CastToManagedIfNecessary(_collectionSource.GetUnmanagedValuesDestination(info, context));

Expand DownExpand Up@@ -175,7 +175,7 @@ public NonBlittableElementsMarshalling(
 _collectionSource = collectionSource;
 }

 public StatementSyntax GenerateByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 // If the parameter is marshalled by-value [Out], then we don't marshal the contents of the collection.
 // We do clear the span, so that if the invoke target doesn't fill it, we aren't left with undefined content.
Expand DownExpand Up@@ -259,7 +259,7 @@ public StatementSyntax GenerateUnmarshalStatement(TypePositionInfo info, StubCod
 StubCodeContext.Stage.Unmarshal));
 }

 public StatementSyntax GenerateByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 // Use ManagedSource and NativeDestination spans for by-value marshalling since we're just marshalling back the contents,
 // not the array itself.
Expand DownExpand Up@@ -356,7 +356,9 @@ public StatementSyntax GenerateElementCleanupStatement(TypePositionInfo info, St
 VariableDeclarator(
 Identifier(nativeSpanIdentifier))
 .WithInitializer(EqualsValueClause(
 _collectionSource.GetUnmanagedValuesDestination(info, context)))))),
 context.Direction == MarshalDirection.ManagedToUnmanaged
 ? _collectionSource.GetUnmanagedValuesDestination(info, context)
 : _collectionSource.GetUnmanagedValuesSource(info, context)))))),
 contentsCleanupStatements);
 }

Expand Down

2 changes: 1 addition & 1 deletion
...en/Microsoft.Interop.SourceGeneration/Marshalling/MarshalAsMarshallingGeneratorFactory.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -88,7 +88,7 @@ public IMarshallingGenerator Create(
 return s_delegate;

 case { MarshallingAttributeInfo: SafeHandleMarshallingInfo(_, bool isAbstract) }:
 if (!context.AdditionalTemporaryStateLivesAcrossStages)
 if (!context.AdditionalTemporaryStateLivesAcrossStages || context.Direction != MarshalDirection.ManagedToUnmanaged)
 {
 throw new MarshallingNotSupportedException(info, context);
 }
Expand Down

77 changes: 60 additions & 17 deletions
...ervices/gen/Microsoft.Interop.SourceGeneration/Marshalling/StatefulMarshallingStrategy.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -372,40 +372,36 @@ internal sealed class StatefulLinearCollectionMarshalling : ICustomTypeMarshalli
 private readonly MarshallerShape _shape;
 private readonly ExpressionSyntax _numElementsExpression;
 private readonly IElementsMarshalling _elementsMarshalling;
 private readonly bool _cleanupElements;

 public StatefulLinearCollectionMarshalling(
 ICustomTypeMarshallingStrategy innerMarshaller,
 MarshallerShape shape,
 ExpressionSyntax numElementsExpression,
 IElementsMarshalling elementsMarshalling)
 IElementsMarshalling elementsMarshalling,
 bool cleanupElements)
 {
 _innerMarshaller = innerMarshaller;
 _shape = shape;
 _numElementsExpression = numElementsExpression;
 _elementsMarshalling = elementsMarshalling;
 _cleanupElements = cleanupElements;
 }

 public ManagedTypeInfo AsNativeType(TypePositionInfo info) => _innerMarshaller.AsNativeType(info);
 public IEnumerable<StatementSyntax> GenerateCleanupStatements(TypePositionInfo info, StubCodeContext context)
 {
 if (!_cleanupElements)
 {
 yield break;
 }

 StatementSyntax elementCleanup = _elementsMarshalling.GenerateElementCleanupStatement(info, context);

 if (!elementCleanup.IsKind(SyntaxKind.EmptyStatement))
 {
 yield return elementCleanup;
 }

 if (!_shape.HasFlag(MarshallerShape.Free))
 yield break;

 string marshaller = StatefulValueMarshalling.GetMarshallerIdentifier(info, context);
 // <marshaller>.Free();
 yield return ExpressionStatement(
 InvocationExpression(
 MemberAccessExpression(SyntaxKind.SimpleMemberAccessExpression,
 IdentifierName(marshaller),
 IdentifierName(ShapeMemberNames.Free)),
 ArgumentList()));
 }
 public IEnumerable<StatementSyntax> GenerateGuaranteedUnmarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateGuaranteedUnmarshalStatements(info, context);

Expand All@@ -419,9 +415,9 @@ public IEnumerable<StatementSyntax> GenerateMarshalStatements(TypePositionInfo i
 yield return statement;
 }

 if (!info.IsByRef && info.ByValueContentsMarshalKind == ByValueContentsMarshalKind.Out)
 if (context.Direction == MarshalDirection.ManagedToUnmanaged && !info.IsByRef && info.ByValueContentsMarshalKind == ByValueContentsMarshalKind.Out)
 {
 yield return _elementsMarshalling.GenerateByValueOutMarshalStatement(info, context);
 yield return _elementsMarshalling.GenerateManagedToUnmanagedByValueOutMarshalStatement(info, context);
 yield break;
 }

Expand All@@ -437,9 +433,10 @@ public IEnumerable<StatementSyntax> GenerateUnmarshalStatements(TypePositionInfo
 {
 string numElementsIdentifier = MarshallerHelpers.GetNumElementsIdentifier(info, context);

 if (!info.IsByRef && info.ByValueContentsMarshalKind.HasFlag(ByValueContentsMarshalKind.Out))
 if (context.Direction == MarshalDirection.ManagedToUnmanaged && !info.IsByRef && info.ByValueContentsMarshalKind.HasFlag(ByValueContentsMarshalKind.Out))
 {
 yield return _elementsMarshalling.GenerateByValueOutUnmarshalStatement(info, context);
 yield return _elementsMarshalling.GenerateManagedToUnmanagedByValueOutUnmarshalStatement(info, context);
 yield break;
 }

 if (!_shape.HasFlag(MarshallerShape.ToManaged))
Expand DownExpand Up@@ -469,4 +466,50 @@ public IEnumerable<StatementSyntax> GenerateUnmarshalStatements(TypePositionInfo

 public bool UsesNativeIdentifier(TypePositionInfo info, StubCodeContext context) => true;
 }

 /// <summary>
 /// Marshaller that enables calling the Free method on a stateful marshaller.
 /// </summary>
 internal sealed class StatefulFreeMarshalling : ICustomTypeMarshallingStrategy
 {
 private readonly ICustomTypeMarshallingStrategy _innerMarshaller;

 public StatefulFreeMarshalling(ICustomTypeMarshallingStrategy innerMarshaller)
 {
 _innerMarshaller = innerMarshaller;
 }

 public ManagedTypeInfo AsNativeType(TypePositionInfo info) => _innerMarshaller.AsNativeType(info);

 public IEnumerable<StatementSyntax> GenerateCleanupStatements(TypePositionInfo info, StubCodeContext context)
 {
 foreach (var statement in _innerMarshaller.GenerateCleanupStatements(info, context))
 {
 yield return statement;
 }

 string marshaller = StatefulValueMarshalling.GetMarshallerIdentifier(info, context);
 // <marshaller>.Free();
 yield return ExpressionStatement(
 InvocationExpression(
 MemberAccessExpression(SyntaxKind.SimpleMemberAccessExpression,
 IdentifierName(marshaller),
 IdentifierName(ShapeMemberNames.Free)),
 ArgumentList()));
 }
 public IEnumerable<StatementSyntax> GenerateGuaranteedUnmarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateGuaranteedUnmarshalStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateMarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateMarshalStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateNotifyForSuccessfulInvokeStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateNotifyForSuccessfulInvokeStatements(info, context);
 public IEnumerable<StatementSyntax> GeneratePinnedMarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GeneratePinnedMarshalStatements(info, context);
 public IEnumerable<StatementSyntax> GeneratePinStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GeneratePinStatements(info, context);
 public IEnumerable<StatementSyntax> GenerateSetupStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateSetupStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateUnmarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateUnmarshalStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateUnmarshalCaptureStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateUnmarshalCaptureStatements(info, context);

 public bool UsesNativeIdentifier(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.UsesNativeIdentifier(info, context);
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Only call Free in unmanaged->managed stubs when ownership has been transfered to the callee by jkoritzinsky · Pull Request #86415 · dotnet/runtime · GitHub
Skip to content
Only call Free in unmanaged->managed stubs when ownership has been transfered to the callee#86415

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

 Merged

jkoritzinsky
merged 9 commits into

from

May 23, 2023
 Merged


Only call Free in unmanaged->managed stubs when ownership has been transfered to the callee
#86415
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
616d53f

Only call Free in unmanaged->managed stubs when ownership has been tr…


jkoritzinsky May 17, 2023
53ea459

Add missing condition


jkoritzinsky May 17, 2023
0d8cf4c

Fix ref parameter marshalling and by-value collection marshalling. Di…


jkoritzinsky May 19, 2023
c3a6fe4

Add test for by-ref collections


jkoritzinsky May 19, 2023
e6c5b22

Fix by-ref collection ownership.


jkoritzinsky May 19, 2023
fcefc57

Fix compilation of stateless by-value out marshalling for unmanaged-t…


jkoritzinsky May 19, 2023
6bb51e1

Add tests for stateful marshaller shapes and update behavior to match…


jkoritzinsky May 22, 2023
32ff447

Fix test failures and remove duplicate test runs.


jkoritzinsky May 22, 2023
14c023b

Uncomment code


jkoritzinsky May 22, 2023

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


1 change: 1 addition & 0 deletions
...s/gen/Microsoft.Interop.SourceGeneration/LinearCollectionElementMarshallingCodeContext.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ public LinearCollectionElementMarshallingCodeContext(
 _managedSpanIdentifier = managedSpanIdentifier;
 _nativeSpanIdentifier = nativeSpanIdentifier;
 ParentContext = parentContext;
 Direction = ParentContext.Direction;
 }

 public override (TargetFramework framework, Version version) GetTargetFramework()
Expand Down

94 changes: 90 additions & 4 deletions
...rosoft.Interop.SourceGeneration/Marshalling/AttributedMarshallingModelGeneratorFactory.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -244,8 +244,22 @@ private IMarshallingGenerator CreateCustomNativeTypeMarshaller(TypePositionInfo
 if (marshallerData.Shape.HasFlag(MarshallerShape.CallerAllocatedBuffer))
 marshallingStrategy = new StatelessCallerAllocatedBufferMarshalling(marshallingStrategy, marshallerData.MarshallerType.Syntax, marshallerData.BufferElementType.Syntax, isLinearCollectionMarshalling: false);

 if (marshallerData.Shape.HasFlag(MarshallerShape.Free))
 FreeStrategy freeStrategy = GetFreeStrategy(info, context);

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new StatelessUnmanagedToManagedOwnershipTracking(marshallingStrategy);
 }

 if (freeStrategy != FreeStrategy.NoFree && marshallerData.Shape.HasFlag(MarshallerShape.Free))
 {
 marshallingStrategy = new StatelessFreeMarshalling(marshallingStrategy, marshallerData.MarshallerType.Syntax);
 }

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new FreeOwnedOriginalValueMarshalling(marshallingStrategy);
 }
 }

 IMarshallingGenerator marshallingGenerator = new CustomTypeMarshallingGenerator(marshallingStrategy, enableByValueContentsMarshalling: false);
Expand DownExpand Up@@ -311,19 +325,42 @@ private IMarshallingGenerator CreateNativeCollectionMarshaller(
 marshallingStrategy = new StatefulCallerAllocatedBufferMarshalling(marshallingStrategy, marshallerTypeSyntax, bufferElementTypeSyntax);
 }

 FreeStrategy freeStrategy = GetFreeStrategy(info, context);
 IElementsMarshallingCollectionSource collectionSource = new StatefulLinearCollectionSource();
 IElementsMarshalling elementsMarshalling = CreateElementsMarshalling(marshallerData, elementInfo, elementMarshaller, unmanagedElementType, collectionSource);

 marshallingStrategy = new StatefulLinearCollectionMarshalling(marshallingStrategy, marshallerData.Shape, numElementsExpression, elementsMarshalling);
 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new StatelessUnmanagedToManagedOwnershipTracking(marshallingStrategy);
 }

 marshallingStrategy = new StatefulLinearCollectionMarshalling(marshallingStrategy, marshallerData.Shape, numElementsExpression, elementsMarshalling, freeStrategy != FreeStrategy.NoFree);

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new FreeOwnedOriginalValueMarshalling(marshallingStrategy);
 }

 if (marshallerData.Shape.HasFlag(MarshallerShape.Free))
 {
 marshallingStrategy = new StatefulFreeMarshalling(marshallingStrategy);
 }
 }
 else
 {
 marshallingStrategy = new StatelessLinearCollectionSpaceAllocator(marshallerTypeSyntax, nativeType, marshallerData.Shape, numElementsExpression);

 FreeStrategy freeStrategy = GetFreeStrategy(info, context);

 IElementsMarshallingCollectionSource collectionSource = new StatelessLinearCollectionSource(marshallerTypeSyntax);
 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new StatelessUnmanagedToManagedOwnershipTracking(marshallingStrategy);
 }

 IElementsMarshalling elementsMarshalling = CreateElementsMarshalling(marshallerData, elementInfo, elementMarshaller, unmanagedElementType, collectionSource);

 marshallingStrategy = new StatelessLinearCollectionMarshalling(marshallingStrategy, elementsMarshalling, nativeType, marshallerData.Shape);
 marshallingStrategy = new StatelessLinearCollectionMarshalling(marshallingStrategy, elementsMarshalling, nativeType, marshallerData.Shape, freeStrategy != FreeStrategy.NoFree);

 if (marshallerData.Shape.HasFlag(MarshallerShape.CallerAllocatedBuffer))
 {
Expand All@@ -334,8 +371,15 @@ private IMarshallingGenerator CreateNativeCollectionMarshaller(
 marshallingStrategy = new StatelessCallerAllocatedBufferMarshalling(marshallingStrategy, marshallerTypeSyntax, bufferElementTypeSyntax, isLinearCollectionMarshalling: true);
 }

 if (marshallerData.Shape.HasFlag(MarshallerShape.Free))
 if (freeStrategy != FreeStrategy.NoFree && marshallerData.Shape.HasFlag(MarshallerShape.Free))
 {
 marshallingStrategy = new StatelessFreeMarshalling(marshallingStrategy, marshallerTypeSyntax);
 }

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new FreeOwnedOriginalValueMarshalling(marshallingStrategy);
 }
 }

 IMarshallingGenerator marshallingGenerator = new CustomTypeMarshallingGenerator(
Expand All@@ -351,6 +395,48 @@ private IMarshallingGenerator CreateNativeCollectionMarshaller(
 return marshallingGenerator;
 }

 private enum FreeStrategy
 {
 /// <summary>
 /// Free the unmanaged value stored in the native identifier.
 /// </summary>
 FreeNative,
 /// <summary>
 /// Free the unmanaged value originally passed into the stub.
 /// </summary>
 FreeOriginal,
 /// <summary>
 /// Do not free the unmanaged value, we don't own it.
 /// </summary>
 NoFree
 }

 private static FreeStrategy GetFreeStrategy(TypePositionInfo info, StubCodeContext context)
 {
 // When marshalling from managed to unmanaged, we always own the value in the native identifier.
 if (context.Direction == MarshalDirection.ManagedToUnmanaged)
 {
 return FreeStrategy.FreeNative;
 }

 // When we're in a case where we don't have state across stages, the parent stub context that can track the state
 // will only call our Cleanup stage when we own the value in the native identifier.
 if (!context.AdditionalTemporaryStateLivesAcrossStages)
 {
 return FreeStrategy.FreeNative;
 }

 // In an unmanaged-to-managed stub where a value is passed by 'ref',
 // we own the original value once we replace it with the new value we're passing out to the caller.
 if (info.RefKind == RefKind.Ref)
 {
 return FreeStrategy.FreeOriginal;
 }

 // In an unmanaged-to-managed stub, we don't take ownership of the value when it isn't passed by 'ref'.
 return FreeStrategy.NoFree;
 }

 private static IElementsMarshalling CreateElementsMarshalling(CustomTypeMarshallerData marshallerData, TypePositionInfo elementInfo, IMarshallingGenerator elementMarshaller, TypeSyntax unmanagedElementType, IElementsMarshallingCollectionSource collectionSource)
 {
 IElementsMarshalling elementsMarshalling;
Expand Down

16 changes: 9 additions & 7 deletions
...InteropServices/gen/Microsoft.Interop.SourceGeneration/Marshalling/ElementsMarshalling.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,9 +22,9 @@ internal interface IElementsMarshallingCollectionSource

 internal interface IElementsMarshalling
 {
 StatementSyntax GenerateByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateManagedToUnmanagedByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateMarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateManagedToUnmanagedByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateUnmarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateElementCleanupStatement(TypePositionInfo info, StubCodeContext context);
 }
Expand All@@ -45,7 +45,7 @@ public BlittableElementsMarshalling(TypeSyntax managedElementType, TypeSyntax un
 _collectionSource = collectionSource;
 }

 public StatementSyntax GenerateByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 // If the parameter is marshalled by-value [Out], then we don't marshal the contents of the collection.
 // We do clear the span, so that if the invoke target doesn't fill it, we aren't left with undefined content.
Expand DownExpand Up@@ -73,7 +73,7 @@ public StatementSyntax GenerateMarshalStatement(TypePositionInfo info, StubCodeC
 Argument(destination)));
 }

 public StatementSyntax GenerateByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 ExpressionSyntax source = CastToManagedIfNecessary(_collectionSource.GetUnmanagedValuesDestination(info, context));

Expand DownExpand Up@@ -175,7 +175,7 @@ public NonBlittableElementsMarshalling(
 _collectionSource = collectionSource;
 }

 public StatementSyntax GenerateByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 // If the parameter is marshalled by-value [Out], then we don't marshal the contents of the collection.
 // We do clear the span, so that if the invoke target doesn't fill it, we aren't left with undefined content.
Expand DownExpand Up@@ -259,7 +259,7 @@ public StatementSyntax GenerateUnmarshalStatement(TypePositionInfo info, StubCod
 StubCodeContext.Stage.Unmarshal));
 }

 public StatementSyntax GenerateByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 // Use ManagedSource and NativeDestination spans for by-value marshalling since we're just marshalling back the contents,
 // not the array itself.
Expand DownExpand Up@@ -356,7 +356,9 @@ public StatementSyntax GenerateElementCleanupStatement(TypePositionInfo info, St
 VariableDeclarator(
 Identifier(nativeSpanIdentifier))
 .WithInitializer(EqualsValueClause(
 _collectionSource.GetUnmanagedValuesDestination(info, context)))))),
 context.Direction == MarshalDirection.ManagedToUnmanaged
 ? _collectionSource.GetUnmanagedValuesDestination(info, context)
 : _collectionSource.GetUnmanagedValuesSource(info, context)))))),
 contentsCleanupStatements);
 }

Expand Down

2 changes: 1 addition & 1 deletion
...en/Microsoft.Interop.SourceGeneration/Marshalling/MarshalAsMarshallingGeneratorFactory.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -88,7 +88,7 @@ public IMarshallingGenerator Create(
 return s_delegate;

 case { MarshallingAttributeInfo: SafeHandleMarshallingInfo(_, bool isAbstract) }:
 if (!context.AdditionalTemporaryStateLivesAcrossStages)
 if (!context.AdditionalTemporaryStateLivesAcrossStages || context.Direction != MarshalDirection.ManagedToUnmanaged)
 {
 throw new MarshallingNotSupportedException(info, context);
 }
Expand Down

77 changes: 60 additions & 17 deletions
...ervices/gen/Microsoft.Interop.SourceGeneration/Marshalling/StatefulMarshallingStrategy.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -372,40 +372,36 @@ internal sealed class StatefulLinearCollectionMarshalling : ICustomTypeMarshalli
 private readonly MarshallerShape _shape;
 private readonly ExpressionSyntax _numElementsExpression;
 private readonly IElementsMarshalling _elementsMarshalling;
 private readonly bool _cleanupElements;

 public StatefulLinearCollectionMarshalling(
 ICustomTypeMarshallingStrategy innerMarshaller,
 MarshallerShape shape,
 ExpressionSyntax numElementsExpression,
 IElementsMarshalling elementsMarshalling)
 IElementsMarshalling elementsMarshalling,
 bool cleanupElements)
 {
 _innerMarshaller = innerMarshaller;
 _shape = shape;
 _numElementsExpression = numElementsExpression;
 _elementsMarshalling = elementsMarshalling;
 _cleanupElements = cleanupElements;
 }

 public ManagedTypeInfo AsNativeType(TypePositionInfo info) => _innerMarshaller.AsNativeType(info);
 public IEnumerable<StatementSyntax> GenerateCleanupStatements(TypePositionInfo info, StubCodeContext context)
 {
 if (!_cleanupElements)
 {
 yield break;
 }

 StatementSyntax elementCleanup = _elementsMarshalling.GenerateElementCleanupStatement(info, context);

 if (!elementCleanup.IsKind(SyntaxKind.EmptyStatement))
 {
 yield return elementCleanup;
 }

 if (!_shape.HasFlag(MarshallerShape.Free))
 yield break;

 string marshaller = StatefulValueMarshalling.GetMarshallerIdentifier(info, context);
 // <marshaller>.Free();
 yield return ExpressionStatement(
 InvocationExpression(
 MemberAccessExpression(SyntaxKind.SimpleMemberAccessExpression,
 IdentifierName(marshaller),
 IdentifierName(ShapeMemberNames.Free)),
 ArgumentList()));
 }
 public IEnumerable<StatementSyntax> GenerateGuaranteedUnmarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateGuaranteedUnmarshalStatements(info, context);

Expand All@@ -419,9 +415,9 @@ public IEnumerable<StatementSyntax> GenerateMarshalStatements(TypePositionInfo i
 yield return statement;
 }

 if (!info.IsByRef && info.ByValueContentsMarshalKind == ByValueContentsMarshalKind.Out)
 if (context.Direction == MarshalDirection.ManagedToUnmanaged && !info.IsByRef && info.ByValueContentsMarshalKind == ByValueContentsMarshalKind.Out)
 {
 yield return _elementsMarshalling.GenerateByValueOutMarshalStatement(info, context);
 yield return _elementsMarshalling.GenerateManagedToUnmanagedByValueOutMarshalStatement(info, context);
 yield break;
 }

Expand All@@ -437,9 +433,10 @@ public IEnumerable<StatementSyntax> GenerateUnmarshalStatements(TypePositionInfo
 {
 string numElementsIdentifier = MarshallerHelpers.GetNumElementsIdentifier(info, context);

 if (!info.IsByRef && info.ByValueContentsMarshalKind.HasFlag(ByValueContentsMarshalKind.Out))
 if (context.Direction == MarshalDirection.ManagedToUnmanaged && !info.IsByRef && info.ByValueContentsMarshalKind.HasFlag(ByValueContentsMarshalKind.Out))
 {
 yield return _elementsMarshalling.GenerateByValueOutUnmarshalStatement(info, context);
 yield return _elementsMarshalling.GenerateManagedToUnmanagedByValueOutUnmarshalStatement(info, context);
 yield break;
 }

 if (!_shape.HasFlag(MarshallerShape.ToManaged))
Expand DownExpand Up@@ -469,4 +466,50 @@ public IEnumerable<StatementSyntax> GenerateUnmarshalStatements(TypePositionInfo

 public bool UsesNativeIdentifier(TypePositionInfo info, StubCodeContext context) => true;
 }

 /// <summary>
 /// Marshaller that enables calling the Free method on a stateful marshaller.
 /// </summary>
 internal sealed class StatefulFreeMarshalling : ICustomTypeMarshallingStrategy
 {
 private readonly ICustomTypeMarshallingStrategy _innerMarshaller;

 public StatefulFreeMarshalling(ICustomTypeMarshallingStrategy innerMarshaller)
 {
 _innerMarshaller = innerMarshaller;
 }

 public ManagedTypeInfo AsNativeType(TypePositionInfo info) => _innerMarshaller.AsNativeType(info);

 public IEnumerable<StatementSyntax> GenerateCleanupStatements(TypePositionInfo info, StubCodeContext context)
 {
 foreach (var statement in _innerMarshaller.GenerateCleanupStatements(info, context))
 {
 yield return statement;
 }

 string marshaller = StatefulValueMarshalling.GetMarshallerIdentifier(info, context);
 // <marshaller>.Free();
 yield return ExpressionStatement(
 InvocationExpression(
 MemberAccessExpression(SyntaxKind.SimpleMemberAccessExpression,
 IdentifierName(marshaller),
 IdentifierName(ShapeMemberNames.Free)),
 ArgumentList()));
 }
 public IEnumerable<StatementSyntax> GenerateGuaranteedUnmarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateGuaranteedUnmarshalStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateMarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateMarshalStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateNotifyForSuccessfulInvokeStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateNotifyForSuccessfulInvokeStatements(info, context);
 public IEnumerable<StatementSyntax> GeneratePinnedMarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GeneratePinnedMarshalStatements(info, context);
 public IEnumerable<StatementSyntax> GeneratePinStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GeneratePinStatements(info, context);
 public IEnumerable<StatementSyntax> GenerateSetupStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateSetupStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateUnmarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateUnmarshalStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateUnmarshalCaptureStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateUnmarshalCaptureStatements(info, context);

 public bool UsesNativeIdentifier(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.UsesNativeIdentifier(info, context);
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Only call Free in unmanaged->managed stubs when ownership has been transfered to the callee by jkoritzinsky · Pull Request #86415 · dotnet/runtime · GitHub
Skip to content
Only call Free in unmanaged->managed stubs when ownership has been transfered to the callee#86415

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

 Merged

jkoritzinsky
merged 9 commits into

from

May 23, 2023
 Merged


Only call Free in unmanaged->managed stubs when ownership has been transfered to the callee
#86415
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
616d53f

Only call Free in unmanaged->managed stubs when ownership has been tr…


jkoritzinsky May 17, 2023
53ea459

Add missing condition


jkoritzinsky May 17, 2023
0d8cf4c

Fix ref parameter marshalling and by-value collection marshalling. Di…


jkoritzinsky May 19, 2023
c3a6fe4

Add test for by-ref collections


jkoritzinsky May 19, 2023
e6c5b22

Fix by-ref collection ownership.


jkoritzinsky May 19, 2023
fcefc57

Fix compilation of stateless by-value out marshalling for unmanaged-t…


jkoritzinsky May 19, 2023
6bb51e1

Add tests for stateful marshaller shapes and update behavior to match…


jkoritzinsky May 22, 2023
32ff447

Fix test failures and remove duplicate test runs.


jkoritzinsky May 22, 2023
14c023b

Uncomment code


jkoritzinsky May 22, 2023

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


1 change: 1 addition & 0 deletions
...s/gen/Microsoft.Interop.SourceGeneration/LinearCollectionElementMarshallingCodeContext.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ public LinearCollectionElementMarshallingCodeContext(
 _managedSpanIdentifier = managedSpanIdentifier;
 _nativeSpanIdentifier = nativeSpanIdentifier;
 ParentContext = parentContext;
 Direction = ParentContext.Direction;
 }

 public override (TargetFramework framework, Version version) GetTargetFramework()
Expand Down

94 changes: 90 additions & 4 deletions
...rosoft.Interop.SourceGeneration/Marshalling/AttributedMarshallingModelGeneratorFactory.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -244,8 +244,22 @@ private IMarshallingGenerator CreateCustomNativeTypeMarshaller(TypePositionInfo
 if (marshallerData.Shape.HasFlag(MarshallerShape.CallerAllocatedBuffer))
 marshallingStrategy = new StatelessCallerAllocatedBufferMarshalling(marshallingStrategy, marshallerData.MarshallerType.Syntax, marshallerData.BufferElementType.Syntax, isLinearCollectionMarshalling: false);

 if (marshallerData.Shape.HasFlag(MarshallerShape.Free))
 FreeStrategy freeStrategy = GetFreeStrategy(info, context);

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new StatelessUnmanagedToManagedOwnershipTracking(marshallingStrategy);
 }

 if (freeStrategy != FreeStrategy.NoFree && marshallerData.Shape.HasFlag(MarshallerShape.Free))
 {
 marshallingStrategy = new StatelessFreeMarshalling(marshallingStrategy, marshallerData.MarshallerType.Syntax);
 }

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new FreeOwnedOriginalValueMarshalling(marshallingStrategy);
 }
 }

 IMarshallingGenerator marshallingGenerator = new CustomTypeMarshallingGenerator(marshallingStrategy, enableByValueContentsMarshalling: false);
Expand DownExpand Up@@ -311,19 +325,42 @@ private IMarshallingGenerator CreateNativeCollectionMarshaller(
 marshallingStrategy = new StatefulCallerAllocatedBufferMarshalling(marshallingStrategy, marshallerTypeSyntax, bufferElementTypeSyntax);
 }

 FreeStrategy freeStrategy = GetFreeStrategy(info, context);
 IElementsMarshallingCollectionSource collectionSource = new StatefulLinearCollectionSource();
 IElementsMarshalling elementsMarshalling = CreateElementsMarshalling(marshallerData, elementInfo, elementMarshaller, unmanagedElementType, collectionSource);

 marshallingStrategy = new StatefulLinearCollectionMarshalling(marshallingStrategy, marshallerData.Shape, numElementsExpression, elementsMarshalling);
 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new StatelessUnmanagedToManagedOwnershipTracking(marshallingStrategy);
 }

 marshallingStrategy = new StatefulLinearCollectionMarshalling(marshallingStrategy, marshallerData.Shape, numElementsExpression, elementsMarshalling, freeStrategy != FreeStrategy.NoFree);

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new FreeOwnedOriginalValueMarshalling(marshallingStrategy);
 }

 if (marshallerData.Shape.HasFlag(MarshallerShape.Free))
 {
 marshallingStrategy = new StatefulFreeMarshalling(marshallingStrategy);
 }
 }
 else
 {
 marshallingStrategy = new StatelessLinearCollectionSpaceAllocator(marshallerTypeSyntax, nativeType, marshallerData.Shape, numElementsExpression);

 FreeStrategy freeStrategy = GetFreeStrategy(info, context);

 IElementsMarshallingCollectionSource collectionSource = new StatelessLinearCollectionSource(marshallerTypeSyntax);
 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new StatelessUnmanagedToManagedOwnershipTracking(marshallingStrategy);
 }

 IElementsMarshalling elementsMarshalling = CreateElementsMarshalling(marshallerData, elementInfo, elementMarshaller, unmanagedElementType, collectionSource);

 marshallingStrategy = new StatelessLinearCollectionMarshalling(marshallingStrategy, elementsMarshalling, nativeType, marshallerData.Shape);
 marshallingStrategy = new StatelessLinearCollectionMarshalling(marshallingStrategy, elementsMarshalling, nativeType, marshallerData.Shape, freeStrategy != FreeStrategy.NoFree);

 if (marshallerData.Shape.HasFlag(MarshallerShape.CallerAllocatedBuffer))
 {
Expand All@@ -334,8 +371,15 @@ private IMarshallingGenerator CreateNativeCollectionMarshaller(
 marshallingStrategy = new StatelessCallerAllocatedBufferMarshalling(marshallingStrategy, marshallerTypeSyntax, bufferElementTypeSyntax, isLinearCollectionMarshalling: true);
 }

 if (marshallerData.Shape.HasFlag(MarshallerShape.Free))
 if (freeStrategy != FreeStrategy.NoFree && marshallerData.Shape.HasFlag(MarshallerShape.Free))
 {
 marshallingStrategy = new StatelessFreeMarshalling(marshallingStrategy, marshallerTypeSyntax);
 }

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new FreeOwnedOriginalValueMarshalling(marshallingStrategy);
 }
 }

 IMarshallingGenerator marshallingGenerator = new CustomTypeMarshallingGenerator(
Expand All@@ -351,6 +395,48 @@ private IMarshallingGenerator CreateNativeCollectionMarshaller(
 return marshallingGenerator;
 }

 private enum FreeStrategy
 {
 /// <summary>
 /// Free the unmanaged value stored in the native identifier.
 /// </summary>
 FreeNative,
 /// <summary>
 /// Free the unmanaged value originally passed into the stub.
 /// </summary>
 FreeOriginal,
 /// <summary>
 /// Do not free the unmanaged value, we don't own it.
 /// </summary>
 NoFree
 }

 private static FreeStrategy GetFreeStrategy(TypePositionInfo info, StubCodeContext context)
 {
 // When marshalling from managed to unmanaged, we always own the value in the native identifier.
 if (context.Direction == MarshalDirection.ManagedToUnmanaged)
 {
 return FreeStrategy.FreeNative;
 }

 // When we're in a case where we don't have state across stages, the parent stub context that can track the state
 // will only call our Cleanup stage when we own the value in the native identifier.
 if (!context.AdditionalTemporaryStateLivesAcrossStages)
 {
 return FreeStrategy.FreeNative;
 }

 // In an unmanaged-to-managed stub where a value is passed by 'ref',
 // we own the original value once we replace it with the new value we're passing out to the caller.
 if (info.RefKind == RefKind.Ref)
 {
 return FreeStrategy.FreeOriginal;
 }

 // In an unmanaged-to-managed stub, we don't take ownership of the value when it isn't passed by 'ref'.
 return FreeStrategy.NoFree;
 }

 private static IElementsMarshalling CreateElementsMarshalling(CustomTypeMarshallerData marshallerData, TypePositionInfo elementInfo, IMarshallingGenerator elementMarshaller, TypeSyntax unmanagedElementType, IElementsMarshallingCollectionSource collectionSource)
 {
 IElementsMarshalling elementsMarshalling;
Expand Down

16 changes: 9 additions & 7 deletions
...InteropServices/gen/Microsoft.Interop.SourceGeneration/Marshalling/ElementsMarshalling.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,9 +22,9 @@ internal interface IElementsMarshallingCollectionSource

 internal interface IElementsMarshalling
 {
 StatementSyntax GenerateByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateManagedToUnmanagedByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateMarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateManagedToUnmanagedByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateUnmarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateElementCleanupStatement(TypePositionInfo info, StubCodeContext context);
 }
Expand All@@ -45,7 +45,7 @@ public BlittableElementsMarshalling(TypeSyntax managedElementType, TypeSyntax un
 _collectionSource = collectionSource;
 }

 public StatementSyntax GenerateByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 // If the parameter is marshalled by-value [Out], then we don't marshal the contents of the collection.
 // We do clear the span, so that if the invoke target doesn't fill it, we aren't left with undefined content.
Expand DownExpand Up@@ -73,7 +73,7 @@ public StatementSyntax GenerateMarshalStatement(TypePositionInfo info, StubCodeC
 Argument(destination)));
 }

 public StatementSyntax GenerateByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 ExpressionSyntax source = CastToManagedIfNecessary(_collectionSource.GetUnmanagedValuesDestination(info, context));

Expand DownExpand Up@@ -175,7 +175,7 @@ public NonBlittableElementsMarshalling(
 _collectionSource = collectionSource;
 }

 public StatementSyntax GenerateByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 // If the parameter is marshalled by-value [Out], then we don't marshal the contents of the collection.
 // We do clear the span, so that if the invoke target doesn't fill it, we aren't left with undefined content.
Expand DownExpand Up@@ -259,7 +259,7 @@ public StatementSyntax GenerateUnmarshalStatement(TypePositionInfo info, StubCod
 StubCodeContext.Stage.Unmarshal));
 }

 public StatementSyntax GenerateByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 // Use ManagedSource and NativeDestination spans for by-value marshalling since we're just marshalling back the contents,
 // not the array itself.
Expand DownExpand Up@@ -356,7 +356,9 @@ public StatementSyntax GenerateElementCleanupStatement(TypePositionInfo info, St
 VariableDeclarator(
 Identifier(nativeSpanIdentifier))
 .WithInitializer(EqualsValueClause(
 _collectionSource.GetUnmanagedValuesDestination(info, context)))))),
 context.Direction == MarshalDirection.ManagedToUnmanaged
 ? _collectionSource.GetUnmanagedValuesDestination(info, context)
 : _collectionSource.GetUnmanagedValuesSource(info, context)))))),
 contentsCleanupStatements);
 }

Expand Down

2 changes: 1 addition & 1 deletion
...en/Microsoft.Interop.SourceGeneration/Marshalling/MarshalAsMarshallingGeneratorFactory.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -88,7 +88,7 @@ public IMarshallingGenerator Create(
 return s_delegate;

 case { MarshallingAttributeInfo: SafeHandleMarshallingInfo(_, bool isAbstract) }:
 if (!context.AdditionalTemporaryStateLivesAcrossStages)
 if (!context.AdditionalTemporaryStateLivesAcrossStages || context.Direction != MarshalDirection.ManagedToUnmanaged)
 {
 throw new MarshallingNotSupportedException(info, context);
 }
Expand Down

77 changes: 60 additions & 17 deletions
...ervices/gen/Microsoft.Interop.SourceGeneration/Marshalling/StatefulMarshallingStrategy.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -372,40 +372,36 @@ internal sealed class StatefulLinearCollectionMarshalling : ICustomTypeMarshalli
 private readonly MarshallerShape _shape;
 private readonly ExpressionSyntax _numElementsExpression;
 private readonly IElementsMarshalling _elementsMarshalling;
 private readonly bool _cleanupElements;

 public StatefulLinearCollectionMarshalling(
 ICustomTypeMarshallingStrategy innerMarshaller,
 MarshallerShape shape,
 ExpressionSyntax numElementsExpression,
 IElementsMarshalling elementsMarshalling)
 IElementsMarshalling elementsMarshalling,
 bool cleanupElements)
 {
 _innerMarshaller = innerMarshaller;
 _shape = shape;
 _numElementsExpression = numElementsExpression;
 _elementsMarshalling = elementsMarshalling;
 _cleanupElements = cleanupElements;
 }

 public ManagedTypeInfo AsNativeType(TypePositionInfo info) => _innerMarshaller.AsNativeType(info);
 public IEnumerable<StatementSyntax> GenerateCleanupStatements(TypePositionInfo info, StubCodeContext context)
 {
 if (!_cleanupElements)
 {
 yield break;
 }

 StatementSyntax elementCleanup = _elementsMarshalling.GenerateElementCleanupStatement(info, context);

 if (!elementCleanup.IsKind(SyntaxKind.EmptyStatement))
 {
 yield return elementCleanup;
 }

 if (!_shape.HasFlag(MarshallerShape.Free))
 yield break;

 string marshaller = StatefulValueMarshalling.GetMarshallerIdentifier(info, context);
 // <marshaller>.Free();
 yield return ExpressionStatement(
 InvocationExpression(
 MemberAccessExpression(SyntaxKind.SimpleMemberAccessExpression,
 IdentifierName(marshaller),
 IdentifierName(ShapeMemberNames.Free)),
 ArgumentList()));
 }
 public IEnumerable<StatementSyntax> GenerateGuaranteedUnmarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateGuaranteedUnmarshalStatements(info, context);

Expand All@@ -419,9 +415,9 @@ public IEnumerable<StatementSyntax> GenerateMarshalStatements(TypePositionInfo i
 yield return statement;
 }

 if (!info.IsByRef && info.ByValueContentsMarshalKind == ByValueContentsMarshalKind.Out)
 if (context.Direction == MarshalDirection.ManagedToUnmanaged && !info.IsByRef && info.ByValueContentsMarshalKind == ByValueContentsMarshalKind.Out)
 {
 yield return _elementsMarshalling.GenerateByValueOutMarshalStatement(info, context);
 yield return _elementsMarshalling.GenerateManagedToUnmanagedByValueOutMarshalStatement(info, context);
 yield break;
 }

Expand All@@ -437,9 +433,10 @@ public IEnumerable<StatementSyntax> GenerateUnmarshalStatements(TypePositionInfo
 {
 string numElementsIdentifier = MarshallerHelpers.GetNumElementsIdentifier(info, context);

 if (!info.IsByRef && info.ByValueContentsMarshalKind.HasFlag(ByValueContentsMarshalKind.Out))
 if (context.Direction == MarshalDirection.ManagedToUnmanaged && !info.IsByRef && info.ByValueContentsMarshalKind.HasFlag(ByValueContentsMarshalKind.Out))
 {
 yield return _elementsMarshalling.GenerateByValueOutUnmarshalStatement(info, context);
 yield return _elementsMarshalling.GenerateManagedToUnmanagedByValueOutUnmarshalStatement(info, context);
 yield break;
 }

 if (!_shape.HasFlag(MarshallerShape.ToManaged))
Expand DownExpand Up@@ -469,4 +466,50 @@ public IEnumerable<StatementSyntax> GenerateUnmarshalStatements(TypePositionInfo

 public bool UsesNativeIdentifier(TypePositionInfo info, StubCodeContext context) => true;
 }

 /// <summary>
 /// Marshaller that enables calling the Free method on a stateful marshaller.
 /// </summary>
 internal sealed class StatefulFreeMarshalling : ICustomTypeMarshallingStrategy
 {
 private readonly ICustomTypeMarshallingStrategy _innerMarshaller;

 public StatefulFreeMarshalling(ICustomTypeMarshallingStrategy innerMarshaller)
 {
 _innerMarshaller = innerMarshaller;
 }

 public ManagedTypeInfo AsNativeType(TypePositionInfo info) => _innerMarshaller.AsNativeType(info);

 public IEnumerable<StatementSyntax> GenerateCleanupStatements(TypePositionInfo info, StubCodeContext context)
 {
 foreach (var statement in _innerMarshaller.GenerateCleanupStatements(info, context))
 {
 yield return statement;
 }

 string marshaller = StatefulValueMarshalling.GetMarshallerIdentifier(info, context);
 // <marshaller>.Free();
 yield return ExpressionStatement(
 InvocationExpression(
 MemberAccessExpression(SyntaxKind.SimpleMemberAccessExpression,
 IdentifierName(marshaller),
 IdentifierName(ShapeMemberNames.Free)),
 ArgumentList()));
 }
 public IEnumerable<StatementSyntax> GenerateGuaranteedUnmarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateGuaranteedUnmarshalStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateMarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateMarshalStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateNotifyForSuccessfulInvokeStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateNotifyForSuccessfulInvokeStatements(info, context);
 public IEnumerable<StatementSyntax> GeneratePinnedMarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GeneratePinnedMarshalStatements(info, context);
 public IEnumerable<StatementSyntax> GeneratePinStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GeneratePinStatements(info, context);
 public IEnumerable<StatementSyntax> GenerateSetupStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateSetupStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateUnmarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateUnmarshalStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateUnmarshalCaptureStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateUnmarshalCaptureStatements(info, context);

 public bool UsesNativeIdentifier(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.UsesNativeIdentifier(info, context);
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Only call Free in unmanaged->managed stubs when ownership has been transfered to the callee by jkoritzinsky · Pull Request #86415 · dotnet/runtime · GitHub
Skip to content
Only call Free in unmanaged->managed stubs when ownership has been transfered to the callee#86415

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

 Merged

jkoritzinsky
merged 9 commits into

from

May 23, 2023
 Merged


Only call Free in unmanaged->managed stubs when ownership has been transfered to the callee
#86415
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
616d53f

Only call Free in unmanaged->managed stubs when ownership has been tr…


jkoritzinsky May 17, 2023
53ea459

Add missing condition


jkoritzinsky May 17, 2023
0d8cf4c

Fix ref parameter marshalling and by-value collection marshalling. Di…


jkoritzinsky May 19, 2023
c3a6fe4

Add test for by-ref collections


jkoritzinsky May 19, 2023
e6c5b22

Fix by-ref collection ownership.


jkoritzinsky May 19, 2023
fcefc57

Fix compilation of stateless by-value out marshalling for unmanaged-t…


jkoritzinsky May 19, 2023
6bb51e1

Add tests for stateful marshaller shapes and update behavior to match…


jkoritzinsky May 22, 2023
32ff447

Fix test failures and remove duplicate test runs.


jkoritzinsky May 22, 2023
14c023b

Uncomment code


jkoritzinsky May 22, 2023

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


1 change: 1 addition & 0 deletions
...s/gen/Microsoft.Interop.SourceGeneration/LinearCollectionElementMarshallingCodeContext.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ public LinearCollectionElementMarshallingCodeContext(
 _managedSpanIdentifier = managedSpanIdentifier;
 _nativeSpanIdentifier = nativeSpanIdentifier;
 ParentContext = parentContext;
 Direction = ParentContext.Direction;
 }

 public override (TargetFramework framework, Version version) GetTargetFramework()
Expand Down

94 changes: 90 additions & 4 deletions
...rosoft.Interop.SourceGeneration/Marshalling/AttributedMarshallingModelGeneratorFactory.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -244,8 +244,22 @@ private IMarshallingGenerator CreateCustomNativeTypeMarshaller(TypePositionInfo
 if (marshallerData.Shape.HasFlag(MarshallerShape.CallerAllocatedBuffer))
 marshallingStrategy = new StatelessCallerAllocatedBufferMarshalling(marshallingStrategy, marshallerData.MarshallerType.Syntax, marshallerData.BufferElementType.Syntax, isLinearCollectionMarshalling: false);

 if (marshallerData.Shape.HasFlag(MarshallerShape.Free))
 FreeStrategy freeStrategy = GetFreeStrategy(info, context);

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new StatelessUnmanagedToManagedOwnershipTracking(marshallingStrategy);
 }

 if (freeStrategy != FreeStrategy.NoFree && marshallerData.Shape.HasFlag(MarshallerShape.Free))
 {
 marshallingStrategy = new StatelessFreeMarshalling(marshallingStrategy, marshallerData.MarshallerType.Syntax);
 }

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new FreeOwnedOriginalValueMarshalling(marshallingStrategy);
 }
 }

 IMarshallingGenerator marshallingGenerator = new CustomTypeMarshallingGenerator(marshallingStrategy, enableByValueContentsMarshalling: false);
Expand DownExpand Up@@ -311,19 +325,42 @@ private IMarshallingGenerator CreateNativeCollectionMarshaller(
 marshallingStrategy = new StatefulCallerAllocatedBufferMarshalling(marshallingStrategy, marshallerTypeSyntax, bufferElementTypeSyntax);
 }

 FreeStrategy freeStrategy = GetFreeStrategy(info, context);
 IElementsMarshallingCollectionSource collectionSource = new StatefulLinearCollectionSource();
 IElementsMarshalling elementsMarshalling = CreateElementsMarshalling(marshallerData, elementInfo, elementMarshaller, unmanagedElementType, collectionSource);

 marshallingStrategy = new StatefulLinearCollectionMarshalling(marshallingStrategy, marshallerData.Shape, numElementsExpression, elementsMarshalling);
 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new StatelessUnmanagedToManagedOwnershipTracking(marshallingStrategy);
 }

 marshallingStrategy = new StatefulLinearCollectionMarshalling(marshallingStrategy, marshallerData.Shape, numElementsExpression, elementsMarshalling, freeStrategy != FreeStrategy.NoFree);

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new FreeOwnedOriginalValueMarshalling(marshallingStrategy);
 }

 if (marshallerData.Shape.HasFlag(MarshallerShape.Free))
 {
 marshallingStrategy = new StatefulFreeMarshalling(marshallingStrategy);
 }
 }
 else
 {
 marshallingStrategy = new StatelessLinearCollectionSpaceAllocator(marshallerTypeSyntax, nativeType, marshallerData.Shape, numElementsExpression);

 FreeStrategy freeStrategy = GetFreeStrategy(info, context);

 IElementsMarshallingCollectionSource collectionSource = new StatelessLinearCollectionSource(marshallerTypeSyntax);
 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new StatelessUnmanagedToManagedOwnershipTracking(marshallingStrategy);
 }

 IElementsMarshalling elementsMarshalling = CreateElementsMarshalling(marshallerData, elementInfo, elementMarshaller, unmanagedElementType, collectionSource);

 marshallingStrategy = new StatelessLinearCollectionMarshalling(marshallingStrategy, elementsMarshalling, nativeType, marshallerData.Shape);
 marshallingStrategy = new StatelessLinearCollectionMarshalling(marshallingStrategy, elementsMarshalling, nativeType, marshallerData.Shape, freeStrategy != FreeStrategy.NoFree);

 if (marshallerData.Shape.HasFlag(MarshallerShape.CallerAllocatedBuffer))
 {
Expand All@@ -334,8 +371,15 @@ private IMarshallingGenerator CreateNativeCollectionMarshaller(
 marshallingStrategy = new StatelessCallerAllocatedBufferMarshalling(marshallingStrategy, marshallerTypeSyntax, bufferElementTypeSyntax, isLinearCollectionMarshalling: true);
 }

 if (marshallerData.Shape.HasFlag(MarshallerShape.Free))
 if (freeStrategy != FreeStrategy.NoFree && marshallerData.Shape.HasFlag(MarshallerShape.Free))
 {
 marshallingStrategy = new StatelessFreeMarshalling(marshallingStrategy, marshallerTypeSyntax);
 }

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new FreeOwnedOriginalValueMarshalling(marshallingStrategy);
 }
 }

 IMarshallingGenerator marshallingGenerator = new CustomTypeMarshallingGenerator(
Expand All@@ -351,6 +395,48 @@ private IMarshallingGenerator CreateNativeCollectionMarshaller(
 return marshallingGenerator;
 }

 private enum FreeStrategy
 {
 /// <summary>
 /// Free the unmanaged value stored in the native identifier.
 /// </summary>
 FreeNative,
 /// <summary>
 /// Free the unmanaged value originally passed into the stub.
 /// </summary>
 FreeOriginal,
 /// <summary>
 /// Do not free the unmanaged value, we don't own it.
 /// </summary>
 NoFree
 }

 private static FreeStrategy GetFreeStrategy(TypePositionInfo info, StubCodeContext context)
 {
 // When marshalling from managed to unmanaged, we always own the value in the native identifier.
 if (context.Direction == MarshalDirection.ManagedToUnmanaged)
 {
 return FreeStrategy.FreeNative;
 }

 // When we're in a case where we don't have state across stages, the parent stub context that can track the state
 // will only call our Cleanup stage when we own the value in the native identifier.
 if (!context.AdditionalTemporaryStateLivesAcrossStages)
 {
 return FreeStrategy.FreeNative;
 }

 // In an unmanaged-to-managed stub where a value is passed by 'ref',
 // we own the original value once we replace it with the new value we're passing out to the caller.
 if (info.RefKind == RefKind.Ref)
 {
 return FreeStrategy.FreeOriginal;
 }

 // In an unmanaged-to-managed stub, we don't take ownership of the value when it isn't passed by 'ref'.
 return FreeStrategy.NoFree;
 }

 private static IElementsMarshalling CreateElementsMarshalling(CustomTypeMarshallerData marshallerData, TypePositionInfo elementInfo, IMarshallingGenerator elementMarshaller, TypeSyntax unmanagedElementType, IElementsMarshallingCollectionSource collectionSource)
 {
 IElementsMarshalling elementsMarshalling;
Expand Down

16 changes: 9 additions & 7 deletions
...InteropServices/gen/Microsoft.Interop.SourceGeneration/Marshalling/ElementsMarshalling.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,9 +22,9 @@ internal interface IElementsMarshallingCollectionSource

 internal interface IElementsMarshalling
 {
 StatementSyntax GenerateByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateManagedToUnmanagedByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateMarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateManagedToUnmanagedByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateUnmarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateElementCleanupStatement(TypePositionInfo info, StubCodeContext context);
 }
Expand All@@ -45,7 +45,7 @@ public BlittableElementsMarshalling(TypeSyntax managedElementType, TypeSyntax un
 _collectionSource = collectionSource;
 }

 public StatementSyntax GenerateByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 // If the parameter is marshalled by-value [Out], then we don't marshal the contents of the collection.
 // We do clear the span, so that if the invoke target doesn't fill it, we aren't left with undefined content.
Expand DownExpand Up@@ -73,7 +73,7 @@ public StatementSyntax GenerateMarshalStatement(TypePositionInfo info, StubCodeC
 Argument(destination)));
 }

 public StatementSyntax GenerateByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 ExpressionSyntax source = CastToManagedIfNecessary(_collectionSource.GetUnmanagedValuesDestination(info, context));

Expand DownExpand Up@@ -175,7 +175,7 @@ public NonBlittableElementsMarshalling(
 _collectionSource = collectionSource;
 }

 public StatementSyntax GenerateByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 // If the parameter is marshalled by-value [Out], then we don't marshal the contents of the collection.
 // We do clear the span, so that if the invoke target doesn't fill it, we aren't left with undefined content.
Expand DownExpand Up@@ -259,7 +259,7 @@ public StatementSyntax GenerateUnmarshalStatement(TypePositionInfo info, StubCod
 StubCodeContext.Stage.Unmarshal));
 }

 public StatementSyntax GenerateByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 // Use ManagedSource and NativeDestination spans for by-value marshalling since we're just marshalling back the contents,
 // not the array itself.
Expand DownExpand Up@@ -356,7 +356,9 @@ public StatementSyntax GenerateElementCleanupStatement(TypePositionInfo info, St
 VariableDeclarator(
 Identifier(nativeSpanIdentifier))
 .WithInitializer(EqualsValueClause(
 _collectionSource.GetUnmanagedValuesDestination(info, context)))))),
 context.Direction == MarshalDirection.ManagedToUnmanaged
 ? _collectionSource.GetUnmanagedValuesDestination(info, context)
 : _collectionSource.GetUnmanagedValuesSource(info, context)))))),
 contentsCleanupStatements);
 }

Expand Down

2 changes: 1 addition & 1 deletion
...en/Microsoft.Interop.SourceGeneration/Marshalling/MarshalAsMarshallingGeneratorFactory.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -88,7 +88,7 @@ public IMarshallingGenerator Create(
 return s_delegate;

 case { MarshallingAttributeInfo: SafeHandleMarshallingInfo(_, bool isAbstract) }:
 if (!context.AdditionalTemporaryStateLivesAcrossStages)
 if (!context.AdditionalTemporaryStateLivesAcrossStages || context.Direction != MarshalDirection.ManagedToUnmanaged)
 {
 throw new MarshallingNotSupportedException(info, context);
 }
Expand Down

77 changes: 60 additions & 17 deletions
...ervices/gen/Microsoft.Interop.SourceGeneration/Marshalling/StatefulMarshallingStrategy.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -372,40 +372,36 @@ internal sealed class StatefulLinearCollectionMarshalling : ICustomTypeMarshalli
 private readonly MarshallerShape _shape;
 private readonly ExpressionSyntax _numElementsExpression;
 private readonly IElementsMarshalling _elementsMarshalling;
 private readonly bool _cleanupElements;

 public StatefulLinearCollectionMarshalling(
 ICustomTypeMarshallingStrategy innerMarshaller,
 MarshallerShape shape,
 ExpressionSyntax numElementsExpression,
 IElementsMarshalling elementsMarshalling)
 IElementsMarshalling elementsMarshalling,
 bool cleanupElements)
 {
 _innerMarshaller = innerMarshaller;
 _shape = shape;
 _numElementsExpression = numElementsExpression;
 _elementsMarshalling = elementsMarshalling;
 _cleanupElements = cleanupElements;
 }

 public ManagedTypeInfo AsNativeType(TypePositionInfo info) => _innerMarshaller.AsNativeType(info);
 public IEnumerable<StatementSyntax> GenerateCleanupStatements(TypePositionInfo info, StubCodeContext context)
 {
 if (!_cleanupElements)
 {
 yield break;
 }

 StatementSyntax elementCleanup = _elementsMarshalling.GenerateElementCleanupStatement(info, context);

 if (!elementCleanup.IsKind(SyntaxKind.EmptyStatement))
 {
 yield return elementCleanup;
 }

 if (!_shape.HasFlag(MarshallerShape.Free))
 yield break;

 string marshaller = StatefulValueMarshalling.GetMarshallerIdentifier(info, context);
 // <marshaller>.Free();
 yield return ExpressionStatement(
 InvocationExpression(
 MemberAccessExpression(SyntaxKind.SimpleMemberAccessExpression,
 IdentifierName(marshaller),
 IdentifierName(ShapeMemberNames.Free)),
 ArgumentList()));
 }
 public IEnumerable<StatementSyntax> GenerateGuaranteedUnmarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateGuaranteedUnmarshalStatements(info, context);

Expand All@@ -419,9 +415,9 @@ public IEnumerable<StatementSyntax> GenerateMarshalStatements(TypePositionInfo i
 yield return statement;
 }

 if (!info.IsByRef && info.ByValueContentsMarshalKind == ByValueContentsMarshalKind.Out)
 if (context.Direction == MarshalDirection.ManagedToUnmanaged && !info.IsByRef && info.ByValueContentsMarshalKind == ByValueContentsMarshalKind.Out)
 {
 yield return _elementsMarshalling.GenerateByValueOutMarshalStatement(info, context);
 yield return _elementsMarshalling.GenerateManagedToUnmanagedByValueOutMarshalStatement(info, context);
 yield break;
 }

Expand All@@ -437,9 +433,10 @@ public IEnumerable<StatementSyntax> GenerateUnmarshalStatements(TypePositionInfo
 {
 string numElementsIdentifier = MarshallerHelpers.GetNumElementsIdentifier(info, context);

 if (!info.IsByRef && info.ByValueContentsMarshalKind.HasFlag(ByValueContentsMarshalKind.Out))
 if (context.Direction == MarshalDirection.ManagedToUnmanaged && !info.IsByRef && info.ByValueContentsMarshalKind.HasFlag(ByValueContentsMarshalKind.Out))
 {
 yield return _elementsMarshalling.GenerateByValueOutUnmarshalStatement(info, context);
 yield return _elementsMarshalling.GenerateManagedToUnmanagedByValueOutUnmarshalStatement(info, context);
 yield break;
 }

 if (!_shape.HasFlag(MarshallerShape.ToManaged))
Expand DownExpand Up@@ -469,4 +466,50 @@ public IEnumerable<StatementSyntax> GenerateUnmarshalStatements(TypePositionInfo

 public bool UsesNativeIdentifier(TypePositionInfo info, StubCodeContext context) => true;
 }

 /// <summary>
 /// Marshaller that enables calling the Free method on a stateful marshaller.
 /// </summary>
 internal sealed class StatefulFreeMarshalling : ICustomTypeMarshallingStrategy
 {
 private readonly ICustomTypeMarshallingStrategy _innerMarshaller;

 public StatefulFreeMarshalling(ICustomTypeMarshallingStrategy innerMarshaller)
 {
 _innerMarshaller = innerMarshaller;
 }

 public ManagedTypeInfo AsNativeType(TypePositionInfo info) => _innerMarshaller.AsNativeType(info);

 public IEnumerable<StatementSyntax> GenerateCleanupStatements(TypePositionInfo info, StubCodeContext context)
 {
 foreach (var statement in _innerMarshaller.GenerateCleanupStatements(info, context))
 {
 yield return statement;
 }

 string marshaller = StatefulValueMarshalling.GetMarshallerIdentifier(info, context);
 // <marshaller>.Free();
 yield return ExpressionStatement(
 InvocationExpression(
 MemberAccessExpression(SyntaxKind.SimpleMemberAccessExpression,
 IdentifierName(marshaller),
 IdentifierName(ShapeMemberNames.Free)),
 ArgumentList()));
 }
 public IEnumerable<StatementSyntax> GenerateGuaranteedUnmarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateGuaranteedUnmarshalStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateMarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateMarshalStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateNotifyForSuccessfulInvokeStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateNotifyForSuccessfulInvokeStatements(info, context);
 public IEnumerable<StatementSyntax> GeneratePinnedMarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GeneratePinnedMarshalStatements(info, context);
 public IEnumerable<StatementSyntax> GeneratePinStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GeneratePinStatements(info, context);
 public IEnumerable<StatementSyntax> GenerateSetupStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateSetupStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateUnmarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateUnmarshalStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateUnmarshalCaptureStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateUnmarshalCaptureStatements(info, context);

 public bool UsesNativeIdentifier(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.UsesNativeIdentifier(info, context);
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Only call Free in unmanaged->managed stubs when ownership has been transfered to the callee by jkoritzinsky · Pull Request #86415 · dotnet/runtime · GitHub
Skip to content
Only call Free in unmanaged->managed stubs when ownership has been transfered to the callee#86415

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

 Merged

jkoritzinsky
merged 9 commits into

from

May 23, 2023
 Merged


Only call Free in unmanaged->managed stubs when ownership has been transfered to the callee
#86415
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
616d53f

Only call Free in unmanaged->managed stubs when ownership has been tr…


jkoritzinsky May 17, 2023
53ea459

Add missing condition


jkoritzinsky May 17, 2023
0d8cf4c

Fix ref parameter marshalling and by-value collection marshalling. Di…


jkoritzinsky May 19, 2023
c3a6fe4

Add test for by-ref collections


jkoritzinsky May 19, 2023
e6c5b22

Fix by-ref collection ownership.


jkoritzinsky May 19, 2023
fcefc57

Fix compilation of stateless by-value out marshalling for unmanaged-t…


jkoritzinsky May 19, 2023
6bb51e1

Add tests for stateful marshaller shapes and update behavior to match…


jkoritzinsky May 22, 2023
32ff447

Fix test failures and remove duplicate test runs.


jkoritzinsky May 22, 2023
14c023b

Uncomment code


jkoritzinsky May 22, 2023

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


1 change: 1 addition & 0 deletions
...s/gen/Microsoft.Interop.SourceGeneration/LinearCollectionElementMarshallingCodeContext.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ public LinearCollectionElementMarshallingCodeContext(
 _managedSpanIdentifier = managedSpanIdentifier;
 _nativeSpanIdentifier = nativeSpanIdentifier;
 ParentContext = parentContext;
 Direction = ParentContext.Direction;
 }

 public override (TargetFramework framework, Version version) GetTargetFramework()
Expand Down

94 changes: 90 additions & 4 deletions
...rosoft.Interop.SourceGeneration/Marshalling/AttributedMarshallingModelGeneratorFactory.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -244,8 +244,22 @@ private IMarshallingGenerator CreateCustomNativeTypeMarshaller(TypePositionInfo
 if (marshallerData.Shape.HasFlag(MarshallerShape.CallerAllocatedBuffer))
 marshallingStrategy = new StatelessCallerAllocatedBufferMarshalling(marshallingStrategy, marshallerData.MarshallerType.Syntax, marshallerData.BufferElementType.Syntax, isLinearCollectionMarshalling: false);

 if (marshallerData.Shape.HasFlag(MarshallerShape.Free))
 FreeStrategy freeStrategy = GetFreeStrategy(info, context);

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new StatelessUnmanagedToManagedOwnershipTracking(marshallingStrategy);
 }

 if (freeStrategy != FreeStrategy.NoFree && marshallerData.Shape.HasFlag(MarshallerShape.Free))
 {
 marshallingStrategy = new StatelessFreeMarshalling(marshallingStrategy, marshallerData.MarshallerType.Syntax);
 }

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new FreeOwnedOriginalValueMarshalling(marshallingStrategy);
 }
 }

 IMarshallingGenerator marshallingGenerator = new CustomTypeMarshallingGenerator(marshallingStrategy, enableByValueContentsMarshalling: false);
Expand DownExpand Up@@ -311,19 +325,42 @@ private IMarshallingGenerator CreateNativeCollectionMarshaller(
 marshallingStrategy = new StatefulCallerAllocatedBufferMarshalling(marshallingStrategy, marshallerTypeSyntax, bufferElementTypeSyntax);
 }

 FreeStrategy freeStrategy = GetFreeStrategy(info, context);
 IElementsMarshallingCollectionSource collectionSource = new StatefulLinearCollectionSource();
 IElementsMarshalling elementsMarshalling = CreateElementsMarshalling(marshallerData, elementInfo, elementMarshaller, unmanagedElementType, collectionSource);

 marshallingStrategy = new StatefulLinearCollectionMarshalling(marshallingStrategy, marshallerData.Shape, numElementsExpression, elementsMarshalling);
 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new StatelessUnmanagedToManagedOwnershipTracking(marshallingStrategy);
 }

 marshallingStrategy = new StatefulLinearCollectionMarshalling(marshallingStrategy, marshallerData.Shape, numElementsExpression, elementsMarshalling, freeStrategy != FreeStrategy.NoFree);

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new FreeOwnedOriginalValueMarshalling(marshallingStrategy);
 }

 if (marshallerData.Shape.HasFlag(MarshallerShape.Free))
 {
 marshallingStrategy = new StatefulFreeMarshalling(marshallingStrategy);
 }
 }
 else
 {
 marshallingStrategy = new StatelessLinearCollectionSpaceAllocator(marshallerTypeSyntax, nativeType, marshallerData.Shape, numElementsExpression);

 FreeStrategy freeStrategy = GetFreeStrategy(info, context);

 IElementsMarshallingCollectionSource collectionSource = new StatelessLinearCollectionSource(marshallerTypeSyntax);
 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new StatelessUnmanagedToManagedOwnershipTracking(marshallingStrategy);
 }

 IElementsMarshalling elementsMarshalling = CreateElementsMarshalling(marshallerData, elementInfo, elementMarshaller, unmanagedElementType, collectionSource);

 marshallingStrategy = new StatelessLinearCollectionMarshalling(marshallingStrategy, elementsMarshalling, nativeType, marshallerData.Shape);
 marshallingStrategy = new StatelessLinearCollectionMarshalling(marshallingStrategy, elementsMarshalling, nativeType, marshallerData.Shape, freeStrategy != FreeStrategy.NoFree);

 if (marshallerData.Shape.HasFlag(MarshallerShape.CallerAllocatedBuffer))
 {
Expand All@@ -334,8 +371,15 @@ private IMarshallingGenerator CreateNativeCollectionMarshaller(
 marshallingStrategy = new StatelessCallerAllocatedBufferMarshalling(marshallingStrategy, marshallerTypeSyntax, bufferElementTypeSyntax, isLinearCollectionMarshalling: true);
 }

 if (marshallerData.Shape.HasFlag(MarshallerShape.Free))
 if (freeStrategy != FreeStrategy.NoFree && marshallerData.Shape.HasFlag(MarshallerShape.Free))
 {
 marshallingStrategy = new StatelessFreeMarshalling(marshallingStrategy, marshallerTypeSyntax);
 }

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new FreeOwnedOriginalValueMarshalling(marshallingStrategy);
 }
 }

 IMarshallingGenerator marshallingGenerator = new CustomTypeMarshallingGenerator(
Expand All@@ -351,6 +395,48 @@ private IMarshallingGenerator CreateNativeCollectionMarshaller(
 return marshallingGenerator;
 }

 private enum FreeStrategy
 {
 /// <summary>
 /// Free the unmanaged value stored in the native identifier.
 /// </summary>
 FreeNative,
 /// <summary>
 /// Free the unmanaged value originally passed into the stub.
 /// </summary>
 FreeOriginal,
 /// <summary>
 /// Do not free the unmanaged value, we don't own it.
 /// </summary>
 NoFree
 }

 private static FreeStrategy GetFreeStrategy(TypePositionInfo info, StubCodeContext context)
 {
 // When marshalling from managed to unmanaged, we always own the value in the native identifier.
 if (context.Direction == MarshalDirection.ManagedToUnmanaged)
 {
 return FreeStrategy.FreeNative;
 }

 // When we're in a case where we don't have state across stages, the parent stub context that can track the state
 // will only call our Cleanup stage when we own the value in the native identifier.
 if (!context.AdditionalTemporaryStateLivesAcrossStages)
 {
 return FreeStrategy.FreeNative;
 }

 // In an unmanaged-to-managed stub where a value is passed by 'ref',
 // we own the original value once we replace it with the new value we're passing out to the caller.
 if (info.RefKind == RefKind.Ref)
 {
 return FreeStrategy.FreeOriginal;
 }

 // In an unmanaged-to-managed stub, we don't take ownership of the value when it isn't passed by 'ref'.
 return FreeStrategy.NoFree;
 }

 private static IElementsMarshalling CreateElementsMarshalling(CustomTypeMarshallerData marshallerData, TypePositionInfo elementInfo, IMarshallingGenerator elementMarshaller, TypeSyntax unmanagedElementType, IElementsMarshallingCollectionSource collectionSource)
 {
 IElementsMarshalling elementsMarshalling;
Expand Down

16 changes: 9 additions & 7 deletions
...InteropServices/gen/Microsoft.Interop.SourceGeneration/Marshalling/ElementsMarshalling.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,9 +22,9 @@ internal interface IElementsMarshallingCollectionSource

 internal interface IElementsMarshalling
 {
 StatementSyntax GenerateByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateManagedToUnmanagedByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateMarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateManagedToUnmanagedByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateUnmarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateElementCleanupStatement(TypePositionInfo info, StubCodeContext context);
 }
Expand All@@ -45,7 +45,7 @@ public BlittableElementsMarshalling(TypeSyntax managedElementType, TypeSyntax un
 _collectionSource = collectionSource;
 }

 public StatementSyntax GenerateByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 // If the parameter is marshalled by-value [Out], then we don't marshal the contents of the collection.
 // We do clear the span, so that if the invoke target doesn't fill it, we aren't left with undefined content.
Expand DownExpand Up@@ -73,7 +73,7 @@ public StatementSyntax GenerateMarshalStatement(TypePositionInfo info, StubCodeC
 Argument(destination)));
 }

 public StatementSyntax GenerateByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 ExpressionSyntax source = CastToManagedIfNecessary(_collectionSource.GetUnmanagedValuesDestination(info, context));

Expand DownExpand Up@@ -175,7 +175,7 @@ public NonBlittableElementsMarshalling(
 _collectionSource = collectionSource;
 }

 public StatementSyntax GenerateByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 // If the parameter is marshalled by-value [Out], then we don't marshal the contents of the collection.
 // We do clear the span, so that if the invoke target doesn't fill it, we aren't left with undefined content.
Expand DownExpand Up@@ -259,7 +259,7 @@ public StatementSyntax GenerateUnmarshalStatement(TypePositionInfo info, StubCod
 StubCodeContext.Stage.Unmarshal));
 }

 public StatementSyntax GenerateByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 // Use ManagedSource and NativeDestination spans for by-value marshalling since we're just marshalling back the contents,
 // not the array itself.
Expand DownExpand Up@@ -356,7 +356,9 @@ public StatementSyntax GenerateElementCleanupStatement(TypePositionInfo info, St
 VariableDeclarator(
 Identifier(nativeSpanIdentifier))
 .WithInitializer(EqualsValueClause(
 _collectionSource.GetUnmanagedValuesDestination(info, context)))))),
 context.Direction == MarshalDirection.ManagedToUnmanaged
 ? _collectionSource.GetUnmanagedValuesDestination(info, context)
 : _collectionSource.GetUnmanagedValuesSource(info, context)))))),
 contentsCleanupStatements);
 }

Expand Down

2 changes: 1 addition & 1 deletion
...en/Microsoft.Interop.SourceGeneration/Marshalling/MarshalAsMarshallingGeneratorFactory.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -88,7 +88,7 @@ public IMarshallingGenerator Create(
 return s_delegate;

 case { MarshallingAttributeInfo: SafeHandleMarshallingInfo(_, bool isAbstract) }:
 if (!context.AdditionalTemporaryStateLivesAcrossStages)
 if (!context.AdditionalTemporaryStateLivesAcrossStages || context.Direction != MarshalDirection.ManagedToUnmanaged)
 {
 throw new MarshallingNotSupportedException(info, context);
 }
Expand Down

77 changes: 60 additions & 17 deletions
...ervices/gen/Microsoft.Interop.SourceGeneration/Marshalling/StatefulMarshallingStrategy.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -372,40 +372,36 @@ internal sealed class StatefulLinearCollectionMarshalling : ICustomTypeMarshalli
 private readonly MarshallerShape _shape;
 private readonly ExpressionSyntax _numElementsExpression;
 private readonly IElementsMarshalling _elementsMarshalling;
 private readonly bool _cleanupElements;

 public StatefulLinearCollectionMarshalling(
 ICustomTypeMarshallingStrategy innerMarshaller,
 MarshallerShape shape,
 ExpressionSyntax numElementsExpression,
 IElementsMarshalling elementsMarshalling)
 IElementsMarshalling elementsMarshalling,
 bool cleanupElements)
 {
 _innerMarshaller = innerMarshaller;
 _shape = shape;
 _numElementsExpression = numElementsExpression;
 _elementsMarshalling = elementsMarshalling;
 _cleanupElements = cleanupElements;
 }

 public ManagedTypeInfo AsNativeType(TypePositionInfo info) => _innerMarshaller.AsNativeType(info);
 public IEnumerable<StatementSyntax> GenerateCleanupStatements(TypePositionInfo info, StubCodeContext context)
 {
 if (!_cleanupElements)
 {
 yield break;
 }

 StatementSyntax elementCleanup = _elementsMarshalling.GenerateElementCleanupStatement(info, context);

 if (!elementCleanup.IsKind(SyntaxKind.EmptyStatement))
 {
 yield return elementCleanup;
 }

 if (!_shape.HasFlag(MarshallerShape.Free))
 yield break;

 string marshaller = StatefulValueMarshalling.GetMarshallerIdentifier(info, context);
 // <marshaller>.Free();
 yield return ExpressionStatement(
 InvocationExpression(
 MemberAccessExpression(SyntaxKind.SimpleMemberAccessExpression,
 IdentifierName(marshaller),
 IdentifierName(ShapeMemberNames.Free)),
 ArgumentList()));
 }
 public IEnumerable<StatementSyntax> GenerateGuaranteedUnmarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateGuaranteedUnmarshalStatements(info, context);

Expand All@@ -419,9 +415,9 @@ public IEnumerable<StatementSyntax> GenerateMarshalStatements(TypePositionInfo i
 yield return statement;
 }

 if (!info.IsByRef && info.ByValueContentsMarshalKind == ByValueContentsMarshalKind.Out)
 if (context.Direction == MarshalDirection.ManagedToUnmanaged && !info.IsByRef && info.ByValueContentsMarshalKind == ByValueContentsMarshalKind.Out)
 {
 yield return _elementsMarshalling.GenerateByValueOutMarshalStatement(info, context);
 yield return _elementsMarshalling.GenerateManagedToUnmanagedByValueOutMarshalStatement(info, context);
 yield break;
 }

Expand All@@ -437,9 +433,10 @@ public IEnumerable<StatementSyntax> GenerateUnmarshalStatements(TypePositionInfo
 {
 string numElementsIdentifier = MarshallerHelpers.GetNumElementsIdentifier(info, context);

 if (!info.IsByRef && info.ByValueContentsMarshalKind.HasFlag(ByValueContentsMarshalKind.Out))
 if (context.Direction == MarshalDirection.ManagedToUnmanaged && !info.IsByRef && info.ByValueContentsMarshalKind.HasFlag(ByValueContentsMarshalKind.Out))
 {
 yield return _elementsMarshalling.GenerateByValueOutUnmarshalStatement(info, context);
 yield return _elementsMarshalling.GenerateManagedToUnmanagedByValueOutUnmarshalStatement(info, context);
 yield break;
 }

 if (!_shape.HasFlag(MarshallerShape.ToManaged))
Expand DownExpand Up@@ -469,4 +466,50 @@ public IEnumerable<StatementSyntax> GenerateUnmarshalStatements(TypePositionInfo

 public bool UsesNativeIdentifier(TypePositionInfo info, StubCodeContext context) => true;
 }

 /// <summary>
 /// Marshaller that enables calling the Free method on a stateful marshaller.
 /// </summary>
 internal sealed class StatefulFreeMarshalling : ICustomTypeMarshallingStrategy
 {
 private readonly ICustomTypeMarshallingStrategy _innerMarshaller;

 public StatefulFreeMarshalling(ICustomTypeMarshallingStrategy innerMarshaller)
 {
 _innerMarshaller = innerMarshaller;
 }

 public ManagedTypeInfo AsNativeType(TypePositionInfo info) => _innerMarshaller.AsNativeType(info);

 public IEnumerable<StatementSyntax> GenerateCleanupStatements(TypePositionInfo info, StubCodeContext context)
 {
 foreach (var statement in _innerMarshaller.GenerateCleanupStatements(info, context))
 {
 yield return statement;
 }

 string marshaller = StatefulValueMarshalling.GetMarshallerIdentifier(info, context);
 // <marshaller>.Free();
 yield return ExpressionStatement(
 InvocationExpression(
 MemberAccessExpression(SyntaxKind.SimpleMemberAccessExpression,
 IdentifierName(marshaller),
 IdentifierName(ShapeMemberNames.Free)),
 ArgumentList()));
 }
 public IEnumerable<StatementSyntax> GenerateGuaranteedUnmarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateGuaranteedUnmarshalStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateMarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateMarshalStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateNotifyForSuccessfulInvokeStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateNotifyForSuccessfulInvokeStatements(info, context);
 public IEnumerable<StatementSyntax> GeneratePinnedMarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GeneratePinnedMarshalStatements(info, context);
 public IEnumerable<StatementSyntax> GeneratePinStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GeneratePinStatements(info, context);
 public IEnumerable<StatementSyntax> GenerateSetupStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateSetupStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateUnmarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateUnmarshalStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateUnmarshalCaptureStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateUnmarshalCaptureStatements(info, context);

 public bool UsesNativeIdentifier(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.UsesNativeIdentifier(info, context);
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Only call Free in unmanaged->managed stubs when ownership has been transfered to the callee by jkoritzinsky · Pull Request #86415 · dotnet/runtime · GitHub
Skip to content
Only call Free in unmanaged->managed stubs when ownership has been transfered to the callee#86415

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

 Merged

jkoritzinsky
merged 9 commits into

from

May 23, 2023
 Merged


Only call Free in unmanaged->managed stubs when ownership has been transfered to the callee
#86415
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
616d53f

Only call Free in unmanaged->managed stubs when ownership has been tr…


jkoritzinsky May 17, 2023
53ea459

Add missing condition


jkoritzinsky May 17, 2023
0d8cf4c

Fix ref parameter marshalling and by-value collection marshalling. Di…


jkoritzinsky May 19, 2023
c3a6fe4

Add test for by-ref collections


jkoritzinsky May 19, 2023
e6c5b22

Fix by-ref collection ownership.


jkoritzinsky May 19, 2023
fcefc57

Fix compilation of stateless by-value out marshalling for unmanaged-t…


jkoritzinsky May 19, 2023
6bb51e1

Add tests for stateful marshaller shapes and update behavior to match…


jkoritzinsky May 22, 2023
32ff447

Fix test failures and remove duplicate test runs.


jkoritzinsky May 22, 2023
14c023b

Uncomment code


jkoritzinsky May 22, 2023

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


1 change: 1 addition & 0 deletions
...s/gen/Microsoft.Interop.SourceGeneration/LinearCollectionElementMarshallingCodeContext.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ public LinearCollectionElementMarshallingCodeContext(
 _managedSpanIdentifier = managedSpanIdentifier;
 _nativeSpanIdentifier = nativeSpanIdentifier;
 ParentContext = parentContext;
 Direction = ParentContext.Direction;
 }

 public override (TargetFramework framework, Version version) GetTargetFramework()
Expand Down

94 changes: 90 additions & 4 deletions
...rosoft.Interop.SourceGeneration/Marshalling/AttributedMarshallingModelGeneratorFactory.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -244,8 +244,22 @@ private IMarshallingGenerator CreateCustomNativeTypeMarshaller(TypePositionInfo
 if (marshallerData.Shape.HasFlag(MarshallerShape.CallerAllocatedBuffer))
 marshallingStrategy = new StatelessCallerAllocatedBufferMarshalling(marshallingStrategy, marshallerData.MarshallerType.Syntax, marshallerData.BufferElementType.Syntax, isLinearCollectionMarshalling: false);

 if (marshallerData.Shape.HasFlag(MarshallerShape.Free))
 FreeStrategy freeStrategy = GetFreeStrategy(info, context);

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new StatelessUnmanagedToManagedOwnershipTracking(marshallingStrategy);
 }

 if (freeStrategy != FreeStrategy.NoFree && marshallerData.Shape.HasFlag(MarshallerShape.Free))
 {
 marshallingStrategy = new StatelessFreeMarshalling(marshallingStrategy, marshallerData.MarshallerType.Syntax);
 }

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new FreeOwnedOriginalValueMarshalling(marshallingStrategy);
 }
 }

 IMarshallingGenerator marshallingGenerator = new CustomTypeMarshallingGenerator(marshallingStrategy, enableByValueContentsMarshalling: false);
Expand DownExpand Up@@ -311,19 +325,42 @@ private IMarshallingGenerator CreateNativeCollectionMarshaller(
 marshallingStrategy = new StatefulCallerAllocatedBufferMarshalling(marshallingStrategy, marshallerTypeSyntax, bufferElementTypeSyntax);
 }

 FreeStrategy freeStrategy = GetFreeStrategy(info, context);
 IElementsMarshallingCollectionSource collectionSource = new StatefulLinearCollectionSource();
 IElementsMarshalling elementsMarshalling = CreateElementsMarshalling(marshallerData, elementInfo, elementMarshaller, unmanagedElementType, collectionSource);

 marshallingStrategy = new StatefulLinearCollectionMarshalling(marshallingStrategy, marshallerData.Shape, numElementsExpression, elementsMarshalling);
 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new StatelessUnmanagedToManagedOwnershipTracking(marshallingStrategy);
 }

 marshallingStrategy = new StatefulLinearCollectionMarshalling(marshallingStrategy, marshallerData.Shape, numElementsExpression, elementsMarshalling, freeStrategy != FreeStrategy.NoFree);

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new FreeOwnedOriginalValueMarshalling(marshallingStrategy);
 }

 if (marshallerData.Shape.HasFlag(MarshallerShape.Free))
 {
 marshallingStrategy = new StatefulFreeMarshalling(marshallingStrategy);
 }
 }
 else
 {
 marshallingStrategy = new StatelessLinearCollectionSpaceAllocator(marshallerTypeSyntax, nativeType, marshallerData.Shape, numElementsExpression);

 FreeStrategy freeStrategy = GetFreeStrategy(info, context);

 IElementsMarshallingCollectionSource collectionSource = new StatelessLinearCollectionSource(marshallerTypeSyntax);
 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new StatelessUnmanagedToManagedOwnershipTracking(marshallingStrategy);
 }

 IElementsMarshalling elementsMarshalling = CreateElementsMarshalling(marshallerData, elementInfo, elementMarshaller, unmanagedElementType, collectionSource);

 marshallingStrategy = new StatelessLinearCollectionMarshalling(marshallingStrategy, elementsMarshalling, nativeType, marshallerData.Shape);
 marshallingStrategy = new StatelessLinearCollectionMarshalling(marshallingStrategy, elementsMarshalling, nativeType, marshallerData.Shape, freeStrategy != FreeStrategy.NoFree);

 if (marshallerData.Shape.HasFlag(MarshallerShape.CallerAllocatedBuffer))
 {
Expand All@@ -334,8 +371,15 @@ private IMarshallingGenerator CreateNativeCollectionMarshaller(
 marshallingStrategy = new StatelessCallerAllocatedBufferMarshalling(marshallingStrategy, marshallerTypeSyntax, bufferElementTypeSyntax, isLinearCollectionMarshalling: true);
 }

 if (marshallerData.Shape.HasFlag(MarshallerShape.Free))
 if (freeStrategy != FreeStrategy.NoFree && marshallerData.Shape.HasFlag(MarshallerShape.Free))
 {
 marshallingStrategy = new StatelessFreeMarshalling(marshallingStrategy, marshallerTypeSyntax);
 }

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new FreeOwnedOriginalValueMarshalling(marshallingStrategy);
 }
 }

 IMarshallingGenerator marshallingGenerator = new CustomTypeMarshallingGenerator(
Expand All@@ -351,6 +395,48 @@ private IMarshallingGenerator CreateNativeCollectionMarshaller(
 return marshallingGenerator;
 }

 private enum FreeStrategy
 {
 /// <summary>
 /// Free the unmanaged value stored in the native identifier.
 /// </summary>
 FreeNative,
 /// <summary>
 /// Free the unmanaged value originally passed into the stub.
 /// </summary>
 FreeOriginal,
 /// <summary>
 /// Do not free the unmanaged value, we don't own it.
 /// </summary>
 NoFree
 }

 private static FreeStrategy GetFreeStrategy(TypePositionInfo info, StubCodeContext context)
 {
 // When marshalling from managed to unmanaged, we always own the value in the native identifier.
 if (context.Direction == MarshalDirection.ManagedToUnmanaged)
 {
 return FreeStrategy.FreeNative;
 }

 // When we're in a case where we don't have state across stages, the parent stub context that can track the state
 // will only call our Cleanup stage when we own the value in the native identifier.
 if (!context.AdditionalTemporaryStateLivesAcrossStages)
 {
 return FreeStrategy.FreeNative;
 }

 // In an unmanaged-to-managed stub where a value is passed by 'ref',
 // we own the original value once we replace it with the new value we're passing out to the caller.
 if (info.RefKind == RefKind.Ref)
 {
 return FreeStrategy.FreeOriginal;
 }

 // In an unmanaged-to-managed stub, we don't take ownership of the value when it isn't passed by 'ref'.
 return FreeStrategy.NoFree;
 }

 private static IElementsMarshalling CreateElementsMarshalling(CustomTypeMarshallerData marshallerData, TypePositionInfo elementInfo, IMarshallingGenerator elementMarshaller, TypeSyntax unmanagedElementType, IElementsMarshallingCollectionSource collectionSource)
 {
 IElementsMarshalling elementsMarshalling;
Expand Down

16 changes: 9 additions & 7 deletions
...InteropServices/gen/Microsoft.Interop.SourceGeneration/Marshalling/ElementsMarshalling.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,9 +22,9 @@ internal interface IElementsMarshallingCollectionSource

 internal interface IElementsMarshalling
 {
 StatementSyntax GenerateByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateManagedToUnmanagedByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateMarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateManagedToUnmanagedByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateUnmarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateElementCleanupStatement(TypePositionInfo info, StubCodeContext context);
 }
Expand All@@ -45,7 +45,7 @@ public BlittableElementsMarshalling(TypeSyntax managedElementType, TypeSyntax un
 _collectionSource = collectionSource;
 }

 public StatementSyntax GenerateByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 // If the parameter is marshalled by-value [Out], then we don't marshal the contents of the collection.
 // We do clear the span, so that if the invoke target doesn't fill it, we aren't left with undefined content.
Expand DownExpand Up@@ -73,7 +73,7 @@ public StatementSyntax GenerateMarshalStatement(TypePositionInfo info, StubCodeC
 Argument(destination)));
 }

 public StatementSyntax GenerateByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 ExpressionSyntax source = CastToManagedIfNecessary(_collectionSource.GetUnmanagedValuesDestination(info, context));

Expand DownExpand Up@@ -175,7 +175,7 @@ public NonBlittableElementsMarshalling(
 _collectionSource = collectionSource;
 }

 public StatementSyntax GenerateByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 // If the parameter is marshalled by-value [Out], then we don't marshal the contents of the collection.
 // We do clear the span, so that if the invoke target doesn't fill it, we aren't left with undefined content.
Expand DownExpand Up@@ -259,7 +259,7 @@ public StatementSyntax GenerateUnmarshalStatement(TypePositionInfo info, StubCod
 StubCodeContext.Stage.Unmarshal));
 }

 public StatementSyntax GenerateByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 // Use ManagedSource and NativeDestination spans for by-value marshalling since we're just marshalling back the contents,
 // not the array itself.
Expand DownExpand Up@@ -356,7 +356,9 @@ public StatementSyntax GenerateElementCleanupStatement(TypePositionInfo info, St
 VariableDeclarator(
 Identifier(nativeSpanIdentifier))
 .WithInitializer(EqualsValueClause(
 _collectionSource.GetUnmanagedValuesDestination(info, context)))))),
 context.Direction == MarshalDirection.ManagedToUnmanaged
 ? _collectionSource.GetUnmanagedValuesDestination(info, context)
 : _collectionSource.GetUnmanagedValuesSource(info, context)))))),
 contentsCleanupStatements);
 }

Expand Down

2 changes: 1 addition & 1 deletion
...en/Microsoft.Interop.SourceGeneration/Marshalling/MarshalAsMarshallingGeneratorFactory.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -88,7 +88,7 @@ public IMarshallingGenerator Create(
 return s_delegate;

 case { MarshallingAttributeInfo: SafeHandleMarshallingInfo(_, bool isAbstract) }:
 if (!context.AdditionalTemporaryStateLivesAcrossStages)
 if (!context.AdditionalTemporaryStateLivesAcrossStages || context.Direction != MarshalDirection.ManagedToUnmanaged)
 {
 throw new MarshallingNotSupportedException(info, context);
 }
Expand Down

77 changes: 60 additions & 17 deletions
...ervices/gen/Microsoft.Interop.SourceGeneration/Marshalling/StatefulMarshallingStrategy.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -372,40 +372,36 @@ internal sealed class StatefulLinearCollectionMarshalling : ICustomTypeMarshalli
 private readonly MarshallerShape _shape;
 private readonly ExpressionSyntax _numElementsExpression;
 private readonly IElementsMarshalling _elementsMarshalling;
 private readonly bool _cleanupElements;

 public StatefulLinearCollectionMarshalling(
 ICustomTypeMarshallingStrategy innerMarshaller,
 MarshallerShape shape,
 ExpressionSyntax numElementsExpression,
 IElementsMarshalling elementsMarshalling)
 IElementsMarshalling elementsMarshalling,
 bool cleanupElements)
 {
 _innerMarshaller = innerMarshaller;
 _shape = shape;
 _numElementsExpression = numElementsExpression;
 _elementsMarshalling = elementsMarshalling;
 _cleanupElements = cleanupElements;
 }

 public ManagedTypeInfo AsNativeType(TypePositionInfo info) => _innerMarshaller.AsNativeType(info);
 public IEnumerable<StatementSyntax> GenerateCleanupStatements(TypePositionInfo info, StubCodeContext context)
 {
 if (!_cleanupElements)
 {
 yield break;
 }

 StatementSyntax elementCleanup = _elementsMarshalling.GenerateElementCleanupStatement(info, context);

 if (!elementCleanup.IsKind(SyntaxKind.EmptyStatement))
 {
 yield return elementCleanup;
 }

 if (!_shape.HasFlag(MarshallerShape.Free))
 yield break;

 string marshaller = StatefulValueMarshalling.GetMarshallerIdentifier(info, context);
 // <marshaller>.Free();
 yield return ExpressionStatement(
 InvocationExpression(
 MemberAccessExpression(SyntaxKind.SimpleMemberAccessExpression,
 IdentifierName(marshaller),
 IdentifierName(ShapeMemberNames.Free)),
 ArgumentList()));
 }
 public IEnumerable<StatementSyntax> GenerateGuaranteedUnmarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateGuaranteedUnmarshalStatements(info, context);

Expand All@@ -419,9 +415,9 @@ public IEnumerable<StatementSyntax> GenerateMarshalStatements(TypePositionInfo i
 yield return statement;
 }

 if (!info.IsByRef && info.ByValueContentsMarshalKind == ByValueContentsMarshalKind.Out)
 if (context.Direction == MarshalDirection.ManagedToUnmanaged && !info.IsByRef && info.ByValueContentsMarshalKind == ByValueContentsMarshalKind.Out)
 {
 yield return _elementsMarshalling.GenerateByValueOutMarshalStatement(info, context);
 yield return _elementsMarshalling.GenerateManagedToUnmanagedByValueOutMarshalStatement(info, context);
 yield break;
 }

Expand All@@ -437,9 +433,10 @@ public IEnumerable<StatementSyntax> GenerateUnmarshalStatements(TypePositionInfo
 {
 string numElementsIdentifier = MarshallerHelpers.GetNumElementsIdentifier(info, context);

 if (!info.IsByRef && info.ByValueContentsMarshalKind.HasFlag(ByValueContentsMarshalKind.Out))
 if (context.Direction == MarshalDirection.ManagedToUnmanaged && !info.IsByRef && info.ByValueContentsMarshalKind.HasFlag(ByValueContentsMarshalKind.Out))
 {
 yield return _elementsMarshalling.GenerateByValueOutUnmarshalStatement(info, context);
 yield return _elementsMarshalling.GenerateManagedToUnmanagedByValueOutUnmarshalStatement(info, context);
 yield break;
 }

 if (!_shape.HasFlag(MarshallerShape.ToManaged))
Expand DownExpand Up@@ -469,4 +466,50 @@ public IEnumerable<StatementSyntax> GenerateUnmarshalStatements(TypePositionInfo

 public bool UsesNativeIdentifier(TypePositionInfo info, StubCodeContext context) => true;
 }

 /// <summary>
 /// Marshaller that enables calling the Free method on a stateful marshaller.
 /// </summary>
 internal sealed class StatefulFreeMarshalling : ICustomTypeMarshallingStrategy
 {
 private readonly ICustomTypeMarshallingStrategy _innerMarshaller;

 public StatefulFreeMarshalling(ICustomTypeMarshallingStrategy innerMarshaller)
 {
 _innerMarshaller = innerMarshaller;
 }

 public ManagedTypeInfo AsNativeType(TypePositionInfo info) => _innerMarshaller.AsNativeType(info);

 public IEnumerable<StatementSyntax> GenerateCleanupStatements(TypePositionInfo info, StubCodeContext context)
 {
 foreach (var statement in _innerMarshaller.GenerateCleanupStatements(info, context))
 {
 yield return statement;
 }

 string marshaller = StatefulValueMarshalling.GetMarshallerIdentifier(info, context);
 // <marshaller>.Free();
 yield return ExpressionStatement(
 InvocationExpression(
 MemberAccessExpression(SyntaxKind.SimpleMemberAccessExpression,
 IdentifierName(marshaller),
 IdentifierName(ShapeMemberNames.Free)),
 ArgumentList()));
 }
 public IEnumerable<StatementSyntax> GenerateGuaranteedUnmarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateGuaranteedUnmarshalStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateMarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateMarshalStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateNotifyForSuccessfulInvokeStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateNotifyForSuccessfulInvokeStatements(info, context);
 public IEnumerable<StatementSyntax> GeneratePinnedMarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GeneratePinnedMarshalStatements(info, context);
 public IEnumerable<StatementSyntax> GeneratePinStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GeneratePinStatements(info, context);
 public IEnumerable<StatementSyntax> GenerateSetupStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateSetupStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateUnmarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateUnmarshalStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateUnmarshalCaptureStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateUnmarshalCaptureStatements(info, context);

 public bool UsesNativeIdentifier(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.UsesNativeIdentifier(info, context);
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Only call Free in unmanaged->managed stubs when ownership has been transfered to the callee by jkoritzinsky · Pull Request #86415 · dotnet/runtime · GitHub
Skip to content
Only call Free in unmanaged->managed stubs when ownership has been transfered to the callee#86415

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

 Merged

jkoritzinsky
merged 9 commits into

from

May 23, 2023
 Merged


Only call Free in unmanaged->managed stubs when ownership has been transfered to the callee
#86415
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
616d53f

Only call Free in unmanaged->managed stubs when ownership has been tr…


jkoritzinsky May 17, 2023
53ea459

Add missing condition


jkoritzinsky May 17, 2023
0d8cf4c

Fix ref parameter marshalling and by-value collection marshalling. Di…


jkoritzinsky May 19, 2023
c3a6fe4

Add test for by-ref collections


jkoritzinsky May 19, 2023
e6c5b22

Fix by-ref collection ownership.


jkoritzinsky May 19, 2023
fcefc57

Fix compilation of stateless by-value out marshalling for unmanaged-t…


jkoritzinsky May 19, 2023
6bb51e1

Add tests for stateful marshaller shapes and update behavior to match…


jkoritzinsky May 22, 2023
32ff447

Fix test failures and remove duplicate test runs.


jkoritzinsky May 22, 2023
14c023b

Uncomment code


jkoritzinsky May 22, 2023

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


1 change: 1 addition & 0 deletions
...s/gen/Microsoft.Interop.SourceGeneration/LinearCollectionElementMarshallingCodeContext.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ public LinearCollectionElementMarshallingCodeContext(
 _managedSpanIdentifier = managedSpanIdentifier;
 _nativeSpanIdentifier = nativeSpanIdentifier;
 ParentContext = parentContext;
 Direction = ParentContext.Direction;
 }

 public override (TargetFramework framework, Version version) GetTargetFramework()
Expand Down

94 changes: 90 additions & 4 deletions
...rosoft.Interop.SourceGeneration/Marshalling/AttributedMarshallingModelGeneratorFactory.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -244,8 +244,22 @@ private IMarshallingGenerator CreateCustomNativeTypeMarshaller(TypePositionInfo
 if (marshallerData.Shape.HasFlag(MarshallerShape.CallerAllocatedBuffer))
 marshallingStrategy = new StatelessCallerAllocatedBufferMarshalling(marshallingStrategy, marshallerData.MarshallerType.Syntax, marshallerData.BufferElementType.Syntax, isLinearCollectionMarshalling: false);

 if (marshallerData.Shape.HasFlag(MarshallerShape.Free))
 FreeStrategy freeStrategy = GetFreeStrategy(info, context);

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new StatelessUnmanagedToManagedOwnershipTracking(marshallingStrategy);
 }

 if (freeStrategy != FreeStrategy.NoFree && marshallerData.Shape.HasFlag(MarshallerShape.Free))
 {
 marshallingStrategy = new StatelessFreeMarshalling(marshallingStrategy, marshallerData.MarshallerType.Syntax);
 }

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new FreeOwnedOriginalValueMarshalling(marshallingStrategy);
 }
 }

 IMarshallingGenerator marshallingGenerator = new CustomTypeMarshallingGenerator(marshallingStrategy, enableByValueContentsMarshalling: false);
Expand DownExpand Up@@ -311,19 +325,42 @@ private IMarshallingGenerator CreateNativeCollectionMarshaller(
 marshallingStrategy = new StatefulCallerAllocatedBufferMarshalling(marshallingStrategy, marshallerTypeSyntax, bufferElementTypeSyntax);
 }

 FreeStrategy freeStrategy = GetFreeStrategy(info, context);
 IElementsMarshallingCollectionSource collectionSource = new StatefulLinearCollectionSource();
 IElementsMarshalling elementsMarshalling = CreateElementsMarshalling(marshallerData, elementInfo, elementMarshaller, unmanagedElementType, collectionSource);

 marshallingStrategy = new StatefulLinearCollectionMarshalling(marshallingStrategy, marshallerData.Shape, numElementsExpression, elementsMarshalling);
 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new StatelessUnmanagedToManagedOwnershipTracking(marshallingStrategy);
 }

 marshallingStrategy = new StatefulLinearCollectionMarshalling(marshallingStrategy, marshallerData.Shape, numElementsExpression, elementsMarshalling, freeStrategy != FreeStrategy.NoFree);

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new FreeOwnedOriginalValueMarshalling(marshallingStrategy);
 }

 if (marshallerData.Shape.HasFlag(MarshallerShape.Free))
 {
 marshallingStrategy = new StatefulFreeMarshalling(marshallingStrategy);
 }
 }
 else
 {
 marshallingStrategy = new StatelessLinearCollectionSpaceAllocator(marshallerTypeSyntax, nativeType, marshallerData.Shape, numElementsExpression);

 FreeStrategy freeStrategy = GetFreeStrategy(info, context);

 IElementsMarshallingCollectionSource collectionSource = new StatelessLinearCollectionSource(marshallerTypeSyntax);
 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new StatelessUnmanagedToManagedOwnershipTracking(marshallingStrategy);
 }

 IElementsMarshalling elementsMarshalling = CreateElementsMarshalling(marshallerData, elementInfo, elementMarshaller, unmanagedElementType, collectionSource);

 marshallingStrategy = new StatelessLinearCollectionMarshalling(marshallingStrategy, elementsMarshalling, nativeType, marshallerData.Shape);
 marshallingStrategy = new StatelessLinearCollectionMarshalling(marshallingStrategy, elementsMarshalling, nativeType, marshallerData.Shape, freeStrategy != FreeStrategy.NoFree);

 if (marshallerData.Shape.HasFlag(MarshallerShape.CallerAllocatedBuffer))
 {
Expand All@@ -334,8 +371,15 @@ private IMarshallingGenerator CreateNativeCollectionMarshaller(
 marshallingStrategy = new StatelessCallerAllocatedBufferMarshalling(marshallingStrategy, marshallerTypeSyntax, bufferElementTypeSyntax, isLinearCollectionMarshalling: true);
 }

 if (marshallerData.Shape.HasFlag(MarshallerShape.Free))
 if (freeStrategy != FreeStrategy.NoFree && marshallerData.Shape.HasFlag(MarshallerShape.Free))
 {
 marshallingStrategy = new StatelessFreeMarshalling(marshallingStrategy, marshallerTypeSyntax);
 }

 if (freeStrategy == FreeStrategy.FreeOriginal)
 {
 marshallingStrategy = new FreeOwnedOriginalValueMarshalling(marshallingStrategy);
 }
 }

 IMarshallingGenerator marshallingGenerator = new CustomTypeMarshallingGenerator(
Expand All@@ -351,6 +395,48 @@ private IMarshallingGenerator CreateNativeCollectionMarshaller(
 return marshallingGenerator;
 }

 private enum FreeStrategy
 {
 /// <summary>
 /// Free the unmanaged value stored in the native identifier.
 /// </summary>
 FreeNative,
 /// <summary>
 /// Free the unmanaged value originally passed into the stub.
 /// </summary>
 FreeOriginal,
 /// <summary>
 /// Do not free the unmanaged value, we don't own it.
 /// </summary>
 NoFree
 }

 private static FreeStrategy GetFreeStrategy(TypePositionInfo info, StubCodeContext context)
 {
 // When marshalling from managed to unmanaged, we always own the value in the native identifier.
 if (context.Direction == MarshalDirection.ManagedToUnmanaged)
 {
 return FreeStrategy.FreeNative;
 }

 // When we're in a case where we don't have state across stages, the parent stub context that can track the state
 // will only call our Cleanup stage when we own the value in the native identifier.
 if (!context.AdditionalTemporaryStateLivesAcrossStages)
 {
 return FreeStrategy.FreeNative;
 }

 // In an unmanaged-to-managed stub where a value is passed by 'ref',
 // we own the original value once we replace it with the new value we're passing out to the caller.
 if (info.RefKind == RefKind.Ref)
 {
 return FreeStrategy.FreeOriginal;
 }

 // In an unmanaged-to-managed stub, we don't take ownership of the value when it isn't passed by 'ref'.
 return FreeStrategy.NoFree;
 }

 private static IElementsMarshalling CreateElementsMarshalling(CustomTypeMarshallerData marshallerData, TypePositionInfo elementInfo, IMarshallingGenerator elementMarshaller, TypeSyntax unmanagedElementType, IElementsMarshallingCollectionSource collectionSource)
 {
 IElementsMarshalling elementsMarshalling;
Expand Down

16 changes: 9 additions & 7 deletions
...InteropServices/gen/Microsoft.Interop.SourceGeneration/Marshalling/ElementsMarshalling.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,9 +22,9 @@ internal interface IElementsMarshallingCollectionSource

 internal interface IElementsMarshalling
 {
 StatementSyntax GenerateByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateManagedToUnmanagedByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateMarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateManagedToUnmanagedByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateUnmarshalStatement(TypePositionInfo info, StubCodeContext context);
 StatementSyntax GenerateElementCleanupStatement(TypePositionInfo info, StubCodeContext context);
 }
Expand All@@ -45,7 +45,7 @@ public BlittableElementsMarshalling(TypeSyntax managedElementType, TypeSyntax un
 _collectionSource = collectionSource;
 }

 public StatementSyntax GenerateByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 // If the parameter is marshalled by-value [Out], then we don't marshal the contents of the collection.
 // We do clear the span, so that if the invoke target doesn't fill it, we aren't left with undefined content.
Expand DownExpand Up@@ -73,7 +73,7 @@ public StatementSyntax GenerateMarshalStatement(TypePositionInfo info, StubCodeC
 Argument(destination)));
 }

 public StatementSyntax GenerateByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 ExpressionSyntax source = CastToManagedIfNecessary(_collectionSource.GetUnmanagedValuesDestination(info, context));

Expand DownExpand Up@@ -175,7 +175,7 @@ public NonBlittableElementsMarshalling(
 _collectionSource = collectionSource;
 }

 public StatementSyntax GenerateByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutMarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 // If the parameter is marshalled by-value [Out], then we don't marshal the contents of the collection.
 // We do clear the span, so that if the invoke target doesn't fill it, we aren't left with undefined content.
Expand DownExpand Up@@ -259,7 +259,7 @@ public StatementSyntax GenerateUnmarshalStatement(TypePositionInfo info, StubCod
 StubCodeContext.Stage.Unmarshal));
 }

 public StatementSyntax GenerateByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 public StatementSyntax GenerateManagedToUnmanagedByValueOutUnmarshalStatement(TypePositionInfo info, StubCodeContext context)
 {
 // Use ManagedSource and NativeDestination spans for by-value marshalling since we're just marshalling back the contents,
 // not the array itself.
Expand DownExpand Up@@ -356,7 +356,9 @@ public StatementSyntax GenerateElementCleanupStatement(TypePositionInfo info, St
 VariableDeclarator(
 Identifier(nativeSpanIdentifier))
 .WithInitializer(EqualsValueClause(
 _collectionSource.GetUnmanagedValuesDestination(info, context)))))),
 context.Direction == MarshalDirection.ManagedToUnmanaged
 ? _collectionSource.GetUnmanagedValuesDestination(info, context)
 : _collectionSource.GetUnmanagedValuesSource(info, context)))))),
 contentsCleanupStatements);
 }

Expand Down

2 changes: 1 addition & 1 deletion
...en/Microsoft.Interop.SourceGeneration/Marshalling/MarshalAsMarshallingGeneratorFactory.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -88,7 +88,7 @@ public IMarshallingGenerator Create(
 return s_delegate;

 case { MarshallingAttributeInfo: SafeHandleMarshallingInfo(_, bool isAbstract) }:
 if (!context.AdditionalTemporaryStateLivesAcrossStages)
 if (!context.AdditionalTemporaryStateLivesAcrossStages || context.Direction != MarshalDirection.ManagedToUnmanaged)
 {
 throw new MarshallingNotSupportedException(info, context);
 }
Expand Down

77 changes: 60 additions & 17 deletions
...ervices/gen/Microsoft.Interop.SourceGeneration/Marshalling/StatefulMarshallingStrategy.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -372,40 +372,36 @@ internal sealed class StatefulLinearCollectionMarshalling : ICustomTypeMarshalli
 private readonly MarshallerShape _shape;
 private readonly ExpressionSyntax _numElementsExpression;
 private readonly IElementsMarshalling _elementsMarshalling;
 private readonly bool _cleanupElements;

 public StatefulLinearCollectionMarshalling(
 ICustomTypeMarshallingStrategy innerMarshaller,
 MarshallerShape shape,
 ExpressionSyntax numElementsExpression,
 IElementsMarshalling elementsMarshalling)
 IElementsMarshalling elementsMarshalling,
 bool cleanupElements)
 {
 _innerMarshaller = innerMarshaller;
 _shape = shape;
 _numElementsExpression = numElementsExpression;
 _elementsMarshalling = elementsMarshalling;
 _cleanupElements = cleanupElements;
 }

 public ManagedTypeInfo AsNativeType(TypePositionInfo info) => _innerMarshaller.AsNativeType(info);
 public IEnumerable<StatementSyntax> GenerateCleanupStatements(TypePositionInfo info, StubCodeContext context)
 {
 if (!_cleanupElements)
 {
 yield break;
 }

 StatementSyntax elementCleanup = _elementsMarshalling.GenerateElementCleanupStatement(info, context);

 if (!elementCleanup.IsKind(SyntaxKind.EmptyStatement))
 {
 yield return elementCleanup;
 }

 if (!_shape.HasFlag(MarshallerShape.Free))
 yield break;

 string marshaller = StatefulValueMarshalling.GetMarshallerIdentifier(info, context);
 // <marshaller>.Free();
 yield return ExpressionStatement(
 InvocationExpression(
 MemberAccessExpression(SyntaxKind.SimpleMemberAccessExpression,
 IdentifierName(marshaller),
 IdentifierName(ShapeMemberNames.Free)),
 ArgumentList()));
 }
 public IEnumerable<StatementSyntax> GenerateGuaranteedUnmarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateGuaranteedUnmarshalStatements(info, context);

Expand All@@ -419,9 +415,9 @@ public IEnumerable<StatementSyntax> GenerateMarshalStatements(TypePositionInfo i
 yield return statement;
 }

 if (!info.IsByRef && info.ByValueContentsMarshalKind == ByValueContentsMarshalKind.Out)
 if (context.Direction == MarshalDirection.ManagedToUnmanaged && !info.IsByRef && info.ByValueContentsMarshalKind == ByValueContentsMarshalKind.Out)
 {
 yield return _elementsMarshalling.GenerateByValueOutMarshalStatement(info, context);
 yield return _elementsMarshalling.GenerateManagedToUnmanagedByValueOutMarshalStatement(info, context);
 yield break;
 }

Expand All@@ -437,9 +433,10 @@ public IEnumerable<StatementSyntax> GenerateUnmarshalStatements(TypePositionInfo
 {
 string numElementsIdentifier = MarshallerHelpers.GetNumElementsIdentifier(info, context);

 if (!info.IsByRef && info.ByValueContentsMarshalKind.HasFlag(ByValueContentsMarshalKind.Out))
 if (context.Direction == MarshalDirection.ManagedToUnmanaged && !info.IsByRef && info.ByValueContentsMarshalKind.HasFlag(ByValueContentsMarshalKind.Out))
 {
 yield return _elementsMarshalling.GenerateByValueOutUnmarshalStatement(info, context);
 yield return _elementsMarshalling.GenerateManagedToUnmanagedByValueOutUnmarshalStatement(info, context);
 yield break;
 }

 if (!_shape.HasFlag(MarshallerShape.ToManaged))
Expand DownExpand Up@@ -469,4 +466,50 @@ public IEnumerable<StatementSyntax> GenerateUnmarshalStatements(TypePositionInfo

 public bool UsesNativeIdentifier(TypePositionInfo info, StubCodeContext context) => true;
 }

 /// <summary>
 /// Marshaller that enables calling the Free method on a stateful marshaller.
 /// </summary>
 internal sealed class StatefulFreeMarshalling : ICustomTypeMarshallingStrategy
 {
 private readonly ICustomTypeMarshallingStrategy _innerMarshaller;

 public StatefulFreeMarshalling(ICustomTypeMarshallingStrategy innerMarshaller)
 {
 _innerMarshaller = innerMarshaller;
 }

 public ManagedTypeInfo AsNativeType(TypePositionInfo info) => _innerMarshaller.AsNativeType(info);

 public IEnumerable<StatementSyntax> GenerateCleanupStatements(TypePositionInfo info, StubCodeContext context)
 {
 foreach (var statement in _innerMarshaller.GenerateCleanupStatements(info, context))
 {
 yield return statement;
 }

 string marshaller = StatefulValueMarshalling.GetMarshallerIdentifier(info, context);
 // <marshaller>.Free();
 yield return ExpressionStatement(
 InvocationExpression(
 MemberAccessExpression(SyntaxKind.SimpleMemberAccessExpression,
 IdentifierName(marshaller),
 IdentifierName(ShapeMemberNames.Free)),
 ArgumentList()));
 }
 public IEnumerable<StatementSyntax> GenerateGuaranteedUnmarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateGuaranteedUnmarshalStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateMarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateMarshalStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateNotifyForSuccessfulInvokeStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateNotifyForSuccessfulInvokeStatements(info, context);
 public IEnumerable<StatementSyntax> GeneratePinnedMarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GeneratePinnedMarshalStatements(info, context);
 public IEnumerable<StatementSyntax> GeneratePinStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GeneratePinStatements(info, context);
 public IEnumerable<StatementSyntax> GenerateSetupStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateSetupStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateUnmarshalStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateUnmarshalStatements(info, context);

 public IEnumerable<StatementSyntax> GenerateUnmarshalCaptureStatements(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.GenerateUnmarshalCaptureStatements(info, context);

 public bool UsesNativeIdentifier(TypePositionInfo info, StubCodeContext context) => _innerMarshaller.UsesNativeIdentifier(info, context);
 }
}
Loading