[cmake] add FindSwiftCore module for supplemental libraries #81215

justice-adams-apple · 2025-04-30T21:28:20Z

Add FindSwiftCore to Supplemental cmake modules so we can link against libswiftCore in a given end users SDK if SwiftCore_DIR is not provided

Runtimes/Supplemental/cmake/modules/FindSwiftCore.cmake

justice-adams-apple · 2025-05-05T21:38:20Z

@swift-ci please smoke test

edymtt · 2025-05-05T22:36:26Z

Runtimes/Supplemental/cmake/modules/FindSwiftCore.cmake

+ ``SDKROOT``
+   Set the path to the Swift SDK Root.
+   This only affects MacOS builds.


This description seems stale now -- this seems to be now an environment variable sensed when building on Windows

The SDKROOT env var gets set up by the Windows toolchain installation. It's less of a hint and more meant as a fallback to avoid requiring the variable be set when building for Windows. If it's important, it should likely be set via the Swift_SDKROOT variable directly.

edymtt · 2025-05-05T22:37:16Z

Runtimes/Supplemental/cmake/modules/FindSwiftCore.cmake

+  find_package_handle_standard_args(SwiftCore DEFAULT_MSG
+    SwiftCore_LIBRARY SwiftCore_INCLUDE_DIR)
+elseif(WIN32)
+  set(SwiftCore_INCLUDE_DIR "${Swift_SDKROOT}/usr/lib/swift_static/linux-static/Swift.swiftmodule" CACHE STRING "")


This seems like a left over from iterating on the code -- if I interpret this comment correctly, the line below should be enough

Suggested change

set(SwiftCore_INCLUDE_DIR "${Swift_SDKROOT}/usr/lib/swift_static/linux-static/Swift.swiftmodule" CACHE STRING "")

Yeah, let's use find_path to search for the appropriate Swift.swiftmoule. We should prefer to search via Swift_SDKROOT, but then can fall back on $ENV{SDKROOT}. If we're building for Windows, we shouldn't be trying to find the swiftmodule from the linux-static SDK.

etcwilde · 2025-05-06T17:23:25Z

Runtimes/Supplemental/cmake/modules/FindSwiftCore.cmake

+ ``SDKROOT``
+   Set the path to the Swift SDK Root.
+   This only affects MacOS builds.


The SDKROOT env var gets set up by the Windows toolchain installation. It's less of a hint and more meant as a fallback to avoid requiring the variable be set when building for Windows. If it's important, it should likely be set via the Swift_SDKROOT variable directly.

etcwilde · 2025-05-06T17:24:16Z

Runtimes/Supplemental/cmake/modules/FindSwiftCore.cmake

+   Set the path to the Swift SDK Root.
+   This only affects MacOS builds.
+
+ ``swift_SDKROOT``


The variable below uses a capital S on "Swift".

Suggested change

``swift_SDKROOT``

``Swift_SDKROOT``

etcwilde · 2025-05-06T17:24:41Z

Runtimes/Supplemental/cmake/modules/FindSwiftCore.cmake

+
+ ``SwiftCore_LIBRARIES`` OR ``SwiftCore_IMPLIB``
+   the libraries to be linked
+


SwiftCore_INCLUDE_DIR is also set.

This can also be a property on the imported library target.

etcwilde · 2025-05-06T17:26:51Z

Runtimes/Supplemental/cmake/modules/FindSwiftCore.cmake

+  find_package_handle_standard_args(SwiftCore DEFAULT_MSG
+    SwiftCore_LIBRARY SwiftCore_INCLUDE_DIR)
+elseif(WIN32)
+  set(SwiftCore_INCLUDE_DIR "${Swift_SDKROOT}/usr/lib/swift_static/linux-static/Swift.swiftmodule" CACHE STRING "")


