codegen: Bring in fixes from glave codegen scripts to vulkan.py vk_helper.py

Add a new target to vk_helper.py for "struct_size" so vktrace can use that.
Otherwise target "struct_wrappers" builds a bunch of files not needed by vtrace.

Add debug_report as an extension in vulkan.py. Vktrace needs this to intercept
debug_report extensions.

diff --git a/vk_helper.py b/vk_helper.py
index bcff445..906c916 100755 (executable)
--- a/vk_helper.py
+++ b/vk_helper.py
@@ -40,6 +40,7 @@ def handle_args():
     parser.add_argument('--abs_out_dir', required=False, default=None, help='Absolute path to write output files. Will be created if needed.')
     parser.add_argument('--gen_enum_string_helper', required=False, action='store_true', default=False, help='Enable generation of helper header file to print string versions of enums.')
     parser.add_argument('--gen_struct_wrappers', required=False, action='store_true', default=False, help='Enable generation of struct wrapper classes.')
+    parser.add_argument('--gen_struct_sizes', required=False, action='store_true', default=False, help='Enable generation of struct sizes.')
     parser.add_argument('--gen_cmake', required=False, action='store_true', default=False, help='Enable generation of cmake file for generated code.')
     parser.add_argument('--gen_graphviz', required=False, action='store_true', default=False, help='Enable generation of graphviz dot file.')
     #parser.add_argument('--test', action='store_true', default=False, help='Run simple test.')
@@ -121,6 +122,7 @@ class HeaderFileParser:
         # TODO : Comment parsing is very fragile but handles 2 known files
         block_comment = False
         prev_count_name = ''
+        exclude_struct_list = ['VkPlatformHandleXcbWSI', 'VkPlatformHandleX11WSI']
         with open(self.header_file) as f:
             for line in f:
                 if block_comment:
@@ -146,6 +148,8 @@ class HeaderFileParser:
                     default_enum_val = 0
                     self.types_dict[base_type] = 'enum'
                 elif 'typedef struct' in line or 'typedef union' in line:
+                    if True in [ex_type in line for ex_type in exclude_struct_list]:
+                        continue
                     (ty_txt, st_txt, base_type) = line.strip().split(None, 2)
                     #print("Found STRUCT type: %s" % base_type)
                     if '{' == base_type:
@@ -231,7 +235,7 @@ class HeaderFileParser:
             self.enum_type_dict[enum_type] = []
         self.enum_type_dict[enum_type].append(enum_name)
 
-    # Return True of struct member is a dynamic array
+    # Return True if struct member is a dynamic array
     # RULES : This is a bit quirky based on the API
     # NOTE : Changes in API spec may cause these rules to change
     #  1. There must be a previous uint var w/ 'count' in the name in the struct
@@ -397,6 +401,7 @@ class StructWrapperGen:
     def __init__(self, in_struct_dict, prefix, out_dir):
         self.struct_dict = in_struct_dict
         self.include_headers = []
+        self.lineinfo = sourcelineinfo()
         self.api = prefix
         if prefix.lower() == "vulkan":
             self.api_prefix = "vk"
@@ -1245,43 +1250,45 @@ class StructWrapperGen:
             sh_funcs.append('%s}' % (indent))
             sh_funcs.append("%sreturn structSize;\n}" % (indent))
         # Now generate generic functions to loop over entire struct chain (or just handle single generic structs)
