Skip to content

Commit 8756d27

Browse files
Merge pull request #1897 from jasonrandrews/review
Review Arm Performance Studio updates
2 parents eb0d427 + aac3420 commit 8756d27

File tree

4 files changed

+29
-49
lines changed

4 files changed

+29
-49
lines changed

content/install-guides/ams.md

Lines changed: 22 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,10 @@ test_maintenance: true
3333
test_images:
3434
- ubuntu:latest
3535
---
36-
[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
36+
[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.
37+
38+
It comprises 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 devices, or drain the battery.
3739

38-
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.
3940

4041
| Component | Functionality |
4142
|----------|-------------|
@@ -56,37 +57,37 @@ Full details about the supported OS and Android versions are given in the Arm Pe
5657

5758
### How do I install Arm Performance Studio on Windows?
5859

59-
Run the supplied `Arm_Performance_Studio_<version>_windows_x86-64.exe` installer, and follow the on-screen instructions.
60+
Run the downloaded `Arm_Performance_Studio_<version>_windows_x86-64.exe` installer, and follow the on-screen instructions.
6061

6162
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.
6263

63-
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 -pa` command on the Streamline capture file. This command is added to your `PATH` environment variable during installation, so it can be used from anywhere.
64+
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 `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.
6465

65-
```console
66-
Streamline-cli.exe -pa <options> my_capture.apc
67-
```
66+
```console
67+
Streamline-cli.exe -pa <options> my_capture.apc
68+
```
6869

69-
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 can be used from anywhere
70+
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.
7071

71-
```console
72-
malioc.exe <options> my_shader.frag
73-
```
72+
```console
73+
malioc.exe <options> my_shader.frag
74+
```
7475

75-
### macOS
76+
### How do I install Arm Performance Studio on macOS?
7677

7778
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.
7879

79-
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,
80+
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:
8081

8182
```
8283
chmod go-w <dest_dir>
8384
```
8485

85-
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.
86+
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.
8687

8788
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.
8889

89-
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) tutorial. After you have captured a profile with Streamline, run the `Streamline-cli -pa` command on the Streamline capture file to generate a performance report:
90+
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:
9091

9192
```
9293
Streamline-cli -pa <options> my_capture.apc
@@ -102,13 +103,13 @@ On some versions of macOS, you might see a message that Mali Offline Compiler is
102103

103104
### How do I install Arm Performance Studio on Linux?
104105

105-
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:
106+
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:
106107

107108
```
108-
tar xvzf Arm_Performance_Studio_2025.1_linux.tgz
109+
tar xvzf Arm_Performance_Studio_<version>_linux.tgz
109110
```
110111

111-
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:
112+
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:
112113

113114
```
114115
chmod go-w <dest_dir>
@@ -117,33 +118,10 @@ chmod go-w <dest_dir>
117118
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:
118119

119120
```
120-
PATH=$PATH:/<installation_directory>/streamline
121-
PATH=$PATH:/<installation_directory>/mali_offline_compiler
122-
```
123-
124-
### How do I install Arm Performance Studio on macOS?
125-
126-
To open Streamline, Frame Advisor or RenderDoc for Arm GPUs, go to the installation directory, open the folder for the tool you want to open and run the application file. For example:
127-
128-
```
129-
cd <installation_directory>/streamline
130-
./Streamline
131-
```
132-
133-
Performance Advisor is a feature of the Streamline command-line application. To use it 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. After you have captured a profile with Streamline, go to the `installation_directory>/streamline` directory and run the `Streamline-cli -pa` command on the Streamline capture file to generate a performance report:
134-
135-
```
136-
cd <installation_directory>/performance_advisor
137-
./Streamline-cli -pa <options> my_capture.apc
138-
```
139-
140-
To run Mali Offline Compiler, go to the `installation_directory>/mali_offline_compiler` directory and run the `malioc` command on a shader program:
141-
142-
```
143-
cd <installation_directory>/mali_offline_compiler
144-
./malioc <options> my_shader.frag
121+
PATH=$PATH:<installation_directory>/streamline
122+
PATH=$PATH:<installation_directory>/mali_offline_compiler
145123
```
146124

147125
## How do I get started with Arm Performance Studio?
148126

149-
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.
127+
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.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ prerequisites:
1717
- For OpenGL ES applications, your device must be running Android 10 or later.
1818
- For Vulkan applications, your device must be running Android 9 or later.
1919
- A debuggable build of your application.
20-
- Download [Arm Performance Studio](https://developer.arm.com/Tools%20and%20Software/Arm%20Performance%20Studio#Downloads) and install it, following the [Install Guide](/install-guides/ams). It is supported on Windows, Linux, and macOS host platforms.
21-
- Download and install [Android SDK Platform tools](https://developer.android.com/studio/releases/platform-tools.html). Required for [Android Debug bridge (adb)](https://developer.android.com/studio/command-line/adb).
20+
- Arm Performance Studio installed. Follow the [Arm Performance Studio install guide](/install-guides/ams) for instructions.
21+
- Android SDK Platform tools installed. Required for the Android Debug bridge (adb).
2222

2323
author: Ronan Synnott
2424

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ 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 comprises 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.
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.
1111

1212
| Component | Functionality |
1313
|----------|-------------|
@@ -17,4 +17,6 @@ layout: "learningpathall"
1717
| [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. |
1818
| [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. |
1919

20-
Arm Performance Studio is supported on Windows, Linux, and macOS hosts. See the [Install Guide](/install-guides/ams) for installation instructions.
20+
Arm Performance Studio is supported on Windows, Linux, and macOS hosts.
21+
22+
Refer to the [Arm Performance Studio install guide](/install-guides/ams/) for installation instructions.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ layout: "learningpathall"
99
---
1010
## Installation
1111

12-
1. [Download Arm Performance Studio](https://developer.arm.com/Tools%20and%20Software/Arm%20Performance%20Studio#Downloads) and follow the installation instructions in the [Install Guide](/install-guides/ams). Details about changes since the last release can be found in the [Release Note](https://developer.arm.com/documentation/107649/latest/).
12+
1. Install Arm Performance Studio by follwing the instructions in the [Arm Performance Studio install guide](/install-guides/ams). Details about changes since the last release can be found in the [Release Note](https://developer.arm.com/documentation/107649/latest/).
1313
1. Ensure you have installed [Android Debug Bridge (adb)](https://developer.android.com/studio/command-line/adb). `adb` is available with the Android SDK platform tools, which are installed as part of Android Studio. Alternatively, you can download them separately as part of the Android SDK platform tools.
1414
1. Performance Advisor uses a Python script to connect to your device. To run this script, you will need [Python](https://www.python.org/downloads/) 3.8 or later installed.
1515

0 commit comments

Comments
 (0)