Repacking Harmony in Debug mode fails

[pardeike]

Hi,

my open source project Harmony uses this task to pack its "Fat" releases. It works fine but we discovered that the "DebugFat" release does not work on .NET 5 or newer. Packing itself isn't the problem because ReleaseFat works just fine.

The problem is very easy to replicate by cloning the project (master) and running tests for DebugFat and ReleaseFat.

There is an active discussion going on on my discord server where the guys from the MonoMod.Core project (a dependency Harmony has) discuss that this is related to them using some function pointer here which matches the exception I get when running/testing DebugFat:

System.TypeLoadException : Could not load type 'CORINFO_METHOD_INFO' from assembly 'System.Runtime.Serialization.Formatters, Version=6.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a'.

which is also randomly giving other assemblies (so not related to System.Runtime.Serialization.Formatters at all).

Quote from @nike4613 in the discord:

• InvokeCompileMethod there is a property which returns a function pointer, which is immediately invoked
• this is emitted as a calli
• you'll notice, one of the parameters is a V21.CORINFO_METHOD_INFO*
• i think that the repacker is messing up the calli signature in exactly the same way that monomod's calli emitter was
• so one way or another, the sig asks for CORINFO_METHOD_INFO, but that somehow has the wrong 'context' token

If you want to discuss this issue, you are welcome to temporarily join my discord server. The channel is called harmony-contributors.

Reference to original post: https://github.com/ravibpatel/ILRepack.Lib.MSBuild.Task/issues/49#issuecomment-2019474516

[KirillOsenkov]

Hmm I just cloned and built Harmony and I get an error:

Have you seen this?

Happy to take a look at this as well.

[KirillOsenkov]

I'm guessing this is because I don't have .NET 5.0 installed so it can't resolve against .NET 5.0 (and 3.1?)

[pardeike]

Could very well be. Harmony support a wide range of .net versions so I guess you need the sdks

[KirillOsenkov]

OK here's the fix for the build to not require all the .NET Core SDKs installed: https://github.com/pardeike/Harmony/pull/604

[KirillOsenkov]

OK indeed I can confirm something is wrong.

dotnet tool update -g checkbinarycompat
cd C:\Harmony\Harmony\bin\DebugFat\net8.0
checkbinarycompat 0harmony.dll

produces BinaryCompatReport.txt:

In assembly '0Harmony, Version=2.3.3.0, PublicKeyToken=null': Failed to resolve assembly reference to 'Microsoft.Win32.Primitives, Version=8.0.0.0, PublicKeyToken=b03f5f7f11d50a3a'
In assembly '0Harmony, Version=2.3.3.0, PublicKeyToken=null': Failed to resolve type reference 'MonoMod.Core.Interop.CoreCLR' in assembly 'System.Text.Json, Version=8.0.0.0, PublicKeyToken=cc7b13ffcd2ddd51'
In assembly '0Harmony, Version=2.3.3.0, PublicKeyToken=null': Failed to resolve type reference 'MonoMod.Core.Interop.CoreCLR/V21' in assembly 'System.Text.Json, Version=8.0.0.0, PublicKeyToken=cc7b13ffcd2ddd51'
In assembly '0Harmony, Version=2.3.3.0, PublicKeyToken=null': Failed to resolve type reference 'MonoMod.Core.Interop.CoreCLR/V21/CORINFO_METHOD_INFO' in assembly 'System.Text.Json, Version=8.0.0.0, PublicKeyToken=cc7b13ffcd2ddd51'
In assembly '0Harmony, Version=2.3.3.0, PublicKeyToken=null': Failed to resolve type reference 'MonoMod.Core.Interop.CoreCLR/V70' in assembly 'System.Text.Json, Version=8.0.0.0, PublicKeyToken=cc7b13ffcd2ddd51'
In assembly '0Harmony, Version=2.3.3.0, PublicKeyToken=null': Failed to resolve type reference 'MonoMod.Core.Interop.CoreCLR/V70/AllocMemArgs' in assembly 'System.Text.Json, Version=8.0.0.0, PublicKeyToken=cc7b13ffcd2ddd51'
In assembly '0Harmony, Version=2.3.3.0, PublicKeyToken=null': reference 'System.Text.Json, Version=8.0.0.0, PublicKeyToken=cc7b13ffcd2ddd51' resolved from 'C:\Program Files\dotnet\shared\Microsoft.NETCore.App\8.0.3\System.Text.Json.dll' as 'System.Text.Json, Version=8.0.0.0, PublicKeyToken=cc7b13ffcd2ddd51'

[KirillOsenkov]

checkbinarycompat is a tool I wrote to resolve all assembly refs, type refs and member refs and ensure they are present in the referenced assembly: https://www.nuget.org/packages/checkbinarycompat#readme-body-tab

[KirillOsenkov]

Indeed, I'm seeing 10 invalid tokens in the merged assembly:

calli      valuetype MonoMod.Core.Interop.CoreCLR/CorJitResult(native int,native int,native int,valuetype  [ERROR: INVALID TOKEN 0x23000007] MonoMod.Core.Interop.CoreCLR/V21/CORINFO_METHOD_INFO*,uint32,uint8**,uint32*)

[KirillOsenkov]

Easy peasy! Apparently we forgot to rewrite types for parameters of calli instruction. Confirmed checkbinarycompat is happy now.

[KirillOsenkov]

Published https://www.nuget.org/packages/ILRepack/2.0.29 and https://www.nuget.org/packages/ILRepack.Lib/2.0.29

[pardeike]

Wow, cool, thanks for the swift response and fix. Also nice to get a PR from you so it builds regardless of sdk installs.

[pardeike]

Hmm, I still cannot use the resulting DebugFat package with the same error message as before. The change did fix something but it still fails (and ReleaseFat still works).

[KirillOsenkov]

OK I'll look again and maybe this time I'll actually try the fix :)

[KirillOsenkov]

do you have a specific test that fails in debugfat?

[KirillOsenkov]

also to be conpletely sure, can you please git clean -xdf and try again?

[pardeike]

my bad, everything works as expected