Merge branch 'main' into openbsd

rnro · web-flow · commit 048335c2c92b · 2025-11-24T11:03:47.000Z
diff --git a/.github/workflows/benchmarks.yml b/.github/workflows/benchmarks.yml
@@ -71,6 +71,37 @@ on:
         description: "Boolean to enable the Windows nightly main Swift version matrix job. Currently has no effect!"  # TODO: implement Windows benchmarking
         default: false
 
+      macos_xcode_16_3_enabled:
+        type: boolean
+        description: "Boolean to enable the macOS Xcode 16.3 benchmark job. Defaults to false."
+        default: false
+      macos_xcode_16_4_enabled:
+        type: boolean
+        description: "Boolean to enable the macOS Xcode 16.4 benchmark job. Defaults to false."
+        default: false
+      macos_xcode_26_0_enabled:
+        type: boolean
+        description: "Boolean to enable the macOS Xcode 26.0 benchmark job. Defaults to false."
+        default: false
+      macos_xcode_26_1_enabled:
+        type: boolean
+        description: "Boolean to enable the macOS Xcode 26.1 benchmark job. Defaults to false."
+        default: false
+      macos_xcode_latest_beta_enabled:
+        type: boolean
+        description: "Boolean to enable the macOS Xcode latest beta benchmark job. Defaults to false."
+        default: false
+
+      macos_runner_pool:
+        type: string
+        description: "The runner pool which will be requested for macOS jobs."
+        default: "nightly"
+
+      macos_env_vars:
+        type: string
+        description: "Environment variables for macOS jobs as JSON (e.g., '{\"DEBUG\":\"1\",\"LOG_LEVEL\":\"info\"}')."
+        default: "{}"
+
       linux_env_vars:
         type: string
         description: "Environment variables for Linux jobs as JSON (e.g., '{\"DEBUG\":\"1\",\"LOG_LEVEL\":\"info\"}')."
@@ -82,8 +113,8 @@ on:
         default: ""
 
 jobs:
-  construct-matrix:
-    name: Construct Benchmarks matrix
+  construct-matrix-linux:
+    name: Construct Linux Benchmarks matrix
     runs-on: ubuntu-latest
     outputs:
       benchmarks-matrix: '${{ steps.generate-matrix.outputs.benchmarks-matrix }}'
@@ -115,11 +146,121 @@ jobs:
           MATRIX_LINUX_NIGHTLY_NEXT_ENABLED: ${{ inputs.linux_nightly_6_1_enabled && inputs.linux_nightly_next_enabled  }}
           MATRIX_LINUX_NIGHTLY_MAIN_ENABLED: ${{ inputs.linux_nightly_main_enabled }}
 
