src/mapi/glapi/gen/gl_marshal.py

   1 #!/usr/bin/env python
   2
   3 # Copyright (C) 2012 Intel Corporation
   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 # the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9 # and/or sell copies of the Software, and to permit persons to whom the
  10 # 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 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 DEALINGS
  22 # IN THE SOFTWARE.
  23
  24 import contextlib
  25 import getopt
  26 import gl_XML
  27 import license
  28 import marshal_XML
  29 import sys
  30
  31 header = """
  32 #include "api_exec.h"
  33 #include "context.h"
  34 #include "dispatch.h"
  35 #include "glthread.h"
  36 #include "marshal.h"
  37 #include "marshal_generated.h"
  38 """
  39
  40
  41 current_indent = 0
  42
  43
  44 def out(str):
  45     if str:
  46         print ' '*current_indent + str
  47     else:
  48         print ''
  49
  50
  51 @contextlib.contextmanager
  52 def indent(delta = 3):
  53     global current_indent
  54     current_indent += delta
  55     yield
  56     current_indent -= delta
  57
  58
  59 class PrintCode(gl_XML.gl_print_base):
  60     def __init__(self):
  61         super(PrintCode, self).__init__()
  62
  63         self.name = 'gl_marshal.py'
  64         self.license = license.bsd_license_template % (
  65             'Copyright (C) 2012 Intel Corporation', 'INTEL CORPORATION')
  66
  67     def printRealHeader(self):
  68         print header
  69         print 'static inline int safe_mul(int a, int b)'
  70         print '{'
  71         print '    if (a < 0 || b < 0) return -1;'
  72         print '    if (a == 0 || b == 0) return 0;'
  73         print '    if (a > INT_MAX / b) return -1;'
  74         print '    return a * b;'
  75         print '}'
  76         print
  77
  78     def printRealFooter(self):
  79         pass
  80
  81     def print_sync_call(self, func):
  82         call = 'CALL_{0}(ctx->CurrentServerDispatch, ({1}))'.format(
  83             func.name, func.get_called_parameter_string())
  84         if func.return_type == 'void':
  85             out('{0};'.format(call))
  86         else:
  87             out('return {0};'.format(call))
  88
  89     def print_sync_dispatch(self, func):
  90         out('debug_print_sync_fallback("{0}");'.format(func.name))
  91         self.print_sync_call(func)
  92
  93     def print_sync_body(self, func):
  94         out('/* {0}: marshalled synchronously */'.format(func.name))
  95         out('static {0} GLAPIENTRY'.format(func.return_type))
  96         out('_mesa_marshal_{0}({1})'.format(func.name, func.get_parameter_string()))
  97         out('{')
  98         with indent():
  99             out('GET_CURRENT_CONTEXT(ctx);')
 100             out('_mesa_glthread_finish(ctx);')
 101             out('debug_print_sync("{0}");'.format(func.name))
 102             self.print_sync_call(func)
 103         out('}')
 104         out('')
 105         out('')
 106
 107     def print_async_dispatch(self, func):
 108         out('cmd = _mesa_glthread_allocate_command(ctx, '
 109             'DISPATCH_CMD_{0}, cmd_size);'.format(func.name))
 110         for p in func.fixed_params:
 111             if p.count:
 112                 out('memcpy(cmd->{0}, {0}, {1});'.format(
 113                         p.name, p.size_string()))
 114             else:
 115                 out('cmd->{0} = {0};'.format(p.name))
 116         if func.variable_params:
 117             out('char *variable_data = (char *) (cmd + 1);')
 118             for p in func.variable_params:
 119                 if p.img_null_flag:
 120                     out('cmd->{0}_null = !{0};'.format(p.name))
 121                     out('if (!cmd->{0}_null) {{'.format(p.name))
 122                     with indent():
 123                         out(('memcpy(variable_data, {0}, {1});').format(
 124                             p.name, p.size_string(False)))
 125                         out('variable_data += {0};'.format(
 126                             p.size_string(False)))
 127                     out('}')
 128                 else:
 129                     out(('memcpy(variable_data, {0}, {1});').format(
 130                         p.name, p.size_string(False)))
 131                     out('variable_data += {0};'.format(
 132                         p.size_string(False)))
 133
 134         if not func.fixed_params and not func.variable_params:
 135             out('(void) cmd;\n')
 136         out('_mesa_post_marshal_hook(ctx);')
 137
 138     def print_async_struct(self, func):
 139         out('struct marshal_cmd_{0}'.format(func.name))
 140         out('{')
 141         with indent():
 142             out('struct marshal_cmd_base cmd_base;')
 143             for p in func.fixed_params:
 144                 if p.count:
 145                     out('{0} {1}[{2}];'.format(
 146                             p.get_base_type_string(), p.name, p.count))
 147                 else:
 148                     out('{0} {1};'.format(p.type_string(), p.name))
 149
 150             for p in func.variable_params:
 151                 if p.img_null_flag:
 152                     out('bool {0}_null; /* If set, no data follows '
 153                         'for "{0}" */'.format(p.name))
 154
 155             for p in func.variable_params:
 156                 if p.count_scale != 1:
 157                     out(('/* Next {0} bytes are '
 158                          '{1} {2}[{3}][{4}] */').format(
 159                             p.size_string(), p.get_base_type_string(),
 160                             p.name, p.counter, p.count_scale))
 161                 else:
 162                     out(('/* Next {0} bytes are '
 163                          '{1} {2}[{3}] */').format(
 164                             p.size_string(), p.get_base_type_string(),
 165                             p.name, p.counter))
 166         out('};')
 167
 168     def print_async_unmarshal(self, func):
 169         out('static inline void')
 170         out(('_mesa_unmarshal_{0}(struct gl_context *ctx, '
 171              'const struct marshal_cmd_{0} *cmd)').format(func.name))
 172         out('{')
 173         with indent():
 174             for p in func.fixed_params:
 175                 if p.count:
 176                     p_decl = '{0} * {1} = cmd->{1};'.format(
 177                             p.get_base_type_string(), p.name)
 178                 else:
 179                     p_decl = '{0} {1} = cmd->{1};'.format(
 180                             p.type_string(), p.name)
 181
 182                 if not p_decl.startswith('const '):
 183                     # Declare all local function variables as const, even if
 184                     # the original parameter is not const.
 185                     p_decl = 'const ' + p_decl
 186
 187                 out(p_decl)
 188
 189             if func.variable_params:
 190                 for p in func.variable_params:
 191                     out('const {0} * {1};'.format(
 192                             p.get_base_type_string(), p.name))
 193                 out('const char *variable_data = (const char *) (cmd + 1);')
 194                 for p in func.variable_params:
 195                     out('{0} = (const {1} *) variable_data;'.format(
 196                             p.name, p.get_base_type_string()))
 197
 198                     if p.img_null_flag:
 199                         out('if (cmd->{0}_null)'.format(p.name))
 200                         with indent():
 201                             out('{0} = NULL;'.format(p.name))
 202                         out('else')
 203                         with indent():
 204                             out('variable_data += {0};'.format(p.size_string(False)))
 205                     else:
 206                         out('variable_data += {0};'.format(p.size_string(False)))
 207
 208             self.print_sync_call(func)
 209         out('}')
 210
 211     def validate_count_or_fallback(self, func):
 212         # Check that any counts for variable-length arguments might be < 0, in
 213         # which case the command alloc or the memcpy would blow up before we
 214         # get to the validation in Mesa core.
 215         for p in func.parameters:
 216             if p.is_variable_length():
 217                 out('if (unlikely({0} < 0)) {{'.format(p.size_string()))
 218                 with indent():
 219                     out('goto fallback_to_sync;')
 220                 out('}')
 221                 return True
 222         return False
 223
 224
 225     def print_async_marshal(self, func):
 226         need_fallback_sync = False
 227         out('static void GLAPIENTRY')
 228         out('_mesa_marshal_{0}({1})'.format(
 229                 func.name, func.get_parameter_string()))
 230         out('{')
 231         with indent():
 232             out('GET_CURRENT_CONTEXT(ctx);')
 233             struct = 'struct marshal_cmd_{0}'.format(func.name)
 234             size_terms = ['sizeof({0})'.format(struct)]
 235             for p in func.variable_params:
 236                 size = p.size_string()
 237                 if p.img_null_flag:
 238                     size = '({0} ? {1} : 0)'.format(p.name, size)
 239                 size_terms.append(size)
 240             out('size_t cmd_size = {0};'.format(' + '.join(size_terms)))
 241             out('{0} *cmd;'.format(struct))
 242
 243             out('debug_print_marshal("{0}");'.format(func.name))
 244
 245             need_fallback_sync = self.validate_count_or_fallback(func)
 246
 247             if func.marshal_fail:
 248                 out('if ({0}) {{'.format(func.marshal_fail))
 249                 with indent():
 250                     out('_mesa_glthread_finish(ctx);')
 251                     out('_mesa_glthread_restore_dispatch(ctx);')
 252                     self.print_sync_dispatch(func)
 253                     out('return;')
 254                 out('}')
 255
 256             out('if (cmd_size <= MARSHAL_MAX_CMD_SIZE) {')
 257             with indent():
 258                 self.print_async_dispatch(func)
 259                 out('return;')
 260             out('}')
 261
 262         out('')
 263         if need_fallback_sync:
 264             out('fallback_to_sync:')
 265         with indent():
 266             out('_mesa_glthread_finish(ctx);')
 267             self.print_sync_dispatch(func)
 268
 269         out('}')
 270
 271     def print_async_body(self, func):
 272         out('/* {0}: marshalled asynchronously */'.format(func.name))
 273         self.print_async_struct(func)
 274         self.print_async_unmarshal(func)
 275         self.print_async_marshal(func)
 276         out('')
 277         out('')
 278
 279     def print_unmarshal_dispatch_cmd(self, api):
 280         out('size_t')
 281         out('_mesa_unmarshal_dispatch_cmd(struct gl_context *ctx, '
 282             'const void *cmd)')
 283         out('{')
 284         with indent():
 285             out('const struct marshal_cmd_base *cmd_base = cmd;')
 286             out('switch (cmd_base->cmd_id) {')
 287             for func in api.functionIterateAll():
 288                 flavor = func.marshal_flavor()
 289                 if flavor in ('skip', 'sync'):
 290                     continue
 291                 out('case DISPATCH_CMD_{0}:'.format(func.name))
 292                 with indent():
 293                     out('debug_print_unmarshal("{0}");'.format(func.name))
 294                     out(('_mesa_unmarshal_{0}(ctx, (const struct marshal_cmd_{0} *)'
 295                          ' cmd);').format(func.name))
 296                     out('break;')
 297             out('default:')
 298             with indent():
 299                 out('assert(!"Unrecognized command ID");')
 300                 out('break;')
 301             out('}')
 302             out('')
 303             out('return cmd_base->cmd_size;')
 304         out('}')
 305         out('')
 306         out('')
 307
 308     def print_create_marshal_table(self, api):
 309         out('struct _glapi_table *')
 310         out('_mesa_create_marshal_table(const struct gl_context *ctx)')
 311         out('{')
 312         with indent():
 313             out('struct _glapi_table *table;')
 314             out('')
 315             out('table = _mesa_alloc_dispatch_table();')
 316             out('if (table == NULL)')
 317             with indent():
 318                 out('return NULL;')
 319             out('')
 320             for func in api.functionIterateAll():
 321                 if func.marshal_flavor() == 'skip':
 322                     continue
 323                 out('SET_{0}(table, _mesa_marshal_{0});'.format(func.name))
 324             out('')
 325             out('return table;')
 326         out('}')
 327         out('')
 328         out('')
 329
 330     def printBody(self, api):
 331         async_funcs = []
 332         for func in api.functionIterateAll():
 333             flavor = func.marshal_flavor()
 334             if flavor in ('skip', 'custom'):
 335                 continue
 336             elif flavor == 'async':
 337                 self.print_async_body(func)
 338                 async_funcs.append(func)
 339             elif flavor == 'sync':
 340                 self.print_sync_body(func)
 341         self.print_unmarshal_dispatch_cmd(api)
 342         self.print_create_marshal_table(api)
 343
 344
 345 def show_usage():
 346     print 'Usage: %s [-f input_file_name]' % sys.argv[0]
 347     sys.exit(1)
 348
 349
 350 if __name__ == '__main__':
 351     file_name = 'gl_API.xml'
 352
 353     try:
 354         (args, trail) = getopt.getopt(sys.argv[1:], 'm:f:')
 355     except Exception,e:
 356         show_usage()
 357
 358     for (arg,val) in args:
 359         if arg == '-f':
 360             file_name = val
 361
 362     printer = PrintCode()
 363
 364     api = gl_XML.parse_GL_API(file_name, marshal_XML.marshal_item_factory())
 365     printer.Print(api)