build-script: Permit to build compiler-rt with `LLVM_ENABLE_RUNTIMES` #80174

edymtt · 2025-03-20T19:52:50Z

LLVM-21 plans to remove the legacy method for building compiler-rt in the same invocation as LLVM using LLVM_ENABLED_PROJECTS and LLVM_BUILD_EXTERNAL_COMPILER_RT.

Support the new way of building compiler-rt with a new build-script opt-in flag --llvm-build-compiler-rt-with-use-runtimes -- this will allow a staged introduction, and will ensure we can revert back to the old behaviour temporarily in case of unforeseen regression.

Since this flag is meant to be short lived, in an attempt to keep the logic simple we are gating on it only the
CMake cache entries that strictly control the compilation mode, all the other entries used for configuring are added in both modes.

Take this chance to remove some stale code from build-script-impl, and move some code in the generic CMake product to the LLVM one.

Addresses rdar://147505298

edymtt · 2025-03-20T19:53:02Z

@swift-ci please python lint

compnerd · 2025-03-20T20:01:49Z

utils/swift_build_support/swift_build_support/products/llvm.py

+    @classmethod
+    def compute_cmake_args_for_runtimes(cls, host_target):
+        # Swift expects the old layout for the runtime directory
+        args_for_runtime = '-DLLVM_ENABLE_PER_TARGET_RUNTIME_DIR:BOOL=OFF'


Note that Windows has started migrating to the new layout. clang already prefers the new layout. We should file an issue to bring the other hosts in line.

Created #80180

compnerd · 2025-03-20T20:02:43Z

utils/swift_build_support/swift_build_support/products/llvm.py

+        if self.args.test:
+            # LLVMTestingSupport is not built at part of `all`
+            # and is required by some Swift tests
+            build_targets.append('LLVMTestingSupport')


This seems unrelated to this change?

This is needed because with LLVM_ENABLE_RUNTIMES the new runtimes target does not have any dependencies to LLVMTestingSupport -- currently that is scheduled as a result of the compiler-rt configuration

I preferred to apply it to the old way of building compiler-rt as well to limit the number of places where I check for the flags -- it should not cause any additional rebuilds there.

However, if it is required for tests, I think that the tests should add that dependency, not compiler-rt.

I would like to do that, but build-script does not schedule Swift as an external project of LLVM (like build.ps1 does) -- so I cannot put LLVMTestingSupport as a dependency of the test targets that need that.

edymtt · 2025-03-20T21:44:26Z

@swift-ci please test

edymtt · 2025-03-24T21:07:10Z

@swift-ci please python lint

edymtt · 2025-03-24T21:11:56Z

@swift-ci please test

edymtt · 2025-03-25T15:02:17Z

@swift-ci please test Apple Silicon

edymtt · 2025-03-25T15:03:00Z

@swift-ci please build toolchain

edymtt · 2025-03-25T15:03:19Z

@swift-ci Please Test Source Compatibility

edymtt · 2025-03-25T15:03:32Z

preset=stdlib_S_standalone_minimal_macho_x86_64,build,test
@swift-ci please test with toolchain and preset

utils/swift_build_support/swift_build_support/products/llvm.py

edymtt · 2025-03-31T16:36:53Z

@swift-ci please python lint

edymtt · 2025-03-31T16:47:59Z

@swift-ci please python lint

etcwilde · 2025-03-20T20:04:09Z

utils/build_swift/build_swift/driver_arguments.py

@@ -1398,6 +1398,11 @@ def create_argument_parser():
                'separated options "-DCMAKE_VAR1=YES,-DCMAKE_VAR2=/tmp". Can '
                'be called multiple times to add multiple such options.')

