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