Introduce Cmake support for SwiftFoundation #573

iCharlesHu · 2024-04-30T22:04:17Z

Add Cmake support for SwiftFoundation which includes

Adding CMakeLists.txt in major directories;
Adding module.modulemap for _CShims

Note: I had to change uuid.h's header guard because it's somehow conflicting with system ones while using Cmake to build.

Testing Notes

In order to build SwiftFoundation with Cmake you will need to install cmake and ninja: brew install cmake && brew install ninja

Currently the Cmake build for SwiftFoundationICU (SwiftFoundation's dependency) is hitting two compiler crashes. To work around these issues, first download the nightly Swift snapshot newer than 4/25's build. Then add the following lines in the main CMakeLists.txt file, right after cmake_minimum_required:

set(CMAKE_BUILD_TYPE "RelWithDebInfo")
set(CMAKE_Swift_COMPILER "/Library/Developer/Toolchains/<Toolchain you downloaded>/usr/bin/swiftc")

As of now, the main CMakeLists.txt does not fetch dependencies for you (yet). You'll have to manually checkout SwiftFoundation's two dependencies:

https://github.com/iCharlesHu/swift-foundation-icu.git (branch charles/cmake-support)
https://github.com/apple/swift-collections.git (branch release/1.1)

Next, go to each directory and manually build them: cmake -S . -B ./build -G Ninja && cd ./build && ninja

Finally, add these two lines to SwiftFoundation's main CMakeLists.txt, right below the two lines you just added:

set(SwiftCollections_DIR "/path/to/SwiftCollections/build/cmake/modules")
set(SwiftFoundationICU_DIR "/path/to/SwiftFoundationICU/build/cmake/modules")

Make sure to use the build folder above. This will instruct Cmake to use the dependencies you just checked out.

Now you can finally build SwiftFoundation with Cmake:

cmake -S . -B ./build -G Ninja && cd ./build && ninja

iCharlesHu · 2024-04-30T22:04:27Z

@swift-ci please test

iCharlesHu · 2024-04-30T22:04:57Z

@swift-ci please build toolchian

CMakeLists.txt

parkera · 2024-04-30T23:11:32Z

Sources/Foundation/CMakeLists.txt

+##
+##===----------------------------------------------------------------------===##
+
+file(GLOB_RECURSE _FoundationPreviewSources "*.swift")


Let's not build the "FoundationPreview" package in this mode.

You are aware of the limitation here that if you add a new file or remove a file you will need to do a clean build as the added/removed source will not be reflected in the build.

compnerd · 2024-05-01T15:08:54Z

Sources/Foundation/CMakeLists.txt

+##
+##===----------------------------------------------------------------------===##
+
+file(GLOB_RECURSE _FoundationPreviewSources "*.swift")


You are aware of the limitation here that if you add a new file or remove a file you will need to do a clean build as the added/removed source will not be reflected in the build.

Sources/_CShims/CMakeLists.txt

Sources/_CShims/include/module.modulemap

etcwilde · 2024-06-03T20:34:10Z

cmake/modules/SwiftSupport.cmake

+#
+# If the current architecture is supported by Swift, sets ${result_var_name}
+# with the sanitized host architecture name derived from CMAKE_SYSTEM_PROCESSOR.
+function(get_swift_host_arch result_var_name)


Rather than hard-code each architecture, we can ask the compiler what the module triple is based on either the default target triple for the toolchain or if someone is trying to cross-compile, based on CMAKE_Swift_COMPILER_TARGET:

if(NOT SwiftFoundation_MODULE_TRIPLE) # TODO: This logic should migrate to CMake once CMake supports installing swiftmodules set(module_triple_command "${CMAKE_Swift_COMPILER}" -print-target-info) if(CMAKE_Swift_COMPILER_TARGET) list(APPEND module_triple_command -target ${CMAKE_Swift_COMPILER_TARGET}) endif() execute_process(COMMAND ${module_triple_command} OUTPUT_VARIABLE target_info_json) string(JSON module_triple GET "${target_info_json}" "target" "moduleTriple") set(SwiftFoundation_MODULE_TRIPLE "${module_triple}" CACHE STRING "swift module triple used for installed swiftmodule and swiftinterface files") mark_as_advanced(SwiftFoundation_MODULE_TRIPLE) endif()

https://github.com/etcwilde/swift/blob/e10563e336f2fdd7bde5b4b5f1c2a181aa2fe024/stdlib/cmake/modules/PlatformInfo.cmake#L16-L26

etcwilde · 2024-06-03T20:35:04Z

cmake/modules/SwiftSupport.cmake

+      $<TARGET_PROPERTY:${module},Swift_MODULE_DIRECTORY>/${module_name}.swiftmodule
+      DESTINATION lib/${swift}/${swift_os}/${swift_arch})
+  endif()
+endfunction()


