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
= sorted(self
.entries
, key
=attrgetter('name'))
296 self
.indent
= ' ' * 3
297 self
.noop_warn
= 'noop_warn'
298 self
.noop_generic
= 'noop_generic'
299 self
.current_get
= 'entry_current_get'
301 self
.api_defines
= []
302 self
.api_headers
= ['"KHR/khrplatform.h"']
303 self
.api_call
= 'KHRONOS_APICALL'
304 self
.api_entry
= 'KHRONOS_APIENTRY'
305 self
.api_attrs
= 'KHRONOS_APIATTRIBUTES'
309 self
.lib_need_table_size
= True
310 self
.lib_need_noop_array
= True
311 self
.lib_need_stubs
= True
312 self
.lib_need_all_entries
= True
313 self
.lib_need_non_hidden_entries
= False
316 return '/* This file is automatically generated by mapi_abi.py. Do not modify. */'
318 def c_public_includes(self
):
319 """Return includes of the client API headers."""
320 defines
= ['#define ' + d
for d
in self
.api_defines
]
321 includes
= ['#include ' + h
for h
in self
.api_headers
]
322 return "\n".join(defines
+ includes
)
324 def need_entry_point(self
, ent
):
325 """Return True if an entry point is needed for the entry."""
326 # non-handcode hidden aliases may share the entry they alias
327 use_alias
= (ent
.hidden
and ent
.alias
and not ent
.handcode
)
330 def c_public_declarations(self
, prefix
):
331 """Return the declarations of public entry points."""
333 for ent
in self
.entries
:
334 if not self
.need_entry_point(ent
):
336 export
= self
.api_call
if not ent
.hidden
else ''
337 decls
.append(self
._c
_decl
(ent
, prefix
, True, export
) + ';')
339 return "\n".join(decls
)
341 def c_mapi_table(self
):
342 """Return defines of the dispatch table size."""
343 num_static_entries
= self
.entries
[-1].slot
+ 1
344 return ('#define MAPI_TABLE_NUM_STATIC %d\n' + \
345 '#define MAPI_TABLE_NUM_DYNAMIC %d') % (
346 num_static_entries
, ABI_NUM_DYNAMIC_ENTRIES
)
348 def _c_function(self
, ent
, prefix
, mangle
=False, stringify
=False):
349 """Return the function name of an entry."""
351 True: { True: '%s_STR(%s)', False: '%s(%s)' },
352 False: { True: '"%s%s"', False: '%s%s' },
354 fmt
= formats
[prefix
.isupper()][stringify
]
356 if mangle
and ent
.hidden
:
357 name
= '_dispatch_stub_' + str(ent
.slot
)
358 return fmt
% (prefix
, name
)
360 def _c_function_call(self
, ent
, prefix
):
361 """Return the function name used for calling."""
363 # _c_function does not handle this case
364 formats
= { True: '%s(%s)', False: '%s%s' }
365 fmt
= formats
[prefix
.isupper()]
366 name
= fmt
% (prefix
, ent
.handcode
)
367 elif self
.need_entry_point(ent
):
368 name
= self
._c
_function
(ent
, prefix
, True)
370 name
= self
._c
_function
(ent
.alias
, prefix
, True)
373 def _c_decl(self
, ent
, prefix
, mangle
=False, export
=''):
374 """Return the C declaration for the entry."""
375 decl
= '%s %s %s(%s)' % (ent
.c_return(), self
.api_entry
,
376 self
._c
_function
(ent
, prefix
, mangle
), ent
.c_params())
378 decl
= export
+ ' ' + decl
380 decl
+= ' ' + self
.api_attrs
384 def _c_cast(self
, ent
):
385 """Return the C cast for the entry."""
386 cast
= '%s (%s *)(%s)' % (
387 ent
.c_return(), self
.api_entry
, ent
.c_params())
391 def c_public_dispatches(self
, prefix
, no_hidden
):
392 """Return the public dispatch functions."""
394 for ent
in self
.entries
:
395 if ent
.hidden
and no_hidden
:
398 if not self
.need_entry_point(ent
):
401 export
= self
.api_call
if not ent
.hidden
else ''
403 proto
= self
._c
_decl
(ent
, prefix
, True, export
)
404 cast
= self
._c
_cast
(ent
)
410 stmt1
+= 'const struct _glapi_table *_tbl = %s();' % (
413 stmt2
+= 'mapi_func _func = ((const mapi_func *) _tbl)[%d];' % (
416 stmt3
+= '%s((%s) _func)(%s);' % (ret
, cast
, ent
.c_args())
418 disp
= '%s\n{\n%s\n%s\n%s\n}' % (proto
, stmt1
, stmt2
, stmt3
)
421 disp
= '#if 0\n' + disp
+ '\n#endif'
423 dispatches
.append(disp
)
425 return '\n\n'.join(dispatches
)
427 def c_public_initializer(self
, prefix
):
428 """Return the initializer for public dispatch functions."""
430 for ent
in self
.entries
:
434 name
= '%s(mapi_func) %s' % (self
.indent
,
435 self
._c
_function
_call
(ent
, prefix
))
438 return ',\n'.join(names
)
440 def c_stub_string_pool(self
):
441 """Return the string pool for use by stubs."""
442 # sort entries by their names
443 sorted_entries
= sorted(self
.entries
, key
=attrgetter('name'))
448 for ent
in sorted_entries
:
450 pool
.append('%s' % (ent
.name
))
451 count
+= len(ent
.name
) + 1
453 pool_str
= self
.indent
+ '"' + \
454 ('\\0"\n' + self
.indent
+ '"').join(pool
) + '";'
455 return (pool_str
, offsets
)
457 def c_stub_initializer(self
, prefix
, pool_offsets
):
458 """Return the initializer for struct mapi_stub array."""
460 for ent
in self
.entries_sorted_by_names
:
461 stubs
.append('%s{ (void *) %d, %d, NULL }' % (
462 self
.indent
, pool_offsets
[ent
], ent
.slot
))
464 return ',\n'.join(stubs
)
466 def c_noop_functions(self
, prefix
, warn_prefix
):
467 """Return the noop functions."""
469 for ent
in self
.entries
:
473 proto
= self
._c
_decl
(ent
, prefix
, False, 'static')
477 for t
, n
, a
in ent
.params
:
478 stmt1
+= "%s(void) %s;" % (space
, n
)
484 stmt1
+= self
.indent
+ '%s(%s);' % (self
.noop_warn
,
485 self
._c
_function
(ent
, warn_prefix
, False, True))
488 stmt2
= self
.indent
+ 'return (%s) 0;' % (ent
.ret
)
489 noop
= '%s\n{\n%s\n%s\n}' % (proto
, stmt1
, stmt2
)
491 noop
= '%s\n{\n%s\n}' % (proto
, stmt1
)
495 return '\n\n'.join(noops
)
497 def c_noop_initializer(self
, prefix
, use_generic
):
498 """Return an initializer for the noop dispatch table."""
499 entries
= [self
._c
_function
(ent
, prefix
)
500 for ent
in self
.entries
if not ent
.alias
]
502 entries
= [self
.noop_generic
] * len(entries
)
504 entries
.extend([self
.noop_generic
] * ABI_NUM_DYNAMIC_ENTRIES
)
506 pre
= self
.indent
+ '(mapi_func) '
507 return pre
+ (',\n' + pre
).join(entries
)
509 def c_asm_gcc(self
, prefix
, no_hidden
):
512 for ent
in self
.entries
:
513 if ent
.hidden
and no_hidden
:
516 if not self
.need_entry_point(ent
):
519 name
= self
._c
_function
(ent
, prefix
, True, True)
525 asm
.append('".hidden "%s"\\n"' % (name
))
527 if ent
.alias
and not (ent
.alias
.hidden
and no_hidden
):
528 asm
.append('".globl "%s"\\n"' % (name
))
529 asm
.append('".set "%s", "%s"\\n"' % (name
,
530 self
._c
_function
(ent
.alias
, prefix
, True, True)))
532 asm
.append('STUB_ASM_ENTRY(%s)"\\n"' % (name
))
533 asm
.append('"\\t"STUB_ASM_CODE("%d")"\\n"' % (ent
.slot
))
539 return "\n".join(asm
)
541 def output_for_lib(self
):
542 print(self
.c_notice())
549 print('#ifdef MAPI_TMP_DEFINES')
550 print(self
.c_public_includes())
552 print(self
.c_public_declarations(self
.prefix_lib
))
553 print('#undef MAPI_TMP_DEFINES')
554 print('#endif /* MAPI_TMP_DEFINES */')
556 if self
.lib_need_table_size
:
558 print('#ifdef MAPI_TMP_TABLE')
559 print(self
.c_mapi_table())
560 print('#undef MAPI_TMP_TABLE')
561 print('#endif /* MAPI_TMP_TABLE */')
563 if self
.lib_need_noop_array
:
565 print('#ifdef MAPI_TMP_NOOP_ARRAY')
566 print('#ifdef DEBUG')
568 print(self
.c_noop_functions(self
.prefix_noop
, self
.prefix_warn
))
570 print('const mapi_func table_%s_array[] = {' % (self
.prefix_noop
))
571 print(self
.c_noop_initializer(self
.prefix_noop
, False))
574 print('#else /* DEBUG */')
576 print('const mapi_func table_%s_array[] = {' % (self
.prefix_noop
))
577 print(self
.c_noop_initializer(self
.prefix_noop
, True))
580 print('#endif /* DEBUG */')
581 print('#undef MAPI_TMP_NOOP_ARRAY')
582 print('#endif /* MAPI_TMP_NOOP_ARRAY */')
584 if self
.lib_need_stubs
:
585 pool
, pool_offsets
= self
.c_stub_string_pool()
587 print('#ifdef MAPI_TMP_PUBLIC_STUBS')
588 print('static const char public_string_pool[] =')
591 print('static const struct mapi_stub public_stubs[] = {')
592 print(self
.c_stub_initializer(self
.prefix_lib
, pool_offsets
))
594 print('#undef MAPI_TMP_PUBLIC_STUBS')
595 print('#endif /* MAPI_TMP_PUBLIC_STUBS */')
597 if self
.lib_need_all_entries
:
599 print('#ifdef MAPI_TMP_PUBLIC_ENTRIES')
600 print(self
.c_public_dispatches(self
.prefix_lib
, False))
602 print('static const mapi_func public_entries[] = {')
603 print(self
.c_public_initializer(self
.prefix_lib
))
605 print('#undef MAPI_TMP_PUBLIC_ENTRIES')
606 print('#endif /* MAPI_TMP_PUBLIC_ENTRIES */')
609 print('#ifdef MAPI_TMP_STUB_ASM_GCC')
611 print(self
.c_asm_gcc(self
.prefix_lib
, False))
613 print('#undef MAPI_TMP_STUB_ASM_GCC')
614 print('#endif /* MAPI_TMP_STUB_ASM_GCC */')
616 if self
.lib_need_non_hidden_entries
:
618 for ent
in self
.entries
:
624 print('#ifdef MAPI_TMP_PUBLIC_ENTRIES_NO_HIDDEN')
625 print(self
.c_public_dispatches(self
.prefix_lib
, True))
627 print('/* does not need public_entries */')
628 print('#undef MAPI_TMP_PUBLIC_ENTRIES_NO_HIDDEN')
629 print('#endif /* MAPI_TMP_PUBLIC_ENTRIES_NO_HIDDEN */')
632 print('#ifdef MAPI_TMP_STUB_ASM_GCC_NO_HIDDEN')
634 print(self
.c_asm_gcc(self
.prefix_lib
, True))
636 print('#undef MAPI_TMP_STUB_ASM_GCC_NO_HIDDEN')
637 print('#endif /* MAPI_TMP_STUB_ASM_GCC_NO_HIDDEN */')
639 class GLAPIPrinter(ABIPrinter
):
640 """OpenGL API Printer"""
642 def __init__(self
, entries
):
644 self
._override
_for
_api
(ent
)
645 super(GLAPIPrinter
, self
).__init
__(entries
)
647 self
.api_defines
= ['GL_GLEXT_PROTOTYPES']
648 self
.api_headers
= ['"GL/gl.h"', '"GL/glext.h"']
649 self
.api_call
= 'GLAPI'
650 self
.api_entry
= 'APIENTRY'
653 self
.lib_need_table_size
= False
654 self
.lib_need_noop_array
= False
655 self
.lib_need_stubs
= False
656 self
.lib_need_all_entries
= False
657 self
.lib_need_non_hidden_entries
= True
659 self
.prefix_lib
= 'GLAPI_PREFIX'
660 self
.prefix_noop
= 'noop'
661 self
.prefix_warn
= self
.prefix_lib
663 self
.c_header
= self
._get
_c
_header
()
665 def _override_for_api(self
, ent
):
666 """Override attributes of an entry if necessary for this
668 # By default, no override is necessary.
671 def _get_c_header(self
):
672 header
= """#ifndef _GLAPI_TMP_H_
673 #define _GLAPI_TMP_H_
674 #ifdef USE_MGL_NAMESPACE
675 #define GLAPI_PREFIX(func) mgl##func
676 #define GLAPI_PREFIX_STR(func) "mgl"#func
678 #define GLAPI_PREFIX(func) gl##func
679 #define GLAPI_PREFIX_STR(func) "gl"#func
680 #endif /* USE_MGL_NAMESPACE */
682 typedef int GLclampx;
683 #endif /* _GLAPI_TMP_H_ */"""
687 class ES1APIPrinter(GLAPIPrinter
):
688 """OpenGL ES 1.x API Printer"""
690 def __init__(self
, entries
):
691 super(ES1APIPrinter
, self
).__init
__(entries
)
692 self
.prefix_lib
= 'gl'
693 self
.prefix_warn
= 'gl'
695 def _override_for_api(self
, ent
):
696 if ent
.xml_data
is None:
697 raise Exception('ES2 API printer requires XML input')
698 ent
.hidden
= (ent
.name
not in \
699 ent
.xml_data
.entry_points_for_api_version('es1')) \
703 def _get_c_header(self
):
704 header
= """#ifndef _GLAPI_TMP_H_
705 #define _GLAPI_TMP_H_
706 typedef int GLclampx;
707 #endif /* _GLAPI_TMP_H_ */"""
711 class ES2APIPrinter(GLAPIPrinter
):
712 """OpenGL ES 2.x API Printer"""
714 def __init__(self
, entries
):
715 super(ES2APIPrinter
, self
).__init
__(entries
)
716 self
.prefix_lib
= 'gl'
717 self
.prefix_warn
= 'gl'
719 def _override_for_api(self
, ent
):
720 if ent
.xml_data
is None:
721 raise Exception('ES2 API printer requires XML input')
722 ent
.hidden
= (ent
.name
not in \
723 ent
.xml_data
.entry_points_for_api_version('es2')) \
726 # This is hella ugly. The same-named function in desktop OpenGL is
727 # hidden, but it needs to be exposed by libGLESv2 for OpenGL ES 3.0.
728 # There's no way to express in the XML that a function should be be
729 # hidden in one API but exposed in another.
730 if ent
.name
== 'GetInternalformativ':
735 def _get_c_header(self
):
736 header
= """#ifndef _GLAPI_TMP_H_
737 #define _GLAPI_TMP_H_
738 typedef int GLclampx;
739 #endif /* _GLAPI_TMP_H_ */"""
743 class SharedGLAPIPrinter(GLAPIPrinter
):
744 """Shared GLAPI API Printer"""
746 def __init__(self
, entries
):
747 super(SharedGLAPIPrinter
, self
).__init
__(entries
)
749 self
.lib_need_table_size
= True
750 self
.lib_need_noop_array
= True
751 self
.lib_need_stubs
= True
752 self
.lib_need_all_entries
= True
753 self
.lib_need_non_hidden_entries
= False
755 self
.prefix_lib
= 'shared'
756 self
.prefix_warn
= 'gl'
758 def _override_for_api(self
, ent
):
762 def _get_c_header(self
):
763 header
= """#ifndef _GLAPI_TMP_H_
764 #define _GLAPI_TMP_H_
765 typedef int GLclampx;
766 #endif /* _GLAPI_TMP_H_ */"""
771 printers
= ['glapi', 'es1api', 'es2api', 'shared-glapi']
773 parser
= OptionParser(usage
='usage: %prog [options] <filename>')
774 parser
.add_option('-p', '--printer', dest
='printer',
775 help='printer to use: %s' % (", ".join(printers
)))
777 options
, args
= parser
.parse_args()
778 if not args
or options
.printer
not in printers
:
782 return (args
[0], options
)
786 'glapi': GLAPIPrinter
,
787 'es1api': ES1APIPrinter
,
788 'es2api': ES2APIPrinter
,
789 'shared-glapi': SharedGLAPIPrinter
,
792 filename
, options
= parse_args()
794 if filename
.endswith('.xml'):
795 entries
= abi_parse_xml(filename
)
797 entries
= abi_parse(filename
)
798 abi_sanity_check(entries
)
800 printer
= printers
[options
.printer
](entries
)
801 printer
.output_for_lib()
803 if __name__
== '__main__':