Build failure with SwiftPM package with spaces in directory name on Linux

[cmcgee1024]

When building a SwiftPM package on a path with spaces in it there is a build failure on Linux.

Run this command from a swift-package manager Linux development environment:

swift run swift-build -v --build-system=swiftbuild --package-path=Fixtures/Miscellaneous/Spaces\ Fixture

It's expected that this should pass as it does for similar packages without spaces in the package path.

Instead, we get an error from clang:

info: Link Module Name 1_Module.o (aarch64)
    cd /swiftpm/Fixtures/Miscellaneous/Spaces\ Fixture
    /usr/bin/clang -target aarch64-unknown-linux-gnu -r --sysroot / -O0 -L/swiftpm/Fixtures/Miscellaneous/Spaces\ Fixture/.build/aarch64-unknown-linux-gnu/Intermediates.noindex/EagerLinkingTBDs/Debug-linux -L/swiftpm/Fixtures/Miscellaneous/Spaces\ Fixture/.build/aarch64-unknown-linux-gnu/Products/Debug-linux -L/usr/lib @/swiftpm/Fixtures/Miscellaneous/Spaces\ Fixture/.build/aarch64-unknown-linux-gnu/Intermediates.noindex/Spaces\ Fixture.build/Debug-linux/Module\ Name\ 1_Module.build/Objects-normal/aarch64/Module\ Name\ 1_Module.LinkFileList -nostdlib -rdynamic -o /swiftpm/Fixtures/Miscellaneous/Spaces\ Fixture/.build/aarch64-unknown-linux-gnu/Products/Debug-linux/Module\ Name\ 1_Module.o
error: unknown No such file or directory: '/swiftpm/Fixtures/Miscellaneous/Spaces' []
error: unknown No such file or directory: 'Fixture/.build/aarch64-unknown-linux-gnu/Intermediates.noindex/Spaces' []
error: unknown No such file or directory: 'Fixture.build/Debug-linux/Module' []
error: unknown No such file or directory: 'Name' []
error: unknown No such file or directory: '1_Module.build/Objects-normal/aarch64/Modules/Module_Name_1.o' []
error: unknown No such file or directory: '/swiftpm/Fixtures/Miscellaneous/Spaces' []
error: unknown No such file or directory: 'Fixture/.build/aarch64-unknown-linux-gnu/Intermediates.noindex/Spaces' []
info: Compile main.swift (aarch64)
    cd /swiftpm/Fixtures/Miscellaneous/Spaces\ Fixture

error: unknown No such file or directory: 'Fixture.build/Debug-linux/Module' []
error: unknown No such file or directory: 'Name' []
error: unknown No such file or directory: '1_Module.build/Objects-normal/aarch64/Foo.o' []
info: clang: error: no such file or directory: '/swiftpm/Fixtures/Miscellaneous/Spaces'
clang: error: no such file or directory: 'Fixture/.build/aarch64-unknown-linux-gnu/Intermediates.noindex/Spaces'
clang: error: no such file or directory: 'Fixture.build/Debug-linux/Module'
clang: error: no such file or directory: 'Name'
clang: error: no such file or directory: '1_Module.build/Objects-normal/aarch64/Modules/Module_Name_1.o'
clang: error: no such file or directory: '/swiftpm/Fixtures/Miscellaneous/Spaces'
clang: error: no such file or directory: 'Fixture/.build/aarch64-unknown-linux-gnu/Intermediates.noindex/Spaces'
clang: error: no such file or directory: 'Fixture.build/Debug-linux/Module'
clang: error: no such file or directory: 'Name'
clang: error: no such file or directory: '1_Module.build/Objects-normal/aarch64/Foo.o'
error: Build failed

[cmcgee1024]

This appears to be caused by the way that the link file list is being set up for clang. It's interpreting the space as a file name delimiter.

[cmcgee1024]

Clang on linux expects shell escaping for each line of the file list file. See the following section of code where the file list file is generated:

swift-build/Sources/SWBCore/SpecImplementations/Tools/LinkerTools.swift

Line 353 in d8be8e6

// ld64 reads lines from the file using fgets, without doing any other processing.

This comment:

// ld64 reads lines from the file using fgets, without doing any other processing.

It only applies to a specific linker, ld64. If clang, or other linkers are interpreting this file then some might have other conventions. For example, clang will directly interpret the list with @, but if the file is sent to the linker via an -Xlinker flag then the linker will read the file. It is currently unknown what binutils ld, and lld-link.exe will do in these cases.

[bkhouri]

Fixed in #768

[bkhouri]

the TestDiscoverTests.nonStandardName tests fails on macOS when run against the SwiftBuilld backend.

