OpenXR SDK 1.0.28.2 hotfix release: Includes the following fixes

rpavlik · rpavlik · commit 6f3ccf365997 · 2023-07-27T14:16:39.000-05:00
-   Loader spec: Fix description of &lt;queries&gt; element contents:
    existing description would fail to install. (internal MR 2840,
    internal issue 2053)
-   Android AAR artifacts (loader) and hello_xr: Fix &lt;queries&gt;
    element contents. (internal MR 2840, internal issue 2053)
-   Android AAR artifacts: Fix C++ standard library selection for
    Android artifacts in build-aar.sh (internal MR 2836, internal
    issue 2052)
-   Android AAR artifacts: Use jar instead of 7-zip to perform
    archiving, and document requirements in build-aar.sh (internal
    MR 2836, OpenXR-SDK-Source issue 303, internal issue 1711)
-   build system: Support SDK hotfix versions (fourth version
    component). (internal MR 2836)
diff --git a/.reuse/dep5 b/.reuse/dep5
@@ -4,6 +4,7 @@ Upstream-Contact: Ryan Pavlik <openxr-speceditor AT khronos DOT org>
 Source: https://khronos.org/registry/OpenXR/
 
 Files: changes/*
+       HOTFIX
 Copyright: 2019-2023, The Khronos Group Inc.
 License: CC-BY-4.0
 
diff --git a/CHANGELOG.SDK.md b/CHANGELOG.SDK.md
@@ -28,6 +28,28 @@ the loader documentation now describes how OpenXR handles compatibility with
 Android API levels of 30 and above: runtimes may need to update accordingly to
 support this compatibility solution.
 
+- **OpenXR SDK 1.0.28.2** hotfix release includes the following fixes
+  - Loader spec: Fix description of `<queries>` element contents: existing
+    description would fail to install.
+    ([internal MR 2840](https://gitlab.khronos.org/openxr/openxr/merge_requests/2840),
+    [internal issue 2053](https://gitlab.khronos.org/openxr/openxr/issues/2053))
+  - Android AAR artifacts (loader) and hello_xr: Fix `<queries>` element contents.
+    ([internal MR 2840](https://gitlab.khronos.org/openxr/openxr/merge_requests/2840),
+    [internal issue 2053](https://gitlab.khronos.org/openxr/openxr/issues/2053))
+  - Android AAR artifacts: Fix C++ standard library selection for Android artifacts
+    in `build-aar.sh`
+    ([internal MR 2836](https://gitlab.khronos.org/openxr/openxr/merge_requests/2836),
+    [internal issue 2052](https://gitlab.khronos.org/openxr/openxr/issues/2052))
+  - Android AAR artifacts: Use `jar` instead of 7-zip to perform archiving, and
+    document requirements in `build-aar.sh`
+    ([internal MR 2836](https://gitlab.khronos.org/openxr/openxr/merge_requests/2836),
+    [OpenXR-SDK-Source issue 303](https://github.com/KhronosGroup/OpenXR-SDK-Source/issues/303),
+    [internal issue 1711](https://gitlab.khronos.org/openxr/openxr/issues/1711))
+  - build system: Support SDK hotfix versions (fourth version component).
+    ([internal MR 2836](https://gitlab.khronos.org/openxr/openxr/merge_requests/2836))
+- **OpenXR SDK 1.0.28.1** hotfix release includes the following fix
+  - API dump layer: Fix build on Windows on ARM64.
+    ([OpenXR-SDK-Source PR 414](https://github.com/KhronosGroup/OpenXR-SDK-Source/pull/414))
 - Registry
   - Added defines to `xr.xml` for extension enum base and enum stride.
     ([internal MR 2693](https://gitlab.khronos.org/openxr/openxr/merge_requests/2693),
diff --git a/HOTFIX b/HOTFIX
@@ -0,0 +1 @@
+2
diff --git a/changes/sdk/mr.2836.gl.1.md b/changes/sdk/mr.2836.gl.1.md
@@ -0,0 +1,4 @@
+---
+- issue.2052.gl
+---
+Android AAR artifacts: Fix C++ standard library selection for Android artifacts in `build-aar.sh`
diff --git a/changes/sdk/mr.2836.gl.2.md b/changes/sdk/mr.2836.gl.2.md
@@ -0,0 +1,5 @@
+---
+- issue.303.gh.OpenXR-SDK-Source
+- issue.1711.gl
+---
+- Android AAR artifacts: Use `jar` instead of 7-zip to perform archiving, and document requirements in `build-aar.sh`
diff --git a/changes/sdk/mr.2836.gl.md b/changes/sdk/mr.2836.gl.md
@@ -0,0 +1 @@
+- build system: Support SDK hotfix versions (fourth version component).
diff --git a/changes/sdk/mr.2840.gl.md b/changes/sdk/mr.2840.gl.md
@@ -0,0 +1,4 @@
+---
+- issue.2053.gl
+---
+- Android AAR artifacts (loader) and hello_xr: Fix `<queries>` element contents.
diff --git a/changes/sdk/mr.414.gh.OpenXR-SDK-Source.md b/changes/sdk/mr.414.gh.OpenXR-SDK-Source.md
@@ -0,0 +1 @@
+API dump layer: Fix build on Windows on ARM64.
diff --git a/maintainer-scripts/build-aar.sh b/maintainer-scripts/build-aar.sh
@@ -1,30 +1,64 @@
 #!/usr/bin/env bash
-# Copyright (c) 2020-2022 Collabora, Ltd.
+# Copyright (c) 2020-2023 Collabora, Ltd.
 #
 # SPDX-License-Identifier: Apache-2.0
 
+# Builds the .aar Android prefab artifact for the OpenXR Loader.
+# Depends on the tools `cmake`, `ninja`, and `jar` (usually shipped with your JDK)
+# in addition to an Android NDK.
+#
+# Requires that ANDROID_NDK_HOME be set in the environment.
+# Pass the argument "clean" to wipe build directories before building.
+#
+# Touch a file named SNAPSHOT in the root directory to
+# make a version suffixed with -SNAPSHOT
+
 set -e
+
+logMsg() {
+    echo
+    echo "**** $1"
+    echo
+}
+
 ROOT=$(cd "$(dirname "$0")" && cd .. && pwd)
 
 OPENXR_ANDROID_VERSION_SUFFIX=
 if [ -f "${ROOT}/SNAPSHOT" ]; then
     OPENXR_ANDROID_VERSION_SUFFIX=-SNAPSHOT
-    echo "Building a -SNAPSHOT version"
+    logMsg "Building a -SNAPSHOT version"
 fi
 
 BUILD_DIR=${BUILD_DIR:-${ROOT}/build-android}
 INSTALL_DIR=${INSTALL_DIR:-${ROOT}/build-android-install}
 
-ANDROID_STL=$(grep ext.stl "${ROOT}/src/loader/build.gradle" | sed -E 's/.*"(.*)"/\1/')
+ANDROID_STL=c++_static
 CONFIG=Release
 ANDROID_PLATFORM=24
 
+logMsg "ANDROID_NDK_HOME: ${ANDROID_NDK_HOME}"
+logMsg "ANDROID_STL: ${ANDROID_STL}"
+logMsg "CONFIG: ${CONFIG}"
+logMsg "ANDROID_PLATFORM: ${ANDROID_PLATFORM}"
+
+logMsg "BUILD_DIR: ${BUILD_DIR}"
+logMsg "INSTALL_DIR: ${INSTALL_DIR}"
+
+logMsg "Wiping install staging dir"
 rm -rf "${INSTALL_DIR}"
+
+if [ "$1" = "clean" ]; then
+    logMsg "Wiping build dir completely"
+    rm -rf "${BUILD_DIR}"
+fi
+
 if [ -d "${BUILD_DIR}" ]; then
+    logMsg "Removing POM files from build dir"
     find "${BUILD_DIR}" -name "*.pom" -delete
 fi
 
 for arch in x86 x86_64 armeabi-v7a arm64-v8a; do
+    logMsg "Configuring and building for arch ${arch}"
     cmake -S "${ROOT}" \
       -B "${BUILD_DIR}/${arch}" \
       -G Ninja \
@@ -44,16 +78,23 @@ for arch in x86 x86_64 armeabi-v7a arm64-v8a; do
 
     ninja -C "${BUILD_DIR}/${arch}"
 
+    logMsg "Installing for arch ${arch}"
+
     for comp in License Headers Loader Prefab; do
+        # Component-wise install of the build, since we do not want all components
         cmake -DCMAKE_INSTALL_COMPONENT=${comp} -P "${BUILD_DIR}/${arch}/cmake_install.cmake"
     done
 done
+
+# The name of the POM file that CMake made with our decorated version number
 DECORATED=$(cd "${BUILD_DIR}/x86/src/loader" && ls openxr_loader*.pom)
 cp "${BUILD_DIR}/x86/src/loader/${DECORATED}" .
 
 DIR=$(pwd)
 (
+    logMsg "Packing AAR file"
     cd "$INSTALL_DIR/openxr"
-    7za a -r ../openxr.zip ./*
-    mv ../openxr.zip "$DIR/${DECORATED%.pom}.aar"
+    AARFILE="$DIR/${DECORATED%.pom}.aar"
+    jar --create --file="${AARFILE}" ./*
+    logMsg "AAR file created: ${AARFILE}"
 )
diff --git a/specification/loader/runtime.adoc b/specification/loader/runtime.adoc
@@ -225,6 +225,8 @@ manifest and will be merged into your application manifest automatically.)
   <provider android:authorities="org.khronos.openxr.runtime_broker;org.khronos.openxr.system_runtime_broker" />
   <intent>
     <action android:name="org.khronos.openxr.OpenXRRuntimeService" />
+  </intent>
+  <intent>
     <action android:name="org.khronos.openxr.OpenXRApiLayerService" />
   </intent>
 </queries>
diff --git a/src/loader/AndroidManifest.xml b/src/loader/AndroidManifest.xml
@@ -14,8 +14,10 @@
 
     <!-- so client-side code of runtime/layers can talk to their service sides -->
     <intent>
-      <action android:name="org.khronos.openxr.OpenXRRuntimeService" />
-      <action android:name="org.khronos.openxr.OpenXRApiLayerService" />
+        <action android:name="org.khronos.openxr.OpenXRRuntimeService" />
+    </intent>
+    <intent>
+        <action android:name="org.khronos.openxr.OpenXRApiLayerService" />
     </intent>
   </queries>
 
diff --git a/src/loader/AndroidManifest.xml.in b/src/loader/AndroidManifest.xml.in
@@ -1,7 +1,7 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
   package="org.khronos.openxr.openxr_loader_for_android"
   android:versionCode="1"
-  android:versionName="${MAJOR}.${MINOR}.${PATCH}${OPENXR_ANDROID_VERSION_SUFFIX}">
+  android:versionName="${OPENXR_FULL_VERSION}${OPENXR_ANDROID_VERSION_SUFFIX}">
   <!--
   Copyright (c) 2020-2023, The Khronos Group Inc.
   SPDX-License-Identifier: Apache-2.0
@@ -17,6 +17,8 @@
     <!-- so client-side code of runtime/layers can talk to their service sides -->
     <intent>
       <action android:name="org.khronos.openxr.OpenXRRuntimeService" />
+    </intent>
+    <intent>
       <action android:name="org.khronos.openxr.OpenXRApiLayerService" />
     </intent>
   </queries>
diff --git a/src/loader/CMakeLists.txt b/src/loader/CMakeLists.txt
@@ -166,11 +166,11 @@ if(CMAKE_SYSTEM_NAME STREQUAL "Linux")
         target_compile_definitions(openxr_loader PRIVATE EXTRASYSCONFDIR="/etc")
     endif()
 
-    set_target_properties(openxr_loader PROPERTIES SOVERSION "${MAJOR}" VERSION "${MAJOR}.${MINOR}.${PATCH}")
+    set_target_properties(openxr_loader PROPERTIES SOVERSION "${MAJOR}" VERSION "${OPENXR_FULL_VERSION}")
 
     add_custom_target(
         libopenxr_loader.so.${MAJOR}.${MINOR} ALL
-        COMMAND ${CMAKE_COMMAND} -E create_symlink libopenxr_loader.so.${MAJOR}.${MINOR}.${PATCH}
+        COMMAND ${CMAKE_COMMAND} -E create_symlink libopenxr_loader.so.${OPENXR_FULL_VERSION}
                 libopenxr_loader.so.${MAJOR}.${MINOR}
     )
 elseif(WIN32)
@@ -338,7 +338,7 @@ configure_package_config_file(
 )
 write_basic_package_version_file(
     ${CMAKE_CURRENT_BINARY_DIR}/OpenXRConfigVersion.cmake
-    VERSION "${MAJOR}.${MINOR}.${PATCH}"
+    VERSION "${OPENXR_FULL_VERSION}"
     COMPATIBILITY SameMajorVersion
 )
 install(
@@ -401,5 +401,5 @@ elseif(ANDROID AND INSTALL_TO_ARCHITECTURE_PREFIXES)
 
     # This gets used directly by build-aar.sh
     configure_file(${CMAKE_CURRENT_SOURCE_DIR}/openxr_loader_for_android.pom
-        ${CMAKE_CURRENT_BINARY_DIR}/openxr_loader_for_android-${MAJOR}.${MINOR}.${PATCH}${OPENXR_ANDROID_VERSION_SUFFIX}.pom)
+        ${CMAKE_CURRENT_BINARY_DIR}/openxr_loader_for_android-${OPENXR_FULL_VERSION}${OPENXR_ANDROID_VERSION_SUFFIX}.pom)
 endif()
diff --git a/src/loader/openxr_loader_for_android.pom b/src/loader/openxr_loader_for_android.pom
@@ -1,13 +1,14 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
-    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
+         xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <!--
-  Copyright (c) 2020 The Khronos Group Inc.
-  SPDX-License-Identifier: Apache-2.0
+  Copyright (c) 2020-2023, The Khronos Group Inc.
+  SPDX-License-Identifier: Apache-2.0 OR MIT
   -->
   <groupId>org.khronos.openxr</groupId>
   <artifactId>openxr_loader_for_android</artifactId>
-  <version>@MAJOR@.@MINOR@.@PATCH@@OPENXR_ANDROID_VERSION_SUFFIX@</version>
+  <version>@MAJOR@.@MINOR@.@PATCH@@OPENXR_SDK_HOTFIX_VERSION_SUFFIX@@OPENXR_ANDROID_VERSION_SUFFIX@</version>
   <packaging>aar</packaging>
   <name>OpenXR Loader for Android</name>
   <description>The AAR for the OpenXR Loader as used on Android.</description>
diff --git a/src/tests/hello_xr/AndroidManifest.xml b/src/tests/hello_xr/AndroidManifest.xml
@@ -20,8 +20,10 @@
     android:required="false"
     android:version="1" />
 
-  <!-- If building externally with the OpenXR loader AAR, this would be merged in automatically. -->
+  <!-- Recommended for haptic feedback -->
   <uses-permission android:name="android.permission.VIBRATE" />
+
+  <!-- If building externally with the OpenXR loader AAR, this would be merged in automatically. -->
   <uses-permission android:name="org.khronos.openxr.permission.OPENXR" />
   <uses-permission android:name="org.khronos.openxr.permission.OPENXR_SYSTEM" />
 
@@ -32,6 +34,8 @@
     <!-- so client-side code of runtime/layers can talk to their service sides -->
     <intent>
       <action android:name="org.khronos.openxr.OpenXRRuntimeService" />
+    </intent>
+    <intent>
       <action android:name="org.khronos.openxr.OpenXRApiLayerService" />
     </intent>
   </queries>
diff --git a/src/version.cmake b/src/version.cmake
@@ -18,26 +18,45 @@
 set(MAJOR "0")
 set(MINOR "0")
 set(PATCH "0")
+set(OPENXR_SDK_HOTFIX_VERSION)
 
 if(EXISTS "${PROJECT_SOURCE_DIR}/specification/registry/xr.xml")
-	file(STRINGS ${PROJECT_SOURCE_DIR}/specification/registry/xr.xml lines REGEX "#define <name>XR_CURRENT_API_VERSION")
+    file(STRINGS ${PROJECT_SOURCE_DIR}/specification/registry/xr.xml lines REGEX "#define <name>XR_CURRENT_API_VERSION")
 else()
-	file(STRINGS ${PROJECT_SOURCE_DIR}/include/openxr/openxr.h lines REGEX "#define XR_CURRENT_API_VERSION")
+    file(STRINGS ${PROJECT_SOURCE_DIR}/include/openxr/openxr.h lines REGEX "#define XR_CURRENT_API_VERSION")
 endif()
+
 list(LENGTH lines len)
 if(${len} EQUAL 1)
     list(GET lines 0 cur_line)
-    # Erase everything up to the open parentheses
-    string(REGEX REPLACE "^[^\(]+" "" VERSION_BEFORE_ERASED ${cur_line})
-    # Erase everything after the close parentheses
-    string(REGEX REPLACE "[^\)]+$" "" VERSION_AFTER_ERASED ${VERSION_BEFORE_ERASED})
-    # Erase the parentheses
-    string(REPLACE "(" "" VERSION_AFTER_ERASED2 ${VERSION_AFTER_ERASED})
-    string(REPLACE ")" "" VERSION_AFTER_ERASED3 ${VERSION_AFTER_ERASED2})
-    string(REPLACE " " "" VERSION_AFTER_ERASED4 ${VERSION_AFTER_ERASED3})
-    string(REGEX REPLACE "^([0-9]+)\\,[0-9]+\\,[0-9]+" "\\1" MAJOR "${VERSION_AFTER_ERASED4}")
-    string(REGEX REPLACE "^[0-9]+\\,([0-9]+)\\,[0-9]+" "\\1" MINOR "${VERSION_AFTER_ERASED4}")
-    string(REGEX REPLACE "^[0-9]+\\,[0-9]+\\,([0-9]+)" "\\1" PATCH "${VERSION_AFTER_ERASED4}")
+
+    # Grab just the stuff in the parentheses of XR_MAKE_VERSION( ),
+    # by replacing the whole line with the stuff in the parentheses
+    string(REGEX REPLACE "^.+\\(([^\)]+)\\).+$" "\\1" VERSION_WITH_WHITESPACE ${cur_line})
+
+    # Remove whitespace
+    string(REPLACE " " "" VERSION_NO_WHITESPACE ${VERSION_WITH_WHITESPACE})
+
+    # Grab components
+    string(REGEX REPLACE "^([0-9]+)\\,[0-9]+\\,[0-9]+" "\\1" MAJOR "${VERSION_NO_WHITESPACE}")
+    string(REGEX REPLACE "^[0-9]+\\,([0-9]+)\\,[0-9]+" "\\1" MINOR "${VERSION_NO_WHITESPACE}")
+    string(REGEX REPLACE "^[0-9]+\\,[0-9]+\\,([0-9]+)" "\\1" PATCH "${VERSION_NO_WHITESPACE}")
 else()
-    message(FATAL_ERROR "Unable to fetch major/minor version from registry or header")
+    message(FATAL_ERROR "Unable to fetch major/minor/patch version from registry or header")
+endif()
+
+# Check for an SDK hotfix version indicator file.
+if(EXISTS "${PROJECT_SOURCE_DIR}/HOTFIX")
+    file(STRINGS "${PROJECT_SOURCE_DIR}/HOTFIX" OPENXR_SDK_HOTFIX_VERSION)
+endif()
+if(OPENXR_SDK_HOTFIX_VERSION)
+    set(OPENXR_SDK_HOTFIX_VERSION_SUFFIX ".${OPENXR_SDK_HOTFIX_VERSION}")
+endif()
+
+set(OPENXR_VERSION "${MAJOR}.${MINOR}.${PATCH}")
+set(OPENXR_FULL_VERSION "${OPENXR_VERSION}${OPENXR_SDK_HOTFIX_VERSION_SUFFIX}")
+
+if(PROJECT_NAME STREQUAL "OPENXR")
+    # Only show the message if we aren't a subproject
+    message(STATUS "OpenXR ${OPENXR_FULL_VERSION}")
 endif()
diff --git a/src/version.gradle b/src/version.gradle
@@ -6,6 +6,8 @@ class OpenXRVersion {
     public int major;
     public int minor;
     public int patch;
+    public boolean hasHotfix;
+    public int hotfix;
 
     /// Returns a version code for Android usage.
     int getVersionCode() {
@@ -17,33 +19,45 @@ class OpenXRVersion {
 
     @Override
     String toString() {
-        "${major}.${minor}.${patch}"
+        if (hasHotfix) {
+            "${major}.${minor}.${patch}.${hotfix}"
+        } else {
+            "${major}.${minor}.${patch}"
+        }
     }
 
     /**
      * Parses the registry (as a text file) or the openxr.h header to get the version.
      * @param project Gradle project
-     * @param fn registry or header filename
+     * @param registryOrHeaderFile registry or header File
+     * @param hotfixFile HOTFIX File
      * @return version parsed
      */
