2 # Mesa 3-D graphics library
4 # Copyright (C) 2010 LunarG Inc.
6 # Permission is hereby granted, free of charge, to any person obtaining a
7 # copy of this software and associated documentation files (the "Software"),
8 # to deal in the Software without restriction, including without limitation
9 # the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 # and/or sell copies of the Software, and to permit persons to whom the
11 # Software is furnished to do so, subject to the following conditions:
13 # The above copyright notice and this permission notice shall be included
14 # in all copies or substantial portions of the Software.
16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 # THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 # DEALINGS IN THE SOFTWARE.
25 # Chia-I Wu <olv@lunarg.com>
27 from __future__
import print_function
30 # make it possible to import glapi
32 GLAPI
= os
.path
.join(".", os
.path
.dirname(sys
.argv
[0]), "glapi/gen")
33 sys
.path
.append(GLAPI
)
35 from operator
import attrgetter
37 from optparse
import OptionParser
42 # number of dynamic entries
43 ABI_NUM_DYNAMIC_ENTRIES
= 256
45 class ABIEntry(object):
46 """Represent an ABI entry."""
48 _match_c_param
= re
.compile(
49 '^(?P<type>[\w\s*]+?)(?P<name>\w+)(\[(?P<array>\d+)\])?$')
51 def __init__(self
, cols
, attrs
, xml_data
= None):
54 self
.slot
= attrs
['slot']
55 self
.hidden
= attrs
['hidden']
56 self
.alias
= attrs
['alias']
57 self
.handcode
= attrs
['handcode']
58 self
.xml_data
= xml_data
60 def c_prototype(self
):
61 return '%s %s(%s)' % (self
.c_return(), self
.name
, self
.c_params())
71 """Return the parameter list used in the entry prototype."""
73 for t
, n
, a
in self
.params
:
74 sep
= '' if t
.endswith('*') else ' '
75 arr
= '[%d]' % a
if a
else ''
76 c_params
.append(t
+ sep
+ n
+ arr
)
78 c_params
.append('void')
80 return ", ".join(c_params
)
83 """Return the argument list used in the entry invocation."""
85 for t
, n
, a
in self
.params
:
88 return ", ".join(c_args
)
90 def _parse(self
, cols
):
100 elif len(cols
) == 1 and cols
[0] == 'void':
104 params
.append(self
._parse
_param
(val
))
110 def _parse_param(self
, c_param
):
111 m
= self
._match
_c
_param
.match(c_param
)
113 raise Exception('unrecognized param ' + c_param
)
115 c_type
= m
.group('type').strip()
116 c_name
= m
.group('name')
117 c_array
= m
.group('array')
118 c_array
= int(c_array
) if c_array
else 0
120 return (c_type
, c_name
, c_array
)
123 return self
.c_prototype()
125 def __lt__(self
, other
):
126 # compare slot, alias, and then name
127 if self
.slot
== other
.slot
:
130 elif not other
.alias
:
133 return self
.name
< other
.name
135 return self
.slot
< other
.slot
138 def abi_parse_xml(xml
):
139 """Parse a GLAPI XML file for ABI entries."""
140 api
= gl_XML
.parse_GL_API(xml
, glX_XML
.glx_item_factory())
143 for func
in api
.functionIterateByOffset():
144 # make sure func.name appear first
145 entry_points
= func
.entry_points
[:]
146 entry_points
.remove(func
.name
)
147 entry_points
.insert(0, func
.name
)
149 for name
in entry_points
:
152 'hidden': not func
.is_static_entry_point(name
),
153 'alias': None if name
== func
.name
else func
.name
,
154 'handcode': bool(func
.has_different_protocol(name
)),
160 alias
= entry_dict
[attrs
['alias']]
162 raise Exception('failed to alias %s' % attrs
['alias'])
164 raise Exception('recursive alias %s' % ent
.name
)
165 attrs
['alias'] = alias
166 if attrs
['handcode']:
167 attrs
['handcode'] = func
.static_glx_name(name
)
169 attrs
['handcode'] = None
171 if name
in entry_dict
:
172 raise Exception('%s is duplicated' % (name
))
175 cols
.append(func
.return_type
)
177 params
= func
.get_parameter_string(name
)
178 cols
.extend([p
.strip() for p
in params
.split(',')])
180 ent
= ABIEntry(cols
, attrs
, func
)
181 entry_dict
[ent
.name
] = ent
183 entries
= sorted(entry_dict
.values())
187 def abi_parse_line(line
):
188 cols
= [col
.strip() for col
in line
.split(',')]
197 # extract attributes from the first column
198 vals
= cols
[0].split(':')
201 if val
.startswith('slot='):
202 attrs
['slot'] = int(val
[5:])
203 elif val
== 'hidden':
204 attrs
['hidden'] = True
205 elif val
.startswith('alias='):
206 attrs
['alias'] = val
[6:]
207 elif val
.startswith('handcode='):
208 attrs
['handcode'] = val
[9:]
212 raise Exception('unknown attribute %s' % val
)
217 def abi_parse(filename
):
218 """Parse a CSV file for ABI entries."""
219 fp
= open(filename
) if filename
!= '-' else sys
.stdin
220 lines
= [line
.strip() for line
in fp
.readlines()
221 if not line
.startswith('#') and line
.strip()]
226 attrs
, cols
= abi_parse_line(line
)
228 # post-process attributes
231 alias
= entry_dict
[attrs
['alias']]
233 raise Exception('failed to alias %s' % attrs
['alias'])
235 raise Exception('recursive alias %s' % ent
.name
)
237 attrs
['alias'] = alias
242 if attrs
['slot'] < 0:
244 elif attrs
['slot'] != slot
:
245 raise Exception('invalid slot in %s' % (line
))
247 ent
= ABIEntry(cols
, attrs
)
248 if ent
.name
in entry_dict
:
249 raise Exception('%s is duplicated' % (ent
.name
))
250 entry_dict
[ent
.name
] = ent
252 entries
= sorted(entry_dict
.values())
256 def abi_sanity_check(entries
):
261 last_slot
= entries
[-1].slot
263 for slot
in range(last_slot
+ 1):
264 if entries
[i
].slot
!= slot
:
265 raise Exception('entries are not ordered by slots')
267 raise Exception('first entry of slot %d aliases %s'
268 % (slot
, entries
[i
].alias
.name
))
270 while i
< len(entries
) and entries
[i
].slot
== slot
:
272 if not handcode
and ent
.handcode
:
273 handcode
= ent
.handcode
274 elif ent
.handcode
!= handcode
:
275 raise Exception('two aliases with handcode %s != %s',
276 ent
.handcode
, handcode
)
278 if ent
.name
in all_names
:
279 raise Exception('%s is duplicated' % (ent
.name
))
280 if ent
.alias
and ent
.alias
.name
not in all_names
:
281 raise Exception('failed to alias %s' % (ent
.alias
.name
))
282 all_names
.append(ent
.name
)
285 raise Exception('there are %d invalid entries' % (len(entries
) - 1))
287 class ABIPrinter(object):
290 def __init__(self
, entries
):
291 self
.entries
= entries
293 # sort entries by their names
294 self
.entries_sorted_by_names
= self
.entries
[:]
295 self
.entries_sorted_by_names
.sort(key
=attrgetter('name'))
297 self
.indent
= ' ' * 3
298 self
.noop_warn
= 'noop_warn'
299 self
.noop_generic
= 'noop_generic'
300 self
.current_get
= 'entry_current_get'
302 self
.api_defines
= []
303 self
.api_headers
= ['"KHR/khrplatform.h"']
304 self
.api_call
= 'KHRONOS_APICALL'
305 self
.api_entry
= 'KHRONOS_APIENTRY'
306 self
.api_attrs
= 'KHRONOS_APIATTRIBUTES'
310 self
.lib_need_table_size
= True
311 self
.lib_need_noop_array
= True
312 self
.lib_need_stubs
= True
313 self
.lib_need_all_entries
= True
314 self
.lib_need_non_hidden_entries
= False
317 return '/* This file is automatically generated by mapi_abi.py. Do not modify. */'
319 def c_public_includes(self
):
320 """Return includes of the client API headers."""
321 defines
= ['#define ' + d
for d
in self
.api_defines
]
322 includes
= ['#include ' + h
for h
in self
.api_headers
]
323 return "\n".join(defines
+ includes
)
325 def need_entry_point(self
, ent
):
326 """Return True if an entry point is needed for the entry."""
327 # non-handcode hidden aliases may share the entry they alias
328 use_alias
= (ent
.hidden
and ent
.alias
and not ent
.handcode
)
331 def c_public_declarations(self
, prefix
):
332 """Return the declarations of public entry points."""
334 for ent
in self
.entries
:
335 if not self
.need_entry_point(ent
):
337 export
= self
.api_call
if not ent
.hidden
else ''
338 decls
.append(self
._c
_decl
(ent
, prefix
, True, export
) + ';')
340 return "\n".join(decls
)
342 def c_mapi_table(self
):
343 """Return defines of the dispatch table size."""
344 num_static_entries
= self
.entries
[-1].slot
+ 1
345 return ('#define MAPI_TABLE_NUM_STATIC %d\n' + \
346 '#define MAPI_TABLE_NUM_DYNAMIC %d') % (
347 num_static_entries
, ABI_NUM_DYNAMIC_ENTRIES
)
349 def _c_function(self
, ent
, prefix
, mangle
=False, stringify
=False):
350 """Return the function name of an entry."""
352 True: { True: '%s_STR(%s)', False: '%s(%s)' },
353 False: { True: '"%s%s"', False: '%s%s' },
355 fmt
= formats
[prefix
.isupper()][stringify
]
357 if mangle
and ent
.hidden
:
358 name
= '_dispatch_stub_' + str(ent
.slot
)
359 return fmt
% (prefix
, name
)
361 def _c_function_call(self
, ent
, prefix
):
362 """Return the function name used for calling."""
364 # _c_function does not handle this case
365 formats
= { True: '%s(%s)', False: '%s%s' }
366 fmt
= formats
[prefix
.isupper()]
367 name
= fmt
% (prefix
, ent
.handcode
)
368 elif self
.need_entry_point(ent
):
369 name
= self
._c
_function
(ent
, prefix
, True)
371 name
= self
._c
_function
(ent
.alias
, prefix
, True)
374 def _c_decl(self
, ent
, prefix
, mangle
=False, export
=''):
375 """Return the C declaration for the entry."""
376 decl
= '%s %s %s(%s)' % (ent
.c_return(), self
.api_entry
,
377 self
._c
_function
(ent
, prefix
, mangle
), ent
.c_params())
379 decl
= export
+ ' ' + decl
381 decl
+= ' ' + self
.api_attrs
385 def _c_cast(self
, ent
):
386 """Return the C cast for the entry."""
387 cast
= '%s (%s *)(%s)' % (
388 ent
.c_return(), self
.api_entry
, ent
.c_params())
392 def c_public_dispatches(self
, prefix
, no_hidden
):
393 """Return the public dispatch functions."""
395 for ent
in self
.entries
:
396 if ent
.hidden
and no_hidden
:
399 if not self
.need_entry_point(ent
):
402 export
= self
.api_call
if not ent
.hidden
else ''
404 proto
= self
._c
_decl
(ent
, prefix
, True, export
)
405 cast
= self
._c
_cast
(ent
)
411 stmt1
+= 'const struct _glapi_table *_tbl = %s();' % (
414 stmt2
+= 'mapi_func _func = ((const mapi_func *) _tbl)[%d];' % (
417 stmt3
+= '%s((%s) _func)(%s);' % (ret
, cast
, ent
.c_args())
419 disp
= '%s\n{\n%s\n%s\n%s\n}' % (proto
, stmt1
, stmt2
, stmt3
)
422 disp
= '#if 0\n' + disp
+ '\n#endif'
424 dispatches
.append(disp
)
426 return '\n\n'.join(dispatches
)
428 def c_public_initializer(self
, prefix
):
429 """Return the initializer for public dispatch functions."""
431 for ent
in self
.entries
:
435 name
= '%s(mapi_func) %s' % (self
.indent
,
436 self
._c
_function
_call
(ent
, prefix
))
439 return ',\n'.join(names
)
441 def c_stub_string_pool(self
):
442 """Return the string pool for use by stubs."""
443 # sort entries by their names
444 sorted_entries
= self
.entries
[:]
445 sorted_entries
.sort(key
=attrgetter('name'))
450 for ent
in sorted_entries
:
452 pool
.append('%s' % (ent
.name
))
453 count
+= len(ent
.name
) + 1
455 pool_str
= self
.indent
+ '"' + \
456 ('\\0"\n' + self
.indent
+ '"').join(pool
) + '";'
457 return (pool_str
, offsets
)
459 def c_stub_initializer(self
, prefix
, pool_offsets
):
460 """Return the initializer for struct mapi_stub array."""
462 for ent
in self
.entries_sorted_by_names
:
463 stubs
.append('%s{ (void *) %d, %d, NULL }' % (
464 self
.indent
, pool_offsets
[ent
], ent
.slot
))
466 return ',\n'.join(stubs
)
468 def c_noop_functions(self
, prefix
, warn_prefix
):
469 """Return the noop functions."""
471 for ent
in self
.entries
:
475 proto
= self
._c
_decl
(ent
, prefix
, False, 'static')
479 for t
, n
, a
in ent
.params
:
480 stmt1
+= "%s(void) %s;" % (space
, n
)
486 stmt1
+= self
.indent
+ '%s(%s);' % (self
.noop_warn
,
487 self
._c
_function
(ent
, warn_prefix
, False, True))
490 stmt2
= self
.indent
+ 'return (%s) 0;' % (ent
.ret
)
491 noop
= '%s\n{\n%s\n%s\n}' % (proto
, stmt1
, stmt2
)
493 noop
= '%s\n{\n%s\n}' % (proto
, stmt1
)
497 return '\n\n'.join(noops
)
499 def c_noop_initializer(self
, prefix
, use_generic
):
500 """Return an initializer for the noop dispatch table."""
501 entries
= [self
._c
_function
(ent
, prefix
)
502 for ent
in self
.entries
if not ent
.alias
]
504 entries
= [self
.noop_generic
] * len(entries
)
506 entries
.extend([self
.noop_generic
] * ABI_NUM_DYNAMIC_ENTRIES
)
508 pre
= self
.indent
+ '(mapi_func) '
509 return pre
+ (',\n' + pre
).join(entries
)
511 def c_asm_gcc(self
, prefix
, no_hidden
):
514 for ent
in self
.entries
:
515 if ent
.hidden
and no_hidden
:
518 if not self
.need_entry_point(ent
):
521 name
= self
._c
_function
(ent
, prefix
, True, True)
527 asm
.append('".hidden "%s"\\n"' % (name
))
529 if ent
.alias
and not (ent
.alias
.hidden
and no_hidden
):
530 asm
.append('".globl "%s"\\n"' % (name
))
531 asm
.append('".set "%s", "%s"\\n"' % (name
,
532 self
._c
_function
(ent
.alias
, prefix
, True, True)))
534 asm
.append('STUB_ASM_ENTRY(%s)"\\n"' % (name
))
535 asm
.append('"\\t"STUB_ASM_CODE("%d")"\\n"' % (ent
.slot
))
541 return "\n".join(asm
)
543 def output_for_lib(self
):
544 print(self
.c_notice())
551 print('#ifdef MAPI_TMP_DEFINES')
552 print(self
.c_public_includes())
554 print(self
.c_public_declarations(self
.prefix_lib
))
555 print('#undef MAPI_TMP_DEFINES')
556 print('#endif /* MAPI_TMP_DEFINES */')
558 if self
.lib_need_table_size
:
560 print('#ifdef MAPI_TMP_TABLE')
561 print(self
.c_mapi_table())
562 print('#undef MAPI_TMP_TABLE')
563 print('#endif /* MAPI_TMP_TABLE */')
565 if self
.lib_need_noop_array
:
567 print('#ifdef MAPI_TMP_NOOP_ARRAY')
568 print('#ifdef DEBUG')
570 print(self
.c_noop_functions(self
.prefix_noop
, self
.prefix_warn
))
572 print('const mapi_func table_%s_array[] = {' % (self
.prefix_noop
))
573 print(self
.c_noop_initializer(self
.prefix_noop
, False))
576 print('#else /* DEBUG */')
578 print('const mapi_func table_%s_array[] = {' % (self
.prefix_noop
))
579 print(self
.c_noop_initializer(self
.prefix_noop
, True))
582 print('#endif /* DEBUG */')
583 print('#undef MAPI_TMP_NOOP_ARRAY')
584 print('#endif /* MAPI_TMP_NOOP_ARRAY */')
586 if self
.lib_need_stubs
:
587 pool
, pool_offsets
= self
.c_stub_string_pool()
589 print('#ifdef MAPI_TMP_PUBLIC_STUBS')
590 print('static const char public_string_pool[] =')
593 print('static const struct mapi_stub public_stubs[] = {')
594 print(self
.c_stub_initializer(self
.prefix_lib
, pool_offsets
))
596 print('#undef MAPI_TMP_PUBLIC_STUBS')
597 print('#endif /* MAPI_TMP_PUBLIC_STUBS */')
599 if self
.lib_need_all_entries
:
601 print('#ifdef MAPI_TMP_PUBLIC_ENTRIES')
602 print(self
.c_public_dispatches(self
.prefix_lib
, False))
604 print('static const mapi_func public_entries[] = {')
605 print(self
.c_public_initializer(self
.prefix_lib
))
607 print('#undef MAPI_TMP_PUBLIC_ENTRIES')
608 print('#endif /* MAPI_TMP_PUBLIC_ENTRIES */')
611 print('#ifdef MAPI_TMP_STUB_ASM_GCC')
613 print(self
.c_asm_gcc(self
.prefix_lib
, False))
615 print('#undef MAPI_TMP_STUB_ASM_GCC')
616 print('#endif /* MAPI_TMP_STUB_ASM_GCC */')
618 if self
.lib_need_non_hidden_entries
:
620 for ent
in self
.entries
:
626 print('#ifdef MAPI_TMP_PUBLIC_ENTRIES_NO_HIDDEN')
627 print(self
.c_public_dispatches(self
.prefix_lib
, True))
629 print('/* does not need public_entries */')
630 print('#undef MAPI_TMP_PUBLIC_ENTRIES_NO_HIDDEN')
631 print('#endif /* MAPI_TMP_PUBLIC_ENTRIES_NO_HIDDEN */')
634 print('#ifdef MAPI_TMP_STUB_ASM_GCC_NO_HIDDEN')
636 print(self
.c_asm_gcc(self
.prefix_lib
, True))
638 print('#undef MAPI_TMP_STUB_ASM_GCC_NO_HIDDEN')
639 print('#endif /* MAPI_TMP_STUB_ASM_GCC_NO_HIDDEN */')
641 class GLAPIPrinter(ABIPrinter
):
642 """OpenGL API Printer"""
644 def __init__(self
, entries
):
646 self
._override
_for
_api
(ent
)
647 super(GLAPIPrinter
, self
).__init
__(entries
)
649 self
.api_defines
= ['GL_GLEXT_PROTOTYPES']
650 self
.api_headers
= ['"GL/gl.h"', '"GL/glext.h"']
651 self
.api_call
= 'GLAPI'
652 self
.api_entry
= 'APIENTRY'
655 self
.lib_need_table_size
= False
656 self
.lib_need_noop_array
= False
657 self
.lib_need_stubs
= False
658 self
.lib_need_all_entries
= False
659 self
.lib_need_non_hidden_entries
= True
661 self
.prefix_lib
= 'GLAPI_PREFIX'
662 self
.prefix_noop
= 'noop'
663 self
.prefix_warn
= self
.prefix_lib
665 self
.c_header
= self
._get
_c
_header
()
667 def _override_for_api(self
, ent
):
668 """Override attributes of an entry if necessary for this
670 # By default, no override is necessary.
673 def _get_c_header(self
):
674 header
= """#ifndef _GLAPI_TMP_H_
675 #define _GLAPI_TMP_H_
676 #ifdef USE_MGL_NAMESPACE
677 #define GLAPI_PREFIX(func) mgl##func
678 #define GLAPI_PREFIX_STR(func) "mgl"#func
680 #define GLAPI_PREFIX(func) gl##func
681 #define GLAPI_PREFIX_STR(func) "gl"#func
682 #endif /* USE_MGL_NAMESPACE */
684 typedef int GLclampx;
685 #endif /* _GLAPI_TMP_H_ */"""
689 class ES1APIPrinter(GLAPIPrinter
):
690 """OpenGL ES 1.x API Printer"""
692 def __init__(self
, entries
):
693 super(ES1APIPrinter
, self
).__init
__(entries
)
694 self
.prefix_lib
= 'gl'
695 self
.prefix_warn
= 'gl'
697 def _override_for_api(self
, ent
):
698 if ent
.xml_data
is None:
699 raise Exception('ES2 API printer requires XML input')
700 ent
.hidden
= (ent
.name
not in \
701 ent
.xml_data
.entry_points_for_api_version('es1')) \
705 def _get_c_header(self
):
706 header
= """#ifndef _GLAPI_TMP_H_
707 #define _GLAPI_TMP_H_
708 typedef int GLclampx;
709 #endif /* _GLAPI_TMP_H_ */"""
713 class ES2APIPrinter(GLAPIPrinter
):
714 """OpenGL ES 2.x API Printer"""
716 def __init__(self
, entries
):
717 super(ES2APIPrinter
, self
).__init
__(entries
)
718 self
.prefix_lib
= 'gl'
719 self
.prefix_warn
= 'gl'
721 def _override_for_api(self
, ent
):
722 if ent
.xml_data
is None:
723 raise Exception('ES2 API printer requires XML input')
724 ent
.hidden
= (ent
.name
not in \
725 ent
.xml_data
.entry_points_for_api_version('es2')) \
728 # This is hella ugly. The same-named function in desktop OpenGL is
729 # hidden, but it needs to be exposed by libGLESv2 for OpenGL ES 3.0.
730 # There's no way to express in the XML that a function should be be
731 # hidden in one API but exposed in another.
732 if ent
.name
== 'GetInternalformativ':
737 def _get_c_header(self
):
738 header
= """#ifndef _GLAPI_TMP_H_
739 #define _GLAPI_TMP_H_
740 typedef int GLclampx;
741 #endif /* _GLAPI_TMP_H_ */"""
745 class SharedGLAPIPrinter(GLAPIPrinter
):
746 """Shared GLAPI API Printer"""
748 def __init__(self
, entries
):
749 super(SharedGLAPIPrinter
, self
).__init
__(entries
)
751 self
.lib_need_table_size
= True
752 self
.lib_need_noop_array
= True
753 self
.lib_need_stubs
= True
754 self
.lib_need_all_entries
= True
755 self
.lib_need_non_hidden_entries
= False
757 self
.prefix_lib
= 'shared'
758 self
.prefix_warn
= 'gl'
760 def _override_for_api(self
, ent
):
764 def _get_c_header(self
):
765 header
= """#ifndef _GLAPI_TMP_H_
766 #define _GLAPI_TMP_H_
767 typedef int GLclampx;
768 #endif /* _GLAPI_TMP_H_ */"""
773 printers
= ['glapi', 'es1api', 'es2api', 'shared-glapi']
775 parser
= OptionParser(usage
='usage: %prog [options] <filename>')
776 parser
.add_option('-p', '--printer', dest
='printer',
777 help='printer to use: %s' % (", ".join(printers
)))
779 options
, args
= parser
.parse_args()
780 if not args
or options
.printer
not in printers
:
784 return (args
[0], options
)
788 'glapi': GLAPIPrinter
,
789 'es1api': ES1APIPrinter
,
790 'es2api': ES2APIPrinter
,
791 'shared-glapi': SharedGLAPIPrinter
,
794 filename
, options
= parse_args()
796 if filename
.endswith('.xml'):
797 entries
= abi_parse_xml(filename
)
799 entries
= abi_parse(filename
)
800 abi_sanity_check(entries
)
802 printer
= printers
[options
.printer
](entries
)
803 printer
.output_for_lib()
805 if __name__
== '__main__':