Compare commits

...
Author SHA1 Message Date
Guillaume Lessard a34201439c Merge pull request #220 from glessard/1.4.2
[1.4.x] Support for FreeBSD and OpenBSD
2025-02-18 15:35:23 -08:00
Guillaume Lessard 12573bfb88 Merge branch 'main' into 1.4.2 2025-02-17 17:03:43 -08:00
Guillaume Lessard 3a1b4a8e05 Merge pull request #219 from glessard/1.4.1
[1.4.x] Use GetTempPathW for better compatibility
2025-02-17 14:04:33 -08:00
Guillaume Lessard d9b03016dc Merge pull request #218 from glessard/1.4.1
[1.4.x] Use GetTempPathW for better compatibility
2025-02-17 11:52:53 -08:00
xuty f18ed75481 Use GetTempPathW for better compatibility 2025-02-17 11:43:11 -08:00
Guillaume Lessard b1b7b60a55 Merge pull request #215 from 3405691582/openbsd
OpenBSD support.
2025-02-10 14:41:18 -08:00
Guillaume Lessard 2228d64644 Merge pull request #213 from Steelskin/fabrice/cmake-install-paths
[cmake] Install libraries in standard directories
2025-02-07 11:00:22 -08:00
3405691582 3b053e055b ManagedBuffer.capacity is unavailable on OpenBSD.
`.capacity` is backed by malloc introspection (`malloc_size`), which is
not available on all platforms. The workaround is straightforward here,
thankfully: instead, use the minimum capacity already specified.
2025-02-04 19:44:35 -05:00
3405691582 90702d6d15 Typealias system_DIRPtr for OpenBSD. 2025-02-04 19:44:32 -05:00
Guillaume Lessard 849d005b2b Merge pull request #211 from ShaftUI/temp-path-w
[Windows] Use GetTempPathW in _getTemporaryDirectory for better compatibility
2025-01-30 15:00:27 -08:00
Guillaume Lessard 8790e47013 Merge pull request #214 from michael-yuji/freebsd-wip
Add FreeBSD errno and open options
2025-01-29 15:50:13 -08:00
Guillaume Lessard f27874d762 Merge pull request #209 from ADKaster/install-interface
CSystem: Set build and install interfaces on included headers
2025-01-28 13:49:12 -08:00
Michael Chiu df7341ee2b fix cmake x86_64 build 2025-01-26 21:29:19 -08:00
Michael Chiu 4d735a6631 Add FreeBSD errnos and open options 2025-01-26 21:29:13 -08:00
Fabrice de Gans bebd7c146e [cmake] Install libraries in standard directories
Previously, libs were installed under `lib/swift/${os}`. They should be
installed in the default library directory for the relevant target
system.
In addition, swiftmodules were installed in the older layout format.
This changes to use the standard modern layout format for swiftmodules.
2025-01-23 11:45:17 -08:00
michael-yuji 4fa2a719c5 Merge pull request #212 from michael-yuji/freebsd-wip
Guard errnos not available on FreeBSD
2025-01-17 21:52:07 -08:00
Michael Chiu 0d824eee86 refactor ifdef in test 2025-01-17 15:06:28 -08:00
Michael Chiu eb566de2d3 Fix tests on FreeBSD 2025-01-17 14:43:40 -08:00
Michael Chiu a4fb6cb206 Keep order consistent 2025-01-17 14:43:34 -08:00
Michael Chiu 7e73a336fb Guard errnos not available on FreeBSD 2025-01-17 14:30:51 -08:00
xuty 85b83fddb1 Use GetTempPathW for better compatibility 2024-12-17 15:13:15 +08:00
Guillaume Lessard 61a2af5e8b Merge pull request #210 from ADKaster/remove-nbsp
Internals: Remove non-breaking spaces from Windows syscall adapter
2024-11-22 19:38:54 -05:00
Andrew Kaster eb3b1fa54b Internals: Remove non-breaking spaces from Windows syscall adapter
This was causing a warning with Swift 6.0.2
2024-11-21 15:03:28 -07:00
Andrew Kaster f1393b76f3 CSystem: Set build and install interfaces on included headers 2024-11-21 14:48:57 -07:00
Guillaume Lessard fbd61a676d Merge pull request #207 from glessard/merge-1.4.0-into-main
Merge 1.4.0 into main
2024-10-18 22:39:45 -07:00
Guillaume Lessard f21f6a8866 Merge branch 'release/1.4.0' into merge-1.4.0-into-main
# Conflicts:
#	.gitignore
#	.swiftci/5_10_ubuntu2204
#	.swiftci/5_8_ubuntu2204
#	.swiftci/5_9_ubuntu2204
#	.swiftci/nightly_6_0_macos
#	.swiftci/nightly_6_0_ubuntu2204
#	.swiftci/nightly_main_macos
#	.swiftci/nightly_main_ubuntu2204
#	.swiftci/nightly_main_windows
#	Package.swift
#	Sources/System/FileOperations.swift
#	Sources/System/FilePath/FilePath.swift
#	Sources/System/Internals/WindowsSyscallAdapters.swift
2024-10-17 17:24:38 -07:00
Guillaume Lessard c8a44d836f Merge pull request #206 from glessard/1.4.0-readme
[1.4.0] Updates to the README file
2024-10-17 16:12:10 -07:00
Guillaume Lessard b80d743dab Update README.md 2024-10-17 15:52:41 -07:00
Guillaume Lessard eeeb81d0cd [readme] update usage example, reword stability 2024-10-17 15:14:38 -07:00
Guillaume Lessard 234e15320e Merge pull request #204 from glessard/1.4.0-ci-adjustment
[1.4.0] Swift 5.8 is not supported on this branch
2024-10-17 15:01:46 -07:00
Guillaume Lessard 154cbf7c95 Merge pull request #205 from glessard/1.4.0-pipe-correction
[windows] expose pipe’s buffer size parameter
2024-10-17 14:57:49 -07:00
Guillaume Lessard 3f4e7cb45c [windows] expose pipe’s buffer size parameter 2024-10-17 14:31:37 -07:00
Guillaume Lessard 11d481252d [1.4.0] Updates to the README file 2024-10-17 13:17:08 -07:00
Guillaume Lessard 2e8f58ac41 [1.4.0] Swift 5.8 is not supported on this branch 2024-10-17 08:49:29 -07:00
Guillaume Lessard 5cd7eade6d Merge pull request #203 from glessard/systemstring-tweaks-1.4.0
[1.4.0] SystemString consistency improvements
2024-10-16 23:25:29 -07:00
Guillaume Lessard b2d4917ebe Update copyright notices 2024-10-16 23:09:09 -07:00
Guillaume Lessard d96435c72b Rename withSystemChars
- `withNullTerminatedSystemChars` makes it clear that the null-termination is included. Operations where the null-termination is included should be obvious.
2024-10-16 23:09:09 -07:00
Guillaume Lessard 95784d018f Fix behaviour of withCodeUnits()
- The original implementation includes a trailing zero with the full collection, but the implementation for a slice does not. As a result, given a `let s: SystemString`, `s.string` was not equal to `s[…].string`
2024-10-16 23:09:09 -07:00
Guillaume Lessard 448bef7c38 Test SystemString.string property consistency 2024-10-16 23:09:09 -07:00
Guillaume Lessard 69e737de3d Generate SystemString.string consistently
- SystemString.string and Slice<SystemString>.string should be generated in the same manner. Now they are.
2024-10-16 23:09:09 -07:00
Guillaume Lessard afeecb6c28 Merge pull request #201 from glessard/32-are-too-few-bits-1.4.0
[1.4.0] fix a 32-bit overflow issue
2024-10-16 18:30:16 -07:00
Guillaume Lessard 69eee996ac Merge pull request #202 from glessard/platform-support-1.4.0
[1.4.0] cherry-pick platform support changes
2024-10-16 18:29:59 -07:00
Finagolfin 209dfeacb8 Import new Android overlay
Use Bionic module instead where possible
2024-10-16 18:22:35 -07:00
Finagolfin b2b60a6b94 Android: DIR* is an OpaquePointer in Bionic too 2024-10-16 18:22:19 -07:00
Max Desiatov e11703d915 Add support for WASILibc module (#159)
Quoting the [wasi.dev landing page](https://wasi.dev):
> The WebAssembly System Interface (WASI) is a group of standard API specifications for software compiled to the W3C WebAssembly (Wasm) standard. WASI is designed to provide a secure standard interface for applications that can be compiled to Wasm from any language, and that may run anywhere—from browsers to clouds to embedded devices.

Currently support for WASI in Swift is based on [`wasi-libc`](https://github.com/WebAssembly/wasi-libc).

Adding support for `wasi-libc` mostly amounted to excluding unsupported errnos, adding TLS dictionary storage shim for single-threaded environment, and adding constants in C headers for macros that Clang importer currently doesn't support.

Co-authored-by: Guillaume Lessard <guillaume.lessard@apple.com>

# Conflicts:
#	Sources/System/FileOperations.swift
#	Sources/System/Internals/Syscalls.swift
2024-10-16 18:22:19 -07:00
Guillaume Lessard 8df901cb24 fix a 32-bit overflow issue
- ensures compatibility with watchOS
2024-10-16 17:57:36 -07:00
Guillaume Lessard 938fda53e2 Merge pull request #200 from glessard/private-aeic-init-removal-1.4.0
[1.4.0] backport #191
2024-10-16 17:41:50 -07:00
Guillaume Lessard e7ffa45882 Remove private-and-@_aEIC initializers
These were just passthroughs.
2024-10-16 17:38:24 -07:00
Guillaume Lessard 607542a559 Merge pull request #198 from glessard/1.4.0-backport-158&176 2024-10-16 17:28:28 -07:00
Guillaume Lessard b9e4d2b2ba Remove more accidentally public functions 2024-10-16 17:03:59 -07:00
Guillaume Lessard 473b493ab0 Merge pull request #199 from glessard/1.4.0-backport-193
Add support for macCatalyst
2024-10-16 14:15:25 -07:00
George Barnett 9eb1f34cbf Add support for macCatalyst
Building swift-system for macCatalyst fails as there is no import of the
Darwin module.

# Conflicts:
#	Package.swift
2024-10-16 14:00:47 -07:00
Guillaume Lessard 7a18b4bf34 Merge pull request #193 from glbrntt/mac-catalyst
Add support for macCatalyst
2024-10-16 13:57:03 -07:00
Alastair Houghton 6c64372b85 [Windows] Add a comment to explain the O_RDONLY/O_WRONLY/O_RDWR logic.
The values of these flags on Windows do not overlap, and more
particularly, `O_RDONLY` is actually zero on Windows, which means we
cannot test for it by AND-ing.
2024-10-14 16:01:01 -07:00
Alastair Houghton 3a4e2f8071 [Windows] Fix tests.
We need to use `@testable` when importing `SystemPackage` in order to
let us test the `internal` functions.

Also, use `NUL` instead of `/dev/null`, and generate random bytes in a
file instead of reading from `/dev/random`.
2024-10-14 16:01:01 -07:00
Alastair Houghton 53471ce33b [Windows] Fix a problem with opening files read only.
`_O_RDONLY` is zero, so we can't test for it by AND-ing.
2024-10-14 16:01:01 -07:00
Alastair Houghton f1d7eb52c6 Remove accidentally public functions.
These can't be new API as they haven't been reviewed.
2024-10-14 16:01:01 -07:00
Alastair Houghton cf7530848e [Linux] Glibc's DIR doesn't get imported into Swift.
Swift ends up with OpaquePointer instead of a typed pointer.

rdar://125087707
2024-10-14 15:59:36 -07:00
Alastair Houghton 5ae5d5a3af Refactor FilePathTemp, add tests for permission code.
Broke `FilePathTemp.swift` into separate files for POSIX and
Windows.

Added tests for permissions code on Windows.

Added leading underscores to some function names.

Made some other functions `fileprivate`.

rdar://125087707
2024-10-14 15:59:36 -07:00
Alastair HoughtonandKaroy Lorentey bcc7f6d569 Update Sources/System/FilePath/FilePathTemp.swift
Co-authored-by: Karoy Lorentey <klorentey@apple.com>
2024-10-14 15:59:36 -07:00
Alastair Houghton e293300430 Map mode bits to Windows ACLs.
This adds support for mapping POSIX-style mode bits to Windows ACLs when
calling `open()` or `mkdir()`.

rdar://125087707
2024-10-14 15:59:36 -07:00
Alastair Houghton 4cafcc96f6 Changes after comments from Saleem.
Use idiomatic Swift notation, not `Optional<Bool>`.

Prefer Win32 APIs to UCRT APIs.

rdar://125087707
2024-10-14 15:59:36 -07:00
Alastair Houghton 85de4e51e2 Use the proper temporary directory on Darwin.
It seems we can get the temporary directory from confstr().

rdar://125087707
2024-10-14 15:59:36 -07:00
Alastair Houghton d4e2b09c37 Fix swift-system to work on Windows.
The swift-system tests were not passing, for various reasons, mostly
to do with path related confusion.

As part of this, add a function to create a temporary directory, as that
was one of the problems.

Also add Windows support for pipe() and ftruncate(), which was missing.

rdar://125087707
2024-10-14 15:59:36 -07:00
Guillaume Lessard 5ea5b2e89a Merge pull request #197 from lorentey/merge-1.3.0→1.4.0
Merge release/1.3.0 to release/1.4.0
2024-10-14 11:02:40 -07:00
Karoy Lorentey 8564f96d1f Merge branch 'release/1.3.0' into release/1.4.0
# Conflicts:
#	.gitignore
#	.swiftci/5_10_ubuntu2204
#	.swiftci/5_8_ubuntu2204
#	.swiftci/5_9_ubuntu2204
#	.swiftci/nightly_6_0_macos
#	.swiftci/nightly_6_0_ubuntu2204
#	.swiftci/nightly_main_macos
#	.swiftci/nightly_main_ubuntu2204
#	.swiftci/nightly_main_windows
#	Package.swift
#	Sources/System/FilePath/FilePath.swift
#	Sources/System/Internals/CInterop.swift
2024-09-19 16:50:34 -07:00
Karoy Lorentey b85a788897 Merge pull request #196 from lorentey/metadata-updates
[1.4] Metadata updates
2024-09-19 15:31:34 -07:00
Karoy Lorentey 88a60e08b3 Update README
- Clarify swift-system’s stance on cross-platform abstractions. Stop using the term “multi-platform”.
- Expand source stability section.
- Add a section on our branching strategy.
- Link to the Code of Conduct document.
2024-09-19 13:01:48 -07:00
Karoy Lorentey 4c612a1e29 Bump required toolchain version to 5.9. Sanitize Package manifest
- Don’t define _CRT_SECURE_NO_WARNINGS outside Windows
- Let all targets share the same settings
2024-09-19 12:57:57 -07:00
Karoy Lorentey 603c451818 Add code of conduct 2024-09-19 12:49:08 -07:00
George Barnett 2662793bd6 Add support for macCatalyst
Building swift-system for macCatalyst fails as there is no import of the
Darwin module.
2024-08-19 10:20:12 +01:00
Guillaume Lessard d581098eeb Merge pull request #191 from glessard/private-aeic-init-removal
Remove private-and-@_aEIC initializers
2024-07-31 16:56:38 -07:00
Guillaume Lessard edbc9e4fdc Remove private-and-@_aEIC initializers
These were just passthroughs.
2024-07-31 16:30:25 -07:00
Guillaume Lessard d2ba781702 Merge pull request #190 from glessard/enforce-file-path-invariants-in-decode-1.3.x
Cherry-pick: ensure invariants are enforced when decoding
2024-07-23 12:42:13 -07:00
Stephen Canon a1f77d0e1a Cherry-pick: ensure invariants are enforced when decoding
Ensure that FilePath and SystemString's invariants are enforced when decoding.

Cherry-pick of merge-commit 9c42c54644
from PR #189

# Conflicts:
#	Sources/System/FilePath/FilePath.swift
2024-07-23 11:26:26 -07:00
Stephen Canon 9c42c54644 Merge pull request #189 from stephentyrone/enforce-file-path-invariants-in-decode
Ensure that FilePath and SystemString's invariants are enforced when …
2024-07-17 14:49:19 -04:00
Stephen Canon 3841a7531f Add some notes explaining what invariants are violated. 2024-07-17 13:49:15 -04:00
Stephen Canon 3b43b391b5 Add some comments and remove leftover WIP noise. 2024-07-17 12:49:37 -04:00
Stephen Canon c64775ef71 Another invariant to check 2024-07-17 12:25:34 -04:00
Stephen Canon 4c96faa6d8 Insure that FilePath and SystemString's invariants are enforced when decoding. 2024-07-17 12:14:43 -04:00
Guillaume Lessard 19e7f0fdd4 Merge pull request #187 from finagolfin/droid
Import new Android overlay
2024-07-08 17:20:28 -07:00
Finagolfin 02811ea6b4 Import new Android overlay
Use Bionic module instead where possible
2024-07-08 17:53:39 +05:30
Guillaume Lessard 2ce971a831 Merge pull request #155 from glessard/system-string-api-consistency
SystemString api consistency improvements
2024-07-05 14:26:21 -07:00
Guillaume Lessard 80788529b5 Merge pull request #170 from glessard/platform-flags
Make a platform-specific flag explicitly platform-specific
2024-07-05 14:24:12 -07:00
Guillaume Lessard 05fb1f1142 Merge pull request #178 from apple/dev/merge-1.3.0-back-to-main
[gardening] Merge the release/1.3.0 branch back into main
2024-07-03 16:22:44 -07:00
Guillaume Lessard 8d2dda76fa Merge pull request #186 from futurejones/add-riscv64-support
add support for riscv64
2024-06-18 16:21:38 -07:00
Neil Jones c1789e0525 add support for riscv64 2024-06-18 10:45:08 +09:00
Guillaume Lessard 6a9e38e7bd Merge pull request #185 from glessard/disfavoredOverload-1.3.0
[1.3.x] Disfavor String.init(platformString: UnsafePointer<CChar>)
2024-06-07 17:43:21 -07:00
Yuta Saito 848a927122 Merge pull request #184 from kateinoigakukun/katei/suppress-cmakelists-warning-1.4
[1.4] Suppress unhandled CMakeLists.txt warning by SwiftPM
2024-06-07 11:46:19 +09:00
Guillaume Lessard 2b30f8820c Merge pull request #183 from kateinoigakukun/katei/suppress-cmakelists-warning-1.3
[1.3] Suppress unhandled CMakeLists.txt warning by SwiftPM
2024-06-06 13:44:13 -07:00
Yuta Saito 318d2159d1 Merge pull request #182 from kateinoigakukun/katei/suppress-cmakelists-warning
Suppress unhandled CMakeLists.txt warning by SwiftPM
2024-06-06 03:08:41 +09:00
Yuta Saito 1a8d472f35 Suppress unhandled CMakeLists.txt warning by SwiftPM 2024-06-05 18:06:54 +00:00
Yuta Saito f9d6b48027 Suppress unhandled CMakeLists.txt warning by SwiftPM 2024-06-05 18:05:57 +00:00
Karoy Lorentey d82bccbb17 Merge pull request #164 from lorentey/retarget-to-1.4.0
Retarget pending changes to 1.4.0
2024-06-05 09:15:44 -07:00
Yuta Saito 9c17c8562d Suppress unhandled CMakeLists.txt warning by SwiftPM 2024-06-03 02:15:29 +00:00
Guillaume Lessard 0d6be7ac22 Merge branch 'release/1.3.0'
# Conflicts:
#	.gitignore
#	.swiftci/5_10_ubuntu2204
#	.swiftci/5_8_ubuntu2204
#	.swiftci/5_9_ubuntu2204
#	.swiftci/nightly_6_0_macos
#	.swiftci/nightly_6_0_ubuntu2204
#	.swiftci/nightly_main_macos
#	.swiftci/nightly_main_ubuntu2204
#	.swiftci/nightly_main_windows
#	Package.swift
#	Sources/System/Internals/CInterop.swift
#	Sources/System/Internals/Constants.swift
#	Sources/System/Internals/Exports.swift
#	Sources/System/Internals/Syscalls.swift
#	Tests/SystemTests/FileOperationsTest.swift
2024-05-16 11:51:10 -07:00
Karoy Lorentey f9266c8518 Merge pull request #177 from lorentey/fix-cmake
[1.3][CMake] Restore to working order on Apple platforms
2024-05-15 14:48:03 -07:00
Karoy Lorentey b7dc8e8e41 [CMake] Restore to working order on Apple platforms 2024-05-15 14:30:14 -07:00
Guillaume Lessard b642f54526 Merge pull request #175 from glessard/32-are-too-few-bits
fix a 32-bit overflow issue
2024-05-14 11:32:44 -07:00
Alastair Houghton 36987d6d37 Merge pull request #176 from al45tair/remove-unintended-public
Remove unintentional public functions and fix a couple of Windows issues.
2024-05-14 14:52:12 +01:00
Alastair Houghton 082adfe732 [Windows] Add a comment to explain the O_RDONLY/O_WRONLY/O_RDWR logic.
The values of these flags on Windows do not overlap, and more
particularly, `O_RDONLY` is actually zero on Windows, which means we
cannot test for it by AND-ing.
2024-05-14 14:42:57 +01:00
Alastair Houghton abc0a6d26f [Windows] Fix tests.
We need to use `@testable` when importing `SystemPackage` in order to
let us test the `internal` functions.

Also, use `NUL` instead of `/dev/null`, and generate random bytes in a
file instead of reading from `/dev/random`.
2024-05-13 15:13:31 +01:00
Alastair Houghton c3559ecd61 [Windows] Fix a problem with opening files read only.
`_O_RDONLY` is zero, so we can't test for it by AND-ing.
2024-05-13 14:18:17 +01:00
Alastair Houghton 8e09ede76d Remove accidentally public functions.
These can't be new API as they haven't been reviewed.
2024-05-13 11:19:43 +01:00
Guillaume Lessard 25c4b1ad75 fix a 32-bit overflow issue
- ensures compatibility with watchOS
2024-05-12 14:07:11 -07:00
Guillaume Lessard 7d45e0dd46 Update README.md to refer to 1.3.0 2024-05-12 11:40:14 -07:00
Karoy Lorentey aac7f54e89 Merge pull request #174 from lorentey/codeowners
Add CODEOWNERS
2024-05-10 17:17:48 -07:00
Karoy Lorentey 62e62b3a7c Add CODEOWNERS 2024-05-10 17:10:08 -07:00
Guillaume Lessard ab09f04cfe Merge pull request #173 from lorentey/codeowners-1.3.0
Add CODEOWNERS
2024-05-10 17:07:55 -07:00
Karoy Lorentey a6fd8ba9ba Add CODEOWNERS 2024-05-10 17:06:59 -07:00
Karoy Lorentey 0cf079efea Add CODEOWNERS 2024-05-10 17:05:37 -07:00
Mishal Shah 3433699e6e [CI] Remove support for Swift 5.7 2024-05-10 16:32:21 -07:00
Mishal Shah 52f603c6b3 [CI] Remove support for Swift 5.7 2024-05-10 16:31:46 -07:00
Mishal Shah d18980c960 [CI] Remove support for Swift 5.7 2024-05-10 16:30:41 -07:00
Mishal Shah 08800445eb Add support for Swift CI on release/1.4.0 2024-05-10 16:27:47 -07:00
Guillaume Lessard de1f8bce5e Merge pull request #172 from glessard/visionOS-support-for-1.3.0
[1.3.0] visionOS support for 1.3.0
2024-05-10 16:23:53 -07:00
Mishal Shah 0368ce547b Add support for Swift CI on release/1.3.0 2024-05-10 16:18:08 -07:00
Guillaume Lessard 7b14e48d0d Remove the repeated list of Darwin-based platforms
Replaced with a constant defined in the package manifest.
2024-05-10 16:09:22 -07:00
Guillaume Lessard c456f4186e Change the package manifest to support visionOS 2024-05-10 16:02:32 -07:00
Karoy Lorentey ec395a7aa2 Merge pull request #171 from lorentey/require-5.8
[1.3.0] Require Swift 5.8
2024-05-10 15:59:40 -07:00
Karoy Lorentey f1f59e148f Update gitignore 2024-05-10 15:55:04 -07:00
Karoy Lorentey 37a5bbb965 Require Swift 5.8 or better 2024-05-10 15:54:56 -07:00
Guillaume Lessard d8c0e24651 Merge pull request #169 from glessard/manifest-fix
Improved compatibility for visionOS support
2024-05-10 15:42:15 -07:00
Karoy Lorentey f07d14ddb1 Merge pull request #168 from glessard/cherry-pick-pr148
Cherry-pick changes from PR148
2024-05-10 15:41:26 -07:00
Guillaume Lessard 63b05e24e8 Improved compatibility for visionOS support 2024-05-10 15:37:04 -07:00
Guillaume Lessard b0e2a510ed Make a platform-specific flag explicitly platform-specific 2024-05-10 15:28:43 -07:00
Guillaume LessardandFinagolfin 9620c1d30e Cherry-pick changes from PR148
Co-authored-by: Finagolfin <finagolfin@tuta.io>
2024-05-09 22:24:04 -07:00
Guillaume LessardandHiroshi Yamauchi c7259554b5 Cherry-pick changes from PR151
Co-authored-by: Hiroshi Yamauchi <hjyamauchi@gmail.com>
2024-05-09 22:10:26 -07:00
Guillaume LessardandMax Desiatov c3a7235bf7 Cherry-pick changes from PR133
Co-authored-by: Max Desiatov <m_desiatov@apple.com>
2024-05-09 19:10:58 -07:00
Guillaume Lessard e5a56da50e Cherry-pick changes from PR154 2024-05-09 16:03:48 -07:00
Karoy Lorentey 73baf1113d Retarget pending changes to 1.4.0
We decided to spend the 1.3.0 version number on a small interim release; retarget the currently pending changes to 1.4.0.
2024-05-09 14:31:11 -07:00
Guillaume Lessard cf5e688e70 Merge pull request #162 from finagolfin/droid
Android: DIR* is an OpaquePointer in Bionic too
2024-05-09 09:31:47 -07:00
Guillaume Lessard 93d600b5c9 Merge pull request #161 from jmschonfeld/string-init-ambiguity
Disfavor String.init(platformString: UnsafePointer<CChar>)
2024-05-09 09:26:56 -07:00
Finagolfin 7fe8e6cfc2 Android: DIR* is an OpaquePointer in Bionic too 2024-05-09 19:29:36 +05:30
Mishal Shah 84077b3b4b Add Swift CI Support 2024-05-08 15:21:09 -07:00
Alastair Houghton 027c936a26 Merge pull request #158 from al45tair/eng/PR-125087707
Fix swift-system to work on Windows.
2024-05-08 16:13:21 +01:00
Alastair Houghton f5ad5e57fb [Linux] Glibc's DIR doesn't get imported into Swift.
Swift ends up with OpaquePointer instead of a typed pointer.

rdar://125087707
2024-05-08 16:09:56 +01:00
Alastair Houghton 2357d6932c Refactor FilePathTemp, add tests for permission code.
Broke `FilePathTemp.swift` into separate files for POSIX and
Windows.

Added tests for permissions code on Windows.

Added leading underscores to some function names.

Made some other functions `fileprivate`.

rdar://125087707
2024-05-08 16:09:56 +01:00
Alastair HoughtonandKaroy Lorentey 33773a8eb9 Update Sources/System/FilePath/FilePathTemp.swift
Co-authored-by: Karoy Lorentey <klorentey@apple.com>
2024-05-08 16:09:56 +01:00
Alastair Houghton 21638a06b1 Map mode bits to Windows ACLs.
This adds support for mapping POSIX-style mode bits to Windows ACLs when
calling `open()` or `mkdir()`.

rdar://125087707
2024-05-08 16:09:56 +01:00
Alastair Houghton ec7d406cd4 Changes after comments from Saleem.
Use idiomatic Swift notation, not `Optional<Bool>`.

Prefer Win32 APIs to UCRT APIs.

rdar://125087707
2024-05-08 16:09:56 +01:00
Alastair Houghton c6456a9c03 Use the proper temporary directory on Darwin.
It seems we can get the temporary directory from confstr().

rdar://125087707
2024-05-08 16:09:56 +01:00
Alastair Houghton cfd3f9da90 Fix swift-system to work on Windows.
The swift-system tests were not passing, for various reasons, mostly
to do with path related confusion.

As part of this, add a function to create a temporary directory, as that
was one of the problems.

Also add Windows support for pipe() and ftruncate(), which was missing.

rdar://125087707
2024-05-08 16:09:54 +01:00
Jeremy Schonfeld dd45c80062 Disfavor String.init(platformString: UnsafePointer<CChar>) 2024-05-02 13:25:04 -07:00
Max DesiatovandGuillaume Lessard 40b6b0ef8c Add support for WASILibc module (#159)
Quoting the [wasi.dev landing page](https://wasi.dev):
> The WebAssembly System Interface (WASI) is a group of standard API specifications for software compiled to the W3C WebAssembly (Wasm) standard. WASI is designed to provide a secure standard interface for applications that can be compiled to Wasm from any language, and that may run anywhere—from browsers to clouds to embedded devices.

Currently support for WASI in Swift is based on [`wasi-libc`](https://github.com/WebAssembly/wasi-libc).

Adding support for `wasi-libc` mostly amounted to excluding unsupported errnos, adding TLS dictionary storage shim for single-threaded environment, and adding constants in C headers for macros that Clang importer currently doesn't support.

Co-authored-by: Guillaume Lessard <guillaume.lessard@apple.com>
2024-04-30 17:11:39 +01:00
Guillaume Lessard dae787c199 Merge pull request #148 from finagolfin/droid
Android: update pread/pwrite for nullability annotations in NDK 26
2024-03-19 18:23:38 -07:00
Guillaume Lessard 5ca37e7d39 Android: more targeted approach to unusual nullabilities 2024-03-11 09:10:11 -07:00
Guillaume Lessard 14597334dc [test] test reading and writing empty, nil-based buffers 2024-03-08 16:28:11 -08:00
Guillaume Lessard 403776dc2a Merge pull request #152 from noahpistilli/visionPro
Add support for visionOS
2024-03-08 14:54:35 -08:00
Guillaume Lessard 6609a401b9 Update copyright notices 2024-03-08 12:16:44 -08:00
Guillaume Lessard 17e9790792 Rename withSystemChars
- `withNullTerminatedSystemChars` makes it clear that the null-termination is included. Operations where the null-termination is included should be obvious.
2024-03-08 12:16:43 -08:00
Guillaume Lessard def7b1a70c Fix behaviour of withCodeUnits()
- The original implementation includes a trailing zero with the full collection, but the implementation for a slice does not. As a result, given a `let s: SystemString`, `s.string` was not equal to `s[…].string`
2024-03-08 12:13:04 -08:00
Guillaume Lessard c86758849a Test SystemString.string property consistency 2024-03-08 12:13:04 -08:00
Guillaume Lessard afb7fa4eef Generate SystemString.string consistently
- SystemString.string and Slice<SystemString>.string should be generated in the same manner. Now they are.
2024-03-08 12:13:04 -08:00
Sketch f59a0b73ce Add support for visionOS 2024-03-08 10:39:54 -05:00
Guillaume Lessard 8441d4a310 Merge pull request #154 from glessard/system-string-collection-fix 2024-03-07 18:20:02 -08:00
Guillaume Lessard adca1f70b1 Fix SystemString.withCSIA()
- The original implementation simply forwarded to the underlying `nullTerminatedStorage`, which contains one element – a null terminator – more than the actual `String`.
- This isn’t in keeping with the sperit of `withContiguousStorageIfAvailable()`, which should present exactly the elements of the collection.
2024-03-07 15:15:56 -08:00
Saleem Abdulrasool cc1962b882 Merge pull request #151 from hjyamauchi/arm64
Support Windows ARM64
2024-02-14 07:54:19 -08:00
Hiroshi Yamauchi 6b15689813 Support Windows ARM64 2024-02-13 10:32:39 -08:00
Guillaume Lessard 51f6be041f Merge pull request #149 from Kyle-Ye/optimize/doc
Enable Swift Package Index documentation and add API doc link
2024-02-02 15:56:58 -08:00
KyleandMax Desiatov e49d2b9bd2 Update .spi.yml
Co-authored-by: Max Desiatov <m_desiatov@apple.com>
2024-01-22 17:23:31 +08:00
Kyle c6b2119c81 Enable SPI documentation and add API doc link 2024-01-22 17:00:46 +08:00
Guillaume Lessard c2e8f24c7c avoid passing null pointer to pread() or pwrite() 2024-01-04 17:53:38 -08:00
Finagolfin 5c3617b9e9 Android: update pread/pwrite for nullability annotations in NDK 26 2023-11-24 19:01:31 +05:30
Guillaume Lessard 9a812b5fef Merge pull request #147 from glessard/availability 2023-10-13 22:11:51 -07:00
Guillaume Lessard 882466a730 apply missing availability attributes to Mach.Port 2023-10-13 18:55:23 -07:00
Guillaume Lessard 11f1c6da5a Merge pull request #146 from glessard/availability
Update availability declarations for swift-system 1.1.0 API
2023-10-13 18:53:06 -07:00
Guillaume Lessard b92be8a02a Update availability declarations for swift-system 1.1.0 API 2023-10-13 10:21:57 -07:00
Guillaume Lessard c81d5f35e1 Merge pull request #145 from glessard/reenable-mach-port 2023-10-12 19:40:03 -07:00
Guillaume Lessard fb0efe832c [gardening] finish cleaning up old test files
This should have been removed alongside XCTestManifests.swift
2023-10-12 15:02:31 -07:00
Guillaume Lessard 495f729347 [noncopyability] explicitly prevent a capture
This may be needed because of a bug involving resilient structs.
2023-10-12 15:01:08 -07:00
Guillaume Lessard 7654f14f8c [gardening] add some more availability annotations 2023-10-11 14:28:43 -07:00
Guillaume Lessard 0e060b7a7a Merge pull request #144 from kateinoigakukun/katei/fix-rename-typo
Fix typos in renaming message for `Errno`
2023-09-07 15:21:20 -07:00
Yuta Saito 1ccaee141c Fix typos in renaming message for Errno 2023-09-05 11:36:08 -07:00
Guillaume Lessard 8a8552f617 Merge pull request #129 from glessard/reenable-mach-port
Re-enable Mach.Port
2023-08-16 16:04:53 -07:00
Guillaume Lessard ad407249fe make test expression return Void
- It can’t return `Mach.Port<SendRight>`, because a noncopyable type cannot currently be a generic type argument.
2023-08-16 13:34:41 -07:00
Guillaume Lessardandloffgren faffb9a15a Apply suggestions from code review
This better communicates the intention.

Co-authored-by: loffgren <117697138+loffgren@users.noreply.github.com>
2023-08-16 13:19:52 -07:00
Guillaume Lessard 547b2a5828 Merge pull request #141 from glessard/requirement-update 2023-08-16 11:52:22 -07:00
Guillaume Lessard 87e68fca36 declare Sendable conformances along with the types
- `Sendable` is fundamental, it is preferably not declared as an extension.
2023-08-16 11:19:06 -07:00
Guillaume Lessard f32faad415 remove code depending on Swift older than 5.6 2023-08-16 11:02:51 -07:00
Guillaume Lessard a3aff2f913 require Swift 5.6 2023-08-16 11:01:36 -07:00
Guillaume Lessard 8730f2cf25 [gardening] 80-column enforcement 2023-08-15 09:34:05 -07:00
Guillaume Lessard 65693b8b80 improve memory rebinding for mach_port_get_attributes call 2023-08-15 09:11:46 -07:00
Guillaume Lessard f5edd720bd clarify some tests 2023-08-11 18:03:24 -07:00
Guillaume Lessard 6189c1f553 fix copySendRight() for send rights that become dead names 2023-08-11 14:09:44 -07:00
Guillaume Lessard e4d06ae3ea simplify deinit 2023-08-10 15:35:27 -07:00
Guillaume Lessard d259ef476e test two-parameter withBorrowedName 2023-08-10 15:35:27 -07:00
Guillaume Lessard 5e03246e4e test copies of dead mach port names 2023-08-10 15:32:19 -07:00
Guillaume Lessard 40b5b3068b test all the relinquish() methods 2023-08-10 15:32:19 -07:00
Guillaume Lessard e8bb779909 use inout conversion
- this is the situation where it is appropriate
2023-08-10 15:32:19 -07:00
Guillaume Lessard 6ee96ffdb5 modify consuming methods to call discard self 2023-08-09 15:58:56 -07:00
Guillaume Lessard 0539daa364 fix test of receive-right deallocation 2023-08-09 15:58:56 -07:00
Guillaume Lessard 669dcf2c25 ensure Mach.Port lives until the function returns 2023-08-09 15:58:56 -07:00
Guillaume Lessard 9123120c08 destroy Send rights with mach_port_deallocate 2023-08-09 15:58:56 -07:00
Guillaume Lessard bf16d3da30 [test] use XCTAssertEqual or XCTAssertNotEqual 2023-08-09 15:58:56 -07:00
Daniel Loffgren 2df5b0b031 srdelta argument to mach_port_destruct should be zero
This should never have been -1, as there is no send right for
it to balance when `RightType.self == ReceiveRight.self`.
2023-08-09 15:58:56 -07:00
Guillaume Lessard af4544c869 Re-enable Mach.Port 2023-08-09 15:58:56 -07:00
Saleem Abdulrasool 164fe8ce93 Merge pull request #136 from compnerd/singularity
Tests: avoid unnecessary duplication (NFCI)
2023-07-13 10:11:23 -07:00
Saleem Abdulrasool e1ab868059 Tests: avoid unnecessary duplication (NFCI)
Rather than specialising the function with the same implementation,
prefer to use the `CInterop.PlatformUnicodeEncoding` to determine the
correct code point encoding.  This allows us to share the implementation
across the platforms.
2023-07-13 10:00:45 -07:00
Saleem Abdulrasool 022a7fe638 Merge pull request #135 from compnerd/encoding
Tests: adjust the `FilePathTest.testFilePath` to build on Windows
2023-07-13 08:56:56 -07:00
Saleem Abdulrasool 32026456ba Tests: adjust the FilePathTest.testFilePath to build on Windows
UTF-8 is not the universal encoding for file systems.  Use a platform
specific invalid string encoding for testing the sequence.  The internal
representation of a `FilePath` is dependent on the system, and Windows
uses UTF-16 as the base encoding for C interoperability.  Adjust the
test to use an invalid sequence in the proper encoding.  This allows the
tests to now build on Windows once again.
2023-07-13 08:42:12 -07:00
Max Desiatov 0062c82c90 Add support for Musl libc (#133)
Since Musl is sufficiently different from Glibc (see https://wiki.musl-libc.org/functional-differences-from-glibc.html), it requires a different import, which now should be applied to files that have `import Glibc` in them.
2023-07-04 16:50:13 +01:00
Guillaume Lessard 4116b8cbfb Merge pull request #131 from glessard/sendable-availability
Add availability attributes to `Sendable` conformances
2023-06-21 16:47:51 -07:00
Guillaume Lessard adbf8d2856 Add availability attributes to Sendable conformances 2023-06-21 14:50:47 -07:00
Guillaume Lessard a87eaf71f6 Merge pull request #130 from amartini51/abstracts
Fix abstracts to follow reference style
2023-06-21 14:11:40 -07:00
Alex Martini 1d1bef36c9 Fix abstracts to follow reference style.
- Use a present tense verb phrase
- Avoid repeating the symbol's name
2023-06-21 10:26:04 -07:00
Guillaume Lessard a74751c99c Merge pull request #128 from apple/maxd/fix-comment-typo
FilePathSyntax.swift: fix doc comment typo
2023-06-10 00:18:26 -07:00
Guillaume Lessard 1cbb2cbcc6 Merge pull request #127 from loffgren/no-tuple-api 2023-06-09 23:57:08 -07:00
Guillaume Lessard 7bcc01f0bf deactivate Mach.Port
Will reactivate when the following issue is fixed:
https://github.com/apple/swift/issues/66299 (rdar://110496872)
2023-06-09 16:46:48 -07:00
Guillaume Lessard 6bbed6b199 update non-copyable type declaration syntax 2023-06-09 16:40:32 -07:00
Guillaume Lessard 2d6c6a82b3 import module correctly in test file 2023-06-09 16:40:32 -07:00
Daniel Loffgren 5b1b4cab56 Remove allocatePortRightPair(), as move only types are not permitted in tuples 2023-06-09 16:40:32 -07:00
Max Desiatov 7c6609eaca FilePathSyntax.swift: fix doc comment typo
`Appliations` -> `Applications`
2023-06-01 17:01:30 +01:00
56 changed files with 2846 additions and 763 deletions

No files matched your search

+13
View File
@@ -0,0 +1,13 @@
# Lines starting with '#' are comments.
# Each line is a case-sensitive file pattern followed by one or more owners.
# Order is important. The last matching pattern has the most precedence.
# More information: https://docs.github.com/en/articles/about-code-owners
#
# Please mirror the repository's file hierarchy in case-sensitive lexicographic
# order.
# Default owners
* @glessard @lorentey @milseman
# Swift CI configuration files
.swiftci/ @shahmishal
+2 -1
View File
@@ -2,7 +2,8 @@
/.swiftpm
/.build
/Packages
swift-system.xcodeproj
/*.xcodeproj
xcuserdata/
.*.sw?
/.swiftpm
.docc-build
+4
View File
@@ -0,0 +1,4 @@
version: 1
builder:
configs:
- documentation_targets: [SystemPackage]
+5
View File
@@ -0,0 +1,5 @@
LinuxSwiftPackageJob {
swift_version_tag = "5.10-jammy"
repo = "swift-system"
branch = "release/1.4.0"
}
+5
View File
@@ -0,0 +1,5 @@
LinuxSwiftPackageJob {
swift_version_tag = "5.9-jammy"
repo = "swift-system"
branch = "release/1.4.0"
}
+5
View File
@@ -0,0 +1,5 @@
macOSSwiftPackageJob {
swift_version = "6.0"
repo = "swift-system"
branch = "release/1.4.0"
}
+5
View File
@@ -0,0 +1,5 @@
LinuxSwiftPackageJob {
nightly_docker_tag = "nightly-6.0-jammy"
repo = "swift-system"
branch = "release/1.4.0"
}
+5
View File
@@ -0,0 +1,5 @@
macOSSwiftPackageJob {
swift_version = "main"
repo = "swift-system"
branch = "release/1.4.0"
}
+5
View File
@@ -0,0 +1,5 @@
LinuxSwiftPackageJob {
nightly_docker_tag = "nightly-jammy"
repo = "swift-system"
branch = "release/1.4.0"
}
+7
View File
@@ -0,0 +1,7 @@
WindowsSwiftPackageWithDockerImageJob {
docker_image = "swiftlang/swift:nightly-windowsservercore-1809"
repo = "swift-system"
branch = "release/1.4.0"
sub_dir = "swift-system"
label = "windows-server-2019"
}
+2
View File
@@ -11,6 +11,8 @@ cmake_minimum_required(VERSION 3.16.0)
project(SwiftSystem
LANGUAGES C Swift)
include(GNUInstallDirs)
list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake/modules)
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
+38
View File
@@ -0,0 +1,38 @@
# Code of Conduct
To be a truly great community, Swift.org needs to welcome developers from all walks of life, with different backgrounds, and with a wide range of experience. A diverse and friendly community will have more great ideas, more unique perspectives, and produce more great code. We will work diligently to make the Swift community welcoming to everyone.
To give clarity of what is expected of our members, this code of conduct is based on [contributor-covenant.org](http://contributor-covenant.org). This document is used across many open source communities, and we think it articulates our values well.
### Contributor Code of Conduct v1.4
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
Examples of behavior that contributes to creating a positive environment include:
* Using welcoming and inclusive language (e.g., prefer non-gendered words like “folks” to “guys”, non-ableist words like “soundness check” to “sanity check”, etc.)
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others’ private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
This Code of Conduct applies within all project spaces managed by Swift.org, including (but not limited to) source code repositories, bug trackers, web sites, documentation, and online forums. It also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a member of the [Swift Core Team](https://swift.org/community/#community-structure) or by flagging the behavior for moderation (e.g., in the Forums), whether you are the target of that behavior or not. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. Maintainers are obligated to maintain confidentiality with regard to the reporter of an incident. The site of the disputed behavior is usually not an acceptable place to discuss moderation decisions, and moderators may move or remove any such discussion.
Project maintainers are held to a higher standard, and project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.
If you disagree with a moderation action, you can appeal to the Core Team (or individual Core Team members) privately.
This policy is adapted from the Contributor Code of Conduct [version 1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/).
+47 -39
View File
@@ -1,43 +1,51 @@
// swift-tools-version:5.2
// The swift-tools-version declares the minimum version of Swift required to build this package.
/*
This source file is part of the Swift System open source project
Copyright (c) 2020 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
*/
// swift-tools-version:5.9
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift System open source project
//
// Copyright (c) 2020 - 2024 Apple Inc. and the Swift System project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
//
//===----------------------------------------------------------------------===//
import PackageDescription
let cSettings: [CSetting] = [
.define("_CRT_SECURE_NO_WARNINGS", .when(platforms: [.windows])),
]
let swiftSettings: [SwiftSetting] = [
.define(
"SYSTEM_PACKAGE_DARWIN",
.when(platforms: [.macOS, .macCatalyst, .iOS, .watchOS, .tvOS, .visionOS])),
.define("SYSTEM_PACKAGE"),
.define("ENABLE_MOCKING", .when(configuration: .debug)),
]
let package = Package(
name: "swift-system",
products: [
.library(name: "SystemPackage", targets: ["SystemPackage"]),
],
dependencies: [],
targets: [
.target(
name: "CSystem",
dependencies: []),
.target(
name: "SystemPackage",
dependencies: ["CSystem"],
path: "Sources/System",
cSettings: [
.define("_CRT_SECURE_NO_WARNINGS")
],
swiftSettings: [
.define("SYSTEM_PACKAGE"),
.define("ENABLE_MOCKING", .when(configuration: .debug))
]),
.testTarget(
name: "SystemTests",
dependencies: ["SystemPackage"],
swiftSettings: [
.define("SYSTEM_PACKAGE")
]),
]
)
name: "swift-system",
products: [
.library(name: "SystemPackage", targets: ["SystemPackage"]),
],
dependencies: [],
targets: [
.target(
name: "CSystem",
dependencies: [],
exclude: ["CMakeLists.txt"],
cSettings: cSettings),
.target(
name: "SystemPackage",
dependencies: ["CSystem"],
path: "Sources/System",
exclude: ["CMakeLists.txt"],
cSettings: cSettings,
swiftSettings: swiftSettings),
.testTarget(
name: "SystemTests",
dependencies: ["SystemPackage"],
cSettings: cSettings,
swiftSettings: swiftSettings),
])
+69 -9
View File
@@ -2,11 +2,13 @@
Swift System provides idiomatic interfaces to system calls and low-level currency types. Our vision is for System to act as the single home for low-level system interfaces for all supported Swift platforms.
## Multi-platform not Cross-platform
## No Cross-platform Abstractions
System is a multi-platform library, not a cross-platform one. It provides a separate set of APIs and behaviors on every supported platform, closely reflecting the underlying OS interfaces. A single import will pull in the native platform interfaces specific for the targeted OS.
Swift System is not a cross-platform library. It provides a separate set of APIs and behaviors on every supported platform, closely reflecting the underlying OS interfaces. A single import will pull in the native platform interfaces specific for the targeted OS.
Our immediate goal is to simplify building cross-platform libraries and applications such as SwiftNIO and SwiftPM. System does not eliminate the need for `#if os()` conditionals to implement cross-platform abstractions, but it does make it safer and more expressive to fill out the platform-specific parts.
Our immediate goal is to simplify building cross-platform libraries and applications such as SwiftNIO and SwiftPM. It is not a design goal for System to eliminate the need for `#if os()` conditionals to implement cross-platform abstractions; rather, our goal is to make it safer and more expressive to fill out the platform-specific parts.
(That said, it is desirable to avoid unnecessary differences -- for example, when two operating systems share the same C name for a system call, ideally Swift System would expose them using the same Swift name. This is a particularly obvious expectation for system interfaces that implement an industry standard, such as POSIX.)
## Usage
@@ -22,13 +24,15 @@ try fd.closeAfter {
}
```
[API documentation](https://swiftpackageindex.com/apple/swift-system/main/documentation/SystemPackage)
## Adding `SystemPackage` as a Dependency
To use the `SystemPackage` library in a SwiftPM project,
add the following line to the dependencies in your `Package.swift` file:
```swift
.package(url: "https://github.com/apple/swift-system", from: "1.0.0"),
.package(url: "https://github.com/apple/swift-system", from: "1.4.0"),
```
Finally, include `"SystemPackage"` as a dependency for your executable target:
@@ -37,7 +41,7 @@ Finally, include `"SystemPackage"` as a dependency for your executable target:
let package = Package(
// name, platforms, products, etc.
dependencies: [
.package(url: "https://github.com/apple/swift-system", from: "1.0.0"),
.package(url: "https://github.com/apple/swift-system", from: "1.4.0"),
// other dependencies
],
targets: [
@@ -51,14 +55,70 @@ let package = Package(
## Source Stability
The Swift System package is source stable. The version numbers follow [Semantic Versioning][semver] -- source breaking changes to public API can only land in a new major version.
At this time, the Swift System package supports three types of operating systems: Darwin-based, POSIX-like, and Windows. The source-stability status of the package differs according to the platform:
| Platform type | Source Stability |
| ----------------- | --------------- |
| Darwin (macOS, iOS, etc.) | Stable |
| POSIX (Linux, WASI, etc.) | Stable |
| Windows | Unstable |
The package version numbers follow [Semantic Versioning][semver] -- source breaking changes to source-stable public API can only land in a new major version. However, platforms for which support has not reached source stability may see source-breaking changes in a new minor version.
[semver]: https://semver.org
## Contributing
The public API of the swift-system package consists of non-underscored declarations that are marked `public` in the `SystemPackage` module.
Before contributing, please read [CONTRIBUTING.md](CONTRIBUTING.md).
By "underscored declarations" we mean declarations that have a leading underscore anywhere in their fully qualified name. For instance, here are some names that wouldn't be considered part of the public API, even if they were technically marked public:
## LICENSE
- `FooModule.Bar._someMember(value:)` (underscored member)
- `FooModule._Bar.someMember` (underscored type)
- `_FooModule.Bar` (underscored module)
- `FooModule.Bar.init(_value:)` (underscored initializer)
Interfaces that aren't part of the public API may continue to change in any release, including patch releases. If you have a use case that requires using non-public APIs, please submit a Feature Request describing it! We'd like the public interface to be as useful as possible -- although preferably without compromising safety or limiting future evolution.
Future minor versions of the package may update these rules as needed.
## Toolchain Requirements
The following table maps existing package releases to their minimum required Swift toolchain release:
| Package version | Swift version | Xcode release |
| ----------------------- | --------------- | ------------- |
| swift-system 1.3.x | >= Swift 5.8 | >= Xcode 14.3 |
| swift-system 1.4.x | >= Swift 5.9 | >= Xcode 15.0 |
We'd like this package to quickly embrace Swift language and toolchain improvements that are relevant to its mandate. Accordingly, from time to time, new versions of this package require clients to upgrade to a more recent Swift toolchain release. (This allows the package to make use of new language/stdlib features, build on compiler bug fixes, and adopt new package manager functionality as soon as they are available.) Patch (i.e., bugfix) releases will not increase the required toolchain version, but any minor (i.e., new feature) release may do so.
(Note: the package has no minimum deployment target, so while it does require clients to use a recent Swift toolchain to build it, the code itself is able to run on any OS release that supports running Swift code.)
## Licensing
See [LICENSE](LICENSE.txt) for license information.
## Contributing
Before contributing, please read [CONTRIBUTING.md](CONTRIBUTING.md).
### Branching Strategy
We maintain separate branches for each active minor version of the package:
| Package version | Branch |
| ----------------------- | ----------- |
| swift-system 1.3.x | release/1.3 |
| swift-system 1.4.x (unreleased) | release/1.4 |
| swift-system 1.5.x (unreleased) | main |
Changes must land on the branch corresponding to the earliest release that they will need to ship on. They are periodically propagated to subsequent branches, in the following direction:
`release/1.3` → `release/1.4` → `main`
For example, anything landing on `release/1.3` will eventually appear on `release/1.4` and then `main` too; there is no need to file standalone PRs for each release line. (Change propagation currently requires manual work -- it is performed by project maintainers.)
### Code of Conduct
Like all Swift.org projects, we would like the Swift System project to foster a diverse and friendly community. We expect contributors to adhere to the [Swift.org Code of Conduct](https://swift.org/code-of-conduct/). A copy of this document is [available in this repository][coc].
[coc]: CODE_OF_CONDUCT.md
+2 -2
View File
@@ -9,8 +9,8 @@ See https://swift.org/LICENSE.txt for license information
add_library(CSystem INTERFACE)
target_include_directories(CSystem INTERFACE
include)
"$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>"
$<INSTALL_INTERFACE:include/CSystem>)
install(FILES
include/CSystemLinux.h
+31
View File
@@ -0,0 +1,31 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2024 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
*/
#pragma once
#if __wasi__
#include <errno.h>
#include <fcntl.h>
// wasi-libc defines the following constants in a way that Clang Importer can't
// understand, so we need to expose them manually.
static inline int32_t _getConst_O_ACCMODE(void) { return O_ACCMODE; }
static inline int32_t _getConst_O_APPEND(void) { return O_APPEND; }
static inline int32_t _getConst_O_CREAT(void) { return O_CREAT; }
static inline int32_t _getConst_O_DIRECTORY(void) { return O_DIRECTORY; }
static inline int32_t _getConst_O_EXCL(void) { return O_EXCL; }
static inline int32_t _getConst_O_NONBLOCK(void) { return O_NONBLOCK; }
static inline int32_t _getConst_O_TRUNC(void) { return O_TRUNC; }
static inline int32_t _getConst_O_WRONLY(void) { return O_WRONLY; }
static inline int32_t _getConst_EWOULDBLOCK(void) { return EWOULDBLOCK; }
static inline int32_t _getConst_EOPNOTSUPP(void) { return EOPNOTSUPP; }
#endif
+1
View File
@@ -1,5 +1,6 @@
module CSystem {
header "CSystemLinux.h"
header "CSystemWASI.h"
header "CSystemWindows.h"
export *
}
+4
View File
@@ -41,6 +41,10 @@ target_sources(SystemPackage PRIVATE
target_link_libraries(SystemPackage PUBLIC
CSystem)
set(SWIFT_SYSTEM_APPLE_PLATFORMS "Darwin" "iOS" "watchOS" "tvOS" "visionOS")
if(CMAKE_SYSTEM_NAME IN_LIST SWIFT_SYSTEM_APPLE_PLATFORMS)
target_compile_definitions(SystemPackage PRIVATE SYSTEM_PACKAGE_DARWIN)
endif()
_install_target(SystemPackage)
set_property(GLOBAL APPEND PROPERTY SWIFT_SYSTEM_EXPORTS SystemPackage)
+174 -128
View File
File diff suppressed because it is too large. Load diff
+20
View File
@@ -0,0 +1,20 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2024 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
*/
#if os(Windows)
import WinSDK
extension Errno {
internal init(windowsError: DWORD) {
self.init(rawValue: _mapWindowsErrorToErrno(windowsError))
}
}
#endif
+52 -29
View File
@@ -45,7 +45,8 @@ extension FileDescriptor {
extension FileDescriptor {
/// The desired read and write access for a newly opened file.
@frozen
public struct AccessMode: RawRepresentable, Hashable, Codable {
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
public struct AccessMode: RawRepresentable, Sendable, Hashable, Codable {
/// The raw C access mode.
@_alwaysEmitIntoClient
public var rawValue: CInt
@@ -87,7 +88,8 @@ extension FileDescriptor {
/// Options that specify behavior for a newly-opened file.
@frozen
public struct OpenOptions: OptionSet, Hashable, Codable {
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
public struct OpenOptions: OptionSet, Sendable, Hashable, Codable {
/// The raw C options.
@_alwaysEmitIntoClient
public var rawValue: CInt
@@ -96,9 +98,6 @@ extension FileDescriptor {
@_alwaysEmitIntoClient
public init(rawValue: CInt) { self.rawValue = rawValue }
@_alwaysEmitIntoClient
private init(_ raw: CInt) { self.init(rawValue: raw) }
#if !os(Windows)
/// Indicates that opening the file doesn't
/// wait for the file or device to become available.
@@ -115,7 +114,7 @@ extension FileDescriptor {
///
/// The corresponding C constant is `O_NONBLOCK`.
@_alwaysEmitIntoClient
public static var nonBlocking: OpenOptions { OpenOptions(_O_NONBLOCK) }
public static var nonBlocking: OpenOptions { .init(rawValue: _O_NONBLOCK) }
@_alwaysEmitIntoClient
@available(*, unavailable, renamed: "nonBlocking")
@@ -131,7 +130,7 @@ extension FileDescriptor {
///
/// The corresponding C constant is `O_APPEND`.
@_alwaysEmitIntoClient
public static var append: OpenOptions { OpenOptions(_O_APPEND) }
public static var append: OpenOptions { .init(rawValue: _O_APPEND) }
@_alwaysEmitIntoClient
@available(*, unavailable, renamed: "append")
@@ -141,7 +140,7 @@ extension FileDescriptor {
///
/// The corresponding C constant is `O_CREAT`.
@_alwaysEmitIntoClient
public static var create: OpenOptions { OpenOptions(_O_CREAT) }
public static var create: OpenOptions { .init(rawValue: _O_CREAT) }
@_alwaysEmitIntoClient
@available(*, unavailable, renamed: "create")
@@ -155,7 +154,7 @@ extension FileDescriptor {
///
/// The corresponding C constant is `O_TRUNC`.
@_alwaysEmitIntoClient
public static var truncate: OpenOptions { OpenOptions(_O_TRUNC) }
public static var truncate: OpenOptions { .init(rawValue: _O_TRUNC) }
@_alwaysEmitIntoClient
@available(*, unavailable, renamed: "truncate")
@@ -177,13 +176,13 @@ extension FileDescriptor {
///
/// The corresponding C constant is `O_EXCL`.
@_alwaysEmitIntoClient
public static var exclusiveCreate: OpenOptions { OpenOptions(_O_EXCL) }
public static var exclusiveCreate: OpenOptions { .init(rawValue: _O_EXCL) }
@_alwaysEmitIntoClient
@available(*, unavailable, renamed: "exclusiveCreate")
public static var O_EXCL: OpenOptions { exclusiveCreate }
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if SYSTEM_PACKAGE_DARWIN || os(FreeBSD)
/// Indicates that opening the file
/// atomically obtains a shared lock on the file.
///
@@ -195,7 +194,7 @@ extension FileDescriptor {
///
/// The corresponding C constant is `O_SHLOCK`.
@_alwaysEmitIntoClient
public static var sharedLock: OpenOptions { OpenOptions(_O_SHLOCK) }
public static var sharedLock: OpenOptions { .init(rawValue: _O_SHLOCK) }
@_alwaysEmitIntoClient
@available(*, unavailable, renamed: "sharedLock")
@@ -212,7 +211,7 @@ extension FileDescriptor {
///
/// The corresponding C constant is `O_EXLOCK`.
@_alwaysEmitIntoClient
public static var exclusiveLock: OpenOptions { OpenOptions(_O_EXLOCK) }
public static var exclusiveLock: OpenOptions { .init(rawValue: _O_EXLOCK) }
@_alwaysEmitIntoClient
@available(*, unavailable, renamed: "exclusiveLock")
@@ -230,7 +229,7 @@ extension FileDescriptor {
///
/// The corresponding C constant is `O_NOFOLLOW`.
@_alwaysEmitIntoClient
public static var noFollow: OpenOptions { OpenOptions(_O_NOFOLLOW) }
public static var noFollow: OpenOptions { .init(rawValue: _O_NOFOLLOW) }
@_alwaysEmitIntoClient
@available(*, unavailable, renamed: "noFollow")
@@ -244,14 +243,30 @@ extension FileDescriptor {
///
/// The corresponding C constant is `O_DIRECTORY`.
@_alwaysEmitIntoClient
public static var directory: OpenOptions { OpenOptions(_O_DIRECTORY) }
public static var directory: OpenOptions { .init(rawValue: _O_DIRECTORY) }
@_alwaysEmitIntoClient
@available(*, unavailable, renamed: "directory")
public static var O_DIRECTORY: OpenOptions { directory }
#endif
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if os(FreeBSD)
/// Indicates that each write operation is synchronous.
///
/// If this option is specified,
/// each time you write to the file,
/// the new data is written immediately and synchronously to the disk.
///
/// The corresponding C constant is `O_SYNC`.
@_alwaysEmitIntoClient
public static var sync: OpenOptions { .init(rawValue: _O_SYNC) }
@_alwaysEmitIntoClient
@available(*, unavailable, renamed: "sync")
public static var O_SYNC: OpenOptions { sync }
#endif
#if SYSTEM_PACKAGE_DARWIN
/// Indicates that opening the file
/// opens symbolic links instead of following them.
///
@@ -263,7 +278,7 @@ extension FileDescriptor {
///
/// The corresponding C constant is `O_SYMLINK`.
@_alwaysEmitIntoClient
public static var symlink: OpenOptions { OpenOptions(_O_SYMLINK) }
public static var symlink: OpenOptions { .init(rawValue: _O_SYMLINK) }
@_alwaysEmitIntoClient
@available(*, unavailable, renamed: "symlink")
@@ -279,7 +294,7 @@ extension FileDescriptor {
///
/// The corresponding C constant is `O_EVTONLY`.
@_alwaysEmitIntoClient
public static var eventOnly: OpenOptions { OpenOptions(_O_EVTONLY) }
public static var eventOnly: OpenOptions { .init(rawValue: _O_EVTONLY) }
@_alwaysEmitIntoClient
@available(*, unavailable, renamed: "eventOnly")
@@ -301,7 +316,7 @@ extension FileDescriptor {
///
/// The corresponding C constant is `O_CLOEXEC`.
@_alwaysEmitIntoClient
public static var closeOnExec: OpenOptions { OpenOptions(_O_CLOEXEC) }
public static var closeOnExec: OpenOptions { .init(rawValue: _O_CLOEXEC) }
@_alwaysEmitIntoClient
@available(*, unavailable, renamed: "closeOnExec")
@@ -311,7 +326,8 @@ extension FileDescriptor {
/// Options for specifying what a file descriptor's offset is relative to.
@frozen
public struct SeekOrigin: RawRepresentable, Hashable, Codable {
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
public struct SeekOrigin: RawRepresentable, Sendable, Hashable, Codable {
/// The raw C value.
@_alwaysEmitIntoClient
public var rawValue: CInt
@@ -354,7 +370,7 @@ extension FileDescriptor {
// TODO: These are available on some versions of Linux with appropriate
// macro defines.
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if SYSTEM_PACKAGE_DARWIN || os(FreeBSD)
/// Indicates that the offset should be set
/// to the next hole after the specified number of bytes.
///
@@ -416,7 +432,7 @@ extension FileDescriptor.SeekOrigin
case .start: return "start"
case .current: return "current"
case .end: return "end"
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if SYSTEM_PACKAGE_DARWIN
case .nextHole: return "nextHole"
case .nextData: return "nextData"
#endif
@@ -435,7 +451,7 @@ extension FileDescriptor.OpenOptions
/// A textual representation of the open options.
@inline(never)
public var description: String {
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if SYSTEM_PACKAGE_DARWIN
let descriptions: [(Element, StaticString)] = [
(.nonBlocking, ".nonBlocking"),
(.append, ".append"),
@@ -456,6 +472,19 @@ extension FileDescriptor.OpenOptions
(.truncate, ".truncate"),
(.exclusiveCreate, ".exclusiveCreate"),
]
#elseif os(FreeBSD)
let descriptions: [(Element, StaticString)] = [
(.nonBlocking, ".nonBlocking"),
(.append, ".append"),
(.create, ".create"),
(.truncate, ".truncate"),
(.exclusiveCreate, ".exclusiveCreate"),
(.sharedLock, ".sharedLock"),
(.exclusiveLock, ".exclusiveLock"),
(.sync, ".sync"),
(.noFollow, ".noFollow"),
(.closeOnExec, ".closeOnExec")
]
#else
let descriptions: [(Element, StaticString)] = [
(.nonBlocking, ".nonBlocking"),
@@ -475,13 +504,7 @@ extension FileDescriptor.OpenOptions
public var debugDescription: String { self.description }
}
#if compiler(>=5.5) && canImport(_Concurrency)
// The decision on whether to make FileDescriptor Sendable or not
// is currently being discussed in https://github.com/apple/swift-system/pull/112
//@available(*, unavailable, message: "File descriptors are not completely thread-safe.")
//extension FileDescriptor: Sendable {}
extension FileDescriptor.AccessMode: Sendable {}
extension FileDescriptor.OpenOptions: Sendable {}
extension FileDescriptor.SeekOrigin: Sendable {}
#endif
+52 -13
View File
@@ -1,7 +1,7 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2020 Apple Inc. and the Swift System project authors
Copyright (c) 2020 - 2024 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
@@ -135,8 +135,6 @@ extension FileDescriptor {
if let permissions = permissions {
return system_open(path, oFlag, permissions.rawValue)
}
precondition(!options.contains(.create),
"Create must be given permissions")
return system_open(path, oFlag)
}
return descOrError.map { FileDescriptor(rawValue: $0) }
@@ -158,7 +156,7 @@ extension FileDescriptor {
nothingOrErrno(retryOnInterrupt: false) { system_close(self.rawValue) }
}
/// Reposition the offset for the given file descriptor.
/// Repositions the offset for the given file descriptor.
///
/// - Parameters:
/// - offset: The new offset for the file descriptor.
@@ -369,9 +367,10 @@ extension FileDescriptor {
}
}
#if !os(WASI)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FileDescriptor {
/// Duplicate this file descriptor and return the newly created copy.
/// Duplicates this file descriptor and return the newly created copy.
///
/// - Parameters:
/// - `target`: The desired target file descriptor, or `nil`, in which case
@@ -433,22 +432,23 @@ extension FileDescriptor {
fatalError("Not implemented")
}
}
#endif
#if !os(Windows)
@available(/*System 1.1.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
#if !os(WASI)
@available(/*System 1.1.0: macOS 12.3, iOS 15.4, watchOS 8.5, tvOS 15.4*/iOS 8, *)
extension FileDescriptor {
/// Create a pipe, a unidirectional data channel which can be used for interprocess communication.
/// Creates a unidirectional data channel, which can be used for interprocess communication.
///
/// - Returns: The pair of file descriptors.
///
/// The corresponding C function is `pipe`.
@_alwaysEmitIntoClient
@available(/*System 1.1.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
@available(/*System 1.1.0: macOS 12.3, iOS 15.4, watchOS 8.5, tvOS 15.4*/iOS 8, *)
public static func pipe() throws -> (readEnd: FileDescriptor, writeEnd: FileDescriptor) {
try _pipe().get()
}
@available(/*System 1.1.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
@available(/*System 1.1.0: macOS 12.3, iOS 15.4, watchOS 8.5, tvOS 15.4*/iOS 8, *)
@usableFromInline
internal static func _pipe() -> Result<(readEnd: FileDescriptor, writeEnd: FileDescriptor), Errno> {
var fds: (Int32, Int32) = (-1, -1)
@@ -463,10 +463,9 @@ extension FileDescriptor {
}
#endif
#if !os(Windows)
@available(/*System 1.2.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
extension FileDescriptor {
/// Truncate or extend the file referenced by this file descriptor.
/// Truncates or extends the file referenced by this file descriptor.
///
/// - Parameters:
/// - newSize: The length in bytes to resize the file to.
@@ -509,4 +508,44 @@ extension FileDescriptor {
}
}
}
#endif
extension FilePermissions {
/// The file creation permission mask (aka "umask").
///
/// Permissions set in this mask will be cleared by functions that create
/// files or directories. Note that this mask is process-wide, and that
/// *getting* it is not thread safe.
internal static var creationMask: FilePermissions {
get {
let oldMask = _umask(0o22)
_ = _umask(oldMask)
return FilePermissions(rawValue: oldMask)
}
set {
_ = _umask(newValue.rawValue)
}
}
/// Change the file creation permission mask, run some code, then
/// restore it to its original value.
///
/// - Parameters:
/// - permissions: The new permission mask.
///
/// This is more efficient than reading `creationMask` and restoring it
/// afterwards, because of the way reading the creation mask works.
internal static func withCreationMask<R>(
_ permissions: FilePermissions,
body: () throws -> R
) rethrows -> R {
let oldMask = _umask(permissions.rawValue)
defer {
_ = _umask(oldMask)
}
return try body()
}
internal static func _umask(_ mode: CModeT) -> CModeT {
return system_umask(mode)
}
}
+22 -5
View File
@@ -38,7 +38,7 @@
/// are file-system–specific and have additional considerations
/// like case insensitivity, Unicode normalization, and symbolic links.
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
public struct FilePath {
public struct FilePath: Sendable {
// TODO(docs): Section on all the new syntactic operations, lexical normalization, decomposition,
// components, etc.
internal var _storage: SystemString
@@ -66,8 +66,25 @@ extension FilePath {
}
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension FilePath: Hashable, Codable {}
extension FilePath: Hashable {}
#if compiler(>=5.5) && canImport(_Concurrency)
extension FilePath: Sendable {}
#endif
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension FilePath: Codable {
// Encoder is synthesized; it probably should have been explicit and used
// a single-value container, but making that change now is somewhat risky.
// Decoder is written explicitly to ensure that we validate invariants on
// untrusted input.
public init(from decoder: any Decoder) throws {
let container = try decoder.container(keyedBy: CodingKeys.self)
self._storage = try container.decode(SystemString.self, forKey: ._storage)
guard _invariantsSatisfied() else {
throw DecodingError.dataCorruptedError(
forKey: ._storage,
in: container,
debugDescription:
"Encoding does not satisfy the invariants of FilePath"
)
}
}
}
@@ -28,7 +28,8 @@ extension FilePath {
///
/// path.components.removeAll { $0.kind == .currentDirectory }
/// // path is "/home/username/bin/scripts/tree"
public struct ComponentView {
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
public struct ComponentView: Sendable {
internal var _path: FilePath
internal var _start: SystemString.Index
@@ -39,30 +40,6 @@ extension FilePath {
}
}
#if SYSTEM_PACKAGE // Workaround for a __consuming getter bug in Swift 5.3.3
/// View the non-root components that make up this path.
public var components: ComponentView {
get { ComponentView(self) }
_modify {
// RRC's empty init means that we can't guarantee that the yielded
// view will restore our root. So copy it out first.
//
// TODO(perf): Small-form root (especially on Unix). Have Root
// always copy out (not worth ref counting). Make sure that we're
// not needlessly sliding values around or triggering a COW
let rootStr = self.root?._systemString ?? SystemString()
var comp = ComponentView(self)
self = FilePath()
defer {
self = comp._path
if root?._slice.elementsEqual(rootStr) != true {
self.root = Root(rootStr)
}
}
yield &comp
}
}
#else
/// View the non-root components that make up this path.
public var components: ComponentView {
__consuming get { ComponentView(self) }
@@ -85,13 +62,14 @@ extension FilePath {
yield &comp
}
}
#endif
}
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath.ComponentView: BidirectionalCollection {
public typealias Element = FilePath.Component
public struct Index: Comparable, Hashable {
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
public struct Index: Sendable, Comparable, Hashable {
internal typealias Storage = SystemString.Index
internal var _storage: Storage
@@ -239,8 +217,3 @@ extension FilePath.ComponentView {
#endif // DEBUG
}
}
#if compiler(>=5.5) && canImport(_Concurrency)
extension FilePath.ComponentView: Sendable {}
extension FilePath.ComponentView.Index: Sendable {}
#endif
@@ -1,7 +1,7 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2020 Apple Inc. and the Swift System project authors
Copyright (c) 2020 - 2024 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
@@ -28,7 +28,8 @@ extension FilePath {
/// * `\\server\share\`
/// * `\\?\UNC\server\share\`
/// * `\\?\Volume{12345678-abcd-1111-2222-123445789abc}\`
public struct Root {
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
public struct Root: Sendable {
internal var _path: FilePath
internal var _rootEnd: SystemString.Index
@@ -54,7 +55,8 @@ extension FilePath {
/// file.kind == .regular // true
/// file.extension // "txt"
/// path.append(file) // path is "/tmp/foo.txt"
public struct Component {
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
public struct Component: Sendable {
internal var _path: FilePath
internal var _range: Range<SystemString.Index>
@@ -78,7 +80,8 @@ extension FilePath.Component {
/// Whether a component is a regular file or directory name, or a special
/// directory `.` or `..`
@frozen
public enum Kind {
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
public enum Kind: Sendable {
/// The special directory `.`, representing the current directory.
case currentDirectory
@@ -143,7 +146,7 @@ extension _StrSlice {
internal func _withSystemChars<T>(
_ f: (UnsafeBufferPointer<SystemChar>) throws -> T
) rethrows -> T {
try _storage.withSystemChars {
try _storage.withNullTerminatedSystemChars {
try f(UnsafeBufferPointer(rebasing: $0[_range]))
}
}
@@ -285,9 +288,3 @@ extension FilePath.Root {
#endif
}
}
#if compiler(>=5.5) && canImport(_Concurrency)
extension FilePath.Root: Sendable {}
extension FilePath.Component: Sendable {}
extension FilePath.Component.Kind: Sendable {}
#endif
+19 -6
View File
@@ -89,6 +89,11 @@ extension SystemString {
// `_prenormalizeWindowsRoots` and resume.
readIdx = _prenormalizeWindowsRoots()
writeIdx = readIdx
// Skip redundant separators
while readIdx < endIndex && isSeparator(self[readIdx]) {
self.formIndex(after: &readIdx)
}
} else {
assert(genericSeparator == platformSeparator)
}
@@ -330,10 +335,13 @@ extension FilePath {
// Whether we are providing Windows paths
@inline(__always)
internal var _windowsPaths: Bool {
if let forceWindowsPaths = forceWindowsPaths {
return forceWindowsPaths
}
#if os(Windows)
return true
#else
return forceWindowsPaths
return false
#endif
}
@@ -367,13 +375,18 @@ extension FilePath {
// MARK: - Invariants
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension FilePath {
internal func _invariantCheck() {
#if DEBUG
internal func _invariantsSatisfied() -> Bool {
var normal = self
normal._normalizeSeparators()
precondition(self == normal)
precondition(!self._storage._hasTrailingSeparator())
precondition(_hasRoot == (self.root != nil))
guard self == normal else { return false }
guard !self._storage._hasTrailingSeparator() else { return false }
guard _hasRoot == (self.root != nil) else { return false }
return true
}
internal func _invariantCheck() {
#if DEBUG
precondition(_invariantsSatisfied())
#endif // DEBUG
}
}
+2 -2
View File
@@ -340,8 +340,8 @@ extension FilePath {
/// Returns `nil` if `lastComponent` is `nil`
///
/// * `/tmp/foo.txt => foo`
/// * `/Appliations/Foo.app/ => Foo`
/// * `/Appliations/Foo.app/bar.txt => bar`
/// * `/Applications/Foo.app/ => Foo`
/// * `/Applications/Foo.app/bar.txt => bar`
/// * `/tmp/.hidden => .hidden`
/// * `/tmp/.. => ..`
/// * `/ => nil`
@@ -0,0 +1,97 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2024 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
*/
// MARK: - API
/// Create a temporary path for the duration of the closure.
///
/// - Parameters:
/// - basename: The base name for the temporary path.
/// - body: The closure to execute.
///
/// Creates a temporary directory with a name based on the given `basename`,
/// executes `body`, passing in the path of the created directory, then
/// deletes the directory and all of its contents before returning.
internal func withTemporaryFilePath<R>(
basename: FilePath.Component,
_ body: (FilePath) throws -> R
) throws -> R {
let temporaryDir = try createUniqueTemporaryDirectory(basename: basename)
defer {
try? _recursiveRemove(at: temporaryDir)
}
return try body(temporaryDir)
}
// MARK: - Internals
fileprivate let base64 = Array<UInt8>(
"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_".utf8
)
/// Create a directory that is only accessible to the current user.
///
/// - Parameters:
/// - path: The path of the directory to create.
/// - Returns: `true` if a new directory was created.
///
/// This function will throw if there is an error, except if the error
/// is that the directory exists, in which case it returns `false`.
fileprivate func makeLockedDownDirectory(at path: FilePath) throws -> Bool {
return try path.withPlatformString {
if system_mkdir($0, 0o700) == 0 {
return true
}
let err = system_errno
if err == Errno.fileExists.rawValue {
return false
} else {
throw Errno(rawValue: err)
}
}
}
/// Generate a random string of base64 filename safe characters.
///
/// - Parameters:
/// - length: The number of characters in the returned string.
/// - Returns: A random string of length `length`.
fileprivate func createRandomString(length: Int) -> String {
return String(
decoding: (0..<length).map{
_ in base64[Int.random(in: 0..<64)]
},
as: UTF8.self
)
}
/// Given a base name, create a uniquely named temporary directory.
///
/// - Parameters:
/// - basename: The base name for the new directory.
/// - Returns: The path to the new directory.
///
/// Creates a directory in the system temporary directory whose name
/// starts with `basename`, followed by a `.` and then a random
/// string of characters.
fileprivate func createUniqueTemporaryDirectory(
basename: FilePath.Component
) throws -> FilePath {
var tempDir = try _getTemporaryDirectory()
tempDir.append(basename)
while true {
tempDir.extension = createRandomString(length: 16)
if try makeLockedDownDirectory(at: tempDir) {
return tempDir
}
}
}
@@ -0,0 +1,153 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2024 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
*/
#if !os(Windows)
/// Get the path to the system temporary directory.
internal func _getTemporaryDirectory() throws -> FilePath {
guard let tmp = system_getenv("TMPDIR") else {
return "/tmp"
}
return FilePath(SystemString(platformString: tmp))
}
/// Delete the entire contents of a directory, including its subdirectories.
///
/// - Parameters:
/// - path: The directory to be deleted.
///
/// Removes a directory completely, including all of its contents.
internal func _recursiveRemove(
at path: FilePath
) throws {
let dirfd = try FileDescriptor.open(path, .readOnly, options: .directory)
defer {
try? dirfd.close()
}
let dot: (CInterop.PlatformChar, CInterop.PlatformChar) = (46, 0)
try withUnsafeBytes(of: dot) {
try recursiveRemove(
in: dirfd.rawValue,
name: $0.assumingMemoryBound(to: CInterop.PlatformChar.self).baseAddress!
)
}
try path.withPlatformString {
if system_rmdir($0) != 0 {
throw Errno.current
}
}
}
/// Open a directory by reference to its parent and name.
///
/// - Parameters:
/// - dirfd: An open file descriptor for the parent directory.
/// - name: The name of the directory to open.
/// - Returns: A pointer to a `DIR` structure.
///
/// This is like `opendir()`, but instead of taking a path, it uses a
/// file descriptor pointing at the parent, thus avoiding path length
/// limits.
fileprivate func impl_opendirat(
_ dirfd: CInt,
_ name: UnsafePointer<CInterop.PlatformChar>
) -> system_DIRPtr? {
let fd = system_openat(dirfd, name,
FileDescriptor.AccessMode.readOnly.rawValue
| FileDescriptor.OpenOptions.directory.rawValue)
if fd < 0 {
return nil
}
return system_fdopendir(fd)
}
/// Invoke a closure for each file within a particular directory.
///
/// - Parameters:
/// - dirfd: The parent of the directory to be enumerated.
/// - subdir: The subdirectory to be enumerated.
/// - body: The closure that will be invoked.
///
/// We skip the `.` and `..` pseudo-entries.
fileprivate func forEachFile(
in dirfd: CInt,
subdir: UnsafePointer<CInterop.PlatformChar>,
_ body: (system_dirent) throws -> ()
) throws {
guard let dir = impl_opendirat(dirfd, subdir) else {
throw Errno.current
}
defer {
_ = system_closedir(dir)
}
while let dirent = system_readdir(dir) {
// Skip . and ..
if dirent.pointee.d_name.0 == 46
&& (dirent.pointee.d_name.1 == 0
|| (dirent.pointee.d_name.1 == 46
&& dirent.pointee.d_name.2 == 0)) {
continue
}
try body(dirent.pointee)
}
}
/// Delete the entire contents of a directory, including its subdirectories.
///
/// - Parameters:
/// - dirfd: The parent of the directory to be removed.
/// - name: The name of the directory to be removed.
///
/// Removes a directory completely, including all of its contents.
fileprivate func recursiveRemove(
in dirfd: CInt,
name: UnsafePointer<CInterop.PlatformChar>
) throws {
// First, deal with subdirectories
try forEachFile(in: dirfd, subdir: name) { dirent in
if dirent.d_type == SYSTEM_DT_DIR {
try withUnsafeBytes(of: dirent.d_name) {
try recursiveRemove(
in: dirfd,
name: $0.assumingMemoryBound(to: CInterop.PlatformChar.self)
.baseAddress!
)
}
}
}
// Now delete the contents of this directory
try forEachFile(in: dirfd, subdir: name) { dirent in
let flag: CInt
if dirent.d_type == SYSTEM_DT_DIR {
flag = SYSTEM_AT_REMOVE_DIR
} else {
flag = 0
}
let result = withUnsafeBytes(of: dirent.d_name) {
system_unlinkat(dirfd,
$0.assumingMemoryBound(to: CInterop.PlatformChar.self)
.baseAddress!,
flag)
}
if result != 0 {
throw Errno.current
}
}
}
#endif // !os(Windows)
@@ -0,0 +1,114 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2024 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
*/
#if os(Windows)
import WinSDK
/// Get the path to the system temporary directory.
internal func _getTemporaryDirectory() throws -> FilePath {
return try withUnsafeTemporaryAllocation(of: CInterop.PlatformChar.self,
capacity: Int(MAX_PATH) + 1) {
buffer in
guard GetTempPathW(DWORD(buffer.count), buffer.baseAddress) != 0 else {
throw Errno(windowsError: GetLastError())
}
return FilePath(SystemString(platformString: buffer.baseAddress!))
}
}
/// Invoke a closure for each file within a particular directory.
///
/// - Parameters:
/// - path: The path at which we should enumerate items.
/// - body: The closure that will be invoked.
///
/// We skip the `.` and `..` pseudo-entries.
fileprivate func forEachFile(
at path: FilePath,
_ body: (WIN32_FIND_DATAW) throws -> ()
) rethrows {
let searchPath = path.appending("\\*")
try searchPath.withPlatformString { szPath in
var findData = WIN32_FIND_DATAW()
let hFind = FindFirstFileW(szPath, &findData)
if hFind == INVALID_HANDLE_VALUE {
throw Errno(windowsError: GetLastError())
}
defer {
FindClose(hFind)
}
repeat {
// Skip . and ..
if findData.cFileName.0 == 46
&& (findData.cFileName.1 == 0
|| (findData.cFileName.1 == 46
&& findData.cFileName.2 == 0)) {
continue
}
try body(findData)
} while FindNextFileW(hFind, &findData)
}
}
/// Delete the entire contents of a directory, including its subdirectories.
///
/// - Parameters:
/// - path: The directory to be deleted.
///
/// Removes a directory completely, including all of its contents.
internal func _recursiveRemove(
at path: FilePath
) throws {
// First, deal with subdirectories
try forEachFile(at: path) { findData in
if (findData.dwFileAttributes & DWORD(FILE_ATTRIBUTE_DIRECTORY)) != 0 {
let name = withUnsafeBytes(of: findData.cFileName) {
return SystemString(platformString: $0.assumingMemoryBound(
to: CInterop.PlatformChar.self).baseAddress!)
}
let component = FilePath.Component(name)!
let subpath = path.appending(component)
try _recursiveRemove(at: subpath)
}
}
// Now delete everything else
try forEachFile(at: path) { findData in
let name = withUnsafeBytes(of: findData.cFileName) {
return SystemString(platformString: $0.assumingMemoryBound(
to: CInterop.PlatformChar.self).baseAddress!)
}
let component = FilePath.Component(name)!
let subpath = path.appending(component)
if (findData.dwFileAttributes & DWORD(FILE_ATTRIBUTE_DIRECTORY)) == 0 {
try subpath.withPlatformString {
if !DeleteFileW($0) {
throw Errno(windowsError: GetLastError())
}
}
}
}
// Finally, delete the parent
try path.withPlatformString {
if !RemoveDirectoryW($0) {
throw Errno(windowsError: GetLastError())
}
}
}
#endif // os(Windows)
+25 -32
View File
@@ -18,7 +18,7 @@
/// perms == [.ownerReadWrite, .groupRead, .otherRead] // true
@frozen
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
public struct FilePermissions: OptionSet, Hashable, Codable {
public struct FilePermissions: OptionSet, Sendable, Hashable, Codable {
/// The raw C file permissions.
@_alwaysEmitIntoClient
public let rawValue: CModeT
@@ -27,104 +27,101 @@ public struct FilePermissions: OptionSet, Hashable, Codable {
@_alwaysEmitIntoClient
public init(rawValue: CModeT) { self.rawValue = rawValue }
@_alwaysEmitIntoClient
private init(_ raw: CModeT) { self.init(rawValue: raw) }
/// Indicates that other users have read-only permission.
@_alwaysEmitIntoClient
public static var otherRead: FilePermissions { FilePermissions(0o4) }
public static var otherRead: FilePermissions { .init(rawValue: 0o4) }
/// Indicates that other users have write-only permission.
@_alwaysEmitIntoClient
public static var otherWrite: FilePermissions { FilePermissions(0o2) }
public static var otherWrite: FilePermissions { .init(rawValue: 0o2) }
/// Indicates that other users have execute-only permission.
@_alwaysEmitIntoClient
public static var otherExecute: FilePermissions { FilePermissions(0o1) }
public static var otherExecute: FilePermissions { .init(rawValue: 0o1) }
/// Indicates that other users have read-write permission.
@_alwaysEmitIntoClient
public static var otherReadWrite: FilePermissions { FilePermissions(0o6) }
public static var otherReadWrite: FilePermissions { .init(rawValue: 0o6) }
/// Indicates that other users have read-execute permission.
@_alwaysEmitIntoClient
public static var otherReadExecute: FilePermissions { FilePermissions(0o5) }
public static var otherReadExecute: FilePermissions { .init(rawValue: 0o5) }
/// Indicates that other users have write-execute permission.
@_alwaysEmitIntoClient
public static var otherWriteExecute: FilePermissions { FilePermissions(0o3) }
public static var otherWriteExecute: FilePermissions { .init(rawValue: 0o3) }
/// Indicates that other users have read, write, and execute permission.
@_alwaysEmitIntoClient
public static var otherReadWriteExecute: FilePermissions { FilePermissions(0o7) }
public static var otherReadWriteExecute: FilePermissions { .init(rawValue: 0o7) }
/// Indicates that the group has read-only permission.
@_alwaysEmitIntoClient
public static var groupRead: FilePermissions { FilePermissions(0o40) }
public static var groupRead: FilePermissions { .init(rawValue: 0o40) }
/// Indicates that the group has write-only permission.
@_alwaysEmitIntoClient
public static var groupWrite: FilePermissions { FilePermissions(0o20) }
public static var groupWrite: FilePermissions { .init(rawValue: 0o20) }
/// Indicates that the group has execute-only permission.
@_alwaysEmitIntoClient
public static var groupExecute: FilePermissions { FilePermissions(0o10) }
public static var groupExecute: FilePermissions { .init(rawValue: 0o10) }
/// Indicates that the group has read-write permission.
@_alwaysEmitIntoClient
public static var groupReadWrite: FilePermissions { FilePermissions(0o60) }
public static var groupReadWrite: FilePermissions { .init(rawValue: 0o60) }
/// Indicates that the group has read-execute permission.
@_alwaysEmitIntoClient
public static var groupReadExecute: FilePermissions { FilePermissions(0o50) }
public static var groupReadExecute: FilePermissions { .init(rawValue: 0o50) }
/// Indicates that the group has write-execute permission.
@_alwaysEmitIntoClient
public static var groupWriteExecute: FilePermissions { FilePermissions(0o30) }
public static var groupWriteExecute: FilePermissions { .init(rawValue: 0o30) }
/// Indicates that the group has read, write, and execute permission.
@_alwaysEmitIntoClient
public static var groupReadWriteExecute: FilePermissions { FilePermissions(0o70) }
public static var groupReadWriteExecute: FilePermissions { .init(rawValue: 0o70) }
/// Indicates that the owner has read-only permission.
@_alwaysEmitIntoClient
public static var ownerRead: FilePermissions { FilePermissions(0o400) }
public static var ownerRead: FilePermissions { .init(rawValue: 0o400) }
/// Indicates that the owner has write-only permission.
@_alwaysEmitIntoClient
public static var ownerWrite: FilePermissions { FilePermissions(0o200) }
public static var ownerWrite: FilePermissions { .init(rawValue: 0o200) }
/// Indicates that the owner has execute-only permission.
@_alwaysEmitIntoClient
public static var ownerExecute: FilePermissions { FilePermissions(0o100) }
public static var ownerExecute: FilePermissions { .init(rawValue: 0o100) }
/// Indicates that the owner has read-write permission.
@_alwaysEmitIntoClient
public static var ownerReadWrite: FilePermissions { FilePermissions(0o600) }
public static var ownerReadWrite: FilePermissions { .init(rawValue: 0o600) }
/// Indicates that the owner has read-execute permission.
@_alwaysEmitIntoClient
public static var ownerReadExecute: FilePermissions { FilePermissions(0o500) }
public static var ownerReadExecute: FilePermissions { .init(rawValue: 0o500) }
/// Indicates that the owner has write-execute permission.
@_alwaysEmitIntoClient
public static var ownerWriteExecute: FilePermissions { FilePermissions(0o300) }
public static var ownerWriteExecute: FilePermissions { .init(rawValue: 0o300) }
/// Indicates that the owner has read, write, and execute permission.
@_alwaysEmitIntoClient
public static var ownerReadWriteExecute: FilePermissions { FilePermissions(0o700) }
public static var ownerReadWriteExecute: FilePermissions { .init(rawValue: 0o700) }
/// Indicates that the file is executed as the owner.
///
/// For more information, see the `setuid(2)` man page.
@_alwaysEmitIntoClient
public static var setUserID: FilePermissions { FilePermissions(0o4000) }
public static var setUserID: FilePermissions { .init(rawValue: 0o4000) }
/// Indicates that the file is executed as the group.
///
/// For more information, see the `setgid(2)` man page.
@_alwaysEmitIntoClient
public static var setGroupID: FilePermissions { FilePermissions(0o2000) }
public static var setGroupID: FilePermissions { .init(rawValue: 0o2000) }
/// Indicates that executable's text segment
/// should be kept in swap space even after it exits.
@@ -132,7 +129,7 @@ public struct FilePermissions: OptionSet, Hashable, Codable {
/// For more information, see the `chmod(2)` man page's
/// discussion of `S_ISVTX` (the sticky bit).
@_alwaysEmitIntoClient
public static var saveText: FilePermissions { FilePermissions(0o1000) }
public static var saveText: FilePermissions { .init(rawValue: 0o1000) }
}
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
@@ -175,7 +172,3 @@ extension FilePermissions
/// A textual representation of the file permissions, suitable for debugging.
public var debugDescription: String { self.description }
}
#if compiler(>=5.5) && canImport(_Concurrency)
extension FilePermissions: Sendable {}
#endif
+13 -5
View File
@@ -1,20 +1,28 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2020 - 2021 Apple Inc. and the Swift System project authors
Copyright (c) 2020 - 2024 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
*/
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if SYSTEM_PACKAGE_DARWIN
import Darwin
#elseif os(Linux) || os(FreeBSD) || os(OpenBSD) || os(Android)
@_implementationOnly import CSystem
import Glibc
#elseif os(Windows)
import CSystem
import ucrt
#elseif canImport(Glibc)
@_implementationOnly import CSystem
import Glibc
#elseif canImport(Musl)
@_implementationOnly import CSystem
import Musl
#elseif canImport(WASILibc)
import WASILibc
#elseif canImport(Bionic)
@_implementationOnly import CSystem
import Bionic
#else
#error("Unsupported Platform")
#endif
+138 -30
View File
@@ -1,7 +1,7 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2020 - 2021 Apple Inc. and the Swift System project authors
Copyright (c) 2020 - 2024 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
@@ -11,19 +11,27 @@
// they can be used anywhere without imports and without confusion to
// unavailable local decls.
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if SYSTEM_PACKAGE_DARWIN
import Darwin
#elseif os(Linux) || os(FreeBSD) || os(OpenBSD) || os(Android)
import Glibc
#elseif os(Windows)
import CSystem
import ucrt
#elseif canImport(Glibc)
import Glibc
#elseif canImport(Musl)
import CSystem
import Musl
#elseif canImport(WASILibc)
import CSystem
import WASILibc
#elseif canImport(Android)
import Android
#else
#error("Unsupported Platform")
#endif
// MARK: errno
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if SYSTEM_PACKAGE_DARWIN
@_alwaysEmitIntoClient
internal var _ERRNO_NOT_USED: CInt { 0 }
#endif
@@ -70,7 +78,7 @@ internal var _EACCES: CInt { EACCES }
@_alwaysEmitIntoClient
internal var _EFAULT: CInt { EFAULT }
#if !os(Windows)
#if !os(Windows) && !os(WASI)
@_alwaysEmitIntoClient
internal var _ENOTBLK: CInt { ENOTBLK }
#endif
@@ -138,7 +146,13 @@ internal var _ERANGE: CInt { ERANGE }
internal var _EAGAIN: CInt { EAGAIN }
@_alwaysEmitIntoClient
internal var _EWOULDBLOCK: CInt { EWOULDBLOCK }
internal var _EWOULDBLOCK: CInt {
#if os(WASI)
_getConst_EWOULDBLOCK()
#else
EWOULDBLOCK
#endif
}
@_alwaysEmitIntoClient
internal var _EINPROGRESS: CInt { EINPROGRESS }
@@ -164,6 +178,7 @@ internal var _ENOPROTOOPT: CInt { ENOPROTOOPT }
@_alwaysEmitIntoClient
internal var _EPROTONOSUPPORT: CInt { EPROTONOSUPPORT }
#if !os(WASI)
@_alwaysEmitIntoClient
internal var _ESOCKTNOSUPPORT: CInt {
#if os(Windows)
@@ -172,6 +187,7 @@ internal var _ESOCKTNOSUPPORT: CInt {
return ESOCKTNOSUPPORT
#endif
}
#endif
@_alwaysEmitIntoClient
internal var _ENOTSUP: CInt {
@@ -182,6 +198,7 @@ internal var _ENOTSUP: CInt {
#endif
}
#if !os(WASI)
@_alwaysEmitIntoClient
internal var _EPFNOSUPPORT: CInt {
#if os(Windows)
@@ -190,6 +207,7 @@ internal var _EPFNOSUPPORT: CInt {
return EPFNOSUPPORT
#endif
}
#endif
@_alwaysEmitIntoClient
internal var _EAFNOSUPPORT: CInt { EAFNOSUPPORT }
@@ -224,6 +242,7 @@ internal var _EISCONN: CInt { EISCONN }
@_alwaysEmitIntoClient
internal var _ENOTCONN: CInt { ENOTCONN }
#if !os(WASI)
@_alwaysEmitIntoClient
internal var _ESHUTDOWN: CInt {
#if os(Windows)
@@ -241,6 +260,7 @@ internal var _ETOOMANYREFS: CInt {
return ETOOMANYREFS
#endif
}
#endif
@_alwaysEmitIntoClient
internal var _ETIMEDOUT: CInt { ETIMEDOUT }
@@ -254,6 +274,7 @@ internal var _ELOOP: CInt { ELOOP }
@_alwaysEmitIntoClient
internal var _ENAMETOOLONG: CInt { ENAMETOOLONG }
#if !os(WASI)
@_alwaysEmitIntoClient
internal var _EHOSTDOWN: CInt {
#if os(Windows)
@@ -262,6 +283,7 @@ internal var _EHOSTDOWN: CInt {
return EHOSTDOWN
#endif
}
#endif
@_alwaysEmitIntoClient
internal var _EHOSTUNREACH: CInt { EHOSTUNREACH }
@@ -269,11 +291,12 @@ internal var _EHOSTUNREACH: CInt { EHOSTUNREACH }
@_alwaysEmitIntoClient
internal var _ENOTEMPTY: CInt { ENOTEMPTY }
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if SYSTEM_PACKAGE_DARWIN
@_alwaysEmitIntoClient
internal var _EPROCLIM: CInt { EPROCLIM }
#endif
#if !os(WASI)
@_alwaysEmitIntoClient
internal var _EUSERS: CInt {
#if os(Windows)
@@ -282,6 +305,7 @@ internal var _EUSERS: CInt {
return EUSERS
#endif
}
#endif
@_alwaysEmitIntoClient
internal var _EDQUOT: CInt {
@@ -301,6 +325,7 @@ internal var _ESTALE: CInt {
#endif
}
#if !os(WASI)
@_alwaysEmitIntoClient
internal var _EREMOTE: CInt {
#if os(Windows)
@@ -309,8 +334,9 @@ internal var _EREMOTE: CInt {
return EREMOTE
#endif
}
#endif
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if SYSTEM_PACKAGE_DARWIN
@_alwaysEmitIntoClient
internal var _EBADRPC: CInt { EBADRPC }
@@ -333,7 +359,7 @@ internal var _ENOLCK: CInt { ENOLCK }
@_alwaysEmitIntoClient
internal var _ENOSYS: CInt { ENOSYS }
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if SYSTEM_PACKAGE_DARWIN || os(FreeBSD)
@_alwaysEmitIntoClient
internal var _EFTYPE: CInt { EFTYPE }
@@ -342,7 +368,9 @@ internal var _EAUTH: CInt { EAUTH }
@_alwaysEmitIntoClient
internal var _ENEEDAUTH: CInt { ENEEDAUTH }
#endif
#if SYSTEM_PACKAGE_DARWIN
@_alwaysEmitIntoClient
internal var _EPWROFF: CInt { EPWROFF }
@@ -355,7 +383,7 @@ internal var _EDEVERR: CInt { EDEVERR }
internal var _EOVERFLOW: CInt { EOVERFLOW }
#endif
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if SYSTEM_PACKAGE_DARWIN
@_alwaysEmitIntoClient
internal var _EBADEXEC: CInt { EBADEXEC }
@@ -383,7 +411,7 @@ internal var _ENOMSG: CInt { ENOMSG }
@_alwaysEmitIntoClient
internal var _EILSEQ: CInt { EILSEQ }
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if SYSTEM_PACKAGE_DARWIN || os(FreeBSD)
@_alwaysEmitIntoClient
internal var _ENOATTR: CInt { ENOATTR }
#endif
@@ -396,32 +424,43 @@ internal var _EBADMSG: CInt { EBADMSG }
@_alwaysEmitIntoClient
internal var _EMULTIHOP: CInt { EMULTIHOP }
#if !os(WASI) && !os(FreeBSD)
@_alwaysEmitIntoClient
internal var _ENODATA: CInt { ENODATA }
#endif
@_alwaysEmitIntoClient
internal var _ENOLINK: CInt { ENOLINK }
#if !os(WASI) && !os(FreeBSD)
@_alwaysEmitIntoClient
internal var _ENOSR: CInt { ENOSR }
@_alwaysEmitIntoClient
internal var _ENOSTR: CInt { ENOSTR }
#endif
#endif
@_alwaysEmitIntoClient
internal var _EPROTO: CInt { EPROTO }
#if !os(OpenBSD)
#if !os(OpenBSD) && !os(WASI) && !os(FreeBSD)
@_alwaysEmitIntoClient
internal var _ETIME: CInt { ETIME }
#endif
#endif
@_alwaysEmitIntoClient
internal var _EOPNOTSUPP: CInt { EOPNOTSUPP }
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
@_alwaysEmitIntoClient
internal var _EOPNOTSUPP: CInt {
#if os(WASI)
_getConst_EOPNOTSUPP()
#else
EOPNOTSUPP
#endif
}
#if SYSTEM_PACKAGE_DARWIN
@_alwaysEmitIntoClient
internal var _ENOPOLICY: CInt { ENOPOLICY }
#endif
@@ -434,10 +473,23 @@ internal var _ENOTRECOVERABLE: CInt { ENOTRECOVERABLE }
internal var _EOWNERDEAD: CInt { EOWNERDEAD }
#endif
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if os(FreeBSD)
@_alwaysEmitIntoClient
internal var _ENOTCAPABLE: CInt { ENOTCAPABLE }
@_alwaysEmitIntoClient
internal var _ECAPMODE: CInt { ECAPMODE }
@_alwaysEmitIntoClient
internal var _EINTEGRITY: CInt { EINTEGRITY }
#endif
#if SYSTEM_PACKAGE_DARWIN
@_alwaysEmitIntoClient
internal var _EQFULL: CInt { EQFULL }
#endif
#if SYSTEM_PACKAGE_DARWIN || os(FreeBSD)
@_alwaysEmitIntoClient
internal var _ELAST: CInt { ELAST }
#endif
@@ -454,18 +506,40 @@ internal var _O_WRONLY: CInt { O_WRONLY }
internal var _O_RDWR: CInt { O_RDWR }
#if !os(Windows)
#if canImport(Musl)
internal var _O_ACCMODE: CInt { 0x03|O_SEARCH }
#else
// TODO: API?
@_alwaysEmitIntoClient
internal var _O_ACCMODE: CInt { O_ACCMODE }
@_alwaysEmitIntoClient
internal var _O_NONBLOCK: CInt { O_NONBLOCK }
internal var _O_ACCMODE: CInt {
#if os(WASI)
_getConst_O_ACCMODE()
#else
O_ACCMODE
#endif
}
#endif
@_alwaysEmitIntoClient
internal var _O_APPEND: CInt { O_APPEND }
internal var _O_NONBLOCK: CInt {
#if os(WASI)
_getConst_O_NONBLOCK()
#else
O_NONBLOCK
#endif
}
#endif
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
@_alwaysEmitIntoClient
internal var _O_APPEND: CInt {
#if os(WASI)
_getConst_O_APPEND()
#else
O_APPEND
#endif
}
#if SYSTEM_PACKAGE_DARWIN || os(FreeBSD)
@_alwaysEmitIntoClient
internal var _O_SHLOCK: CInt { O_SHLOCK }
@@ -474,24 +548,52 @@ internal var _O_EXLOCK: CInt { O_EXLOCK }
#endif
#if !os(Windows)
#if !os(WASI)
// TODO: API?
@_alwaysEmitIntoClient
internal var _O_ASYNC: CInt { O_ASYNC }
#endif
@_alwaysEmitIntoClient
internal var _O_NOFOLLOW: CInt { O_NOFOLLOW }
#endif
#if os(FreeBSD)
@_alwaysEmitIntoClient
internal var _O_CREAT: CInt { O_CREAT }
internal var _O_FSYNC: CInt { O_FSYNC }
@_alwaysEmitIntoClient
internal var _O_TRUNC: CInt { O_TRUNC }
internal var _O_SYNC: CInt { O_SYNC }
#endif
@_alwaysEmitIntoClient
internal var _O_EXCL: CInt { O_EXCL }
internal var _O_CREAT: CInt {
#if os(WASI)
_getConst_O_CREAT()
#else
O_CREAT
#endif
}
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
@_alwaysEmitIntoClient
internal var _O_TRUNC: CInt {
#if os(WASI)
_getConst_O_TRUNC()
#else
O_TRUNC
#endif
}
@_alwaysEmitIntoClient
internal var _O_EXCL: CInt {
#if os(WASI)
_getConst_O_EXCL()
#else
O_EXCL
#endif
}
#if SYSTEM_PACKAGE_DARWIN
@_alwaysEmitIntoClient
internal var _O_EVTONLY: CInt { O_EVTONLY }
#endif
@@ -502,10 +604,16 @@ internal var _O_EVTONLY: CInt { O_EVTONLY }
internal var _O_NOCTTY: CInt { O_NOCTTY }
@_alwaysEmitIntoClient
internal var _O_DIRECTORY: CInt { O_DIRECTORY }
internal var _O_DIRECTORY: CInt {
#if os(WASI)
_getConst_O_DIRECTORY()
#else
O_DIRECTORY
#endif
}
#endif
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if SYSTEM_PACKAGE_DARWIN
@_alwaysEmitIntoClient
internal var _O_SYMLINK: CInt { O_SYMLINK }
#endif
@@ -524,7 +632,7 @@ internal var _SEEK_CUR: CInt { SEEK_CUR }
@_alwaysEmitIntoClient
internal var _SEEK_END: CInt { SEEK_END }
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if SYSTEM_PACKAGE_DARWIN || os(FreeBSD)
@_alwaysEmitIntoClient
internal var _SEEK_HOLE: CInt { SEEK_HOLE }
+50 -7
View File
@@ -1,7 +1,7 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2020 - 2021 Apple Inc. and the Swift System project authors
Copyright (c) 2020 - 2024 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
@@ -12,14 +12,22 @@
// TODO: Should CSystem just include all the header files we need?
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if SYSTEM_PACKAGE_DARWIN
import Darwin
#elseif os(Linux) || os(FreeBSD) || os(OpenBSD) || os(Android)
@_implementationOnly import CSystem
import Glibc
#elseif os(Windows)
import CSystem
import ucrt
#elseif canImport(Glibc)
@_implementationOnly import CSystem
import Glibc
#elseif canImport(Musl)
@_implementationOnly import CSystem
import Musl
#elseif canImport(WASILibc)
import WASILibc
#elseif canImport(Android)
@_implementationOnly import CSystem
import Android
#else
#error("Unsupported Platform")
#endif
@@ -28,7 +36,7 @@ internal typealias _COffT = off_t
// MARK: syscalls and variables
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if SYSTEM_PACKAGE_DARWIN
internal var system_errno: CInt {
get { Darwin.errno }
set { Darwin.errno = newValue }
@@ -45,11 +53,26 @@ internal var system_errno: CInt {
_ = ucrt._set_errno(newValue)
}
}
#else
#elseif canImport(Glibc)
internal var system_errno: CInt {
get { Glibc.errno }
set { Glibc.errno = newValue }
}
#elseif canImport(Musl)
internal var system_errno: CInt {
get { Musl.errno }
set { Musl.errno = newValue }
}
#elseif canImport(WASILibc)
internal var system_errno: CInt {
get { WASILibc.errno }
set { WASILibc.errno = newValue }
}
#elseif canImport(Android)
internal var system_errno: CInt {
get { Android.errno }
set { Android.errno = newValue }
}
#endif
// MARK: C stdlib decls
@@ -141,6 +164,24 @@ extension String {
// TLS
#if os(Windows)
internal typealias _PlatformTLSKey = DWORD
#elseif os(WASI) && (swift(<6.1) || !_runtime(_multithreaded))
// Mock TLS storage for single-threaded WASI
internal final class _PlatformTLSKey {
fileprivate init() {}
}
private final class TLSStorage: @unchecked Sendable {
var storage = [ObjectIdentifier: UnsafeMutableRawPointer]()
}
private let sharedTLSStorage = TLSStorage()
func pthread_setspecific(_ key: _PlatformTLSKey, _ p: UnsafeMutableRawPointer?) -> Int {
sharedTLSStorage.storage[ObjectIdentifier(key)] = p
return 0
}
func pthread_getspecific(_ key: _PlatformTLSKey) -> UnsafeMutableRawPointer? {
sharedTLSStorage.storage[ObjectIdentifier(key)]
}
#else
internal typealias _PlatformTLSKey = pthread_key_t
#endif
@@ -152,6 +193,8 @@ internal func makeTLSKey() -> _PlatformTLSKey {
fatalError("Unable to create key")
}
return raw
#elseif os(WASI) && (swift(<6.1) || !_runtime(_multithreaded))
return _PlatformTLSKey()
#else
var raw = pthread_key_t()
guard 0 == pthread_key_create(&raw, nil) else {
+6 -10
View File
@@ -63,7 +63,7 @@ internal class MockingDriver {
// Whether we should pretend to be Windows for syntactic operations
// inside FilePath
fileprivate var forceWindowsSyntaxForPaths = false
fileprivate var forceWindowsSyntaxForPaths: Bool? = nil
}
private let driverKey: _PlatformTLSKey = { makeTLSKey() }()
@@ -110,8 +110,8 @@ private var contextualMockingEnabled: Bool {
extension MockingDriver {
internal static var enabled: Bool { mockingEnabled }
internal static var forceWindowsPaths: Bool {
currentMockingDriver?.forceWindowsSyntaxForPaths ?? false
internal static var forceWindowsPaths: Bool? {
currentMockingDriver?.forceWindowsSyntaxForPaths
}
}
@@ -128,7 +128,7 @@ internal var mockingEnabled: Bool {
}
@inline(__always)
internal var forceWindowsPaths: Bool {
internal var forceWindowsPaths: Bool? {
#if !ENABLE_MOCKING
return false
#else
@@ -196,15 +196,11 @@ internal func _mockOffT(
#endif // ENABLE_MOCKING
// Force paths to be treated as Windows syntactically if `enabled` is
// true.
// true, and as POSIX syntactically if not.
internal func _withWindowsPaths(enabled: Bool, _ body: () -> ()) {
#if ENABLE_MOCKING
guard enabled else {
body()
return
}
MockingDriver.withMockingEnabled { driver in
driver.forceWindowsSyntaxForPaths = true
driver.forceWindowsSyntaxForPaths = enabled
body()
}
#else
+7 -1
View File
@@ -80,7 +80,13 @@ extension _RawBuffer {
internal static func create(minimumCapacity: Int) -> Storage {
Storage.create(
minimumCapacity: minimumCapacity,
makingHeaderWith: { $0.capacity }
makingHeaderWith: {
#if os(OpenBSD)
minimumCapacity
#else
$0.capacity
#endif
}
) as! Storage
}
}
+129 -5
View File
@@ -1,18 +1,24 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2020 - 2021 Apple Inc. and the Swift System project authors
Copyright (c) 2020 - 2024 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
*/
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if SYSTEM_PACKAGE_DARWIN
import Darwin
#elseif os(Linux) || os(FreeBSD) || os(OpenBSD) || os(Android)
#elseif canImport(Glibc)
import Glibc
#elseif canImport(Musl)
import Musl
#elseif canImport(WASILibc)
import WASILibc
#elseif os(Windows)
import ucrt
#elseif canImport(Android)
import Android
#else
#error("Unsupported Platform")
#endif
@@ -69,7 +75,15 @@ internal func system_pread(
#if ENABLE_MOCKING
if mockingEnabled { return _mockInt(fd, buf, nbyte, offset) }
#endif
#if os(Android)
var zero = UInt8.zero
return withUnsafeMutablePointer(to: &zero) {
// this pread has a non-nullable `buf` pointer
pread(fd, buf ?? UnsafeMutableRawPointer($0), nbyte, offset)
}
#else
return pread(fd, buf, nbyte, offset)
#endif
}
// lseek
@@ -99,9 +113,18 @@ internal func system_pwrite(
#if ENABLE_MOCKING
if mockingEnabled { return _mockInt(fd, buf, nbyte, offset) }
#endif
#if os(Android)
var zero = UInt8.zero
return withUnsafeMutablePointer(to: &zero) {
// this pwrite has a non-nullable `buf` pointer
pwrite(fd, buf ?? UnsafeRawPointer($0), nbyte, offset)
}
#else
return pwrite(fd, buf, nbyte, offset)
#endif
}
#if !os(WASI)
internal func system_dup(_ fd: Int32) -> Int32 {
#if ENABLE_MOCKING
if mockingEnabled { return _mock(fd) }
@@ -115,8 +138,9 @@ internal func system_dup2(_ fd: Int32, _ fd2: Int32) -> Int32 {
#endif
return dup2(fd, fd2)
}
#endif
#if !os(Windows)
#if !os(WASI)
internal func system_pipe(_ fds: UnsafeMutablePointer<Int32>) -> CInt {
#if ENABLE_MOCKING
if mockingEnabled { return _mock(fds) }
@@ -125,11 +149,111 @@ internal func system_pipe(_ fds: UnsafeMutablePointer<Int32>) -> CInt {
}
#endif
#if !os(Windows)
internal func system_ftruncate(_ fd: Int32, _ length: off_t) -> Int32 {
#if ENABLE_MOCKING
if mockingEnabled { return _mock(fd, length) }
#endif
return ftruncate(fd, length)
}
internal func system_mkdir(
_ path: UnsafePointer<CInterop.PlatformChar>,
_ mode: CInterop.Mode
) -> CInt {
#if ENABLE_MOCKING
if mockingEnabled { return _mock(path: path, mode) }
#endif
return mkdir(path, mode)
}
internal func system_rmdir(
_ path: UnsafePointer<CInterop.PlatformChar>
) -> CInt {
#if ENABLE_MOCKING
if mockingEnabled { return _mock(path: path) }
#endif
return rmdir(path)
}
#if SYSTEM_PACKAGE_DARWIN
internal let SYSTEM_CS_DARWIN_USER_TEMP_DIR = _CS_DARWIN_USER_TEMP_DIR
internal func system_confstr(
_ name: CInt,
_ buf: UnsafeMutablePointer<CInterop.PlatformChar>,
_ len: Int
) -> Int {
return confstr(name, buf, len)
}
#endif
#if !os(Windows)
internal let SYSTEM_AT_REMOVE_DIR = AT_REMOVEDIR
internal let SYSTEM_DT_DIR = DT_DIR
internal typealias system_dirent = dirent
#if os(Linux) || os(Android) || os(FreeBSD) || os(OpenBSD)
internal typealias system_DIRPtr = OpaquePointer
#else
internal typealias system_DIRPtr = UnsafeMutablePointer<DIR>
#endif
internal func system_unlinkat(
_ fd: CInt,
_ path: UnsafePointer<CInterop.PlatformChar>,
_ flag: CInt
) -> CInt {
#if ENABLE_MOCKING
if mockingEnabled { return _mock(fd, path, flag) }
#endif
return unlinkat(fd, path, flag)
}
internal func system_fdopendir(
_ fd: CInt
) -> system_DIRPtr? {
return fdopendir(fd)
}
internal func system_readdir(
_ dir: system_DIRPtr
) -> UnsafeMutablePointer<dirent>? {
return readdir(dir)
}
internal func system_rewinddir(
_ dir: system_DIRPtr
) {
return rewinddir(dir)
}
internal func system_closedir(
_ dir: system_DIRPtr
) -> CInt {
return closedir(dir)
}
internal func system_openat(
_ fd: CInt,
_ path: UnsafePointer<CInterop.PlatformChar>,
_ oflag: Int32
) -> CInt {
#if ENABLE_MOCKING
if mockingEnabled {
return _mock(fd, path, oflag)
}
#endif
return openat(fd, path, oflag)
}
#endif
internal func system_umask(
_ mode: CInterop.Mode
) -> CInterop.Mode {
return umask(mode)
}
internal func system_getenv(
_ name: UnsafePointer<CChar>
) -> UnsafeMutablePointer<CChar>? {
return getenv(name)
}
@@ -12,13 +12,45 @@
import ucrt
import WinSDK
fileprivate var _umask: CInterop.Mode = 0o22
@inline(__always)
func umask(
_ mode: CInterop.Mode
) -> CInterop.Mode {
let oldMask = _umask
_umask = mode
return oldMask
}
@inline(__always)
internal func open(
_ path: UnsafePointer<CInterop.PlatformChar>, _ oflag: Int32
) -> CInt {
var fh: CInt = -1
_ = _wsopen_s(&fh, path, oflag, _SH_DENYNO, _S_IREAD | _S_IWRITE)
return fh
let decodedFlags = DecodedOpenFlags(oflag)
var saAttrs = SECURITY_ATTRIBUTES(
nLength: DWORD(MemoryLayout<SECURITY_ATTRIBUTES>.size),
lpSecurityDescriptor: nil,
bInheritHandle: decodedFlags.bInheritHandle
)
let hFile = CreateFileW(path,
decodedFlags.dwDesiredAccess,
DWORD(FILE_SHARE_DELETE
| FILE_SHARE_READ
| FILE_SHARE_WRITE),
&saAttrs,
decodedFlags.dwCreationDisposition,
decodedFlags.dwFlagsAndAttributes,
nil)
if hFile == INVALID_HANDLE_VALUE {
ucrt._set_errno(_mapWindowsErrorToErrno(GetLastError()))
return -1
}
return _open_osfhandle(intptr_t(bitPattern: hFile), oflag);
}
@inline(__always)
@@ -26,10 +58,41 @@ internal func open(
_ path: UnsafePointer<CInterop.PlatformChar>, _ oflag: Int32,
_ mode: CInterop.Mode
) -> CInt {
// TODO(compnerd): Apply read/write permissions
var fh: CInt = -1
_ = _wsopen_s(&fh, path, oflag, _SH_DENYNO, _S_IREAD | _S_IWRITE)
return fh
let actualMode = mode & ~_umask
guard let pSD = _createSecurityDescriptor(from: actualMode, for: .file) else {
ucrt._set_errno(_mapWindowsErrorToErrno(GetLastError()))
return -1
}
defer {
pSD.deallocate()
}
let decodedFlags = DecodedOpenFlags(oflag)
var saAttrs = SECURITY_ATTRIBUTES(
nLength: DWORD(MemoryLayout<SECURITY_ATTRIBUTES>.size),
lpSecurityDescriptor: pSD,
bInheritHandle: decodedFlags.bInheritHandle
)
let hFile = CreateFileW(path,
decodedFlags.dwDesiredAccess,
DWORD(FILE_SHARE_DELETE
| FILE_SHARE_READ
| FILE_SHARE_WRITE),
&saAttrs,
decodedFlags.dwCreationDisposition,
decodedFlags.dwFlagsAndAttributes,
nil)
if hFile == INVALID_HANDLE_VALUE {
ucrt._set_errno(_mapWindowsErrorToErrno(GetLastError()))
return -1
}
return _open_osfhandle(intptr_t(bitPattern: hFile), oflag);
}
@inline(__always)
@@ -80,7 +143,7 @@ internal func pread(
_ fd: Int32, _ buf: UnsafeMutableRawPointer!, _ nbyte: Int, _ offset: off_t
) -> Int {
let handle: intptr_t = _get_osfhandle(fd)
if handle == /* INVALID_HANDLE_VALUE */ -1 { return Int(EBADF) }
if handle == /* INVALID_HANDLE_VALUE */ -1 { ucrt._set_errno(EBADF); return -1 }
// NOTE: this is a non-owning handle, do *not* call CloseHandle on it
let hFile: HANDLE = HANDLE(bitPattern: handle)!
@@ -91,8 +154,7 @@ internal func pread(
var nNumberOfBytesRead: DWORD = 0
if !ReadFile(hFile, buf, DWORD(nbyte), &nNumberOfBytesRead, &ovlOverlapped) {
let _ = GetLastError()
// TODO(compnerd) map windows error to errno
ucrt._set_errno(_mapWindowsErrorToErrno(GetLastError()))
return Int(-1)
}
return Int(nNumberOfBytesRead)
@@ -103,7 +165,7 @@ internal func pwrite(
_ fd: Int32, _ buf: UnsafeRawPointer!, _ nbyte: Int, _ offset: off_t
) -> Int {
let handle: intptr_t = _get_osfhandle(fd)
if handle == /* INVALID_HANDLE_VALUE */ -1 { return Int(EBADF) }
if handle == /* INVALID_HANDLE_VALUE */ -1 { ucrt._set_errno(EBADF); return -1 }
// NOTE: this is a non-owning handle, do *not* call CloseHandle on it
let hFile: HANDLE = HANDLE(bitPattern: handle)!
@@ -115,11 +177,482 @@ internal func pwrite(
var nNumberOfBytesWritten: DWORD = 0
if !WriteFile(hFile, buf, DWORD(nbyte), &nNumberOfBytesWritten,
&ovlOverlapped) {
let _ = GetLastError()
// TODO(compnerd) map windows error to errno
ucrt._set_errno(_mapWindowsErrorToErrno(GetLastError()))
return Int(-1)
}
return Int(nNumberOfBytesWritten)
}
@inline(__always)
internal func pipe(
_ fds: UnsafeMutablePointer<Int32>, bytesReserved: UInt32 = 4096
) -> CInt {
return _pipe(fds, bytesReserved, _O_BINARY | _O_NOINHERIT);
}
@inline(__always)
internal func ftruncate(_ fd: Int32, _ length: off_t) -> Int32 {
let handle: intptr_t = _get_osfhandle(fd)
if handle == /* INVALID_HANDLE_VALUE */ -1 { ucrt._set_errno(EBADF); return -1 }
// NOTE: this is a non-owning handle, do *not* call CloseHandle on it
let hFile: HANDLE = HANDLE(bitPattern: handle)!
let liDesiredLength = LARGE_INTEGER(QuadPart: LONGLONG(length))
var liCurrentOffset = LARGE_INTEGER(QuadPart: 0)
// Save the current position and restore it when we're done
if !SetFilePointerEx(hFile, liCurrentOffset, &liCurrentOffset,
DWORD(FILE_CURRENT)) {
ucrt._set_errno(_mapWindowsErrorToErrno(GetLastError()))
return -1
}
defer {
_ = SetFilePointerEx(hFile, liCurrentOffset, nil, DWORD(FILE_BEGIN));
}
// Truncate (or extend) the file
if !SetFilePointerEx(hFile, liDesiredLength, nil, DWORD(FILE_BEGIN))
|| !SetEndOfFile(hFile) {
ucrt._set_errno(_mapWindowsErrorToErrno(GetLastError()))
return -1
}
return 0;
}
@inline(__always)
internal func mkdir(
_ path: UnsafePointer<CInterop.PlatformChar>,
_ mode: CInterop.Mode
) -> CInt {
let actualMode = mode & ~_umask
guard let pSD = _createSecurityDescriptor(from: actualMode,
for: .directory) else {
ucrt._set_errno(_mapWindowsErrorToErrno(GetLastError()))
return -1
}
defer {
pSD.deallocate()
}
var saAttrs = SECURITY_ATTRIBUTES(
nLength: DWORD(MemoryLayout<SECURITY_ATTRIBUTES>.size),
lpSecurityDescriptor: pSD,
bInheritHandle: false
)
if !CreateDirectoryW(path, &saAttrs) {
ucrt._set_errno(_mapWindowsErrorToErrno(GetLastError()))
return -1
}
return 0;
}
@inline(__always)
internal func rmdir(
_ path: UnsafePointer<CInterop.PlatformChar>
) -> CInt {
if !RemoveDirectoryW(path) {
ucrt._set_errno(_mapWindowsErrorToErrno(GetLastError()))
return -1
}
return 0;
}
internal func _mapWindowsErrorToErrno(_ errorCode: DWORD) -> CInt {
switch Int32(errorCode) {
case ERROR_SUCCESS:
return 0
case ERROR_INVALID_FUNCTION,
ERROR_INVALID_ACCESS,
ERROR_INVALID_DATA,
ERROR_INVALID_PARAMETER,
ERROR_NEGATIVE_SEEK:
return EINVAL
case ERROR_FILE_NOT_FOUND,
ERROR_PATH_NOT_FOUND,
ERROR_INVALID_DRIVE,
ERROR_NO_MORE_FILES,
ERROR_BAD_NETPATH,
ERROR_BAD_NET_NAME,
ERROR_BAD_PATHNAME,
ERROR_FILENAME_EXCED_RANGE:
return ENOENT
case ERROR_TOO_MANY_OPEN_FILES:
return EMFILE
case ERROR_ACCESS_DENIED,
ERROR_CURRENT_DIRECTORY,
ERROR_LOCK_VIOLATION,
ERROR_NETWORK_ACCESS_DENIED,
ERROR_CANNOT_MAKE,
ERROR_FAIL_I24,
ERROR_DRIVE_LOCKED,
ERROR_SEEK_ON_DEVICE,
ERROR_NOT_LOCKED,
ERROR_LOCK_FAILED,
ERROR_WRITE_PROTECT...ERROR_SHARING_BUFFER_EXCEEDED:
return EACCES
case ERROR_INVALID_HANDLE,
ERROR_INVALID_TARGET_HANDLE,
ERROR_DIRECT_ACCESS_HANDLE:
return EBADF
case ERROR_ARENA_TRASHED,
ERROR_NOT_ENOUGH_MEMORY,
ERROR_INVALID_BLOCK,
ERROR_NOT_ENOUGH_QUOTA:
return ENOMEM
case ERROR_BAD_ENVIRONMENT:
return E2BIG
case ERROR_BAD_FORMAT,
ERROR_INVALID_STARTING_CODESEG...ERROR_INFLOOP_IN_RELOC_CHAIN:
return ENOEXEC
case ERROR_NOT_SAME_DEVICE:
return EXDEV
case ERROR_FILE_EXISTS,
ERROR_ALREADY_EXISTS:
return EEXIST
case ERROR_NO_PROC_SLOTS,
ERROR_MAX_THRDS_REACHED,
ERROR_NESTING_NOT_ALLOWED:
return EAGAIN
case ERROR_BROKEN_PIPE:
return EPIPE
case ERROR_DISK_FULL:
return ENOSPC
case ERROR_WAIT_NO_CHILDREN,
ERROR_CHILD_NOT_COMPLETE:
return ECHILD
case ERROR_DIR_NOT_EMPTY:
return ENOTEMPTY
case ERROR_NO_UNICODE_TRANSLATION:
return EILSEQ
default:
return EINVAL
}
}
fileprivate func rightsFromModeBits(
_ bits: Int,
sticky: Bool = false,
for fileOrDirectory: _FileOrDirectory
) -> DWORD {
var rights: DWORD = 0
if (bits & 0o4) != 0 {
rights |= DWORD(FILE_READ_ATTRIBUTES
| FILE_READ_DATA
| FILE_READ_EA
| STANDARD_RIGHTS_READ
| SYNCHRONIZE)
}
if (bits & 0o2) != 0 {
rights |= DWORD(FILE_APPEND_DATA
| FILE_WRITE_ATTRIBUTES
| FILE_WRITE_DATA
| FILE_WRITE_EA
| STANDARD_RIGHTS_WRITE
| SYNCHRONIZE)
if fileOrDirectory == .directory && !sticky {
rights |= DWORD(FILE_DELETE_CHILD)
}
}
if (bits & 0o1) != 0 {
rights |= DWORD(FILE_EXECUTE
| FILE_READ_ATTRIBUTES
| STANDARD_RIGHTS_EXECUTE
| SYNCHRONIZE)
}
return rights
}
fileprivate func getTokenInformation<T>(
of: T.Type,
hToken: HANDLE,
ticTokenClass: TOKEN_INFORMATION_CLASS
) -> UnsafePointer<T>? {
var capacity = 1024
for _ in 0..<2 {
let buffer = UnsafeMutableRawPointer.allocate(
byteCount: capacity,
alignment: MemoryLayout<T>.alignment
)
var dwLength = DWORD(0)
if GetTokenInformation(hToken,
ticTokenClass,
buffer,
DWORD(capacity),
&dwLength) {
return UnsafePointer(buffer.assumingMemoryBound(to: T.self))
}
buffer.deallocate()
capacity = Int(dwLength)
}
return nil
}
internal enum _FileOrDirectory {
case file
case directory
}
/// Build a SECURITY_DESCRIPTOR from UNIX-style "mode" bits. This only
/// takes account of the rwx and sticky bits; there's really nothing that
/// we can do about setuid/setgid.
internal func _createSecurityDescriptor(from mode: CInterop.Mode,
for fileOrDirectory: _FileOrDirectory)
-> PSECURITY_DESCRIPTOR? {
let ownerPerm = (Int(mode) >> 6) & 0o7
let groupPerm = (Int(mode) >> 3) & 0o7
let otherPerm = Int(mode) & 0o7
let ownerRights = rightsFromModeBits(ownerPerm, for: fileOrDirectory)
let groupRights = rightsFromModeBits(groupPerm,
sticky: (mode & 0o1000) != 0,
for: fileOrDirectory)
let otherRights = rightsFromModeBits(otherPerm,
sticky: (mode & 0o1000) != 0,
for: fileOrDirectory)
// If group or other permissions are *more* permissive, then we need
// some DENY ACEs as well to implement the expected semantics
let ownerDenyRights = ((ownerRights ^ groupRights) & groupRights) |
((ownerRights ^ otherRights) & otherRights)
let groupDenyRights = (groupRights ^ otherRights) & otherRights
var SIDAuthWorld = SID_IDENTIFIER_AUTHORITY(Value: (0, 0, 0, 0, 0, 1))
var everyone: PSID? = nil
guard AllocateAndInitializeSid(&SIDAuthWorld, 1,
DWORD(SECURITY_WORLD_RID),
0, 0, 0, 0, 0, 0, 0,
&everyone) else {
return nil
}
guard let everyone = everyone else {
return nil
}
defer {
FreeSid(everyone)
}
let hToken = GetCurrentThreadEffectiveToken()!
guard let pTokenUser = getTokenInformation(of: TOKEN_USER.self,
hToken: hToken,
ticTokenClass: TokenUser) else {
return nil
}
defer {
pTokenUser.deallocate()
}
guard let pTokenPrimaryGroup = getTokenInformation(
of: TOKEN_PRIMARY_GROUP.self,
hToken: hToken,
ticTokenClass: TokenPrimaryGroup
) else {
return nil
}
defer {
pTokenPrimaryGroup.deallocate()
}
let user = pTokenUser.pointee.User.Sid!
let group = pTokenPrimaryGroup.pointee.PrimaryGroup!
var eas = [
EXPLICIT_ACCESS_W(
grfAccessPermissions: ownerRights,
grfAccessMode: GRANT_ACCESS,
grfInheritance: DWORD(NO_INHERITANCE),
Trustee: TRUSTEE_W(
pMultipleTrustee: nil,
MultipleTrusteeOperation: NO_MULTIPLE_TRUSTEE,
TrusteeForm: TRUSTEE_IS_SID,
TrusteeType: TRUSTEE_IS_USER,
ptstrName:
user.assumingMemoryBound(to: CInterop.PlatformChar.self)
)
),
EXPLICIT_ACCESS_W(
grfAccessPermissions: groupRights,
grfAccessMode: GRANT_ACCESS,
grfInheritance: DWORD(NO_INHERITANCE),
Trustee: TRUSTEE_W(
pMultipleTrustee: nil,
MultipleTrusteeOperation: NO_MULTIPLE_TRUSTEE,
TrusteeForm: TRUSTEE_IS_SID,
TrusteeType: TRUSTEE_IS_GROUP,
ptstrName:
group.assumingMemoryBound(to: CInterop.PlatformChar.self)
)
),
EXPLICIT_ACCESS_W(
grfAccessPermissions: otherRights,
grfAccessMode: GRANT_ACCESS,
grfInheritance: DWORD(NO_INHERITANCE),
Trustee: TRUSTEE_W(
pMultipleTrustee: nil,
MultipleTrusteeOperation: NO_MULTIPLE_TRUSTEE,
TrusteeForm: TRUSTEE_IS_SID,
TrusteeType: TRUSTEE_IS_GROUP,
ptstrName:
everyone.assumingMemoryBound(to: CInterop.PlatformChar.self)
)
)
]
if ownerDenyRights != 0 {
eas.append(
EXPLICIT_ACCESS_W(
grfAccessPermissions: ownerDenyRights,
grfAccessMode: DENY_ACCESS,
grfInheritance: DWORD(NO_INHERITANCE),
Trustee: TRUSTEE_W(
pMultipleTrustee: nil,
MultipleTrusteeOperation: NO_MULTIPLE_TRUSTEE,
TrusteeForm: TRUSTEE_IS_SID,
TrusteeType: TRUSTEE_IS_USER,
ptstrName:
user.assumingMemoryBound(to: CInterop.PlatformChar.self)
)
)
)
}
if groupDenyRights != 0 {
eas.append(
EXPLICIT_ACCESS_W(
grfAccessPermissions: groupDenyRights,
grfAccessMode: DENY_ACCESS,
grfInheritance: DWORD(NO_INHERITANCE),
Trustee: TRUSTEE_W(
pMultipleTrustee: nil,
MultipleTrusteeOperation: NO_MULTIPLE_TRUSTEE,
TrusteeForm: TRUSTEE_IS_SID,
TrusteeType: TRUSTEE_IS_GROUP,
ptstrName:
group.assumingMemoryBound(to: CInterop.PlatformChar.self)
)
)
)
}
var pACL: PACL? = nil
guard SetEntriesInAclW(ULONG(eas.count),
&eas,
nil,
&pACL) == ERROR_SUCCESS else {
return nil
}
defer {
LocalFree(pACL)
}
// Create the security descriptor, making sure that inherited ACEs don't
// take effect, since that wouldn't match the behaviour of mode bits.
var descriptor = SECURITY_DESCRIPTOR()
guard InitializeSecurityDescriptor(&descriptor,
DWORD(SECURITY_DESCRIPTOR_REVISION)) else {
return nil
}
guard SetSecurityDescriptorControl(&descriptor,
SECURITY_DESCRIPTOR_CONTROL(SE_DACL_PROTECTED),
SECURITY_DESCRIPTOR_CONTROL(SE_DACL_PROTECTED))
&& SetSecurityDescriptorOwner(&descriptor, user, false)
&& SetSecurityDescriptorGroup(&descriptor, group, false)
&& SetSecurityDescriptorDacl(&descriptor,
true,
pACL,
false) else {
return nil
}
// Make it self-contained (up to this point it uses pointers)
var dwRelativeSize = DWORD(0)
guard !MakeSelfRelativeSD(&descriptor, nil, &dwRelativeSize)
&& GetLastError() == ERROR_INSUFFICIENT_BUFFER else {
return nil
}
let pDescriptor = UnsafeMutableRawPointer.allocate(
byteCount: Int(dwRelativeSize),
alignment: MemoryLayout<SECURITY_DESCRIPTOR>.alignment
).assumingMemoryBound(to: SECURITY_DESCRIPTOR.self)
guard MakeSelfRelativeSD(&descriptor, pDescriptor, &dwRelativeSize) else {
pDescriptor.deallocate()
return nil
}
return UnsafeMutableRawPointer(pDescriptor)
}
fileprivate struct DecodedOpenFlags {
var dwDesiredAccess: DWORD
var dwCreationDisposition: DWORD
var bInheritHandle: WindowsBool
var dwFlagsAndAttributes: DWORD
init(_ oflag: Int32) {
switch oflag & (_O_CREAT | _O_EXCL | _O_TRUNC) {
case _O_CREAT | _O_EXCL, _O_CREAT | _O_EXCL | _O_TRUNC:
dwCreationDisposition = DWORD(CREATE_NEW)
case _O_CREAT:
dwCreationDisposition = DWORD(OPEN_ALWAYS)
case _O_CREAT | _O_TRUNC:
dwCreationDisposition = DWORD(CREATE_ALWAYS)
case _O_TRUNC:
dwCreationDisposition = DWORD(TRUNCATE_EXISTING)
default:
dwCreationDisposition = DWORD(OPEN_EXISTING)
}
// The _O_RDONLY, _O_WRONLY and _O_RDWR flags are non-overlapping
// on Windows; in particular, _O_RDONLY is zero, which means we can't
// test for it by AND-ing.
dwDesiredAccess = 0
switch (oflag & (_O_RDONLY|_O_WRONLY|_O_RDWR)) {
case _O_RDONLY:
dwDesiredAccess |= DWORD(GENERIC_READ)
case _O_WRONLY:
dwDesiredAccess |= DWORD(GENERIC_WRITE)
case _O_RDWR:
dwDesiredAccess |= DWORD(GENERIC_READ) | DWORD(GENERIC_WRITE)
default:
break
}
bInheritHandle = WindowsBool((oflag & _O_NOINHERIT) == 0)
dwFlagsAndAttributes = 0
if (oflag & _O_SEQUENTIAL) != 0 {
dwFlagsAndAttributes |= DWORD(FILE_FLAG_SEQUENTIAL_SCAN)
}
if (oflag & _O_RANDOM) != 0 {
dwFlagsAndAttributes |= DWORD(FILE_FLAG_RANDOM_ACCESS)
}
if (oflag & _O_TEMPORARY) != 0 {
dwFlagsAndAttributes |= DWORD(FILE_FLAG_DELETE_ON_CLOSE)
}
if (oflag & _O_SHORT_LIVED) != 0 {
dwFlagsAndAttributes |= DWORD(FILE_ATTRIBUTE_TEMPORARY)
} else {
dwFlagsAndAttributes |= DWORD(FILE_ATTRIBUTE_NORMAL)
}
}
}
#endif
+90 -66
View File
@@ -7,12 +7,14 @@
See https://swift.org/LICENSE.txt for license information
*/
#if swift(>=5.8) && $MoveOnly && (os(macOS) || os(iOS) || os(watchOS) || os(tvOS))
#if swift(>=5.9) && SYSTEM_PACKAGE_DARWIN
import Darwin.Mach
@available(/*System 1.4.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
public protocol MachPortRight {}
@available(/*System 1.4.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
@inlinable
internal func _machPrecondition(
file: StaticString = #file,
@@ -24,11 +26,11 @@ internal func _machPrecondition(
precondition(kr == expected, file: file, line: line)
}
@available(/*System 1.3.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
@available(/*System 1.4.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
@frozen
public enum Mach {
@_moveOnly
public struct Port<RightType: MachPortRight> {
@available(/*System 1.4.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
public struct Port<RightType: MachPortRight>: ~Copyable {
@usableFromInline
internal var _name: mach_port_name_t
@@ -49,11 +51,15 @@ public enum Mach {
///
/// This initializer makes a syscall to guard the right.
public init(name: mach_port_name_t) {
precondition(name != mach_port_name_t(MACH_PORT_NULL), "Mach.Port cannot be initialized with MACH_PORT_NULL")
precondition(name != mach_port_name_t(MACH_PORT_NULL),
"Mach.Port cannot be initialized with MACH_PORT_NULL")
self._name = name
if RightType.self == ReceiveRight.self {
precondition(name != 0xFFFFFFFF /* MACH_PORT_DEAD */, "Receive rights cannot be dead names")
precondition(
_name != (0xFFFFFFFF as mach_port_name_t) /* MACH_PORT_DEAD */,
"Receive rights cannot be dead names"
)
let secret = mach_port_context_t(arc4random())
_machPrecondition(mach_port_guard(mach_task_self_, name, secret, 0))
@@ -82,17 +88,20 @@ public enum Mach {
}
deinit {
if _name == 0xFFFFFFFF /* MACH_PORT_DEAD */ {
precondition(RightType.self != ReceiveRight.self, "Receive rights cannot be dead names")
_machPrecondition(mach_port_mod_refs(mach_task_self_, _name, MACH_PORT_RIGHT_DEAD_NAME, -1))
if RightType.self == ReceiveRight.self {
precondition(
_name != (0xFFFFFFFF as mach_port_name_t) /* MACH_PORT_DEAD */,
"Receive rights cannot be dead names"
)
_machPrecondition(
mach_port_destruct(mach_task_self_, _name, 0, _context)
)
} else {
if RightType.self == ReceiveRight.self {
_machPrecondition(mach_port_destruct(mach_task_self_, _name, -1, _context))
} else if RightType.self == SendRight.self {
_machPrecondition(mach_port_mod_refs(mach_task_self_, _name, MACH_PORT_RIGHT_SEND, -1))
} else if RightType.self == SendOnceRight.self {
_machPrecondition(mach_port_mod_refs(mach_task_self_, _name, MACH_PORT_RIGHT_SEND_ONCE, -1))
}
assert(
RightType.self == SendRight.self ||
RightType.self == SendOnceRight.self
)
_machPrecondition(mach_port_deallocate(mach_task_self_, _name))
}
}
}
@@ -122,26 +131,9 @@ public enum Mach {
/// receiving end.
@frozen
public struct SendOnceRight: MachPortRight {}
/// Create a connected pair of rights, one receive, and one send.
///
/// This function will abort if the rights could not be created.
/// Callers may assert that valid rights are always returned.
public static func allocatePortRightPair() ->
(receive: Mach.Port<Mach.ReceiveRight>, send: Mach.Port<Mach.SendRight>) {
var name = mach_port_name_t(MACH_PORT_NULL)
let secret = mach_port_context_t(arc4random())
withUnsafeMutablePointer(to: &name) { name in
var options = mach_port_options_t()
options.flags = UInt32(MPO_INSERT_SEND_RIGHT);
withUnsafeMutablePointer(to: &options) { options in
_machPrecondition(mach_port_construct(mach_task_self_, options, secret, name))
}
}
return (Mach.Port(name: name, context: secret), Mach.Port(name: name))
}
}
@available(/*System 1.4.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
extension Mach.Port where RightType == Mach.ReceiveRight {
/// Transfer ownership of an existing, unmanaged, but already guarded,
/// Mach port right into a Mach.Port by name.
@@ -154,6 +146,8 @@ extension Mach.Port where RightType == Mach.ReceiveRight {
/// The underlying port right will be automatically deallocated when
/// the Mach.Port object is destroyed.
public init(name: mach_port_name_t, context: mach_port_context_t) {
precondition(name != mach_port_name_t(MACH_PORT_NULL),
"Mach.Port cannot be initialized with MACH_PORT_NULL")
self._name = name
self._context = context
}
@@ -164,11 +158,12 @@ extension Mach.Port where RightType == Mach.ReceiveRight {
/// This initializer will abort if the right could not be created.
/// Callers may assert that a valid right is always returned.
@inlinable
@available(/*System 1.4.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
public init() {
var storage: mach_port_name_t = mach_port_name_t(MACH_PORT_NULL)
withUnsafeMutablePointer(to: &storage) { storage in
_machPrecondition(mach_port_allocate(mach_task_self_, MACH_PORT_RIGHT_RECEIVE, storage))
}
_machPrecondition(
mach_port_allocate(mach_task_self_, MACH_PORT_RIGHT_RECEIVE, &storage)
)
// name-only init will guard ReceiveRights
self.init(name: storage)
@@ -186,9 +181,12 @@ extension Mach.Port where RightType == Mach.ReceiveRight {
/// After this function completes, the Mach.Port is destroyed and no longer
/// usable.
@inlinable
public __consuming func relinquish(
@available(/*System 1.4.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
public consuming func relinquish(
) -> (name: mach_port_name_t, context: mach_port_context_t) {
return (name: _name, context: _context)
let destructured = (name: _name, context: _context)
discard self
return destructured
}
/// Remove guard and transfer ownership of the underlying port right to
@@ -206,9 +204,11 @@ extension Mach.Port where RightType == Mach.ReceiveRight {
/// Mach.ReceiveRights. Use relinquish() to avoid the syscall and extract
/// the context value along with the port name.
@inlinable
public __consuming func unguardAndRelinquish() -> mach_port_name_t {
_machPrecondition(mach_port_unguard(mach_task_self_, _name, _context))
return _name
@available(/*System 1.4.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
public consuming func unguardAndRelinquish() -> mach_port_name_t {
let (name, context) = self.relinquish()
_machPrecondition(mach_port_unguard(mach_task_self_, name, context))
return name
}
/// Borrow access to the port name in a block that can perform
@@ -221,6 +221,7 @@ extension Mach.Port where RightType == Mach.ReceiveRight {
/// The body block may optionally return something, which will then be
/// returned to the caller of withBorrowedName.
@inlinable
@available(/*System 1.4.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
public func withBorrowedName<ReturnType>(
body: (mach_port_name_t, mach_port_context_t) -> ReturnType
) -> ReturnType {
@@ -234,22 +235,21 @@ extension Mach.Port where RightType == Mach.ReceiveRight {
/// This function will abort if the right could not be created.
/// Callers may assert that a valid right is always returned.
@inlinable
@available(/*System 1.4.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
public func makeSendOnceRight() -> Mach.Port<Mach.SendOnceRight> {
// send once rights do not coalesce
var newRight: mach_port_name_t = mach_port_name_t(MACH_PORT_NULL)
var newRightType: mach_port_type_t = MACH_PORT_TYPE_NONE
withUnsafeMutablePointer(to: &newRight) { newRight in
withUnsafeMutablePointer(to: &newRightType) { newRightType in
_machPrecondition(
mach_port_extract_right(mach_task_self_,
_name,
mach_msg_type_name_t(MACH_MSG_TYPE_MAKE_SEND_ONCE),
newRight,
newRightType)
)
}
}
_machPrecondition(
mach_port_extract_right(
mach_task_self_,
_name,
mach_msg_type_name_t(MACH_MSG_TYPE_MAKE_SEND_ONCE),
&newRight,
&newRightType
)
)
// The value of newRight is validated by the Mach.Port initializer
precondition(newRightType == MACH_MSG_TYPE_MOVE_SEND_ONCE)
@@ -264,11 +264,16 @@ extension Mach.Port where RightType == Mach.ReceiveRight {
/// This function will abort if the right could not be created.
/// Callers may assert that a valid right is always returned.
@inlinable
@available(/*System 1.4.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
public func makeSendRight() -> Mach.Port<Mach.SendRight> {
let how = MACH_MSG_TYPE_MAKE_SEND
// name is the same because send and recv rights are coalesced
_machPrecondition(mach_port_insert_right(mach_task_self_, _name, _name, mach_msg_type_name_t(how)))
_machPrecondition(
mach_port_insert_right(
mach_task_self_, _name, _name, mach_msg_type_name_t(how)
)
)
return Mach.Port(name: _name)
}
@@ -277,14 +282,24 @@ extension Mach.Port where RightType == Mach.ReceiveRight {
///
/// Each get/set of this property makes a syscall.
@inlinable
@available(/*System 1.4.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
public var makeSendCount: mach_port_mscount_t {
get {
var status: mach_port_status = mach_port_status()
var size: mach_msg_type_number_t = mach_msg_type_number_t(MemoryLayout<mach_port_status>.size / MemoryLayout<natural_t>.size)
withUnsafeMutablePointer(to: &size) { size in
withUnsafeMutablePointer(to: &status) { status in
let info = UnsafeMutableRawPointer(status).bindMemory(to: integer_t.self, capacity: 1)
_machPrecondition(mach_port_get_attributes(mach_task_self_, _name, MACH_PORT_RECEIVE_STATUS, info, size))
var size = mach_msg_type_number_t(
MemoryLayout<mach_port_status>.size / MemoryLayout<natural_t>.size
)
withUnsafeMutablePointer(to: &status) {
[ _name = self._name ] in
let status = UnsafeMutableBufferPointer(start: $0, count: 1)
status.withMemoryRebound(to: integer_t.self) {
let info = $0.baseAddress
_machPrecondition(
mach_port_get_attributes(
mach_task_self_, _name, MACH_PORT_RECEIVE_STATUS, info, &size
)
)
}
}
return status.mps_mscount
@@ -296,6 +311,7 @@ extension Mach.Port where RightType == Mach.ReceiveRight {
}
}
@available(/*System 1.4.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
extension Mach.Port where RightType == Mach.SendRight {
/// Transfer ownership of the underlying port right to the caller.
///
@@ -307,8 +323,10 @@ extension Mach.Port where RightType == Mach.SendRight {
/// After this function completes, the Mach.Port is destroyed and no longer
/// usable.
@inlinable
public __consuming func relinquish() -> mach_port_name_t {
return _name
public consuming func relinquish() -> mach_port_name_t {
let name = _name
discard self
return name
}
/// Create another send right from a given send right.
@@ -319,12 +337,15 @@ extension Mach.Port where RightType == Mach.SendRight {
/// receiving side has been deallocated, then copySendRight() will throw
/// a Mach.PortRightError.deadName error.
@inlinable
@available(/*System 1.4.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
public func copySendRight() throws -> Mach.Port<Mach.SendRight> {
let how = MACH_MSG_TYPE_COPY_SEND
// name is the same because send rights are coalesced
let kr = mach_port_insert_right(mach_task_self_, _name, _name, mach_msg_type_name_t(how))
if kr == KERN_INVALID_CAPABILITY {
let kr = mach_port_insert_right(
mach_task_self_, _name, _name, mach_msg_type_name_t(how)
)
if kr == KERN_INVALID_NAME || kr == KERN_INVALID_CAPABILITY {
throw Mach.PortRightError.deadName
}
_machPrecondition(kr)
@@ -333,7 +354,7 @@ extension Mach.Port where RightType == Mach.SendRight {
}
}
@available(/*System 1.4.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
extension Mach.Port where RightType == Mach.SendOnceRight {
/// Transfer ownership of the underlying port right to the caller.
///
@@ -345,8 +366,11 @@ extension Mach.Port where RightType == Mach.SendOnceRight {
/// After this function completes, the Mach.Port is destroyed and no longer
/// usable.
@inlinable
public __consuming func relinquish() -> mach_port_name_t {
return _name
@available(/*System 1.4.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
public consuming func relinquish() -> mach_port_name_t {
let name = _name
discard self
return name
}
}
+1
View File
@@ -20,6 +20,7 @@ extension String {
/// This means that, depending on the semantics of the specific platform,
/// conversion to a string and back might result in a value that's different
/// from the original platform string.
@_disfavoredOverload
public init(platformString: UnsafePointer<CInterop.PlatformChar>) {
self.init(_errorCorrectingPlatformString: platformString)
}
+62 -29
View File
@@ -1,14 +1,15 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2020 Apple Inc. and the Swift System project authors
Copyright (c) 2020 - 2024 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
*/
// A platform-native character representation, currently used for file paths
internal struct SystemChar: RawRepresentable, Comparable, Hashable, Codable {
internal struct SystemChar:
RawRepresentable, Sendable, Comparable, Hashable, Codable {
internal typealias RawValue = CInterop.PlatformChar
internal var rawValue: RawValue
@@ -61,7 +62,7 @@ extension SystemChar {
// A platform-native string representation, currently for file paths
//
// Always null-terminated.
internal struct SystemString {
internal struct SystemString: Sendable {
internal typealias Storage = [SystemChar]
internal var nullTerminatedStorage: Storage
}
@@ -95,10 +96,18 @@ extension SystemString {
}
extension SystemString {
fileprivate func _invariantsSatisfied() -> Bool {
guard !nullTerminatedStorage.isEmpty else { return false }
guard nullTerminatedStorage.last! == .null else { return false }
guard nullTerminatedStorage.firstIndex(of: .null) == length else {
return false
}
return true
}
fileprivate func _invariantCheck() {
#if DEBUG
precondition(nullTerminatedStorage.last! == .null)
precondition(nullTerminatedStorage.firstIndex(of: .null) == length)
precondition(_invariantsSatisfied())
#endif // DEBUG
}
}
@@ -141,44 +150,67 @@ extension SystemString: RangeReplaceableCollection {
nullTerminatedStorage.reserveCapacity(1 + n)
}
// TODO: Below include null terminator, is this desired?
internal func withContiguousStorageIfAvailable<R>(
_ body: (UnsafeBufferPointer<SystemChar>) throws -> R
) rethrows -> R? {
try nullTerminatedStorage.withContiguousStorageIfAvailable(body)
// Do not include the null terminator, it is outside the Collection
try nullTerminatedStorage.withContiguousStorageIfAvailable {
try body(.init(start: $0.baseAddress, count: $0.count-1))
}
}
internal mutating func withContiguousMutableStorageIfAvailable<R>(
_ body: (inout UnsafeMutableBufferPointer<SystemChar>) throws -> R
) rethrows -> R? {
defer { _invariantCheck() }
return try nullTerminatedStorage.withContiguousMutableStorageIfAvailable(body)
// Do not include the null terminator, it is outside the Collection
return try nullTerminatedStorage.withContiguousMutableStorageIfAvailable {
var buffer = UnsafeMutableBufferPointer<SystemChar>(
start: $0.baseAddress, count: $0.count-1
)
return try body(&buffer)
}
}
}
extension SystemString: Hashable, Codable {}
extension SystemString: Hashable, Codable {
// Encoder is synthesized; it probably should have been explicit and used
// a single-value container, but making that change now is somewhat risky.
// Decoder is written explicitly to ensure that we validate invariants on
// untrusted input.
public init(from decoder: any Decoder) throws {
let container = try decoder.container(keyedBy: CodingKeys.self)
self.nullTerminatedStorage = try container.decode(
Storage.self, forKey: .nullTerminatedStorage
)
guard _invariantsSatisfied() else {
throw DecodingError.dataCorruptedError(
forKey: .nullTerminatedStorage,
in: container,
debugDescription:
"Encoding does not satisfy the invariants of SystemString"
)
}
}
}
extension SystemString {
// TODO: Below include null terminator, is this desired?
internal func withSystemChars<T>(
internal func withNullTerminatedSystemChars<T>(
_ f: (UnsafeBufferPointer<SystemChar>) throws -> T
) rethrows -> T {
try withContiguousStorageIfAvailable(f)!
try nullTerminatedStorage.withUnsafeBufferPointer(f)
}
// withCodeUnits does not include the null terminator
internal func withCodeUnits<T>(
_ f: (UnsafeBufferPointer<CInterop.PlatformUnicodeEncoding.CodeUnit>) throws -> T
) rethrows -> T {
try withSystemChars { chars in
let length = chars.count * MemoryLayout<SystemChar>.stride
let count = length / MemoryLayout<CInterop.PlatformUnicodeEncoding.CodeUnit>.stride
return try chars.baseAddress!.withMemoryRebound(
to: CInterop.PlatformUnicodeEncoding.CodeUnit.self,
capacity: count
) { pointer in
try f(UnsafeBufferPointer(start: pointer, count: count))
try withNullTerminatedSystemChars {
try $0.withMemoryRebound(to: CInterop.PlatformUnicodeEncoding.CodeUnit.self) {
assert($0.last == .zero)
return try f(.init(start: $0.baseAddress, count: $0.count&-1))
}
}
}
@@ -194,7 +226,9 @@ extension Slice where Base == SystemString {
}
internal var string: String {
withCodeUnits { String(decoding: $0, as: CInterop.PlatformUnicodeEncoding.self) }
withCodeUnits {
String(decoding: $0, as: CInterop.PlatformUnicodeEncoding.self)
}
}
internal func withPlatformString<T>(
@@ -236,7 +270,11 @@ extension SystemString: ExpressibleByStringLiteral {
}
extension SystemString: CustomStringConvertible, CustomDebugStringConvertible {
internal var string: String { String(decoding: self) }
internal var string: String {
self.withCodeUnits {
String(decoding: $0, as: CInterop.PlatformUnicodeEncoding.self)
}
}
internal var description: String { string }
internal var debugDescription: String { description.debugDescription }
@@ -275,7 +313,7 @@ extension SystemString {
internal func withPlatformString<T>(
_ f: (UnsafePointer<CInterop.PlatformChar>) throws -> T
) rethrows -> T {
try withSystemChars { chars in
try withNullTerminatedSystemChars { chars in
let length = chars.count * MemoryLayout<SystemChar>.stride
return try chars.baseAddress!.withMemoryRebound(
to: CInterop.PlatformChar.self,
@@ -288,11 +326,6 @@ extension SystemString {
}
}
#if compiler(>=5.5) && canImport(_Concurrency)
extension SystemChar: Sendable {}
extension SystemString: Sendable {}
#endif
// TODO: SystemString should use a COW-interchangable storage form rather
// than array, so you could "borrow" the storage from a non-bridged String
// or Data or whatever
-8
View File
@@ -1,8 +0,0 @@
import XCTest
import SystemTests
var tests = [XCTestCaseEntry]()
tests += SystemTests.__allTests()
XCTMain(tests)
+22 -9
View File
@@ -106,7 +106,7 @@ final class ErrnoTest: XCTestCase {
XCTAssert(EHOSTUNREACH == Errno.noRouteToHost.rawValue)
XCTAssert(ENOTEMPTY == Errno.directoryNotEmpty.rawValue)
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if SYSTEM_PACKAGE_DARWIN
XCTAssert(EPROCLIM == Errno.tooManyProcesses.rawValue)
#endif
@@ -120,7 +120,7 @@ final class ErrnoTest: XCTestCase {
XCTAssert(ESTALE == Errno.staleNFSFileHandle.rawValue)
#endif
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if SYSTEM_PACKAGE_DARWIN
XCTAssert(EBADRPC == Errno.rpcUnsuccessful.rawValue)
XCTAssert(ERPCMISMATCH == Errno.rpcVersionMismatch.rawValue)
XCTAssert(EPROGUNAVAIL == Errno.rpcProgramUnavailable.rawValue)
@@ -131,10 +131,13 @@ final class ErrnoTest: XCTestCase {
XCTAssert(ENOLCK == Errno.noLocks.rawValue)
XCTAssert(ENOSYS == Errno.noFunction.rawValue)
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if SYSTEM_PACKAGE_DARWIN || os(FreeBSD)
XCTAssert(EFTYPE == Errno.badFileTypeOrFormat.rawValue)
XCTAssert(EAUTH == Errno.authenticationError.rawValue)
XCTAssert(ENEEDAUTH == Errno.needAuthenticator.rawValue)
#endif
#if SYSTEM_PACKAGE_DARWIN
XCTAssert(EPWROFF == Errno.devicePowerIsOff.rawValue)
XCTAssert(EDEVERR == Errno.deviceError.rawValue)
#endif
@@ -143,7 +146,7 @@ final class ErrnoTest: XCTestCase {
XCTAssert(EOVERFLOW == Errno.overflow.rawValue)
#endif
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if SYSTEM_PACKAGE_DARWIN
XCTAssert(EBADEXEC == Errno.badExecutable.rawValue)
XCTAssert(EBADARCH == Errno.badCPUType.rawValue)
XCTAssert(ESHLIBVERS == Errno.sharedLibraryVersionMismatch.rawValue)
@@ -157,20 +160,24 @@ final class ErrnoTest: XCTestCase {
#endif
XCTAssert(EILSEQ == Errno.illegalByteSequence.rawValue)
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if SYSTEM_PACKAGE_DARWIN
XCTAssert(ENOATTR == Errno.attributeNotFound.rawValue)
#endif
#if !os(Windows)
XCTAssert(EBADMSG == Errno.badMessage.rawValue)
XCTAssert(EMULTIHOP == Errno.multiHop.rawValue)
XCTAssert(ENODATA == Errno.noData.rawValue)
XCTAssert(ENOLINK == Errno.noLink.rawValue)
XCTAssert(EPROTO == Errno.protocolError.rawValue)
#endif
#if !os(Windows) && !os(FreeBSD)
XCTAssert(ENODATA == Errno.noData.rawValue)
XCTAssert(ENOSR == Errno.noStreamResources.rawValue)
XCTAssert(ENOSTR == Errno.notStream.rawValue)
XCTAssert(EPROTO == Errno.protocolError.rawValue)
XCTAssert(ETIME == Errno.timeout.rawValue)
#endif
XCTAssert(EOPNOTSUPP == Errno.notSupportedOnSocket.rawValue)
// From headers but not man page
@@ -183,7 +190,7 @@ final class ErrnoTest: XCTestCase {
XCTAssert(EREMOTE == Errno.tooManyRemoteLevels.rawValue)
#endif
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if SYSTEM_PACKAGE_DARWIN
XCTAssert(ENOPOLICY == Errno.noSuchPolicy.rawValue)
#endif
@@ -192,7 +199,13 @@ final class ErrnoTest: XCTestCase {
XCTAssert(EOWNERDEAD == Errno.previousOwnerDied.rawValue)
#endif
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if os(FreeBSD)
XCTAssert(ENOTCAPABLE == Errno.notCapable.rawValue)
XCTAssert(ECAPMODE == Errno.capabilityMode.rawValue)
XCTAssert(EINTEGRITY == Errno.integrityCheckFailed.rawValue)
#endif
#if SYSTEM_PACKAGE_DARWIN
XCTAssert(EQFULL == Errno.outputQueueFull.rawValue)
XCTAssert(ELAST == Errno.lastErrnoValue.rawValue)
#endif
+122 -62
View File
@@ -10,9 +10,9 @@
import XCTest
#if SYSTEM_PACKAGE
import SystemPackage
@testable import SystemPackage
#else
import System
@testable import System
#endif
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
@@ -86,11 +86,70 @@ final class FileOperationsTest: XCTestCase {
for test in syscallTestCases { test.runAllTests() }
}
func testWriteFromEmptyBuffer() throws {
#if os(Windows)
let fd = try FileDescriptor.open(FilePath("NUL"), .writeOnly)
#else
let fd = try FileDescriptor.open(FilePath("/dev/null"), .writeOnly)
#endif
let written1 = try fd.write(toAbsoluteOffset: 0, .init(start: nil, count: 0))
XCTAssertEqual(written1, 0)
let pointer = UnsafeMutableRawPointer.allocate(byteCount: 8, alignment: 8)
defer { pointer.deallocate() }
let empty = UnsafeRawBufferPointer(start: pointer, count: 0)
let written2 = try fd.write(toAbsoluteOffset: 0, empty)
XCTAssertEqual(written2, 0)
}
#if os(Windows)
// Generate a file containing random bytes; this should not be used
// for cryptography, it's just for testing.
func generateRandomData(at path: FilePath, count: Int) throws {
let fd = try FileDescriptor.open(path, .readWrite,
options: [.create, .truncate])
defer {
try! fd.close()
}
let data = [UInt8](
sequence(first: 0,
next: {
_ in UInt8.random(in: UInt8.min...UInt8.max)
}).dropFirst().prefix(count)
)
try data.withUnsafeBytes {
_ = try fd.write($0)
}
}
#endif
func testReadToEmptyBuffer() throws {
try withTemporaryFilePath(basename: "testReadToEmptyBuffer") { path in
#if os(Windows)
// Windows doesn't have an equivalent to /dev/random, so generate
// some random bytes and write them to a file for the next step.
let randomPath = path.appending("random.txt")
try generateRandomData(at: randomPath, count: 16)
let fd = try FileDescriptor.open(randomPath, .readOnly)
#else // !os(Windows)
let fd = try FileDescriptor.open(FilePath("/dev/random"), .readOnly)
#endif
let read1 = try fd.read(fromAbsoluteOffset: 0, into: .init(start: nil, count: 0))
XCTAssertEqual(read1, 0)
let pointer = UnsafeMutableRawPointer.allocate(byteCount: 8, alignment: 8)
defer { pointer.deallocate() }
let empty = UnsafeMutableRawBufferPointer(start: pointer, count: 0)
let read2 = try fd.read(fromAbsoluteOffset: 0, into: empty)
XCTAssertEqual(read2, 0)
}
}
func testHelpers() {
// TODO: Test writeAll, writeAll(toAbsoluteOffset), closeAfter
}
#if !os(Windows)
func testAdHocPipe() throws {
// Ad-hoc test testing `Pipe` functionality.
// We cannot test `Pipe` using `MockTestCase` because it calls `pipe` with a pointer to an array local to the `Pipe`, the address of which we do not know prior to invoking `Pipe`.
@@ -109,33 +168,34 @@ final class FileOperationsTest: XCTestCase {
}
}
}
#endif
func testAdHocOpen() {
// Ad-hoc test touching a file system.
do {
// TODO: Test this against a virtual in-memory file system
let fd = try FileDescriptor.open("/tmp/b.txt", .readWrite, options: [.create, .truncate], permissions: .ownerReadWrite)
try fd.closeAfter {
try fd.writeAll("abc".utf8)
var def = "def"
try def.withUTF8 {
_ = try fd.write(UnsafeRawBufferPointer($0))
}
try fd.seek(offset: 1, from: .start)
try withTemporaryFilePath(basename: "testAdhocOpen") { path in
let fd = try FileDescriptor.open(path.appending("b.txt"), .readWrite, options: [.create, .truncate], permissions: .ownerReadWrite)
try fd.closeAfter {
try fd.writeAll("abc".utf8)
var def = "def"
try def.withUTF8 {
_ = try fd.write(UnsafeRawBufferPointer($0))
}
try fd.seek(offset: 1, from: .start)
let readLen = 3
let readBytes = try Array<UInt8>(unsafeUninitializedCapacity: readLen) { (buf, count) in
count = try fd.read(into: UnsafeMutableRawBufferPointer(buf))
}
let preadBytes = try Array<UInt8>(unsafeUninitializedCapacity: readLen) { (buf, count) in
count = try fd.read(fromAbsoluteOffset: 1, into: UnsafeMutableRawBufferPointer(buf))
}
let readLen = 3
let readBytes = try Array<UInt8>(unsafeUninitializedCapacity: readLen) { (buf, count) in
count = try fd.read(into: UnsafeMutableRawBufferPointer(buf))
}
let preadBytes = try Array<UInt8>(unsafeUninitializedCapacity: readLen) { (buf, count) in
count = try fd.read(fromAbsoluteOffset: 1, into: UnsafeMutableRawBufferPointer(buf))
}
XCTAssertEqual(readBytes.first!, "b".utf8.first!)
XCTAssertEqual(readBytes, preadBytes)
XCTAssertEqual(readBytes.first!, "b".utf8.first!)
XCTAssertEqual(readBytes, preadBytes)
// TODO: seek
// TODO: seek
}
}
} catch let err as Errno {
print("caught \(err))")
@@ -161,48 +221,48 @@ final class FileOperationsTest: XCTestCase {
}
#if !os(Windows)
func testResizeFile() throws {
let fd = try FileDescriptor.open("/tmp/\(UUID().uuidString).txt", .readWrite, options: [.create, .truncate], permissions: .ownerReadWrite)
try fd.closeAfter {
// File should be empty initially.
XCTAssertEqual(try fd.fileSize(), 0)
// Write 3 bytes.
try fd.writeAll("abc".utf8)
// File should now be 3 bytes.
XCTAssertEqual(try fd.fileSize(), 3)
// Resize to 6 bytes.
try fd.resize(to: 6)
// File should now be 6 bytes.
XCTAssertEqual(try fd.fileSize(), 6)
// Read in the 6 bytes.
let readBytes = try Array<UInt8>(unsafeUninitializedCapacity: 6) { (buf, count) in
try fd.seek(offset: 0, from: .start)
// Should have read all 6 bytes.
count = try fd.read(into: UnsafeMutableRawBufferPointer(buf))
XCTAssertEqual(count, 6)
try withTemporaryFilePath(basename: "testResizeFile") { path in
let fd = try FileDescriptor.open(path.appending("\(UUID().uuidString).txt"), .readWrite, options: [.create, .truncate], permissions: .ownerReadWrite)
try fd.closeAfter {
// File should be empty initially.
XCTAssertEqual(try fd.fileSize(), 0)
// Write 3 bytes.
try fd.writeAll("abc".utf8)
// File should now be 3 bytes.
XCTAssertEqual(try fd.fileSize(), 3)
// Resize to 6 bytes.
try fd.resize(to: 6)
// File should now be 6 bytes.
XCTAssertEqual(try fd.fileSize(), 6)
// Read in the 6 bytes.
let readBytes = try Array<UInt8>(unsafeUninitializedCapacity: 6) { (buf, count) in
try fd.seek(offset: 0, from: .start)
// Should have read all 6 bytes.
count = try fd.read(into: UnsafeMutableRawBufferPointer(buf))
XCTAssertEqual(count, 6)
}
// First 3 bytes should be unaffected by resize.
XCTAssertEqual(Array(readBytes[..<3]), Array("abc".utf8))
// Extension should be padded with zeros.
XCTAssertEqual(Array(readBytes[3...]), Array(repeating: 0, count: 3))
// File should still be 6 bytes.
XCTAssertEqual(try fd.fileSize(), 6)
// Resize to 2 bytes.
try fd.resize(to: 2)
// File should now be 2 bytes.
XCTAssertEqual(try fd.fileSize(), 2)
// Read in file with a buffer big enough for 6 bytes.
let readBytesAfterTruncation = try Array<UInt8>(unsafeUninitializedCapacity: 6) { (buf, count) in
try fd.seek(offset: 0, from: .start)
count = try fd.read(into: UnsafeMutableRawBufferPointer(buf))
// Should only have read 2 bytes.
XCTAssertEqual(count, 2)
}
// Written content was trunctated.
XCTAssertEqual(readBytesAfterTruncation, Array("ab".utf8))
}
// First 3 bytes should be unaffected by resize.
XCTAssertEqual(Array(readBytes[..<3]), Array("abc".utf8))
// Extension should be padded with zeros.
XCTAssertEqual(Array(readBytes[3...]), Array(repeating: 0, count: 3))
// File should still be 6 bytes.
XCTAssertEqual(try fd.fileSize(), 6)
// Resize to 2 bytes.
try fd.resize(to: 2)
// File should now be 2 bytes.
XCTAssertEqual(try fd.fileSize(), 2)
// Read in file with a buffer big enough for 6 bytes.
let readBytesAfterTruncation = try Array<UInt8>(unsafeUninitializedCapacity: 6) { (buf, count) in
try fd.seek(offset: 0, from: .start)
count = try fd.read(into: UnsafeMutableRawBufferPointer(buf))
// Should only have read 2 bytes.
XCTAssertEqual(count, 2)
}
// Written content was trunctated.
XCTAssertEqual(readBytesAfterTruncation, Array("ab".utf8))
}
}
#endif
}
@@ -0,0 +1,241 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2024 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
*/
import XCTest
#if os(Windows)
#if SYSTEM_PACKAGE
@testable import SystemPackage
#else
@testable import System
#endif
import WinSDK
@available(iOS 8, *)
final class FileOperationsTestWindows: XCTestCase {
private let r = ACCESS_MASK(
FILE_READ_ATTRIBUTES
| FILE_READ_DATA
| FILE_READ_EA
| STANDARD_RIGHTS_READ
| SYNCHRONIZE
)
private let w = ACCESS_MASK(
FILE_APPEND_DATA
| FILE_WRITE_ATTRIBUTES
| FILE_WRITE_DATA
| FILE_WRITE_EA
| STANDARD_RIGHTS_WRITE
| SYNCHRONIZE
)
private let x = ACCESS_MASK(
FILE_EXECUTE
| FILE_READ_ATTRIBUTES
| STANDARD_RIGHTS_EXECUTE
| SYNCHRONIZE
)
private struct Test {
var permissions: CModeT
var ownerAccess: ACCESS_MASK
var groupAccess: ACCESS_MASK
var otherAccess: ACCESS_MASK
init(_ permissions: CModeT,
_ ownerAccess: ACCESS_MASK,
_ groupAccess: ACCESS_MASK,
_ otherAccess: ACCESS_MASK) {
self.permissions = permissions
self.ownerAccess = ownerAccess
self.groupAccess = groupAccess
self.otherAccess = otherAccess
}
}
/// Retrieve the owner, group and other access masks for a given file.
///
/// - Parameters:
/// - path: The path to the file to inspect
/// - Returns: A tuple of ACCESS_MASK values.
func getAccessMasks(
path: FilePath
) -> (ACCESS_MASK, ACCESS_MASK, ACCESS_MASK) {
var SIDAuthWorld = SID_IDENTIFIER_AUTHORITY(Value: (0, 0, 0, 0, 0, 1))
var psidEveryone: PSID? = nil
XCTAssert(AllocateAndInitializeSid(&SIDAuthWorld, 1,
DWORD(SECURITY_WORLD_RID),
0, 0, 0, 0, 0, 0, 0,
&psidEveryone))
defer {
FreeSid(psidEveryone)
}
var everyone = TRUSTEE_W(
pMultipleTrustee: nil,
MultipleTrusteeOperation: NO_MULTIPLE_TRUSTEE,
TrusteeForm: TRUSTEE_IS_SID,
TrusteeType: TRUSTEE_IS_GROUP,
ptstrName:
psidEveryone!.assumingMemoryBound(to: CInterop.PlatformChar.self)
)
return path.withPlatformString { objectName in
var psidOwner: PSID? = nil
var psidGroup: PSID? = nil
var pDacl: PACL? = nil
var pSD: PSECURITY_DESCRIPTOR? = nil
XCTAssertEqual(GetNamedSecurityInfoW(
objectName,
SE_FILE_OBJECT,
SECURITY_INFORMATION(
DACL_SECURITY_INFORMATION
| GROUP_SECURITY_INFORMATION
| OWNER_SECURITY_INFORMATION
),
&psidOwner,
&psidGroup,
&pDacl,
nil,
&pSD), DWORD(ERROR_SUCCESS))
defer {
LocalFree(pSD)
}
var owner = TRUSTEE_W(
pMultipleTrustee: nil,
MultipleTrusteeOperation: NO_MULTIPLE_TRUSTEE,
TrusteeForm: TRUSTEE_IS_SID,
TrusteeType: TRUSTEE_IS_USER,
ptstrName:
psidOwner!.assumingMemoryBound(to: CInterop.PlatformChar.self)
)
var group = TRUSTEE_W(
pMultipleTrustee: nil,
MultipleTrusteeOperation: NO_MULTIPLE_TRUSTEE,
TrusteeForm: TRUSTEE_IS_SID,
TrusteeType: TRUSTEE_IS_GROUP,
ptstrName:
psidGroup!.assumingMemoryBound(to: CInterop.PlatformChar.self)
)
var ownerAccess = ACCESS_MASK(0)
var groupAccess = ACCESS_MASK(0)
var otherAccess = ACCESS_MASK(0)
XCTAssertEqual(GetEffectiveRightsFromAclW(
pDacl,
&owner,
&ownerAccess), DWORD(ERROR_SUCCESS))
XCTAssertEqual(GetEffectiveRightsFromAclW(
pDacl,
&group,
&groupAccess), DWORD(ERROR_SUCCESS))
XCTAssertEqual(GetEffectiveRightsFromAclW(
pDacl,
&everyone,
&otherAccess), DWORD(ERROR_SUCCESS))
return (ownerAccess, groupAccess, otherAccess)
}
}
private func runTests(_ tests: [Test], at path: FilePath) throws {
for test in tests {
let octal = String(test.permissions, radix: 8)
let testPath = path.appending("test-\(octal).txt")
let fd = try FileDescriptor.open(
testPath,
.readWrite,
options: [.create, .truncate],
permissions: FilePermissions(rawValue: test.permissions)
)
_ = try fd.closeAfter {
try fd.writeAll("Hello World".utf8)
}
let (ownerAccess, groupAccess, otherAccess)
= getAccessMasks(path: testPath)
XCTAssertEqual(ownerAccess, test.ownerAccess)
XCTAssertEqual(groupAccess, test.groupAccess)
XCTAssertEqual(otherAccess, test.otherAccess)
}
}
/// Test that the umask works properly
func testUmask() throws {
// Default mask should be 0o022
XCTAssertEqual(FilePermissions.creationMask, [.groupWrite, .otherWrite])
try withTemporaryFilePath(basename: "testUmask") { path in
let tests = [
Test(0o000, 0, 0, 0),
Test(0o700, r|w|x, 0, 0),
Test(0o770, r|w|x, r|x, 0),
Test(0o777, r|w|x, r|x, r|x)
]
try runTests(tests, at: path)
}
try FilePermissions.withCreationMask([.groupWrite, .groupExecute,
.otherWrite, .otherExecute]) {
try withTemporaryFilePath(basename: "testUmask") { path in
let tests = [
Test(0o000, 0, 0, 0),
Test(0o700, r|w|x, 0, 0),
Test(0o770, r|w|x, r, 0),
Test(0o777, r|w|x, r, r)
]
try runTests(tests, at: path)
}
}
}
/// Test that setting permissions on a file works as expected
func testPermissions() throws {
try FilePermissions.withCreationMask([]) {
try withTemporaryFilePath(basename: "testPermissions") { path in
let tests = [
Test(0o000, 0, 0, 0),
Test(0o400, r, 0, 0),
Test(0o200, w, 0, 0),
Test(0o100, x, 0, 0),
Test(0o040, 0, r, 0),
Test(0o020, 0, w, 0),
Test(0o010, 0, x, 0),
Test(0o004, 0, 0, r),
Test(0o002, 0, 0, w),
Test(0o001, 0, 0, x),
Test(0o700, r|w|x, 0, 0),
Test(0o770, r|w|x, r|w|x, 0),
Test(0o777, r|w|x, r|w|x, r|w|x),
Test(0o755, r|w|x, r|x, r|x),
Test(0o644, r|w, r, r),
Test(0o007, 0, 0, r|w|x),
Test(0o070, 0, r|w|x, 0),
Test(0o077, 0, r|w|x, r|w|x),
]
try runTests(tests, at: path)
}
}
}
}
#endif // os(Windows)
@@ -231,7 +231,7 @@ final class FilePathComponentsTest: XCTestCase {
}
func testCases() {
let testPaths: Array<TestPathComponents> = [
var testPaths: Array<TestPathComponents> = [
TestPathComponents("", root: nil, []),
TestPathComponents("/", root: "/", []),
TestPathComponents("foo", root: nil, ["foo"]),
@@ -240,16 +240,28 @@ final class FilePathComponentsTest: XCTestCase {
TestPathComponents("foo/bar", root: nil, ["foo", "bar"]),
TestPathComponents("foo/bar/", root: nil, ["foo", "bar"]),
TestPathComponents("/foo/bar", root: "/", ["foo", "bar"]),
TestPathComponents("///foo//", root: "/", ["foo"]),
TestPathComponents("/foo///bar", root: "/", ["foo", "bar"]),
TestPathComponents("foo/bar/", root: nil, ["foo", "bar"]),
TestPathComponents("foo///bar/baz/", root: nil, ["foo", "bar", "baz"]),
TestPathComponents("//foo///bar/baz/", root: "/", ["foo", "bar", "baz"]),
TestPathComponents("./", root: nil, ["."]),
TestPathComponents("./..", root: nil, [".", ".."]),
TestPathComponents("/./..//", root: "/", [".", ".."]),
]
testPaths.forEach { $0.runAllTests() }
#if !os(Windows)
testPaths.append(contentsOf:[
TestPathComponents("///foo//", root: "/", ["foo"]),
TestPathComponents("//foo///bar/baz/", root: "/", ["foo", "bar", "baz"])
])
#else
// On Windows, these are UNC paths
testPaths.append(contentsOf:[
TestPathComponents("///foo//", root: "///foo//", []),
TestPathComponents("//foo///bar/baz/", root: "//foo//", ["bar", "baz"])
])
#endif
testPaths.forEach {
$0.runAllTests()
}
}
func testSeparatorNormalization() {
@@ -0,0 +1,129 @@
/*
This source file is part of the Swift System open source project
Copyright (c)2024 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
*/
import XCTest
#if SYSTEM_PACKAGE
@testable import SystemPackage
#else
@testable import System
#endif
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
final class FilePathDecodableTest: XCTestCase {
func testInvalidFilePath() {
// _storage is a valid SystemString, but the invariants of FilePath are
// violated (specifically, _storage is not normal).
let input: [UInt8] = [
123, 34, 95,115,116,111,114, 97,103,101, 34, 58,123, 34,110,117,108,108,
84,101,114,109,105,110, 97,116,101,100, 83,116,111,114, 97,103,101, 34,
58, 91, 49, 48, 57, 44, 45, 55, 54, 44, 53, 53, 44, 55, 49, 44, 49, 52,
44, 53, 57, 44, 45, 49, 49, 50, 44, 45, 56, 52, 44, 52, 50, 44, 45, 55,
48, 44, 45, 49, 48, 52, 44, 55, 51, 44, 45, 54, 44, 50, 44, 53, 55, 44,
54, 50, 44, 45, 56, 55, 44, 45, 53, 44, 45, 54, 53, 44, 45, 51, 57, 44,
45, 49, 48, 57, 44, 45, 55, 54, 44, 51, 48, 44, 53, 50, 44, 45, 56, 50,
44, 45, 54, 48, 44, 45, 50, 44, 56, 53, 44, 49, 50, 51, 44, 45, 56, 52,
44, 45, 53, 56, 44, 49, 49, 52, 44, 49, 44, 45, 49, 49, 54, 44, 56, 48,
44, 49, 48, 52, 44, 45, 55, 56, 44, 45, 52, 53, 44, 49, 54, 44, 45, 52,
54, 44, 55, 44, 49, 49, 56, 44, 45, 50, 52, 44, 54, 50, 44, 54, 52, 44,
45, 52, 49, 44, 45, 49, 48, 51, 44, 53, 44, 45, 55, 53, 44, 50, 50, 44,
45, 49, 48, 53, 44, 45, 49, 54, 44, 52, 55, 44, 52, 55, 44, 49, 50, 52,
44, 45, 53, 55, 44, 53, 51, 44, 49, 49, 49, 44, 49, 53, 44, 45, 50, 55,
44, 54, 54, 44, 45, 49, 54, 44, 49, 48, 50, 44, 49, 48, 54, 44, 49, 51,
44, 49, 48, 53, 44, 45, 49, 49, 50, 44, 55, 56, 44, 45, 53, 48, 44, 50,
48, 44, 56, 44, 45, 50, 55, 44, 52, 52, 44, 52, 44, 56, 44, 54, 53, 44,
50, 51, 44, 57, 55, 44, 45, 50, 56, 44, 56, 56, 44, 52, 50, 44, 45, 51,
54, 44, 45, 50, 51, 44, 49, 48, 51, 44, 57, 57, 44, 45, 53, 56, 44, 45,
49, 49, 48, 44, 45, 53, 52, 44, 45, 49, 49, 55, 44, 45, 57, 52, 44, 45,
55, 50, 44, 50, 57, 44, 45, 50, 52, 44, 45, 56, 52, 44, 53, 55, 44, 45,
49, 50, 54, 44, 52, 52, 44, 55, 53, 44, 55, 54, 44, 52, 57, 44, 45, 52,
49, 44, 45, 50, 53, 44, 50, 52, 44, 45, 49, 50, 54, 44, 55, 44, 50, 56,
44, 45, 52, 56, 44, 56, 55, 44, 51, 49, 44, 45, 49, 49, 53, 44, 55, 44,
45, 54, 48, 44, 53, 57, 44, 49, 51, 44, 55, 57, 44, 53, 48, 44, 45, 57,
54, 44, 45, 50, 44, 45, 50, 52, 44, 45, 57, 49, 44, 55, 49, 44, 45, 49,
50, 53, 44, 52, 50, 44, 45, 56, 52, 44, 52, 44, 53, 57, 44, 49, 50, 53,
44, 49, 50, 49, 44, 45, 50, 54, 44, 45, 49, 50, 44, 45, 49, 48, 53, 44,
53, 54, 44, 49, 49, 48, 44, 49, 52, 44, 45, 49, 48, 52, 44, 45, 53, 50,
44, 45, 53, 56, 44, 45, 54, 44, 45, 50, 54, 44, 45, 52, 55, 44, 53, 57,
44, 52, 50, 44, 49, 50, 51, 44, 52, 52, 44, 45, 57, 50, 44, 45, 50, 57,
44, 45, 51, 54, 44, 45, 54, 50, 44, 50, 54, 44, 45, 49, 55, 44, 45, 49,
48, 44, 45, 56, 49, 44, 54, 49, 44, 52, 55, 44, 45, 57, 52, 44, 45, 49,
48, 54, 44, 49, 53, 44, 49, 48, 48, 44, 45, 49, 50, 49, 44, 45, 49, 49,
49, 44, 51, 44, 45, 57, 44, 52, 54, 44, 45, 55, 48, 44, 45, 49, 57, 44,
52, 56, 44, 45, 49, 50, 44, 45, 57, 49, 44, 45, 50, 48, 44, 49, 51, 44,
54, 53, 44, 45, 55, 48, 44, 52, 49, 44, 45, 57, 53, 44, 49, 48, 52, 44,
45, 55, 53, 44, 45, 49, 49, 53, 44, 49, 48, 49, 44, 45, 57, 52, 44, 45,
49, 50, 51, 44, 45, 51, 53, 44, 45, 50, 49, 44, 45, 52, 50, 44, 45, 51,
48, 44, 45, 55, 49, 44, 45, 49, 49, 57, 44, 52, 52, 44, 49, 49, 49, 44,
49, 48, 53, 44, 54, 54, 44, 45, 49, 50, 54, 44, 55, 50, 44, 45, 52, 48,
44, 49, 50, 49, 44, 45, 50, 49, 44, 52, 50, 44, 45, 55, 56, 44, 49, 50,
54, 44, 56, 49, 44, 45, 57, 52, 44, 55, 52, 44, 49, 49, 50, 44, 45, 56,
54, 44, 51, 50, 44, 55, 54, 44, 49, 49, 55, 44, 45, 56, 44, 56, 54, 44,
49, 48, 51, 44, 54, 50, 44, 49, 49, 55, 44, 54, 55, 44, 45, 56, 54, 44,
45, 49, 48, 48, 44, 45, 49, 48, 57, 44, 45, 53, 52, 44, 45, 51, 49, 44,
45, 56, 57, 44, 48, 93,125,125,
]
XCTAssertThrowsError(try JSONDecoder().decode(
FilePath.self,
from: Data(input)
))
}
func testInvalidSystemString() {
// _storage is a SystemString whose invariants are violated; it contains
// a non-terminating null byte.
let input: [UInt8] = [
123, 34, 95,115,116,111,114, 97,103,101, 34, 58,123, 34,110,117,108,108,
84,101,114,109,105,110, 97,116,101,100, 83,116,111,114, 97,103,101, 34,
58, 91, 49, 49, 49, 44, 48, 44, 45, 49, 54, 44, 57, 49, 44, 52, 54, 44,
45, 49, 48, 50, 44, 49, 49, 53, 44, 45, 50, 49, 44, 45, 49, 49, 56, 44,
52, 57, 44, 57, 50, 44, 45, 49, 48, 44, 53, 56, 44, 45, 55, 48, 44, 57,
55, 44, 56, 44, 57, 57, 44, 48, 93,125, 125
]
XCTAssertThrowsError(try JSONDecoder().decode(
FilePath.self,
from: Data(input)
))
}
func testInvalidExample() {
// Another misformed example from Johannes that violates FilePath's
// invariants by virtue of not being normalized.
let input: [UInt8] = [
123, 34, 95,115,116,111,114, 97,103,101, 34, 58,123, 34,110,117,108,108,
84,101,114,109,105,110, 97,116,101,100, 83,116,111,114, 97,103,101, 34,
58, 91, 56, 55, 44, 50, 52, 44, 45, 49, 49, 53, 44, 45, 49, 57, 44, 49,
50, 50, 44, 45, 54, 56, 44, 57, 49, 44, 45, 49, 48, 54, 44, 45, 49, 48,
48, 44, 45, 49, 49, 52, 44, 53, 54, 44, 45, 54, 53, 44, 49, 49, 56, 44,
45, 54, 48, 44, 54, 54, 44, 45, 52, 50, 44, 55, 55, 44, 45, 54, 44, 45,
52, 50, 44, 45, 56, 56, 44, 52, 55, 44, 48, 93,125, 125
]
XCTAssertThrowsError(try JSONDecoder().decode(
FilePath.self,
from: Data(input)
))
}
func testEmptyString() {
// FilePath with an empty (and hence not null-terminated) SystemString.
let input: [UInt8] = [
123, 34, 95,115,116,111,114, 97,103,101, 34, 58,123, 34,110,117,108,108,
84,101,114,109,105,110, 97,116,101,100, 83,116,111,114, 97,103,101, 34,
58, 91, 93,125,125
]
XCTAssertThrowsError(try JSONDecoder().decode(
FilePath.self,
from: Data(input)
))
}
}
@@ -1064,7 +1064,10 @@ final class FilePathSyntaxTest: XCTestCase {
XCTAssert(path.lexicallyContains("usr"))
XCTAssert(path.lexicallyContains("/usr"))
XCTAssert(path.lexicallyContains("local/bin"))
#if !os(Windows)
// On Windows, this is a relative path and is still contained
XCTAssert(!path.lexicallyContains("/local/bin"))
#endif
path.append("..")
XCTAssert(!path.lexicallyContains("local/bin"))
XCTAssert(path.lexicallyContains("local/bin/.."))
@@ -0,0 +1,58 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2024 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
*/
import XCTest
#if SYSTEM_PACKAGE
@testable import SystemPackage
#else
@testable import System
#endif
final class TemporaryPathTest: XCTestCase {
#if SYSTEM_PACKAGE_DARWIN
func testNotInSlashTmp() throws {
try withTemporaryFilePath(basename: "NotInSlashTmp") { path in
// We shouldn't be using "/tmp" on Darwin
XCTAssertNotEqual(path.components.first!, "tmp")
}
}
#endif
func testUnique() throws {
try withTemporaryFilePath(basename: "test") { path in
let strPath = String(decoding: path)
XCTAssert(strPath.contains("test"))
try withTemporaryFilePath(basename: "test") { path2 in
let strPath2 = String(decoding: path2)
XCTAssertNotEqual(strPath, strPath2)
}
}
}
func testCleanup() throws {
var thePath: FilePath? = nil
try withTemporaryFilePath(basename: "test") { path in
thePath = path.appending("foo.txt")
let fd = try FileDescriptor.open(thePath!, .readWrite,
options: [.create, .truncate],
permissions: .ownerReadWrite)
_ = try fd.closeAfter {
try fd.writeAll("Hello World".utf8)
}
}
XCTAssertThrowsError(try FileDescriptor.open(thePath!, .readOnly)) {
error in
XCTAssertEqual(error as! Errno, Errno.noSuchFileOrDirectory)
}
}
}
@@ -16,39 +16,62 @@ import System
#endif
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
func filePathFromUnterminatedBytes<S: Sequence>(_ bytes: S) -> FilePath where S.Element == UInt8 {
func filePathFromInvalidCodePointSequence<S: Sequence>(_ bytes: S) -> FilePath where S.Element == CInterop.PlatformUnicodeEncoding.CodeUnit {
var array = Array(bytes)
assert(array.last != 0, "already null terminated")
array += [0]
return array.withUnsafeBufferPointer {
$0.withMemoryRebound(to: CChar.self) {
$0.withMemoryRebound(to: CInterop.PlatformChar.self) {
FilePath(platformString: $0.baseAddress!)
}
}
}
let invalidBytes: [UInt8] = [0x2F, 0x61, 0x2F, 0x62, 0x2F, 0x83]
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
final class FilePathTest: XCTestCase {
struct TestPath {
let filePath: FilePath
let string: String
let validUTF8: Bool
let validString: Bool
init(filePath: FilePath, string: String, validString: Bool) {
self.filePath = filePath
#if os(Windows)
self.string = string.replacingOccurrences(of: "/", with: "\\")
#else
self.string = string
#endif
self.validString = validString
}
}
let testPaths: [TestPath] = [
#if os(Windows)
static let invalidSequence: [UTF16.CodeUnit] = [0xd800, 0x0020]
static let invalidSequenceTest =
TestPath(filePath: filePathFromInvalidCodePointSequence(invalidSequence),
string: String(decoding: invalidSequence, as: UTF16.self),
validString: false)
#else
static let invalidSequence: [UTF8.CodeUnit] = [0x2F, 0x61, 0x2F, 0x62, 0x2F, 0x83]
static let invalidSequenceTest =
TestPath(filePath: filePathFromInvalidCodePointSequence(invalidSequence),
string: String(decoding: invalidSequence, as: UTF8.self),
validString: false)
#endif
var testPaths: [TestPath] = [
// empty
TestPath(filePath: FilePath(), string: String(), validUTF8: true),
TestPath(filePath: FilePath(), string: String(), validString: true),
// valid ascii
TestPath(filePath: "/a/b/c", string: "/a/b/c", validUTF8: true),
TestPath(filePath: "/a/b/c", string: "/a/b/c", validString: true),
// valid utf8
TestPath(filePath: "/あ/🧟‍♀️", string: "/あ/🧟‍♀️", validUTF8: true),
TestPath(filePath: "/あ/🧟‍♀️", string: "/あ/🧟‍♀️", validString: true),
// invalid utf8
TestPath(filePath: filePathFromUnterminatedBytes(invalidBytes), string: String(decoding: invalidBytes, as: UTF8.self), validUTF8: false),
// invalid sequence
invalidSequenceTest,
]
func testFilePath() {
@@ -59,8 +82,8 @@ final class FilePathTest: XCTestCase {
XCTAssertEqual(testPath.string, String(decoding: testPath.filePath))
// TODO: test component UTF8 validation
if testPath.validUTF8 {
// TODO: test component CodeUnit representation validation
if testPath.validString {
XCTAssertEqual(testPath.filePath, FilePath(testPath.string))
XCTAssertEqual(testPath.string, String(validating: testPath.filePath))
} else {
+9 -2
View File
@@ -42,18 +42,25 @@ final class FileDescriptorTest: XCTestCase {
#endif
// BSD only
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if SYSTEM_PACKAGE_DARWIN || os(FreeBSD)
XCTAssertEqual(O_SHLOCK, FileDescriptor.OpenOptions.sharedLock.rawValue)
XCTAssertEqual(O_EXLOCK, FileDescriptor.OpenOptions.exclusiveLock.rawValue)
#endif
#if SYSTEM_PACKAGE_DARWIN
XCTAssertEqual(O_SYMLINK, FileDescriptor.OpenOptions.symlink.rawValue)
XCTAssertEqual(O_EVTONLY, FileDescriptor.OpenOptions.eventOnly.rawValue)
#endif
#if os(FreeBSD)
XCTAssertEqual(O_SYNC, FileDescriptor.OpenOptions.sync.rawValue)
#endif
XCTAssertEqual(SEEK_SET, FileDescriptor.SeekOrigin.start.rawValue)
XCTAssertEqual(SEEK_CUR, FileDescriptor.SeekOrigin.current.rawValue)
XCTAssertEqual(SEEK_END, FileDescriptor.SeekOrigin.end.rawValue)
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
#if SYSTEM_PACKAGE_DARWIN || os(FreeBSD)
XCTAssertEqual(SEEK_HOLE, FileDescriptor.SeekOrigin.nextHole.rawValue)
XCTAssertEqual(SEEK_DATA, FileDescriptor.SeekOrigin.nextData.rawValue)
#endif
+137 -46
View File
@@ -7,40 +7,51 @@
See https://swift.org/LICENSE.txt for license information
*/
#if swift(>=5.8) && $MoveOnly && (os(macOS) || os(iOS) || os(watchOS) || os(tvOS))
#if swift(>=5.9) && SYSTEM_PACKAGE_DARWIN
import XCTest
import Darwin.Mach
#if SYSTEM_PACKAGE
import SystemPackage
#else
import System
#endif
@available(/*System 1.4.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
final class MachPortTests: XCTestCase {
func refCountForMachPortName(name:mach_port_name_t, kind:mach_port_right_t) -> mach_port_urefs_t {
var refCount:mach_port_urefs_t = 0
withUnsafeMutablePointer(to: &refCount) { refCount in
let kr = mach_port_get_refs(mach_task_self_, name, kind, refCount)
assert(kr == KERN_SUCCESS)
var refCount:mach_port_urefs_t = .max
let kr = mach_port_get_refs(mach_task_self_, name, kind, &refCount)
if kr == KERN_INVALID_NAME {
refCount = 0
} else {
XCTAssertEqual(kr, KERN_SUCCESS)
}
return refCount
}
func scopedReceiveRight(name:mach_port_name_t) -> mach_port_urefs_t {
_ = Mach.Port<Mach.ReceiveRight>(name:name) // this should automatically deallocate when going out of scope
let right = Mach.Port<Mach.ReceiveRight>(name:name) // this should automatically deallocate when going out of scope
defer { _ = right }
return refCountForMachPortName(name:name, kind:MACH_PORT_RIGHT_RECEIVE)
}
func testRecieveRightDeallocation() throws {
var name:mach_port_name_t = 0 // Never read
withUnsafeMutablePointer(to:&name) { name in
let kr = mach_port_allocate(mach_task_self_, MACH_PORT_RIGHT_RECEIVE, name)
assert(kr == KERN_SUCCESS)
}
func testReceiveRightDeallocation() throws {
var name: mach_port_name_t = 0xFFFFFFFF
let kr = mach_port_allocate(mach_task_self_, MACH_PORT_RIGHT_RECEIVE, &name)
XCTAssertEqual(kr, KERN_SUCCESS)
XCTAssert(name != 0xFFFFFFFF)
XCTAssertNotEqual(name, 0xFFFFFFFF)
let one = scopedReceiveRight(name:name)
let zero = refCountForMachPortName(name:name, kind: MACH_PORT_RIGHT_RECEIVE)
let originalCount = refCountForMachPortName(name: name, kind: MACH_PORT_RIGHT_RECEIVE)
XCTAssertEqual(originalCount, 1)
XCTAssert(one == 1);
XCTAssert(zero == 0);
let incrementedCount = scopedReceiveRight(name:name)
XCTAssertEqual(incrementedCount, 1);
let deallocated = refCountForMachPortName(name:name, kind: MACH_PORT_RIGHT_RECEIVE)
XCTAssertEqual(deallocated, 0);
}
func consumeSendRightAutomatically(name:mach_port_name_t) -> mach_port_urefs_t {
@@ -55,11 +66,11 @@ final class MachPortTests: XCTestCase {
let recv = Mach.Port<Mach.ReceiveRight>()
recv.withBorrowedName { name in
let kr = mach_port_insert_right(mach_task_self_, name, name, mach_msg_type_name_t(MACH_MSG_TYPE_MAKE_SEND))
XCTAssert(kr == KERN_SUCCESS)
XCTAssertEqual(kr, KERN_SUCCESS)
let one = consumeSendRightAutomatically(name:name)
XCTAssert(one == 1);
XCTAssertEqual(one, 1);
let zero = refCountForMachPortName(name:name, kind:MACH_PORT_RIGHT_SEND)
XCTAssert(zero == 0);
XCTAssertEqual(zero, 0);
}
}
@@ -71,29 +82,70 @@ final class MachPortTests: XCTestCase {
let one = send.withBorrowedName { name in
return self.refCountForMachPortName(name:name, kind:MACH_PORT_RIGHT_SEND)
}
XCTAssert(one == 1)
XCTAssertEqual(one, 1)
return send.relinquish()
})()
let stillOne = refCountForMachPortName(name:name, kind:MACH_PORT_RIGHT_SEND)
XCTAssert(stillOne == 1)
XCTAssertEqual(stillOne, 1)
recv.withBorrowedName {
let alsoOne = refCountForMachPortName(name: $0, kind: MACH_PORT_RIGHT_RECEIVE)
XCTAssertEqual(alsoOne, 1)
}
}
func testSendOnceRightRelinquishment() throws {
let recv = Mach.Port<Mach.ReceiveRight>()
let name = ({
let send = recv.makeSendOnceRight()
let one = send.withBorrowedName { name in
return self.refCountForMachPortName(name: name, kind: MACH_PORT_RIGHT_SEND_ONCE)
}
XCTAssertEqual(one, 1)
return send.relinquish()
})()
let stillOne = refCountForMachPortName(name: name, kind: MACH_PORT_RIGHT_SEND_ONCE)
XCTAssertEqual(stillOne, 1)
recv.withBorrowedName {
let alsoOne = refCountForMachPortName(name: $0, kind: MACH_PORT_RIGHT_RECEIVE)
XCTAssertEqual(alsoOne, 1)
}
}
func testReceiveRightRelinquishment() throws {
let recv = Mach.Port<Mach.ReceiveRight>()
let one = recv.withBorrowedName {
self.refCountForMachPortName(name: $0, kind: MACH_PORT_RIGHT_RECEIVE)
}
XCTAssertEqual(one, 1)
let name = recv.unguardAndRelinquish()
let stillOne = refCountForMachPortName(name: name, kind: MACH_PORT_RIGHT_RECEIVE)
XCTAssertEqual(stillOne, 1)
}
func testMakeSendCountSettable() throws {
var recv = Mach.Port<Mach.ReceiveRight>()
XCTAssert(recv.makeSendCount == 0)
XCTAssertEqual(recv.makeSendCount, 0)
recv.makeSendCount = 7
XCTAssert(recv.makeSendCount == 7)
XCTAssertEqual(recv.makeSendCount, 7)
}
func makeSendRight() throws -> Mach.Port<Mach.SendRight> {
let recv = Mach.Port<Mach.ReceiveRight>()
let zero = recv.makeSendCount
XCTAssert(zero == 0)
XCTAssertEqual(zero, 0)
let send = recv.makeSendRight()
let one = recv.makeSendCount
XCTAssert(one == 1)
XCTAssertEqual(one, 1)
return send
}
@@ -104,10 +156,10 @@ final class MachPortTests: XCTestCase {
func testMakeSendOnceDoesntIncrementMakeSendCount() throws {
let recv = Mach.Port<Mach.ReceiveRight>()
let zero = recv.makeSendCount
XCTAssert(zero == 0)
XCTAssertEqual(zero, 0)
_ = recv.makeSendOnceRight()
let same = recv.makeSendCount
XCTAssert(same == zero)
XCTAssertEqual(same, zero)
}
func testMakeSendOnceIsUnique() throws {
@@ -115,21 +167,7 @@ final class MachPortTests: XCTestCase {
let once = recv.makeSendOnceRight()
recv.withBorrowedName { rname in
once.withBorrowedName { oname in
print(oname, rname)
XCTAssert(oname != rname)
}
}
}
func testMakePair() throws {
let (recv, send) = Mach.allocatePortRightPair()
XCTAssert(recv.makeSendCount == 1)
recv.withBorrowedName { rName in
send.withBorrowedName { sName in
XCTAssert(rName != 0xFFFFFFFF)
XCTAssert(rName != MACH_PORT_NULL)
// send and recv port names coalesce
XCTAssert(rName == sName)
XCTAssertNotEqual(oname, rname)
}
}
}
@@ -137,15 +175,68 @@ final class MachPortTests: XCTestCase {
func testCopySend() throws {
let recv = Mach.Port<Mach.ReceiveRight>()
let zero = recv.makeSendCount
XCTAssert(zero == 0)
XCTAssertEqual(zero, 0)
let send = recv.makeSendRight()
let one = recv.makeSendCount
XCTAssert(one == 1)
XCTAssertEqual(one, 1)
_ = try send.copySendRight()
let same = recv.makeSendCount
XCTAssert(same == one)
XCTAssertEqual(same, one)
}
func testCopyDeadName() throws {
let recv = Mach.Port<Mach.ReceiveRight>()
let send = recv.makeSendRight()
_ = consume recv // and turn `send` into a dead name
XCTAssertThrowsError(
_ = try send.copySendRight(),
"Copying a dead name should throw"
) { error in
XCTAssertEqual(
error as! Mach.PortRightError, Mach.PortRightError.deadName
)
}
}
func testCopyDeadName2() throws {
let send = Mach.Port<Mach.SendRight>(name: 0xffffffff)
XCTAssertThrowsError(
_ = try send.copySendRight(),
"Copying a dead name should throw"
) { error in
XCTAssertEqual(
error as! Mach.PortRightError, Mach.PortRightError.deadName
)
}
}
func testMakeReceiveRightFromExistingName() throws {
var name = mach_port_name_t(MACH_PORT_NULL)
var kr = mach_port_allocate(mach_task_self_, MACH_PORT_RIGHT_RECEIVE, &name)
XCTAssertEqual(kr, KERN_SUCCESS)
XCTAssertNotEqual(name, mach_port_name_t(MACH_PORT_NULL))
let context = mach_port_context_t(arc4random())
kr = mach_port_guard(mach_task_self_, name, context, 0)
XCTAssertEqual(kr, KERN_SUCCESS)
let right = Mach.Port<Mach.ReceiveRight>(name: name, context: context)
right.withBorrowedName {
XCTAssertEqual(name, $0)
XCTAssertEqual(context, $1)
}
}
func testDeinitDeadSendRights() throws {
let recv = Mach.Port<Mach.ReceiveRight>()
let send = recv.makeSendRight()
let send1 = recv.makeSendOnceRight()
_ = consume recv
// `send` and `send1` have become dead names
_ = consume send
_ = consume send1
}
}
#endif
+7 -2
View File
@@ -1,7 +1,7 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2020 Apple Inc. and the Swift System project authors
Copyright (c) 2020 - 2024 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
@@ -101,7 +101,7 @@ struct StringTest: TestCase {
// Test null insertion
let rawChars = raw.lazy.map { SystemChar($0) }
expectEqual(sysRaw, SystemString(rawChars.dropLast()))
sysRaw.withSystemChars { // TODO: assuming we want null in withSysChars
sysRaw.withNullTerminatedSystemChars {
expectEqualSequence(rawChars, $0, "rawChars")
}
@@ -254,6 +254,11 @@ final class SystemStringTest: XCTestCase {
XCTAssert(str == "abcd")
}
func testStringProperty() {
let source: [CInterop.PlatformChar] = [0x61, 0x62, 0, 0x63]
let str = SystemString(platformString: source)
XCTAssertEqual(str.string, str[...].string)
}
}
extension SystemStringTest {
-132
View File
@@ -1,132 +0,0 @@
#if !canImport(ObjectiveC) && swift(<5.5)
import XCTest
extension ErrnoTest {
// DO NOT MODIFY: This is autogenerated, use:
// `swift test --generate-linuxmain`
// to regenerate.
static let __allTests__ErrnoTest = [
("testConstants", testConstants),
("testPatternMatching", testPatternMatching),
]
}
extension FileDescriptorTest {
// DO NOT MODIFY: This is autogenerated, use:
// `swift test --generate-linuxmain`
// to regenerate.
static let __allTests__FileDescriptorTest = [
("testConstants", testConstants),
("testStandardDescriptors", testStandardDescriptors),
]
}
extension FileOperationsTest {
// DO NOT MODIFY: This is autogenerated, use:
// `swift test --generate-linuxmain`
// to regenerate.
static let __allTests__FileOperationsTest = [
("testAdHocOpen", testAdHocOpen),
("testAdHocPipe", testAdHocPipe),
("testGithubIssues", testGithubIssues),
("testHelpers", testHelpers),
("testSyscalls", testSyscalls),
]
}
extension FilePathComponentsTest {
// DO NOT MODIFY: This is autogenerated, use:
// `swift test --generate-linuxmain`
// to regenerate.
static let __allTests__FilePathComponentsTest = [
("testAdHocRRC", testAdHocRRC),
("testCases", testCases),
("testSeparatorNormalization", testSeparatorNormalization),
]
}
extension FilePathParsingTest {
// DO NOT MODIFY: This is autogenerated, use:
// `swift test --generate-linuxmain`
// to regenerate.
static let __allTests__FilePathParsingTest = [
("testNormalization", testNormalization),
]
}
extension FilePathSyntaxTest {
// DO NOT MODIFY: This is autogenerated, use:
// `swift test --generate-linuxmain`
// to regenerate.
static let __allTests__FilePathSyntaxTest = [
("testAdHocMutations", testAdHocMutations),
("testFailableStringInitializers", testFailableStringInitializers),
("testLexicallyRelative", testLexicallyRelative),
("testPartialWindowsRoots", testPartialWindowsRoots),
("testPathSyntax", testPathSyntax),
("testPrefixSuffix", testPrefixSuffix),
]
}
extension FilePathTest {
// DO NOT MODIFY: This is autogenerated, use:
// `swift test --generate-linuxmain`
// to regenerate.
static let __allTests__FilePathTest = [
("testFilePath", testFilePath),
]
}
extension FilePermissionsTest {
// DO NOT MODIFY: This is autogenerated, use:
// `swift test --generate-linuxmain`
// to regenerate.
static let __allTests__FilePermissionsTest = [
("testPermissions", testPermissions),
]
}
extension MockingTest {
// DO NOT MODIFY: This is autogenerated, use:
// `swift test --generate-linuxmain`
// to regenerate.
static let __allTests__MockingTest = [
("testMocking", testMocking),
]
}
extension SystemCharTest {
// DO NOT MODIFY: This is autogenerated, use:
// `swift test --generate-linuxmain`
// to regenerate.
static let __allTests__SystemCharTest = [
("testIsLetter", testIsLetter),
]
}
extension SystemStringTest {
// DO NOT MODIFY: This is autogenerated, use:
// `swift test --generate-linuxmain`
// to regenerate.
static let __allTests__SystemStringTest = [
("testAdHoc", testAdHoc),
("testPlatformString", testPlatformString),
]
}
public func __allTests() -> [XCTestCaseEntry] {
return [
testCase(ErrnoTest.__allTests__ErrnoTest),
testCase(FileDescriptorTest.__allTests__FileDescriptorTest),
testCase(FileOperationsTest.__allTests__FileOperationsTest),
testCase(FilePathComponentsTest.__allTests__FilePathComponentsTest),
testCase(FilePathParsingTest.__allTests__FilePathParsingTest),
testCase(FilePathSyntaxTest.__allTests__FilePathSyntaxTest),
testCase(FilePathTest.__allTests__FilePathTest),
testCase(FilePermissionsTest.__allTests__FilePermissionsTest),
testCase(MockingTest.__allTests__MockingTest),
testCase(SystemCharTest.__allTests__SystemCharTest),
testCase(SystemStringTest.__allTests__SystemStringTest),
]
}
#endif
+2 -1
View File
@@ -54,9 +54,10 @@ import argparse
versions = {
"System 0.0.1": "macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0",
"System 0.0.2": "macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0",
"System 1.1.0": "macOS 9999, iOS 9999, watchOS 9999, tvOS 9999",
"System 1.1.0": "macOS 12.3, iOS 15.4, watchOS 8.5, tvOS 15.4",
"System 1.2.0": "macOS 9999, iOS 9999, watchOS 9999, tvOS 9999",
"System 1.3.0": "macOS 9999, iOS 9999, watchOS 9999, tvOS 9999",
"System 1.4.0": "macOS 9999, iOS 9999, watchOS 9999, tvOS 9999",
}
parser = argparse.ArgumentParser(description="Expand availability macros.")
+30 -10
View File
@@ -36,7 +36,7 @@ function(get_swift_host_arch result_var_name)
elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "armv7-a")
set("${result_var_name}" "armv7" PARENT_SCOPE)
elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "amd64")
set("${result_var_name}" "amd64" PARENT_SCOPE)
set("${result_var_name}" "x86_64" PARENT_SCOPE)
elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "AMD64")
set("${result_var_name}" "x86_64" PARENT_SCOPE)
elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "IA64")
@@ -45,6 +45,8 @@ function(get_swift_host_arch result_var_name)
set("${result_var_name}" "i686" PARENT_SCOPE)
elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "i686")
set("${result_var_name}" "i686" PARENT_SCOPE)
elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "riscv64")
set("${result_var_name}" "riscv64" PARENT_SCOPE)
else()
message(FATAL_ERROR "Unrecognized architecture on host system: ${CMAKE_SYSTEM_PROCESSOR}")
endif()
@@ -67,6 +69,28 @@ function(get_swift_host_os result_var_name)
endif()
endfunction()
if(NOT Swift_MODULE_TRIPLE)
# Attempt to get the module triple from the Swift compiler.
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")
# Exit now if we failed to infer the triple.
if(NOT module_triple)
message(FATAL_ERROR
"Failed to get module triple from Swift compiler. "
"Compiler output: ${target_info_json}")
endif()
# Cache the module triple for future use.
set(Swift_MODULE_TRIPLE "${module_triple}" CACHE STRING "swift module triple used for installed swiftmodule and swiftinterface files")
mark_as_advanced(Swift_MODULE_TRIPLE)
endif()
function(_install_target module)
get_swift_host_os(swift_os)
get_target_property(type ${module} TYPE)
@@ -77,24 +101,20 @@ function(_install_target module)
set(swift swift)
endif()
install(TARGETS ${module}
ARCHIVE DESTINATION lib/${swift}/${swift_os}
LIBRARY DESTINATION lib/${swift}/${swift_os}
RUNTIME DESTINATION bin)
install(TARGETS ${module})
if(type STREQUAL EXECUTABLE)
return()
endif()
get_swift_host_arch(swift_arch)
get_target_property(module_name ${module} Swift_MODULE_NAME)
if(NOT module_name)
set(module_name ${module})
endif()
install(FILES $<TARGET_PROPERTY:${module},Swift_MODULE_DIRECTORY>/${module_name}.swiftdoc
DESTINATION lib/${swift}/${swift_os}/${module_name}.swiftmodule
RENAME ${swift_arch}.swiftdoc)
DESTINATION ${CMAKE_INSTALL_LIBDIR}/${swift}/${swift_os}/${module_name}.swiftmodule
RENAME ${Swift_MODULE_TRIPLE}.swiftdoc)
install(FILES $<TARGET_PROPERTY:${module},Swift_MODULE_DIRECTORY>/${module_name}.swiftmodule
DESTINATION lib/${swift}/${swift_os}/${module_name}.swiftmodule
RENAME ${swift_arch}.swiftmodule)
DESTINATION ${CMAKE_INSTALL_LIBDIR}/${swift}/${swift_os}/${module_name}.swiftmodule
RENAME ${Swift_MODULE_TRIPLE}.swiftmodule)
endfunction()