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
Copy file name to clipboardExpand all lines: content/install-guides/windows-perf-vs-extension.md
+22-28Lines changed: 22 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,52 +24,46 @@ multi_install: FALSE # Set to true if first page of multi-page article, else fal
24
24
multitool_install_part: false # Set to true if a sub-page of a multi-page article, else false
25
25
layout: installtoolsall # DO NOT MODIFY. Always true for tool install articles
26
26
---
27
-
28
-
## Introduction
29
-
30
-
WindowsPerf is a lightweight performance profiling tool inspired by Linux Perf, and specifically tailored for Windows on Arm. It leverages the ARM64 PMU (Performance Monitor Unit) and its hardware counters to offer precise profiling capabilities.
27
+
[WindowsPerf](https://learn.arm.com/install-guides/wperf/) is a lightweight performance profiling tool inspired by Linux Perf, and specifically tailored for Windows on Arm. It leverages the ARM64 PMU (Performance Monitor Unit) and its hardware counters to offer precise profiling capabilities.
31
28
32
29
Recognizing the complexities of command-line interaction, the WindowsPerf GUI is a Visual Studio 2022 extension created to provide a more intuitive, integrated experience within the integrated development environment (IDE). This tool enables developers to interact with WindowsPerf, adjust settings, and visualize performance data seamlessly in Visual Studio.
33
30
34
-
## A Glimpse of the available features
31
+
## Overview of key features
35
32
36
33
The WindowsPerf GUI extension is composed of several key features, each designed to streamline the user experience:
37
34
38
-
-**WindowsPerf Configuration**: Connect directly to `wperf.exe` for a seamless integration. Configuration is accessible via `Tools -> Options -> Windows Perf -> WindowsPerf Path`.
39
-
-**Host Data**: Understand your environment with `Tools -> WindowsPerf Host Data`, offering insights into tests run by WindowsPerf.
40
-
-**Output Logging**: All commands executed through the GUI are logged, ensuring transparency and aiding in performance analysis.
41
-
-**Sampling UI**: Customize your sampling experience by selecting events, setting frequency and duration, choosing programs for sampling, and comprehensively analyzing results.
35
+
-**WindowsPerf Configuration**: Connect directly to `wperf.exe` for a seamless integration. Configuration is accessible by selecting **Tools > Options > Windows Perf > WindowsPerf Path**.
36
+
-**Host Data**: Understand your environment by selecting **Tools** then **WindowsPerf Host Data**. This offers insights into tests run by WindowsPerf.
37
+
-**Output Logging**: All commands executed through the GUI are logged, ensuring transparency and supporting performance analysis.
38
+
-**Sampling UI**: Customize your sampling experience by selecting events, setting frequency and duration, choosing programs for sampling, and comprehensively analyzing results. See screenshot below.
-**Counting Settings UI**: Build a `wperf stat` command from scratch using the configuration interface, then view the output in the IDE or open it with Windows Performance Analyzer (WPA)
-**Counting Settings UI**: Build a `wperf stat` command from scratch using the configuration interface, then view the output in the IDE or open it with Windows Performance Analyzer (WPA). See screenshot below.
-**Visual Studio 2022**: Ensure you have Visual Studio 2022 installed on your Windows on Arm device.
57
-
-**WindowsPerf**: Download and install WindowsPerf by following the [WindowsPerf install guide](/install-guides/wperf/).
58
-
-**LLVM** (Recommended): You can install the LLVM toolchain by following the [LLVM toolchain for Windows on Arm install guide](/install-guides/llvm-woa).
50
+
Before installing WindowsPerf Visual Studio Extension, check the following:
51
+
1. Ensure Visual Studio 2022 is installed on your Windows on Arm device.
52
+
2. Download and install WindowsPerf by following the [WindowsPerf install guide](/install-guides/wperf/).
53
+
3. (Recommended) You can install the LLVM toolchain by following the [LLVM toolchain for Windows on Arm install guide](/install-guides/llvm-woa).
59
54
60
55
{{% notice llvm-objdump %}}
61
-
The disassembly feature needs to have `llvm-objdump` available at `%PATH%` to work properly.
56
+
Note that the disassembly feature needs to have `llvm-objdump` available at `%PATH%` to work properly.
62
57
{{% /notice %}}
63
58
64
59
### Installation from Visual Studio Extension Manager
65
60
66
61
To install the WindowsPerf Visual Studio Extension from Visual Studio:
67
62
68
-
1. Open Visual Studio 2022
69
-
2. Go to the `Extensions` menu
70
-
3. Select **Manage Extensions**
71
-
4. Click on the search bar ( or tap `Ctrl` + `L` ) and type `WindowsPerf`
72
-
5. Click on the install button and restart Visual Studio
63
+
1. Open Visual Studio 2022.
64
+
2. Go to the **Extensions** menu and select **Manage Extensions**.
65
+
4. Click on the search bar (Ctrl+L) and type `WindowsPerf`.
66
+
5. Click on the **Install** button and restart Visual Studio.
@@ -79,7 +73,7 @@ You can also install the WindowsPerf Visual Studio Extension from GitHub.
79
73
80
74
Download the installation file directly from the [GitHub release page](https://github.com/arm-developer-tools/windowsperf-vs-extension/releases).
81
75
82
-
Unzip the downloaded file and double click on the `WindowsPerfGUI.vsix` file
76
+
Unzip the downloaded file and double click on the `WindowsPerfGUI.vsix` file.
83
77
84
78
{{% notice Note %}}
85
79
Make sure that any previous version of the extension is uninstalled and that Visual Studio is closed before installing the extension.
@@ -93,10 +87,10 @@ Building the source is not required, but offered as an alternative installation
93
87
94
88
### WindowsPerf Setup
95
89
96
-
To get started, you must link the GUI with the executable file `wperf.exe` by navigating to `Tools -> Options -> WindowsPerf -> WindowsPerf Path`. This step is crucial for utilizing the GUI, and the extension will not work if you don't do it.
90
+
To get started, you must link the GUI with the executable file `wperf.exe` by navigating to **Tools > Options > WindowsPerf > WindowsPerf Path**. This step is crucial for utilizing the GUI, and the extension will not work if you don't do it.
97
91
98
92
## Uninstall the WindowsPerfGUI extension
99
93
100
-
In Visual Studio go to `Extensions` -> `Manage Extensions` -> `Installed` -> `All` -> `WindowsPerfGUI` and select "Uninstall".
94
+
In Visual Studio go to **Extensions > Manage Extensions > Installed > All > WindowsPerfGUI** and select **Uninstall**.
101
95
102
-
Please note that this will be scheduled by Visual Studio. You may need to close VS instance and follow uninstall wizard to remove the extension.
96
+
Please note that this will be scheduled by Visual Studio. You may need to close the VS instance and follow the uninstall wizard to remove the extension.
0 commit comments