[compat] HaikuOS port (#2805)

Still had the issues with libusb, but that should get solved with the other PRs anyways
Signed-off-by: lizzie <lizzie@eden-emu.dev>

Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/2805
Reviewed-by: MaranBr <maranbr@eden-emu.dev>
Reviewed-by: crueter <crueter@eden-emu.dev>
Co-authored-by: lizzie <lizzie@eden-emu.dev>
Co-committed-by: lizzie <lizzie@eden-emu.dev>

docs/Caveats.md

@@ -41,6 +41,18 @@ export LIBGL_ALWAYS_SOFTWARE=1
 - If using OpenIndiana, due to a bug in SDL2's CMake configuration, audio driver defaults to SunOS `<sys/audioio.h>`, which does not exist on OpenIndiana. Using external or bundled SDL2 may solve this.
 - System OpenSSL generally does not work. Instead, use `-DYUZU_USE_BUNDLED_OPENSSL=ON` to use a bundled static OpenSSL, or build a system dependency from source.
 
+## HaikuOS
+
+It's recommended to do a `pkgman full-sync` before installing. See [HaikuOS: Installing applications](https://www.haiku-os.org/guides/daily-tasks/install-applications/). Sometimes the process may be interrupted by an error like "Interrupted syscall". Simply firing the command again fixes the issue. By default `g++` is included on the default installation.
+
+GPU support is generally lacking/buggy, hence it's recommended to only install `pkgman install mesa_lavapipe`. Performance is acceptable for most homebrew applications and even some retail games.
+
+For reasons unberknownst to any human being, `glslangValidator` will crash upon trying to be executed, the solution to this is to build `glslang` yourself. Apply the patch in `.patch/glslang/0001-haikuos-fix.patch`. The main issue is `ShFinalize()` is deallocating already destroyed memory; the "fix" in question is allowing the program to just leak memory and the OS will take care of the rest. See [this issue](https://web.archive.org/web/20251021183604/https://github.com/haikuports/haikuports/issues/13083).
+
+For this reason this patch is NOT applied to default on all platforms (for obvious reasons) - instead this is a HaikuOS specific patch, apply with `git apply <absolute path to patch>` after cloning SPIRV-Tools then `make -C build` and add the resulting binary (in `build/StandAlone/glslang`) into PATH.
+
+`cubeb_devel` will also not work, either disable cubeb or uninstall it.
+
 ## OpenBSD
 
 After configuration, you may need to modify `externals/ffmpeg/CMakeFiles/ffmpeg-build/build.make` to use `-j$(nproc)` instead of just `-j`.
@@ -57,6 +69,23 @@ The available OpenSSL port (3.0.17) is out-of-date, and using a bundled static l
 
 ## NetBSD
 
+Install `pkgin` if not already `pkg_add pkgin`, see also the general [pkgsrc guide](https://www.netbsd.org/docs/pkgsrc/using.html). For NetBSD 10.1 provide `echo 'PKG_PATH="https://cdn.netbsd.org/pub/pkgsrc/packages/NetBSD/x86_64/10.0_2025Q3/All/"' >/etc/pkg_install.conf`. If `pkgin` is taking too much time consider adding the following to `/etc/rc.conf`:
+```sh
+ip6addrctl=YES
+ip6addrctl_policy=ipv4_prefer
+```
+
 System provides a default `g++-10` which doesn't support the current C++ codebase; install `clang-19` with `pkgin install clang-19`. Then build with `cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_C_COMPILER=clang -B build`.
 
 Make may error out when generating C++ headers of SPIRV shaders, hence it's recommended to use `gmake` over the default system one.
+
+glslang is not available on NetBSD, to circumvent this simply build glslang by yourself:
+```sh
+pkgin python313
+git clone --depth=1 https://github.com/KhronosGroup/glslang.git
+cd glslang
+python3.13 ./update_glslang_sources.py
+cmake -B build -DCMAKE_BUILD_TYPE=Release
+cmake --build build -- -j`nproc`
+cmake --install build
+```

docs/Deps.md

@@ -150,37 +150,25 @@ To run with MoltenVK, install additional dependencies:
 brew install molten-vk vulkan-loader
 ```
 
-</details>
+[Caveats](./Caveats.md#macos).
 
+</details>
 <details>
 <summary>FreeBSD</summary>
 
 As root run: `pkg install devel/cmake devel/sdl20 devel/boost-libs devel/catch2 devel/libfmt devel/nlohmann-json devel/ninja devel/nasm devel/autoconf devel/pkgconf devel/qt6-base devel/simpleini net/enet multimedia/ffnvcodec-headers multimedia/ffmpeg audio/opus archivers/liblz4 lang/gcc12 graphics/glslang graphics/vulkan-utility-libraries graphics/spirv-tools www/cpp-httplib devel/jwt-cpp devel/unordered-dense devel/zydis`
 
 If using FreeBSD 12 or prior, use `devel/pkg-config` instead.
-</details>
 
+[Caveats](./Caveats.md#freebsd).
+
+</details>
 <details>
 <summary>NetBSD</summary>
 
-Install `pkgin` if not already `pkg_add pkgin`, see also the general [pkgsrc guide](https://www.netbsd.org/docs/pkgsrc/using.html). For NetBSD 10.1 provide `cat 'PKG_PATH="https://cdn.netbsd.org/pub/pkgsrc/packages/NetBSD/x86_64/10.0_2025Q3/All/"' >/etc/pkg_install.conf`. If `pkgin` is taking too much time consider adding the following to `/etc/rc.conf`:
-```
-ip6addrctl=YES
-ip6addrctl_policy=ipv4_prefer
-```
-
 For NetBSD +10.1: `pkgin install git cmake boost fmtlib SDL2 catch2 libjwt spirv-headers ffmpeg7 libva nlohmann-json jq libopus qt6 mbedtls3 cpp-httplib lz4 vulkan-headers nasm autoconf enet pkg-config libusb1`.
 
-glslang is not available on NetBSD, to circumvent this simply build glslang by yourself:
-```sh
-pkgin python313
-git clone https://github.com/KhronosGroup/glslang.git
-cd glslang
-python3.13 ./update_glslang_sources.py
-cmake -B build -DCMAKE_BUILD_TYPE=Release
-cmake --build build -- -j`nproc`
-cmake --install build
-```
+[Caveats](./Caveats.md#netbsd).
 
 </details>
 
@@ -192,6 +180,8 @@ pkg_add -u
 pkg_add cmake nasm git boost unzip--iconv autoconf-2.72p0 bash ffmpeg glslang gmake llvm-19.1.7p3 qt6 jq fmt nlohmann-json enet boost vulkan-utility-libraries vulkan-headers spirv-headers spirv-tools catch2 sdl2 libusb1-1.0.27
 ```
 
+[Caveats](./Caveats.md#openbsd).
+
 </details>
 
 <details>
@@ -205,6 +195,9 @@ Run the usual update + install of essential toolings: `sudo pkg update && sudo p
 - **clang**: Version 20 is broken, use `sudo pkg install developer/clang-19`.
 
 Then install the libraries: `sudo pkg install qt6 boost glslang libzip library/lz4 libusb-1 nlohmann-json openssl opus sdl2 zlib compress/zstd unzip pkg-config nasm autoconf mesa library/libdrm header-drm developer/fmt`.
+
+[Caveats](./Caveats.md#solaris).
+
 </details>
 
 <details>
@@ -220,8 +213,18 @@ Then install the libraries: `sudo pkg install qt6 boost glslang libzip library/l
 </details>
 
 <details>
+<summary>HaikuOS</summary>
+
+```sh
+pkgman install git cmake libfmt_devel nlohmann_json lz4_devel opus_devel boost1.89_devel vulkan_devel qt6_base_devel libsdl2_devel ffmpeg7_devel libx11_devel enet_devel catch2_devel quazip1_qt6_devel qt6_5compat_devel zydis_devel glslang
+```
+
+[Caveats](./Caveats.md#haikuos).
+
+</details>
 <summary>RedoxOS</summary>
 
+TODO: Fix syscall crashes (heavy IO stalls and hangup due to net mutexes?)
 ```sh
 sudo pkg update && sudo pkg install git cmake
 sudo pkg install ffmpeg6 sdl2 zlib llvm18

docs/user/Architectures.md

@@ -52,6 +52,7 @@ IA-64 (Itanium) support is completely unknown. Existing amd64 packages will not
 
 The vast majority of Eden's testing is done on Windows, Linux, and Android. However, first-class support is also provided for:
 
+- HaikuOS
 - FreeBSD
 - OpenBSD
 - NetBSD
@@ -126,6 +127,13 @@ BSD and Solaris distributions tend to lag behind Linux in terms of Vulkan and ot
 
 AMD GPU support on these platforms is limited or nonexistent.
 
+## HaikuOS
+
+HaikuOS supports (see below) Vulkan 1.3 and has Mesa 24.0. Because OpenGL ES is used instead of the desktop flavour of OpenGL the OpenGL backend is actually worse than the Vulkan one in terms of stability and system support. OpenGL is highly not recommended due to it being: out of tree builds of Mesa and generally unstable ones at that. Users are advised to use Vulkan whenever possible.
+
+- Additionally system drivers for NVIDIA and Intel iGPUs exist and provide a native Vulkan ICD with the `Xcb` interface as opposed to the native `BView`
+- In order to obtain Vulkan 1.3 support with native `BView` support; Swiftshader can be compiled from source [see this thread](https://discuss.haiku-os.org/t/swiftshader-vulkan-software-renderer-on-haiku/11526/6).
+
 ## VMs
 
 Eden "can" run in a VM, but only with the software renderer, *unless* you create a hardware-accelerated KVM with GPU passthrough. If you *really* want to do this and don't have a spare GPU lying around, RX 570 and 580 GPUs are extremely cheap on the black market and are powerful enough to run most commercial games at 60 FPS.

docs/user/Basics.md

@@ -25,6 +25,7 @@ Eden will store configuration files in the following directories:
 - **Windows**: `%AppData%\Roaming`.
 - **Android**: Data is stored internally.
 - **Linux, macOS, FreeBSD, Solaris, OpenBSD**: `$XDG_DATA_HOME`, `$XDG_CACHE_HOME`, `$XDG_CONFIG_HOME`.
+- **HaikuOS**: `/boot/home/config/settings/eden`
 
 If a `user` directory is present in the current working directory, that will override all global configuration directories and the emulator will use that instead.
 

docs/user/Graphics.md

@@ -60,3 +60,7 @@ Unstable multithreaded optimisations are offered by the stock proprietary NVIDIA
 ### swrast/LLVMpipe crashes under high load
 
 The OpenGL backend would invoke behaviour that would result in swarst/LLVMpipe writing an invalid SSA IR (on old versions of Mesa), and then proceeding to crash. The solution is using a script found in [tools/llvmpipe-run.sh](../../tools/llvmpipe-run.sh).
+
+### HaikuOS compatibility
+
+HaikuOS bundles a Mesa library that doesn't support full core OpenGL 4.6 (required by the emulator). This leads to HaikuOS being one of the few computer platforms where Vulkan is the only available option for users. If OpenGL is desired, Mesa has to be built manually from source. For debugging purpouses `lavapipe` is recommended over the GPU driver; there is in-kernel support for NVIDIA cards through.