1
2# (C) Copyright IBM Corporation 2005
3# All Rights Reserved.
4#
5# Permission is hereby granted, free of charge, to any person obtaining a
6# copy of this software and associated documentation files (the "Software"),
7# to deal in the Software without restriction, including without limitation
8# on the rights to use, copy, modify, merge, publish, distribute, sub
9# license, and/or sell copies of the Software, and to permit persons to whom
10# the Software is furnished to do so, subject to the following conditions:
11#
12# The above copyright notice and this permission notice (including the next
13# paragraph) shall be included in all copies or substantial portions of the
14# Software.
15#
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 NON-INFRINGEMENT.  IN NO EVENT SHALL
19# IBM AND/OR ITS SUPPLIERS 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 DEALINGS
22# IN THE SOFTWARE.
23#
24# Authors:
25#    Ian Romanick <idr@us.ibm.com>
26
27import argparse
28import copy
29
30import license
31import gl_XML, glX_XML
32
33def should_use_push(registers):
34    for [reg, offset] in registers:
35        if reg[1:4] == "xmm":
36            return 0
37
38    N = len(registers)
39    return (N & 1) != 0
40
41
42def local_size(registers):
43    # The x86-64 ABI says "the value (%rsp - 8) is always a multiple of
44    # 16 when control is transfered to the function entry point."  This
45    # means that the local stack usage must be (16*N)+8 for some value
46    # of N.  (16*N)+8 = (8*(2N))+8 = 8*(2N+1).  As long as N is odd, we
47    # meet this requirement.
48
49    N = (len(registers) | 1)
50    return 8*N
51
52
53def save_all_regs(registers):
54    adjust_stack = 0
55    if not should_use_push(registers):
56        adjust_stack = local_size(registers)
57        print '\tsubq\t$%u, %%rsp' % (adjust_stack)
58
59    for [reg, stack_offset] in registers:
60        save_reg( reg, stack_offset, adjust_stack )
61    return
62
63
64def restore_all_regs(registers):
65    adjust_stack = 0
66    if not should_use_push(registers):
67        adjust_stack = local_size(registers)
68
69    temp = copy.deepcopy(registers)
70    while len(temp):
71        [reg, stack_offset] = temp.pop()
72        restore_reg(reg, stack_offset, adjust_stack)
73
74    if adjust_stack:
75        print '\taddq\t$%u, %%rsp' % (adjust_stack)
76    return
77
78
79def save_reg(reg, offset, use_move):
80    if use_move:
81        if offset == 0:
82            print '\tmovq\t%s, (%%rsp)' % (reg)
83        else:
84            print '\tmovq\t%s, %u(%%rsp)' % (reg, offset)
85    else:
86        print '\tpushq\t%s' % (reg)
87
88    return
89
90
91def restore_reg(reg, offset, use_move):
92    if use_move:
93        if offset == 0:
94            print '\tmovq\t(%%rsp), %s' % (reg)
95        else:
96            print '\tmovq\t%u(%%rsp), %s' % (offset, reg)
97    else:
98        print '\tpopq\t%s' % (reg)
99
100    return
101
102
103class PrintGenericStubs(gl_XML.gl_print_base):
104
105    def __init__(self):
106        gl_XML.gl_print_base.__init__(self)
107
108        self.name = "gl_x86-64_asm.py (from Mesa)"
109        self.license = license.bsd_license_template % ("(C) Copyright IBM Corporation 2005", "IBM")
110        return
111
112
113    def get_stack_size(self, f):
114        size = 0
115        for p in f.parameterIterator():
116            size += p.get_stack_size()
117
118        return size
119
120
121    def printRealHeader(self):
122        print "/* If we build with gcc's -fvisibility=hidden flag, we'll need to change"
123        print " * the symbol visibility mode to 'default'."
124        print ' */'
125        print ''
126        print '#include "x86/assyntax.h"'
127        print ''
128        print '#ifdef __GNUC__'
129        print '#  pragma GCC visibility push(default)'
130        print '#  define HIDDEN(x) .hidden x'
131        print '#else'
132        print '#  define HIDDEN(x)'
133        print '#endif'
134        print ''
135        print '# if defined(USE_MGL_NAMESPACE)'
136        print '#  define GL_PREFIX(n) GLNAME(CONCAT(mgl,n))'
137        print '#  define _glapi_Dispatch _mglapi_Dispatch'
138        print '# else'
139        print '#  define GL_PREFIX(n) GLNAME(CONCAT(gl,n))'
140        print '# endif'
141        print ''
142        print '\t.text'
143        print ''
144        print '#ifdef GLX_USE_TLS'
145        print ''
146        print '_x86_64_get_dispatch:'
147        print '\tmovq\t_glapi_tls_Dispatch@GOTTPOFF(%rip), %rax'
148        print '\tmovq\t%fs:(%rax), %rax'
149        print '\tret'
150        print '\t.size\t_x86_64_get_dispatch, .-_x86_64_get_dispatch'
151        print ''
152        print '#elif defined(HAVE_PTHREAD)'
153        print ''
154        print '\t.extern\t_glapi_Dispatch'
155        print '\t.extern\t_gl_DispatchTSD'
156        print '\t.extern\tpthread_getspecific'
157        print ''
158        print '\t.p2align\t4,,15'
159        print '_x86_64_get_dispatch:'
160        print '\tmovq\t_gl_DispatchTSD@GOTPCREL(%rip), %rax'
161        print '\tmovl\t(%rax), %edi'
162        print '\tjmp\tpthread_getspecific@PLT'
163        print ''
164        print '#else'
165        print ''
166        print '\t.extern\t_glapi_get_dispatch'
167        print ''
168        print '#endif'
169        print ''
170        return
171
172
173    def printRealFooter(self):
174        print ''
175        print '#if defined (__ELF__) && defined (__linux__)'
176        print '	.section .note.GNU-stack,"",%progbits'
177        print '#endif'
178        return
179
180
181    def printFunction(self, f):
182
183        # The x86-64 ABI divides function parameters into a couple
184        # classes.  For the OpenGL interface, the only ones that are
185        # relevant are INTEGER and SSE.  Basically, the first 8
186        # GLfloat or GLdouble parameters are placed in %xmm0 - %xmm7,
187        # the first 6 non-GLfloat / non-GLdouble parameters are placed
188        # in registers listed in int_parameters.
189        #
190        # If more parameters than that are required, they are passed
191        # on the stack.  Therefore, we just have to make sure that
192        # %esp hasn't changed when we jump to the actual function.
193        # Since we're jumping to the function (and not calling it), we
194        # have to make sure of that anyway!
195
196        int_parameters = ["%rdi", "%rsi", "%rdx", "%rcx", "%r8", "%r9"]
197
198        int_class = 0
199        sse_class = 0
200        stack_offset = 0
201        registers = []
202        for p in f.parameterIterator():
203            type_name = p.get_base_type_string()
204
205            if p.is_pointer() or (type_name != "GLfloat" and type_name != "GLdouble"):
206                if int_class < 6:
207                    registers.append( [int_parameters[int_class], stack_offset] )
208                    int_class += 1
209                    stack_offset += 8
210            else:
211                if sse_class < 8:
212                    registers.append( ["%%xmm%u" % (sse_class), stack_offset] )
213                    sse_class += 1
214                    stack_offset += 8
215
216        if ((int_class & 1) == 0) and (sse_class == 0):
217            registers.append( ["%rbp", 0] )
218
219
220        name = f.dispatch_name()
221
222        print '\t.p2align\t4,,15'
223        print '\t.globl\tGL_PREFIX(%s)' % (name)
224        print '\t.type\tGL_PREFIX(%s), @function' % (name)
225        if not f.is_static_entry_point(f.name):
226            print '\tHIDDEN(GL_PREFIX(%s))' % (name)
227        print 'GL_PREFIX(%s):' % (name)
228        print '#if defined(GLX_USE_TLS)'
229        print '\tcall\t_x86_64_get_dispatch@PLT'
230        print '\tmovq\t%u(%%rax), %%r11' % (f.offset * 8)
231        print '\tjmp\t*%r11'
232        print '#elif defined(HAVE_PTHREAD)'
233
234        save_all_regs(registers)
235        print '\tcall\t_x86_64_get_dispatch@PLT'
236        restore_all_regs(registers)
237
238        if f.offset == 0:
239            print '\tmovq\t(%rax), %r11'
240        else:
241            print '\tmovq\t%u(%%rax), %%r11' % (f.offset * 8)
242
243        print '\tjmp\t*%r11'
244
245        print '#else'
246        print '\tmovq\t_glapi_Dispatch(%rip), %rax'
247        print '\ttestq\t%rax, %rax'
248        print '\tje\t1f'
249        print '\tmovq\t%u(%%rax), %%r11' % (f.offset * 8)
250        print '\tjmp\t*%r11'
251        print '1:'
252
253        save_all_regs(registers)
254        print '\tcall\t_glapi_get_dispatch'
255        restore_all_regs(registers)
256
257        print '\tmovq\t%u(%%rax), %%r11' % (f.offset * 8)
258        print '\tjmp\t*%r11'
259        print '#endif /* defined(GLX_USE_TLS) */'
260
261        print '\t.size\tGL_PREFIX(%s), .-GL_PREFIX(%s)' % (name, name)
262        print ''
263        return
264
265
266    def printBody(self, api):
267        for f in api.functionIterateByOffset():
268            self.printFunction(f)
269
270
271        for f in api.functionIterateByOffset():
272            dispatch = f.dispatch_name()
273            for n in f.entry_points:
274                if n != f.name:
275                    if f.is_static_entry_point(n):
276                        text = '\t.globl GL_PREFIX(%s) ; .set GL_PREFIX(%s), GL_PREFIX(%s)' % (n, n, dispatch)
277
278                        if f.has_different_protocol(n):
279                            print '#ifndef GLX_INDIRECT_RENDERING'
280                            print text
281                            print '#endif'
282                        else:
283                            print text
284
285        return
286
287
288def _parser():
289    """Parse arguments and return a namespace."""
290    parser = argparse.ArgumentParser()
291    parser.add_argument('-f',
292                        default='gl_API.xml',
293                        dest='filename',
294                        help='An XML file describing an API')
295    return parser.parse_args()
296
297
298def main():
299    """Main file."""
300    args = _parser()
301    printer = PrintGenericStubs()
302    api = gl_XML.parse_GL_API(args.filename, glX_XML.glx_item_factory())
303
304    printer.Print(api)
305
306
307if __name__ == '__main__':
308    main()
309