mapi: Fix a couple of warning in generated code
[mesa.git] / src / mapi / glapi / gen / gl_marshal.py
1
2 # Copyright (C) 2012 Intel Corporation
3 #
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:
10 #
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
13 # Software.
14 #
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
21 # IN THE SOFTWARE.
22
23 from __future__ import print_function
24
25 import contextlib
26 import getopt
27 import gl_XML
28 import license
29 import marshal_XML
30 import sys
31
32 header = """
33 #include "api_exec.h"
34 #include "glthread_marshal.h"
35 #include "bufferobj.h"
36 #include "dispatch.h"
37
38 #define COMPAT (ctx->API != API_OPENGL_CORE)
39
40 UNUSED static inline int safe_mul(int a, int b)
41 {
42 if (a < 0 || b < 0) return -1;
43 if (a == 0 || b == 0) return 0;
44 if (a > INT_MAX / b) return -1;
45 return a * b;
46 }
47 """
48
49
50 file_index = 0
51 file_count = 1
52 current_indent = 0
53
54
55 def out(str):
56 if str:
57 print(' '*current_indent + str)
58 else:
59 print('')
60
61
62 @contextlib.contextmanager
63 def indent(delta = 3):
64 global current_indent
65 current_indent += delta
66 yield
67 current_indent -= delta
68
69
70 class PrintCode(gl_XML.gl_print_base):
71 def __init__(self):
72 super(PrintCode, self).__init__()
73
74 self.name = 'gl_marshal.py'
75 self.license = license.bsd_license_template % (
76 'Copyright (C) 2012 Intel Corporation', 'INTEL CORPORATION')
77
78 def printRealHeader(self):
79 print(header)
80
81 def printRealFooter(self):
82 pass
83
84 def print_sync_call(self, func, unmarshal = 0):
85 call = 'CALL_{0}(ctx->CurrentServerDispatch, ({1}))'.format(
86 func.name, func.get_called_parameter_string())
87 if func.return_type == 'void':
88 out('{0};'.format(call))
89 if func.marshal_call_after and not unmarshal:
90 out(func.marshal_call_after);
91 else:
92 out('return {0};'.format(call))
93 assert not func.marshal_call_after
94
95 def print_sync_dispatch(self, func):
96 self.print_sync_call(func)
97
98 def print_sync_body(self, func):
99 out('/* {0}: marshalled synchronously */'.format(func.name))
100 out('{0} GLAPIENTRY'.format(func.return_type))
101 out('_mesa_marshal_{0}({1})'.format(func.name, func.get_parameter_string()))
102 out('{')
103 with indent():
104 out('GET_CURRENT_CONTEXT(ctx);')
105 out('_mesa_glthread_finish_before(ctx, "{0}");'.format(func.name))
106 self.print_sync_call(func)
107 out('}')
108 out('')
109 out('')
110
111 def print_async_dispatch(self, func):
112 out('cmd = _mesa_glthread_allocate_command(ctx, '
113 'DISPATCH_CMD_{0}, cmd_size);'.format(func.name))
114 for p in func.fixed_params:
115 if p.count:
116 out('memcpy(cmd->{0}, {0}, {1});'.format(
117 p.name, p.size_string()))
118 else:
119 out('cmd->{0} = {0};'.format(p.name))
120 if func.variable_params:
121 out('char *variable_data = (char *) (cmd + 1);')
122 i = 1
123 for p in func.variable_params:
124 if p.img_null_flag:
125 out('cmd->{0}_null = !{0};'.format(p.name))
126 out('if (!cmd->{0}_null) {{'.format(p.name))
127 with indent():
128 out(('memcpy(variable_data, {0}, {0}_size);').format(p.name))
129 if i < len(func.variable_params):
130 out('variable_data += {0}_size;'.format(p.name))
131 out('}')
132 else:
133 out(('memcpy(variable_data, {0}, {0}_size);').format(p.name))
134 if i < len(func.variable_params):
135 out('variable_data += {0}_size;'.format(p.name))
136 i += 1
137
138 if not func.fixed_params and not func.variable_params:
139 out('(void) cmd;')
140
141 if func.marshal_call_after:
142 out(func.marshal_call_after);
143
144 # Uncomment this if you want to call _mesa_glthread_finish for debugging
145 #out('_mesa_glthread_finish(ctx);')
146
147 def get_type_size(self, str):
148 if str.find('*') != -1:
149 return 8;
150
151 mapping = {
152 'GLboolean': 1,
153 'GLbyte': 1,
154 'GLubyte': 1,
155 'GLshort': 2,
156 'GLushort': 2,
157 'GLenum': 4,
158 'GLint': 4,
159 'GLuint': 4,
160 'GLbitfield': 4,
161 'GLsizei': 4,
162 'GLfloat': 4,
163 'GLclampf': 4,
164 'GLfixed': 4,
165 'GLclampx': 4,
166 'GLhandleARB': 4,
167 'int': 4,
168 'float': 4,
169 'GLdouble': 8,
170 'GLclampd': 8,
171 'GLintptr': 8,
172 'GLsizeiptr': 8,
173 'GLint64': 8,
174 'GLuint64': 8,
175 'GLuint64EXT': 8,
176 'GLsync': 8,
177 }
178 val = mapping.get(str, 9999)
179 if val == 9999:
180 print('Unhandled type in gl_marshal.py.get_type_size: ' + str, file=sys.stderr)
181 return val
182
183 def print_async_struct(self, func):
184 out('struct marshal_cmd_{0}'.format(func.name))
185 out('{')
186 with indent():
187 out('struct marshal_cmd_base cmd_base;')
188
189 # Sort the parameters according to their size to pack the structure optimally
190 for p in sorted(func.fixed_params, key=lambda p: self.get_type_size(p.type_string())):
191 if p.count:
192 out('{0} {1}[{2}];'.format(
193 p.get_base_type_string(), p.name, p.count))
194 else:
195 out('{0} {1};'.format(p.type_string(), p.name))
196
197 for p in func.variable_params:
198 if p.img_null_flag:
199 out('bool {0}_null; /* If set, no data follows '
200 'for "{0}" */'.format(p.name))
201
202 for p in func.variable_params:
203 if p.count_scale != 1:
204 out(('/* Next {0} bytes are '
205 '{1} {2}[{3}][{4}] */').format(
206 p.size_string(marshal = 1), p.get_base_type_string(),
207 p.name, p.counter, p.count_scale))
208 else:
209 out(('/* Next {0} bytes are '
210 '{1} {2}[{3}] */').format(
211 p.size_string(marshal = 1), p.get_base_type_string(),
212 p.name, p.counter))
213 out('};')
214
215 def print_async_unmarshal(self, func):
216 out('void')
217 out(('_mesa_unmarshal_{0}(struct gl_context *ctx, '
218 'const struct marshal_cmd_{0} *cmd)').format(func.name))
219 out('{')
220 with indent():
221 for p in func.fixed_params:
222 if p.count:
223 p_decl = '{0} * {1} = cmd->{1};'.format(
224 p.get_base_type_string(), p.name)
225 else:
226 p_decl = '{0} {1} = cmd->{1};'.format(
227 p.type_string(), p.name)
228
229 if not p_decl.startswith('const '):
230 # Declare all local function variables as const, even if
231 # the original parameter is not const.
232 p_decl = 'const ' + p_decl
233
234 out(p_decl)
235
236 if func.variable_params:
237 for p in func.variable_params:
238 out('{0} * {1};'.format(
239 p.get_base_type_string(), p.name))
240 out('const char *variable_data = (const char *) (cmd + 1);')
241 i = 1
242 for p in func.variable_params:
243 out('{0} = ({1} *) variable_data;'.format(
244 p.name, p.get_base_type_string()))
245
246 if p.img_null_flag:
247 out('if (cmd->{0}_null)'.format(p.name))
248 with indent():
249 out('{0} = NULL;'.format(p.name))
250 if i < len(func.variable_params):
251 out('else')
252 with indent():
253 out('variable_data += {0};'.format(p.size_string(False, marshal = 1)))
254 elif i < len(func.variable_params):
255 out('variable_data += {0};'.format(p.size_string(False, marshal = 1)))
256 i += 1
257
258 self.print_sync_call(func, unmarshal = 1)
259 out('}')
260
261 def validate_count_or_fallback(self, func):
262 # Check that any counts for variable-length arguments might be < 0, in
263 # which case the command alloc or the memcpy would blow up before we
264 # get to the validation in Mesa core.
265 list = []
266 for p in func.parameters:
267 if p.is_variable_length():
268 list.append('{0}_size < 0'.format(p.name))
269 list.append('({0}_size > 0 && !{0})'.format(p.name))
270
271 if len(list) == 0:
272 return
273
274 list.append('(unsigned)cmd_size > MARSHAL_MAX_CMD_SIZE')
275
276 out('if (unlikely({0})) {{'.format(' || '.join(list)))
277 with indent():
278 out('_mesa_glthread_finish_before(ctx, "{0}");'.format(func.name))
279 self.print_sync_dispatch(func)
280 out('return;')
281 out('}')
282
283 def print_async_marshal(self, func):
284 out('void GLAPIENTRY')
285 out('_mesa_marshal_{0}({1})'.format(
286 func.name, func.get_parameter_string()))
287 out('{')
288 with indent():
289 out('GET_CURRENT_CONTEXT(ctx);')
290 for p in func.variable_params:
291 out('int {0}_size = {1};'.format(p.name, p.size_string(marshal = 1)))
292
293 struct = 'struct marshal_cmd_{0}'.format(func.name)
294 size_terms = ['sizeof({0})'.format(struct)]
295 for p in func.variable_params:
296 if p.img_null_flag:
297 size_terms.append('({0} ? {0}_size : 0)'.format(p.name))
298 else:
299 size_terms.append('{0}_size'.format(p.name))
300 out('int cmd_size = {0};'.format(' + '.join(size_terms)))
301 out('{0} *cmd;'.format(struct))
302
303 self.validate_count_or_fallback(func)
304
305 if func.marshal_sync:
306 out('if ({0}) {{'.format(func.marshal_sync))
307 with indent():
308 out('_mesa_glthread_finish_before(ctx, "{0}");'.format(func.name))
309 self.print_sync_dispatch(func)
310 out('return;')
311 out('}')
312
313 with indent():
314 self.print_async_dispatch(func)
315 out('}')
316
317 def print_async_body(self, func):
318 out('/* {0}: marshalled asynchronously */'.format(func.name))
319 self.print_async_struct(func)
320 self.print_async_unmarshal(func)
321 self.print_async_marshal(func)
322 out('')
323 out('')
324
325 def print_unmarshal_dispatch_cmd(self, api):
326 out('const _mesa_unmarshal_func _mesa_unmarshal_dispatch[NUM_DISPATCH_CMD] = {')
327 with indent():
328 for func in api.functionIterateAll():
329 flavor = func.marshal_flavor()
330 if flavor in ('skip', 'sync'):
331 continue
332 out('[DISPATCH_CMD_{0}] = (_mesa_unmarshal_func)_mesa_unmarshal_{0},'.format(func.name))
333 out('};')
334 out('')
335 out('')
336
337 def print_create_marshal_table(self, api):
338 out('/* _mesa_create_marshal_table takes a long time to compile with -O2 */')
339 out('#if defined(__GNUC__) && !defined(__clang__)')
340 out('__attribute__((optimize("O1")))')
341 out('#endif')
342 out('struct _glapi_table *')
343 out('_mesa_create_marshal_table(const struct gl_context *ctx)')
344 out('{')
345 with indent():
346 out('struct _glapi_table *table;')
347 out('')
348 out('table = _mesa_alloc_dispatch_table();')
349 out('if (table == NULL)')
350 with indent():
351 out('return NULL;')
352 out('')
353 for func in api.functionIterateAll():
354 if func.marshal_flavor() == 'skip':
355 continue
356 # Don't use the SET_* functions, because they increase compile time
357 # by 20 seconds (on Ryzen 1700X).
358 out('if (_gloffset_{0} >= 0)'.format(func.name))
359 out(' ((_glapi_proc *)(table))[_gloffset_{0}] = (_glapi_proc)_mesa_marshal_{0};'
360 .format(func.name))
361 out('')
362 out('return table;')
363 out('}')
364 out('')
365 out('')
366
367 def printBody(self, api):
368 # The first file only contains the dispatch tables
369 if file_index == 0:
370 self.print_unmarshal_dispatch_cmd(api)
371 self.print_create_marshal_table(api)
372 return
373
374 # The remaining files contain the marshal and unmarshal functions
375 func_per_file = (len(api.functionIterateAll()) // (file_count - 1)) + 1
376 i = -1
377 for func in api.functionIterateAll():
378 i += 1
379 if i // func_per_file != (file_index - 1):
380 continue
381
382 flavor = func.marshal_flavor()
383 if flavor in ('skip', 'custom'):
384 continue
385 elif flavor == 'async':
386 self.print_async_body(func)
387 elif flavor == 'sync':
388 self.print_sync_body(func)
389
390
391 def show_usage():
392 print('Usage: %s [-f input_file_name]' % sys.argv[0])
393 sys.exit(1)
394
395
396 if __name__ == '__main__':
397 file_name = 'gl_API.xml'
398
399 try:
400 (args, trail) = getopt.getopt(sys.argv[1:], 'm:f:i:n:')
401 except Exception:
402 show_usage()
403
404 for (arg,val) in args:
405 if arg == '-f':
406 file_name = val
407 elif arg == '-i':
408 file_index = int(val)
409 elif arg == '-n':
410 file_count = int(val)
411
412 assert file_index < file_count
413 printer = PrintCode()
414
415 api = gl_XML.parse_GL_API(file_name, marshal_XML.marshal_item_factory())
416 printer.Print(api)