intel/fs: Refactor ALU source and destination handling to a separate function
[mesa.git] / src / intel / compiler / 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 #ifndef BRW_FS_H
29 #define BRW_FS_H
30
31 #include "brw_shader.h"
32 #include "brw_ir_fs.h"
33 #include "brw_fs_builder.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(const fs_reg &reg, const brw::fs_builder &bld, unsigned delta)
49 {
50 return offset(reg, bld.dispatch_width(), delta);
51 }
52
53 #define UBO_START ((1 << 16) - 4)
54
55 /**
56 * The fragment shader front-end.
57 *
58 * Translates either GLSL IR or Mesa IR (for ARB_fragment_program) into FS IR.
59 */
60 class fs_visitor : public backend_shader
61 {
62 public:
63 fs_visitor(const struct brw_compiler *compiler, void *log_data,
64 void *mem_ctx,
65 const void *key,
66 struct brw_stage_prog_data *prog_data,
67 struct gl_program *prog,
68 const nir_shader *shader,
69 unsigned dispatch_width,
70 int shader_time_index,
71 const struct brw_vue_map *input_vue_map = NULL);
72 fs_visitor(const struct brw_compiler *compiler, void *log_data,
73 void *mem_ctx,
74 struct brw_gs_compile *gs_compile,
75 struct brw_gs_prog_data *prog_data,
76 const nir_shader *shader,
77 int shader_time_index);
78 void init();
79 ~fs_visitor();
80
81 fs_reg vgrf(const glsl_type *const type);
82 void import_uniforms(fs_visitor *v);
83 void setup_uniform_clipplane_values();
84 void compute_clip_distance();
85
86 void VARYING_PULL_CONSTANT_LOAD(const brw::fs_builder &bld,
87 const fs_reg &dst,
88 const fs_reg &surf_index,
89 const fs_reg &varying_offset,
90 uint32_t const_offset);
91 void DEP_RESOLVE_MOV(const brw::fs_builder &bld, int grf);
92
93 bool run_fs(bool allow_spilling, bool do_rep_send);
94 bool run_vs();
95 bool run_tcs_single_patch();
96 bool run_tes();
97 bool run_gs();
98 bool run_cs(unsigned min_dispatch_width);
99 void optimize();
100 void allocate_registers(unsigned min_dispatch_width, bool allow_spilling);
101 void setup_fs_payload_gen4();
102 void setup_fs_payload_gen6();
103 void setup_vs_payload();
104 void setup_gs_payload();
105 void setup_cs_payload();
106 bool fixup_sends_duplicate_payload();
107 void fixup_3src_null_dest();
108 void assign_curb_setup();
109 void calculate_urb_setup();
110 void assign_urb_setup();
111 void convert_attr_sources_to_hw_regs(fs_inst *inst);
112 void assign_vs_urb_setup();
113 void assign_tcs_single_patch_urb_setup();
114 void assign_tes_urb_setup();
115 void assign_gs_urb_setup();
116 bool assign_regs(bool allow_spilling, bool spill_all);
117 void assign_regs_trivial();
118 void calculate_payload_ranges(int payload_node_count,
119 int *payload_last_use_ip);
120 void setup_payload_interference(struct ra_graph *g, int payload_reg_count,
121 int first_payload_node);
122 int choose_spill_reg(struct ra_graph *g);
123 void spill_reg(unsigned spill_reg);
124 void split_virtual_grfs();
125 bool compact_virtual_grfs();
126 void assign_constant_locations();
127 bool get_pull_locs(const fs_reg &src, unsigned *out_surf_index,
128 unsigned *out_pull_index);
129 void lower_constant_loads();
130 void invalidate_live_intervals();
131 void calculate_live_intervals();
132 void calculate_register_pressure();
133 void validate();
134 bool opt_algebraic();
135 bool opt_redundant_discard_jumps();
136 bool opt_cse();
137 bool opt_cse_local(bblock_t *block);
138 bool opt_copy_propagation();
139 bool try_copy_propagate(fs_inst *inst, int arg, acp_entry *entry);
140 bool try_constant_propagate(fs_inst *inst, acp_entry *entry);
141 bool opt_copy_propagation_local(void *mem_ctx, bblock_t *block,
142 exec_list *acp);
143 bool opt_drop_redundant_mov_to_flags();
144 bool opt_register_renaming();
145 bool opt_bank_conflicts();
146 unsigned bank_conflict_cycles(const fs_inst *inst) const;
147 bool register_coalesce();
148 bool compute_to_mrf();
149 bool eliminate_find_live_channel();
150 bool dead_code_eliminate();
151 bool remove_duplicate_mrf_writes();
152 bool remove_extra_rounding_modes();
153
154 bool opt_sampler_eot();
155 bool virtual_grf_interferes(int a, int b);
156 void schedule_instructions(instruction_scheduler_mode mode);
157 void insert_gen4_send_dependency_workarounds();
158 void insert_gen4_pre_send_dependency_workarounds(bblock_t *block,
159 fs_inst *inst);
160 void insert_gen4_post_send_dependency_workarounds(bblock_t *block,
161 fs_inst *inst);
162 void vfail(const char *msg, va_list args);
163 void fail(const char *msg, ...);
164 void limit_dispatch_width(unsigned n, const char *msg);
165 void lower_uniform_pull_constant_loads();
166 bool lower_load_payload();
167 bool lower_pack();
168 bool lower_regioning();
169 bool lower_logical_sends();
170 bool lower_integer_multiplication();
171 bool lower_minmax();
172 bool lower_simd_width();
173 bool opt_combine_constants();
174
175 void emit_dummy_fs();
176 void emit_repclear_shader();
177 void emit_fragcoord_interpolation(fs_reg wpos);
178 fs_reg *emit_frontfacing_interpolation();
179 fs_reg *emit_samplepos_setup();
180 fs_reg *emit_sampleid_setup();
181 fs_reg *emit_samplemaskin_setup();
182 void emit_interpolation_setup_gen4();
183 void emit_interpolation_setup_gen6();
184 void compute_sample_position(fs_reg dst, fs_reg int_sample_pos);
185 fs_reg emit_mcs_fetch(const fs_reg &coordinate, unsigned components,
186 const fs_reg &sampler);
187 void emit_gen6_gather_wa(uint8_t wa, fs_reg dst);
188 fs_reg resolve_source_modifiers(const fs_reg &src);
189 void emit_discard_jump();
190 bool opt_peephole_sel();
191 bool opt_peephole_csel();
192 bool opt_peephole_predicated_break();
193 bool opt_saturate_propagation();
194 bool opt_cmod_propagation();
195 bool opt_zero_samples();
196
197 void emit_nir_code();
198 void nir_setup_outputs();
199 void nir_setup_uniforms();
200 void nir_emit_system_values();
201 void nir_emit_impl(nir_function_impl *impl);
202 void nir_emit_cf_list(exec_list *list);
203 void nir_emit_if(nir_if *if_stmt);
204 void nir_emit_loop(nir_loop *loop);
205 void nir_emit_block(nir_block *block);
206 void nir_emit_instr(nir_instr *instr);
207 void nir_emit_alu(const brw::fs_builder &bld, nir_alu_instr *instr);
208 void nir_emit_load_const(const brw::fs_builder &bld,
209 nir_load_const_instr *instr);
210 void nir_emit_vs_intrinsic(const brw::fs_builder &bld,
211 nir_intrinsic_instr *instr);
212 void nir_emit_tcs_intrinsic(const brw::fs_builder &bld,
213 nir_intrinsic_instr *instr);
214 void nir_emit_gs_intrinsic(const brw::fs_builder &bld,
215 nir_intrinsic_instr *instr);
216 void nir_emit_fs_intrinsic(const brw::fs_builder &bld,
217 nir_intrinsic_instr *instr);
218 void nir_emit_cs_intrinsic(const brw::fs_builder &bld,
219 nir_intrinsic_instr *instr);
220 fs_reg get_nir_image_intrinsic_image(const brw::fs_builder &bld,
221 nir_intrinsic_instr *instr);
222 fs_reg get_nir_ssbo_intrinsic_index(const brw::fs_builder &bld,
223 nir_intrinsic_instr *instr);
224 void nir_emit_intrinsic(const brw::fs_builder &bld,
225 nir_intrinsic_instr *instr);
226 void nir_emit_tes_intrinsic(const brw::fs_builder &bld,
227 nir_intrinsic_instr *instr);
228 void nir_emit_ssbo_atomic(const brw::fs_builder &bld,
229 int op, nir_intrinsic_instr *instr);
230 void nir_emit_ssbo_atomic_float(const brw::fs_builder &bld,
231 int op, nir_intrinsic_instr *instr);
232 void nir_emit_shared_atomic(const brw::fs_builder &bld,
233 int op, nir_intrinsic_instr *instr);
234 void nir_emit_shared_atomic_float(const brw::fs_builder &bld,
235 int op, nir_intrinsic_instr *instr);
236 void nir_emit_global_atomic(const brw::fs_builder &bld,
237 int op, nir_intrinsic_instr *instr);
238 void nir_emit_global_atomic_float(const brw::fs_builder &bld,
239 int op, nir_intrinsic_instr *instr);
240 void nir_emit_texture(const brw::fs_builder &bld,
241 nir_tex_instr *instr);
242 void nir_emit_jump(const brw::fs_builder &bld,
243 nir_jump_instr *instr);
244 fs_reg get_nir_src(const nir_src &src);
245 fs_reg get_nir_src_imm(const nir_src &src);
246 fs_reg get_nir_dest(const nir_dest &dest);
247 fs_reg get_indirect_offset(nir_intrinsic_instr *instr);
248 void emit_percomp(const brw::fs_builder &bld, const fs_inst &inst,
249 unsigned wr_mask);
250
251 bool optimize_extract_to_float(nir_alu_instr *instr,
252 const fs_reg &result);
253 bool optimize_frontfacing_ternary(nir_alu_instr *instr,
254 const fs_reg &result);
255
256 void emit_alpha_test();
257 fs_inst *emit_single_fb_write(const brw::fs_builder &bld,
258 fs_reg color1, fs_reg color2,
259 fs_reg src0_alpha, unsigned components);
260 void emit_fb_writes();
261 fs_inst *emit_non_coherent_fb_read(const brw::fs_builder &bld,
262 const fs_reg &dst, unsigned target);
263 void emit_urb_writes(const fs_reg &gs_vertex_count = fs_reg());
264 void set_gs_stream_control_data_bits(const fs_reg &vertex_count,
265 unsigned stream_id);
266 void emit_gs_control_data_bits(const fs_reg &vertex_count);
267 void emit_gs_end_primitive(const nir_src &vertex_count_nir_src);
268 void emit_gs_vertex(const nir_src &vertex_count_nir_src,
269 unsigned stream_id);
270 void emit_gs_thread_end();
271 void emit_gs_input_load(const fs_reg &dst, const nir_src &vertex_src,
272 unsigned base_offset, const nir_src &offset_src,
273 unsigned num_components, unsigned first_component);
274 void emit_cs_terminate();
275 fs_reg *emit_cs_work_group_id_setup();
276
277 void emit_barrier();
278
279 void emit_shader_time_begin();
280 void emit_shader_time_end();
281 void SHADER_TIME_ADD(const brw::fs_builder &bld,
282 int shader_time_subindex,
283 fs_reg value);
284
285 fs_reg get_timestamp(const brw::fs_builder &bld);
286
287 fs_reg interp_reg(int location, int channel);
288
289 int implied_mrf_writes(fs_inst *inst) const;
290
291 virtual void dump_instructions();
292 virtual void dump_instructions(const char *name);
293 void dump_instruction(backend_instruction *inst);
294 void dump_instruction(backend_instruction *inst, FILE *file);
295
296 const void *const key;
297 const struct brw_sampler_prog_key_data *key_tex;
298
299 struct brw_gs_compile *gs_compile;
300
301 struct brw_stage_prog_data *prog_data;
302 struct gl_program *prog;
303
304 const struct brw_vue_map *input_vue_map;
305
306 int *virtual_grf_start;
307 int *virtual_grf_end;
308 brw::fs_live_variables *live_intervals;
309
310 int *regs_live_at_ip;
311
312 /** Number of uniform variable components visited. */
313 unsigned uniforms;
314
315 /** Byte-offset for the next available spot in the scratch space buffer. */
316 unsigned last_scratch;
317
318 /**
319 * Array mapping UNIFORM register numbers to the pull parameter index,
320 * or -1 if this uniform register isn't being uploaded as a pull constant.
321 */
322 int *pull_constant_loc;
323
324 /**
325 * Array mapping UNIFORM register numbers to the push parameter index,
326 * or -1 if this uniform register isn't being uploaded as a push constant.
327 */
328 int *push_constant_loc;
329
330 fs_reg subgroup_id;
331 fs_reg frag_depth;
332 fs_reg frag_stencil;
333 fs_reg sample_mask;
334 fs_reg outputs[VARYING_SLOT_MAX];
335 fs_reg dual_src_output;
336 int first_non_payload_grf;
337 /** Either BRW_MAX_GRF or GEN7_MRF_HACK_START */
338 unsigned max_grf;
339
340 fs_reg *nir_locals;
341 fs_reg *nir_ssa_values;
342 fs_reg *nir_system_values;
343
344 bool failed;
345 char *fail_msg;
346
347 /** Register numbers for thread payload fields. */
348 struct thread_payload {
349 uint8_t subspan_coord_reg[2];
350 uint8_t source_depth_reg[2];
351 uint8_t source_w_reg[2];
352 uint8_t aa_dest_stencil_reg[2];
353 uint8_t dest_depth_reg[2];
354 uint8_t sample_pos_reg[2];
355 uint8_t sample_mask_in_reg[2];
356 uint8_t barycentric_coord_reg[BRW_BARYCENTRIC_MODE_COUNT][2];
357 uint8_t local_invocation_id_reg[2];
358
359 /** The number of thread payload registers the hardware will supply. */
360 uint8_t num_regs;
361 } payload;
362
363 bool source_depth_to_render_target;
364 bool runtime_check_aads_emit;
365
366 fs_reg pixel_x;
367 fs_reg pixel_y;
368 fs_reg wpos_w;
369 fs_reg pixel_w;
370 fs_reg delta_xy[BRW_BARYCENTRIC_MODE_COUNT];
371 fs_reg shader_start_time;
372 fs_reg userplane[MAX_CLIP_PLANES];
373 fs_reg final_gs_vertex_count;
374 fs_reg control_data_bits;
375 fs_reg invocation_id;
376
377 unsigned grf_used;
378 bool spilled_any_registers;
379
380 const unsigned dispatch_width; /**< 8, 16 or 32 */
381 unsigned max_dispatch_width;
382
383 int shader_time_index;
384
385 unsigned promoted_constants;
386 brw::fs_builder bld;
387
388 private:
389 fs_reg prepare_alu_destination_and_sources(const brw::fs_builder &bld,
390 nir_alu_instr *instr,
391 fs_reg *op,
392 bool need_dest);
393 };
394
395 /**
396 * The fragment shader code generator.
397 *
398 * Translates FS IR to actual i965 assembly code.
399 */
400 class fs_generator
401 {
402 public:
403 fs_generator(const struct brw_compiler *compiler, void *log_data,
404 void *mem_ctx,
405 struct brw_stage_prog_data *prog_data,
406 unsigned promoted_constants,
407 bool runtime_check_aads_emit,
408 gl_shader_stage stage);
409 ~fs_generator();
410
411 void enable_debug(const char *shader_name);
412 int generate_code(const cfg_t *cfg, int dispatch_width);
413 const unsigned *get_assembly();
414
415 private:
416 void fire_fb_write(fs_inst *inst,
417 struct brw_reg payload,
418 struct brw_reg implied_header,
419 GLuint nr);
420 void generate_send(fs_inst *inst,
421 struct brw_reg dst,
422 struct brw_reg desc,
423 struct brw_reg ex_desc,
424 struct brw_reg payload,
425 struct brw_reg payload2);
426 void generate_fb_write(fs_inst *inst, struct brw_reg payload);
427 void generate_fb_read(fs_inst *inst, struct brw_reg dst,
428 struct brw_reg payload);
429 void generate_urb_read(fs_inst *inst, struct brw_reg dst, struct brw_reg payload);
430 void generate_urb_write(fs_inst *inst, struct brw_reg payload);
431 void generate_cs_terminate(fs_inst *inst, struct brw_reg payload);
432 void generate_barrier(fs_inst *inst, struct brw_reg src);
433 bool generate_linterp(fs_inst *inst, struct brw_reg dst,
434 struct brw_reg *src);
435 void generate_tex(fs_inst *inst, struct brw_reg dst,
436 struct brw_reg surface_index,
437 struct brw_reg sampler_index);
438 void generate_get_buffer_size(fs_inst *inst, struct brw_reg dst,
439 struct brw_reg src,
440 struct brw_reg surf_index);
441 void generate_ddx(const fs_inst *inst,
442 struct brw_reg dst, struct brw_reg src);
443 void generate_ddy(const fs_inst *inst,
444 struct brw_reg dst, struct brw_reg src);
445 void generate_scratch_write(fs_inst *inst, struct brw_reg src);
446 void generate_scratch_read(fs_inst *inst, struct brw_reg dst);
447 void generate_scratch_read_gen7(fs_inst *inst, struct brw_reg dst);
448 void generate_uniform_pull_constant_load(fs_inst *inst, struct brw_reg dst,
449 struct brw_reg index,
450 struct brw_reg offset);
451 void generate_uniform_pull_constant_load_gen7(fs_inst *inst,
452 struct brw_reg dst,
453 struct brw_reg surf_index,
454 struct brw_reg payload);
455 void generate_varying_pull_constant_load_gen4(fs_inst *inst,
456 struct brw_reg dst,
457 struct brw_reg index);
458 void generate_mov_dispatch_to_flags(fs_inst *inst);
459
460 void generate_pixel_interpolator_query(fs_inst *inst,
461 struct brw_reg dst,
462 struct brw_reg src,
463 struct brw_reg msg_data,
464 unsigned msg_type);
465
466 void generate_set_sample_id(fs_inst *inst,
467 struct brw_reg dst,
468 struct brw_reg src0,
469 struct brw_reg src1);
470
471 void generate_discard_jump(fs_inst *inst);
472
473 void generate_pack_half_2x16_split(fs_inst *inst,
474 struct brw_reg dst,
475 struct brw_reg x,
476 struct brw_reg y);
477
478 void generate_shader_time_add(fs_inst *inst,
479 struct brw_reg payload,
480 struct brw_reg offset,
481 struct brw_reg value);
482
483 void generate_mov_indirect(fs_inst *inst,
484 struct brw_reg dst,
485 struct brw_reg reg,
486 struct brw_reg indirect_byte_offset);
487
488 void generate_shuffle(fs_inst *inst,
489 struct brw_reg dst,
490 struct brw_reg src,
491 struct brw_reg idx);
492
493 void generate_quad_swizzle(const fs_inst *inst,
494 struct brw_reg dst, struct brw_reg src,
495 unsigned swiz);
496
497 bool patch_discard_jumps_to_fb_writes();
498
499 const struct brw_compiler *compiler;
500 void *log_data; /* Passed to compiler->*_log functions */
501
502 const struct gen_device_info *devinfo;
503
504 struct brw_codegen *p;
505 struct brw_stage_prog_data * const prog_data;
506
507 unsigned dispatch_width; /**< 8, 16 or 32 */
508
509 exec_list discard_halt_patches;
510 unsigned promoted_constants;
511 bool runtime_check_aads_emit;
512 bool debug_flag;
513 const char *shader_name;
514 gl_shader_stage stage;
515 void *mem_ctx;
516 };
517
518 namespace brw {
519 inline fs_reg
520 fetch_payload_reg(const brw::fs_builder &bld, uint8_t regs[2],
521 brw_reg_type type = BRW_REGISTER_TYPE_F, unsigned n = 1)
522 {
523 if (!regs[0])
524 return fs_reg();
525
526 if (bld.dispatch_width() > 16) {
527 const fs_reg tmp = bld.vgrf(type, n);
528 const brw::fs_builder hbld = bld.exec_all().group(16, 0);
529 const unsigned m = bld.dispatch_width() / hbld.dispatch_width();
530 fs_reg *const components = new fs_reg[n * m];
531
532 for (unsigned c = 0; c < n; c++) {
533 for (unsigned g = 0; g < m; g++) {
534 components[c * m + g] =
535 offset(retype(brw_vec8_grf(regs[g], 0), type), hbld, c);
536 }
537 }
538
539 hbld.LOAD_PAYLOAD(tmp, components, n * m, 0);
540
541 delete[] components;
542 return tmp;
543
544 } else {
545 return fs_reg(retype(brw_vec8_grf(regs[0], 0), type));
546 }
547 }
548
549 bool
550 lower_src_modifiers(fs_visitor *v, bblock_t *block, fs_inst *inst, unsigned i);
551 }
552
553 void shuffle_from_32bit_read(const brw::fs_builder &bld,
554 const fs_reg &dst,
555 const fs_reg &src,
556 uint32_t first_component,
557 uint32_t components);
558
559 fs_reg shuffle_for_32bit_write(const brw::fs_builder &bld,
560 const fs_reg &src,
561 uint32_t first_component,
562 uint32_t components);
563
564 fs_reg setup_imm_df(const brw::fs_builder &bld,
565 double v);
566
567 fs_reg setup_imm_b(const brw::fs_builder &bld,
568 int8_t v);
569
570 fs_reg setup_imm_ub(const brw::fs_builder &bld,
571 uint8_t v);
572
573 enum brw_barycentric_mode brw_barycentric_mode(enum glsl_interp_mode mode,
574 nir_intrinsic_op op);
575
576 #endif /* BRW_FS_H */