[cmake] add FindSwiftPlatformOverlay.cmake #82895

justice-adams-apple · 2025-07-08T21:37:11Z

Add FindSwiftPlatformOverlay module responsible for finding the platform overlays for the supplemental libraries

Runtimes/Supplemental/cmake/modules/FindSwiftPlatformOverlay.cmake

compnerd · 2025-07-08T21:50:53Z

Runtimes/Supplemental/cmake/modules/FindSwiftPlatformOverlay.cmake

Suggested change

#ToDo: Handle the static MUSL SDK case

#TODO(swiftlang/swift#????): Handle the static MUSL SDK case

Can you fill in an issue identifier that has the context on what exactly needs to be done here?

Runtimes/Supplemental/cmake/modules/FindSwiftPlatformOverlay.cmake

compnerd · 2025-07-08T21:54:54Z

Runtimes/Supplemental/cmake/modules/FindSwiftPlatformOverlay.cmake

Seems like a generator expression should allow us to fold the two branches into one:

list(APPEND swiftAndroid_INCLUDE_DIR_HINTS "${Swift_SDKROOT}/usr/lib/swift$<$<BOOL:${SwiftPlatformOverlay_USE_STATIC_LIBS}>:_static>/swift/android ...

I don't believe that find_library or find_path accept generator expressions as its HINTS ~~since it's run well before the is instantiated~~.

It turns out that find_library does actually grab a pointer to the global generator from the makefile, so I learned something new today.

cmFindLibraryHelper::cmFindLibraryHelper(cmMakefile* mf, cmFindBase const* base, cmFindCommonDebugState* debugState) : Makefile(mf) , FindBase(base) , DebugState(debugState) { this->GG = this->Makefile->GetGlobalGenerator(); // Collect the list of library name prefixes/suffixes to try. std::string const& prefixes_list = get_prefixes(this->Makefile); std::string const& suffixes_list = get_suffixes(this->Makefile); this->Prefixes.assign(prefixes_list, cmList::EmptyElements::Yes); this->Suffixes.assign(suffixes_list, cmList::EmptyElements::Yes); this->RegexFromList(this->PrefixRegexStr, this->Prefixes, cmSystemTools::DirCase::Sensitive); this->RegexFromList(this->ICasePrefixRegexStr, this->Prefixes, cmSystemTools::DirCase::Insensitive); this->RegexFromList(this->SuffixRegexStr, this->Suffixes, cmSystemTools::DirCase::Sensitive); this->RegexFromList(this->ICaseSuffixRegexStr, this->Suffixes, cmSystemTools::DirCase::Insensitive); // Check whether to use OpenBSD-style library version comparisons. this->IsOpenBSD = this->Makefile->GetState()->GetGlobalPropertyAsBool( "FIND_LIBRARY_USE_OPENBSD_VERSIONING"); }

That's so that it can call cmGlobalGenerator::GetDirectoryContent, but I don't see it calling cmGeneratorExpression::Expand anywhere in the evaluation.

etcwilde · 2025-07-08T23:34:09Z

Runtimes/Supplemental/cmake/modules/FindSwiftPlatformOverlay.cmake

What is this? The project name is SwiftOverlay:

https://github.com/swiftlang/swift/blob/9ae27d7a2fe547768c1637ecc06791f63f55aa61/Runtimes/Overlay/CMakeLists.txt#L30C1-L30C21

This will need to align with the Find-module name, (SwiftPlatformOverlay). This will be consistent across all of the platforms.

We should be able to move this bit to the top of the file just like with FindSwiftCore.cmake.

if(SwiftPlatformOverlay_DIR) if(SwiftPlatformOverlay_FIND_REQUIRED) list(APPEND args REQUIRED) endif() if(SwiftPlatformOverlay_FIND_QUIETLY) list(APPEND args QUIET) endif() find_package(SwiftPlatformOverlay CONFIG ${args}) return() endif()

I renamed the package to FindSwiftOverlay and moved the check for SwiftOverlay_Dir to the top of the module

etcwilde · 2025-07-08T23:34:45Z

Runtimes/Supplemental/cmake/modules/FindSwiftPlatformOverlay.cmake

This is part of the platform overlay package. This should be exported by the SwiftPlatformOverlay module.

Runtimes/Supplemental/cmake/modules/FindSwiftPlatformOverlay.cmake

justice-adams-apple · 2025-07-11T21:51:15Z

@swift-ci smoke test

justice-adams-apple · 2025-07-14T20:32:26Z

@swift-ci smoke test macOS

edymtt · 2025-07-21T22:27:15Z

Runtimes/Supplemental/cmake/modules/FindSwiftOverlay.cmake

+endif()
+
+if(SwiftOverlay_DIR)
+  find_package(SwiftOverlay CONFIG)


I think it still makes sense to propagate of the QUIET and REQUIRED keywords like find_dependency does (since find_package does not do that, at least from a quick skim of the source code)

Suggested change

find_package(SwiftOverlay CONFIG)

if(${CMAKE_FIND_PACKAGE_NAME}_FIND_REQUIRED)

list(APPEND args REQUIRED)

endif()

if(${CMAKE_FIND_PACKAGE_NAME}_FIND_QUIETLY)

list(APPEND args QUIET)

endif()

find_package(SwiftOverlay CONFIG ${args})

edymtt · 2025-07-21T22:40:52Z

Runtimes/Supplemental/cmake/modules/FindSwiftOverlay.cmake

+include(FindPackageHandleStandardArgs)
+include(PlatformInfo)


(Nitpick) I would suggest to move this after if(SwiftOverlay_DIR), so it matches the structure of FindSwiftCore (and we avoid loading those modules if we have a config file)

edymtt · 2025-07-21T22:45:23Z

Runtimes/Supplemental/cmake/modules/FindSwiftOverlay.cmake

+  # If the swiftGlibc_DIR_FLAG is specified, look there instead. The cmake-generated
+  # config file is more accurate
+  if(swiftGlibc_DIR)
+    if(swiftGlibc_FIND_REQUIRED)
+      list(APPEND args REQUIRED)
+    endif()
+    if(swiftGlibc_FIND_QUIETLY)
+      list(APPEND args QUIET)
+    endif()
+    find_package(swiftGlibc NO_MODULE ${args})
+  # Look in the SDK
+  else()


I don't think this is needed -- I expect swiftGlibc to be exported as part of the Overlay build system, so the call to find_package(SwiftOverlay ...) should take care of this.

Suggested change

# If the swiftGlibc_DIR_FLAG is specified, look there instead. The cmake-generated

# config file is more accurate

if(swiftGlibc_DIR)

if(swiftGlibc_FIND_REQUIRED)

list(APPEND args REQUIRED)

endif()

if(swiftGlibc_FIND_QUIETLY)

list(APPEND args QUIET)

endif()

find_package(swiftGlibc NO_MODULE ${args})

# Look in the SDK

else()

(the matching endif() should be deleted as well)

edymtt · 2025-07-21T22:47:25Z

Runtimes/Supplemental/cmake/modules/FindSwiftOverlay.cmake

+    "${Swift_SDKROOT}/usr/lib/swift"
+    "$ENV{SDKROOT}/usr/lib/swift/${${PROJECT_NAME}_PLATFORM_SUBDIR}/${${PROJECT_NAME}_ARCH_SUBDIR}"
+    "$ENV{SDKROOT}/usr/lib/swift")
+  list(APPEND swiftCRT_NAMES swiftCRT.lib)


We need to change the name whether we are looking for dynamic or static libraries
(please double check with what we did for FindSwiftCore)

Suggested change

list(APPEND swiftCRT_NAMES swiftCRT.lib)

if(SwiftOverlay_USE_STATIC_LIBS)

list(APPEND swiftCRT_NAMES libswiftCRT.lib)

else()

list(APPEND swiftCRT_NAMES swiftCRT.lib)

endif()

edymtt · 2025-07-21T22:48:05Z

Runtimes/Supplemental/cmake/modules/FindSwiftOverlay.cmake

+    "${Swift_SDKROOT}/usr/lib/swift"
+    "$ENV{SDKROOT}/usr/lib/swift/${${PROJECT_NAME}_PLATFORM_SUBDIR}/${${PROJECT_NAME}_ARCH_SUBDIR}"
+    "$ENV{SDKROOT}/usr/lib/swift")
+  list(APPEND swiftWinSDK_NAMES swiftWinSDK.lib)


