layers: Remove extra properties pretty print setting

artem-lunarg · artem-lunarg · commit 50b87dd4be88 · 2025-05-02T01:10:55.000+02:00
diff --git a/layers/VkLayer_khronos_validation.json.in b/layers/VkLayer_khronos_validation.json.in
@@ -437,20 +437,6 @@
                                                     { "key": "validate_sync", "value": true }
                                                 ]
                                             }
-                                        },
-                                        {
-                                            "key": "syncval_message_extra_properties_pretty_print",
-                                            "label": "Pretty print extra properties",
-                                            "description": "Enable formatted output of key-value properties. Disabled by default to simplify pattern matching when filtering errors.",
-                                            "type": "BOOL",
-                                            "default": false,
-                                            "dependence": {
-                                                "mode": "ALL",
-                                                "settings": [
-                                                    { "key": "validate_sync", "value": true },
-                                                    { "key": "syncval_message_extra_properties", "value": true }
-                                                ]
-                                            }
                                         }
                                     ]
                                 }
diff --git a/layers/layer_options.cpp b/layers/layer_options.cpp
@@ -223,7 +223,6 @@ const char *VK_LAYER_GPUAV_DEBUG_PRINT_INSTRUMENTATION_INFO = "gpuav_debug_print
 const char *VK_LAYER_SYNCVAL_SUBMIT_TIME_VALIDATION = "syncval_submit_time_validation";
 const char *VK_LAYER_SYNCVAL_SHADER_ACCESSES_HEURISTIC = "syncval_shader_accesses_heuristic";
 const char *VK_LAYER_SYNCVAL_MESSAGE_EXTRA_PROPERTIES = "syncval_message_extra_properties";
-const char *VK_LAYER_SYNCVAL_MESSAGE_EXTRA_PROPERTIES_PRETTY_PRINT = "syncval_message_extra_properties_pretty_print";
 
 // Message Formatting
 // ---
@@ -632,8 +631,6 @@ static void ValidateLayerSettingsProvided(const VkLayerSettingsCreateInfoEXT *la
             required_type = VK_LAYER_SETTING_TYPE_BOOL32_EXT;
         } else if (strcmp(VK_LAYER_SYNCVAL_MESSAGE_EXTRA_PROPERTIES, setting.pSettingName) == 0) {
             required_type = VK_LAYER_SETTING_TYPE_BOOL32_EXT;
-        } else if (strcmp(VK_LAYER_SYNCVAL_MESSAGE_EXTRA_PROPERTIES_PRETTY_PRINT, setting.pSettingName) == 0) {
-            required_type = VK_LAYER_SETTING_TYPE_BOOL32_EXT;
         } else if (strcmp(VK_LAYER_MESSAGE_FORMAT_JSON, setting.pSettingName) == 0) {
             required_type = VK_LAYER_SETTING_TYPE_BOOL32_EXT;
         } else if (strcmp(VK_LAYER_MESSAGE_FORMAT_DISPLAY_APPLICATION_NAME, setting.pSettingName) == 0) {
@@ -1226,9 +1223,11 @@ void ProcessConfigAndEnvSettings(ConfigAndEnvSettings *settings_data) {
                                 syncval_settings.message_extra_properties);
     }
 
