llvm-project/libclc
John Ericson 6fd2db04d0 Use `GNUInstallDirs` to support custom installation dirs. -- LLVM
This is a new draft of D28234. I previously did the unorthodox thing of
pushing to it when I wasn't the original author, but since this version

- Uses `GNUInstallDirs`, rather than mimics it, as the original author
  was hesitant to do but others requested.

- Is much broader, effecting many more projects than LLVM itself.

I figured it was time to make a new revision.

I am using this patch (and many back-ports) as the basis of
https://github.com/NixOS/nixpkgs/pull/111487 for my distro (NixOS). It
looked like people were generally on board in D28234, but I make note of
this here in case extra motivation is useful.

---

As pointed out in the original issue, a central tension is that LLVM
already has some partial support for these sorts of things. For example
`LLVM_LIBDIR_SUFFIX`, or `COMPILER_RT_INSTALL_PATH`. Because it's not
quite clear yet what to do about those, we are holding off on changing
libdirs and `compiler-rt`. for this initial PR.

---

On the advice of @lebedev.ri, I am splitting this up a bit per
subproject, starting with LLVM. To allow it to be more easily reviewed. This and the subsequent patch must be landed together, as this will not build alone. But the rest can be landed on their own.

Reviewed By: compnerd

Differential Revision: https://reviews.llvm.org/D100810
2021-11-02 10:23:30 -04:00
..
amdgcn/lib libclc: Make all built-ins overloadable 2020-08-17 13:55:48 -07:00
amdgcn-amdhsa/lib libclc: Make all built-ins overloadable 2020-08-17 13:55:48 -07:00
amdgpu/lib
clspv/lib libclc: Add clspv target to libclc 2021-03-04 00:19:10 -05:00
cmake libclc: Use temporary files rather than a pipe 2020-04-14 10:03:27 -04:00
generic libclc: Fix rounding during type conversion 2021-08-19 22:24:19 -07:00
ptx/lib
ptx-nvidiacl/lib libclc: Make all built-ins overloadable 2020-08-17 13:55:48 -07:00
r600/lib libclc: Make all built-ins overloadable 2020-08-17 13:55:48 -07:00
spirv/lib libclc: Add a __builtin to let SPIRV targets select between SW and HW FMA 2020-09-16 01:37:22 -04:00
spirv64/lib libclc: Add a __builtin to let SPIRV targets select between SW and HW FMA 2020-09-16 01:37:22 -04:00
test
utils Support: Stop using F_{None,Text,Append} compatibility synonyms, NFC 2021-04-30 11:00:03 -07:00
www [www] Change URLs to HTTPS. 2019-10-24 13:25:15 -07:00
.gitignore
CMakeLists.txt Use `GNUInstallDirs` to support custom installation dirs. -- LLVM 2021-11-02 10:23:30 -04:00
CREDITS.TXT
LICENSE.TXT Fix typos throughout the license files that somehow I and my reviewers 2019-01-21 09:52:34 +00:00
README.TXT libclc: update website url 2020-05-29 09:18:37 +02:00
amdgcn-mesa3d
check_external_calls.sh
compile-test.sh
libclc.pc.in cmake: Install libraries to DATADIR from GNUInstallDirs 2019-01-07 20:20:37 +00:00

README.TXT

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

libclc
------

libclc is an open source, BSD licensed implementation of the library
requirements of the OpenCL C programming language, as specified by the
OpenCL 1.1 Specification. The following sections of the specification
impose library requirements:

  * 6.1: Supported Data Types
  * 6.2.3: Explicit Conversions
  * 6.2.4.2: Reinterpreting Types Using as_type() and as_typen()
  * 6.9: Preprocessor Directives and Macros
  * 6.11: Built-in Functions
  * 9.3: Double Precision Floating-Point
  * 9.4: 64-bit Atomics
  * 9.5: Writing to 3D image memory objects
  * 9.6: Half Precision Floating-Point

libclc is intended to be used with the Clang compiler's OpenCL frontend.

libclc is designed to be portable and extensible. To this end, it provides
generic implementations of most library requirements, allowing the target
to override the generic implementation at the granularity of individual
functions.

libclc currently only supports the PTX target, but support for more
targets is welcome.

Compiling and installing with Make
----------------------------------

$ ./configure.py --with-llvm-config=/path/to/llvm-config && make
$ make install

Note you can use the DESTDIR Makefile variable to do staged installs.

$ make install DESTDIR=/path/for/staged/install

Compiling and installing with Ninja
-----------------------------------

$ ./configure.py -g ninja --with-llvm-config=/path/to/llvm-config && ninja
$ ninja install

Note you can use the DESTDIR environment variable to do staged installs.

$ DESTDIR=/path/for/staged/install ninja install

Website
-------

https://libclc.llvm.org/