Swap to manifest.json for install config (#83)

solidpixel · web-flow · commit 315c954db1cd · 2025-02-17T14:44:12.000Z
Switch to using standard Vulkan layer manifest.json files for configuring
the Android installer, allowing the same manifest to be used for both
Android and Linux.

This commit also changes layer tag names to match Khronos convention, 
where tags are of the form VK_LAYER_LGL_layer_name.
diff --git a/docs/running_android.md b/docs/running_android.md
@@ -87,7 +87,7 @@ For users with existing configuration flows, Vulkan layers can be manually
 configured using `adb` to copy the files and set the system properties.
 
 For layers with configuration files, the configuration file must be named
-after the layer (e.g. `VK_LAYER_LGL_GPUSUPPORT.json`) and then pushed to
+after the layer (e.g. `VK_LAYER_LGL_gpu_support.json`) and then pushed to
 the `/data/local/tmp` directory with global (`0666`) access permissions.
 
 **Note:** Android will fail to start an application if it has a layer enabled,
diff --git a/generator/generate_vulkan_layer.py b/generator/generate_vulkan_layer.py
@@ -56,7 +56,8 @@ def load_template(path: str) -> str:
 def get_layer_api_name(vendor: str, layer: str) -> str:
     '''
     Generate the layer string name for the new layer used by the loader.
-    Names are of the form "VK_LAYER_<VENDOR>_<LAYER>" in upper case.
+    Names are of the form "VK_LAYER_<VENDOR>_<layer>_<name>" where vendor
+    is in upper case, and the layer name is in lower case.
 
     Args:
         vendor: The layer vendor tag.
@@ -69,7 +70,25 @@ def get_layer_api_name(vendor: str, layer: str) -> str:
     match = pattern.match(layer)
     assert match
 
-    name_parts = ('VK_LAYER', vendor.upper(), match.group(1).upper())
+    name = match.group(1)
+    parts = []
+    part = None
+
+    for char in name:
+        is_uc = char.isupper()
+        is_last_uc = False if not part else part[-1].isupper()
+
+        if (is_uc and not is_last_uc) or not part:
+            if part:
+                parts.append(part.lower())
+            part = char
+        else:
+            part += char
+
+    if part:
+        parts.append(part.lower())
+
+    name_parts = ('VK_LAYER', vendor.upper(), *parts)
     return '_'.join(name_parts)
 
 
@@ -125,16 +144,16 @@ def generate_source_cmake(file: TextIO, vendor: str, layer: str) -> None:
     file.write(data)
 
 
-def generate_install_helper(file: TextIO, vendor: str, layer: str) -> None:
+def generate_install_manifest(file: TextIO, vendor: str, layer: str) -> None:
     '''
-    Generate the Android installer helper with placeholders replaced.
+    Generate the layer manifest with placeholders replaced.
 
     Args:
         file: The file handle to write to.
         vendor: The layer vendor tag.
         layer: The name of the layer.
     '''
-    data = load_template('android_install.json')
+    data = load_template('manifest.json')
     data = data.replace('{LAYER_NAME}', layer)
 
     name = get_layer_api_name(vendor, layer)
@@ -228,9 +247,9 @@ def main() -> int:
     with open(outfile, 'w', encoding='utf-8', newline='\n') as handle:
         generate_source_cmake(handle, args.vendor_name, args.layer_name)
 
-    outfile = os.path.join(outdir, 'android_install.json')
+    outfile = os.path.join(outdir, 'manifest.json')
     with open(outfile, 'w', encoding='utf-8', newline='\n') as handle:
-        generate_install_helper(handle, args.vendor_name, args.layer_name)
+        generate_install_manifest(handle, args.vendor_name, args.layer_name)
 
     return 0
 
diff --git a/generator/vk_codegen/android_install.json b/generator/vk_codegen/android_install.json
diff --git a/generator/vk_codegen/manifest.json b/generator/vk_codegen/manifest.json
@@ -0,0 +1,11 @@
+{
+  "file_format_version": "1.0.0",
+  "layer": {
+      "name": "{LGL_LAYER_NAME}",
+      "type": "INSTANCE",
+      "library_path": "lib{LAYER_NAME}.so",
+      "api_version": "1.0.0",
+      "implementation_version": "1",
+      "description": "Layer for ..."
+  }
+}
diff --git a/layer_example/android_install.json b/layer_example/android_install.json
diff --git a/layer_example/manifest.json b/layer_example/manifest.json
@@ -0,0 +1,11 @@
+{
+  "file_format_version": "1.0.0",
+  "layer": {
+      "name": "VK_LAYER_LGL_example",
+      "type": "INSTANCE",
+      "library_path": "libVkLayerExample.so",
+      "api_version": "1.0.0",
+      "implementation_version": "1",
+      "description": "Layer generator skeleton no-op example layer"
+  }
+}
diff --git a/layer_example/source/CMakeLists.txt b/layer_example/source/CMakeLists.txt
@@ -30,7 +30,7 @@ else()
 endif()
 
 # Set strings used by configure
-set(LGL_LAYER_NAME_STR "VK_LAYER_LGL_EXAMPLE")
+set(LGL_LAYER_NAME_STR "VK_LAYER_LGL_example")
 set(LGL_LAYER_DESC_STR "VkLayerExample by LGL")
 
 # Vulkan layer library
diff --git a/layer_gpu_support/android_install.json b/layer_gpu_support/android_install.json
diff --git a/layer_gpu_support/layer_config.json b/layer_gpu_support/layer_config.json
@@ -1,5 +1,5 @@
 {
-    "layer": "VK_LAYER_LGL_GPUSUPPORT",
+    "layer": "VK_LAYER_LGL_gpu_support",
     "serialize": {
         "all": false,
         "none": false,
diff --git a/layer_gpu_support/manifest.json b/layer_gpu_support/manifest.json
@@ -0,0 +1,11 @@
+{
+  "file_format_version": "1.0.0",
+  "layer": {
+      "name": "VK_LAYER_LGL_gpu_support",
+      "type": "INSTANCE",
+      "library_path": "libVkLayerGPUSupport.so",
+      "api_version": "1.0.0",
+      "implementation_version": "1",
+      "description": "Layer for quick triage experimentation"
+  }
+}
diff --git a/layer_gpu_support/run.sh b/layer_gpu_support/run.sh
@@ -0,0 +1,7 @@
+# VK_LOADER_DEBUG=all \
+
+env \
+    VK_LAYER_PATH=$VK_LAYER_PATH:${PWD} \
+    LD_LIBRARY_PATH=$LD_LIBRARY_PATH:${PWD} \
+    VK_INSTANCE_LAYERS=VK_LAYER_LGL_gpu_support \
+    vkmark
diff --git a/layer_gpu_support/source/CMakeLists.txt b/layer_gpu_support/source/CMakeLists.txt
@@ -30,7 +30,7 @@ else()
 endif()
 
 # Set strings used by configure
-set(LGL_LAYER_NAME_STR "VK_LAYER_LGL_GPUSUPPORT")
+set(LGL_LAYER_NAME_STR "VK_LAYER_LGL_gpu_support")
 set(LGL_LAYER_DESC_STR "VkLayerGPUSupport by LGL")
 
 # Vulkan layer library
diff --git a/layer_gpu_timeline/android_install.json b/layer_gpu_timeline/android_install.json
diff --git a/layer_gpu_timeline/manifest.json b/layer_gpu_timeline/manifest.json
@@ -0,0 +1,11 @@
+{
+  "file_format_version": "1.0.0",
+  "layer": {
+      "name": "VK_LAYER_LGL_gpu_timeline",
+      "type": "INSTANCE",
+      "library_path": "libVkLayerGPUTimeline.so",
+      "api_version": "1.0.0",
+      "implementation_version": "1",
+      "description": "Layer for generating API correlated semantic metadata"
+  }
+}
diff --git a/layer_gpu_timeline/source/CMakeLists.txt b/layer_gpu_timeline/source/CMakeLists.txt
@@ -30,7 +30,7 @@ else()
 endif()
 
 # Set strings used by configure
-set(LGL_LAYER_NAME_STR "VK_LAYER_LGL_GPUTIMELINE")
+set(LGL_LAYER_NAME_STR "VK_LAYER_LGL_gpu_timeline")
 set(LGL_LAYER_DESC_STR "VkLayerGPUTimeline by LGL")
 
 # Vulkan layer library
diff --git a/layer_khronos_validation/android_install.json b/layer_khronos_validation/android_install.json
diff --git a/layer_khronos_validation/manifest.json b/layer_khronos_validation/manifest.json
@@ -0,0 +1,11 @@
+{
+  "file_format_version": "1.0.0",
+  "layer": {
+      "name": "VK_LAYER_KHRONOS_validation",
+      "type": "INSTANCE",
+      "library_path": "libVkLayer_khronos_validation.so",
+      "api_version": "1.0.0",
+      "implementation_version": "1",
+      "description": "Layer for Vulkan API validation"
+  }
+}
diff --git a/lgl_android_install.py b/lgl_android_install.py
@@ -63,7 +63,7 @@
 on the command line, with the first layer specified being the top of the stack
 closest to the application.
 
-An android_install.json file in the layer directory informs the script of the
+The manifest.json file in the layer directory informs the script of the
 layer string identifier and shared object library name. Layers without this
 file cannot be installed using this script.
 
@@ -91,9 +91,8 @@
 ===================
 
 Some layers use JSON configuration files to parameterize their behavior. If
-the android_install.json configuration file for a layer specifies that it
-requires a configuration file, this script will default to using the built-in
-layer_config.json found in the layer directory.
+a layer_config.json is found in the layer directory, the script will use this
+file by default.
 
 Users can override this, providing a custom configuration using the --config
 command line option to specify an alternative.
@@ -103,7 +102,7 @@
 
 This installer can be used to install the Khronos validation layers. A dummy
 layer directory, layer_khronos_validation, is provided for this purpose with a
-pre-populated android_install.json config file.
+pre-populated manifest.json config file.
 
 Download the latest Khronos validation layer binaries from GitHub, and copy the
 required Arm binaries into the appropriate build directory as described in the
@@ -147,7 +146,7 @@ class LayerMeta:
 
     Attributes:
         layer_dir: The directory name of the layer in the project.
-        name: The Vulkan name of the layer, e.g. VK_LAYER_LGL_EXAMPLE.
+        name: The Vulkan name of the layer, e.g. VK_LAYER_LGL_example.
         host_path: The file path of the layer library on the host filesystem.
         device_file: The file name to use on the device. May be different to
             the host_path file name.
@@ -163,7 +162,7 @@ def __init__(
 
         Args:
             layer_dir: The directory name of the layer in the project.
-            name: The Vulkan name of the layer, e.g. VK_LAYER_LGL_EXAMPLE.
+            name: The Vulkan name of the layer, e.g. VK_LAYER_LGL_example.
             host_path: The full file path on the host filesystem.
             device_file: The file name to use on the device.
             has_config: Does this layer need a configuration file?
@@ -331,20 +330,22 @@ def get_layer_metadata(
 
     for layer_dir in layer_dirs:
         # Parse the JSON metadata file
-        metadata_path = os.path.join(layer_dir, 'android_install.json')
+        metadata_path = os.path.join(layer_dir, 'manifest.json')
+        config_path = os.path.join(layer_dir, 'layer_config.json')
+
         if not os.path.isfile(metadata_path):
-            print(f'ERROR: {layer_dir} has no android_install.json')
+            print(f'ERROR: {layer_dir} has no manifest.json')
             return None
 
         with open(metadata_path, 'r', encoding='utf-8') as handle:
             config = json.load(handle)
 
         try:
-            layer_name = config['layer_name']
-            layer_binary = config['layer_binary']
-            has_config = config.get('has_config', False)
+            layer_name = config['layer']['name']
+            layer_binary = config['layer']['library_path']
+            has_config = os.path.isfile(config_path)
         except KeyError:
-            print(f'ERROR: {layer_dir} has invalid android_install.json')
+            print(f'ERROR: {layer_dir} has invalid manifest.json')
             return None
 
         # Check that the binary exists

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "layer": "VK_LAYER_LGL_GPUSUPPORT",`
	`2`	`+ "layer": "VK_LAYER_LGL_gpu_support",`
`3`	`3`	`"serialize": {`
`4`	`4`	`"all": false,`
`5`	`5`	`"none": false,`