Reorganize CoreCLR native build to reduce CMake reconfigures when the build system is untouched #49906

jkoritzinsky · 2021-03-19T21:06:39Z

Part of April's batched infrastructure rollout: #49889

Move the CoreCLR native subsets support to use custom CMake targets instead of additional subset properties. Now, cmake will always configure the whole CoreCLR native project, but will only build the required subsets. This enables the generated CMake build system to be reused between build invocations even if for example the developer first builds the clr.runtime subset and then builds the clr.alljits subset.

Since CMake already supports rerunning itself during the build when it detects changes in CMake files, this PR also adds caching of the CMake command line options that can change between build invocations for a given arch/config so that we don't do a CMake reconfigure if the results will be the same as the last invocation or if CMake can regenerate the build system itself with its up-to-date check. This is only done on builds that are not "configure only" and do not use the VS generator (CMake-generated VS projects lack the auto-regeneration feature that makes this work).

This PR also adds a clr.native subset that builds all of the CoreCLR native code since apparently we didn't have a subset that did that after clr.runtime and clr.alljits was introduced.

Changes to the build-runtime.cmd/sh arguments

The -skipruntime, -skipjit, -skipalljits, -paltests, and -skipiltools arguments have been removed. Instead of using an opt-out system, the command line uses an opt-in system with a new -component <componentName> argument which can be specified multiple times. The following components are supported:

-component runtime
-component jit
-component alljits
-component paltests
-component iltools

If no -component argument is provided, then all native components are built.

ghost · 2021-03-19T21:06:44Z

Tagging subscribers to this area: @hoyosjs
See info in area-owners.md if you want to be subscribed.

Issue Details

Move the CoreCLR native subsets support to use custom CMake targets instead of additional subset properties. Now, cmake will always configure the whole CoreCLR native project, but will only build the required subsets. This enables the generated CMake build system to be reused between build invocations even if for example the developer first builds the clr.runtime subset and then builds the clr.alljits subset.

Since CMake already supports rerunning itself during the build when it detects changes in CMake files, this PR also adds caching of the CMake command line options that can change between build invocations for a given arch/config so that we don't do a CMake reconfigure if the results will be the same as the last invocation or if CMake can regenerate the build system itself with its up-to-date check. This is only done on builds that are not "configure only" and do not use the VS generator (CMake-generated VS projects lack the auto-regeneration feature that makes this work).

This PR also adds a clr.native subset that builds all of the CoreCLR native code since apparently we didn't have a subset that did that after clr.runtime and clr.alljits was introduced.

Author:	jkoritzinsky
Assignees:	-
Labels:	`area-Infrastructure-coreclr`
Milestone:	-

Add a -component flag to the native build scripts to control which components are built. Remove the old -skipX flags and use the component flags instead. Move symbol stripping for CoreCLR out of the install step and into the add_library/executable step to ensure we only strip once when a file can be installed for multiple components. Fix specifying all subsets. mark corerun and coreshim as runtime components. Move cross-component build targets onto the componentized plan. Remove _install function since the check it does is no longer needed. Implicitly add dependencies for runtime/all_jits metatargets. Move paltests to the component plan. Fixes for unix platform builds Add clr.native subset to build the full clr project. Don't build pal tests as part of the default build. Make targets without a specific component automatically be built by any non-crosscomponent subcomponent. Move libraries CMake build to stop using environment variables. Don't rerun Cmake configure if the command line hasn't changed since the last run. Saves about 15 seconds on a no-op incremental build. Non-Windows impl still tbd Add iltools subset. Since we're at a point where combinatorial explosion makes it untenable to support combinatorial targets, use the multiple-targets feature of CMake when available (thankfully Windows is included in this set) and otherwise use the underlying build tool. Disable command line up-to-date check for VS. Implement command-line check for cmake reconfigure for Unix platforms as well.

…ince they don't need to be installed in the coreclr build.

…e components are hooked up. Update mono build to set up enough of the infra to be able to build the pal.