Same feedback as swiftCRT

justice-adams-apple · 2025-07-22T21:33:38Z

@swift-ci smoke test macOS

justice-adams-apple · 2025-07-23T16:58:53Z

@swift-ci smoke test

edymtt

Looks good to me -- of all my comments, the only important one before merging is about lines 144-148

edymtt · 2025-07-25T18:43:55Z

Runtimes/Supplemental/cmake/modules/FindSwiftOverlay.cmake

+FindSwiftOverlay
+------------
+
+Find SwiftOverlay, deferring to the associated <Overlay>Config.cmake when requested.


(Can be done in a follow up PR) At the moment we can defer only to the config file for the SwiftOverlay project

Suggested change

Find SwiftOverlay, deferring to the associated <Overlay>Config.cmake when requested.

Find SwiftOverlay, deferring to the associated SwiftOverlayConfig.cmake when requested.

edymtt · 2025-07-25T18:49:20Z

Runtimes/Supplemental/cmake/modules/FindSwiftOverlay.cmake

+   This affects Linux, Android, and Windows builds.
+   Apple builds always use the overlay provided by the SDK.
+
+Result Variables


(Can be done in a follow up PR) This section refers to variables that are not considered (swiftDarwin_DIR et al) or not set by find_package and our search logic (swiftDarwin_DIR_FOUND et all)

The section would need to either be reworked, or possibly removed all together (to nudge users toward using the target)

edymtt · 2025-07-25T20:13:58Z

Runtimes/Supplemental/cmake/modules/FindSwiftOverlay.cmake

