Ship Swift Atomics 1.1

[lorentey]

Candidate commit: 6c89474

Diff: 1.0.3...main

• Review CMake configuration for missed source files
• Review diffs for stray changes
• Update copyright year in file headers (Update file headers #80)
• Update README (Update README #84)
• Draft release notes (https://github.com/apple/swift-atomics/releases/edit/untagged-c8b1096f1bc33e48b11f)
• Announce new release on the forum

Testing progress: (On Mac and Linux, this is done by running Utilities/run-full-tests.sh. This script builds and tests this package using various build systems and build configurations.)

macOS/AS

• macOS 13.3, Apple Silicon, Xcode 14.3, Swift main (swift.org developer snapshot as of 2023-03-30)
• macOS 13.3, Apple Silicon, Xcode 14.3, Swift 5.9 (swift.org developer snapshot as of 2023-03-30)
• macOS 13.3, Apple Silicon, Xcode 14.3, Swift 5.8
• macOS 13.3, Apple Silicon, Xcode 14.2, Swift 5.7.2
• macOS 13.3, Apple Silicon, Xcode 13.4.1, Swift 5.6.1

macOS/x86_64

• macOS 13.3, x86_64 (Rosetta), Xcode 14.3, Swift main (swift.org developer snapshot as of 2023-03-30)
• macOS 13.3, x86_64 (Rosetta), Xcode 14.3, Swift 5.9 (swift.org developer snapshot as of 2023-03-30)
• macOS 13.3, x86_64 (Rosetta), Xcode 14.3, Swift 5.8
• macOS 13.3, x86_64 (Rosetta), Xcode 14.2, Swift 5.7.2
• macOS 13.3, x86_64 (Rosetta), Xcode 13.4.1, Swift 5.6.1
• macOS 13.3, x86_64, Xcode 14.3, Swift main (swift.org developer snapshot as of 2023-03-30) (skipped)
• macOS 13.3, x86_64, Xcode 14.3, Swift 5.9 (swift.org developer snapshot as of 2023-03-30) (skipped)
• macOS 13.3, x86_64, Xcode 14.3, Swift 5.8
• macOS 13.3, x86_64, Xcode 14.2, Swift 5.7.2
• macOS 12.5, x86_64, Xcode 13.4.1, Swift 5.6.1

Linux/Aarch64

• Ubuntu 20.04, Aarch64, Swift main nightly build as of 2023-03-30
• Ubuntu 20.04, Aarch64, Swift 5.9 nightly build as of 2023-03-30
• Ubuntu 20.04, Aarch64, Swift 5.8 release
• Ubuntu 20.04, Aarch64, Swift 5.7.3 release
• Ubuntu 20.04, Aarch64, Swift 5.6.3 release

Linux/x86_64

• Ubuntu 22.04, x86_64, Swift main nightly build as of 2023-03-30 (skipped)
• Ubuntu 22.04, x86_64, Swift 5.9 nightly build as of 2023-03-30 (skipped)
• Ubuntu 22.04, x86_64, Swift 5.8 release
• Ubuntu 22.04, x86_64, Swift 5.7.3 release
• Ubuntu 20.04, x86_64, Swift 5.6.3 release

Windows 11/x86_64 (experimental)

• Windows 11, x86_64, Swift main nightly build as of 2023-03-28
• Windows 11, x86_64, Swift 5.8 release
• Windows 11, x86_64, Swift 5.7.3 release (sincere thanks to @stevapple)
• Windows 11, x86_64, Swift 5.6.3 release

Note: Swift 5.8 has not shipped yet; I'll hold testing that for now.

[lorentey]

Building using xcodebuild with library evolution enabled currently breaks due to #54, under Swift 5.7.1 (and 5.8). We will have to live with this for now.

[22 xcodebuild.library-evolution] xcodebuild -scheme swift-atomics -destination generic/platform=macOS -destination generic/platform=iOS BUILD_LIBRARY_FOR_DISTRIBUTION=YES

/Users/lorentey/Library/Developer/Xcode/DerivedData/swift-atomics-ceuvqitsfiwgtwejiuxxrfrjfari/Build/Intermediates.noindex/swift-atomics.build/Debug-iphoneos/AtomicsTests.build/Objects-normal/arm64/AtomicsTests.private.swiftinterface:4:8: error: missing required module '_AtomicsShims'
import Atomics
       ^
/Users/lorentey/Library/Developer/Xcode/DerivedData/swift-atomics-ceuvqitsfiwgtwejiuxxrfrjfari/Build/Intermediates.noindex/swift-atomics.build/Debug-iphoneos/AtomicsTests.build/Objects-normal/arm64/AtomicsTests.private.swiftinterface:1:1: error: failed to verify module interface of 'AtomicsTests' due to the errors above; the textual interface may be broken by project issues or a compiler bug
// swift-interface-format-version: 1.0
^

[lorentey]

TSan tests are failing on Ubuntu with signal 9. I'm ignoring this.

[lorentey]

xcodebuild.test.macCatalyst is failing with 5.6.1 under macOS due to an Xcode issue with test bundles and code signing on Mac Catalyst. This is a known problem that only affects arm64 builds. Ignoring.

  		xctest (21578) encountered an error (Failed to load the test bundle. If you believe this error represents a bug, please attach the result bundle at /tmp/run-full-tests.sh.1BHWc/xcodebuild/Logs/Test/Test-swift-atomics-2023.03.31_17-16-10--0700.xcresult. (Underlying Error: The bundle “AtomicsTests” couldn’t be loaded. The bundle couldn’t be loaded. Try reinstalling the bundle. dlopen(/tmp/run-full-tests.sh.1BHWc/xcodebuild/Build/Products/Release-maccatalyst/AtomicsTests.xctest/Contents/MacOS/AtomicsTests, 0x0109): tried: '/tmp/run-full-tests.sh.1BHWc/xcodebuild/Build/Products/Release-maccatalyst/AtomicsTests' (no such file), '/System/iOSSupport/tmp/run-full-tests.sh.1BHWc/xcodebuild/Build/Products/Release-maccatalyst/AtomicsTests.xctest/Contents/MacOS/AtomicsTests' (no such file), '/System/Volumes/Preboot/Cryptexes/OS/System/iOSSupport/tmp/run-full-tests.sh.1BHWc/xcodebuild/Build/Products/Release-maccatalyst/AtomicsTests.xctest/Contents/MacOS/AtomicsTests' (no such file), '/System/iOSSupport/tmp/run-full-tests.sh.1BHWc/xcodebuild/Build/Products/Release-maccatalyst/AtomicsTests.xctest/Contents/MacOS/AtomicsTests' (no such file), '/tmp/run-full-tests.sh.1BHWc/xcodebuild/Build/Products/Release-maccatalyst/AtomicsTests.xctest/Contents/MacOS/AtomicsTests' (code signature in <79432E30-443D-3FCD-92F6-CCEE25F4D743> '/private/tmp/run-full-tests.sh.1BHWc/xcodebuild/Build/Products/Release-maccatalyst/AtomicsTests.xctest/Contents/MacOS/AtomicsTests' not valid for use in process: Trying to load an unsigned library), '/System/Volumes/Preboot/Cryptexes/OS/tmp/run-full-tests.sh.1BHWc/xcodebuild/Build/Products/Release-maccatalyst/AtomicsTests.xctest/Contents/MacOS/AtomicsTests' (no such file), '/tmp/run-full-tests.sh.1BHWc/xcodebuild/Build/Products/Release-maccatalyst/AtomicsTests.xctest/Contents/MacOS/AtomicsTests' (code signature in <79432E30-443D-3FCD-92F6-CCEE25F4D743> '/private/tmp/run-full-tests.sh.1BHWc/xcodebuild/Build/Products/Release-maccatalyst/AtomicsTests.xctest/Contents/MacOS/AtomicsTests' not valid for use in process: Trying to load an unsigned library), '/tmp/run-full-tests.sh.1BHWc/xcodebuild/Build/Products/Release-maccatalyst/AtomicsTests' (no such file), '/System/iOSSupport/private/tmp/run-full-tests.sh.1BHWc/xcodebuild/Build/Products/Release-maccatalyst/AtomicsTests.xctest/Contents/MacOS/AtomicsTests' (no such file), '/System/Volumes/Preboot/Cryptexes/OS/System/iOSSupport/private/tmp/run-full-tests.sh.1BHWc/xcodebuild/Build/Products/Release-maccatalyst/AtomicsTests.xctest/Contents/MacOS/AtomicsTests' (no such file), '/System/iOSSupport/private/tmp/run-full-tests.sh.1BHWc/xcodebuild/Build/Products/Release-maccatalyst/AtomicsTests.xctest/Contents/MacOS/AtomicsTests' (no such file), '/private/tmp/run-full-tests.sh.1BHWc/xcodebuild/Build/Products/Release-maccatalyst/AtomicsTests.xctest/Contents/MacOS/AtomicsTests' (code signature in <79432E30-443D-3FCD-92F6-CCEE25F4D743> '/private/tmp/run-full-tests.sh.1BHWc/xcodebuild/Build/Products/Release-maccatalyst/AtomicsTests.xctest/Contents/MacOS/AtomicsTests' not valid for use in process: Trying to load an unsigned library), '/System/Volumes/Preboot/Cryptexes/OS/private/tmp/run-full-tests.sh.1BHWc/xcodebuild/Build/Products/Release-maccatalyst/AtomicsTests.xctest/Contents/MacOS/AtomicsTests' (no such file), '/private/tmp/run-full-tests.sh.1BHWc/xcodebuild/Build/Products/Release-maccatalyst/AtomicsTests.xctest/Contents/MacOS/AtomicsTests' (code signature in <79432E30-443D-3FCD-92F6-CCEE25F4D743> '/private/tmp/run-full-tests.sh.1BHWc/xcodebuild/Build/Products/Release-maccatalyst/AtomicsTests.xctest/Contents/MacOS/AtomicsTests' not valid for use in process: Trying to load an unsigned library)))

[lorentey]

Evidently Swift Atomics has been quietly failing on Windows since forever.

(#56, swiftlang/swift#60534, swiftlang/swift-installer-scripts#144)

My own Windows testing is blocked on elementary problems with Swift packages on my Windows box that I don't really have time or energy to investigate.

<unknown>:0: error: missing required module 'SwiftShims'

[lorentey]

Ah, reinstalling VS2019 & Swift 5.9 restored SwiftPM to working order. Windows platform support continues to be blocked on #56. Ignoring.

[stevapple]

Ah, reinstalling VS2019 & Swift 5.9 restored SwiftPM to working order. Windows platform support continues to be blocked on #56. Ignoring.

Windows support for Swift Atomics 1.0.x did work with VS 2022, but I’m not sure if 1.1 breaks it again.

We’ll try to solve the problem in main, and then back port it to 5.8/5.9. The workaround continues to make sense.

[lorentey]

I got further! My steps, for posterity:

1. Carefully read the Getting Started instructions at https://www.swift.org/getting-started/#on-windows. Then sigh and forget them.

2. Install VS 2022 with the following incantation:

   curl -sOL https://aka.ms/vs/17/release/vs_community.exe
   start /w vs_community.exe --passive --wait --norestart --nocache --installPath "%ProgramFiles(x86)%\Microsoft Visual Studio\2022\Community" --add Microsoft.VisualStudio.Component.Windows10SDK.19041 --add Microsoft.VisualStudio.Component.VC.Tools.x86.x64
   del /q vs_community.exe
   

3. Download and install swift 5.8 from swift.org.

4. Add a random symlink: (This isn't necessary with VS2022)

   cd \Library\Developer\Toolchains\unknown-Asserts-development.xctoolchain\usr\lib\swift
   mklink /D clang ..\clang\15.0.0
   

swift build in a local clone of swift-atomics will now progress to:

C:\Users\Karoy Lorentey\Documents\swift-atomics>swift --version
compnerd.org Swift version 5.8 (swift-5.8-RELEASE)
Target: x86_64-unknown-windows-msvc

C:\Users\Karoy Lorentey\Documents\swift-atomics>swift build
Building for debugging...
error: emit-module command failed due to exception 3 (use -v to see invocation)
error: failed parsing the Swift compiler output: unexpected JSON message: : dataCorrupted(Swift.DecodingError.Context(codingPath: [CodingKeys(stringValue: "kind", intValue: nil)], debugDescription: "invalid kind", underlyingError: nil))

This happens both on main and the 1.0.3 tag, so I won't delay the 1.1.0 release because of it.

[stevapple]

C:\Users\Karoy Lorentey\Documents\swift-atomics>swift build
Building for debugging...
error: emit-module command failed due to exception 3 (use -v to see invocation)
error: failed parsing the Swift compiler output: unexpected JSON message: : dataCorrupted(Swift.DecodingError.Context(codingPath: [CodingKeys(stringValue: "kind", intValue: nil)], debugDescription: "invalid kind", underlyingError: nil))

Interesting… What about swift build -v? I’d like to inspect the failing command line.

[lorentey]

Here goes!

C:\Library\Developer\Toolchains\unknown-Asserts-development.xctoolchain\usr\bin\swift-frontend.exe -frontend -emit-module -experimental-skip-non-inlinable-function-bodies-without-types C:\Users\Karoy Lorentey\Documents\swift-atomics\Sources\Atomics\AtomicInteger.swift C:\Users\Karoy Lorentey\Documents\swift-atomics\Sources\Atomics\AtomicMemoryOrderings.swift C:\Users\Karoy Lorentey\Documents\swift-atomics\Sources\Atomics\AtomicOptional.swift C:\Users\Karoy Lorentey\Documents\swift-atomics\Sources\Atomics\AtomicRawRepresentable.swift C:\Users\Karoy Lorentey\Documents\swift-atomics\Sources\Atomics\AtomicStrongReference.swift C:\Users\Karoy Lorentey\Documents\swift-atomics\Sources\Atomics\AtomicValue.swift C:\Users\Karoy Lorentey\Documents\swift-atomics\Sources\Atomics\DoubleWord.swift C:\Users\Karoy Lorentey\Documents\swift-atomics\Sources\Atomics\autogenerated\AtomicBool.swift C:\Users\Karoy Lorentey\Documents\swift-atomics\Sources\Atomics\autogenerated\AtomicLazyReference.swift C:\Users\Karoy Lorentey\Documents\swift-atomics\Sources\Atomics\autogenerated\HighLevelTypes.swift C:\Users\Karoy Lorentey\Documents\swift-atomics\Sources\Atomics\autogenerated\IntegerConformances.swift C:\Users\Karoy Lorentey\Documents\swift-atomics\Sources\Atomics\autogenerated\PointerConformances.swift -target x86_64-unknown-windows-msvc -disable-objc-interop -sdk C:\Library\Developer\Platforms\Windows.platform\Developer\SDKs\Windows.sdk -I C:\Users\Karoy Lorentey\Documents\swift-atomics\.build\x86_64-unknown-windows-msvc\debug -I C:\Library\Developer\Platforms\Windows.platform\Developer\Library\XCTest-development\usr\lib\swift\windows -I C:\Library\Developer\Platforms\Windows.platform\Developer\Library\XCTest-development\usr\lib\swift\windows\x86_64 -color-diagnostics -enable-testing -g -module-cache-path C:\Users\Karoy Lorentey\Documents\swift-atomics\.build\x86_64-unknown-windows-msvc\debug\ModuleCache -swift-version 5 -Onone -D SWIFT_PACKAGE -D DEBUG -empty-abi-descriptor -resource-dir C:\Library\Developer\Toolchains\unknown-Asserts-development.xctoolchain\usr\lib\swift -enable-anonymous-context-mangled-names -Xcc -fmodule-map-file=C:\Users\Karoy Lorentey\Documents\swift-atomics\Sources\_AtomicsShims\include\module.modulemap -Xcc -I -Xcc C:\Users\Karoy Lorentey\Documents\swift-atomics\Sources\_AtomicsShims\include -module-name Atomics -emit-module-doc-path C:\Users\Karoy Lorentey\Documents\swift-atomics\.build\x86_64-unknown-windows-msvc\debug\Atomics.swiftdoc -emit-module-source-info-path C:\Users\Karoy Lorentey\Documents\swift-atomics\.build\x86_64-unknown-windows-msvc\debug\Atomics.swiftsourceinfo -emit-dependencies-path C:\Users\Karoy Lorentey\Documents\swift-atomics\.build\x86_64-unknown-windows-msvc\debug\Atomics.build\Atomics.emit-module.d -parse-as-library -o C:\Users\Karoy Lorentey\Documents\swift-atomics\.build\x86_64-unknown-windows-msvc\debug\Atomics.swiftmodule
error: compile command failed due to exception 3 (use -v to see invocation)
error: failed parsing the Swift compiler output: unexpected JSON message: : dataCorrupted(Swift.DecodingError.Context(codingPath: [CodingKeys(stringValue: "kind", intValue: nil)], debugDescription: "invalid kind", underlyingError: nil))

[stevapple]

I cannot reproduce it with Swift 5.7.3🤔️ With VS 17.5.3 and Swift 5.7.3, you don’t even need the mklink workaround to build Atomics.

I suspect this could be some Swift 5.8 regression. -experimental-skip-non-inlinable-function-bodies-without-types is the most suspicious, and I didn’t notice it with Swift 5.7.

[lorentey]

Huh. I also see this error with 5.7.3, so presumably something is messed up on my end.

Can I delegate the testing to you? 🙈 Do these pass for you on 5.7.3?

swift test -c debug
swift test -c release

The need for custom installation steps will preclude Windows from being a supported platform, but it would be good to know if the underlying code will eventually work!

[lorentey]

Hm, xcodebuild.build.watchOS-simulator is failing on Xcode 14.3 (Swift 5.8). Apparently the generic/platform=watchOS Simulator destination still tries to build i386 code, but predictably Xcode doesn't ship an XCTest overlay for it.

xcrun xcodebuild -scheme swift-atomics -configuration Release -destination generic/platform=watchOS Simulator -derivedDataPath /tmp/run-full-tests.sh.s6EQf/xcodebuild build

...
Ld /tmp/run-full-tests.sh.s6EQf/xcodebuild/Build/Intermediates.noindex/swift-atomics.build/Release-watchsimulator/AtomicsTests.build/Objects-normal/i386/Binary/AtomicsTests normal i386 (in target 'AtomicsTests' from project 'swift-atomics')
    cd /Users/lorentey/Git/swift-atomics
    /Applications/Xcode-MAS.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/clang -Xlinker -reproducible -target i386-apple-watchos4.0-simulator -bundle -isysroot /Applications/Xcode-MAS.app/Contents/Developer/Platforms/WatchSimulator.platform/Developer/SDKs/WatchSimulator9.4.sdk -L/tmp/run-full-tests.sh.s6EQf/xcodebuild/Build/Intermediates.noindex/EagerLinkingTBDs/Release-watchsimulator -L/tmp/run-full-tests.sh.s6EQf/xcodebuild/Build/Products/Release-watchsimulator -L/Applications/Xcode-MAS.app/Contents/Developer/Platforms/WatchSimulator.platform/Developer/usr/lib -F/tmp/run-full-tests.sh.s6EQf/xcodebuild/Build/Intermediates.noindex/EagerLinkingTBDs/Release-watchsimulator -F/tmp/run-full-tests.sh.s6EQf/xcodebuild/Build/Products/Release-watchsimulator/PackageFrameworks -F/tmp/run-full-tests.sh.s6EQf/xcodebuild/Build/Products/Release-watchsimulator/PackageFrameworks -F/tmp/run-full-tests.sh.s6EQf/xcodebuild/Build/Products/Release-watchsimulator -iframework /Applications/Xcode-MAS.app/Contents/Developer/Platforms/WatchSimulator.platform/Developer/Library/Frameworks -iframework /Applications/Xcode-MAS.app/Contents/Developer/Platforms/WatchSimulator.platform/Developer/SDKs/WatchSimulator9.4.sdk/Developer/Library/Frameworks -filelist /tmp/run-full-tests.sh.s6EQf/xcodebuild/Build/Intermediates.noindex/swift-atomics.build/Release-watchsimulator/AtomicsTests.build/Objects-normal/i386/AtomicsTests.LinkFileList -Xlinker -rpath -Xlinker /usr/lib/swift -Xlinker -rpath -Xlinker @loader_path/Frameworks -Xlinker -rpath -Xlinker @loader_path/../Frameworks -Xlinker -rpath -Xlinker @loader_path/Frameworks -dead_strip -Xlinker -object_path_lto -Xlinker /tmp/run-full-tests.sh.s6EQf/xcodebuild/Build/Intermediates.noindex/swift-atomics.build/Release-watchsimulator/AtomicsTests.build/Objects-normal/i386/AtomicsTests_lto.o -Xlinker -objc_abi_version -Xlinker 2 -fobjc-link-runtime -L/Applications/Xcode-MAS.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/swift/watchsimulator -L/usr/lib/swift -Xlinker -add_ast_path -Xlinker /tmp/run-full-tests.sh.s6EQf/xcodebuild/Build/Intermediates.noindex/swift-atomics.build/Release-watchsimulator/AtomicsTests.build/Objects-normal/i386/AtomicsTests.swiftmodule -framework XCTest -Xlinker -no_adhoc_codesign -Xlinker -dependency_info -Xlinker /tmp/run-full-tests.sh.s6EQf/xcodebuild/Build/Intermediates.noindex/swift-atomics.build/Release-watchsimulator/AtomicsTests.build/Objects-normal/i386/AtomicsTests_dependency_info.dat -o /tmp/run-full-tests.sh.s6EQf/xcodebuild/Build/Intermediates.noindex/swift-atomics.build/Release-watchsimulator/AtomicsTests.build/Objects-normal/i386/Binary/AtomicsTests -Xlinker -add_ast_path -Xlinker /tmp/run-full-tests.sh.s6EQf/xcodebuild/Build/Intermediates.noindex/swift-atomics.build/Release-watchsimulator/Atomics.build/Objects-normal/i386/Atomics.swiftmodule
ld: warning: ignoring file /Applications/Xcode-MAS.app/Contents/Developer/Platforms/WatchSimulator.platform/Developer/Library/Frameworks/XCTest.framework/XCTest, file is universal (x86_64,arm64) but does not contain the i386 architecture: /Applications/Xcode-MAS.app/Contents/Developer/Platforms/WatchSimulator.platform/Developer/Library/Frameworks/XCTest.framework/XCTest
ld: warning: Could not find or use auto-linked library 'XCTestSwiftSupport'
Undefined symbols for architecture i386:
[...]

This is an Xcode issue (or perhaps a problem in the test script). Ignoring.