Mark Lobodzinski | d146148 | 2017-07-18 13:56:09 -0600 | [diff] [blame] | 1 | #!/usr/bin/python3 -i |
| 2 | # |
| 3 | # Copyright (c) 2015-2017 The Khronos Group Inc. |
| 4 | # Copyright (c) 2015-2017 Valve Corporation |
| 5 | # Copyright (c) 2015-2017 LunarG, Inc. |
| 6 | # Copyright (c) 2015-2017 Google Inc. |
| 7 | # |
| 8 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 9 | # you may not use this file except in compliance with the License. |
| 10 | # You may obtain a copy of the License at |
| 11 | # |
| 12 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 13 | # |
| 14 | # Unless required by applicable law or agreed to in writing, software |
| 15 | # distributed under the License is distributed on an "AS IS" BASIS, |
| 16 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 17 | # See the License for the specific language governing permissions and |
| 18 | # limitations under the License. |
| 19 | # |
| 20 | # Author: Mark Lobodzinski <mark@lunarg.com> |
| 21 | |
| 22 | import os,re,sys,string |
| 23 | import xml.etree.ElementTree as etree |
| 24 | from generator import * |
| 25 | from collections import namedtuple |
| 26 | from vuid_mapping import * |
Mark Lobodzinski | 62f7156 | 2017-10-24 13:41:18 -0600 | [diff] [blame] | 27 | from common_codegen import * |
Mark Lobodzinski | d146148 | 2017-07-18 13:56:09 -0600 | [diff] [blame] | 28 | |
Jamie Madill | 8d4cda2 | 2017-11-08 13:40:09 -0500 | [diff] [blame] | 29 | # This is a workaround to use a Python 2.7 and 3.x compatible syntax. |
| 30 | from io import open |
| 31 | |
Mark Lobodzinski | d146148 | 2017-07-18 13:56:09 -0600 | [diff] [blame] | 32 | # ObjectTrackerGeneratorOptions - subclass of GeneratorOptions. |
| 33 | # |
| 34 | # Adds options used by ObjectTrackerOutputGenerator objects during |
| 35 | # object_tracker layer generation. |
| 36 | # |
| 37 | # Additional members |
| 38 | # prefixText - list of strings to prefix generated header with |
| 39 | # (usually a copyright statement + calling convention macros). |
| 40 | # protectFile - True if multiple inclusion protection should be |
| 41 | # generated (based on the filename) around the entire header. |
| 42 | # protectFeature - True if #ifndef..#endif protection should be |
| 43 | # generated around a feature interface in the header file. |
| 44 | # genFuncPointers - True if function pointer typedefs should be |
| 45 | # generated |
| 46 | # protectProto - If conditional protection should be generated |
| 47 | # around prototype declarations, set to either '#ifdef' |
| 48 | # to require opt-in (#ifdef protectProtoStr) or '#ifndef' |
| 49 | # to require opt-out (#ifndef protectProtoStr). Otherwise |
| 50 | # set to None. |
| 51 | # protectProtoStr - #ifdef/#ifndef symbol to use around prototype |
| 52 | # declarations, if protectProto is set |
| 53 | # apicall - string to use for the function declaration prefix, |
| 54 | # such as APICALL on Windows. |
| 55 | # apientry - string to use for the calling convention macro, |
| 56 | # in typedefs, such as APIENTRY. |
| 57 | # apientryp - string to use for the calling convention macro |
| 58 | # in function pointer typedefs, such as APIENTRYP. |
| 59 | # indentFuncProto - True if prototype declarations should put each |
| 60 | # parameter on a separate line |
| 61 | # indentFuncPointer - True if typedefed function pointers should put each |
| 62 | # parameter on a separate line |
| 63 | # alignFuncParam - if nonzero and parameters are being put on a |
| 64 | # separate line, align parameter names at the specified column |
| 65 | class ObjectTrackerGeneratorOptions(GeneratorOptions): |
| 66 | def __init__(self, |
| 67 | filename = None, |
| 68 | directory = '.', |
| 69 | apiname = None, |
| 70 | profile = None, |
| 71 | versions = '.*', |
| 72 | emitversions = '.*', |
| 73 | defaultExtensions = None, |
| 74 | addExtensions = None, |
| 75 | removeExtensions = None, |
Mark Lobodzinski | 62f7156 | 2017-10-24 13:41:18 -0600 | [diff] [blame] | 76 | emitExtensions = None, |
Mark Lobodzinski | d146148 | 2017-07-18 13:56:09 -0600 | [diff] [blame] | 77 | sortProcedure = regSortFeatures, |
| 78 | prefixText = "", |
| 79 | genFuncPointers = True, |
| 80 | protectFile = True, |
| 81 | protectFeature = True, |
Mark Lobodzinski | d146148 | 2017-07-18 13:56:09 -0600 | [diff] [blame] | 82 | apicall = '', |
| 83 | apientry = '', |
| 84 | apientryp = '', |
| 85 | indentFuncProto = True, |
| 86 | indentFuncPointer = False, |
Mark Lobodzinski | 62f7156 | 2017-10-24 13:41:18 -0600 | [diff] [blame] | 87 | alignFuncParam = 0, |
| 88 | expandEnumerants = True): |
Mark Lobodzinski | d146148 | 2017-07-18 13:56:09 -0600 | [diff] [blame] | 89 | GeneratorOptions.__init__(self, filename, directory, apiname, profile, |
| 90 | versions, emitversions, defaultExtensions, |
Mark Lobodzinski | 62f7156 | 2017-10-24 13:41:18 -0600 | [diff] [blame] | 91 | addExtensions, removeExtensions, emitExtensions, sortProcedure) |
Mark Lobodzinski | d146148 | 2017-07-18 13:56:09 -0600 | [diff] [blame] | 92 | self.prefixText = prefixText |
| 93 | self.genFuncPointers = genFuncPointers |
| 94 | self.protectFile = protectFile |
| 95 | self.protectFeature = protectFeature |
Mark Lobodzinski | d146148 | 2017-07-18 13:56:09 -0600 | [diff] [blame] | 96 | self.apicall = apicall |
| 97 | self.apientry = apientry |
| 98 | self.apientryp = apientryp |
| 99 | self.indentFuncProto = indentFuncProto |
| 100 | self.indentFuncPointer = indentFuncPointer |
| 101 | self.alignFuncParam = alignFuncParam |
Mark Lobodzinski | 62f7156 | 2017-10-24 13:41:18 -0600 | [diff] [blame] | 102 | self.expandEnumerants = expandEnumerants |
| 103 | |
Mark Lobodzinski | d146148 | 2017-07-18 13:56:09 -0600 | [diff] [blame] | 104 | |
| 105 | # ObjectTrackerOutputGenerator - subclass of OutputGenerator. |
| 106 | # Generates object_tracker layer object validation code |
| 107 | # |
| 108 | # ---- methods ---- |
| 109 | # ObjectTrackerOutputGenerator(errFile, warnFile, diagFile) - args as for OutputGenerator. Defines additional internal state. |
| 110 | # ---- methods overriding base class ---- |
| 111 | # beginFile(genOpts) |
| 112 | # endFile() |
| 113 | # beginFeature(interface, emit) |
| 114 | # endFeature() |
| 115 | # genCmd(cmdinfo) |
| 116 | # genStruct() |
| 117 | # genType() |
| 118 | class ObjectTrackerOutputGenerator(OutputGenerator): |
| 119 | """Generate ObjectTracker code based on XML element attributes""" |
| 120 | # This is an ordered list of sections in the header file. |
| 121 | ALL_SECTIONS = ['command'] |
| 122 | def __init__(self, |
| 123 | errFile = sys.stderr, |
| 124 | warnFile = sys.stderr, |
| 125 | diagFile = sys.stdout): |
| 126 | OutputGenerator.__init__(self, errFile, warnFile, diagFile) |
| 127 | self.INDENT_SPACES = 4 |
| 128 | self.intercepts = [] |
| 129 | self.instance_extensions = [] |
| 130 | self.device_extensions = [] |
| 131 | # Commands which are not autogenerated but still intercepted |
| 132 | self.no_autogen_list = [ |
| 133 | 'vkDestroyInstance', |
| 134 | 'vkDestroyDevice', |
| 135 | 'vkUpdateDescriptorSets', |
| 136 | 'vkDestroyDebugReportCallbackEXT', |
| 137 | 'vkDebugReportMessageEXT', |
| 138 | 'vkGetPhysicalDeviceQueueFamilyProperties', |
| 139 | 'vkFreeCommandBuffers', |
| 140 | 'vkDestroySwapchainKHR', |
| 141 | 'vkDestroyDescriptorPool', |
| 142 | 'vkDestroyCommandPool', |
Mark Lobodzinski | 14ddc19 | 2017-10-25 16:57:04 -0600 | [diff] [blame^] | 143 | 'vkGetPhysicalDeviceQueueFamilyProperties2', |
Mark Lobodzinski | d146148 | 2017-07-18 13:56:09 -0600 | [diff] [blame] | 144 | 'vkGetPhysicalDeviceQueueFamilyProperties2KHR', |
| 145 | 'vkResetDescriptorPool', |
| 146 | 'vkBeginCommandBuffer', |
| 147 | 'vkCreateDebugReportCallbackEXT', |
| 148 | 'vkEnumerateInstanceLayerProperties', |
| 149 | 'vkEnumerateDeviceLayerProperties', |
| 150 | 'vkEnumerateInstanceExtensionProperties', |
| 151 | 'vkEnumerateDeviceExtensionProperties', |
| 152 | 'vkCreateDevice', |
| 153 | 'vkCreateInstance', |
| 154 | 'vkEnumeratePhysicalDevices', |
| 155 | 'vkAllocateCommandBuffers', |
| 156 | 'vkAllocateDescriptorSets', |
| 157 | 'vkFreeDescriptorSets', |
Tony Barbour | 2fd0c2c | 2017-08-08 12:51:33 -0600 | [diff] [blame] | 158 | 'vkCmdPushDescriptorSetKHR', |
Mark Lobodzinski | d146148 | 2017-07-18 13:56:09 -0600 | [diff] [blame] | 159 | 'vkDebugMarkerSetObjectNameEXT', |
| 160 | 'vkGetPhysicalDeviceProcAddr', |
| 161 | 'vkGetDeviceProcAddr', |
| 162 | 'vkGetInstanceProcAddr', |
| 163 | 'vkEnumerateInstanceExtensionProperties', |
| 164 | 'vkEnumerateInstanceLayerProperties', |
| 165 | 'vkEnumerateDeviceLayerProperties', |
| 166 | 'vkGetDeviceProcAddr', |
| 167 | 'vkGetInstanceProcAddr', |
| 168 | 'vkEnumerateDeviceExtensionProperties', |
| 169 | 'vk_layerGetPhysicalDeviceProcAddr', |
| 170 | 'vkNegotiateLoaderLayerInterfaceVersion', |
| 171 | 'vkCreateComputePipelines', |
| 172 | 'vkGetDeviceQueue', |
| 173 | 'vkGetSwapchainImagesKHR', |
Petr Kraus | 42f6f8d | 2017-12-17 17:37:33 +0100 | [diff] [blame] | 174 | 'vkCreateDescriptorSetLayout', |
Mark Lobodzinski | d146148 | 2017-07-18 13:56:09 -0600 | [diff] [blame] | 175 | ] |
| 176 | # These VUIDS are not implicit, but are best handled in this layer. Codegen for vkDestroy calls will generate a key |
| 177 | # which is translated here into a good VU. Saves ~40 checks. |
| 178 | self.manual_vuids = dict() |
| 179 | self.manual_vuids = { |
| 180 | "fence-compatalloc": "VALIDATION_ERROR_24e008c2", |
| 181 | "fence-nullalloc": "VALIDATION_ERROR_24e008c4", |
| 182 | "event-compatalloc": "VALIDATION_ERROR_24c008f4", |
| 183 | "event-nullalloc": "VALIDATION_ERROR_24c008f6", |
| 184 | "buffer-compatalloc": "VALIDATION_ERROR_23c00736", |
| 185 | "buffer-nullalloc": "VALIDATION_ERROR_23c00738", |
| 186 | "image-compatalloc": "VALIDATION_ERROR_252007d2", |
| 187 | "image-nullalloc": "VALIDATION_ERROR_252007d4", |
| 188 | "shaderModule-compatalloc": "VALIDATION_ERROR_26a00888", |
| 189 | "shaderModule-nullalloc": "VALIDATION_ERROR_26a0088a", |
| 190 | "pipeline-compatalloc": "VALIDATION_ERROR_25c005fc", |
| 191 | "pipeline-nullalloc": "VALIDATION_ERROR_25c005fe", |
| 192 | "sampler-compatalloc": "VALIDATION_ERROR_26600876", |
| 193 | "sampler-nullalloc": "VALIDATION_ERROR_26600878", |
| 194 | "renderPass-compatalloc": "VALIDATION_ERROR_264006d4", |
| 195 | "renderPass-nullalloc": "VALIDATION_ERROR_264006d6", |
| 196 | "descriptorUpdateTemplate-compatalloc": "VALIDATION_ERROR_248002c8", |
| 197 | "descriptorUpdateTemplate-nullalloc": "VALIDATION_ERROR_248002ca", |
| 198 | "imageView-compatalloc": "VALIDATION_ERROR_25400806", |
| 199 | "imageView-nullalloc": "VALIDATION_ERROR_25400808", |
| 200 | "pipelineCache-compatalloc": "VALIDATION_ERROR_25e00606", |
| 201 | "pipelineCache-nullalloc": "VALIDATION_ERROR_25e00608", |
| 202 | "pipelineLayout-compatalloc": "VALIDATION_ERROR_26000256", |
| 203 | "pipelineLayout-nullalloc": "VALIDATION_ERROR_26000258", |
| 204 | "descriptorSetLayout-compatalloc": "VALIDATION_ERROR_24600238", |
| 205 | "descriptorSetLayout-nullalloc": "VALIDATION_ERROR_2460023a", |
| 206 | "semaphore-compatalloc": "VALIDATION_ERROR_268008e4", |
| 207 | "semaphore-nullalloc": "VALIDATION_ERROR_268008e6", |
| 208 | "queryPool-compatalloc": "VALIDATION_ERROR_26200634", |
| 209 | "queryPool-nullalloc": "VALIDATION_ERROR_26200636", |
| 210 | "bufferView-compatalloc": "VALIDATION_ERROR_23e00752", |
| 211 | "bufferView-nullalloc": "VALIDATION_ERROR_23e00754", |
| 212 | "surface-compatalloc": "VALIDATION_ERROR_26c009e6", |
| 213 | "surface-nullalloc": "VALIDATION_ERROR_26c009e8", |
| 214 | "framebuffer-compatalloc": "VALIDATION_ERROR_250006fa", |
| 215 | "framebuffer-nullalloc": "VALIDATION_ERROR_250006fc", |
| 216 | } |
| 217 | |
| 218 | # Commands shadowed by interface functions and are not implemented |
| 219 | self.interface_functions = [ |
| 220 | ] |
| 221 | self.headerVersion = None |
| 222 | # Internal state - accumulators for different inner block text |
| 223 | self.sections = dict([(section, []) for section in self.ALL_SECTIONS]) |
| 224 | self.cmdMembers = [] |
| 225 | self.cmd_feature_protect = [] # Save ifdef's for each command |
| 226 | self.cmd_info_data = [] # Save the cmdinfo data for validating the handles when processing is complete |
| 227 | self.structMembers = [] # List of StructMemberData records for all Vulkan structs |
| 228 | self.extension_structs = [] # List of all structs or sister-structs containing handles |
| 229 | # A sister-struct may contain no handles but shares <validextensionstructs> with one that does |
| 230 | self.structTypes = dict() # Map of Vulkan struct typename to required VkStructureType |
| 231 | self.struct_member_dict = dict() |
| 232 | # Named tuples to store struct and command data |
| 233 | self.StructType = namedtuple('StructType', ['name', 'value']) |
| 234 | self.CmdMemberData = namedtuple('CmdMemberData', ['name', 'members']) |
| 235 | self.CmdInfoData = namedtuple('CmdInfoData', ['name', 'cmdinfo']) |
| 236 | self.CmdExtraProtect = namedtuple('CmdExtraProtect', ['name', 'extra_protect']) |
| 237 | self.CommandParam = namedtuple('CommandParam', ['type', 'name', 'ispointer', 'isconst', 'isoptional', 'iscount', 'len', 'extstructs', 'cdecl', 'islocal', 'iscreate', 'isdestroy', 'feature_protect']) |
| 238 | self.StructMemberData = namedtuple('StructMemberData', ['name', 'members']) |
| 239 | self.object_types = [] # List of all handle types |
| 240 | self.valid_vuids = set() # Set of all valid VUIDs |
| 241 | self.vuid_file = None |
| 242 | # Cover cases where file is built from scripts directory, Lin/Win, or Android build structure |
Jamie Madill | c47ddf9 | 2017-12-20 14:45:11 -0500 | [diff] [blame] | 243 | # Set cwd to the script directory to more easily locate the header. |
| 244 | previous_dir = os.getcwd() |
| 245 | os.chdir(os.path.dirname(sys.argv[0])) |
Mark Lobodzinski | d146148 | 2017-07-18 13:56:09 -0600 | [diff] [blame] | 246 | vuid_filename_locations = [ |
| 247 | './vk_validation_error_messages.h', |
| 248 | '../layers/vk_validation_error_messages.h', |
| 249 | '../../layers/vk_validation_error_messages.h', |
| 250 | '../../../layers/vk_validation_error_messages.h', |
| 251 | ] |
| 252 | for vuid_filename in vuid_filename_locations: |
| 253 | if os.path.isfile(vuid_filename): |
Lenny Komow | b79f04a | 2017-09-18 17:07:00 -0600 | [diff] [blame] | 254 | self.vuid_file = open(vuid_filename, "r", encoding="utf8") |
Mark Lobodzinski | d146148 | 2017-07-18 13:56:09 -0600 | [diff] [blame] | 255 | break |
| 256 | if self.vuid_file == None: |
| 257 | print("Error: Could not find vk_validation_error_messages.h") |
Jamie Madill | 3935f7c | 2017-11-08 13:50:14 -0500 | [diff] [blame] | 258 | sys.exit(1) |
Jamie Madill | c47ddf9 | 2017-12-20 14:45:11 -0500 | [diff] [blame] | 259 | os.chdir(previous_dir) |
Mark Lobodzinski | d146148 | 2017-07-18 13:56:09 -0600 | [diff] [blame] | 260 | # |
| 261 | # Check if the parameter passed in is optional |
| 262 | def paramIsOptional(self, param): |
| 263 | # See if the handle is optional |
| 264 | isoptional = False |
| 265 | # Simple, if it's optional, return true |
| 266 | optString = param.attrib.get('optional') |
| 267 | if optString: |
| 268 | if optString == 'true': |
| 269 | isoptional = True |
| 270 | elif ',' in optString: |
| 271 | opts = [] |
| 272 | for opt in optString.split(','): |
| 273 | val = opt.strip() |
| 274 | if val == 'true': |
| 275 | opts.append(True) |
| 276 | elif val == 'false': |
| 277 | opts.append(False) |
| 278 | else: |
| 279 | print('Unrecognized len attribute value',val) |
| 280 | isoptional = opts |
| 281 | return isoptional |
| 282 | # |
| 283 | # Convert decimal number to 8 digit hexadecimal lower-case representation |
| 284 | def IdToHex(self, dec_num): |
| 285 | if dec_num > 4294967295: |
| 286 | print ("ERROR: Decimal # %d can't be represented in 8 hex digits" % (dec_num)) |
| 287 | sys.exit() |
| 288 | hex_num = hex(dec_num) |
| 289 | return hex_num[2:].zfill(8) |
| 290 | # |
| 291 | # Get VUID identifier from implicit VUID tag |
| 292 | def GetVuid(self, vuid_string): |
| 293 | if '->' in vuid_string: |
| 294 | return "VALIDATION_ERROR_UNDEFINED" |
| 295 | vuid_num = self.IdToHex(convertVUID(vuid_string)) |
| 296 | if vuid_num in self.valid_vuids: |
| 297 | vuid = "VALIDATION_ERROR_%s" % vuid_num |
| 298 | else: |
| 299 | vuid = "VALIDATION_ERROR_UNDEFINED" |
| 300 | return vuid |
| 301 | # |
| 302 | # Increases indent by 4 spaces and tracks it globally |
| 303 | def incIndent(self, indent): |
| 304 | inc = ' ' * self.INDENT_SPACES |
| 305 | if indent: |
| 306 | return indent + inc |
| 307 | return inc |
| 308 | # |
| 309 | # Decreases indent by 4 spaces and tracks it globally |
| 310 | def decIndent(self, indent): |
| 311 | if indent and (len(indent) > self.INDENT_SPACES): |
| 312 | return indent[:-self.INDENT_SPACES] |
| 313 | return '' |
| 314 | # |
| 315 | # Override makeProtoName to drop the "vk" prefix |
| 316 | def makeProtoName(self, name, tail): |
| 317 | return self.genOpts.apientry + name[2:] + tail |
| 318 | # |
| 319 | # Check if the parameter passed in is a pointer to an array |
| 320 | def paramIsArray(self, param): |
| 321 | return param.attrib.get('len') is not None |
| 322 | # |
| 323 | # Generate the object tracker undestroyed object validation function |
| 324 | def GenReportFunc(self): |
| 325 | output_func = '' |
| 326 | output_func += 'void ReportUndestroyedObjects(VkDevice device, enum UNIQUE_VALIDATION_ERROR_CODE error_code) {\n' |
| 327 | output_func += ' DeviceReportUndestroyedObjects(device, kVulkanObjectTypeCommandBuffer, error_code);\n' |
| 328 | for handle in self.object_types: |
| 329 | if self.isHandleTypeNonDispatchable(handle): |
| 330 | output_func += ' DeviceReportUndestroyedObjects(device, %s, error_code);\n' % (self.GetVulkanObjType(handle)) |
| 331 | output_func += '}\n' |
| 332 | return output_func |
| 333 | # |
| 334 | # Called at beginning of processing as file is opened |
| 335 | def beginFile(self, genOpts): |
| 336 | OutputGenerator.beginFile(self, genOpts) |
| 337 | # Open vk_validation_error_messages.h file to verify computed VUIDs |
| 338 | for line in self.vuid_file: |
| 339 | # Grab hex number from enum definition |
| 340 | vuid_list = line.split('0x') |
| 341 | # If this is a valid enumeration line, remove trailing comma and CR |
| 342 | if len(vuid_list) == 2: |
| 343 | vuid_num = vuid_list[1][:-2] |
| 344 | # Make sure this is a good hex number before adding to set |
| 345 | if len(vuid_num) == 8 and all(c in string.hexdigits for c in vuid_num): |
| 346 | self.valid_vuids.add(vuid_num) |
| 347 | # File Comment |
| 348 | file_comment = '// *** THIS FILE IS GENERATED - DO NOT EDIT ***\n' |
| 349 | file_comment += '// See object_tracker_generator.py for modifications\n' |
| 350 | write(file_comment, file=self.outFile) |
| 351 | # Copyright Statement |
| 352 | copyright = '' |
| 353 | copyright += '\n' |
| 354 | copyright += '/***************************************************************************\n' |
| 355 | copyright += ' *\n' |
| 356 | copyright += ' * Copyright (c) 2015-2017 The Khronos Group Inc.\n' |
| 357 | copyright += ' * Copyright (c) 2015-2017 Valve Corporation\n' |
| 358 | copyright += ' * Copyright (c) 2015-2017 LunarG, Inc.\n' |
| 359 | copyright += ' * Copyright (c) 2015-2017 Google Inc.\n' |
| 360 | copyright += ' *\n' |
| 361 | copyright += ' * Licensed under the Apache License, Version 2.0 (the "License");\n' |
| 362 | copyright += ' * you may not use this file except in compliance with the License.\n' |
| 363 | copyright += ' * You may obtain a copy of the License at\n' |
| 364 | copyright += ' *\n' |
| 365 | copyright += ' * http://www.apache.org/licenses/LICENSE-2.0\n' |
| 366 | copyright += ' *\n' |
| 367 | copyright += ' * Unless required by applicable law or agreed to in writing, software\n' |
| 368 | copyright += ' * distributed under the License is distributed on an "AS IS" BASIS,\n' |
| 369 | copyright += ' * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n' |
| 370 | copyright += ' * See the License for the specific language governing permissions and\n' |
| 371 | copyright += ' * limitations under the License.\n' |
| 372 | copyright += ' *\n' |
| 373 | copyright += ' * Author: Mark Lobodzinski <mark@lunarg.com>\n' |
| 374 | copyright += ' *\n' |
| 375 | copyright += ' ****************************************************************************/\n' |
| 376 | write(copyright, file=self.outFile) |
| 377 | # Namespace |
| 378 | self.newline() |
| 379 | write('#include "object_tracker.h"', file = self.outFile) |
| 380 | self.newline() |
| 381 | write('namespace object_tracker {', file = self.outFile) |
| 382 | # |
| 383 | # Now that the data is all collected and complete, generate and output the object validation routines |
| 384 | def endFile(self): |
| 385 | self.struct_member_dict = dict(self.structMembers) |
| 386 | # Generate the list of APIs that might need to handle wrapped extension structs |
| 387 | # self.GenerateCommandWrapExtensionList() |
| 388 | self.WrapCommands() |
| 389 | # Build undestroyed objects reporting function |
| 390 | report_func = self.GenReportFunc() |
| 391 | self.newline() |
| 392 | write('// ObjectTracker undestroyed objects validation function', file=self.outFile) |
| 393 | write('%s' % report_func, file=self.outFile) |
| 394 | # Actually write the interface to the output file. |
| 395 | if (self.emit): |
| 396 | self.newline() |
| 397 | if (self.featureExtraProtect != None): |
| 398 | write('#ifdef', self.featureExtraProtect, file=self.outFile) |
| 399 | # Write the object_tracker code to the file |
| 400 | if (self.sections['command']): |
Mark Lobodzinski | d146148 | 2017-07-18 13:56:09 -0600 | [diff] [blame] | 401 | write('\n'.join(self.sections['command']), end=u'', file=self.outFile) |
| 402 | if (self.featureExtraProtect != None): |
| 403 | write('\n#endif //', self.featureExtraProtect, file=self.outFile) |
| 404 | else: |
| 405 | self.newline() |
| 406 | |
| 407 | # Record intercepted procedures |
| 408 | write('// Map of all APIs to be intercepted by this layer', file=self.outFile) |
| 409 | write('const std::unordered_map<std::string, void*> name_to_funcptr_map = {', file=self.outFile) |
| 410 | write('\n'.join(self.intercepts), file=self.outFile) |
| 411 | write('};\n', file=self.outFile) |
| 412 | self.newline() |
| 413 | write('} // namespace object_tracker', file=self.outFile) |
| 414 | # Finish processing in superclass |
| 415 | OutputGenerator.endFile(self) |
| 416 | # |
| 417 | # Processing point at beginning of each extension definition |
| 418 | def beginFeature(self, interface, emit): |
| 419 | # Start processing in superclass |
| 420 | OutputGenerator.beginFeature(self, interface, emit) |
| 421 | self.headerVersion = None |
Mark Lobodzinski | 62f7156 | 2017-10-24 13:41:18 -0600 | [diff] [blame] | 422 | self.featureExtraProtect = GetFeatureProtect(interface) |
Mark Lobodzinski | d146148 | 2017-07-18 13:56:09 -0600 | [diff] [blame] | 423 | |
Mark Lobodzinski | 31964ca | 2017-09-18 14:15:09 -0600 | [diff] [blame] | 424 | if self.featureName != 'VK_VERSION_1_0' and self.featureName != 'VK_VERSION_1_1': |
Mark Lobodzinski | d146148 | 2017-07-18 13:56:09 -0600 | [diff] [blame] | 425 | white_list_entry = [] |
| 426 | if (self.featureExtraProtect != None): |
| 427 | white_list_entry += [ '#ifdef %s' % self.featureExtraProtect ] |
| 428 | white_list_entry += [ '"%s"' % self.featureName ] |
| 429 | if (self.featureExtraProtect != None): |
| 430 | white_list_entry += [ '#endif' ] |
| 431 | featureType = interface.get('type') |
| 432 | if featureType == 'instance': |
| 433 | self.instance_extensions += white_list_entry |
| 434 | elif featureType == 'device': |
| 435 | self.device_extensions += white_list_entry |
| 436 | # |
| 437 | # Processing point at end of each extension definition |
| 438 | def endFeature(self): |
| 439 | # Finish processing in superclass |
| 440 | OutputGenerator.endFeature(self) |
| 441 | # |
| 442 | # Process enums, structs, etc. |
| 443 | def genType(self, typeinfo, name): |
| 444 | OutputGenerator.genType(self, typeinfo, name) |
| 445 | typeElem = typeinfo.elem |
| 446 | # If the type is a struct type, traverse the imbedded <member> tags generating a structure. |
| 447 | # Otherwise, emit the tag text. |
| 448 | category = typeElem.get('category') |
| 449 | if (category == 'struct' or category == 'union'): |
| 450 | self.genStruct(typeinfo, name) |
| 451 | if category == 'handle': |
| 452 | self.object_types.append(name) |
| 453 | # |
| 454 | # Append a definition to the specified section |
| 455 | def appendSection(self, section, text): |
| 456 | # self.sections[section].append('SECTION: ' + section + '\n') |
| 457 | self.sections[section].append(text) |
| 458 | # |
| 459 | # Check if the parameter passed in is a pointer |
| 460 | def paramIsPointer(self, param): |
| 461 | ispointer = False |
| 462 | for elem in param: |
| 463 | if ((elem.tag is not 'type') and (elem.tail is not None)) and '*' in elem.tail: |
| 464 | ispointer = True |
| 465 | return ispointer |
| 466 | # |
| 467 | # Get the category of a type |
| 468 | def getTypeCategory(self, typename): |
| 469 | types = self.registry.tree.findall("types/type") |
| 470 | for elem in types: |
| 471 | if (elem.find("name") is not None and elem.find('name').text == typename) or elem.attrib.get('name') == typename: |
| 472 | return elem.attrib.get('category') |
| 473 | # |
| 474 | # Check if a parent object is dispatchable or not |
| 475 | def isHandleTypeObject(self, handletype): |
| 476 | handle = self.registry.tree.find("types/type/[name='" + handletype + "'][@category='handle']") |
| 477 | if handle is not None: |
| 478 | return True |
| 479 | else: |
| 480 | return False |
| 481 | # |
| 482 | # Check if a parent object is dispatchable or not |
| 483 | def isHandleTypeNonDispatchable(self, handletype): |
| 484 | handle = self.registry.tree.find("types/type/[name='" + handletype + "'][@category='handle']") |
| 485 | if handle is not None and handle.find('type').text == 'VK_DEFINE_NON_DISPATCHABLE_HANDLE': |
| 486 | return True |
| 487 | else: |
| 488 | return False |
| 489 | # |
| 490 | # Retrieve the type and name for a parameter |
| 491 | def getTypeNameTuple(self, param): |
| 492 | type = '' |
| 493 | name = '' |
| 494 | for elem in param: |
| 495 | if elem.tag == 'type': |
| 496 | type = noneStr(elem.text) |
| 497 | elif elem.tag == 'name': |
| 498 | name = noneStr(elem.text) |
| 499 | return (type, name) |
| 500 | # |
| 501 | # Retrieve the value of the len tag |
| 502 | def getLen(self, param): |
| 503 | result = None |
| 504 | len = param.attrib.get('len') |
| 505 | if len and len != 'null-terminated': |
| 506 | # For string arrays, 'len' can look like 'count,null-terminated', indicating that we |
| 507 | # have a null terminated array of strings. We strip the null-terminated from the |
| 508 | # 'len' field and only return the parameter specifying the string count |
| 509 | if 'null-terminated' in len: |
| 510 | result = len.split(',')[0] |
| 511 | else: |
| 512 | result = len |
| 513 | # Spec has now notation for len attributes, using :: instead of platform specific pointer symbol |
| 514 | result = str(result).replace('::', '->') |
| 515 | return result |
| 516 | # |
| 517 | # Generate a VkStructureType based on a structure typename |
| 518 | def genVkStructureType(self, typename): |
| 519 | # Add underscore between lowercase then uppercase |
| 520 | value = re.sub('([a-z0-9])([A-Z])', r'\1_\2', typename) |
| 521 | # Change to uppercase |
| 522 | value = value.upper() |
| 523 | # Add STRUCTURE_TYPE_ |
| 524 | return re.sub('VK_', 'VK_STRUCTURE_TYPE_', value) |
| 525 | # |
| 526 | # Struct parameter check generation. |
| 527 | # This is a special case of the <type> tag where the contents are interpreted as a set of |
| 528 | # <member> tags instead of freeform C type declarations. The <member> tags are just like |
| 529 | # <param> tags - they are a declaration of a struct or union member. Only simple member |
| 530 | # declarations are supported (no nested structs etc.) |
| 531 | def genStruct(self, typeinfo, typeName): |
| 532 | OutputGenerator.genStruct(self, typeinfo, typeName) |
| 533 | members = typeinfo.elem.findall('.//member') |
| 534 | # Iterate over members once to get length parameters for arrays |
| 535 | lens = set() |
| 536 | for member in members: |
| 537 | len = self.getLen(member) |
| 538 | if len: |
| 539 | lens.add(len) |
| 540 | # Generate member info |
| 541 | membersInfo = [] |
| 542 | for member in members: |
| 543 | # Get the member's type and name |
| 544 | info = self.getTypeNameTuple(member) |
| 545 | type = info[0] |
| 546 | name = info[1] |
| 547 | cdecl = self.makeCParamDecl(member, 0) |
| 548 | # Process VkStructureType |
| 549 | if type == 'VkStructureType': |
| 550 | # Extract the required struct type value from the comments |
| 551 | # embedded in the original text defining the 'typeinfo' element |
| 552 | rawXml = etree.tostring(typeinfo.elem).decode('ascii') |
| 553 | result = re.search(r'VK_STRUCTURE_TYPE_\w+', rawXml) |
| 554 | if result: |
| 555 | value = result.group(0) |
| 556 | else: |
| 557 | value = self.genVkStructureType(typeName) |
| 558 | # Store the required type value |
| 559 | self.structTypes[typeName] = self.StructType(name=name, value=value) |
| 560 | # Store pointer/array/string info |
| 561 | extstructs = member.attrib.get('validextensionstructs') if name == 'pNext' else None |
| 562 | membersInfo.append(self.CommandParam(type=type, |
| 563 | name=name, |
| 564 | ispointer=self.paramIsPointer(member), |
| 565 | isconst=True if 'const' in cdecl else False, |
| 566 | isoptional=self.paramIsOptional(member), |
| 567 | iscount=True if name in lens else False, |
| 568 | len=self.getLen(member), |
| 569 | extstructs=extstructs, |
| 570 | cdecl=cdecl, |
| 571 | islocal=False, |
| 572 | iscreate=False, |
| 573 | isdestroy=False, |
| 574 | feature_protect=self.featureExtraProtect)) |
| 575 | self.structMembers.append(self.StructMemberData(name=typeName, members=membersInfo)) |
| 576 | # |
| 577 | # Insert a lock_guard line |
| 578 | def lock_guard(self, indent): |
| 579 | return '%sstd::lock_guard<std::mutex> lock(global_lock);\n' % indent |
| 580 | # |
| 581 | # Determine if a struct has an object as a member or an embedded member |
| 582 | def struct_contains_object(self, struct_item): |
| 583 | struct_member_dict = dict(self.structMembers) |
| 584 | struct_members = struct_member_dict[struct_item] |
| 585 | |
| 586 | for member in struct_members: |
| 587 | if self.isHandleTypeObject(member.type): |
| 588 | return True |
| 589 | elif member.type in struct_member_dict: |
| 590 | if self.struct_contains_object(member.type) == True: |
| 591 | return True |
| 592 | return False |
| 593 | # |
| 594 | # Return list of struct members which contain, or whose sub-structures contain an obj in a given list of parameters or members |
| 595 | def getParmeterStructsWithObjects(self, item_list): |
| 596 | struct_list = set() |
| 597 | for item in item_list: |
| 598 | paramtype = item.find('type') |
| 599 | typecategory = self.getTypeCategory(paramtype.text) |
| 600 | if typecategory == 'struct': |
| 601 | if self.struct_contains_object(paramtype.text) == True: |
| 602 | struct_list.add(item) |
| 603 | return struct_list |
| 604 | # |
| 605 | # Return list of objects from a given list of parameters or members |
| 606 | def getObjectsInParameterList(self, item_list, create_func): |
| 607 | object_list = set() |
| 608 | if create_func == True: |
| 609 | member_list = item_list[0:-1] |
| 610 | else: |
| 611 | member_list = item_list |
| 612 | for item in member_list: |
| 613 | if self.isHandleTypeObject(paramtype.text): |
| 614 | object_list.add(item) |
| 615 | return object_list |
| 616 | # |
| 617 | # Construct list of extension structs containing handles, or extension structs that share a <validextensionstructs> |
| 618 | # tag WITH an extension struct containing handles. |
| 619 | def GenerateCommandWrapExtensionList(self): |
| 620 | for struct in self.structMembers: |
| 621 | if (len(struct.members) > 1) and struct.members[1].extstructs is not None: |
| 622 | found = False; |
| 623 | for item in struct.members[1].extstructs.split(','): |
| 624 | if item != '' and self.struct_contains_object(item) == True: |
| 625 | found = True |
| 626 | if found == True: |
| 627 | for item in struct.members[1].extstructs.split(','): |
| 628 | if item != '' and item not in self.extension_structs: |
| 629 | self.extension_structs.append(item) |
| 630 | # |
| 631 | # Returns True if a struct may have a pNext chain containing an object |
| 632 | def StructWithExtensions(self, struct_type): |
| 633 | if struct_type in self.struct_member_dict: |
| 634 | param_info = self.struct_member_dict[struct_type] |
| 635 | if (len(param_info) > 1) and param_info[1].extstructs is not None: |
| 636 | for item in param_info[1].extstructs.split(','): |
| 637 | if item in self.extension_structs: |
| 638 | return True |
| 639 | return False |
| 640 | # |
| 641 | # Generate VulkanObjectType from object type |
| 642 | def GetVulkanObjType(self, type): |
| 643 | return 'kVulkanObjectType%s' % type[2:] |
| 644 | # |
| 645 | # Return correct dispatch table type -- instance or device |
| 646 | def GetDispType(self, type): |
| 647 | return 'instance' if type in ['VkInstance', 'VkPhysicalDevice'] else 'device' |
| 648 | # |
| 649 | # Generate source for creating a Vulkan object |
| 650 | def generate_create_object_code(self, indent, proto, params, cmd_info): |
| 651 | create_obj_code = '' |
| 652 | handle_type = params[-1].find('type') |
| 653 | if self.isHandleTypeObject(handle_type.text): |
| 654 | # Check for special case where multiple handles are returned |
| 655 | object_array = False |
| 656 | if cmd_info[-1].len is not None: |
| 657 | object_array = True; |
| 658 | handle_name = params[-1].find('name') |
| 659 | create_obj_code += '%sif (VK_SUCCESS == result) {\n' % (indent) |
| 660 | indent = self.incIndent(indent) |
| 661 | create_obj_code += '%sstd::lock_guard<std::mutex> lock(global_lock);\n' % (indent) |
| 662 | object_dest = '*%s' % handle_name.text |
| 663 | if object_array == True: |
| 664 | create_obj_code += '%sfor (uint32_t index = 0; index < %s; index++) {\n' % (indent, cmd_info[-1].len) |
| 665 | indent = self.incIndent(indent) |
| 666 | object_dest = '%s[index]' % cmd_info[-1].name |
| 667 | create_obj_code += '%sCreateObject(%s, %s, %s, pAllocator);\n' % (indent, params[0].find('name').text, object_dest, self.GetVulkanObjType(cmd_info[-1].type)) |
| 668 | if object_array == True: |
| 669 | indent = self.decIndent(indent) |
| 670 | create_obj_code += '%s}\n' % indent |
| 671 | indent = self.decIndent(indent) |
| 672 | create_obj_code += '%s}\n' % (indent) |
| 673 | return create_obj_code |
| 674 | # |
| 675 | # Generate source for destroying a non-dispatchable object |
| 676 | def generate_destroy_object_code(self, indent, proto, cmd_info): |
| 677 | destroy_obj_code = '' |
| 678 | object_array = False |
| 679 | if True in [destroy_txt in proto.text for destroy_txt in ['Destroy', 'Free']]: |
| 680 | # Check for special case where multiple handles are returned |
| 681 | if cmd_info[-1].len is not None: |
| 682 | object_array = True; |
| 683 | param = -1 |
| 684 | else: |
| 685 | param = -2 |
| 686 | compatalloc_vuid_string = '%s-compatalloc' % cmd_info[param].name |
| 687 | nullalloc_vuid_string = '%s-nullalloc' % cmd_info[param].name |
| 688 | compatalloc_vuid = self.manual_vuids.get(compatalloc_vuid_string, "VALIDATION_ERROR_UNDEFINED") |
| 689 | nullalloc_vuid = self.manual_vuids.get(nullalloc_vuid_string, "VALIDATION_ERROR_UNDEFINED") |
| 690 | if self.isHandleTypeObject(cmd_info[param].type) == True: |
| 691 | if object_array == True: |
| 692 | # This API is freeing an array of handles -- add loop control |
| 693 | destroy_obj_code += 'HEY, NEED TO DESTROY AN ARRAY\n' |
| 694 | else: |
| 695 | # Call Destroy a single time |
| 696 | destroy_obj_code += '%sif (skip) return;\n' % indent |
| 697 | destroy_obj_code += '%s{\n' % indent |
| 698 | destroy_obj_code += '%s std::lock_guard<std::mutex> lock(global_lock);\n' % indent |
| 699 | destroy_obj_code += '%s DestroyObject(%s, %s, %s, pAllocator, %s, %s);\n' % (indent, cmd_info[0].name, cmd_info[param].name, self.GetVulkanObjType(cmd_info[param].type), compatalloc_vuid, nullalloc_vuid) |
| 700 | destroy_obj_code += '%s}\n' % indent |
| 701 | return object_array, destroy_obj_code |
| 702 | # |
| 703 | # Output validation for a single object (obj_count is NULL) or a counted list of objects |
| 704 | def outputObjects(self, obj_type, obj_name, obj_count, prefix, index, indent, destroy_func, destroy_array, disp_name, parent_name, null_allowed, top_level): |
| 705 | decl_code = '' |
| 706 | pre_call_code = '' |
| 707 | post_call_code = '' |
| 708 | param_vuid_string = 'VUID-%s-%s-parameter' % (parent_name, obj_name) |
| 709 | parent_vuid_string = 'VUID-%s-%s-parent' % (parent_name, obj_name) |
| 710 | param_vuid = self.GetVuid(param_vuid_string) |
| 711 | parent_vuid = self.GetVuid(parent_vuid_string) |
| 712 | # If no parent VUID for this member, look for a commonparent VUID |
| 713 | if parent_vuid == 'VALIDATION_ERROR_UNDEFINED': |
| 714 | commonparent_vuid_string = 'VUID-%s-commonparent' % parent_name |
| 715 | parent_vuid = self.GetVuid(commonparent_vuid_string) |
| 716 | if obj_count is not None: |
| 717 | pre_call_code += '%s if (%s%s) {\n' % (indent, prefix, obj_name) |
| 718 | indent = self.incIndent(indent) |
| 719 | pre_call_code += '%s for (uint32_t %s = 0; %s < %s; ++%s) {\n' % (indent, index, index, obj_count, index) |
| 720 | indent = self.incIndent(indent) |
| 721 | pre_call_code += '%s skip |= ValidateObject(%s, %s%s[%s], %s, %s, %s, %s);\n' % (indent, disp_name, prefix, obj_name, index, self.GetVulkanObjType(obj_type), null_allowed, param_vuid, parent_vuid) |
| 722 | indent = self.decIndent(indent) |
| 723 | pre_call_code += '%s }\n' % indent |
| 724 | indent = self.decIndent(indent) |
| 725 | pre_call_code += '%s }\n' % indent |
| 726 | else: |
| 727 | pre_call_code += '%s skip |= ValidateObject(%s, %s%s, %s, %s, %s, %s);\n' % (indent, disp_name, prefix, obj_name, self.GetVulkanObjType(obj_type), null_allowed, param_vuid, parent_vuid) |
| 728 | return decl_code, pre_call_code, post_call_code |
| 729 | # |
| 730 | # first_level_param indicates if elements are passed directly into the function else they're below a ptr/struct |
| 731 | # create_func means that this is API creates or allocates objects |
| 732 | # destroy_func indicates that this API destroys or frees objects |
| 733 | # destroy_array means that the destroy_func operated on an array of objects |
| 734 | def validate_objects(self, members, indent, prefix, array_index, create_func, destroy_func, destroy_array, disp_name, parent_name, first_level_param): |
| 735 | decls = '' |
| 736 | pre_code = '' |
| 737 | post_code = '' |
| 738 | index = 'index%s' % str(array_index) |
| 739 | array_index += 1 |
| 740 | # Process any objects in this structure and recurse for any sub-structs in this struct |
| 741 | for member in members: |
| 742 | # Handle objects |
| 743 | if member.iscreate and first_level_param and member == members[-1]: |
| 744 | continue |
| 745 | if self.isHandleTypeObject(member.type) == True: |
| 746 | count_name = member.len |
| 747 | if (count_name is not None): |
| 748 | count_name = '%s%s' % (prefix, member.len) |
| 749 | null_allowed = member.isoptional |
| 750 | (tmp_decl, tmp_pre, tmp_post) = self.outputObjects(member.type, member.name, count_name, prefix, index, indent, destroy_func, destroy_array, disp_name, parent_name, str(null_allowed).lower(), first_level_param) |
| 751 | decls += tmp_decl |
| 752 | pre_code += tmp_pre |
| 753 | post_code += tmp_post |
| 754 | # Handle Structs that contain objects at some level |
| 755 | elif member.type in self.struct_member_dict: |
| 756 | # Structs at first level will have an object |
| 757 | if self.struct_contains_object(member.type) == True: |
| 758 | struct_info = self.struct_member_dict[member.type] |
| 759 | # Struct Array |
| 760 | if member.len is not None: |
| 761 | # Update struct prefix |
| 762 | new_prefix = '%s%s' % (prefix, member.name) |
| 763 | pre_code += '%s if (%s%s) {\n' % (indent, prefix, member.name) |
| 764 | indent = self.incIndent(indent) |
| 765 | pre_code += '%s for (uint32_t %s = 0; %s < %s%s; ++%s) {\n' % (indent, index, index, prefix, member.len, index) |
| 766 | indent = self.incIndent(indent) |
| 767 | local_prefix = '%s[%s].' % (new_prefix, index) |
| 768 | # Process sub-structs in this struct |
| 769 | (tmp_decl, tmp_pre, tmp_post) = self.validate_objects(struct_info, indent, local_prefix, array_index, create_func, destroy_func, destroy_array, disp_name, member.type, False) |
| 770 | decls += tmp_decl |
| 771 | pre_code += tmp_pre |
| 772 | post_code += tmp_post |
| 773 | indent = self.decIndent(indent) |
| 774 | pre_code += '%s }\n' % indent |
| 775 | indent = self.decIndent(indent) |
| 776 | pre_code += '%s }\n' % indent |
| 777 | # Single Struct |
| 778 | else: |
| 779 | # Update struct prefix |
| 780 | new_prefix = '%s%s->' % (prefix, member.name) |
| 781 | # Declare safe_VarType for struct |
| 782 | pre_code += '%s if (%s%s) {\n' % (indent, prefix, member.name) |
| 783 | indent = self.incIndent(indent) |
| 784 | # Process sub-structs in this struct |
| 785 | (tmp_decl, tmp_pre, tmp_post) = self.validate_objects(struct_info, indent, new_prefix, array_index, create_func, destroy_func, destroy_array, disp_name, member.type, False) |
| 786 | decls += tmp_decl |
| 787 | pre_code += tmp_pre |
| 788 | post_code += tmp_post |
| 789 | indent = self.decIndent(indent) |
| 790 | pre_code += '%s }\n' % indent |
| 791 | return decls, pre_code, post_code |
| 792 | # |
| 793 | # For a particular API, generate the object handling code |
| 794 | def generate_wrapping_code(self, cmd): |
| 795 | indent = ' ' |
| 796 | proto = cmd.find('proto/name') |
| 797 | params = cmd.findall('param') |
| 798 | if proto.text is not None: |
| 799 | cmd_member_dict = dict(self.cmdMembers) |
| 800 | cmd_info = cmd_member_dict[proto.text] |
| 801 | disp_name = cmd_info[0].name |
| 802 | # Handle object create operations |
| 803 | if cmd_info[0].iscreate: |
| 804 | create_obj_code = self.generate_create_object_code(indent, proto, params, cmd_info) |
| 805 | else: |
| 806 | create_obj_code = '' |
| 807 | # Handle object destroy operations |
| 808 | if cmd_info[0].isdestroy: |
| 809 | (destroy_array, destroy_object_code) = self.generate_destroy_object_code(indent, proto, cmd_info) |
| 810 | else: |
| 811 | destroy_array = False |
| 812 | destroy_object_code = '' |
| 813 | paramdecl = '' |
| 814 | param_pre_code = '' |
| 815 | param_post_code = '' |
| 816 | create_func = True if create_obj_code else False |
| 817 | destroy_func = True if destroy_object_code else False |
| 818 | (paramdecl, param_pre_code, param_post_code) = self.validate_objects(cmd_info, indent, '', 0, create_func, destroy_func, destroy_array, disp_name, proto.text, True) |
| 819 | param_post_code += create_obj_code |
| 820 | if destroy_object_code: |
| 821 | if destroy_array == True: |
| 822 | param_post_code += destroy_object_code |
| 823 | else: |
| 824 | param_pre_code += destroy_object_code |
| 825 | if param_pre_code: |
| 826 | if (not destroy_func) or (destroy_array): |
| 827 | param_pre_code = '%s{\n%s%s%s%s}\n' % (' ', indent, self.lock_guard(indent), param_pre_code, indent) |
| 828 | return paramdecl, param_pre_code, param_post_code |
| 829 | # |
| 830 | # Capture command parameter info needed to create, destroy, and validate objects |
| 831 | def genCmd(self, cmdinfo, cmdname): |
| 832 | |
| 833 | # Add struct-member type information to command parameter information |
| 834 | OutputGenerator.genCmd(self, cmdinfo, cmdname) |
| 835 | members = cmdinfo.elem.findall('.//param') |
| 836 | # Iterate over members once to get length parameters for arrays |
| 837 | lens = set() |
| 838 | for member in members: |
| 839 | len = self.getLen(member) |
| 840 | if len: |
| 841 | lens.add(len) |
| 842 | struct_member_dict = dict(self.structMembers) |
| 843 | # Generate member info |
| 844 | membersInfo = [] |
| 845 | constains_extension_structs = False |
| 846 | for member in members: |
| 847 | # Get type and name of member |
| 848 | info = self.getTypeNameTuple(member) |
| 849 | type = info[0] |
| 850 | name = info[1] |
| 851 | cdecl = self.makeCParamDecl(member, 0) |
| 852 | # Check for parameter name in lens set |
| 853 | iscount = True if name in lens else False |
| 854 | len = self.getLen(member) |
| 855 | isconst = True if 'const' in cdecl else False |
| 856 | ispointer = self.paramIsPointer(member) |
| 857 | # Mark param as local if it is an array of objects |
| 858 | islocal = False; |
| 859 | if self.isHandleTypeObject(type) == True: |
| 860 | if (len is not None) and (isconst == True): |
| 861 | islocal = True |
| 862 | # Or if it's a struct that contains an object |
| 863 | elif type in struct_member_dict: |
| 864 | if self.struct_contains_object(type) == True: |
| 865 | islocal = True |
| 866 | isdestroy = True if True in [destroy_txt in cmdname for destroy_txt in ['Destroy', 'Free']] else False |
| 867 | iscreate = True if True in [create_txt in cmdname for create_txt in ['Create', 'Allocate', 'Enumerate', 'RegisterDeviceEvent', 'RegisterDisplayEvent']] or ('vkGet' in cmdname and member == members[-1] and ispointer == True) else False |
| 868 | extstructs = member.attrib.get('validextensionstructs') if name == 'pNext' else None |
| 869 | membersInfo.append(self.CommandParam(type=type, |
| 870 | name=name, |
| 871 | ispointer=ispointer, |
| 872 | isconst=isconst, |
| 873 | isoptional=self.paramIsOptional(member), |
| 874 | iscount=iscount, |
| 875 | len=len, |
| 876 | extstructs=extstructs, |
| 877 | cdecl=cdecl, |
| 878 | islocal=islocal, |
| 879 | iscreate=iscreate, |
| 880 | isdestroy=isdestroy, |
| 881 | feature_protect=self.featureExtraProtect)) |
| 882 | self.cmdMembers.append(self.CmdMemberData(name=cmdname, members=membersInfo)) |
| 883 | self.cmd_info_data.append(self.CmdInfoData(name=cmdname, cmdinfo=cmdinfo)) |
| 884 | self.cmd_feature_protect.append(self.CmdExtraProtect(name=cmdname, extra_protect=self.featureExtraProtect)) |
| 885 | # |
| 886 | # Create code Create, Destroy, and validate Vulkan objects |
| 887 | def WrapCommands(self): |
| 888 | cmd_member_dict = dict(self.cmdMembers) |
| 889 | cmd_info_dict = dict(self.cmd_info_data) |
| 890 | cmd_protect_dict = dict(self.cmd_feature_protect) |
| 891 | for api_call in self.cmdMembers: |
| 892 | cmdname = api_call.name |
| 893 | cmdinfo = cmd_info_dict[api_call.name] |
| 894 | if cmdname in self.interface_functions: |
| 895 | continue |
| 896 | if cmdname in self.no_autogen_list: |
| 897 | decls = self.makeCDecls(cmdinfo.elem) |
| 898 | self.appendSection('command', '') |
| 899 | self.appendSection('command', '// Declare only') |
| 900 | self.appendSection('command', decls[0]) |
| 901 | self.intercepts += [ ' {"%s", (void *)%s},' % (cmdname,cmdname[2:]) ] |
| 902 | continue |
| 903 | # Generate object handling code |
| 904 | (api_decls, api_pre, api_post) = self.generate_wrapping_code(cmdinfo.elem) |
| 905 | # If API doesn't contain any object handles, don't fool with it |
| 906 | if not api_decls and not api_pre and not api_post: |
| 907 | continue |
| 908 | feature_extra_protect = cmd_protect_dict[api_call.name] |
| 909 | if (feature_extra_protect != None): |
| 910 | self.appendSection('command', '') |
| 911 | self.appendSection('command', '#ifdef '+ feature_extra_protect) |
| 912 | self.intercepts += [ '#ifdef %s' % feature_extra_protect ] |
| 913 | # Add intercept to procmap |
| 914 | self.intercepts += [ ' {"%s", (void*)%s},' % (cmdname,cmdname[2:]) ] |
| 915 | decls = self.makeCDecls(cmdinfo.elem) |
| 916 | self.appendSection('command', '') |
| 917 | self.appendSection('command', decls[0][:-1]) |
| 918 | self.appendSection('command', '{') |
| 919 | self.appendSection('command', ' bool skip = false;') |
| 920 | # Handle return values, if any |
| 921 | resulttype = cmdinfo.elem.find('proto/type') |
| 922 | if (resulttype != None and resulttype.text == 'void'): |
| 923 | resulttype = None |
| 924 | if (resulttype != None): |
| 925 | assignresult = resulttype.text + ' result = ' |
| 926 | else: |
| 927 | assignresult = '' |
| 928 | # Pre-pend declarations and pre-api-call codegen |
| 929 | if api_decls: |
| 930 | self.appendSection('command', "\n".join(str(api_decls).rstrip().split("\n"))) |
| 931 | if api_pre: |
| 932 | self.appendSection('command', "\n".join(str(api_pre).rstrip().split("\n"))) |
| 933 | # Generate the API call itself |
| 934 | # Gather the parameter items |
| 935 | params = cmdinfo.elem.findall('param/name') |
| 936 | # Pull out the text for each of the parameters, separate them by commas in a list |
| 937 | paramstext = ', '.join([str(param.text) for param in params]) |
| 938 | # Use correct dispatch table |
| 939 | disp_type = cmdinfo.elem.find('param/type').text |
| 940 | disp_name = cmdinfo.elem.find('param/name').text |
| 941 | dispatch_table = 'get_dispatch_table(ot_%s_table_map, %s)->' % (self.GetDispType(disp_type), disp_name) |
| 942 | API = cmdinfo.elem.attrib.get('name').replace('vk', dispatch_table, 1) |
| 943 | # Put all this together for the final down-chain call |
| 944 | if assignresult != '': |
Jamie Madill | fc31519 | 2017-11-08 14:11:26 -0500 | [diff] [blame] | 945 | if resulttype.text == 'VkResult': |
| 946 | self.appendSection('command', ' if (skip) return VK_ERROR_VALIDATION_FAILED_EXT;') |
| 947 | elif resulttype.text == 'VkBool32': |
| 948 | self.appendSection('command', ' if (skip) return VK_FALSE;') |
| 949 | else: |
| 950 | raise Exception('Unknown result type ' + resulttype.text) |
Mark Lobodzinski | d146148 | 2017-07-18 13:56:09 -0600 | [diff] [blame] | 951 | else: |
| 952 | self.appendSection('command', ' if (skip) return;') |
| 953 | self.appendSection('command', ' ' + assignresult + API + '(' + paramstext + ');') |
| 954 | # And add the post-API-call codegen |
| 955 | self.appendSection('command', "\n".join(str(api_post).rstrip().split("\n"))) |
| 956 | # Handle the return result variable, if any |
| 957 | if (resulttype != None): |
| 958 | self.appendSection('command', ' return result;') |
| 959 | self.appendSection('command', '}') |
| 960 | if (feature_extra_protect != None): |
| 961 | self.appendSection('command', '#endif // '+ feature_extra_protect) |
| 962 | self.intercepts += [ '#endif' ] |