Merge remote-tracking branch 'public/master' into vulkan
[mesa.git] / src / mesa / drivers / dri / i965 / brw_fs.h
1 /*
2 * Copyright © 2010 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 * Authors:
24 * Eric Anholt <eric@anholt.net>
25 *
26 */
27
28 #pragma once
29
30 #include "brw_shader.h"
31 #include "brw_ir_fs.h"
32 #include "brw_fs_builder.h"
33 #include "compiler/glsl/ir.h"
34 #include "compiler/nir/nir.h"
35
36 struct bblock_t;
37 namespace {
38 struct acp_entry;
39 }
40
41 namespace brw {
42 class fs_live_variables;
43 }
44
45 struct brw_gs_compile;
46
47 static inline fs_reg
48 offset(fs_reg reg, const brw::fs_builder& bld, unsigned delta)
49 {
50 switch (reg.file) {
51 case BAD_FILE:
52 break;
53 case ARF:
54 case FIXED_GRF:
55 case MRF:
56 case VGRF:
57 case ATTR:
58 return byte_offset(reg,
59 delta * reg.component_size(bld.dispatch_width()));
60 case UNIFORM:
61 reg.reg_offset += delta;
62 break;
63 case IMM:
64 assert(delta == 0);
65 }
66 return reg;
67 }
68
69 /**
70 * The fragment shader front-end.
71 *
72 * Translates either GLSL IR or Mesa IR (for ARB_fragment_program) into FS IR.
73 */
74 class fs_visitor : public backend_shader
75 {
76 public:
77 fs_visitor(const struct brw_compiler *compiler, void *log_data,
78 void *mem_ctx,
79 const void *key,
80 struct brw_stage_prog_data *prog_data,
81 struct gl_program *prog,
82 const nir_shader *shader,
83 unsigned dispatch_width,
84 int shader_time_index,
85 const struct brw_vue_map *input_vue_map = NULL);
86 fs_visitor(const struct brw_compiler *compiler, void *log_data,
87 void *mem_ctx,
88 struct brw_gs_compile *gs_compile,
89 struct brw_gs_prog_data *prog_data,
90 const nir_shader *shader,
91 int shader_time_index);
92 void init();
93 ~fs_visitor();
94
95 fs_reg vgrf(const glsl_type *const type);
96 void import_uniforms(fs_visitor *v);
97 void setup_uniform_clipplane_values(gl_clip_plane *clip_planes);
98 void compute_clip_distance(gl_clip_plane *clip_planes);
99
100 fs_inst *get_instruction_generating_reg(fs_inst *start,
101 fs_inst *end,
102 const fs_reg &reg);
103
104 void VARYING_PULL_CONSTANT_LOAD(const brw::fs_builder &bld,
105 const fs_reg &dst,
106 const fs_reg &surf_index,
107 const fs_reg &varying_offset,
108 uint32_t const_offset);
109 void DEP_RESOLVE_MOV(const brw::fs_builder &bld, int grf);
110
111 bool run_fs(bool do_rep_send);
112 bool run_vs(gl_clip_plane *clip_planes);
113 bool run_tes();
114 bool run_gs();
115 bool run_cs();
116 void optimize();
117 void allocate_registers();
118 void setup_fs_payload_gen4();
119 void setup_fs_payload_gen6();
120 void setup_vs_payload();
121 void setup_gs_payload();
122 void setup_cs_payload();
123 void fixup_3src_null_dest();
124 void assign_curb_setup();
125 void calculate_urb_setup();
126 void assign_urb_setup();
127 void convert_attr_sources_to_hw_regs(fs_inst *inst);
128 void assign_vs_urb_setup();
129 void assign_tes_urb_setup();
130 void assign_gs_urb_setup();
131 bool assign_regs(bool allow_spilling);
132 void assign_regs_trivial();
133 void calculate_payload_ranges(int payload_node_count,
134 int *payload_last_use_ip);
135 void setup_payload_interference(struct ra_graph *g, int payload_reg_count,
136 int first_payload_node);
137 int choose_spill_reg(struct ra_graph *g);
138 void spill_reg(int spill_reg);
139 void split_virtual_grfs();
140 bool compact_virtual_grfs();
141 void assign_constant_locations();
142 void lower_constant_loads();
143 void invalidate_live_intervals();
144 void calculate_live_intervals();
145 void calculate_register_pressure();
146 void validate();
147 bool opt_algebraic();
148 bool opt_redundant_discard_jumps();
149 bool opt_cse();
150 bool opt_cse_local(bblock_t *block);
151 bool opt_copy_propagate();
152 bool try_copy_propagate(fs_inst *inst, int arg, acp_entry *entry);
153 bool try_constant_propagate(fs_inst *inst, acp_entry *entry);
154 bool opt_copy_propagate_local(void *mem_ctx, bblock_t *block,
155 exec_list *acp);
156 bool opt_register_renaming();
157 bool register_coalesce();
158 bool compute_to_mrf();
159 bool eliminate_find_live_channel();
160 bool dead_code_eliminate();
161 bool remove_duplicate_mrf_writes();
162
163 bool opt_sampler_eot();
164 bool virtual_grf_interferes(int a, int b);
165 void schedule_instructions(instruction_scheduler_mode mode);
166 void insert_gen4_send_dependency_workarounds();
167 void insert_gen4_pre_send_dependency_workarounds(bblock_t *block,
168 fs_inst *inst);
169 void insert_gen4_post_send_dependency_workarounds(bblock_t *block,
170 fs_inst *inst);
171 void vfail(const char *msg, va_list args);
172 void fail(const char *msg, ...);
173 void no16(const char *msg);
174 void lower_uniform_pull_constant_loads();
175 bool lower_load_payload();
176 bool lower_logical_sends();
177 bool lower_integer_multiplication();
178 bool lower_minmax();
179 bool lower_simd_width();
180 bool opt_combine_constants();
181
182 void emit_dummy_fs();
183 void emit_repclear_shader();
184 fs_reg *emit_fragcoord_interpolation(bool pixel_center_integer,
185 bool origin_upper_left);
186 fs_inst *emit_linterp(const fs_reg &attr, const fs_reg &interp,
187 glsl_interp_qualifier interpolation_mode,
188 bool is_centroid, bool is_sample);
189 fs_reg *emit_frontfacing_interpolation();
190 fs_reg *emit_samplepos_setup();
191 fs_reg *emit_sampleid_setup();
192 void emit_general_interpolation(fs_reg *attr, const char *name,
193 const glsl_type *type,
194 glsl_interp_qualifier interpolation_mode,
195 int *location, bool mod_centroid,
196 bool mod_sample);
197 fs_reg *emit_vs_system_value(int location);
198 void emit_interpolation_setup_gen4();
199 void emit_interpolation_setup_gen6();
200 void compute_sample_position(fs_reg dst, fs_reg int_sample_pos);
201 void emit_texture(ir_texture_opcode op,
202 const glsl_type *dest_type,
203 fs_reg coordinate, int components,
204 fs_reg shadow_c,
205 fs_reg lod, fs_reg dpdy, int grad_components,
206 fs_reg sample_index,
207 fs_reg offset,
208 fs_reg mcs,
209 int gather_component,
210 bool is_cube_array,
211 uint32_t surface,
212 fs_reg surface_reg,
213 uint32_t sampler,
214 fs_reg sampler_reg);
215 fs_reg emit_mcs_fetch(const fs_reg &coordinate, unsigned components,
216 const fs_reg &sampler);
217 void emit_gen6_gather_wa(uint8_t wa, fs_reg dst);
218 fs_reg resolve_source_modifiers(const fs_reg &src);
219 void emit_discard_jump();
220 bool opt_peephole_sel();
221 bool opt_peephole_predicated_break();
222 bool opt_saturate_propagation();
223 bool opt_cmod_propagation();
224 bool opt_zero_samples();
225 void emit_unspill(bblock_t *block, fs_inst *inst, fs_reg reg,
226 uint32_t spill_offset, int count);
227 void emit_spill(bblock_t *block, fs_inst *inst, fs_reg reg,
228 uint32_t spill_offset, int count, bool we_all);
229
230 void emit_nir_code();
231 void nir_setup_inputs();
232 void nir_setup_single_output_varying(fs_reg *reg, const glsl_type *type,
233 unsigned *location);
234 void nir_setup_outputs();
235 void nir_setup_uniforms();
236 void nir_emit_system_values();
237 void nir_emit_impl(nir_function_impl *impl);
238 void nir_emit_cf_list(exec_list *list);
239 void nir_emit_if(nir_if *if_stmt);
240 void nir_emit_loop(nir_loop *loop);
241 void nir_emit_block(nir_block *block);
242 void nir_emit_instr(nir_instr *instr);
243 void nir_emit_alu(const brw::fs_builder &bld, nir_alu_instr *instr);
244 void nir_emit_load_const(const brw::fs_builder &bld,
245 nir_load_const_instr *instr);
246 void nir_emit_undef(const brw::fs_builder &bld,
247 nir_ssa_undef_instr *instr);
248 void nir_emit_vs_intrinsic(const brw::fs_builder &bld,
249 nir_intrinsic_instr *instr);
250 void nir_emit_gs_intrinsic(const brw::fs_builder &bld,
251 nir_intrinsic_instr *instr);
252 void nir_emit_fs_intrinsic(const brw::fs_builder &bld,
253 nir_intrinsic_instr *instr);
254 void nir_emit_cs_intrinsic(const brw::fs_builder &bld,
255 nir_intrinsic_instr *instr);
256 void nir_emit_intrinsic(const brw::fs_builder &bld,
257 nir_intrinsic_instr *instr);
258 void nir_emit_tes_intrinsic(const brw::fs_builder &bld,
259 nir_intrinsic_instr *instr);
260 void nir_emit_ssbo_atomic(const brw::fs_builder &bld,
261 int op, nir_intrinsic_instr *instr);
262 void nir_emit_shared_atomic(const brw::fs_builder &bld,
263 int op, nir_intrinsic_instr *instr);
264 void nir_emit_texture(const brw::fs_builder &bld,
265 nir_tex_instr *instr);
266 void nir_emit_jump(const brw::fs_builder &bld,
267 nir_jump_instr *instr);
268 fs_reg get_nir_src(nir_src src);
269 fs_reg get_nir_dest(nir_dest dest);
270 fs_reg get_nir_image_deref(const nir_deref_var *deref);
271 fs_reg get_indirect_offset(nir_intrinsic_instr *instr);
272 void emit_percomp(const brw::fs_builder &bld, const fs_inst &inst,
273 unsigned wr_mask);
274
275 bool optimize_extract_to_float(nir_alu_instr *instr,
276 const fs_reg &result);
277 bool optimize_frontfacing_ternary(nir_alu_instr *instr,
278 const fs_reg &result);
279
280 void emit_alpha_test();
281 fs_inst *emit_single_fb_write(const brw::fs_builder &bld,
282 fs_reg color1, fs_reg color2,
283 fs_reg src0_alpha, unsigned components);
284 void emit_fb_writes();
285 void emit_urb_writes(const fs_reg &gs_vertex_count = fs_reg());
286 void set_gs_stream_control_data_bits(const fs_reg &vertex_count,
287 unsigned stream_id);
288 void emit_gs_control_data_bits(const fs_reg &vertex_count);
289 void emit_gs_end_primitive(const nir_src &vertex_count_nir_src);
290 void emit_gs_vertex(const nir_src &vertex_count_nir_src,
291 unsigned stream_id);
292 void emit_gs_thread_end();
293 void emit_gs_input_load(const fs_reg &dst, const nir_src &vertex_src,
294 unsigned base_offset, const nir_src &offset_src,
295 unsigned num_components);
296 void emit_cs_terminate();
297 fs_reg *emit_cs_local_invocation_id_setup();
298 fs_reg *emit_cs_work_group_id_setup();
299
300 void emit_barrier();
301
302 void emit_shader_time_begin();
303 void emit_shader_time_end();
304 void SHADER_TIME_ADD(const brw::fs_builder &bld,
305 int shader_time_subindex,
306 fs_reg value);
307
308 fs_reg get_timestamp(const brw::fs_builder &bld);
309
310 struct brw_reg interp_reg(int location, int channel);
311
312 int implied_mrf_writes(fs_inst *inst);
313
314 virtual void dump_instructions();
315 virtual void dump_instructions(const char *name);
316 void dump_instruction(backend_instruction *inst);
317 void dump_instruction(backend_instruction *inst, FILE *file);
318
319 const void *const key;
320 const struct brw_sampler_prog_key_data *key_tex;
321
322 struct brw_gs_compile *gs_compile;
323
324 struct brw_stage_prog_data *prog_data;
325 struct gl_program *prog;
326
327 const struct brw_vue_map *input_vue_map;
328
329 int *virtual_grf_start;
330 int *virtual_grf_end;
331 brw::fs_live_variables *live_intervals;
332
333 int *regs_live_at_ip;
334
335 /** Number of uniform variable components visited. */
336 unsigned uniforms;
337
338 /** Byte-offset for the next available spot in the scratch space buffer. */
339 unsigned last_scratch;
340
341 /**
342 * Array mapping UNIFORM register numbers to the pull parameter index,
343 * or -1 if this uniform register isn't being uploaded as a pull constant.
344 */
345 int *pull_constant_loc;
346
347 /**
348 * Array mapping UNIFORM register numbers to the push parameter index,
349 * or -1 if this uniform register isn't being uploaded as a push constant.
350 */
351 int *push_constant_loc;
352
353 fs_reg frag_depth;
354 fs_reg frag_stencil;
355 fs_reg sample_mask;
356 fs_reg outputs[VARYING_SLOT_MAX];
357 unsigned output_components[VARYING_SLOT_MAX];
358 fs_reg dual_src_output;
359 bool do_dual_src;
360 int first_non_payload_grf;
361 /** Either BRW_MAX_GRF or GEN7_MRF_HACK_START */
362 unsigned max_grf;
363
364 fs_reg *nir_locals;
365 fs_reg *nir_ssa_values;
366 fs_reg nir_inputs;
367 fs_reg nir_outputs;
368 fs_reg *nir_system_values;
369
370 bool failed;
371 char *fail_msg;
372 bool simd16_unsupported;
373 char *no16_msg;
374
375 /* Result of last visit() method. Still used by emit_texture() */
376 fs_reg result;
377
378 /** Register numbers for thread payload fields. */
379 struct thread_payload {
380 uint8_t source_depth_reg;
381 uint8_t source_w_reg;
382 uint8_t aa_dest_stencil_reg;
383 uint8_t dest_depth_reg;
384 uint8_t sample_pos_reg;
385 uint8_t sample_mask_in_reg;
386 uint8_t barycentric_coord_reg[BRW_WM_BARYCENTRIC_INTERP_MODE_COUNT];
387 uint8_t local_invocation_id_reg;
388
389 /** The number of thread payload registers the hardware will supply. */
390 uint8_t num_regs;
391 } payload;
392
393 bool source_depth_to_render_target;
394 bool runtime_check_aads_emit;
395
396 fs_reg pixel_x;
397 fs_reg pixel_y;
398 fs_reg wpos_w;
399 fs_reg pixel_w;
400 fs_reg delta_xy[BRW_WM_BARYCENTRIC_INTERP_MODE_COUNT];
401 fs_reg shader_start_time;
402 fs_reg userplane[MAX_CLIP_PLANES];
403 fs_reg final_gs_vertex_count;
404 fs_reg control_data_bits;
405
406 unsigned grf_used;
407 bool spilled_any_registers;
408
409 const unsigned dispatch_width; /**< 8 or 16 */
410 unsigned min_dispatch_width;
411
412 int shader_time_index;
413
414 unsigned promoted_constants;
415 brw::fs_builder bld;
416 };
417
418 /**
419 * The fragment shader code generator.
420 *
421 * Translates FS IR to actual i965 assembly code.
422 */
423 class fs_generator
424 {
425 public:
426 fs_generator(const struct brw_compiler *compiler, void *log_data,
427 void *mem_ctx,
428 const void *key,
429 struct brw_stage_prog_data *prog_data,
430 unsigned promoted_constants,
431 bool runtime_check_aads_emit,
432 gl_shader_stage stage);
433 ~fs_generator();
434
435 void enable_debug(const char *shader_name);
436 int generate_code(const cfg_t *cfg, int dispatch_width);
437 const unsigned *get_assembly(unsigned int *assembly_size);
438
439 private:
440 void fire_fb_write(fs_inst *inst,
441 struct brw_reg payload,
442 struct brw_reg implied_header,
443 GLuint nr);
444 void generate_fb_write(fs_inst *inst, struct brw_reg payload);
445 void generate_urb_read(fs_inst *inst, struct brw_reg dst, struct brw_reg payload);
446 void generate_urb_write(fs_inst *inst, struct brw_reg payload);
447 void generate_cs_terminate(fs_inst *inst, struct brw_reg payload);
448 void generate_stencil_ref_packing(fs_inst *inst, struct brw_reg dst,
449 struct brw_reg src);
450 void generate_barrier(fs_inst *inst, struct brw_reg src);
451 void generate_blorp_fb_write(fs_inst *inst);
452 void generate_linterp(fs_inst *inst, struct brw_reg dst,
453 struct brw_reg *src);
454 void generate_tex(fs_inst *inst, struct brw_reg dst, struct brw_reg src,
455 struct brw_reg surface_index,
456 struct brw_reg sampler_index);
457 void generate_get_buffer_size(fs_inst *inst, struct brw_reg dst,
458 struct brw_reg src,
459 struct brw_reg surf_index);
460 void generate_math_gen6(fs_inst *inst,
461 struct brw_reg dst,
462 struct brw_reg src0,
463 struct brw_reg src1);
464 void generate_math_gen4(fs_inst *inst,
465 struct brw_reg dst,
466 struct brw_reg src);
467 void generate_math_g45(fs_inst *inst,
468 struct brw_reg dst,
469 struct brw_reg src);
470 void generate_ddx(enum opcode op, struct brw_reg dst, struct brw_reg src);
471 void generate_ddy(enum opcode op, struct brw_reg dst, struct brw_reg src,
472 bool negate_value);
473 void generate_scratch_write(fs_inst *inst, struct brw_reg src);
474 void generate_scratch_read(fs_inst *inst, struct brw_reg dst);
475 void generate_scratch_read_gen7(fs_inst *inst, struct brw_reg dst);
476 void generate_uniform_pull_constant_load(fs_inst *inst, struct brw_reg dst,
477 struct brw_reg index,
478 struct brw_reg offset);
479 void generate_uniform_pull_constant_load_gen7(fs_inst *inst,
480 struct brw_reg dst,
481 struct brw_reg surf_index,
482 struct brw_reg offset);
483 void generate_varying_pull_constant_load(fs_inst *inst, struct brw_reg dst,
484 struct brw_reg index,
485 struct brw_reg offset);
486 void generate_varying_pull_constant_load_gen7(fs_inst *inst,
487 struct brw_reg dst,
488 struct brw_reg index,
489 struct brw_reg offset);
490 void generate_mov_dispatch_to_flags(fs_inst *inst);
491
492 void generate_pixel_interpolator_query(fs_inst *inst,
493 struct brw_reg dst,
494 struct brw_reg src,
495 struct brw_reg msg_data,
496 unsigned msg_type);
497
498 void generate_set_sample_id(fs_inst *inst,
499 struct brw_reg dst,
500 struct brw_reg src0,
501 struct brw_reg src1);
502
503 void generate_set_simd4x2_offset(fs_inst *inst,
504 struct brw_reg dst,
505 struct brw_reg offset);
506 void generate_discard_jump(fs_inst *inst);
507
508 void generate_pack_half_2x16_split(fs_inst *inst,
509 struct brw_reg dst,
510 struct brw_reg x,
511 struct brw_reg y);
512 void generate_unpack_half_2x16_split(fs_inst *inst,
513 struct brw_reg dst,
514 struct brw_reg src);
515
516 void generate_shader_time_add(fs_inst *inst,
517 struct brw_reg payload,
518 struct brw_reg offset,
519 struct brw_reg value);
520
521 void generate_mov_indirect(fs_inst *inst,
522 struct brw_reg dst,
523 struct brw_reg reg,
524 struct brw_reg indirect_byte_offset);
525
526 bool patch_discard_jumps_to_fb_writes();
527
528 const struct brw_compiler *compiler;
529 void *log_data; /* Passed to compiler->*_log functions */
530
531 const struct brw_device_info *devinfo;
532
533 struct brw_codegen *p;
534 const void * const key;
535 struct brw_stage_prog_data * const prog_data;
536
537 unsigned dispatch_width; /**< 8 or 16 */
538
539 exec_list discard_halt_patches;
540 unsigned promoted_constants;
541 bool runtime_check_aads_emit;
542 bool debug_flag;
543 const char *shader_name;
544 gl_shader_stage stage;
545 void *mem_ctx;
546 };
547
548 bool brw_do_channel_expressions(struct exec_list *instructions);
549 bool brw_do_vector_splitting(struct exec_list *instructions);