src/mapi/glapi/gen/gl_marshal.py

   1
   2 # Copyright (C) 2012 Intel Corporation
   3 #
   4 # Permission is hereby granted, free of charge, to any person obtaining a
   5 # copy of this software and associated documentation files (the "Software"),
   6 # to deal in the Software without restriction, including without limitation
   7 # the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8 # and/or sell copies of the Software, and to permit persons to whom the
   9 # Software is furnished to do so, subject to the following conditions:
  10 #
  11 # The above copyright notice and this permission notice (including the next
  12 # paragraph) shall be included in all copies or substantial portions of the
  13 # Software.
  14 #
  15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18 # THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21 # IN THE SOFTWARE.
  22
  23 from __future__ import print_function
  24
  25 import contextlib
  26 import getopt
  27 import gl_XML
  28 import license
  29 import marshal_XML
  30 import sys
  31
  32 header = """
  33 #include "api_exec.h"
  34 #include "context.h"
  35 #include "dispatch.h"
  36 #include "glthread.h"
  37 #include "marshal.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         self.print_sync_call(func)
  91
  92     def print_sync_body(self, func):
  93         out('/* {0}: marshalled synchronously */'.format(func.name))
  94         out('static {0} GLAPIENTRY'.format(func.return_type))
  95         out('_mesa_marshal_{0}({1})'.format(func.name, func.get_parameter_string()))
  96         out('{')
  97         with indent():
  98             out('GET_CURRENT_CONTEXT(ctx);')
  99             out('_mesa_glthread_finish_before(ctx, "{0}");'.format(func.name))
 100             self.print_sync_call(func)
 101         out('}')
 102         out('')
 103         out('')
 104
 105     def print_async_dispatch(self, func):
 106         out('cmd = _mesa_glthread_allocate_command(ctx, '
 107             'DISPATCH_CMD_{0}, cmd_size);'.format(func.name))
 108         for p in func.fixed_params:
 109             if p.count:
 110                 out('memcpy(cmd->{0}, {0}, {1});'.format(
 111                         p.name, p.size_string()))
 112             else:
 113                 out('cmd->{0} = {0};'.format(p.name))
 114         if func.variable_params:
 115             out('char *variable_data = (char *) (cmd + 1);')
 116             i = 1
 117             for p in func.variable_params:
 118                 if p.img_null_flag:
 119                     out('cmd->{0}_null = !{0};'.format(p.name))
 120                     out('if (!cmd->{0}_null) {{'.format(p.name))
 121                     with indent():
 122                         out(('memcpy(variable_data, {0}, {0}_size);').format(p.name))
 123                         if i < len(func.variable_params):
 124                             out('variable_data += {0}_size;'.format(p.name))
 125                     out('}')
 126                 else:
 127                     out(('memcpy(variable_data, {0}, {0}_size);').format(p.name))
 128                     if i < len(func.variable_params):
 129                         out('variable_data += {0}_size;'.format(p.name))
 130                 i += 1
 131
 132         if not func.fixed_params and not func.variable_params:
 133             out('(void) cmd;\n')
 134
 135         # Uncomment this if you want to call _mesa_glthread_finish for debugging
 136         #out('_mesa_glthread_finish(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('{0} * {1};'.format(
 192                             p.get_base_type_string(), p.name))
 193                 out('const char *variable_data = (const char *) (cmd + 1);')
 194                 i = 1
 195                 for p in func.variable_params:
 196                     out('{0} = ({1} *) variable_data;'.format(
 197                             p.name, p.get_base_type_string()))
 198
 199                     if p.img_null_flag:
 200                         out('if (cmd->{0}_null)'.format(p.name))
 201                         with indent():
 202                             out('{0} = NULL;'.format(p.name))
 203                         if i < len(func.variable_params):
 204                             out('else')
 205                             with indent():
 206                                 out('variable_data += {0};'.format(p.size_string(False)))
 207                     elif i < len(func.variable_params):
 208                         out('variable_data += {0};'.format(p.size_string(False)))
 209                     i += 1
 210
 211             self.print_sync_call(func)
 212         out('}')
 213
 214     def validate_count_or_fallback(self, func):
 215         # Check that any counts for variable-length arguments might be < 0, in
 216         # which case the command alloc or the memcpy would blow up before we
 217         # get to the validation in Mesa core.
 218         for p in func.parameters:
 219             if p.is_variable_length():
 220                 out('if (unlikely({0}_size < 0)) {{'.format(p.name))
 221                 with indent():
 222                     out('goto fallback_to_sync;')
 223                 out('}')
 224                 return True
 225         return False
 226
 227
 228     def print_async_marshal(self, func):
 229         need_fallback_sync = False
 230         out('static void GLAPIENTRY')
 231         out('_mesa_marshal_{0}({1})'.format(
 232                 func.name, func.get_parameter_string()))
 233         out('{')
 234         with indent():
 235             out('GET_CURRENT_CONTEXT(ctx);')
 236             for p in func.variable_params:
 237                 out('int {0}_size = {1};'.format(p.name, p.size_string()))
 238
 239             struct = 'struct marshal_cmd_{0}'.format(func.name)
 240             size_terms = ['sizeof({0})'.format(struct)]
 241             for p in func.variable_params:
 242                 if p.img_null_flag:
 243                     size_terms.append('({0} ? {0}_size : 0)'.format(p.name))
 244                 else:
 245                     size_terms.append('{0}_size'.format(p.name))
 246             out('int cmd_size = {0};'.format(' + '.join(size_terms)))
 247             out('{0} *cmd;'.format(struct))
 248
 249             out('debug_print_marshal("{0}");'.format(func.name))
 250
 251             need_fallback_sync = self.validate_count_or_fallback(func)
 252
 253             if func.marshal_fail:
 254                 out('if ({0}) {{'.format(func.marshal_fail))
 255                 with indent():
 256                     out('_mesa_glthread_disable(ctx, "{0}");'.format(func.name))
 257                     self.print_sync_dispatch(func)
 258                     out('return;')
 259                 out('}')
 260
 261         if len(func.variable_params) > 0:
 262             with indent():
 263                 out('if (cmd_size <= MARSHAL_MAX_CMD_SIZE) {')
 264                 with indent():
 265                     self.print_async_dispatch(func)
 266                     out('return;')
 267                 out('}')
 268             out('')
 269             if need_fallback_sync:
 270                 out('fallback_to_sync:')
 271             with indent():
 272                 out('_mesa_glthread_finish_before(ctx, "{0}");'.format(func.name))
 273                 self.print_sync_dispatch(func)
 274         else:
 275             with indent():
 276                 self.print_async_dispatch(func)
 277                 assert not need_fallback_sync
 278         out('}')
 279
 280     def print_async_body(self, func):
 281         out('/* {0}: marshalled asynchronously */'.format(func.name))
 282         self.print_async_struct(func)
 283         self.print_async_unmarshal(func)
 284         self.print_async_marshal(func)
 285         out('')
 286         out('')
 287
 288     def print_unmarshal_dispatch_cmd(self, api):
 289         out('const _mesa_unmarshal_func _mesa_unmarshal_dispatch[NUM_DISPATCH_CMD] = {')
 290         with indent():
 291             for func in api.functionIterateAll():
 292                 flavor = func.marshal_flavor()
 293                 if flavor in ('skip', 'sync'):
 294                     continue
 295                 out('[DISPATCH_CMD_{0}] = (_mesa_unmarshal_func)_mesa_unmarshal_{0},'.format(func.name))
 296         out('};')
 297         out('')
 298         out('')
 299
 300     def print_create_marshal_table(self, api):
 301         out('struct _glapi_table *')
 302         out('_mesa_create_marshal_table(const struct gl_context *ctx)')
 303         out('{')
 304         with indent():
 305             out('struct _glapi_table *table;')
 306             out('')
 307             out('table = _mesa_alloc_dispatch_table();')
 308             out('if (table == NULL)')
 309             with indent():
 310                 out('return NULL;')
 311             out('')
 312             for func in api.functionIterateAll():
 313                 if func.marshal_flavor() == 'skip':
 314                     continue
 315                 out('SET_{0}(table, _mesa_marshal_{0});'.format(func.name))
 316             out('')
 317             out('return table;')
 318         out('}')
 319         out('')
 320         out('')
 321
 322     def printBody(self, api):
 323         async_funcs = []
 324         for func in api.functionIterateAll():
 325             flavor = func.marshal_flavor()
 326             if flavor in ('skip', 'custom'):
 327                 continue
 328             elif flavor == 'async':
 329                 self.print_async_body(func)
 330                 async_funcs.append(func)
 331             elif flavor == 'sync':
 332                 self.print_sync_body(func)
 333         self.print_unmarshal_dispatch_cmd(api)
 334         self.print_create_marshal_table(api)
 335
 336
 337 def show_usage():
 338     print('Usage: %s [-f input_file_name]' % sys.argv[0])
 339     sys.exit(1)
 340
 341
 342 if __name__ == '__main__':
 343     file_name = 'gl_API.xml'
 344
 345     try:
 346         (args, trail) = getopt.getopt(sys.argv[1:], 'm:f:')
 347     except Exception:
 348         show_usage()
 349
 350     for (arg,val) in args:
 351         if arg == '-f':
 352             file_name = val
 353
 354     printer = PrintCode()
 355
 356     api = gl_XML.parse_GL_API(file_name, marshal_XML.marshal_item_factory())
 357     printer.Print(api)