Try to untangle the rid calculation. #82832

tmds · 2023-03-01T13:47:02Z

This is an attempt at simplifying how the rids get calculated.

Instead of providing a single rid, init-distro-rid.sh also provides a __PortableOS value which is the portable os that matches the target platform. It gets initialized also for non-portable builds, which enables detecting musl in the native script and passing that information along. The existing __DistroRid is used solely for naming the non-portable build output.

Instead of calculating the _portableOS of the old __DistroRid, Directory.Build.props can now directly use __PortableOS (and fall back to using TargetOS).

_runtimeOS is merged into _packageOS.

Let's see how well this works against the CI configurations. 🤞

cc @ViktorHofer @am11 @jkotas

dotnet-issue-labeler · 2023-03-01T13:47:11Z

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

tmds · 2023-03-02T17:11:28Z

CI is looking good for these changes, with the exception of the coreclr linux_musl_arm64 job.

This is a cross build job, and not I'm familiar with those.

From the error message, I assume the wrong linker gets used for the crossgen2 project?
Or maybe, the build is supposed to use the crossgen2_crossarch project instead of the crossgen2 project?

@wfurt @am11 any thoughts on what changes in this PR are causing this failure?

  Generating native code
  /usr/bin/ld: unrecognised emulation mode: aarch64linux
  Supported emulations: elf_x86_64 elf32_x86_64 elf_i386 elf_iamcu elf_l1om elf_k1om i386pep i386pe
clang : error : linker command failed with exit code 1 (use -v to see invocation) [/__w/1/s/src/coreclr/tools/aot/crossgen2/crossgen2.csproj]
##[error]clang(0,0): error : (NETCORE_ENGINEERING_TELEMETRY=Build) linker command failed with exit code 1 (use -v to see invocation)
/__w/1/s/artifacts/transport/coreclr/build/Microsoft.NETCore.Native.targets(334,5): error MSB3073: The command ""/usr/bin/clang-15" "/__w/1/s/artifacts/obj/coreclr/crossgen2/arm64/Debug/native/crossgen2.o" -o "/__w/1/s/artifacts/bin/coreclr/linux.arm64.Debug/crossgen2/native/crossgen2" /__w/1/s/artifacts/transport/coreclr/aotsdk/libbootstrapper.a /__w/1/s/artifacts/transport/coreclr/aotsdk/libRuntime.ServerGC.a /__w/1/s/artifacts/transport/coreclr/aotsdk/libeventpipe-disabled.a /__w/1/s/artifacts/transport/coreclr/aotsdk/libstdc++compat.a /__w/1/s/artifacts/transport/coreclr/aotsdk/libnumasupportdynamic.a /__w/1/s/artifacts/bin/microsoft.netcore.app.runtime.linux-musl-arm64/Release/runtimes/linux-musl-arm64/native/libSystem.Native.a /__w/1/s/artifacts/bin/microsoft.netcore.app.runtime.linux-musl-arm64/Release/runtimes/linux-musl-arm64/native/libSystem.Globalization.Native.a /__w/1/s/artifacts/bin/microsoft.netcore.app.runtime.linux-musl-arm64/Release/runtimes/linux-musl-arm64/native/libSystem.IO.Compression.Native.a /__w/1/s/artifacts/bin/microsoft.netcore.app.runtime.linux-musl-arm64/Release/runtimes/linux-musl-arm64/native/libSystem.Net.Security.Native.a /__w/1/s/artifacts/bin/microsoft.netcore.app.runtime.linux-musl-arm64/Release/runtimes/linux-musl-arm64/native/libSystem.Security.Cryptography.Native.OpenSsl.a --sysroot=/crossrootfs/arm64 --target=aarch64-linux-gnu -g -Wl,-rpath,'$ORIGIN' -Wl,--build-id=sha1 -Wl,--as-needed -pthread -ldl -lz -lrt -lm -pie -Wl,-pie -Wl,-z,relro -Wl,-z,now -Wl,--discard-all -Wl,--gc-sections" exited with code 1. [/__w/1/s/src/coreclr/tools/aot/crossgen2/crossgen2.csproj]
##[error]artifacts/transport/coreclr/build/Microsoft.NETCore.Native.targets(334,5): error MSB3073: (NETCORE_ENGINEERING_TELEMETRY=Build) The command ""/usr/bin/clang-15" "/__w/1/s/artifacts/obj/coreclr/crossgen2/arm64/Debug/native/crossgen2.o" -o "/__w/1/s/artifacts/bin/coreclr/linux.arm64.Debug/crossgen2/native/crossgen2" /__w/1/s/artifacts/transport/coreclr/aotsdk/libbootstrapper.a /__w/1/s/artifacts/transport/coreclr/aotsdk/libRuntime.ServerGC.a /__w/1/s/artifacts/transport/coreclr/aotsdk/libeventpipe-disabled.a /__w/1/s/artifacts/transport/coreclr/aotsdk/libstdc++compat.a /__w/1/s/artifacts/transport/coreclr/aotsdk/libnumasupportdynamic.a /__w/1/s/artifacts/bin/microsoft.netcore.app.runtime.linux-musl-arm64/Release/runtimes/linux-musl-arm64/native/libSystem.Native.a /__w/1/s/artifacts/bin/microsoft.netcore.app.runtime.linux-musl-arm64/Release/runtimes/linux-musl-arm64/native/libSystem.Globalization.Native.a /__w/1/s/artifacts/bin/microsoft.netcore.app.runtime.linux-musl-arm64/Release/runtimes/linux-musl-arm64/native/libSystem.IO.Compression.Native.a /__w/1/s/artifacts/bin/microsoft.netcore.app.runtime.linux-musl-arm64/Release/runtimes/linux-musl-arm64/native/libSystem.Net.Security.Native.a /__w/1/s/artifacts/bin/microsoft.netcore.app.runtime.linux-musl-arm64/Release/runtimes/linux-musl-arm64/native/libSystem.Security.Cryptography.Native.OpenSsl.a --sysroot=/crossrootfs/arm64 --target=aarch64-linux-gnu -g -Wl,-rpath,'$ORIGIN' -Wl,--build-id=sha1 -Wl,--as-needed -pthread -ldl -lz -lrt -lm -pie -Wl,-pie -Wl,-z,relro -Wl,-z,now -Wl,--discard-all -Wl,--gc-sections" exited with code 1.