-    if (vkuHasLayerSetting(layer_setting_set, VK_LAYER_SYNCVAL_MESSAGE_EXTRA_PROPERTIES_PRETTY_PRINT)) {
-        vkuGetLayerSettingValue(layer_setting_set, VK_LAYER_SYNCVAL_MESSAGE_EXTRA_PROPERTIES_PRETTY_PRINT,
-                                syncval_settings.message_extra_properties_pretty_print);
+    const char *REMOVED_VK_LAYER_SYNCVAL_MESSAGE_EXTRA_PROPERTIES_PRETTY_PRINT = "syncval_message_extra_properties_pretty_print";
+    if (vkuHasLayerSetting(layer_setting_set, REMOVED_VK_LAYER_SYNCVAL_MESSAGE_EXTRA_PROPERTIES_PRETTY_PRINT)) {
+        setting_warnings.emplace_back(std::string(REMOVED_VK_LAYER_SYNCVAL_MESSAGE_EXTRA_PROPERTIES_PRETTY_PRINT) +
+                                      " was removed. The main purpose of the extra properties section is to filter syncval error "
+                                      "messages. The priority is to have a fixed and easy-to-parse layout.");
     }
 
     const auto *validation_features_ext = vku::FindStructInPNextChain<VkValidationFeaturesEXT>(settings_data->create_info);
diff --git a/layers/sync/sync_error_messages.cpp b/layers/sync/sync_error_messages.cpp
@@ -42,7 +42,7 @@ std::string ErrorMessages::Error(const HazardResult& hazard, const CommandExecut
             message += '\n';
         }
         const ReportProperties properties = GetErrorMessageProperties(hazard, context, command, message_type, additional_info);
-        message += properties.FormatExtraPropertiesSection(validator_.syncval_settings.message_extra_properties_pretty_print);
+        message += properties.FormatExtraPropertiesSection();
     }
     return message;
 }
diff --git a/layers/sync/sync_reporting.cpp b/layers/sync/sync_reporting.cpp
@@ -325,11 +325,10 @@ void ReportProperties::Add(std::string_view property_name, uint64_t value) {
     name_values.emplace_back(NameValue{std::string(property_name), std::to_string(value)});
 }
 
-std::string ReportProperties::FormatExtraPropertiesSection(bool pretty_print) const {
+std::string ReportProperties::FormatExtraPropertiesSection() const {
     if (name_values.empty()) {
         return {};
     }
-    const uint32_t pretty_print_alignment = 18;
     const auto sorted = SortKeyValues(name_values);
     std::stringstream ss;
     ss << "[Extra properties]\n";
@@ -339,11 +338,7 @@ std::string ReportProperties::FormatExtraPropertiesSection(bool pretty_print) co
             ss << "\n";
         }
         first = false;
-        uint32_t extra_space_count = 0;
-        if (pretty_print && property.name.length() < pretty_print_alignment) {
-            extra_space_count = pretty_print_alignment - (uint32_t)property.name.length();
-        }
-        ss << property.name << std::string(extra_space_count, ' ') << " = " << property.value;
+        ss << property.name << " = " << property.value;
     }
     return ss.str();
 }
diff --git a/layers/sync/sync_reporting.h b/layers/sync/sync_reporting.h
@@ -40,7 +40,7 @@ struct ReportProperties {
 
     void Add(std::string_view property_name, std::string_view value);
     void Add(std::string_view property_name, uint64_t value);
-    std::string FormatExtraPropertiesSection(bool pretty_print) const;
+    std::string FormatExtraPropertiesSection() const;
 };
 
 // Customization options to modify the standard form of the synchronization error message.
