Skip to content

Commit 9e552b2

Browse files
authored
Merge pull request #2198 from juliegaskin/main
Add Performance Studio Hub for 2025.4 release
2 parents 75ebc42 + ef9d0b6 commit 9e552b2

File tree

5 files changed

+57
-53
lines changed

5 files changed

+57
-53
lines changed

content/install-guides/ams.md

Lines changed: 29 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -37,96 +37,77 @@ test_maintenance: true
3737
test_images:
3838
- ubuntu:latest
3939
---
40-
[Arm Performance Studio](https://developer.arm.com/Tools%20and%20Software/Arm%20Performance%20Studio) is a performance analysis tool suite for Android and Linux application developers.
40+
[Arm Performance Studio](https://developer.arm.com/Tools%20and%20Software/Arm%20Performance%20Studio) is a performance analysis tool suite for Android and Linux application developers
4141

42-
It helps analyze how your game or app performs on production devices, so you can identify issues that affect performance, cause overheating, or drain battery life.
43-
44-
The following table lists the tools and describes their functions:
42+
It comprises of a suite of easy-to-use tools that show you how well your game or app performs on production devices, so that you can identify problems that might cause slow performance, overheat the device, or drain the battery.
4543

4644
| Component | Functionality |
4745
|----------|-------------|
48-
| [Streamline](https://developer.arm.com/Tools%20and%20Software/Streamline%20Performance%20Analyzer) | Captures a performance profile with hardware counter activity from the device. |
49-
| [Performance Advisor](https://developer.arm.com/Tools%20and%20Software/Performance%20Advisor) | Generates an easy-to-read performance summary from an annotated Streamline capture, and provides actionable optimization suggestions. |
50-
| [Frame Advisor](https://developer.arm.com/Tools%20and%20Software/Frame%20Advisor) | Captures API calls and rendering details from a specific frame and provides detailed geometry metrics to help identify rendering bottlenecks. |
51-
| [Mali Offline Compiler](https://developer.arm.com/Tools%20and%20Software/Mali%20Offline%20Compiler) | Analyzes how efficiently your shader programs perform on a range of Mali GPUs. |
52-
| [RenderDoc for Arm GPUs](https://developer.arm.com/Tools%20and%20Software/RenderDoc%20for%20Arm%20GPUs) | Debugs Vulkan graphics applications with support for Arm GPU extensions and Android features. |
46+
| [Streamline](https://developer.arm.com/Tools%20and%20Software/Streamline%20Performance%20Analyzer) with [Performance Advisor](https://developer.arm.com/Tools%20and%20Software/Performance%20Advisor)| Capture a performance profile that shows all the performance counter activity from the device. Generate an easy-to-read performance summary from an annotated Streamline capture, and get actionable advice about where you should optimize. |
47+
| [Frame Advisor](https://developer.arm.com/Tools%20and%20Software/Frame%20Advisor) | Capture the API calls and rendering from a problem frame and get comprehensive geometry metrics to discover what might be slowing down your application. |
48+
| [Mali Offline Compiler](https://developer.arm.com/Tools%20and%20Software/Mali%20Offline%20Compiler) | Analyze how efficiently your shader programs perform on a range of Mali GPUs. |
49+
| [RenderDoc for Arm GPUs](https://developer.arm.com/Tools%20and%20Software/RenderDoc%20for%20Arm%20GPUs) | The industry-standard tool for debugging Vulkan graphics applications, including early support for Arm GPU extensions and Android features. |
5350

5451

55-
All features of Arm Performance Studio are available free of charge without a license.
52+
All features of Arm Performance Studio are available free of charge without any additional license.
5653

57-
## How do I install Arm Performance Studio?
54+
## Download Arm Performance Studio
5855

5956
Arm Performance Studio is supported on Windows, Linux, and macOS hosts. Download the appropriate installer from [Arm Performance Studio Downloads](https://developer.arm.com/Tools%20and%20Software/Arm%20Performance%20Studio#Downloads).
6057

6158
Full details about the supported OS and Android versions are given in the Arm Performance Studio [Release Notes](https://developer.arm.com/documentation/107649).
6259

63-
### How do I install Arm Performance Studio on Windows?
64-
65-
Run the downloaded `Arm_Performance_Studio_<version>_windows_x86-64.exe` installer, and follow the on-screen instructions.
66-
67-
To open Streamline, Frame Advisor, or RenderDoc for Arm GPUs, go to the Windows **Start** menu and search for the name of the tool you want to open.
68-
69-
Performance Advisor is a feature of the Streamline command-line application. To generate a performance report, you must first run the provided Python script to enable Streamline to collect frame data from the device. [Get started with Performance Advisor tutorial](https://developer.arm.com/documentation/102478/latest) describes this process in detail. After you have captured a profile with Streamline, run `Streamline-cli` on the Streamline capture file. This command is added to your `PATH` environment variable during installation, so it can be used from anywhere.
60+
## How do I install Arm Performance Studio on Windows
7061

71-
```console
72-
Streamline-cli.exe -pa <options> my_capture.apc
73-
```
74-
75-
To run Mali Offline Compiler, open a command terminal, navigate to your work directory, and run the `malioc` command on a shader program. The malioc command is added to your `PATH` environment variable during installation, so it can be used from anywhere.
62+
Arm Performance Studio is provided as an installer executable. Double-click the `.exe` file and follow the instructions in the setup wizard.
7663

77-
```console
78-
malioc.exe <options> my_shader.frag
79-
```
64+
Open the Performance Studio Hub from the **Windows Start** menu, or by double-clicking the shortcut in the installation directory. You can read a description of the tools and launch them from the Hub.
8065

81-
### How do I install Arm Performance Studio on macOS?
66+
### How do I install Arm Performance Studio on macOS
8267

8368
Arm Performance Studio is provided as a `.dmg` package. To mount it, double-click the `.dmg` package and follow the instructions. The Arm Performance Studio directory tree is copied to the Applications directory on your local file system for easy access.
8469

85-
You can remove write permission from the installation directory to prevent other users from writing to it. This is done with the `chmod` command. For example:
70+
Arm recommends that you set the permissions for the installation directory to prevent other users from writing to it. This is typically achieved with the `chmod` command. For example,
8671

8772
```
8873
chmod go-w <dest_dir>
8974
```
9075

91-
Open Streamline, Frame Advisor or RenderDoc for Arm GPUs directly from the Arm Performance Studio directory in your Applications directory. For example, to open Streamline, go to the `<installation_directory>/streamline` directory and open the `Streamline.app` file.
76+
To get started, navigate to the Arm Performance Studio installation directory in your `Applications` directory. Open the `Performance Studio.app` file to launch the **Arm Performance Studio Hub**. You can read a description of the tools and launch them from the Hub.
9277

93-
To run Performance Advisor, go to the `<installation_directory>/streamline` directory, and double-click the `Streamline-cli-launcher` file. Your computer will ask you to allow Streamline to control the Terminal application. Allow this. The Performance Advisor launcher opens the Terminal application and updates your `PATH` environment variable so you can run Performance Advisor from any directory.
78+
### Install Arm Performance Studio on Linux
9479

95-
Performance Advisor is a feature of the Streamline command-line application. To generate a performance report, you must first run the provided Python script to enable Streamline to collect frame data from the device. This process is described in detail in the [Get started with Performance Advisor tutorial](https://developer.arm.com/documentation/102478/latest). After you have captured a profile with Streamline, run the `Streamline-cli` command on the Streamline capture file to generate a performance report:
80+
Arm Performance Studio is provided as a gzipped tar archive. Extract this tar archive to your preferred location, using a recent version (1.13 or later) of GNU tar:
9681

9782
```
98-
Streamline-cli -pa <options> my_capture.apc
83+
tar xvzf Arm_Performance_Studio_2025.1_linux.tgz
9984
```
10085

101-
To run Mali Offline Compiler, go to the `<installation_directory>/mali_offline_compiler` directory, and double-click the `mali_offline_compiler_launcher` file. The Mali Offline Compiler launcher opens the Terminal application and updates your `PATH` environment variable so you can run the `malioc` command from any directory. To generate a shader analysis report, run the `malioc` command on a shader program:
86+
Arm recommends that you set the permissions for the installation directory to prevent other users from writing to it. This is typically achieved with the `chmod` command. For example:
10287

10388
```
104-
malioc <options> my_shader.frag
89+
chmod go-w <dest_dir>
10590
```
10691

107-
On some versions of macOS, you might see a message that Mali Offline Compiler is not recognized as an application from an identified developer. To enable Mali Offline Compiler, cancel this message, then open **System Preferences > Security & Privacy** and select **Allow Anyway** for the `malioc` application.
108-
109-
### How do I install Arm Performance Studio on Linux?
110-
111-
Arm Performance Studio is provided as a gzipped tar archive. Extract this tar archive to your preferred location, using version 1.13 or later of GNU tar:
92+
{{% notice Tip %}}
93+
You might find it useful to edit your `PATH` environment variable to add the paths to the `Streamline-cli` and `malioc` executables so that you can run them from any directory. Add the following commands to the .bashrc file in your home directory, so that they are set whenever you initialize a shell session:
11294

11395
```
114-
tar xvzf Arm_Performance_Studio_<version>_linux.tgz
96+
PATH=$PATH:/<installation_directory>/streamline
97+
PATH=$PATH:/<installation_directory>/mali_offline_compiler
11598
```
11699

117-
You can remove write permission from the installation directory to prevent other users from writing to it. This is done with the `chmod` command. For example:
100+
{{% /notice %}}
118101

119-
```
120-
chmod go-w <dest_dir>
121-
```
102+
Inside the installation directory is a shortcut called **Performance Studio**. Double-click on the shortcut to launch the Performance Studio Hub. You can read a description of the tools and launch them from the Hub.
122103

123-
You might find it useful to edit your `PATH` environment variable to add the paths to the `Streamline-cli` and `malioc` executables so that you can run them from any directory. Add the following commands to the .bashrc file in your home directory, so that they are set whenever you initialize a shell session:
104+
Alternatively, to open Streamline, Frame Advisor or RenderDoc for Arm GPUs directly, go to the installation directory, open the folder for the tool you want to open and run the application file. For example:
124105

125106
```
126-
PATH=$PATH:<installation_directory>/streamline
127-
PATH=$PATH:<installation_directory>/mali_offline_compiler
107+
cd <installation_directory>/streamline
108+
./Streamline
128109
```
129110

130111
## How do I get started with Arm Performance Studio?
131112

132-
Refer to [Get started with Arm Performance Studio](/learning-paths/mobile-graphics-and-gaming/ams/) for an overview of how to run each tool in Arm Performance Studio.
113+
See the [Get started with Arm Performance Studio](/learning-paths/mobile-graphics-and-gaming/ams/) learning path for an overview of how to run each tool in Arm Performance Studio.

content/learning-paths/mobile-graphics-and-gaming/ams/ams.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,26 @@ weight: 2 # 1 is first, 2 is second, etc.
77
# Do not modify these elements
88
layout: "learningpathall"
99
---
10-
[Arm Performance Studio](https://developer.arm.com/Tools%20and%20Software/Arm%20Mobile%20Studio) (formerly known as Arm Mobile Studio) is a performance analysis tool suite for developers to performance test their applications on devices with Mali-based GPUs. It consists of 5 easy-to-use tools that show you how well your application performs either on off-the-shelf Android devices, or Linux targets. The tools help you to identify problems that might slow down performance, overheat the device, or drain the battery.
10+
[Arm Performance Studio](https://developer.arm.com/Tools%20and%20Software/Arm%20Performance%20Studio) is a performance analysis tool suite for developers to performance test their applications on devices with Mali-based GPUs. It consists of 4 easy-to-use tools that show you how well your application performs either on off-the-shelf Android devices, or Linux targets. The tools help you to identify problems that might slow down performance, overheat the device, or drain the battery.
1111

1212
| Component | Functionality |
1313
|----------|-------------|
14-
| [Streamline](https://developer.arm.com/Tools%20and%20Software/Streamline%20Performance%20Analyzer) | Capture a performance profile that shows all the performance counter activity from the device. |
15-
| [Performance Advisor](https://developer.arm.com/Tools%20and%20Software/Performance%20Advisor) | Generate an easy-to-read performance summary from an annotated Streamline capture, and get actionable advice about where you should optimize. |
14+
| [Streamline](https://developer.arm.com/Tools%20and%20Software/Streamline%20Performance%20Analyzer) with [Performance Advisor](https://developer.arm.com/Tools%20and%20Software/Performance%20Advisor) | Capture a performance profile that shows all the performance counter activity from the device. Generate an easy-to-read performance summary from an annotated Streamline capture, and get actionable advice about where you should optimize. |
1615
| [Frame Advisor](https://developer.arm.com/Tools%20and%20Software/Frame%20Advisor) | Capture the API calls and rendering from a problem frame and get comprehensive geometry metrics to discover what might be slowing down your application. |
1716
| [Mali Offline Compiler](https://developer.arm.com/Tools%20and%20Software/Mali%20Offline%20Compiler) | Analyze how efficiently your shader programs perform on a range of Mali GPUs. |
1817
| [RenderDoc for Arm GPUs](https://developer.arm.com/Tools%20and%20Software/RenderDoc%20for%20Arm%20GPUs) | The industry-standard tool for debugging Vulkan graphics applications, including early support for Arm GPU extensions and Android features. |
1918

20-
Arm Performance Studio is supported on Windows, Linux, and macOS hosts.
19+
## Download and Install Arm Performance Studio
20+
21+
Arm Performance Studio is supported on Windows, Linux, and macOS hosts. Get the installation package [here](https://developer.arm.com/Tools%20and%20Software/Arm%20Performance%20Studio#Downloads).
2122

2223
Refer to the [Arm Performance Studio install guide](/install-guides/ams/) for installation instructions.
24+
25+
## Launch the tools
26+
27+
To open the tools, launch the Performance Studio Hub:
28+
29+
- On Windows, search for Performance Studio.
30+
- On macOS and Linux, open the Performance Studio application file from the install directory.
31+
32+
![Performance Studio Hub](images/ps_Hub.png)

content/learning-paths/mobile-graphics-and-gaming/ams/fa.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,13 @@ Build your application, and setup the Android device as described in [Setup task
1515

1616
## Connect to the device
1717

18-
1. Open Frame Advisor and select `New trace` to start a new trace.
18+
1. Launch the Performance Studio Hub and open Frame Advisor.
19+
- On Windows, search for Performance Studio.
20+
- On macOS and Linux, open the Performance Studio application file from the install directory.
21+
22+
![Performance Studio Hub](images/ps_Hub.png)
23+
24+
1. Select `New trace` to start a new trace.
1925

2026
![Frame Advisor launch screen](images/fa_launch_screen.png)
2127

300 KB
Loading

content/learning-paths/mobile-graphics-and-gaming/ams/streamline.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,13 @@ Now that you have seen an [Arm Streamline example capture](/learning-paths/mobil
1111

1212
## Select the device and application in Streamline
1313

14+
1. Launch the Performance Studio Hub and open Streamline.
15+
16+
- On Windows, search for Performance Studio.
17+
- On macOS and Linux, open the Performance Studio application file from the install directory.
18+
19+
![Performance Studio Hub](images/ps_Hub.png)
20+
1421
1. In the Streamline `Start` view, select `Android (adb)` as your device type, then select your device from the list of detected devices. This installs the `gatord` daemon and connects to the device.
1522

1623
1. Wait for the list of available packages to populate, then select the one you wish to profile.

0 commit comments

Comments
 (0)