Skip to content

Latest commit

 

History

History
executable file
·
115 lines (93 loc) · 7.33 KB

BUILD.md

File metadata and controls

executable file
·
115 lines (93 loc) · 7.33 KB
Raw

CodeXL build instructions

Windows

Installations

Building CodeXL

  • Open the following solution in Visual Studio: CodeXL\AllProjectsBuild\CodeXL-AllProjects.sln
  • Build 64 bit configuration
  • Build 32 bit configuration

CodeXL property sheets

  • Most of project configurations are defined in dedicated property sheets
  • In order to alter windows SDK installation directory use "Global-WindowsSDK" property sheet and change user macro "WindowsSDKDir"

Linux

  • CodeXL uses the SCons build system on Linux.
  • CodeXL require GCC version 4.8.5 or higher.

Building on Ubuntu 15.04 or higher

  • sudo apt-get install gcc-multilib g++-multilib
  • sudo apt-get install libglu1-mesa-dev mesa-common-dev libgtk2.0-dev
  • sudo apt-get install zlib1g-dev libx11-dev:i386
  • sudo apt-get install scons
  • sudo apt-get install libjpeg9-dev
  • sudo apt-get install libfltk1.3-dev
Ubuntu 16.04 specific
  • sudo apt-get install libboost-all-dev

Go to the Building the JAVA Agent section

Building on CENTOS 7.X

Install SCons
  • wget http://prdownloads.sourceforge.net/scons/scons-2.5.0-1.noarch.rpm
  • sudo rpm -ivh scons-2.5.0-1.noarch.rpm
Install additional dependencies
  • sudo yum install libX11-devel mesa-libGL-devel mesa-libGLU-devel
  • sudo yum install zlib-devel gtk2-devel libpng12
  • sudo yum install fltk-devel libjpeg-turbo-devel
Install x86 dependencies
  • yum -y install glibc-devel.i686 libstdc++-static.i686

Building the JAVA Agent:

  • Install Java JDK (version 1.7.x or higher) from Linux distribution (for example: sudo yum install java-1.8.0-openjdk-devel \ sudo apt-get install openjdk-8-jdk-headless).
  • Or download and install latest JDK for linux Oracle site: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
  • Before build please define JAVA_HOME variable for example : export JAVA_HOME=/opt/java/jdk1.8.0_77
  • If JAVA_HOME variable is not defined the build will skip the Java agent project.

Building the HSA/ROCm Profiler

  • In order to build the HSA/ROCm profiler, the rocm-dev package needs to be installed (so that the ROCR header files are available at build time).
  • The ROCm packages are available at https://github.com/RadeonOpenCompute. Please see the ROCm install instructions at https://radeonopencompute.github.io/install.html. To build CodeXL, only the rocm-dev package is needed. In order to run and profile HSA/ROCm applications, the rocm package is needed.
  • If the ROCR header files are not available on the build system, you can skip this part of the build. See the Build Switches section below for information on how to do this.

Building CodeXL

  • CD to local copy of /CodeXL/Util/linux/
  • Run ./buildCodeXLFullLinuxProjects
  • CD to local copy of /CodeXL/Components/GpuProfiling/Build
  • Run ./backend_build.sh

Build Switches

  • all SCons general switches, like -c for clean , more info at http://scons.org/doc/HTML/scons-man.html
  • -j specify the number of concurrent jobs (-j6).
  • CXL_build=[debug|release] - build type. If not stated default value is release.
  • CXL_build_verbose=1 - verbose output
  • CXL_boost_lib_dir=[path to boost libraries] - override the bundled boost libraries with files in given path
  • CXL_boost_include_dir=[path to boost headers] - override the bundled boost headers with files in given path
  • CXL_hsa=[true|false] - define if to build HSA parts. If not stated default value is false (skip HSA)
  • -c - performs a "clean" of all build targets.
  • When executing the backend_build.sh script, the following switches are supported:
    • debug: performs a debug build
    • skip-32bitbuild: skips building the 32-bit binaries
    • skip-oclprofiler: skips building the OpenCL profiler binaries
    • skip-hsaprofiler: skips building the HSA profiler binaries. If building on a system where you don't have HSA/ROCR header files, use this switch to avoid errors due to missing header files
    • hsadir 'dir': by default, when building the HSA Profiler binaries, the build scripts will look for the HSA/ROCR headers under /opt/rocm/hsa. You can override this location using the "hsadir" switch.
    • boostlibdir 'dir': by default, the build scripts will look for the boost libs in Common/Lib/Ext/Boost/boost_1_59_0/lib/RHEL6. You can override the location this location using the "boostlibdir" switch.
    • quick or incremental: performs an incremental build (as opposed to a from-scratch build)
    • clean: performs a "clean" of all build targets, removing all intermediate and final output files

Specific build instructions Ubuntu 16.04

  • Since Ubuntu 16.04 comes with gcc 5.3, use the installed system boost libraries. example - ./backend_build.sh boostlibdir /usr/lib/x86_64-linux-gnu ./buildCodeXLFullLinuxProjects -j5 CXL_build=debug CXL_boost_lib_dir=/usr/lib/x86_64-linux-gnu CXL_boost_include_dir=/usr/include/boost

Running CodeXL

The folder containing the CodeXL binaries can be found in the root folder of CodeXL (Output_x86_64). If a license agreement is not displayed, copy the file CodeXL/Setup/Legal/Public/EndUserLicenseAgreement-Linux.htm to the Legal subdirectory in the CodeXL binaries folder (Output_x86_64/release/bin/Legal) If CodeXL displays an error indicating that it is unable to establish a connection with the CodeXL remote agent, copy the CodeXLRemoteAgentConfig.xml file into your CodeXL binary folder. The source file is in the folder CodeXL/CodeXL/Remote/AMDTRemoteAgent/CodeXLRemoteAgentConfig.xml

Using Detours Express 3.0 for graphics backend injection with Windows builds of CodeXL

  • For some Steam games the default injection technique used by CodeXL may not work. In most cases this can be fixed by using Detours Express 3.0.
  • Download Detours Express 3.0
  • Install Detours Express 3.0
    • We assume the Detours Express is installed in the following location: "CodeXL\Common\Lib\Ext\Detours Express 3.0"
    • The detours files that are used are included by the following file: "\CodeXL\Common\Src\AMDTInterceptor\mhook-dllInjector\dllInjectorDetours.inl"
    • Detours can be installed elsewhere but the paths for the included detours files (creatwth.cpp and modules.cpp) will need modifying in dllInjectorDetours.inl
  • Edit "CodeXL\Common\Lib\Ext\Detours Express 3.0\src\creatwth.cpp"
    • Change the line: "DETOUR_EXE_RESTORE der;" to: "static DETOUR_EXE_RESTORE der;". This struct is quite large and can a cause stack overflow on some systems.
  • Replace both occurrences of '#1' in creatwth.cpp with 'InjectDLL'
  • Uncomment the #define USE_DETOURS line below and rebuild the solution.