src/mapi/glapi/gen/gl_x86-64_asm.py

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