Build FAILED.

src/tests/build.proj

am11 · 2023-03-02T18:43:16Z

Just a heads up: we spent days of testing in previous consolidation of RID calculation from various places in the repo. There are many scenarios not obvious and not covered by the CI. Then some folks only run their build flavors near the releases. Some edge-cases from memory:

Visual Studio build failures (managed libraries development heavily rely on it)
Official packages (that shows up when package validation runs / not accessible via public CI)
Tizen; uses hybrid approach: portable build for coreclr and non-portable for libs (no source-build infra involved)
FreeBSD / illumos: $other Unices when cross-built from linux && when built on the actual VM. Now we have good CI coverage for FreeBSD cross-built (which also implies illumos cross-build is happy). I will try to run build on their host too (once this gets closer to completion).
Alpine Linux: cross and native build. There are old and new CI legs some of which only run during the official build.

Then we had issue with what goes into the official nuget packages and we went back and forth on fixing those.

tmds · 2023-04-21T06:52:14Z

CI is looking good.

ViktorHofer · 2023-04-21T07:51:13Z

Directory.Build.props

@@ -253,11 +250,13 @@
    <OutputRID Condition="'$(OutputRID)' == ''">$(_outputOS)-$(TargetArchitecture)</OutputRID>
  </PropertyGroup>

-  <PropertyGroup Label="CalculateTargetOSName" Condition="'$(SkipInferTargetOSName)' != 'true'">
+  <PropertyGroup Label="CalculateTargetOSName">


Nit: Would be good to move this up in a follow-up and add TargetsMobile into the group as well.

ViktorHofer · 2023-04-21T07:54:43Z

src/installer/tests/Directory.Build.targets

