ARM® DS-5 Streamline User Guide

Version 6.1


Table of Contents

Preface
About this book
Using this book
Glossary
Typographic conventions
Feedback
Other information
1 Target Setup
1.1 Features of Streamline Ultimate, Professional, and Community Editions
1.2 Standards compliance in Streamline
1.3 Streamline prerequisites
1.4 Setup scenarios for Linux targets
1.4.1 Comparison of user space gator and kernel space gator
1.4.2 Validating the target setup
1.4.3 Building and installing user space gator
1.4.4 Building and installing kernel space gator
1.5 Preparing and building your Linux kernel
1.6 Required kernel configuration menu options
1.7 Building the gator daemon
1.8 Building the gator module
1.9 Running the gator daemon on your target
1.10 Connecting to an Android target using Ethernet
1.11 Starting a capture session
1.12 Stopping the gator daemon
1.13 gatord command-line options
1.14 Setting up Streamline to support an ARM® Mali™-based device
1.15 Setting up Streamline to support ARM® Mali™-V500
1.16 Recommended compiler options
2 Streamline Data View
2.1 Streamline Data view
2.2 Streamline Data view toolbar options
2.3 Importing perf data
2.4 Streamline preferences
2.5 Capture color-coding
2.6 Connection Browser dialog box
2.7 Setup Target dialog box
2.8 Analysis Data Locations dialog box options
2.9 Re-analyzing stored Streamline capture data
2.10 Duplicating a capture
3 Capture and Analysis Options
3.1 Capture & Analysis Options dialog box settings
4 Counter Configuration
4.1 Opening the Counter Configuration dialog box
4.2 Counter Configuration dialog box structure
4.3 Adding new events to the Events to Collect list
4.4 Removing events from the Events to Collect list
4.5 Counter Configuration dialog box settings
4.6 Events specific to ARM® Mali™ technology
4.7 Event-based sampling
4.8 Setting up event-based sampling
5 Live View and Timeline View
5.1 Live view overview
5.2 Timeline view overview
5.3 Charts
5.3.1 Default charts
5.3.2 Charts that are specific to ARM® Mali™-based targets
5.3.3 Moving and re-sizing charts
5.3.4 Chart disclosure control
5.3.5 Per-cluster charts
5.3.6 Quick access tooltips
5.3.7 Cross Section Marker
5.3.8 Filtering using the caliper controls
5.4 Chart configuration
5.4.1 Chart configuration panel
5.4.2 Chart configuration toolbar options
5.4.3 Chart configuration series options
5.4.4 Chart configuration templates
5.5 Details panel in the Timeline view
5.5.1 Details panel modes
5.5.2 Heat Map mode
5.5.3 Core Map and Cluster Map modes
5.5.4 Filtering by threads or processes
5.5.5 Selecting the activity source
5.5.6 Samples mode
5.5.7 Processes mode
5.5.8 Images mode
5.5.9 OpenCL mode
5.6 Automatic image transfer in Live view
5.7 Mali Graphics Debugger (MGD) Mode in Live view
5.8 Toolbar options in the Live and Timeline views
5.9 Contextual menu options in the Live and Timeline views
5.10 Keyboard shortcuts in the Live and Timeline views
5.11 Warnings tag
5.12 Counter classes
5.13 Visual Annotation in the Timeline view
6 Table Views: Call Paths and Functions
6.1 Toolbar options in the table views
6.2 Call Paths view contextual menu options
6.3 Functions view contextual menu options
6.4 Keyboard shortcuts in the table views
6.5 Sorting table reports
6.6 Call Paths view column headers
6.7 Functions view column headers
7 Code View
7.1 Code view basics
7.2 Selecting rows in the Code view
7.3 Path prefix substitution in the Code view
7.4 Using the Find field in the Code view
7.5 Code view toolbar options
7.6 Code view keyboard shortcuts
8 Streamline Annotate
8.1 Annotate overview
8.2 Adding string annotations to your code
8.3 Visual Annotate overview
8.4 Adding Visual Annotate to your code
8.5 Kernel annotations
8.6 Annotate macros
8.7 Importing the Streamline_annotate example
9 Log View
9.1 Log view column headers
9.2 Log view filter fields and toolbar options
9.3 Log view contextual menu options
10 Capturing Energy Data
10.1 Energy Probe overview
10.2 Energy Probe requirements
10.3 Shunt resistor selection for Energy Probe
10.4 Setting up Energy Probe
10.5 Adding the caiman application to Streamline
10.6 Updating your firmware
10.7 Energy Probe data in Streamline
10.8 Setting up National Instrument Multifunction Data Acquisition devices (NI DAQ) to capture energy data
11 Advanced gator Customizations
11.1 Capturing data on your target without an Ethernet connection
11.2 Creating a configuration.xml file
11.3 Capturing energy data locally and importing it to a capture
11.4 Using the gator_events_mmapped.c custom counters example
11.5 Creating custom performance counters with kernel space gator
11.6 gator_events functions
11.7 Creating filesystem and ftrace counters
11.8 Attributes for custom, filesystem, and ftrace counters in the events XML file
11.9 Enabling atrace and ttrace annotations
11.10 Getting L2C-310 memory-mapped peripherals working with Streamline
11.11 Profiling the Linux kernel
11.12 Adding support to gatord for a new CPU or perf PMU
11.13 Increasing the memory that is available for Streamline
12 Bare-Metal Support
12.1 Bare-metal support overview
12.2 Configuring barman
12.3 Custom counters
12.3.1 Configuring custom counters
12.3.2 Sampled and nonsampled counters
12.4 Data storage
12.5 Interfacing with barman
12.5.1 Configuration #defines
12.5.2 Annotation #defines
12.5.3 Barman public API
12.5.4 External functions to implement
12.6 Extracting and importing data
13 Troubleshooting Common Streamline Issues
13.1 Troubleshooting target connection issues
13.2 Troubleshooting perf import issues
13.3 Troubleshooting MGD Mode issues
13.4 Troubleshooting report issues
14 Using Streamline on the Command Line
14.1 Opening a Streamline-enabled command prompt or shell
14.2 Streamline command-line options
14.3 Outputting command-line data to a file
14.4 Accessing the Bare-Metal generation mechanism from the command line
Glossary

