| #!/usr/bin/python3 -i |
| # |
| # Copyright (c) 2015-2024 The Khronos Group Inc. |
| # Copyright (c) 2015-2024 Valve Corporation |
| # Copyright (c) 2015-2024 LunarG, Inc. |
| # |
| # Licensed under the Apache License, Version 2.0 (the "License"); |
| # you may not use this file except in compliance with the License. |
| # You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, software |
| # distributed under the License is distributed on an "AS IS" BASIS, |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| # See the License for the specific language governing permissions and |
| # limitations under the License. |
| |
| import os |
| from generators.base_generator import BaseGenerator |
| from generators.generator_utils import PlatformGuardHelper |
| |
| # If there is another success code other than VK_SUCCESS |
| def hasNonVkSuccess(successCodes: list[str]) -> bool: |
| if successCodes is None or len(successCodes) == 0: |
| return False |
| return len(successCodes) > 1 or 'VK_SUCCESS' not in successCodes |
| |
| class BestPracticesOutputGenerator(BaseGenerator): |
| def __init__(self): |
| BaseGenerator.__init__(self) |
| |
| # Commands which are not autogenerated but still intercepted |
| # More are added from a first pass over the functions |
| self.no_autogen_list = [ |
| 'vkEnumerateInstanceVersion', |
| 'vkCreateValidationCacheEXT', |
| 'vkDestroyValidationCacheEXT', |
| 'vkMergeValidationCachesEXT', |
| 'vkGetValidationCacheDataEXT', |
| ] |
| |
| # Commands that require an extra parameter for state sharing between validate/record steps |
| self.extra_parameter_map = { |
| 'vkCreateShaderModule' : 'chassis::CreateShaderModule', |
| 'vkCreateShadersEXT' : 'chassis::ShaderObject', |
| 'vkAllocateDescriptorSets' : 'vvl::AllocateDescriptorSetsData', |
| } |
| self.pipeline_parameter_map = { |
| 'vkCreateGraphicsPipelines' : 'chassis::CreateGraphicsPipelines&', |
| 'vkCreateComputePipelines' : 'chassis::CreateComputePipelines&', |
| 'vkCreateRayTracingPipelinesNV' : 'chassis::CreateRayTracingPipelinesNV&', |
| 'vkCreateRayTracingPipelinesKHR' : 'std::shared_ptr<chassis::CreateRayTracingPipelinesKHR>', |
| } |
| # Commands that have a manually written post-call-record step which needs to be called from the autogen'd fcn |
| self.manual_postcallrecord_list = [ |
| 'vkAllocateDescriptorSets', |
| 'vkQueuePresentKHR', |
| 'vkQueueBindSparse', |
| 'vkCreateGraphicsPipelines', |
| 'vkGetPhysicalDeviceSurfaceCapabilitiesKHR', |
| 'vkGetPhysicalDeviceSurfaceCapabilities2KHR', |
| 'vkGetPhysicalDeviceSurfaceCapabilities2EXT', |
| 'vkGetPhysicalDeviceSurfacePresentModesKHR', |
| 'vkGetPhysicalDeviceSurfaceFormatsKHR', |
| 'vkGetPhysicalDeviceSurfaceFormats2KHR', |
| 'vkGetPhysicalDeviceDisplayPlanePropertiesKHR', |
| 'vkGetSwapchainImagesKHR', |
| 'vkBindBufferMemory2', |
| 'vkBindImageMemory2', |
| # AMD tracked |
| 'vkCreateComputePipelines', |
| 'vkCmdPipelineBarrier', |
| 'vkQueueSubmit', |
| ] |
| |
| self.extension_info = dict() |
| |
| def generate(self): |
| self.write(f'''// *** THIS FILE IS GENERATED - DO NOT EDIT *** |
| // See {os.path.basename(__file__)} for modifications |
| |
| /*************************************************************************** |
| * |
| * Copyright (c) 2015-2024 The Khronos Group Inc. |
| * Copyright (c) 2015-2024 Valve Corporation |
| * Copyright (c) 2015-2024 LunarG, Inc. |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| ****************************************************************************/\n''') |
| self.write('// NOLINTBEGIN') # Wrap for clang-tidy to ignore |
| |
| # Build additional pass of functions to ignore |
| for name, command in self.vk.commands.items(): |
| if command.returnType != 'VkResult': |
| self.no_autogen_list.append(name) |
| # This is just to remove un-used commands from be generated |
| # This can be removed if another use for these commands are needed |
| if (command.errorCodes is None and not hasNonVkSuccess(command.successCodes)): |
| self.no_autogen_list.append(name) |
| |
| if self.filename == 'best_practices.h': |
| self.generateHeader() |
| elif self.filename == 'best_practices.cpp': |
| self.generateSource() |
| else: |
| self.write(f'\nFile name {self.filename} has no code to generate\n') |
| |
| self.write('// NOLINTEND') # Wrap for clang-tidy to ignore |
| |
| def generateHeader(self): |
| out = [] |
| guard_helper = PlatformGuardHelper() |
| # List all Function declarations |
| for command in [x for x in self.vk.commands.values() if x.name not in self.no_autogen_list]: |
| out.extend(guard_helper.add_guard(command.protect)) |
| prototype = command.cPrototype.split("VKAPI_CALL ")[1] |
| prototype = f'void PostCallRecord{prototype[2:]}' |
| prototype = prototype.replace(');', ', const RecordObject& record_obj) {\n') |
| prototype = prototype.replace(') {', ') override;\n') |
| if command.name in self.extra_parameter_map: |
| prototype = prototype.replace(')', f', {self.extra_parameter_map[command.name]}& chassis_state)') |
| elif command.name in self.pipeline_parameter_map: |
| prototype = prototype.replace(')', f', PipelineStates& pipeline_states, {self.pipeline_parameter_map[command.name]} chassis_state)') |
| out.append(prototype) |
| out.extend(guard_helper.add_guard(None)) |
| self.write("".join(out)) |
| |
| def generateSource(self): |
| guard_helper = PlatformGuardHelper() |
| out = [] |
| out.append(''' |
| #include "best_practices/best_practices_validation.h" |
| |
| DeprecationData GetDeprecatedData(vvl::Extension extension_name) { |
| static const DeprecationData empty_deprecated_data{DeprecationReason::Empty, vvl::Extension::Empty}; |
| static const vvl::unordered_map<vvl::Extension, DeprecationData> deprecated_extensions = { |
| ''') |
| for extension in self.vk.extensions.values(): |
| target = None |
| reason = None |
| if extension.promotedTo is not None: |
| reason = 'DeprecationReason::Promoted' |
| target = extension.promotedTo |
| elif extension.obsoletedBy is not None: |
| reason = 'DeprecationReason::Obsoleted' |
| target = extension.obsoletedBy |
| elif extension.deprecatedBy is not None: |
| reason = 'DeprecationReason::Deprecated' |
| target = extension.deprecatedBy |
| else: |
| continue |
| |
| if len(target) == 0: |
| target = 'vvl::Extension::Empty' |
| elif 'VERSION' in target: |
| target = f'vvl::Version::_{target}' |
| else: |
| target = f'vvl::Extension::_{target}' |
| |
| out.append(f' {{vvl::Extension::_{extension.name}, {{{reason}, {{{target}}}}}}},\n') |
| out.append(''' }; |
| |
| auto it = deprecated_extensions.find(extension_name); |
| return (it == deprecated_extensions.end()) ? empty_deprecated_data : it->second; |
| } |
| |
| std::string GetSpecialUse(vvl::Extension extension_name) { |
| const vvl::unordered_map<vvl::Extension, std::string> special_use_extensions = { |
| ''') |
| for extension in self.vk.extensions.values(): |
| if extension.specialUse is not None: |
| out.append(f' {{vvl::Extension::_{extension.name}, "{", ".join(extension.specialUse)}"}},\n') |
| out.append(''' }; |
| |
| auto it = special_use_extensions.find(extension_name); |
| return (it == special_use_extensions.end()) ? "" : it->second; |
| } |
| ''') |
| |
| for command in [x for x in self.vk.commands.values() if x.name not in self.no_autogen_list]: |
| paramList = [param.name for param in command.params] |
| paramList.append('record_obj') |
| if command.name in self.extra_parameter_map: |
| paramList.append('chassis_state') |
| elif command.name in self.pipeline_parameter_map: |
| paramList.append('pipeline_states') |
| paramList.append('chassis_state') |
| params = ', '.join(paramList) |
| |
| out.extend(guard_helper.add_guard(command.protect, extra_newline=True)) |
| prototype = command.cPrototype.split("VKAPI_CALL ")[1] |
| prototype = f'void BestPractices::PostCallRecord{prototype[2:]}' |
| prototype = prototype.replace(');', ', const RecordObject& record_obj) {\n') |
| if command.name in self.extra_parameter_map: |
| prototype = prototype.replace(')', f', {self.extra_parameter_map[command.name]}& chassis_state)') |
| elif command.name in self.pipeline_parameter_map: |
| prototype = prototype.replace(')', f', PipelineStates& pipeline_states, {self.pipeline_parameter_map[command.name]} chassis_state)') |
| out.append(prototype) |
| |
| if command.alias: |
| # For alias that are promoted, just point to new function, RecordObject will allow us to distinguish the caller |
| paramList = [param.name for param in command.params] |
| paramList.append('record_obj') |
| params = ', '.join(paramList) |
| out.append(f'PostCallRecord{command.alias[2:]}({params});') |
| else: |
| out.append(f'BaseClass::PostCallRecord{command.name[2:]}({params});\n') |
| if command.name in self.manual_postcallrecord_list: |
| out.append(f'ManualPostCallRecord{command.name[2:]}({params});\n') |
| |
| if hasNonVkSuccess(command.successCodes): |
| out.append(''' |
| if (record_obj.result > VK_SUCCESS) { |
| LogPositiveSuccessCode(record_obj); |
| return; |
| }''') |
| |
| if command.errorCodes is not None: |
| out.append(''' |
| if (record_obj.result < VK_SUCCESS) { |
| LogErrorCode(record_obj); |
| }''') |
| |
| out.append('}\n') |
| out.extend(guard_helper.add_guard(None, extra_newline=True)) |
| self.write(''.join(out)) |