@@ -73,7 +73,7 @@
      <TestContextVariable Include="NUGET_PACKAGES=$(TestRestorePackagesPath)" />
      <TestContextVariable Include="TEST_ARTIFACTS=$(SystemPathTestsOutputDir)" />
      <TestContextVariable Include="TEST_TARGETRID=$(TestTargetRid)" />
-      <TestContextVariable Include="BUILDRID=$(OutputRid)" />
+      <TestContextVariable Include="BUILDRID=$(OutputRID)" />


Nit: Should the test context variable be changed in the future to OutputRID?

ViktorHofer · 2023-04-21T07:57:55Z

eng/SourceBuild.props

-      <InnerBuildArgs>$(InnerBuildArgs) /p:RuntimeOS=$(RuntimeOS)</InnerBuildArgs>
+      <!-- PackageOS and ToolsOS control the rids of prebuilts consumed by the build.
+           They are set to RuntimeOS so they match with the build SDK rid. -->
+      <InnerBuildArgs Condition="'$(RuntimeOS)' != ''">$(InnerBuildArgs) /p:PackageOS=$(RuntimeOS) /p:ToolsOS=$(RuntimeOS)</InnerBuildArgs>


Who provides RuntimeOS in source build?

It gets set here: https://github.com/dotnet/dotnet/blob/3b38fd69120ec5cac0433923225a8d6f1d40c0bf/repo-projects/runtime.proj#L16.

Is that still the right property to set or do we want to change that?

ViktorHofer

Approving with the caveat that I didn't understand all the changes in init-distro-rid.sh but if our builds are happy with the changes then so am I. Great work. Thanks a lot 💯

ViktorHofer · 2023-04-21T08:01:59Z

Test failures are unrelated. I will merge and if something starts to fail, we can revert the change anytime.

tmds · 2023-04-21T08:26:21Z

@ViktorHofer and @akoeplinger thanks for your support!

ViktorHofer · 2023-04-23T06:09:38Z

@tmat the SourceIndexStage leg in dotnet/runtime official builds are currently broken with the following error:

build.cmd -subset libs.sfx+libs.oob -binarylog -os linux -ci

D:\a_work\1\s.dotnet\sdk\8.0.100-preview.3.23178.7\Sdks\NuGet.Build.Tasks.Pack\build\NuGet.Build.Tasks.Pack.targets(221,5): error NU5026: The file 'D:\a_work\1\s\artifacts\bin\native\net8.0-linux-Debug-x64\libSystem.IO.Ports.Native.so.dbg' to be packed was not found on disk. [D:\a_work\1\s\src\libraries\System.IO.Ports\pkg\runtime.linux-x64.runtime.native.System.IO.Ports.proj]
##[error].dotnet\sdk\8.0.100-preview.3.23178.7\Sdks\NuGet.Build.Tasks.Pack\build\NuGet.Build.Tasks.Pack.targets(221,5): error NU5026: (NETCORE_ENGINEERING_TELEMETRY=Build) The file 'D:\a_work\1\s\artifacts\bin\native\net8.0-linux-Debug-x64\libSystem.IO.Ports.Native.so.dbg' to be packed was not found on disk.

I will allow us 24 hours to investigate the issue, otherwise we will need to revert the change, unfortunately.

ViktorHofer · 2023-04-23T06:41:22Z

I submitted a fix for it to unblock official builds: #85215

The behavior change was unexpected. Previously, we didn't build the runtime.$(OutputRID).*.proj projects (only System.IO.Ports) in that leg as the glob pattern didn't match anything as OutputRID was set to something different:

runtime/src/libraries/oob-src.proj

Lines 18 to 21 in 46101c4

    
               <!-- During an official Build, build the rid specific package matching the OutputRID only outside of an allconfigurations build and only when targeting the CoreCLR runtime. 
        
                    The limitation on the CoreCLR runtime is entirely artificial but avoids duplicate assets being publish. --> 
        
               <ProjectReference Include="$(MSBuildThisFileDirectory)*\pkg\runtime.$(OutputRID).*.proj" Condition="'$(BuildingAnOfficialBuildLeg)' != 'true' or 
        
                                                                                                                   ('$(BuildAllConfigurations)' != 'true' and '$(RuntimeFlavor)' == '$(PrimaryRuntimeFlavor)')" />