-  benchmarks:
+  construct-matrix-macos:
+    name: Construct macOS Benchmarks matrix
+    runs-on: ubuntu-latest
+    if: |
+      inputs.macos_xcode_16_3_enabled ||
+      inputs.macos_xcode_16_4_enabled ||
+      inputs.macos_xcode_26_0_enabled ||
+      inputs.macos_xcode_26_1_enabled ||
+      inputs.macos_xcode_latest_beta_enabled
+    outputs:
+      macos-matrix: '${{ steps.generate-matrix.outputs.macos-matrix }}'
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - id: generate-matrix
+        run: |
+          # Validate JSON environment variables
+          macos_env_vars_json='${{ inputs.macos_env_vars }}'
+
+          if ! echo "$macos_env_vars_json" | jq empty 2>/dev/null; then
+            echo "Error: macos_env_vars is not valid JSON"
+            exit 1
+          fi
+
+          runner_pool="${MACOS_RUNNER_POOL}"
+          xcode_16_3_enabled="${MACOS_XCODE_16_3_ENABLED}"
+          xcode_16_4_enabled="${MACOS_XCODE_16_4_ENABLED}"
+          xcode_26_0_enabled="${MACOS_XCODE_26_0_ENABLED}"
+          xcode_26_1_enabled="${MACOS_XCODE_26_1_ENABLED}"
+          xcode_latest_beta_enabled="${MACOS_XCODE_LATEST_BETA_ENABLED}"
+
+          # Create matrix from inputs
+          matrix='{"config": []}'
+
+          if [[ "$xcode_16_3_enabled" == "true" ]]; then
+              matrix=$(echo "$matrix" | jq -c \
+              --arg runner_pool "$runner_pool" \
+              --argjson env_vars "$macos_env_vars_json" \
+              '.config[.config| length] |= . + { "name": "macOS (Xcode 16.3)", "xcode_version": "16.3", "xcode_app": "Xcode_16.3.app", "os": "sequoia", "arch": "ARM64", "pool": $runner_pool, "env": $env_vars }')
+          fi
+
+          if [[ "$xcode_16_4_enabled" == "true" ]]; then
+              matrix=$(echo "$matrix" | jq -c \
+              --arg runner_pool "$runner_pool" \
+              --argjson env_vars "$macos_env_vars_json" \
+              '.config[.config| length] |= . + { "name": "macOS (Xcode 16.4)", "xcode_version": "16.4", "xcode_app": "Xcode_16.4.app", "os": "sequoia", "arch": "ARM64", "pool": $runner_pool, "env": $env_vars }')
+          fi
+
+          if [[ "$xcode_26_0_enabled" == "true" ]]; then
+              matrix=$(echo "$matrix" | jq -c \
+              --arg runner_pool "$runner_pool" \
+              --argjson env_vars "$macos_env_vars_json" \
+              '.config[.config| length] |= . + { "name": "macOS (Xcode 26.0)", "xcode_version": "26.0", "xcode_app": "Xcode_26.0.app", "os": "sequoia", "arch": "ARM64", "pool": $runner_pool, "env": $env_vars }')
+          fi
+
+          if [[ "$xcode_26_1_enabled" == "true" ]]; then
+              matrix=$(echo "$matrix" | jq -c \
+              --arg runner_pool "$runner_pool" \
+              --argjson env_vars "$macos_env_vars_json" \
+              '.config[.config| length] |= . + { "name": "macOS (Xcode 26.1)", "xcode_version": "26.1", "xcode_app": "Xcode_26.1.app", "os": "sequoia", "arch": "ARM64", "pool": $runner_pool, "env": $env_vars }')
+          fi
+
+          if [[ "$xcode_latest_beta_enabled" == "true" ]]; then
+              matrix=$(echo "$matrix" | jq -c \
+              --arg runner_pool "$runner_pool" \
+              --argjson env_vars "$macos_env_vars_json" \
+              '.config[.config| length] |= . + { "name": "macOS (Xcode latest beta)", "xcode_version": "latest beta", "xcode_app": "Xcode-latest.app", "os": "sequoia", "arch": "ARM64", "pool": $runner_pool, "env": $env_vars }')
+          fi
+
+          echo "macos-matrix=$matrix" >> "$GITHUB_OUTPUT"
+        env:
+          MACOS_RUNNER_POOL: ${{ inputs.macos_runner_pool }}
+          MACOS_XCODE_16_3_ENABLED: ${{ inputs.macos_xcode_16_3_enabled }}
+          MACOS_XCODE_16_4_ENABLED: ${{ inputs.macos_xcode_16_4_enabled }}
+          MACOS_XCODE_26_0_ENABLED: ${{ inputs.macos_xcode_26_0_enabled }}
+          MACOS_XCODE_26_1_ENABLED: ${{ inputs.macos_xcode_26_1_enabled }}
+          MACOS_XCODE_LATEST_BETA_ENABLED: ${{ inputs.macos_xcode_latest_beta_enabled }}
+
+  benchmarks-linux:
     name: Benchmarks
-    needs: construct-matrix
+    needs: construct-matrix-linux
     # Workaround https://github.com/nektos/act/issues/1875
     uses: apple/swift-nio/.github/workflows/swift_test_matrix.yml@main
     with:
       name: "Benchmarks"
