Skip to content

Commit fefadca

Browse files
Merge pull request #1332 from jasonrandrews/review
review WindowsPerf Visual Code Extension
2 parents 0b368d0 + 4955bd1 commit fefadca

File tree

1 file changed

+31
-23
lines changed

1 file changed

+31
-23
lines changed
Lines changed: 31 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
### Title the install tools article with the name of the tool to be installed
33
### Include vendor name where appropriate
4-
title: WindowsPerf Ecosystem - the Visual Studio Extension
5-
minutes_to_complete: 5
4+
title: WindowsPerf Visual Studio Extension
5+
minutes_to_complete: 10
66

77
official_docs: https://github.com/arm-developer-tools/windowsperf-vs-extension
88

@@ -16,7 +16,6 @@ additional_search_terms:
1616
- windows
1717
- woa
1818
- windows on arm
19-
- open source windows on arm
2019
- visual studio
2120
### FIXED, DO NOT MODIFY
2221
weight: 1 # Defines page ordering. Must be 1 for first (or only) page.
@@ -28,67 +27,76 @@ layout: installtoolsall # DO NOT MODIFY. Always true for tool install articles
2827

2928
## Introduction
3029

31-
**WindowsPerf** is a lightweight performance profiling tool inspired by Linux perf, specifically tailored for Windows on ARM. It leverages the ARM64 PMU (Performance Monitor Unit) and its hardware counters to offer precise profiling capabilities. Recognizing the complexities of command-line interaction, the WindowsPerf GUI project is a Visual Studio 2022 extension that was initiated to provide a more intuitive, integrated within the development environment (IDE) experience. This tool enables developers to interact with WindowsPerf, adjust settings, and visualize performance data seamlessly within the IDE.
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.
31+
32+
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.
3233

3334
## A Glimpse of the available features
3435

3536
The WindowsPerf GUI extension is composed of several key features, each designed to streamline the user experience:
3637

3738
- **WindowsPerf Configuration**: Connect directly to `wperf.exe` for a seamless integration. Configuration is accessible via `Tools -> Options -> Windows Perf -> WindowsPerf Path`.
38-
- **Host Data**: Understand your environment with `Tools -> WindowsPerf Host Data`, offering insights into tests run by WindowsPerf and their outcomes.
39-
- **Output Logging**: All commands executed through the GUI are meticulously logged, ensuring transparency and aiding in performance analysis.
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.
4041
- **Sampling UI**: Customize your sampling experience by selecting events, setting frequency and duration, choosing programs for sampling, and comprehensively analyzing results.
4142

42-
![Sampling preview #center](../_images/wperf-vs-extension-sampling-preview.png)
43-
_Sampling settings UI Overview_
43+
![Sampling preview #center](../_images/wperf-vs-extension-sampling-preview.png "Sampling settings UI Overview")
44+
45+
46+
- **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)
47+
4448

45-
- **Counting Settings UI**: Build a `wperf stat` command from scratch using our configurator, then view the output on the IDE or open it on WPA
49+
![Counting preview #center](../_images/wperf-vs-extension-counting-preview.png "_Counting settings UI Overview_")
4650

47-
![Counting preview #center](../_images/wperf-vs-extension-counting-preview.png)
48-
_Counting settings UI Overview_
4951

5052
## Getting Started
5153

5254
### Prerequisites
5355

5456
- **Visual Studio 2022**: Ensure you have Visual Studio 2022 installed on your Windows on Arm device.
55-
- **WindowsPerf**: Download and install WindowsPerf. You can follow this [learning path](../wperf) for further details
56-
- **LLVM** (Optional): You can install the LLVM toolchain by following this [guide](../llvm-woa).
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).
5759

5860
{{% notice llvm-objdump %}}
5961
The disassembly feature needs to have `llvm-objdump` available at `%PATH%` to work properly.
6062
{{% /notice %}}
6163

62-
### Installation (VS Extension Manager)
64+
### Installation from Visual Studio Extension Manager
6365

64-
To install WindowsPerf Visual Studio Extension you can do that from Visual Studio itself.
66+
To install the WindowsPerf Visual Studio Extension from Visual Studio:
6567

6668
1. Open Visual Studio 2022
67-
2. Go to `Extensions` menu
69+
2. Go to the `Extensions` menu
6870
3. Select **Manage Extensions**
6971
4. Click on the search bar ( or tap `Ctrl` + `L` ) and type `WindowsPerf`
7072
5. Click on the install button and restart Visual Studio
7173

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

74-
### Installation (Option 2)
76+
### Installation from GitHub
7577

76-
To install WindowsPerf Visual Studio Extension you can download the installation file directly from our [GitHub release page](https://github.com/arm-developer-tools/windowsperf-vs-extension/releases).
78+
You can also install the WindowsPerf Visual Studio Extension from GitHub.
79+
80+
Download the installation file directly from the [GitHub release page](https://github.com/arm-developer-tools/windowsperf-vs-extension/releases).
7781

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

8084
{{% notice Note %}}
81-
You need to make sure that any previous version of the extension is uninstalled and that Visual Studio is closed before installing the extension.
85+
Make sure that any previous version of the extension is uninstalled and that Visual Studio is closed before installing the extension.
8286
{{% /notice %}}
8387

8488
### Build from source
8589

86-
For those preferring to build from the source, simply clone [the repository](https://github.com/arm-developer-tools/windowsperf-vs-extension) and build the `WindowsPerfGUI` solution using the default configuration on Visual Studio. This alternative installation method offers flexibility and customization.
90+
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.
91+
92+
Building the source is not required, but offered as an alternative installation method if you want to customize the extension.
8793

8894
### WindowsPerf Setup
8995

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. The extension **will not work** without it!
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.
97+
98+
## Uninstall the WindowsPerfGUI extension
9199

92-
## How to uninstall old WindowsPerfGUI extension
100+
In Visual Studio go to `Extensions` -> `Manage Extensions` -> `Installed` -> `All` -> `WindowsPerfGUI` and select "Uninstall".
93101

94-
In Visual Studio go to `Extensions` -> `Manage Extensions` -> `Installed` -> `All` -> `WindowsPerfGUI` and select "Uninstall". Please note that this will be scheduled by VS. You may need to close VS instance and follow uninstallation wizard to remove extension.
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.

0 commit comments

Comments
 (0)