Now that OutputRID points to the TargetOS, the glob matches and requires the libs.native subset to be built first. Do we want to change anything is or is that the expected new behavior?

tmds · 2023-04-23T17:04:12Z

build.cmd -subset libs.sfx+libs.oob -binarylog -os linux -ci

I assume this issue is specific to this type of 'cross-build': on Windows we build for Linux.

Once we figure out what the rids were, we should be able to match the previous behavior.

"$(MSBuildThisFileDirectory)\pkg\runtime.$(OutputRID)..proj"

What are these projects?

I submitted a fix for it to unblock official builds: #85215

If you can unblock the official builds, we can fix this in the coming days.

tmds · 2023-04-24T07:30:17Z

Previously, when we were building on Windows and set TargetOS to Linux, it would use a _packageOS of win for anything that is not TargetsMobile.

<_runtimeOS Condition="'$(_runtimeOS)' == ''">$(_parseDistroRid.SubString(0, $(_distroRidIndex)))</_runtimeOS>
...
<_runtimeOS Condition="'$(TargetsMobile)' == 'true'">$(TargetOS.ToLowerInvariant())</_runtimeOS>
...
<_portableOS Condition="'$(_runtimeOS)' == 'win' or '$(TargetOS)' == 'windows'">win</_portableOS>

To go back to the previous behavior, we can set /p:PackageOS=win in the job, or add something like:

<_packageOS Condition="'$(_hostOS)' == 'windows' and '$(TargetsMobile)' != 'true'">win</_packageOS>

I assume the goal of this configuration is being able to build managed sources on Windows for non-Windows targets.

@ViktorHofer can you verify on Windows if the build works as before by adding /p:PackageOS=win? Should I make a PR for the _packageOS assignment?

ViktorHofer · 2023-04-24T07:42:33Z

I assume the goal of this configuration is being able to build managed sources on Windows for non-Windows targets.

Correct. The "source-index-stage" job which runs in our official builds is what powers https://source.dot.net. It just needs to build the managed libraries under src/libraries. We need to skip the native packages under https://github.com/dotnet/runtime/tree/main/src/libraries/System.IO.Ports/pkg as they currently require the native assets of the TargetOS to be built. Cross-building linux assets on a Windows OS isn't a supported scenario today AFAIK.

I submitted a workaround to fix the failing official builds via #85239. My previous attempt was flawed as I missed that we can't build the libs.native subset targeting Linux, on Windows.

@ViktorHofer can you verify on Windows if the build works as before by adding /p:PackageOS=win? Should I make a PR for the _packageOS assignment?

let me check. FWIW here's the build command:

runtime/eng/pipelines/runtime-official.yml

Line 54 in 0219a1b

    
           sourceIndexBuildCommand: build.cmd -subset libs.native+libs.sfx+libs.oob -binarylog -os linux -ci

tmds · 2023-04-24T08:11:49Z

Correct. The "source-index-stage" job which runs in our official builds is what powers https://source.dot.net/.

Interesting to know, I was wondering why the job was building sources like that.

I submitted a workaround to fix the failing official builds via #85239.

Thanks for looking into the fix.

ViktorHofer · 2023-04-24T08:57:25Z

Thanks for looking into the fix.

Unfortunately, appending /p:PackageOS=win didn't help:

C:\Program Files\dotnet\sdk\8.0.100-preview.3.23178.7\Sdks\NuGet.Build.Tasks.Pack\build\NuGet.Build.Tasks.Pack.targets(
221,5): error NU5026: The file 'C:\git\runtime2\artifacts\bin\native\net8.0-linux-Debug-x64\libSystem.IO.Ports.Native.s
o.dbg' to be packed was not found on disk. [C:\git\runtime2\src\libraries\System.IO.Ports\pkg\runtime.linux-x64.runtime
.native.System.IO.Ports.proj]

tmds · 2023-04-24T09:40:53Z

Unfortunately, appending /p:PackageOS=win didn't help:

