Merge remote-tracking branch 'origin/mmbm-range-relative-thresholds-options-bak' into mmbm-range-relative-thresholds-options-bak

Author: MahdiBM

Benchmarks/Benchmarks/Basic/BenchmarkRunner+Basic.swift

@@ -125,7 +125,7 @@ let benchmarks: @Sendable () -> Void = {
         }
     }
 
-    let parameterization = (0...5).map { 1 << $0 }  // 1, 2, 4, ...
+    let parameterization = (0...5).map { 1 << $0 } // 1, 2, 4, ...
 
     parameterization.forEach { count in
         Benchmark("Parameterized", configuration: .init(tags: ["count": count.description])) { benchmark in

Package.swift

@@ -117,7 +117,7 @@ let package = Package(
 )
 // Check if this is a SPI build, then we need to disable jemalloc for macOS
 
-let macOSSPIBuild: Bool  // Disables jemalloc for macOS SPI builds as the infrastructure doesn't have jemalloc there
+let macOSSPIBuild: Bool // Disables jemalloc for macOS SPI builds as the infrastructure doesn't have jemalloc there
 
 #if canImport(Darwin)
 if let spiBuildEnvironment = ProcessInfo.processInfo.environment["SPI_BUILD"], spiBuildEnvironment == "1" {
@@ -144,7 +144,7 @@ var dependencies: [PackageDescription.Target.Dependency] = [
     "BenchmarkShared",
 ]
 
-if macOSSPIBuild == false {  // jemalloc always disable for macOSSPIBuild
+if macOSSPIBuild == false { // jemalloc always disable for macOSSPIBuild
     if let disableJemalloc, disableJemalloc != "false", disableJemalloc != "0" {
         print("Jemalloc disabled through environment variable.")
     } else {

Plugins/BenchmarkBoilerplateGenerator/BenchmarkBoilerplateGenerator.swift

@@ -20,7 +20,7 @@ struct Benchmark: AsyncParsableCommand {
     var output: String
 
     mutating func run() async throws {
-        let outputPath = FilePath(output)  // package
+        let outputPath = FilePath(output) // package
         var boilerplate = """
             import Benchmark
 

Plugins/BenchmarkCommandPlugin/BenchmarkCommandPlugin.swift

@@ -37,7 +37,7 @@ import Glibc
         let specifiedTargets = try argumentExtractor.extractSpecifiedTargets(in: context.package, withOption: "target")
         let skipTargets = try argumentExtractor.extractSpecifiedTargets(in: context.package, withOption: "skip-target")
         let outputFormats = argumentExtractor.extractOption(named: "format")
-        let pathSpecified = argumentExtractor.extractOption(named: "path")  // export path
+        let pathSpecified = argumentExtractor.extractOption(named: "path") // export path
         let quietRunning = argumentExtractor.extractFlag(named: "quiet")
         let noProgress = argumentExtractor.extractFlag(named: "no-progress")
         let checkAbsoluteThresholdsPath = argumentExtractor.extractOption(named: "check-absolute-path")
@@ -143,16 +143,16 @@ import Glibc
                     )
                     throw MyError.invalidArgument
                 }
-            } catch {  // We will throw if we can use the target name (it's unused!)
+            } catch { // We will throw if we can use the target name (it's unused!)
             }
         }
 
         let swiftSourceModuleTargets: [SwiftSourceModuleTarget]
-        var shouldBuildTargets = true  // We don't rebuild the targets when we dont need to execute them, e.g. baseline read/compare
+        var shouldBuildTargets = true // We don't rebuild the targets when we dont need to execute them, e.g. baseline read/compare
 
         let packageBenchmarkIdentifier = "package-benchmark"
         let benchmarkToolName = "BenchmarkTool"
-        let benchmarkTool: PackagePlugin.Path  // = try context.tool(named: benchmarkToolName)
+        let benchmarkTool: PackagePlugin.Path // = try context.tool(named: benchmarkToolName)
 
         var args: [String] = [
             benchmarkToolName,
@@ -473,7 +473,7 @@ import Glibc
                 }
 
                 let buildResult = try packageManager.build(
-                    .product(target.name),  // .all(includingTests: false),
+                    .product(target.name), // .all(includingTests: false),
                     parameters: .init(configuration: .release)
                 )
 

Plugins/BenchmarkTool/BenchmarkTool+Baselines.swift

@@ -33,8 +33,8 @@ struct BenchmarkMachine: Codable, Equatable {
 
     var hostname: String
     var processors: Int
-    var processorType: String  // e.g. arm64e
-    var memory: Int  // in GB
+    var processorType: String // e.g. arm64e
+    var memory: Int // in GB
     var kernelVersion: String
 
     public static func == (lhs: BenchmarkMachine, rhs: BenchmarkMachine) -> Bool {
@@ -48,8 +48,8 @@ struct BenchmarkIdentifier: Codable, Hashable {
         self.name = name
     }
 
-    var target: String  // The name of the executable benchmark target id
-    var name: String  // The name of the benchmark
+    var target: String // The name of the executable benchmark target id
+    var name: String // The name of the benchmark
 
     public func hash(into hasher: inout Hasher) {
         hasher.combine(target)
@@ -178,7 +178,7 @@ let baselinesDirectory: String = ".benchmarkBaselines"
 extension BenchmarkTool {
     func printAllBaselines() {
         var storagePath = FilePath(baselineStoragePath)
-        storagePath.append(baselinesDirectory)  // package/.benchmarkBaselines
+        storagePath.append(baselinesDirectory) // package/.benchmarkBaselines
         for file in storagePath.directoryEntries {
             if file.ends(with: ".") == false,
                 file.ends(with: "..") == false
@@ -206,7 +206,7 @@ extension BenchmarkTool {
         var storagePath = FilePath(baselineStoragePath)
         let filemanager = FileManager.default
 
-        storagePath.append(baselinesDirectory)  // package/.benchmarkBaselines
+        storagePath.append(baselinesDirectory) // package/.benchmarkBaselines
         for file in storagePath.directoryEntries {
             if file.ends(with: ".") == false,
                 file.ends(with: "..") == false
@@ -284,14 +284,14 @@ extension BenchmarkTool {
          │       └── ...
          └── ...
          */
-        var outputPath = FilePath(baselineStoragePath)  // package
-        var subPath = FilePath()  // subpath rooted in package used for directory creation
+        var outputPath = FilePath(baselineStoragePath) // package
+        var subPath = FilePath() // subpath rooted in package used for directory creation
 
-        subPath.append(baselinesDirectory)  // package/.benchmarkBaselines
-        subPath.append("\(target)")  // package/.benchmarkBaselines/myTarget1
-        subPath.append(baselineName)  // package/.benchmarkBaselines/myTarget1/named1
+        subPath.append(baselinesDirectory) // package/.benchmarkBaselines
+        subPath.append("\(target)") // package/.benchmarkBaselines/myTarget1
+        subPath.append(baselineName) // package/.benchmarkBaselines/myTarget1/named1
 
-        outputPath.createSubPath(subPath)  // Create destination subpath if needed
+        outputPath.createSubPath(subPath) // Create destination subpath if needed
 
         outputPath.append(subPath.components)
 
@@ -348,13 +348,13 @@ extension BenchmarkTool {
         baselineIdentifier: String? = nil
     ) throws -> BenchmarkBaseline? {
         var path = FilePath(baselineStoragePath)
-        path.append(baselinesDirectory)  // package/.benchmarkBaselines
-        path.append(FilePath.Component(target)!)  // package/.benchmarkBaselines/myTarget1
+        path.append(baselinesDirectory) // package/.benchmarkBaselines
+        path.append(FilePath.Component(target)!) // package/.benchmarkBaselines/myTarget1
 
         if let baselineIdentifier {
-            path.append(baselineIdentifier)  // package/.benchmarkBaselines/myTarget1/named1
+            path.append(baselineIdentifier) // package/.benchmarkBaselines/myTarget1/named1
         } else {
-            path.append("default")  // // package/.benchmarkBaselines/myTarget1/default
+            path.append("default") // // package/.benchmarkBaselines/myTarget1/default
         }
 
         if let hostIdentifier {
@@ -376,7 +376,7 @@ extension BenchmarkTool {
                         let bufferSize = 16 * 1_024 * 1_024
                         var done = false
 
-                        while done == false {  // readBytes.count < bufferLength {
+                        while done == false { // readBytes.count < bufferLength {
                             let nextBytes = try [UInt8](unsafeUninitializedCapacity: bufferSize) { buf, count in
                                 count = try fd.read(into: UnsafeMutableRawBufferPointer(buf))
                                 if count == 0 {
@@ -396,7 +396,7 @@ extension BenchmarkTool {
                 print("Failed to close fd for \(path) after reading.")
             }
         } catch {
-            if errno != ENOENT {  // file not found is ok, e.g. when no baselines exist
+            if errno != ENOENT { // file not found is ok, e.g. when no baselines exist
                 print("Failed to open file \(path), errno = [\(errno)]")
             }
         }
@@ -522,11 +522,11 @@ extension BenchmarkBaseline: Equatable {
 
         for (lhsBenchmarkIdentifier, lhsBenchmarkResults) in lhs.results {
             for lhsBenchmarkResult in lhsBenchmarkResults {
-                guard let rhsResults = rhs.results.first(where: { $0.key == lhsBenchmarkIdentifier }) else {  // We couldn't find a result for one of the tests
+                guard let rhsResults = rhs.results.first(where: { $0.key == lhsBenchmarkIdentifier }) else { // We couldn't find a result for one of the tests
                     return false
                 }
                 guard let rhsBenchmarkResult = rhsResults.value.first(where: { $0.metric == lhsBenchmarkResult.metric })
-                else {  // We couldn't find the specific metric
+                else { // We couldn't find the specific metric
                     return false
                 }
                 if lhsBenchmarkResult != rhsBenchmarkResult {

Plugins/BenchmarkTool/BenchmarkTool+CreateBenchmark.swift

@@ -44,9 +44,9 @@ extension BenchmarkTool {
             ]
             """
 
-        var outputPath = FilePath(baselineStoragePath)  // package
-        var subPath = FilePath()  // subpath rooted in package used for directory creation
-        subPath.append("Package.swift")  // package/Benchmarks/targetName
+        var outputPath = FilePath(baselineStoragePath) // package
+        var subPath = FilePath() // subpath rooted in package used for directory creation
+        subPath.append("Package.swift") // package/Benchmarks/targetName
         outputPath.append(subPath.components)
 
         print("Adding new executable target \(targetName) to \(outputPath.description)")
@@ -110,13 +110,13 @@ extension BenchmarkTool {
 
             """
 
-        var outputPath = FilePath(baselineStoragePath)  // package
-        var subPath = FilePath()  // subpath rooted in package used for directory creation
+        var outputPath = FilePath(baselineStoragePath) // package
+        var subPath = FilePath() // subpath rooted in package used for directory creation
 
-        subPath.append(benchmarksDirectory)  // package/Benchmarks
-        subPath.append("\(targetName)")  // package/Benchmarks/targetName
+        subPath.append(benchmarksDirectory) // package/Benchmarks
+        subPath.append("\(targetName)") // package/Benchmarks/targetName
 
-        outputPath.createSubPath(subPath)  // Create destination subpath if needed
+        outputPath.createSubPath(subPath) // Create destination subpath if needed
         outputPath.append(subPath.components)
         outputPath.append("\(targetName).swift")
 

Plugins/BenchmarkTool/BenchmarkTool+Export+JMHFormatter.swift

@@ -56,7 +56,7 @@ extension JMHPrimaryMetric {
         if result.metric.countable {
             scoreUnit = result.metric == .throughput ? "# / s" : "#"
         } else {
-            scoreUnit = "μs"  // result.timeUnits.description
+            scoreUnit = "μs" // result.timeUnits.description
         }
         rawData = [recordedValues]
     }
@@ -66,7 +66,7 @@ extension BenchmarkTool {
     func convertToJMH(_ baseline: BenchmarkBaseline) throws -> String {
         var resultString = ""
         var jmhElements: [JMHElement] = []
-        var secondaryMetrics: [String: JMHPrimaryMetric] = [:]  // could move to OrderedDictionary for consistent output
+        var secondaryMetrics: [String: JMHPrimaryMetric] = [:] // could move to OrderedDictionary for consistent output
 
         baseline.targets.forEach { benchmarkTarget in
 

Plugins/BenchmarkTool/BenchmarkTool+Machine.swift

@@ -23,7 +23,7 @@ import Glibc
 extension BenchmarkTool {
     func benchmarkMachine() -> BenchmarkMachine {
         let processors = sysconf(Int32(_SC_NPROCESSORS_ONLN))
-        let memory = sysconf(Int32(_SC_PHYS_PAGES)) / 1_024 * sysconf(Int32(_SC_PAGESIZE)) / (1_024 * 1_024)  // avoid overflow
+        let memory = sysconf(Int32(_SC_PHYS_PAGES)) / 1_024 * sysconf(Int32(_SC_PAGESIZE)) / (1_024 * 1_024) // avoid overflow
 
         var uuname = utsname()
         _ = uname(&uuname)

Plugins/BenchmarkTool/BenchmarkTool+Operations.swift

@@ -29,7 +29,7 @@ extension BenchmarkTool {
             let benchmarkReply = try read()
 
             switch benchmarkReply {
-            case let .list(benchmark):
+            case .list(let benchmark):
                 benchmark.executablePath = benchmarkPath
                 benchmark.target = FilePath(benchmarkPath).lastComponent!.description
                 if metrics.isEmpty == false {
@@ -38,7 +38,7 @@ extension BenchmarkTool {
                 benchmarks.append(benchmark)
             case .end:
                 break outerloop
-            case let .error(description):
+            case .error(let description):
                 failBenchmark(description)
                 break outerloop
             default:
@@ -55,12 +55,12 @@ extension BenchmarkTool {
             let benchmarkReply = try read()
 
             switch benchmarkReply {
-            case let .result(benchmark: benchmark, results: results):
+            case .result(benchmark: let benchmark, results: let results):
                 let filteredResults = results.filter { benchmark.configuration.metrics.contains($0.metric) }
                 benchmarkResults[BenchmarkIdentifier(target: target, name: benchmark.name)] = filteredResults
             case .end:
                 break outerloop
-            case let .error(description):
+            case .error(let description):
                 failBenchmark(description, exitCode: .benchmarkJobFailed, "\(target)/\(benchmark.name)")
 
                 benchmarkResults[BenchmarkIdentifier(target: target, name: benchmark.name)] = []
@@ -134,7 +134,7 @@ extension BenchmarkTool {
                     return
                 }
 
-                if benchmarks.isEmpty {  // if we read from baseline and didn't run them, we put in some fake entries for the compare
+                if benchmarks.isEmpty { // if we read from baseline and didn't run them, we put in some fake entries for the compare
                     currentBaseline.results.keys.forEach { baselineKey in
                         if let benchmark: Benchmark = .init(baselineKey.name, closure: { _ in }) {
                             benchmark.target = baselineKey.target
@@ -287,7 +287,7 @@ extension BenchmarkTool {
                         return
                     }
 
-                    if benchmarks.isEmpty {  // if we read from baseline and didn't run them, we put in some fake entries for the compare
+                    if benchmarks.isEmpty { // if we read from baseline and didn't run them, we put in some fake entries for the compare
                         currentBaseline.results.keys.forEach { baselineKey in
                             if let benchmark: Benchmark = .init(baselineKey.name, closure: { _ in }) {
                                 benchmark.target = baselineKey.target
@@ -307,7 +307,7 @@ extension BenchmarkTool {
                     var p90Thresholds: [BenchmarkIdentifier: [BenchmarkMetric: BenchmarkThreshold]] =
                         [:]
 
-                    if let benchmarkPath = checkAbsolutePath {  // load statically defined thresholds for .p90
+                    if let benchmarkPath = checkAbsolutePath { // load statically defined thresholds for .p90
                         benchmarks.forEach { benchmark in
                             if let thresholds = BenchmarkTool.makeBenchmarkThresholds(
                                 path: benchmarkPath,

Plugins/BenchmarkTool/BenchmarkTool+ReadP90AbsoluteThresholds.swift

@@ -96,7 +96,7 @@ extension BenchmarkTool {
                 print("Failed to close fd for \(path) after reading.")
             }
         } catch {
-            if errno != ENOENT {  // file not found is ok, e.g. no thresholds found, then silently return nil
+            if errno != ENOENT { // file not found is ok, e.g. no thresholds found, then silently return nil
                 print("Failed to open file \(path), errno = [\(errno)] \(Errno(rawValue: errno).description)")
             }
         }