Broken install of OpenXR-SDK package on Android

[emaschino]

Hi,

Rebuilding OpenXR-SDK Git repository targeting Android yields to a broken install directory (e.g. Debug build):

E:\dev\OpenXR-SDK>cmake --build build_x86_64/Debug -t install
[0/2] Re-checking globbed directories...
[22/23] Install the project...-- Install configuration: "Debug"
-- Installing: /openxr/openxr_platform_defines.h
-- Installing: /openxr/openxr.h
-- Installing: /openxr/openxr_loader_negotiation.h
-- Installing: /openxr/openxr_platform.h
-- Installing: /openxr/openxr_reflection.h
-- Installing: /openxr/openxr_reflection_structs.h
-- Installing: /openxr/openxr_reflection_parent_structs.h
-- Installing: /pkgconfig/openxr.pc
-- Installing: E:/dev/OpenXR-SDK/build_x86_64/Debug/install/lib/libopenxr_loaderd.so
-- Installing: E:/dev/OpenXR-SDK/build_x86_64/Debug/install/lib/cmake/openxr/OpenXRTargets.cmake
-- Installing: E:/dev/OpenXR-SDK/build_x86_64/Debug/install/lib/cmake/openxr/OpenXRTargets-debug.cmake
-- Installing: E:/dev/OpenXR-SDK/build_x86_64/Debug/install/lib/cmake/openxr/OpenXRConfig.cmake
-- Installing: E:/dev/OpenXR-SDK/build_x86_64/Debug/install/lib/cmake/openxr/OpenXRConfigVersion.cmake
-- Installing: E:/dev/OpenXR-SDK/build_x86_64/Debug/install/share/doc/openxr/LICENSE

Notice how the headers and PkgConfig files are incorrectly installed to the root directory.

I've traced back this regression to OpenXR release 1.0.32. Looking at the various CMakeLists.txt, it seems to me that inclusion of GNUInstallDirs is missing for Android because of this explicit test at ln. 123 in the main CMakeLists.txt file:

elseif(NOT ANDROID)
    include(GNUInstallDirs)
endif()

Why is Android excluded for inclusion of GNUInstallDirs?

Replacing elseif(NOT ANDROID) by else() yields a correct install directory:

E:\dev\OpenXR-SDK>cmake --build build_x86_64/Debug -t install
[0/2] Re-checking globbed directories...
[22/23] Install the project...-- Install configuration: "Debug"
-- Installing: E:/dev/OpenXR-SDK/build_x86_64/Debug/install/include/openxr/openxr_platform_defines.h
-- Installing: E:/dev/OpenXR-SDK/build_x86_64/Debug/install/include/openxr/openxr.h
-- Installing: E:/dev/OpenXR-SDK/build_x86_64/Debug/install/include/openxr/openxr_loader_negotiation.h
-- Installing: E:/dev/OpenXR-SDK/build_x86_64/Debug/install/include/openxr/openxr_platform.h
-- Installing: E:/dev/OpenXR-SDK/build_x86_64/Debug/install/include/openxr/openxr_reflection.h
-- Installing: E:/dev/OpenXR-SDK/build_x86_64/Debug/install/include/openxr/openxr_reflection_structs.h
-- Installing: E:/dev/OpenXR-SDK/build_x86_64/Debug/install/include/openxr/openxr_reflection_parent_structs.h
-- Installing: E:/dev/OpenXR-SDK/build_x86_64/Debug/install/lib/pkgconfig/openxr.pc
-- Installing: E:/dev/OpenXR-SDK/build_x86_64/Debug/install/lib/libopenxr_loaderd.so
-- Installing: E:/dev/OpenXR-SDK/build_x86_64/Debug/install/lib/cmake/openxr/OpenXRTargets.cmake
-- Installing: E:/dev/OpenXR-SDK/build_x86_64/Debug/install/lib/cmake/openxr/OpenXRTargets-debug.cmake
-- Installing: E:/dev/OpenXR-SDK/build_x86_64/Debug/install/lib/cmake/openxr/OpenXRConfig.cmake
-- Installing: E:/dev/OpenXR-SDK/build_x86_64/Debug/install/lib/cmake/openxr/OpenXRConfigVersion.cmake
-- Installing: E:/dev/OpenXR-SDK/build_x86_64/Debug/install/share/doc/openxr/LICENSE

Or am I missing something else (e.g. a particular variable to set) ?

Thanks.

[rpavlik]

Usually maintainer-scripts/build-aar.sh is used to make an Android build - there are strange layout things that are needed for an AAR (and you don't system-install a loader on Android) which is why the GNUInstallDirs is not used. If you use maintainer-scripts/build-aar.sh it should give you an AAR which you can extract and point CMake to the root of, similar to the Windows binaries. I think it might be safe to include GNUInstallDirs on Android as long as the variable named something like INSTALL_TO_ARCH_DIRS is not set, that's the other config that build-aar.sh applies, if you wanted to try that.

[emaschino]

Thanks for the info, I didn't noticed the maintainer-scripts/build-aar.sh script as it's missing from the OpenXR-SDK Git repository. So I was building OpenXR loader as any CMake-based project and this used to work flawlessly up to release 1.0.32.

[rpavlik]

Looks like 1.0.29 was the last release that this worked in, apparently.

I suspect it's just the addition of the man files that caused the issue, since those are what didn't install right.

[rpavlik]

Can you test #573 and see if it suits your needs? You should be able to make an "openxr-sdk" equivalent tarball with maintainer-scripts/archive-sdk.sh

[emaschino]

Well, I'm not sure I'm getting your point.
The headers and PkgConfig files are the ones that don't install in the correct location for me.
OpenXR 1.0.32 was the last revision where they installed fine.
The proposed fix in #573 is about installing the manpages on Android, which I didn't install in my case.

[rpavlik]

Hmm, I wonder why they don't install for you, because they install fine for me (even when I do a fresh build tree)

using:

cmake -S . -B build-android -G Ninja -DCMAKE_TOOLCHAIN_FILE=~/Android/Sdk/ndk/26.3.11579264/build/cmake/android.toolchain.cmake -DANDROID_PLATFORM=29 -DANDROID_ABI=x86_64 -DANDROID_STL=c++_static -DCMAKE_EXPORT_COMPILE_COMMANDS=true -DCMAKE_INSTALL_PREFIX=build-android-install

ninja -C build build-android-install

EDIT: OK that's weird now I see the same issue. Well at least I can reproduce it now.

[rpavlik]

I pushed one more commit, see if that helps.

[emaschino]

I pushed one more commit, see if that helps.

Well, it was the fix I proposed in my starter message, so yes, it's fine by me :-)

[rpavlik-bot]

An issue (number 2645) has been filed to correspond to this issue in the internal Khronos GitLab (Khronos members only: KHR:openxr/openxr#2645 ), to facilitate working group processes.

This GitHub issue will continue to be the main site of discussion.

[emaschino]

@rpavlik Would it be possible to report this fix to the OpenXR-SDK Git repository too?

[rpavlik]

yeah it will get synced at the next monthly release coming soon