Yes. I didn't understand well enough what these projects were and should have taken a closer look. Somehow I had assumed they'd be generated using PackageRID in their name and changing it would cause it to no longer match with OutputRID. But they are real projects with those literal rids in their name, and to avoid the match, we should have set OutputRID instead.

Thanks for getting the issue fixed.

ViktorHofer · 2023-04-24T10:31:09Z

Thanks for getting the issue fixed.

Sure, but my fix was just meant as a workaround. Would it make sense to additionally add the following back?

<_portableOS Condition="'$(HostOS)' == 'win'">win</_portableOS>

MichaelSimons · 2023-04-25T19:18:34Z

@tmds - This change broke the stage2 build of source-build. The PackageRID is set to portable e.g. linux-x64 whereas previously it was non-portable. Looking at the changes, this looks suspect - https://github.com/dotnet/runtime/pull/82832/files#diff-9da24614831c308827a1ae533ffea392c97638c261dd42bd0f5226baa136d16eR210


    <!-- source-build sets PackageOS to build with non-portable rid packages that were source-built previously. -->
    <PackageRID Condition="'$(PackageOS)' != ''">$(PackageOS)-$(TargetArchitecture)</PackageRID>
    <PackageRID>$(_packageOS)-$(TargetArchitecture)</PackageRID>

The first PackageRID assignment will always be overridden by the second.

tmds · 2023-04-25T19:32:12Z

The first PackageRID assignment will always be overridden by the second.

Yes, this is an error. This should have been similar to:

runtime/Directory.Build.props

Lines 226 to 228 in 0fc8978

    
           <!-- source-build sets ToolsOS to build with non-portable rid packages that were source-built previously. --> 
        
           <ToolsRID Condition="'$(ToolsOS)' != ''">$(ToolsOS)-$(_hostArch)</ToolsRID> 
        
           <ToolsRID Condition="'$(ToolsRID)' == ''">$(_portableHostOS)-$(_hostArch)</ToolsRID>

tmds · 2023-04-25T19:36:08Z

@MichaelSimons #85350 adds the missing Condition.

ghost added the community-contribution Indicates that the PR has been added by a community member label Mar 1, 2023

tmds force-pushed the rid_cleanup branch 2 times, most recently from 796337e to ebf8d01 Compare March 1, 2023 16:38

runfoapp bot mentioned this pull request Mar 1, 2023

Test failure: System.Security.Cryptography.X509Certificates.Tests.CertificateCreation.CertificateRequestChainTests/CreateChain_Hybrid #25979

Closed

This was referenced Mar 1, 2023

Tracking issue for CI build timeouts #76454

Closed

System.Security.Cryptography.X509Certificates.Tests.ChainTests.BuildInvalidSignatureTwice failure #82837

Open

Some System.Buffers.Binary.Tests.ReverseEndiannessUnitTests tests broken on main #82868

Closed

tmds force-pushed the rid_cleanup branch 4 times, most recently from 02c0f79 to e420bf5 Compare March 2, 2023 14:22

am11 reviewed Mar 2, 2023

View reviewed changes

src/tests/build.proj Outdated Show resolved Hide resolved

tmds added 6 commits March 2, 2023 19:37

Try to untangle the rid calculation.

9d890f4

Ignore __portableOS.

c320ff9

Add back musl detection.

494afb7

Try fix AnyOS tests.

034d1d5

Try fix coreclr linux_musl_arm64 job.

92ffb2f

src/tests/build.proj: use PackageRID for restore.

ae67592

tmds force-pushed the rid_cleanup branch from cbf0c46 to ae67592 Compare March 2, 2023 18:39

tmds added 4 commits March 2, 2023 19:45

Use RuntimeOS as an override for _packageOS.

8c91698

Remove (probably) out-dated override for non-portable ToolsRID.

4ce7c57

CI cross-builds for linux-musl use linux.

e5ec2a5

Add missing arch to rid.

6d84cb4

tmds force-pushed the rid_cleanup branch from 609cb93 to 0745d58 Compare March 3, 2023 01:20

build-analysis bot mentioned this pull request Mar 3, 2023

Roslyn source generator crash on mono/linux/arm64 #81123

Closed

