mirror of https://github.com/intel/intel-graphics-compiler.git synced 2025-10-30 08:18:26 +08:00

Files

Alexander Us c51c68facf Clean up main LLVM cmake lists

Remove packaging code. Remove unneeded code.
Separate one file into several.

2021-04-01 07:04:30 +02:00

9.7 KiB

Raw Blame History

Intel® Graphics Compiler for OpenCL™

Ubuntu build section

1. Prepare workspace

Building IGC needs flex, bison, libz and cmake version at least 3.13.4. You can install required packages on Ubuntu using this command:

$ sudo apt-get install flex bison libz-dev cmake

Some of the incoming git operations will try to download and apply patches. For this purpose it is necessary to setup git credentials if they are not already in the git configuration:

$ git config --global user.name "FirstName LastName"
$ git config --global user.email "your@email.com"

2. Install LLVM, Clang and OpenCL Clang

Important notice Every LLVM/Clang version brings some restrictions and in some cases needs different configuration. Please refer to LLVM/Clang version information section for more information.

In this step you need to prepare VC Intrinsics, SPIRV-LLVM Translator, LLVM, OpenCL-Clang libraries and Clang for IGC. It can be done either by using packaged releases or building those yourself:

Use preinstalled packages

For LLVM and Clang packages please visit this link to download and install desired version. As of now OpenCL Clang is still needed to be built and installed manually. Sources are available here. You can use out-of-tree build method with LLVM and Clang preinstalled. VC Intrinsics is a lightweight library that is built from sources with IGC and there is no package for it. Currently, in this mode SPIRV-LLVM Translator sources should be present too.

Installing LLVM, Clang, and OpenCL Clang components means you no longer have to download their sources alongside IGC, so the workspace tree in the next step may look like this:

<workspace>
      |- igc                          https://github.com/intel/intel-graphics-compiler
      |- vc-intrinsics                https://github.com/intel/vc-intrinsics
      |- llvm-spirv                   https://github.com/KhronosGroup/SPIRV-LLVM-Translator

Build from sources

Download all dependencies and create workspace. You can use following commands for setup:

$ cd <workspace>
$ git clone https://github.com/intel/vc-intrinsics vc-intrinsics
$ git clone -b release/10.x https://github.com/llvm/llvm-project llvm-project
$ git clone -b ocl-open-100 https://github.com/intel/opencl-clang llvm-project/llvm/projects/opencl-clang
$ git clone -b llvm_release_100 https://github.com/KhronosGroup/SPIRV-LLVM-Translator llvm-project/llvm/projects/llvm-spirv

These commands will set up a workspace with LLVM 10. If you wish to use any other version please refer to the component revision table

Correct directory tree looks like this:

<workspace>
    |- igc              https://github.com/intel/intel-graphics-compiler
    |- vc-intrinsics    https://github.com/intel/vc-intrinsics
    |- llvm-project     https://github.com/llvm/llvm-project
        |- llvm/projects/opencl-clang    https://github.com/intel/opencl-clang
        |- llvm/projects/llvm-spirv      https://github.com/KhronosGroup/SPIRV-LLVM-Translator

All dependencies will be build in the next step.

If you have problems with LLVM patching during IGC build, you can try listed steps:

$ cd llvm-project
$ git checkout -b tag llvmorg-10.0.0

Additional notes on build modes

There are several flags for these builds modes that you can pass to cmake command.

IGC_OPTION__LLVM_PREFERRED_VERSION -- sets version of LLVM that will be used by IGC (defaults to "10.0.0").
IGC_OPTION__LLVM_SOURCES -- whether IGC uses LLVM sources in build (by default OFF). This mode has suboptions:
- IGC_OPTION__LLVM_STOCK_SOURCES -- whether non-patched LLVM will be used or not (by default OFF).
- IGC_OPTION__LLVM_SOURCES_DIR -- path to llvm sources when building with LLVM sources (by default IGC takes whatever can be found on the same directory level like in example above).
IGC_OPTION__LLVM_FROM_SYSTEM -- whether IGC uses LLVM as a package (by default OFF).

As it can be noted, by default all modes are in OFF position. This means that IGC will start to look for LLVM in the following order:

Source build (see source build);
Package build (see build with packages).

In most cases IGC will automatically detect all components. However, in case of any problems you can set variables listed above to help IGC with locating of components.

3. Build and install IGC

Download sources:

$ cd <workspace>
$ git clone https://github.com/intel/intel-graphics-compiler igc
  [If using specific release]
$ cd igc && git checkout -b tag igc-<version>

Prepare workspace and build

If you are using Use preinstalled packages method IGC will link with installed dependencies dynamically. If you are using Build from sources method IGC will automatically build all dependencies (provided that the workspace structure is preserved) and link statically to LLVM and OpenCL Clang.

You can use following commands to build IGC:

$ cd <workspace>
$ mkdir build
$ cd build
$ cmake ../igc/IGC
$ make -j`nproc`

Install IGC:

$ sudo make install

LLVM/Clang version information

Version Overview

Version	Product quality
LLVM 11	Experimental
LLVM 10	Production
LLVM 9 and older	Experimental

Terminology	Description
Production	Current production version; Builds are verified internally
Experimental	No quality expectations

Revision table

LLVM version determines what branches are used when building dependencies. When checking out the components refer to the following table, replace XX with the LLVM version used:

Repository name	Version specific	Branch	LLVM 10 example
llvm-project	-	release/XX.x	release/10.x
vc-intrinsics	no	master	master
SPIRV-LLVM-Translator	yes	llvm_release_XX0	llvm_release_100
opencl-clang	yes	ocl-open-XX0	ocl-open-100

LLVM/Clang version specific caveats

Some LLVM versions require special steps to build successfully.

LLVM7/Clang7

In the OpenCL Clang project there are patches for Clang. If the Clang you are using to build IGC does not have these patches (for example, when you are using prebuilt packages) it is necessary to add -DVME_TYPES_DEFINED=FALSE to IGC CMake flags.

VectorComplier must be disabled by adding -DIGC_BUILD__VC_ENABLED=OFF to CMake flags.

LLVM8/Clang8

We recommend building LLVM8/Clang8 from sources instead for using prebuilds, because packaged Clang8 is missing these patches:

which are needed for enqueue_kernel.