nir: Don't abs the result of b2f or b2i
[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, ('b2f', c)), ('bcsel', c, b, a), 'options->lower_flrp'),
87 (('flrp', a, b, c), ('fadd', ('fmul', c, ('fsub', b, a)), a), 'options->lower_flrp'),
88 (('ffract', a), ('fsub', a, ('ffloor', a)), 'options->lower_ffract'),
89 (('fadd', ('fmul', a, ('fadd', 1.0, ('fneg', ('b2f', c)))), ('fmul', b, ('b2f', c))), ('bcsel', c, b, a), 'options->lower_flrp'),
90 (('fadd', ('fmul', a, ('fadd', 1.0, ('fneg', c ))), ('fmul', b, c )), ('flrp', a, b, c), '!options->lower_flrp'),
91 (('fadd', a, ('fmul', ('b2f', c), ('fadd', b, ('fneg', a)))), ('bcsel', c, b, a), 'options->lower_flrp'),
92 (('fadd', a, ('fmul', c , ('fadd', b, ('fneg', a)))), ('flrp', a, b, c), '!options->lower_flrp'),
93 (('ffma', a, b, c), ('fadd', ('fmul', a, b), c), 'options->lower_ffma'),
94 (('fadd', ('fmul', a, b), c), ('ffma', a, b, c), '!options->lower_ffma'),
95 # Comparison simplifications
96 (('inot', ('flt', a, b)), ('fge', a, b)),
97 (('inot', ('fge', a, b)), ('flt', a, b)),
98 (('inot', ('feq', a, b)), ('fne', a, b)),
99 (('inot', ('fne', a, b)), ('feq', a, b)),
100 (('inot', ('ilt', a, b)), ('ige', a, b)),
101 (('inot', ('ige', a, b)), ('ilt', a, b)),
102 (('inot', ('ieq', a, b)), ('ine', a, b)),
103 (('inot', ('ine', a, b)), ('ieq', a, b)),
104
105 # 0.0 >= b2f(a)
106 # b2f(a) <= 0.0
107 # b2f(a) == 0.0 because b2f(a) can only be 0 or 1
108 # inot(a)
109 (('fge', 0.0, ('b2f', a)), ('inot', a)),
110
111 # 0.0 < fabs(a)
112 # fabs(a) > 0.0
113 # fabs(a) != 0.0 because fabs(a) must be >= 0
114 # a != 0.0
115 (('flt', 0.0, ('fabs', a)), ('fne', a, 0.0)),
116
117 (('fge', ('fneg', ('fabs', a)), 0.0), ('feq', a, 0.0)),
118 (('bcsel', ('flt', a, b), a, b), ('fmin', a, b)),
119 (('bcsel', ('flt', a, b), b, a), ('fmax', a, b)),
120 (('bcsel', ('inot', 'a@bool'), b, c), ('bcsel', a, c, b)),
121 (('bcsel', a, ('bcsel', a, b, c), d), ('bcsel', a, b, d)),
122 (('fmin', a, a), a),
123 (('fmax', a, a), a),
124 (('imin', a, a), a),
125 (('imax', a, a), a),
126 (('umin', a, a), a),
127 (('umax', a, a), a),
128 (('fmin', ('fmax', a, 0.0), 1.0), ('fsat', a), '!options->lower_fsat'),
129 (('fmax', ('fmin', a, 1.0), 0.0), ('fsat', a), '!options->lower_fsat'),
130 (('fsat', a), ('fmin', ('fmax', a, 0.0), 1.0), 'options->lower_fsat'),
131 (('fsat', ('fsat', a)), ('fsat', a)),
132 (('fmin', ('fmax', ('fmin', ('fmax', a, 0.0), 1.0), 0.0), 1.0), ('fmin', ('fmax', a, 0.0), 1.0)),
133 (('ior', ('flt', a, b), ('flt', a, c)), ('flt', a, ('fmax', b, c))),
134 (('ior', ('flt', a, c), ('flt', b, c)), ('flt', ('fmin', a, b), c)),
135 (('ior', ('fge', a, b), ('fge', a, c)), ('fge', a, ('fmin', b, c))),
136 (('ior', ('fge', a, c), ('fge', b, c)), ('fge', ('fmax', a, b), c)),
137 (('slt', a, b), ('b2f', ('flt', a, b)), 'options->lower_scmp'),
138 (('sge', a, b), ('b2f', ('fge', a, b)), 'options->lower_scmp'),
139 (('seq', a, b), ('b2f', ('feq', a, b)), 'options->lower_scmp'),
140 (('sne', a, b), ('b2f', ('fne', a, b)), 'options->lower_scmp'),
141 (('fne', ('fneg', a), a), ('fne', a, 0.0)),
142 (('feq', ('fneg', a), a), ('feq', a, 0.0)),
143 # Emulating booleans
144 (('imul', ('b2i', a), ('b2i', b)), ('b2i', ('iand', a, b))),
145 (('fmul', ('b2f', a), ('b2f', b)), ('b2f', ('iand', a, b))),
146 (('fsat', ('fadd', ('b2f', a), ('b2f', b))), ('b2f', ('ior', a, b))),
147 (('iand', 'a@bool', 1.0), ('b2f', a)),
148 (('flt', ('fneg', ('b2f', a)), 0), a), # Generated by TGSI KILL_IF.
149 (('flt', ('fsub', 0.0, ('b2f', a)), 0), a), # Generated by TGSI KILL_IF.
150 # Comparison with the same args. Note that these are not done for
151 # the float versions because NaN always returns false on float
152 # inequalities.
153 (('ilt', a, a), False),
154 (('ige', a, a), True),
155 (('ieq', a, a), True),
156 (('ine', a, a), False),
157 (('ult', a, a), False),
158 (('uge', a, a), True),
159 # Logical and bit operations
160 (('fand', a, 0.0), 0.0),
161 (('iand', a, a), a),
162 (('iand', a, ~0), a),
163 (('iand', a, 0), 0),
164 (('ior', a, a), a),
165 (('ior', a, 0), a),
166 (('fxor', a, a), 0.0),
167 (('ixor', a, a), 0),
168 (('fxor', a, 0.0), a),
169 (('ixor', a, 0), a),
170 (('inot', ('inot', a)), a),
171 # DeMorgan's Laws
172 (('iand', ('inot', a), ('inot', b)), ('inot', ('ior', a, b))),
173 (('ior', ('inot', a), ('inot', b)), ('inot', ('iand', a, b))),
174 # Shift optimizations
175 (('ishl', 0, a), 0),
176 (('ishl', a, 0), a),
177 (('ishr', 0, a), 0),
178 (('ishr', a, 0), a),
179 (('ushr', 0, a), 0),
180 (('ushr', a, 0), a),
181 (('iand', 0xff, ('ushr', a, 24)), ('ushr', a, 24)),
182 (('iand', 0xffff, ('ushr', a, 16)), ('ushr', a, 16)),
183 # Exponential/logarithmic identities
184 (('fexp2', ('flog2', a)), a), # 2^lg2(a) = a
185 (('flog2', ('fexp2', a)), a), # lg2(2^a) = a
186 (('fpow', a, b), ('fexp2', ('fmul', ('flog2', a), b)), 'options->lower_fpow'), # a^b = 2^(lg2(a)*b)
187 (('fexp2', ('fmul', ('flog2', a), b)), ('fpow', a, b), '!options->lower_fpow'), # 2^(lg2(a)*b) = a^b
188 (('fexp2', ('fadd', ('fmul', ('flog2', a), b), ('fmul', ('flog2', c), d))),
189 ('fmul', ('fpow', a, b), ('fpow', c, d)), '!options->lower_fpow'), # 2^(lg2(a) * b + lg2(c) + d) = a^b * c^d
190 (('fpow', a, 1.0), a),
191 (('fpow', a, 2.0), ('fmul', a, a)),
192 (('fpow', a, 4.0), ('fmul', ('fmul', a, a), ('fmul', a, a))),
193 (('fpow', 2.0, a), ('fexp2', a)),
194 (('fpow', ('fpow', a, 2.2), 0.454545), a),
195 (('fpow', ('fabs', ('fpow', a, 2.2)), 0.454545), ('fabs', a)),
196 (('fsqrt', ('fexp2', a)), ('fexp2', ('fmul', 0.5, a))),
197 (('frcp', ('fexp2', a)), ('fexp2', ('fneg', a))),
198 (('frsq', ('fexp2', a)), ('fexp2', ('fmul', -0.5, a))),
199 (('flog2', ('fsqrt', a)), ('fmul', 0.5, ('flog2', a))),
200 (('flog2', ('frcp', a)), ('fneg', ('flog2', a))),
201 (('flog2', ('frsq', a)), ('fmul', -0.5, ('flog2', a))),
202 (('flog2', ('fpow', a, b)), ('fmul', b, ('flog2', a))),
203 (('fadd', ('flog2', a), ('flog2', b)), ('flog2', ('fmul', a, b))),
204 (('fadd', ('flog2', a), ('fneg', ('flog2', b))), ('flog2', ('fdiv', a, b))),
205 (('fmul', ('fexp2', a), ('fexp2', b)), ('fexp2', ('fadd', a, b))),
206 # Division and reciprocal
207 (('fdiv', 1.0, a), ('frcp', a)),
208 (('fdiv', a, b), ('fmul', a, ('frcp', b)), 'options->lower_fdiv'),
209 (('frcp', ('frcp', a)), a),
210 (('frcp', ('fsqrt', a)), ('frsq', a)),
211 (('fsqrt', a), ('frcp', ('frsq', a)), 'options->lower_fsqrt'),
212 (('frcp', ('frsq', a)), ('fsqrt', a), '!options->lower_fsqrt'),
213 # Boolean simplifications
214 (('ieq', 'a@bool', True), a),
215 (('ine', 'a@bool', True), ('inot', a)),
216 (('ine', 'a@bool', False), a),
217 (('ieq', 'a@bool', False), ('inot', 'a')),
218 (('bcsel', a, True, False), ('ine', a, 0)),
219 (('bcsel', a, False, True), ('ieq', a, 0)),
220 (('bcsel', True, b, c), b),
221 (('bcsel', False, b, c), c),
222 # The result of this should be hit by constant propagation and, in the
223 # next round of opt_algebraic, get picked up by one of the above two.
224 (('bcsel', '#a', b, c), ('bcsel', ('ine', 'a', 0), b, c)),
225
226 (('bcsel', a, b, b), b),
227 (('fcsel', a, b, b), b),
228
229 # Conversions
230 (('i2b', ('b2i', a)), a),
231 (('f2i', ('ftrunc', a)), ('f2i', a)),
232 (('f2u', ('ftrunc', a)), ('f2u', a)),
233 (('i2b', ('ineg', a)), ('i2b', a)),
234 (('i2b', ('iabs', a)), ('i2b', a)),
235 (('fabs', ('b2f', a)), ('b2f', a)),
236 (('iabs', ('b2i', a)), ('b2i', a)),
237
238 # Byte extraction
239 (('ushr', a, 24), ('extract_u8', a, 3), '!options->lower_extract_byte'),
240 (('iand', 0xff, ('ushr', a, 16)), ('extract_u8', a, 2), '!options->lower_extract_byte'),
241 (('iand', 0xff, ('ushr', a, 8)), ('extract_u8', a, 1), '!options->lower_extract_byte'),
242 (('iand', 0xff, a), ('extract_u8', a, 0), '!options->lower_extract_byte'),
243
244 # Word extraction
245 (('ushr', a, 16), ('extract_u16', a, 1), '!options->lower_extract_word'),
246 (('iand', 0xffff, a), ('extract_u16', a, 0), '!options->lower_extract_word'),
247
248 # Subtracts
249 (('fsub', a, ('fsub', 0.0, b)), ('fadd', a, b)),
250 (('isub', a, ('isub', 0, b)), ('iadd', a, b)),
251 (('ussub_4x8', a, 0), a),
252 (('ussub_4x8', a, ~0), 0),
253 (('fsub', a, b), ('fadd', a, ('fneg', b)), 'options->lower_sub'),
254 (('isub', a, b), ('iadd', a, ('ineg', b)), 'options->lower_sub'),
255 (('fneg', a), ('fsub', 0.0, a), 'options->lower_negate'),
256 (('ineg', a), ('isub', 0, a), 'options->lower_negate'),
257 (('fadd', a, ('fsub', 0.0, b)), ('fsub', a, b)),
258 (('iadd', a, ('isub', 0, b)), ('isub', a, b)),
259 (('fabs', ('fsub', 0.0, a)), ('fabs', a)),
260 (('iabs', ('isub', 0, a)), ('iabs', a)),
261
262 # Misc. lowering
263 (('fmod', a, b), ('fsub', a, ('fmul', b, ('ffloor', ('fdiv', a, b)))), 'options->lower_fmod'),
264 (('uadd_carry', a, b), ('b2i', ('ult', ('iadd', a, b), a)), 'options->lower_uadd_carry'),
265 (('usub_borrow', a, b), ('b2i', ('ult', a, b)), 'options->lower_usub_borrow'),
266
267 (('bitfield_insert', 'base', 'insert', 'offset', 'bits'),
268 ('bcsel', ('ilt', 31, 'bits'), 'insert',
269 ('bfi', ('bfm', 'bits', 'offset'), 'insert', 'base')),
270 'options->lower_bitfield_insert'),
271
272 (('ibitfield_extract', 'value', 'offset', 'bits'),
273 ('bcsel', ('ilt', 31, 'bits'), 'value',
274 ('ibfe', 'value', 'offset', 'bits')),
275 'options->lower_bitfield_extract'),
276
277 (('ubitfield_extract', 'value', 'offset', 'bits'),
278 ('bcsel', ('ult', 31, 'bits'), 'value',
279 ('ubfe', 'value', 'offset', 'bits')),
280 'options->lower_bitfield_extract'),
281
282 (('extract_i8', a, b),
283 ('ishr', ('ishl', a, ('imul', ('isub', 3, b), 8)), 24),
284 'options->lower_extract_byte'),
285
286 (('extract_u8', a, b),
287 ('iand', ('ushr', a, ('imul', b, 8)), 0xff),
288 'options->lower_extract_byte'),
289
290 (('extract_i16', a, b),
291 ('ishr', ('ishl', a, ('imul', ('isub', 1, b), 16)), 16),
292 'options->lower_extract_word'),
293
294 (('extract_u16', a, b),
295 ('iand', ('ushr', a, ('imul', b, 16)), 0xffff),
296 'options->lower_extract_word'),
297
298 (('pack_unorm_2x16', 'v'),
299 ('pack_uvec2_to_uint',
300 ('f2u', ('fround_even', ('fmul', ('fsat', 'v'), 65535.0)))),
301 'options->lower_pack_unorm_2x16'),
302
303 (('pack_unorm_4x8', 'v'),
304 ('pack_uvec4_to_uint',
305 ('f2u', ('fround_even', ('fmul', ('fsat', 'v'), 255.0)))),
306 'options->lower_pack_unorm_4x8'),
307
308 (('pack_snorm_2x16', 'v'),
309 ('pack_uvec2_to_uint',
310 ('f2i', ('fround_even', ('fmul', ('fmin', 1.0, ('fmax', -1.0, 'v')), 32767.0)))),
311 'options->lower_pack_snorm_2x16'),
312
313 (('pack_snorm_4x8', 'v'),
314 ('pack_uvec4_to_uint',
315 ('f2i', ('fround_even', ('fmul', ('fmin', 1.0, ('fmax', -1.0, 'v')), 127.0)))),
316 'options->lower_pack_snorm_4x8'),
317
318 (('unpack_unorm_2x16', 'v'),
319 ('fdiv', ('u2f', ('vec2', ('extract_u16', 'v', 0),
320 ('extract_u16', 'v', 1))),
321 65535.0),
322 'options->lower_unpack_unorm_2x16'),
323
324 (('unpack_unorm_4x8', 'v'),
325 ('fdiv', ('u2f', ('vec4', ('extract_u8', 'v', 0),
326 ('extract_u8', 'v', 1),
327 ('extract_u8', 'v', 2),
328 ('extract_u8', 'v', 3))),
329 255.0),
330 'options->lower_unpack_unorm_4x8'),
331
332 (('unpack_snorm_2x16', 'v'),
333 ('fmin', 1.0, ('fmax', -1.0, ('fdiv', ('i2f', ('vec2', ('extract_i16', 'v', 0),
334 ('extract_i16', 'v', 1))),
335 32767.0))),
336 'options->lower_unpack_snorm_2x16'),
337
338 (('unpack_snorm_4x8', 'v'),
339 ('fmin', 1.0, ('fmax', -1.0, ('fdiv', ('i2f', ('vec4', ('extract_i8', 'v', 0),
340 ('extract_i8', 'v', 1),
341 ('extract_i8', 'v', 2),
342 ('extract_i8', 'v', 3))),
343 127.0))),
344 'options->lower_unpack_snorm_4x8'),
345 ]
346
347 # Unreal Engine 4 demo applications open-codes bitfieldReverse()
348 def bitfield_reverse(u):
349 step1 = ('ior', ('ishl', u, 16), ('ushr', u, 16))
350 step2 = ('ior', ('ishl', ('iand', step1, 0x00ff00ff), 8), ('ushr', ('iand', step1, 0xff00ff00), 8))
351 step3 = ('ior', ('ishl', ('iand', step2, 0x0f0f0f0f), 4), ('ushr', ('iand', step2, 0xf0f0f0f0), 4))
352 step4 = ('ior', ('ishl', ('iand', step3, 0x33333333), 2), ('ushr', ('iand', step3, 0xcccccccc), 2))
353 step5 = ('ior', ('ishl', ('iand', step4, 0x55555555), 1), ('ushr', ('iand', step4, 0xaaaaaaaa), 1))
354
355 return step5
356
357 optimizations += [(bitfield_reverse('x'), ('bitfield_reverse', 'x'))]
358
359
360 # Add optimizations to handle the case where the result of a ternary is
361 # compared to a constant. This way we can take things like
362 #
363 # (a ? 0 : 1) > 0
364 #
365 # and turn it into
366 #
367 # a ? (0 > 0) : (1 > 0)
368 #
369 # which constant folding will eat for lunch. The resulting ternary will
370 # further get cleaned up by the boolean reductions above and we will be
371 # left with just the original variable "a".
372 for op in ['flt', 'fge', 'feq', 'fne',
373 'ilt', 'ige', 'ieq', 'ine', 'ult', 'uge']:
374 optimizations += [
375 ((op, ('bcsel', 'a', '#b', '#c'), '#d'),
376 ('bcsel', 'a', (op, 'b', 'd'), (op, 'c', 'd'))),
377 ((op, '#d', ('bcsel', a, '#b', '#c')),
378 ('bcsel', 'a', (op, 'd', 'b'), (op, 'd', 'c'))),
379 ]
380
381 # This section contains "late" optimizations that should be run after the
382 # regular optimizations have finished. Optimizations should go here if
383 # they help code generation but do not necessarily produce code that is
384 # more easily optimizable.
385 late_optimizations = [
386 (('flt', ('fadd', a, b), 0.0), ('flt', a, ('fneg', b))),
387 (('fge', ('fadd', a, b), 0.0), ('fge', a, ('fneg', b))),
388 (('feq', ('fadd', a, b), 0.0), ('feq', a, ('fneg', b))),
389 (('fne', ('fadd', a, b), 0.0), ('fne', a, ('fneg', b))),
390 (('fdot2', a, b), ('fdot_replicated2', a, b), 'options->fdot_replicates'),
391 (('fdot3', a, b), ('fdot_replicated3', a, b), 'options->fdot_replicates'),
392 (('fdot4', a, b), ('fdot_replicated4', a, b), 'options->fdot_replicates'),
393 (('fdph', a, b), ('fdph_replicated', a, b), 'options->fdot_replicates'),
394 ]
395
396 print nir_algebraic.AlgebraicPass("nir_opt_algebraic", optimizations).render()
397 print nir_algebraic.AlgebraicPass("nir_opt_algebraic_late",
398 late_optimizations).render()