Skip to content

switch to using CSTRMarshaller instead of AnsiBSTR #55032

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
mangod9 merged 9 commits into from
Jul 13, 2021
Merged

switch to using CSTRMarshaller instead of AnsiBSTR #55032

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
42ff51a
switch to using CSTRMarshaller instead of AnsiBSTR
mangod9 Jul 1, 2021
821aece
cleanup
mangod9 Jul 1, 2021
39f17b8
Add CleanupManaged back
mangod9 Jul 2, 2021
5d24e5a
CR feedback
mangod9 Jul 2, 2021
f4f44c8
update MAX_LOCAL_BUFFER_LENGTH
mangod9 Jul 6, 2021
8575306
generate stubs for all methods if corelib is within the bubble.
mangod9 Jul 8, 2021
a3f5ac2
Revert "generate stubs for all methods if corelib is within the bubble."
mangod9 Jul 8, 2021
185ccc0
CR feedback
mangod9 Jul 12, 2021
56f8cbe
use wellknowntype
mangod9 Jul 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
switch to using CSTRMarshaller instead of AnsiBSTR
  • Loading branch information
@mangod9
mangod9 committed Jul 1, 2021
commit 42ff51ad2eda01d6a930a1fd4e958b3dce6652d8
105 changes: 64 additions & 41 deletions src/coreclr/tools/Common/TypeSystem/Interop/IL/Marshaller.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1581,13 +1581,7 @@ protected override void EmitCleanupManaged(ILCodeStream codeStream)