List of Figures

1-1 Starting a capture session
2-1 Streamline Data view
2-2 Color-coded captures
2-3 Connection Browser in Streamline
2-4 Automatically setting up Streamline on the target
2-5 Analyze dialog box
2-6 Duplicating a capture
3-1 Capture & Analysis Options dialog box
3-2 Symbols loaded icon
4-1 Streamline Data view - Counter Configuration
4-2 Counter Configuration dialog box
4-3 Interface drop-down menu
4-4 Setting up event-based sampling
5-1 Live view
5-2 Dead process in Live view
5-3 Timeline view
5-4 Charts specific to a Mali Midgard-based target
5-5 Moving a chart using the handle control
5-6 Using the chart disclosure control to show per-core data
5-7 Per-cluster charts
5-8 Quick Access tooltip
5-9 Cross Section Marker blurred border
5-10 Using the calipers to filter
5-11 Chart configuration button
5-12 Chart configuration panel
5-13 Filled chart
5-14 Line chart
5-15 Bar chart
5-16 Stacked chart
5-17 Data from series A obstructed by data from series B
5-18 Logarithmic scale
5-19 Series options
5-20 Warning message for a missing counter
5-21 Heat Map mode
5-22 Filtering annotations
5-23 Core Map mode with five cores
5-24 Cluster Map mode with two clusters
5-25 CPU Activity chart with a thread selected in the Heat Map
5-26 Processes focus menu
5-27 Samples mode
5-28 Processes mode
5-29 Images mode
5-30 OpenCL mode
5-31 Time delta between connected commands
5-32 Selecting a command in OpenCL mode
5-33 Zooming out in OpenCL mode
5-34 OpenCL mode tooltip
5-35 Filtering in OpenCL mode
5-36 Specifying a regex in the Live view
5-37 Zoom level drop-down list
5-38 Dark color scheme
5-39 Light color scheme
5-40 Bookmarks
5-41 Warnings tag
5-42 Counter classes
5-43 Visual annotation in the Timeline view
6-1 Multi-level sort
7-1 Code view
7-2 Missing source file
7-3 Path Prefix Substitutions dialog box
7-4 Find field
8-1 Custom Activity Maps
8-2 String annotation overlays
8-3 Visual Annotate in the Timeline view
9-1 Annotations in the Log view
9-2 Log view totals panel
10-1 Energy Probe schematic
10-2 Energy Probe electrical connection example
10-3 Connection to target
10-4 Tool Path field
10-5 Energy Probe data in the Timeline view
10-6 Connections for NI USB-621x
11-1 Sine counter chart
14-1 Functions report generated using report mode
14-2 Timeline view data output to a text file

