/*
* Copyright © 2014 Broadcom
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice (including the next
* paragraph) shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
* IN THE SOFTWARE.
*/
#ifndef VC4_QIR_H
#define VC4_QIR_H
#include <assert.h>
#include <stdio.h>
#include <stdlib.h>
#include <stdbool.h>
#include <stdint.h>
#include <string.h>
#include "util/macros.h"
#include "glsl/nir/nir.h"
#include "util/simple_list.h"
#include "util/u_math.h"
enum qfile {
QFILE_NULL,
QFILE_TEMP,
QFILE_VARY,
QFILE_UNIF,
QFILE_VPM,
/**
* Stores an immediate value in the index field that can be turned
* into a small immediate field by qpu_encode_small_immediate().
*/
QFILE_SMALL_IMM,
};
struct qreg {
enum qfile file;
uint32_t index;
};
enum qop {
QOP_UNDEF,
QOP_MOV,
QOP_FADD,
QOP_FSUB,
QOP_FMUL,
QOP_MUL24,
QOP_FMIN,
QOP_FMAX,
QOP_FMINABS,
QOP_FMAXABS,
QOP_ADD,
QOP_SUB,
QOP_SHL,
QOP_SHR,
QOP_ASR,
QOP_MIN,
QOP_MAX,
QOP_AND,
QOP_OR,
QOP_XOR,
QOP_NOT,
/* Note: Orderings of these compares must be the same as in
* qpu_defines.h. Selects the src[0] if the ns flag bit is set,
* otherwise 0. */
QOP_SEL_X_0_ZS,
QOP_SEL_X_0_ZC,
QOP_SEL_X_0_NS,
QOP_SEL_X_0_NC,
/* Selects the src[0] if the ns flag bit is set, otherwise src[1]. */
QOP_SEL_X_Y_ZS,
QOP_SEL_X_Y_ZC,
QOP_SEL_X_Y_NS,
QOP_SEL_X_Y_NC,
QOP_FTOI,
QOP_ITOF,
QOP_RCP,
QOP_RSQ,
QOP_EXP2,
QOP_LOG2,
QOP_VW_SETUP,
QOP_VR_SETUP,
QOP_PACK_SCALED,
QOP_PACK_8888_F,
QOP_PACK_8A_F,
QOP_PACK_8B_F,
QOP_PACK_8C_F,
QOP_PACK_8D_F,
QOP_TLB_DISCARD_SETUP,
QOP_TLB_STENCIL_SETUP,
QOP_TLB_Z_WRITE,
QOP_TLB_COLOR_WRITE,
QOP_TLB_COLOR_READ,
QOP_VARY_ADD_C,
QOP_FRAG_X,
QOP_FRAG_Y,
QOP_FRAG_Z,
QOP_FRAG_W,
QOP_FRAG_REV_FLAG,
QOP_UNPACK_8A_F,
QOP_UNPACK_8B_F,
QOP_UNPACK_8C_F,
QOP_UNPACK_8D_F,
QOP_UNPACK_16A_F,
QOP_UNPACK_16B_F,
QOP_UNPACK_8A_I,
QOP_UNPACK_8B_I,
QOP_UNPACK_8C_I,
QOP_UNPACK_8D_I,
QOP_UNPACK_16A_I,
QOP_UNPACK_16B_I,
/** Texture x coordinate parameter write */
QOP_TEX_S,
/** Texture y coordinate parameter write */
QOP_TEX_T,
/** Texture border color parameter or cube map z coordinate write */
QOP_TEX_R,
/** Texture LOD bias parameter write */
QOP_TEX_B,
/**
* Texture-unit 4-byte read with address provided direct in S
* cooordinate.
*
* The first operand is the offset from the start of the UBO, and the
* second is the uniform that has the UBO's base pointer.
*/
QOP_TEX_DIRECT,
/**
* Signal of texture read being necessary and then reading r4 into
* the destination
*/
QOP_TEX_RESULT,
QOP_R4_UNPACK_A,
QOP_R4_UNPACK_B,
QOP_R4_UNPACK_C,
QOP_R4_UNPACK_D
};
struct queued_qpu_inst {
struct simple_node link;
uint64_t inst;
};
struct qinst {
struct simple_node link;
enum qop op;
struct qreg dst;
struct qreg *src;
bool sf;
};
enum qstage {
/**
* Coordinate shader, runs during binning, before the VS, and just
* outputs position.
*/
QSTAGE_COORD,
QSTAGE_VERT,
QSTAGE_FRAG,
};
enum quniform_contents {
/**
* Indicates that a constant 32-bit value is copied from the program's
* uniform contents.
*/
QUNIFORM_CONSTANT,
/**
* Indicates that the program's uniform contents are used as an index
* into the GL uniform storage.
*/
QUNIFORM_UNIFORM,
/** @{
* Scaling factors from clip coordinates to relative to the viewport
* center.
*
* This is used by the coordinate and vertex shaders to produce the
* 32-bit entry consisting of 2 16-bit fields with 12.4 signed fixed
* point offsets from the viewport ccenter.
*/
QUNIFORM_VIEWPORT_X_SCALE,
QUNIFORM_VIEWPORT_Y_SCALE,
/** @} */
QUNIFORM_VIEWPORT_Z_OFFSET,
QUNIFORM_VIEWPORT_Z_SCALE,
QUNIFORM_USER_CLIP_PLANE,
/**
* A reference to a texture config parameter 0 uniform.
*
* This is a uniform implicitly loaded with a QPU_W_TMU* write, which
* defines texture type, miplevels, and such. It will be found as a
* parameter to the first QOP_TEX_[STRB] instruction in a sequence.
*/
QUNIFORM_TEXTURE_CONFIG_P0,
/**
* A reference to a texture config parameter 1 uniform.
*
* This is a uniform implicitly loaded with a QPU_W_TMU* write, which
* defines texture width, height, filters, and wrap modes. It will be
* found as a parameter to the second QOP_TEX_[STRB] instruction in a
* sequence.
*/
QUNIFORM_TEXTURE_CONFIG_P1,
/** A reference to a texture config parameter 2 cubemap stride uniform */
QUNIFORM_TEXTURE_CONFIG_P2,
QUNIFORM_UBO_ADDR,
QUNIFORM_TEXRECT_SCALE_X,
QUNIFORM_TEXRECT_SCALE_Y,
QUNIFORM_TEXTURE_BORDER_COLOR,
QUNIFORM_BLEND_CONST_COLOR,
QUNIFORM_STENCIL,
QUNIFORM_ALPHA_REF,
};
struct vc4_varying_semantic {
uint8_t semantic;
uint8_t index;
uint8_t swizzle;
};
struct vc4_compiler_ubo_range {
/**
* offset in bytes from the start of the ubo where this range is
* uploaded.
*
* Only set once used is set.
*/
uint32_t dst_offset;
/**
* offset in bytes from the start of the gallium uniforms where the
* data comes from.
*/
uint32_t src_offset;
/** size in bytes of this ubo range */
uint32_t size;
/**
* Set if this range is used by the shader for indirect uniforms
* access.
*/
bool used;
};
struct vc4_compile {
struct vc4_context *vc4;
nir_shader *s;
nir_function_impl *impl;
struct exec_list *cf_node_list;
/**
* Mapping from nir_register * or nir_ssa_def * to array of struct
* qreg for the values.
*/
struct hash_table *def_ht;
/* For each temp, the instruction generating its value. */
struct qinst **defs;
uint32_t defs_array_size;
/**
* Inputs to the shader, arranged by TGSI declaration order.
*
* Not all fragment shader QFILE_VARY reads are present in this array.
*/
struct qreg *inputs;
struct qreg *outputs;
uint32_t inputs_array_size;
uint32_t outputs_array_size;
uint32_t uniforms_array_size;
struct vc4_compiler_ubo_range *ubo_ranges;
uint32_t ubo_ranges_array_size;
/** Number of uniform areas declared in ubo_ranges. */
uint32_t num_uniform_ranges;
/** Number of uniform areas used for indirect addressed loads. */
uint32_t num_ubo_ranges;
uint32_t next_ubo_dst_offset;
struct qreg line_x, point_x, point_y;
struct qreg discard;
uint8_t vattr_sizes[8];
/**
* Array of the TGSI semantics of all FS QFILE_VARY reads.
*
* This includes those that aren't part of the VPM varyings, like
* point/line coordinates.
*/
struct vc4_varying_semantic *input_semantics;
uint32_t num_input_semantics;
uint32_t input_semantics_array_size;
/**
* An entry per outputs[] in the VS indicating what the semantic of
* the output is. Used to emit from the VS in the order that the FS
* needs.
*/
struct vc4_varying_semantic *output_semantics;
struct pipe_shader_state *shader_state;
struct vc4_key *key;
struct vc4_fs_key *fs_key;
struct vc4_vs_key *vs_key;
uint32_t *uniform_data;
enum quniform_contents *uniform_contents;
uint32_t uniform_array_size;
uint32_t num_uniforms;
uint32_t num_outputs;
uint32_t num_texture_samples;
uint32_t output_position_index;
uint32_t output_clipvertex_index;
uint32_t output_color_index;
uint32_t output_point_size_index;
struct qreg undef;
enum qstage stage;
uint32_t num_temps;
struct simple_node instructions;
uint32_t immediates[1024];
struct simple_node qpu_inst_list;
uint64_t *qpu_insts;
uint32_t qpu_inst_count;
uint32_t qpu_inst_size;
uint32_t num_inputs;
uint32_t program_id;
uint32_t variant_id;
};
struct vc4_compile *qir_compile_init(void);
void qir_compile_destroy(struct vc4_compile *c);
struct qinst *qir_inst(enum qop op, struct qreg dst,
struct qreg src0, struct qreg src1);
struct qinst *qir_inst4(enum qop op, struct qreg dst,
struct qreg a,
struct qreg b,
struct qreg c,
struct qreg d);
void qir_remove_instruction(struct vc4_compile *c, struct qinst *qinst);
struct qreg qir_uniform(struct vc4_compile *c,
enum quniform_contents contents,
uint32_t data);
void qir_reorder_uniforms(struct vc4_compile *c);
void qir_emit(struct vc4_compile *c, struct qinst *inst);
struct qreg qir_get_temp(struct vc4_compile *c);
int qir_get_op_nsrc(enum qop qop);
bool qir_reg_equals(struct qreg a, struct qreg b);
bool qir_has_side_effects(struct vc4_compile *c, struct qinst *inst);
bool qir_has_side_effect_reads(struct vc4_compile *c, struct qinst *inst);
bool qir_is_multi_instruction(struct qinst *inst);
bool qir_is_tex(struct qinst *inst);
bool qir_depends_on_flags(struct qinst *inst);
bool qir_writes_r4(struct qinst *inst);
bool qir_reads_r4(struct qinst *inst);
bool qir_src_needs_a_file(struct qinst *inst);
struct qreg qir_follow_movs(struct vc4_compile *c, struct qreg reg);
void qir_dump(struct vc4_compile *c);
void qir_dump_inst(struct vc4_compile *c, struct qinst *inst);
const char *qir_get_stage_name(enum qstage stage);
void qir_optimize(struct vc4_compile *c);
bool qir_opt_algebraic(struct vc4_compile *c);
bool qir_opt_constant_folding(struct vc4_compile *c);
bool qir_opt_copy_propagation(struct vc4_compile *c);
bool qir_opt_cse(struct vc4_compile *c);
bool qir_opt_dead_code(struct vc4_compile *c);
bool qir_opt_small_immediates(struct vc4_compile *c);
bool qir_opt_vpm_writes(struct vc4_compile *c);
void qir_lower_uniforms(struct vc4_compile *c);
void qpu_schedule_instructions(struct vc4_compile *c);
void qir_SF(struct vc4_compile *c, struct qreg src);
static inline struct qreg
qir_uniform_ui(struct vc4_compile *c, uint32_t ui)
{
return qir_uniform(c, QUNIFORM_CONSTANT, ui);
}
static inline struct qreg
qir_uniform_f(struct vc4_compile *c, float f)
{
return qir_uniform(c, QUNIFORM_CONSTANT, fui(f));
}
#define QIR_ALU0(name) \
static inline struct qreg \
qir_##name(struct vc4_compile *c) \
{ \
struct qreg t = qir_get_temp(c); \
qir_emit(c, qir_inst(QOP_##name, t, c->undef, c->undef)); \
return t; \
}
#define QIR_ALU1(name) \
static inline struct qreg \
qir_##name(struct vc4_compile *c, struct qreg a) \
{ \
struct qreg t = qir_get_temp(c); \
qir_emit(c, qir_inst(QOP_##name, t, a, c->undef)); \
return t; \
}
#define QIR_ALU2(name) \
static inline struct qreg \
qir_##name(struct vc4_compile *c, struct qreg a, struct qreg b) \
{ \
struct qreg t = qir_get_temp(c); \
qir_emit(c, qir_inst(QOP_##name, t, a, b)); \
return t; \
}
#define QIR_NODST_1(name) \
static inline void \
qir_##name(struct vc4_compile *c, struct qreg a) \
{ \
qir_emit(c, qir_inst(QOP_##name, c->undef, a, c->undef)); \
}
#define QIR_NODST_2(name) \
static inline void \
qir_##name(struct vc4_compile *c, struct qreg a, struct qreg b) \
{ \
qir_emit(c, qir_inst(QOP_##name, c->undef, a, b)); \
}
QIR_ALU1(MOV)
QIR_ALU2(FADD)
QIR_ALU2(FSUB)
QIR_ALU2(FMUL)
QIR_ALU2(MUL24)
QIR_ALU1(SEL_X_0_ZS)
QIR_ALU1(SEL_X_0_ZC)
QIR_ALU1(SEL_X_0_NS)
QIR_ALU1(SEL_X_0_NC)
QIR_ALU2(SEL_X_Y_ZS)
QIR_ALU2(SEL_X_Y_ZC)
QIR_ALU2(SEL_X_Y_NS)
QIR_ALU2(SEL_X_Y_NC)
QIR_ALU2(FMIN)
QIR_ALU2(FMAX)
QIR_ALU2(FMINABS)
QIR_ALU2(FMAXABS)
QIR_ALU1(FTOI)
QIR_ALU1(ITOF)
QIR_ALU2(ADD)
QIR_ALU2(SUB)
QIR_ALU2(SHL)
QIR_ALU2(SHR)
QIR_ALU2(ASR)
QIR_ALU2(MIN)
QIR_ALU2(MAX)
QIR_ALU2(AND)
QIR_ALU2(OR)
QIR_ALU2(XOR)
QIR_ALU1(NOT)
QIR_ALU1(RCP)
QIR_ALU1(RSQ)
QIR_ALU1(EXP2)
QIR_ALU1(LOG2)
QIR_ALU2(PACK_SCALED)
QIR_ALU1(PACK_8888_F)
QIR_ALU2(PACK_8A_F)
QIR_ALU2(PACK_8B_F)
QIR_ALU2(PACK_8C_F)
QIR_ALU2(PACK_8D_F)
QIR_ALU1(VARY_ADD_C)
QIR_NODST_2(TEX_S)
QIR_NODST_2(TEX_T)
QIR_NODST_2(TEX_R)
QIR_NODST_2(TEX_B)
QIR_NODST_2(TEX_DIRECT)
QIR_ALU0(FRAG_X)
QIR_ALU0(FRAG_Y)
QIR_ALU0(FRAG_Z)
QIR_ALU0(FRAG_W)
QIR_ALU0(FRAG_REV_FLAG)
QIR_ALU0(TEX_RESULT)
QIR_ALU0(TLB_COLOR_READ)
QIR_NODST_1(TLB_Z_WRITE)
QIR_NODST_1(TLB_DISCARD_SETUP)
QIR_NODST_1(TLB_STENCIL_SETUP)
static inline struct qreg
qir_R4_UNPACK(struct vc4_compile *c, struct qreg r4, int i)
{
struct qreg t = qir_get_temp(c);
qir_emit(c, qir_inst(QOP_R4_UNPACK_A + i, t, r4, c->undef));
return t;
}
static inline struct qreg
qir_SEL_X_0_COND(struct vc4_compile *c, int i)
{
struct qreg t = qir_get_temp(c);
qir_emit(c, qir_inst(QOP_R4_UNPACK_A + i, t, c->undef, c->undef));
return t;
}
static inline struct qreg
qir_UNPACK_8_F(struct vc4_compile *c, struct qreg src, int i)
{
struct qreg t = qir_get_temp(c);
qir_emit(c, qir_inst(QOP_UNPACK_8A_F + i, t, src, c->undef));
return t;
}
static inline struct qreg
qir_UNPACK_8_I(struct vc4_compile *c, struct qreg src, int i)
{
struct qreg t = qir_get_temp(c);
qir_emit(c, qir_inst(QOP_UNPACK_8A_I + i, t, src, c->undef));
return t;
}
static inline struct qreg
qir_UNPACK_16_F(struct vc4_compile *c, struct qreg src, int i)
{
struct qreg t = qir_get_temp(c);
qir_emit(c, qir_inst(QOP_UNPACK_16A_F + i, t, src, c->undef));
return t;
}
static inline struct qreg
qir_UNPACK_16_I(struct vc4_compile *c, struct qreg src, int i)
{
struct qreg t = qir_get_temp(c);
qir_emit(c, qir_inst(QOP_UNPACK_16A_I + i, t, src, c->undef));
return t;
}
static inline struct qreg
qir_PACK_8_F(struct vc4_compile *c, struct qreg rest, struct qreg val, int chan)
{
struct qreg t = qir_get_temp(c);
qir_emit(c, qir_inst(QOP_PACK_8A_F + chan, t, rest, val));
return t;
}
static inline struct qreg
qir_POW(struct vc4_compile *c, struct qreg x, struct qreg y)
{
return qir_EXP2(c, qir_FMUL(c,
y,
qir_LOG2(c, x)));
}
static inline void
qir_VPM_WRITE(struct vc4_compile *c, struct qreg val)
{
static const struct qreg vpm = { QFILE_VPM, 0 };
qir_emit(c, qir_inst(QOP_MOV, vpm, val, c->undef));
}
#endif /* VC4_QIR_H */