diff --git a/layers/sync/sync_settings.h b/layers/sync/sync_settings.h
@@ -1,6 +1,6 @@
-/* Copyright (c) 2024 The Khronos Group Inc.
- * Copyright (c) 2024 Valve Corporation
- * Copyright (c) 2024 LunarG, Inc.
+/* Copyright (c) 2025 The Khronos Group Inc.
+ * Copyright (c) 2025 Valve Corporation
+ * Copyright (c) 2025 LunarG, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,5 +21,4 @@ struct SyncValSettings {
     bool submit_time_validation = true;
     bool shader_accesses_heuristic = false;
     bool message_extra_properties = false;
-    bool message_extra_properties_pretty_print = false;
 };
diff --git a/tests/unit/layer_settings_positive.cpp b/tests/unit/layer_settings_positive.cpp
@@ -74,7 +74,6 @@ TEST_F(PositiveLayerSettings, AllSettings) {
         {OBJECT_LAYER_NAME, "syncval_submit_time_validation", VK_LAYER_SETTING_TYPE_BOOL32_EXT, 1, &disable},
         {OBJECT_LAYER_NAME, "syncval_shader_accesses_heuristic", VK_LAYER_SETTING_TYPE_BOOL32_EXT, 1, &disable},
         {OBJECT_LAYER_NAME, "syncval_message_extra_properties", VK_LAYER_SETTING_TYPE_BOOL32_EXT, 1, &disable},
-        {OBJECT_LAYER_NAME, "syncval_message_extra_properties_pretty_print", VK_LAYER_SETTING_TYPE_BOOL32_EXT, 1, &disable},
         {OBJECT_LAYER_NAME, "message_format_display_application_name", VK_LAYER_SETTING_TYPE_BOOL32_EXT, 1, &disable},
         {OBJECT_LAYER_NAME, "message_format_json", VK_LAYER_SETTING_TYPE_BOOL32_EXT, 1, &disable},
         {OBJECT_LAYER_NAME, "debug_action", VK_LAYER_SETTING_TYPE_STRING_EXT, 1, &action_ignore},

Original file line number	Diff line number	Diff line change
`@@ -437,20 +437,6 @@`
`437`	`437`	`{ "key": "validate_sync", "value": true }`
`438`	`438`	`]`
`439`	`439`	`}`
`440`		`- },`
`441`		`- {`
`442`		`- "key": "syncval_message_extra_properties_pretty_print",`
`443`		`- "label": "Pretty print extra properties",`
`444`		`- "description": "Enable formatted output of key-value properties. Disabled by default to simplify pattern matching when filtering errors.",`
`445`		`- "type": "BOOL",`
`446`		`- "default": false,`
`447`		`- "dependence": {`
`448`		`- "mode": "ALL",`
`449`		`- "settings": [`
`450`		`- { "key": "validate_sync", "value": true },`
`451`		`- { "key": "syncval_message_extra_properties", "value": true }`
`452`		`- ]`
`453`		`- }`
`454`	`440`	`}`
`455`	`441`	`]`
`456`	`442`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ std::string ErrorMessages::Error(const HazardResult& hazard, const CommandExecut`
`42`	`42`	`message += '\n';`
`43`	`43`	`}`
`44`	`44`	`const ReportProperties properties = GetErrorMessageProperties(hazard, context, command, message_type, additional_info);`
`45`		`- message += properties.FormatExtraPropertiesSection(validator_.syncval_settings.message_extra_properties_pretty_print);`
	`45`	`+ message += properties.FormatExtraPropertiesSection();`
`46`	`46`	`}`
`47`	`47`	`return message;`
`48`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -325,11 +325,10 @@ void ReportProperties::Add(std::string_view property_name, uint64_t value) {`
`325`	`325`	`name_values.emplace_back(NameValue{std::string(property_name), std::to_string(value)});`
`326`	`326`	`}`
`327`	`327`
`328`		`-std::string ReportProperties::FormatExtraPropertiesSection(bool pretty_print) const {`
	`328`	`+std::string ReportProperties::FormatExtraPropertiesSection() const {`
`329`	`329`	`if (name_values.empty()) {`
`330`	`330`	`return {};`
`331`	`331`	`}`
`332`		`- const uint32_t pretty_print_alignment = 18;`
`333`	`332`	`const auto sorted = SortKeyValues(name_values);`
`334`	`333`	`std::stringstream ss;`
`335`	`334`	`ss << "[Extra properties]\n";`
`@@ -339,11 +338,7 @@ std::string ReportProperties::FormatExtraPropertiesSection(bool pretty_print) co`
`339`	`338`	`ss << "\n";`
`340`	`339`	`}`
`341`	`340`	`first = false;`
`342`		`- uint32_t extra_space_count = 0;`
`343`		`- if (pretty_print && property.name.length() < pretty_print_alignment) {`
`344`		`- extra_space_count = pretty_print_alignment - (uint32_t)property.name.length();`
`345`		`- }`
`346`		`- ss << property.name << std::string(extra_space_count, ' ') << " = " << property.value;`
	`341`	`+ ss << property.name << " = " << property.value;`
`347`	`342`	`}`
`348`	`343`	`return ss.str();`
`349`	`344`	`}`