Add platform-specific branches for FreeBSD. (#685)

This PR adds support for FreeBSD where we have platform-specific code.
Most changes simply involve changing `os(Linux)` to `os(Linux) ||
os(FreeBSD)`, although there is some actual platform-specific code and
at least one spot where Darwin and FreeBSD share an implementation but
Linux does not.

> [!NOTE]
> This new code is minimally tested. Support for FreeBSD is provided by
the Swift community.

### Checklist:

- [x] Code and documentation should follow the style of the [Style
Guide](https://github.com/apple/swift-testing/blob/main/Documentation/StyleGuide.md).
- [x] If public symbols are renamed or modified, DocC references should
be updated.

Author: grynspan

Sources/Testing/ABI/EntryPoints/EntryPoint.swift

@@ -673,7 +673,7 @@ extension Event.ConsoleOutputRecorder.Options {
   /// Whether or not the system terminal claims to support 16-color ANSI escape
   /// codes.
   private static var _terminalSupports16ColorANSIEscapeCodes: Bool {
-#if SWT_TARGET_OS_APPLE || os(Linux) || os(Android)
+#if SWT_TARGET_OS_APPLE || os(Linux) || os(FreeBSD) || os(Android)
     if let termVariable = Environment.variable(named: "TERM") {
       return termVariable != "dumb"
     }
@@ -695,7 +695,7 @@ extension Event.ConsoleOutputRecorder.Options {
   /// Whether or not the system terminal claims to support 256-color ANSI escape
   /// codes.
   private static var _terminalSupports256ColorANSIEscapeCodes: Bool {
-#if SWT_TARGET_OS_APPLE || os(Linux) || os(Android)
+#if SWT_TARGET_OS_APPLE || os(Linux) || os(FreeBSD) || os(Android)
     if let termVariable = Environment.variable(named: "TERM") {
       return strstr(termVariable, "256") != nil
     }
@@ -717,7 +717,7 @@ extension Event.ConsoleOutputRecorder.Options {
   /// Whether or not the system terminal claims to support true-color ANSI
   /// escape codes.
   private static var _terminalSupportsTrueColorANSIEscapeCodes: Bool {
-#if SWT_TARGET_OS_APPLE || os(Linux) || os(Android)
+#if SWT_TARGET_OS_APPLE || os(Linux) || os(FreeBSD) || os(Android)
     if let colortermVariable = Environment.variable(named: "COLORTERM") {
       return strstr(colortermVariable, "truecolor") != nil
     }

Sources/Testing/ABI/EntryPoints/SwiftPMEntryPoint.swift

@@ -24,7 +24,7 @@ private import _TestingInternals
 ///
 /// This constant is not part of the public interface of the testing library.
 var EXIT_NO_TESTS_FOUND: CInt {
-#if SWT_TARGET_OS_APPLE || os(Linux) || os(Android) || os(WASI)
+#if SWT_TARGET_OS_APPLE || os(Linux) || os(FreeBSD) || os(Android) || os(WASI)
   EX_UNAVAILABLE
 #elseif os(Windows)
   CInt(ERROR_NOT_FOUND)

Sources/Testing/Events/Recorder/Event.Symbol.swift

@@ -100,7 +100,7 @@ extension Event.Symbol {
   /// be used to represent it in text-based output. The value of this property
   /// is platform-dependent.
   public var unicodeCharacter: Character {
-#if SWT_TARGET_OS_APPLE || os(Linux) || os(Android) || os(WASI)
+#if SWT_TARGET_OS_APPLE || os(Linux) || os(FreeBSD) || os(Android) || os(WASI)
     switch self {
     case .default:
       // Unicode: WHITE DIAMOND

Sources/Testing/ExitTests/ExitCondition.swift

@@ -42,11 +42,13 @@ public enum ExitCondition: Sendable {
   /// |-|-|
   /// | macOS | [`<stdlib.h>`](https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man3/_Exit.3.html), [`<sysexits.h>`](https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man3/sysexits.3.html) |
   /// | Linux | [`<stdlib.h>`](https://sourceware.org/glibc/manual/latest/html_node/Exit-Status.html), `<sysexits.h>` |
+  /// | FreeBSD | `<stdlib.h>`, `<sysexits.h>` |
   /// | Windows | [`<stdlib.h>`](https://learn.microsoft.com/en-us/cpp/c-runtime-library/exit-success-exit-failure) |
   ///
-  /// On macOS and Windows, the full exit code reported by the process is
-  /// yielded to the parent process. Linux and other POSIX-like systems may only
-  /// reliably report the low unsigned 8 bits (0&ndash;255) of the exit code.
+  /// On macOS, FreeBSD, and Windows, the full exit code reported by the process
+  /// is yielded to the parent process. Linux and other POSIX-like systems may
+  /// only reliably report the low unsigned 8 bits (0&ndash;255) of the exit
+  /// code.
   case exitCode(_ exitCode: CInt)
 
   /// The process terminated with the given signal.
@@ -61,6 +63,7 @@ public enum ExitCondition: Sendable {
   /// |-|-|
   /// | macOS | [`<signal.h>`](https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man3/signal.3.html) |
   /// | Linux | [`<signal.h>`](https://sourceware.org/glibc/manual/latest/html_node/Standard-Signals.html) |
+  /// | FreeBSD | `<signal.h>` |
   /// | Windows | [`<signal.h>`](https://learn.microsoft.com/en-us/cpp/c-runtime-library/signal-constants) |
   ///
   /// On Windows, by default, the C runtime will terminate a process with exit

Sources/Testing/ExitTests/ExitTest.swift

@@ -47,10 +47,10 @@ public struct ExitTest: Sendable {
       EXCEPTION_DEFAULT,
       THREAD_STATE_NONE
     )
-#elseif os(Linux)
-    // On Linux, disable the generation of core files (although they will often
-    // be disabled by default.) If a particular Linux distro performs additional
-    // crash diagnostics, we may want to special-case them as well if we can.
+#elseif os(Linux) || os(FreeBSD)
+    // On Linux and FreeBSD, disable the generation of core files (although they
+    // will often be disabled by default.) If a particular Linux distro performs
+    // additional crash diagnostics, we may want to special-case them as well if we can.
     var rl = rlimit(rlim_cur: 0, rlim_max: 0)
     _ = setrlimit(CInt(RLIMIT_CORE.rawValue), &rl)
 #elseif os(Windows)
@@ -322,13 +322,14 @@ extension ExitTest {
       for key in childEnvironment.keys where key.starts(with: "XCTest") {
         childEnvironment.removeValue(forKey: key)
       }
-#elseif os(Linux)
+#endif
+
       if childEnvironment["SWIFT_BACKTRACE"] == nil {
         // Disable interactive backtraces unless explicitly enabled to reduce
-        // the noise level during the exit test. Only needed on Linux.
+        // the noise level during the exit test.
         childEnvironment["SWIFT_BACKTRACE"] = "enable=no"
       }
-#endif
+
       // Insert a specific variable that tells the child process which exit test
       // to run.
       try JSON.withEncoding(of: exitTest.sourceLocation) { json in
@@ -364,11 +365,11 @@ extension ExitTest {
     // use, so use this typealias to paper over the differences.
 #if SWT_TARGET_OS_APPLE
     typealias P<T> = T?
-#elseif os(Linux)
+#elseif os(Linux) || os(FreeBSD)
     typealias P<T> = T
 #endif
 
-#if SWT_TARGET_OS_APPLE || os(Linux)
+#if SWT_TARGET_OS_APPLE || os(Linux) || os(FreeBSD)
     let pid = try withUnsafeTemporaryAllocation(of: P<posix_spawn_file_actions_t>.self, capacity: 1) { fileActions in
       guard 0 == posix_spawn_file_actions_init(fileActions.baseAddress!) else {
         throw CError(rawValue: swt_errno())

Sources/Testing/ExitTests/WaitFor.swift

@@ -12,7 +12,7 @@
 
 internal import _TestingInternals
 
-#if SWT_TARGET_OS_APPLE || os(Linux)
+#if SWT_TARGET_OS_APPLE || os(Linux) || os(FreeBSD)
 /// Block the calling thread, wait for the target process to exit, and return
 /// a value describing the conditions under which it exited.
 ///
@@ -104,11 +104,16 @@ private let _createWaitThreadImpl: Void = {
     { _ in
       // Set the thread name to help with diagnostics. Note that different
       // platforms support different thread name lengths. See MAXTHREADNAMESIZE
-      // on Darwin and TASK_COMM_LEN on Linux.
+      // on Darwin, TASK_COMM_LEN on Linux, and MAXCOMLEN on FreeBSD. We try to
+      // maximize legibility in the available space.
 #if SWT_TARGET_OS_APPLE
       _ = pthread_setname_np("Swift Testing exit test monitor")
-#else
+#elseif os(Linux)
       _ = pthread_setname_np(pthread_self(), "SWT ExT monitor")
+#elseif os(FreeBSD)
+      _ = pthread_set_name_np(pthread_self(), "SWT ex test monitor")
+#else
+#warning("Platform-specific implementation missing: thread naming unavailable")
 #endif
 
       // Run an infinite loop that waits for child processes to terminate and

Sources/Testing/SourceAttribution/Backtrace+Symbolication.swift

@@ -70,14 +70,12 @@ extension Backtrace {
         result[i] = SymbolicatedAddress(address: address, offset: offset, symbolName: symbolName)
       }
     }
-#elseif os(Linux)
-    // Although Linux has dladdr(), it does not have symbol names from ELF
-    // binaries by default. The standard library's backtracing functionality has
-    // implemented sufficient ELF/DWARF parsing to be able to symbolicate Linux
-    // backtraces. TODO: adopt the standard library's Backtrace on Linux
-    // Note that this means on Linux we don't have demangling capability (since
-    // we don't have the mangled symbol names in the first place) so this code
-    // does not check the mode argument.
+#elseif os(Linux) || os(FreeBSD) || os(Android)
+    // Although these platforms have dladdr(), they do not have symbol names
+    // from DWARF binaries by default, only from shared libraries. The standard
+    // library's backtracing functionality has implemented sufficient ELF/DWARF
+    // parsing to be able to symbolicate Linux backtraces.
+    // TODO: adopt the standard library's Backtrace on these platforms
 #elseif os(Windows)
     _withDbgHelpLibrary { hProcess in
       guard let hProcess else {

Sources/Testing/SourceAttribution/Backtrace.swift

@@ -69,7 +69,7 @@ public struct Backtrace: Sendable {
       initializedCount = addresses.withMemoryRebound(to: UnsafeMutableRawPointer.self) { addresses in
         .init(clamping: backtrace(addresses.baseAddress!, .init(clamping: addresses.count)))
       }
-#elseif os(Linux)
+#elseif os(Linux) || os(FreeBSD)
       initializedCount = .init(clamping: backtrace(addresses.baseAddress!, .init(clamping: addresses.count)))
 #elseif os(Windows)
       initializedCount = Int(clamping: RtlCaptureStackBackTrace(0, ULONG(clamping: addresses.count), addresses.baseAddress!, nil))

Sources/Testing/Support/Additions/CommandLineAdditions.swift

@@ -38,6 +38,20 @@ extension CommandLine {
         buffer[readCount] = 0 // NUL-terminate the string.
         return String(cString: buffer.baseAddress!)
       }
+#elseif os(FreeBSD)
+      var mib = [CTL_KERN, KERN_PROC, KERN_PROC_PATHNAME, -1]
+      try mib.withUnsafeMutableBufferPointer { mib in
+        var bufferCount = 0
+        guard 0 == sysctl(mib.baseAddress!, .init(mib.count), nil, &bufferCount, nil, 0) else {
+          throw CError(rawValue: swt_errno())
+        }
+        return try withUnsafeTemporaryAllocation(of: CChar.self, capacity: bufferCount) { buffer in
+          guard 0 == sysctl(mib.baseAddress!, .init(mib.count), buffer.baseAddress!, &bufferCount, nil, 0) else {
+            throw CError(rawValue: swt_errno())
+          }
+          return String(cString: buffer.baseAddress!)
+        }
+      }
 #elseif os(Windows)
       return try withUnsafeTemporaryAllocation(of: wchar_t.self, capacity: Int(MAX_PATH) * 2) { buffer in
         guard 0 != GetModuleFileNameW(nil, buffer.baseAddress!, DWORD(buffer.count)) else {

Sources/Testing/Support/Environment.swift

@@ -42,7 +42,7 @@ enum Environment {
     }
   }
 
-#if SWT_TARGET_OS_APPLE || os(Linux) || os(Android) || os(WASI)
+#if SWT_TARGET_OS_APPLE || os(Linux) || os(FreeBSD) || os(Android) || os(WASI)
   /// Get all environment variables from a POSIX environment block.
   ///
   /// - Parameters:
@@ -103,7 +103,7 @@ enum Environment {
     }
 #endif
     return _get(fromEnviron: _NSGetEnviron()!.pointee!)
-#elseif os(Linux) || os(Android)
+#elseif os(Linux) || os(FreeBSD) || os(Android)
     _get(fromEnviron: swt_environ())
 #elseif os(WASI)
     _get(fromEnviron: __wasilibc_get_environ())
@@ -170,7 +170,7 @@ enum Environment {
       }
       return nil
     }
-#elseif SWT_TARGET_OS_APPLE || os(Linux) || os(Android) || os(WASI)
+#elseif SWT_TARGET_OS_APPLE || os(Linux) || os(FreeBSD) || os(Android) || os(WASI)
     getenv(name).flatMap { String(validatingCString: $0) }
 #elseif os(Windows)
     name.withCString(encodedAs: UTF16.self) { name in