Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JIT: Avoid removing multi-use boxes #72842

Merged
merged 3 commits into from
Jul 27, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions src/coreclr/jit/compiler.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -9539,6 +9539,11 @@ void cTreeFlags(Compiler* comp, GenTree* tree)
{
chars += printf("[BOX_VALUE]");
}

if (tree->gtFlags & GTF_BOX_CLONED)
{
chars += printf("[BOX_CLONED]");
}
break;

case GT_ARR_ADDR:
Expand Down
9 changes: 9 additions & 0 deletions src/coreclr/jit/gentree.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -8508,6 +8508,8 @@ GenTree* Compiler::gtCloneExpr(
copy = new (this, GT_BOX)
GenTreeBox(tree->TypeGet(), tree->AsOp()->gtOp1, tree->AsBox()->gtAsgStmtWhenInlinedBoxValue,
tree->AsBox()->gtCopyStmtWhenInlinedBoxValue);
tree->AsBox()->SetCloned();
copy->AsBox()->SetCloned();
break;

case GT_INTRINSIC:
Expand Down Expand Up @@ -13612,6 +13614,13 @@ GenTree* Compiler::gtTryRemoveBoxUpstreamEffects(GenTree* op, BoxRemovalOptions
return nullptr;
}

// If this box is no longer single-use, bail.
if (box->WasCloned())
{
JITDUMP(" bailing; unsafe to remove box that has been cloned\n");
return nullptr;
}

// If we're eventually going to return the type handle, remember it now.
GenTree* boxTypeHandle = nullptr;
if ((options == BR_REMOVE_AND_NARROW_WANT_TYPE_HANDLE) || (options == BR_DONT_REMOVE_WANT_TYPE_HANDLE))
Expand Down
11 changes: 11 additions & 0 deletions src/coreclr/jit/gentree.h
Original file line number Diff line number Diff line change
Expand Up @@ -543,6 +543,7 @@ enum GenTreeFlags : unsigned int
GTF_QMARK_CAST_INSTOF = 0x80000000, // GT_QMARK -- Is this a top (not nested) level qmark created for
// castclass or instanceof?

GTF_BOX_CLONED = 0x40000000, // GT_BOX -- this box and its operand has been cloned, cannot assume it to be single-use anymore
Copy link
Contributor

Choose a reason for hiding this comment

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

The local under the box is also marked as "cloned" -- is a new flag truly needed?

Copy link
Member Author

Choose a reason for hiding this comment

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

Transformations can affect that local in arbitrary ways (I mentioned it above).

Copy link
Contributor

@SingleAccretion SingleAccretion Jul 26, 2022

Choose a reason for hiding this comment

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

Hmm, yes, sorry I missed the description somehow.

I suppose this is more robust in the face of something like:

var sdsuTmp = boxTmp; // Cloned.
Use(BOX(sdsuTmp));

So it is needed.

Copy link
Member Author

Choose a reason for hiding this comment

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

Right, something like that. It would probably be ok in practice, especially since gtTryRemoveBoxUpstreamEffects is only called very early, but given the function name it seems best to make it more robust.

GTF_BOX_VALUE = 0x80000000, // GT_BOX -- "box" is on a value type

GTF_ARR_ADDR_NONNULL = 0x80000000, // GT_ARR_ADDR -- this array's address is not null
Expand Down Expand Up @@ -3874,6 +3875,16 @@ struct GenTreeBox : public GenTreeUnOp
{
}
#endif

bool WasCloned()
{
return (gtFlags & GTF_BOX_CLONED) != 0;
}

void SetCloned()
{
gtFlags |= GTF_BOX_CLONED;
}
};

// GenTreeField -- data member ref (GT_FIELD)
Expand Down
53 changes: 53 additions & 0 deletions src/tests/JIT/Regression/JitBlue/Runtime_72775/Runtime_72775.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System;
using System.Runtime.CompilerServices;
using System.Threading;

public class Runtime_72775
{
public static int Main()
{
for (int i = 0; i < 100; i++)
{
Call(new Impl1());
if (i > 30 && i < 40)
Thread.Sleep(10);
}

// With GDV, JIT would optimize Call by fully removing the box since Impl1.Foo does not use it.
// This would cause null to be passed to Impl2.Foo.
return Call(new Impl2());
}

[MethodImpl(MethodImplOptions.NoInlining)]
private static int Call(I i) => i.Foo(5);
}

public interface I
{
int Foo(object o);
}

class Impl1 : I
{
public int Foo(object o) => 0;
}

class Impl2 : I
{
public int Foo(object o)
{
if (o is not int i || i != 5)
{
Console.WriteLine("FAIL: Got {0}", o?.ToString() ?? "(null)");
return -1;
}
else
{
Console.WriteLine("PASS: Got 5");
return 100;
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<Optimize>True</Optimize>
</PropertyGroup>
<ItemGroup>
<Compile Include="$(MSBuildProjectName).cs" />
</ItemGroup>
<PropertyGroup>
<CLRTestBatchPreCommands><![CDATA[
$(CLRTestBatchPreCommands)
set COMPlus_TieredCompilation=1
set COMPlus_TieredPGO=1
]]></CLRTestBatchPreCommands>
<BashCLRTestPreCommands><![CDATA[
$(BashCLRTestPreCommands)
export COMPlus_TieredCompilation=1
export COMPlus_TieredPGO=1
]]></BashCLRTestPreCommands>
</PropertyGroup>
</Project>