Merge pull request #220 from glessard/1.4.2

[1.4.x] Support for FreeBSD and OpenBSD

Author: glessard

.gitignore

@@ -2,7 +2,8 @@
 /.swiftpm
 /.build
 /Packages
-swift-system.xcodeproj
+/*.xcodeproj
 xcuserdata/
 .*.sw?
+/.swiftpm
 .docc-build

CMakeLists.txt

@@ -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)

Sources/CSystem/CMakeLists.txt

@@ -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

Sources/System/Errno.swift

@@ -1067,7 +1067,7 @@ public struct Errno: RawRepresentable, Error, Hashable, Codable {
   public static var ENOSYS: Errno { noFunction }
 
 // BSD
-#if SYSTEM_PACKAGE_DARWIN
+#if SYSTEM_PACKAGE_DARWIN || os(FreeBSD)
   /// Inappropriate file type or format.
   ///
   /// The file was the wrong type for the operation,
@@ -1082,7 +1082,7 @@ public struct Errno: RawRepresentable, Error, Hashable, Codable {
   public static var EFTYPE: Errno { badFileTypeOrFormat }
 #endif
 
-#if SYSTEM_PACKAGE_DARWIN
+#if SYSTEM_PACKAGE_DARWIN || os(FreeBSD)
   /// Authentication error.
   ///
   /// The authentication ticket used to mount an NFS file system was invalid.
@@ -1253,7 +1253,7 @@ public struct Errno: RawRepresentable, Error, Hashable, Codable {
   @available(*, unavailable, renamed: "illegalByteSequence")
   public static var EILSEQ: Errno { illegalByteSequence }
 
-#if SYSTEM_PACKAGE_DARWIN
+#if SYSTEM_PACKAGE_DARWIN || os(FreeBSD)
   /// Attribute not found.
   ///
   /// The specified extended attribute doesn't exist.
@@ -1294,7 +1294,7 @@ public struct Errno: RawRepresentable, Error, Hashable, Codable {
   @available(*, unavailable, renamed: "multiHop")
   public static var EMULTIHOP: Errno { multiHop }
 
-#if !os(WASI)
+#if !os(WASI) && !os(FreeBSD)
   /// No message available.
   ///
   /// No message was available to be received by the requested operation.
@@ -1320,7 +1320,7 @@ public struct Errno: RawRepresentable, Error, Hashable, Codable {
   @available(*, unavailable, renamed: "noLink")
   public static var ENOLINK: Errno { noLink }
 
-#if !os(WASI)
+#if !os(WASI) && !os(FreeBSD)
   /// Reserved.
   ///
   /// This error is reserved for future use.
@@ -1361,7 +1361,7 @@ public struct Errno: RawRepresentable, Error, Hashable, Codable {
   @available(*, unavailable, renamed: "protocolError")
   public static var EPROTO: Errno { protocolError }
 
-#if !os(OpenBSD) && !os(WASI)
+#if !os(OpenBSD) && !os(WASI) && !os(FreeBSD)
   /// Reserved.
   ///
   /// This error is reserved for future use.
@@ -1459,6 +1459,38 @@ extension Errno {
   public static var EOWNERDEAD: Errno { previousOwnerDied }
 #endif
 
+#if os(FreeBSD)
+  /// Capabilities insufficient.
+  ///
+  /// The corresponding C error is `ENOTCAPABLE`.
+  @_alwaysEmitIntoClient
+  public static var notCapable: Errno { .init(rawValue: _ENOTCAPABLE) }
+
+  @_alwaysEmitIntoClient
+  @available(*, unavailable, renamed: "notCapable")
+  public static var ENOTCAPABLE: Errno { notCapable }
+
+  /// Not permitted in capability mode.
+  ///
+  /// The corresponding C error is `ECAPMODE`.
+  @_alwaysEmitIntoClient
+  public static var capabilityMode: Errno { .init(rawValue: _ECAPMODE) }
+
+  @_alwaysEmitIntoClient
+  @available(*, unavailable, renamed: "capabilityMode")
+  public static var ECAPMODE: Errno { capabilityMode }
+
+  /// Integrity check failed.
+  ///
+  /// The corresponding C error is `EINTEGRITY`.
+  @_alwaysEmitIntoClient
+  public static var integrityCheckFailed: Errno { .init(rawValue: _EINTEGRITY) }
+
+  @_alwaysEmitIntoClient
+  @available(*, unavailable, renamed: "integrityCheckFailed")
+  public static var EINTEGRITY: Errno { integrityCheckFailed }
+#endif
+
 #if SYSTEM_PACKAGE_DARWIN
   /// Interface output queue is full.
   ///
@@ -1469,7 +1501,9 @@ extension Errno {
   @_alwaysEmitIntoClient
   @available(*, unavailable, renamed: "outputQueueFull")
   public static var EQFULL: Errno { outputQueueFull }
+#endif
 
+#if SYSTEM_PACKAGE_DARWIN || os(FreeBSD)
   /// The largest valid error.
   ///
   /// This value is the largest valid value

Sources/System/FileDescriptor.swift

@@ -182,7 +182,7 @@ extension FileDescriptor {
     @available(*, unavailable, renamed: "exclusiveCreate")
     public static var O_EXCL: OpenOptions { exclusiveCreate }
 
-#if SYSTEM_PACKAGE_DARWIN
+#if SYSTEM_PACKAGE_DARWIN || os(FreeBSD)
     /// Indicates that opening the file
     /// atomically obtains a shared lock on the file.
     ///
@@ -250,6 +250,22 @@ extension FileDescriptor {
     public static var O_DIRECTORY: OpenOptions { directory }
 #endif
 
+#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.
@@ -354,7 +370,7 @@ extension FileDescriptor {
 
 // TODO: These are available on some versions of Linux with appropriate
 // macro defines.
-#if SYSTEM_PACKAGE_DARWIN
+#if SYSTEM_PACKAGE_DARWIN || os(FreeBSD)
     /// Indicates that the offset should be set
     /// to the next hole after the specified number of bytes.
     ///
@@ -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"),

Sources/System/Internals/Constants.swift

@@ -359,7 +359,7 @@ internal var _ENOLCK: CInt { ENOLCK }
 @_alwaysEmitIntoClient
 internal var _ENOSYS: CInt { ENOSYS }
 
-#if SYSTEM_PACKAGE_DARWIN
+#if SYSTEM_PACKAGE_DARWIN || os(FreeBSD)
 @_alwaysEmitIntoClient
 internal var _EFTYPE: CInt { EFTYPE }
 
@@ -368,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 }
 
@@ -409,7 +411,7 @@ internal var _ENOMSG: CInt { ENOMSG }
 @_alwaysEmitIntoClient
 internal var _EILSEQ: CInt { EILSEQ }
 
-#if SYSTEM_PACKAGE_DARWIN
+#if SYSTEM_PACKAGE_DARWIN || os(FreeBSD)
 @_alwaysEmitIntoClient
 internal var _ENOATTR: CInt { ENOATTR }
 #endif
@@ -422,15 +424,15 @@ internal var _EBADMSG: CInt { EBADMSG }
 @_alwaysEmitIntoClient
 internal var _EMULTIHOP: CInt { EMULTIHOP }
 
-#if !os(WASI)
+#if !os(WASI) && !os(FreeBSD)
 @_alwaysEmitIntoClient
 internal var _ENODATA: CInt { ENODATA }
 #endif
 
 @_alwaysEmitIntoClient
 internal var _ENOLINK: CInt { ENOLINK }
 
-#if !os(WASI)
+#if !os(WASI) && !os(FreeBSD)
 @_alwaysEmitIntoClient
 internal var _ENOSR: CInt { ENOSR }
 
@@ -442,7 +444,7 @@ internal var _ENOSTR: CInt { ENOSTR }
 @_alwaysEmitIntoClient
 internal var _EPROTO: CInt { EPROTO }
 
-#if !os(OpenBSD) && !os(WASI)
+#if !os(OpenBSD) && !os(WASI) && !os(FreeBSD)
 @_alwaysEmitIntoClient
 internal var _ETIME: CInt { ETIME }
 #endif
@@ -471,10 +473,23 @@ internal var _ENOTRECOVERABLE: CInt { ENOTRECOVERABLE }
 internal var _EOWNERDEAD: CInt { EOWNERDEAD }
 #endif
 
+#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
@@ -524,7 +539,7 @@ internal var _O_APPEND: CInt {
 #endif
 }
 
-#if SYSTEM_PACKAGE_DARWIN
+#if SYSTEM_PACKAGE_DARWIN || os(FreeBSD)
 @_alwaysEmitIntoClient
 internal var _O_SHLOCK: CInt { O_SHLOCK }
 
@@ -543,6 +558,14 @@ internal var _O_ASYNC: CInt { O_ASYNC }
 internal var _O_NOFOLLOW: CInt { O_NOFOLLOW }
 #endif
 
+#if os(FreeBSD)
+@_alwaysEmitIntoClient
+internal var _O_FSYNC: CInt { O_FSYNC }
+
+@_alwaysEmitIntoClient
+internal var _O_SYNC: CInt { O_SYNC }
+#endif
+
 @_alwaysEmitIntoClient
 internal var _O_CREAT: CInt {
 #if os(WASI)
@@ -609,7 +632,7 @@ internal var _SEEK_CUR: CInt { SEEK_CUR }
 @_alwaysEmitIntoClient
 internal var _SEEK_END: CInt { SEEK_END }
 
-#if SYSTEM_PACKAGE_DARWIN
+#if SYSTEM_PACKAGE_DARWIN || os(FreeBSD)
 @_alwaysEmitIntoClient
 internal var _SEEK_HOLE: CInt { SEEK_HOLE }
 

Sources/System/Internals/RawBuffer.swift

@@ -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
     }
   }

Sources/System/Internals/Syscalls.swift

@@ -191,7 +191,7 @@ internal func system_confstr(
 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)
+#if os(Linux) || os(Android) || os(FreeBSD) || os(OpenBSD)
 internal typealias system_DIRPtr = OpaquePointer
 #else
 internal typealias system_DIRPtr = UnsafeMutablePointer<DIR>

Sources/System/Internals/WindowsSyscallAdapters.swift

@@ -187,7 +187,7 @@ internal func pwrite(
 internal func pipe(
   _ fds: UnsafeMutablePointer<Int32>, bytesReserved: UInt32 = 4096
 ) -> CInt {
-  return _pipe(fds, bytesReserved, _O_BINARY | _O_NOINHERIT);
+  return _pipe(fds, bytesReserved, _O_BINARY | _O_NOINHERIT);
 }
 
 @inline(__always)

Tests/SystemTests/ErrnoTest.swift

@@ -131,10 +131,13 @@ final class ErrnoTest: XCTestCase {
     XCTAssert(ENOLCK == Errno.noLocks.rawValue)
     XCTAssert(ENOSYS == Errno.noFunction.rawValue)
 
-#if SYSTEM_PACKAGE_DARWIN
+#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
@@ -164,13 +167,17 @@ final class ErrnoTest: XCTestCase {
 #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
@@ -192,6 +199,12 @@ final class ErrnoTest: XCTestCase {
     XCTAssert(EOWNERDEAD == Errno.previousOwnerDied.rawValue)
 #endif
 
+#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)