2 * Copyright © 2014 Connor Abbott
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
24 * Connor Abbott (cwabbott0@gmail.com)
30 #include "util/hash_table.h"
31 #include "compiler/glsl/list.h"
32 #include "GL/gl.h" /* GLenum */
33 #include "util/list.h"
34 #include "util/ralloc.h"
36 #include "util/bitset.h"
37 #include "compiler/nir_types.h"
38 #include "compiler/shader_enums.h"
41 #include "nir_opcodes.h"
48 struct gl_shader_program
;
51 #define NIR_TRUE (~0u)
53 /** Defines a cast function
55 * This macro defines a cast function from in_type to out_type where
56 * out_type is some structure type that contains a field of type out_type.
58 * Note that you have to be a bit careful as the generated cast function
61 #define NIR_DEFINE_CAST(name, in_type, out_type, field) \
62 static inline out_type * \
63 name(const in_type *parent) \
65 return exec_node_data(out_type, parent, field); \
74 * Description of built-in state associated with a uniform
76 * \sa nir_variable::state_slots
90 nir_var_shader_storage
,
97 * Data stored in an nir_constant
99 union nir_constant_data
{
107 typedef struct nir_constant
{
109 * Value of the constant.
111 * The field used to back the values supplied by the constant is determined
112 * by the type associated with the \c nir_variable. Constants may be
113 * scalars, vectors, or matrices.
115 union nir_constant_data value
;
117 /* we could get this from the var->type but makes clone *much* easier to
118 * not have to care about the type.
120 unsigned num_elements
;
122 /* Array elements / Structure Fields */
123 struct nir_constant
**elements
;
127 * \brief Layout qualifiers for gl_FragDepth.
129 * The AMD/ARB_conservative_depth extensions allow gl_FragDepth to be redeclared
130 * with a layout qualifier.
133 nir_depth_layout_none
, /**< No depth layout is specified. */
134 nir_depth_layout_any
,
135 nir_depth_layout_greater
,
136 nir_depth_layout_less
,
137 nir_depth_layout_unchanged
141 * Either a uniform, global variable, shader input, or shader output. Based on
142 * ir_variable - it should be easy to translate between the two.
145 typedef struct nir_variable
{
146 struct exec_node node
;
149 * Declared type of the variable
151 const struct glsl_type
*type
;
154 * Declared name of the variable
158 struct nir_variable_data
{
161 * Is the variable read-only?
163 * This is set for variables declared as \c const, shader inputs,
166 unsigned read_only
:1;
170 unsigned invariant
:1;
173 * Storage class of the variable.
175 * \sa nir_variable_mode
177 nir_variable_mode mode
:5;
180 * Interpolation mode for shader inputs / outputs
182 * \sa glsl_interp_qualifier
184 unsigned interpolation
:2;
187 * \name ARB_fragment_coord_conventions
190 unsigned origin_upper_left
:1;
191 unsigned pixel_center_integer
:1;
195 * Was the location explicitly set in the shader?
197 * If the location is explicitly set in the shader, it \b cannot be changed
198 * by the linker or by the API (e.g., calls to \c glBindAttribLocation have
201 unsigned explicit_location
:1;
202 unsigned explicit_index
:1;
205 * Was an initial binding explicitly set in the shader?
207 * If so, constant_initializer contains an integer nir_constant
208 * representing the initial binding point.
210 unsigned explicit_binding
:1;
213 * Does this variable have an initializer?
215 * This is used by the linker to cross-validiate initializers of global
218 unsigned has_initializer
:1;
221 * If non-zero, then this variable may be packed along with other variables
222 * into a single varying slot, so this offset should be applied when
223 * accessing components. For example, an offset of 1 means that the x
224 * component of this variable is actually stored in component y of the
225 * location specified by \c location.
227 unsigned location_frac
:2;
230 * \brief Layout qualifier for gl_FragDepth.
232 * This is not equal to \c ir_depth_layout_none if and only if this
233 * variable is \c gl_FragDepth and a layout qualifier is specified.
235 nir_depth_layout depth_layout
;
238 * Storage location of the base of this variable
240 * The precise meaning of this field depends on the nature of the variable.
242 * - Vertex shader input: one of the values from \c gl_vert_attrib.
243 * - Vertex shader output: one of the values from \c gl_varying_slot.
244 * - Geometry shader input: one of the values from \c gl_varying_slot.
245 * - Geometry shader output: one of the values from \c gl_varying_slot.
246 * - Fragment shader input: one of the values from \c gl_varying_slot.
247 * - Fragment shader output: one of the values from \c gl_frag_result.
248 * - Uniforms: Per-stage uniform slot number for default uniform block.
249 * - Uniforms: Index within the uniform block definition for UBO members.
250 * - Non-UBO Uniforms: uniform slot number.
251 * - Other: This field is not currently used.
253 * If the variable is a uniform, shader input, or shader output, and the
254 * slot has not been assigned, the value will be -1.
259 * The actual location of the variable in the IR. Only valid for inputs
262 unsigned int driver_location
;
265 * output index for dual source blending.
270 * Initial binding point for a sampler or UBO.
272 * For array types, this represents the binding point for the first element.
277 * Location an atomic counter is stored at.
282 * ARB_shader_image_load_store qualifiers.
285 bool read_only
; /**< "readonly" qualifier. */
286 bool write_only
; /**< "writeonly" qualifier. */
291 /** Image internal format if specified explicitly, otherwise GL_NONE. */
296 * Highest element accessed with a constant expression array index
298 * Not used for non-array variables.
300 unsigned max_array_access
;
305 * Built-in state that backs this uniform
307 * Once set at variable creation, \c state_slots must remain invariant.
308 * This is because, ideally, this array would be shared by all clones of
309 * this variable in the IR tree. In other words, we'd really like for it
310 * to be a fly-weight.
312 * If the variable is not a uniform, \c num_state_slots will be zero and
313 * \c state_slots will be \c NULL.
316 unsigned num_state_slots
; /**< Number of state slots used */
317 nir_state_slot
*state_slots
; /**< State descriptors. */
321 * Constant expression assigned in the initializer of the variable
323 nir_constant
*constant_initializer
;
326 * For variables that are in an interface block or are an instance of an
327 * interface block, this is the \c GLSL_TYPE_INTERFACE type for that block.
329 * \sa ir_variable::location
331 const struct glsl_type
*interface_type
;
334 #define nir_foreach_variable(var, var_list) \
335 foreach_list_typed(nir_variable, var, node, var_list)
338 nir_variable_is_global(const nir_variable
*var
)
340 return var
->data
.mode
!= nir_var_local
&& var
->data
.mode
!= nir_var_param
;
343 typedef struct nir_register
{
344 struct exec_node node
;
346 unsigned num_components
; /** < number of vector components */
347 unsigned num_array_elems
; /** < size of array (0 for no array) */
349 /* The bit-size of each channel; must be one of 8, 16, 32, or 64 */
352 /** generic register index. */
355 /** only for debug purposes, can be NULL */
358 /** whether this register is local (per-function) or global (per-shader) */
362 * If this flag is set to true, then accessing channels >= num_components
363 * is well-defined, and simply spills over to the next array element. This
364 * is useful for backends that can do per-component accessing, in
365 * particular scalar backends. By setting this flag and making
366 * num_components equal to 1, structures can be packed tightly into
367 * registers and then registers can be accessed per-component to get to
368 * each structure member, even if it crosses vec4 boundaries.
372 /** set of nir_src's where this register is used (read from) */
373 struct list_head uses
;
375 /** set of nir_dest's where this register is defined (written to) */
376 struct list_head defs
;
378 /** set of nir_if's where this register is used as a condition */
379 struct list_head if_uses
;
386 nir_instr_type_intrinsic
,
387 nir_instr_type_load_const
,
389 nir_instr_type_ssa_undef
,
391 nir_instr_type_parallel_copy
,
394 typedef struct nir_instr
{
395 struct exec_node node
;
397 struct nir_block
*block
;
399 /** generic instruction index. */
402 /* A temporary for optimization and analysis passes to use for storing
403 * flags. For instance, DCE uses this to store the "dead/live" info.
408 static inline nir_instr
*
409 nir_instr_next(nir_instr
*instr
)
411 struct exec_node
*next
= exec_node_get_next(&instr
->node
);
412 if (exec_node_is_tail_sentinel(next
))
415 return exec_node_data(nir_instr
, next
, node
);
418 static inline nir_instr
*
419 nir_instr_prev(nir_instr
*instr
)
421 struct exec_node
*prev
= exec_node_get_prev(&instr
->node
);
422 if (exec_node_is_head_sentinel(prev
))
425 return exec_node_data(nir_instr
, prev
, node
);
429 nir_instr_is_first(nir_instr
*instr
)
431 return exec_node_is_head_sentinel(exec_node_get_prev(&instr
->node
));
435 nir_instr_is_last(nir_instr
*instr
)
437 return exec_node_is_tail_sentinel(exec_node_get_next(&instr
->node
));
440 typedef struct nir_ssa_def
{
441 /** for debugging only, can be NULL */
444 /** generic SSA definition index. */
447 /** Index into the live_in and live_out bitfields */
450 nir_instr
*parent_instr
;
452 /** set of nir_instr's where this register is used (read from) */
453 struct list_head uses
;
455 /** set of nir_if's where this register is used as a condition */
456 struct list_head if_uses
;
458 uint8_t num_components
;
460 /* The bit-size of each channel; must be one of 8, 16, 32, or 64 */
468 struct nir_src
*indirect
; /** < NULL for no indirect offset */
469 unsigned base_offset
;
471 /* TODO use-def chain goes here */
475 nir_instr
*parent_instr
;
476 struct list_head def_link
;
479 struct nir_src
*indirect
; /** < NULL for no indirect offset */
480 unsigned base_offset
;
482 /* TODO def-use chain goes here */
487 typedef struct nir_src
{
489 nir_instr
*parent_instr
;
490 struct nir_if
*parent_if
;
493 struct list_head use_link
;
503 #define NIR_SRC_INIT (nir_src) { { NULL } }
505 #define nir_foreach_use(reg_or_ssa_def, src) \
506 list_for_each_entry(nir_src, src, &(reg_or_ssa_def)->uses, use_link)
508 #define nir_foreach_use_safe(reg_or_ssa_def, src) \
509 list_for_each_entry_safe(nir_src, src, &(reg_or_ssa_def)->uses, use_link)
511 #define nir_foreach_if_use(reg_or_ssa_def, src) \
512 list_for_each_entry(nir_src, src, &(reg_or_ssa_def)->if_uses, use_link)
514 #define nir_foreach_if_use_safe(reg_or_ssa_def, src) \
515 list_for_each_entry_safe(nir_src, src, &(reg_or_ssa_def)->if_uses, use_link)
526 #define NIR_DEST_INIT (nir_dest) { { { NULL } } }
528 #define nir_foreach_def(reg, dest) \
529 list_for_each_entry(nir_dest, dest, &(reg)->defs, reg.def_link)
531 #define nir_foreach_def_safe(reg, dest) \
532 list_for_each_entry_safe(nir_dest, dest, &(reg)->defs, reg.def_link)
534 static inline nir_src
535 nir_src_for_ssa(nir_ssa_def
*def
)
537 nir_src src
= NIR_SRC_INIT
;
545 static inline nir_src
546 nir_src_for_reg(nir_register
*reg
)
548 nir_src src
= NIR_SRC_INIT
;
552 src
.reg
.indirect
= NULL
;
553 src
.reg
.base_offset
= 0;
558 static inline nir_dest
559 nir_dest_for_reg(nir_register
*reg
)
561 nir_dest dest
= NIR_DEST_INIT
;
568 static inline unsigned
569 nir_src_bit_size(nir_src src
)
571 return src
.is_ssa
? src
.ssa
->bit_size
: src
.reg
.reg
->bit_size
;
574 static inline unsigned
575 nir_dest_bit_size(nir_dest dest
)
577 return dest
.is_ssa
? dest
.ssa
.bit_size
: dest
.reg
.reg
->bit_size
;
580 void nir_src_copy(nir_src
*dest
, const nir_src
*src
, void *instr_or_if
);
581 void nir_dest_copy(nir_dest
*dest
, const nir_dest
*src
, nir_instr
*instr
);
587 * \name input modifiers
591 * For inputs interpreted as floating point, flips the sign bit. For
592 * inputs interpreted as integers, performs the two's complement negation.
597 * Clears the sign bit for floating point values, and computes the integer
598 * absolute value for integers. Note that the negate modifier acts after
599 * the absolute value modifier, therefore if both are set then all inputs
600 * will become negative.
606 * For each input component, says which component of the register it is
607 * chosen from. Note that which elements of the swizzle are used and which
608 * are ignored are based on the write mask for most opcodes - for example,
609 * a statement like "foo.xzw = bar.zyx" would have a writemask of 1101b and
610 * a swizzle of {2, x, 1, 0} where x means "don't care."
619 * \name saturate output modifier
621 * Only valid for opcodes that output floating-point numbers. Clamps the
622 * output to between 0.0 and 1.0 inclusive.
627 unsigned write_mask
: 4; /* ignored if dest.is_ssa is true */
631 nir_type_invalid
= 0, /* Not a valid type */
636 nir_type_bool32
= 32 | nir_type_bool
,
637 nir_type_int8
= 8 | nir_type_int
,
638 nir_type_int16
= 16 | nir_type_int
,
639 nir_type_int32
= 32 | nir_type_int
,
640 nir_type_int64
= 64 | nir_type_int
,
641 nir_type_uint8
= 8 | nir_type_uint
,
642 nir_type_uint16
= 16 | nir_type_uint
,
643 nir_type_uint32
= 32 | nir_type_uint
,
644 nir_type_uint64
= 64 | nir_type_uint
,
645 nir_type_float16
= 16 | nir_type_float
,
646 nir_type_float32
= 32 | nir_type_float
,
647 nir_type_float64
= 64 | nir_type_float
,
650 #define NIR_ALU_TYPE_SIZE_MASK 0xfffffff8
651 #define NIR_ALU_TYPE_BASE_TYPE_MASK 0x00000007
653 static inline unsigned
654 nir_alu_type_get_type_size(nir_alu_type type
)
656 return type
& NIR_ALU_TYPE_SIZE_MASK
;
659 static inline unsigned
660 nir_alu_type_get_base_type(nir_alu_type type
)
662 return type
& NIR_ALU_TYPE_BASE_TYPE_MASK
;
666 NIR_OP_IS_COMMUTATIVE
= (1 << 0),
667 NIR_OP_IS_ASSOCIATIVE
= (1 << 1),
668 } nir_op_algebraic_property
;
676 * The number of components in the output
678 * If non-zero, this is the size of the output and input sizes are
679 * explicitly given; swizzle and writemask are still in effect, but if
680 * the output component is masked out, then the input component may
683 * If zero, the opcode acts in the standard, per-component manner; the
684 * operation is performed on each component (except the ones that are
685 * masked out) with the input being taken from the input swizzle for
688 * The size of some of the inputs may be given (i.e. non-zero) even
689 * though output_size is zero; in that case, the inputs with a zero
690 * size act per-component, while the inputs with non-zero size don't.
692 unsigned output_size
;
695 * The type of vector that the instruction outputs. Note that the
696 * staurate modifier is only allowed on outputs with the float type.
699 nir_alu_type output_type
;
702 * The number of components in each input
704 unsigned input_sizes
[4];
707 * The type of vector that each input takes. Note that negate and
708 * absolute value are only allowed on inputs with int or float type and
709 * behave differently on the two.
711 nir_alu_type input_types
[4];
713 nir_op_algebraic_property algebraic_properties
;
716 extern const nir_op_info nir_op_infos
[nir_num_opcodes
];
718 typedef struct nir_alu_instr
{
722 /** Indicates that this ALU instruction generates an exact value
724 * This is kind of a mixture of GLSL "precise" and "invariant" and not
725 * really equivalent to either. This indicates that the value generated by
726 * this operation is high-precision and any code transformations that touch
727 * it must ensure that the resulting value is bit-for-bit identical to the
736 void nir_alu_src_copy(nir_alu_src
*dest
, const nir_alu_src
*src
,
737 nir_alu_instr
*instr
);
738 void nir_alu_dest_copy(nir_alu_dest
*dest
, const nir_alu_dest
*src
,
739 nir_alu_instr
*instr
);
741 /* is this source channel used? */
743 nir_alu_instr_channel_used(nir_alu_instr
*instr
, unsigned src
, unsigned channel
)
745 if (nir_op_infos
[instr
->op
].input_sizes
[src
] > 0)
746 return channel
< nir_op_infos
[instr
->op
].input_sizes
[src
];
748 return (instr
->dest
.write_mask
>> channel
) & 1;
752 * For instructions whose destinations are SSA, get the number of channels
755 static inline unsigned
756 nir_ssa_alu_instr_src_components(const nir_alu_instr
*instr
, unsigned src
)
758 assert(instr
->dest
.dest
.is_ssa
);
760 if (nir_op_infos
[instr
->op
].input_sizes
[src
] > 0)
761 return nir_op_infos
[instr
->op
].input_sizes
[src
];
763 return instr
->dest
.dest
.ssa
.num_components
;
768 nir_deref_type_array
,
769 nir_deref_type_struct
772 typedef struct nir_deref
{
773 nir_deref_type deref_type
;
774 struct nir_deref
*child
;
775 const struct glsl_type
*type
;
784 /* This enum describes how the array is referenced. If the deref is
785 * direct then the base_offset is used. If the deref is indirect then then
786 * offset is given by base_offset + indirect. If the deref is a wildcard
787 * then the deref refers to all of the elements of the array at the same
788 * time. Wildcard dereferences are only ever allowed in copy_var
789 * intrinsics and the source and destination derefs must have matching
793 nir_deref_array_type_direct
,
794 nir_deref_array_type_indirect
,
795 nir_deref_array_type_wildcard
,
796 } nir_deref_array_type
;
801 nir_deref_array_type deref_array_type
;
802 unsigned base_offset
;
812 NIR_DEFINE_CAST(nir_deref_as_var
, nir_deref
, nir_deref_var
, deref
)
813 NIR_DEFINE_CAST(nir_deref_as_array
, nir_deref
, nir_deref_array
, deref
)
814 NIR_DEFINE_CAST(nir_deref_as_struct
, nir_deref
, nir_deref_struct
, deref
)
816 /* Returns the last deref in the chain. */
817 static inline nir_deref
*
818 nir_deref_tail(nir_deref
*deref
)
821 deref
= deref
->child
;
829 nir_deref_var
**params
;
830 nir_deref_var
*return_deref
;
832 struct nir_function
*callee
;
835 #define INTRINSIC(name, num_srcs, src_components, has_dest, dest_components, \
836 num_variables, num_indices, idx0, idx1, idx2, flags) \
837 nir_intrinsic_##name,
839 #define LAST_INTRINSIC(name) nir_last_intrinsic = nir_intrinsic_##name,
842 #include "nir_intrinsics.h"
843 nir_num_intrinsics
= nir_last_intrinsic
+ 1
847 #undef LAST_INTRINSIC
849 #define NIR_INTRINSIC_MAX_CONST_INDEX 3
851 /** Represents an intrinsic
853 * An intrinsic is an instruction type for handling things that are
854 * more-or-less regular operations but don't just consume and produce SSA
855 * values like ALU operations do. Intrinsics are not for things that have
856 * special semantic meaning such as phi nodes and parallel copies.
857 * Examples of intrinsics include variable load/store operations, system
858 * value loads, and the like. Even though texturing more-or-less falls
859 * under this category, texturing is its own instruction type because
860 * trying to represent texturing with intrinsics would lead to a
861 * combinatorial explosion of intrinsic opcodes.
863 * By having a single instruction type for handling a lot of different
864 * cases, optimization passes can look for intrinsics and, for the most
865 * part, completely ignore them. Each intrinsic type also has a few
866 * possible flags that govern whether or not they can be reordered or
867 * eliminated. That way passes like dead code elimination can still work
868 * on intrisics without understanding the meaning of each.
870 * Each intrinsic has some number of constant indices, some number of
871 * variables, and some number of sources. What these sources, variables,
872 * and indices mean depends on the intrinsic and is documented with the
873 * intrinsic declaration in nir_intrinsics.h. Intrinsics and texture
874 * instructions are the only types of instruction that can operate on
880 nir_intrinsic_op intrinsic
;
884 /** number of components if this is a vectorized intrinsic
886 * Similarly to ALU operations, some intrinsics are vectorized.
887 * An intrinsic is vectorized if nir_intrinsic_infos.dest_components == 0.
888 * For vectorized intrinsics, the num_components field specifies the
889 * number of destination components and the number of source components
890 * for all sources with nir_intrinsic_infos.src_components[i] == 0.
892 uint8_t num_components
;
894 int const_index
[NIR_INTRINSIC_MAX_CONST_INDEX
];
896 nir_deref_var
*variables
[2];
899 } nir_intrinsic_instr
;
902 * \name NIR intrinsics semantic flags
904 * information about what the compiler can do with the intrinsics.
906 * \sa nir_intrinsic_info::flags
910 * whether the intrinsic can be safely eliminated if none of its output
911 * value is not being used.
913 NIR_INTRINSIC_CAN_ELIMINATE
= (1 << 0),
916 * Whether the intrinsic can be reordered with respect to any other
917 * intrinsic, i.e. whether the only reordering dependencies of the
918 * intrinsic are due to the register reads/writes.
920 NIR_INTRINSIC_CAN_REORDER
= (1 << 1),
921 } nir_intrinsic_semantic_flag
;
924 * \name NIR intrinsics const-index flag
926 * Indicates the usage of a const_index slot.
928 * \sa nir_intrinsic_info::index_map
932 * Generally instructions that take a offset src argument, can encode
933 * a constant 'base' value which is added to the offset.
935 NIR_INTRINSIC_BASE
= 1,
938 * For store instructions, a writemask for the store.
940 NIR_INTRINSIC_WRMASK
= 2,
943 * The stream-id for GS emit_vertex/end_primitive intrinsics.
945 NIR_INTRINSIC_STREAM_ID
= 3,
948 * The clip-plane id for load_user_clip_plane intrinsic.
950 NIR_INTRINSIC_UCP_ID
= 4,
952 NIR_INTRINSIC_NUM_INDEX_FLAGS
,
954 } nir_intrinsic_index_flag
;
956 #define NIR_INTRINSIC_MAX_INPUTS 4
961 unsigned num_srcs
; /** < number of register/SSA inputs */
963 /** number of components of each input register
965 * If this value is 0, the number of components is given by the
966 * num_components field of nir_intrinsic_instr.
968 unsigned src_components
[NIR_INTRINSIC_MAX_INPUTS
];
972 /** number of components of the output register
974 * If this value is 0, the number of components is given by the
975 * num_components field of nir_intrinsic_instr.
977 unsigned dest_components
;
979 /** the number of inputs/outputs that are variables */
980 unsigned num_variables
;
982 /** the number of constant indices used by the intrinsic */
983 unsigned num_indices
;
985 /** indicates the usage of intr->const_index[n] */
986 unsigned index_map
[NIR_INTRINSIC_NUM_INDEX_FLAGS
];
988 /** semantic flags for calls to this intrinsic */
989 nir_intrinsic_semantic_flag flags
;
990 } nir_intrinsic_info
;
992 extern const nir_intrinsic_info nir_intrinsic_infos
[nir_num_intrinsics
];
995 #define INTRINSIC_IDX_ACCESSORS(name, flag, type) \
997 nir_intrinsic_##name(nir_intrinsic_instr *instr) \
999 const nir_intrinsic_info *info = &nir_intrinsic_infos[instr->intrinsic]; \
1000 assert(info->index_map[NIR_INTRINSIC_##flag] > 0); \
1001 return instr->const_index[info->index_map[NIR_INTRINSIC_##flag] - 1]; \
1003 static inline void \
1004 nir_intrinsic_set_##name(nir_intrinsic_instr *instr, type val) \
1006 const nir_intrinsic_info *info = &nir_intrinsic_infos[instr->intrinsic]; \
1007 assert(info->index_map[NIR_INTRINSIC_##flag] > 0); \
1008 instr->const_index[info->index_map[NIR_INTRINSIC_##flag] - 1] = val; \
1011 INTRINSIC_IDX_ACCESSORS(write_mask
, WRMASK
, unsigned)
1012 INTRINSIC_IDX_ACCESSORS(base
, BASE
, int)
1013 INTRINSIC_IDX_ACCESSORS(stream_id
, STREAM_ID
, unsigned)
1014 INTRINSIC_IDX_ACCESSORS(ucp_id
, UCP_ID
, unsigned)
1017 * \group texture information
1019 * This gives semantic information about textures which is useful to the
1020 * frontend, the backend, and lowering passes, but not the optimizer.
1025 nir_tex_src_projector
,
1026 nir_tex_src_comparitor
, /* shadow comparitor */
1030 nir_tex_src_ms_index
, /* MSAA sample index */
1033 nir_tex_src_texture_offset
, /* < dynamically uniform indirect offset */
1034 nir_tex_src_sampler_offset
, /* < dynamically uniform indirect offset */
1035 nir_num_tex_src_types
1040 nir_tex_src_type src_type
;
1044 nir_texop_tex
, /**< Regular texture look-up */
1045 nir_texop_txb
, /**< Texture look-up with LOD bias */
1046 nir_texop_txl
, /**< Texture look-up with explicit LOD */
1047 nir_texop_txd
, /**< Texture look-up with partial derivatvies */
1048 nir_texop_txf
, /**< Texel fetch with explicit LOD */
1049 nir_texop_txf_ms
, /**< Multisample texture fetch */
1050 nir_texop_txs
, /**< Texture size */
1051 nir_texop_lod
, /**< Texture lod query */
1052 nir_texop_tg4
, /**< Texture gather */
1053 nir_texop_query_levels
, /**< Texture levels query */
1054 nir_texop_texture_samples
, /**< Texture samples query */
1055 nir_texop_samples_identical
, /**< Query whether all samples are definitely
1063 enum glsl_sampler_dim sampler_dim
;
1064 nir_alu_type dest_type
;
1069 unsigned num_srcs
, coord_components
;
1070 bool is_array
, is_shadow
;
1073 * If is_shadow is true, whether this is the old-style shadow that outputs 4
1074 * components or the new-style shadow that outputs 1 component.
1076 bool is_new_style_shadow
;
1078 /* gather component selector */
1079 unsigned component
: 2;
1081 /** The texture index
1083 * If this texture instruction has a nir_tex_src_texture_offset source,
1084 * then the texture index is given by texture_index + texture_offset.
1086 unsigned texture_index
;
1088 /** The size of the texture array or 0 if it's not an array */
1089 unsigned texture_array_size
;
1091 /** The texture deref
1093 * If this is null, use texture_index instead.
1095 nir_deref_var
*texture
;
1097 /** The sampler index
1099 * The following operations do not require a sampler and, as such, this
1100 * field should be ignored:
1102 * - nir_texop_txf_ms
1106 * - nir_texop_query_levels
1107 * - nir_texop_texture_samples
1108 * - nir_texop_samples_identical
1110 * If this texture instruction has a nir_tex_src_sampler_offset source,
1111 * then the sampler index is given by sampler_index + sampler_offset.
1113 unsigned sampler_index
;
1115 /** The sampler deref
1117 * If this is null, use sampler_index instead.
1119 nir_deref_var
*sampler
;
1122 static inline unsigned
1123 nir_tex_instr_dest_size(nir_tex_instr
*instr
)
1125 switch (instr
->op
) {
1126 case nir_texop_txs
: {
1128 switch (instr
->sampler_dim
) {
1129 case GLSL_SAMPLER_DIM_1D
:
1130 case GLSL_SAMPLER_DIM_BUF
:
1133 case GLSL_SAMPLER_DIM_2D
:
1134 case GLSL_SAMPLER_DIM_CUBE
:
1135 case GLSL_SAMPLER_DIM_MS
:
1136 case GLSL_SAMPLER_DIM_RECT
:
1137 case GLSL_SAMPLER_DIM_EXTERNAL
:
1140 case GLSL_SAMPLER_DIM_3D
:
1144 unreachable("not reached");
1146 if (instr
->is_array
)
1154 case nir_texop_texture_samples
:
1155 case nir_texop_query_levels
:
1156 case nir_texop_samples_identical
:
1160 if (instr
->is_shadow
&& instr
->is_new_style_shadow
)
1167 /* Returns true if this texture operation queries something about the texture
1168 * rather than actually sampling it.
1171 nir_tex_instr_is_query(nir_tex_instr
*instr
)
1173 switch (instr
->op
) {
1176 case nir_texop_texture_samples
:
1177 case nir_texop_query_levels
:
1184 case nir_texop_txf_ms
:
1188 unreachable("Invalid texture opcode");
1192 static inline unsigned
1193 nir_tex_instr_src_size(nir_tex_instr
*instr
, unsigned src
)
1195 if (instr
->src
[src
].src_type
== nir_tex_src_coord
)
1196 return instr
->coord_components
;
1199 if (instr
->src
[src
].src_type
== nir_tex_src_offset
||
1200 instr
->src
[src
].src_type
== nir_tex_src_ddx
||
1201 instr
->src
[src
].src_type
== nir_tex_src_ddy
) {
1202 if (instr
->is_array
)
1203 return instr
->coord_components
- 1;
1205 return instr
->coord_components
;
1212 nir_tex_instr_src_index(nir_tex_instr
*instr
, nir_tex_src_type type
)
1214 for (unsigned i
= 0; i
< instr
->num_srcs
; i
++)
1215 if (instr
->src
[i
].src_type
== type
)
1235 nir_const_value value
;
1238 } nir_load_const_instr
;
1251 /* creates a new SSA variable in an undefined state */
1256 } nir_ssa_undef_instr
;
1259 struct exec_node node
;
1261 /* The predecessor block corresponding to this source */
1262 struct nir_block
*pred
;
1267 #define nir_foreach_phi_src(phi, entry) \
1268 foreach_list_typed(nir_phi_src, entry, node, &(phi)->srcs)
1269 #define nir_foreach_phi_src_safe(phi, entry) \
1270 foreach_list_typed_safe(nir_phi_src, entry, node, &(phi)->srcs)
1275 struct exec_list srcs
; /** < list of nir_phi_src */
1281 struct exec_node node
;
1284 } nir_parallel_copy_entry
;
1286 #define nir_foreach_parallel_copy_entry(pcopy, entry) \
1287 foreach_list_typed(nir_parallel_copy_entry, entry, node, &(pcopy)->entries)
1292 /* A list of nir_parallel_copy_entry's. The sources of all of the
1293 * entries are copied to the corresponding destinations "in parallel".
1294 * In other words, if we have two entries: a -> b and b -> a, the values
1297 struct exec_list entries
;
1298 } nir_parallel_copy_instr
;
1300 NIR_DEFINE_CAST(nir_instr_as_alu
, nir_instr
, nir_alu_instr
, instr
)
1301 NIR_DEFINE_CAST(nir_instr_as_call
, nir_instr
, nir_call_instr
, instr
)
1302 NIR_DEFINE_CAST(nir_instr_as_jump
, nir_instr
, nir_jump_instr
, instr
)
1303 NIR_DEFINE_CAST(nir_instr_as_tex
, nir_instr
, nir_tex_instr
, instr
)
1304 NIR_DEFINE_CAST(nir_instr_as_intrinsic
, nir_instr
, nir_intrinsic_instr
, instr
)
1305 NIR_DEFINE_CAST(nir_instr_as_load_const
, nir_instr
, nir_load_const_instr
, instr
)
1306 NIR_DEFINE_CAST(nir_instr_as_ssa_undef
, nir_instr
, nir_ssa_undef_instr
, instr
)
1307 NIR_DEFINE_CAST(nir_instr_as_phi
, nir_instr
, nir_phi_instr
, instr
)
1308 NIR_DEFINE_CAST(nir_instr_as_parallel_copy
, nir_instr
,
1309 nir_parallel_copy_instr
, instr
)
1314 * Control flow consists of a tree of control flow nodes, which include
1315 * if-statements and loops. The leaves of the tree are basic blocks, lists of
1316 * instructions that always run start-to-finish. Each basic block also keeps
1317 * track of its successors (blocks which may run immediately after the current
1318 * block) and predecessors (blocks which could have run immediately before the
1319 * current block). Each function also has a start block and an end block which
1320 * all return statements point to (which is always empty). Together, all the
1321 * blocks with their predecessors and successors make up the control flow
1322 * graph (CFG) of the function. There are helpers that modify the tree of
1323 * control flow nodes while modifying the CFG appropriately; these should be
1324 * used instead of modifying the tree directly.
1331 nir_cf_node_function
1334 typedef struct nir_cf_node
{
1335 struct exec_node node
;
1336 nir_cf_node_type type
;
1337 struct nir_cf_node
*parent
;
1340 typedef struct nir_block
{
1341 nir_cf_node cf_node
;
1343 struct exec_list instr_list
; /** < list of nir_instr */
1345 /** generic block index; generated by nir_index_blocks */
1349 * Each block can only have up to 2 successors, so we put them in a simple
1350 * array - no need for anything more complicated.
1352 struct nir_block
*successors
[2];
1354 /* Set of nir_block predecessors in the CFG */
1355 struct set
*predecessors
;
1358 * this node's immediate dominator in the dominance tree - set to NULL for
1361 struct nir_block
*imm_dom
;
1363 /* This node's children in the dominance tree */
1364 unsigned num_dom_children
;
1365 struct nir_block
**dom_children
;
1367 /* Set of nir_block's on the dominance frontier of this block */
1368 struct set
*dom_frontier
;
1371 * These two indices have the property that dom_{pre,post}_index for each
1372 * child of this block in the dominance tree will always be between
1373 * dom_pre_index and dom_post_index for this block, which makes testing if
1374 * a given block is dominated by another block an O(1) operation.
1376 unsigned dom_pre_index
, dom_post_index
;
1378 /* live in and out for this block; used for liveness analysis */
1379 BITSET_WORD
*live_in
;
1380 BITSET_WORD
*live_out
;
1383 static inline nir_instr
*
1384 nir_block_first_instr(nir_block
*block
)
1386 struct exec_node
*head
= exec_list_get_head(&block
->instr_list
);
1387 return exec_node_data(nir_instr
, head
, node
);
1390 static inline nir_instr
*
1391 nir_block_last_instr(nir_block
*block
)
1393 struct exec_node
*tail
= exec_list_get_tail(&block
->instr_list
);
1394 return exec_node_data(nir_instr
, tail
, node
);
1397 #define nir_foreach_instr(block, instr) \
1398 foreach_list_typed(nir_instr, instr, node, &(block)->instr_list)
1399 #define nir_foreach_instr_reverse(block, instr) \
1400 foreach_list_typed_reverse(nir_instr, instr, node, &(block)->instr_list)
1401 #define nir_foreach_instr_safe(block, instr) \
1402 foreach_list_typed_safe(nir_instr, instr, node, &(block)->instr_list)
1403 #define nir_foreach_instr_reverse_safe(block, instr) \
1404 foreach_list_typed_reverse_safe(nir_instr, instr, node, &(block)->instr_list)
1406 typedef struct nir_if
{
1407 nir_cf_node cf_node
;
1410 struct exec_list then_list
; /** < list of nir_cf_node */
1411 struct exec_list else_list
; /** < list of nir_cf_node */
1414 static inline nir_cf_node
*
1415 nir_if_first_then_node(nir_if
*if_stmt
)
1417 struct exec_node
*head
= exec_list_get_head(&if_stmt
->then_list
);
1418 return exec_node_data(nir_cf_node
, head
, node
);
1421 static inline nir_cf_node
*
1422 nir_if_last_then_node(nir_if
*if_stmt
)
1424 struct exec_node
*tail
= exec_list_get_tail(&if_stmt
->then_list
);
1425 return exec_node_data(nir_cf_node
, tail
, node
);
1428 static inline nir_cf_node
*
1429 nir_if_first_else_node(nir_if
*if_stmt
)
1431 struct exec_node
*head
= exec_list_get_head(&if_stmt
->else_list
);
1432 return exec_node_data(nir_cf_node
, head
, node
);
1435 static inline nir_cf_node
*
1436 nir_if_last_else_node(nir_if
*if_stmt
)
1438 struct exec_node
*tail
= exec_list_get_tail(&if_stmt
->else_list
);
1439 return exec_node_data(nir_cf_node
, tail
, node
);
1443 nir_cf_node cf_node
;
1445 struct exec_list body
; /** < list of nir_cf_node */
1448 static inline nir_cf_node
*
1449 nir_loop_first_cf_node(nir_loop
*loop
)
1451 return exec_node_data(nir_cf_node
, exec_list_get_head(&loop
->body
), node
);
1454 static inline nir_cf_node
*
1455 nir_loop_last_cf_node(nir_loop
*loop
)
1457 return exec_node_data(nir_cf_node
, exec_list_get_tail(&loop
->body
), node
);
1461 * Various bits of metadata that can may be created or required by
1462 * optimization and analysis passes
1465 nir_metadata_none
= 0x0,
1466 nir_metadata_block_index
= 0x1,
1467 nir_metadata_dominance
= 0x2,
1468 nir_metadata_live_ssa_defs
= 0x4,
1469 nir_metadata_not_properly_reset
= 0x8,
1473 nir_cf_node cf_node
;
1475 /** pointer to the function of which this is an implementation */
1476 struct nir_function
*function
;
1478 struct exec_list body
; /** < list of nir_cf_node */
1480 nir_block
*end_block
;
1482 /** list for all local variables in the function */
1483 struct exec_list locals
;
1485 /** array of variables used as parameters */
1486 unsigned num_params
;
1487 nir_variable
**params
;
1489 /** variable used to hold the result of the function */
1490 nir_variable
*return_var
;
1492 /** list of local registers in the function */
1493 struct exec_list registers
;
1495 /** next available local register index */
1498 /** next available SSA value index */
1501 /* total number of basic blocks, only valid when block_index_dirty = false */
1502 unsigned num_blocks
;
1504 nir_metadata valid_metadata
;
1505 } nir_function_impl
;
1507 static inline nir_block
*
1508 nir_start_block(nir_function_impl
*impl
)
1510 return (nir_block
*) exec_list_get_head(&impl
->body
);
1513 static inline nir_cf_node
*
1514 nir_cf_node_next(nir_cf_node
*node
)
1516 struct exec_node
*next
= exec_node_get_next(&node
->node
);
1517 if (exec_node_is_tail_sentinel(next
))
1520 return exec_node_data(nir_cf_node
, next
, node
);
1523 static inline nir_cf_node
*
1524 nir_cf_node_prev(nir_cf_node
*node
)
1526 struct exec_node
*prev
= exec_node_get_prev(&node
->node
);
1527 if (exec_node_is_head_sentinel(prev
))
1530 return exec_node_data(nir_cf_node
, prev
, node
);
1534 nir_cf_node_is_first(const nir_cf_node
*node
)
1536 return exec_node_is_head_sentinel(node
->node
.prev
);
1540 nir_cf_node_is_last(const nir_cf_node
*node
)
1542 return exec_node_is_tail_sentinel(node
->node
.next
);
1545 NIR_DEFINE_CAST(nir_cf_node_as_block
, nir_cf_node
, nir_block
, cf_node
)
1546 NIR_DEFINE_CAST(nir_cf_node_as_if
, nir_cf_node
, nir_if
, cf_node
)
1547 NIR_DEFINE_CAST(nir_cf_node_as_loop
, nir_cf_node
, nir_loop
, cf_node
)
1548 NIR_DEFINE_CAST(nir_cf_node_as_function
, nir_cf_node
, nir_function_impl
, cf_node
)
1553 nir_parameter_inout
,
1554 } nir_parameter_type
;
1557 nir_parameter_type param_type
;
1558 const struct glsl_type
*type
;
1561 typedef struct nir_function
{
1562 struct exec_node node
;
1565 struct nir_shader
*shader
;
1567 unsigned num_params
;
1568 nir_parameter
*params
;
1569 const struct glsl_type
*return_type
;
1571 /** The implementation of this function.
1573 * If the function is only declared and not implemented, this is NULL.
1575 nir_function_impl
*impl
;
1578 typedef struct nir_shader_compiler_options
{
1586 bool lower_bitfield_extract
;
1587 bool lower_bitfield_insert
;
1588 bool lower_uadd_carry
;
1589 bool lower_usub_borrow
;
1590 /** lowers fneg and ineg to fsub and isub. */
1592 /** lowers fsub and isub to fadd+fneg and iadd+ineg. */
1595 /* lower {slt,sge,seq,sne} to {flt,fge,feq,fne} + b2f: */
1598 /* Does the native fdot instruction replicate its result for four
1599 * components? If so, then opt_algebraic_late will turn all fdotN
1600 * instructions into fdot_replicatedN instructions.
1602 bool fdot_replicates
;
1604 /** lowers ffract to fsub+ffloor: */
1607 bool lower_pack_half_2x16
;
1608 bool lower_pack_unorm_2x16
;
1609 bool lower_pack_snorm_2x16
;
1610 bool lower_pack_unorm_4x8
;
1611 bool lower_pack_snorm_4x8
;
1612 bool lower_unpack_half_2x16
;
1613 bool lower_unpack_unorm_2x16
;
1614 bool lower_unpack_snorm_2x16
;
1615 bool lower_unpack_unorm_4x8
;
1616 bool lower_unpack_snorm_4x8
;
1618 bool lower_extract_byte
;
1619 bool lower_extract_word
;
1622 * Does the driver support real 32-bit integers? (Otherwise, integers
1623 * are simulated by floats.)
1625 bool native_integers
;
1626 } nir_shader_compiler_options
;
1628 typedef struct nir_shader_info
{
1631 /* Descriptive name provided by the client; may be NULL */
1634 /* Number of textures used by this shader */
1635 unsigned num_textures
;
1636 /* Number of uniform buffers used by this shader */
1638 /* Number of atomic buffers used by this shader */
1640 /* Number of shader storage buffers used by this shader */
1642 /* Number of images used by this shader */
1643 unsigned num_images
;
1645 /* Which inputs are actually read */
1646 uint64_t inputs_read
;
1647 /* Which outputs are actually written */
1648 uint64_t outputs_written
;
1649 /* Which system values are actually read */
1650 uint64_t system_values_read
;
1652 /* Which patch inputs are actually read */
1653 uint32_t patch_inputs_read
;
1654 /* Which patch outputs are actually written */
1655 uint32_t patch_outputs_written
;
1657 /* Whether or not this shader ever uses textureGather() */
1658 bool uses_texture_gather
;
1660 /* Whether or not this shader uses the gl_ClipDistance output */
1661 bool uses_clip_distance_out
;
1663 /* Whether or not separate shader objects were used */
1664 bool separate_shader
;
1666 /** Was this shader linked with any transform feedback varyings? */
1667 bool has_transform_feedback_varyings
;
1671 /** The number of vertices recieves per input primitive */
1672 unsigned vertices_in
;
1674 /** The output primitive type (GL enum value) */
1675 unsigned output_primitive
;
1677 /** The maximum number of vertices the geometry shader might write. */
1678 unsigned vertices_out
;
1680 /** 1 .. MAX_GEOMETRY_SHADER_INVOCATIONS */
1681 unsigned invocations
;
1683 /** Whether or not this shader uses EndPrimitive */
1684 bool uses_end_primitive
;
1686 /** Whether or not this shader uses non-zero streams */
1694 * Whether early fragment tests are enabled as defined by
1695 * ARB_shader_image_load_store.
1697 bool early_fragment_tests
;
1699 /** gl_FragDepth layout for ARB_conservative_depth. */
1700 enum gl_frag_depth_layout depth_layout
;
1704 unsigned local_size
[3];
1708 /** The number of vertices in the TCS output patch. */
1709 unsigned vertices_out
;
1714 typedef struct nir_shader
{
1715 /** list of uniforms (nir_variable) */
1716 struct exec_list uniforms
;
1718 /** list of inputs (nir_variable) */
1719 struct exec_list inputs
;
1721 /** list of outputs (nir_variable) */
1722 struct exec_list outputs
;
1724 /** list of shared compute variables (nir_variable) */
1725 struct exec_list shared
;
1727 /** Set of driver-specific options for the shader.
1729 * The memory for the options is expected to be kept in a single static
1730 * copy by the driver.
1732 const struct nir_shader_compiler_options
*options
;
1734 /** Various bits of compile-time information about a given shader */
1735 struct nir_shader_info info
;
1737 /** list of global variables in the shader (nir_variable) */
1738 struct exec_list globals
;
1740 /** list of system value variables in the shader (nir_variable) */
1741 struct exec_list system_values
;
1743 struct exec_list functions
; /** < list of nir_function */
1745 /** list of global register in the shader */
1746 struct exec_list registers
;
1748 /** next available global register index */
1752 * the highest index a load_input_*, load_uniform_*, etc. intrinsic can
1755 unsigned num_inputs
, num_uniforms
, num_outputs
, num_shared
;
1757 /** The shader stage, such as MESA_SHADER_VERTEX. */
1758 gl_shader_stage stage
;
1761 #define nir_foreach_function(shader, func) \
1762 foreach_list_typed(nir_function, func, node, &(shader)->functions)
1764 nir_shader
*nir_shader_create(void *mem_ctx
,
1765 gl_shader_stage stage
,
1766 const nir_shader_compiler_options
*options
);
1768 /** creates a register, including assigning it an index and adding it to the list */
1769 nir_register
*nir_global_reg_create(nir_shader
*shader
);
1771 nir_register
*nir_local_reg_create(nir_function_impl
*impl
);
1773 void nir_reg_remove(nir_register
*reg
);
1775 /** Adds a variable to the appropreate list in nir_shader */
1776 void nir_shader_add_variable(nir_shader
*shader
, nir_variable
*var
);
1779 nir_function_impl_add_variable(nir_function_impl
*impl
, nir_variable
*var
)
1781 assert(var
->data
.mode
== nir_var_local
);
1782 exec_list_push_tail(&impl
->locals
, &var
->node
);
1785 /** creates a variable, sets a few defaults, and adds it to the list */
1786 nir_variable
*nir_variable_create(nir_shader
*shader
,
1787 nir_variable_mode mode
,
1788 const struct glsl_type
*type
,
1790 /** creates a local variable and adds it to the list */
1791 nir_variable
*nir_local_variable_create(nir_function_impl
*impl
,
1792 const struct glsl_type
*type
,
1795 /** creates a function and adds it to the shader's list of functions */
1796 nir_function
*nir_function_create(nir_shader
*shader
, const char *name
);
1798 nir_function_impl
*nir_function_impl_create(nir_function
*func
);
1799 /** creates a function_impl that isn't tied to any particular function */
1800 nir_function_impl
*nir_function_impl_create_bare(nir_shader
*shader
);
1802 nir_block
*nir_block_create(nir_shader
*shader
);
1803 nir_if
*nir_if_create(nir_shader
*shader
);
1804 nir_loop
*nir_loop_create(nir_shader
*shader
);
1806 nir_function_impl
*nir_cf_node_get_function(nir_cf_node
*node
);
1808 /** requests that the given pieces of metadata be generated */
1809 void nir_metadata_require(nir_function_impl
*impl
, nir_metadata required
);
1810 /** dirties all but the preserved metadata */
1811 void nir_metadata_preserve(nir_function_impl
*impl
, nir_metadata preserved
);
1813 /** creates an instruction with default swizzle/writemask/etc. with NULL registers */
1814 nir_alu_instr
*nir_alu_instr_create(nir_shader
*shader
, nir_op op
);
1816 nir_jump_instr
*nir_jump_instr_create(nir_shader
*shader
, nir_jump_type type
);
1818 nir_load_const_instr
*nir_load_const_instr_create(nir_shader
*shader
,
1819 unsigned num_components
);
1821 nir_intrinsic_instr
*nir_intrinsic_instr_create(nir_shader
*shader
,
1822 nir_intrinsic_op op
);
1824 nir_call_instr
*nir_call_instr_create(nir_shader
*shader
,
1825 nir_function
*callee
);
1827 nir_tex_instr
*nir_tex_instr_create(nir_shader
*shader
, unsigned num_srcs
);
1829 nir_phi_instr
*nir_phi_instr_create(nir_shader
*shader
);
1831 nir_parallel_copy_instr
*nir_parallel_copy_instr_create(nir_shader
*shader
);
1833 nir_ssa_undef_instr
*nir_ssa_undef_instr_create(nir_shader
*shader
,
1834 unsigned num_components
);
1836 nir_deref_var
*nir_deref_var_create(void *mem_ctx
, nir_variable
*var
);
1837 nir_deref_array
*nir_deref_array_create(void *mem_ctx
);
1838 nir_deref_struct
*nir_deref_struct_create(void *mem_ctx
, unsigned field_index
);
1840 nir_deref
*nir_copy_deref(void *mem_ctx
, nir_deref
*deref
);
1842 nir_load_const_instr
*
1843 nir_deref_get_const_initializer_load(nir_shader
*shader
, nir_deref_var
*deref
);
1846 * NIR Cursors and Instruction Insertion API
1849 * A tiny struct representing a point to insert/extract instructions or
1850 * control flow nodes. Helps reduce the combinatorial explosion of possible
1851 * points to insert/extract.
1853 * \sa nir_control_flow.h
1856 nir_cursor_before_block
,
1857 nir_cursor_after_block
,
1858 nir_cursor_before_instr
,
1859 nir_cursor_after_instr
,
1860 } nir_cursor_option
;
1863 nir_cursor_option option
;
1870 static inline nir_cursor
1871 nir_before_block(nir_block
*block
)
1874 cursor
.option
= nir_cursor_before_block
;
1875 cursor
.block
= block
;
1879 static inline nir_cursor
1880 nir_after_block(nir_block
*block
)
1883 cursor
.option
= nir_cursor_after_block
;
1884 cursor
.block
= block
;
1888 static inline nir_cursor
1889 nir_before_instr(nir_instr
*instr
)
1892 cursor
.option
= nir_cursor_before_instr
;
1893 cursor
.instr
= instr
;
1897 static inline nir_cursor
1898 nir_after_instr(nir_instr
*instr
)
1901 cursor
.option
= nir_cursor_after_instr
;
1902 cursor
.instr
= instr
;
1906 static inline nir_cursor
1907 nir_after_block_before_jump(nir_block
*block
)
1909 nir_instr
*last_instr
= nir_block_last_instr(block
);
1910 if (last_instr
&& last_instr
->type
== nir_instr_type_jump
) {
1911 return nir_before_instr(last_instr
);
1913 return nir_after_block(block
);
1917 static inline nir_cursor
1918 nir_before_cf_node(nir_cf_node
*node
)
1920 if (node
->type
== nir_cf_node_block
)
1921 return nir_before_block(nir_cf_node_as_block(node
));
1923 return nir_after_block(nir_cf_node_as_block(nir_cf_node_prev(node
)));
1926 static inline nir_cursor
1927 nir_after_cf_node(nir_cf_node
*node
)
1929 if (node
->type
== nir_cf_node_block
)
1930 return nir_after_block(nir_cf_node_as_block(node
));
1932 return nir_before_block(nir_cf_node_as_block(nir_cf_node_next(node
)));
1935 static inline nir_cursor
1936 nir_before_cf_list(struct exec_list
*cf_list
)
1938 nir_cf_node
*first_node
= exec_node_data(nir_cf_node
,
1939 exec_list_get_head(cf_list
), node
);
1940 return nir_before_cf_node(first_node
);
1943 static inline nir_cursor
1944 nir_after_cf_list(struct exec_list
*cf_list
)
1946 nir_cf_node
*last_node
= exec_node_data(nir_cf_node
,
1947 exec_list_get_tail(cf_list
), node
);
1948 return nir_after_cf_node(last_node
);
1952 * Insert a NIR instruction at the given cursor.
1954 * Note: This does not update the cursor.
1956 void nir_instr_insert(nir_cursor cursor
, nir_instr
*instr
);
1959 nir_instr_insert_before(nir_instr
*instr
, nir_instr
*before
)
1961 nir_instr_insert(nir_before_instr(instr
), before
);
1965 nir_instr_insert_after(nir_instr
*instr
, nir_instr
*after
)
1967 nir_instr_insert(nir_after_instr(instr
), after
);
1971 nir_instr_insert_before_block(nir_block
*block
, nir_instr
*before
)
1973 nir_instr_insert(nir_before_block(block
), before
);
1977 nir_instr_insert_after_block(nir_block
*block
, nir_instr
*after
)
1979 nir_instr_insert(nir_after_block(block
), after
);
1983 nir_instr_insert_before_cf(nir_cf_node
*node
, nir_instr
*before
)
1985 nir_instr_insert(nir_before_cf_node(node
), before
);
1989 nir_instr_insert_after_cf(nir_cf_node
*node
, nir_instr
*after
)
1991 nir_instr_insert(nir_after_cf_node(node
), after
);
1995 nir_instr_insert_before_cf_list(struct exec_list
*list
, nir_instr
*before
)
1997 nir_instr_insert(nir_before_cf_list(list
), before
);
2001 nir_instr_insert_after_cf_list(struct exec_list
*list
, nir_instr
*after
)
2003 nir_instr_insert(nir_after_cf_list(list
), after
);
2006 void nir_instr_remove(nir_instr
*instr
);
2010 typedef bool (*nir_foreach_ssa_def_cb
)(nir_ssa_def
*def
, void *state
);
2011 typedef bool (*nir_foreach_dest_cb
)(nir_dest
*dest
, void *state
);
2012 typedef bool (*nir_foreach_src_cb
)(nir_src
*src
, void *state
);
2013 bool nir_foreach_ssa_def(nir_instr
*instr
, nir_foreach_ssa_def_cb cb
,
2015 bool nir_foreach_dest(nir_instr
*instr
, nir_foreach_dest_cb cb
, void *state
);
2016 bool nir_foreach_src(nir_instr
*instr
, nir_foreach_src_cb cb
, void *state
);
2018 nir_const_value
*nir_src_as_const_value(nir_src src
);
2019 bool nir_src_is_dynamically_uniform(nir_src src
);
2020 bool nir_srcs_equal(nir_src src1
, nir_src src2
);
2021 void nir_instr_rewrite_src(nir_instr
*instr
, nir_src
*src
, nir_src new_src
);
2022 void nir_instr_move_src(nir_instr
*dest_instr
, nir_src
*dest
, nir_src
*src
);
2023 void nir_if_rewrite_condition(nir_if
*if_stmt
, nir_src new_src
);
2024 void nir_instr_rewrite_dest(nir_instr
*instr
, nir_dest
*dest
,
2027 void nir_ssa_dest_init(nir_instr
*instr
, nir_dest
*dest
,
2028 unsigned num_components
, unsigned bit_size
,
2030 void nir_ssa_def_init(nir_instr
*instr
, nir_ssa_def
*def
,
2031 unsigned num_components
, unsigned bit_size
,
2033 void nir_ssa_def_rewrite_uses(nir_ssa_def
*def
, nir_src new_src
);
2034 void nir_ssa_def_rewrite_uses_after(nir_ssa_def
*def
, nir_src new_src
,
2035 nir_instr
*after_me
);
2037 /* visits basic blocks in source-code order */
2038 typedef bool (*nir_foreach_block_cb
)(nir_block
*block
, void *state
);
2039 bool nir_foreach_block(nir_function_impl
*impl
, nir_foreach_block_cb cb
,
2041 bool nir_foreach_block_reverse(nir_function_impl
*impl
, nir_foreach_block_cb cb
,
2043 bool nir_foreach_block_in_cf_node(nir_cf_node
*node
, nir_foreach_block_cb cb
,
2046 /* If the following CF node is an if, this function returns that if.
2047 * Otherwise, it returns NULL.
2049 nir_if
*nir_block_get_following_if(nir_block
*block
);
2051 nir_loop
*nir_block_get_following_loop(nir_block
*block
);
2053 void nir_index_local_regs(nir_function_impl
*impl
);
2054 void nir_index_global_regs(nir_shader
*shader
);
2055 void nir_index_ssa_defs(nir_function_impl
*impl
);
2056 unsigned nir_index_instrs(nir_function_impl
*impl
);
2058 void nir_index_blocks(nir_function_impl
*impl
);
2060 void nir_print_shader(nir_shader
*shader
, FILE *fp
);
2061 void nir_print_instr(const nir_instr
*instr
, FILE *fp
);
2063 nir_shader
*nir_shader_clone(void *mem_ctx
, const nir_shader
*s
);
2064 nir_function_impl
*nir_function_impl_clone(const nir_function_impl
*fi
);
2065 nir_constant
*nir_constant_clone(const nir_constant
*c
, nir_variable
*var
);
2066 nir_variable
*nir_variable_clone(const nir_variable
*c
, nir_shader
*shader
);
2069 void nir_validate_shader(nir_shader
*shader
);
2070 void nir_metadata_set_validation_flag(nir_shader
*shader
);
2071 void nir_metadata_check_validation_flag(nir_shader
*shader
);
2073 #include "util/debug.h"
2075 should_clone_nir(void)
2077 static int should_clone
= -1;
2078 if (should_clone
< 0)
2079 should_clone
= env_var_as_boolean("NIR_TEST_CLONE", false);
2081 return should_clone
;
2084 static inline void nir_validate_shader(nir_shader
*shader
) { (void) shader
; }
2085 static inline void nir_metadata_set_validation_flag(nir_shader
*shader
) { (void) shader
; }
2086 static inline void nir_metadata_check_validation_flag(nir_shader
*shader
) { (void) shader
; }
2087 static inline bool should_clone_nir(void) { return false; }
2090 #define _PASS(nir, do_pass) do { \
2092 nir_validate_shader(nir); \
2093 if (should_clone_nir()) { \
2094 nir_shader *clone = nir_shader_clone(ralloc_parent(nir), nir); \
2100 #define NIR_PASS(progress, nir, pass, ...) _PASS(nir, \
2101 nir_metadata_set_validation_flag(nir); \
2102 if (pass(nir, ##__VA_ARGS__)) { \
2104 nir_metadata_check_validation_flag(nir); \
2108 #define NIR_PASS_V(nir, pass, ...) _PASS(nir, \
2109 pass(nir, ##__VA_ARGS__); \
2112 void nir_calc_dominance_impl(nir_function_impl
*impl
);
2113 void nir_calc_dominance(nir_shader
*shader
);
2115 nir_block
*nir_dominance_lca(nir_block
*b1
, nir_block
*b2
);
2116 bool nir_block_dominates(nir_block
*parent
, nir_block
*child
);
2118 void nir_dump_dom_tree_impl(nir_function_impl
*impl
, FILE *fp
);
2119 void nir_dump_dom_tree(nir_shader
*shader
, FILE *fp
);
2121 void nir_dump_dom_frontier_impl(nir_function_impl
*impl
, FILE *fp
);
2122 void nir_dump_dom_frontier(nir_shader
*shader
, FILE *fp
);
2124 void nir_dump_cfg_impl(nir_function_impl
*impl
, FILE *fp
);
2125 void nir_dump_cfg(nir_shader
*shader
, FILE *fp
);
2127 int nir_gs_count_vertices(const nir_shader
*shader
);
2129 bool nir_split_var_copies(nir_shader
*shader
);
2131 void nir_lower_var_copy_instr(nir_intrinsic_instr
*copy
, void *mem_ctx
);
2132 void nir_lower_var_copies(nir_shader
*shader
);
2134 bool nir_lower_global_vars_to_local(nir_shader
*shader
);
2136 bool nir_lower_indirect_derefs(nir_shader
*shader
, uint32_t mode_mask
);
2138 bool nir_lower_locals_to_regs(nir_shader
*shader
);
2140 void nir_lower_outputs_to_temporaries(nir_shader
*shader
);
2142 void nir_assign_var_locations(struct exec_list
*var_list
,
2144 int (*type_size
)(const struct glsl_type
*));
2146 void nir_lower_io(nir_shader
*shader
,
2147 nir_variable_mode mode
,
2148 int (*type_size
)(const struct glsl_type
*));
2149 nir_src
*nir_get_io_offset_src(nir_intrinsic_instr
*instr
);
2150 nir_src
*nir_get_io_vertex_index_src(nir_intrinsic_instr
*instr
);
2152 void nir_lower_vars_to_ssa(nir_shader
*shader
);
2154 bool nir_remove_dead_variables(nir_shader
*shader
);
2156 void nir_move_vec_src_uses_to_dest(nir_shader
*shader
);
2157 bool nir_lower_vec_to_movs(nir_shader
*shader
);
2158 void nir_lower_alu_to_scalar(nir_shader
*shader
);
2159 void nir_lower_load_const_to_scalar(nir_shader
*shader
);
2161 void nir_lower_phis_to_scalar(nir_shader
*shader
);
2163 void nir_lower_samplers(nir_shader
*shader
,
2164 const struct gl_shader_program
*shader_program
);
2166 bool nir_lower_system_values(nir_shader
*shader
);
2168 typedef struct nir_lower_tex_options
{
2170 * bitmask of (1 << GLSL_SAMPLER_DIM_x) to control for which
2171 * sampler types a texture projector is lowered.
2176 * If true, lower rect textures to 2D, using txs to fetch the
2177 * texture dimensions and dividing the texture coords by the
2178 * texture dims to normalize.
2183 * To emulate certain texture wrap modes, this can be used
2184 * to saturate the specified tex coord to [0.0, 1.0]. The
2185 * bits are according to sampler #, ie. if, for example:
2187 * (conf->saturate_s & (1 << n))
2189 * is true, then the s coord for sampler n is saturated.
2191 * Note that clamping must happen *after* projector lowering
2192 * so any projected texture sample instruction with a clamped
2193 * coordinate gets automatically lowered, regardless of the
2194 * 'lower_txp' setting.
2196 unsigned saturate_s
;
2197 unsigned saturate_t
;
2198 unsigned saturate_r
;
2200 /* Bitmask of textures that need swizzling.
2202 * If (swizzle_result & (1 << texture_index)), then the swizzle in
2203 * swizzles[texture_index] is applied to the result of the texturing
2206 unsigned swizzle_result
;
2208 /* A swizzle for each texture. Values 0-3 represent x, y, z, or w swizzles
2209 * while 4 and 5 represent 0 and 1 respectively.
2211 uint8_t swizzles
[32][4];
2212 } nir_lower_tex_options
;
2214 bool nir_lower_tex(nir_shader
*shader
,
2215 const nir_lower_tex_options
*options
);
2217 void nir_lower_idiv(nir_shader
*shader
);
2219 void nir_lower_clip_vs(nir_shader
*shader
, unsigned ucp_enables
);
2220 void nir_lower_clip_fs(nir_shader
*shader
, unsigned ucp_enables
);
2222 void nir_lower_two_sided_color(nir_shader
*shader
);
2224 void nir_lower_atomics(nir_shader
*shader
,
2225 const struct gl_shader_program
*shader_program
);
2226 void nir_lower_to_source_mods(nir_shader
*shader
);
2228 bool nir_lower_gs_intrinsics(nir_shader
*shader
);
2230 bool nir_normalize_cubemap_coords(nir_shader
*shader
);
2232 void nir_live_ssa_defs_impl(nir_function_impl
*impl
);
2233 bool nir_ssa_defs_interfere(nir_ssa_def
*a
, nir_ssa_def
*b
);
2235 void nir_convert_to_ssa_impl(nir_function_impl
*impl
);
2236 void nir_convert_to_ssa(nir_shader
*shader
);
2238 bool nir_repair_ssa_impl(nir_function_impl
*impl
);
2239 bool nir_repair_ssa(nir_shader
*shader
);
2241 /* If phi_webs_only is true, only convert SSA values involved in phi nodes to
2242 * registers. If false, convert all values (even those not involved in a phi
2243 * node) to registers.
2245 void nir_convert_from_ssa(nir_shader
*shader
, bool phi_webs_only
);
2247 bool nir_opt_algebraic(nir_shader
*shader
);
2248 bool nir_opt_algebraic_late(nir_shader
*shader
);
2249 bool nir_opt_constant_folding(nir_shader
*shader
);
2251 bool nir_opt_global_to_local(nir_shader
*shader
);
2253 bool nir_copy_prop(nir_shader
*shader
);
2255 bool nir_opt_cse(nir_shader
*shader
);
2257 bool nir_opt_dce(nir_shader
*shader
);
2259 bool nir_opt_dead_cf(nir_shader
*shader
);
2261 void nir_opt_gcm(nir_shader
*shader
);
2263 bool nir_opt_peephole_select(nir_shader
*shader
);
2265 bool nir_opt_remove_phis(nir_shader
*shader
);
2267 bool nir_opt_undef(nir_shader
*shader
);
2269 void nir_sweep(nir_shader
*shader
);
2271 nir_intrinsic_op
nir_intrinsic_from_system_value(gl_system_value val
);
2272 gl_system_value
nir_system_value_from_intrinsic(nir_intrinsic_op intrin
);