Skip to content

Update WindowsPerf install guide for version 4.0.0 #1592

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 3 commits into from
Feb 7, 2025
Merged

Update WindowsPerf install guide for version 4.0.0 #1592

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5249fb5
Update WindowsPerf install guide for version 4.0.0
jasonrandrews Feb 7, 2025
ac4b637
Update WindowsPerf install guides for new location.
jasonrandrews Feb 7, 2025
b0411ca
Update wperf version output for version 4.0.0
jasonrandrews Feb 7, 2025
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
10 changes: 5 additions & 5 deletions content/install-guides/windows-perf-vs-extension.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ cascade:

minutes_to_complete: 10

official_docs: https://github.com/arm-developer-tools/windowsperf-vs-extension
official_docs: https://gitlab.com/Linaro/WindowsPerf/vs-extension

author: Nader Zouaoui

Expand Down Expand Up @@ -71,11 +71,11 @@ To install the WindowsPerf Visual Studio Extension from Visual Studio:

![WindowsPerf install page #center](/install_guides/_images/wperf-vs-extension-install-page.png)

### Installation from GitHub
### Installation from GitLab

You can also install the WindowsPerf Visual Studio Extension from GitHub.
You can also install the WindowsPerf Visual Studio Extension from GitLab.

Download the installation file directly from the [GitHub release page](https://github.com/arm-developer-tools/windowsperf-vs-extension/releases).
Download the installation file directly from the [release page](https://gitlab.com/Linaro/WindowsPerf/vs-extension/-/releases).

Unzip the downloaded file and double click on the `WindowsPerfGUI.vsix` file.

Expand All @@ -85,7 +85,7 @@ Make sure that any previous version of the extension is uninstalled and that Vis

### Build from source

To build the source code, clone [the repository](https://github.com/arm-developer-tools/windowsperf-vs-extension) and build the `WindowsPerfGUI` solution using the default configuration in Visual Studio.
To build the source code, clone [the repository](https://gitlab.com/Linaro/WindowsPerf/vs-extension.git) and build the `WindowsPerfGUI` solution using the default configuration in Visual Studio.

Building the source is not required, but offered as an alternative installation method if you want to customize the extension.

Expand Down
7 changes: 3 additions & 4 deletions content/install-guides/windows-perf-wpa-plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Windows Performance Analyzer (WPA) plugin

minutes_to_complete: 15

official_docs: https://github.com/arm-developer-tools/windowsperf-wpa-plugin
official_docs: https://gitlab.com/Linaro/WindowsPerf/wpa-plugin

author: Alaaeddine Chakroun

Expand Down Expand Up @@ -83,14 +83,14 @@ Close Windows Performance Analyzer.

You are now ready to install the WPA plugin, which is a single `.dll` file.

Download the `.zip` file from the [Windows Perf WPA plugin GitHub releases page](https://github.com/arm-developer-tools/windowsperf-wpa-plugin/releases) on GitHub.
Download the `.zip` file from the [Windows Perf WPA plugin releases page](https://gitlab.com/Linaro/WindowsPerf/wpa-plugin/-/releases).

Alternatively, you can download the `.zip` file from a command prompt:

```console
mkdir wpa-plugin
cd wpa-plugin
curl -L -O https://github.com/arm-developer-tools/windowsperf-wpa-plugin/releases/download/1.0.3/wpa-plugin-1.0.3.zip
curl -L -O https://gitlab.com/api/v4/projects/50944937/packages/generic/wperf-wpa-plugin/1.0.3/wpa-plugin-1.0.3.zip
```

Extract the `.dll` file from the downloaded `.zip` file.
Expand Down Expand Up @@ -140,4 +140,3 @@ wpa -addsearchdir %USERPROFILE%\Downloads\wpa-plugin-1.0.3 -i %USERPROFILE%\Down
## How do I uninstall the WPA plugin?

To uninstall the plugin, simply delete the `WPAPlugin.dll` file.

30 changes: 15 additions & 15 deletions content/install-guides/wperf.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ additional_search_terms:
minutes_to_complete: 15

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

author: Jason Andrews

Expand All @@ -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 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).
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 [GitLab](https://gitlab.com/Linaro/WindowsPerf/windowsperf/)

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.

Expand All @@ -49,30 +49,30 @@ See also the [Visual Studio for Windows on Arm install guide](/install-guides/vs

## Download WindowsPerf

You can download the latest release package, `windowsperf-bin-<version>.zip` from the Arm GitHub repository:
You can download the latest release package, `windowsperf-bin-<version>.zip` from the Linaro GitLab repository:
```url
https://github.com/arm-developer-tools/windowsperf/releases
https://gitlab.com/Linaro/WindowsPerf/windowsperf/-/releases
```

To download directly from command prompt, use:

```console
mkdir windowsperf-bin-3.8.0
cd windowsperf-bin-3.8.0
curl -L -O https://github.com/arm-developer-tools/windowsperf/releases/download/3.8.0/windowsperf-bin-3.8.0.zip
mkdir windowsperf-bin-4.0.0
cd windowsperf-bin-4.0.0
curl -L -O https://gitlab.com/api/v4/projects/40381146/packages/generic/windowsperf/4.0.0/windowsperf-bin-4.0.0.zip
```

Unzip the package:

```console
tar -xmf windowsperf-bin-3.8.0.zip
tar -xmf windowsperf-bin-4.0.0.zip
```

## Install wperf driver

You can install the kernel driver using the 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.
The [wperf-devgen](https://gitlab.com/Linaro/WindowsPerf/windowsperf/-/tree/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.

{{% notice Note%}}
You must install the driver as `Administrator`.
Expand All @@ -83,7 +83,7 @@ Open a **Windows Command Prompt** terminal with **Run as administrator** selecte
Make sure you are in the `windowsperf-bin-<version>` directory:

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

### Install with wperf-devgen {#devgen_install}
Expand Down Expand Up @@ -123,8 +123,8 @@ 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
wperf 4.0.0 b18197bd +etw-app
wperf-driver 4.0.0 b18197bd +etw-drv

```
## Uninstall wperf driver
Expand All @@ -138,7 +138,7 @@ You must uninstall the driver as `Administrator`.
### Uninstall with wperf-devgen {#devgen_uninstall}

```command
cd windowsperf-bin-3.8.0\wperf-driver
cd windowsperf-bin-4.0.0\wperf-driver
wperf-devgen uninstall
```

Expand All @@ -162,7 +162,7 @@ Install by opening **Extensions** menu, click **Manage Extensions**, and click *
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.
{{% /notice %}}

Also, visit WindowsPerf GUI project website on [GitHub](https://github.com/arm-developer-tools/windowsperf-vs-extension) for more details and latest updates.
Also, visit WindowsPerf GUI project website on [GitLab](https://gitlab.com/Linaro/WindowsPerf/vs-extension) for more details and latest updates.

## Install WindowsPerf VS Code Extension (optional) {#vscode}

Expand All @@ -180,7 +180,7 @@ If using a non-Windows on Arm host, you can import and analyze `WindowsPerf` JSO
You do not need to install `wperf` on non-Windows on Arm devices.
{{% /notice %}}

## Further reading
## Read related resources

### WindowsPerf

Expand Down