class AnsiStringMarshaller : Marshaller
{
internal override bool CleanupRequired
{
get
{
return true;
}
}
const int MAX_LOCAL_BUFFER_LENGTH = 256; // TODO: Is this accurate on all platforms?

internal override void EmitElementCleanup(ILCodeStream codeStream, ILEmitter emitter)
{
Expand All @@ -1603,24 +1597,77 @@ protected override void TransformManagedToNative(ILCodeStream codeStream)
// ANSI marshalling. Allocate a byte array, copy characters
//

#if READYTORUN
var stringToAnsi =
Context.SystemModule.GetKnownType("System.StubHelpers", "AnsiBSTRMarshaler")
Context.SystemModule.GetKnownType("System.StubHelpers", "CSTRMarshaler")
.GetKnownMethod("ConvertToNative", null);

bool bPassByValueInOnly = In && !Out && !IsManagedByRef;
ILLocalVariable localBuffer = emitter.NewLocal(Context.GetWellKnownType(WellKnownType.IntPtr));
if (bPassByValueInOnly)
Copy link
Member Author

@mangod9 mangod9 Jul 1, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is there a reason why this logic cant move to System.StubHelpers.CSTRMarshaler ?

Copy link
Member

@jkotas jkotas Jul 1, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it would be nice to have majority of the logic in C#, and minimize amount of the hand-emitted IL.

{
var bufSize = emitter.NewLocal(Context.GetWellKnownType(WellKnownType.Int32));
//localBuffer = emitter.NewLocal(Context.GetWellKnownType(WellKnownType.Byte));

// LocalBuffer = 0
codeStream.Emit(ILOpcode.ldnull);
codeStream.EmitStLoc(localBuffer);

var noOptimize = emitter.NewCodeLabel();

// if == NULL, goto NoOptimize
LoadManagedValue(codeStream);
codeStream.Emit(ILOpcode.brfalse, noOptimize);

// String.Length + 2
LoadManagedValue(codeStream);
var stringLen =
Context.SystemModule.GetKnownType("System", "String")
.GetKnownMethod("get_Length", null);
codeStream.Emit(ILOpcode.call, emitter.NewToken(stringLen));
codeStream.EmitLdc(2);
codeStream.Emit(ILOpcode.add);

// (String.Length + 2) * GetMaxDBCSCharByteSize()
codeStream.Emit(ILOpcode.ldsfld, emitter.NewToken(Context.SystemModule.GetKnownType(
"System.Runtime.InteropServices","Marshal")
.GetKnownField("SystemMaxDBCSCharSize")));
codeStream.Emit(ILOpcode.mul_ovf);

// BufSize = (String.Length + 2) * GetMaxDBCSCharByteSize()
codeStream.EmitStLoc(bufSize);

// if (MAX_LOCAL_BUFFER_LENGTH < BufSize ) goto NoOptimize
codeStream.EmitLdc(MAX_LOCAL_BUFFER_LENGTH + 1);
codeStream.EmitLdLoc(bufSize);
codeStream.Emit(ILOpcode.clt);
codeStream.Emit(ILOpcode.brtrue, noOptimize);

// LocalBuffer = localloc(BufSize);
codeStream.EmitLdLoc(bufSize);
codeStream.Emit(ILOpcode.localloc);
codeStream.EmitStLoc(localBuffer);

// NoOptimize:
codeStream.EmitLabel(noOptimize);
}

int flags = (PInvokeFlags.BestFitMapping ? 0x1 : 0)
| (PInvokeFlags.ThrowOnUnmappableChar ? 0x100 : 0);

// CSTRMarshaler.ConvertToNative pManaged, dwAnsiMarshalFlags, pLocalBuffer
codeStream.EmitLdc(flags);
LoadManagedValue(codeStream);
codeStream.Emit(ILOpcode.call, emitter.NewToken(stringToAnsi));
#else
LoadManagedValue(codeStream);
var stringToAnsi = Context.GetHelperEntryPoint("InteropHelpers", "StringToAnsiString");

codeStream.Emit(PInvokeFlags.BestFitMapping ? ILOpcode.ldc_i4_1 : ILOpcode.ldc_i4_0);
codeStream.Emit(PInvokeFlags.ThrowOnUnmappableChar ? ILOpcode.ldc_i4_1 : ILOpcode.ldc_i4_0);
if (bPassByValueInOnly)
{
codeStream.EmitLdLoc(localBuffer);
}
else
{
codeStream.Emit(ILOpcode.ldnull);
}

codeStream.Emit(ILOpcode.call, emitter.NewToken(stringToAnsi));
#endif

StoreNativeValue(codeStream);
}
Expand All @@ -1631,7 +1678,7 @@ protected override void TransformNativeToManaged(ILCodeStream codeStream)

#if READYTORUN
var ansiToString =
Context.SystemModule.GetKnownType("System.StubHelpers", "AnsiBSTRMarshaler")
Context.SystemModule.GetKnownType("System.StubHelpers", "CSTRMarshaler")
.GetKnownMethod("ConvertToManaged", null);
#else
var ansiToString = Context.GetHelperEntryPoint("InteropHelpers", "AnsiStringToString");
Expand All @@ -1640,30 +1687,6 @@ protected override void TransformNativeToManaged(ILCodeStream codeStream)
codeStream.Emit(ILOpcode.call, emitter.NewToken(ansiToString));
StoreManagedValue(codeStream);
}

protected override void EmitCleanupManaged(ILCodeStream codeStream)
{
var emitter = _ilCodeStreams.Emitter;
#if READYTORUN
MethodDesc clearNative =
Context.SystemModule.GetKnownType("System.StubHelpers", "AnsiBSTRMarshaler")
.GetKnownMethod("ClearNative", null);
LoadNativeValue(codeStream);
codeStream.Emit(ILOpcode.call, emitter.NewToken(clearNative));
#else
var lNullCheck = emitter.NewCodeLabel();

// Check for null array
LoadManagedValue(codeStream);
codeStream.Emit(ILOpcode.brfalse, lNullCheck);

LoadNativeValue(codeStream);
codeStream.Emit(ILOpcode.call, emitter.NewToken(
Context.GetHelperEntryPoint("InteropHelpers", "CoTaskMemFree")));

codeStream.EmitLabel(lNullCheck);
#endif
}
}

class UTF8StringMarshaller : Marshaller
Expand Down