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
@@ -32,14 +32,16 @@ layout: installtoolsall # DO NOT MODIFY. Always true for tool install ar
32
32
33
33
WindowsPerf is an open-source command line tool for performance analysis on Windows on Arm devices.
34
34
35
-
WindowsPerf consists of a kernel-mode driver and a user-space command-line tool. The command-line tool is modeled after the Linux `perf` command.
35
+
WindowsPerf consists of a kernel-mode driver and a user-space command-line tool, or [VS Code Extension](#vscode). The command-line tool is modeled after the Linux `perf` command.
36
36
37
37
WindowsPerf includes a **counting model** for counting events such as cycles, instructions, and cache events and a **sampling model** to understand how frequently events occur.
38
38
39
39
{{% notice Virtual Machines%}}
40
40
WindowsPerf cannot be used on virtual machines, such as cloud instances.
41
41
{{% /notice %}}
42
42
43
+
You can interact with the
44
+
43
45
## Visual Studio and the Windows Driver Kit (WDK)
44
46
45
47
WindowsPerf relies on `dll` files installed with Visual Studio (Community Edition or higher) and (optionally) installers from the Windows Driver Kit extension.
In addition to the command-line tools, `WindowsPerf` is available on the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=Arm.windowsperf).
76
+
77
+
Install by opening the `Extensions` view (`Ctrl`+`Shift`+`X`) and searching for `WindowsPerf`. Click `Install`.
78
+
79
+
Open `Settings` (`Ctrl`+`,`) > `Extensions` > `WindowsPerf`, and specify the path to the `wperf` executable.
80
+
81
+
{{% notice Non-Windows on Arm host%}}
82
+
You can only generate reports from a Windows on Arm device.
83
+
84
+
If using a non-Windows on Arm host, you can import and analyze `WindowsPerf` JSON reports from such devices.
85
+
86
+
You do not need to install `wperf` on non-Windows on Arm devices.
87
+
{{% /notice %}}
88
+
89
+
71
90
## Install wperf driver
72
91
73
-
You can install the kernel driver using either the Visual Studio [devcon](#devcon) utility or the supplied [installer](#devgen).
92
+
You can install the kernel driver using either the Visual Studio [devcon](#devcon_install) utility or the supplied [installer](#devgen_install).
74
93
75
94
{{% notice Note%}}
76
95
You must install the driver as `Administrator`.
@@ -80,10 +99,10 @@ Open a `Windows Command Prompt` terminal with `Run as administrator` enabled.
80
99
81
100
Navigate to the `windowsperf-bin-<version>` directory.
82
101
```command
83
-
cd windowsperf-bin-3.2.1
102
+
cd windowsperf-bin-3.8.0
84
103
```
85
104
86
-
### Install with devcon {#devcon}
105
+
### Install with devcon {#devcon_install}
87
106
88
107
Navigate into the `wperf-driver` folder, and use `devcon` to install the driver:
89
108
@@ -99,12 +118,8 @@ Updating drivers for Root\WPERFDRIVER from <path>\wperf-driver.inf.
99
118
Drivers installed successfully.
100
119
```
101
120
102
-
### Install with wperf-devgen {#devgen}
121
+
### Install with wperf-devgen {#devgen_install}
103
122
104
-
Copy the `wperf-devgen.exe` executable to the `wperf-driver` folder.
105
-
```command
106
-
copy wperf-devgen.exe wperf-driver\
107
-
```
108
123
Navigate to the `wperf-driver` folder and run the installer:
109
124
```command
110
125
cd wperf-driver
@@ -134,21 +149,22 @@ wperf --version
134
149
```
135
150
You should see output similar to:
136
151
```output
137
-
Component Version GitVer
138
-
========= ======= ======
139
-
wperf 3.2.1 c831cfc2
140
-
wperf-driver 3.2.1 c831cfc2
152
+
Component Version GitVer FeatureString
153
+
========= ======= ====== =============
154
+
wperf 3.8.0 6d15ddfc +etw-app
155
+
wperf-driver 3.8.0 6d15ddfc +etw-drv
156
+
141
157
```
142
158
143
159
## Uninstall wperf driver
144
160
145
-
You can uninstall (aka "remove") the kernel driver using either the Visual Studio [devcon](#devcon) utility or the supplied [installer](#devgen).
161
+
You can uninstall (aka "remove") the kernel driver using either the Visual Studio [devcon](#devcon_uninstall) utility or the supplied [installer](#devgen_uninstall).
146
162
147
163
{{% notice Note%}}
148
164
You must uninstall the driver as `Administrator`.
149
165
{{% /notice %}}
150
166
151
-
### Uninstall with devcon {#devcon}
167
+
### Uninstall with devcon {#devcon_uninstall}
152
168
153
169
Below command removes the device from the device tree and deletes the device stack for the device. As a result of these actions, child devices are removed from the device tree and the drivers that support the device are unloaded. See [DevCon Remove](https://learn.microsoft.com/en-us/windows-hardware/drivers/devtest/devcon-remove) article for more details.
154
170
@@ -161,7 +177,7 @@ ROOT\SYSTEM\0001 : Removed
161
177
1 device(s) were removed.
162
178
```
163
179
164
-
### Uninstall with wperf-devgen {#devgen}
180
+
### Uninstall with wperf-devgen {#devgen_uninstall}
0 commit comments