blob: 018e3abfb35c97ccd33adfac19f7f0867dd2dd76 [file] [log] [blame]
Tobin Ehlis12076fc2014-10-22 09:06:33 -06001#!/usr/bin/env python3
2#
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06003# VK
Tobin Ehlis12076fc2014-10-22 09:06:33 -06004#
5# Copyright (C) 2014 LunarG, Inc.
6#
7# Permission is hereby granted, free of charge, to any person obtaining a
8# copy of this software and associated documentation files (the "Software"),
9# to deal in the Software without restriction, including without limitation
10# the rights to use, copy, modify, merge, publish, distribute, sublicense,
11# and/or sell copies of the Software, and to permit persons to whom the
12# Software is furnished to do so, subject to the following conditions:
13#
14# The above copyright notice and this permission notice shall be included
15# in all copies or substantial portions of the Software.
16#
17# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
23# DEALINGS IN THE SOFTWARE.
24#
25# Authors:
26# Chia-I Wu <olv@lunarg.com>
27
28import sys
Tobin Ehlis14ff0852014-12-17 17:44:50 -070029import os
Mark Lobodzinski7c75b852015-05-05 15:01:37 -050030import re
Tobin Ehlis12076fc2014-10-22 09:06:33 -060031
Courtney Goeltzenleuchterf53c3cb2015-04-14 14:55:44 -060032import vulkan
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -060033import vk_helper
Tobin Ehlis08fafd02015-06-12 12:49:01 -060034from source_line_info import sourcelineinfo
Tobin Ehlis154e0462015-08-26 11:22:09 -060035from collections import defaultdict
Tobin Ehlis12076fc2014-10-22 09:06:33 -060036
Jon Ashburn95a77ba2015-05-15 15:09:35 -060037def proto_is_global(proto):
Courtney Goeltzenleuchter110fdf92015-06-29 15:39:26 -060038 if proto.params[0].ty == "VkInstance" or proto.params[0].ty == "VkPhysicalDevice" or proto.name == "CreateInstance" or proto.name == "GetGlobalLayerProperties" or proto.name == "GetGlobalExtensionProperties" or proto.name == "GetPhysicalDeviceLayerProperties" or proto.name == "GetPhysicalDeviceExtensionProperties":
Jon Ashburn95a77ba2015-05-15 15:09:35 -060039 return True
40 else:
41 return False
42
Mike Stroyan938c2532015-04-03 13:58:35 -060043def generate_get_proc_addr_check(name):
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -060044 return " if (!%s || %s[0] != 'v' || %s[1] != 'k')\n" \
45 " return NULL;" % ((name,) * 3)
Mike Stroyan938c2532015-04-03 13:58:35 -060046
Mark Lobodzinski7c75b852015-05-05 15:01:37 -050047def ucc_to_U_C_C(CamelCase):
48 temp = re.sub('(.)([A-Z][a-z]+)', r'\1_\2', CamelCase)
49 return re.sub('([a-z0-9])([A-Z])', r'\1_\2', temp).upper()
50
Tobin Ehlis12076fc2014-10-22 09:06:33 -060051class Subcommand(object):
52 def __init__(self, argv):
53 self.argv = argv
Courtney Goeltzenleuchterf53c3cb2015-04-14 14:55:44 -060054 self.headers = vulkan.headers
55 self.protos = vulkan.protos
Mike Stroyan3e3a1eb2015-04-03 17:13:23 -060056 self.no_addr = False
57 self.layer_name = ""
Tobin Ehlis08fafd02015-06-12 12:49:01 -060058 self.lineinfo = sourcelineinfo()
Tobin Ehlis12076fc2014-10-22 09:06:33 -060059
60 def run(self):
Tobin Ehlis12076fc2014-10-22 09:06:33 -060061 print(self.generate())
62
63 def generate(self):
64 copyright = self.generate_copyright()
65 header = self.generate_header()
66 body = self.generate_body()
67 footer = self.generate_footer()
68
69 contents = []
70 if copyright:
71 contents.append(copyright)
72 if header:
73 contents.append(header)
74 if body:
75 contents.append(body)
76 if footer:
77 contents.append(footer)
78
79 return "\n\n".join(contents)
80
81 def generate_copyright(self):
82 return """/* THIS FILE IS GENERATED. DO NOT EDIT. */
83
84/*
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -060085 * Vulkan
Tobin Ehlis12076fc2014-10-22 09:06:33 -060086 *
87 * Copyright (C) 2014 LunarG, Inc.
88 *
89 * Permission is hereby granted, free of charge, to any person obtaining a
90 * copy of this software and associated documentation files (the "Software"),
91 * to deal in the Software without restriction, including without limitation
92 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
93 * and/or sell copies of the Software, and to permit persons to whom the
94 * Software is furnished to do so, subject to the following conditions:
95 *
96 * The above copyright notice and this permission notice shall be included
97 * in all copies or substantial portions of the Software.
98 *
99 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
100 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
101 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
102 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
103 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
104 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
105 * DEALINGS IN THE SOFTWARE.
106 */"""
107
108 def generate_header(self):
109 return "\n".join(["#include <" + h + ">" for h in self.headers])
110
111 def generate_body(self):
112 pass
113
114 def generate_footer(self):
115 pass
116
117 # Return set of printf '%' qualifier and input to that qualifier
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600118 def _get_printf_params(self, vk_type, name, output_param, cpp=False):
Tobin Ehlis12076fc2014-10-22 09:06:33 -0600119 # TODO : Need ENUM and STRUCT checks here
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600120 if vk_helper.is_type(vk_type, 'enum'):#"_TYPE" in vk_type: # TODO : This should be generic ENUM check
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600121 return ("%s", "string_%s(%s)" % (vk_type.replace('const ', '').strip('*'), name))
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600122 if "char*" == vk_type:
Tobin Ehlis12076fc2014-10-22 09:06:33 -0600123 return ("%s", name)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600124 if "uint64" in vk_type:
125 if '*' in vk_type:
Tobin Ehlis12076fc2014-10-22 09:06:33 -0600126 return ("%lu", "*%s" % name)
127 return ("%lu", name)
Tobin Ehlisa30e7e52015-07-06 14:02:36 -0600128 if vk_type.strip('*') in vulkan.object_non_dispatch_list:
129 if '*' in vk_type:
130 return ("%lu", "%s->handle" % name)
131 return ("%lu", "%s.handle" % name)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600132 if "size" in vk_type:
133 if '*' in vk_type:
Chia-I Wu99ff89d2014-12-27 14:14:50 +0800134 return ("%zu", "*%s" % name)
135 return ("%zu", name)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600136 if "float" in vk_type:
137 if '[' in vk_type: # handle array, current hard-coded to 4 (TODO: Make this dynamic)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700138 if cpp:
139 return ("[%i, %i, %i, %i]", '"[" << %s[0] << "," << %s[1] << "," << %s[2] << "," << %s[3] << "]"' % (name, name, name, name))
Tobin Ehlis12076fc2014-10-22 09:06:33 -0600140 return ("[%f, %f, %f, %f]", "%s[0], %s[1], %s[2], %s[3]" % (name, name, name, name))
141 return ("%f", name)
Courtney Goeltzenleuchtercd2a0992015-07-09 11:44:38 -0600142 if "bool" in vk_type.lower() or 'xcb_randr_crtc_t' in vk_type:
Tobin Ehlis12076fc2014-10-22 09:06:33 -0600143 return ("%u", name)
Tobin Ehlisb870cbb2015-04-15 07:46:12 -0600144 if True in [t in vk_type.lower() for t in ["int", "flags", "mask", "xcb_window_t"]]:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600145 if '[' in vk_type: # handle array, current hard-coded to 4 (TODO: Make this dynamic)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700146 if cpp:
147 return ("[%i, %i, %i, %i]", "%s[0] << %s[1] << %s[2] << %s[3]" % (name, name, name, name))
Tobin Ehlis12076fc2014-10-22 09:06:33 -0600148 return ("[%i, %i, %i, %i]", "%s[0], %s[1], %s[2], %s[3]" % (name, name, name, name))
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600149 if '*' in vk_type:
Tobin Ehlisd2b88e82015-02-04 15:15:11 -0700150 if 'pUserData' == name:
151 return ("%i", "((pUserData == 0) ? 0 : *(pUserData))")
Tobin Ehlisc62cb892015-04-17 13:26:33 -0600152 if 'const' in vk_type.lower():
153 return ("%p", "(void*)(%s)" % name)
Jon Ashburn52f79b52014-12-12 16:10:45 -0700154 return ("%i", "*(%s)" % name)
Tobin Ehlis12076fc2014-10-22 09:06:33 -0600155 return ("%i", name)
Tobin Ehlis3a1cc8d2014-11-11 17:28:22 -0700156 # TODO : This is special-cased as there's only one "format" param currently and it's nice to expand it
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600157 if "VkFormat" == vk_type:
Tobin Ehlis99f88672015-01-10 12:42:41 -0700158 if cpp:
159 return ("%p", "&%s" % name)
Courtney Goeltzenleuchterc729b3a2015-07-12 12:40:29 -0600160 return ("{%s.channelFormat = %%s, %s.numericFormat = %%s}" % (name, name), "string_VK_CHANNEL_FORMAT(%s.channelFormat), string_VK_FORMAT_NUM(%s.numericFormat)" % (name, name))
Tobin Ehlise7271572014-11-19 15:52:46 -0700161 if output_param:
Tobin Ehlis12076fc2014-10-22 09:06:33 -0600162 return ("%p", "(void*)*%s" % name)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600163 if vk_helper.is_type(vk_type, 'struct') and '*' not in vk_type:
Courtney Goeltzenleuchterd462fba2015-04-03 16:35:32 -0600164 return ("%p", "(void*)(&%s)" % name)
Jon Ashburn52f79b52014-12-12 16:10:45 -0700165 return ("%p", "(void*)(%s)" % name)
Tobin Ehlis12076fc2014-10-22 09:06:33 -0600166
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600167 def _gen_create_msg_callback(self):
Tobin Ehlise8185062014-12-17 08:01:59 -0700168 r_body = []
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600169 r_body.append('%s' % self.lineinfo.get())
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600170 r_body.append('VK_LAYER_EXPORT VkResult VKAPI vkDbgCreateMsgCallback(VkInstance instance, VkFlags msgFlags, const PFN_vkDbgMsgCallback pfnMsgCallback, void* pUserData, VkDbgMsgCallback* pMsgCallback)')
Tobin Ehlise8185062014-12-17 08:01:59 -0700171 r_body.append('{')
Mark Lobodzinskifae78852015-06-23 11:35:12 -0600172 # Switch to this code section for the new per-instance storage and debug callbacks
Mike Stroyan313f7e62015-08-10 16:42:53 -0600173 if self.layer_name == 'ObjectTracker' or self.layer_name == 'Threading':
Mark Lobodzinskifae78852015-06-23 11:35:12 -0600174 r_body.append(' VkLayerInstanceDispatchTable *pInstanceTable = get_dispatch_table(%s_instance_table_map, instance);' % self.layer_name )
175 r_body.append(' VkResult result = pInstanceTable->DbgCreateMsgCallback(instance, msgFlags, pfnMsgCallback, pUserData, pMsgCallback);')
176 r_body.append(' if (VK_SUCCESS == result) {')
177 r_body.append(' layer_data *my_data = get_my_data_ptr(get_dispatch_key(instance), layer_data_map);')
178 r_body.append(' result = layer_create_msg_callback(my_data->report_data, msgFlags, pfnMsgCallback, pUserData, pMsgCallback);')
179 r_body.append(' }')
180 r_body.append(' return result;')
181 else:
182 # Old version of callbacks for compatibility
183 r_body.append(' return layer_create_msg_callback(instance, instance_dispatch_table(instance), msgFlags, pfnMsgCallback, pUserData, pMsgCallback);')
Tobin Ehlise8185062014-12-17 08:01:59 -0700184 r_body.append('}')
185 return "\n".join(r_body)
186
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600187 def _gen_destroy_msg_callback(self):
188 r_body = []
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600189 r_body.append('%s' % self.lineinfo.get())
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600190 r_body.append('VK_LAYER_EXPORT VkResult VKAPI vkDbgDestroyMsgCallback(VkInstance instance, VkDbgMsgCallback msgCallback)')
191 r_body.append('{')
Mark Lobodzinskifae78852015-06-23 11:35:12 -0600192 # Switch to this code section for the new per-instance storage and debug callbacks
Mike Stroyan313f7e62015-08-10 16:42:53 -0600193 if self.layer_name == 'ObjectTracker' or self.layer_name == 'Threading':
Mark Lobodzinskifae78852015-06-23 11:35:12 -0600194 r_body.append(' VkLayerInstanceDispatchTable *pInstanceTable = get_dispatch_table(%s_instance_table_map, instance);' % self.layer_name )
195 r_body.append(' VkResult result = pInstanceTable->DbgDestroyMsgCallback(instance, msgCallback);')
196 r_body.append(' layer_data *my_data = get_my_data_ptr(get_dispatch_key(instance), layer_data_map);')
197 r_body.append(' layer_destroy_msg_callback(my_data->report_data, msgCallback);')
198 r_body.append(' return result;')
199 else:
200 # Old version of callbacks for compatibility
201 r_body.append(' return layer_destroy_msg_callback(instance, instance_dispatch_table(instance), msgCallback);')
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600202 r_body.append('}')
203 return "\n".join(r_body)
Tobin Ehlise8185062014-12-17 08:01:59 -0700204
Tony Barbour59a47322015-06-24 16:06:58 -0600205 def _gen_layer_get_global_extension_props(self, layer="Generic"):
206 ggep_body = []
Courtney Goeltzenleuchter110fdf92015-06-29 15:39:26 -0600207 # generated layers do not provide any global extensions
208 ggep_body.append('%s' % self.lineinfo.get())
209
210 ggep_body.append('')
211 ggep_body.append('VK_LAYER_EXPORT VkResult VKAPI vkGetGlobalExtensionProperties(const char *pLayerName, uint32_t *pCount, VkExtensionProperties* pProperties)')
212 ggep_body.append('{')
213 ggep_body.append(' return util_GetExtensionProperties(0, NULL, pCount, pProperties);')
214 ggep_body.append('}')
215 return "\n".join(ggep_body)
216
217 def _gen_layer_get_global_layer_props(self, layer="Generic"):
218 ggep_body = []
219 if layer == 'Generic':
220 # Do nothing, extension definition part of generic.h
Tony Barbour59a47322015-06-24 16:06:58 -0600221 ggep_body.append('%s' % self.lineinfo.get())
Courtney Goeltzenleuchterd971b612015-06-17 20:51:59 -0600222 else:
Tony Barbour59a47322015-06-24 16:06:58 -0600223 ggep_body.append('%s' % self.lineinfo.get())
Courtney Goeltzenleuchter79a5a962015-07-07 17:51:45 -0600224 ggep_body.append('static const VkLayerProperties globalLayerProps[] = {')
Tony Barbour59a47322015-06-24 16:06:58 -0600225 ggep_body.append(' {')
Tony Barbour59a47322015-06-24 16:06:58 -0600226 ggep_body.append(' "%s",' % layer)
Courtney Goeltzenleuchter110fdf92015-06-29 15:39:26 -0600227 ggep_body.append(' VK_API_VERSION, // specVersion')
228 ggep_body.append(' VK_MAKE_VERSION(0, 1, 0), // implVersion')
Tony Barbour59a47322015-06-24 16:06:58 -0600229 ggep_body.append(' "layer: %s",' % layer)
230 ggep_body.append(' }')
231 ggep_body.append('};')
232 ggep_body.append('')
233 ggep_body.append('%s' % self.lineinfo.get())
Tony Barbour59a47322015-06-24 16:06:58 -0600234 ggep_body.append('')
Courtney Goeltzenleuchter110fdf92015-06-29 15:39:26 -0600235 ggep_body.append('VK_LAYER_EXPORT VkResult VKAPI vkGetGlobalLayerProperties(uint32_t *pCount, VkLayerProperties* pProperties)')
Tony Barbour59a47322015-06-24 16:06:58 -0600236 ggep_body.append('{')
Courtney Goeltzenleuchter79a5a962015-07-07 17:51:45 -0600237 ggep_body.append(' return util_GetLayerProperties(ARRAY_SIZE(globalLayerProps), globalLayerProps, pCount, pProperties);')
Tony Barbour59a47322015-06-24 16:06:58 -0600238 ggep_body.append('}')
239 return "\n".join(ggep_body)
240
Courtney Goeltzenleuchter3f9f7c42015-07-06 09:11:12 -0600241 def _gen_layer_get_physical_device_layer_props(self, layer="Generic"):
242 gpdlp_body = []
243 if layer == 'Generic':
244 # Do nothing, extension definition part of generic.h
245 gpdlp_body.append('%s' % self.lineinfo.get())
246 else:
247 gpdlp_body.append('%s' % self.lineinfo.get())
Courtney Goeltzenleuchter79a5a962015-07-07 17:51:45 -0600248 gpdlp_body.append('static const VkLayerProperties deviceLayerProps[] = {')
Courtney Goeltzenleuchter3f9f7c42015-07-06 09:11:12 -0600249 gpdlp_body.append(' {')
250 gpdlp_body.append(' "%s",' % layer)
251 gpdlp_body.append(' VK_API_VERSION,')
252 gpdlp_body.append(' VK_MAKE_VERSION(0, 1, 0),')
253 gpdlp_body.append(' "layer: %s",' % layer)
254 gpdlp_body.append(' }')
255 gpdlp_body.append('};')
256 gpdlp_body.append('VK_LAYER_EXPORT VkResult VKAPI vkGetPhysicalDeviceLayerProperties(VkPhysicalDevice physicalDevice, uint32_t *pCount, VkLayerProperties* pProperties)')
257 gpdlp_body.append('{')
Courtney Goeltzenleuchter79a5a962015-07-07 17:51:45 -0600258 gpdlp_body.append(' return util_GetLayerProperties(ARRAY_SIZE(deviceLayerProps), deviceLayerProps, pCount, pProperties);')
Courtney Goeltzenleuchter3f9f7c42015-07-06 09:11:12 -0600259 gpdlp_body.append('}')
260 gpdlp_body.append('')
261 return "\n".join(gpdlp_body)
262
Mike Stroyanbf237d72015-04-03 17:45:53 -0600263 def _generate_dispatch_entrypoints(self, qual=""):
Mike Stroyan938c2532015-04-03 13:58:35 -0600264 if qual:
265 qual += " "
266
Mike Stroyan938c2532015-04-03 13:58:35 -0600267 funcs = []
268 intercepted = []
269 for proto in self.protos:
Jon Ashburn8d1b0b52015-05-18 13:20:15 -0600270 if proto.name == "GetDeviceProcAddr" or proto.name == "GetInstanceProcAddr":
Jon Ashburn8fd08252015-05-28 16:25:02 -0600271 continue
Mike Stroyan70c05e82015-04-08 10:27:43 -0600272 else:
Mike Stroyan3e3a1eb2015-04-03 17:13:23 -0600273 intercept = self.generate_intercept(proto, qual)
Mike Stroyan938c2532015-04-03 13:58:35 -0600274 if intercept is None:
275 # fill in default intercept for certain entrypoints
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600276 if 'DbgCreateMsgCallback' == proto.name:
277 intercept = self._gen_layer_dbg_create_msg_callback()
278 elif 'DbgDestroyMsgCallback' == proto.name:
279 intercept = self._gen_layer_dbg_destroy_msg_callback()
280 elif 'CreateDevice' == proto.name:
281 funcs.append('/* CreateDevice HERE */')
Tony Barbour59a47322015-06-24 16:06:58 -0600282 elif 'GetGlobalExtensionProperties' == proto.name:
283 intercept = self._gen_layer_get_global_extension_props(self.layer_name)
Courtney Goeltzenleuchter110fdf92015-06-29 15:39:26 -0600284 elif 'GetGlobalLayerProperties' == proto.name:
285 intercept = self._gen_layer_get_global_layer_props(self.layer_name)
286 elif 'GetPhysicalDeviceLayerProperties' == proto.name:
287 intercept = self._gen_layer_get_physical_device_layer_props(self.layer_name)
Tony Barbour59a47322015-06-24 16:06:58 -0600288
Mike Stroyan938c2532015-04-03 13:58:35 -0600289 if intercept is not None:
290 funcs.append(intercept)
Jon Ashburn747f2b62015-06-18 15:02:58 -0600291 if not "WSI" in proto.name:
292 intercepted.append(proto)
Mike Stroyan938c2532015-04-03 13:58:35 -0600293
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600294 prefix="vk"
Mike Stroyan938c2532015-04-03 13:58:35 -0600295 lookups = []
296 for proto in intercepted:
Mike Stroyan938c2532015-04-03 13:58:35 -0600297 lookups.append("if (!strcmp(name, \"%s\"))" % proto.name)
Courtney Goeltzenleuchter2d3ba632015-07-12 14:35:22 -0600298 lookups.append(" return (PFN_vkVoidFunction) %s%s;" %
Mike Stroyan938c2532015-04-03 13:58:35 -0600299 (prefix, proto.name))
Mike Stroyan938c2532015-04-03 13:58:35 -0600300
301 # add customized layer_intercept_proc
302 body = []
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600303 body.append('%s' % self.lineinfo.get())
Courtney Goeltzenleuchter2d3ba632015-07-12 14:35:22 -0600304 body.append("static inline PFN_vkVoidFunction layer_intercept_proc(const char *name)")
Mike Stroyan938c2532015-04-03 13:58:35 -0600305 body.append("{")
306 body.append(generate_get_proc_addr_check("name"))
307 body.append("")
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600308 body.append(" name += 2;")
Mike Stroyan938c2532015-04-03 13:58:35 -0600309 body.append(" %s" % "\n ".join(lookups))
310 body.append("")
311 body.append(" return NULL;")
312 body.append("}")
Jon Ashburnf6b33db2015-05-05 14:22:52 -0600313 # add layer_intercept_instance_proc
314 lookups = []
315 for proto in self.protos:
Jon Ashburn95a77ba2015-05-15 15:09:35 -0600316 if not proto_is_global(proto):
Jon Ashburnf6b33db2015-05-05 14:22:52 -0600317 continue
318
319 if not proto in intercepted:
320 continue
Courtney Goeltzenleuchterca173b82015-06-25 18:01:43 -0600321 if proto.name == "CreateDevice":
322 continue
Jon Ashburnf6b33db2015-05-05 14:22:52 -0600323 lookups.append("if (!strcmp(name, \"%s\"))" % proto.name)
Courtney Goeltzenleuchter2d3ba632015-07-12 14:35:22 -0600324 lookups.append(" return (PFN_vkVoidFunction) %s%s;" % (prefix, proto.name))
Jon Ashburnf6b33db2015-05-05 14:22:52 -0600325
Courtney Goeltzenleuchter2d3ba632015-07-12 14:35:22 -0600326 body.append("static inline PFN_vkVoidFunction layer_intercept_instance_proc(const char *name)")
Jon Ashburnf6b33db2015-05-05 14:22:52 -0600327 body.append("{")
328 body.append(generate_get_proc_addr_check("name"))
329 body.append("")
330 body.append(" name += 2;")
331 body.append(" %s" % "\n ".join(lookups))
332 body.append("")
333 body.append(" return NULL;")
334 body.append("}")
335
Mike Stroyan938c2532015-04-03 13:58:35 -0600336 funcs.append("\n".join(body))
Mike Stroyan938c2532015-04-03 13:58:35 -0600337 return "\n\n".join(funcs)
338
Tobin Ehlisca915872014-11-18 11:28:33 -0700339 def _generate_extensions(self):
340 exts = []
Mark Lobodzinskifae78852015-06-23 11:35:12 -0600341 exts.append('%s' % self.lineinfo.get())
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600342 exts.append(self._gen_create_msg_callback())
343 exts.append(self._gen_destroy_msg_callback())
Tobin Ehlisb870cbb2015-04-15 07:46:12 -0600344 return "\n".join(exts)
345
Jon Ashburnf6b33db2015-05-05 14:22:52 -0600346 def _generate_layer_gpa_function(self, extensions=[], instance_extensions=[]):
Jon Ashburnbacb0f52015-04-06 10:58:22 -0600347 func_body = []
Mark Lobodzinskifae78852015-06-23 11:35:12 -0600348#
Courtney Goeltzenleuchter3f9f7c42015-07-06 09:11:12 -0600349# New style of GPA Functions for the new layer_data/layer_logging changes
Mark Lobodzinskifae78852015-06-23 11:35:12 -0600350#
Mike Stroyan313f7e62015-08-10 16:42:53 -0600351 if self.layer_name == 'ObjectTracker' or self.layer_name == 'Threading':
Courtney Goeltzenleuchter2d3ba632015-07-12 14:35:22 -0600352 func_body.append("VK_LAYER_EXPORT PFN_vkVoidFunction VKAPI vkGetDeviceProcAddr(VkDevice device, const char* funcName)\n"
Mark Lobodzinskifae78852015-06-23 11:35:12 -0600353 "{\n"
Courtney Goeltzenleuchter2d3ba632015-07-12 14:35:22 -0600354 " PFN_vkVoidFunction addr;\n"
Mark Lobodzinskifae78852015-06-23 11:35:12 -0600355 " if (device == VK_NULL_HANDLE) {\n"
356 " return NULL;\n"
357 " }\n"
358 " /* loader uses this to force layer initialization; device object is wrapped */\n"
359 " if (!strcmp(\"vkGetDeviceProcAddr\", funcName)) {\n"
360 " initDeviceTable(%s_device_table_map, (const VkBaseLayerObject *) device);\n"
Courtney Goeltzenleuchter2d3ba632015-07-12 14:35:22 -0600361 " return (PFN_vkVoidFunction) vkGetDeviceProcAddr;\n"
Mark Lobodzinskifae78852015-06-23 11:35:12 -0600362 " }\n\n"
363 " addr = layer_intercept_proc(funcName);\n"
364 " if (addr)\n"
365 " return addr;" % self.layer_name)
366 if 0 != len(extensions):
Courtney Goeltzenleuchter3f9f7c42015-07-06 09:11:12 -0600367 func_body.append('%s' % self.lineinfo.get())
368 func_body.append(' layer_data *my_device_data = get_my_data_ptr(get_dispatch_key(device), layer_data_map);')
Mark Lobodzinskifae78852015-06-23 11:35:12 -0600369 for (ext_enable, ext_list) in extensions:
370 extra_space = ""
371 if 0 != len(ext_enable):
Courtney Goeltzenleuchter3f9f7c42015-07-06 09:11:12 -0600372 func_body.append(' if (my_device_data->%s) {' % ext_enable)
Mark Lobodzinskifae78852015-06-23 11:35:12 -0600373 extra_space = " "
374 for ext_name in ext_list:
375 func_body.append(' %sif (!strcmp("%s", funcName))\n'
Courtney Goeltzenleuchter2d3ba632015-07-12 14:35:22 -0600376 ' %sreturn reinterpret_cast<PFN_vkVoidFunction>(%s);' % (extra_space, ext_name, extra_space, ext_name))
Mark Lobodzinskifae78852015-06-23 11:35:12 -0600377 if 0 != len(ext_enable):
378 func_body.append(' }\n')
379 func_body.append("\n if (get_dispatch_table(%s_device_table_map, device)->GetDeviceProcAddr == NULL)\n"
380 " return NULL;\n"
381 " return get_dispatch_table(%s_device_table_map, device)->GetDeviceProcAddr(device, funcName);\n"
382 "}\n" % (self.layer_name, self.layer_name))
Courtney Goeltzenleuchter2d3ba632015-07-12 14:35:22 -0600383 func_body.append("VK_LAYER_EXPORT PFN_vkVoidFunction VKAPI vkGetInstanceProcAddr(VkInstance instance, const char* funcName)\n"
Mark Lobodzinskifae78852015-06-23 11:35:12 -0600384 "{\n"
Courtney Goeltzenleuchter2d3ba632015-07-12 14:35:22 -0600385 " PFN_vkVoidFunction addr;\n"
Mark Lobodzinskifae78852015-06-23 11:35:12 -0600386 " if (instance == VK_NULL_HANDLE) {\n"
387 " return NULL;\n"
388 " }\n"
389 " /* loader uses this to force layer initialization; instance object is wrapped */\n"
390 " if (!strcmp(\"vkGetInstanceProcAddr\", funcName)) {\n"
391 " initInstanceTable(%s_instance_table_map, (const VkBaseLayerObject *) instance);\n"
Courtney Goeltzenleuchter2d3ba632015-07-12 14:35:22 -0600392 " return (PFN_vkVoidFunction) vkGetInstanceProcAddr;\n"
Mark Lobodzinskifae78852015-06-23 11:35:12 -0600393 " }\n\n"
394 " addr = layer_intercept_instance_proc(funcName);\n"
395 " if (addr) {\n"
396 " return addr;"
397 " }\n" % self.layer_name)
Jon Ashburnbacb0f52015-04-06 10:58:22 -0600398
Mark Lobodzinskifae78852015-06-23 11:35:12 -0600399 if 0 != len(instance_extensions):
400 for ext_name in instance_extensions:
401 func_body.append(" layer_data *my_data = get_my_data_ptr(get_dispatch_key(instance), layer_data_map);\n"
402 " addr = debug_report_get_instance_proc_addr(my_data->report_data, funcName);\n"
403 " if (addr) {\n"
404 " return addr;\n"
405 " }\n"
406 " if (get_dispatch_table(%s_instance_table_map, instance)->GetInstanceProcAddr == NULL) {\n"
407 " return NULL;\n"
408 " }\n"
409 " return get_dispatch_table(%s_instance_table_map, instance)->GetInstanceProcAddr(instance, funcName);\n"
410 "}\n" % (self.layer_name, self.layer_name))
411 return "\n".join(func_body)
412 else:
413#
414# TODO:: Old-style GPA Functions -- no local storage, no new logging mechanism. Left for compatibility.
415#
416 func_body.append('%s' % self.lineinfo.get())
Courtney Goeltzenleuchter2d3ba632015-07-12 14:35:22 -0600417 func_body.append("VK_LAYER_EXPORT PFN_vkVoidFunction VKAPI vkGetDeviceProcAddr(VkDevice device, const char* funcName)\n"
Mark Lobodzinskifae78852015-06-23 11:35:12 -0600418 "{\n"
Courtney Goeltzenleuchter2d3ba632015-07-12 14:35:22 -0600419 " PFN_vkVoidFunction addr;\n"
Mark Lobodzinskifae78852015-06-23 11:35:12 -0600420 " if (device == VK_NULL_HANDLE) {\n"
421 " return NULL;\n"
422 " }\n"
423 " loader_platform_thread_once(&initOnce, init%s);\n\n"
424 " /* loader uses this to force layer initialization; device object is wrapped */\n"
425 " if (!strcmp(\"vkGetDeviceProcAddr\", funcName)) {\n"
426 " initDeviceTable((const VkBaseLayerObject *) device);\n"
Courtney Goeltzenleuchter2d3ba632015-07-12 14:35:22 -0600427 " return (PFN_vkVoidFunction) vkGetDeviceProcAddr;\n"
Mark Lobodzinskifae78852015-06-23 11:35:12 -0600428 " }\n\n"
429 " addr = layer_intercept_proc(funcName);\n"
430 " if (addr)\n"
431 " return addr;" % self.layer_name)
432 func_body.append('')
433 func_body.append(' VkLayerDispatchTable *pDisp = device_dispatch_table(device);')
434 if 0 != len(extensions):
435 extra_space = ""
436 for (ext_enable, ext_list) in extensions:
437 if 0 != len(ext_enable):
438 func_body.append(' if (deviceExtMap.size() == 0 || deviceExtMap[pDisp].%s)' % ext_enable)
439 func_body.append(' {')
440 extra_space = " "
441 for ext_name in ext_list:
442 func_body.append(' %sif (!strcmp("%s", funcName))\n'
Courtney Goeltzenleuchter2d3ba632015-07-12 14:35:22 -0600443 ' return reinterpret_cast<PFN_vkVoidFunction>(%s);' % (extra_space, ext_name, ext_name))
Mark Lobodzinskifae78852015-06-23 11:35:12 -0600444 if 0 != len(ext_enable):
445 func_body.append(' }')
446 func_body.append('%s' % self.lineinfo.get())
447 func_body.append(" {\n"
448 " if (pDisp->GetDeviceProcAddr == NULL)\n"
449 " return NULL;\n"
450 " return pDisp->GetDeviceProcAddr(device, funcName);\n"
451 " }\n"
452 "}\n")
Courtney Goeltzenleuchter2d3ba632015-07-12 14:35:22 -0600453 func_body.append("VK_LAYER_EXPORT PFN_vkVoidFunction VKAPI vkGetInstanceProcAddr(VkInstance instance, const char* funcName)\n"
Mark Lobodzinskifae78852015-06-23 11:35:12 -0600454 "{\n"
Courtney Goeltzenleuchter2d3ba632015-07-12 14:35:22 -0600455 " PFN_vkVoidFunction addr;\n"
Mark Lobodzinskifae78852015-06-23 11:35:12 -0600456 " if (instance == VK_NULL_HANDLE) {\n"
457 " return NULL;\n"
458 " }\n"
459 " loader_platform_thread_once(&initOnce, init%s);\n\n"
460 " /* loader uses this to force layer initialization; instance object is wrapped */\n"
461 " if (!strcmp(\"vkGetInstanceProcAddr\", funcName)) {\n"
462 " initInstanceTable((const VkBaseLayerObject *) instance);\n"
Courtney Goeltzenleuchter2d3ba632015-07-12 14:35:22 -0600463 " return (PFN_vkVoidFunction) vkGetInstanceProcAddr;\n"
Mark Lobodzinskifae78852015-06-23 11:35:12 -0600464 " }\n\n"
465 " addr = layer_intercept_instance_proc(funcName);\n"
466 " if (addr)\n"
467 " return addr;" % self.layer_name)
468 if 0 != len(instance_extensions):
469 for ext_name in instance_extensions:
470 func_body.append(" {\n"
Courtney Goeltzenleuchter2d3ba632015-07-12 14:35:22 -0600471 " PFN_vkVoidFunction fptr;\n"
Mark Lobodzinskifae78852015-06-23 11:35:12 -0600472 " fptr = %s(funcName);\n"
473 " if (fptr) return fptr;\n"
474 " }\n" % ext_name)
475 func_body.append(" VkLayerInstanceDispatchTable* pTable = instance_dispatch_table(instance);\n"
476 " if (pTable->GetInstanceProcAddr == NULL)\n"
477 " return NULL;\n"
478 " return pTable->GetInstanceProcAddr(instance, funcName);\n"
479 "}\n")
480 return "\n".join(func_body)
Jon Ashburnf6b33db2015-05-05 14:22:52 -0600481
Tobin Ehlis12076fc2014-10-22 09:06:33 -0600482
Mike Stroyaned238bb2015-05-15 08:50:57 -0600483 def _generate_layer_initialization(self, init_opts=False, prefix='vk', lockname=None, condname=None):
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600484 func_body = ["#include \"vk_dispatch_table_helper.h\""]
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600485 func_body.append('%s' % self.lineinfo.get())
Jon Ashburnd6badbc2015-02-16 08:26:50 -0700486 func_body.append('static void init%s(void)\n'
Mike Stroyan3e3a1eb2015-04-03 17:13:23 -0600487 '{\n' % self.layer_name)
Jon Ashburnd6badbc2015-02-16 08:26:50 -0700488 if init_opts:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600489 func_body.append('%s' % self.lineinfo.get())
Jon Ashburnd6badbc2015-02-16 08:26:50 -0700490 func_body.append(' const char *strOpt;')
Mike Stroyan3e3a1eb2015-04-03 17:13:23 -0600491 func_body.append(' // initialize %s options' % self.layer_name)
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600492 func_body.append(' getLayerOptionEnum("%sReportLevel", (uint32_t *) &g_reportFlags);' % self.layer_name)
Mike Stroyan3e3a1eb2015-04-03 17:13:23 -0600493 func_body.append(' g_actionIsDefault = getLayerOptionEnum("%sDebugAction", (uint32_t *) &g_debugAction);' % self.layer_name)
Jon Ashburnd6badbc2015-02-16 08:26:50 -0700494 func_body.append('')
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600495 func_body.append(' if (g_debugAction & VK_DBG_LAYER_ACTION_LOG_MSG)')
Jon Ashburnd6badbc2015-02-16 08:26:50 -0700496 func_body.append(' {')
Mike Stroyan3e3a1eb2015-04-03 17:13:23 -0600497 func_body.append(' strOpt = getLayerOption("%sLogFilename");' % self.layer_name)
Jon Ashburnd6badbc2015-02-16 08:26:50 -0700498 func_body.append(' if (strOpt)')
499 func_body.append(' {')
500 func_body.append(' g_logFile = fopen(strOpt, "w");')
501 func_body.append(' }')
502 func_body.append(' if (g_logFile == NULL)')
503 func_body.append(' g_logFile = stdout;')
504 func_body.append(' }')
505 func_body.append('')
Tobin Ehlis36f1b462015-02-23 14:09:16 -0700506 if lockname is not None:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600507 func_body.append('%s' % self.lineinfo.get())
Tobin Ehlis36f1b462015-02-23 14:09:16 -0700508 func_body.append(" if (!%sLockInitialized)" % lockname)
509 func_body.append(" {")
510 func_body.append(" // TODO/TBD: Need to delete this mutex sometime. How???")
511 func_body.append(" loader_platform_thread_create_mutex(&%sLock);" % lockname)
Mike Stroyaned238bb2015-05-15 08:50:57 -0600512 if condname is not None:
513 func_body.append(" loader_platform_thread_init_cond(&%sCond);" % condname)
Tobin Ehlis36f1b462015-02-23 14:09:16 -0700514 func_body.append(" %sLockInitialized = 1;" % lockname)
515 func_body.append(" }")
Tobin Ehlis12076fc2014-10-22 09:06:33 -0600516 func_body.append("}\n")
Jon Ashburn8c5cbcf2015-05-07 10:27:37 -0600517 func_body.append('')
Tobin Ehlis12076fc2014-10-22 09:06:33 -0600518 return "\n".join(func_body)
519
Mike Stroyan313f7e62015-08-10 16:42:53 -0600520 def _generate_new_layer_initialization(self, init_opts=False, prefix='vk', lockname=None, condname=None):
521 func_body = ["#include \"vk_dispatch_table_helper.h\""]
522 func_body.append('%s' % self.lineinfo.get())
523 func_body.append('static void init%s(layer_data *my_data)\n'
524 '{\n' % self.layer_name)
525 if init_opts:
526 func_body.append('%s' % self.lineinfo.get())
527 func_body.append(' uint32_t report_flags = 0;')
528 func_body.append(' uint32_t debug_action = 0;')
529 func_body.append(' FILE *log_output = NULL;')
530 func_body.append(' const char *strOpt;')
531 func_body.append(' // initialize %s options' % self.layer_name)
532 func_body.append(' report_flags = getLayerOptionFlags("%sReportFlags", 0);' % self.layer_name)
533 func_body.append(' g_actionIsDefault = getLayerOptionEnum("%sDebugAction", (uint32_t *) &debug_action);' % self.layer_name)
534 func_body.append('')
535 func_body.append(' if (debug_action & VK_DBG_LAYER_ACTION_LOG_MSG)')
536 func_body.append(' {')
537 func_body.append(' strOpt = getLayerOption("%sLogFilename");' % self.layer_name)
538 func_body.append(' if (strOpt)')
539 func_body.append(' {')
540 func_body.append(' log_output = fopen(strOpt, "w");')
541 func_body.append(' }')
542 func_body.append(' if (log_output == NULL)')
543 func_body.append(' log_output = stdout;')
544 func_body.append(' layer_create_msg_callback(my_data->report_data, report_flags, log_callback, (void *) log_output, &my_data->logging_callback);')
545 func_body.append(' }')
546 func_body.append('')
547 if lockname is not None:
548 func_body.append('%s' % self.lineinfo.get())
549 func_body.append(" if (!%sLockInitialized)" % lockname)
550 func_body.append(" {")
551 func_body.append(" // TODO/TBD: Need to delete this mutex sometime. How???")
552 func_body.append(" loader_platform_thread_create_mutex(&%sLock);" % lockname)
553 if condname is not None:
554 func_body.append(" loader_platform_thread_init_cond(&%sCond);" % condname)
555 func_body.append(" %sLockInitialized = 1;" % lockname)
556 func_body.append(" }")
557 func_body.append("}\n")
558 func_body.append('')
559 return "\n".join(func_body)
560
Tobin Ehlis12076fc2014-10-22 09:06:33 -0600561class LayerFuncsSubcommand(Subcommand):
562 def generate_header(self):
Tobin Ehlis0c6f9ee2015-07-03 09:42:57 -0600563 return '#include <vk_layer.h>\n#include "loader.h"'
Tobin Ehlis12076fc2014-10-22 09:06:33 -0600564
565 def generate_body(self):
Mike Stroyan3e3a1eb2015-04-03 17:13:23 -0600566 return self._generate_dispatch_entrypoints("static")
Tobin Ehlis12076fc2014-10-22 09:06:33 -0600567
Tobin Ehlis12076fc2014-10-22 09:06:33 -0600568class GenericLayerSubcommand(Subcommand):
569 def generate_header(self):
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -0500570 gen_header = []
Courtney Goeltzenleuchter79a5a962015-07-07 17:51:45 -0600571 gen_header.append('%s' % self.lineinfo.get())
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -0500572 gen_header.append('#include <stdio.h>')
573 gen_header.append('#include <stdlib.h>')
574 gen_header.append('#include <string.h>')
575 gen_header.append('#include <unordered_map>')
Tobin Ehlisb835d1b2015-07-03 10:34:49 -0600576 gen_header.append('#include "vk_loader_platform.h"')
Tobin Ehlis0c6f9ee2015-07-03 09:42:57 -0600577 gen_header.append('#include "vk_layer.h"')
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -0500578 gen_header.append('//The following is #included again to catch certain OS-specific functions being used:')
579 gen_header.append('')
Tobin Ehlisb835d1b2015-07-03 10:34:49 -0600580 gen_header.append('#include "vk_loader_platform.h"')
Tobin Ehlisa0cb02e2015-07-03 10:15:26 -0600581 gen_header.append('#include "vk_layer_config.h"')
582 gen_header.append('#include "vk_layer_msg.h"')
583 gen_header.append('#include "vk_layer_table.h"')
Courtney Goeltzenleuchter3f9f7c42015-07-06 09:11:12 -0600584 gen_header.append('#include "vk_layer_extension_utils.h"')
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -0500585 gen_header.append('')
Courtney Goeltzenleuchter79a5a962015-07-07 17:51:45 -0600586 gen_header.append('#include "generic.h"')
Courtney Goeltzenleuchter110fdf92015-06-29 15:39:26 -0600587 gen_header.append('')
Tobin Ehlisa30e7e52015-07-06 14:02:36 -0600588 gen_header.append('%s' % self.lineinfo.get())
589 gen_header.append('#define LAYER_EXT_ARRAY_SIZE 1')
590 gen_header.append('#define LAYER_DEV_EXT_ARRAY_SIZE 1')
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -0500591 gen_header.append('static LOADER_PLATFORM_THREAD_ONCE_DECLARATION(initOnce);')
Jon Ashburn747f2b62015-06-18 15:02:58 -0600592 gen_header.append('struct devExts {')
Ian Elliott1064fe32015-07-06 14:31:32 -0600593 gen_header.append(' bool wsi_enabled;')
Jon Ashburn747f2b62015-06-18 15:02:58 -0600594 gen_header.append('};')
595 gen_header.append('static std::unordered_map<void *, struct devExts> deviceExtMap;')
596 gen_header.append('')
597 gen_header.append('static void createDeviceRegisterExtensions(const VkDeviceCreateInfo* pCreateInfo, VkDevice device)')
598 gen_header.append('{')
Tony Barbour3b4732f2015-07-13 13:37:24 -0600599 gen_header.append(' uint32_t i;')
Jon Ashburn747f2b62015-06-18 15:02:58 -0600600 gen_header.append(' VkLayerDispatchTable *pDisp = device_dispatch_table(device);')
Ian Elliott1064fe32015-07-06 14:31:32 -0600601 gen_header.append(' deviceExtMap[pDisp].wsi_enabled = false;')
Jon Ashburn747f2b62015-06-18 15:02:58 -0600602 gen_header.append(' for (i = 0; i < pCreateInfo->extensionCount; i++) {')
Ian Elliott1064fe32015-07-06 14:31:32 -0600603 gen_header.append(' if (strcmp(pCreateInfo->ppEnabledExtensionNames[i], VK_WSI_SWAPCHAIN_EXTENSION_NAME) == 0)')
604 gen_header.append(' deviceExtMap[pDisp].wsi_enabled = true;')
Jon Ashburn747f2b62015-06-18 15:02:58 -0600605 gen_header.append('')
606 gen_header.append(' }')
607 gen_header.append('}')
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -0500608 gen_header.append('')
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -0500609 return "\n".join(gen_header)
Tobin Ehlis7a314ea2015-07-07 11:02:44 -0600610
Mike Stroyan3e3a1eb2015-04-03 17:13:23 -0600611 def generate_intercept(self, proto, qual):
Courtney Goeltzenleuchter110fdf92015-06-29 15:39:26 -0600612 if proto.name in [ 'GetGlobalLayerProperties', 'GetGlobalExtensionProperties', 'GetPhysicalDeviceLayerProperties', 'GetPhysicalDeviceExtensionProperties' ]:
Mike Stroyan00087e62015-04-03 14:39:16 -0600613 # use default version
614 return None
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600615 decl = proto.c_func(prefix="vk", attr="VKAPI")
Mike Stroyan938c2532015-04-03 13:58:35 -0600616 ret_val = ''
617 stmt = ''
618 funcs = []
Jon Ashburn71836d92015-05-12 17:23:55 -0600619 table = ''
Jon Ashburn95a77ba2015-05-15 15:09:35 -0600620 if proto_is_global(proto):
Jon Ashburn71836d92015-05-12 17:23:55 -0600621 table = 'Instance'
Mike Stroyan938c2532015-04-03 13:58:35 -0600622 if proto.ret != "void":
Courtney Goeltzenleuchter0de9e212015-06-26 15:07:53 -0600623 funcs.append('%s' % self.lineinfo.get())
Jon Ashburnb0fbe912015-05-06 10:15:07 -0600624 ret_val = "%s result = " % proto.ret
Mike Stroyan938c2532015-04-03 13:58:35 -0600625 stmt = " return result;\n"
Jon Ashburn8ced4212015-05-22 12:01:50 -0600626 if proto.name == "CreateDevice":
Courtney Goeltzenleuchter0de9e212015-06-26 15:07:53 -0600627 funcs.append('%s' % self.lineinfo.get())
Mike Stroyan938c2532015-04-03 13:58:35 -0600628 funcs.append('%s%s\n'
629 '{\n'
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -0500630 ' char str[1024];\n'
631 ' sprintf(str, "At start of layered %s\\n");\n'
Tony Barboura05dbaa2015-07-09 17:31:46 -0600632 ' layerCbMsg(VK_DBG_REPORT_INFO_BIT,VK_OBJECT_TYPE_PHYSICAL_DEVICE, (uint64_t)physicalDevice, 0, 0, (char *) "GENERIC", (char *) str);\n'
Courtney Goeltzenleuchterca173b82015-06-25 18:01:43 -0600633 ' %sdevice_dispatch_table(*pDevice)->%s;\n'
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600634 ' if (result == VK_SUCCESS) {\n'
Courtney Goeltzenleuchter110fdf92015-06-29 15:39:26 -0600635 ' enable_debug_report(pCreateInfo->extensionCount, pCreateInfo->ppEnabledExtensionNames);\n'
Jon Ashburn747f2b62015-06-18 15:02:58 -0600636 ' createDeviceRegisterExtensions(pCreateInfo, *pDevice);\n'
Mike Stroyan938c2532015-04-03 13:58:35 -0600637 ' }\n'
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -0500638 ' sprintf(str, "Completed layered %s\\n");\n'
Tony Barboura05dbaa2015-07-09 17:31:46 -0600639 ' layerCbMsg(VK_DBG_REPORT_INFO_BIT, VK_OBJECT_TYPE_PHYSICAL_DEVICE, (uint64_t)physicalDevice, 0, 0, (char *) "GENERIC", (char *) str);\n'
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -0500640 ' fflush(stdout);\n'
641 ' %s'
642 '}' % (qual, decl, proto.name, ret_val, proto.c_call(), proto.name, stmt))
643 elif proto.name == "DestroyDevice":
Courtney Goeltzenleuchter0de9e212015-06-26 15:07:53 -0600644 funcs.append('%s' % self.lineinfo.get())
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -0500645 funcs.append('%s%s\n'
646 '{\n'
Courtney Goeltzenleuchter0daf2282015-06-13 21:22:12 -0600647 ' dispatch_key key = get_dispatch_key(device);\n'
Jon Ashburn747f2b62015-06-18 15:02:58 -0600648 ' VkLayerDispatchTable *pDisp = device_dispatch_table(device);\n'
649 ' VkResult res = pDisp->DestroyDevice(device);\n'
650 ' deviceExtMap.erase(pDisp);\n'
Courtney Goeltzenleuchter0daf2282015-06-13 21:22:12 -0600651 ' destroy_device_dispatch_table(key);\n'
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -0500652 ' return res;\n'
653 '}\n' % (qual, decl))
654 elif proto.name == "DestroyInstance":
Courtney Goeltzenleuchter0de9e212015-06-26 15:07:53 -0600655 funcs.append('%s' % self.lineinfo.get())
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -0500656 funcs.append('%s%s\n'
657 '{\n'
Courtney Goeltzenleuchter0daf2282015-06-13 21:22:12 -0600658 ' dispatch_key key = get_dispatch_key(instance);\n'
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -0500659 ' VkResult res = instance_dispatch_table(instance)->DestroyInstance(instance);\n'
Courtney Goeltzenleuchter0daf2282015-06-13 21:22:12 -0600660 ' destroy_instance_dispatch_table(key);\n'
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -0500661 ' return res;\n'
662 '}\n' % (qual, decl))
Jon Ashburn4d9f4652015-04-08 21:33:34 -0600663 else:
Courtney Goeltzenleuchter0de9e212015-06-26 15:07:53 -0600664 funcs.append('%s' % self.lineinfo.get())
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -0500665 # CreateInstance needs to use the second parm instead of the first to set the correct dispatch table
666 dispatch_param = proto.params[0].name
667 # Must use 'instance' table for these APIs, 'device' table otherwise
668 table_type = ""
669 if proto_is_global(proto):
670 table_type = "instance"
671 else:
672 table_type = "device"
673 if 'CreateInstance' in proto.name:
674 dispatch_param = '*' + proto.params[1].name
Mike Stroyan938c2532015-04-03 13:58:35 -0600675 funcs.append('%s%s\n'
676 '{\n'
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -0500677 ' %s%s_dispatch_table(%s)->%s;\n'
Mike Stroyan938c2532015-04-03 13:58:35 -0600678 '%s'
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -0500679 '}' % (qual, decl, ret_val, table_type, dispatch_param, proto.c_call(), stmt))
Mike Stroyan938c2532015-04-03 13:58:35 -0600680 return "\n\n".join(funcs)
681
Tobin Ehlis12076fc2014-10-22 09:06:33 -0600682 def generate_body(self):
Mike Stroyan3e3a1eb2015-04-03 17:13:23 -0600683 self.layer_name = "Generic"
Ian Elliott1064fe32015-07-06 14:31:32 -0600684 extensions=[('wsi_enabled',
Jon Ashburn747f2b62015-06-18 15:02:58 -0600685 ['vkCreateSwapChainWSI', 'vkDestroySwapChainWSI',
Ian Elliott2b6b68a2015-08-07 14:11:14 -0600686 'vkGetSwapChainImagesWSI', 'vkQueuePresentWSI'])]
Mike Stroyan3e3a1eb2015-04-03 17:13:23 -0600687 body = [self._generate_layer_initialization(True),
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600688 self._generate_dispatch_entrypoints("VK_LAYER_EXPORT"),
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600689 self._gen_create_msg_callback(),
690 self._gen_destroy_msg_callback(),
Jon Ashburn747f2b62015-06-18 15:02:58 -0600691 self._generate_layer_gpa_function(extensions)]
Tobin Ehlis12076fc2014-10-22 09:06:33 -0600692
693 return "\n\n".join(body)
694
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600695class APIDumpSubcommand(Subcommand):
Tobin Ehlis12076fc2014-10-22 09:06:33 -0600696 def generate_header(self):
Tobin Ehlisd009bae2014-11-24 15:46:55 -0700697 header_txt = []
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600698 header_txt.append('%s' % self.lineinfo.get())
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600699 header_txt.append('#include <fstream>')
700 header_txt.append('#include <iostream>')
701 header_txt.append('#include <string>')
Jon Ashburn747f2b62015-06-18 15:02:58 -0600702 header_txt.append('#include <string.h>')
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600703 header_txt.append('')
Tobin Ehlis80d048e2015-08-28 09:57:53 -0600704 header_txt.append('#include "vk_loader_platform.h"')
705 header_txt.append('#include "vk_layer.h"')
706 header_txt.append('#include "vk_struct_string_helper_cpp.h"')
707 header_txt.append('#include "vk_layer_table.h"')
708 header_txt.append('#include "vk_layer_extension_utils.h"')
709 header_txt.append('#include <unordered_map>')
710 header_txt.append('')
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600711 header_txt.append('static std::ofstream fileStream;')
712 header_txt.append('static std::string fileName = "vk_apidump.txt";')
713 header_txt.append('std::ostream* outputStream = NULL;')
714 header_txt.append('void ConfigureOutputStream(bool writeToFile, bool flushAfterWrite)')
715 header_txt.append('{')
716 header_txt.append(' if(writeToFile)')
717 header_txt.append(' {')
718 header_txt.append(' fileStream.open(fileName);')
Tobin Ehlis80d048e2015-08-28 09:57:53 -0600719 header_txt.append(' if ((fileStream.rdstate() & fileStream.failbit) != 0) {')
720 header_txt.append(' outputStream = &std::cout;')
721 header_txt.append(' (*outputStream) << endl << "APIDump ERROR: Bad output filename specified: " << fileName << ". Writing to STDOUT instead" << endl << endl;')
722 header_txt.append(' }')
723 header_txt.append(' else')
724 header_txt.append(' outputStream = &fileStream;')
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600725 header_txt.append(' }')
726 header_txt.append(' else')
727 header_txt.append(' {')
728 header_txt.append(' outputStream = &std::cout;')
729 header_txt.append(' }')
730 header_txt.append('')
731 header_txt.append(' if(flushAfterWrite)')
732 header_txt.append(' {')
733 header_txt.append(' outputStream->sync_with_stdio(true);')
734 header_txt.append(' }')
735 header_txt.append(' else')
736 header_txt.append(' {')
737 header_txt.append(' outputStream->sync_with_stdio(false);')
738 header_txt.append(' }')
739 header_txt.append('}')
740 header_txt.append('')
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600741 header_txt.append('%s' % self.lineinfo.get())
Ian Elliott655cad72015-02-12 17:08:34 -0700742 header_txt.append('// The following is #included again to catch certain OS-specific functions being used:')
Tobin Ehlisb835d1b2015-07-03 10:34:49 -0600743 header_txt.append('#include "vk_loader_platform.h"')
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600744 header_txt.append('')
Jon Ashburnbacb0f52015-04-06 10:58:22 -0600745 header_txt.append('static VkBaseLayerObject *pCurObj;')
Tobin Ehlisa2b199c2015-04-27 17:30:04 -0600746 header_txt.append('static bool g_APIDumpDetailed = true;')
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600747 header_txt.append('')
Jon Ashburn8c5cbcf2015-05-07 10:27:37 -0600748 header_txt.append('static LOADER_PLATFORM_THREAD_ONCE_DECLARATION(initOnce);')
Mark Lobodzinski4c7ac0a2015-05-26 09:29:09 -0500749 header_txt.append('')
Ian Elliott2d4ab1e2015-01-13 17:52:38 -0700750 header_txt.append('static int printLockInitialized = 0;')
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600751 header_txt.append('static loader_platform_thread_mutex printLock;')
752 header_txt.append('')
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600753 header_txt.append('%s' % self.lineinfo.get())
Tobin Ehlisa30e7e52015-07-06 14:02:36 -0600754 header_txt.append('#define LAYER_EXT_ARRAY_SIZE 1')
755 header_txt.append('#define LAYER_DEV_EXT_ARRAY_SIZE 1')
Tobin Ehlisd009bae2014-11-24 15:46:55 -0700756 header_txt.append('#define MAX_TID 513')
Ian Elliott2d4ab1e2015-01-13 17:52:38 -0700757 header_txt.append('static loader_platform_thread_id tidMapping[MAX_TID] = {0};')
Tobin Ehlisd009bae2014-11-24 15:46:55 -0700758 header_txt.append('static uint32_t maxTID = 0;')
759 header_txt.append('// Map actual TID to an index value and return that index')
760 header_txt.append('// This keeps TIDs in range from 0-MAX_TID and simplifies compares between runs')
761 header_txt.append('static uint32_t getTIDIndex() {')
Ian Elliott2d4ab1e2015-01-13 17:52:38 -0700762 header_txt.append(' loader_platform_thread_id tid = loader_platform_get_thread_id();')
Tobin Ehlisd009bae2014-11-24 15:46:55 -0700763 header_txt.append(' for (uint32_t i = 0; i < maxTID; i++) {')
764 header_txt.append(' if (tid == tidMapping[i])')
765 header_txt.append(' return i;')
766 header_txt.append(' }')
767 header_txt.append(" // Don't yet have mapping, set it and return newly set index")
Ian Elliott2d4ab1e2015-01-13 17:52:38 -0700768 header_txt.append(' uint32_t retVal = (uint32_t) maxTID;')
Tobin Ehlisd009bae2014-11-24 15:46:55 -0700769 header_txt.append(' tidMapping[maxTID++] = tid;')
770 header_txt.append(' assert(maxTID < MAX_TID);')
771 header_txt.append(' return retVal;')
772 header_txt.append('}')
Jon Ashburn747f2b62015-06-18 15:02:58 -0600773 header_txt.append('struct devExts {')
Ian Elliott1064fe32015-07-06 14:31:32 -0600774 header_txt.append(' bool wsi_enabled;')
Jon Ashburn747f2b62015-06-18 15:02:58 -0600775 header_txt.append('};')
776 header_txt.append('')
777 header_txt.append('static std::unordered_map<void *, struct devExts> deviceExtMap;')
778 header_txt.append('')
779 header_txt.append('static void createDeviceRegisterExtensions(const VkDeviceCreateInfo* pCreateInfo, VkDevice device)')
780 header_txt.append('{')
Tony Barbour3b4732f2015-07-13 13:37:24 -0600781 header_txt.append(' uint32_t i;')
Jon Ashburn747f2b62015-06-18 15:02:58 -0600782 header_txt.append(' VkLayerDispatchTable *pDisp = device_dispatch_table(device);')
Ian Elliott1064fe32015-07-06 14:31:32 -0600783 header_txt.append(' deviceExtMap[pDisp].wsi_enabled = false;')
Jon Ashburn747f2b62015-06-18 15:02:58 -0600784 header_txt.append(' for (i = 0; i < pCreateInfo->extensionCount; i++) {')
Ian Elliott1064fe32015-07-06 14:31:32 -0600785 header_txt.append(' if (strcmp(pCreateInfo->ppEnabledExtensionNames[i], VK_WSI_SWAPCHAIN_EXTENSION_NAME) == 0)')
786 header_txt.append(' deviceExtMap[pDisp].wsi_enabled = true;')
Jon Ashburn747f2b62015-06-18 15:02:58 -0600787 header_txt.append('')
788 header_txt.append(' }')
789 header_txt.append('}')
Mark Lobodzinski4c7ac0a2015-05-26 09:29:09 -0500790 header_txt.append('')
Mark Lobodzinskib9143d82015-07-30 10:11:32 -0600791 header_txt.append('void interpret_memBarriers(const void* const* ppMemBarriers, uint32_t memBarrierCount)')
792 header_txt.append('{')
793 header_txt.append(' if (ppMemBarriers) {')
794 header_txt.append(' string tmp_str;')
Mark Lobodzinski29bfb202015-07-31 13:47:42 -0600795 header_txt.append(' for (uint32_t i = 0; i < memBarrierCount; i++) {')
796 header_txt.append(' switch(*(VkStructureType*)ppMemBarriers[i])')
Mark Lobodzinskib9143d82015-07-30 10:11:32 -0600797 header_txt.append(' {')
798 header_txt.append(' case VK_STRUCTURE_TYPE_MEMORY_BARRIER:')
Mark Lobodzinski29bfb202015-07-31 13:47:42 -0600799 header_txt.append(' tmp_str = vk_print_vkmemorybarrier((VkMemoryBarrier*)ppMemBarriers[i], " ");')
Mark Lobodzinskib9143d82015-07-30 10:11:32 -0600800 header_txt.append(' break;')
801 header_txt.append(' case VK_STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER:')
Mark Lobodzinski29bfb202015-07-31 13:47:42 -0600802 header_txt.append(' tmp_str = vk_print_vkbuffermemorybarrier((VkBufferMemoryBarrier*)ppMemBarriers[i], " ");')
Mark Lobodzinskib9143d82015-07-30 10:11:32 -0600803 header_txt.append(' break;')
804 header_txt.append(' case VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER:')
Mark Lobodzinski29bfb202015-07-31 13:47:42 -0600805 header_txt.append(' tmp_str = vk_print_vkimagememorybarrier((VkImageMemoryBarrier*)ppMemBarriers[i], " ");')
Mark Lobodzinskib9143d82015-07-30 10:11:32 -0600806 header_txt.append(' break;')
807 header_txt.append(' default:')
808 header_txt.append(' break;')
809 header_txt.append(' }')
810 header_txt.append('')
811 header_txt.append(' if (StreamControl::writeAddress == true) {')
812 header_txt.append(' (*outputStream) << " ppMemBarriers[" << i << "] (" << &ppMemBarriers[i] << ")" << endl << tmp_str << endl;')
813 header_txt.append(' } else {')
814 header_txt.append(' (*outputStream) << " ppMemBarriers[" << i << "] (address)" << endl << " address" << endl;')
815 header_txt.append(' }')
816 header_txt.append(' }')
817 header_txt.append(' }')
818 header_txt.append('}')
819 header_txt.append('')
Tobin Ehlisd009bae2014-11-24 15:46:55 -0700820 return "\n".join(header_txt)
Tobin Ehlis12076fc2014-10-22 09:06:33 -0600821
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600822 def generate_init(self):
823 func_body = []
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600824 func_body.append('%s' % self.lineinfo.get())
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600825 func_body.append('#include "vk_dispatch_table_helper.h"')
Tobin Ehlisa0cb02e2015-07-03 10:15:26 -0600826 func_body.append('#include "vk_layer_config.h"')
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600827 func_body.append('')
828 func_body.append('static void init%s(void)' % self.layer_name)
829 func_body.append('{')
830 func_body.append(' using namespace StreamControl;')
831 func_body.append('')
Tobin Ehlisa8700972015-08-26 16:18:52 -0600832 func_body.append(' char const*const logName = getLayerOption("APIDumpLogFilename");')
833 func_body.append(' if(logName != NULL)')
834 func_body.append(' {')
835 func_body.append(' fileName = logName;')
836 func_body.append(' }')
837 func_body.append('')
Tobin Ehlisa2b199c2015-04-27 17:30:04 -0600838 func_body.append(' char const*const detailedStr = getLayerOption("APIDumpDetailed");')
839 func_body.append(' if(detailedStr != NULL)')
840 func_body.append(' {')
841 func_body.append(' if(strcmp(detailedStr, "TRUE") == 0)')
842 func_body.append(' {')
843 func_body.append(' g_APIDumpDetailed = true;')
844 func_body.append(' }')
845 func_body.append(' else if(strcmp(detailedStr, "FALSE") == 0)')
846 func_body.append(' {')
847 func_body.append(' g_APIDumpDetailed = false;')
848 func_body.append(' }')
849 func_body.append(' }')
850 func_body.append('')
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600851 func_body.append(' char const*const writeToFileStr = getLayerOption("APIDumpFile");')
852 func_body.append(' bool writeToFile = false;')
853 func_body.append(' if(writeToFileStr != NULL)')
854 func_body.append(' {')
855 func_body.append(' if(strcmp(writeToFileStr, "TRUE") == 0)')
856 func_body.append(' {')
857 func_body.append(' writeToFile = true;')
858 func_body.append(' }')
859 func_body.append(' else if(strcmp(writeToFileStr, "FALSE") == 0)')
860 func_body.append(' {')
861 func_body.append(' writeToFile = false;')
862 func_body.append(' }')
863 func_body.append(' }')
864 func_body.append('')
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600865 func_body.append('%s' % self.lineinfo.get())
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600866 func_body.append(' char const*const noAddrStr = getLayerOption("APIDumpNoAddr");')
867 func_body.append(' if(noAddrStr != NULL)')
868 func_body.append(' {')
869 func_body.append(' if(strcmp(noAddrStr, "FALSE") == 0)')
870 func_body.append(' {')
871 func_body.append(' StreamControl::writeAddress = true;')
872 func_body.append(' }')
873 func_body.append(' else if(strcmp(noAddrStr, "TRUE") == 0)')
874 func_body.append(' {')
875 func_body.append(' StreamControl::writeAddress = false;')
876 func_body.append(' }')
877 func_body.append(' }')
878 func_body.append('')
879 func_body.append(' char const*const flushAfterWriteStr = getLayerOption("APIDumpFlush");')
880 func_body.append(' bool flushAfterWrite = false;')
881 func_body.append(' if(flushAfterWriteStr != NULL)')
882 func_body.append(' {')
883 func_body.append(' if(strcmp(flushAfterWriteStr, "TRUE") == 0)')
884 func_body.append(' {')
885 func_body.append(' flushAfterWrite = true;')
886 func_body.append(' }')
887 func_body.append(' else if(strcmp(flushAfterWriteStr, "FALSE") == 0)')
888 func_body.append(' {')
889 func_body.append(' flushAfterWrite = false;')
890 func_body.append(' }')
891 func_body.append(' }')
892 func_body.append('')
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600893 func_body.append('%s' % self.lineinfo.get())
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600894 func_body.append(' ConfigureOutputStream(writeToFile, flushAfterWrite);')
895 func_body.append('')
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600896 func_body.append(' if (!printLockInitialized)')
897 func_body.append(' {')
898 func_body.append(' // TODO/TBD: Need to delete this mutex sometime. How???')
899 func_body.append(' loader_platform_thread_create_mutex(&printLock);')
900 func_body.append(' printLockInitialized = 1;')
901 func_body.append(' }')
902 func_body.append('}')
903 func_body.append('')
904 return "\n".join(func_body)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700905
Mike Stroyanbf237d72015-04-03 17:45:53 -0600906 def generate_intercept(self, proto, qual):
Courtney Goeltzenleuchter110fdf92015-06-29 15:39:26 -0600907 if proto.name in [ 'GetGlobalLayerProperties','GetGlobalExtensionProperties','GetPhysicalDeviceLayerProperties','GetPhysicalDeviceExtensionProperties']:
Jon Ashburn9fd4cc42015-04-10 14:33:07 -0600908 return None
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600909 decl = proto.c_func(prefix="vk", attr="VKAPI")
Mike Stroyanbf237d72015-04-03 17:45:53 -0600910 ret_val = ''
911 stmt = ''
912 funcs = []
913 sp_param_dict = {} # Store 'index' for struct param to print, or an name of binding "Count" param for array to print
914 create_params = 0 # Num of params at end of function that are created and returned as output values
Chia-I Wuf8693382015-04-16 22:02:10 +0800915 if 'AllocDescriptorSets' in proto.name:
Cody Northrop1e4f8022015-08-03 12:47:29 -0600916 create_params = -1
Mike Stroyanbf237d72015-04-03 17:45:53 -0600917 elif 'Create' in proto.name or 'Alloc' in proto.name or 'MapMemory' in proto.name:
918 create_params = -1
919 if proto.ret != "void":
Jon Ashburnb0fbe912015-05-06 10:15:07 -0600920 ret_val = "%s result = " % proto.ret
Mike Stroyanbf237d72015-04-03 17:45:53 -0600921 stmt = " return result;\n"
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600922 f_open = 'loader_platform_thread_lock_mutex(&printLock);\n '
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600923 log_func = '%s\n' % self.lineinfo.get()
924 log_func += ' if (StreamControl::writeAddress == true) {'
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600925 log_func += '\n (*outputStream) << "t{" << getTIDIndex() << "} vk%s(' % proto.name
926 log_func_no_addr = '\n (*outputStream) << "t{" << getTIDIndex() << "} vk%s(' % proto.name
927 f_close = '\n loader_platform_thread_unlock_mutex(&printLock);'
Mike Stroyanbf237d72015-04-03 17:45:53 -0600928 pindex = 0
929 prev_count_name = ''
930 for p in proto.params:
931 cp = False
932 if 0 != create_params:
933 # If this is any of the N last params of the func, treat as output
934 for y in range(-1, create_params-1, -1):
935 if p.name == proto.params[y].name:
936 cp = True
937 (pft, pfi) = self._get_printf_params(p.ty, p.name, cp, cpp=True)
Ian Elliott1064fe32015-07-06 14:31:32 -0600938 if p.name == "pSwapChain":
939 log_func += '%s = " << %s->handle << ", ' % (p.name, p.name)
940 elif p.name == "swapChain":
941 log_func += '%s = " << %s.handle << ", ' % (p.name, p.name)
942 else:
943 log_func += '%s = " << %s << ", ' % (p.name, pfi)
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600944 if "%p" == pft:
945 log_func_no_addr += '%s = address, ' % (p.name)
946 else:
947 log_func_no_addr += '%s = " << %s << ", ' % (p.name, pfi)
Tobin Ehlis08541742015-04-16 15:56:11 -0600948 if prev_count_name != '' and (prev_count_name.replace('Count', '')[1:] in p.name):
Mike Stroyanbf237d72015-04-03 17:45:53 -0600949 sp_param_dict[pindex] = prev_count_name
Tobin Ehlis08541742015-04-16 15:56:11 -0600950 prev_count_name = ''
Chia-I Wuf8693382015-04-16 22:02:10 +0800951 elif vk_helper.is_type(p.ty.strip('*').replace('const ', ''), 'struct'):
Mike Stroyanbf237d72015-04-03 17:45:53 -0600952 sp_param_dict[pindex] = 'index'
Mike Stroyanbf237d72015-04-03 17:45:53 -0600953 if p.name.endswith('Count'):
954 if '*' in p.ty:
955 prev_count_name = "*%s" % p.name
956 else:
957 prev_count_name = p.name
Jon Ashburn9fd4cc42015-04-10 14:33:07 -0600958 pindex += 1
Mike Stroyanbf237d72015-04-03 17:45:53 -0600959 log_func = log_func.strip(', ')
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600960 log_func_no_addr = log_func_no_addr.strip(', ')
Jon Ashburnb0fbe912015-05-06 10:15:07 -0600961 if proto.ret == "VkResult":
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600962 log_func += ') = " << string_VkResult((VkResult)result) << endl'
963 log_func_no_addr += ') = " << string_VkResult((VkResult)result) << endl'
Jon Ashburnb0fbe912015-05-06 10:15:07 -0600964 elif proto.ret == "void*":
965 log_func += ') = " << result << endl'
966 log_func_no_addr += ') = " << result << endl'
Mike Stroyanbf237d72015-04-03 17:45:53 -0600967 else:
968 log_func += ')\\n"'
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600969 log_func_no_addr += ')\\n"'
Mike Stroyanbf237d72015-04-03 17:45:53 -0600970 log_func += ';'
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600971 log_func_no_addr += ';'
Tobin Ehlisa30e7e52015-07-06 14:02:36 -0600972 log_func += '\n }\n else {%s\n }' % log_func_no_addr;
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600973 log_func += '\n%s' % self.lineinfo.get()
Tobin Ehlisb870cbb2015-04-15 07:46:12 -0600974 #print("Proto %s has param_dict: %s" % (proto.name, sp_param_dict))
Mike Stroyanbf237d72015-04-03 17:45:53 -0600975 if len(sp_param_dict) > 0:
Tobin Ehlisa2b199c2015-04-27 17:30:04 -0600976 indent = ' '
977 log_func += '\n%sif (g_APIDumpDetailed) {' % indent
978 indent += ' '
Mike Stroyanbf237d72015-04-03 17:45:53 -0600979 i_decl = False
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600980 log_func += '\n%s' % self.lineinfo.get()
Tobin Ehlisa2b199c2015-04-27 17:30:04 -0600981 log_func += '\n%sstring tmp_str;' % indent
Mike Stroyanbf237d72015-04-03 17:45:53 -0600982 for sp_index in sp_param_dict:
Tobin Ehlisb870cbb2015-04-15 07:46:12 -0600983 #print("sp_index: %s" % str(sp_index))
Mike Stroyanbf237d72015-04-03 17:45:53 -0600984 if 'index' == sp_param_dict[sp_index]:
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600985 cis_print_func = 'vk_print_%s' % (proto.params[sp_index].ty.replace('const ', '').strip('*').lower())
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600986 local_name = proto.params[sp_index].name
987 if '*' not in proto.params[sp_index].ty:
988 local_name = '&%s' % proto.params[sp_index].name
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600989 log_func += '\n%s' % self.lineinfo.get()
Tobin Ehlisa2b199c2015-04-27 17:30:04 -0600990 log_func += '\n%sif (%s) {' % (indent, local_name)
991 indent += ' '
992 log_func += '\n%stmp_str = %s(%s, " ");' % (indent, cis_print_func, local_name)
993 log_func += '\n%s(*outputStream) << " %s (" << %s << ")" << endl << tmp_str << endl;' % (indent, local_name, local_name)
994 indent = indent[4:]
995 log_func += '\n%s}' % (indent)
Mark Lobodzinskib9143d82015-07-30 10:11:32 -0600996 elif 'memBarrierCount' == sp_param_dict[sp_index]: # call helper function
997 log_func += '\n%sif (ppMemBarriers) {' % (indent)
998 log_func += '\n%s interpret_memBarriers(ppMemBarriers, memBarrierCount);' % (indent)
999 log_func += '\n%s}' % (indent)
Mike Stroyanbf237d72015-04-03 17:45:53 -06001000 else: # We have a count value stored to iterate over an array
1001 print_cast = ''
1002 print_func = ''
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -06001003 if vk_helper.is_type(proto.params[sp_index].ty.strip('*').replace('const ', ''), 'struct'):
Mike Stroyanbf237d72015-04-03 17:45:53 -06001004 print_cast = '&'
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -06001005 print_func = 'vk_print_%s' % proto.params[sp_index].ty.replace('const ', '').strip('*').lower()
Mike Stroyanbf237d72015-04-03 17:45:53 -06001006 else:
Tobin Ehlise78dbd82015-04-09 09:19:36 -06001007 print_cast = ''
Mike Stroyanbf237d72015-04-03 17:45:53 -06001008 print_func = 'string_convert_helper'
1009 #cis_print_func = 'tmp_str = string_convert_helper((void*)%s[i], " ");' % proto.params[sp_index].name
Tobin Ehlisa30e7e52015-07-06 14:02:36 -06001010 if proto.params[sp_index].ty.strip('*').replace('const ', '') in vulkan.object_non_dispatch_list:
1011 cis_print_func = 'tmp_str = %s(%s%s[i].handle, " ");' % (print_func, print_cast, proto.params[sp_index].name)
1012 else:
1013 cis_print_func = 'tmp_str = %s(%s%s[i], " ");' % (print_func, print_cast, proto.params[sp_index].name)
Mike Stroyanbf237d72015-04-03 17:45:53 -06001014 if not i_decl:
Tobin Ehlisa2b199c2015-04-27 17:30:04 -06001015 log_func += '\n%suint32_t i;' % (indent)
Mike Stroyanbf237d72015-04-03 17:45:53 -06001016 i_decl = True
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -06001017 log_func += '\n%sif (%s) {' % (indent, proto.params[sp_index].name)
1018 indent += ' '
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001019 log_func += '\n%s' % self.lineinfo.get()
Tobin Ehlisa2b199c2015-04-27 17:30:04 -06001020 log_func += '\n%sfor (i = 0; i < %s; i++) {' % (indent, sp_param_dict[sp_index])
1021 indent += ' '
1022 log_func += '\n%s%s' % (indent, cis_print_func)
Tobin Ehlis45a23a82015-04-28 10:58:20 -06001023 log_func += '\n%sif (StreamControl::writeAddress == true) {' % (indent)
1024 indent += ' '
Tobin Ehlisa2b199c2015-04-27 17:30:04 -06001025 log_func += '\n%s(*outputStream) << " %s[" << i << "] (" << %s%s[i] << ")" << endl << tmp_str << endl;' % (indent, proto.params[sp_index].name, '&', proto.params[sp_index].name)
1026 indent = indent[4:]
Tobin Ehlis45a23a82015-04-28 10:58:20 -06001027 log_func += '\n%s} else {' % (indent)
1028 indent += ' '
1029 log_func += '\n%s(*outputStream) << " %s[" << i << "] (address)" << endl << " address" << endl;' % (indent, proto.params[sp_index].name)
1030 indent = indent[4:]
1031 log_func += '\n%s}' % (indent)
1032 indent = indent[4:]
Tobin Ehlisa2b199c2015-04-27 17:30:04 -06001033 log_func += '\n%s}' % (indent)
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -06001034 indent = indent[4:]
1035 log_func += '\n%s}' % (indent)
Tobin Ehlisa2b199c2015-04-27 17:30:04 -06001036 indent = indent[4:]
1037 log_func += '\n%s}' % (indent)
Mark Lobodzinski4c7ac0a2015-05-26 09:29:09 -05001038 table_type = ''
Jon Ashburn95a77ba2015-05-15 15:09:35 -06001039 if proto_is_global(proto):
Mark Lobodzinski4c7ac0a2015-05-26 09:29:09 -05001040 table_type = 'instance'
1041 else:
1042 table_type = 'device'
Jon Ashburn71836d92015-05-12 17:23:55 -06001043
Mark Lobodzinski4c7ac0a2015-05-26 09:29:09 -05001044 if proto.name == "CreateInstance":
1045 dispatch_param = '*' + proto.params[1].name
1046 else:
1047 dispatch_param = proto.params[0].name
1048
Jon Ashburn747f2b62015-06-18 15:02:58 -06001049 if proto.name == "CreateDevice":
Courtney Goeltzenleuchter0de9e212015-06-26 15:07:53 -06001050 funcs.append('%s\n' % self.lineinfo.get())
Jon Ashburn747f2b62015-06-18 15:02:58 -06001051 funcs.append('%s%s\n'
1052 '{\n'
1053 ' using namespace StreamControl;\n'
Courtney Goeltzenleuchterca173b82015-06-25 18:01:43 -06001054 ' %sdevice_dispatch_table(*pDevice)->%s;\n'
Jon Ashburn747f2b62015-06-18 15:02:58 -06001055 ' if (result == VK_SUCCESS)\n'
1056 ' createDeviceRegisterExtensions(pCreateInfo, *pDevice);\n'
1057 ' %s%s%s\n'
1058 '%s'
Courtney Goeltzenleuchterca173b82015-06-25 18:01:43 -06001059 '}' % (qual, decl, ret_val, proto.c_call(), f_open, log_func, f_close, stmt))
Jon Ashburn747f2b62015-06-18 15:02:58 -06001060 elif proto.name == "DestroyDevice":
Mark Lobodzinski4c7ac0a2015-05-26 09:29:09 -05001061 funcs.append('%s%s\n'
1062 '{\n'
1063 ' using namespace StreamControl;\n'
Courtney Goeltzenleuchter0daf2282015-06-13 21:22:12 -06001064 ' dispatch_key key = get_dispatch_key(device);\n'
Jon Ashburn747f2b62015-06-18 15:02:58 -06001065 ' VkLayerDispatchTable *pDisp = %s_dispatch_table(%s);\n'
1066 ' %spDisp->%s;\n'
1067 ' deviceExtMap.erase(pDisp);\n'
Courtney Goeltzenleuchter0daf2282015-06-13 21:22:12 -06001068 ' destroy_device_dispatch_table(key);\n'
Mark Lobodzinski4c7ac0a2015-05-26 09:29:09 -05001069 ' %s%s%s\n'
1070 '%s'
Jon Ashburn747f2b62015-06-18 15:02:58 -06001071 '}' % (qual, decl, table_type, dispatch_param, ret_val, proto.c_call(), f_open, log_func, f_close, stmt))
Mark Lobodzinski4c7ac0a2015-05-26 09:29:09 -05001072 elif proto.name == "DestroyInstance":
1073 funcs.append('%s%s\n'
1074 '{\n'
1075 ' using namespace StreamControl;\n'
Courtney Goeltzenleuchter0daf2282015-06-13 21:22:12 -06001076 ' dispatch_key key = get_dispatch_key(instance);\n'
Mark Lobodzinski4c7ac0a2015-05-26 09:29:09 -05001077 ' %s%s_dispatch_table(%s)->%s;\n'
Courtney Goeltzenleuchter0daf2282015-06-13 21:22:12 -06001078 ' destroy_instance_dispatch_table(key);\n'
Mark Lobodzinski4c7ac0a2015-05-26 09:29:09 -05001079 ' %s%s%s\n'
1080 '%s'
1081 '}' % (qual, decl, ret_val, table_type, dispatch_param, proto.c_call(), f_open, log_func, f_close, stmt))
1082 else:
1083 funcs.append('%s%s\n'
1084 '{\n'
1085 ' using namespace StreamControl;\n'
1086 ' %s%s_dispatch_table(%s)->%s;\n'
Jon Ashburnbacb0f52015-04-06 10:58:22 -06001087 ' %s%s%s\n'
1088 '%s'
Mark Lobodzinski4c7ac0a2015-05-26 09:29:09 -05001089 '}' % (qual, decl, ret_val, table_type, dispatch_param, proto.c_call(), f_open, log_func, f_close, stmt))
Mike Stroyanbf237d72015-04-03 17:45:53 -06001090 return "\n\n".join(funcs)
1091
Tobin Ehlis99f88672015-01-10 12:42:41 -07001092 def generate_body(self):
Tobin Ehlise78dbd82015-04-09 09:19:36 -06001093 self.layer_name = "APIDump"
Ian Elliott1064fe32015-07-06 14:31:32 -06001094 extensions=[('wsi_enabled',
Jon Ashburn747f2b62015-06-18 15:02:58 -06001095 ['vkCreateSwapChainWSI', 'vkDestroySwapChainWSI',
Ian Elliott2b6b68a2015-08-07 14:11:14 -06001096 'vkGetSwapChainImagesWSI', 'vkQueuePresentWSI'])]
Tobin Ehlise78dbd82015-04-09 09:19:36 -06001097 body = [self.generate_init(),
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001098 self._generate_dispatch_entrypoints("VK_LAYER_EXPORT"),
Jon Ashburn747f2b62015-06-18 15:02:58 -06001099 self._generate_layer_gpa_function(extensions)]
Tobin Ehlis99f88672015-01-10 12:42:41 -07001100 return "\n\n".join(body)
1101
Tobin Ehlis12076fc2014-10-22 09:06:33 -06001102class ObjectTrackerSubcommand(Subcommand):
1103 def generate_header(self):
1104 header_txt = []
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001105 header_txt.append('%s' % self.lineinfo.get())
Mark Lobodzinskifae78852015-06-23 11:35:12 -06001106 header_txt.append('#include <stdio.h>')
1107 header_txt.append('#include <stdlib.h>')
1108 header_txt.append('#include <string.h>')
1109 header_txt.append('#include <inttypes.h>')
1110 header_txt.append('')
1111 header_txt.append('#include "vulkan.h"')
Tobin Ehlisb835d1b2015-07-03 10:34:49 -06001112 header_txt.append('#include "vk_loader_platform.h"')
Mark Lobodzinskifae78852015-06-23 11:35:12 -06001113 header_txt.append('')
Tobin Ehlis803cc492015-06-08 17:36:28 -06001114 header_txt.append('#include <unordered_map>')
1115 header_txt.append('using namespace std;')
Ian Elliott655cad72015-02-12 17:08:34 -07001116 header_txt.append('// The following is #included again to catch certain OS-specific functions being used:')
Tobin Ehlisb835d1b2015-07-03 10:34:49 -06001117 header_txt.append('#include "vk_loader_platform.h"')
Tobin Ehlisa0cb02e2015-07-03 10:15:26 -06001118 header_txt.append('#include "vk_layer_config.h"')
1119 header_txt.append('#include "vk_layer_msg.h"')
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -06001120 header_txt.append('#include "vk_debug_report_lunarg.h"')
Tobin Ehlisa0cb02e2015-07-03 10:15:26 -06001121 header_txt.append('#include "vk_layer_table.h"')
1122 header_txt.append('#include "vk_layer_data.h"')
1123 header_txt.append('#include "vk_layer_logging.h"')
Mark Lobodzinskifae78852015-06-23 11:35:12 -06001124 header_txt.append('')
1125# NOTE: The non-autoGenerated code is in the object_track.h header file
1126 header_txt.append('#include "object_track.h"')
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -05001127 header_txt.append('')
Jon Ashburn8c5cbcf2015-05-07 10:27:37 -06001128 header_txt.append('static LOADER_PLATFORM_THREAD_ONCE_DECLARATION(initOnce);')
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -05001129 header_txt.append('')
Tobin Ehlis12076fc2014-10-22 09:06:33 -06001130 return "\n".join(header_txt)
1131
Tony Barboura05dbaa2015-07-09 17:31:46 -06001132 def generate_maps(self):
1133 maps_txt = []
1134 for o in vulkan.core.objects:
1135 maps_txt.append('unordered_map<const void*, OBJTRACK_NODE*> %sMap;' % (o))
1136 maps_txt.append('unordered_map<const void*, OBJTRACK_NODE*> VkSwapChainWSIMap;')
1137 return "\n".join(maps_txt)
1138
1139 def generate_procs(self):
1140 procs_txt = []
1141 for o in vulkan.core.objects:
1142 procs_txt.append('%s' % self.lineinfo.get())
Tobin Ehlis154e0462015-08-26 11:22:09 -06001143 if o in vulkan.object_dispatch_list:
Tony Barboura05dbaa2015-07-09 17:31:46 -06001144 procs_txt.append('static void create_obj(%s dispatchable_object, %s vkObj, VkDbgObjectType objType)' % (o, o))
1145 procs_txt.append('{')
Courtney Goeltzenleuchterdee721d2015-08-26 15:09:25 -06001146 procs_txt.append(' log_msg(mdd(dispatchable_object), VK_DBG_REPORT_INFO_BIT, objType, reinterpret_cast<uint64_t>(vkObj), 0, OBJTRACK_NONE, "OBJTRACK",')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001147 procs_txt.append(' "OBJ[%llu] : CREATE %s object 0x%" PRIxLEAST64 , object_track_index++, string_VkDbgObjectType(objType),')
Courtney Goeltzenleuchterdee721d2015-08-26 15:09:25 -06001148 procs_txt.append(' reinterpret_cast<uint64_t>(vkObj));')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001149 else:
1150 procs_txt.append('static void create_obj(VkDevice dispatchable_object, %s vkObj, VkDbgObjectType objType)' % (o))
1151 procs_txt.append('{')
1152 procs_txt.append(' log_msg(mdd(dispatchable_object), VK_DBG_REPORT_INFO_BIT, objType, vkObj.handle, 0, OBJTRACK_NONE, "OBJTRACK",')
1153 procs_txt.append(' "OBJ[%llu] : CREATE %s object 0x%" PRIxLEAST64 , object_track_index++, string_VkDbgObjectType(objType),')
Tony Barbour343d6212015-07-10 18:32:33 -06001154 procs_txt.append(' vkObj.handle);')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001155 procs_txt.append('')
1156 procs_txt.append(' OBJTRACK_NODE* pNewObjNode = new OBJTRACK_NODE;')
1157 procs_txt.append(' pNewObjNode->objType = objType;')
1158 procs_txt.append(' pNewObjNode->status = OBJSTATUS_NONE;')
Tobin Ehlis154e0462015-08-26 11:22:09 -06001159 if o in vulkan.object_dispatch_list:
Courtney Goeltzenleuchterdee721d2015-08-26 15:09:25 -06001160 procs_txt.append(' pNewObjNode->vkObj = reinterpret_cast<uint64_t>(vkObj);')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001161 procs_txt.append(' %sMap[vkObj] = pNewObjNode;' % (o))
1162 else:
Tony Barbour343d6212015-07-10 18:32:33 -06001163 procs_txt.append(' pNewObjNode->vkObj = vkObj.handle;')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001164 procs_txt.append(' %sMap[(void*)vkObj.handle] = pNewObjNode;' % (o))
1165 procs_txt.append(' uint32_t objIndex = objTypeToIndex(objType);')
1166 procs_txt.append(' numObjs[objIndex]++;')
1167 procs_txt.append(' numTotalObjs++;')
1168 procs_txt.append('}')
1169 procs_txt.append('')
1170 procs_txt.append('%s' % self.lineinfo.get())
Tobin Ehlis154e0462015-08-26 11:22:09 -06001171 if o in vulkan.object_dispatch_list:
Tony Barboura05dbaa2015-07-09 17:31:46 -06001172 procs_txt.append('static void validate_object(%s dispatchable_object, %s object)' % (o, o))
1173 else:
1174 procs_txt.append('static void validate_object(VkDevice dispatchable_object, %s object)' % (o))
1175 procs_txt.append('{')
Tobin Ehlis154e0462015-08-26 11:22:09 -06001176 if o in vulkan.object_dispatch_list:
Tony Barboura05dbaa2015-07-09 17:31:46 -06001177 procs_txt.append(' if (%sMap.find(object) == %sMap.end()) {' % (o, o))
Courtney Goeltzenleuchterdee721d2015-08-26 15:09:25 -06001178 procs_txt.append(' log_msg(mdd(dispatchable_object), VK_DBG_REPORT_ERROR_BIT, (VkDbgObjectType) 0, reinterpret_cast<uint64_t>(object), 0, OBJTRACK_INVALID_OBJECT, "OBJTRACK",')
1179 procs_txt.append(' "Invalid %s Object %%p",reinterpret_cast<uint64_t>(object));' % o)
Tony Barboura05dbaa2015-07-09 17:31:46 -06001180 else:
1181 procs_txt.append(' if (%sMap.find((void*)object.handle) == %sMap.end()) {' % (o, o))
1182 procs_txt.append(' log_msg(mdd(dispatchable_object), VK_DBG_REPORT_ERROR_BIT, (VkDbgObjectType) 0, object.handle, 0, OBJTRACK_INVALID_OBJECT, "OBJTRACK",')
Tony Barbour343d6212015-07-10 18:32:33 -06001183 procs_txt.append(' "Invalid %s Object %%p", object.handle);' % o)
Tony Barboura05dbaa2015-07-09 17:31:46 -06001184 procs_txt.append(' }')
1185 procs_txt.append('}')
1186 procs_txt.append('')
1187 procs_txt.append('')
1188 procs_txt.append('%s' % self.lineinfo.get())
Tobin Ehlis154e0462015-08-26 11:22:09 -06001189 if o in vulkan.object_dispatch_list:
Tony Barboura05dbaa2015-07-09 17:31:46 -06001190 procs_txt.append('static void destroy_obj(%s dispatchable_object, %s object)' % (o, o))
1191 else:
1192 procs_txt.append('static void destroy_obj(VkDevice dispatchable_object, %s object)' % (o))
1193 procs_txt.append('{')
Tobin Ehlis154e0462015-08-26 11:22:09 -06001194 if o in vulkan.object_dispatch_list:
Tony Barboura05dbaa2015-07-09 17:31:46 -06001195 procs_txt.append(' if (%sMap.find(object) != %sMap.end()) {' % (o, o))
1196 procs_txt.append(' OBJTRACK_NODE* pNode = %sMap[object];' % (o))
1197 else:
1198 procs_txt.append(' if (%sMap.find((void*)object.handle) != %sMap.end()) {' % (o, o))
1199 procs_txt.append(' OBJTRACK_NODE* pNode = %sMap[(void*)object.handle];' % (o))
1200 procs_txt.append(' uint32_t objIndex = objTypeToIndex(pNode->objType);')
1201 procs_txt.append(' assert(numTotalObjs > 0);')
1202 procs_txt.append(' numTotalObjs--;')
1203 procs_txt.append(' assert(numObjs[objIndex] > 0);')
1204 procs_txt.append(' numObjs[objIndex]--;')
Tobin Ehlis154e0462015-08-26 11:22:09 -06001205 if o in vulkan.object_dispatch_list:
Courtney Goeltzenleuchterdee721d2015-08-26 15:09:25 -06001206 procs_txt.append(' log_msg(mdd(dispatchable_object), VK_DBG_REPORT_INFO_BIT, pNode->objType, reinterpret_cast<uint64_t>(object), 0, OBJTRACK_NONE, "OBJTRACK",')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001207 procs_txt.append(' "OBJ_STAT Destroy %s obj 0x%" PRIxLEAST64 " (%lu total objs remain & %lu %s objs).",')
Courtney Goeltzenleuchterdee721d2015-08-26 15:09:25 -06001208 procs_txt.append(' string_VkDbgObjectType(pNode->objType), reinterpret_cast<uint64_t>(object), numTotalObjs, numObjs[objIndex],')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001209 else:
1210 procs_txt.append(' log_msg(mdd(dispatchable_object), VK_DBG_REPORT_INFO_BIT, pNode->objType, object.handle, 0, OBJTRACK_NONE, "OBJTRACK",')
1211 procs_txt.append(' "OBJ_STAT Destroy %s obj 0x%" PRIxLEAST64 " (%lu total objs remain & %lu %s objs).",')
Tony Barbour343d6212015-07-10 18:32:33 -06001212 procs_txt.append(' string_VkDbgObjectType(pNode->objType), object.handle, numTotalObjs, numObjs[objIndex],')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001213 procs_txt.append(' string_VkDbgObjectType(pNode->objType));')
1214 procs_txt.append(' delete pNode;')
Tobin Ehlis154e0462015-08-26 11:22:09 -06001215 if o in vulkan.object_dispatch_list:
Tony Barboura05dbaa2015-07-09 17:31:46 -06001216 procs_txt.append(' %sMap.erase(object);' % (o))
1217 procs_txt.append(' } else {')
Courtney Goeltzenleuchterdee721d2015-08-26 15:09:25 -06001218 procs_txt.append(' log_msg(mdd(dispatchable_object), VK_DBG_REPORT_ERROR_BIT, (VkDbgObjectType) 0, reinterpret_cast<uint64_t>(object), 0, OBJTRACK_NONE, "OBJTRACK",')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001219 procs_txt.append(' "Unable to remove obj 0x%" PRIxLEAST64 ". Was it created? Has it already been destroyed?",')
Courtney Goeltzenleuchterdee721d2015-08-26 15:09:25 -06001220 procs_txt.append(' reinterpret_cast<uint64_t>(object));')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001221 procs_txt.append(' }')
1222 else:
1223 procs_txt.append(' %sMap.erase((void*)object.handle);' % (o))
1224 procs_txt.append(' } else {')
1225 procs_txt.append(' log_msg(mdd(dispatchable_object), VK_DBG_REPORT_ERROR_BIT, (VkDbgObjectType) 0, object.handle, 0, OBJTRACK_NONE, "OBJTRACK",')
1226 procs_txt.append(' "Unable to remove obj 0x%" PRIxLEAST64 ". Was it created? Has it already been destroyed?",')
Tony Barbour343d6212015-07-10 18:32:33 -06001227 procs_txt.append(' object.handle);')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001228 procs_txt.append(' }')
1229 procs_txt.append('}')
1230 procs_txt.append('')
1231 procs_txt.append('%s' % self.lineinfo.get())
Tobin Ehlis154e0462015-08-26 11:22:09 -06001232 if o in vulkan.object_dispatch_list:
Tony Barboura05dbaa2015-07-09 17:31:46 -06001233 procs_txt.append('static void set_status(%s dispatchable_object, %s object, VkDbgObjectType objType, ObjectStatusFlags status_flag)' % (o, o))
1234 procs_txt.append('{')
1235 procs_txt.append(' if (object != VK_NULL_HANDLE) {')
1236 procs_txt.append(' if (%sMap.find(object) != %sMap.end()) {' % (o, o))
1237 procs_txt.append(' OBJTRACK_NODE* pNode = %sMap[object];' % (o))
1238 else:
1239 procs_txt.append('static void set_status(VkDevice dispatchable_object, %s object, VkDbgObjectType objType, ObjectStatusFlags status_flag)' % (o))
1240 procs_txt.append('{')
Dana Jansens10dddd72015-07-30 13:21:41 -07001241 procs_txt.append(' if (object != VK_NULL_HANDLE) {')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001242 procs_txt.append(' if (%sMap.find((void*)object.handle) != %sMap.end()) {' % (o, o))
1243 procs_txt.append(' OBJTRACK_NODE* pNode = %sMap[(void*)object.handle];' % (o))
Tobin Ehlis154e0462015-08-26 11:22:09 -06001244 procs_txt.append(' pNode->status |= status_flag;')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001245 procs_txt.append(' return;')
1246 procs_txt.append(' }')
1247 procs_txt.append(' else {')
1248 procs_txt.append(' // If we do not find it print an error')
Tobin Ehlis154e0462015-08-26 11:22:09 -06001249 if o in vulkan.object_dispatch_list:
Courtney Goeltzenleuchterdee721d2015-08-26 15:09:25 -06001250 procs_txt.append(' log_msg(mdd(dispatchable_object), VK_DBG_REPORT_ERROR_BIT, (VkDbgObjectType) 0, reinterpret_cast<uint64_t>(object), 0, OBJTRACK_NONE, "OBJTRACK",')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001251 procs_txt.append(' "Unable to set status for non-existent object 0x%" PRIxLEAST64 " of %s type",')
Courtney Goeltzenleuchterdee721d2015-08-26 15:09:25 -06001252 procs_txt.append(' reinterpret_cast<uint64_t>(object), string_VkDbgObjectType(objType));')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001253 else:
1254 procs_txt.append(' log_msg(mdd(dispatchable_object), VK_DBG_REPORT_ERROR_BIT, (VkDbgObjectType) 0, object.handle, 0, OBJTRACK_NONE, "OBJTRACK",')
1255 procs_txt.append(' "Unable to set status for non-existent object 0x%" PRIxLEAST64 " of %s type",')
Tony Barbour343d6212015-07-10 18:32:33 -06001256 procs_txt.append(' object.handle, string_VkDbgObjectType(objType));')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001257 procs_txt.append(' }')
1258 procs_txt.append(' }')
1259 procs_txt.append('}')
1260 procs_txt.append('')
1261 procs_txt.append('%s' % self.lineinfo.get())
1262 procs_txt.append('static VkBool32 validate_status(')
Tobin Ehlis154e0462015-08-26 11:22:09 -06001263 if o in vulkan.object_dispatch_list:
Tony Barboura05dbaa2015-07-09 17:31:46 -06001264 procs_txt.append('%s dispatchable_object, %s object,' % (o, o))
1265 else:
1266 procs_txt.append('VkDevice dispatchable_object, %s object,' % (o))
1267 procs_txt.append(' VkDbgObjectType objType,')
1268 procs_txt.append(' ObjectStatusFlags status_mask,')
1269 procs_txt.append(' ObjectStatusFlags status_flag,')
1270 procs_txt.append(' VkFlags msg_flags,')
1271 procs_txt.append(' OBJECT_TRACK_ERROR error_code,')
1272 procs_txt.append(' const char *fail_msg)')
1273 procs_txt.append('{')
Tobin Ehlis154e0462015-08-26 11:22:09 -06001274 if o in vulkan.object_dispatch_list:
Tony Barboura05dbaa2015-07-09 17:31:46 -06001275 procs_txt.append(' if (%sMap.find(object) != %sMap.end()) {' % (o, o))
1276 procs_txt.append(' OBJTRACK_NODE* pNode = %sMap[object];' % (o))
1277 else:
1278 procs_txt.append(' if (%sMap.find((void*)object.handle) != %sMap.end()) {' % (o, o))
1279 procs_txt.append(' OBJTRACK_NODE* pNode = %sMap[(void*)object.handle];' % (o))
1280 procs_txt.append(' if ((pNode->status & status_mask) != status_flag) {')
Tobin Ehlis154e0462015-08-26 11:22:09 -06001281 if o in vulkan.object_dispatch_list:
Courtney Goeltzenleuchterdee721d2015-08-26 15:09:25 -06001282 procs_txt.append(' log_msg(mdd(dispatchable_object), msg_flags, pNode->objType, reinterpret_cast<uint64_t>(object), 0, OBJTRACK_UNKNOWN_OBJECT, "OBJTRACK",')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001283 procs_txt.append(' "OBJECT VALIDATION WARNING: %s object 0x%" PRIxLEAST64 ": %s", string_VkDbgObjectType(objType),')
Courtney Goeltzenleuchterdee721d2015-08-26 15:09:25 -06001284 procs_txt.append(' reinterpret_cast<uint64_t>(object), fail_msg);')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001285 else:
1286 procs_txt.append(' log_msg(mdd(dispatchable_object), msg_flags, pNode->objType, object.handle, 0, OBJTRACK_UNKNOWN_OBJECT, "OBJTRACK",')
1287 procs_txt.append(' "OBJECT VALIDATION WARNING: %s object 0x%" PRIxLEAST64 ": %s", string_VkDbgObjectType(objType),')
Tony Barbour343d6212015-07-10 18:32:33 -06001288 procs_txt.append(' object.handle, fail_msg);')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001289 procs_txt.append(' return VK_FALSE;')
1290 procs_txt.append(' }')
1291 procs_txt.append(' return VK_TRUE;')
1292 procs_txt.append(' }')
1293 procs_txt.append(' else {')
1294 procs_txt.append(' // If we do not find it print an error')
Tobin Ehlis154e0462015-08-26 11:22:09 -06001295 if o in vulkan.object_dispatch_list:
Courtney Goeltzenleuchterdee721d2015-08-26 15:09:25 -06001296 procs_txt.append(' log_msg(mdd(dispatchable_object), msg_flags, (VkDbgObjectType) 0, reinterpret_cast<uint64_t>(object), 0, OBJTRACK_UNKNOWN_OBJECT, "OBJTRACK",')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001297 procs_txt.append(' "Unable to obtain status for non-existent object 0x%" PRIxLEAST64 " of %s type",')
Courtney Goeltzenleuchterdee721d2015-08-26 15:09:25 -06001298 procs_txt.append(' reinterpret_cast<uint64_t>(object), string_VkDbgObjectType(objType));')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001299 else:
1300 procs_txt.append(' log_msg(mdd(dispatchable_object), msg_flags, (VkDbgObjectType) 0, object.handle, 0, OBJTRACK_UNKNOWN_OBJECT, "OBJTRACK",')
1301 procs_txt.append(' "Unable to obtain status for non-existent object 0x%" PRIxLEAST64 " of %s type",')
Tony Barbour343d6212015-07-10 18:32:33 -06001302 procs_txt.append(' object.handle, string_VkDbgObjectType(objType));')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001303 procs_txt.append(' return VK_FALSE;')
1304 procs_txt.append(' }')
1305 procs_txt.append('}')
1306 procs_txt.append('')
1307 procs_txt.append('%s' % self.lineinfo.get())
Tobin Ehlis154e0462015-08-26 11:22:09 -06001308 if o in vulkan.object_dispatch_list:
Tony Barboura05dbaa2015-07-09 17:31:46 -06001309 procs_txt.append('static void reset_status(%s dispatchable_object, %s object, VkDbgObjectType objType, ObjectStatusFlags status_flag)' % (o, o))
1310 procs_txt.append('{')
1311 procs_txt.append(' if (%sMap.find(object) != %sMap.end()) {' % (o, o))
1312 procs_txt.append(' OBJTRACK_NODE* pNode = %sMap[object];' % (o))
1313 else:
1314 procs_txt.append('static void reset_status(VkDevice dispatchable_object, %s object, VkDbgObjectType objType, ObjectStatusFlags status_flag)' % (o))
1315 procs_txt.append('{')
1316 procs_txt.append(' if (%sMap.find((void*)object.handle) != %sMap.end()) {' % (o, o))
1317 procs_txt.append(' OBJTRACK_NODE* pNode = %sMap[(void*)object.handle];' % (o))
1318 procs_txt.append(' pNode->status &= ~status_flag;')
1319 procs_txt.append(' return;')
1320 procs_txt.append(' }')
1321 procs_txt.append(' else {')
1322 procs_txt.append(' // If we do not find it print an error')
Tobin Ehlis154e0462015-08-26 11:22:09 -06001323 if o in vulkan.object_dispatch_list:
Courtney Goeltzenleuchterdee721d2015-08-26 15:09:25 -06001324 procs_txt.append(' log_msg(mdd(dispatchable_object), VK_DBG_REPORT_ERROR_BIT, objType, reinterpret_cast<uint64_t>(object), 0, OBJTRACK_UNKNOWN_OBJECT, "OBJTRACK",')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001325 procs_txt.append(' "Unable to reset status for non-existent object 0x%" PRIxLEAST64 " of %s type",')
Courtney Goeltzenleuchterdee721d2015-08-26 15:09:25 -06001326 procs_txt.append(' reinterpret_cast<uint64_t>(object), string_VkDbgObjectType(objType));')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001327 else:
1328 procs_txt.append(' log_msg(mdd(dispatchable_object), VK_DBG_REPORT_ERROR_BIT, objType, object.handle, 0, OBJTRACK_UNKNOWN_OBJECT, "OBJTRACK",')
1329 procs_txt.append(' "Unable to reset status for non-existent object 0x%" PRIxLEAST64 " of %s type",')
Tony Barbour343d6212015-07-10 18:32:33 -06001330 procs_txt.append(' object.handle, string_VkDbgObjectType(objType));')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001331 procs_txt.append(' }')
1332 procs_txt.append('}')
1333 procs_txt.append('')
1334 return "\n".join(procs_txt)
1335
Mark Lobodzinski64d57752015-07-17 11:51:24 -06001336 def generate_destroy_instance(self):
Tony Barboura05dbaa2015-07-09 17:31:46 -06001337 gedi_txt = []
1338 gedi_txt.append('%s' % self.lineinfo.get())
Mark Lobodzinski64d57752015-07-17 11:51:24 -06001339 gedi_txt.append('VkResult vkDestroyInstance(')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001340 gedi_txt.append('VkInstance instance)')
1341 gedi_txt.append('{')
1342 gedi_txt.append(' loader_platform_thread_lock_mutex(&objLock);')
1343 gedi_txt.append(' validate_object(instance, instance);')
1344 gedi_txt.append('')
1345 gedi_txt.append(' destroy_obj(instance, instance);')
1346 gedi_txt.append(' // Report any remaining objects in LL')
1347 for o in vulkan.core.objects:
1348 if o in ['VkPhysicalDevice', 'VkQueue']:
1349 continue
1350 gedi_txt.append(' for (auto it = %sMap.begin(); it != %sMap.end(); ++it) {' % (o, o))
1351 gedi_txt.append(' OBJTRACK_NODE* pNode = it->second;')
1352 gedi_txt.append(' log_msg(mid(instance), VK_DBG_REPORT_ERROR_BIT, pNode->objType, pNode->vkObj, 0, OBJTRACK_OBJECT_LEAK, "OBJTRACK",')
1353 gedi_txt.append(' "OBJ ERROR : %s object 0x%" PRIxLEAST64 " has not been destroyed.", string_VkDbgObjectType(pNode->objType),')
Tony Barbour343d6212015-07-10 18:32:33 -06001354 gedi_txt.append(' pNode->vkObj);')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001355 gedi_txt.append(' }')
1356 gedi_txt.append('')
1357 gedi_txt.append(' dispatch_key key = get_dispatch_key(instance);')
1358 gedi_txt.append(' VkLayerInstanceDispatchTable *pInstanceTable = get_dispatch_table(ObjectTracker_instance_table_map, instance);')
1359 gedi_txt.append(' VkResult result = pInstanceTable->DestroyInstance(instance);')
1360 gedi_txt.append('')
1361 gedi_txt.append(' // Clean up logging callback, if any')
1362 gedi_txt.append(' layer_data *my_data = get_my_data_ptr(key, layer_data_map);')
1363 gedi_txt.append(' if (my_data->logging_callback) {')
1364 gedi_txt.append(' layer_destroy_msg_callback(my_data->report_data, my_data->logging_callback);')
1365 gedi_txt.append(' }')
1366 gedi_txt.append('')
1367 gedi_txt.append(' layer_debug_report_destroy_instance(mid(instance));')
1368 gedi_txt.append(' layer_data_map.erase(pInstanceTable);')
1369 gedi_txt.append('')
1370 gedi_txt.append(' ObjectTracker_instance_table_map.erase(key);')
1371 gedi_txt.append(' assert(ObjectTracker_instance_table_map.size() == 0 && "Should not have any instance mappings hanging around");')
1372 gedi_txt.append('')
1373 gedi_txt.append(' loader_platform_thread_unlock_mutex(&objLock);')
1374 gedi_txt.append(' return result;')
1375 gedi_txt.append('}')
1376 gedi_txt.append('')
1377 return "\n".join(gedi_txt)
1378
Mark Lobodzinski64d57752015-07-17 11:51:24 -06001379 def generate_destroy_device(self):
Tony Barboura05dbaa2015-07-09 17:31:46 -06001380 gedd_txt = []
1381 gedd_txt.append('%s' % self.lineinfo.get())
Mark Lobodzinski64d57752015-07-17 11:51:24 -06001382 gedd_txt.append('VkResult vkDestroyDevice(')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001383 gedd_txt.append('VkDevice device)')
1384 gedd_txt.append('{')
1385 gedd_txt.append(' loader_platform_thread_lock_mutex(&objLock);')
1386 gedd_txt.append(' validate_object(device, device);')
1387 gedd_txt.append('')
1388 gedd_txt.append(' destroy_obj(device, device);')
1389 gedd_txt.append(' // Report any remaining objects in LL')
1390 for o in vulkan.core.objects:
Mark Lobodzinski64d57752015-07-17 11:51:24 -06001391 if o in ['VkInstance', 'VkPhysicalDevice', 'VkQueue']:
Tony Barboura05dbaa2015-07-09 17:31:46 -06001392 continue
1393 gedd_txt.append(' for (auto it = %sMap.begin(); it != %sMap.end(); ++it) {' % (o, o))
1394 gedd_txt.append(' OBJTRACK_NODE* pNode = it->second;')
1395 gedd_txt.append(' log_msg(mdd(device), VK_DBG_REPORT_ERROR_BIT, pNode->objType, pNode->vkObj, 0, OBJTRACK_OBJECT_LEAK, "OBJTRACK",')
1396 gedd_txt.append(' "OBJ ERROR : %s object 0x%" PRIxLEAST64 " has not been destroyed.", string_VkDbgObjectType(pNode->objType),')
Tony Barbour343d6212015-07-10 18:32:33 -06001397 gedd_txt.append(' pNode->vkObj);')
Tony Barboura05dbaa2015-07-09 17:31:46 -06001398 gedd_txt.append(' }')
1399 gedd_txt.append('')
1400 gedd_txt.append(" // Clean up Queue's MemRef Linked Lists")
1401 gedd_txt.append(' destroyQueueMemRefLists();')
1402 gedd_txt.append('')
1403 gedd_txt.append(' loader_platform_thread_unlock_mutex(&objLock);')
1404 gedd_txt.append('')
1405 gedd_txt.append(' dispatch_key key = get_dispatch_key(device);')
1406 gedd_txt.append(' VkLayerDispatchTable *pDisp = get_dispatch_table(ObjectTracker_device_table_map, device);')
1407 gedd_txt.append(' VkResult result = pDisp->DestroyDevice(device);')
1408 gedd_txt.append(' ObjectTracker_device_table_map.erase(key);')
1409 gedd_txt.append(' assert(ObjectTracker_device_table_map.size() == 0 && "Should not have any instance mappings hanging around");')
1410 gedd_txt.append('')
1411 gedd_txt.append(' return result;')
1412 gedd_txt.append('}')
1413 gedd_txt.append('')
1414 return "\n".join(gedd_txt)
1415
1416 def generate_command_buffer_validates(self):
1417 cbv_txt = []
1418 cbv_txt.append('%s' % self.lineinfo.get())
Cody Northrop271ba752015-08-26 10:01:32 -06001419 for o in ['VkPipeline', 'VkDynamicViewportState', 'VkDynamicLineWidthState', 'VkDynamicDepthBiasState', 'VkDynamicBlendState', 'VkDynamicDepthBoundsState', 'VkDynamicStencilState',
Tony Barboura05dbaa2015-07-09 17:31:46 -06001420 'VkPipelineLayout', 'VkBuffer', 'VkEvent', 'VkQueryPool', 'VkRenderPass', 'VkFramebuffer']:
1421 cbv_txt.append('static void validate_object(VkCmdBuffer dispatchable_object, %s object)' % (o))
1422 cbv_txt.append('{')
1423 cbv_txt.append(' if (%sMap.find((void*)object.handle) == %sMap.end()) {' % (o, o))
1424 cbv_txt.append(' log_msg(mdd(dispatchable_object), VK_DBG_REPORT_ERROR_BIT, (VkDbgObjectType) 0, object.handle, 0, OBJTRACK_INVALID_OBJECT, "OBJTRACK",')
Tony Barbour343d6212015-07-10 18:32:33 -06001425 cbv_txt.append(' "Invalid %s Object %%p", object.handle);' % (o))
Tony Barboura05dbaa2015-07-09 17:31:46 -06001426 cbv_txt.append(' }')
1427 cbv_txt.append('}')
1428 cbv_txt.append('')
1429 return "\n".join(cbv_txt)
1430
Mike Stroyan3e3a1eb2015-04-03 17:13:23 -06001431 def generate_intercept(self, proto, qual):
Courtney Goeltzenleuchter110fdf92015-06-29 15:39:26 -06001432 if proto.name in [ 'DbgCreateMsgCallback', 'GetGlobalLayerProperties', 'GetGlobalExtensionProperties','GetPhysicalDeviceLayerProperties', 'GetPhysicalDeviceExtensionProperties' ]:
Mike Stroyan00087e62015-04-03 14:39:16 -06001433 # use default version
1434 return None
Mark Lobodzinski7c75b852015-05-05 15:01:37 -05001435
Tony Barboura05dbaa2015-07-09 17:31:46 -06001436 # Create map of object names to object type enums of the form VkName : VkObjectTypeName
1437 obj_type_mapping = {base_t : base_t.replace("Vk", "VkObjectType") for base_t in vulkan.object_type_list}
Mark Lobodzinski7c75b852015-05-05 15:01:37 -05001438 # Convert object type enum names from UpperCamelCase to UPPER_CASE_WITH_UNDERSCORES
1439 for objectName, objectTypeEnum in obj_type_mapping.items():
1440 obj_type_mapping[objectName] = ucc_to_U_C_C(objectTypeEnum);
1441 # Command Buffer Object doesn't follow the rule.
1442 obj_type_mapping['VkCmdBuffer'] = "VK_OBJECT_TYPE_COMMAND_BUFFER"
Courtney Goeltzenleuchteree4027d2015-06-28 13:01:17 -06001443 obj_type_mapping['VkShaderModule'] = "VK_OBJECT_TYPE_SHADER_MODULE"
Mike Stroyan00087e62015-04-03 14:39:16 -06001444
Mark Lobodzinskifae78852015-06-23 11:35:12 -06001445 explicit_object_tracker_functions = [
1446 "CreateInstance",
Cody Northropd0802882015-08-03 17:04:53 -06001447 "GetPhysicalDeviceQueueFamilyProperties",
Mark Lobodzinskifae78852015-06-23 11:35:12 -06001448 "CreateDevice",
Mark Lobodzinskifae78852015-06-23 11:35:12 -06001449 "GetDeviceQueue",
1450 "QueueSubmit",
Mark Lobodzinskifae78852015-06-23 11:35:12 -06001451 "QueueBindSparseImageMemory",
1452 "QueueBindSparseBufferMemory",
1453 "GetFenceStatus",
1454 "WaitForFences",
1455 "AllocDescriptorSets",
Tony Barbour770f80d2015-07-20 10:52:13 -06001456 "FreeDescriptorSets",
Mark Lobodzinskifae78852015-06-23 11:35:12 -06001457 "MapMemory",
1458 "UnmapMemory",
1459 "FreeMemory",
1460 "DestroySwapChainWSI"
1461 ]
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001462 decl = proto.c_func(prefix="vk", attr="VKAPI")
Mike Stroyan00087e62015-04-03 14:39:16 -06001463 param0_name = proto.params[0].name
Mark Lobodzinski48bd16d2015-05-08 09:12:28 -05001464 using_line = ''
Mike Stroyan00087e62015-04-03 14:39:16 -06001465 create_line = ''
Mark Lobodzinski64d57752015-07-17 11:51:24 -06001466 destroy_line = ''
Tobin Ehlis154e0462015-08-26 11:22:09 -06001467 # Dict below tracks params that are vk objects. Dict is "loop count"->["params w/ that loop count"] where '0' is params that aren't in an array
1468 loop_params = defaultdict(list) # Dict uses loop count as key to make final code generation cleaner so params shared in single loop where needed
Tobin Ehlis2717d132015-07-10 18:25:07 -06001469 # TODO : For now skipping objs that can be NULL. Really should check these and have special case that allows them to be NULL
Tobin Ehlis154e0462015-08-26 11:22:09 -06001470 # or better yet, these should be encoded into an API json definition and we generate checks from there
1471 # Until then, this is a dict where each func name is a list of object params that can be null (so don't need to be validated)
1472 # param names may be directly passed to the function, or may be a field in a struct param
1473 valid_null_object_names = {'CreateGraphicsPipelines' : ['basePipelineHandle'],
1474 'CreateComputePipelines' : ['basePipelineHandle'],
1475 'BeginCommandBuffer' : ['renderPass', 'framebuffer'],
1476 }
Tobin Ehlis803cc492015-06-08 17:36:28 -06001477 # TODO : A few of the skipped types are just "hard" cases that need some more work to support
1478 # Need to handle NULL fences on queue submit, binding null memory, and WSI Image objects
Tobin Ehlis154e0462015-08-26 11:22:09 -06001479 param_count = 'NONE' # keep track of arrays passed directly into API functions
Tobin Ehlis803cc492015-06-08 17:36:28 -06001480 for p in proto.params:
Tobin Ehlis154e0462015-08-26 11:22:09 -06001481 if 'count' in p.name.lower():
1482 param_count = p.name
Tobin Ehlis803cc492015-06-08 17:36:28 -06001483 if p.ty in vulkan.core.objects and p.ty not in ['VkPhysicalDevice', 'VkQueue', 'VkFence', 'VkImage', 'VkDeviceMemory']:
Tobin Ehlis154e0462015-08-26 11:22:09 -06001484 if proto.name not in valid_null_object_names or p.name not in valid_null_object_names[proto.name]:
1485 loop_params[0].append(p.name)
Tobin Ehlis9d675942015-06-30 14:32:16 -06001486 elif vk_helper.is_type(p.ty.replace('const ', '').strip('*'), 'struct'):
1487 struct_type = p.ty.replace('const ', '').strip('*')
1488 if vk_helper.typedef_rev_dict[struct_type] in vk_helper.struct_dict:
1489 struct_type = vk_helper.typedef_rev_dict[struct_type]
1490 for m in sorted(vk_helper.struct_dict[struct_type]):
1491 if vk_helper.struct_dict[struct_type][m]['type'] in vulkan.core.objects and vk_helper.struct_dict[struct_type][m]['type'] not in ['VkPhysicalDevice', 'VkQueue', 'VkFence', 'VkImage', 'VkDeviceMemory']:
Tobin Ehlis154e0462015-08-26 11:22:09 -06001492 if proto.name not in valid_null_object_names or vk_helper.struct_dict[struct_type][m]['name'] not in valid_null_object_names[proto.name]:
1493 # If we have a count and this param is a ptr w/ last letter 's', then this is a dynamically sized array param
1494 # This is not great, but gets the job done for now
1495 if param_count != 'NONE' and '*' in p.ty and 's' == p.name[-1]:
1496 param_name = '%s[i].%s' % (p.name, vk_helper.struct_dict[struct_type][m]['name'])
Tobin Ehlis46d53622015-07-10 11:10:21 -06001497 else:
Tobin Ehlis154e0462015-08-26 11:22:09 -06001498 param_name = '%s->%s' % (p.name, vk_helper.struct_dict[struct_type][m]['name'])
1499 if vk_helper.struct_dict[struct_type][m]['dyn_array']:
1500 loop_count = '%s->%s' % (p.name, vk_helper.struct_dict[struct_type][m]['array_size'])
1501 loop_params[loop_count].append(param_name)
1502 else:
1503 if '[' in param_name: # dynamic array param, set size
1504 loop_params[param_count].append(param_name)
1505 else:
1506 loop_params[0].append(param_name)
Mike Stroyan00087e62015-04-03 14:39:16 -06001507 funcs = []
Tobin Ehlis803cc492015-06-08 17:36:28 -06001508 mutex_unlock = False
Tobin Ehlis154e0462015-08-26 11:22:09 -06001509 funcs.append('%s\n' % self.lineinfo.get())
Mark Lobodzinskifae78852015-06-23 11:35:12 -06001510 if proto.name in explicit_object_tracker_functions:
Jon Ashburn4d9f4652015-04-08 21:33:34 -06001511 funcs.append('%s%s\n'
1512 '{\n'
Mark Lobodzinskifae78852015-06-23 11:35:12 -06001513 ' return explicit_%s;\n'
1514 '}' % (qual, decl, proto.c_call()))
1515 return "".join(funcs)
Mark Lobodzinski64d57752015-07-17 11:51:24 -06001516 elif 'DestroyInstance' in proto.name or 'DestroyDevice' in proto.name:
1517 return ""
Jon Ashburn4d9f4652015-04-08 21:33:34 -06001518 else:
Mark Lobodzinskifae78852015-06-23 11:35:12 -06001519 if 'Create' in proto.name or 'Alloc' in proto.name:
1520 create_line = ' loader_platform_thread_lock_mutex(&objLock);\n'
1521 create_line += ' if (result == VK_SUCCESS) {\n'
1522 create_line += ' create_obj(%s, *%s, %s);\n' % (param0_name, proto.params[-1].name, obj_type_mapping[proto.params[-1].ty.strip('*').replace('const ', '')])
1523 create_line += ' }\n'
1524 create_line += ' loader_platform_thread_unlock_mutex(&objLock);\n'
Mark Lobodzinski64d57752015-07-17 11:51:24 -06001525 if 'Destroy' in proto.name:
1526 destroy_line = ' loader_platform_thread_lock_mutex(&objLock);\n'
1527 destroy_line += ' if (result == VK_SUCCESS) {\n'
1528 if 'DestroyCommandBuffer' in proto.name:
1529 destroy_line += ' destroy_obj(%s, %s);\n' % (proto.params[-1].name, proto.params[-1].name)
1530 else:
1531 destroy_line += ' destroy_obj(%s, %s);\n' % (param0_name, proto.params[-1].name)
1532 destroy_line += ' }\n'
1533 destroy_line += ' loader_platform_thread_unlock_mutex(&objLock);\n'
Tobin Ehlis154e0462015-08-26 11:22:09 -06001534 if len(loop_params) > 0:
Mark Lobodzinskifae78852015-06-23 11:35:12 -06001535 if not mutex_unlock:
1536 using_line += ' loader_platform_thread_lock_mutex(&objLock);\n'
1537 mutex_unlock = True
Tobin Ehlis154e0462015-08-26 11:22:09 -06001538 for lc in loop_params:
1539 if 0 == lc: # No looping required for these params
1540 for opn in loop_params[lc]:
1541 if '->' in opn:
1542 using_line += ' if (%s)\n' % (opn.split('-')[0])
1543 using_line += ' validate_object(%s, %s);\n' % (param0_name, opn)
1544 else:
1545 using_line += ' validate_object(%s, %s);\n' % (param0_name, opn)
Tobin Ehlis9d675942015-06-30 14:32:16 -06001546 else:
Tobin Ehlis154e0462015-08-26 11:22:09 -06001547 base_param = loop_params[lc][0].split('-')[0].split('[')[0]
1548 using_line += ' if (%s) {\n' % base_param
1549 using_line += ' for (uint32_t i=0; i<%s; i++) {\n' % lc
1550 for opn in loop_params[lc]:
1551 if '[' in opn: # API func param is array
1552 using_line += ' validate_object(%s, %s);\n' % (param0_name, opn)
1553 else: # struct element is array
1554 using_line += ' validate_object(%s, %s[i]);\n' % (param0_name, opn)
1555 using_line += ' }\n'
1556 using_line += ' }\n'
Mark Lobodzinskifae78852015-06-23 11:35:12 -06001557 if mutex_unlock:
1558 using_line += ' loader_platform_thread_unlock_mutex(&objLock);\n'
1559 ret_val = ''
1560 stmt = ''
Mark Lobodzinskifae78852015-06-23 11:35:12 -06001561 if proto.ret != "void":
1562 ret_val = "%s result = " % proto.ret
1563 stmt = " return result;\n"
1564
1565 dispatch_param = proto.params[0].name
1566 if 'CreateInstance' in proto.name:
1567 dispatch_param = '*' + proto.params[1].name
1568
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -05001569 # Must use 'instance' table for these APIs, 'device' table otherwise
1570 table_type = ""
1571 if proto_is_global(proto):
1572 table_type = "instance"
1573 else:
1574 table_type = "device"
Mike Stroyan00087e62015-04-03 14:39:16 -06001575 funcs.append('%s%s\n'
1576 '{\n'
1577 '%s'
Mark Lobodzinskifae78852015-06-23 11:35:12 -06001578 ' %sget_dispatch_table(ObjectTracker_%s_table_map, %s)->%s;\n'
Mark Lobodzinski64d57752015-07-17 11:51:24 -06001579 '%s%s'
Mike Stroyan00087e62015-04-03 14:39:16 -06001580 '%s'
Mark Lobodzinski64d57752015-07-17 11:51:24 -06001581 '}' % (qual, decl, using_line, ret_val, table_type, dispatch_param, proto.c_call(), create_line, destroy_line, stmt))
Mike Stroyan00087e62015-04-03 14:39:16 -06001582 return "\n\n".join(funcs)
1583
Tobin Ehlis12076fc2014-10-22 09:06:33 -06001584 def generate_body(self):
Mike Stroyan3e3a1eb2015-04-03 17:13:23 -06001585 self.layer_name = "ObjectTracker"
Ian Elliott1064fe32015-07-06 14:31:32 -06001586 extensions=[('wsi_enabled',
Jon Ashburn747f2b62015-06-18 15:02:58 -06001587 ['vkCreateSwapChainWSI', 'vkDestroySwapChainWSI',
Ian Elliott2b6b68a2015-08-07 14:11:14 -06001588 'vkGetSwapChainImagesWSI', 'vkQueuePresentWSI'])]
Tony Barboura05dbaa2015-07-09 17:31:46 -06001589 body = [self.generate_maps(),
1590 self.generate_procs(),
Mark Lobodzinski64d57752015-07-17 11:51:24 -06001591 self.generate_destroy_instance(),
1592 self.generate_destroy_device(),
Tony Barboura05dbaa2015-07-09 17:31:46 -06001593 self.generate_command_buffer_validates(),
1594 self._generate_dispatch_entrypoints("VK_LAYER_EXPORT"),
Tobin Ehlisca915872014-11-18 11:28:33 -07001595 self._generate_extensions(),
Jon Ashburn747f2b62015-06-18 15:02:58 -06001596 self._generate_layer_gpa_function(extensions,
Courtney Goeltzenleuchter17274172015-06-01 14:52:57 -06001597 instance_extensions=['msg_callback_get_proc_addr'])]
Tobin Ehlis12076fc2014-10-22 09:06:33 -06001598 return "\n\n".join(body)
Courtney Goeltzenleuchterb412d212014-11-18 10:40:29 -07001599
Mike Stroyan3712d5c2015-04-02 11:59:05 -06001600class ThreadingSubcommand(Subcommand):
Mike Stroyanbe2b5d82015-07-09 11:01:07 -06001601 thread_check_dispatchable_objects = [
1602 "VkQueue",
1603 "VkCmdBuffer",
1604 ]
1605 thread_check_nondispatchable_objects = [
1606 "VkDeviceMemory",
1607 "VkBuffer",
1608 "VkImage",
1609 "VkDescriptorSet",
1610 "VkDescriptorPool",
1611 "VkSemaphore"
1612 ]
Mike Stroyan313f7e62015-08-10 16:42:53 -06001613 thread_check_object_types = {
1614 'VkInstance' : 'VK_OBJECT_TYPE_INSTANCE',
1615 'VkPhysicalDevice' : 'VK_OBJECT_TYPE_PHYSICAL_DEVICE',
1616 'VkDevice' : 'VK_OBJECT_TYPE_DEVICE',
1617 'VkQueue' : 'VK_OBJECT_TYPE_QUEUE',
1618 'VkCmdBuffer' : 'VK_OBJECT_TYPE_COMMAND_BUFFER',
1619 'VkFence' : 'VK_OBJECT_TYPE_FENCE',
1620 'VkDeviceMemory' : 'VK_OBJECT_TYPE_DEVICE_MEMORY',
1621 'VkBuffer' : 'VK_OBJECT_TYPE_BUFFER',
1622 'VkImage' : 'VK_OBJECT_TYPE_IMAGE',
1623 'VkSemaphore' : 'VK_OBJECT_TYPE_SEMAPHORE',
1624 'VkEvent' : 'VK_OBJECT_TYPE_EVENT',
1625 'VkQueryPool' : 'VK_OBJECT_TYPE_QUERY_POOL',
1626 'VkBufferView' : 'VK_OBJECT_TYPE_BUFFER_VIEW',
1627 'VkImageView' : 'VK_OBJECT_TYPE_IMAGE_VIEW',
1628 'VkAttachmentView' : 'VK_OBJECT_TYPE_ATTACHMENT_VIEW',
1629 'VkShaderModule' : 'VK_OBJECT_TYPE_SHADER_MODULE',
1630 'VkShader' : 'VK_OBJECT_TYPE_SHADER',
1631 'VkPipelineCache' : 'VK_OBJECT_TYPE_PIPELINE_CACHE',
1632 'VkPipelineLayout' : 'VK_OBJECT_TYPE_PIPELINE_LAYOUT',
1633 'VkRenderPass' : 'VK_OBJECT_TYPE_RENDER_PASS',
1634 'VkPipeline' : 'VK_OBJECT_TYPE_PIPELINE',
1635 'VkDescriptorSetLayout' : 'VK_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT',
1636 'VkSampler' : 'VK_OBJECT_TYPE_SAMPLER',
1637 'VkDescriptorPool' : 'VK_OBJECT_TYPE_DESCRIPTOR_POOL',
1638 'VkDescriptorSet' : 'VK_OBJECT_TYPE_DESCRIPTOR_SET',
1639 'VkDynamicViewportState' : 'VK_OBJECT_TYPE_DYNAMIC_VIEWPORT_STATE',
Cody Northrop271ba752015-08-26 10:01:32 -06001640 'VkDynamicLineWidthState' : 'VK_OBJECT_TYPE_DYNAMIC_LINE_WIDTH_STATE',
1641 'VkDynamicDepthBiasState' : 'VK_OBJECT_TYPE_DYNAMIC_DEPTH_BIAS_STATE',
1642 'VkDynamicBlendState' : 'VK_OBJECT_TYPE_DYNAMIC_BLEND_STATE',
1643 'VkDynamicDepthBoundsState' : 'VK_OBJECT_TYPE_DYNAMIC_DEPTH_BOUNDS_STATE',
Cody Northrop82485a82015-08-18 15:21:16 -06001644 'VkDynamicStencilState' : 'VK_OBJECT_TYPE_DYNAMIC_STENCIL_STATE',
Mike Stroyan313f7e62015-08-10 16:42:53 -06001645 'VkFramebuffer' : 'VK_OBJECT_TYPE_FRAMEBUFFER',
1646 'VkCmdPool' : 'VK_OBJECT_TYPE_CMD_POOL',
1647 }
1648 def generate_useObject(self, ty):
1649 obj_type = self.thread_check_object_types[ty]
1650 if ty in self.thread_check_dispatchable_objects:
1651 key = "object"
Courtney Goeltzenleuchterdee721d2015-08-26 15:09:25 -06001652 msg_object = "reinterpret_cast<uint64_t>(object)"
Mike Stroyan313f7e62015-08-10 16:42:53 -06001653 else:
1654 key = "object.handle"
1655 msg_object = "object.handle"
Mike Stroyanbe2b5d82015-07-09 11:01:07 -06001656 header_txt = []
1657 header_txt.append('%s' % self.lineinfo.get())
Mike Stroyan313f7e62015-08-10 16:42:53 -06001658 header_txt.append('static void useObject(const void* dispatchable_object, %s object)' % ty)
Mike Stroyanbe2b5d82015-07-09 11:01:07 -06001659 header_txt.append('{')
1660 header_txt.append(' loader_platform_thread_id tid = loader_platform_get_thread_id();')
1661 header_txt.append(' loader_platform_thread_lock_mutex(&threadingLock);')
1662 header_txt.append(' if (%sObjectsInUse.find(%s) == %sObjectsInUse.end()) {' % (ty, key, ty))
1663 header_txt.append(' %sObjectsInUse[%s] = tid;' % (ty, key))
1664 header_txt.append(' } else {')
1665 header_txt.append(' if (%sObjectsInUse[%s] != tid) {' % (ty, key))
Mike Stroyan313f7e62015-08-10 16:42:53 -06001666 header_txt.append(' log_msg(mdd(dispatchable_object), VK_DBG_REPORT_ERROR_BIT, %s, %s,' % (obj_type, msg_object))
1667 header_txt.append(' /*location*/ 0, THREADING_CHECKER_MULTIPLE_THREADS, "THREADING",')
1668 header_txt.append(' "THREADING ERROR : object of type %s is simultaneously used in thread %%ld and thread %%ld",' % (ty))
1669 header_txt.append(' %sObjectsInUse[%s], tid);' % (ty, key))
Mike Stroyanbe2b5d82015-07-09 11:01:07 -06001670 header_txt.append(' // Wait for thread-safe access to object')
1671 header_txt.append(' while (%sObjectsInUse.find(%s) != %sObjectsInUse.end()) {' % (ty, key, ty))
1672 header_txt.append(' loader_platform_thread_cond_wait(&threadingCond, &threadingLock);')
1673 header_txt.append(' }')
1674 header_txt.append(' %sObjectsInUse[%s] = tid;' % (ty, key))
1675 header_txt.append(' } else {')
Mike Stroyan313f7e62015-08-10 16:42:53 -06001676 header_txt.append(' log_msg(mdd(dispatchable_object), VK_DBG_REPORT_ERROR_BIT, %s, %s,' % (obj_type, msg_object))
1677 header_txt.append(' /*location*/ 0, THREADING_CHECKER_MULTIPLE_THREADS, "THREADING",')
1678 header_txt.append(' "THREADING ERROR : object of type %s is recursively used in thread %%ld",' % (ty))
1679 header_txt.append(' tid);')
Mike Stroyanbe2b5d82015-07-09 11:01:07 -06001680 header_txt.append(' }')
1681 header_txt.append(' }')
1682 header_txt.append(' loader_platform_thread_unlock_mutex(&threadingLock);')
1683 header_txt.append('}')
1684 return "\n".join(header_txt)
Mike Stroyan313f7e62015-08-10 16:42:53 -06001685 def generate_finishUsingObject(self, ty):
1686 if ty in self.thread_check_dispatchable_objects:
1687 key = "object"
1688 else:
1689 key = "object.handle"
Mike Stroyanbe2b5d82015-07-09 11:01:07 -06001690 header_txt = []
1691 header_txt.append('%s' % self.lineinfo.get())
1692 header_txt.append('static void finishUsingObject(%s object)' % ty)
1693 header_txt.append('{')
1694 header_txt.append(' // Object is no longer in use')
1695 header_txt.append(' loader_platform_thread_lock_mutex(&threadingLock);')
1696 header_txt.append(' %sObjectsInUse.erase(%s);' % (ty, key))
1697 header_txt.append(' loader_platform_thread_cond_broadcast(&threadingCond);')
1698 header_txt.append(' loader_platform_thread_unlock_mutex(&threadingLock);')
1699 header_txt.append('}')
1700 return "\n".join(header_txt)
Mike Stroyan3712d5c2015-04-02 11:59:05 -06001701 def generate_header(self):
1702 header_txt = []
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001703 header_txt.append('%s' % self.lineinfo.get())
Mike Stroyan3712d5c2015-04-02 11:59:05 -06001704 header_txt.append('#include <stdio.h>')
1705 header_txt.append('#include <stdlib.h>')
1706 header_txt.append('#include <string.h>')
1707 header_txt.append('#include <unordered_map>')
Tobin Ehlisb835d1b2015-07-03 10:34:49 -06001708 header_txt.append('#include "vk_loader_platform.h"')
Tobin Ehlis0c6f9ee2015-07-03 09:42:57 -06001709 header_txt.append('#include "vk_layer.h"')
Mike Stroyan3712d5c2015-04-02 11:59:05 -06001710 header_txt.append('#include "threading.h"')
Tobin Ehlisa0cb02e2015-07-03 10:15:26 -06001711 header_txt.append('#include "vk_layer_config.h"')
Courtney Goeltzenleuchter3f9f7c42015-07-06 09:11:12 -06001712 header_txt.append('#include "vk_layer_extension_utils.h"')
Mike Stroyan3712d5c2015-04-02 11:59:05 -06001713 header_txt.append('#include "vk_enum_validate_helper.h"')
1714 header_txt.append('#include "vk_struct_validate_helper.h"')
1715 header_txt.append('//The following is #included again to catch certain OS-specific functions being used:')
Mike Stroyan313f7e62015-08-10 16:42:53 -06001716 header_txt.append('#include "vk_loader_platform.h"')
1717 header_txt.append('#include "vk_layer_msg.h"')
1718 header_txt.append('#include "vk_layer_table.h"')
1719 header_txt.append('#include "vk_layer_logging.h"')
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -05001720 header_txt.append('')
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -05001721 header_txt.append('')
1722 header_txt.append('static LOADER_PLATFORM_THREAD_ONCE_DECLARATION(initOnce);')
1723 header_txt.append('')
Mike Stroyan3712d5c2015-04-02 11:59:05 -06001724 header_txt.append('using namespace std;')
Mike Stroyanbe2b5d82015-07-09 11:01:07 -06001725 for ty in self.thread_check_dispatchable_objects:
1726 header_txt.append('static unordered_map<%s, loader_platform_thread_id> %sObjectsInUse;' % (ty, ty))
1727 for ty in self.thread_check_nondispatchable_objects:
1728 header_txt.append('static unordered_map<uint64_t, loader_platform_thread_id> %sObjectsInUse;' % ty)
Mike Stroyan3712d5c2015-04-02 11:59:05 -06001729 header_txt.append('static int threadingLockInitialized = 0;')
1730 header_txt.append('static loader_platform_thread_mutex threadingLock;')
Mike Stroyaned238bb2015-05-15 08:50:57 -06001731 header_txt.append('static loader_platform_thread_cond threadingCond;')
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001732 header_txt.append('%s' % self.lineinfo.get())
Mike Stroyan313f7e62015-08-10 16:42:53 -06001733 for ty in self.thread_check_dispatchable_objects + self.thread_check_nondispatchable_objects:
1734 header_txt.append(self.generate_useObject(ty))
1735 header_txt.append(self.generate_finishUsingObject(ty))
Mike Stroyanbe2b5d82015-07-09 11:01:07 -06001736 header_txt.append('%s' % self.lineinfo.get())
Mike Stroyan3712d5c2015-04-02 11:59:05 -06001737 return "\n".join(header_txt)
1738
1739 def generate_intercept(self, proto, qual):
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -06001740 if proto.name in [ 'DbgCreateMsgCallback' ]:
Mike Stroyan3712d5c2015-04-02 11:59:05 -06001741 # use default version
1742 return None
1743 decl = proto.c_func(prefix="vk", attr="VKAPI")
1744 ret_val = ''
1745 stmt = ''
1746 funcs = []
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -05001747 table = 'device'
Mike Stroyan3712d5c2015-04-02 11:59:05 -06001748 if proto.ret != "void":
Jon Ashburnb0fbe912015-05-06 10:15:07 -06001749 ret_val = "%s result = " % proto.ret
Mike Stroyan3712d5c2015-04-02 11:59:05 -06001750 stmt = " return result;\n"
Jon Ashburn95a77ba2015-05-15 15:09:35 -06001751 if proto_is_global(proto):
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -05001752 table = 'instance'
Jon Ashburn71836d92015-05-12 17:23:55 -06001753
Mike Stroyan6ea73e42015-05-11 17:18:14 -06001754 # Memory range calls are special in needed thread checking within structs
1755 if proto.name in ["FlushMappedMemoryRanges","InvalidateMappedMemoryRanges"]:
Mike Stroyan313f7e62015-08-10 16:42:53 -06001756 funcs.append('%s' % self.lineinfo.get())
1757 funcs.append('%s%s\n' % (qual, decl) +
Mike Stroyan6ea73e42015-05-11 17:18:14 -06001758 '{\n'
Tony Barbour92503c62015-07-13 15:28:47 -06001759 ' for (uint32_t i=0; i<memRangeCount; i++) {\n'
Mike Stroyan313f7e62015-08-10 16:42:53 -06001760 ' useObject((const void *) %s, pMemRanges[i].mem);\n' % proto.params[0].name +
Mike Stroyan6ea73e42015-05-11 17:18:14 -06001761 ' }\n'
Mike Stroyan313f7e62015-08-10 16:42:53 -06001762 ' VkLayerDispatchTable *pDeviceTable = get_dispatch_table(Threading_%s_table_map, %s);\n' % (table, proto.params[0].name) +
1763 ' %s pDeviceTable->%s;\n' % (ret_val, proto.c_call()) +
Tony Barbour92503c62015-07-13 15:28:47 -06001764 ' for (uint32_t i=0; i<memRangeCount; i++) {\n'
Mike Stroyanbe2b5d82015-07-09 11:01:07 -06001765 ' finishUsingObject(pMemRanges[i].mem);\n'
Mike Stroyan6ea73e42015-05-11 17:18:14 -06001766 ' }\n'
Mike Stroyan313f7e62015-08-10 16:42:53 -06001767 '%s' % (stmt) +
1768 '}')
Mike Stroyan6ea73e42015-05-11 17:18:14 -06001769 return "\n".join(funcs)
Mike Stroyan3712d5c2015-04-02 11:59:05 -06001770 # All functions that do a Get are thread safe
Mike Stroyan6ea73e42015-05-11 17:18:14 -06001771 if 'Get' in proto.name:
Mike Stroyan3712d5c2015-04-02 11:59:05 -06001772 return None
Mike Stroyan6ea73e42015-05-11 17:18:14 -06001773 # All WSI functions are thread safe
1774 if 'WSI' in proto.name:
Mike Stroyan3712d5c2015-04-02 11:59:05 -06001775 return None
Mike Stroyan6ea73e42015-05-11 17:18:14 -06001776 # Initialize in early calls
Courtney Goeltzenleuchterca173b82015-06-25 18:01:43 -06001777 if proto.name == "CreateDevice":
1778 funcs.append('%s' % self.lineinfo.get())
Mike Stroyan313f7e62015-08-10 16:42:53 -06001779 funcs.append('%s%s\n' % (qual, decl) +
Courtney Goeltzenleuchterca173b82015-06-25 18:01:43 -06001780 '{\n'
Mike Stroyan313f7e62015-08-10 16:42:53 -06001781 ' VkLayerDispatchTable *pDeviceTable = get_dispatch_table(Threading_device_table_map, (void *) *pDevice);\n'
1782 ' VkResult result = pDeviceTable->%s;\n' % (proto.c_call()) +
1783 ' if (result == VK_SUCCESS) {\n'
1784 ' layer_data *my_instance_data = get_my_data_ptr(get_dispatch_key(%s), layer_data_map);\n' % proto.params[0].name +
1785 ' layer_data *my_device_data = get_my_data_ptr(get_dispatch_key(*pDevice), layer_data_map);\n'
1786 ' my_device_data->report_data = layer_debug_report_create_device(my_instance_data->report_data, *pDevice);\n'
1787 ' }\n'
1788 '\n'
1789 ' return result;'
1790 '}')
Courtney Goeltzenleuchterca173b82015-06-25 18:01:43 -06001791 return "\n".join(funcs)
1792 elif proto.params[0].ty == "VkPhysicalDevice":
Mike Stroyan313f7e62015-08-10 16:42:53 -06001793 return None
Mike Stroyan6ea73e42015-05-11 17:18:14 -06001794 # Functions changing command buffers need thread safe use of first parameter
1795 if proto.params[0].ty == "VkCmdBuffer":
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001796 funcs.append('%s' % self.lineinfo.get())
Mike Stroyan313f7e62015-08-10 16:42:53 -06001797 funcs.append('%s%s\n' % (qual, decl) +
Mike Stroyan3712d5c2015-04-02 11:59:05 -06001798 '{\n'
Mike Stroyan313f7e62015-08-10 16:42:53 -06001799 ' useObject((const void *) %s, %s);\n' % (proto.params[0].name, proto.params[0].name) +
1800 ' VkLayerDispatchTable *pDeviceTable = get_dispatch_table(Threading_%s_table_map, %s);\n' % (table, proto.params[0].name) +
1801 ' %spDeviceTable->%s;\n' % (ret_val, proto.c_call()) +
1802 ' finishUsingObject(%s);\n' % proto.params[0].name +
1803 '%s' % stmt +
1804 '}')
Mike Stroyan6ea73e42015-05-11 17:18:14 -06001805 return "\n".join(funcs)
1806 # Non-Cmd functions that do a Wait are thread safe
1807 if 'Wait' in proto.name:
1808 return None
1809 # Watch use of certain types of objects passed as any parameter
1810 checked_params = []
1811 for param in proto.params:
Mike Stroyanbe2b5d82015-07-09 11:01:07 -06001812 if param.ty in self.thread_check_dispatchable_objects or param.ty in self.thread_check_nondispatchable_objects:
Mike Stroyan6ea73e42015-05-11 17:18:14 -06001813 checked_params.append(param)
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -05001814 if proto.name == "DestroyDevice":
Mike Stroyan313f7e62015-08-10 16:42:53 -06001815 funcs.append('%s%s\n' % (qual, decl) +
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -05001816 '{\n'
Courtney Goeltzenleuchter0daf2282015-06-13 21:22:12 -06001817 ' dispatch_key key = get_dispatch_key(device);\n'
Mike Stroyan313f7e62015-08-10 16:42:53 -06001818 ' VkLayerDispatchTable *pDeviceTable = get_dispatch_table(Threading_%s_table_map, %s);\n' % (table, proto.params[0].name) +
1819 ' %spDeviceTable->%s;\n' % (ret_val, proto.c_call()) +
1820 ' Threading_device_table_map.erase(key);\n'
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -05001821 ' return result;\n'
Mike Stroyan313f7e62015-08-10 16:42:53 -06001822 '}\n')
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -05001823 return "\n".join(funcs);
1824 elif proto.name == "DestroyInstance":
Mike Stroyan313f7e62015-08-10 16:42:53 -06001825 funcs.append('%s%s\n' % (qual, decl) +
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -05001826 '{\n'
Courtney Goeltzenleuchter0daf2282015-06-13 21:22:12 -06001827 ' dispatch_key key = get_dispatch_key(instance);\n'
Mike Stroyan313f7e62015-08-10 16:42:53 -06001828 ' VkLayerInstanceDispatchTable *pInstanceTable = get_dispatch_table(Threading_instance_table_map, %s);\n' % proto.params[0].name +
1829 ' %spInstanceTable->%s;\n' % (ret_val, proto.c_call()) +
Courtney Goeltzenleuchter0daf2282015-06-13 21:22:12 -06001830 ' destroy_instance_dispatch_table(key);\n'
Mike Stroyan313f7e62015-08-10 16:42:53 -06001831 '\n'
1832 ' // Clean up logging callback, if any\n'
1833 ' layer_data *my_data = get_my_data_ptr(key, layer_data_map);\n'
1834 ' if (my_data->logging_callback) {\n'
1835 ' layer_destroy_msg_callback(my_data->report_data, my_data->logging_callback);\n'
1836 ' }\n'
1837 '\n'
1838 ' layer_debug_report_destroy_instance(my_data->report_data);\n'
1839 ' layer_data_map.erase(pInstanceTable);\n'
1840 '\n'
1841 ' Threading_instance_table_map.erase(key);\n'
1842 '\n'
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -05001843 ' return result;\n'
Mike Stroyan313f7e62015-08-10 16:42:53 -06001844 '}\n')
Mark Lobodzinskifb5437a2015-05-22 14:15:36 -05001845 return "\n".join(funcs);
Courtney Goeltzenleuchterd02a9642015-06-08 14:58:39 -06001846 elif proto.name == "CreateInstance":
1847 funcs.append('%s%s\n'
1848 '{\n'
Mike Stroyan313f7e62015-08-10 16:42:53 -06001849 ' VkLayerInstanceDispatchTable *pInstanceTable = get_dispatch_table(Threading_instance_table_map, *pInstance);\n'
1850 ' VkResult result = pInstanceTable->CreateInstance(pCreateInfo, pInstance);\n'
Courtney Goeltzenleuchterd02a9642015-06-08 14:58:39 -06001851 '\n'
1852 ' if (result == VK_SUCCESS) {\n'
Mike Stroyan313f7e62015-08-10 16:42:53 -06001853 ' layer_data *my_data = get_my_data_ptr(get_dispatch_key(*pInstance), layer_data_map);\n'
1854 ' my_data->report_data = debug_report_create_instance(\n'
1855 ' pInstanceTable,\n'
1856 ' *pInstance,\n'
1857 ' pCreateInfo->extensionCount,\n'
1858 ' pCreateInfo->ppEnabledExtensionNames);\n'
1859 ' initThreading(my_data);\n'
Courtney Goeltzenleuchterd02a9642015-06-08 14:58:39 -06001860 ' }\n'
1861 ' return result;\n'
Mike Stroyan313f7e62015-08-10 16:42:53 -06001862 '}\n' % (qual, decl))
Courtney Goeltzenleuchterd02a9642015-06-08 14:58:39 -06001863 return "\n".join(funcs);
Mike Stroyan6ea73e42015-05-11 17:18:14 -06001864 if len(checked_params) == 0:
1865 return None
1866 # Surround call with useObject and finishUsingObject for each checked_param
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001867 funcs.append('%s' % self.lineinfo.get())
Mike Stroyan6ea73e42015-05-11 17:18:14 -06001868 funcs.append('%s%s' % (qual, decl))
1869 funcs.append('{')
1870 for param in checked_params:
Mike Stroyan313f7e62015-08-10 16:42:53 -06001871 funcs.append(' useObject((const void *) %s, %s);' % (proto.params[0].name, param.name))
1872 funcs.append(' VkLayerDispatchTable *pDeviceTable = get_dispatch_table(Threading_%s_table_map, %s);' % (table, proto.params[0].name));
1873 funcs.append(' %spDeviceTable->%s;' % (ret_val, proto.c_call()))
Mike Stroyan6ea73e42015-05-11 17:18:14 -06001874 for param in checked_params:
Mike Stroyanbe2b5d82015-07-09 11:01:07 -06001875 funcs.append(' finishUsingObject(%s);' % param.name)
Mike Stroyan6ea73e42015-05-11 17:18:14 -06001876 funcs.append('%s'
1877 '}' % stmt)
1878 return "\n".join(funcs)
Mike Stroyan3712d5c2015-04-02 11:59:05 -06001879
1880 def generate_body(self):
1881 self.layer_name = "Threading"
Mike Stroyan313f7e62015-08-10 16:42:53 -06001882 body = [self._generate_new_layer_initialization(True, lockname='threading', condname='threading'),
Mike Stroyan3712d5c2015-04-02 11:59:05 -06001883 self._generate_dispatch_entrypoints("VK_LAYER_EXPORT"),
Courtney Goeltzenleuchter17274172015-06-01 14:52:57 -06001884 self._generate_layer_gpa_function(extensions=[],
1885 instance_extensions=['msg_callback_get_proc_addr']),
1886 self._gen_create_msg_callback(),
1887 self._gen_destroy_msg_callback()]
Mike Stroyan3712d5c2015-04-02 11:59:05 -06001888 return "\n\n".join(body)
1889
Tobin Ehlis12076fc2014-10-22 09:06:33 -06001890def main():
1891 subcommands = {
1892 "layer-funcs" : LayerFuncsSubcommand,
Tobin Ehlisa363cfa2014-11-25 16:59:27 -07001893 "Generic" : GenericLayerSubcommand,
Tobin Ehlise78dbd82015-04-09 09:19:36 -06001894 "APIDump" : APIDumpSubcommand,
Tobin Ehlisa363cfa2014-11-25 16:59:27 -07001895 "ObjectTracker" : ObjectTrackerSubcommand,
Mike Stroyan3712d5c2015-04-02 11:59:05 -06001896 "Threading" : ThreadingSubcommand,
Tobin Ehlis12076fc2014-10-22 09:06:33 -06001897 }
1898
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001899 if len(sys.argv) < 3 or sys.argv[1] not in subcommands or not os.path.exists(sys.argv[2]):
1900 print("Usage: %s <subcommand> <input_header> [options]" % sys.argv[0])
Tobin Ehlis12076fc2014-10-22 09:06:33 -06001901 print
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001902 print("Available subcommands are: %s" % " ".join(subcommands))
Tobin Ehlis12076fc2014-10-22 09:06:33 -06001903 exit(1)
1904
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001905 hfp = vk_helper.HeaderFileParser(sys.argv[2])
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001906 hfp.parse()
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001907 vk_helper.enum_val_dict = hfp.get_enum_val_dict()
1908 vk_helper.enum_type_dict = hfp.get_enum_type_dict()
1909 vk_helper.struct_dict = hfp.get_struct_dict()
1910 vk_helper.typedef_fwd_dict = hfp.get_typedef_fwd_dict()
1911 vk_helper.typedef_rev_dict = hfp.get_typedef_rev_dict()
1912 vk_helper.types_dict = hfp.get_types_dict()
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001913
Tobin Ehlis12076fc2014-10-22 09:06:33 -06001914 subcmd = subcommands[sys.argv[1]](sys.argv[2:])
1915 subcmd.run()
1916
1917if __name__ == "__main__":
1918 main()