[FreeBSD] Fix FreeBSD build/support (#1075)

michael-yuji · web-flow · commit 5ed6c724845b · 2025-01-10T14:20:27.000-08:00
* FreeBSD platform specific fixes

- Use "/usr/share/zoneinfo"
- Use platform specific types and values
- Implement extattr ops for FreeBSD
- Use copy_file_range(2) for file cloning

* Revise patch to ProcessInfo to reduce potential impact to other platforms

* Fix macOS build

* typo

* take suggested change
diff --git a/Sources/FoundationEssentials/Data/Data+Reading.swift b/Sources/FoundationEssentials/Data/Data+Reading.swift
@@ -34,6 +34,8 @@ import WASILibc
 func _fgetxattr(_ fd: Int32, _ name: UnsafePointer<CChar>!, _ value: UnsafeMutableRawPointer!, _ size: Int, _ position: UInt32, _ options: Int32) -> Int {
 #if canImport(Darwin)
     return fgetxattr(fd, name, value, size, position, options)
+#elseif os(FreeBSD)
+    return extattr_get_fd(fd, EXTATTR_NAMESPACE_USER, name, value, size)
 #elseif canImport(Glibc) || canImport(Musl) || canImport(Android)
     return fgetxattr(fd, name, value, size)
 #else
diff --git a/Sources/FoundationEssentials/Data/Data+Writing.swift b/Sources/FoundationEssentials/Data/Data+Writing.swift
@@ -610,6 +610,8 @@ private func writeExtendedAttributes(fd: Int32, attributes: [String : Data]) {
             // Returns non-zero on error, but we ignore them
 #if canImport(Darwin)
             _ = fsetxattr(fd, key, valueBuf.baseAddress!, valueBuf.count, 0, 0)
+#elseif os(FreeBSD)
+            _ = extattr_set_fd(fd, EXTATTR_NAMESPACE_USER, key, valueBuf.baseAddress!, valueBuf.count)
 #elseif canImport(Glibc) || canImport(Musl)
             _ = fsetxattr(fd, key, valueBuf.baseAddress!, valueBuf.count, 0)
 #endif
diff --git a/Sources/FoundationEssentials/Error/ErrorCodes+POSIX.swift b/Sources/FoundationEssentials/Error/ErrorCodes+POSIX.swift
@@ -623,7 +623,7 @@ extension POSIXError {
         return .EMULTIHOP
     }
 
-    #if !os(WASI)
+    #if !os(WASI) && !os(FreeBSD)
     /// No message available on STREAM.
     public static var ENODATA: POSIXErrorCode {
         return .ENODATA
@@ -635,7 +635,7 @@ extension POSIXError {
         return .ENOLINK
     }
 
-    #if !os(WASI)
+    #if !os(WASI) && !os(FreeBSD)
     /// No STREAM resources.
     public static var ENOSR: POSIXErrorCode {
         return .ENOSR
@@ -653,7 +653,7 @@ extension POSIXError {
         return .EPROTO
     }
 
-    #if !os(OpenBSD) && !os(WASI)
+    #if !os(OpenBSD) && !os(WASI) && !os(FreeBSD)
     /// STREAM ioctl timeout.
     public static var ETIME: POSIXErrorCode {
         return .ETIME
diff --git a/Sources/FoundationEssentials/FileManager/FileManager+Files.swift b/Sources/FoundationEssentials/FileManager/FileManager+Files.swift
@@ -486,6 +486,8 @@ extension _FileManagerImpl {
     private func _extendedAttribute(_ key: UnsafePointer<CChar>, at path: UnsafePointer<CChar>, followSymlinks: Bool) throws -> Data? {
         #if canImport(Darwin)
         var size = getxattr(path, key, nil, 0, 0, followSymlinks ? 0 : XATTR_NOFOLLOW)
+        #elseif os(FreeBSD)
+        var size = (followSymlinks ? extattr_get_file : extattr_get_link)(path, EXTATTR_NAMESPACE_USER, key, nil, 0)
         #else
         var size = followSymlinks ? getxattr(path, key, nil, 0) : lgetxattr(path, key, nil, 0)
         #endif
@@ -498,6 +500,8 @@ extension _FileManagerImpl {
         let buffer = malloc(size)!
         #if canImport(Darwin)
         size = getxattr(path, key, buffer, size, 0, followSymlinks ? 0 : XATTR_NOFOLLOW)
+        #elseif os(FreeBSD)
+        size = (followSymlinks ? extattr_get_file : extattr_get_link)(path, EXTATTR_NAMESPACE_USER, key, buffer, size)
         #else
         size = followSymlinks ? getxattr(path, key, buffer, size) : lgetxattr(path, key, buffer, size)
         #endif
@@ -516,6 +520,8 @@ extension _FileManagerImpl {
     private func _extendedAttributes(at path: UnsafePointer<CChar>, followSymlinks: Bool) throws -> [String : Data]? {
         #if canImport(Darwin)
         var size = listxattr(path, nil, 0, 0)
+        #elseif os(FreeBSD)
+        var size = (followSymlinks ? extattr_list_file : extattr_list_link)(path, EXTATTR_NAMESPACE_USER, nil, 0)
         #else
         var size = listxattr(path, nil, 0)
         #endif
@@ -524,6 +530,8 @@ extension _FileManagerImpl {
         defer { keyList.deallocate() }
         #if canImport(Darwin)
         size = listxattr(path, keyList.baseAddress!, size, 0)
+        #elseif os(FreeBSD)
+        size = (followSymlinks ? extattr_list_file : extattr_list_link)(path, EXTATTR_NAMESPACE_USER, nil, 0)
         #else
         size = listxattr(path, keyList.baseAddress!, size)
         #endif
diff --git a/Sources/FoundationEssentials/FileManager/FileManager+Utilities.swift b/Sources/FoundationEssentials/FileManager/FileManager+Utilities.swift
@@ -183,6 +183,13 @@ extension _FileManagerImpl {
         try value.withUnsafeBytes { buffer in
             #if canImport(Darwin)
             let result = setxattr(path, key, buffer.baseAddress!, buffer.count, 0, followSymLinks ? 0 : XATTR_NOFOLLOW)
+            #elseif os(FreeBSD)
+            var result: Int32
+            if followSymLinks {
+                result = Int32(extattr_set_file(path, EXTATTR_NAMESPACE_USER, key, buffer.baseAddress!, buffer.count))
+            } else {
+                result = Int32(extattr_set_link(path, EXTATTR_NAMESPACE_USER, key, buffer.baseAddress!, buffer.count))
+            }
             #else
             var result: Int32
             if followSymLinks {
@@ -191,6 +198,7 @@ extension _FileManagerImpl {
                 result = setxattr(path, key, buffer.baseAddress!, buffer.count, 0)
             }
             #endif
+
             #if os(macOS) && FOUNDATION_FRAMEWORK
             // if setxaddr failed and its a permission error for a sandbox app trying to set quaratine attribute, ignore it since its not
             // permitted, the attribute will be put on the file by the quaratine MAC hook
diff --git a/Sources/FoundationEssentials/FileManager/FileOperations+Enumeration.swift b/Sources/FoundationEssentials/FileManager/FileOperations+Enumeration.swift
@@ -354,9 +354,15 @@ struct _POSIXDirectoryContentsSequence: Sequence {
                     continue
                 }
                 #endif
+                #if os(FreeBSD)
+                guard dent.pointee.d_fileno != 0 else {
+                    continue
+                }
+                #else
                 guard dent.pointee.d_ino != 0 else {
                     continue
                 }
+                #endif
                 // Use name
                 let fileName: String
                 #if os(WASI)
diff --git a/Sources/FoundationEssentials/FileManager/FileOperations.swift b/Sources/FoundationEssentials/FileManager/FileOperations.swift
@@ -940,10 +940,17 @@ enum _FileOperations {
         }
         #else
         while current < total {
+            #if os(FreeBSD)
+            guard copy_file_range(srcfd, &current, dstfd, nil, total - Int(current), 0) != -1 else {
+                try delegate.throwIfNecessary(errno, String(cString: srcPtr), String(cString: dstPtr))
+                return
+            }
+            #else
             guard sendfile(dstfd, srcfd, &current, Swift.min(total - Int(current), chunkSize)) != -1 else {
                 try delegate.throwIfNecessary(errno, String(cString: srcPtr), String(cString: dstPtr))
                 return
             }
+            #endif
         }
         #endif
     }
diff --git a/Sources/FoundationEssentials/LockedState.swift b/Sources/FoundationEssentials/LockedState.swift
@@ -31,6 +31,8 @@ package struct LockedState<State> {
     private struct _Lock {
 #if canImport(os)
         typealias Primitive = os_unfair_lock
+#elseif os(FreeBSD)
+        typealias Primitive = pthread_mutex_t?
 #elseif canImport(Bionic) || canImport(Glibc) || canImport(Musl)
         typealias Primitive = pthread_mutex_t
 #elseif canImport(WinSDK)
diff --git a/Sources/FoundationEssentials/ProcessInfo/ProcessInfo.swift b/Sources/FoundationEssentials/ProcessInfo/ProcessInfo.swift
@@ -142,7 +142,11 @@ final class _ProcessInfo: Sendable {
         let time: UInt64 = ullTime
 #else
         var ts: timespec = timespec()
+        #if os(FreeBSD) || os(OpenBSD)
+        clock_gettime(CLOCK_MONOTONIC, &ts)
+        #else
         clock_gettime(CLOCK_MONOTONIC_RAW, &ts)
+        #endif
         let time: UInt64 = UInt64(ts.tv_sec) * 1000000000 + UInt64(ts.tv_nsec)
 #endif
         let timeString = String(time, radix: 16, uppercase: true)
diff --git a/Sources/_FoundationCShims/include/_CStdlib.h b/Sources/_FoundationCShims/include/_CStdlib.h
@@ -148,15 +148,15 @@
 #include <tzfile.h>
 #else
 
-#if TARGET_OS_MAC || TARGET_OS_LINUX
+#if TARGET_OS_MAC || TARGET_OS_LINUX || TARGET_OS_BSD
 #ifndef TZDIR
 #define TZDIR    "/usr/share/zoneinfo/" /* Time zone object file directory */
 #endif /* !defined TZDIR */
 
 #ifndef TZDEFAULT
 #define TZDEFAULT    "/etc/localtime"
 #endif /* !defined TZDEFAULT */
-#endif /* TARGET_OS_MAC || TARGET_OS_LINUX */
+#endif /* TARGET_OS_MAC || TARGET_OS_LINUX || TARGET_OS_BSD */
 
 #endif
 

Original file line number	Diff line number	Diff line change
`@@ -940,10 +940,17 @@ enum _FileOperations {`
`940`	`940`	`}`
`941`	`941`	`#else`
`942`	`942`	`while current < total {`
	`943`	`+ #if os(FreeBSD)`
	`944`	`+ guard copy_file_range(srcfd, &current, dstfd, nil, total - Int(current), 0) != -1 else {`
	`945`	`+ try delegate.throwIfNecessary(errno, String(cString: srcPtr), String(cString: dstPtr))`
	`946`	`+ return`
	`947`	`+ }`
	`948`	`+ #else`
`943`	`949`	`guard sendfile(dstfd, srcfd, &current, Swift.min(total - Int(current), chunkSize)) != -1 else {`
`944`	`950`	`try delegate.throwIfNecessary(errno, String(cString: srcPtr), String(cString: dstPtr))`
`945`	`951`	`return`
`946`	`952`	`}`
	`953`	`+ #endif`
`947`	`954`	`}`
`948`	`955`	`#endif`
`949`	`956`	`}`