+  if(SwiftOverlay_USE_STATIC_LIBS)
+    list(APPEND swiftCRT_NAMES libswiftWinSDK.lib)
+  else()
+    list(APPEND swiftCRT_NAMES swiftWinSDK.lib)
+  endif()


The name of the variable does not match the overlay we are searching

Suggested change

if(SwiftOverlay_USE_STATIC_LIBS)

list(APPEND swiftCRT_NAMES libswiftWinSDK.lib)

else()

list(APPEND swiftCRT_NAMES swiftWinSDK.lib)

endif()

if(SwiftOverlay_USE_STATIC_LIBS)

list(APPEND swiftWinSDK_NAMES libswiftWinSDK.lib)

else()

list(APPEND swiftWinSDK_NAMES swiftWinSDK.lib)

endif()

edymtt · 2025-07-25T20:17:02Z

Runtimes/Supplemental/cmake/modules/FindSwiftOverlay.cmake

+  " Build the Overlays for your platform and set the appropriate `<OverlayTarget>_DIR` variable to"
+  " the directory containing <OverlayTarget>Config.cmake\n")


(Can be done in a later PR) I believe we want to suggest the SwiftOverlay project is the place to build additional overlays

Suggested change

" Build the Overlays for your platform and set the appropriate `<OverlayTarget>_DIR` variable to"

" the directory containing <OverlayTarget>Config.cmake\n")

" Build the Overlays for your platform and set the appropriate `SwiftOverlay_DIR` variable to"

" the directory containing SwiftOverlayConfig.cmake\n")

edymtt · 2025-07-25T22:05:45Z

Runtimes/Supplemental/cmake/modules/FindSwiftOverlay.cmake

+
+# Setup SwiftOverlay interface library and link it against the explicit
+# overlay targets
+add_library(SwiftOverlay INTERFACE)


(Can be done in a follow up PR) I would use the same camel case convention we use for the other targets -- that is, start the name with a lower case letter

Suggested change

add_library(SwiftOverlay INTERFACE)

add_library(swiftOverlay INTERFACE)

@edymtt I' would probably tackle this in a another PR, but a bit confused, I see the target in the Overlay project is called SwiftOverlay and the FindSwiftCore defines SwiftCore so I was going off that. Might be overlooking something

justice-adams-apple · 2025-07-30T20:10:14Z

@swift-ci smoke test

justice-adams-apple requested review from compnerd, edymtt and etcwilde as code owners July 8, 2025 21:37

compnerd reviewed Jul 8, 2025

View reviewed changes

etcwilde reviewed Jul 8, 2025

View reviewed changes

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

justice-adams-apple force-pushed the jadams/add-find-platform-overlay branch from fb9bbc0 to f902e53 Compare July 11, 2025 21:44

justice-adams-apple mentioned this pull request Jul 11, 2025

[CMAKE] update FindSwiftOverlay with ability to find and pull in musl static SDK #83014

Open

justice-adams-apple force-pushed the jadams/add-find-platform-overlay branch from f902e53 to 4a02999 Compare July 11, 2025 21:49

edymtt reviewed Jul 21, 2025

View reviewed changes

justice-adams-apple force-pushed the jadams/add-find-platform-overlay branch from 4a02999 to 0cb933a Compare July 22, 2025 21:32

edymtt approved these changes Jul 25, 2025

View reviewed changes

[cmake] add FindSwiftPlatformOverlay module

86821e4

justice-adams-apple force-pushed the jadams/add-find-platform-overlay branch from 0cb933a to 86821e4 Compare July 30, 2025 20:08

justice-adams-apple merged commit 573607f into main Aug 4, 2025
3 checks passed

justice-adams-apple deleted the jadams/add-find-platform-overlay branch August 4, 2025 16:19

	#ToDo: Handle the static MUSL SDK case
	#TODO(swiftlang/swift#????): Handle the static MUSL SDK case

	Find SwiftOverlay, deferring to the associated <Overlay>Config.cmake when requested.
	Find SwiftOverlay, deferring to the associated SwiftOverlayConfig.cmake when requested.

		" Build the Overlays for your platform and set the appropriate `<OverlayTarget>_DIR` variable to"
		" the directory containing <OverlayTarget>Config.cmake\n")

	add_library(SwiftOverlay INTERFACE)
	add_library(swiftOverlay INTERFACE)

		include(FindPackageHandleStandardArgs)
		include(PlatformInfo)

[cmake] add FindSwiftPlatformOverlay.cmake #82895

[cmake] add FindSwiftPlatformOverlay.cmake #82895

Uh oh!

Conversation

justice-adams-apple commented Jul 8, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

etcwilde Jul 8, 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!

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!

Uh oh!

justice-adams-apple commented Jul 11, 2025

Uh oh!

justice-adams-apple commented Jul 14, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

edymtt Jul 21, 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

justice-adams-apple commented Jul 22, 2025

Uh oh!

justice-adams-apple commented Jul 23, 2025

Uh oh!

edymtt left a comment • 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!

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 Jul 30, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

etcwilde Jul 8, 2025 •

edited

Loading

edymtt Jul 21, 2025 •

edited

Loading

edymtt left a comment •

edited

Loading