Merge pull request #176 from rpavlik/layer-improvements

Layer improvements

Author: rpavlik

changes/sdk/pr.176.OpenXR-SDK-Source.md

@@ -0,0 +1 @@
+validation layer: Simplify some generated code, and minor performance improvements.

src/api_layers/core_validation.cpp

@@ -426,6 +426,24 @@ void InvalidStructureType(GenValidUsageXrInstanceInfo *instance_info, const std:
     }
 }
 
+std::string StructTypesToString(GenValidUsageXrInstanceInfo *instance_info, const std::vector<XrStructureType> &structs) {
+    char struct_type_buffer[XR_MAX_STRUCTURE_NAME_SIZE];
+    std::string error_message;
+    if (nullptr == instance_info) {
+        error_message = "UNKNOWN - no instance info available";
+        return error_message;
+    }
+    bool wrote_struct = false;
+    for (auto &s : structs)
+        if (XR_SUCCESS == instance_info->dispatch_table->StructureTypeToString(instance_info->instance, s, struct_type_buffer)) {
+            if (wrote_struct) {
+                error_message += ", ";
+            }
+            wrote_struct = true;
+            error_message += struct_type_buffer;
+        }
+    return error_message;
+}
 // NOTE: Can't validate the following VUIDs since the command never enters a layer:
 // Command: xrEnumerateApiLayerProperties
 //      VUIDs:  "VUID-xrEnumerateApiLayerProperties-propertyCountOutput-parameter"

src/api_layers/validation_utils.h

@@ -78,7 +78,7 @@ typedef std::unique_ptr<CoreValidationMessengerInfo, CoreValidationMessengerInfo
 struct GenValidUsageXrInstanceInfo {
     GenValidUsageXrInstanceInfo(XrInstance inst, PFN_xrGetInstanceProcAddr next_get_instance_proc_addr);
     ~GenValidUsageXrInstanceInfo();
-    const XrInstance instance;
+    XrInstance const instance;
     XrGeneratedDispatchTable *dispatch_table;
     std::vector<std::string> enabled_extensions;
     std::vector<UniqueCoreValidationMessengerInfo> debug_messengers;
@@ -208,6 +208,8 @@ void InvalidStructureType(GenValidUsageXrInstanceInfo *instance_info, const std:
                           const char *vuid = nullptr, XrStructureType expected = XrStructureType(0),
                           const char *expected_name = "");
 
+std::string StructTypesToString(GenValidUsageXrInstanceInfo *instance_info, const std::vector<XrStructureType> &structs);
+
 // -- Only implementations of templates follow --//
 
 template <typename HT, typename IT>

src/scripts/validation_layer_generator.py

@@ -389,7 +389,7 @@ def outputValidationInternalProtos(self):
         validation_internal_protos += '                    XrObjectType handle2_type, const uint64_t handle2,\n'
         validation_internal_protos += '                    bool check_this);\n'
         validation_internal_protos += '\n// Function to check if an extension has been enabled\n'
-        validation_internal_protos += 'bool ExtensionEnabled(std::vector<std::string> &extensions, const char* const check_extension_name);\n'
+        validation_internal_protos += 'bool ExtensionEnabled(const std::vector<std::string> &extensions, const char* const check_extension_name);\n'
         validation_internal_protos += '\n// Functions to validate structures\n'
         for xr_struct in self.api_structures:
             if xr_struct.protect_value:
@@ -605,9 +605,9 @@ def outputValidationHeaderInfo(self):
     # Generate C++ utility functions to verify that all the required extensions have been enabled.
     #   self            the ValidationSourceOutputGenerator object
     def writeVerifyExtensions(self):
-        verify_extensions = 'bool ExtensionEnabled(std::vector<std::string> &extensions, const char* const check_extension_name) {\n'
+        verify_extensions = 'bool ExtensionEnabled(const std::vector<std::string> &extensions, const char* const check_extension_name) {\n'
         verify_extensions += self.writeIndent(1)
-        verify_extensions += 'for (auto enabled_extension: extensions) {\n'
+        verify_extensions += 'for (const auto& enabled_extension: extensions) {\n'
         verify_extensions += self.writeIndent(2)
         verify_extensions += 'if (enabled_extension == check_extension_name) {\n'
         verify_extensions += self.writeIndent(3)
@@ -1007,35 +1007,7 @@ def writeValidateStructNextCheck(self, struct_type, struct_name, member, indent)
         validate_struct_next += self.writeIndent(indent + 1)
         validate_struct_next += 'error_message += "%s : ";\n' % struct_type
         validate_struct_next += self.writeIndent(indent + 1)
-        validate_struct_next += 'if (nullptr != instance_info) {\n'
-        validate_struct_next += self.writeIndent(indent + 2)
-        validate_struct_next += 'bool wrote_struct = false;\n'
-        validate_struct_next += self.writeIndent(indent + 2)
-        validate_struct_next += 'for (uint32_t dup = 0; dup < duplicate_ext_structs.size(); ++dup) {\n'
-        validate_struct_next += self.writeIndent(indent + 3)
-        validate_struct_next += 'if (XR_SUCCESS == instance_info->dispatch_table->StructureTypeToString(instance_info->instance,\n'
-        validate_struct_next += self.writeIndent(indent + 3)
-        validate_struct_next += '                                                                       duplicate_ext_structs[dup],\n'
-        validate_struct_next += self.writeIndent(indent + 3)
-        validate_struct_next += '                                                                       struct_type_buffer)) {\n'
-        validate_struct_next += self.writeIndent(indent + 4)
-        validate_struct_next += 'if (wrote_struct) {\n'
-        validate_struct_next += self.writeIndent(indent + 5)
-        validate_struct_next += 'error_message += ", ";\n'
-        validate_struct_next += self.writeIndent(indent + 4)
-        validate_struct_next += '} else {\n'
-        validate_struct_next += self.writeIndent(indent + 5)
-        validate_struct_next += 'wrote_struct = true;\n'
-        validate_struct_next += self.writeIndent(indent + 4)
-        validate_struct_next += '}\n'
-        validate_struct_next += self.writeIndent(indent + 4)
-        validate_struct_next += 'error_message += struct_type_buffer;\n'
-        validate_struct_next += self.writeIndent(indent + 3)
-        validate_struct_next += '}\n'
-        validate_struct_next += self.writeIndent(indent + 2)
-        validate_struct_next += '}\n'
-        validate_struct_next += self.writeIndent(indent + 1)
-        validate_struct_next += '}\n'
+        validate_struct_next += 'error_message += StructTypesToString(instance_info, duplicate_ext_structs);\n'
         validate_struct_next += self.writeIndent(indent + 1)
         validate_struct_next += 'CoreValidLogMessage(instance_info, "VUID-%s-next-unique",\n' % struct_type
         validate_struct_next += self.writeIndent(indent + 1)