caio/clang-p2996
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[libclc] Convert README to Markdown (#111549)

Browse Source 
A bit nicer to read on GitHub and with clickable links.

No content changes purely formatting.
This commit is contained in:
David Spickett
2024-10-08 16:58:02 +01:00
committed by GitHub
parent 10054ba4ac
commit 70e0a7e7e6
1 changed files with 28 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
libclc/README.TXT → libclc/README.md
View File

@@ -1,20 +1,19 @@
libclc # libclc
------
libclc is an open source implementation of the library libclc is an open source implementation of the library
requirements of the OpenCL C programming language, as specified by the requirements of the OpenCL C programming language, as specified by the
OpenCL 1.1 Specification. The following sections of the specification OpenCL 1.1 Specification. The following sections of the specification
impose library requirements: impose library requirements:
* 6.1: Supported Data Types * 6.1: Supported Data Types
* 6.2.3: Explicit Conversions * 6.2.3: Explicit Conversions
* 6.2.4.2: Reinterpreting Types Using as_type() and as_typen() * 6.2.4.2: Reinterpreting Types Using as_type() and as_typen()
* 6.9: Preprocessor Directives and Macros * 6.9: Preprocessor Directives and Macros
* 6.11: Built-in Functions * 6.11: Built-in Functions
* 9.3: Double Precision Floating-Point * 9.3: Double Precision Floating-Point
* 9.4: 64-bit Atomics * 9.4: 64-bit Atomics
* 9.5: Writing to 3D image memory objects * 9.5: Writing to 3D image memory objects
* 9.6: Half Precision Floating-Point * 9.6: Half Precision Floating-Point
libclc is intended to be used with the Clang compiler's OpenCL frontend. libclc is intended to be used with the Clang compiler's OpenCL frontend.
@@ -26,44 +25,43 @@ functions.
libclc currently supports PTX, AMDGPU, SPIRV and CLSPV targets, but support for libclc currently supports PTX, AMDGPU, SPIRV and CLSPV targets, but support for
more targets is welcome. more targets is welcome.
Compiling and installing ## Compiling and installing
------------------------
(in the following instructions you can use make or ninja) (in the following instructions you can use `make` or `ninja`)
For an in-tree build, Clang must also be built at the same time: For an in-tree build, Clang must also be built at the same time:
```
$ cmake <path-to>/llvm-project/llvm/CMakeLists.txt -DLLVM_ENABLE_PROJECTS="libclc;clang" \ $ cmake <path-to>/llvm-project/llvm/CMakeLists.txt -DLLVM_ENABLE_PROJECTS="libclc;clang" \
-DCMAKE_BUILD_TYPE=Release -G Ninja -DCMAKE_BUILD_TYPE=Release -G Ninja
$ ninja $ ninja
```
Then install: Then install:
```
$ ninja install $ ninja install
```
Note you can use the DESTDIR Makefile variable to do staged installs. Note you can use the `DESTDIR` Makefile variable to do staged installs.
```
$ DESTDIR=/path/for/staged/install ninja install $ DESTDIR=/path/for/staged/install ninja install
```
To build out of tree, or in other words, against an existing LLVM build or install: To build out of tree, or in other words, against an existing LLVM build or install:
```
$ cmake <path-to>/llvm-project/libclc/CMakeLists.txt -DCMAKE_BUILD_TYPE=Release \ $ cmake <path-to>/llvm-project/libclc/CMakeLists.txt -DCMAKE_BUILD_TYPE=Release \
-G Ninja -DLLVM_DIR=$(<path-to>/llvm-config --cmakedir) -G Ninja -DLLVM_DIR=$(<path-to>/llvm-config --cmakedir)
$ ninja $ ninja
```
Then install as before. Then install as before.
In both cases this will include all supported targets. You can choose which In both cases this will include all supported targets. You can choose which
targets are enabled by passing `-DLIBCLC_TARGETS_TO_BUILD` to CMake. The default targets are enabled by passing `-DLIBCLC_TARGETS_TO_BUILD` to CMake. The default
is "all". is `all`.
In both cases, the LLVM used must include the targets you want libclc support for In both cases, the LLVM used must include the targets you want libclc support for
(AMDGPU and NVPTX are enabled in LLVM by default). Apart from SPIRV where you do (`AMDGPU` and `NVPTX` are enabled in LLVM by default). Apart from `SPIRV` where you do
not need an LLVM target but you do need the llvm-spirv tool not need an LLVM target but you do need the
(https://github.com/KhronosGroup/SPIRV-LLVM-Translator) available. Either build [llvm-spirv tool](https://github.com/KhronosGroup/SPIRV-LLVM-Translator) available.
this in-tree, or place it in the directory pointed to by `LLVM_TOOLS_BINARY_DIR`. Either build this in-tree, or place it in the directory pointed to by
`LLVM_TOOLS_BINARY_DIR`.
Website ## Website
-------
https://libclc.llvm.org/ https://libclc.llvm.org/