Skip to content

legacy: Add warning about layers and VMA #12293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
spencer-lunarg wants to merge 1 commit into
base: main
Choose a base branch
from
+84 −55
Open

legacy: Add warning about layers and VMA #12293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
131 changes: 78 additions & 53 deletions layers/vulkan/generated/legacy.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,19 @@ bool Instance::PreCallValidateGetPhysicalDeviceFeatures(VkPhysicalDevice physica
reported = true;
LogWarning("WARNING-legacy-gpdp2", physicalDevice, error_obj.location,
"vkGetPhysicalDeviceFeatures is a legacy command and this VkInstance was created with VK_VERSION_1_1 which "
"contains vkGetPhysicalDeviceFeatures2 that can be used instead.\nSee more information about this legacy in the "
"specification: https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
"contains vkGetPhysicalDeviceFeatures2 that can be used instead.\nNOTE: Many implicit layers and libraries "
"(such as VMA) are known to still be using these functions. One may add \"WARNING-legacy-gpdp2\" to their VUID "
"Mute Message list to ignore these.\nSee more information about this legacy in the specification: "
"https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
} else if (IsExtEnabled(extensions.vk_khr_get_physical_device_properties2)) {
reported = true;
LogWarning("WARNING-legacy-gpdp2", physicalDevice, error_obj.location,
"vkGetPhysicalDeviceFeatures is a legacy command and this VkInstance enabled the "
"VK_KHR_get_physical_device_properties2 extension which contains vkGetPhysicalDeviceFeatures2KHR that can be "
"used instead.\nSee more information about this legacy in the specification: "
"https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
LogWarning(
"WARNING-legacy-gpdp2", physicalDevice, error_obj.location,
"vkGetPhysicalDeviceFeatures is a legacy command and this VkInstance enabled the "
"VK_KHR_get_physical_device_properties2 extension which contains vkGetPhysicalDeviceFeatures2KHR that can be used "
"instead.\nNOTE: Many implicit layers and libraries (such as VMA) are known to still be using these functions. One may "
"add \"WARNING-legacy-gpdp2\" to their VUID Mute Message list to ignore these.\nSee more information about this legacy "
"in the specification: https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
}
return false;
}
Expand All @@ -58,15 +62,19 @@ bool Instance::PreCallValidateGetPhysicalDeviceFormatProperties(VkPhysicalDevice
reported = true;
LogWarning("WARNING-legacy-gpdp2", physicalDevice, error_obj.location,
"vkGetPhysicalDeviceFormatProperties is a legacy command and this VkInstance was created with VK_VERSION_1_1 "
"which contains vkGetPhysicalDeviceFormatProperties2 that can be used instead.\nSee more information about this "
"legacy in the specification: https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
"which contains vkGetPhysicalDeviceFormatProperties2 that can be used instead.\nNOTE: Many implicit layers and "
"libraries (such as VMA) are known to still be using these functions. One may add \"WARNING-legacy-gpdp2\" to "
"their VUID Mute Message list to ignore these.\nSee more information about this legacy in the specification: "
"https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
} else if (IsExtEnabled(extensions.vk_khr_get_physical_device_properties2)) {
reported = true;
LogWarning("WARNING-legacy-gpdp2", physicalDevice, error_obj.location,
"vkGetPhysicalDeviceFormatProperties is a legacy command and this VkInstance enabled the "
"VK_KHR_get_physical_device_properties2 extension which contains vkGetPhysicalDeviceFormatProperties2KHR that "
"can be used instead.\nSee more information about this legacy in the specification: "
"https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
LogWarning(
"WARNING-legacy-gpdp2", physicalDevice, error_obj.location,
"vkGetPhysicalDeviceFormatProperties is a legacy command and this VkInstance enabled the "
"VK_KHR_get_physical_device_properties2 extension which contains vkGetPhysicalDeviceFormatProperties2KHR that can be "
"used instead.\nNOTE: Many implicit layers and libraries (such as VMA) are known to still be using these functions. "
"One may add \"WARNING-legacy-gpdp2\" to their VUID Mute Message list to ignore these.\nSee more information about "
"this legacy in the specification: https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
}
return false;
}
Expand All @@ -81,18 +89,21 @@ bool Instance::PreCallValidateGetPhysicalDeviceImageFormatProperties(VkPhysicalD

if (api_version >= VK_API_VERSION_1_1) {
reported = true;
LogWarning(
"WARNING-legacy-gpdp2", physicalDevice, error_obj.location,
"vkGetPhysicalDeviceImageFormatProperties is a legacy command and this VkInstance was created with VK_VERSION_1_1 "
"which contains vkGetPhysicalDeviceImageFormatProperties2 that can be used instead.\nSee more information about this "
"legacy in the specification: https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
LogWarning("WARNING-legacy-gpdp2", physicalDevice, error_obj.location,
"vkGetPhysicalDeviceImageFormatProperties is a legacy command and this VkInstance was created with "
"VK_VERSION_1_1 which contains vkGetPhysicalDeviceImageFormatProperties2 that can be used instead.\nNOTE: Many "
"implicit layers and libraries (such as VMA) are known to still be using these functions. One may add "
"\"WARNING-legacy-gpdp2\" to their VUID Mute Message list to ignore these.\nSee more information about this "
"legacy in the specification: https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
} else if (IsExtEnabled(extensions.vk_khr_get_physical_device_properties2)) {
reported = true;
LogWarning("WARNING-legacy-gpdp2", physicalDevice, error_obj.location,
"vkGetPhysicalDeviceImageFormatProperties is a legacy command and this VkInstance enabled the "
"VK_KHR_get_physical_device_properties2 extension which contains vkGetPhysicalDeviceImageFormatProperties2KHR "
"that can be used instead.\nSee more information about this legacy in the specification: "
"https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
LogWarning(
"WARNING-legacy-gpdp2", physicalDevice, error_obj.location,
"vkGetPhysicalDeviceImageFormatProperties is a legacy command and this VkInstance enabled the "
"VK_KHR_get_physical_device_properties2 extension which contains vkGetPhysicalDeviceImageFormatProperties2KHR that can "
"be used instead.\nNOTE: Many implicit layers and libraries (such as VMA) are known to still be using these functions. "
"One may add \"WARNING-legacy-gpdp2\" to their VUID Mute Message list to ignore these.\nSee more information about "
"this legacy in the specification: https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
}
return false;
}
Expand All @@ -106,15 +117,19 @@ bool Instance::PreCallValidateGetPhysicalDeviceProperties(VkPhysicalDevice physi
reported = true;
LogWarning("WARNING-legacy-gpdp2", physicalDevice, error_obj.location,
"vkGetPhysicalDeviceProperties is a legacy command and this VkInstance was created with VK_VERSION_1_1 which "
"contains vkGetPhysicalDeviceProperties2 that can be used instead.\nSee more information about this legacy in "
"the specification: https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
"contains vkGetPhysicalDeviceProperties2 that can be used instead.\nNOTE: Many implicit layers and libraries "
"(such as VMA) are known to still be using these functions. One may add \"WARNING-legacy-gpdp2\" to their VUID "
"Mute Message list to ignore these.\nSee more information about this legacy in the specification: "
"https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
} else if (IsExtEnabled(extensions.vk_khr_get_physical_device_properties2)) {
reported = true;
LogWarning("WARNING-legacy-gpdp2", physicalDevice, error_obj.location,
"vkGetPhysicalDeviceProperties is a legacy command and this VkInstance enabled the "
"VK_KHR_get_physical_device_properties2 extension which contains vkGetPhysicalDeviceProperties2KHR that can be "
"used instead.\nSee more information about this legacy in the specification: "
"https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
LogWarning(
"WARNING-legacy-gpdp2", physicalDevice, error_obj.location,
"vkGetPhysicalDeviceProperties is a legacy command and this VkInstance enabled the "
"VK_KHR_get_physical_device_properties2 extension which contains vkGetPhysicalDeviceProperties2KHR that can be used "
"instead.\nNOTE: Many implicit layers and libraries (such as VMA) are known to still be using these functions. One may "
"add \"WARNING-legacy-gpdp2\" to their VUID Mute Message list to ignore these.\nSee more information about this legacy "
"in the specification: https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
}
return false;
}
Expand All @@ -128,18 +143,21 @@ bool Instance::PreCallValidateGetPhysicalDeviceQueueFamilyProperties(VkPhysicalD

if (api_version >= VK_API_VERSION_1_1) {
reported = true;
LogWarning(
"WARNING-legacy-gpdp2", physicalDevice, error_obj.location,
"vkGetPhysicalDeviceQueueFamilyProperties is a legacy command and this VkInstance was created with VK_VERSION_1_1 "
"which contains vkGetPhysicalDeviceQueueFamilyProperties2 that can be used instead.\nSee more information about this "
"legacy in the specification: https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
LogWarning("WARNING-legacy-gpdp2", physicalDevice, error_obj.location,
"vkGetPhysicalDeviceQueueFamilyProperties is a legacy command and this VkInstance was created with "
"VK_VERSION_1_1 which contains vkGetPhysicalDeviceQueueFamilyProperties2 that can be used instead.\nNOTE: Many "
"implicit layers and libraries (such as VMA) are known to still be using these functions. One may add "
"\"WARNING-legacy-gpdp2\" to their VUID Mute Message list to ignore these.\nSee more information about this "
"legacy in the specification: https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
} else if (IsExtEnabled(extensions.vk_khr_get_physical_device_properties2)) {
reported = true;
LogWarning("WARNING-legacy-gpdp2", physicalDevice, error_obj.location,
"vkGetPhysicalDeviceQueueFamilyProperties is a legacy command and this VkInstance enabled the "
"VK_KHR_get_physical_device_properties2 extension which contains vkGetPhysicalDeviceQueueFamilyProperties2KHR "
"that can be used instead.\nSee more information about this legacy in the specification: "
"https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
LogWarning(
"WARNING-legacy-gpdp2", physicalDevice, error_obj.location,
"vkGetPhysicalDeviceQueueFamilyProperties is a legacy command and this VkInstance enabled the "
"VK_KHR_get_physical_device_properties2 extension which contains vkGetPhysicalDeviceQueueFamilyProperties2KHR that can "
"be used instead.\nNOTE: Many implicit layers and libraries (such as VMA) are known to still be using these functions. "
"One may add \"WARNING-legacy-gpdp2\" to their VUID Mute Message list to ignore these.\nSee more information about "
"this legacy in the specification: https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
}
return false;
}
Expand All @@ -154,15 +172,19 @@ bool Instance::PreCallValidateGetPhysicalDeviceMemoryProperties(VkPhysicalDevice
reported = true;
LogWarning("WARNING-legacy-gpdp2", physicalDevice, error_obj.location,
"vkGetPhysicalDeviceMemoryProperties is a legacy command and this VkInstance was created with VK_VERSION_1_1 "
"which contains vkGetPhysicalDeviceMemoryProperties2 that can be used instead.\nSee more information about this "
"legacy in the specification: https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
"which contains vkGetPhysicalDeviceMemoryProperties2 that can be used instead.\nNOTE: Many implicit layers and "
"libraries (such as VMA) are known to still be using these functions. One may add \"WARNING-legacy-gpdp2\" to "
"their VUID Mute Message list to ignore these.\nSee more information about this legacy in the specification: "
"https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
} else if (IsExtEnabled(extensions.vk_khr_get_physical_device_properties2)) {
reported = true;
LogWarning("WARNING-legacy-gpdp2", physicalDevice, error_obj.location,
"vkGetPhysicalDeviceMemoryProperties is a legacy command and this VkInstance enabled the "
"VK_KHR_get_physical_device_properties2 extension which contains vkGetPhysicalDeviceMemoryProperties2KHR that "
"can be used instead.\nSee more information about this legacy in the specification: "
"https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
LogWarning(
"WARNING-legacy-gpdp2", physicalDevice, error_obj.location,
"vkGetPhysicalDeviceMemoryProperties is a legacy command and this VkInstance enabled the "
"VK_KHR_get_physical_device_properties2 extension which contains vkGetPhysicalDeviceMemoryProperties2KHR that can be "
"used instead.\nNOTE: Many implicit layers and libraries (such as VMA) are known to still be using these functions. "
"One may add \"WARNING-legacy-gpdp2\" to their VUID Mute Message list to ignore these.\nSee more information about "
"this legacy in the specification: https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
}
return false;
}
Expand Down Expand Up @@ -213,16 +235,19 @@ bool Instance::PreCallValidateGetPhysicalDeviceSparseImageFormatProperties(VkPhy
reported = true;
LogWarning("WARNING-legacy-gpdp2", physicalDevice, error_obj.location,
"vkGetPhysicalDeviceSparseImageFormatProperties is a legacy command and this VkInstance was created with "
"VK_VERSION_1_1 which contains vkGetPhysicalDeviceSparseImageFormatProperties2 that can be used instead.\nSee "
"more information about this legacy in the specification: "
"https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
"VK_VERSION_1_1 which contains vkGetPhysicalDeviceSparseImageFormatProperties2 that can be used instead.\nNOTE: "
"Many implicit layers and libraries (such as VMA) are known to still be using these functions. One may add "
"\"WARNING-legacy-gpdp2\" to their VUID Mute Message list to ignore these.\nSee more information about this "
"legacy in the specification: https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
} else if (IsExtEnabled(extensions.vk_khr_get_physical_device_properties2)) {
reported = true;
LogWarning("WARNING-legacy-gpdp2", physicalDevice, error_obj.location,
"vkGetPhysicalDeviceSparseImageFormatProperties is a legacy command and this VkInstance enabled the "
"VK_KHR_get_physical_device_properties2 extension which contains "
"vkGetPhysicalDeviceSparseImageFormatProperties2KHR that can be used instead.\nSee more information about this "
"legacy in the specification: https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
"vkGetPhysicalDeviceSparseImageFormatProperties2KHR that can be used instead.\nNOTE: Many implicit layers and "
"libraries (such as VMA) are known to still be using these functions. One may add \"WARNING-legacy-gpdp2\" to "
"their VUID Mute Message list to ignore these.\nSee more information about this legacy in the specification: "
"https://docs.vulkan.org/spec/latest/appendices/legacy.html#legacy-gpdp2");
}
return false;
}
Expand Down
8 changes: 6 additions & 2 deletions scripts/generators/legacy_generator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,10 @@ def generateSource(self):
if command.name.startswith('vkDestroy'):
continue

extra = ''
if command.legacy.link == 'legacy-gpdp2':
extra = "\\nNOTE: Many implicit layers and libraries (such as VMA) are known to still be using these functions. One may add \\\"WARNING-legacy-gpdp2\\\" to their VUID Mute Message list to ignore these."

className = 'Device' if command.device else 'Instance'
handleName = 'VkDevice' if command.device else 'VkInstance'
objName = 'device' if command.device else 'physicalDevice'
Expand All @@ -182,7 +186,7 @@ def generateSource(self):
{logic} (api_version >= {command.legacy.version.nameApi}) {{
reported = true;
LogWarning("WARNING-{command.legacy.link}", {objName}, error_obj.location,
"{command.name} is a legacy command and this {handleName} was created with {command.legacy.version.name} {replacement}.\\nSee more information about this legacy in the specification: https://docs.vulkan.org/spec/latest/appendices/legacy.html#{command.legacy.link}");
"{command.name} is a legacy command and this {handleName} was created with {command.legacy.version.name} {replacement}.{extra}\\nSee more information about this legacy in the specification: https://docs.vulkan.org/spec/latest/appendices/legacy.html#{command.legacy.link}");
}}''')

for extension in command.legacy.extensions:
Expand All @@ -208,7 +212,7 @@ def generateSource(self):
{logic} (IsExtEnabled(extensions.{extension.lower()})) {{
reported = true;
LogWarning("WARNING-{command.legacy.link}", {objName}, error_obj.location,
"{command.name} is a legacy command and this {handleName} enabled the {extension} extension {replacement}.\\nSee more information about this legacy in the specification: https://docs.vulkan.org/spec/latest/appendices/legacy.html#{command.legacy.link}");
"{command.name} is a legacy command and this {handleName} enabled the {extension} extension {replacement}.{extra}\\nSee more information about this legacy in the specification: https://docs.vulkan.org/spec/latest/appendices/legacy.html#{command.legacy.link}");
}}''')

# For things mark as legacy in Vulkan 1.0
Expand Down
Loading