Symlink `swift` and `swiftc` to `swift-driver`, when available #69834

artemcm · 2023-11-14T00:35:45Z

Remove redundant calls to add_swift_tool_symlink on /bin executables of the driver CMake target
Symlink swift and swiftc to swift-driver, when available (when earlyswiftdriver was built with the host toolchain (default))
Install host-built swift-driver and swift-help when installing the 'compiler' component
Add symlinks for the legacy driver invocation (for emergency fallback invoked from swift-driver)
- Corresponding swift-driver change: Add fallback to auxiliary legacy driver executable on '--disallow-use-new-driver' swift-driver#1485

artemcm · 2023-11-14T00:44:37Z

artemcm · 2023-11-14T23:32:46Z

swiftlang/swift-driver#1485
@swift-ci test

bnbarham · 2023-11-15T00:22:12Z

tools/driver/CMakeLists.txt

As far as I can tell what happened here is that #6053 added this and removed the others, but that was somehow lost in the conflict resolution in #10337. I haven't looked at the LLVM closely, but I assume we should probably prefer add_swift_tool_symlink over swift_create_post_build_symlink and swift_install_in_component? Any thoughts @edymtt/@compnerd?

One thing about add_swift_tool_symlink is that it requires the "source" be a component. So we can't simply call:

add_swift_tool_symlink(swift swift-driver compiler)

Because that leads to:

CMake Error at /Volumes/Data/GHWorkspace/build/Ninja-Release/llvm-macosx-arm64/lib/cmake/llvm/AddLLVM.cmake:2168 (get_target_property): get_target_property() called with non-existent target "swift-driver".

@bnbarham yes, we do prefer the add_swift_tool_symlink because it correctly handles the install of the link (or in the case of Windows, copy 😠). This makes it significantly better for building the toolchain distribution. Without that we will need to add a whole slew of custom install logic.

To be clear, we have that logic already (we have both today):

swift_install_in_component(FILES "${SWIFT_RUNTIME_OUTPUT_INTDIR}/swift${CMAKE_EXECUTABLE_SUFFIX}" DESTINATION "bin" COMPONENT compiler)

One thing about add_swift_tool_symlink is that it requires the "source" be a component. So we can't simply call:

We could fix that by adding a custom target for the early swift driver (which does the copy) right? ie. change swift_create_early_driver_copies to instead use add_custom_command + add_custom_target rather than configure_file.

We already have a slew of custom install logic though, with swift_install_in_component later in this file.

We can pursue a refactor here to replace both swift_create_post_build_symlink and swift_install_in_component with LLVM tooling, but as-is, the logic is already there, and add_swift_tool_symlink would not work for this use-case for the reason described above.

Also, swift_install_in_component does, I believe, already do Windows-specific things (copy instead of symlink) so I don't think this will functionally change much here.

artemcm · 2023-11-17T00:47:30Z

swiftlang/swift-driver#1485
@swift-ci test

artemcm · 2023-11-17T20:08:54Z

swiftlang/swift-driver#1485
@swift-ci test

artemcm · 2023-11-27T19:08:12Z

swiftlang/swift-driver#1485
@swift-ci test

artemcm · 2023-11-30T17:45:18Z

swiftlang/swift-driver#1485
@swift-ci test

artemcm · 2023-11-30T18:58:48Z

swiftlang/swift-driver#1485
@swift-ci build toolchain

artemcm · 2023-12-06T19:19:11Z

swiftlang/swift-driver#1485
@swift-ci test

compnerd · 2023-12-08T17:12:47Z

@swift-ci please build toolchain Windows platform

artemcm · 2023-12-08T23:26:07Z

swiftlang/swift-driver#1485
@swift-ci test macOS platform

artemcm · 2023-12-13T16:31:29Z

swiftlang/swift-driver#1485
@swift-ci test macOS platform

artemcm · 2023-12-19T19:51:24Z

swiftlang/swift-driver#1485
@swift-ci test macOS platform

artemcm · 2024-01-02T21:45:42Z

swiftlang/swift-driver#1485
@swift-ci test macOS platform

… of the driver CMake target

…e 'compiler' component

… invoked from 'swift-driver')

artemcm · 2024-01-04T17:25:36Z

swiftlang/swift-driver#1485
@swift-ci test

artemcm · 2024-01-08T18:16:40Z

@swift-ci please build Windows toolchain

artemcm · 2024-01-08T21:41:44Z

