ILStrip failure for FsToolkit.ErrorHandling(Must be of type CilStrip.Mono.Cecil.TypeReference) #87867

rolfbjarne · 2023-06-21T12:19:06Z

From @NickDarvey on Wed, 21 Jun 2023 11:28:51 GMT

Steps to Reproduce

Download FsToolkitiOSApp.zip (attached)

Run

dotnet build -c Release -t:Run -f net7.0-ios -p:RuntimeIdentifier=ios-arm64 -p:_DeviceName=1234 -bl

Expected Behavior

Release build completes.

Actual Behavior

/usr/local/share/dotnet/packs/Microsoft.iOS.Sdk/16.4.7067/targets/Xamarin.Shared.Sdk.targets(765,3): ILStrip failed for obj/Release/net7.0-ios/ios-arm64/linked/FsToolkit.ErrorHandling.dll: Must be of type CilStrip.Mono.Cecil.TypeReference [/FsToolkitiOSApp.fsproj]


System.ArgumentException: Must be of type CilStrip.Mono.Cecil.TypeReference
   at CilStrip.Mono.Cecil.GenericArgumentCollection.OnValidate(Object o)
   at System.Collections.CollectionBase.System.Collections.IList.Add(Object value)
   at CilStrip.Mono.Cecil.GenericArgumentCollection.Add(TypeReference value)
   at CilStrip.Mono.Cecil.ReflectionReader.GetTypeRefFromSig(SigType t, GenericContext context)
   at CilStrip.Mono.Cecil.ReflectionReader.GetGenericArg(GenericArg arg, GenericContext context)
   at CilStrip.Mono.Cecil.ReflectionReader.GetTypeRefFromSig(SigType t, GenericContext context)
   at CilStrip.Mono.Cecil.ReflectionReader.CompleteParameter(ParameterDefinition parameter, Param signature, GenericContext context)
   at CilStrip.Mono.Cecil.ReflectionReader.BuildParameterDefinition(String name, Int32 sequence, ParameterAttributes attrs, Param psig, GenericContext context)
   at CilStrip.Mono.Cecil.ReflectionReader.CompleteMethods()
   at CilStrip.Mono.Cecil.ReflectionReader.VisitTypeDefinitionCollection(TypeDefinitionCollection types)
   at CilStrip.Mono.Cecil.AggressiveReflectionReader.VisitTypeDefinitionCollection(TypeDefinitionCollection types)
   at CilStrip.Mono.Cecil.ReflectionReader.VisitModuleDefinition(ModuleDefinition mod)
   at CilStrip.Mono.Cecil.StructureReader.TerminateAssemblyDefinition(AssemblyDefinition asm)
   at CilStrip.Mono.Cecil.AssemblyDefinition.Accept(IReflectionStructureVisitor visitor)
   at CilStrip.Mono.Cecil.AssemblyFactory.GetAssembly(ImageReader irv, Boolean manifestOnly)
   at CilStrip.Mono.Cecil.AssemblyFactory.GetAssembly(ImageReader reader)
   at CilStrip.Mono.Cecil.AssemblyFactory.GetAssembly(String file)
   at ILStrip.StripAssembly(ITaskItem assemblyItem)

Environment

Version information

dotnet  7.0.304
dotnet workload maui-ios 7.0.86/7.0.100

Build Logs and Example Project

FsToolkitiOSApp.zip

Workaround

Disabling IL stripping, as described in xamarin/xamarin-macios#14841 (comment), works.

Is there a way to only disable it for this asssembly?

Copied from original issue xamarin/xamarin-macios#18485

The text was updated successfully, but these errors were encountered:

rolfbjarne · 2023-06-21T12:19:06Z

From @rolfbjarne on Wed, 21 Jun 2023 12:18:17 GMT

Smaller repro: testproj.zip

Download & execute:

$ dotnet build /t:RunILStrip
testproj.csproj(10,5): error : ILStrip failed for FsToolkit.ErrorHandling.dll: Must be of type CilStrip.Mono.Cecil.TypeReference

rolfbjarne · 2023-06-21T12:19:07Z

From @rolfbjarne on Wed, 21 Jun 2023 12:18:34 GMT

Is there a way to only disable it for this asssembly?

It's rather ugly, but you can add something like this to your project file:

  <Target Name="_RemoveILStripTrigger" BeforeTargets="_StripAssemblyIL">
    <ItemGroup>
      <_RemovedResolvedFileToPublish Include="@(ResolvedFileToPublish)" Condition="'%(Filename)%(Extension)' == 'FsToolkit.ErrorHandling.dll'" />
      <ResolvedFileToPublish Remove="@(_RemovedResolvedFileToPublish)" />
    </ItemGroup>
  </Target>

  <Target Name="_RestoreILStripTrigger" AfterTargets="_StripAssemblyIL">
    <ItemGroup>
      <ResolvedFileToPublish Include="@(_RemovedResolvedFileToPublish)" />
    </ItemGroup>
  </Target>

rolfbjarne · 2023-06-21T12:19:08Z

From @rolfbjarne on Wed, 21 Jun 2023 12:18:58 GMT

