1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
|
import Foundation
extension BenchmarkRunner {
/// Attempts to save the results to the given path
func save(to savePath: String) throws {
let url = URL(fileURLWithPath: savePath, isDirectory: false)
let parent = url.deletingLastPathComponent()
if !FileManager.default.fileExists(atPath: parent.path) {
try! FileManager.default.createDirectory(
atPath: parent.path,
withIntermediateDirectories: true)
}
print("Saving result to \(url.path)")
try results.save(to: url)
}
/// Attempts to load the results from the given save file
mutating func load(from savePath: String) throws {
let url = URL(fileURLWithPath: savePath)
let result = try SuiteResult.load(from: url)
self.results = result
print("Loaded results from \(url.path)")
}
/// Compare this runner's results against the results stored in the given file path
func compare(
against compareFilePath: String,
showChart: Bool,
saveTo: String?
) throws {
let compareFileURL = URL(fileURLWithPath: compareFilePath)
let compareResult = try SuiteResult.load(from: compareFileURL)
let compareFile = compareFileURL.lastPathComponent
let comparisons = results
.compare(with: compareResult)
.filter({!$0.name.contains("_NS")})
.filter({$0.diff != nil})
displayComparisons(
comparisons,
showChart,
against: "saved benchmark result " + compareFile)
if let saveFile = saveTo {
try saveComparisons(comparisons, path: saveFile)
}
}
// Compile times are often very short (5-20µs) so results are likely to be
// very affected by background tasks. This is primarily for making sure
// there aren't any catastrophic changes in compile times
func compareCompileTimes(
against compareFilePath: String,
showChart: Bool
) throws {
let compareFileURL = URL(fileURLWithPath: compareFilePath)
let compareResult = try SuiteResult.load(from: compareFileURL)
let compareFile = compareFileURL.lastPathComponent
let compileTimeComparisons = results
.compareCompileTimes(with: compareResult)
.filter({!$0.name.contains("_NS")})
.filter({$0.diff != nil})
print("Comparing estimated compile times")
displayComparisons(
compileTimeComparisons,
false,
against: "saved benchmark result " + compareFile)
}
/// Compares Swift Regex benchmark results against NSRegularExpression
func compareWithNS(showChart: Bool, saveTo: String?) throws {
let comparisons = results.compareWithNS().filter({$0.diff != nil})
displayComparisons(
comparisons,
showChart,
against: "NSRegularExpression (via CrossBenchmark)")
if let saveFile = saveTo {
try saveComparisons(comparisons, path: saveFile)
}
}
func displayComparisons(
_ comparisons: [BenchmarkResult.Comparison],
_ showChart: Bool,
against: String
) {
let regressions = comparisons.filter({$0.diff!.seconds > 0})
.sorted(by: {(a,b) in a.diff!.seconds > b.diff!.seconds})
let improvements = comparisons.filter({$0.diff!.seconds < 0})
.sorted(by: {(a,b) in a.diff!.seconds < b.diff!.seconds})
print("Comparing against \(against)")
print("=== Regressions ======================================================================")
for item in regressions {
print(item)
}
print("=== Improvements =====================================================================")
for item in improvements {
print(item)
}
#if os(macOS) && canImport(Charts)
if showChart {
print("""
=== Comparison chart =================================================================
Press Control-C to close...
""")
BenchmarkResultApp.comparisons = comparisons
BenchmarkResultApp.main()
}
#endif
}
func saveComparisons(
_ comparisons: [BenchmarkResult.Comparison],
path: String
) throws {
let url = URL(fileURLWithPath: path, isDirectory: false)
let parent = url.deletingLastPathComponent()
if !FileManager.default.fileExists(atPath: parent.path) {
try! FileManager.default.createDirectory(
atPath: parent.path,
withIntermediateDirectories: true)
}
var contents = "name,latest,baseline,diff,percentage\n"
for comparison in comparisons {
contents += comparison.asCsv + "\n"
}
print("Saving comparisons as .csv to \(path)")
try contents.write(to: url, atomically: true, encoding: String.Encoding.utf8)
}
}
struct Measurement: Codable, CustomStringConvertible {
let median: Time
let stdev: Double
let samples: Int
init(results: [Time]) {
let sorted = results.sorted()
self.samples = sorted.count
self.median = sorted[samples/2]
let sum = results.reduce(0.0) {acc, next in acc + next.seconds}
let mean = sum / Double(samples)
let squareDiffs = results.reduce(0.0) { acc, next in
acc + pow(next.seconds - mean, 2)
}
self.stdev = (squareDiffs / Double(samples)).squareRoot()
}
var description: String {
return "\(median) (stdev: \(Time(stdev)), N = \(samples))"
}
}
struct BenchmarkResult: Codable, CustomStringConvertible {
let runtime: Measurement
let compileTime: Measurement?
let parseTime: Measurement?
var description: String {
var base = " > run time: \(runtime.description)"
if let compileTime = compileTime {
base += "\n > compile time: \(compileTime)"
}
if let parseTime = parseTime {
base += "\n > parse time: \(parseTime)"
}
return base
}
}
extension BenchmarkResult {
struct Comparison: Identifiable, CustomStringConvertible {
var id = UUID()
var name: String
var baseline: Measurement
var latest: Measurement
var latestTime: Time { latest.median }
var baselineTime: Time { baseline.median }
var diff: Time? {
if Stats.tTest(baseline, latest) {
return latestTime - baselineTime
}
return nil
}
var normalizedDiff: Double {
latestTime.seconds/baselineTime.seconds
}
var description: String {
guard let diff = diff else {
return "- \(name) N/A"
}
let percentage = (1000 * diff.seconds / baselineTime.seconds).rounded()/10
let len = max(40 - name.count, 1)
let nameSpacing = String(repeating: " ", count: len)
return "- \(name)\(nameSpacing)\(latestTime)\t\(baselineTime)\t\(diff)\t\t\(percentage)%"
}
var asCsv: String {
guard let diff = diff else {
return "\(name),N/A"
}
let percentage = (1000 * diff.seconds / baselineTime.seconds).rounded()/10
return "\"\(name)\",\(latestTime.seconds),\(baselineTime.seconds),\(diff.seconds),\(percentage)%"
}
}
}
struct SuiteResult {
var results: [String: BenchmarkResult] = [:]
mutating func add(name: String, result: BenchmarkResult) {
results.updateValue(result, forKey: name)
}
func compare(with other: SuiteResult) -> [BenchmarkResult.Comparison] {
var comparisons: [BenchmarkResult.Comparison] = []
for latest in results {
if let otherVal = other.results[latest.key] {
comparisons.append(
.init(name: latest.key,
baseline: otherVal.runtime, latest: latest.value.runtime))
}
}
return comparisons
}
/// Compares with the NSRegularExpression benchmarks generated by CrossBenchmark
func compareWithNS() -> [BenchmarkResult.Comparison] {
var comparisons: [BenchmarkResult.Comparison] = []
for latest in results {
let key = latest.key + CrossBenchmark.nsSuffix
if let nsResult = results[key] {
comparisons.append(
.init(name: latest.key,
baseline: nsResult.runtime, latest: latest.value.runtime))
}
}
return comparisons
}
func compareCompileTimes(
with other: SuiteResult
) -> [BenchmarkResult.Comparison] {
var comparisons: [BenchmarkResult.Comparison] = []
for latest in results {
if let baseline = other.results[latest.key],
let baselineTime = baseline.compileTime,
let latestTime = latest.value.compileTime {
comparisons.append(
.init(name: latest.key,
baseline: baselineTime,
latest: latestTime))
}
}
return comparisons
}
}
extension SuiteResult: Codable {
func save(to url: URL) throws {
let encoder = JSONEncoder()
let data = try encoder.encode(self)
try data.write(to: url, options: .atomic)
}
static func load(from url: URL) throws -> SuiteResult {
let decoder = JSONDecoder()
let data = try Data(contentsOf: url)
return try decoder.decode(SuiteResult.self, from: data)
}
}
|