nir: Recognize product of open-coded pow()s.
[mesa.git] / src / compiler / nir / nir_opt_algebraic.py
1 #! /usr/bin/env python
2 #
3 # Copyright (C) 2014 Intel Corporation
4 #
5 # Permission is hereby granted, free of charge, to any person obtaining a
6 # copy of this software and associated documentation files (the "Software"),
7 # to deal in the Software without restriction, including without limitation
8 # the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 # and/or sell copies of the Software, and to permit persons to whom the
10 # Software is furnished to do so, subject to the following conditions:
11 #
12 # The above copyright notice and this permission notice (including the next
13 # paragraph) shall be included in all copies or substantial portions of the
14 # Software.
15 #
16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 # THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22 # IN THE SOFTWARE.
23 #
24 # Authors:
25 # Jason Ekstrand (jason@jlekstrand.net)
26
27 import nir_algebraic
28
29 # Convenience variables
30 a = 'a'
31 b = 'b'
32 c = 'c'
33 d = 'd'
34
35 # Written in the form (<search>, <replace>) where <search> is an expression
36 # and <replace> is either an expression or a value. An expression is
37 # defined as a tuple of the form (<op>, <src0>, <src1>, <src2>, <src3>)
38 # where each source is either an expression or a value. A value can be
39 # either a numeric constant or a string representing a variable name.
40 #
41 # Variable names are specified as "[#]name[@type]" where "#" inicates that
42 # the given variable will only match constants and the type indicates that
43 # the given variable will only match values from ALU instructions with the
44 # given output type.
45 #
46 # For constants, you have to be careful to make sure that it is the right
47 # type because python is unaware of the source and destination types of the
48 # opcodes.
49
50 optimizations = [
51 (('fneg', ('fneg', a)), a),
52 (('ineg', ('ineg', a)), a),
53 (('fabs', ('fabs', a)), ('fabs', a)),
54 (('fabs', ('fneg', a)), ('fabs', a)),
55 (('iabs', ('iabs', a)), ('iabs', a)),
56 (('iabs', ('ineg', a)), ('iabs', a)),
57 (('fadd', a, 0.0), a),
58 (('iadd', a, 0), a),
59 (('usadd_4x8', a, 0), a),
60 (('usadd_4x8', a, ~0), ~0),
61 (('fadd', ('fmul', a, b), ('fmul', a, c)), ('fmul', a, ('fadd', b, c))),
62 (('iadd', ('imul', a, b), ('imul', a, c)), ('imul', a, ('iadd', b, c))),
63 (('fadd', ('fneg', a), a), 0.0),
64 (('iadd', ('ineg', a), a), 0),
65 (('iadd', ('ineg', a), ('iadd', a, b)), b),
66 (('iadd', a, ('iadd', ('ineg', a), b)), b),
67 (('fadd', ('fneg', a), ('fadd', a, b)), b),
68 (('fadd', a, ('fadd', ('fneg', a), b)), b),
69 (('fmul', a, 0.0), 0.0),
70 (('imul', a, 0), 0),
71 (('umul_unorm_4x8', a, 0), 0),
72 (('umul_unorm_4x8', a, ~0), a),
73 (('fmul', a, 1.0), a),
74 (('imul', a, 1), a),
75 (('fmul', a, -1.0), ('fneg', a)),
76 (('imul', a, -1), ('ineg', a)),
77 (('ffma', 0.0, a, b), b),
78 (('ffma', a, 0.0, b), b),
79 (('ffma', a, b, 0.0), ('fmul', a, b)),
80 (('ffma', a, 1.0, b), ('fadd', a, b)),
81 (('ffma', 1.0, a, b), ('fadd', a, b)),
82 (('flrp', a, b, 0.0), a),
83 (('flrp', a, b, 1.0), b),
84 (('flrp', a, a, b), a),
85 (('flrp', 0.0, a, b), ('fmul', a, b)),
86 (('flrp', a, b, c), ('fadd', ('fmul', c, ('fsub', b, a)), a), 'options->lower_flrp'),
87 (('ffract', a), ('fsub', a, ('ffloor', a)), 'options->lower_ffract'),
88 (('fadd', ('fmul', a, ('fadd', 1.0, ('fneg', c))), ('fmul', b, c)), ('flrp', a, b, c), '!options->lower_flrp'),
89 (('fadd', a, ('fmul', c, ('fadd', b, ('fneg', a)))), ('flrp', a, b, c), '!options->lower_flrp'),
90 (('ffma', a, b, c), ('fadd', ('fmul', a, b), c), 'options->lower_ffma'),
91 (('fadd', ('fmul', a, b), c), ('ffma', a, b, c), '!options->lower_ffma'),
92 # Comparison simplifications
93 (('inot', ('flt', a, b)), ('fge', a, b)),
94 (('inot', ('fge', a, b)), ('flt', a, b)),
95 (('inot', ('feq', a, b)), ('fne', a, b)),
96 (('inot', ('fne', a, b)), ('feq', a, b)),
97 (('inot', ('ilt', a, b)), ('ige', a, b)),
98 (('inot', ('ige', a, b)), ('ilt', a, b)),
99 (('inot', ('ieq', a, b)), ('ine', a, b)),
100 (('inot', ('ine', a, b)), ('ieq', a, b)),
101 (('fge', ('fneg', ('fabs', a)), 0.0), ('feq', a, 0.0)),
102 (('bcsel', ('flt', a, b), a, b), ('fmin', a, b)),
103 (('bcsel', ('flt', a, b), b, a), ('fmax', a, b)),
104 (('bcsel', ('inot', 'a@bool'), b, c), ('bcsel', a, c, b)),
105 (('bcsel', a, ('bcsel', a, b, c), d), ('bcsel', a, b, d)),
106 (('fmin', a, a), a),
107 (('fmax', a, a), a),
108 (('imin', a, a), a),
109 (('imax', a, a), a),
110 (('umin', a, a), a),
111 (('umax', a, a), a),
112 (('fmin', ('fmax', a, 0.0), 1.0), ('fsat', a), '!options->lower_fsat'),
113 (('fmax', ('fmin', a, 1.0), 0.0), ('fsat', a), '!options->lower_fsat'),
114 (('fsat', a), ('fmin', ('fmax', a, 0.0), 1.0), 'options->lower_fsat'),
115 (('fsat', ('fsat', a)), ('fsat', a)),
116 (('fmin', ('fmax', ('fmin', ('fmax', a, 0.0), 1.0), 0.0), 1.0), ('fmin', ('fmax', a, 0.0), 1.0)),
117 (('ior', ('flt', a, b), ('flt', a, c)), ('flt', a, ('fmax', b, c))),
118 (('ior', ('flt', a, c), ('flt', b, c)), ('flt', ('fmin', a, b), c)),
119 (('ior', ('fge', a, b), ('fge', a, c)), ('fge', a, ('fmin', b, c))),
120 (('ior', ('fge', a, c), ('fge', b, c)), ('fge', ('fmax', a, b), c)),
121 (('slt', a, b), ('b2f', ('flt', a, b)), 'options->lower_scmp'),
122 (('sge', a, b), ('b2f', ('fge', a, b)), 'options->lower_scmp'),
123 (('seq', a, b), ('b2f', ('feq', a, b)), 'options->lower_scmp'),
124 (('sne', a, b), ('b2f', ('fne', a, b)), 'options->lower_scmp'),
125 (('fne', ('fneg', a), a), ('fne', a, 0.0)),
126 (('feq', ('fneg', a), a), ('feq', a, 0.0)),
127 # Emulating booleans
128 (('imul', ('b2i', a), ('b2i', b)), ('b2i', ('iand', a, b))),
129 (('fmul', ('b2f', a), ('b2f', b)), ('b2f', ('iand', a, b))),
130 (('fsat', ('fadd', ('b2f', a), ('b2f', b))), ('b2f', ('ior', a, b))),
131 (('iand', 'a@bool', 1.0), ('b2f', a)),
132 (('flt', ('fneg', ('b2f', a)), 0), a), # Generated by TGSI KILL_IF.
133 (('flt', ('fsub', 0.0, ('b2f', a)), 0), a), # Generated by TGSI KILL_IF.
134 # Comparison with the same args. Note that these are not done for
135 # the float versions because NaN always returns false on float
136 # inequalities.
137 (('ilt', a, a), False),
138 (('ige', a, a), True),
139 (('ieq', a, a), True),
140 (('ine', a, a), False),
141 (('ult', a, a), False),
142 (('uge', a, a), True),
143 # Logical and bit operations
144 (('fand', a, 0.0), 0.0),
145 (('iand', a, a), a),
146 (('iand', a, ~0), a),
147 (('iand', a, 0), 0),
148 (('ior', a, a), a),
149 (('ior', a, 0), a),
150 (('fxor', a, a), 0.0),
151 (('ixor', a, a), 0),
152 (('fxor', a, 0.0), a),
153 (('ixor', a, 0), a),
154 (('inot', ('inot', a)), a),
155 # DeMorgan's Laws
156 (('iand', ('inot', a), ('inot', b)), ('inot', ('ior', a, b))),
157 (('ior', ('inot', a), ('inot', b)), ('inot', ('iand', a, b))),
158 # Shift optimizations
159 (('ishl', 0, a), 0),
160 (('ishl', a, 0), a),
161 (('ishr', 0, a), 0),
162 (('ishr', a, 0), a),
163 (('ushr', 0, a), 0),
164 (('ushr', a, 0), a),
165 # Exponential/logarithmic identities
166 (('fexp2', ('flog2', a)), a), # 2^lg2(a) = a
167 (('flog2', ('fexp2', a)), a), # lg2(2^a) = a
168 (('fpow', a, b), ('fexp2', ('fmul', ('flog2', a), b)), 'options->lower_fpow'), # a^b = 2^(lg2(a)*b)
169 (('fexp2', ('fmul', ('flog2', a), b)), ('fpow', a, b), '!options->lower_fpow'), # 2^(lg2(a)*b) = a^b
170 (('fexp2', ('fadd', ('fmul', ('flog2', a), b), ('fmul', ('flog2', c), d))),
171 ('fmul', ('fpow', a, b), ('fpow', c, d)), '!options->lower_fpow'), # 2^(lg2(a) * b + lg2(c) + d) = a^b * c^d
172 (('fpow', a, 1.0), a),
173 (('fpow', a, 2.0), ('fmul', a, a)),
174 (('fpow', a, 4.0), ('fmul', ('fmul', a, a), ('fmul', a, a))),
175 (('fpow', 2.0, a), ('fexp2', a)),
176 (('fpow', ('fpow', a, 2.2), 0.454545), a),
177 (('fpow', ('fabs', ('fpow', a, 2.2)), 0.454545), ('fabs', a)),
178 (('fsqrt', ('fexp2', a)), ('fexp2', ('fmul', 0.5, a))),
179 (('frcp', ('fexp2', a)), ('fexp2', ('fneg', a))),
180 (('frsq', ('fexp2', a)), ('fexp2', ('fmul', -0.5, a))),
181 (('flog2', ('fsqrt', a)), ('fmul', 0.5, ('flog2', a))),
182 (('flog2', ('frcp', a)), ('fneg', ('flog2', a))),
183 (('flog2', ('frsq', a)), ('fmul', -0.5, ('flog2', a))),
184 (('flog2', ('fpow', a, b)), ('fmul', b, ('flog2', a))),
185 (('fadd', ('flog2', a), ('flog2', b)), ('flog2', ('fmul', a, b))),
186 (('fadd', ('flog2', a), ('fneg', ('flog2', b))), ('flog2', ('fdiv', a, b))),
187 (('fmul', ('fexp2', a), ('fexp2', b)), ('fexp2', ('fadd', a, b))),
188 # Division and reciprocal
189 (('fdiv', 1.0, a), ('frcp', a)),
190 (('fdiv', a, b), ('fmul', a, ('frcp', b)), 'options->lower_fdiv'),
191 (('frcp', ('frcp', a)), a),
192 (('frcp', ('fsqrt', a)), ('frsq', a)),
193 (('fsqrt', a), ('frcp', ('frsq', a)), 'options->lower_fsqrt'),
194 (('frcp', ('frsq', a)), ('fsqrt', a), '!options->lower_fsqrt'),
195 # Boolean simplifications
196 (('ieq', 'a@bool', True), a),
197 (('ine', 'a@bool', True), ('inot', a)),
198 (('ine', 'a@bool', False), a),
199 (('ieq', 'a@bool', False), ('inot', 'a')),
200 (('bcsel', a, True, False), ('ine', a, 0)),
201 (('bcsel', a, False, True), ('ieq', a, 0)),
202 (('bcsel', True, b, c), b),
203 (('bcsel', False, b, c), c),
204 # The result of this should be hit by constant propagation and, in the
205 # next round of opt_algebraic, get picked up by one of the above two.
206 (('bcsel', '#a', b, c), ('bcsel', ('ine', 'a', 0), b, c)),
207
208 (('bcsel', a, b, b), b),
209 (('fcsel', a, b, b), b),
210
211 # Conversions
212 (('i2b', ('b2i', a)), a),
213 (('f2i', ('ftrunc', a)), ('f2i', a)),
214 (('f2u', ('ftrunc', a)), ('f2u', a)),
215
216 # Subtracts
217 (('fsub', a, ('fsub', 0.0, b)), ('fadd', a, b)),
218 (('isub', a, ('isub', 0, b)), ('iadd', a, b)),
219 (('ussub_4x8', a, 0), a),
220 (('ussub_4x8', a, ~0), 0),
221 (('fsub', a, b), ('fadd', a, ('fneg', b)), 'options->lower_sub'),
222 (('isub', a, b), ('iadd', a, ('ineg', b)), 'options->lower_sub'),
223 (('fneg', a), ('fsub', 0.0, a), 'options->lower_negate'),
224 (('ineg', a), ('isub', 0, a), 'options->lower_negate'),
225 (('fadd', a, ('fsub', 0.0, b)), ('fsub', a, b)),
226 (('iadd', a, ('isub', 0, b)), ('isub', a, b)),
227 (('fabs', ('fsub', 0.0, a)), ('fabs', a)),
228 (('iabs', ('isub', 0, a)), ('iabs', a)),
229
230 # Misc. lowering
231 (('fmod', a, b), ('fsub', a, ('fmul', b, ('ffloor', ('fdiv', a, b)))), 'options->lower_fmod'),
232 (('uadd_carry', a, b), ('b2i', ('ult', ('iadd', a, b), a)), 'options->lower_uadd_carry'),
233 (('usub_borrow', a, b), ('b2i', ('ult', a, b)), 'options->lower_usub_borrow'),
234
235 (('bitfield_insert', 'base', 'insert', 'offset', 'bits'),
236 ('bcsel', ('ilt', 31, 'bits'), 'insert',
237 ('bfi', ('bfm', 'bits', 'offset'), 'insert', 'base')),
238 'options->lower_bitfield_insert'),
239
240 (('ibitfield_extract', 'value', 'offset', 'bits'),
241 ('bcsel', ('ilt', 31, 'bits'), 'value',
242 ('ibfe', 'value', 'offset', 'bits')),
243 'options->lower_bitfield_extract'),
244
245 (('ubitfield_extract', 'value', 'offset', 'bits'),
246 ('bcsel', ('ult', 31, 'bits'), 'value',
247 ('ubfe', 'value', 'offset', 'bits')),
248 'options->lower_bitfield_extract'),
249
250 (('extract_i8', a, b),
251 ('ishr', ('ishl', a, ('imul', ('isub', 3, b), 8)), 24),
252 'options->lower_extract_byte'),
253
254 (('extract_u8', a, b),
255 ('iand', ('ushr', a, ('imul', b, 8)), 0xff),
256 'options->lower_extract_byte'),
257
258 (('extract_i16', a, b),
259 ('ishr', ('ishl', a, ('imul', ('isub', 1, b), 16)), 16),
260 'options->lower_extract_word'),
261
262 (('extract_u16', a, b),
263 ('iand', ('ushr', a, ('imul', b, 16)), 0xffff),
264 'options->lower_extract_word'),
265
266 (('pack_unorm_2x16', 'v'),
267 ('pack_uvec2_to_uint',
268 ('f2u', ('fround_even', ('fmul', ('fsat', 'v'), 65535.0)))),
269 'options->lower_pack_unorm_2x16'),
270
271 (('pack_unorm_4x8', 'v'),
272 ('pack_uvec4_to_uint',
273 ('f2u', ('fround_even', ('fmul', ('fsat', 'v'), 255.0)))),
274 'options->lower_pack_unorm_4x8'),
275
276 (('pack_snorm_2x16', 'v'),
277 ('pack_uvec2_to_uint',
278 ('f2i', ('fround_even', ('fmul', ('fmin', 1.0, ('fmax', -1.0, 'v')), 32767.0)))),
279 'options->lower_pack_snorm_2x16'),
280
281 (('pack_snorm_4x8', 'v'),
282 ('pack_uvec4_to_uint',
283 ('f2i', ('fround_even', ('fmul', ('fmin', 1.0, ('fmax', -1.0, 'v')), 127.0)))),
284 'options->lower_pack_snorm_4x8'),
285
286 (('unpack_unorm_2x16', 'v'),
287 ('fdiv', ('u2f', ('vec2', ('extract_u16', 'v', 0),
288 ('extract_u16', 'v', 1))),
289 65535.0),
290 'options->lower_unpack_unorm_2x16'),
291
292 (('unpack_unorm_4x8', 'v'),
293 ('fdiv', ('u2f', ('vec4', ('extract_u8', 'v', 0),
294 ('extract_u8', 'v', 1),
295 ('extract_u8', 'v', 2),
296 ('extract_u8', 'v', 3))),
297 255.0),
298 'options->lower_unpack_unorm_4x8'),
299
300 (('unpack_snorm_2x16', 'v'),
301 ('fmin', 1.0, ('fmax', -1.0, ('fdiv', ('i2f', ('vec2', ('extract_i16', 'v', 0),
302 ('extract_i16', 'v', 1))),
303 32767.0))),
304 'options->lower_unpack_snorm_2x16'),
305
306 (('unpack_snorm_4x8', 'v'),
307 ('fmin', 1.0, ('fmax', -1.0, ('fdiv', ('i2f', ('vec4', ('extract_i8', 'v', 0),
308 ('extract_i8', 'v', 1),
309 ('extract_i8', 'v', 2),
310 ('extract_i8', 'v', 3))),
311 127.0))),
312 'options->lower_unpack_snorm_4x8'),
313 ]
314
315 # Add optimizations to handle the case where the result of a ternary is
316 # compared to a constant. This way we can take things like
317 #
318 # (a ? 0 : 1) > 0
319 #
320 # and turn it into
321 #
322 # a ? (0 > 0) : (1 > 0)
323 #
324 # which constant folding will eat for lunch. The resulting ternary will
325 # further get cleaned up by the boolean reductions above and we will be
326 # left with just the original variable "a".
327 for op in ['flt', 'fge', 'feq', 'fne',
328 'ilt', 'ige', 'ieq', 'ine', 'ult', 'uge']:
329 optimizations += [
330 ((op, ('bcsel', 'a', '#b', '#c'), '#d'),
331 ('bcsel', 'a', (op, 'b', 'd'), (op, 'c', 'd'))),
332 ((op, '#d', ('bcsel', a, '#b', '#c')),
333 ('bcsel', 'a', (op, 'd', 'b'), (op, 'd', 'c'))),
334 ]
335
336 # This section contains "late" optimizations that should be run after the
337 # regular optimizations have finished. Optimizations should go here if
338 # they help code generation but do not necessarily produce code that is
339 # more easily optimizable.
340 late_optimizations = [
341 (('flt', ('fadd', a, b), 0.0), ('flt', a, ('fneg', b))),
342 (('fge', ('fadd', a, b), 0.0), ('fge', a, ('fneg', b))),
343 (('feq', ('fadd', a, b), 0.0), ('feq', a, ('fneg', b))),
344 (('fne', ('fadd', a, b), 0.0), ('fne', a, ('fneg', b))),
345 (('fdot2', a, b), ('fdot_replicated2', a, b), 'options->fdot_replicates'),
346 (('fdot3', a, b), ('fdot_replicated3', a, b), 'options->fdot_replicates'),
347 (('fdot4', a, b), ('fdot_replicated4', a, b), 'options->fdot_replicates'),
348 (('fdph', a, b), ('fdph_replicated', a, b), 'options->fdot_replicates'),
349 ]
350
351 print nir_algebraic.AlgebraicPass("nir_opt_algebraic", optimizations).render()
352 print nir_algebraic.AlgebraicPass("nir_opt_algebraic_late",
353 late_optimizations).render()