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
34 #include "glthread_marshal.h"
37 #define COMPAT (ctx->API != API_OPENGL_CORE)
39 static inline int safe_mul(int a, int b)
41 if (a < 0 || b < 0) return -1;
42 if (a == 0 || b == 0) return 0;
43 if (a > INT_MAX / b) return -1;
54 print(' '*current_indent
+ str)
59 @contextlib.contextmanager
60 def indent(delta
= 3):
62 current_indent
+= delta
64 current_indent
-= delta
67 class PrintCode(gl_XML
.gl_print_base
):
69 super(PrintCode
, self
).__init
__()
71 self
.name
= 'gl_marshal.py'
72 self
.license
= license
.bsd_license_template
% (
73 'Copyright (C) 2012 Intel Corporation', 'INTEL CORPORATION')
75 def printRealHeader(self
):
78 def printRealFooter(self
):
81 def print_sync_call(self
, func
, unmarshal
= 0):
82 call
= 'CALL_{0}(ctx->CurrentServerDispatch, ({1}))'.format(
83 func
.name
, func
.get_called_parameter_string())
84 if func
.return_type
== 'void':
85 out('{0};'.format(call
))
86 if func
.marshal_call_after
and not unmarshal
:
87 out(func
.marshal_call_after
);
89 out('return {0};'.format(call
))
90 assert not func
.marshal_call_after
92 def print_sync_dispatch(self
, func
):
93 self
.print_sync_call(func
)
95 def print_sync_body(self
, func
):
96 out('/* {0}: marshalled synchronously */'.format(func
.name
))
97 out('{0} GLAPIENTRY'.format(func
.return_type
))
98 out('_mesa_marshal_{0}({1})'.format(func
.name
, func
.get_parameter_string()))
101 out('GET_CURRENT_CONTEXT(ctx);')
102 out('_mesa_glthread_finish_before(ctx, "{0}");'.format(func
.name
))
103 self
.print_sync_call(func
)
108 def print_async_dispatch(self
, func
):
109 out('cmd = _mesa_glthread_allocate_command(ctx, '
110 'DISPATCH_CMD_{0}, cmd_size);'.format(func
.name
))
111 for p
in func
.fixed_params
:
113 out('memcpy(cmd->{0}, {0}, {1});'.format(
114 p
.name
, p
.size_string()))
116 out('cmd->{0} = {0};'.format(p
.name
))
117 if func
.variable_params
:
118 out('char *variable_data = (char *) (cmd + 1);')
120 for p
in func
.variable_params
:
122 out('cmd->{0}_null = !{0};'.format(p
.name
))
123 out('if (!cmd->{0}_null) {{'.format(p
.name
))
125 out(('memcpy(variable_data, {0}, {0}_size);').format(p
.name
))
126 if i
< len(func
.variable_params
):
127 out('variable_data += {0}_size;'.format(p
.name
))
130 out(('memcpy(variable_data, {0}, {0}_size);').format(p
.name
))
131 if i
< len(func
.variable_params
):
132 out('variable_data += {0}_size;'.format(p
.name
))
135 if not func
.fixed_params
and not func
.variable_params
:
138 if func
.marshal_call_after
:
139 out(func
.marshal_call_after
);
141 # Uncomment this if you want to call _mesa_glthread_finish for debugging
142 #out('_mesa_glthread_finish(ctx);')
144 def print_async_struct(self
, func
):
145 out('struct marshal_cmd_{0}'.format(func
.name
))
148 out('struct marshal_cmd_base cmd_base;')
149 for p
in func
.fixed_params
:
151 out('{0} {1}[{2}];'.format(
152 p
.get_base_type_string(), p
.name
, p
.count
))
154 out('{0} {1};'.format(p
.type_string(), p
.name
))
156 for p
in func
.variable_params
:
158 out('bool {0}_null; /* If set, no data follows '
159 'for "{0}" */'.format(p
.name
))
161 for p
in func
.variable_params
:
162 if p
.count_scale
!= 1:
163 out(('/* Next {0} bytes are '
164 '{1} {2}[{3}][{4}] */').format(
165 p
.size_string(marshal
= 1), p
.get_base_type_string(),
166 p
.name
, p
.counter
, p
.count_scale
))
168 out(('/* Next {0} bytes are '
169 '{1} {2}[{3}] */').format(
170 p
.size_string(marshal
= 1), p
.get_base_type_string(),
174 def print_async_unmarshal(self
, func
):
176 out(('_mesa_unmarshal_{0}(struct gl_context *ctx, '
177 'const struct marshal_cmd_{0} *cmd)').format(func
.name
))
180 for p
in func
.fixed_params
:
182 p_decl
= '{0} * {1} = cmd->{1};'.format(
183 p
.get_base_type_string(), p
.name
)
185 p_decl
= '{0} {1} = cmd->{1};'.format(
186 p
.type_string(), p
.name
)
188 if not p_decl
.startswith('const '):
189 # Declare all local function variables as const, even if
190 # the original parameter is not const.
191 p_decl
= 'const ' + p_decl
195 if func
.variable_params
:
196 for p
in func
.variable_params
:
197 out('{0} * {1};'.format(
198 p
.get_base_type_string(), p
.name
))
199 out('const char *variable_data = (const char *) (cmd + 1);')
201 for p
in func
.variable_params
:
202 out('{0} = ({1} *) variable_data;'.format(
203 p
.name
, p
.get_base_type_string()))
206 out('if (cmd->{0}_null)'.format(p
.name
))
208 out('{0} = NULL;'.format(p
.name
))
209 if i
< len(func
.variable_params
):
212 out('variable_data += {0};'.format(p
.size_string(False, marshal
= 1)))
213 elif i
< len(func
.variable_params
):
214 out('variable_data += {0};'.format(p
.size_string(False, marshal
= 1)))
217 self
.print_sync_call(func
, unmarshal
= 1)
220 def validate_count_or_fallback(self
, func
):
221 # Check that any counts for variable-length arguments might be < 0, in
222 # which case the command alloc or the memcpy would blow up before we
223 # get to the validation in Mesa core.
225 for p
in func
.parameters
:
226 if p
.is_variable_length():
227 list.append('{0}_size < 0'.format(p
.name
))
228 list.append('({0}_size > 0 && !{0})'.format(p
.name
))
233 list.append('(unsigned)cmd_size > MARSHAL_MAX_CMD_SIZE')
235 out('if (unlikely({0})) {{'.format(' || '.join(list)))
237 out('_mesa_glthread_finish_before(ctx, "{0}");'.format(func
.name
))
238 self
.print_sync_dispatch(func
)
242 def print_async_marshal(self
, func
):
243 out('void GLAPIENTRY')
244 out('_mesa_marshal_{0}({1})'.format(
245 func
.name
, func
.get_parameter_string()))
248 out('GET_CURRENT_CONTEXT(ctx);')
249 for p
in func
.variable_params
:
250 out('int {0}_size = {1};'.format(p
.name
, p
.size_string(marshal
= 1)))
252 struct
= 'struct marshal_cmd_{0}'.format(func
.name
)
253 size_terms
= ['sizeof({0})'.format(struct
)]
254 for p
in func
.variable_params
:
256 size_terms
.append('({0} ? {0}_size : 0)'.format(p
.name
))
258 size_terms
.append('{0}_size'.format(p
.name
))
259 out('int cmd_size = {0};'.format(' + '.join(size_terms
)))
260 out('{0} *cmd;'.format(struct
))
262 self
.validate_count_or_fallback(func
)
264 if func
.marshal_sync
:
265 out('if ({0}) {{'.format(func
.marshal_sync
))
267 out('_mesa_glthread_finish_before(ctx, "{0}");'.format(func
.name
))
268 self
.print_sync_dispatch(func
)
273 self
.print_async_dispatch(func
)
276 def print_async_body(self
, func
):
277 out('/* {0}: marshalled asynchronously */'.format(func
.name
))
278 self
.print_async_struct(func
)
279 self
.print_async_unmarshal(func
)
280 self
.print_async_marshal(func
)
284 def print_unmarshal_dispatch_cmd(self
, api
):
285 out('const _mesa_unmarshal_func _mesa_unmarshal_dispatch[NUM_DISPATCH_CMD] = {')
287 for func
in api
.functionIterateAll():
288 flavor
= func
.marshal_flavor()
289 if flavor
in ('skip', 'sync'):
291 out('[DISPATCH_CMD_{0}] = (_mesa_unmarshal_func)_mesa_unmarshal_{0},'.format(func
.name
))
296 def print_create_marshal_table(self
, api
):
297 out('/* _mesa_create_marshal_table takes a long time to compile with -O2 */')
298 out('#ifdef __GNUC__')
299 out('__attribute__((optimize("O1")))')
301 out('struct _glapi_table *')
302 out('_mesa_create_marshal_table(const struct gl_context *ctx)')
305 out('struct _glapi_table *table;')
307 out('table = _mesa_alloc_dispatch_table();')
308 out('if (table == NULL)')
312 for func
in api
.functionIterateAll():
313 if func
.marshal_flavor() == 'skip':
315 # Don't use the SET_* functions, because they increase compile time
316 # by 20 seconds (on Ryzen 1700X).
317 out('if (_gloffset_{0} >= 0)'.format(func
.name
))
318 out(' ((_glapi_proc *)(table))[_gloffset_{0}] = (_glapi_proc)_mesa_marshal_{0};'
326 def printBody(self
, api
):
328 for func
in api
.functionIterateAll():
329 flavor
= func
.marshal_flavor()
330 if flavor
in ('skip', 'custom'):
332 elif flavor
== 'async':
333 self
.print_async_body(func
)
334 async_funcs
.append(func
)
335 elif flavor
== 'sync':
336 self
.print_sync_body(func
)
337 self
.print_unmarshal_dispatch_cmd(api
)
338 self
.print_create_marshal_table(api
)
342 print('Usage: %s [-f input_file_name]' % sys
.argv
[0])
346 if __name__
== '__main__':
347 file_name
= 'gl_API.xml'
350 (args
, trail
) = getopt
.getopt(sys
.argv
[1:], 'm:f:')
354 for (arg
,val
) in args
:
358 printer
= PrintCode()
360 api
= gl_XML
.parse_GL_API(file_name
, marshal_XML
.marshal_item_factory())