…e-coreclr-cmake

… feedback.

jkoritzinsky · 2021-03-23T23:44:21Z

Test failure is rare intermittent failure. Tracked by #50139

janvorli · 2021-03-24T19:11:53Z

src/coreclr/CMakeLists.txt

  add_subdirectory(${CLR_SRC_NATIVE_DIR}/corehost/apphost/static Corehost.Static)
+  add_dependencies(runtime singlefilehost)


This dependency seems reverse.

We want to build the "singlefilehost" as part of the "runtime" component. Otherwise we'd build it either as its own component (which no one will remember to specify) or as part of the fallback component (which would make all components build it, which is undesirable).

This seems fine for now. Eventually I'd prefer we specify dependencies on the top level projects and people use subsets less. That's something we can address when we're ready.

src/coreclr/CMakeLists.txt

janvorli · 2021-03-25T14:04:51Z

src/coreclr/ToolBox/superpmi/superpmi-shim-collector/CMakeLists.txt

 endif(CLR_CMAKE_HOST_UNIX)

-_install (PROGRAMS $<TARGET_FILE:superpmi-shim-collector> DESTINATION .)
+install_clr(TARGETS superpmi-shim-collector DESTINATIONS .)


These changes from PROGRAMS to TARGETS are a problem. I've recently needed to switch from TARGETS to PROGRAMS to fix macOS arm64 signature corruption issues. Please see #46452 description for the reasons.

install_clr uses PROGRAMS internally, so we should be good.

agocke

LGTM, a few minor comments, mostly around the build-runtime scripts

agocke · 2021-03-26T19:35:02Z

eng/native/functions.cmake

@@ -206,6 +206,27 @@ function(compile_asm)
  set(${COMPILE_ASM_OUTPUT_OBJECTS} ${ASSEMBLED_OBJECTS} PARENT_SCOPE)
 endfunction()

+# add_component(componentName [targetName] [EXCLUDE_FROM_ALL])
+function(add_component componentName)
+  if (${ARGC} GREATER 2 OR ${ARGC} EQUAL 2)


lol there's no >= operator?

Not in CMake 3.6, which we still need to support for Linux source build.

agocke · 2021-03-26T19:37:57Z

src/coreclr/CMakeLists.txt

  add_subdirectory(${CLR_SRC_NATIVE_DIR}/corehost/apphost/static Corehost.Static)
+  add_dependencies(runtime singlefilehost)


This seems fine for now. Eventually I'd prefer we specify dependencies on the top level projects and people use subsets less. That's something we can address when we're ready.

src/coreclr/build-runtime.sh

agocke · 2021-03-26T19:44:39Z

src/coreclr/build-runtime.sh

-usage_list+=("-skipiltools: skip building IL tools.")
-usage_list+=("-paltests: build the pal tests.")
+usage_list+=("-staticanalyzer: use scan_build static analyzer.")
+usage_list+=("-component: Build individual components instead of the full project. Available options are 'jit', 'runtime', 'paltests', 'alljits', and 'iltools'. Can be specified multiple times.")


Do we still consider the build scripts as dev entry points?

I know the JIT team still uses these scripts directly sometimes, so I wanted to keep them up to date.

hoyosjs · 2021-03-26T22:45:11Z

src/coreclr/inc/CMakeLists.txt

 add_library(corguids INTERFACE)
 target_sources(corguids INTERFACE $<TARGET_OBJECTS:corguids_obj>)

 # Binplace the inc files for packaging later.

