CodeXL Quick Start Guide Version 2.6 Revision 1 Table of Contents INTRODUCTION ................................................................................................................... 2 LATEST VERSION OF THIS DOCUMENT ....................................................................... 2 PREREQUISITES ................................................................................................................... 2 DOWNLOAD AND INSTALL CODEXL ............................................................................. 3 CODEXL HELP ....................................................................................................................... 4 SYSTEM INFORMATION .................................................................................................... 4 TEAPOT SAMPLE PROJECT .............................................................................................. 6 Debug the Teapot Sample Application ........................................................................................ 6 Basic Debugging .......................................................................................................................... 7 Source Code View ....................................................................................................................... 8 Breakpoint View ......................................................................................................................... 9 Watch and Locals Views ............................................................................................................ 10 In Host debugging mode .......................................................................................................... 10 Explorer View ............................................................................................................................ 10 Call Stack View .......................................................................................................................... 13 Function Calls History View ....................................................................................................... 14 Debugged Process Events View ................................................................................................. 14 Memory View ........................................................................................................................... 15 Statistics View ........................................................................................................................... 15 PROFILE MODE ................................................................................................................. 16 GPU Profiling ............................................................................................................................. 16 Summary Tab ........................................................................................................................... 17 Performance Counters View .................................................................................................... 18 CodeXL Explorer Tree ............................................................................................................... 19 ANALYZE MODE ................................................................................................................ 20 Static Kernel and Shader Analysis ............................................................................................. 20 Switching to Analyze mode ...................................................................................................... 20 Creating a new project for Analysis ......................................................................................... 21 Working with the new CodeXL Analyzer Explorer Tree ........................................................... 21 Working with Programs ........................................................................................................... 23 Working with Folders ............................................................................................................... 25 Selecting target devices ........................................................................................................... 27 Build Options - defining kernel/shader compilation options ................................................... 28 Output Tab ............................................................................................................................... 30 Statistics Tab ............................................................................................................................ 31 Viewing compilation output: ISA and IL ................................................................................... 32 Navigating through ISA code with the Enhanced ISA View ...................................................... 33 KNOWN ISSUES ................................................................................................................. 34 SUPPORT ............................................................................................................................. 34 Getting Started with CodeXL Introduction CodeXL™ is a tool suite with a unified user interface that lets you harness the benefits of CPUs, GPUs, and APUs. It has powerful capabilities for • APU/GPU debugging, • GPU profiling, • and static OpenCL™/DirectX/OpenGL®/Vulkan kernels and shaders analysis. These features let you find bugs, optimize application performance, and easily access heterogeneous computing. CodeXL source code and released binaries are publically available on GitHub as part of the GPUOpen initiative. CodeXL is available as a stand-alone application for Windows® and Linux® Operating Systems. Getting the most out of the CodeXL tool suite requires a relatively recent AMD APU or GPU, a recent version of Radeon Software, and the OpenCL APP SDK. This document describes how to • get started using CodeXL • find information about known CodeXL issues • contact AMD for support Latest Version of This Document • For the latest and greatest version of the documentation, go to the CodeXL Website. Prerequisites Operating Systems • Microsoft Windows 7 64-bit • Microsoft Windows 8.1 64-bit • Microsoft Windows 10 64-bit • Linux 64-bit (Red Hat, Ubuntu, SUSE) For detailed system requirements see the CodeXL Release Notes in the CodeXL installation folder or on the Documentation section of the CodeXL web page. Profiling OpenCL™ Applications • [GPU device] AMD Adrenaline driver with OpenCL™ GPU support • [GPU device] AMD GCN-based Radeon™ device For detailed system requirements see the CodeXL Release Notes in the CodeXL installation folder or on the Documentation section of the CodeXL web page. Getting Started with CodeXL Download and Install CodeXL Installation is system-specific (Windows or Linux); but once installed and started, the CodeXL operation is system-independent. Download the CodeXL installation package from the CodeXL GitHub repo. For Windows 1. Download the .exe file CodeXL_Win*.exe. 2. When the download completes, double-click the .exe file to install CodeXL. The installer guides you through the installation process. 3. Launch CodeXL from C:\Program Files (x86)\CodeXL\CodeXL.exe or from the created Desktop shortcut. For Linux Either install the dedicated distribution package or use the tar archive. The default installation folder For Red Hat and other Fedora based Linux distributions 1. Download the 64-bit Linux .rpm package CodeXL_Linux*.rpm. 2. If installed version 1. at the machine, remove it first: $ rpm -qa | grep -i codexl $ sudo rpm –e <package name> 3. Install the RPM package: $ sudo rpm -Uvh CodeXL_Linux*.rpm 4. Navigate to /opt/CodeXL_X.Y-ZZZZ/ 5. Launch CodeXL using ./CodeXL. For Ubuntu and other Debian based Linux distributions 1. Download the 64-bit Linux .deb package codexl_*.deb. 2. If installed version 1. at the machine, remove it first: $ dpkg -l |grep -i codexl $ sudo dpkg –r <package name> 3. Install the DEB package: $ sudo dpkg -i codexl_x.x-x_amd64.deb $ sudo apt-get -f install 4. Navigate to /opt/CodeXL_X.Y-ZZZZ/ 5. Launch CodeXL using ./CodeXL. Use the tar archive 1. Download the 64-bit Linux .tar package CodeXL_Linux*.tar.gz. 2. Extract the tar package: a. $ tar –xvzf CodeXL_Linux*.tar.gz 3. Navigate to <codexl-install-dir> Getting Started with CodeXL 4. Launch CodeXL using ./CodeXL. CodeXL Help To bring up a CodeXL Help window: 1. Click on the CodeXLUser Guide link on the CodeXL startup Home Page. OR 2. Select Help >> View Help from the CodeXL toolbar. CodeXL Help provides some of the same information provided in this document, but also includes additional details about CodeXL views and modules. To bring up the CodeXL Help window for the Visual Studio extension: 1. Select CodeXL >> Help >> View Help from the VS menu. System information To display system information: 1. Select Tools >> System Information from the CodeXL toolbar. Getting Started with CodeXL The tabs let you select a category of information. The following screenshot shows OpenCL device information for a GPU device and a CPU device on the runtimes available locally - a 32-bit and 64-bit runtime. To display project settings, the project must be stopped. To edit the settings of a project: 1. Select File >> Project Settings from the drop-down File menu. See the CodeXL Help for more details about project settings. Getting Started with CodeXL Teapot Sample Project The CodeXL distribution includes a sample project that displays a smoking teapot.