[runtime] Infrastructure to build runtime components using NativeAOT

src/coreclr/runtime-prereqs.proj

@@ -13,6 +13,10 @@
   <Import Project="$(RepositoryEngineeringDir)versioning.targets" />
   <Import Project="$(RepositoryEngineeringDir)nativepgo.targets" />
 
+  <ItemGroup>
+    <ProjectReference Include="$(RepoRoot)\src\native\managed\compile-native.proj" ReferenceOutputAssembly="false"/>
+  </ItemGroup>
+
   <Target Name="BuildPrereqs" BeforeTargets="Build" DependsOnTargets="GenerateRuntimeVersionFile;GenerateNativeSourcelinkFile;OutputPgoPathForCI" />
   <Import Project="Sdk.targets" Sdk="Microsoft.Build.NoTargets" />
   <!--

src/native/managed/Directory.Build.props

@@ -0,0 +1,3 @@
+<Project>
+    <Import Project="..\..\..\Directory.Build.props" />
+</Project>

src/native/managed/README.md

@@ -0,0 +1,35 @@
+# Native runtime component libraries using NativeAOT
+
+This directory contains managed libraries that will be compiled using NativeAOT and can be used in runtime components.
+
+## Adding a new managed library
+
+Add a new subdirectory to `src/native/managed` for your library with a `src` and `inc` subdirectories:
+
+``` console
+$ mkdir -p libMyNewLibrary/src libMyNewLibrary/inc
+$ dotnet new classlib -n libMyNewLibrary -o libMyNewLibrary/src
+```
+
+In `src/native/managed/compile-native.proj`, add
+`src/native/managed/libMyNewLibrary/src/libMyNewLibrary.csproj` to the `NativeLibsProjectsToBuild`
+item group.
+
+In `src/native/managed/libMyNewLibrary/src/libMyNewLibrary.csproj`:
+1. Near the top,  add `<Import Project="..\..\native-library.props" />`
+2. Near the bottom, add `<Import Project="..\..\native-library.targets" />`
+3. Define an item `@(InstallRuntimeComponentDest)` that has directory names relative to `artifacts/bin/<runtimeFlavor>/<os.arch.config>/` where the shared library should be installed.  It's a good idea to have at least `.`:
+    ```xml
+      <ItemGroup>
+          <InstallRuntimeComponentDest Include="." />
+          <InstallRuntimeComponentDest Include="sharedFramework" Condition="'$(RuntimeFlavor)' == 'coreclr'"/>
+      </ItemGroup>
+    ```
+
+Limitations:
+
+* The project should be called `libXXXX` - currently the infrastructure expects a `lib` prefix on all platforms.
+
+* Currently only shared library output is supported.  In principle static linking is possible, but the
+infrastructure is not finished yet.  Additionally, mixing Debug/Release configurations with static
+linking will not be supported on Windows.

src/native/managed/compile-native.proj