-_install (FILES cfi.h


Do file installs not need a component? Is this under unknown?

They'll fall under the coreclr_misc subset and be installed when any component (other that iltools or jit) is built.

…know how to get the substitutions right.

ghost · 2021-04-05T16:38:07Z

Hello @jkoritzinsky!

Because this pull request has the auto-merge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.

jkoritzinsky · 2021-04-05T22:05:27Z

Mono CrossAOT build failure tracked by #50753

…shim_mono # By Aaron Robinson (10) and others # Via GitHub * upstream/main: (108 commits) [mbr] Add Apple sample (dotnet#50740) make EstablishProxyTunnelAsync throw on failure status code from proxy (dotnet#50763) Improve RGB Min Max evaluation performance by using 2 or 3 comparison… (dotnet#50622) [mono] More domain cleanups (dotnet#50479) Fix Crossgen2 of PlatformDefaultMemberFunction methods and calls. (dotnet#50754) Disable EventSource generator in design-time builds (dotnet#50741) Fix X509 test failures on Android (dotnet#50301) Do not confuse fgDispBasicBlocks in fgMorphBlocks (dotnet#50703) Enforce 64KB event payload size limit on EventPipe (dotnet#50600) Reorganize CoreCLR native build to reduce CMake reconfigures when the build system is untouched (dotnet#49906) [mbr] Turn on hot reload for iOS, tvOS and MacCatalyst (dotnet#50458) improve connection scavenge logic by doing zero-byte read (dotnet#50545) Resolve call mdtokens when making tier 1 inline observations (dotnet#50675) Annotate APIs in System.Private.Xml (dotnet#49682) Support compiling against OpenSSL 3 headers Change Configuration.Json to use a regular Dictionary. (dotnet#50611) Remove unused BigNumFromBinary P/Invoke (dotnet#50670) Make Ninja the default CMake generator on Windows for the repo (dotnet#49715) [AppleAppBuilder] Entitlements to run tests on catalyst using the JIT (dotnet#50637) [mono] Fix delegate invokes to dynamic methods in mixed mode. (dotnet#50547) ... # Conflicts: # src/mono/dlls/mscordbi/CMakeLists.txt

Adjust for dotnet#49906

Adjust for #49906

src/coreclr/build-runtime.cmd

jkoritzinsky added the area-Infrastructure-coreclr label Mar 19, 2021

jkoritzinsky requested a review from a team March 19, 2021 21:06

ghost added this to In Progress in Infrastructure Backlog Mar 19, 2021

jkoritzinsky mentioned this pull request Mar 19, 2021

Infrastructure - Rollout (April 2021) #49889

Closed

jkoritzinsky added 4 commits March 19, 2021 14:11

Merge commit '4197e651c8a' into HEAD

21bdc25

Fixups after merging with upstream clr.iltools work.

1d4dfe1

Make iltools a minimal subset that doesn't build all dependencies.

35d617f

jkoritzinsky force-pushed the single-configure-coreclr-cmake branch from f41baf5 to 35d617f Compare March 19, 2021 21:15

Add missing target to mono build expected in coreclr build.

a6ebd8c

jkoritzinsky requested a review from marek-safar as a code owner March 19, 2021 21:47

jkoritzinsky added 9 commits March 19, 2021 15:33

Fix paltests arg in CI.

e42ed30

Fix DacTableGen missing in linker tests.

6f4166c

Fix typo

ecfa8c5

Explicitly pass config down to install command line. Fixes VS build.

8d6e369

Specify a component for the static lib installations from libraries s…

8d198d1

…ince they don't need to be installed in the coreclr build.

Move over the test of the CoreCLR targets to use install_clr to ensur…

4b86b76

…e components are hooked up. Update mono build to set up enough of the infra to be able to build the pal.

Fix destinations.

7acef32

Merge branch 'main' of github.com:dotnet/runtime into single-configur…

b470eb7

…e-coreclr-cmake

Bump minimum CMake version to the recommended version as per @jkotas'…

f4a66a6

… feedback.

runfoapp bot mentioned this pull request Mar 23, 2021

Intermittent Test Failure GC\\Features\\HeapExpansion\\plug\\plug.cmd #50139

Closed

jkoritzinsky requested review from agocke and janvorli March 24, 2021 17:58

janvorli reviewed Mar 25, 2021

View reviewed changes

agocke approved these changes Mar 26, 2021

View reviewed changes

jkoritzinsky added 2 commits March 26, 2021 14:46

Create the target names from the component names and reduce duplication.

002dd85

Fix add_subdirectory ordering to match ordering in main.

d092098

hoyosjs reviewed Mar 26, 2021

View reviewed changes

jkoritzinsky added 5 commits March 26, 2021 17:26

Bring back previous processing because batch is annoying and I don't …

cb629ec

…know how to get the substitutions right.

Fix bash script issue.

3cfb2a7

Rename all_jits target to alljits

81a1f4f

Merge branch 'main' into single-configure-coreclr-cmake

18bc65f

Remove duplicate function definitions from bad merge.

bc9c13f

jkoritzinsky added the auto-merge label Apr 5, 2021

runfoapp bot mentioned this pull request Apr 5, 2021

Builds legs getting abandoned due to agent notification issues #35223

Closed

jkoritzinsky merged commit 8d6cd81 into dotnet:main Apr 5, 2021

Infrastructure Backlog automation moved this from In Progress to Done Apr 5, 2021

jkoritzinsky deleted the single-configure-coreclr-cmake branch April 5, 2021 22:05

BruceForstall added a commit to BruceForstall/runtime that referenced this pull request Apr 7, 2021

Fix JIT rolling build for new build-runtime script arguments

ca053f8

Adjust for dotnet#49906

BruceForstall mentioned this pull request Apr 7, 2021

Fix JIT rolling build for new build-runtime script arguments #50876

Merged

BruceForstall added a commit that referenced this pull request Apr 7, 2021

Fix JIT rolling build for new build-runtime script arguments (#50876)

12f4b02

Adjust for #49906

AntonLapounov mentioned this pull request Apr 8, 2021

x64-hosted crossgen.exe missing in Microsoft.NETCore.App.Runtime.win-arm64 package #50979

Closed

AntonLapounov reviewed Apr 9, 2021

View reviewed changes

src/coreclr/build-runtime.cmd Show resolved Hide resolved

This was referenced Apr 21, 2021

Improve arguments handling in build-runtime.cmd #51639

Merged

Add components to the coreclr native build #38571

Closed

ghost locked as resolved and limited conversation to collaborators May 9, 2021

karelz added this to the 6.0.0 milestone May 20, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reorganize CoreCLR native build to reduce CMake reconfigures when the build system is untouched #49906

Reorganize CoreCLR native build to reduce CMake reconfigures when the build system is untouched #49906

jkoritzinsky commented Mar 19, 2021 •

edited

ghost commented Mar 19, 2021

jkoritzinsky commented Mar 23, 2021

janvorli Mar 24, 2021

jkoritzinsky Mar 25, 2021

agocke Mar 26, 2021

janvorli Mar 25, 2021

jkoritzinsky Mar 25, 2021

agocke left a comment

agocke Mar 26, 2021

jkoritzinsky Mar 26, 2021

agocke Mar 26, 2021

agocke Mar 26, 2021

jkoritzinsky Mar 26, 2021

hoyosjs Mar 26, 2021

jkoritzinsky Mar 27, 2021

ghost commented Apr 5, 2021

jkoritzinsky commented Apr 5, 2021

		add_subdirectory(${CLR_SRC_NATIVE_DIR}/corehost/apphost/static Corehost.Static)
		add_dependencies(runtime singlefilehost)

Reorganize CoreCLR native build to reduce CMake reconfigures when the build system is untouched #49906

Reorganize CoreCLR native build to reduce CMake reconfigures when the build system is untouched #49906

Conversation

jkoritzinsky commented Mar 19, 2021 • edited

Changes to the build-runtime.cmd/sh arguments

ghost commented Mar 19, 2021

jkoritzinsky commented Mar 23, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agocke left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost commented Apr 5, 2021

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

jkoritzinsky commented Apr 5, 2021

jkoritzinsky commented Mar 19, 2021 •

edited

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.