@swift-ci please build toolchain Windows

artemcm · 2024-01-09T16:23:39Z

@swift-ci please build toolchain Windows

artemcm force-pushed the DefaultNewDriverSymlink branch from dea64f9 to 53b2111 Compare November 14, 2023 17:37

artemcm mentioned this pull request Nov 14, 2023

Add fallback to auxiliary legacy driver executable on '--disallow-use-new-driver' swiftlang/swift-driver#1485

Merged

artemcm force-pushed the DefaultNewDriverSymlink branch 2 times, most recently from 44d473c to ec7934c Compare November 14, 2023 23:32

artemcm changed the title ~~Symlink 'swift' and 'swiftc' to 'swift-driver', when available~~ Symlink swift and swiftc to swift-driver, when available Nov 14, 2023

artemcm marked this pull request as ready for review November 14, 2023 23:44

bnbarham reviewed Nov 15, 2023

View reviewed changes

owenv mentioned this pull request Nov 15, 2023

Always forward subcommand invocations to swift-driver #69800

Closed

artemcm force-pushed the DefaultNewDriverSymlink branch from ec7934c to e613b4b Compare November 17, 2023 00:47

artemcm force-pushed the DefaultNewDriverSymlink branch from e613b4b to f380790 Compare November 17, 2023 20:08

artemcm force-pushed the DefaultNewDriverSymlink branch 2 times, most recently from 16b9012 to b89b5d7 Compare November 30, 2023 17:45

artemcm force-pushed the DefaultNewDriverSymlink branch from b89b5d7 to f935713 Compare December 4, 2023 18:56

artemcm added 4 commits January 3, 2024 14:12

Remove redundant calls to 'add_swift_tool_symlink' on bin executables…

f7c3f5a

… of the driver CMake target

Symlink 'swift' and 'swiftc' to 'swift-driver', when available

f85b180

Install host-built 'swift-driver' and 'swift-help' when installing th…

7f6152a

…e 'compiler' component

Add symlinks for the legacy driver invocation (for emergency fallback…

6a181fb

… invoked from 'swift-driver')

artemcm force-pushed the DefaultNewDriverSymlink branch from f935713 to 6a181fb Compare January 3, 2024 23:45

artemcm merged commit 060d822 into swiftlang:main Jan 9, 2024

artemcm deleted the DefaultNewDriverSymlink branch January 9, 2024 20:50

kkebo mentioned this pull request Jan 16, 2024

The new swift-driver doesn't seem to work properly when it's used through a symbolic link #70932

Closed

Symlink swift and swiftc to swift-driver, when available #69834

Symlink swift and swiftc to swift-driver, when available #69834

Uh oh!

Conversation

artemcm commented Nov 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

artemcm commented Nov 14, 2023

Uh oh!

artemcm commented Nov 14, 2023

Uh oh!

bnbarham Nov 15, 2023

Choose a reason for hiding this comment

Uh oh!

artemcm Nov 15, 2023

Choose a reason for hiding this comment

Uh oh!

compnerd Nov 15, 2023

Choose a reason for hiding this comment

Uh oh!

bnbarham Nov 15, 2023

Choose a reason for hiding this comment

Uh oh!

artemcm Nov 15, 2023

Choose a reason for hiding this comment

Uh oh!

artemcm Nov 15, 2023

Choose a reason for hiding this comment

Uh oh!

artemcm commented Nov 17, 2023

Uh oh!

artemcm commented Nov 17, 2023

Uh oh!

artemcm commented Nov 27, 2023

Uh oh!

artemcm commented Nov 30, 2023

Uh oh!

artemcm commented Nov 30, 2023

Uh oh!

artemcm commented Dec 6, 2023

Uh oh!

compnerd commented Dec 8, 2023

Uh oh!

artemcm commented Dec 8, 2023

Uh oh!

artemcm commented Dec 13, 2023

Uh oh!

artemcm commented Dec 19, 2023

Uh oh!

artemcm commented Jan 2, 2024

Uh oh!

artemcm commented Jan 4, 2024

Uh oh!

artemcm commented Jan 8, 2024

Uh oh!

artemcm commented Jan 8, 2024

Uh oh!

artemcm commented Jan 9, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Symlink `swift` and `swiftc` to `swift-driver`, when available #69834

Symlink `swift` and `swiftc` to `swift-driver`, when available #69834

artemcm commented Nov 14, 2023 •

edited

Loading