-        for follow_chain in [True, False]:
-            if follow_chain:
-                sh_funcs.append('size_t get_struct_chain_size(const void* pStruct)\n{')
-            else:
-                sh_funcs.append('size_t get_dynamic_struct_size(const void* pStruct)\n{')
-            indent = '    '
-            sh_funcs.append('%s// Just use VkApplicationInfo as struct until actual type is resolved' % (indent))
-            sh_funcs.append('%sVkApplicationInfo* pNext = (VkApplicationInfo*)pStruct;' % (indent))
-            sh_funcs.append('%ssize_t structSize = 0;' % (indent))
-            if follow_chain:
-                sh_funcs.append('%swhile (pNext) {' % (indent))
-                indent = '        '
-            sh_funcs.append('%sswitch (pNext->sType) {' % (indent))
-            indent += '    '
-            for e in enum_type_dict:
-                if 'StructureType' in e:
-                    for v in sorted(enum_type_dict[e]):
-                        struct_name = get_struct_name_from_struct_type(v)
-                        sh_funcs.append('%scase %s:' % (indent, v))
-                        sh_funcs.append('%s{' % (indent))
+        if 'wsi' not in self.header_filename and 'debug_report' not in self.header_filename:
+            for follow_chain in [True, False]:
+                sh_funcs.append('%s' % self.lineinfo.get())
+                if follow_chain:
+                    sh_funcs.append('size_t get_struct_chain_size(const void* pStruct)\n{')
+                else:
+                    sh_funcs.append('size_t get_dynamic_struct_size(const void* pStruct)\n{')
+                indent = '    '
+                sh_funcs.append('%s// Just use VkApplicationInfo as struct until actual type is resolved' % (indent))
+                sh_funcs.append('%sVkApplicationInfo* pNext = (VkApplicationInfo*)pStruct;' % (indent))
+                sh_funcs.append('%ssize_t structSize = 0;' % (indent))
+                if follow_chain:
+                    sh_funcs.append('%swhile (pNext) {' % (indent))
+                    indent = '        '
+                sh_funcs.append('%sswitch (pNext->sType) {' % (indent))
+                indent += '    '
+                for e in enum_type_dict:
+                    if 'StructureType' in e:
+                        for v in sorted(enum_type_dict[e]):
+                            struct_name = get_struct_name_from_struct_type(v)
+                            sh_funcs.append('%scase %s:' % (indent, v))
+                            sh_funcs.append('%s{' % (indent))
+                            indent += '    '
+                            sh_funcs.append('%sstructSize += %s((%s*)pNext);' % (indent, self._get_size_helper_func_name(struct_name), struct_name))
+                            sh_funcs.append('%sbreak;' % (indent))
+                            indent = indent[:-4]
+                            sh_funcs.append('%s}' % (indent))
+                        sh_funcs.append('%sdefault:' % (indent))
                         indent += '    '
-                        sh_funcs.append('%sstructSize += %s((%s*)pNext);' % (indent, self._get_size_helper_func_name(struct_name), struct_name))
-                        sh_funcs.append('%sbreak;' % (indent))
+                        sh_funcs.append('%sassert(0);' % (indent))
+                        sh_funcs.append('%sstructSize += 0;' % (indent))
                         indent = indent[:-4]
-                        sh_funcs.append('%s}' % (indent))
-                    sh_funcs.append('%sdefault:' % (indent))
-                    indent += '    '
-                    sh_funcs.append('%sassert(0);' % (indent))
-                    sh_funcs.append('%sstructSize += 0;' % (indent))
-                    indent = indent[:-4]
-            indent = indent[:-4]
-            sh_funcs.append('%s}' % (indent))
-            if follow_chain:
-                sh_funcs.append('%spNext = (VkApplicationInfo*)pNext->pNext;' % (indent))
                 indent = indent[:-4]
                 sh_funcs.append('%s}' % (indent))
-            sh_funcs.append('%sreturn structSize;\n}' % indent)
+                if follow_chain:
+                    sh_funcs.append('%spNext = (VkApplicationInfo*)pNext->pNext;' % (indent))
+                    indent = indent[:-4]
+                    sh_funcs.append('%s}' % (indent))
+                sh_funcs.append('%sreturn structSize;\n}' % indent)
         return "\n".join(sh_funcs)
 
     def _generateSizeHelperHeader(self):
@@ -1297,6 +1304,8 @@ class StructWrapperGen:
     def _generateSizeHelperHeaderC(self):
         header = []
         header.append('#include "vk_struct_size_helper.h"')
