xref: /aosp_15_r20/external/mesa3d/src/intel/compiler/elk/elk_nir_lower_alpha_to_coverage.c (revision 6104692788411f58d303aa86923a9ff6ecaded22)
1 /*
2  * Copyright © 2019 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 
24 #include "compiler/nir/nir_builder.h"
25 #include "elk_nir.h"
26 #include "elk_eu_defines.h"
27 
28 /**
29  * We need to compute alpha to coverage dithering manually in shader
30  * and replace sample mask store with the bitwise-AND of sample mask and
31  * alpha to coverage dithering.
32  *
33  * The following formula is used to compute final sample mask:
34  *  m = int(16.0 * clamp(src0_alpha, 0.0, 1.0))
35  *  dither_mask = 0x1111 * ((0xfea80 >> (m & ~3)) & 0xf) |
36  *     0x0808 * (m & 2) | 0x0100 * (m & 1)
37  *  sample_mask = sample_mask & dither_mask
38  *
39  * It gives a number of ones proportional to the alpha for 2, 4, 8 or 16
40  * least significant bits of the result:
41  *  0.0000 0000000000000000
42  *  0.0625 0000000100000000
43  *  0.1250 0001000000010000
44  *  0.1875 0001000100010000
45  *  0.2500 1000100010001000
46  *  0.3125 1000100110001000
47  *  0.3750 1001100010011000
48  *  0.4375 1001100110011000
49  *  0.5000 1010101010101010
50  *  0.5625 1010101110101010
51  *  0.6250 1011101010111010
52  *  0.6875 1011101110111010
53  *  0.7500 1110111011101110
54  *  0.8125 1110111111101110
55  *  0.8750 1111111011111110
56  *  0.9375 1111111111111110
57  *  1.0000 1111111111111111
58  */
59 static nir_def *
build_dither_mask(nir_builder * b,nir_def * color)60 build_dither_mask(nir_builder *b, nir_def *color)
61 {
62    assert(color->num_components == 4);
63    nir_def *alpha = nir_channel(b, color, 3);
64 
65    nir_def *m =
66       nir_f2i32(b, nir_fmul_imm(b, nir_fsat(b, alpha), 16.0));
67 
68    nir_def *part_a =
69       nir_iand_imm(b, nir_ushr(b, nir_imm_int(b, 0xfea80),
70                                   nir_iand_imm(b, m, ~3)),
71                       0xf);
72 
73    nir_def *part_b = nir_iand_imm(b, m, 2);
74    nir_def *part_c = nir_iand_imm(b, m, 1);
75 
76    return nir_ior(b, nir_imul_imm(b, part_a, 0x1111),
77                      nir_ior(b, nir_imul_imm(b, part_b, 0x0808),
78                                 nir_imul_imm(b, part_c, 0x0100)));
79 }
80 
81 bool
elk_nir_lower_alpha_to_coverage(nir_shader * shader,const struct elk_wm_prog_key * key,const struct elk_wm_prog_data * prog_data)82 elk_nir_lower_alpha_to_coverage(nir_shader *shader,
83                                 const struct elk_wm_prog_key *key,
84                                 const struct elk_wm_prog_data *prog_data)
85 {
86    assert(shader->info.stage == MESA_SHADER_FRAGMENT);
87    assert(key->alpha_to_coverage != ELK_NEVER);
88 
89    nir_function_impl *impl = nir_shader_get_entrypoint(shader);
90 
91    const uint64_t outputs_written = shader->info.outputs_written;
92    if (!(outputs_written & BITFIELD64_BIT(FRAG_RESULT_SAMPLE_MASK)) ||
93        !(outputs_written & (BITFIELD64_BIT(FRAG_RESULT_COLOR) |
94                             BITFIELD64_BIT(FRAG_RESULT_DATA0))))
95       goto skip;
96 
97    nir_intrinsic_instr *sample_mask_write = NULL;
98    nir_intrinsic_instr *color0_write = NULL;
99    bool sample_mask_write_first = false;
100 
101    nir_foreach_block(block, impl) {
102       nir_foreach_instr_safe(instr, block) {
103          if (instr->type != nir_instr_type_intrinsic)
104             continue;
105 
106          nir_intrinsic_instr *intrin = nir_instr_as_intrinsic(instr);
107          if (intrin->intrinsic != nir_intrinsic_store_output)
108             continue;
109 
110          /* We call nir_lower_io_to_temporaries to lower FS outputs to
111           * temporaries with a copy at the end so this should be the last
112           * block in the shader.
113           */
114          assert(block->cf_node.parent == &impl->cf_node);
115          assert(nir_cf_node_is_last(&block->cf_node));
116 
117          /* See store_output in elk_fs_visitor::nir_emit_fs_intrinsic */
118          const unsigned store_offset = nir_src_as_uint(intrin->src[1]);
119          const unsigned driver_location = nir_intrinsic_base(intrin) +
120             SET_FIELD(store_offset, ELK_NIR_FRAG_OUTPUT_LOCATION);
121 
122          /* Extract the FRAG_RESULT */
123          const unsigned location =
124             GET_FIELD(driver_location, ELK_NIR_FRAG_OUTPUT_LOCATION);
125 
126          if (location == FRAG_RESULT_SAMPLE_MASK) {
127             assert(sample_mask_write == NULL);
128             sample_mask_write = intrin;
129             sample_mask_write_first = (color0_write == NULL);
130          }
131 
132          if (location == FRAG_RESULT_COLOR ||
133              location == FRAG_RESULT_DATA0) {
134             assert(color0_write == NULL);
135             color0_write = intrin;
136          }
137       }
138    }
139 
140    /* It's possible that shader_info may be out-of-date and the writes to
141     * either gl_SampleMask or the first color value may have been removed.
142     * This can happen if, for instance a nir_undef is written to the
143     * color value.  In that case, just bail and don't do anything rather
144     * than crashing.
145     */
146    if (color0_write == NULL || sample_mask_write == NULL)
147       goto skip;
148 
149    /* It's possible that the color value isn't actually a vec4.  In this case,
150     * assuming an alpha of 1.0 and letting the sample mask pass through
151     * unaltered seems like the kindest thing to do to apps.
152     */
153    nir_def *color0 = color0_write->src[0].ssa;
154    if (color0->num_components < 4)
155       goto skip;
156 
157    nir_def *sample_mask = sample_mask_write->src[0].ssa;
158 
159    if (sample_mask_write_first) {
160       /* If the sample mask write comes before the write to color0, we need
161        * to move it because it's going to use the value from color0 to
162        * compute the sample mask.
163        */
164       nir_instr_remove(&sample_mask_write->instr);
165       nir_instr_insert(nir_after_instr(&color0_write->instr),
166                        &sample_mask_write->instr);
167    }
168 
169    nir_builder b = nir_builder_at(nir_before_instr(&sample_mask_write->instr));
170 
171    /* Combine dither_mask and the gl_SampleMask value */
172    nir_def *dither_mask = build_dither_mask(&b, color0);
173    dither_mask = nir_iand(&b, sample_mask, dither_mask);
174 
175    if (key->alpha_to_coverage == ELK_SOMETIMES) {
176       nir_def *push_flags =
177          nir_load_uniform(&b, 1, 32, nir_imm_int(&b, prog_data->msaa_flags_param * 4));
178       nir_def *alpha_to_coverage =
179          nir_test_mask(&b, push_flags, INTEL_MSAA_FLAG_ALPHA_TO_COVERAGE);
180       dither_mask = nir_bcsel(&b, alpha_to_coverage,
181                               dither_mask, sample_mask_write->src[0].ssa);
182    }
183 
184    nir_src_rewrite(&sample_mask_write->src[0], dither_mask);
185 
186    nir_metadata_preserve(impl, nir_metadata_control_flow);
187    return true;
188 
189 skip:
190    nir_metadata_preserve(impl, nir_metadata_all);
191    return false;
192 }
193