Skip to content

Commit 1e0ffe7

Browse files
TianyouLiharp-intel
authored andcommitted
Modify README for perf lock
1 parent 128ff8f commit 1e0ffe7

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ Svr-info functionality is now included in PerfSpect. The svr-info configuration
3939
| ------- | ----------- |
4040
| [`perfspect config`](#config-command) | Modify system configuration |
4141
| [`perfspect flame`](#flame-command) | Generate flamegraphs |
42+
| [`perfspect lock`](#lock-command) | Collect system wide hotspot, c2c and lock contention information |
4243
| [`perfspect metrics`](#metrics-command) | Monitor core and uncore metrics |
4344
| [`perfspect report`](#report-command) | Generate configuration report |
4445
| [`perfspect telemetry`](#telemetry-command) | Collect system telemetry |
@@ -55,6 +56,10 @@ $ ./perfspect config --cores 24 --llc 2.0 --uncoremaxfreq 1.8
5556
```
5657
#### Flame Command
5758
Software flamegraphs are useful in diagnosing software performance bottlenecks. Run `perfspect flame -h` to capture a system-wide software flamegraph.
59+
60+
#### Lock Command
61+
As system contains more and more cores, it would be usuful to be able to analyze the kernel lock overhead and potential false-sharing that impact the overall system scalability. Run `perfspect lock -h` to collect system wide hotspot, c2c and lock contention information, that will be helpful for experienced performance engineers to have a chance to look into the related problems.
62+
5863
#### Metrics Command
5964
The `metrics` command provides system performance characterization metrics. The metrics provided are dependent on the platform architecture.
6065

@@ -186,4 +191,4 @@ $ ./perfspect report --benchmark speed,memory --targets targets.yaml
186191
`builder/build.sh` builds the dependencies and the app in Docker containers that provide the required build environments. Assumes you have Docker installed on your development system.
187192

188193
### Subsequent Builds
189-
`make` builds the app. Assumes the dependencies have been built previously and that you have Go installed on your development system.
194+
`make` builds the app. Assumes the dependencies have been built previously and that you have Go installed on your development system.

0 commit comments

Comments
 (0)