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