Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/justusc/FindTBB
CMake find module for Intel Threading Building Blocks
https://github.com/justusc/FindTBB
Last synced: about 2 months ago
JSON representation
CMake find module for Intel Threading Building Blocks
- Host: GitHub
- URL: https://github.com/justusc/FindTBB
- Owner: justusc
- License: mit
- Created: 2015-02-05T20:21:37.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-03-22T17:21:11.000Z (over 6 years ago)
- Last Synced: 2024-02-01T16:08:53.013Z (5 months ago)
- Language: CMake
- Homepage:
- Size: 19.5 KB
- Stars: 89
- Watchers: 6
- Forks: 36
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-cmake - FindTBB - CMake find module for Intel Threading Building Blocks. [```[MIT]```][MIT] (Modules)
README
# FindTBB Module
FindTBB is a [CMake](http://www.cmake.org) find package module for [Intel® Threading Building Blocks](https://www.threadingbuildingblocks.org) (TBB).
# Usage
The signature of the TBB find module in CMake is:
```CMake
find_package(TBB [major[.minor]] [EXACT] [QUIET] [REQUIRED]
[COMPONENTS [tbbmalloc] [tbbmalloc_proxy] [tbb_preview]]
[OPTIONAL_COMPONENTS [tbbmalloc] [tbbmalloc_proxy] [tbb_preview]])
```
where the allowed components are tbbmalloc and tbb_preview.
# Example Project
With CMake 3.0 and later
```CMake
cmake_minimum_required(VERSION 3.0)
project(MyProject)
list(APPEND CMAKE_MODULE_PATH "")
find_package(TBB COMPONENTS tbbmalloc tbbmalloc_proxy tbb_preview)
add_executable(myapp myapp.cc)
target_link_libraries(myapp tbb)
```
With CMake 2.8 and earlier
```CMake
cmake_minimum_required(VERSION 2.8)
project(MyProject)
list(APPEND CMAKE_MODULE_PATH "")
find_package(TBB COMPONENTS tbbmalloc tbbmalloc_proxy tbb_preview)
add_executable(myapp myapp)
target_include_directories(myapp PRIVATE ${TBB_INCLUDE_DIRS})
target_compile_definitions(myapp PRIVATE ${TBB_DEFINITIONS})
target_link_libraries(myapp ${TBB_LIBRARIES})
```
# User Variables
The following varibiles may be used by the user to specify the install, include, and/or library directories of TBB.
* ```TBB_ROOT_DIR``` - The base directory the of TBB installation.
* ```TBB_INCLUDE_DIR``` - The directory that contains the TBB headers files.
* ```TBB_LIBRARY``` - The directory that contains the TBB library files.
* ```TBB__LIBRARY``` - The path of the corresponding TBB library. These libraries, if specified, override the corresponding library search results, where may be tbb, tbb_debug, tbbmalloc, tbbmalloc_debug, tbb_preview, or tbb_preview_debug.
* ```TBB_USE_DEBUG_BUILD``` - The debug version of tbb libraries, if present, will be used instead of the release version.
In addition, FindTBB uses the following environment variables to find the TBB install directory.
* ```TBB_INSTALL_DIR```
* ```TBBROOT```
* ```LIBRARY_PATH```
# FindTBB Results
This module will set the following variables:
* ```TBB_FOUND``` - Set to false, or undefined, if we haven’t found, or don’t want to use TBB.
* ```TBB__FOUND``` - If False, optional part of TBB sytem is not available.
* ```TBB_VERSION``` - The full version string
* ```TBB_VERSION_MAJOR``` - The major version
* ```TBB_VERSION_MINOR``` - The minor version
* ```TBB_INTERFACE_VERSION``` - The interface version number defined in tbb/tbb_stddef.h.
* ```TBB__LIBRARY_RELEASE``` - The path of the TBB release version of , where may be tbb, tbb_debug, tbbmalloc, tbbmalloc_proxy, or tbb_preview.
* ```TBB__LIBRARY_DEGUG``` - The path of the TBB release version of , where may be tbb_debug, tbbmalloc_debug, tbbmalloc_proxy_debug, or tbb_preview_debug.
# Output Variables
The following varibles should be used to link executables and libraries with TBB:
* ```TBB_INCLUDE_DIRS``` - The include directory for TBB.
* ```TBB_LIBRARIES``` - The libraries to link against to use TBB.
* ```TBB_LIBRARIES_RELEASE``` - The release libraries to link against to use TBB.
* ```TBB_LIBRARIES_DEBUG``` - The debug libraries to link against to use TBB.
* ```TBB_DEFINITIONS``` - Definitions to use when compiling code that uses TBB.
* ```TBB_DEFINITIONS_RELEASE``` - Definitions to use when compiling release code that uses TBB.
* ```TBB_DEFINITIONS_DEBUG``` - Definitions to use when compiling debug code that uses TBB.