missing trailing newline

cmake/modules/SwiftSupport.cmake

iCharlesHu · 2024-06-11T22:52:32Z

Merged all commits. Now this PR is ready for review

iCharlesHu · 2024-06-11T22:52:38Z

@swift-ci please test

CMakeLists.txt

etcwilde · 2024-06-14T00:33:28Z

Sources/FoundationMacros/CMakeLists.txt

+    # If building at desk, check out and link against the SwiftSyntax repo's targets
+    FetchContent_Declare(SwiftSyntax
+        GIT_REPOSITORY https://github.com/apple/swift-syntax.git
+        GIT_TAG 510.0.0)


Can't do much about it at the moment, but it's unfortunate that this tag doesn't have the changes for picking up the SWIFT_HOST_MODULE_TRIPLE automatically. So just as a heads up, you're likely to get folks forgetting to set that and asking about an the error message:

CMake Error at build/_deps/swiftsyntax-src/CMakeLists.txt:80 (message): Host module triple required

The correct response will be to run swiftc -print-target-info manually and pull out the triple under target > moduleTriple and pass that to their CMake invocation e.g. cmake -G 'Ninja' -DSWIFT_HOST_MODULE_TRIPLE=x86_64-unknown-linux-gnu ....

Sources/FoundationMacros/CMakeLists.txt

CMakeLists.txt

iCharlesHu · 2024-06-14T18:13:13Z

cmake/modules/SwiftSupport.cmake

+  if(CMAKE_SYSTEM_NAME STREQUAL Darwin)
+    install(FILES $<TARGET_PROPERTY:${module},Swift_MODULE_DIRECTORY>/${module_name}.swiftdoc
+      DESTINATION lib/${swift}/${swift_os}/${module_name}.swiftmodule
+      RENAME ${swift_arch}.swiftdoc)


SwiftFoundation_MODULE_TRIPLE.swiftdock

iCharlesHu · 2024-06-14T18:16:29Z

cmake/modules/SwiftSupport.cmake

+  else()
+    install(FILES
+      $<TARGET_PROPERTY:${module},Swift_MODULE_DIRECTORY>/${module_name}.swiftdoc
+      $<TARGET_PROPERTY:${module},Swift_MODULE_DIRECTORY>/${module_name}.swiftmodule
+      DESTINATION lib/${swift}/${swift_os}/${swift_arch})
+  endif()


Remove and only use if for all platforms.

iCharlesHu · 2024-06-14T21:52:15Z

@swift-ci please test

etcwilde

I think this will work. I was able to successfully build and run code against this build locally.

In the string_shims.h, it might be worth figuring out where we're pulling that header in in C++ mode and wrapping the declarations in extern "C" {} to ensure that they get mangled correctly everywhere. If they don't, we'll get a linker error saying that some _Z... C++ symbol doesn't exist because it should actually be looking for the C mangle.

etcwilde · 2024-06-14T23:35:01Z

CMakeLists.txt

+
+set(BUILD_TESTING NO)
+
+set(COLLECTIONS_SINGLE_MODULE YES)


I'm okay to leave them for now, but we should probably move these settings into a separate CMake cache file so that if folks need to cross-compile SwiftFoundation for use outside of the prebuilt SDK, they can do so in a way that is configurable.

Sources/_CShims/include/string_shims.h

iCharlesHu · 2024-06-15T04:56:30Z

@swift-ci please test