Moving to dotnet/runtime, since the ILStrip implementation lives there.

ghost · 2023-06-22T16:12:48Z

Tagging subscribers to this area: @agocke, @sbomer, @vitek-karas
See info in area-owners.md if you want to be subscribed.

Issue Details

From @NickDarvey on Wed, 21 Jun 2023 11:28:51 GMT

Steps to Reproduce

Download FsToolkitiOSApp.zip (attached)

Run

dotnet build -c Release -t:Run -f net7.0-ios -p:RuntimeIdentifier=ios-arm64 -p:_DeviceName=1234 -bl

Expected Behavior

Release build completes.

Actual Behavior

/usr/local/share/dotnet/packs/Microsoft.iOS.Sdk/16.4.7067/targets/Xamarin.Shared.Sdk.targets(765,3): ILStrip failed for obj/Release/net7.0-ios/ios-arm64/linked/FsToolkit.ErrorHandling.dll: Must be of type CilStrip.Mono.Cecil.TypeReference [/FsToolkitiOSApp.fsproj]


System.ArgumentException: Must be of type CilStrip.Mono.Cecil.TypeReference
   at CilStrip.Mono.Cecil.GenericArgumentCollection.OnValidate(Object o)
   at System.Collections.CollectionBase.System.Collections.IList.Add(Object value)
   at CilStrip.Mono.Cecil.GenericArgumentCollection.Add(TypeReference value)
   at CilStrip.Mono.Cecil.ReflectionReader.GetTypeRefFromSig(SigType t, GenericContext context)
   at CilStrip.Mono.Cecil.ReflectionReader.GetGenericArg(GenericArg arg, GenericContext context)
   at CilStrip.Mono.Cecil.ReflectionReader.GetTypeRefFromSig(SigType t, GenericContext context)
   at CilStrip.Mono.Cecil.ReflectionReader.CompleteParameter(ParameterDefinition parameter, Param signature, GenericContext context)
   at CilStrip.Mono.Cecil.ReflectionReader.BuildParameterDefinition(String name, Int32 sequence, ParameterAttributes attrs, Param psig, GenericContext context)
   at CilStrip.Mono.Cecil.ReflectionReader.CompleteMethods()
   at CilStrip.Mono.Cecil.ReflectionReader.VisitTypeDefinitionCollection(TypeDefinitionCollection types)
   at CilStrip.Mono.Cecil.AggressiveReflectionReader.VisitTypeDefinitionCollection(TypeDefinitionCollection types)
   at CilStrip.Mono.Cecil.ReflectionReader.VisitModuleDefinition(ModuleDefinition mod)
   at CilStrip.Mono.Cecil.StructureReader.TerminateAssemblyDefinition(AssemblyDefinition asm)
   at CilStrip.Mono.Cecil.AssemblyDefinition.Accept(IReflectionStructureVisitor visitor)
   at CilStrip.Mono.Cecil.AssemblyFactory.GetAssembly(ImageReader irv, Boolean manifestOnly)
   at CilStrip.Mono.Cecil.AssemblyFactory.GetAssembly(ImageReader reader)
   at CilStrip.Mono.Cecil.AssemblyFactory.GetAssembly(String file)
   at ILStrip.StripAssembly(ITaskItem assemblyItem)

Environment

Version information

dotnet  7.0.304
dotnet workload maui-ios 7.0.86/7.0.100

Build Logs and Example Project

FsToolkitiOSApp.zip

Workaround

Disabling IL stripping, as described in xamarin/xamarin-macios#14841 (comment), works.

Is there a way to only disable it for this asssembly?

Copied from original issue xamarin/xamarin-macios#18485

Author:	rolfbjarne
Assignees:	-
Labels:	`untriaged`, `area-Tools-ILLink`, `needs-area-label`
Milestone:	-

SamMonoRT · 2023-07-25T17:58:59Z

cc @fanyang-mono

jandupej · 2023-08-14T15:26:11Z

I can replicate the issue both with the current ILStrip and one from net6.0.

jandupej · 2023-08-14T15:26:48Z

Moving to net9.0, since there is a workaround.

jandupej · 2023-08-15T13:21:11Z

When opening the assembly to be trimmed, Cecil chokes on the following method:

