2 * Copyright © 2014 Broadcom
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:
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
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
34 #include "util/macros.h"
35 #include "compiler/nir/nir.h"
36 #include "util/list.h"
37 #include "util/u_math.h"
39 #include "vc4_screen.h"
40 #include "vc4_qpu_defines.h"
42 #include "kernel/vc4_packet.h"
43 #include "pipe/p_state.h"
53 QFILE_TLB_COLOR_WRITE
,
54 QFILE_TLB_COLOR_WRITE_MS
,
56 QFILE_TLB_STENCIL_SETUP
,
58 /* If tex_s is written on its own without preceding t/r/b setup, it's
59 * a direct memory access using the input value, without the sideband
60 * uniform load. We represent these in QIR as a separate write
61 * destination so we can tell if the sideband uniform is present.
70 /* Payload registers that aren't in the physical register file, so we
71 * can just use the corresponding qpu_reg at qpu_emit time.
79 * Stores an immediate value in the index field that will be used
80 * directly by qpu_load_imm().
85 * Stores an immediate value in the index field that can be turned
86 * into a small immediate field by qpu_encode_small_immediate().
97 static inline struct qreg
qir_reg(enum qfile file
, uint32_t index
)
99 return (struct qreg
){file
, index
};
148 * Signal of texture read being necessary and then reading r4 into
154 * Insert the signal for switching threads in a threaded fragment
155 * shader. No value can be live in an accumulator across a thrsw.
157 * At the QPU level, this will have several delay slots before the
158 * switch happens. Those slots are the responsibility of the
163 /* 32-bit immediate loaded to each SIMD channel */
166 /* 32-bit immediate divided into 16 2-bit unsigned int values and
167 * loaded to each corresponding SIMD channel.
170 /* 32-bit immediate divided into 16 2-bit signed int values and
171 * loaded to each corresponding SIMD channel.
177 /* Jumps to block->successor[0] if the qinst->cond (as a
178 * QPU_COND_BRANCH_*) passes, or block->successor[1] if not. Note
179 * that block->successor[1] may be unset if the condition is ALWAYS.
183 /* Emits an ADD from src[0] to src[1], where src[0] must be a
184 * QOP_LOAD_IMM result and src[1] is a QUNIFORM_UNIFORMS_ADDRESS,
185 * required by the kernel as part of its branch validation.
190 struct queued_qpu_inst
{
191 struct list_head link
;
196 struct list_head link
;
202 bool cond_is_exec_mask
;
208 * Coordinate shader, runs during binning, before the VS, and just
216 enum quniform_contents
{
218 * Indicates that a constant 32-bit value is copied from the program's
223 * Indicates that the program's uniform contents are used as an index
224 * into the GL uniform storage.
229 * Scaling factors from clip coordinates to relative to the viewport
232 * This is used by the coordinate and vertex shaders to produce the
233 * 32-bit entry consisting of 2 16-bit fields with 12.4 signed fixed
234 * point offsets from the viewport ccenter.
236 QUNIFORM_VIEWPORT_X_SCALE
,
237 QUNIFORM_VIEWPORT_Y_SCALE
,
240 QUNIFORM_VIEWPORT_Z_OFFSET
,
241 QUNIFORM_VIEWPORT_Z_SCALE
,
243 QUNIFORM_USER_CLIP_PLANE
,
246 * A reference to a texture config parameter 0 uniform.
248 * This is a uniform implicitly loaded with a QPU_W_TMU* write, which
249 * defines texture type, miplevels, and such. It will be found as a
250 * parameter to the first QOP_TEX_[STRB] instruction in a sequence.
252 QUNIFORM_TEXTURE_CONFIG_P0
,
255 * A reference to a texture config parameter 1 uniform.
257 * This is a uniform implicitly loaded with a QPU_W_TMU* write, which
258 * defines texture width, height, filters, and wrap modes. It will be
259 * found as a parameter to the second QOP_TEX_[STRB] instruction in a
262 QUNIFORM_TEXTURE_CONFIG_P1
,
264 /** A reference to a texture config parameter 2 cubemap stride uniform */
265 QUNIFORM_TEXTURE_CONFIG_P2
,
267 QUNIFORM_TEXTURE_FIRST_LEVEL
,
269 QUNIFORM_TEXTURE_MSAA_ADDR
,
273 QUNIFORM_TEXRECT_SCALE_X
,
274 QUNIFORM_TEXRECT_SCALE_Y
,
276 QUNIFORM_TEXTURE_BORDER_COLOR
,
278 QUNIFORM_BLEND_CONST_COLOR_X
,
279 QUNIFORM_BLEND_CONST_COLOR_Y
,
280 QUNIFORM_BLEND_CONST_COLOR_Z
,
281 QUNIFORM_BLEND_CONST_COLOR_W
,
282 QUNIFORM_BLEND_CONST_COLOR_RGBA
,
283 QUNIFORM_BLEND_CONST_COLOR_AAAA
,
288 QUNIFORM_SAMPLE_MASK
,
290 /* Placeholder uniform that will be updated by the kernel when used by
291 * an instruction writing to QPU_W_UNIFORMS_ADDRESS.
293 QUNIFORM_UNIFORMS_ADDRESS
,
296 struct vc4_varying_slot
{
301 struct vc4_compiler_ubo_range
{
303 * offset in bytes from the start of the ubo where this range is
306 * Only set once used is set.
311 * offset in bytes from the start of the gallium uniforms where the
316 /** size in bytes of this ubo range */
320 * Set if this range is used by the shader for indirect uniforms
327 struct vc4_uncompiled_shader
*shader_state
;
329 enum pipe_format format
;
333 unsigned compare_mode
:1;
334 unsigned compare_func
:3;
337 bool force_first_level
:1;
340 uint16_t msaa_width
, msaa_height
;
343 } tex
[VC4_MAX_TEXTURE_SAMPLERS
];
349 enum pipe_format color_format
;
351 bool stencil_enabled
;
352 bool stencil_twoside
;
353 bool stencil_full_writemasks
;
357 bool point_coord_upper_left
;
360 bool sample_coverage
;
361 bool sample_alpha_to_coverage
;
362 bool sample_alpha_to_one
;
363 uint8_t alpha_test_func
;
364 uint8_t logicop_func
;
365 uint32_t point_sprite_mask
;
367 struct pipe_rt_blend_state blend
;
373 const struct vc4_fs_inputs
*fs_inputs
;
374 enum pipe_format attr_formats
[8];
376 bool per_vertex_point_size
;
380 /** A basic block of QIR intructions. */
382 struct list_head link
;
384 struct list_head instructions
;
385 struct list_head qpu_inst_list
;
387 struct set
*predecessors
;
388 struct qblock
*successors
[2];
392 /* Instruction IPs for the first and last instruction of the block.
393 * Set by vc4_qpu_schedule.c.
395 uint32_t start_qpu_ip
;
398 /* Instruction IP for the branch instruction of the block. Set by
399 * vc4_qpu_schedule.c.
401 uint32_t branch_qpu_ip
;
403 /** @{ used by vc4_qir_live_variables.c */
406 BITSET_WORD
*live_in
;
407 BITSET_WORD
*live_out
;
408 int start_ip
, end_ip
;
413 struct vc4_context
*vc4
;
415 nir_function_impl
*impl
;
416 struct exec_list
*cf_node_list
;
419 * Mapping from nir_register * or nir_ssa_def * to array of struct
420 * qreg for the values.
422 struct hash_table
*def_ht
;
424 /* For each temp, the instruction generating its value. */
426 uint32_t defs_array_size
;
429 * Inputs to the shader, arranged by TGSI declaration order.
431 * Not all fragment shader QFILE_VARY reads are present in this array.
434 struct qreg
*outputs
;
435 bool msaa_per_sample_output
;
436 struct qreg color_reads
[VC4_MAX_SAMPLES
];
437 struct qreg sample_colors
[VC4_MAX_SAMPLES
];
438 uint32_t inputs_array_size
;
439 uint32_t outputs_array_size
;
440 uint32_t uniforms_array_size
;
442 struct vc4_compiler_ubo_range
*ubo_ranges
;
443 uint32_t ubo_ranges_array_size
;
444 /** Number of uniform areas declared in ubo_ranges. */
445 uint32_t num_uniform_ranges
;
446 /** Number of uniform areas used for indirect addressed loads. */
447 uint32_t num_ubo_ranges
;
448 uint32_t next_ubo_dst_offset
;
450 /* State for whether we're executing on each channel currently. 0 if
451 * yes, otherwise a block number + 1 that the channel jumped to.
455 struct qreg line_x
, point_x
, point_y
;
456 /** boolean (~0 -> true) if the fragment has been discarded. */
458 struct qreg payload_FRAG_Z
;
459 struct qreg payload_FRAG_W
;
461 uint8_t vattr_sizes
[8];
464 * Array of the VARYING_SLOT_* of all FS QFILE_VARY reads.
466 * This includes those that aren't part of the VPM varyings, like
467 * point/line coordinates.
469 struct vc4_varying_slot
*input_slots
;
470 uint32_t num_input_slots
;
471 uint32_t input_slots_array_size
;
474 * An entry per outputs[] in the VS indicating what the VARYING_SLOT_*
475 * of the output is. Used to emit from the VS in the order that the
478 struct vc4_varying_slot
*output_slots
;
480 struct pipe_shader_state
*shader_state
;
482 struct vc4_fs_key
*fs_key
;
483 struct vc4_vs_key
*vs_key
;
485 /* Live ranges of temps. */
486 int *temp_start
, *temp_end
;
488 uint32_t *uniform_data
;
489 enum quniform_contents
*uniform_contents
;
490 uint32_t uniform_array_size
;
491 uint32_t num_uniforms
;
492 uint32_t num_outputs
;
493 uint32_t num_texture_samples
;
494 uint32_t output_position_index
;
495 uint32_t output_color_index
;
496 uint32_t output_point_size_index
;
497 uint32_t output_sample_mask_index
;
503 struct list_head blocks
;
504 int next_block_index
;
505 struct qblock
*cur_block
;
506 struct qblock
*loop_cont_block
;
507 struct qblock
*loop_break_block
;
509 struct list_head qpu_inst_list
;
511 /* Pre-QPU-scheduled instruction containing the last THRSW */
512 uint64_t *last_thrsw
;
515 uint32_t qpu_inst_count
;
516 uint32_t qpu_inst_size
;
520 * Number of inputs from num_inputs remaining to be queued to the read
523 uint32_t num_inputs_remaining
;
525 /* Number of inputs currently in the read FIFO for the VS/CS */
526 uint32_t num_inputs_in_fifo
;
528 /** Next offset in the VPM to read from in the VS/CS */
529 uint32_t vpm_read_offset
;
534 /* Set to compile program in threaded FS mode, where SIG_THREAD_SWITCH
535 * is used to hide texturing latency at the cost of limiting ourselves
536 * to the bottom half of physical reg space.
540 bool last_thrsw_at_top_level
;
545 /* Special nir_load_input intrinsic index for loading the current TLB
548 #define VC4_NIR_TLB_COLOR_READ_INPUT 2000000000
550 #define VC4_NIR_MS_MASK_OUTPUT 2000000000
552 struct vc4_compile
*qir_compile_init(void);
553 void qir_compile_destroy(struct vc4_compile
*c
);
554 struct qblock
*qir_new_block(struct vc4_compile
*c
);
555 void qir_set_emit_block(struct vc4_compile
*c
, struct qblock
*block
);
556 void qir_link_blocks(struct qblock
*predecessor
, struct qblock
*successor
);
557 struct qblock
*qir_entry_block(struct vc4_compile
*c
);
558 struct qblock
*qir_exit_block(struct vc4_compile
*c
);
559 struct qinst
*qir_inst(enum qop op
, struct qreg dst
,
560 struct qreg src0
, struct qreg src1
);
561 void qir_remove_instruction(struct vc4_compile
*c
, struct qinst
*qinst
);
562 struct qreg
qir_uniform(struct vc4_compile
*c
,
563 enum quniform_contents contents
,
565 void qir_schedule_instructions(struct vc4_compile
*c
);
566 void qir_reorder_uniforms(struct vc4_compile
*c
);
567 void qir_emit_uniform_stream_resets(struct vc4_compile
*c
);
569 struct qreg
qir_emit_def(struct vc4_compile
*c
, struct qinst
*inst
);
570 struct qinst
*qir_emit_nondef(struct vc4_compile
*c
, struct qinst
*inst
);
572 struct qreg
qir_get_temp(struct vc4_compile
*c
);
573 void qir_calculate_live_intervals(struct vc4_compile
*c
);
574 int qir_get_nsrc(struct qinst
*inst
);
575 int qir_get_non_sideband_nsrc(struct qinst
*inst
);
576 int qir_get_tex_uniform_src(struct qinst
*inst
);
577 bool qir_reg_equals(struct qreg a
, struct qreg b
);
578 bool qir_has_side_effects(struct vc4_compile
*c
, struct qinst
*inst
);
579 bool qir_has_side_effect_reads(struct vc4_compile
*c
, struct qinst
*inst
);
580 bool qir_is_mul(struct qinst
*inst
);
581 bool qir_is_raw_mov(struct qinst
*inst
);
582 bool qir_is_tex(struct qinst
*inst
);
583 bool qir_has_implicit_tex_uniform(struct qinst
*inst
);
584 bool qir_is_float_input(struct qinst
*inst
);
585 bool qir_depends_on_flags(struct qinst
*inst
);
586 bool qir_writes_r4(struct qinst
*inst
);
587 struct qreg
qir_follow_movs(struct vc4_compile
*c
, struct qreg reg
);
588 uint8_t qir_channels_written(struct qinst
*inst
);
590 void qir_dump(struct vc4_compile
*c
);
591 void qir_dump_inst(struct vc4_compile
*c
, struct qinst
*inst
);
592 const char *qir_get_stage_name(enum qstage stage
);
594 void qir_validate(struct vc4_compile
*c
);
596 void qir_optimize(struct vc4_compile
*c
);
597 bool qir_opt_algebraic(struct vc4_compile
*c
);
598 bool qir_opt_coalesce_ff_writes(struct vc4_compile
*c
);
599 bool qir_opt_constant_folding(struct vc4_compile
*c
);
600 bool qir_opt_copy_propagation(struct vc4_compile
*c
);
601 bool qir_opt_dead_code(struct vc4_compile
*c
);
602 bool qir_opt_peephole_sf(struct vc4_compile
*c
);
603 bool qir_opt_small_immediates(struct vc4_compile
*c
);
604 bool qir_opt_vpm(struct vc4_compile
*c
);
605 void vc4_nir_lower_blend(nir_shader
*s
, struct vc4_compile
*c
);
606 void vc4_nir_lower_io(nir_shader
*s
, struct vc4_compile
*c
);
607 nir_ssa_def
*vc4_nir_get_swizzled_channel(struct nir_builder
*b
,
608 nir_ssa_def
**srcs
, int swiz
);
609 void vc4_nir_lower_txf_ms(nir_shader
*s
, struct vc4_compile
*c
);
610 void qir_lower_uniforms(struct vc4_compile
*c
);
612 uint32_t qpu_schedule_instructions(struct vc4_compile
*c
);
614 void qir_SF(struct vc4_compile
*c
, struct qreg src
);
616 static inline struct qreg
617 qir_uniform_ui(struct vc4_compile
*c
, uint32_t ui
)
619 return qir_uniform(c
, QUNIFORM_CONSTANT
, ui
);
622 static inline struct qreg
623 qir_uniform_f(struct vc4_compile
*c
, float f
)
625 return qir_uniform(c
, QUNIFORM_CONSTANT
, fui(f
));
628 #define QIR_ALU0(name) \
629 static inline struct qreg \
630 qir_##name(struct vc4_compile *c) \
632 return qir_emit_def(c, qir_inst(QOP_##name, c->undef, \
633 c->undef, c->undef)); \
635 static inline struct qinst * \
636 qir_##name##_dest(struct vc4_compile *c, struct qreg dest) \
638 return qir_emit_nondef(c, qir_inst(QOP_##name, dest, \
639 c->undef, c->undef)); \
642 #define QIR_ALU1(name) \
643 static inline struct qreg \
644 qir_##name(struct vc4_compile *c, struct qreg a) \
646 return qir_emit_def(c, qir_inst(QOP_##name, c->undef, \
649 static inline struct qinst * \
650 qir_##name##_dest(struct vc4_compile *c, struct qreg dest, \
653 return qir_emit_nondef(c, qir_inst(QOP_##name, dest, a, \
657 #define QIR_ALU2(name) \
658 static inline struct qreg \
659 qir_##name(struct vc4_compile *c, struct qreg a, struct qreg b) \
661 return qir_emit_def(c, qir_inst(QOP_##name, c->undef, a, b)); \
663 static inline struct qinst * \
664 qir_##name##_dest(struct vc4_compile *c, struct qreg dest, \
665 struct qreg a, struct qreg b) \
667 return qir_emit_nondef(c, qir_inst(QOP_##name, dest, a, b)); \
670 #define QIR_NODST_1(name) \
671 static inline struct qinst * \
672 qir_##name(struct vc4_compile *c, struct qreg a) \
674 return qir_emit_nondef(c, qir_inst(QOP_##name, c->undef, \
678 #define QIR_NODST_2(name) \
679 static inline struct qinst * \
680 qir_##name(struct vc4_compile *c, struct qreg a, struct qreg b) \
682 return qir_emit_nondef(c, qir_inst(QOP_##name, c->undef, \
686 #define QIR_PAYLOAD(name) \
687 static inline struct qreg \
688 qir_##name(struct vc4_compile *c) \
690 struct qreg *payload = &c->payload_##name; \
691 if (payload->file != QFILE_NULL) \
693 *payload = qir_get_temp(c); \
694 struct qinst *inst = qir_inst(QOP_##name, *payload, \
695 c->undef, c->undef); \
696 struct qblock *entry = qir_entry_block(c); \
697 list_add(&inst->link, &entry->instructions); \
698 c->defs[payload->index] = inst; \
741 QIR_ALU0(TLB_COLOR_READ
)
744 static inline struct qreg
745 qir_SEL(struct vc4_compile
*c
, uint8_t cond
, struct qreg src0
, struct qreg src1
)
747 struct qreg t
= qir_get_temp(c
);
748 qir_MOV_dest(c
, t
, src1
);
749 qir_MOV_dest(c
, t
, src0
)->cond
= cond
;
753 static inline struct qreg
754 qir_UNPACK_8_F(struct vc4_compile
*c
, struct qreg src
, int i
)
756 struct qreg t
= qir_FMOV(c
, src
);
757 c
->defs
[t
.index
]->src
[0].pack
= QPU_UNPACK_8A
+ i
;
761 static inline struct qreg
762 qir_UNPACK_8_I(struct vc4_compile
*c
, struct qreg src
, int i
)
764 struct qreg t
= qir_MOV(c
, src
);
765 c
->defs
[t
.index
]->src
[0].pack
= QPU_UNPACK_8A
+ i
;
769 static inline struct qreg
770 qir_UNPACK_16_F(struct vc4_compile
*c
, struct qreg src
, int i
)
772 struct qreg t
= qir_FMOV(c
, src
);
773 c
->defs
[t
.index
]->src
[0].pack
= QPU_UNPACK_16A
+ i
;
777 static inline struct qreg
778 qir_UNPACK_16_I(struct vc4_compile
*c
, struct qreg src
, int i
)
780 struct qreg t
= qir_MOV(c
, src
);
781 c
->defs
[t
.index
]->src
[0].pack
= QPU_UNPACK_16A
+ i
;
786 qir_PACK_8_F(struct vc4_compile
*c
, struct qreg dest
, struct qreg val
, int chan
)
789 dest
.pack
= QPU_PACK_MUL_8A
+ chan
;
790 qir_emit_nondef(c
, qir_inst(QOP_MMOV
, dest
, val
, c
->undef
));
793 static inline struct qreg
794 qir_PACK_8888_F(struct vc4_compile
*c
, struct qreg val
)
796 struct qreg dest
= qir_MMOV(c
, val
);
797 c
->defs
[dest
.index
]->dst
.pack
= QPU_PACK_MUL_8888
;
801 static inline struct qreg
802 qir_POW(struct vc4_compile
*c
, struct qreg x
, struct qreg y
)
804 return qir_EXP2(c
, qir_FMUL(c
,
810 qir_VPM_WRITE(struct vc4_compile
*c
, struct qreg val
)
812 qir_MOV_dest(c
, qir_reg(QFILE_VPM
, 0), val
);
815 static inline struct qreg
816 qir_LOAD_IMM(struct vc4_compile
*c
, uint32_t val
)
818 return qir_emit_def(c
, qir_inst(QOP_LOAD_IMM
, c
->undef
,
819 qir_reg(QFILE_LOAD_IMM
, val
), c
->undef
));
822 static inline struct qreg
823 qir_LOAD_IMM_U2(struct vc4_compile
*c
, uint32_t val
)
825 return qir_emit_def(c
, qir_inst(QOP_LOAD_IMM_U2
, c
->undef
,
826 qir_reg(QFILE_LOAD_IMM
, val
),
830 static inline struct qreg
831 qir_LOAD_IMM_I2(struct vc4_compile
*c
, uint32_t val
)
833 return qir_emit_def(c
, qir_inst(QOP_LOAD_IMM_I2
, c
->undef
,
834 qir_reg(QFILE_LOAD_IMM
, val
),
838 /** Shifts the multiply output to the right by rot channels */
839 static inline struct qreg
840 qir_ROT_MUL(struct vc4_compile
*c
, struct qreg val
, uint32_t rot
)
842 return qir_emit_def(c
, qir_inst(QOP_ROT_MUL
, c
->undef
,
844 qir_reg(QFILE_LOAD_IMM
,
845 QPU_SMALL_IMM_MUL_ROT
+ rot
)));
848 static inline struct qinst
*
849 qir_MOV_cond(struct vc4_compile
*c
, uint8_t cond
,
850 struct qreg dest
, struct qreg src
)
852 struct qinst
*mov
= qir_MOV_dest(c
, dest
, src
);
857 static inline struct qinst
*
858 qir_BRANCH(struct vc4_compile
*c
, uint8_t cond
)
860 struct qinst
*inst
= qir_inst(QOP_BRANCH
, c
->undef
, c
->undef
, c
->undef
);
862 qir_emit_nondef(c
, inst
);
866 #define qir_for_each_block(block, c) \
867 list_for_each_entry(struct qblock, block, &c->blocks, link)
869 #define qir_for_each_block_rev(block, c) \
870 list_for_each_entry_rev(struct qblock, block, &c->blocks, link)
872 /* Loop over the non-NULL members of the successors array. */
873 #define qir_for_each_successor(succ, block) \
874 for (struct qblock *succ = block->successors[0]; \
876 succ = (succ == block->successors[1] ? NULL : \
877 block->successors[1]))
879 #define qir_for_each_inst(inst, block) \
880 list_for_each_entry(struct qinst, inst, &block->instructions, link)
882 #define qir_for_each_inst_rev(inst, block) \
883 list_for_each_entry_rev(struct qinst, inst, &block->instructions, link)
885 #define qir_for_each_inst_safe(inst, block) \
886 list_for_each_entry_safe(struct qinst, inst, &block->instructions, link)
888 #define qir_for_each_inst_inorder(inst, c) \
889 qir_for_each_block(_block, c) \
890 qir_for_each_inst_safe(inst, _block)
892 #endif /* VC4_QIR_H */