freedreno/ir3: small cleanup and comments
[mesa.git] / src / freedreno / ir3 / ir3_nir_lower_tex_prefetch.c
1 /*
2 * Copyright © 2019 Igalia S.L.
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 "ir3_nir.h"
25
26 /**
27 * A pass which detects tex instructions which are candidate to be executed
28 * prior to FS shader start, and change them to nir_texop_tex_prefetch.
29 */
30
31 static int
32 coord_offset(nir_ssa_def *ssa)
33 {
34 nir_instr *parent_instr = ssa->parent_instr;
35
36 /* The coordinate of a texture sampling instruction eligible for
37 * pre-fetch is either going to be a load_interpolated_input/
38 * load_input, or a vec2 assembling non-swizzled components of
39 * a load_interpolated_input/load_input (due to varying packing)
40 */
41
42 if (parent_instr->type == nir_instr_type_alu) {
43 nir_alu_instr *alu = nir_instr_as_alu(parent_instr);
44
45 if (alu->op != nir_op_vec2)
46 return -1;
47
48 if (!alu->src[0].src.is_ssa)
49 return -1;
50
51 int base_offset = coord_offset(alu->src[0].src.ssa) +
52 alu->src[0].swizzle[0];
53
54 /* NOTE it might be possible to support more than 2D? */
55 for (int i = 1; i < 2; i++) {
56 if (!alu->src[i].src.is_ssa)
57 return -1;
58
59 int nth_offset = coord_offset(alu->src[i].src.ssa) +
60 alu->src[i].swizzle[0];
61
62 if (nth_offset != (base_offset + i))
63 return -1;
64 }
65
66 return base_offset;
67 }
68
69 if (parent_instr->type != nir_instr_type_intrinsic)
70 return -1;
71
72 nir_intrinsic_instr *input = nir_instr_as_intrinsic(parent_instr);
73
74 if (input->intrinsic != nir_intrinsic_load_interpolated_input)
75 return -1;
76
77 /* limit to load_barycentric_pixel, other interpolation modes don't seem
78 * to be supported:
79 */
80 if (!input->src[0].is_ssa)
81 return -1;
82
83 nir_intrinsic_instr *interp =
84 nir_instr_as_intrinsic(input->src[0].ssa->parent_instr);
85
86 if (interp->intrinsic != nir_intrinsic_load_barycentric_pixel)
87 return -1;
88
89 /* we also need a const input offset: */
90 if (!nir_src_is_const(input->src[1]))
91 return -1;
92
93 unsigned base = nir_src_as_uint(input->src[1]) + nir_intrinsic_base(input);
94 unsigned comp = nir_intrinsic_component(input);
95
96 return (4 * base) + comp;
97 }
98
99 int
100 ir3_nir_coord_offset(nir_ssa_def *ssa)
101 {
102
103 assert (ssa->num_components == 2);
104 return coord_offset(ssa);
105 }
106
107 static bool
108 has_src(nir_tex_instr *tex, nir_tex_src_type type)
109 {
110 return nir_tex_instr_src_index(tex, type) > 0;
111 }
112
113 static bool
114 lower_tex_prefetch_block(nir_block *block)
115 {
116 bool progress = false;
117
118 nir_foreach_instr_safe (instr, block) {
119 if (instr->type != nir_instr_type_tex)
120 continue;
121
122 nir_tex_instr *tex = nir_instr_as_tex(instr);
123 if (tex->op != nir_texop_tex)
124 continue;
125
126 if (has_src(tex, nir_tex_src_bias) ||
127 has_src(tex, nir_tex_src_lod) ||
128 has_src(tex, nir_tex_src_comparator) ||
129 has_src(tex, nir_tex_src_projector) ||
130 has_src(tex, nir_tex_src_offset) ||
131 has_src(tex, nir_tex_src_ddx) ||
132 has_src(tex, nir_tex_src_ddy) ||
133 has_src(tex, nir_tex_src_ms_index) ||
134 has_src(tex, nir_tex_src_texture_offset) ||
135 has_src(tex, nir_tex_src_sampler_offset))
136 continue;
137
138 /* only prefetch for simple 2d tex fetch case */
139 if (tex->sampler_dim != GLSL_SAMPLER_DIM_2D || tex->is_array)
140 continue;
141
142 int idx = nir_tex_instr_src_index(tex, nir_tex_src_coord);
143 /* First source should be the sampling coordinate. */
144 nir_tex_src *coord = &tex->src[idx];
145 debug_assert(coord->src.is_ssa);
146
147 if (ir3_nir_coord_offset(coord->src.ssa) >= 0) {
148 tex->op = nir_texop_tex_prefetch;
149
150 progress |= true;
151 }
152 }
153
154 return progress;
155 }
156
157 static bool
158 lower_tex_prefetch_func(nir_function_impl *impl)
159 {
160 /* Only instructions in the the outer-most block are considered
161 * eligible for pre-dispatch, because they need to be move-able
162 * to the beginning of the shader to avoid locking down the
163 * register holding the pre-fetched result for too long.
164 */
165 nir_block *block = nir_start_block(impl);
166 if (!block)
167 return false;
168
169 bool progress = lower_tex_prefetch_block(block);
170
171 if (progress) {
172 nir_metadata_preserve(impl, nir_metadata_block_index |
173 nir_metadata_dominance);
174 }
175
176 return progress;
177 }
178
179 bool
180 ir3_nir_lower_tex_prefetch(nir_shader *shader)
181 {
182 bool progress = false;
183
184 assert(shader->info.stage == MESA_SHADER_FRAGMENT);
185
186 nir_foreach_function (function, shader) {
187 /* Only texture sampling instructions inside the main function
188 * are eligible for pre-dispatch.
189 */
190 if (!function->impl || !function->is_entrypoint)
191 continue;
192
193 progress |= lower_tex_prefetch_func(function->impl);
194 }
195
196 return progress;
197 }