.method public static 
	valuetype [FSharp.Core]Microsoft.FSharp.Core.FSharpValueOption`1<!!'value'> tryParse$W<'value'> (
		class [FSharp.Core]Microsoft.FSharp.Core.FSharpFunc`2<string, class [FSharp.Core]Microsoft.FSharp.Core.FSharpFunc`2<!!'value'&, bool>> tryParse,
		string valueToParse
	) cil managed
{...}

Note the 'value'& in the inner FSharpFunc'2, this results in ReflectionReader.GetTypeRefFromSig to return null, because it has no case for ElementType.ByRef. Certain validations fail and build crashes.

xperiandri · 2024-08-28T10:17:44Z

This is our repro https://github.com/Ecierge/FsToolkit.ErrorHandling_AOT_repro on .NET 8

vitek-karas · 2024-09-05T10:44:09Z

This makes me sad...

The ILStrip task uses a private copy of Mono.Cecil because it seems to need to set metadata token values (which mainline Cecil doesn't support). This private copy is maintained in dotnet/runtime-assets and was added with dotnet/runtime-assets#160. But it's really just a copy from mono/mono which was added with mono/mono@29e9001. That is a 14 years old commit - there's no way to tell how old the source was when the copy was made, but at least 14 years.

The problem:

We've been making changes to IL since, some of which needed Mono.Cecil updates so that it can correctly parse the input and write it back out. So, there are likely cases where ILStrip corrupts the content to some degree.
Any fixes made to Cecil in the last 14 years are not there. It's very possible that the above issue doesn't exist in current Cecil.

The thing which breaks the 14 year old Cecil is a ref type in a generic parameter - not surprising as ref types didn't exist 14 years ago really - specifically this: https://github.com/demystifyfp/FsToolkit.ErrorHandling/blob/fd9460f0bfa9b670d7ef95ba48ec274a5146871c/src/FsToolkit.ErrorHandling/ValueOption.fs#L44

Quick look at the usage of Cecil says that this is not going to be easy to fix as Cecil changed a LOT since then (the public APIs used
to just load assembly doesn't exist anymore), so it's not just the ability to manipulate tokens which is different.

The "fix" for this whole situation is probably tracked by #60273.

Honestly, it's surprising this is not a more common problem.

/cc @steveisok

vitek-karas · 2024-09-05T10:45:07Z

Also cc @agocke, @sbomer as sort of owners of Cecil's usage in runtime. See the comment above for context.

xperiandri · 2025-01-02T14:43:30Z

Any updates?

dotnet-issue-labeler bot added the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label Jun 21, 2023

ghost added the untriaged New issue has not been triaged by the area owner label Jun 21, 2023

rolfbjarne mentioned this issue Jun 21, 2023

ILStrip failure for FsToolkit.ErrorHandling(Must be of type CilStrip.Mono.Cecil.TypeReference) xamarin/xamarin-macios#18485

Closed

jeffschwMSFT added the area-Tools-ILLink .NET linker development as well as trimming analyzers label Jun 22, 2023

vcsjones removed the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label Jun 23, 2023

MichalStrehovsky added area-Codegen-AOT-mono and removed area-Tools-ILLink .NET linker development as well as trimming analyzers labels Jun 23, 2023

marek-safar removed the untriaged New issue has not been triaged by the area owner label Jul 21, 2023

marek-safar added this to the 8.0.0 milestone Jul 21, 2023

SamMonoRT assigned fanyang-mono and jandupej Jul 25, 2023

jandupej modified the milestones: 8.0.0, 9.0.0 Aug 14, 2023

SamMonoRT unassigned jandupej Oct 25, 2023

steveisok unassigned fanyang-mono Aug 7, 2024

steveisok modified the milestones: 9.0.0, Future Aug 7, 2024

Juriyx mentioned this issue Aug 28, 2024

Cannot AOT on Android, iOS and MacCatalyst demystifyfp/FsToolkit.ErrorHandling#276

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ILStrip failure for FsToolkit.ErrorHandling(Must be of type CilStrip.Mono.Cecil.TypeReference) #87867

ILStrip failure for FsToolkit.ErrorHandling(Must be of type CilStrip.Mono.Cecil.TypeReference) #87867

rolfbjarne commented Jun 21, 2023

rolfbjarne commented Jun 21, 2023

rolfbjarne commented Jun 21, 2023

rolfbjarne commented Jun 21, 2023

ghost commented Jun 22, 2023

Steps to Reproduce

Expected Behavior

Actual Behavior

Environment

Build Logs and Example Project

Workaround

SamMonoRT commented Jul 25, 2023

jandupej commented Aug 14, 2023

jandupej commented Aug 14, 2023

jandupej commented Aug 15, 2023

xperiandri commented Aug 28, 2024 •

edited

Loading

vitek-karas commented Sep 5, 2024

vitek-karas commented Sep 5, 2024

xperiandri commented Jan 2, 2025

ILStrip failure for FsToolkit.ErrorHandling(Must be of type CilStrip.Mono.Cecil.TypeReference) #87867

ILStrip failure for FsToolkit.ErrorHandling(Must be of type CilStrip.Mono.Cecil.TypeReference) #87867

Comments

rolfbjarne commented Jun 21, 2023

Steps to Reproduce

Expected Behavior

Actual Behavior

Environment

Build Logs and Example Project

Workaround

rolfbjarne commented Jun 21, 2023

rolfbjarne commented Jun 21, 2023

rolfbjarne commented Jun 21, 2023

ghost commented Jun 22, 2023

Steps to Reproduce

Expected Behavior

Actual Behavior

Environment

Build Logs and Example Project

Workaround

SamMonoRT commented Jul 25, 2023

jandupej commented Aug 14, 2023

jandupej commented Aug 14, 2023

jandupej commented Aug 15, 2023

xperiandri commented Aug 28, 2024 • edited Loading

vitek-karas commented Sep 5, 2024

vitek-karas commented Sep 5, 2024

xperiandri commented Jan 2, 2025

xperiandri commented Aug 28, 2024 •

edited

Loading