File: README.md

package info (click to toggle)
swiftlang 6.1.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,791,532 kB
  • sloc: cpp: 9,901,743; ansic: 2,201,431; asm: 1,091,827; python: 308,252; objc: 82,166; f90: 80,126; lisp: 38,358; pascal: 25,559; sh: 20,429; ml: 5,058; perl: 4,745; makefile: 4,484; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (37 lines) | stat: -rw-r--r-- 1,231 bytes parent folder | download
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
# SwiftPM Benchmarks

Benchmarks currently use [ordo-one/package-benchmark](https://github.com/ordo-one/package-benchmark) library for
benchmarking.

## How to Run

To run the benchmarks in their default configuration, run this command in the `Benchmarks` subdirectory of the SwiftPM
repository clone (the directory in which this `README.md` file is contained):

```
swift package benchmark
```

To collect all benchmark metrics, set `SWIFTPM_BENCHMARK_ALL_METRICS` to a truthy value:

```
SWIFTPM_BENCHMARK_ALL_METRICS=true swift package benchmark
```

## Benchmark Thresholds

`Benchmarks/Thresholds` subdirectory contains recorded allocation and syscall counts for macOS on Apple Silicon when
built with Swift 5.10. To record new thresholds, run the following command:

```
swift package --allow-writing-to-package-directory benchmark \
  --format metricP90AbsoluteThresholds \
  --path "Thresholds/$([[ $(uname) == Darwin ]] && echo macos || echo linux)-$(uname -m)"
```

To verify that recorded thresholds do not exceeded given relative or absolute values (passed as `thresholds` arguments
to each benchmark's configuration), run this command:

```
swift package benchmark baseline check --check-absolute-path Thresholds/
```