Yeah, let's use find_path to search for the appropriate Swift.swiftmoule. We should prefer to search via Swift_SDKROOT, but then can fall back on $ENV{SDKROOT}. If we're building for Windows, we shouldn't be trying to find the swiftmodule from the linux-static SDK.

Addresses rdar://150396923

justice-adams-apple · 2025-05-06T19:03:18Z

@swift-ci please smoke test

compnerd · 2025-05-08T01:37:56Z

Runtimes/Supplemental/cmake/modules/FindSwiftCore.cmake

+ ``SwiftCore_FOUND``
+   true if core was found
+
+ ``SwiftCore_LIBRARIES`` OR ``SwiftCore_IMPLIB``


I don't think that we should be doing these variables. Instead we should create a SwiftCore target that is an imported library (static or shared). On Windows, we can associate an IMPORTED_IMPLIB property on the shared library target. This description does seem to match what we are doing below.

compnerd · 2025-05-08T01:38:27Z

Runtimes/Supplemental/cmake/modules/FindSwiftCore.cmake

+
+ ``SwiftCore_LIBRARIES`` OR ``SwiftCore_IMPLIB``
+   the libraries to be linked
+


This can also be a property on the imported library target.

compnerd · 2025-05-08T01:39:52Z

Runtimes/Supplemental/cmake/modules/FindSwiftCore.cmake

+  find_package_handle_standard_args(SwiftCore DEFAULT_MSG
+    SwiftCore_IMPLIB SwiftCore_INCLUDE_DIR)
+elseif(LINUX)
+  if(SwiftCore_STATIC)


Can we detect static or dynamic by any chance?

justice-adams-apple · 2025-05-12T22:15:31Z

@swift-ci please smoke test

edymtt · 2025-05-13T21:02:34Z

Runtimes/Supplemental/cmake/modules/FindSwiftCore.cmake

+Hint Variables
+^^^^^^^^^^^^^^
+
+ ``SDKROOT``


Optional: we may want to state this is not a CMake variable

Suggested change

``SDKROOT``

``SDKROOT`` (environment variable)

edymtt · 2025-05-13T21:10:20Z

Runtimes/Supplemental/cmake/modules/FindSwiftCore.cmake

+      "${CMAKE_OSX_SYSROOT}/usr/lib/swift")
+  add_library(SwiftCore SHARED IMPORTED GLOBAL)
+  set_target_properties(SwiftCore PROPERTIES
+    IMPORTED_IMPLIB "${SwiftCore_IMPLIB}")


I believe this target needs to have the path to the swiftmodules as well like its siblings:

Suggested change

IMPORTED_IMPLIB "${SwiftCore_IMPLIB}")

IMPORTED_IMPLIB "${SwiftCore_IMPLIB}"

INTERFACE_INCLUDE_DIRECTORIES "${SwiftCore_INCLUDE_DIR}")

justice-adams-apple · 2025-05-13T21:41:37Z

@swift-ci please smoke test

Add FindSwiftCore to Supplemental cmake modules so we can link against libswiftCore in a given end users SDK if `SwiftCore_DIR ` is not provided

Addresses rdar://150300769 Add Synchronization library to new build system Land #81215 first

edymtt · 2025-05-20T15:15:26Z

Runtimes/Supplemental/cmake/modules/FindSwiftCore.cmake

+    NAMES "libswiftCore.tbd"
+    HINTS
+      "${CMAKE_OSX_SYSROOT}/usr/lib/swift")
+  add_library(SwiftCore SHARED IMPORTED GLOBAL)


When experimenting at desk I noticed that the case of the target does not match with the one we use in the build system

swift/Runtimes/Core/core/CMakeLists.txt

Lines 29 to 31 in 6534b9b