-    static def parseOpenXRVersionFile(Project project, def fn) {
-        def matches = project.file(fn).readLines().find {
+    static def parseOpenXRVersionFile(def registryOrHeaderFile, def hotfixFile) {
+        def matches = registryOrHeaderFile.readLines().find {
             it.contains('XR_CURRENT_API_VERSION')
         } =~ ~/\(([^\)]+)\)/
         def components = matches[0][1].split(',').collect { it.replace(' ', '').trim() }
         def version = new OpenXRVersion()
         version.major = Integer.parseInt(components[0])
         version.minor = Integer.parseInt(components[1])
         version.patch = Integer.parseInt(components[2])
+
+        if (hotfixFile.exists()) {
+            version.hasHotfix = true
+            version.hotfix = Integer.parseInt(hotfixFile.text.trim())
+        }
         version
     }
 }
 
 class OpenXRVersionPlugin implements Plugin<Project> {
 
     void apply(Project project) {
-        project.ext.versionOpenXR = OpenXRVersion.parseOpenXRVersionFile(project,
-                "${project.repoRoot}/specification/registry/xr.xml")
+        def registryFile = project.file("${project.repoRoot}/specification/registry/xr.xml")
+        def hotfixFile = project.file("${project.repoRoot}/HOTFIX")
+
+        project.ext.versionOpenXR = OpenXRVersion.parseOpenXRVersionFile(registryFile, hotfixFile)
         project.group = "org.khronos.openxr"
 
         if (project.file("${project.repoRoot}/SNAPSHOT").exists()) {

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +---
 +- issue.2052.gl
 +---
 +Android AAR artifacts: Fix C++ standard library selection for Android artifacts in `build-aar.sh`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+- build system: Support SDK hotfix versions (fourth version component).`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+API dump layer: Fix build on Windows on ARM64.`