Less brittle Linux OpenCL setup instructions

[jansol]

Having instructions for installing OpenCL drivers on Linux is nice... but the current ones are bypassing most of the duct tape that distro maintainers frantically apply in order to keep your system from imploding without warning during a future update. This is not ideal.

Seeing that the instructions appear to target Debian and/or Ubuntu, it is possible to set things up in a much easier and more robust way, without having to add 3rd party package repos or manually install build tools (other than the ones needed for building FluidX3D itself):

0. Install apt install ocl-icd-libopencl1 ocl-icd-opencl-dev (provides a driver-agnostic libOpenCL.so. OpenCL applications should be linked against this rather than directly against a specific driver)

• Intel: apt install intel-opencl-icd
• NVIDIA: apt install nvidia-opencl-icd (or if you are on ubuntu, it's usually better to do ubuntu-drivers install nvidia:550 which installs the whole NVIDIA driver suite)
• AMD: ... Neither Ubuntu nor Debian seem to currently package the ROCm OpenCL ICD so for this the current instructions are unfortunately as good as it gets. (some other distros do, though, at least Arch Linux and NixOS and you definitely should make use of those packages if you can)
• CPU: apt install pocl-opencl-icd (Some distros also package other options, such as intel-oneapi-basekit on Arch)

For Intel and AMD GPUs it is also possible to use the Mesa OpenCL ICD (apt install mesa-opencl-icd). This does have some caveats that make it difficult to recommend as the default but. Depending on the distro can contains two different implementations:

• "clover" (older GPUs, will fail to compile OpenCL kernels for too new cards)
• "rusticl" (focuses more on recent GPUs, still considered experimental)
  • due to its experimental status this requires the environment variable RUSTICL_ENABLE=iris (intel) or RUSTICL_ENABLE=radeonsi to be set for GPUs to actually be listed)
  • (Eventually this will also support NVIDIA GPUs, but that is still ways out)
  • If your distro ships both clover and rusticl you can use the OCL_ICD_VENDORS environment variable to force the loader to show only the one that works with your GPU(s)

Even Debian Stable is up to date enough for this approach.

[ProjectPhysX]

Hi @jansol,

thanks a lot for your help! I have updated the instructions!

Some questions and comments:

• Performance with PoCL is a lot worse than with the Intel Runtime for OpenCL, why is that?	MLUPs FP32/FP32	Intel CPU Runtime for OpenCL	PoCL
  i7-13700K	504	287
  i7-8700K	150	84
  i7-4720HQ	80	17

  • How does performance compare for AMD CPUs?
  • PoCL reports the i7-13700K as "cpu-haswell-13th Gen Intel(R) Core(TM) i7-13700K", I think Raptor Lake is a bit more modern than Haswell 😁
  • mesa-opencl-icd's Rusticl performs still badly compared to Clover

Kind regards, Moritz

[jansol]

Yeah, Rusticl would be the most convenient option for recent GPUs but as I said it's still difficult to recommend. The main advantage it has over Clover is that it works at all on RDNA and (to some extent) Arc GPUs. Currently it's mostly interesting for low-friction experimenting since it is the most "native" option for many systems.

PoCL being slower on Intel CPUs than Intel's driver is well known (although I'm surprised the difference is that drastic). This is improved somewhat by a new TBB-based scheduler that was added recently (pocl/pocl#1387). I'm guessing the Intel Runtime also has a compiler that is much more aggressively tuned for their architectures as well as for per-uarch kernel optimizations. PoCL is somewhat conservative with the prebuilt "builtin" function optimizations in distro builds, only generating them based on vector instruction sets rather than specific uarchs (for custom builds it does optimize them specifically for the host CPU).

CPU detection is done by LLVM, so you'll have to check which LLVM version your PoCL was built against - that LLVM might not know about Raptor Lake yet? (On Debian it looks to be still on LLVM15 which came out before Raptor Lake) If it should know that uarch then it sounds like a possible bug in PoCL, LLVM or both. There is also a possibility that PoCL puts "haswell" in the string because that is the uarch used as the reference with a feature set that matches what it detected.

It's also worth noting that thanks to the ICD loader, it is possible to have multiple drivers installed -- even for the same device -- as you can use OCL_ICD_VENDORS to choose which one(s) should be visible on a per-application basis if needed.

[ProjectPhysX]

The haswell-naming is happening with latest PoCL 5.0+debian on Ubuntu 24, should be LLVM 18, see this opencl.gpuinfo.org entry. Closing this issue now, thanks for the help!