Skip to content

Commit eb0d427

Browse files
Merge pull request #1820 from juliegaskin/main
Update APS LP and install guide
2 parents 1fcd6b4 + 86f6483 commit eb0d427

File tree

18 files changed

+291
-85
lines changed

18 files changed

+291
-85
lines changed

content/install-guides/ams.md

Lines changed: 93 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ additional_search_terms:
1212
- mali
1313
- immortalis
1414
- cortex-a
15+
- Install Arm Mobile Studio
1516

1617

1718
### Estimated completion time in minutes (please use integer multiple of 5)
@@ -32,41 +33,117 @@ test_maintenance: true
3233
test_images:
3334
- ubuntu:latest
3435
---
35-
[Arm Performance Studio](https://developer.arm.com/Tools%20and%20Software/Arm%20Performance%20Studio%20for%20Mobile) (formally known as `Arm Mobile Studio`) is a performance analysis tool suite for various application developers:
36-
37-
* Android application developers
38-
* Linux application developers in Embedded and Cloud segments
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
3937

4038
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.
4139

42-
[Frame Advisor](https://developer.arm.com/Tools%20and%20Software/Frame%20Advisor) is available in `2023.5` and later.
43-
44-
[RenderDoc for Arm GPUs](https://community.arm.com/arm-community-blogs/b/graphics-gaming-and-vr-blog/posts/beyond-mobile-arm-mobile-studio-is-now-arm-performance-studio) is available in `2024.0` and later.
40+
| Component | Functionality |
41+
|----------|-------------|
42+
| [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. |
43+
| [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. |
44+
| [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. |
45+
| [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. |
46+
| [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. |
4547

46-
[Graphics Analyzer](https://developer.arm.com/Tools%20and%20Software/Graphics%20Analyzer) is no longer provided. The final release was provided in the `2024.2` release.
4748

48-
All features of Arm Performance Studio are available free of charge without any additional license as of the `2022.4` release.
49+
All features of Arm Performance Studio are available free of charge without any additional license.
4950

5051
## How do I install Arm Performance Studio?
5152

5253
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).
5354

54-
Full installation and application launch instructions are given in the Arm Performance Studio [Release Notes](https://developer.arm.com/documentation/107649).
55+
Full details about the supported OS and Android versions are given in the Arm Performance Studio [Release Notes](https://developer.arm.com/documentation/107649).
5556

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

58-
Run the supplied `Arm_Performance_Studio_<version>_windows_x86-64.exe` installer, and follow on-screen instructions.
59+
Run the supplied `Arm_Performance_Studio_<version>_windows_x86-64.exe` installer, and follow the on-screen instructions.
60+
61+
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.
62+
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+
65+
```console
66+
Streamline-cli.exe -pa <options> my_capture.apc
67+
```
68+
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+
71+
```console
72+
malioc.exe <options> my_shader.frag
73+
```
74+
75+
### macOS
76+
77+
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.
78+
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+
81+
```
82+
chmod go-w <dest_dir>
83+
```
84+
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+
87+
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.
88+
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+
91+
```
92+
Streamline-cli -pa <options> my_capture.apc
93+
```
94+
95+
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:
96+
97+
```
98+
malioc <options> my_shader.frag
99+
```
100+
101+
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 and Privacy** and select **Allow Anyway** for the `malioc` application.
59102

60103
### How do I install Arm Performance Studio on Linux?
61104

62-
Unpack the supplied `Arm Performance Studio` bundle to the desired location. For example:
63-
```console
64-
tar -xf Arm_Performance_Studio_2024.3_linux_x86-64.tgz
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+
107+
```
108+
tar xvzf Arm_Performance_Studio_2025.1_linux.tgz
109+
```
110+
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+
65113
```
114+
chmod go-w <dest_dir>
115+
```
116+
117+
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:
118+
119+
```
120+
PATH=$PATH:/<installation_directory>/streamline
121+
PATH=$PATH:/<installation_directory>/mali_offline_compiler
122+
```
123+
66124
### How do I install Arm Performance Studio on macOS?
67125

68-
Run the supplied `Arm_Performance_Studio_<version>_macos_x86-64.dmg` installer, and follow on-screen instructions.
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
145+
```
69146

70147
## How do I get started with Arm Performance Studio?
71148

72-
See the [Get started with Arm Performance Studio for Mobile](/learning-paths/mobile-graphics-and-gaming/ams/) learning path for a collection of tutorials for each component of Performance Studio.
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.

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

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Get started with Arm Performance Studio for mobile
2+
title: Get started with Arm Performance Studio
33

44
description: Learn how to use each of the tools supplied with Arm Performance Studio (formerly known as Arm Mobile Studio).
55

@@ -12,10 +12,12 @@ learning_objectives:
1212
- Get started profiling and optimizing your application.
1313

1414
prerequisites:
15-
- An appropriate Android device. These [devices](https://developer.arm.com/Tools%20and%20Software/Arm%20Mobile%20Studio#Supported-Devices) have been tested internally within Arm, and confirmed to work with Arm Performance Studio.
16-
- Arm Performance Studio supports applications built with OpenGL ES versions 2.0 to 3.2, or Vulkan versions 1.0 to 1.2. For OpenGL ES applications, your device must be running Android 10 or later. For Vulkan applications, your device must be running Android 9 or later.
15+
- An Android device.
16+
- Arm Performance Studio supports applications built with OpenGL ES versions 2.0 to 3.2, or Vulkan versions 1.0 to 1.2.
17+
- For OpenGL ES applications, your device must be running Android 10 or later.
18+
- For Vulkan applications, your device must be running Android 9 or later.
1719
- A debuggable build of your application.
18-
- Download and install Arm Performance Studio from [Product Download Hub](https://developer.arm.com/downloads/view/MOBST-PRO0). It is supported on Windows, Linux, and macOS host platforms.
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.
1921
- 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).
2022

2123
author: Ronan Synnott
@@ -44,9 +46,9 @@ further_reading:
4446
link: https://developer.arm.com/documentation/102478
4547
type: documentation
4648
- resource:
47-
title: Graphics Analyzer video tutorial
48-
link: https://www.youtube.com/watch?v=6j68rtcTYRc
49-
type: website
49+
title: Frame Advisor video tutorial
50+
link: https://developer.arm.com/Additional%20Resources/Video%20Tutorials/Capture%20and%20analyze%20a%20problem%20frame%20with%20Frame%20Advisor
51+
type: video
5052
- resource:
5153
title: Get started with Mali Offline Compiler Tutorial
5254
link: https://developer.arm.com/documentation/102468

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ layout: "learningpathall"
1414
| [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. |
1515
| [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. |
1616
| [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. |
17-
| [Graphics Analyzer](https://developer.arm.com/Tools%20and%20Software/Graphics%20Analyzer) | Analyze OpenGL ES and Vulkan API calls in your application, to identify rendering defects and investigate problem scenes. |
1817
| [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. |
19-
| [RenderDoc for Arm GPUs](https://renderdoc.org) | The industry-standard tool for debugging Vulkan graphics applications, including early support for Arm GPU extensions and Android features. |
18+
| [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. |
2019

2120
Arm Performance Studio is supported on Windows, Linux, and macOS hosts. See the [Install Guide](/install-guides/ams) for installation instructions.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ weight: 8 # 1 is first, 2 is second, etc.
77
# Do not modify these elements
88
layout: "learningpathall"
99
---
10-
[Frame Advisor](https://developer.arm.com/Tools%20and%20Software/Frame%20Advisor) is a developer tool designed to offer in-depth frame-based analysis for mobile graphics in Android applications. By capturing the API calls and rendering processes of a specific frame, you can identify potential performance bottlenecks that may be causing slowdowns in your application.
10+
[Frame Advisor](https://developer.arm.com/Tools%20and%20Software/Frame%20Advisor) offers in-depth frame-based analysis for mobile graphics in Android applications. By capturing the API calls and rendering processes of a specific frame, you can identify potential performance bottlenecks that may be causing slowdowns in your application.
1111

1212
## Prerequisites
1313

14-
Build your application, and setup the Android device as described in the [Streamline](/learning-paths/mobile-graphics-and-gaming/ams/streamline/) instructions.
14+
Build your application, and setup the Android device as described in [Setup tasks](/learning-paths/mobile-graphics-and-gaming/ams/setup_tasks/).
1515

1616
## Connect to the device
1717

18-
1. When Frame Advisor opens, select `New trace` to start a new trace.
18+
1. Open Frame Advisor and select `New trace` to start a new trace.
1919

2020
![Frame Advisor launch screen](images/fa_launch_screen.png)
2121

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

Lines changed: 0 additions & 43 deletions
This file was deleted.
Loading
Loading
Loading
Loading

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,29 @@ layout: "learningpathall"
99
---
1010
Mali Offline Compiler is a command-line tool that you can use to compile all shaders and kernels from OpenGL ES and Vulkan, and generate a performance report for the GPU of interest.
1111

12+
In a terminal, test that Mali Offline Compiler is installed correctly, by typing:
13+
14+
```
15+
malioc --help
16+
```
17+
18+
The `--help` option returns usage instructions and the full list of available options for the malioc command.
19+
Note
20+
21+
{{% notice %}}
22+
On macOS, Mali Offline Compiler might not be recognised as an application from an identified developer. To enable Mali Offline Compiler, open **System Preferences > Security & Privacy**, and select **Allow Anyway** for the `malioc` item.
23+
{{% /notice %}}
24+
1225
## Supported GPUs
1326

1427
To see the full list of [supported GPUs](https://developer.arm.com/documentation/101863/latest/Platform-support/GPU-support) use:
28+
1529
```console
1630
malioc --list
1731
```
32+
1833
To get information on [API support](https://developer.arm.com/documentation/101863/latest/Platform-support/API-support) for a given GPU, use:
34+
1935
```console
2036
malioc --info --core <GPU_name>
2137
```

0 commit comments

Comments
 (0)