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# This script generates the file api_exec.c, which contains
24# _mesa_initialize_exec_table().  It is responsible for populating all
25# entries in the "exec" dispatch table that aren't dynamic.
26
27from __future__ import print_function
28
29import argparse
30import collections
31import license
32import gl_XML
33import sys
34import apiexec
35
36
37exec_flavor_map = {
38    'dynamic': None,
39    'mesa': '_mesa_',
40    'skip': None,
41    }
42
43
44header = """/**
45 * \\file api_exec.c
46 * Initialize dispatch table.
47 */
48
49
50#include "main/accum.h"
51#include "main/api_exec.h"
52#include "main/arbprogram.h"
53#include "main/atifragshader.h"
54#include "main/attrib.h"
55#include "main/blend.h"
56#include "main/blit.h"
57#include "main/bufferobj.h"
58#include "main/arrayobj.h"
59#include "main/bbox.h"
60#include "main/buffers.h"
61#include "main/clear.h"
62#include "main/clip.h"
63#include "main/colortab.h"
64#include "main/compute.h"
65#include "main/condrender.h"
66#include "main/conservativeraster.h"
67#include "main/context.h"
68#include "main/convolve.h"
69#include "main/copyimage.h"
70#include "main/depth.h"
71#include "main/debug_output.h"
72#include "main/dlist.h"
73#include "main/draw.h"
74#include "main/drawpix.h"
75#include "main/drawtex.h"
76#include "main/rastpos.h"
77#include "main/enable.h"
78#include "main/errors.h"
79#include "main/es1_conversion.h"
80#include "main/eval.h"
81#include "main/externalobjects.h"
82#include "main/get.h"
83#include "main/glspirv.h"
84#include "main/feedback.h"
85#include "main/fog.h"
86#include "main/fbobject.h"
87#include "main/framebuffer.h"
88#include "main/genmipmap.h"
89#include "main/hint.h"
90#include "main/histogram.h"
91#include "main/light.h"
92#include "main/lines.h"
93#include "main/matrix.h"
94#include "main/multisample.h"
95#include "main/objectlabel.h"
96#include "main/objectpurge.h"
97#include "main/performance_monitor.h"
98#include "main/performance_query.h"
99#include "main/pipelineobj.h"
100#include "main/pixel.h"
101#include "main/pixelstore.h"
102#include "main/points.h"
103#include "main/polygon.h"
104#include "main/program_resource.h"
105#include "main/querymatrix.h"
106#include "main/queryobj.h"
107#include "main/readpix.h"
108#include "main/samplerobj.h"
109#include "main/scissor.h"
110#include "main/stencil.h"
111#include "main/texenv.h"
112#include "main/texgetimage.h"
113#include "main/teximage.h"
114#include "main/texgen.h"
115#include "main/texobj.h"
116#include "main/texparam.h"
117#include "main/texstate.h"
118#include "main/texstorage.h"
119#include "main/barrier.h"
120#include "main/texturebindless.h"
121#include "main/textureview.h"
122#include "main/transformfeedback.h"
123#include "main/mtypes.h"
124#include "main/varray.h"
125#include "main/viewport.h"
126#include "main/shaderapi.h"
127#include "main/shaderimage.h"
128#include "main/uniforms.h"
129#include "main/syncobj.h"
130#include "main/formatquery.h"
131#include "main/dispatch.h"
132#include "main/vdpau.h"
133
134
135/**
136 * Initialize a context's exec table with pointers to Mesa's supported
137 * GL functions.
138 *
139 * This function depends on ctx->Version.
140 *
141 * \param ctx  GL context to which \c exec belongs.
142 */
143void
144_mesa_initialize_exec_table(struct gl_context *ctx)
145{
146   struct _glapi_table *exec;
147
148   exec = ctx->Exec;
149   assert(exec != NULL);
150
151   assert(ctx->Version > 0);
152
153   _mesa_initialize_exec_dispatch(ctx, exec);
154"""
155
156
157footer = """
158}
159"""
160
161
162class PrintCode(gl_XML.gl_print_base):
163
164    def __init__(self):
165        gl_XML.gl_print_base.__init__(self)
166
167        self.name = 'gl_genexec.py'
168        self.license = license.bsd_license_template % (
169            'Copyright (C) 2012 Intel Corporation',
170            'Intel Corporation')
171
172    def printRealHeader(self):
173        print(header)
174
175    def printRealFooter(self):
176        print(footer)
177
178    def printBody(self, api):
179        # Collect SET_* calls by the condition under which they should
180        # be called.
181        settings_by_condition = collections.defaultdict(lambda: [])
182        for f in api.functionIterateAll():
183            if f.exec_flavor not in exec_flavor_map:
184                raise Exception(
185                    'Unrecognized exec flavor {0!r}'.format(f.exec_flavor))
186            condition_parts = []
187            if f.name in apiexec.functions:
188                ex = apiexec.functions[f.name]
189                unconditional_count = 0
190
191                if ex.compatibility is not None:
192                    condition_parts.append('ctx->API == API_OPENGL_COMPAT')
193                    unconditional_count += 1
194
195                if ex.core is not None:
196                    condition_parts.append('ctx->API == API_OPENGL_CORE')
197                    unconditional_count += 1
198
199                if ex.es1 is not None:
200                    condition_parts.append('ctx->API == API_OPENGLES')
201                    unconditional_count += 1
202
203                if ex.es2 is not None:
204                    if ex.es2 > 20:
205                        condition_parts.append('(ctx->API == API_OPENGLES2 && ctx->Version >= {0})'.format(ex.es2))
206                    else:
207                        condition_parts.append('ctx->API == API_OPENGLES2')
208                        unconditional_count += 1
209
210                # If the function is unconditionally available in all four
211                # APIs, then it is always available.  Replace the complex
212                # tautology condition with "true" and let GCC do the right
213                # thing.
214                if unconditional_count == 4:
215                    condition_parts = ['true']
216            else:
217                if f.desktop:
218                    if f.deprecated:
219                        condition_parts.append('ctx->API == API_OPENGL_COMPAT')
220                    else:
221                        condition_parts.append('_mesa_is_desktop_gl(ctx)')
222                if 'es1' in f.api_map:
223                    condition_parts.append('ctx->API == API_OPENGLES')
224                if 'es2' in f.api_map:
225                    if f.api_map['es2'] > 2.0:
226                        condition_parts.append('(ctx->API == API_OPENGLES2 && ctx->Version >= {0})'.format(int(f.api_map['es2'] * 10)))
227                    else:
228                        condition_parts.append('ctx->API == API_OPENGLES2')
229
230            if not condition_parts:
231                # This function does not exist in any API.
232                continue
233            condition = ' || '.join(condition_parts)
234            prefix = exec_flavor_map[f.exec_flavor]
235            if prefix is None:
236                # This function is not implemented, or is dispatched
237                # dynamically.
238                continue
239            if f.has_no_error_variant:
240                no_error_condition = '_mesa_is_no_error_enabled(ctx) && ({0})'.format(condition)
241                error_condition = '!_mesa_is_no_error_enabled(ctx) && ({0})'.format(condition)
242                settings_by_condition[no_error_condition].append(
243                    'SET_{0}(exec, {1}{0}_no_error);'.format(f.name, prefix, f.name))
244                settings_by_condition[error_condition].append(
245                    'SET_{0}(exec, {1}{0});'.format(f.name, prefix, f.name))
246            else:
247                settings_by_condition[condition].append(
248                    'SET_{0}(exec, {1}{0});'.format(f.name, prefix, f.name))
249        # Print out an if statement for each unique condition, with
250        # the SET_* calls nested inside it.
251        for condition in sorted(settings_by_condition.keys()):
252            print('   if ({0}) {{'.format(condition))
253            for setting in sorted(settings_by_condition[condition]):
254                print('      {0}'.format(setting))
255            print('   }')
256
257
258def _parser():
259    """Parse arguments and return namespace."""
260    parser = argparse.ArgumentParser()
261    parser.add_argument('-f',
262                        dest='filename',
263                        default='gl_and_es_API.xml',
264                        help='an xml file describing an API')
265    return parser.parse_args()
266
267
268def main():
269    """Main function."""
270    args = _parser()
271    printer = PrintCode()
272    api = gl_XML.parse_GL_API(args.filename)
273    printer.Print(api)
274
275
276if __name__ == '__main__':
277    main()
278