@@ -0,0 +1,67 @@
+<Project Sdk="Microsoft.Build.NoTargets">
+    <PropertyGroup>
+        <!-- We always want to use release for publishing using NativeAOT -->
+        <NativeLibsPublishConfiguration>Release</NativeLibsPublishConfiguration>
+	<!-- we always want to make shared libs -->
+        <NativeLibKind Condition="'$(NativeLibKind)' == ''">shared</NativeLibKind>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <!-- add new projects here -->
+        <!-- NativeLibsProjectsToBuild Include="$(MSBuildThisFileDirectory)libhellomanaged/src/libhellomanaged.csproj" -->
+    </ItemGroup>
+
+    <!-- Decide if we're going to do the NativeAOT builds -->
+    <PropertyGroup>
+        <!-- disable on Mono, for now -->
+        <SupportsNativeAotComponents Condition="'$(SupportsNativeAotComponents)' == '' and '$(RuntimeFlavor)' == 'Mono'">false</SupportsNativeAotComponents>
+        <!-- NativeAOT doesn't support cross-OS compilation. disable for crossdac-->
+        <SupportsNativeAotComponents Condition="'$(SupportsNativeAotComponents)' == '' and '$(HostOS)' != '$(TargetOS)'">false</SupportsNativeAotComponents>
+        <!-- unsupported targets -->
+        <SupportsNativeAotComponents Condition="'$(SupportsNativeAotComponents)' == '' and ('$(TargetArchitecture)' == 'arm' or '$(TargetArchitecture)' == 'armel' or '$(TargetArchitecture)' == 'x86' or '$(TargetArchitecture)' == 'riscv64')">false</SupportsNativeAotComponents>
+        <SupportsNativeAotComponents Condition="'$(SupportsNativeAotComponents)' == '' and ('$(TargetsWindows)' == 'true' or '$(TargetsOSX)' == 'true' or ('$(TargetsLinux)' == 'true' and '$(TargetsAndroid)' != 'true' and '$(TargetsLinuxMusl)' != 'true'))">true</SupportsNativeAotComponents>
+        <SupportsNativeAotComponents Condition="'$(SupportsNativeAotComponents)' == ''">false</SupportsNativeAotComponents>
+    </PropertyGroup>
+
+    <!-- some special kinds of runtime builds need extra NativeAOT flags -->
+    <PropertyGroup>
+        <SysRoot Condition="'$(CrossBuild)' == 'true' and '$(HostOS)' != 'windows'">$(ROOTFS_DIR)</SysRoot>
+        <LinkerFlavor Condition="'$(CrossBuild)' == 'true' and '$(TargetsLinux)' == 'true'">lld</LinkerFlavor>
+        <CustomLinkerArgToolchainArg Condition="'$(CrossBuild)' == 'true' and '$(_hostArchitecture)' == '$(_targetArchitecture)' and '$(_hostOS)' != 'windows'">--gcc-toolchain=$(ROOTFS_DIR)/usr</CustomLinkerArgToolchainArg>
+    </PropertyGroup>
+
+    <!-- properties to pass down to the subproject builds -->
+    <ItemGroup>
+        <SubprojectProps Include="Configuration" Value="$(NativeLibsPublishConfiguration)" />
+        <SubprojectProps Include="RuntimeConfiguration" Value="$(RuntimeConfiguration)" />
+        <SubprojectProps Include="LibrariesConfiguration" Value="$(LibrariesConfiguration)" />
+        <SubprojectProps Include="RuntimeIdentifier" Value="$(OutputRID)" />
+
+        <SubprojectProps Include="NativeLib" Value="$(NativeLibKind)" />
+
+        <SubprojectProps Condition="'$(SysRoot)' != ''" Include="SysRoot" Value="$(SysRoot)" />
+        <SubprojectProps Condition="'$(LinkerFlavor)' != ''" Include="LinkerFlavor" Value="$(LinkerFlavor)" />
+        <SubprojectProps Condition="'$(CustomLinkerArgToolchainArg)' != ''" Include="CustomLinkerArgToolchainArg" Value="$(CustomLinkerArgToolchainArg)" />
+    </ItemGroup>
+
+    <ItemGroup Condition="$(SupportsNativeAotComponents)">
+        <ProjectReference Include="@(NativeLibsProjectsToBuild)"
+                          ReferenceOutputAssembly="false"
+                          AdditionalProperties="%(AdditionalProperties);@(SubprojectProps->'%(Identity)=%(Value)', ';')"/>
+    </ItemGroup>
+
+    <Target Name="BuildNativeLibs" BeforeTargets="Build" Condition="$(SupportsNativeAotComponents)">
+        <PropertyGroup>
+            <SplitSubprojectProps>@(SubprojectProps->'%(Identity)=%(Value)', ';')</SplitSubprojectProps>
+        </PropertyGroup>
+
+        <!-- workaround https://github.com/dotnet/msbuild/issues/2811 - Restore has to be a separate exectution with a different evaluation -->
+        <MSBuild Projects="@(NativeLibsProjectsToBuild)"
+                 Properties="MSBuildRestoreSessionId=$([System.Guid]::NewGuid());$(SplitSubprojectProps)"
+                 Targets="Restore" />
+
+        <MSBuild Projects="@(NativeLibsProjectsToBuild)"
+                 Properties="_IsPublishing=true;$(SplitSubprojectProps)"
+                 Targets="Build;Publish" />
+    </Target>
+</Project>

src/native/managed/native-library.props