Release Information

Document History
Issue Date Confidentiality Change
0600-00 30 September 2016 Non-Confidential Update for Streamline version 6.0
0601-00 04 November 2016 Non-Confidential Update for Streamline version 6.1

Non-Confidential Proprietary Notice

This document is protected by copyright and other related rights and the practice or implementation of the information contained in this document may be protected by one or more patents or pending patent applications. No part of this document may be reproduced in any form by any means without the express prior written permission of ARM. No license, express or implied, by estoppel or otherwise to any intellectual property rights is granted by this document unless specifically stated.

Your access to the information in this document is conditional upon your acceptance that you will not use or permit others to use the information for the purposes of determining whether implementations infringe any third party patents.

THIS DOCUMENT IS PROVIDED “AS IS”. ARM PROVIDES NO REPRESENTATIONS AND NO WARRANTIES, EXPRESS, IMPLIED OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY, SATISFACTORY QUALITY, NON-INFRINGEMENT OR FITNESS FOR A PARTICULAR PURPOSE WITH RESPECT TO THE DOCUMENT. For the avoidance of doubt, ARM makes no representation with respect to, and has undertaken no analysis to identify or understand the scope and content of, third party patents, copyrights, trade secrets, or other rights.

This document may include technical inaccuracies or typographical errors.

TO THE EXTENT NOT PROHIBITED BY LAW, IN NO EVENT WILL ARM BE LIABLE FOR ANY DAMAGES, INCLUDING WITHOUT LIMITATION ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE, OR CONSEQUENTIAL DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF ANY USE OF THIS DOCUMENT, EVEN IF ARM HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

This document consists solely of commercial items. You shall be responsible for ensuring that any use, duplication or disclosure of this document complies fully with any relevant export laws and regulations to assure that this document or any portion thereof is not exported, directly or indirectly, in violation of such export laws. Use of the word “partner” in reference to ARM’s customers is not intended to create or refer to any partnership relationship with any other company. ARM may make changes to this document at any time and without notice.

If any of the provisions contained in these terms conflict with any of the provisions of any signed written agreement covering this document with ARM, then the signed written agreement prevails over and supersedes the conflicting provisions of these terms. This document may be translated into other languages for convenience, and you agree that if there is any conflict between the English version of this document and any translation, the terms of the English version of the Agreement shall prevail.

Words and logos marked with ® or ™ are registered trademarks or trademarks of ARM Limited or its affiliates in the EU and/or elsewhere. All rights reserved. Other brands and names mentioned in this document may be the trademarks of their respective owners. Please follow ARM’s trademark usage guidelines at http://www.arm.com/about/trademark-usage-guidelines.php

Copyright © 2016, ARM Limited or its affiliates. All rights reserved.

ARM Limited. Company 02557590 registered in England.

110 Fulbourn Road, Cambridge, England CB1 9NJ.

LES-PRE-20349

Confidentiality Status

This document is Non-Confidential. The right to use, copy and disclose this document may be subject to license restrictions in accordance with the terms of the agreement entered into by ARM and the party that ARM delivered this document to.

Unrestricted Access is an ARM internal classification.

Product Status

The information in this document is Final, that is for a developed product.

Web Address

Non-ConfidentialPDF file icon PDF versionARM 100769_0601_00_en
Copyright © 2016 ARM Limited or its affiliates. All rights reserved.