Skip to content

Review wperf install guide #1329

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 16, 2024
Merged

Review wperf install guide #1329

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 24 additions & 18 deletions content/install-guides/wperf.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
### Title the install tools article with the name of the tool to be installed
### Include vendor name where appropriate
title: Perf for Windows on Arm (WindowsPerf)
title: WindowsPerf (wperf)

### Optional additional search terms (one per line) to assist in finding the article
additional_search_terms:
Expand Down Expand Up @@ -30,7 +30,7 @@ multitool_install_part: false # Set to true if a sub-page of a multi-page arti
layout: installtoolsall # DO NOT MODIFY. Always true for tool install articles
---

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

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.

Expand Down Expand Up @@ -70,7 +70,7 @@ tar -xmf windowsperf-bin-3.8.0.zip

## Install wperf driver

You can install the kernel driver using supplied [wperf-devgen](#devgen_install) installer.
You can install the kernel driver using supplied `wperf-devgen` installer.

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.

Expand All @@ -80,27 +80,29 @@ You must install the driver as `Administrator`.

Open a `Windows Command Prompt` terminal with `Run as administrator` enabled.

Navigate to the `windowsperf-bin-<version>` directory.
Make sure you are in the `windowsperf-bin-<version>` directory.

```command
cd windowsperf-bin-3.8.0
```

### Install with wperf-devgen {#devgen_install}

Navigate to the `wperf-driver` folder and run the installer:

```command
cd wperf-driver
wperf-devgen install
```
You will see output similar to:
```output

The output is similar to:

```output
Executing command: install.
Install requested.
Waiting for device creation...
Device installed successfully.
Trying to install driver...
Success installing driver.
Device installed successfully
```

## Verify install

You can check everything is working by running the `wperf` executable.
Expand All @@ -110,19 +112,21 @@ Once the above driver is installed, you can use `wperf` without `Administrator`
{{% /notice %}}

For example:

```command
cd ..
cd ..\wperf
wperf --version
```
You should see output similar to:

You see output similar to:

```output
Component Version GitVer FeatureString
========= ======= ====== =============
wperf 3.8.0 6d15ddfc +etw-app
wperf-driver 3.8.0 6d15ddfc +etw-drv

```

## Uninstall wperf driver

You can uninstall (aka "remove") the kernel driver using supplied [wperf-devgen](#devgen_uninstall) uninstaller.
Expand All @@ -134,16 +138,18 @@ You must uninstall the driver as `Administrator`.
### Uninstall with wperf-devgen {#devgen_uninstall}

```command
cd windowsperf-bin-3.8.0\wperf-driver
wperf-devgen uninstall
```
You should see output similar to:

The output is similar to:

```console
Executing command: uninstall.
Uninstall requested.
Waiting for device creation...
Device uninstalled successfully.
Trying to remove driver <path>\wperf-driver.inf.
Driver removed successfully.
Root\WPERFDRIVER
Device found
Device uninstalled sucessfully
```

## Install WindowsPerf Virtual Studio Extension (optional) {#vs2022}
Expand Down