+        header.append('#include "vk_wsi_swapchain.h"')
+        header.append('#include "vk_wsi_device_swapchain.h"')
         header.append('#include <string.h>')
         header.append('#include <assert.h>')
         header.append('\n// Function definitions\n')
@@ -1782,6 +1791,11 @@ def main(argv=None):
         sw.set_include_headers(["stdio.h", "stdlib.h", "vulkan.h"])
         sw.generateSizeHelper()
         sw.generateSizeHelperC()
+    if opts.gen_struct_sizes:
+        st = StructWrapperGen(struct_dict, os.path.basename(opts.input_file).strip(".h"), os.path.dirname(enum_sh_filename))
+        st.set_include_headers(["stdio.h", "stdlib.h", "vulkan.h"])
+        st.generateSizeHelper()
+        st.generateSizeHelperC()
     if opts.gen_cmake:
         cmg = CMakeGen(sw, os.path.dirname(enum_sh_filename))
         cmg.generate()

diff --git a/vulkan.py b/vulkan.py
index 3d73175..152bd3f 100755 (executable)
--- a/vulkan.py
+++ b/vulkan.py
@@ -235,7 +235,7 @@ core = Extension(
         Proto("VkResult", "GetPhysicalDeviceFormatProperties",
             [Param("VkPhysicalDevice", "physicalDevice"),
              Param("VkFormat", "format"),
-             Param("VkFormatProperties*", "pFormatInfo")]),
+             Param("VkFormatProperties*", "pFormatProperties")]),
 
         Proto("VkResult", "GetPhysicalDeviceImageFormatProperties",
             [Param("VkPhysicalDevice", "physicalDevice"),
@@ -286,7 +286,7 @@ core = Extension(
         Proto("VkResult", "GetPhysicalDeviceExtensionProperties",
             [Param("VkPhysicalDevice", "physicalDevice"),
              Param("const char*", "pLayerName"),
-             Param("uint32_t", "*pCount"),
+             Param("uint32_t*", "pCount"),
              Param("VkExtensionProperties*", "pProperties")]),
 
         Proto("VkResult", "GetGlobalLayerProperties",
@@ -295,12 +295,12 @@ core = Extension(
 
         Proto("VkResult", "GetPhysicalDeviceLayerProperties",
             [Param("VkPhysicalDevice", "physicalDevice"),
-             Param("uint32_t", "*pCount"),
+             Param("uint32_t*", "pCount"),
              Param("VkLayerProperties*", "pProperties")]),
 
         Proto("VkResult", "GetDeviceQueue",
             [Param("VkDevice", "device"),
-             Param("uint32_t", "queueNodeIndex"),
+             Param("uint32_t", "queueFamilyIndex"),
              Param("uint32_t", "queueIndex"),
              Param("VkQueue*", "pQueue")]),
 
@@ -930,7 +930,7 @@ core = Extension(
             [Param("VkCmdBuffer", "cmdBuffer"),
              Param("uint32_t", "eventCount"),
              Param("const VkEvent*", "pEvents"),
-             Param("VkPipelineStageFlags", "sourceStageMask"),
+             Param("VkPipelineStageFlags", "srcStageMask"),
              Param("VkPipelineStageFlags", "destStageMask"),
              Param("uint32_t", "memBarrierCount"),
              Param("const void* const*", "ppMemBarriers")]),
@@ -1029,14 +1029,12 @@ core = Extension(
 wsi_swapchain = Extension(
     name="VK_WSI_swapchain",
     headers=["vk_wsi_swapchain.h"],
-    objects=[
-        "VkDbgMsgCallback",
-    ],
+    objects=[],
     protos=[
         Proto("VkResult", "GetPhysicalDeviceSurfaceSupportWSI",
             [Param("VkPhysicalDevice", "physicalDevice"),
-             Param("uint32_t", "queueNodeIndex"),
-            Param("VkSurfaceDescriptionWSI*", "pSurfaceDescription"),
+             Param("uint32_t", "queueFamilyIndex"),
+             Param("const VkSurfaceDescriptionWSI*", "pSurfaceDescription"),
              Param("VkBool32*", "pSupported")]),
     ],
 )
@@ -1044,13 +1042,11 @@ wsi_swapchain = Extension(
 wsi_device_swapchain = Extension(
     name="VK_WSI_device_swapchain",
     headers=["vk_wsi_device_swapchain.h"],
-    objects=[
-        "VkDbgMsgCallback",
-    ],
+    objects=["VkSwapChainWSI"],
     protos=[
         Proto("VkResult", "GetSurfaceInfoWSI",
             [Param("VkDevice", "device"),
-            Param("VkSurfaceDescriptionWSI*", "pSurfaceDescription"),
+             Param("const VkSurfaceDescriptionWSI*", "pSurfaceDescription"),
              Param("VkSurfaceInfoTypeWSI", "infoType"),
              Param("size_t*", "pDataSize"),
              Param("void*", "pData")]),
@@ -1062,18 +1058,18 @@ wsi_device_swapchain = Extension(
 
         Proto("VkResult", "DestroySwapChainWSI",
             [Param("VkDevice", "device"),
-            Param("VkSwapChainWSI", "swapChain")]),
+             Param("VkSwapChainWSI", "swapChain")]),
 
         Proto("VkResult", "GetSwapChainInfoWSI",
             [Param("VkDevice", "device"),
-            Param("VkSwapChainWSI", "swapChain"),
+             Param("VkSwapChainWSI", "swapChain"),
              Param("VkSwapChainInfoTypeWSI", "infoType"),
              Param("size_t*", "pDataSize"),
              Param("void*", "pData")]),
 
         Proto("VkResult", "AcquireNextImageWSI",
             [Param("VkDevice", "device"),
-            Param("VkSwapChainWSI", "swapChain"),
+             Param("VkSwapChainWSI", "swapChain"),
              Param("uint64_t", "timeout"),
              Param("VkSemaphore", "semaphore"),
              Param("uint32_t*", "pImageIndex")]),
@@ -1083,17 +1079,34 @@ wsi_device_swapchain = Extension(
              Param("VkPresentInfoWSI*", "pPresentInfo")]),
     ],
 )
+debug_report_lunarg = Extension(
+    name="VK_DEBUG_REPORT_LunarG",
+    headers=["vk_debug_report_lunarg.h"],
+    objects=[
+        "VkDbgMsgCallback",
+    ],
+    protos=[
+        Proto("VkResult", "DbgCreateMsgCallback",
+            [Param("VkInstance", "instance"),
+             Param("VkFlags", "msgFlags"),
+             Param("const PFN_vkDbgMsgCallback", "pfnMsgCallback"),
+             Param("void*", "pUserData"),
+             Param("VkDbgMsgCallback*", "pMsgCallback")]),
 
-extensions = [core, wsi_swapchain, wsi_device_swapchain]
+        Proto("VkResult", "DbgDestroyMsgCallback",
+            [Param("VkInstance", "instance"),
+             Param("VkDbgMsgCallback", "msgCallback")]),
+    ],
+)
 
+extensions = [core, wsi_swapchain, wsi_device_swapchain]
+extensions_all = [core, wsi_swapchain, wsi_device_swapchain, debug_report_lunarg]
 object_dispatch_list = [
     "VkInstance",
     "VkPhysicalDevice",
     "VkDevice",
     "VkQueue",
     "VkCmdBuffer",
-    "VkDisplayWSI",
-    "VkSwapChainWSI",
 ]
 
 object_non_dispatch_list = [
@@ -1123,6 +1136,8 @@ object_non_dispatch_list = [
     "VkDynamicDepthStencilState",
     "VkRenderPass",
     "VkFramebuffer",
+    "VkSwapChainWSI",
+    "VkDbgMsgCallback",
 ]
 
 object_type_list = object_dispatch_list + object_non_dispatch_list