ilc doesn't match expectations from SourceBuiltSdkContainsNativeDebugSymbols.

[tmds]

With dotnet/sdk#41198, we've added the ilc ILCompiler as part of the .NET installation.

ilc is .NET application that is NativeAOT compiled.

The Microsoft.DotNet.SourceBuild.SmokeTests include a test, SourceBuiltSdkContainsNativeDebugSymbols, which checks the native binaries in the .NET installation.

The test is failing for the ilc binary with:

[xUnit.net 00:00:19.93]     Microsoft.DotNet.SourceBuild.SmokeTests.DebugTests.SourceBuiltSdkContainsNativeDebugSymbols [FAIL]
[xUnit.net 00:00:19.93]       missing .debug_info section in /home/tmds/repos/dotnet/artifacts/bin/Microsoft.DotNet.SourceBuild.SmokeTests/Release/extracted-sdk/packs/runtime.fedora.39-x64.Microsoft.DotNet.ILCompiler/9.0.0-preview.6.24307.2/tools/ilc
[xUnit.net 00:00:19.93]       missing .debug_abbrev section in /home/tmds/repos/dotnet/artifacts/bin/Microsoft.DotNet.SourceBuild.SmokeTests/Release/extracted-sdk/packs/runtime.fedora.39-x64.Microsoft.DotNet.ILCompiler/9.0.0-preview.6.24307.2/tools/ilc
[xUnit.net 00:00:19.93]       missing FILE symbols in /home/tmds/repos/dotnet/artifacts/bin/Microsoft.DotNet.SourceBuild.SmokeTests/Release/extracted-sdk/packs/runtime.fedora.39-x64.Microsoft.DotNet.ILCompiler/9.0.0-preview.6.24307.2/tools/ilc
[xUnit.net 00:00:19.93]       
[xUnit.net 00:00:19.93]       Stack Trace:
[xUnit.net 00:00:19.93]         /home/tmds/repos/dotnet/test/Microsoft.DotNet.SourceBuild.SmokeTests/DebugTests.cs(64,0): at Microsoft.DotNet.SourceBuild.SmokeTests.DebugTests.SourceBuiltSdkContainsNativeDebugSymbols()
[xUnit.net 00:00:19.93]         
[xUnit.net 00:00:19.93]            at System.RuntimeMethodHandle.InvokeMethod(Object target, Void** arguments, Signature sig, Boolean isConstructor)
[xUnit.net 00:00:19.93]            at System.Reflection.MethodBaseInvoker.InvokeWithNoArgs(Object obj, BindingFlags invokeAttr)

We've updated the test to skip ilc: https://github.com/dotnet/sdk/blob/01aab3448c9185f2a5b7e66e7e327fe4b7841408/src/SourceBuild/content/test/Microsoft.DotNet.SourceBuild.SmokeTests/DebugTests.cs#L77-L78

Are there things we can/should do to make ilc pass the test?

cc @MichalStrehovsky @filipnavara @jkotas @omajid @ViktorHofer @MichaelSimons

I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label.

I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label.

[jkotas]

What is the raw output of eu-readelf that the test is trying to check?

[tmds]

Running on my system against a source-built ilc gives:

$ eu-readelf -S ilc 
There are 39 section headers, starting at offset 0xd66d00:

Section Headers:
[Nr] Name                 Type         Addr             Off      Size     ES Flags Lk Inf Al
[ 0]                      NULL         0000000000000000 00000000 00000000  0        0   0  0
[ 1] .interp              PROGBITS     0000000000000350 00000350 0000001c  0 A      0   0  1
[ 2] .note.gnu.property   NOTE         0000000000000370 00000370 00000020  0 A      0   0  8
[ 3] .note.gnu.build-id   NOTE         0000000000000390 00000390 00000024  0 A      0   0  4
[ 4] .note.ABI-tag        NOTE         00000000000003b4 000003b4 00000020  0 A      0   0  4
[ 5] .gnu.hash            GNU_HASH     00000000000003d8 000003d8 00000028  0 A      6   0  8
[ 6] .dynsym              DYNSYM       0000000000000400 00000400 00001320 24 A      7   1  8
[ 7] .dynstr              STRTAB       0000000000001720 00001720 00000915  0 A      0   0  1
[ 8] .gnu.version         GNU_versym   0000000000002036 00002036 00000198  2 A      6   0  2
[ 9] .gnu.version_d       GNU_verdef   00000000000021d0 000021d0 00000038  0 A      7   2  8
[10] .gnu.version_r       GNU_verneed  0000000000002208 00002208 00000140  0 A      7   3  8
[11] .rela.dyn            RELA         0000000000002348 00002348 00012120 24 A      6   0  8
[12] .rela.plt            RELA         0000000000014468 00014468 00001200 24 AI     6  29  8
[13] .init                PROGBITS     0000000000016000 00016000 0000001b  0 AX     0   0  4
[14] .plt                 PROGBITS     0000000000016020 00016020 00000c10 16 AX     0   0 16
[15] .text                PROGBITS     0000000000016c30 00016c30 000f3ec2  0 AX     0   0 16
[16] __managedcode        PROGBITS     000000000010ab00 0010ab00 0067ee0b  0 AX     0   0 32
[17] __unbox              PROGBITS     000000000078990c 0078990c 00004be1  0 AX     0   0  4
[18] .fini                PROGBITS     000000000078e4f0 0078e4f0 0000000d  0 AX     0   0  4
[19] .rodata              PROGBITS     000000000078f000 0078f000 0033f340  0 A      0   0 128
[20] .dotnet_eh_table     PROGBITS     0000000000ace340 00ace340 000d1ddf  0 A      0   0  8
[21] .eh_frame_hdr        PROGBITS     0000000000ba0120 00ba0120 00047ffc  0 A      0   0  4
[22] .eh_frame            PROGBITS     0000000000be8120 00be8120 00155aa8  0 A      0   0  8
[23] .tdata               PROGBITS     0000000000d3eb00 00d3eb00 00000018  0 WAT    0   0  8
[24] .tbss                NOBITS       0000000000d3eb18 00d3eb18 00000100  0 WAT    0   0  8
[25] .init_array          INIT_ARRAY   0000000000d3eb18 00d3eb18 00000050  8 WA     0   0  8
[26] .fini_array          FINI_ARRAY   0000000000d3eb68 00d3eb68 00000008  8 WA     0   0  8
[27] .data.rel.ro         PROGBITS     0000000000d3eb70 00d3eb70 00000b38  0 WA     0   0 16
[28] .dynamic             DYNAMIC      0000000000d3f6a8 00d3f6a8 00000250 16 WA     7   0  8
[29] .got                 PROGBITS     0000000000d3f8f8 00d3f8f8 00000708  8 WA     0   0  8
[30] .data                PROGBITS     0000000000d40000 00d40000 0002692c  0 WA     0   0 16
[31] __modules            PROGBITS     0000000000d66930 00d66930 00000008  0 WA     0   0  8
[32] .bss                 NOBITS       0000000000d66980 00d66938 00036890  0 WA     0   0 128
[33] .hydrated            NOBITS       0000000000d9d210 00d66938 002f9a00  0 WA     0   0 16
[34] .comment             PROGBITS     0000000000000000 00d66938 00000071  1 MS     0   0  1
[35] .annobin.notes       STRTAB       0000000000000000 00d669a9 00000001  1 MS     0   0  1
[36] .gnu.build.attributes NOTE         0000000001098c10 00d669ac 000001b0  0        0   0  4
[37] .shstrtab            STRTAB       0000000000000000 00d66b5c 00000195  0        0   0  1
[38] .gnu_debuglink       PROGBITS     0000000000000000 00d66cf4 0000000c  0        0   0  4

[jkotas]

Naot publish strip symbols by default. Can you try to set <StripSymbols>false</StripSymbols> for source build to see whether it will make this test pass?

[tmds]

I'll give that a try.

[tmds]

Can you try to set <StripSymbols>false</StripSymbols> for source build to see whether it will make this test pass?

This makes things better, and I'll open up a PR for it.

The test is still failing for ilc not meeting this expectation:

https://github.com/dotnet/sdk/blob/01aab3448c9185f2a5b7e66e7e327fe4b7841408/src/SourceBuild/content/test/Microsoft.DotNet.SourceBuild.SmokeTests/DebugTests.cs#L99C1-L102

[MichalStrehovsky]

The test is still failing for ilc not meeting this expectation:

What is the output of readelf on the unstripped ilc? The line is looking for c|cc|cpp|cxx file extension, but despite of that I would expect we have at least some of those since we link with some unmanaged code.

[tmds]

What is the output of readelf on the unstripped ilc?

readelf.zip

[MichalStrehovsky]

Is that readelf -S? I don't see the other strings the test is looking for either.

[MichalStrehovsky]

Oh, never mind, the test runs both -s and -S. I'm surprised FILE is part of -s output.

[MichaelSimons]

cc @NikolaMilosavljevic who is familiar with these tests.