Skip to content

Commit 1f1bccd

Browse files
authored
Merge pull request #1294 from RonanSynnottArm/winperf
Added vs code to wperf install guide
2 parents f605755 + cee47cd commit 1f1bccd

File tree

1 file changed

+37
-21
lines changed

1 file changed

+37
-21
lines changed

content/install-guides/wperf.md

Lines changed: 37 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ additional_search_terms:
1818
minutes_to_complete: 15
1919

2020
### Link to official documentation
21-
official_docs: https://gitlab.com/Linaro/WindowsPerf/windowsperf/-/blob/main/wperf/README.md
21+
official_docs: https://github.com/arm-developer-tools/windowsperf/blob/main/INSTALL.md
2222

2323
author_primary: Jason Andrews
2424

@@ -32,14 +32,16 @@ layout: installtoolsall # DO NOT MODIFY. Always true for tool install ar
3232

3333
WindowsPerf is an open-source command line tool for performance analysis on Windows on Arm devices.
3434

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.
3636

3737
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.
3838

3939
{{% notice Virtual Machines%}}
4040
WindowsPerf cannot be used on virtual machines, such as cloud instances.
4141
{{% /notice %}}
4242

43+
You can interact with the
44+
4345
## Visual Studio and the Windows Driver Kit (WDK)
4446

4547
WindowsPerf relies on `dll` files installed with Visual Studio (Community Edition or higher) and (optionally) installers from the Windows Driver Kit extension.
@@ -57,20 +59,37 @@ https://gitlab.com/Linaro/WindowsPerf/windowsperf/-/releases
5759
To download directly from command prompt, use:
5860

5961
```console
60-
mkdir windowsperf-bin-3.2.1
61-
cd windowsperf-bin-3.2.1
62-
curl https://gitlab.com/api/v4/projects/40381146/packages/generic/windowsperf/3.2.1/windowsperf-bin-3.2.1.zip --output windowsperf-bin-3.2.1.zip
62+
mkdir windowsperf-bin-3.8.0
63+
cd windowsperf-bin-3.8.0
64+
curl https://gitlab.com/api/v4/projects/40381146/packages/generic/windowsperf/3.8.0/windowsperf-bin-3.8.0.zip --output windowsperf-bin-3.8.0.zip
6365
```
6466

6567
Unzip the package:
6668

6769
```console
68-
tar -xmf windowsperf-bin-3.2.1.zip
70+
tar -xmf windowsperf-bin-3.8.0.zip
6971
```
7072

73+
## Install VS Code Extension (optional) {#vscode}
74+
75+
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+
7190
## Install wperf driver
7291

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).
7493

7594
{{% notice Note%}}
7695
You must install the driver as `Administrator`.
@@ -80,10 +99,10 @@ Open a `Windows Command Prompt` terminal with `Run as administrator` enabled.
8099

81100
Navigate to the `windowsperf-bin-<version>` directory.
82101
```command
83-
cd windowsperf-bin-3.2.1
102+
cd windowsperf-bin-3.8.0
84103
```
85104

86-
### Install with devcon {#devcon}
105+
### Install with devcon {#devcon_install}
87106

88107
Navigate into the `wperf-driver` folder, and use `devcon` to install the driver:
89108

@@ -99,12 +118,8 @@ Updating drivers for Root\WPERFDRIVER from <path>\wperf-driver.inf.
99118
Drivers installed successfully.
100119
```
101120

102-
### Install with wperf-devgen {#devgen}
121+
### Install with wperf-devgen {#devgen_install}
103122

104-
Copy the `wperf-devgen.exe` executable to the `wperf-driver` folder.
105-
```command
106-
copy wperf-devgen.exe wperf-driver\
107-
```
108123
Navigate to the `wperf-driver` folder and run the installer:
109124
```command
110125
cd wperf-driver
@@ -134,21 +149,22 @@ wperf --version
134149
```
135150
You should see output similar to:
136151
```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+
141157
```
142158

143159
## Uninstall wperf driver
144160

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).
146162

147163
{{% notice Note%}}
148164
You must uninstall the driver as `Administrator`.
149165
{{% /notice %}}
150166

151-
### Uninstall with devcon {#devcon}
167+
### Uninstall with devcon {#devcon_uninstall}
152168

153169
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.
154170

@@ -161,7 +177,7 @@ ROOT\SYSTEM\0001 : Removed
161177
1 device(s) were removed.
162178
```
163179

164-
### Uninstall with wperf-devgen {#devgen}
180+
### Uninstall with wperf-devgen {#devgen_uninstall}
165181

166182
```command
167183
wperf-devgen uninstall

0 commit comments

Comments
 (0)