| --- |
| parent: Setup |
| nav_order: 1 |
| --- |
| |
| # CMake Options |
|
|
| A Thrust build is configured using CMake options. These may be passed to CMake |
| using |
|
|
| ``` |
| cmake -D<option_name>=<value> /path/to/thrust/sources |
| ``` |
|
|
| or configured interactively with the `ccmake` or `cmake-gui` interfaces. |
|
|
| Thrust supports two build modes. By default, a single configuration is built |
| that targets a specific host system, device system, and C++ dialect. |
| When `THRUST_ENABLE_MULTICONFIG` is `ON`, multiple configurations |
| targeting a variety of systems and dialects are generated. |
|
|
| The CMake options are divided into these categories: |
|
|
| 1. [Generic CMake Options](#generic-cmake-options): Options applicable to all |
| Thrust builds. |
| 1. [Single Config CMake Options](#single-config-cmake-options) Options |
| applicable only when `THRUST_ENABLE_MULTICONFIG` is disabled. |
| 1. [Multi Config CMake Options](#multi-config-cmake-options) Options applicable |
| only when `THRUST_ENABLE_MULTICONFIG` is enabled. |
| 1. [CUDA Specific CMake Options](#cuda-specific-cmake-options) Options that |
| control CUDA compilation. Only available when one or more configurations |
| targets the CUDA system. |
| 1. [TBB Specific CMake Options](#tbb-specific-cmake-options) Options that |
| control TBB compilation. Only available when one or more configurations |
| targets the TBB system. |
|
|
| ## Generic CMake Options |
|
|
| - `CMAKE_BUILD_TYPE={Release, Debug, RelWithDebInfo, MinSizeRel}` |
| - Standard CMake build option. Default: `RelWithDebInfo` |
| - `THRUST_ENABLE_HEADER_TESTING={ON, OFF}` |
| - Whether to test compile public headers. Default is `ON`. |
| - `THRUST_ENABLE_TESTING={ON, OFF}` |
| - Whether to build unit tests. Default is `ON`. |
| - `THRUST_ENABLE_EXAMPLES={ON, OFF}` |
| - Whether to build examples. Default is `ON`. |
| - `THRUST_ENABLE_MULTICONFIG={ON, OFF}` |
| - Toggles single-config and multi-config modes. Default is `OFF` (single config). |
| - `THRUST_ENABLE_EXAMPLE_FILECHECK={ON, OFF}` |
| - Enable validation of example outputs using the LLVM FileCheck utility. |
| Default is `OFF`. |
| - `THRUST_ENABLE_INSTALL_RULES={ON, OFF}` |
| - If true, installation rules will be generated for thrust. Default is `ON`. |
| |
| ## Single Config CMake Options |
|
|
| - `THRUST_HOST_SYSTEM={CPP, TBB, OMP}` |
| - Selects the host system. Default: `CPP` |
| - `THRUST_DEVICE_SYSTEM={CUDA, TBB, OMP, CPP}` |
| - Selects the device system. Default: `CUDA` |
| - `THRUST_CPP_DIALECT={11, 14, 17}` |
| - Selects the C++ standard dialect to use. Default is `14` (C++14). |
|
|
| ## Multi Config CMake Options |
|
|
| - `THRUST_MULTICONFIG_ENABLE_DIALECT_CPPXX={ON, OFF}` |
| - Toggle whether a specific C++ dialect will be targeted. |
| - Possible values of `XX` are `{11, 14, 17}`. |
| - By default, only C++14 is enabled. |
| - `THRUST_MULTICONFIG_ENABLE_SYSTEM_XXXX={ON, OFF}` |
| - Toggle whether a specific system will be targeted. |
| - Possible values of `XXXX` are `{CPP, CUDA, TBB, OMP}` |
| - By default, only `CPP` and `CUDA` are enabled. |
| - `THRUST_MULTICONFIG_WORKLOAD={SMALL, MEDIUM, LARGE, FULL}` |
| - Restricts the host/device combinations that will be targeted. |
| - By default, the `SMALL` workload is used. |
| - The full cross product of `host x device` systems results in 12 |
| configurations, some of which are more important than others. |
| This option can be used to prune some of the less important ones. |
| - `SMALL`: (3 configs) Minimal coverage and validation of each device system against the `CPP` host. |
| - `MEDIUM`: (6 configs) Cheap extended coverage. |
| - `LARGE`: (8 configs) Expensive extended coverage. Includes all useful build configurations. |
| - `FULL`: (12 configs) The complete cross product of all possible build configurations. |
| |
| | Config | Workloads | Value | Expense | Note | |
| |----------|-----------|------------|-----------|------------------------------| |
| | CPP/CUDA | `F L M S` | Essential | Expensive | Validates CUDA against CPP | |
| | CPP/OMP | `F L M S` | Essential | Cheap | Validates OMP against CPP | |
| | CPP/TBB | `F L M S` | Essential | Cheap | Validates TBB against CPP | |
| | CPP/CPP | `F L M ` | Important | Cheap | Tests CPP as device | |
| | OMP/OMP | `F L M ` | Important | Cheap | Tests OMP as host | |
| | TBB/TBB | `F L M ` | Important | Cheap | Tests TBB as host | |
| | TBB/CUDA | `F L ` | Important | Expensive | Validates TBB/CUDA interop | |
| | OMP/CUDA | `F L ` | Important | Expensive | Validates OMP/CUDA interop | |
| | TBB/OMP | `F ` | Not useful | Cheap | Mixes CPU-parallel systems | |
| | OMP/TBB | `F ` | Not useful | Cheap | Mixes CPU-parallel systems | |
| | TBB/CPP | `F ` | Not Useful | Cheap | Parallel host, serial device | |
| | OMP/CPP | `F ` | Not Useful | Cheap | Parallel host, serial device | |
|
|
| ## CUDA Specific CMake Options |
|
|
| - `THRUST_INCLUDE_CUB_CMAKE={ON, OFF}` |
| - If enabled, the CUB project will be built as part of Thrust. Default is |
| `OFF`. |
| - This adds CUB tests, etc. Useful for working on both CUB and Thrust |
| simultaneously. |
| - CUB configurations will be generated for each C++ dialect targeted by |
| the current Thrust build. |
| - `THRUST_INSTALL_CUB_HEADERS={ON, OFF}` |
| - If enabled, the CUB project's headers will be installed through Thrust's |
| installation rules. Default is `ON`. |
| - This option depends on `THRUST_ENABLE_INSTALL_RULES`. |
| - `THRUST_ENABLE_COMPUTE_XX={ON, OFF}` |
| - Controls the targeted CUDA architecture(s) |
| - Multiple options may be selected when using NVCC as the CUDA compiler. |
| - Valid values of `XX` are: |
| `{35, 37, 50, 52, 53, 60, 61, 62, 70, 72, 75, 80}` |
| - Default value depends on `THRUST_DISABLE_ARCH_BY_DEFAULT`: |
| - `THRUST_ENABLE_COMPUTE_FUTURE={ON, OFF}` |
| - If enabled, CUDA objects will target the most recent virtual architecture |
| in addition to the real architectures specified by the |
| `THRUST_ENABLE_COMPUTE_XX` options. |
| - Default value depends on `THRUST_DISABLE_ARCH_BY_DEFAULT`: |
| - `THRUST_DISABLE_ARCH_BY_DEFAULT={ON, OFF}` |
| - When `ON`, all `THRUST_ENABLE_COMPUTE_*` options are initially `OFF`. |
| - Default: `OFF` (meaning all architectures are enabled by default) |
| - `THRUST_ENABLE_TESTS_WITH_RDC={ON, OFF}` |
| - Whether to enable Relocatable Device Code when building tests. |
| Default is `OFF`. |
| - `THRUST_ENABLE_EXAMPLES_WITH_RDC={ON, OFF}` |
| - Whether to enable Relocatable Device Code when building examples. |
| Default is `OFF`. |
| |
| ## TBB Specific CMake Options |
|
|
| - `THRUST_TBB_ROOT=<path to tbb root>` |
| - When the TBB system is requested, set this to the root of the TBB installation |
| (e.g. the location of `lib/`, `bin/` and `include/` for the TBB libraries). |
| |
|
|
