jjzhang166 / libclcxx Goto Github PK

This repository is now to contain WIP libraries for C++ for OpenCL Kernel Language published in releases of OpenCL-Docs.

This repository makes use of functionality from the llvm-project i.e. clang and libcxx.

1. Clone libclcxx:

   • git clone https://github.com/KhronosGroup/libclcxx.git

2. Configure and build libclcxx and its dependencies:

   • cd libclcxx

   • mkdir build && cd build

   • cmake -G <generator> [config options] [build options] ..

     Common build system generators include:

     • Ninja --- recommended.
     • Unix Makefiles

     Config options include:

     • Ommiting the config options will build the default target which includes clang and libcxx.
     • -DDEFAULT_CLANG=ON --- Uses system installation of clang to build libcxx and compile tests. Note that this option only works if the environment variable for clang is clang and not clang-12 or clang-13, use -DCLANG_PATH=<path to clang executable> in those cases.
     • -DCLANG_PATH=<path to clang executable> --- Uses provided executable of clang to build libcxx and compile tests.
     • -DDEFAULT_LIBCXX=ON --- Uses system installation of libcxx to build clang and compile tests. Note that libcxx needs to be installed in the CMAKE_INSTALL_PREFIX directory for this option to work, otherwise use -DPATH_TO_LIBCXX=<path to libcxx>. Please note that you may need to use sudo when building tools for this option to work.
     • -DLIBCXX_PATH=<path to libcxx> --- Uses the provided libcxx installation to build clang and compile tests. Note that the path needs to be to directory which has the include/c++/v1/ directory within it. Please omit the trailing '/' in the libcxx path.
     • If both -DCLANG_PATH and -DLIBCXX_PATH are provided, the provided clang and libcxx installations are used to compile the tests only.
     • If both -DDEFAULT_CLANG and -DDEFAULT_LIBCXX are provided, the default clang and libcxx installations are used to compile the tests only.
     • If either -DCLANG_PATH and -DDEFAULT_LIBCXX or -DLIBCXX_PATH and -DDEFAULT_CLANG combinations are used then the relevant installations are used.

     Some common build options include:

     • -DLLVM_PARALLEL_LINK_JOBS=<number of link jobs> --- Specify the number of link jobs manually. This is useful when running into memory issues during the linking process of the LLVM executables.

     • -DLLVM_TARGETS_TO_BUILD="<target architecture>" --- Specifies which targets are enabled. If ommited, the default target is set to X86.

   • <generator> tools

   • <generator> test

     To clean the test object files, you can run <generator> clean_test, this will delete the compiled object files from the test source directory.

     To clean the copied opencl_<> libclcxx source files from your system libcxx installation (if relevant), you can run <generator> clean_libclcxx.

     To clean everything, including build files, compiled test objects and (if relevant) copied libclcxx source files, you can run <generator> clean. Warning, this will clean your build directory!