add_library(swiftCore

Algorithm.swift

ArrayBody.swift

swift/Runtimes/Supplemental/Synchronization/CMakeLists.txt

Lines 97 to 99 in 6534b9b

target_link_libraries(swiftSynchronization PRIVATE

swiftCore

$<$<PLATFORM_ID:Darwin>:swiftDarwin>)

meaning we are relying on search paths known to the compiler to find this library, instead of CMake providing the explicit path to the tbd/so/lib file

Suggested change

add_library(SwiftCore SHARED IMPORTED GLOBAL)

add_library(swiftCore SHARED IMPORTED GLOBAL)

…wiftlang#81215)" This reverts commit 758ae18.

justice-adams-apple requested review from etcwilde, compnerd and edymtt as code owners April 30, 2025 21:28

edymtt reviewed Apr 30, 2025

View reviewed changes

Runtimes/Supplemental/cmake/modules/FindSwiftCore.cmake Show resolved Hide resolved

Runtimes/Supplemental/cmake/modules/FindSwiftCore.cmake Outdated Show resolved Hide resolved

Runtimes/Supplemental/cmake/modules/FindSwiftCore.cmake Show resolved Hide resolved

justice-adams-apple force-pushed the jadams/add-find-swiftcore branch from 085630a to 6b5befc Compare May 5, 2025 21:29

justice-adams-apple mentioned this pull request May 5, 2025

[cmake] add Synchronization library to Supplemental build #81310

Merged

edymtt reviewed May 5, 2025

View reviewed changes

etcwilde reviewed May 6, 2025

View reviewed changes

[cmake] add FindSwiftCore module for supplemental libraries

c874044

Addresses rdar://150396923

justice-adams-apple force-pushed the jadams/add-find-swiftcore branch from 6b5befc to c874044 Compare May 6, 2025 18:38

compnerd reviewed May 8, 2025

View reviewed changes

cleanup comments and use SHARED_LIBS correctly

a07547d

edymtt reviewed May 13, 2025

View reviewed changes

set INTERFACE_INCLUDE_DIRECTORIES on apple platforms

930ce6b

edymtt approved these changes May 13, 2025

View reviewed changes

justice-adams-apple merged commit 758ae18 into main May 15, 2025
3 checks passed

justice-adams-apple deleted the jadams/add-find-swiftcore branch May 15, 2025 15:55

justice-adams-apple added a commit that referenced this pull request May 16, 2025

[cmake] add Synchronization library to Supplemental build (#81310)

50e3070

Addresses rdar://150300769 Add Synchronization library to new build system Land #81215 first

edymtt reviewed May 20, 2025

View reviewed changes

hamishknight added a commit to hamishknight/swift that referenced this pull request May 22, 2025

Revert "[cmake] add FindSwiftCore module for supplemental libraries (s…

662033c

…wiftlang#81215)" This reverts commit 758ae18.


		``SwiftCore_LIBRARIES`` OR ``SwiftCore_IMPLIB``
		the libraries to be linked

	IMPORTED_IMPLIB "${SwiftCore_IMPLIB}")
	IMPORTED_IMPLIB "${SwiftCore_IMPLIB}"
	INTERFACE_INCLUDE_DIRECTORIES "${SwiftCore_INCLUDE_DIR}")

	target_link_libraries(swiftSynchronization PRIVATE
	swiftCore
	$<$<PLATFORM_ID:Darwin>:swiftDarwin>)

	add_library(SwiftCore SHARED IMPORTED GLOBAL)
	add_library(swiftCore SHARED IMPORTED GLOBAL)

[cmake] add FindSwiftCore module for supplemental libraries #81215

[cmake] add FindSwiftCore module for supplemental libraries #81215

Uh oh!

Conversation

justice-adams-apple commented Apr 30, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

justice-adams-apple commented May 5, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

justice-adams-apple commented May 6, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

justice-adams-apple commented May 12, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

edymtt May 13, 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!

justice-adams-apple commented May 13, 2025

Uh oh!

Uh oh!

edymtt May 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!

Uh oh!

edymtt May 13, 2025 •

edited

Loading

edymtt May 20, 2025 •

edited

Loading