2 # Copyright (C) 2012 Intel Corporation
4 # Permission is hereby granted, free of charge, to any person obtaining a
5 # copy of this software and associated documentation files (the "Software"),
6 # to deal in the Software without restriction, including without limitation
7 # the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 # and/or sell copies of the Software, and to permit persons to whom the
9 # Software is furnished to do so, subject to the following conditions:
11 # The above copyright notice and this permission notice (including the next
12 # paragraph) shall be included in all copies or substantial portions of the
15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 # THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
23 from __future__
import print_function
39 #define COMPAT (ctx->API != API_OPENGL_CORE)
48 print(' '*current_indent
+ str)
53 @contextlib.contextmanager
54 def indent(delta
= 3):
56 current_indent
+= delta
58 current_indent
-= delta
61 class PrintCode(gl_XML
.gl_print_base
):
63 super(PrintCode
, self
).__init
__()
65 self
.name
= 'gl_marshal.py'
66 self
.license
= license
.bsd_license_template
% (
67 'Copyright (C) 2012 Intel Corporation', 'INTEL CORPORATION')
69 def printRealHeader(self
):
71 print('static inline int safe_mul(int a, int b)')
73 print(' if (a < 0 || b < 0) return -1;')
74 print(' if (a == 0 || b == 0) return 0;')
75 print(' if (a > INT_MAX / b) return -1;')
76 print(' return a * b;')
80 def printRealFooter(self
):
83 def print_sync_call(self
, func
, unmarshal
= 0):
84 call
= 'CALL_{0}(ctx->CurrentServerDispatch, ({1}))'.format(
85 func
.name
, func
.get_called_parameter_string())
86 if func
.return_type
== 'void':
87 out('{0};'.format(call
))
88 if func
.marshal_call_after
and not unmarshal
:
89 out(func
.marshal_call_after
);
91 out('return {0};'.format(call
))
92 assert not func
.marshal_call_after
94 def print_sync_dispatch(self
, func
):
95 self
.print_sync_call(func
)
97 def print_sync_body(self
, func
):
98 out('/* {0}: marshalled synchronously */'.format(func
.name
))
99 out('static {0} GLAPIENTRY'.format(func
.return_type
))
100 out('_mesa_marshal_{0}({1})'.format(func
.name
, func
.get_parameter_string()))
103 out('GET_CURRENT_CONTEXT(ctx);')
104 out('_mesa_glthread_finish_before(ctx, "{0}");'.format(func
.name
))
105 self
.print_sync_call(func
)
110 def print_async_dispatch(self
, func
):
111 out('cmd = _mesa_glthread_allocate_command(ctx, '
112 'DISPATCH_CMD_{0}, cmd_size);'.format(func
.name
))
113 for p
in func
.fixed_params
:
115 out('memcpy(cmd->{0}, {0}, {1});'.format(
116 p
.name
, p
.size_string()))
118 out('cmd->{0} = {0};'.format(p
.name
))
119 if func
.variable_params
:
120 out('char *variable_data = (char *) (cmd + 1);')
122 for p
in func
.variable_params
:
124 out('cmd->{0}_null = !{0};'.format(p
.name
))
125 out('if (!cmd->{0}_null) {{'.format(p
.name
))
127 out(('memcpy(variable_data, {0}, {0}_size);').format(p
.name
))
128 if i
< len(func
.variable_params
):
129 out('variable_data += {0}_size;'.format(p
.name
))
132 out(('memcpy(variable_data, {0}, {0}_size);').format(p
.name
))
133 if i
< len(func
.variable_params
):
134 out('variable_data += {0}_size;'.format(p
.name
))
137 if not func
.fixed_params
and not func
.variable_params
:
140 if func
.marshal_call_after
:
141 out(func
.marshal_call_after
);
143 # Uncomment this if you want to call _mesa_glthread_finish for debugging
144 #out('_mesa_glthread_finish(ctx);')
146 def print_async_struct(self
, func
):
147 out('struct marshal_cmd_{0}'.format(func
.name
))
150 out('struct marshal_cmd_base cmd_base;')
151 for p
in func
.fixed_params
:
153 out('{0} {1}[{2}];'.format(
154 p
.get_base_type_string(), p
.name
, p
.count
))
156 out('{0} {1};'.format(p
.type_string(), p
.name
))
158 for p
in func
.variable_params
:
160 out('bool {0}_null; /* If set, no data follows '
161 'for "{0}" */'.format(p
.name
))
163 for p
in func
.variable_params
:
164 if p
.count_scale
!= 1:
165 out(('/* Next {0} bytes are '
166 '{1} {2}[{3}][{4}] */').format(
167 p
.size_string(marshal
= 1), p
.get_base_type_string(),
168 p
.name
, p
.counter
, p
.count_scale
))
170 out(('/* Next {0} bytes are '
171 '{1} {2}[{3}] */').format(
172 p
.size_string(marshal
= 1), p
.get_base_type_string(),
176 def print_async_unmarshal(self
, func
):
177 out('static inline void')
178 out(('_mesa_unmarshal_{0}(struct gl_context *ctx, '
179 'const struct marshal_cmd_{0} *cmd)').format(func
.name
))
182 for p
in func
.fixed_params
:
184 p_decl
= '{0} * {1} = cmd->{1};'.format(
185 p
.get_base_type_string(), p
.name
)
187 p_decl
= '{0} {1} = cmd->{1};'.format(
188 p
.type_string(), p
.name
)
190 if not p_decl
.startswith('const '):
191 # Declare all local function variables as const, even if
192 # the original parameter is not const.
193 p_decl
= 'const ' + p_decl
197 if func
.variable_params
:
198 for p
in func
.variable_params
:
199 out('{0} * {1};'.format(
200 p
.get_base_type_string(), p
.name
))
201 out('const char *variable_data = (const char *) (cmd + 1);')
203 for p
in func
.variable_params
:
204 out('{0} = ({1} *) variable_data;'.format(
205 p
.name
, p
.get_base_type_string()))
208 out('if (cmd->{0}_null)'.format(p
.name
))
210 out('{0} = NULL;'.format(p
.name
))
211 if i
< len(func
.variable_params
):
214 out('variable_data += {0};'.format(p
.size_string(False, marshal
= 1)))
215 elif i
< len(func
.variable_params
):
216 out('variable_data += {0};'.format(p
.size_string(False, marshal
= 1)))
219 self
.print_sync_call(func
, unmarshal
= 1)
222 def validate_count_or_fallback(self
, func
):
223 # Check that any counts for variable-length arguments might be < 0, in
224 # which case the command alloc or the memcpy would blow up before we
225 # get to the validation in Mesa core.
227 for p
in func
.parameters
:
228 if p
.is_variable_length():
229 list.append('{0}_size < 0'.format(p
.name
))
230 list.append('({0}_size > 0 && !{0})'.format(p
.name
))
235 list.append('(unsigned)cmd_size > MARSHAL_MAX_CMD_SIZE')
237 out('if (unlikely({0})) {{'.format(' || '.join(list)))
239 out('_mesa_glthread_finish_before(ctx, "{0}");'.format(func
.name
))
240 self
.print_sync_dispatch(func
)
244 def print_async_marshal(self
, func
):
245 out('static void GLAPIENTRY')
246 out('_mesa_marshal_{0}({1})'.format(
247 func
.name
, func
.get_parameter_string()))
250 out('GET_CURRENT_CONTEXT(ctx);')
251 for p
in func
.variable_params
:
252 out('int {0}_size = {1};'.format(p
.name
, p
.size_string(marshal
= 1)))
254 struct
= 'struct marshal_cmd_{0}'.format(func
.name
)
255 size_terms
= ['sizeof({0})'.format(struct
)]
256 for p
in func
.variable_params
:
258 size_terms
.append('({0} ? {0}_size : 0)'.format(p
.name
))
260 size_terms
.append('{0}_size'.format(p
.name
))
261 out('int cmd_size = {0};'.format(' + '.join(size_terms
)))
262 out('{0} *cmd;'.format(struct
))
264 out('debug_print_marshal("{0}");'.format(func
.name
))
266 self
.validate_count_or_fallback(func
)
268 if func
.marshal_fail
:
269 out('if ({0}) {{'.format(func
.marshal_fail
))
271 out('_mesa_glthread_disable(ctx, "{0}");'.format(func
.name
))
272 self
.print_sync_dispatch(func
)
276 if func
.marshal_sync
:
277 out('if ({0}) {{'.format(func
.marshal_sync
))
279 out('_mesa_glthread_finish_before(ctx, "{0}");'.format(func
.name
))
280 self
.print_sync_dispatch(func
)
285 self
.print_async_dispatch(func
)
288 def print_async_body(self
, func
):
289 out('/* {0}: marshalled asynchronously */'.format(func
.name
))
290 self
.print_async_struct(func
)
291 self
.print_async_unmarshal(func
)
292 self
.print_async_marshal(func
)
296 def print_unmarshal_dispatch_cmd(self
, api
):
297 out('const _mesa_unmarshal_func _mesa_unmarshal_dispatch[NUM_DISPATCH_CMD] = {')
299 for func
in api
.functionIterateAll():
300 flavor
= func
.marshal_flavor()
301 if flavor
in ('skip', 'sync'):
303 out('[DISPATCH_CMD_{0}] = (_mesa_unmarshal_func)_mesa_unmarshal_{0},'.format(func
.name
))
308 def print_create_marshal_table(self
, api
):
309 out('struct _glapi_table *')
310 out('_mesa_create_marshal_table(const struct gl_context *ctx)')
313 out('struct _glapi_table *table;')
315 out('table = _mesa_alloc_dispatch_table();')
316 out('if (table == NULL)')
320 for func
in api
.functionIterateAll():
321 if func
.marshal_flavor() == 'skip':
323 out('SET_{0}(table, _mesa_marshal_{0});'.format(func
.name
))
330 def printBody(self
, api
):
332 for func
in api
.functionIterateAll():
333 flavor
= func
.marshal_flavor()
334 if flavor
in ('skip', 'custom'):
336 elif flavor
== 'async':
337 self
.print_async_body(func
)
338 async_funcs
.append(func
)
339 elif flavor
== 'sync':
340 self
.print_sync_body(func
)
341 self
.print_unmarshal_dispatch_cmd(api
)
342 self
.print_create_marshal_table(api
)
346 print('Usage: %s [-f input_file_name]' % sys
.argv
[0])
350 if __name__
== '__main__':
351 file_name
= 'gl_API.xml'
354 (args
, trail
) = getopt
.getopt(sys
.argv
[1:], 'm:f:')
358 for (arg
,val
) in args
:
362 printer
= PrintCode()
364 api
= gl_XML
.parse_GL_API(file_name
, marshal_XML
.marshal_item_factory())