tmds force-pushed the rid_cleanup branch 2 times, most recently from bf9c686 to ed9c6b4 Compare March 3, 2023 08:28

Remove SkipInferTargetOSName.

8219051

ViktorHofer reviewed Apr 21, 2023

View reviewed changes

ViktorHofer approved these changes Apr 21, 2023

View reviewed changes

ViktorHofer merged commit 21fb96b into dotnet:main Apr 21, 2023

tmds mentioned this pull request Apr 24, 2023

Directory.Build.props: restore previous behavior when targetting 'other' TargetOSes from Windows. #85246

Merged

ManickaP mentioned this pull request Apr 25, 2023

Broken build on Arch Linux #85315

Closed

tmds mentioned this pull request Apr 25, 2023

init-distro-rid.sh: fix unbound error when VERSION_ID is not defined. #85319

Merged

MichaelSimons mentioned this pull request Apr 25, 2023

Stage 2 runtime failure looking for portable packages instead of RID specific packages dotnet/source-build#3420

Closed

tmds mentioned this pull request Apr 25, 2023

Directory.Build.props: don't overwrite PackageOS from source-build. #85350

Merged

LoopedBard3 mentioned this pull request May 4, 2023

Linux_musl runs are failing with libs not found due to mismatched RID expectations dotnet/performance#3008

Closed

ghost locked as resolved and limited conversation to collaborators May 26, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Try to untangle the rid calculation. #82832

Try to untangle the rid calculation. #82832

tmds commented Mar 1, 2023

dotnet-issue-labeler bot commented Mar 1, 2023

tmds commented Mar 2, 2023

am11 commented Mar 2, 2023

tmds commented Apr 21, 2023

ViktorHofer Apr 21, 2023

ViktorHofer Apr 21, 2023

ViktorHofer Apr 21, 2023

tmds Apr 21, 2023

ViktorHofer Apr 21, 2023

ViktorHofer left a comment

ViktorHofer commented Apr 21, 2023

tmds commented Apr 21, 2023

ViktorHofer commented Apr 23, 2023

ViktorHofer commented Apr 23, 2023

tmds commented Apr 23, 2023 •

edited

Loading

tmds commented Apr 24, 2023 •

edited

Loading

ViktorHofer commented Apr 24, 2023

tmds commented Apr 24, 2023

ViktorHofer commented Apr 24, 2023 •

edited

Loading

tmds commented Apr 24, 2023

ViktorHofer commented Apr 24, 2023

MichaelSimons commented Apr 25, 2023

tmds commented Apr 25, 2023

tmds commented Apr 25, 2023

Try to untangle the rid calculation. #82832

Try to untangle the rid calculation. #82832

Conversation

tmds commented Mar 1, 2023

dotnet-issue-labeler bot commented Mar 1, 2023

tmds commented Mar 2, 2023

am11 commented Mar 2, 2023

tmds commented Apr 21, 2023

ViktorHofer Apr 21, 2023

Choose a reason for hiding this comment

ViktorHofer Apr 21, 2023

Choose a reason for hiding this comment

ViktorHofer Apr 21, 2023

Choose a reason for hiding this comment

tmds Apr 21, 2023

Choose a reason for hiding this comment

ViktorHofer Apr 21, 2023

Choose a reason for hiding this comment

ViktorHofer left a comment

Choose a reason for hiding this comment

ViktorHofer commented Apr 21, 2023

tmds commented Apr 21, 2023

ViktorHofer commented Apr 23, 2023

ViktorHofer commented Apr 23, 2023

tmds commented Apr 23, 2023 • edited Loading

tmds commented Apr 24, 2023 • edited Loading

ViktorHofer commented Apr 24, 2023

tmds commented Apr 24, 2023

ViktorHofer commented Apr 24, 2023 • edited Loading

tmds commented Apr 24, 2023

ViktorHofer commented Apr 24, 2023

MichaelSimons commented Apr 25, 2023

tmds commented Apr 25, 2023

tmds commented Apr 25, 2023

tmds commented Apr 23, 2023 •

edited

Loading

tmds commented Apr 24, 2023 •

edited

Loading

ViktorHofer commented Apr 24, 2023 •

edited

Loading