You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/install-guides/wperf.md
+24-18Lines changed: 24 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
### Title the install tools article with the name of the tool to be installed
3
3
### Include vendor name where appropriate
4
-
title: Perf for Windows on Arm (WindowsPerf)
4
+
title: WindowsPerf (wperf)
5
5
6
6
### Optional additional search terms (one per line) to assist in finding the article
7
7
additional_search_terms:
@@ -30,7 +30,7 @@ multitool_install_part: false # Set to true if a sub-page of a multi-page arti
30
30
layout: installtoolsall # DO NOT MODIFY. Always true for tool install articles
31
31
---
32
32
33
-
WindowsPerf is (Linux perf inspired) Windows on Arm performance profiling tool. Profiling is based on ARM64 PMU and its hardware counters. WindowsPerf supports the counting model for obtaining aggregate counts of occurrences of special events, and sampling model for determining the frequencies of event occurrences produced by program locations at the function, basic block, and/or instruction levels. WindowsPerf is an open-source project hosted on [GitHub](https://github.com/arm-developer-tools/windowsperf).
33
+
WindowsPerf is a Linux Perf inspired Windows on Arm performance profiling tool. Profiling is based on ARM64 PMU and its hardware counters. WindowsPerf supports the counting model for obtaining aggregate counts of occurrences of special events, and sampling model for determining the frequencies of event occurrences produced by program locations at the function, basic block, and/or instruction levels. WindowsPerf is an open-source project hosted on [GitHub](https://github.com/arm-developer-tools/windowsperf).
34
34
35
35
WindowsPerf consists of a kernel-mode driver and a user-space command-line tool. The WindowsPerf command line tool can be seamlessly integrated with both the [WindowsPerf Visual Studio Extension](#vs2022) and the [WindowsPerf VS Code Extension](#vscode). These extensions, which can be downloaded from the Visual Studio Marketplace, enhance the functionality of WindowsPerf by providing a more user-friendly interface and additional features for performance analysis and debugging. This integration allows developers to efficiently analyze and optimize their applications directly within their preferred development environment.
36
36
@@ -70,7 +70,7 @@ tar -xmf windowsperf-bin-3.8.0.zip
70
70
71
71
## Install wperf driver
72
72
73
-
You can install the kernel driver using supplied [wperf-devgen](#devgen_install) installer.
73
+
You can install the kernel driver using supplied `wperf-devgen` installer.
74
74
75
75
The [wperf-devgen](https://github.com/arm-developer-tools/windowsperf/blob/main/wperf-devgen/README.md) tool has been designated as the preferred installer and uninstaller for the WindowsPerf Kernel Driver in the latest release. This tool offers a simple process for managing the installation and removal of the driver.
76
76
@@ -80,27 +80,29 @@ You must install the driver as `Administrator`.
80
80
81
81
Open a `Windows Command Prompt` terminal with `Run as administrator` enabled.
82
82
83
-
Navigate to the `windowsperf-bin-<version>` directory.
83
+
Make sure you are in the `windowsperf-bin-<version>` directory.
84
+
84
85
```command
85
86
cd windowsperf-bin-3.8.0
86
87
```
87
88
88
89
### Install with wperf-devgen {#devgen_install}
89
90
90
91
Navigate to the `wperf-driver` folder and run the installer:
92
+
91
93
```command
92
94
cd wperf-driver
93
95
wperf-devgen install
94
96
```
95
-
You will see output similar to:
96
-
```output
97
+
98
+
The output is similar to:
99
+
100
+
```output
97
101
Executing command: install.
98
102
Install requested.
99
-
Waiting for device creation...
100
-
Device installed successfully.
101
-
Trying to install driver...
102
-
Success installing driver.
103
+
Device installed successfully
103
104
```
105
+
104
106
## Verify install
105
107
106
108
You can check everything is working by running the `wperf` executable.
@@ -110,19 +112,21 @@ Once the above driver is installed, you can use `wperf` without `Administrator`
110
112
{{% /notice %}}
111
113
112
114
For example:
115
+
113
116
```command
114
-
cd ..
117
+
cd ..\wperf
115
118
wperf --version
116
119
```
117
-
You should see output similar to:
120
+
121
+
You see output similar to:
122
+
118
123
```output
119
124
Component Version GitVer FeatureString
120
125
========= ======= ====== =============
121
126
wperf 3.8.0 6d15ddfc +etw-app
122
127
wperf-driver 3.8.0 6d15ddfc +etw-drv
123
128
124
129
```
125
-
126
130
## Uninstall wperf driver
127
131
128
132
You can uninstall (aka "remove") the kernel driver using supplied [wperf-devgen](#devgen_uninstall) uninstaller.
@@ -134,16 +138,18 @@ You must uninstall the driver as `Administrator`.
134
138
### Uninstall with wperf-devgen {#devgen_uninstall}
135
139
136
140
```command
141
+
cd windowsperf-bin-3.8.0\wperf-driver
137
142
wperf-devgen uninstall
138
143
```
139
-
You should see output similar to:
144
+
145
+
The output is similar to:
146
+
140
147
```console
141
148
Executing command: uninstall.
142
149
Uninstall requested.
143
-
Waiting for device creation...
144
-
Device uninstalled successfully.
145
-
Trying to remove driver <path>\wperf-driver.inf.
146
-
Driver removed successfully.
150
+
Root\WPERFDRIVER
151
+
Device found
152
+
Device uninstalled sucessfully
147
153
```
148
154
149
155
## Install WindowsPerf Virtual Studio Extension (optional) {#vs2022}
0 commit comments