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 "glthread_marshal.h"
  35 #include "dispatch.h"
  36
  37 #define COMPAT (ctx->API != API_OPENGL_CORE)
  38
  39 static inline int safe_mul(int a, int b)
  40 {
  41     if (a < 0 || b < 0) return -1;
  42     if (a == 0 || b == 0) return 0;
  43     if (a > INT_MAX / b) return -1;
  44     return a * b;
  45 }
  46 """
  47
  48
  49 file_index = 0
  50 file_count = 1
  51 current_indent = 0
  52
  53
  54 def out(str):
  55     if str:
  56         print(' '*current_indent + str)
  57     else:
  58         print('')
  59
  60
  61 @contextlib.contextmanager
  62 def indent(delta = 3):
  63     global current_indent
  64     current_indent += delta
  65     yield
  66     current_indent -= delta
  67
  68
  69 class PrintCode(gl_XML.gl_print_base):
  70     def __init__(self):
  71         super(PrintCode, self).__init__()
  72
  73         self.name = 'gl_marshal.py'
  74         self.license = license.bsd_license_template % (
  75             'Copyright (C) 2012 Intel Corporation', 'INTEL CORPORATION')
  76
  77     def printRealHeader(self):
  78         print(header)
  79
  80     def printRealFooter(self):
  81         pass
  82
  83     def print_sync_call(self, func, unmarshal = 0):
  84         call = 'CALL_{0}(ctx->CurrentServerDispatch, ({1}))'.format(
  85             func.name, func.get_called_parameter_string())
  86         if func.return_type == 'void':
  87             out('{0};'.format(call))
  88             if func.marshal_call_after and not unmarshal:
  89                 out(func.marshal_call_after);
  90         else:
  91             out('return {0};'.format(call))
  92             assert not func.marshal_call_after
  93
  94     def print_sync_dispatch(self, func):
  95         self.print_sync_call(func)
  96
  97     def print_sync_body(self, func):
  98         out('/* {0}: marshalled synchronously */'.format(func.name))
  99         out('{0} GLAPIENTRY'.format(func.return_type))
 100         out('_mesa_marshal_{0}({1})'.format(func.name, func.get_parameter_string()))
 101         out('{')
 102         with indent():
 103             out('GET_CURRENT_CONTEXT(ctx);')
 104             out('_mesa_glthread_finish_before(ctx, "{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             i = 1
 122             for p in func.variable_params:
 123                 if p.img_null_flag:
 124                     out('cmd->{0}_null = !{0};'.format(p.name))
 125                     out('if (!cmd->{0}_null) {{'.format(p.name))
 126                     with indent():
 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                     out('}')
 131                 else:
 132                     out(('memcpy(variable_data, {0}, {0}_size);').format(p.name))
 133                     if i < len(func.variable_params):
 134                         out('variable_data += {0}_size;'.format(p.name))
 135                 i += 1
 136
 137         if not func.fixed_params and not func.variable_params:
 138             out('(void) cmd;')
 139
 140         if func.marshal_call_after:
 141             out(func.marshal_call_after);
 142
 143         # Uncomment this if you want to call _mesa_glthread_finish for debugging
 144         #out('_mesa_glthread_finish(ctx);')
 145
 146     def print_async_struct(self, func):
 147         out('struct marshal_cmd_{0}'.format(func.name))
 148         out('{')
 149         with indent():
 150             out('struct marshal_cmd_base cmd_base;')
 151             for p in func.fixed_params:
 152                 if p.count:
 153                     out('{0} {1}[{2}];'.format(
 154                             p.get_base_type_string(), p.name, p.count))
 155                 else:
 156                     type = p.type_string()
 157                     if type == 'GLenum':
 158                         type = 'GLenum16'
 159                     out('{0} {1};'.format(type, p.name))
 160
 161             for p in func.variable_params:
 162                 if p.img_null_flag:
 163                     out('bool {0}_null; /* If set, no data follows '
 164                         'for "{0}" */'.format(p.name))
 165
 166             for p in func.variable_params:
 167                 if p.count_scale != 1:
 168                     out(('/* Next {0} bytes are '
 169                          '{1} {2}[{3}][{4}] */').format(
 170                             p.size_string(marshal = 1), p.get_base_type_string(),
 171                             p.name, p.counter, p.count_scale))
 172                 else:
 173                     out(('/* Next {0} bytes are '
 174                          '{1} {2}[{3}] */').format(
 175                             p.size_string(marshal = 1), p.get_base_type_string(),
 176                             p.name, p.counter))
 177         out('};')
 178
 179     def print_async_unmarshal(self, func):
 180         out('void')
 181         out(('_mesa_unmarshal_{0}(struct gl_context *ctx, '
 182              'const struct marshal_cmd_{0} *cmd)').format(func.name))
 183         out('{')
 184         with indent():
 185             for p in func.fixed_params:
 186                 if p.count:
 187                     p_decl = '{0} * {1} = cmd->{1};'.format(
 188                             p.get_base_type_string(), p.name)
 189                 else:
 190                     p_decl = '{0} {1} = cmd->{1};'.format(
 191                             p.type_string(), p.name)
 192
 193                 if not p_decl.startswith('const '):
 194                     # Declare all local function variables as const, even if
 195                     # the original parameter is not const.
 196                     p_decl = 'const ' + p_decl
 197
 198                 out(p_decl)
 199
 200             if func.variable_params:
 201                 for p in func.variable_params:
 202                     out('{0} * {1};'.format(
 203                             p.get_base_type_string(), p.name))
 204                 out('const char *variable_data = (const char *) (cmd + 1);')
 205                 i = 1
 206                 for p in func.variable_params:
 207                     out('{0} = ({1} *) variable_data;'.format(
 208                             p.name, p.get_base_type_string()))
 209
 210                     if p.img_null_flag:
 211                         out('if (cmd->{0}_null)'.format(p.name))
 212                         with indent():
 213                             out('{0} = NULL;'.format(p.name))
 214                         if i < len(func.variable_params):
 215                             out('else')
 216                             with indent():
 217                                 out('variable_data += {0};'.format(p.size_string(False, marshal = 1)))
 218                     elif i < len(func.variable_params):
 219                         out('variable_data += {0};'.format(p.size_string(False, marshal = 1)))
 220                     i += 1
 221
 222             self.print_sync_call(func, unmarshal = 1)
 223         out('}')
 224
 225     def validate_count_or_fallback(self, func):
 226         # Check that any counts for variable-length arguments might be < 0, in
 227         # which case the command alloc or the memcpy would blow up before we
 228         # get to the validation in Mesa core.
 229         list = []
 230         for p in func.parameters:
 231             if p.is_variable_length():
 232                 list.append('{0}_size < 0'.format(p.name))
 233                 list.append('({0}_size > 0 && !{0})'.format(p.name))
 234
 235         if len(list) == 0:
 236             return
 237
 238         list.append('(unsigned)cmd_size > MARSHAL_MAX_CMD_SIZE')
 239
 240         out('if (unlikely({0})) {{'.format(' || '.join(list)))
 241         with indent():
 242             out('_mesa_glthread_finish_before(ctx, "{0}");'.format(func.name))
 243             self.print_sync_dispatch(func)
 244             out('return;')
 245         out('}')
 246
 247     def print_async_marshal(self, func):
 248         out('void GLAPIENTRY')
 249         out('_mesa_marshal_{0}({1})'.format(
 250                 func.name, func.get_parameter_string()))
 251         out('{')
 252         with indent():
 253             out('GET_CURRENT_CONTEXT(ctx);')
 254             for p in func.variable_params:
 255                 out('int {0}_size = {1};'.format(p.name, p.size_string(marshal = 1)))
 256
 257             struct = 'struct marshal_cmd_{0}'.format(func.name)
 258             size_terms = ['sizeof({0})'.format(struct)]
 259             for p in func.variable_params:
 260                 if p.img_null_flag:
 261                     size_terms.append('({0} ? {0}_size : 0)'.format(p.name))
 262                 else:
 263                     size_terms.append('{0}_size'.format(p.name))
 264             out('int cmd_size = {0};'.format(' + '.join(size_terms)))
 265             out('{0} *cmd;'.format(struct))
 266
 267             self.validate_count_or_fallback(func)
 268
 269             if func.marshal_sync:
 270                 out('if ({0}) {{'.format(func.marshal_sync))
 271                 with indent():
 272                     out('_mesa_glthread_finish_before(ctx, "{0}");'.format(func.name))
 273                     self.print_sync_dispatch(func)
 274                     out('return;')
 275                 out('}')
 276
 277         with indent():
 278             self.print_async_dispatch(func)
 279         out('}')
 280
 281     def print_async_body(self, func):
 282         out('/* {0}: marshalled asynchronously */'.format(func.name))
 283         self.print_async_struct(func)
 284         self.print_async_unmarshal(func)
 285         self.print_async_marshal(func)
 286         out('')
 287         out('')
 288
 289     def print_unmarshal_dispatch_cmd(self, api):
 290         out('const _mesa_unmarshal_func _mesa_unmarshal_dispatch[NUM_DISPATCH_CMD] = {')
 291         with indent():
 292             for func in api.functionIterateAll():
 293                 flavor = func.marshal_flavor()
 294                 if flavor in ('skip', 'sync'):
 295                     continue
 296                 out('[DISPATCH_CMD_{0}] = (_mesa_unmarshal_func)_mesa_unmarshal_{0},'.format(func.name))
 297         out('};')
 298         out('')
 299         out('')
 300
 301     def print_create_marshal_table(self, api):
 302         out('/* _mesa_create_marshal_table takes a long time to compile with -O2 */')
 303         out('#ifdef __GNUC__')
 304         out('__attribute__((optimize("O1")))')
 305         out('#endif')
 306         out('struct _glapi_table *')
 307         out('_mesa_create_marshal_table(const struct gl_context *ctx)')
 308         out('{')
 309         with indent():
 310             out('struct _glapi_table *table;')
 311             out('')
 312             out('table = _mesa_alloc_dispatch_table();')
 313             out('if (table == NULL)')
 314             with indent():
 315                 out('return NULL;')
 316             out('')
 317             for func in api.functionIterateAll():
 318                 if func.marshal_flavor() == 'skip':
 319                     continue
 320                 # Don't use the SET_* functions, because they increase compile time
 321                 # by 20 seconds (on Ryzen 1700X).
 322                 out('if (_gloffset_{0} >= 0)'.format(func.name))
 323                 out('   ((_glapi_proc *)(table))[_gloffset_{0}] = (_glapi_proc)_mesa_marshal_{0};'
 324                     .format(func.name))
 325             out('')
 326             out('return table;')
 327         out('}')
 328         out('')
 329         out('')
 330
 331     def printBody(self, api):
 332         # The first file only contains the dispatch tables
 333         if file_index == 0:
 334             self.print_unmarshal_dispatch_cmd(api)
 335             self.print_create_marshal_table(api)
 336             return
 337
 338         # The remaining files contain the marshal and unmarshal functions
 339         func_per_file = (len(api.functionIterateAll()) // (file_count - 1)) + 1
 340         i = -1
 341         for func in api.functionIterateAll():
 342             i += 1
 343             if i // func_per_file != (file_index - 1):
 344                 continue
 345
 346             flavor = func.marshal_flavor()
 347             if flavor in ('skip', 'custom'):
 348                 continue
 349             elif flavor == 'async':
 350                 self.print_async_body(func)
 351             elif flavor == 'sync':
 352                 self.print_sync_body(func)
 353
 354
 355 def show_usage():
 356     print('Usage: %s [-f input_file_name]' % sys.argv[0])
 357     sys.exit(1)
 358
 359
 360 if __name__ == '__main__':
 361     file_name = 'gl_API.xml'
 362
 363     try:
 364         (args, trail) = getopt.getopt(sys.argv[1:], 'm:f:i:n:')
 365     except Exception:
 366         show_usage()
 367
 368     for (arg,val) in args:
 369         if arg == '-f':
 370             file_name = val
 371         elif arg == '-i':
 372             file_index = int(val)
 373         elif arg == '-n':
 374             file_count = int(val)
 375
 376     assert file_index < file_count
 377     printer = PrintCode()
 378
 379     api = gl_XML.parse_GL_API(file_name, marshal_XML.marshal_item_factory())
 380     printer.Print(api)