+    option('--llvm-build-compiler-rt-with-use-runtimes', toggle_true,
+           help='Switch to LLVM_USE_RUNTIMES as the mechanism to build compiler-rt'


s/LLVM_USE_RUNTIMES/LLVM_ENABLE_RUNTIMES.

etcwilde · 2025-03-31T16:52:33Z

utils/swift_build_support/swift_build_support/products/cmake_product.py

@@ -23,6 +23,10 @@ class CMakeProduct(product.Product):
    def is_verbose(self):
        return self.args.verbose_build

+    @property
+    def cmake_os_sysroot(self):


Why the property function instead of setting self.cmake_os_sysroot? If we get an error for trying to use cmake_os_sysroot before calling host_cmake_options, this will still result in a failure because self._cmake_os_sysroot is still undefined so it isn't protecting us from anything.

I wanted to make it discoverable that this value can now be accessed outside of this class, and I thought that adding a read only property would help convey this (instead of trawling through the code of ~~build_with_cmake~~ host_cmake_options)

I reworked my approach to avoid the use of the property, and instead return the value I am interested in as an outcome from host_cmake_options

edymtt · 2025-03-31T16:53:16Z

@swift-ci please test

edymtt · 2025-03-31T17:54:03Z

@swift-ci please python lint

edymtt · 2025-03-31T17:58:55Z

@swift-ci please test

edymtt · 2025-03-31T17:59:12Z

@swift-ci please build toolchain

edymtt · 2025-03-31T17:59:21Z

@swift-ci Please Test Source Compatibility

utils/swift_build_support/swift_build_support/products/cmake_product.py

LLVM-21 plans to remove the legacy method for building compiler-rt in the same invocation as LLVM using `LLVM_ENABLED_PROJECTS` and `LLVM_BUILD_EXTERNAL_COMPILER_RT`. Support the new way of building compiler-rt with a new build-script opt-in flag `--llvm-build-compiler-rt-with-use-runtimes` -- this will allow a staged introduction, and will ensure we can revert back to the old behaviour temporarily in case of unforeseen regression. Since this flag is meant to be short lived, in an attempt to keep the logic simple we are gating on it only the CMake cache entries that strictly control the compilation mode, all the other entries used for configuring are added in both modes. Take this chance to remove some stale code from `build-script-impl`, and move some code in the generic CMake product to the LLVM one. Addresses rdar://147505298

edymtt · 2025-03-31T20:56:14Z

@swift-ci please python lint

edymtt · 2025-03-31T21:02:51Z

@swift-ci please python lint

edymtt · 2025-03-31T21:03:01Z

@swift-ci please test

edymtt · 2025-03-31T21:03:08Z

@swift-ci please build toolchain

edymtt · 2025-03-31T21:03:14Z

@swift-ci Please Test Source Compatibility

edymtt · 2025-04-01T19:57:58Z

@swift-ci please test macOS

edymtt · 2025-04-01T19:58:04Z

@swift-ci please test Windows

edymtt · 2025-04-01T19:58:14Z

@swift-ci please build toolchain Windows

edymtt · 2025-04-02T17:06:23Z

@swift-ci please test macOS

edymtt · 2025-04-03T22:49:40Z

@swift-ci please test macOS

edymtt requested review from compnerd, etcwilde and justice-adams-apple March 20, 2025 19:52

compnerd reviewed Mar 20, 2025

View reviewed changes

edymtt mentioned this pull request Mar 20, 2025

Adopt the new runtime layout in the Swift compiler for Linux (and possibly *BSD) #80180

Open

edymtt force-pushed the edymtt/use-runtimes-build-quater branch from 3a7a408 to 442edf4 Compare March 24, 2025 21:06

edymtt mentioned this pull request Mar 24, 2025

Use LLVM_USE_RUNTIMES to build compiler-rt by default #80253

Merged

edymtt commented Mar 25, 2025

View reviewed changes

utils/swift_build_support/swift_build_support/products/llvm.py Outdated Show resolved Hide resolved

edymtt commented Mar 28, 2025

View reviewed changes

utils/swift_build_support/swift_build_support/products/llvm.py Show resolved Hide resolved

edymtt mentioned this pull request Mar 31, 2025

Use LLVM runtimes build #67986

Closed

etcwilde reviewed Mar 31, 2025

View reviewed changes

edymtt force-pushed the edymtt/use-runtimes-build-quater branch from bd12562 to 824fb12 Compare March 31, 2025 17:52

edymtt commented Mar 31, 2025

View reviewed changes

utils/swift_build_support/swift_build_support/products/cmake_product.py Show resolved Hide resolved

edymtt force-pushed the edymtt/use-runtimes-build-quater branch from 824fb12 to 0c8171f Compare March 31, 2025 20:55

edymtt merged commit 7b00176 into swiftlang:main Apr 22, 2025
11 checks passed

build-script: Permit to build compiler-rt with LLVM_ENABLE_RUNTIMES #80174

build-script: Permit to build compiler-rt with LLVM_ENABLE_RUNTIMES #80174

Uh oh!

Conversation

edymtt commented Mar 20, 2025

Uh oh!

edymtt commented Mar 20, 2025

Uh oh!

compnerd Mar 20, 2025

Choose a reason for hiding this comment

Uh oh!

edymtt Mar 20, 2025

Choose a reason for hiding this comment

Uh oh!

compnerd Mar 20, 2025

Choose a reason for hiding this comment

Uh oh!

edymtt Mar 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

compnerd Mar 20, 2025

Choose a reason for hiding this comment

Uh oh!

edymtt Mar 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

edymtt commented Mar 20, 2025

Uh oh!

edymtt commented Mar 24, 2025

Uh oh!

edymtt commented Mar 24, 2025

Uh oh!

edymtt commented Mar 25, 2025

Uh oh!

edymtt commented Mar 25, 2025

Uh oh!

edymtt commented Mar 25, 2025

Uh oh!

edymtt commented Mar 25, 2025

Uh oh!

Uh oh!

Uh oh!

edymtt commented Mar 31, 2025

Uh oh!

edymtt commented Mar 31, 2025

Uh oh!

etcwilde Mar 20, 2025

Choose a reason for hiding this comment

Uh oh!

etcwilde Mar 31, 2025

Choose a reason for hiding this comment

Uh oh!

edymtt Mar 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

edymtt Mar 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

edymtt commented Mar 31, 2025

Uh oh!

edymtt commented Mar 31, 2025

Uh oh!

edymtt commented Mar 31, 2025

Uh oh!

edymtt commented Mar 31, 2025

Uh oh!

edymtt commented Mar 31, 2025

Uh oh!

Uh oh!

edymtt commented Mar 31, 2025

Uh oh!

edymtt commented Mar 31, 2025

Uh oh!

edymtt commented Mar 31, 2025

Uh oh!

edymtt commented Mar 31, 2025

build-script: Permit to build compiler-rt with `LLVM_ENABLE_RUNTIMES` #80174

build-script: Permit to build compiler-rt with `LLVM_ENABLE_RUNTIMES` #80174

edymtt Mar 20, 2025 •

edited

Loading

edymtt Mar 20, 2025 •

edited

Loading

edymtt Mar 31, 2025 •

edited

Loading

edymtt Mar 31, 2025 •

edited

Loading