15:11:08  ✘ Test nonStandardName(_:) recorded an issue with 1 argument buildSystem → .swiftbuild at TestDiscoveryTests.swift:90:13: Expectation failed: (stderr → "Building for debugging...
15:11:08  [0/100] Computing dependencies
15:11:08  [0/100] Constructing description
15:11:08  [0/100] Pre-planning 1 / 66
15:11:08  [0/100] Planning deferred tasks
15:11:08  [50/100] hello world 21 / 42
15:11:08  [52/100] hello world 24 / 45
15:11:08  [71/100] hello world 32 / 45
15:11:08  [78/100] hello world tests-product 36 / 46
15:11:08  [78/100] hello world tests-product 39 / 49
15:11:08  [89/100] hello world tests-product 44 / 49
15:11:08  [91/100] hello world tests-product 45 / 49
15:11:08  error: /private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello world.eJoQ2X/Miscellaneous_TestDiscovery_hello world/Package.swift No such file or directory: '/private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello'
15:11:08  error: /private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello world.eJoQ2X/Miscellaneous_TestDiscovery_hello world/Package.swift No such file or directory: 'world.eJoQ2X/Miscellaneous_TestDiscovery_hello'
15:11:08  error: /private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello world.eJoQ2X/Miscellaneous_TestDiscovery_hello world/Package.swift No such file or directory: 'world/.build/x86_64-apple-macosx/Intermediates.noindex/hello'
15:11:08  error: /private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello world.eJoQ2X/Miscellaneous_TestDiscovery_hello world/Package.swift No such file or directory: 'world.build/Debug/hello'
15:11:08  error: /private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello world.eJoQ2X/Miscellaneous_TestDiscovery_hello world/Package.swift No such file or directory: 'world'
15:11:08  error: /private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello world.eJoQ2X/Miscellaneous_TestDiscovery_hello world/Package.swift No such file or directory: 'tests.build/Objects-normal/x86_64/test_entry_point.o'
15:11:08  error: /private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello world.eJoQ2X/Miscellaneous_TestDiscovery_hello world/Package.swift No such file or directory: '/private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello'
15:11:08  error: /private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello world.eJoQ2X/Miscellaneous_TestDiscovery_hello world/Package.swift No such file or directory: 'world.eJoQ2X/Miscellaneous_TestDiscovery_hello'
15:11:08  error: /private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello world.eJoQ2X/Miscellaneous_TestDiscovery_hello world/Package.swift No such file or directory: 'world/.build/x86_64-apple-macosx/Intermediates.noindex/hello'
15:11:08  error: /private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello world.eJoQ2X/Miscellaneous_TestDiscovery_hello world/Package.swift No such file or directory: 'world.build/Debug/hello'
15:11:08  error: /private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello world.eJoQ2X/Miscellaneous_TestDiscovery_hello world/Package.swift No such file or directory: 'world'
15:11:08  error: /private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello world.eJoQ2X/Miscellaneous_TestDiscovery_hello world/Package.swift No such file or directory: 'tests.build/Objects-normal/x86_64/hello'
15:11:08  error: /private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello world.eJoQ2X/Miscellaneous_TestDiscovery_hello world/Package.swift No such file or directory: 'world'
15:11:08  error: /private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello world.eJoQ2X/Miscellaneous_TestDiscovery_hello world/Package.swift No such file or directory: 'tests.o'
15:11:08  error: /private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello world.eJoQ2X/Miscellaneous_TestDiscovery_hello world/Package.swift No such file or directory: '/private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello'
15:11:08  error: /private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello world.eJoQ2X/Miscellaneous_TestDiscovery_hello world/Package.swift No such file or directory: 'world.eJoQ2X/Miscellaneous_TestDiscovery_hello'
15:11:08  error: /private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello world.eJoQ2X/Miscellaneous_TestDiscovery_hello world/Package.swift No such file or directory: 'world/.build/x86_64-apple-macosx/Products/Debug/hello'
15:11:08  error: /private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello world.eJoQ2X/Miscellaneous_TestDiscovery_hello world/Package.swift No such file or directory: 'world.o'
15:11:08  error: Ld /private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello\ world.eJoQ2X/Miscellaneous_TestDiscovery_hello\ world/.build/x86_64-apple-macosx/Products/Debug/hello\ world\ tests.xctest/Contents/MacOS/hello\ world\ tests normal failed with a nonzero exit code. Command line:     cd /private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello\ world.eJoQ2X/Miscellaneous_TestDiscovery_hello\ world
15:13:29      /Users/ec2-user/jenkins/workspace/swift-package-manager-with-xcode-self-hosted-PR-osx-release-toolchain/branch-main/latest_toolchain.xctoolchain/usr/bin/swiftc -Xlinker -reproducible -target x86_64-apple-macos13.0 -Xlinker -bundle -sdk /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX15.2.sdk -L/private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello\ world.eJoQ2X/Miscellaneous_TestDiscovery_hello\ world/.build/x86_64-apple-macosx/Intermediates.noindex/EagerLinkingTBDs/Debug -L/private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello\ world.eJoQ2X/Miscellaneous_TestDiscovery_hello\ world/.build/x86_64-apple-macosx/Products/Debug -L/Users/ec2-user/jenkins/workspace/swift-package-manager-with-xcode-self-hosted-PR-osx-release-toolchain/branch-main/latest_toolchain/usr/lib -L/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/usr/lib -L/Users/ec2-user/jenkins/workspace/swift-package-manager-with-xcode-self-hosted-PR-osx-release-toolchain/branch-main/latest_toolchain.xctoolchain/usr/lib/swift/macosx/testing -F/private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello\ world.eJoQ2X/Miscellaneous_TestDiscovery_hello\ world/.build/x86_64-apple-macosx/Intermediates.noindex/EagerLinkingTBDs/Debug -F/private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello\ world.eJoQ2X/Miscellaneous_TestDiscovery_hello\ world/.build/x86_64-apple-macosx/Products/Debug/PackageFrameworks -F/private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello\ world.eJoQ2X/Miscellaneous_TestDiscovery_hello\ world/.build/x86_64-apple-macosx/Products/Debug -Fsystem /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/Library/Frameworks @/private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello\ world.eJoQ2X/Miscellaneous_TestDiscovery_hello\ world/.build/x86_64-apple-macosx/Intermediates.noindex/hello\ world.build/Debug/hello\ world\ tests.build/Objects-normal/x86_64/hello\ world\ tests.LinkFileList -Xlinker -rpath -Xlinker /usr/lib/swift -Xlinker -rpath -Xlinker @loader_path -Xlinker -rpath -Xlinker @loader_path/Frameworks -Xlinker -rpath -Xlinker @loader_path/../Frameworks -Xlinker -rpath -Xlinker /private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello\ world.eJoQ2X/Miscellaneous_TestDiscovery_hello\ world/.build/x86_64-apple-macosx/Products/Debug/PackageFrameworks -Xlinker -dead_strip -Xlinker -object_path_lto -Xlinker /private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello\ world.eJoQ2X/Miscellaneous_TestDiscovery_hello\ world/.build/x86_64-apple-macosx/Intermediates.noindex/hello\ world.build/Debug/hello\ world\ tests.build/Objects-normal/x86_64/hello\ world\ tests_lto.o -Xclang-linker -rdynamic -Xlinker -no_deduplicate -Xlinker -dependency_info -Xlinker /private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello\ world.eJoQ2X/Miscellaneous_TestDiscovery_hello\ world/.build/x86_64-apple-macosx/Intermediates.noindex/hello\ world.build/Debug/hello\ world\ tests.build/Objects-normal/x86_64/hello\ world\ tests_dependency_info.dat -link-objc-runtime -L/Users/ec2-user/jenkins/workspace/swift-package-manager-with-xcode-self-hosted-PR-osx-release-toolchain/branch-main/latest_toolchain.xctoolchain/usr/lib/swift/macosx -L/usr/lib/swift -Xlinker -add_ast_path -Xlinker /private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello\ world.eJoQ2X/Miscellaneous_TestDiscovery_hello\ world/.build/x86_64-apple-macosx/Intermediates.noindex/hello\ world.build/Debug/hello\ world\ tests.build/Objects-normal/x86_64/hello_world_tests.swiftmodule -Xlinker -needed_framework -Xlinker XCTest -framework XCTest -Xlinker -needed-lXCTestSwiftSupport -lXCTestSwiftSupport -o /private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello\ world.eJoQ2X/Miscellaneous_TestDiscovery_hello\ world/.build/x86_64-apple-macosx/Products/Debug/hello\ world\ tests.xctest/Contents/MacOS/hello\ world\ tests -no-stdlib-rpath -Xlinker -add_ast_path -Xlinker /private/var/folders/bb/hcrjxg1s0b96pfst0ymhmp240000gn/T/Miscellaneous_TestDiscovery_hello\ world.eJoQ2X/Miscellaneous_TestDiscovery_hello\ world/.build/x86_64-apple-macosx/Intermediates.noindex/hello\ world.build/Debug/hello\ world.build/Objects-normal/x86_64/hello_world.swiftmodule
15:13:29  error: Build failed
15:13:29  error: fatalError
15:13:29  ").contains("Build complete!")