@@ -0,0 +1,35 @@
+<Project>
+  <PropertyGroup>
+    <PublishAot>true</PublishAot>
+    <SelfContained>true</SelfContained>
+    <!-- Don't strip symbols NativeAOT's default way. We will strip and save the symbols ourselves,
+         the same way as eng/native/functions.cmake strip_symbols
+    -->
+    <StripSymbols>false</StripSymbols>
+  </PropertyGroup>
+
+  <!-- set the shared library name.  this helps the native linker correctly reference this shared
+       library in dependents -->
+  <PropertyGroup>
+    <!-- in net9.0 we can do this, but only on mobile apple platforms, not OSX -->
+    <SharedLibraryInstallName>@rpath/$(MSBuildProjectName).dylib</SharedLibraryInstallName>
+  </PropertyGroup>
+  <ItemGroup Condition="'$(TargetsOSX)' == 'true'">
+      <LinkerArg Include="-Wl,-install_name,@rpath/$(MSBuildProjectName).dylib" />
+  </ItemGroup>
+  <ItemGroup Condition="'$(TargetsUnix)' == 'true' and ! ('$(TargetsAppleMobile)' == 'true' or '$(TargetsOSX)' == 'true')">
+      <!-- If there is no soname, ld on Linux and some other Unixes will embed the full (build-time!)
+           path to this shared library into any binary that links against it. We don't want that. -->
+      <LinkerArg Include="-Wl,-soname=$(MSBuildProjectName).so" />
+  </ItemGroup>
+
+  <PropertyGroup>
+      <!-- if IsRuntimeComponent is true, we will put the native library into the specified locations under `artifacts/bin/$(RuntimeFlavor)/os.arch.config/` -->
+      <IsRuntimeComponent Condition="'$(IsRuntimeComponent)' == ''">true</IsRuntimeComponent>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <!-- passed by compile-native.proj to set - -gcc-toolchain=$(ROOTFS_DIR)/usr -->
+    <CustomLinkerArg Condition="'$(CustomLinkerArgToolchainArg)' != ''" Include="$(CustomLinkerArgToolchainArg)" />
+  </ItemGroup>
+</Project>

src/native/managed/native-library.targets

