Skip to content

Commit c437337

Browse files
pareenavermapareenaverma
authored
Merge pull request #1339 from madeline-underwood/win_perf
Win perf_NS to check
2 parents 9434d27 + 5178ed2 commit c437337

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

‎content/install-guides/wperf.md‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -30,26 +30,26 @@ multitool_install_part: false # Set to true if a sub-page of a multi-page arti
3030
layout: installtoolsall # DO NOT MODIFY. Always true for tool install articles
3131
---
3232

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).
33+
WindowsPerf is a Linux Perf-inspired Windows on Arm performance profiling tool. Profiling is based on the Arm AArch64 PMU and its hardware counters. WindowsPerf supports the counting model for obtaining aggregate counts of occurrences of PMU events, and the sampling model for determining the frequencies of event occurrences produced by program locations at the function, basic block, and instruction levels. WindowsPerf is an open-source project hosted on [GitHub](https://github.com/arm-developer-tools/windowsperf).
3434

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.
35+
WindowsPerf consists of a kernel-mode driver and a user-space command-line tool. You can seamlessly integrate the WindowsPerf command line tool with both the [WindowsPerf Visual Studio Extension](#vs2022) and the [WindowsPerf VS Code Extension](#vscode). These extensions, which you can download from the Visual Studio Marketplace, enhance the functionality of WindowsPerf by providing a 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.
3636

3737

38-
{{% notice Virtual Machines%}}
39-
WindowsPerf cannot be used on virtual machines, such as cloud instances.
38+
{{% notice Note%}}
39+
You cannot use WindowsPerf on virtual machines, such as cloud instances.
4040
{{% /notice %}}
4141

4242
## Visual Studio and the Windows Driver Kit (WDK)
4343

44-
WindowsPerf relies on `dll` files installed with Visual Studio (Community Edition or higher) and (optionally) installers from the Windows Driver Kit extension.
44+
WindowsPerf relies on `dll` files installed with Visual Studio, from the Community Edition or higher and, optionally, installers from the Windows Driver Kit extension.
4545

46-
[Download the Windows Driver Kit (WDK)](https://learn.microsoft.com/en-us/windows-hardware/drivers/download-the-wdk) explains the WDK installation process.
46+
For information about the WDK installation process, see [Download the Windows Driver Kit (WDK)](https://learn.microsoft.com/en-us/windows-hardware/drivers/download-the-wdk).
4747

4848
See also the [Visual Studio for Windows on Arm install guide](/install-guides/vs-woa/).
4949

5050
## Download WindowsPerf
5151

52-
The latest release package `windowsperf-bin-<version>.zip` can be downloaded from the Arm GitHub repository:
52+
You can download the latest release package, `windowsperf-bin-<version>.zip` from the Arm GitHub repository:
5353
```url
5454
https://github.com/arm-developer-tools/windowsperf/releases
5555
```
@@ -70,17 +70,17 @@ tar -xmf windowsperf-bin-3.8.0.zip
7070

7171
## Install wperf driver
7272

73-
You can install the kernel driver using supplied `wperf-devgen` installer.
73+
You can install the kernel driver using the supplied `wperf-devgen` installer.
7474

7575
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.
7676

7777
{{% notice Note%}}
7878
You must install the driver as `Administrator`.
7979
{{% /notice %}}
8080

81-
Open a `Windows Command Prompt` terminal with `Run as administrator` enabled.
81+
Open a **Windows Command Prompt** terminal with **Run as administrator** selected.
8282

83-
Make sure you are in the `windowsperf-bin-<version>` directory.
83+
Make sure you are in the `windowsperf-bin-<version>` directory:
8484

8585
```command
8686
cd windowsperf-bin-3.8.0
@@ -95,7 +95,7 @@ cd wperf-driver
9595
wperf-devgen install
9696
```
9797

98-
The output is similar to:
98+
The output should be similar to:
9999

100100
```output
101101
Executing command: install.
@@ -108,7 +108,7 @@ Device installed successfully
108108
You can check everything is working by running the `wperf` executable.
109109

110110
{{% notice Note%}}
111-
Once the above driver is installed, you can use `wperf` without `Administrator` privileges.
111+
Once you have installed the driver, you can use `wperf` without `Administrator` privileges.
112112
{{% /notice %}}
113113

114114
For example:
@@ -129,7 +129,7 @@ You see output similar to:
129129
```
130130
## Uninstall wperf driver
131131

132-
You can uninstall (aka "remove") the kernel driver using supplied [wperf-devgen](#devgen_uninstall) uninstaller.
132+
You can uninstall (or *remove*) the kernel driver using supplied [wperf-devgen](#devgen_uninstall) uninstaller.
133133

134134
{{% notice Note%}}
135135
You must uninstall the driver as `Administrator`.
@@ -149,17 +149,17 @@ Executing command: uninstall.
149149
Uninstall requested.
150150
Root\WPERFDRIVER
151151
Device found
152-
Device uninstalled sucessfully
152+
Device uninstalled successfully
153153
```
154154

155155
## Install WindowsPerf Virtual Studio Extension (optional) {#vs2022}
156156

157-
WindowsPerf GUI (Graphical User Interface) project, a Visual Studio 2022 extension designed to bring a seamless UI experience to WindowsPerf, the command-line performance profiling tool for Windows on Arm. Extension is available on the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=Arm.WindowsPerfGUI).
157+
WindowsPerf GUI (Graphical User Interface) is a Visual Studio 2022 extension designed to bring a seamless UI experience to WindowsPerf, the command-line performance profiling tool for Windows on Arm. It is available on the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=Arm.WindowsPerfGUI).
158158

159-
Install by opening `Extensions` menu, select `Manage Extensions` and click `Browse`. Type `WindowsPerf` to search for Arm WindowsPerf GUI extension. Click `Install`.
159+
Install by opening **Extensions** menu, click **Manage Extensions**, and click **Browse**. Type `WindowsPerf` to search for Arm WindowsPerf GUI extension. Click **Install**.
160160

161161
{{% notice How to set up wperf.exe path in the extension%}}
162-
In order to set the path to the `wperf.exe` executable, go to `Tools -> Options -> WindowsPerf -> WindowsPerf Path` and set the absolute path to the wperf.exe executable and then on the Validate button.
162+
In order to set the path to the `wperf.exe` executable, go to **Tools** -> **Options** -> **WindowsPerf** -> **WindowsPerf Path** and set the absolute path to the wperf.exe executable and then click on the **Validate** button.
163163
{{% /notice %}}
164164

165165
Also, visit WindowsPerf GUI project website on [GitHub](https://github.com/arm-developer-tools/windowsperf-vs-extension) for more details and latest updates.
@@ -168,9 +168,9 @@ Also, visit WindowsPerf GUI project website on [GitHub](https://github.com/arm-d
168168

169169
In addition to the command-line tools, `WindowsPerf` is available on the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=Arm.windowsperf).
170170

171-
Install by opening the `Extensions` view (`Ctrl`+`Shift`+`X`) and searching for `WindowsPerf`.　Click `Install`.
171+
Install by opening the **Extensions** view (Ctrl+Shift+X) and searching for `WindowsPerf`. Click **Install**.
172172

173-
Open `Settings` (`Ctrl`+`,`) > `Extensions` > `WindowsPerf`, and specify the path to the `wperf` executable.
173+
Open **Settings** (Ctrl+,) > **Extensions** > **WindowsPerf**, and specify the path to the `wperf` executable.
174174

175175
{{% notice Non-Windows on Arm host%}}
176176
You can only generate reports from a Windows on Arm device.

0 commit comments

Comments
 (0)