1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
#!/usr/bin/python3 -i
#
# Copyright (c) 2018-2020 Valve Corporation
# Copyright (c) 2018-2020 LunarG, Inc.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
from base_generator import ValueInfo, write
class BaseDecoderBodyGenerator():
"""Base class for generating decoder body code."""
def generate_feature(self):
"""Performs C++ code generation for the feature."""
platform_type = 'Vulkan'
if self.is_dx12_class():
platform_type = 'Dx12'
first = True
for cmd in self.get_filtered_cmd_names():
self.cmd_names.append(cmd)
info = self.feature_cmd_params[cmd]
return_type = info[0]
values = info[2]
cmddef = '' if first else '\n'
cmddef += 'size_t {}Decoder::Decode_{}(const ApiCallInfo& call_info, const uint8_t* parameter_buffer, size_t buffer_size)\n'.format(
platform_type, cmd
)
cmddef += '{\n'
cmddef += ' size_t bytes_read = 0;\n'
cmddef += '\n'
cmddef += self.make_cmd_body(return_type, cmd, values)
cmddef += '\n'
cmddef += ' return bytes_read;\n'
cmddef += '}'
write(cmddef, file=self.outFile)
first = False
def make_cmd_body(self, return_type, name, values, dx12_method=False):
"""Generate C++ code for the decoder method body."""
body = ''
arg_names = []
# Declarations for decoded types.
for value in values:
decode_type = self.make_decoded_param_type(value)
body += ' {} {};\n'.format(decode_type, value.name)
if decode_type == 'Decoded_{}'.format(value.base_type):
body += ' {} value_{};\n'.format(
value.base_type, value.name
)
body += ' {0}.decoded_value = &value_{0};\n'.format(
value.name
)
if 'Decoder' in decode_type:
arg_names.append('&{}'.format(value.name))
else:
arg_names.append(value.name)
# Vulkan return is very simple. Value is only for Dx12 Method.
dx12_return_value = None
dx12_return_decode_type = None
if return_type and return_type != 'void':
if dx12_method:
dx12_return_value = self.get_return_value_info(
return_type, name
)
dx12_return_decode_type = self.make_decoded_param_type(
dx12_return_value
)
body += ' {} return_value;\n'.format(
dx12_return_decode_type
)
if dx12_return_decode_type == 'Decoded_{}'.format(return_type):
body += ' {} value_returned;\n'.format(return_type)
body += ' return_value.decoded_value = &value_returned;\n'
else:
body += ' {} return_value;\n'.format(return_type)
# Blank line after declarations.
if values or return_type:
body += '\n'
# Decode() method calls for pointer decoder wrappers.
for value in values:
body += BaseDecoderBodyGenerator.make_decode_invocation(
self, value
)
if return_type and return_type != 'void':
if dx12_method:
body += BaseDecoderBodyGenerator.make_decode_invocation(
self, dx12_return_value
)
else:
body += BaseDecoderBodyGenerator.make_decode_invocation(
self, ValueInfo('return_value', return_type, return_type)
)
# Blank line after Decode() method invocations.
if values or return_type:
body += '\n'
# Make the argument list for the API call
arglist = ', '.join([arg_name for arg_name in arg_names])
if return_type and return_type != 'void':
if dx12_method and dx12_return_decode_type.find('Decoder') != -1:
arglist = ', '.join(['&return_value', arglist])
else:
arglist = ', '.join(['return_value', arglist])
if dx12_method:
arglist = 'object_id, ' + arglist
if arglist[-2:] == ', ':
arglist = arglist[:-2]
arglist = 'call_info, ' + arglist
body += ' for (auto consumer : GetConsumers())\n'
body += ' {\n'
body += ' consumer->Process_{}({});\n'.format(name, arglist)
body += ' }\n'
return body
def make_decode_invocation(self, value):
"""Generate parameter decode function/method invocation."""
buffer_args = '(parameter_buffer + bytes_read), (buffer_size - bytes_read)'
body = ''
is_struct = False
is_class = False
is_string = False
is_funcp = False
is_handle = False
type_name = self.make_invocation_type_name(value.base_type)
if self.is_struct(type_name):
is_struct = True
elif self.is_class(value):
is_class = True
elif type_name in ['String', 'WString']:
is_string = True
elif type_name == 'FunctionPtr':
is_funcp = True
elif type_name == 'Handle':
is_handle = True
# is_pointer will be False for static arrays.
if value.is_pointer or value.is_array:
if not is_class and type_name in self.EXTERNAL_OBJECT_TYPES and not value.is_array:
if value.pointer_count > 1:
# Pointer to a pointer to an unknown object type (void**), encoded as a pointer to a 64-bit integer ID.
body += ' bytes_read += {}.DecodeVoidPtr({});\n'.format(
value.name, buffer_args
)
else:
# Pointer to an unknown object type, encoded as a 64-bit integer ID.
body += ' bytes_read += ValueDecoder::DecodeAddress({}, &{});\n'.format(
buffer_args, value.name
)
else:
if is_struct or is_string or is_handle or (
is_class and value.pointer_count > 1
):
body += ' bytes_read += {}.Decode({});\n'.format(
value.name, buffer_args
)
elif is_class and value.pointer_count == 1:
body += ' bytes_read += ValueDecoder::DecodeHandleIdValue({}, &{});\n'.format(
buffer_args, value.name
)
else:
body += ' bytes_read += {}.Decode{}({});\n'.format(
value.name, type_name, buffer_args
)
else:
if is_struct:
body += ' bytes_read += DecodeStruct({}, &{});\n'.format(
buffer_args, value.name
)
elif is_funcp:
body += ' bytes_read += ValueDecoder::DecodeAddress({}, &{});\n'.format(
buffer_args, value.name
)
elif is_handle:
body += ' bytes_read += ValueDecoder::DecodeHandleIdValue({}, &{});\n'.format(
buffer_args, value.name
)
else:
body += ' bytes_read += ValueDecoder::Decode{}Value({}, &{});\n'.format(
type_name, buffer_args, value.name
)
return body
def generate_decode_cases(self):
"""Generate the VulkanDecoder::DecodeFunctionCall method."""
write(
'void VulkanDecoder::DecodeFunctionCall(format::ApiCallId call_id,',
file=self.outFile
)
write(
' const ApiCallInfo& call_info,',
file=self.outFile
)
write(
' const uint8_t* parameter_buffer,',
file=self.outFile
)
write(
' size_t buffer_size)',
file=self.outFile
)
write('{', file=self.outFile)
write(' switch(call_id)', file=self.outFile)
write(' {', file=self.outFile)
write(' default:', file=self.outFile)
write(
' VulkanDecoderBase::DecodeFunctionCall(call_id, call_info, parameter_buffer, buffer_size);',
file=self.outFile
)
write(' break;', file=self.outFile)
for cmd in self.cmd_names:
cmddef = ' case format::ApiCallId::ApiCall_{}:\n'.format(cmd)
cmddef += ' Decode_{}(call_info, parameter_buffer, buffer_size);\n'.format(
cmd
)
cmddef += ' break;'
write(cmddef, file=self.outFile)
write(' }', file=self.outFile)
write('}\n', file=self.outFile)
|
