i965: Make dump_instructions be a virtual method of the visitor.
[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
32 extern "C" {
33
34 #include <sys/types.h>
35
36 #include "main/macros.h"
37 #include "main/shaderobj.h"
38 #include "main/uniforms.h"
39 #include "program/prog_parameter.h"
40 #include "program/prog_print.h"
41 #include "program/prog_optimize.h"
42 #include "program/register_allocate.h"
43 #include "program/sampler.h"
44 #include "program/hash_table.h"
45 #include "brw_context.h"
46 #include "brw_eu.h"
47 #include "brw_wm.h"
48 #include "brw_shader.h"
49 }
50 #include "glsl/glsl_types.h"
51 #include "glsl/ir.h"
52
53 class bblock_t;
54 namespace {
55 struct acp_entry;
56 }
57
58 enum register_file {
59 BAD_FILE,
60 ARF,
61 GRF,
62 MRF,
63 IMM,
64 FIXED_HW_REG, /* a struct brw_reg */
65 UNIFORM, /* prog_data->params[reg] */
66 };
67
68 class fs_reg {
69 public:
70 /* Callers of this ralloc-based new need not call delete. It's
71 * easier to just ralloc_free 'ctx' (or any of its ancestors). */
72 static void* operator new(size_t size, void *ctx)
73 {
74 void *node;
75
76 node = ralloc_size(ctx, size);
77 assert(node != NULL);
78
79 return node;
80 }
81
82 void init();
83
84 fs_reg();
85 fs_reg(float f);
86 fs_reg(int32_t i);
87 fs_reg(uint32_t u);
88 fs_reg(struct brw_reg fixed_hw_reg);
89 fs_reg(enum register_file file, int reg);
90 fs_reg(enum register_file file, int reg, uint32_t type);
91 fs_reg(class fs_visitor *v, const struct glsl_type *type);
92
93 bool equals(const fs_reg &r) const;
94 bool is_zero() const;
95 bool is_one() const;
96 bool is_valid_3src() const;
97
98 /** Register file: ARF, GRF, MRF, IMM. */
99 enum register_file file;
100 /**
101 * Register number. For ARF/MRF, it's the hardware register. For
102 * GRF, it's a virtual register number until register allocation
103 */
104 int reg;
105 /**
106 * For virtual registers, this is a hardware register offset from
107 * the start of the register block (for example, a constant index
108 * in an array access).
109 */
110 int reg_offset;
111 /** Register type. BRW_REGISTER_TYPE_* */
112 int type;
113 bool negate;
114 bool abs;
115 bool sechalf;
116 struct brw_reg fixed_hw_reg;
117 int smear; /* -1, or a channel of the reg to smear to all channels. */
118
119 /** Value for file == IMM */
120 union {
121 int32_t i;
122 uint32_t u;
123 float f;
124 } imm;
125
126 fs_reg *reladdr;
127 };
128
129 static const fs_reg reg_undef;
130 static const fs_reg reg_null_f(ARF, BRW_ARF_NULL, BRW_REGISTER_TYPE_F);
131 static const fs_reg reg_null_d(ARF, BRW_ARF_NULL, BRW_REGISTER_TYPE_D);
132
133 class ip_record : public exec_node {
134 public:
135 static void* operator new(size_t size, void *ctx)
136 {
137 void *node;
138
139 node = rzalloc_size(ctx, size);
140 assert(node != NULL);
141
142 return node;
143 }
144
145 ip_record(int ip)
146 {
147 this->ip = ip;
148 }
149
150 int ip;
151 };
152
153 class fs_inst : public backend_instruction {
154 public:
155 /* Callers of this ralloc-based new need not call delete. It's
156 * easier to just ralloc_free 'ctx' (or any of its ancestors). */
157 static void* operator new(size_t size, void *ctx)
158 {
159 void *node;
160
161 node = rzalloc_size(ctx, size);
162 assert(node != NULL);
163
164 return node;
165 }
166
167 void init();
168
169 fs_inst();
170 fs_inst(enum opcode opcode);
171 fs_inst(enum opcode opcode, fs_reg dst);
172 fs_inst(enum opcode opcode, fs_reg dst, fs_reg src0);
173 fs_inst(enum opcode opcode, fs_reg dst, fs_reg src0, fs_reg src1);
174 fs_inst(enum opcode opcode, fs_reg dst,
175 fs_reg src0, fs_reg src1,fs_reg src2);
176
177 bool equals(fs_inst *inst);
178 bool overwrites_reg(const fs_reg &reg);
179 bool is_send_from_grf();
180 bool is_partial_write();
181
182 fs_reg dst;
183 fs_reg src[3];
184 bool saturate;
185 int conditional_mod; /**< BRW_CONDITIONAL_* */
186
187 /* Chooses which flag subregister (f0.0 or f0.1) is used for conditional
188 * mod and predication.
189 */
190 uint8_t flag_subreg;
191
192 int mlen; /**< SEND message length */
193 int regs_written; /**< Number of vgrfs written by a SEND message, or 1 */
194 int base_mrf; /**< First MRF in the SEND message, if mlen is nonzero. */
195 uint32_t texture_offset; /**< Texture offset bitfield */
196 int sampler;
197 int target; /**< MRT target. */
198 bool eot;
199 bool header_present;
200 bool shadow_compare;
201 bool force_uncompressed;
202 bool force_sechalf;
203 bool force_writemask_all;
204 uint32_t offset; /* spill/unspill offset */
205
206 /** @{
207 * Annotation for the generated IR. One of the two can be set.
208 */
209 const void *ir;
210 const char *annotation;
211 /** @} */
212 };
213
214 /**
215 * The fragment shader front-end.
216 *
217 * Translates either GLSL IR or Mesa IR (for ARB_fragment_program) into FS IR.
218 */
219 class fs_visitor : public backend_visitor
220 {
221 public:
222
223 fs_visitor(struct brw_context *brw,
224 struct brw_wm_compile *c,
225 struct gl_shader_program *shader_prog,
226 struct gl_fragment_program *fp,
227 unsigned dispatch_width);
228 ~fs_visitor();
229
230 fs_reg *variable_storage(ir_variable *var);
231 int virtual_grf_alloc(int size);
232 void import_uniforms(fs_visitor *v);
233
234 void visit(ir_variable *ir);
235 void visit(ir_assignment *ir);
236 void visit(ir_dereference_variable *ir);
237 void visit(ir_dereference_record *ir);
238 void visit(ir_dereference_array *ir);
239 void visit(ir_expression *ir);
240 void visit(ir_texture *ir);
241 void visit(ir_if *ir);
242 void visit(ir_constant *ir);
243 void visit(ir_swizzle *ir);
244 void visit(ir_return *ir);
245 void visit(ir_loop *ir);
246 void visit(ir_loop_jump *ir);
247 void visit(ir_discard *ir);
248 void visit(ir_call *ir);
249 void visit(ir_function *ir);
250 void visit(ir_function_signature *ir);
251
252 void swizzle_result(ir_texture *ir, fs_reg orig_val, int sampler);
253
254 bool can_do_source_mods(fs_inst *inst);
255
256 fs_inst *emit(fs_inst inst);
257 fs_inst *emit(fs_inst *inst);
258 void emit(exec_list list);
259
260 fs_inst *emit(enum opcode opcode);
261 fs_inst *emit(enum opcode opcode, fs_reg dst);
262 fs_inst *emit(enum opcode opcode, fs_reg dst, fs_reg src0);
263 fs_inst *emit(enum opcode opcode, fs_reg dst, fs_reg src0, fs_reg src1);
264 fs_inst *emit(enum opcode opcode, fs_reg dst,
265 fs_reg src0, fs_reg src1, fs_reg src2);
266
267 fs_inst *MOV(fs_reg dst, fs_reg src);
268 fs_inst *NOT(fs_reg dst, fs_reg src);
269 fs_inst *RNDD(fs_reg dst, fs_reg src);
270 fs_inst *RNDE(fs_reg dst, fs_reg src);
271 fs_inst *RNDZ(fs_reg dst, fs_reg src);
272 fs_inst *FRC(fs_reg dst, fs_reg src);
273 fs_inst *ADD(fs_reg dst, fs_reg src0, fs_reg src1);
274 fs_inst *MUL(fs_reg dst, fs_reg src0, fs_reg src1);
275 fs_inst *MACH(fs_reg dst, fs_reg src0, fs_reg src1);
276 fs_inst *MAC(fs_reg dst, fs_reg src0, fs_reg src1);
277 fs_inst *SHL(fs_reg dst, fs_reg src0, fs_reg src1);
278 fs_inst *SHR(fs_reg dst, fs_reg src0, fs_reg src1);
279 fs_inst *ASR(fs_reg dst, fs_reg src0, fs_reg src1);
280 fs_inst *AND(fs_reg dst, fs_reg src0, fs_reg src1);
281 fs_inst *OR(fs_reg dst, fs_reg src0, fs_reg src1);
282 fs_inst *XOR(fs_reg dst, fs_reg src0, fs_reg src1);
283 fs_inst *IF(uint32_t predicate);
284 fs_inst *IF(fs_reg src0, fs_reg src1, uint32_t condition);
285 fs_inst *CMP(fs_reg dst, fs_reg src0, fs_reg src1,
286 uint32_t condition);
287 fs_inst *LRP(fs_reg dst, fs_reg a, fs_reg y, fs_reg x);
288 fs_inst *DEP_RESOLVE_MOV(int grf);
289
290 int type_size(const struct glsl_type *type);
291 fs_inst *get_instruction_generating_reg(fs_inst *start,
292 fs_inst *end,
293 fs_reg reg);
294
295 exec_list VARYING_PULL_CONSTANT_LOAD(fs_reg dst, fs_reg surf_index,
296 fs_reg varying_offset,
297 uint32_t const_offset);
298
299 bool run();
300 void setup_payload_gen4();
301 void setup_payload_gen6();
302 void assign_curb_setup();
303 void calculate_urb_setup();
304 void assign_urb_setup();
305 bool assign_regs();
306 void assign_regs_trivial();
307 void setup_payload_interference(struct ra_graph *g, int payload_reg_count,
308 int first_payload_node);
309 void setup_mrf_hack_interference(struct ra_graph *g,
310 int first_mrf_hack_node);
311 int choose_spill_reg(struct ra_graph *g);
312 void spill_reg(int spill_reg);
313 void split_virtual_grfs();
314 void compact_virtual_grfs();
315 void move_uniform_array_access_to_pull_constants();
316 void setup_pull_constants();
317 void calculate_live_intervals();
318 bool opt_algebraic();
319 bool opt_cse();
320 bool opt_cse_local(bblock_t *block, exec_list *aeb);
321 bool opt_copy_propagate();
322 bool try_copy_propagate(fs_inst *inst, int arg, acp_entry *entry);
323 bool try_constant_propagate(fs_inst *inst, acp_entry *entry);
324 bool opt_copy_propagate_local(void *mem_ctx, bblock_t *block,
325 exec_list *acp);
326 bool register_coalesce();
327 bool register_coalesce_2();
328 bool compute_to_mrf();
329 bool dead_code_eliminate();
330 bool dead_code_eliminate_local();
331 bool remove_dead_constants();
332 bool remove_duplicate_mrf_writes();
333 bool virtual_grf_interferes(int a, int b);
334 void schedule_instructions(bool post_reg_alloc);
335 void insert_gen4_send_dependency_workarounds();
336 void insert_gen4_pre_send_dependency_workarounds(fs_inst *inst);
337 void insert_gen4_post_send_dependency_workarounds(fs_inst *inst);
338 void fail(const char *msg, ...);
339 void lower_uniform_pull_constant_loads();
340
341 void push_force_uncompressed();
342 void pop_force_uncompressed();
343 void push_force_sechalf();
344 void pop_force_sechalf();
345
346 void emit_dummy_fs();
347 fs_reg *emit_fragcoord_interpolation(ir_variable *ir);
348 fs_inst *emit_linterp(const fs_reg &attr, const fs_reg &interp,
349 glsl_interp_qualifier interpolation_mode,
350 bool is_centroid);
351 fs_reg *emit_frontfacing_interpolation(ir_variable *ir);
352 fs_reg *emit_general_interpolation(ir_variable *ir);
353 void emit_interpolation_setup_gen4();
354 void emit_interpolation_setup_gen6();
355 fs_reg rescale_texcoord(ir_texture *ir, fs_reg coordinate,
356 bool is_rect, int sampler, int texunit);
357 fs_inst *emit_texture_gen4(ir_texture *ir, fs_reg dst, fs_reg coordinate,
358 fs_reg shadow_comp, fs_reg lod, fs_reg lod2);
359 fs_inst *emit_texture_gen5(ir_texture *ir, fs_reg dst, fs_reg coordinate,
360 fs_reg shadow_comp, fs_reg lod, fs_reg lod2,
361 fs_reg sample_index);
362 fs_inst *emit_texture_gen7(ir_texture *ir, fs_reg dst, fs_reg coordinate,
363 fs_reg shadow_comp, fs_reg lod, fs_reg lod2,
364 fs_reg sample_index);
365 fs_reg fix_math_operand(fs_reg src);
366 fs_inst *emit_math(enum opcode op, fs_reg dst, fs_reg src0);
367 fs_inst *emit_math(enum opcode op, fs_reg dst, fs_reg src0, fs_reg src1);
368 void emit_lrp(fs_reg dst, fs_reg x, fs_reg y, fs_reg a);
369 void emit_minmax(uint32_t conditionalmod, fs_reg dst,
370 fs_reg src0, fs_reg src1);
371 bool try_emit_saturate(ir_expression *ir);
372 bool try_emit_mad(ir_expression *ir, int mul_arg);
373 void emit_bool_to_cond_code(ir_rvalue *condition);
374 void emit_if_gen6(ir_if *ir);
375 void emit_unspill(fs_inst *inst, fs_reg reg, uint32_t spill_offset);
376
377 void emit_fragment_program_code();
378 void setup_fp_regs();
379 fs_reg get_fp_src_reg(const prog_src_register *src);
380 fs_reg get_fp_dst_reg(const prog_dst_register *dst);
381 void emit_fp_alu1(enum opcode opcode,
382 const struct prog_instruction *fpi,
383 fs_reg dst, fs_reg src);
384 void emit_fp_alu2(enum opcode opcode,
385 const struct prog_instruction *fpi,
386 fs_reg dst, fs_reg src0, fs_reg src1);
387 void emit_fp_scalar_write(const struct prog_instruction *fpi,
388 fs_reg dst, fs_reg src);
389 void emit_fp_scalar_math(enum opcode opcode,
390 const struct prog_instruction *fpi,
391 fs_reg dst, fs_reg src);
392
393 void emit_fp_minmax(const struct prog_instruction *fpi,
394 fs_reg dst, fs_reg src0, fs_reg src1);
395
396 void emit_fp_sop(uint32_t conditional_mod,
397 const struct prog_instruction *fpi,
398 fs_reg dst, fs_reg src0, fs_reg src1, fs_reg one);
399
400 void emit_color_write(int target, int index, int first_color_mrf);
401 void emit_fb_writes();
402
403 void emit_shader_time_begin();
404 void emit_shader_time_end();
405 void emit_shader_time_write(enum shader_time_shader_type type,
406 fs_reg value);
407
408 bool try_rewrite_rhs_to_dst(ir_assignment *ir,
409 fs_reg dst,
410 fs_reg src,
411 fs_inst *pre_rhs_inst,
412 fs_inst *last_rhs_inst);
413 void emit_assignment_writes(fs_reg &l, fs_reg &r,
414 const glsl_type *type, bool predicated);
415 void resolve_ud_negate(fs_reg *reg);
416 void resolve_bool_comparison(ir_rvalue *rvalue, fs_reg *reg);
417
418 fs_reg get_timestamp();
419
420 struct brw_reg interp_reg(int location, int channel);
421 void setup_uniform_values(ir_variable *ir);
422 void setup_builtin_uniform_values(ir_variable *ir);
423 int implied_mrf_writes(fs_inst *inst);
424
425 void dump_instruction(backend_instruction *inst);
426
427 struct gl_fragment_program *fp;
428 struct brw_wm_compile *c;
429 unsigned int sanity_param_count;
430
431 int param_size[MAX_UNIFORMS * 4];
432
433 int *virtual_grf_sizes;
434 int virtual_grf_count;
435 int virtual_grf_array_size;
436 int *virtual_grf_def;
437 int *virtual_grf_use;
438 bool live_intervals_valid;
439
440 /* This is the map from UNIFORM hw_reg + reg_offset as generated by
441 * the visitor to the packed uniform number after
442 * remove_dead_constants() that represents the actual uploaded
443 * uniform index.
444 */
445 int *params_remap;
446
447 struct hash_table *variable_ht;
448 fs_reg frag_depth;
449 fs_reg outputs[BRW_MAX_DRAW_BUFFERS];
450 unsigned output_components[BRW_MAX_DRAW_BUFFERS];
451 fs_reg dual_src_output;
452 int first_non_payload_grf;
453 /** Either BRW_MAX_GRF or GEN7_MRF_HACK_START */
454 int max_grf;
455 int urb_setup[VARYING_SLOT_MAX];
456
457 fs_reg *fp_temp_regs;
458 fs_reg *fp_input_regs;
459
460 /** @{ debug annotation info */
461 const char *current_annotation;
462 const void *base_ir;
463 /** @} */
464
465 bool failed;
466 char *fail_msg;
467
468 /* Result of last visit() method. */
469 fs_reg result;
470
471 fs_reg pixel_x;
472 fs_reg pixel_y;
473 fs_reg wpos_w;
474 fs_reg pixel_w;
475 fs_reg delta_x[BRW_WM_BARYCENTRIC_INTERP_MODE_COUNT];
476 fs_reg delta_y[BRW_WM_BARYCENTRIC_INTERP_MODE_COUNT];
477 fs_reg shader_start_time;
478
479 int grf_used;
480
481 const unsigned dispatch_width; /**< 8 or 16 */
482
483 int force_uncompressed_stack;
484 int force_sechalf_stack;
485 };
486
487 /**
488 * The fragment shader code generator.
489 *
490 * Translates FS IR to actual i965 assembly code.
491 */
492 class fs_generator
493 {
494 public:
495 fs_generator(struct brw_context *brw,
496 struct brw_wm_compile *c,
497 struct gl_shader_program *prog,
498 struct gl_fragment_program *fp,
499 bool dual_source_output);
500 ~fs_generator();
501
502 const unsigned *generate_assembly(exec_list *simd8_instructions,
503 exec_list *simd16_instructions,
504 unsigned *assembly_size);
505
506 private:
507 void generate_code(exec_list *instructions);
508 void generate_fb_write(fs_inst *inst);
509 void generate_pixel_xy(struct brw_reg dst, bool is_x);
510 void generate_linterp(fs_inst *inst, struct brw_reg dst,
511 struct brw_reg *src);
512 void generate_tex(fs_inst *inst, struct brw_reg dst, struct brw_reg src);
513 void generate_math1_gen7(fs_inst *inst,
514 struct brw_reg dst,
515 struct brw_reg src);
516 void generate_math2_gen7(fs_inst *inst,
517 struct brw_reg dst,
518 struct brw_reg src0,
519 struct brw_reg src1);
520 void generate_math1_gen6(fs_inst *inst,
521 struct brw_reg dst,
522 struct brw_reg src);
523 void generate_math2_gen6(fs_inst *inst,
524 struct brw_reg dst,
525 struct brw_reg src0,
526 struct brw_reg src1);
527 void generate_math_gen4(fs_inst *inst,
528 struct brw_reg dst,
529 struct brw_reg src);
530 void generate_ddx(fs_inst *inst, struct brw_reg dst, struct brw_reg src);
531 void generate_ddy(fs_inst *inst, struct brw_reg dst, struct brw_reg src,
532 bool negate_value);
533 void generate_spill(fs_inst *inst, struct brw_reg src);
534 void generate_unspill(fs_inst *inst, struct brw_reg dst);
535 void generate_uniform_pull_constant_load(fs_inst *inst, struct brw_reg dst,
536 struct brw_reg index,
537 struct brw_reg offset);
538 void generate_uniform_pull_constant_load_gen7(fs_inst *inst,
539 struct brw_reg dst,
540 struct brw_reg surf_index,
541 struct brw_reg offset);
542 void generate_varying_pull_constant_load(fs_inst *inst, struct brw_reg dst,
543 struct brw_reg index,
544 struct brw_reg offset);
545 void generate_varying_pull_constant_load_gen7(fs_inst *inst,
546 struct brw_reg dst,
547 struct brw_reg index,
548 struct brw_reg offset);
549 void generate_mov_dispatch_to_flags(fs_inst *inst);
550 void generate_set_simd4x2_offset(fs_inst *inst,
551 struct brw_reg dst,
552 struct brw_reg offset);
553 void generate_discard_jump(fs_inst *inst);
554
555 void generate_pack_half_2x16_split(fs_inst *inst,
556 struct brw_reg dst,
557 struct brw_reg x,
558 struct brw_reg y);
559 void generate_unpack_half_2x16_split(fs_inst *inst,
560 struct brw_reg dst,
561 struct brw_reg src);
562
563 void generate_shader_time_add(fs_inst *inst,
564 struct brw_reg payload,
565 struct brw_reg offset,
566 struct brw_reg value);
567
568 void patch_discard_jumps_to_fb_writes();
569
570 struct brw_context *brw;
571 struct intel_context *intel;
572 struct gl_context *ctx;
573
574 struct brw_compile *p;
575 struct brw_wm_compile *c;
576
577 struct gl_shader_program *prog;
578 struct gl_shader *shader;
579 const struct gl_fragment_program *fp;
580
581 unsigned dispatch_width; /**< 8 or 16 */
582
583 exec_list discard_halt_patches;
584 bool dual_source_output;
585 void *mem_ctx;
586 };
587
588 bool brw_do_channel_expressions(struct exec_list *instructions);
589 bool brw_do_vector_splitting(struct exec_list *instructions);
590 bool brw_fs_precompile(struct gl_context *ctx, struct gl_shader_program *prog);