-      matrix_string: '${{ needs.construct-matrix.outputs.benchmarks-matrix }}'
+      matrix_string: '${{ needs.construct-matrix-linux.outputs.benchmarks-matrix }}'
+
+  benchmarks-macos:
+    name: ${{ matrix.config.name }}
+    needs: construct-matrix-macos
+    runs-on: [self-hosted, macos, "${{ matrix.config.os }}", "${{ matrix.config.arch }}", "${{ matrix.config.pool }}"]
+    timeout-minutes: 30
+    strategy:
+      fail-fast: false
+      matrix: ${{ fromJson(needs.construct-matrix-macos.outputs.macos-matrix) }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+          submodules: true
+      - name: Install jemalloc
+        run: |
+          brew install jemalloc
+      - name: Export environment variables
+        if: ${{ matrix.config.env != '' && matrix.config.env != '{}'}}
+        run: |
+          echo "Exporting environment variables from matrix configuration..."
+          echo '${{ toJSON(matrix.config.env) }}' | jq -r 'to_entries[] | "\(.key)=\(.value)"' >> $GITHUB_ENV
+          echo '${{ toJSON(matrix.config.env) }}' | jq -r 'to_entries[] | "exporting \(.key)=\(.value)"'
+      - name: Run benchmarks script
+        run: |
+          curl -s https://raw.githubusercontent.com/apple/swift-nio/main/scripts/check_benchmark_thresholds.sh | BENCHMARK_PACKAGE_PATH=${{ inputs.benchmark_package_path }} bash -s -- --disable-sandbox --allow-writing-to-package-directory
+        env:
+          DEVELOPER_DIR: "/Applications/${{ matrix.config.xcode_app }}"
+          SWIFT_VERSION: "Xcode ${{ matrix.config.xcode_version }}"
diff --git a/Benchmarks/Benchmarks/NIOPosixBenchmarks/Benchmarks.swift b/Benchmarks/Benchmarks/NIOPosixBenchmarks/Benchmarks.swift
@@ -31,7 +31,8 @@ let benchmarks = {
             metrics: defaultMetrics,
             scalingFactor: .mega,
             maxDuration: .seconds(10_000_000),
-            maxIterations: 5
+            maxIterations: 5,
+            thresholds: [.mallocCountTotal: .init(absolute: [.p90: 50])]
         )
     ) { benchmark in
         try runTCPEcho(
diff --git a/Sources/NIOCore/ByteBuffer-aux.swift b/Sources/NIOCore/ByteBuffer-aux.swift
@@ -568,7 +568,7 @@ extension ByteBuffer {
     /// - Returns: The number of bytes written or `bytes.byteCount`.
     @discardableResult
     @inlinable
-    @available(macOS 26, iOS 26, tvOS 26, watchOS 26, visionOS 26, *)
+    @available(macOS 10.14.4, iOS 12.2, watchOS 5.2, tvOS 12.2, visionOS 1.0, *)
     public mutating func writeBytes(_ bytes: RawSpan) -> Int {
         let written = self.setBytes(bytes, at: self.writerIndex)
         self._moveWriterIndex(forwardBy: written)
diff --git a/Sources/NIOCore/ByteBuffer-core.swift b/Sources/NIOCore/ByteBuffer-core.swift
@@ -510,7 +510,7 @@ public struct ByteBuffer {
 
     #if compiler(>=6.2)
     @inlinable
-    @available(macOS 26, iOS 26, tvOS 26, watchOS 26, visionOS 26, *)
+    @available(macOS 10.14.4, iOS 12.2, watchOS 5.2, tvOS 12.2, visionOS 1.0, *)
     mutating func _setBytes(_ bytes: RawSpan, at index: _Index) -> _Capacity {
         let bytesCount = bytes.byteCount
         let newEndIndex: _Index = index + _toIndex(bytesCount)
@@ -524,7 +524,7 @@ public struct ByteBuffer {
     }
 
     @inlinable
-    @available(macOS 26, iOS 26, tvOS 26, watchOS 26, visionOS 26, *)
+    @available(macOS 10.14.4, iOS 12.2, watchOS 5.2, tvOS 12.2, visionOS 1.0, *)
     mutating func _setBytesAssumingUniqueBufferAccess(_ bytes: RawSpan, at index: _Index) {
         let targetPtr = UnsafeMutableRawBufferPointer(
             rebasing: self._slicedStorageBuffer.dropFirst(Int(index))
@@ -1122,7 +1122,7 @@ extension ByteBuffer {
     /// Copy `bytes` from a `RawSpan` into the `ByteBuffer` at `index`. Does not move the writer index.
     @discardableResult
     @inlinable
-    @available(macOS 26, iOS 26, tvOS 26, watchOS 26, visionOS 26, *)
+    @available(macOS 10.14.4, iOS 12.2, watchOS 5.2, tvOS 12.2, visionOS 1.0, *)
     public mutating func setBytes(_ bytes: RawSpan, at index: Int) -> Int {
         Int(self._setBytes(bytes, at: _toIndex(index)))
     }
diff --git a/Sources/NIOPosix/MultiThreadedEventLoopGroup.swift b/Sources/NIOPosix/MultiThreadedEventLoopGroup.swift
@@ -107,9 +107,9 @@ public final class MultiThreadedEventLoopGroup: EventLoopGroup {
                 canBeShutdownIndividually: canEventLoopBeShutdownIndividually,
                 metricsDelegate: metricsDelegate
             )
-            threadSpecificEventLoop.currentValue = loop
+            Self.threadSpecificEventLoop.currentValue = loop
             defer {
-                threadSpecificEventLoop.currentValue = nil
+                Self.threadSpecificEventLoop.currentValue = nil
             }
             callback(loop)
             try loop.run()
diff --git a/Sources/NIOPosix/SelectableEventLoop.swift b/Sources/NIOPosix/SelectableEventLoop.swift
@@ -187,9 +187,7 @@ internal final class SelectableEventLoop: EventLoop, @unchecked Sendable {
     private let promiseCreationStoreLock = NIOLock()
     private var _promiseCreationStore: [_NIOEventLoopFutureIdentifier: (file: StaticString, line: UInt)] = [:]
 
-    private let metricsDelegate: (any NIOEventLoopMetricsDelegate)?
-
-    private var lastTickEndTime: NIODeadline
+    private var metricsDelegateState: MetricsDelegateState?
 
     @usableFromInline
     internal func _promiseCreated(futureIdentifier: _NIOEventLoopFutureIdentifier, file: StaticString, line: UInt) {
@@ -261,7 +259,9 @@ internal final class SelectableEventLoop: EventLoop, @unchecked Sendable {
         canBeShutdownIndividually: Bool,
         metricsDelegate: NIOEventLoopMetricsDelegate?
     ) {
-        self.metricsDelegate = metricsDelegate
+        self.metricsDelegateState = metricsDelegate.map { delegate in
+            MetricsDelegateState(metricsDelegate: delegate, lastTickEndime: .now())
+        }
         self._uniqueID = uniqueID
         self._parentGroup = parentGroup
         self._selector = selector
@@ -270,7 +270,6 @@ internal final class SelectableEventLoop: EventLoop, @unchecked Sendable {
         self.msgBufferPool = Pool<PooledMsgBuffer>(maxSize: 16)
         self.tasksCopy.reserveCapacity(Self.tasksCopyBatchSize)
         self.canBeShutdownIndividually = canBeShutdownIndividually
-        self.lastTickEndTime = .now()
         // note: We are creating a reference cycle here that we'll break when shutting the SelectableEventLoop down.
         // note: We have to create the promise and complete it because otherwise we'll hit a loop in `makeSucceededFuture`. This is
         //       fairly dumb, but it's the only option we have.
@@ -747,21 +746,35 @@ internal final class SelectableEventLoop: EventLoop, @unchecked Sendable {
         return nextDeadline
     }
 
-    private func runLoop(selfIdentifier: ObjectIdentifier) -> NIODeadline? {
-        let tickStartTime: NIODeadline = .now()
-        let sleepTime: TimeAmount = tickStartTime - self.lastTickEndTime
+    private func runOneLoopTick(selfIdentifier: ObjectIdentifier) -> NIODeadline? {
+        let tickStartInfo:
+            (
+                metricsDelegate: any NIOEventLoopMetricsDelegate,
+                tickStartTime: NIODeadline,
+                sleepTime: TimeAmount
+            )? = self.metricsDelegateState.map { metricsDelegateState in
+                let tickStartTime = NIODeadline.now()  // Potentially expensive, only if delegate set.
+                return (
+                    metricsDelegate: metricsDelegateState.metricsDelegate,
+                    tickStartTime: tickStartTime,
+                    sleepTime: tickStartTime - metricsDelegateState.lastTickEndime
+                )
+            }
+
         var tasksProcessedInTick = 0
         defer {
-            let tickEndTime: NIODeadline = .now()
-            let tickInfo = NIOEventLoopTickInfo(
-                eventLoopID: selfIdentifier,
-                numberOfTasks: tasksProcessedInTick,
-                sleepTime: sleepTime,
-                startTime: tickStartTime,
-                endTime: tickEndTime
-            )
-            self.metricsDelegate?.processedTick(info: tickInfo)
-            self.lastTickEndTime = tickEndTime
+            if let tickStartInfo = tickStartInfo {
+                let tickEndTime = NIODeadline.now()  // Potentially expensive, only if delegate set.
+                let tickInfo = NIOEventLoopTickInfo(
+                    eventLoopID: selfIdentifier,
+                    numberOfTasks: tasksProcessedInTick,
+                    sleepTime: tickStartInfo.sleepTime,
+                    startTime: tickStartInfo.tickStartTime,
+                    endTime: tickEndTime
+                )
+                tickStartInfo.metricsDelegate.processedTick(info: tickInfo)
+                self.metricsDelegateState?.lastTickEndime = tickEndTime
+            }
         }
         while true {
             let nextReadyDeadline = self._tasksLock.withLock { () -> NIODeadline? in
@@ -905,7 +918,7 @@ internal final class SelectableEventLoop: EventLoop, @unchecked Sendable {
                     }
                 }
             }
-            nextReadyDeadline = runLoop(selfIdentifier: selfIdentifier)
+            nextReadyDeadline = self.runOneLoopTick(selfIdentifier: selfIdentifier)
         }
 
         // This EventLoop was closed so also close the underlying selector.
@@ -1036,6 +1049,11 @@ internal final class SelectableEventLoop: EventLoop, @unchecked Sendable {
     }
 }
 
+struct MetricsDelegateState {
+    var metricsDelegate: any NIOEventLoopMetricsDelegate
+    var lastTickEndime: NIODeadline
+}
+
 extension SelectableEventLoop: CustomStringConvertible, CustomDebugStringConvertible {
     @usableFromInline
     var description: String {

Original file line number	Diff line number	Diff line change
`@@ -107,9 +107,9 @@ public final class MultiThreadedEventLoopGroup: EventLoopGroup {`
`107`	`107`	`canBeShutdownIndividually: canEventLoopBeShutdownIndividually,`
`108`	`108`	`metricsDelegate: metricsDelegate`
`109`	`109`	`)`
`110`		`- threadSpecificEventLoop.currentValue = loop`
	`110`	`+ Self.threadSpecificEventLoop.currentValue = loop`
`111`	`111`	`defer {`
`112`		`- threadSpecificEventLoop.currentValue = nil`
	`112`	`+ Self.threadSpecificEventLoop.currentValue = nil`
`113`	`113`	`}`
`114`	`114`	`callback(loop)`
`115`	`115`	`try loop.run()`