@@ -0,0 +1,107 @@
+<Project>
+
+    <!-- strip the library the same way as the cmake build for coreclr does it:
+         - on mac, leave a .dylib.dwarf file next to the library.
+         - on linux leave a .so.dbg file next to to the library
+    -->
+    <Target Name="StripLibraryLikeCoreCLRSetupPaths"
+            DependsOnTargets="CopyNativeBinary"
+            Condition="'$(IsRuntimeComponent)' == 'true' and '$(TargetsWindows)' != 'true'">
+        <PropertyGroup>
+            <StrippedOutputPath>$(OutputPath)stripped\</StrippedOutputPath>
+            <StripSourceFile>$(StrippedOutputPath)$(TargetName)$(NativeBinaryExt)</StripSourceFile>
+            <StrippedExt Condition="'$(StrippedExt)' == '' and ('$(TargetsOSX)' == 'true' or '$(TargetsAppleMobile)' == 'true')">.dylib.dwarf</StrippedExt>
+            <StrippedExt Condition="'$(TargetsUnix)' == 'true' and '$(StrippedExt)' == ''">.so.dbg</StrippedExt>
+            <StripDestinationFile>$(StrippedOutputPath)$(TargetName)$(StrippedExt)</StripDestinationFile>
+        </PropertyGroup>
+    </Target>
+
+    <!--
+	Hack: temporarily turn on StripSymbols whlie SetupOSSpecificProps runs, then turn it off
+	again before LinkNative runs.  The problem is that SetupOSSpecificProps only probes for
+	$(ObjCopyName) and $(ObjCopyNameAlternative) if symbol stripping is turned on.  But we don't
+	want LinkNative to actually do any stripping since we have our own way that we'd like it to
+	work.
+    -->
+    <Target Name="TempStripSymbolsOn"
+	    BeforeTargets="SetupOSSpecificProps">
+	<PropertyGroup>
+	    <StripSymbols>true</StripSymbols>
+	</PropertyGroup>
+    </Target>
+
+    <Target Name="TempStripSymbolsOff"
+	    AfterTargets="SetupOSSpecificProps"
+	    BeforeTargets="LinkNative">
+	<PropertyGroup>
+	    <StripSymbols>false</StripSymbols>
+	</PropertyGroup>
+    </Target>
+
+    <Target Name="StripLibraryLikeCoreCLRBuild"
+            DependsOnTargets="SetupOSSpecificProps;CopyNativeBinary;StripLibraryLikeCoreCLRSetupPaths"
+            Condition="'$(IsRuntimeComponent)' == 'true' and '$(TargetsWindows)' != 'true'"
+            Inputs="$(PublishDir)$(TargetName)$(NativeBinaryExt)"
+            Outputs="$(StripSourceFile);$(StripDestinationFile)">
+        <Error Text="Do not set StripSymbols to true - runtime components stripping is controlled by native-library.targets" Condition="'$(StripSymbols)' == 'true'" />
+
+        <Message Importance="Normal" Text="Stripping $(PublishDir)$(TargetName)$(NativeBinaryExt) into $(StripSourceFile) and $(StripDestinationFile)" />
+
+        <!-- copy from the published/ subfolder to the stripped/ subfolder -->
+        <Copy SourceFiles="$(PublishDir)$(TargetName)$(NativeBinaryExt)"
+              DestinationFolder="$(StrippedOutputPath)"
+              SkipUnchangedFiles="true" />
+
+        <PropertyGroup>
+            <_StripLike Condition="'$(TargetsOSX)' == 'true' or '$(TargetsAppleMobile)' == 'true'">apple</_StripLike>
+            <_StripLike Condition="'$(_StripLike)' == ''">gnu</_StripLike>
+        </PropertyGroup>
+
+        <Exec Command="dsymutil --flat $(LikeCoreCLRDSymUtilMinimizeOpt) $(StripSourceFile)" Condition="'$(_StripLike)' == 'apple'"/> <!-- produces the .dylib.dwarf file -->
+        <Exec Command="strip -no_code_signature_warning -S $(StripSourceFile)" Condition="'$(_StripLike)' == 'apple'"/>
+        <!-- runtime build runs "codesign -f -s - libWhatever.dylib" in release configurations -->
+        <Exec Command="codesign -f -s - $(StripSourceFile)" Condition="'$(RuntimeConfiguration)' == 'Release' and '$(_StripLike)' == 'apple'" />
+
+        <Exec Command="$(ObjCopyName) --only-keep-debug $(StripSourceFile) $(StripDestinationFile)" Condition="'$(_StripLike)' == 'gnu'"/>
+        <Exec Command="$(ObjCopyName) --strip-debug --strip-unneeded $(StripSourceFile)" Condition="'$(_StripLike)' == 'gnu'"/>
+        <Exec Command="$(ObjCopyName) --add-gnu-debuglink=$(StripDestinationFile) $(StripSourceFile)" Condition="'$(_StripLike)' == 'gnu'"/>
+    </Target>
+
+    <Target Name="InstallRuntimeComponentToFinalDest"
+            AfterTargets="CopyNativeBinary"
+            DependsOnTargets="CopyNativeBinary;StripLibraryLikeCoreCLRBuild" Condition="'$(IsRuntimeComponent)' == 'true'">
+        <Error Text="Set at least one @InstallRuntimeComponentDest item" Condition="@(InstallRuntimeComponentDest->Count()) == 0" />
+
+        <PropertyGroup>
+            <!-- FIXME: this is the same as CoreCLRToolPath - but that doesn't seem like a good name -->
+            <FinalRuntimeComponentDestinationBase>$([MSBuild]::NormalizeDirectory('$(ArtifactsBinDir)', '$(RuntimeFlavor.ToLower())', '$(TargetOS).$(TargetArchitecture).$(RuntimeConfiguration)'))</FinalRuntimeComponentDestinationBase>
+        </PropertyGroup>
+
+        <ItemGroup>
+            <_NormalizedInstallRuntimeComponentDest Include="$([MSBuild]::NormalizeDirectory('$(FinalRuntimeComponentDestinationBase)', '%(InstallRuntimeComponentDest.Identity)'))" />
+        </ItemGroup>
+
+        <ItemGroup Condition="'$(TargetsWindows)' != 'true'">
+            <CopyFinalFiles Include="$(StripSourceFile)" />
+            <CopyFinalFiles Include="$(StripDestinationFile)" />
+        </ItemGroup>
+
+        <ItemGroup Condition="'$(TargetsWindows)' == 'true'">
+            <CopyFinalFiles Include="$(PublishDir)$(TargetName)$(NativeBinaryExt)" />
+            <CopyFinalFilesPDB Include="$(PublishDir)$(TargetName).pdb" />
+        </ItemGroup>
+
+        <Message Importance="Normal" Text="Installing @(CopyFinalFiles) into %(_NormalizedInstallRuntimeComponentDest.Identity)"/>
+        <Message Importance="Normal" Text="Installing @(CopyFinalFilesPDB) into %(_NormalizedInstallRuntimeComponentDest.Identity)PDB\" Condition="'$(TargetsWindows)' == 'true'"/>
+
+        <Copy SourceFiles="@(CopyFinalFiles)"
+              DestinationFolder="%(_NormalizedInstallRuntimeComponentDest.Identity)"
+              SkipUnchangedFiles="true"/>
+        <Copy SourceFiles="@(CopyFinalFilesPDB)"
+              DestinationFolder="%(_NormalizedInstallRuntimeComponentDest.Identity)PDB\"
+              SkipUnchangedFiles="true"
+              Condition="'$(TargetsWindows)' == 'true'"/>
+    </Target>
+
+
+</Project>