iCharlesHu requested review from shahmishal and parkera April 30, 2024 22:05

parkera reviewed Apr 30, 2024

View reviewed changes

compnerd reviewed May 1, 2024

View reviewed changes

iCharlesHu force-pushed the charles/cmake-support branch from 9ddc89f to e92d120 Compare May 6, 2024 17:20

jmschonfeld mentioned this pull request May 20, 2024

[WIP] Add swift-foundation to toolchain build swiftlang/swift#73403

Closed

iCharlesHu force-pushed the charles/cmake-support branch from 73a1642 to 55170ad Compare May 24, 2024 18:38

parkera reviewed May 24, 2024

View reviewed changes

Sources/_CShims/include/module.modulemap Outdated Show resolved Hide resolved

iCharlesHu force-pushed the charles/cmake-support branch 2 times, most recently from 8a45d5b to 5fafa69 Compare June 3, 2024 17:10

etcwilde reviewed Jun 3, 2024

View reviewed changes

iCharlesHu force-pushed the charles/cmake-support branch 2 times, most recently from e26766c to 06d706e Compare June 5, 2024 18:22

stmontgomery reviewed Jun 5, 2024

View reviewed changes

cmake/modules/SwiftSupport.cmake Outdated Show resolved Hide resolved

iCharlesHu force-pushed the charles/cmake-support branch from 943535f to 9b51995 Compare June 11, 2024 22:52

iCharlesHu force-pushed the charles/cmake-support branch from 9b51995 to 9641641 Compare June 11, 2024 23:42

jmschonfeld mentioned this pull request Jun 13, 2024

[DNM] Test Toolchain Build swiftlang/swift#74344

Closed

etcwilde reviewed Jun 14, 2024

View reviewed changes

iCharlesHu force-pushed the charles/cmake-support branch 2 times, most recently from dd38a58 to e776427 Compare June 14, 2024 18:00

iCharlesHu commented Jun 14, 2024

View reviewed changes

jmschonfeld approved these changes Jun 14, 2024

View reviewed changes

etcwilde approved these changes Jun 15, 2024

View reviewed changes

iCharlesHu force-pushed the charles/cmake-support branch from daad9de to 8a8c4e3 Compare June 15, 2024 03:27

Introduce Cmake support for SwiftFoundation

6c41fba

iCharlesHu force-pushed the charles/cmake-support branch from 8a8c4e3 to 6c41fba Compare June 15, 2024 04:55

iCharlesHu merged commit 8976fc4 into swiftlang:main Jun 17, 2024
2 checks passed

iCharlesHu deleted the charles/cmake-support branch June 17, 2024 05:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce Cmake support for SwiftFoundation #573

Introduce Cmake support for SwiftFoundation #573

iCharlesHu commented Apr 30, 2024 •

edited

Loading

iCharlesHu commented Apr 30, 2024

iCharlesHu commented Apr 30, 2024

parkera Apr 30, 2024

compnerd May 1, 2024

compnerd May 1, 2024

etcwilde Jun 3, 2024

etcwilde Jun 3, 2024

iCharlesHu commented Jun 11, 2024

iCharlesHu commented Jun 11, 2024

etcwilde Jun 14, 2024

iCharlesHu Jun 14, 2024

iCharlesHu Jun 14, 2024

iCharlesHu commented Jun 14, 2024

etcwilde left a comment

etcwilde Jun 14, 2024

iCharlesHu commented Jun 15, 2024


		set(BUILD_TESTING NO)

		set(COLLECTIONS_SINGLE_MODULE YES)

Introduce Cmake support for SwiftFoundation #573

Introduce Cmake support for SwiftFoundation #573

Conversation

iCharlesHu commented Apr 30, 2024 • edited Loading

Testing Notes

iCharlesHu commented Apr 30, 2024

iCharlesHu commented Apr 30, 2024

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

iCharlesHu commented Jun 11, 2024

iCharlesHu commented Jun 11, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iCharlesHu commented Jun 14, 2024

etcwilde left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iCharlesHu commented Jun 15, 2024

iCharlesHu commented Apr 30, 2024 •

edited

Loading