1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
# coding=utf-8
#
# Copyright © 2011 Intel Corporation
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice (including the next
# paragraph) shall be included in all copies or substantial portions of the
# Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
# Generate a pair of glsl parser tests for every overloaded version of
# every built-in function, which test that the built-in functions are
# handled properly when applied to constant arguments inside an array
# size declaration.
#
# In each pair of generated tests, one test exercises the built-in
# function in vertex shaders, and the other exercises it in fragment
# shaders.
#
# This program outputs, to stdout, the name of each file it generates.
# With the optional argument --names-only, it only outputs the names
# of the files; it doesn't generate them.
from builtin_function import *
import abc
import optparse
import os
import os.path
class ParserTest(object):
"""Class used to build a test of a single built-in. This is an
abstract base class--derived types should override test_suffix()
and output_var().
"""
def __init__(self, signature, test_vectors):
"""Prepare to build a test for a single built-in. signature
is the signature of the built-in (a key from the
builtin_function.test_suite dict), and test_vectors is the
list of test vectors for testing the given builtin (the
corresponding value from the builtin_function.test_suite
dict).
"""
self.__signature = signature
self.__test_vectors = test_vectors
def glsl_version(self):
if self.__signature.version_introduced < '1.20':
# Before version 1.20, built-in function invocations
# weren't allowed in constant expressions. So even if
# this built-in was introduced prior to 1.20, test it in
# version 1.20.
return '1.20'
else:
return self.__signature.version_introduced
def version_directive(self):
return '#version {0}\n'.format(self.glsl_version().replace('.', ''))
@abc.abstractmethod
def test_suffix(self):
"""Return the suffix that should be used in the test file name
to identify the type of shader, e.g. "vert" for a vertex
shader test.
"""
def make_condition(self, test_vector):
"""Generate a GLSL constant expression that should evaluate to
true if the GLSL compiler's constant evaluation produces the
correct result for the given test vector, and false if not.
"""
invocation = self.__signature.template.format(
*[glsl_constant(x) for x in test_vector.arguments])
if self.__signature.rettype.base_type == glsl_float:
# Test floating-point values within tolerance
if self.__signature.name == 'distance':
# Don't use the distance() function to test itself.
return '{0} <= {1} && {1} <= {2}'.format(
test_vector.result - test_vector.tolerance,
invocation,
test_vector.result + test_vector.tolerance)
elif self.__signature.rettype.is_matrix:
# We can't apply distance() to matrices. So apply it
# to each column and root-sum-square the results. It
# is safe to use pow() here because its behavior is
# verified in the pow() tests.
terms = []
for col in xrange(self.__signature.rettype.num_cols):
terms.append('pow(distance({0}[{1}], {2}), 2)'.format(
invocation, col,
glsl_constant(test_vector.result[:,col])))
rss_distance = ' + '.join(terms)
sq_tolerance = test_vector.tolerance * test_vector.tolerance
return '{0} <= {1}'.format(
rss_distance, glsl_constant(sq_tolerance))
else:
return 'distance({0}, {1}) <= {2}'.format(
invocation, glsl_constant(test_vector.result),
glsl_constant(test_vector.tolerance))
else:
# Test non-floating point values exactly
assert not self.__signature.rettype.is_matrix
if self.__signature.name == 'equal':
# Don't use the equal() function to test itself.
assert self.__signature.rettype.is_vector
terms = []
for row in xrange(self.__signature.rettype.num_rows):
terms.append('{0}[{1}] == {2}'.format(
invocation, row,
glsl_constant(test_vector.result[row])))
return ' && '.join(terms)
elif self.__signature.rettype.is_vector:
return 'all(equal({0}, {1}))'.format(
invocation, glsl_constant(test_vector.result))
else:
return '{0} == {1}'.format(
invocation, glsl_constant(test_vector.result))
def make_shader(self):
"""Generate the shader code necessary to test the built-in."""
shader = self.version_directive()
shader += '\n'
shader += 'void main()\n'
shader += '{\n'
lengths = []
for i, test_vector in enumerate(self.__test_vectors):
shader += ' float[{0} ? 1 : -1] array{1};\n'.format(
self.make_condition(test_vector), i)
lengths.append('array{0}.length()'.format(i))
shader += ' {0} = vec4({1});\n'.format(
self.output_var(), ' + '.join(lengths))
shader += '}\n'
return shader
def filename(self):
argtype_names = '-'.join(
str(argtype) for argtype in self.__signature.argtypes)
return os.path.join(
'spec', 'glsl-{0}'.format(self.glsl_version()),
'compiler', 'built-in-functions',
'{0}-{1}.{2}'.format(
self.__signature.name, argtype_names, self.test_suffix()))
def generate_parser_test(self):
"""Generate the test and write it to the output file."""
parser_test = '/* [config]\n'
parser_test += ' * expect_result: pass\n'
parser_test += ' * glsl_version: {0}\n'.format(self.glsl_version())
parser_test += ' * [end config]\n'
parser_test += ' *\n'
parser_test += ' * Check that the following test vectors are constant folded correctly:\n'
for test_vector in self.__test_vectors:
parser_test += ' * {0} => {1}\n'.format(
self.__signature.template.format(
*[glsl_constant(arg) for arg in test_vector.arguments]),
glsl_constant(test_vector.result))
parser_test += ' */\n'
parser_test += self.make_shader()
filename = self.filename()
dirname = os.path.dirname(filename)
if not os.path.exists(dirname):
os.makedirs(dirname)
with open(filename, 'w') as f:
f.write(parser_test)
class VertexParserTest(ParserTest):
"""Derived class for tests that exercise the built-in in a vertex
shader.
"""
def test_suffix(self):
return 'vert'
def output_var(self):
return 'gl_Position'
class FragmentParserTest(ParserTest):
"""Derived class for tests that exercise the built-in in a fagment
shader.
"""
def test_suffix(self):
return 'frag'
def output_var(self):
return 'gl_FragColor'
def all_tests():
for signature, test_vectors in sorted(test_suite.items()):
yield VertexParserTest(signature, test_vectors)
yield FragmentParserTest(signature, test_vectors)
def main():
desc = 'Generate shader tests that test built-in functions using constant array sizes'
usage = 'usage: %prog [-h] [--names-only]'
parser = optparse.OptionParser(description=desc, usage=usage)
parser.add_option(
'--names-only', dest='names_only', action='store_true',
help="Don't output files, just generate a list of filenames to stdout")
options, args = parser.parse_args()
for test in all_tests():
if not options.names_only:
test.generate_parser_test()
print test.filename()
if __name__ == '__main__':
main()
|
