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
84 nir_var_shader_in
= (1 << 0),
85 nir_var_shader_out
= (1 << 1),
86 nir_var_global
= (1 << 2),
87 nir_var_local
= (1 << 3),
88 nir_var_uniform
= (1 << 4),
89 nir_var_shader_storage
= (1 << 5),
90 nir_var_system_value
= (1 << 6),
91 nir_var_param
= (1 << 7),
92 nir_var_shared
= (1 << 8),
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
{
160 * Storage class of the variable.
162 * \sa nir_variable_mode
164 nir_variable_mode mode
;
167 * Is the variable read-only?
169 * This is set for variables declared as \c const, shader inputs,
172 unsigned read_only
:1;
176 unsigned invariant
:1;
179 * Interpolation mode for shader inputs / outputs
181 * \sa glsl_interp_qualifier
183 unsigned interpolation
:2;
186 * \name ARB_fragment_coord_conventions
189 unsigned origin_upper_left
:1;
190 unsigned pixel_center_integer
:1;
194 * Was the location explicitly set in the shader?
196 * If the location is explicitly set in the shader, it \b cannot be changed
197 * by the linker or by the API (e.g., calls to \c glBindAttribLocation have
200 unsigned explicit_location
:1;
201 unsigned explicit_index
:1;
204 * Was an initial binding explicitly set in the shader?
206 * If so, constant_initializer contains an integer nir_constant
207 * representing the initial binding point.
209 unsigned explicit_binding
:1;
212 * Does this variable have an initializer?
214 * This is used by the linker to cross-validiate initializers of global
217 unsigned has_initializer
:1;
220 * If non-zero, then this variable may be packed along with other variables
221 * into a single varying slot, so this offset should be applied when
222 * accessing components. For example, an offset of 1 means that the x
223 * component of this variable is actually stored in component y of the
224 * location specified by \c location.
226 unsigned location_frac
:2;
229 * \brief Layout qualifier for gl_FragDepth.
231 * This is not equal to \c ir_depth_layout_none if and only if this
232 * variable is \c gl_FragDepth and a layout qualifier is specified.
234 nir_depth_layout depth_layout
;
237 * Storage location of the base of this variable
239 * The precise meaning of this field depends on the nature of the variable.
241 * - Vertex shader input: one of the values from \c gl_vert_attrib.
242 * - Vertex shader output: one of the values from \c gl_varying_slot.
243 * - Geometry shader input: one of the values from \c gl_varying_slot.
244 * - Geometry shader output: one of the values from \c gl_varying_slot.
245 * - Fragment shader input: one of the values from \c gl_varying_slot.
246 * - Fragment shader output: one of the values from \c gl_frag_result.
247 * - Uniforms: Per-stage uniform slot number for default uniform block.
248 * - Uniforms: Index within the uniform block definition for UBO members.
249 * - Non-UBO Uniforms: uniform slot number.
250 * - Other: This field is not currently used.
252 * If the variable is a uniform, shader input, or shader output, and the
253 * slot has not been assigned, the value will be -1.
258 * The actual location of the variable in the IR. Only valid for inputs
261 unsigned int driver_location
;
264 * output index for dual source blending.
269 * Descriptor set binding for sampler or UBO.
274 * Initial binding point for a sampler or UBO.
276 * For array types, this represents the binding point for the first element.
281 * Location an atomic counter is stored at.
286 * ARB_shader_image_load_store qualifiers.
289 bool read_only
; /**< "readonly" qualifier. */
290 bool write_only
; /**< "writeonly" qualifier. */
295 /** Image internal format if specified explicitly, otherwise GL_NONE. */
300 * Highest element accessed with a constant expression array index
302 * Not used for non-array variables.
304 unsigned max_array_access
;
309 * Built-in state that backs this uniform
311 * Once set at variable creation, \c state_slots must remain invariant.
312 * This is because, ideally, this array would be shared by all clones of
313 * this variable in the IR tree. In other words, we'd really like for it
314 * to be a fly-weight.
316 * If the variable is not a uniform, \c num_state_slots will be zero and
317 * \c state_slots will be \c NULL.
320 unsigned num_state_slots
; /**< Number of state slots used */
321 nir_state_slot
*state_slots
; /**< State descriptors. */
325 * Constant expression assigned in the initializer of the variable
327 nir_constant
*constant_initializer
;
330 * For variables that are in an interface block or are an instance of an
331 * interface block, this is the \c GLSL_TYPE_INTERFACE type for that block.
333 * \sa ir_variable::location
335 const struct glsl_type
*interface_type
;
338 #define nir_foreach_variable(var, var_list) \
339 foreach_list_typed(nir_variable, var, node, var_list)
341 #define nir_foreach_variable_safe(var, var_list) \
342 foreach_list_typed_safe(nir_variable, var, node, var_list)
345 nir_variable_is_global(const nir_variable
*var
)
347 return var
->data
.mode
!= nir_var_local
&& var
->data
.mode
!= nir_var_param
;
350 typedef struct nir_register
{
351 struct exec_node node
;
353 unsigned num_components
; /** < number of vector components */
354 unsigned num_array_elems
; /** < size of array (0 for no array) */
356 /* The bit-size of each channel; must be one of 8, 16, 32, or 64 */
359 /** generic register index. */
362 /** only for debug purposes, can be NULL */
365 /** whether this register is local (per-function) or global (per-shader) */
369 * If this flag is set to true, then accessing channels >= num_components
370 * is well-defined, and simply spills over to the next array element. This
371 * is useful for backends that can do per-component accessing, in
372 * particular scalar backends. By setting this flag and making
373 * num_components equal to 1, structures can be packed tightly into
374 * registers and then registers can be accessed per-component to get to
375 * each structure member, even if it crosses vec4 boundaries.
379 /** set of nir_src's where this register is used (read from) */
380 struct list_head uses
;
382 /** set of nir_dest's where this register is defined (written to) */
383 struct list_head defs
;
385 /** set of nir_if's where this register is used as a condition */
386 struct list_head if_uses
;
393 nir_instr_type_intrinsic
,
394 nir_instr_type_load_const
,
396 nir_instr_type_ssa_undef
,
398 nir_instr_type_parallel_copy
,
401 typedef struct nir_instr
{
402 struct exec_node node
;
404 struct nir_block
*block
;
406 /** generic instruction index. */
409 /* A temporary for optimization and analysis passes to use for storing
410 * flags. For instance, DCE uses this to store the "dead/live" info.
415 static inline nir_instr
*
416 nir_instr_next(nir_instr
*instr
)
418 struct exec_node
*next
= exec_node_get_next(&instr
->node
);
419 if (exec_node_is_tail_sentinel(next
))
422 return exec_node_data(nir_instr
, next
, node
);
425 static inline nir_instr
*
426 nir_instr_prev(nir_instr
*instr
)
428 struct exec_node
*prev
= exec_node_get_prev(&instr
->node
);
429 if (exec_node_is_head_sentinel(prev
))
432 return exec_node_data(nir_instr
, prev
, node
);
436 nir_instr_is_first(nir_instr
*instr
)
438 return exec_node_is_head_sentinel(exec_node_get_prev(&instr
->node
));
442 nir_instr_is_last(nir_instr
*instr
)
444 return exec_node_is_tail_sentinel(exec_node_get_next(&instr
->node
));
447 typedef struct nir_ssa_def
{
448 /** for debugging only, can be NULL */
451 /** generic SSA definition index. */
454 /** Index into the live_in and live_out bitfields */
457 nir_instr
*parent_instr
;
459 /** set of nir_instr's where this register is used (read from) */
460 struct list_head uses
;
462 /** set of nir_if's where this register is used as a condition */
463 struct list_head if_uses
;
465 uint8_t num_components
;
467 /* The bit-size of each channel; must be one of 8, 16, 32, or 64 */
475 struct nir_src
*indirect
; /** < NULL for no indirect offset */
476 unsigned base_offset
;
478 /* TODO use-def chain goes here */
482 nir_instr
*parent_instr
;
483 struct list_head def_link
;
486 struct nir_src
*indirect
; /** < NULL for no indirect offset */
487 unsigned base_offset
;
489 /* TODO def-use chain goes here */
494 typedef struct nir_src
{
496 nir_instr
*parent_instr
;
497 struct nir_if
*parent_if
;
500 struct list_head use_link
;
510 static inline nir_src
513 nir_src src
= { { NULL
} };
517 #define NIR_SRC_INIT nir_src_init()
519 #define nir_foreach_use(reg_or_ssa_def, src) \
520 list_for_each_entry(nir_src, src, &(reg_or_ssa_def)->uses, use_link)
522 #define nir_foreach_use_safe(reg_or_ssa_def, src) \
523 list_for_each_entry_safe(nir_src, src, &(reg_or_ssa_def)->uses, use_link)
525 #define nir_foreach_if_use(reg_or_ssa_def, src) \
526 list_for_each_entry(nir_src, src, &(reg_or_ssa_def)->if_uses, use_link)
528 #define nir_foreach_if_use_safe(reg_or_ssa_def, src) \
529 list_for_each_entry_safe(nir_src, src, &(reg_or_ssa_def)->if_uses, use_link)
540 static inline nir_dest
543 nir_dest dest
= { { { NULL
} } };
547 #define NIR_DEST_INIT nir_dest_init()
549 #define nir_foreach_def(reg, dest) \
550 list_for_each_entry(nir_dest, dest, &(reg)->defs, reg.def_link)
552 #define nir_foreach_def_safe(reg, dest) \
553 list_for_each_entry_safe(nir_dest, dest, &(reg)->defs, reg.def_link)
555 static inline nir_src
556 nir_src_for_ssa(nir_ssa_def
*def
)
558 nir_src src
= NIR_SRC_INIT
;
566 static inline nir_src
567 nir_src_for_reg(nir_register
*reg
)
569 nir_src src
= NIR_SRC_INIT
;
573 src
.reg
.indirect
= NULL
;
574 src
.reg
.base_offset
= 0;
579 static inline nir_dest
580 nir_dest_for_reg(nir_register
*reg
)
582 nir_dest dest
= NIR_DEST_INIT
;
589 static inline unsigned
590 nir_src_bit_size(nir_src src
)
592 return src
.is_ssa
? src
.ssa
->bit_size
: src
.reg
.reg
->bit_size
;
595 static inline unsigned
596 nir_dest_bit_size(nir_dest dest
)
598 return dest
.is_ssa
? dest
.ssa
.bit_size
: dest
.reg
.reg
->bit_size
;
601 void nir_src_copy(nir_src
*dest
, const nir_src
*src
, void *instr_or_if
);
602 void nir_dest_copy(nir_dest
*dest
, const nir_dest
*src
, nir_instr
*instr
);
608 * \name input modifiers
612 * For inputs interpreted as floating point, flips the sign bit. For
613 * inputs interpreted as integers, performs the two's complement negation.
618 * Clears the sign bit for floating point values, and computes the integer
619 * absolute value for integers. Note that the negate modifier acts after
620 * the absolute value modifier, therefore if both are set then all inputs
621 * will become negative.
627 * For each input component, says which component of the register it is
628 * chosen from. Note that which elements of the swizzle are used and which
629 * are ignored are based on the write mask for most opcodes - for example,
630 * a statement like "foo.xzw = bar.zyx" would have a writemask of 1101b and
631 * a swizzle of {2, x, 1, 0} where x means "don't care."
640 * \name saturate output modifier
642 * Only valid for opcodes that output floating-point numbers. Clamps the
643 * output to between 0.0 and 1.0 inclusive.
648 unsigned write_mask
: 4; /* ignored if dest.is_ssa is true */
652 nir_type_invalid
= 0, /* Not a valid type */
657 nir_type_bool32
= 32 | nir_type_bool
,
658 nir_type_int8
= 8 | nir_type_int
,
659 nir_type_int16
= 16 | nir_type_int
,
660 nir_type_int32
= 32 | nir_type_int
,
661 nir_type_int64
= 64 | nir_type_int
,
662 nir_type_uint8
= 8 | nir_type_uint
,
663 nir_type_uint16
= 16 | nir_type_uint
,
664 nir_type_uint32
= 32 | nir_type_uint
,
665 nir_type_uint64
= 64 | nir_type_uint
,
666 nir_type_float16
= 16 | nir_type_float
,
667 nir_type_float32
= 32 | nir_type_float
,
668 nir_type_float64
= 64 | nir_type_float
,
671 #define NIR_ALU_TYPE_SIZE_MASK 0xfffffff8
672 #define NIR_ALU_TYPE_BASE_TYPE_MASK 0x00000007
674 static inline unsigned
675 nir_alu_type_get_type_size(nir_alu_type type
)
677 return type
& NIR_ALU_TYPE_SIZE_MASK
;
680 static inline unsigned
681 nir_alu_type_get_base_type(nir_alu_type type
)
683 return type
& NIR_ALU_TYPE_BASE_TYPE_MASK
;
687 NIR_OP_IS_COMMUTATIVE
= (1 << 0),
688 NIR_OP_IS_ASSOCIATIVE
= (1 << 1),
689 } nir_op_algebraic_property
;
697 * The number of components in the output
699 * If non-zero, this is the size of the output and input sizes are
700 * explicitly given; swizzle and writemask are still in effect, but if
701 * the output component is masked out, then the input component may
704 * If zero, the opcode acts in the standard, per-component manner; the
705 * operation is performed on each component (except the ones that are
706 * masked out) with the input being taken from the input swizzle for
709 * The size of some of the inputs may be given (i.e. non-zero) even
710 * though output_size is zero; in that case, the inputs with a zero
711 * size act per-component, while the inputs with non-zero size don't.
713 unsigned output_size
;
716 * The type of vector that the instruction outputs. Note that the
717 * staurate modifier is only allowed on outputs with the float type.
720 nir_alu_type output_type
;
723 * The number of components in each input
725 unsigned input_sizes
[4];
728 * The type of vector that each input takes. Note that negate and
729 * absolute value are only allowed on inputs with int or float type and
730 * behave differently on the two.
732 nir_alu_type input_types
[4];
734 nir_op_algebraic_property algebraic_properties
;
737 extern const nir_op_info nir_op_infos
[nir_num_opcodes
];
739 typedef struct nir_alu_instr
{
743 /** Indicates that this ALU instruction generates an exact value
745 * This is kind of a mixture of GLSL "precise" and "invariant" and not
746 * really equivalent to either. This indicates that the value generated by
747 * this operation is high-precision and any code transformations that touch
748 * it must ensure that the resulting value is bit-for-bit identical to the
757 void nir_alu_src_copy(nir_alu_src
*dest
, const nir_alu_src
*src
,
758 nir_alu_instr
*instr
);
759 void nir_alu_dest_copy(nir_alu_dest
*dest
, const nir_alu_dest
*src
,
760 nir_alu_instr
*instr
);
762 /* is this source channel used? */
764 nir_alu_instr_channel_used(nir_alu_instr
*instr
, unsigned src
, unsigned channel
)
766 if (nir_op_infos
[instr
->op
].input_sizes
[src
] > 0)
767 return channel
< nir_op_infos
[instr
->op
].input_sizes
[src
];
769 return (instr
->dest
.write_mask
>> channel
) & 1;
773 * For instructions whose destinations are SSA, get the number of channels
776 static inline unsigned
777 nir_ssa_alu_instr_src_components(const nir_alu_instr
*instr
, unsigned src
)
779 assert(instr
->dest
.dest
.is_ssa
);
781 if (nir_op_infos
[instr
->op
].input_sizes
[src
] > 0)
782 return nir_op_infos
[instr
->op
].input_sizes
[src
];
784 return instr
->dest
.dest
.ssa
.num_components
;
789 nir_deref_type_array
,
790 nir_deref_type_struct
793 typedef struct nir_deref
{
794 nir_deref_type deref_type
;
795 struct nir_deref
*child
;
796 const struct glsl_type
*type
;
805 /* This enum describes how the array is referenced. If the deref is
806 * direct then the base_offset is used. If the deref is indirect then then
807 * offset is given by base_offset + indirect. If the deref is a wildcard
808 * then the deref refers to all of the elements of the array at the same
809 * time. Wildcard dereferences are only ever allowed in copy_var
810 * intrinsics and the source and destination derefs must have matching
814 nir_deref_array_type_direct
,
815 nir_deref_array_type_indirect
,
816 nir_deref_array_type_wildcard
,
817 } nir_deref_array_type
;
822 nir_deref_array_type deref_array_type
;
823 unsigned base_offset
;
833 NIR_DEFINE_CAST(nir_deref_as_var
, nir_deref
, nir_deref_var
, deref
)
834 NIR_DEFINE_CAST(nir_deref_as_array
, nir_deref
, nir_deref_array
, deref
)
835 NIR_DEFINE_CAST(nir_deref_as_struct
, nir_deref
, nir_deref_struct
, deref
)
837 /* Returns the last deref in the chain. */
838 static inline nir_deref
*
839 nir_deref_tail(nir_deref
*deref
)
842 deref
= deref
->child
;
850 nir_deref_var
**params
;
851 nir_deref_var
*return_deref
;
853 struct nir_function
*callee
;
856 #define INTRINSIC(name, num_srcs, src_components, has_dest, dest_components, \
857 num_variables, num_indices, idx0, idx1, idx2, flags) \
858 nir_intrinsic_##name,
860 #define LAST_INTRINSIC(name) nir_last_intrinsic = nir_intrinsic_##name,
863 #include "nir_intrinsics.h"
864 nir_num_intrinsics
= nir_last_intrinsic
+ 1
868 #undef LAST_INTRINSIC
870 #define NIR_INTRINSIC_MAX_CONST_INDEX 3
872 /** Represents an intrinsic
874 * An intrinsic is an instruction type for handling things that are
875 * more-or-less regular operations but don't just consume and produce SSA
876 * values like ALU operations do. Intrinsics are not for things that have
877 * special semantic meaning such as phi nodes and parallel copies.
878 * Examples of intrinsics include variable load/store operations, system
879 * value loads, and the like. Even though texturing more-or-less falls
880 * under this category, texturing is its own instruction type because
881 * trying to represent texturing with intrinsics would lead to a
882 * combinatorial explosion of intrinsic opcodes.
884 * By having a single instruction type for handling a lot of different
885 * cases, optimization passes can look for intrinsics and, for the most
886 * part, completely ignore them. Each intrinsic type also has a few
887 * possible flags that govern whether or not they can be reordered or
888 * eliminated. That way passes like dead code elimination can still work
889 * on intrisics without understanding the meaning of each.
891 * Each intrinsic has some number of constant indices, some number of
892 * variables, and some number of sources. What these sources, variables,
893 * and indices mean depends on the intrinsic and is documented with the
894 * intrinsic declaration in nir_intrinsics.h. Intrinsics and texture
895 * instructions are the only types of instruction that can operate on
901 nir_intrinsic_op intrinsic
;
905 /** number of components if this is a vectorized intrinsic
907 * Similarly to ALU operations, some intrinsics are vectorized.
908 * An intrinsic is vectorized if nir_intrinsic_infos.dest_components == 0.
909 * For vectorized intrinsics, the num_components field specifies the
910 * number of destination components and the number of source components
911 * for all sources with nir_intrinsic_infos.src_components[i] == 0.
913 uint8_t num_components
;
915 int const_index
[NIR_INTRINSIC_MAX_CONST_INDEX
];
917 nir_deref_var
*variables
[2];
920 } nir_intrinsic_instr
;
923 * \name NIR intrinsics semantic flags
925 * information about what the compiler can do with the intrinsics.
927 * \sa nir_intrinsic_info::flags
931 * whether the intrinsic can be safely eliminated if none of its output
932 * value is not being used.
934 NIR_INTRINSIC_CAN_ELIMINATE
= (1 << 0),
937 * Whether the intrinsic can be reordered with respect to any other
938 * intrinsic, i.e. whether the only reordering dependencies of the
939 * intrinsic are due to the register reads/writes.
941 NIR_INTRINSIC_CAN_REORDER
= (1 << 1),
942 } nir_intrinsic_semantic_flag
;
945 * \name NIR intrinsics const-index flag
947 * Indicates the usage of a const_index slot.
949 * \sa nir_intrinsic_info::index_map
953 * Generally instructions that take a offset src argument, can encode
954 * a constant 'base' value which is added to the offset.
956 NIR_INTRINSIC_BASE
= 1,
959 * For store instructions, a writemask for the store.
961 NIR_INTRINSIC_WRMASK
= 2,
964 * The stream-id for GS emit_vertex/end_primitive intrinsics.
966 NIR_INTRINSIC_STREAM_ID
= 3,
969 * The clip-plane id for load_user_clip_plane intrinsic.
971 NIR_INTRINSIC_UCP_ID
= 4,
974 * The amount of data, starting from BASE, that this instruction may
975 * access. This is used to provide bounds if the offset is not constant.
977 NIR_INTRINSIC_RANGE
= 5,
980 * The Vulkan descriptor set for vulkan_resource_index intrinsic.
982 NIR_INTRINSIC_DESC_SET
= 6,
985 * The Vulkan descriptor set binding for vulkan_resource_index intrinsic.
987 NIR_INTRINSIC_BINDING
= 7,
989 NIR_INTRINSIC_NUM_INDEX_FLAGS
,
991 } nir_intrinsic_index_flag
;
993 #define NIR_INTRINSIC_MAX_INPUTS 4
998 unsigned num_srcs
; /** < number of register/SSA inputs */
1000 /** number of components of each input register
1002 * If this value is 0, the number of components is given by the
1003 * num_components field of nir_intrinsic_instr.
1005 unsigned src_components
[NIR_INTRINSIC_MAX_INPUTS
];
1009 /** number of components of the output register
1011 * If this value is 0, the number of components is given by the
1012 * num_components field of nir_intrinsic_instr.
1014 unsigned dest_components
;
1016 /** the number of inputs/outputs that are variables */
1017 unsigned num_variables
;
1019 /** the number of constant indices used by the intrinsic */
1020 unsigned num_indices
;
1022 /** indicates the usage of intr->const_index[n] */
1023 unsigned index_map
[NIR_INTRINSIC_NUM_INDEX_FLAGS
];
1025 /** semantic flags for calls to this intrinsic */
1026 nir_intrinsic_semantic_flag flags
;
1027 } nir_intrinsic_info
;
1029 extern const nir_intrinsic_info nir_intrinsic_infos
[nir_num_intrinsics
];
1032 #define INTRINSIC_IDX_ACCESSORS(name, flag, type) \
1033 static inline type \
1034 nir_intrinsic_##name(nir_intrinsic_instr *instr) \
1036 const nir_intrinsic_info *info = &nir_intrinsic_infos[instr->intrinsic]; \
1037 assert(info->index_map[NIR_INTRINSIC_##flag] > 0); \
1038 return instr->const_index[info->index_map[NIR_INTRINSIC_##flag] - 1]; \
1040 static inline void \
1041 nir_intrinsic_set_##name(nir_intrinsic_instr *instr, type val) \
1043 const nir_intrinsic_info *info = &nir_intrinsic_infos[instr->intrinsic]; \
1044 assert(info->index_map[NIR_INTRINSIC_##flag] > 0); \
1045 instr->const_index[info->index_map[NIR_INTRINSIC_##flag] - 1] = val; \
1048 INTRINSIC_IDX_ACCESSORS(write_mask
, WRMASK
, unsigned)
1049 INTRINSIC_IDX_ACCESSORS(base
, BASE
, int)
1050 INTRINSIC_IDX_ACCESSORS(stream_id
, STREAM_ID
, unsigned)
1051 INTRINSIC_IDX_ACCESSORS(ucp_id
, UCP_ID
, unsigned)
1052 INTRINSIC_IDX_ACCESSORS(range
, RANGE
, unsigned)
1053 INTRINSIC_IDX_ACCESSORS(desc_set
, DESC_SET
, unsigned)
1054 INTRINSIC_IDX_ACCESSORS(binding
, BINDING
, unsigned)
1057 * \group texture information
1059 * This gives semantic information about textures which is useful to the
1060 * frontend, the backend, and lowering passes, but not the optimizer.
1065 nir_tex_src_projector
,
1066 nir_tex_src_comparitor
, /* shadow comparitor */
1070 nir_tex_src_ms_index
, /* MSAA sample index */
1073 nir_tex_src_texture_offset
, /* < dynamically uniform indirect offset */
1074 nir_tex_src_sampler_offset
, /* < dynamically uniform indirect offset */
1075 nir_num_tex_src_types
1080 nir_tex_src_type src_type
;
1084 nir_texop_tex
, /**< Regular texture look-up */
1085 nir_texop_txb
, /**< Texture look-up with LOD bias */
1086 nir_texop_txl
, /**< Texture look-up with explicit LOD */
1087 nir_texop_txd
, /**< Texture look-up with partial derivatvies */
1088 nir_texop_txf
, /**< Texel fetch with explicit LOD */
1089 nir_texop_txf_ms
, /**< Multisample texture fetch */
1090 nir_texop_txs
, /**< Texture size */
1091 nir_texop_lod
, /**< Texture lod query */
1092 nir_texop_tg4
, /**< Texture gather */
1093 nir_texop_query_levels
, /**< Texture levels query */
1094 nir_texop_texture_samples
, /**< Texture samples query */
1095 nir_texop_samples_identical
, /**< Query whether all samples are definitely
1103 enum glsl_sampler_dim sampler_dim
;
1104 nir_alu_type dest_type
;
1109 unsigned num_srcs
, coord_components
;
1110 bool is_array
, is_shadow
;
1113 * If is_shadow is true, whether this is the old-style shadow that outputs 4
1114 * components or the new-style shadow that outputs 1 component.
1116 bool is_new_style_shadow
;
1118 /* gather component selector */
1119 unsigned component
: 2;
1121 /** The texture index
1123 * If this texture instruction has a nir_tex_src_texture_offset source,
1124 * then the texture index is given by texture_index + texture_offset.
1126 unsigned texture_index
;
1128 /** The size of the texture array or 0 if it's not an array */
1129 unsigned texture_array_size
;
1131 /** The texture deref
1133 * If this is null, use texture_index instead.
1135 nir_deref_var
*texture
;
1137 /** The sampler index
1139 * The following operations do not require a sampler and, as such, this
1140 * field should be ignored:
1142 * - nir_texop_txf_ms
1146 * - nir_texop_query_levels
1147 * - nir_texop_texture_samples
1148 * - nir_texop_samples_identical
1150 * If this texture instruction has a nir_tex_src_sampler_offset source,
1151 * then the sampler index is given by sampler_index + sampler_offset.
1153 unsigned sampler_index
;
1155 /** The sampler deref
1157 * If this is null, use sampler_index instead.
1159 nir_deref_var
*sampler
;
1162 static inline unsigned
1163 nir_tex_instr_dest_size(nir_tex_instr
*instr
)
1165 switch (instr
->op
) {
1166 case nir_texop_txs
: {
1168 switch (instr
->sampler_dim
) {
1169 case GLSL_SAMPLER_DIM_1D
:
1170 case GLSL_SAMPLER_DIM_BUF
:
1173 case GLSL_SAMPLER_DIM_2D
:
1174 case GLSL_SAMPLER_DIM_CUBE
:
1175 case GLSL_SAMPLER_DIM_MS
:
1176 case GLSL_SAMPLER_DIM_RECT
:
1177 case GLSL_SAMPLER_DIM_EXTERNAL
:
1180 case GLSL_SAMPLER_DIM_3D
:
1184 unreachable("not reached");
1186 if (instr
->is_array
)
1194 case nir_texop_texture_samples
:
1195 case nir_texop_query_levels
:
1196 case nir_texop_samples_identical
:
1200 if (instr
->is_shadow
&& instr
->is_new_style_shadow
)
1207 /* Returns true if this texture operation queries something about the texture
1208 * rather than actually sampling it.
1211 nir_tex_instr_is_query(nir_tex_instr
*instr
)
1213 switch (instr
->op
) {
1216 case nir_texop_texture_samples
:
1217 case nir_texop_query_levels
:
1224 case nir_texop_txf_ms
:
1228 unreachable("Invalid texture opcode");
1232 static inline unsigned
1233 nir_tex_instr_src_size(nir_tex_instr
*instr
, unsigned src
)
1235 if (instr
->src
[src
].src_type
== nir_tex_src_coord
)
1236 return instr
->coord_components
;
1239 if (instr
->src
[src
].src_type
== nir_tex_src_offset
||
1240 instr
->src
[src
].src_type
== nir_tex_src_ddx
||
1241 instr
->src
[src
].src_type
== nir_tex_src_ddy
) {
1242 if (instr
->is_array
)
1243 return instr
->coord_components
- 1;
1245 return instr
->coord_components
;
1252 nir_tex_instr_src_index(nir_tex_instr
*instr
, nir_tex_src_type type
)
1254 for (unsigned i
= 0; i
< instr
->num_srcs
; i
++)
1255 if (instr
->src
[i
].src_type
== type
)
1275 nir_const_value value
;
1278 } nir_load_const_instr
;
1291 /* creates a new SSA variable in an undefined state */
1296 } nir_ssa_undef_instr
;
1299 struct exec_node node
;
1301 /* The predecessor block corresponding to this source */
1302 struct nir_block
*pred
;
1307 #define nir_foreach_phi_src(phi, entry) \
1308 foreach_list_typed(nir_phi_src, entry, node, &(phi)->srcs)
1309 #define nir_foreach_phi_src_safe(phi, entry) \
1310 foreach_list_typed_safe(nir_phi_src, entry, node, &(phi)->srcs)
1315 struct exec_list srcs
; /** < list of nir_phi_src */
1321 struct exec_node node
;
1324 } nir_parallel_copy_entry
;
1326 #define nir_foreach_parallel_copy_entry(pcopy, entry) \
1327 foreach_list_typed(nir_parallel_copy_entry, entry, node, &(pcopy)->entries)
1332 /* A list of nir_parallel_copy_entry's. The sources of all of the
1333 * entries are copied to the corresponding destinations "in parallel".
1334 * In other words, if we have two entries: a -> b and b -> a, the values
1337 struct exec_list entries
;
1338 } nir_parallel_copy_instr
;
1340 NIR_DEFINE_CAST(nir_instr_as_alu
, nir_instr
, nir_alu_instr
, instr
)
1341 NIR_DEFINE_CAST(nir_instr_as_call
, nir_instr
, nir_call_instr
, instr
)
1342 NIR_DEFINE_CAST(nir_instr_as_jump
, nir_instr
, nir_jump_instr
, instr
)
1343 NIR_DEFINE_CAST(nir_instr_as_tex
, nir_instr
, nir_tex_instr
, instr
)
1344 NIR_DEFINE_CAST(nir_instr_as_intrinsic
, nir_instr
, nir_intrinsic_instr
, instr
)
1345 NIR_DEFINE_CAST(nir_instr_as_load_const
, nir_instr
, nir_load_const_instr
, instr
)
1346 NIR_DEFINE_CAST(nir_instr_as_ssa_undef
, nir_instr
, nir_ssa_undef_instr
, instr
)
1347 NIR_DEFINE_CAST(nir_instr_as_phi
, nir_instr
, nir_phi_instr
, instr
)
1348 NIR_DEFINE_CAST(nir_instr_as_parallel_copy
, nir_instr
,
1349 nir_parallel_copy_instr
, instr
)
1354 * Control flow consists of a tree of control flow nodes, which include
1355 * if-statements and loops. The leaves of the tree are basic blocks, lists of
1356 * instructions that always run start-to-finish. Each basic block also keeps
1357 * track of its successors (blocks which may run immediately after the current
1358 * block) and predecessors (blocks which could have run immediately before the
1359 * current block). Each function also has a start block and an end block which
1360 * all return statements point to (which is always empty). Together, all the
1361 * blocks with their predecessors and successors make up the control flow
1362 * graph (CFG) of the function. There are helpers that modify the tree of
1363 * control flow nodes while modifying the CFG appropriately; these should be
1364 * used instead of modifying the tree directly.
1371 nir_cf_node_function
1374 typedef struct nir_cf_node
{
1375 struct exec_node node
;
1376 nir_cf_node_type type
;
1377 struct nir_cf_node
*parent
;
1380 typedef struct nir_block
{
1381 nir_cf_node cf_node
;
1383 struct exec_list instr_list
; /** < list of nir_instr */
1385 /** generic block index; generated by nir_index_blocks */
1389 * Each block can only have up to 2 successors, so we put them in a simple
1390 * array - no need for anything more complicated.
1392 struct nir_block
*successors
[2];
1394 /* Set of nir_block predecessors in the CFG */
1395 struct set
*predecessors
;
1398 * this node's immediate dominator in the dominance tree - set to NULL for
1401 struct nir_block
*imm_dom
;
1403 /* This node's children in the dominance tree */
1404 unsigned num_dom_children
;
1405 struct nir_block
**dom_children
;
1407 /* Set of nir_block's on the dominance frontier of this block */
1408 struct set
*dom_frontier
;
1411 * These two indices have the property that dom_{pre,post}_index for each
1412 * child of this block in the dominance tree will always be between
1413 * dom_pre_index and dom_post_index for this block, which makes testing if
1414 * a given block is dominated by another block an O(1) operation.
1416 unsigned dom_pre_index
, dom_post_index
;
1418 /* live in and out for this block; used for liveness analysis */
1419 BITSET_WORD
*live_in
;
1420 BITSET_WORD
*live_out
;
1423 static inline nir_instr
*
1424 nir_block_first_instr(nir_block
*block
)
1426 struct exec_node
*head
= exec_list_get_head(&block
->instr_list
);
1427 return exec_node_data(nir_instr
, head
, node
);
1430 static inline nir_instr
*
1431 nir_block_last_instr(nir_block
*block
)
1433 struct exec_node
*tail
= exec_list_get_tail(&block
->instr_list
);
1434 return exec_node_data(nir_instr
, tail
, node
);
1437 #define nir_foreach_instr(block, instr) \
1438 foreach_list_typed(nir_instr, instr, node, &(block)->instr_list)
1439 #define nir_foreach_instr_reverse(block, instr) \
1440 foreach_list_typed_reverse(nir_instr, instr, node, &(block)->instr_list)
1441 #define nir_foreach_instr_safe(block, instr) \
1442 foreach_list_typed_safe(nir_instr, instr, node, &(block)->instr_list)
1443 #define nir_foreach_instr_reverse_safe(block, instr) \
1444 foreach_list_typed_reverse_safe(nir_instr, instr, node, &(block)->instr_list)
1446 typedef struct nir_if
{
1447 nir_cf_node cf_node
;
1450 struct exec_list then_list
; /** < list of nir_cf_node */
1451 struct exec_list else_list
; /** < list of nir_cf_node */
1454 static inline nir_cf_node
*
1455 nir_if_first_then_node(nir_if
*if_stmt
)
1457 struct exec_node
*head
= exec_list_get_head(&if_stmt
->then_list
);
1458 return exec_node_data(nir_cf_node
, head
, node
);
1461 static inline nir_cf_node
*
1462 nir_if_last_then_node(nir_if
*if_stmt
)
1464 struct exec_node
*tail
= exec_list_get_tail(&if_stmt
->then_list
);
1465 return exec_node_data(nir_cf_node
, tail
, node
);
1468 static inline nir_cf_node
*
1469 nir_if_first_else_node(nir_if
*if_stmt
)
1471 struct exec_node
*head
= exec_list_get_head(&if_stmt
->else_list
);
1472 return exec_node_data(nir_cf_node
, head
, node
);
1475 static inline nir_cf_node
*
1476 nir_if_last_else_node(nir_if
*if_stmt
)
1478 struct exec_node
*tail
= exec_list_get_tail(&if_stmt
->else_list
);
1479 return exec_node_data(nir_cf_node
, tail
, node
);
1483 nir_cf_node cf_node
;
1485 struct exec_list body
; /** < list of nir_cf_node */
1488 static inline nir_cf_node
*
1489 nir_loop_first_cf_node(nir_loop
*loop
)
1491 return exec_node_data(nir_cf_node
, exec_list_get_head(&loop
->body
), node
);
1494 static inline nir_cf_node
*
1495 nir_loop_last_cf_node(nir_loop
*loop
)
1497 return exec_node_data(nir_cf_node
, exec_list_get_tail(&loop
->body
), node
);
1501 * Various bits of metadata that can may be created or required by
1502 * optimization and analysis passes
1505 nir_metadata_none
= 0x0,
1506 nir_metadata_block_index
= 0x1,
1507 nir_metadata_dominance
= 0x2,
1508 nir_metadata_live_ssa_defs
= 0x4,
1509 nir_metadata_not_properly_reset
= 0x8,
1513 nir_cf_node cf_node
;
1515 /** pointer to the function of which this is an implementation */
1516 struct nir_function
*function
;
1518 struct exec_list body
; /** < list of nir_cf_node */
1520 nir_block
*end_block
;
1522 /** list for all local variables in the function */
1523 struct exec_list locals
;
1525 /** array of variables used as parameters */
1526 unsigned num_params
;
1527 nir_variable
**params
;
1529 /** variable used to hold the result of the function */
1530 nir_variable
*return_var
;
1532 /** list of local registers in the function */
1533 struct exec_list registers
;
1535 /** next available local register index */
1538 /** next available SSA value index */
1541 /* total number of basic blocks, only valid when block_index_dirty = false */
1542 unsigned num_blocks
;
1544 nir_metadata valid_metadata
;
1545 } nir_function_impl
;
1547 static inline nir_block
*
1548 nir_start_block(nir_function_impl
*impl
)
1550 return (nir_block
*) exec_list_get_head(&impl
->body
);
1553 static inline nir_block
*
1554 nir_impl_last_block(nir_function_impl
*impl
)
1556 return (nir_block
*) exec_list_get_tail(&impl
->body
);
1559 static inline nir_cf_node
*
1560 nir_cf_node_next(nir_cf_node
*node
)
1562 struct exec_node
*next
= exec_node_get_next(&node
->node
);
1563 if (exec_node_is_tail_sentinel(next
))
1566 return exec_node_data(nir_cf_node
, next
, node
);
1569 static inline nir_cf_node
*
1570 nir_cf_node_prev(nir_cf_node
*node
)
1572 struct exec_node
*prev
= exec_node_get_prev(&node
->node
);
1573 if (exec_node_is_head_sentinel(prev
))
1576 return exec_node_data(nir_cf_node
, prev
, node
);
1580 nir_cf_node_is_first(const nir_cf_node
*node
)
1582 return exec_node_is_head_sentinel(node
->node
.prev
);
1586 nir_cf_node_is_last(const nir_cf_node
*node
)
1588 return exec_node_is_tail_sentinel(node
->node
.next
);
1591 NIR_DEFINE_CAST(nir_cf_node_as_block
, nir_cf_node
, nir_block
, cf_node
)
1592 NIR_DEFINE_CAST(nir_cf_node_as_if
, nir_cf_node
, nir_if
, cf_node
)
1593 NIR_DEFINE_CAST(nir_cf_node_as_loop
, nir_cf_node
, nir_loop
, cf_node
)
1594 NIR_DEFINE_CAST(nir_cf_node_as_function
, nir_cf_node
, nir_function_impl
, cf_node
)
1599 nir_parameter_inout
,
1600 } nir_parameter_type
;
1603 nir_parameter_type param_type
;
1604 const struct glsl_type
*type
;
1607 typedef struct nir_function
{
1608 struct exec_node node
;
1611 struct nir_shader
*shader
;
1613 unsigned num_params
;
1614 nir_parameter
*params
;
1615 const struct glsl_type
*return_type
;
1617 /** The implementation of this function.
1619 * If the function is only declared and not implemented, this is NULL.
1621 nir_function_impl
*impl
;
1624 typedef struct nir_shader_compiler_options
{
1632 bool lower_bitfield_extract
;
1633 bool lower_bitfield_insert
;
1634 bool lower_uadd_carry
;
1635 bool lower_usub_borrow
;
1636 /** lowers fneg and ineg to fsub and isub. */
1638 /** lowers fsub and isub to fadd+fneg and iadd+ineg. */
1641 /* lower {slt,sge,seq,sne} to {flt,fge,feq,fne} + b2f: */
1644 /* Does the native fdot instruction replicate its result for four
1645 * components? If so, then opt_algebraic_late will turn all fdotN
1646 * instructions into fdot_replicatedN instructions.
1648 bool fdot_replicates
;
1650 /** lowers ffract to fsub+ffloor: */
1653 bool lower_pack_half_2x16
;
1654 bool lower_pack_unorm_2x16
;
1655 bool lower_pack_snorm_2x16
;
1656 bool lower_pack_unorm_4x8
;
1657 bool lower_pack_snorm_4x8
;
1658 bool lower_unpack_half_2x16
;
1659 bool lower_unpack_unorm_2x16
;
1660 bool lower_unpack_snorm_2x16
;
1661 bool lower_unpack_unorm_4x8
;
1662 bool lower_unpack_snorm_4x8
;
1664 bool lower_extract_byte
;
1665 bool lower_extract_word
;
1668 * Does the driver support real 32-bit integers? (Otherwise, integers
1669 * are simulated by floats.)
1671 bool native_integers
;
1673 /* Indicates that the driver only has zero-based vertex id */
1674 bool vertex_id_zero_based
;
1675 } nir_shader_compiler_options
;
1677 typedef struct nir_shader_info
{
1680 /* Descriptive name provided by the client; may be NULL */
1683 /* Number of textures used by this shader */
1684 unsigned num_textures
;
1685 /* Number of uniform buffers used by this shader */
1687 /* Number of atomic buffers used by this shader */
1689 /* Number of shader storage buffers used by this shader */
1691 /* Number of images used by this shader */
1692 unsigned num_images
;
1694 /* Which inputs are actually read */
1695 uint64_t inputs_read
;
1696 /* Which outputs are actually written */
1697 uint64_t outputs_written
;
1698 /* Which system values are actually read */
1699 uint64_t system_values_read
;
1701 /* Which patch inputs are actually read */
1702 uint32_t patch_inputs_read
;
1703 /* Which patch outputs are actually written */
1704 uint32_t patch_outputs_written
;
1706 /* Whether or not this shader ever uses textureGather() */
1707 bool uses_texture_gather
;
1709 /* Whether or not this shader uses the gl_ClipDistance output */
1710 bool uses_clip_distance_out
;
1712 /* Whether or not separate shader objects were used */
1713 bool separate_shader
;
1715 /** Was this shader linked with any transform feedback varyings? */
1716 bool has_transform_feedback_varyings
;
1720 /** The number of vertices recieves per input primitive */
1721 unsigned vertices_in
;
1723 /** The output primitive type (GL enum value) */
1724 unsigned output_primitive
;
1726 /** The maximum number of vertices the geometry shader might write. */
1727 unsigned vertices_out
;
1729 /** 1 .. MAX_GEOMETRY_SHADER_INVOCATIONS */
1730 unsigned invocations
;
1732 /** Whether or not this shader uses EndPrimitive */
1733 bool uses_end_primitive
;
1735 /** Whether or not this shader uses non-zero streams */
1743 * Whether early fragment tests are enabled as defined by
1744 * ARB_shader_image_load_store.
1746 bool early_fragment_tests
;
1748 /** gl_FragDepth layout for ARB_conservative_depth. */
1749 enum gl_frag_depth_layout depth_layout
;
1753 unsigned local_size
[3];
1757 /** The number of vertices in the TCS output patch. */
1758 unsigned vertices_out
;
1763 typedef struct nir_shader
{
1764 /** list of uniforms (nir_variable) */
1765 struct exec_list uniforms
;
1767 /** list of inputs (nir_variable) */
1768 struct exec_list inputs
;
1770 /** list of outputs (nir_variable) */
1771 struct exec_list outputs
;
1773 /** list of shared compute variables (nir_variable) */
1774 struct exec_list shared
;
1776 /** Set of driver-specific options for the shader.
1778 * The memory for the options is expected to be kept in a single static
1779 * copy by the driver.
1781 const struct nir_shader_compiler_options
*options
;
1783 /** Various bits of compile-time information about a given shader */
1784 struct nir_shader_info info
;
1786 /** list of global variables in the shader (nir_variable) */
1787 struct exec_list globals
;
1789 /** list of system value variables in the shader (nir_variable) */
1790 struct exec_list system_values
;
1792 struct exec_list functions
; /** < list of nir_function */
1794 /** list of global register in the shader */
1795 struct exec_list registers
;
1797 /** next available global register index */
1801 * the highest index a load_input_*, load_uniform_*, etc. intrinsic can
1804 unsigned num_inputs
, num_uniforms
, num_outputs
, num_shared
;
1806 /** The shader stage, such as MESA_SHADER_VERTEX. */
1807 gl_shader_stage stage
;
1810 static inline nir_function
*
1811 nir_shader_get_entrypoint(nir_shader
*shader
)
1813 assert(exec_list_length(&shader
->functions
) == 1);
1814 struct exec_node
*func_node
= exec_list_get_head(&shader
->functions
);
1815 nir_function
*func
= exec_node_data(nir_function
, func_node
, node
);
1816 assert(func
->return_type
== glsl_void_type());
1817 assert(func
->num_params
== 0);
1821 #define nir_foreach_function(shader, func) \
1822 foreach_list_typed(nir_function, func, node, &(shader)->functions)
1824 nir_shader
*nir_shader_create(void *mem_ctx
,
1825 gl_shader_stage stage
,
1826 const nir_shader_compiler_options
*options
);
1828 /** creates a register, including assigning it an index and adding it to the list */
1829 nir_register
*nir_global_reg_create(nir_shader
*shader
);
1831 nir_register
*nir_local_reg_create(nir_function_impl
*impl
);
1833 void nir_reg_remove(nir_register
*reg
);
1835 /** Adds a variable to the appropreate list in nir_shader */
1836 void nir_shader_add_variable(nir_shader
*shader
, nir_variable
*var
);
1839 nir_function_impl_add_variable(nir_function_impl
*impl
, nir_variable
*var
)
1841 assert(var
->data
.mode
== nir_var_local
);
1842 exec_list_push_tail(&impl
->locals
, &var
->node
);
1845 /** creates a variable, sets a few defaults, and adds it to the list */
1846 nir_variable
*nir_variable_create(nir_shader
*shader
,
1847 nir_variable_mode mode
,
1848 const struct glsl_type
*type
,
1850 /** creates a local variable and adds it to the list */
1851 nir_variable
*nir_local_variable_create(nir_function_impl
*impl
,
1852 const struct glsl_type
*type
,
1855 /** creates a function and adds it to the shader's list of functions */
1856 nir_function
*nir_function_create(nir_shader
*shader
, const char *name
);
1858 nir_function_impl
*nir_function_impl_create(nir_function
*func
);
1859 /** creates a function_impl that isn't tied to any particular function */
1860 nir_function_impl
*nir_function_impl_create_bare(nir_shader
*shader
);
1862 nir_block
*nir_block_create(nir_shader
*shader
);
1863 nir_if
*nir_if_create(nir_shader
*shader
);
1864 nir_loop
*nir_loop_create(nir_shader
*shader
);
1866 nir_function_impl
*nir_cf_node_get_function(nir_cf_node
*node
);
1868 /** requests that the given pieces of metadata be generated */
1869 void nir_metadata_require(nir_function_impl
*impl
, nir_metadata required
);
1870 /** dirties all but the preserved metadata */
1871 void nir_metadata_preserve(nir_function_impl
*impl
, nir_metadata preserved
);
1873 /** creates an instruction with default swizzle/writemask/etc. with NULL registers */
1874 nir_alu_instr
*nir_alu_instr_create(nir_shader
*shader
, nir_op op
);
1876 nir_jump_instr
*nir_jump_instr_create(nir_shader
*shader
, nir_jump_type type
);
1878 nir_load_const_instr
*nir_load_const_instr_create(nir_shader
*shader
,
1879 unsigned num_components
,
1882 nir_intrinsic_instr
*nir_intrinsic_instr_create(nir_shader
*shader
,
1883 nir_intrinsic_op op
);
1885 nir_call_instr
*nir_call_instr_create(nir_shader
*shader
,
1886 nir_function
*callee
);
1888 nir_tex_instr
*nir_tex_instr_create(nir_shader
*shader
, unsigned num_srcs
);
1890 nir_phi_instr
*nir_phi_instr_create(nir_shader
*shader
);
1892 nir_parallel_copy_instr
*nir_parallel_copy_instr_create(nir_shader
*shader
);
1894 nir_ssa_undef_instr
*nir_ssa_undef_instr_create(nir_shader
*shader
,
1895 unsigned num_components
,
1898 nir_deref_var
*nir_deref_var_create(void *mem_ctx
, nir_variable
*var
);
1899 nir_deref_array
*nir_deref_array_create(void *mem_ctx
);
1900 nir_deref_struct
*nir_deref_struct_create(void *mem_ctx
, unsigned field_index
);
1902 nir_deref
*nir_copy_deref(void *mem_ctx
, nir_deref
*deref
);
1904 nir_load_const_instr
*
1905 nir_deref_get_const_initializer_load(nir_shader
*shader
, nir_deref_var
*deref
);
1908 * NIR Cursors and Instruction Insertion API
1911 * A tiny struct representing a point to insert/extract instructions or
1912 * control flow nodes. Helps reduce the combinatorial explosion of possible
1913 * points to insert/extract.
1915 * \sa nir_control_flow.h
1918 nir_cursor_before_block
,
1919 nir_cursor_after_block
,
1920 nir_cursor_before_instr
,
1921 nir_cursor_after_instr
,
1922 } nir_cursor_option
;
1925 nir_cursor_option option
;
1932 static inline nir_block
*
1933 nir_cursor_current_block(nir_cursor cursor
)
1935 if (cursor
.option
== nir_cursor_before_instr
||
1936 cursor
.option
== nir_cursor_after_instr
) {
1937 return cursor
.instr
->block
;
1939 return cursor
.block
;
1943 bool nir_cursors_equal(nir_cursor a
, nir_cursor b
);
1945 static inline nir_cursor
1946 nir_before_block(nir_block
*block
)
1949 cursor
.option
= nir_cursor_before_block
;
1950 cursor
.block
= block
;
1954 static inline nir_cursor
1955 nir_after_block(nir_block
*block
)
1958 cursor
.option
= nir_cursor_after_block
;
1959 cursor
.block
= block
;
1963 static inline nir_cursor
1964 nir_before_instr(nir_instr
*instr
)
1967 cursor
.option
= nir_cursor_before_instr
;
1968 cursor
.instr
= instr
;
1972 static inline nir_cursor
1973 nir_after_instr(nir_instr
*instr
)
1976 cursor
.option
= nir_cursor_after_instr
;
1977 cursor
.instr
= instr
;
1981 static inline nir_cursor
1982 nir_after_block_before_jump(nir_block
*block
)
1984 nir_instr
*last_instr
= nir_block_last_instr(block
);
1985 if (last_instr
&& last_instr
->type
== nir_instr_type_jump
) {
1986 return nir_before_instr(last_instr
);
1988 return nir_after_block(block
);
1992 static inline nir_cursor
1993 nir_before_cf_node(nir_cf_node
*node
)
1995 if (node
->type
== nir_cf_node_block
)
1996 return nir_before_block(nir_cf_node_as_block(node
));
1998 return nir_after_block(nir_cf_node_as_block(nir_cf_node_prev(node
)));
2001 static inline nir_cursor
2002 nir_after_cf_node(nir_cf_node
*node
)
2004 if (node
->type
== nir_cf_node_block
)
2005 return nir_after_block(nir_cf_node_as_block(node
));
2007 return nir_before_block(nir_cf_node_as_block(nir_cf_node_next(node
)));
2010 static inline nir_cursor
2011 nir_after_cf_node_and_phis(nir_cf_node
*node
)
2013 if (node
->type
== nir_cf_node_block
)
2014 return nir_after_block(nir_cf_node_as_block(node
));
2016 nir_block
*block
= nir_cf_node_as_block(nir_cf_node_next(node
));
2017 assert(block
->cf_node
.type
== nir_cf_node_block
);
2019 nir_foreach_instr(block
, instr
) {
2020 if (instr
->type
!= nir_instr_type_phi
)
2021 return nir_before_instr(instr
);
2023 return nir_after_block(block
);
2026 static inline nir_cursor
2027 nir_before_cf_list(struct exec_list
*cf_list
)
2029 nir_cf_node
*first_node
= exec_node_data(nir_cf_node
,
2030 exec_list_get_head(cf_list
), node
);
2031 return nir_before_cf_node(first_node
);
2034 static inline nir_cursor
2035 nir_after_cf_list(struct exec_list
*cf_list
)
2037 nir_cf_node
*last_node
= exec_node_data(nir_cf_node
,
2038 exec_list_get_tail(cf_list
), node
);
2039 return nir_after_cf_node(last_node
);
2043 * Insert a NIR instruction at the given cursor.
2045 * Note: This does not update the cursor.
2047 void nir_instr_insert(nir_cursor cursor
, nir_instr
*instr
);
2050 nir_instr_insert_before(nir_instr
*instr
, nir_instr
*before
)
2052 nir_instr_insert(nir_before_instr(instr
), before
);
2056 nir_instr_insert_after(nir_instr
*instr
, nir_instr
*after
)
2058 nir_instr_insert(nir_after_instr(instr
), after
);
2062 nir_instr_insert_before_block(nir_block
*block
, nir_instr
*before
)
2064 nir_instr_insert(nir_before_block(block
), before
);
2068 nir_instr_insert_after_block(nir_block
*block
, nir_instr
*after
)
2070 nir_instr_insert(nir_after_block(block
), after
);
2074 nir_instr_insert_before_cf(nir_cf_node
*node
, nir_instr
*before
)
2076 nir_instr_insert(nir_before_cf_node(node
), before
);
2080 nir_instr_insert_after_cf(nir_cf_node
*node
, nir_instr
*after
)
2082 nir_instr_insert(nir_after_cf_node(node
), after
);
2086 nir_instr_insert_before_cf_list(struct exec_list
*list
, nir_instr
*before
)
2088 nir_instr_insert(nir_before_cf_list(list
), before
);
2092 nir_instr_insert_after_cf_list(struct exec_list
*list
, nir_instr
*after
)
2094 nir_instr_insert(nir_after_cf_list(list
), after
);
2097 void nir_instr_remove(nir_instr
*instr
);
2101 typedef bool (*nir_foreach_ssa_def_cb
)(nir_ssa_def
*def
, void *state
);
2102 typedef bool (*nir_foreach_dest_cb
)(nir_dest
*dest
, void *state
);
2103 typedef bool (*nir_foreach_src_cb
)(nir_src
*src
, void *state
);
2104 bool nir_foreach_ssa_def(nir_instr
*instr
, nir_foreach_ssa_def_cb cb
,
2106 bool nir_foreach_dest(nir_instr
*instr
, nir_foreach_dest_cb cb
, void *state
);
2107 bool nir_foreach_src(nir_instr
*instr
, nir_foreach_src_cb cb
, void *state
);
2109 nir_const_value
*nir_src_as_const_value(nir_src src
);
2110 bool nir_src_is_dynamically_uniform(nir_src src
);
2111 bool nir_srcs_equal(nir_src src1
, nir_src src2
);
2112 void nir_instr_rewrite_src(nir_instr
*instr
, nir_src
*src
, nir_src new_src
);
2113 void nir_instr_move_src(nir_instr
*dest_instr
, nir_src
*dest
, nir_src
*src
);
2114 void nir_if_rewrite_condition(nir_if
*if_stmt
, nir_src new_src
);
2115 void nir_instr_rewrite_dest(nir_instr
*instr
, nir_dest
*dest
,
2118 void nir_ssa_dest_init(nir_instr
*instr
, nir_dest
*dest
,
2119 unsigned num_components
, unsigned bit_size
,
2121 void nir_ssa_def_init(nir_instr
*instr
, nir_ssa_def
*def
,
2122 unsigned num_components
, unsigned bit_size
,
2124 void nir_ssa_def_rewrite_uses(nir_ssa_def
*def
, nir_src new_src
);
2125 void nir_ssa_def_rewrite_uses_after(nir_ssa_def
*def
, nir_src new_src
,
2126 nir_instr
*after_me
);
2128 uint8_t nir_ssa_def_components_read(nir_ssa_def
*def
);
2131 * finds the next basic block in source-code order, returns NULL if there is
2135 nir_block
*nir_block_cf_tree_next(nir_block
*block
);
2137 /* Performs the opposite of nir_block_cf_tree_next() */
2139 nir_block
*nir_block_cf_tree_prev(nir_block
*block
);
2141 /* Gets the first block in a CF node in source-code order */
2143 nir_block
*nir_cf_node_cf_tree_first(nir_cf_node
*node
);
2145 /* Gets the last block in a CF node in source-code order */
2147 nir_block
*nir_cf_node_cf_tree_last(nir_cf_node
*node
);
2149 /* Gets the next block after a CF node in source-code order */
2151 nir_block
*nir_cf_node_cf_tree_next(nir_cf_node
*node
);
2153 /* Macros for loops that visit blocks in source-code order */
2155 #define nir_foreach_block(block, impl) \
2156 for (nir_block *block = nir_start_block(impl); block != NULL; \
2157 block = nir_block_cf_tree_next(block))
2159 #define nir_foreach_block_safe(block, impl) \
2160 for (nir_block *block = nir_start_block(impl), \
2161 *next = nir_block_cf_tree_next(block); \
2163 block = next, next = nir_block_cf_tree_next(block))
2165 #define nir_foreach_block_reverse(block, impl) \
2166 for (nir_block *block = nir_impl_last_block(impl); block != NULL; \
2167 block = nir_block_cf_tree_prev(block))
2169 #define nir_foreach_block_reverse_safe(block, impl) \
2170 for (nir_block *block = nir_impl_last_block(impl), \
2171 *prev = nir_block_cf_tree_prev(block); \
2173 block = prev, prev = nir_block_cf_tree_prev(block))
2175 #define nir_foreach_block_in_cf_node(block, node) \
2176 for (nir_block *block = nir_cf_node_cf_tree_first(node); \
2177 block != nir_cf_node_cf_tree_next(node); \
2178 block = nir_block_cf_tree_next(block))
2180 typedef bool (*nir_foreach_block_cb
)(nir_block
*block
, void *state
);
2183 nir_foreach_block_call(nir_function_impl
*impl
, nir_foreach_block_cb cb
,
2186 nir_foreach_block_safe(block
, impl
) {
2187 if (!cb(block
, state
))
2195 nir_foreach_block_reverse_call(nir_function_impl
*impl
, nir_foreach_block_cb cb
,
2198 nir_foreach_block_reverse_safe(block
, impl
) {
2199 if (!cb(block
, state
))
2207 nir_foreach_block_in_cf_node_call(nir_cf_node
*node
, nir_foreach_block_cb cb
,
2210 nir_foreach_block_in_cf_node(block
, node
) {
2211 if (!cb(block
, state
))
2218 /* If the following CF node is an if, this function returns that if.
2219 * Otherwise, it returns NULL.
2221 nir_if
*nir_block_get_following_if(nir_block
*block
);
2223 nir_loop
*nir_block_get_following_loop(nir_block
*block
);
2225 void nir_index_local_regs(nir_function_impl
*impl
);
2226 void nir_index_global_regs(nir_shader
*shader
);
2227 void nir_index_ssa_defs(nir_function_impl
*impl
);
2228 unsigned nir_index_instrs(nir_function_impl
*impl
);
2230 void nir_index_blocks(nir_function_impl
*impl
);
2232 void nir_print_shader(nir_shader
*shader
, FILE *fp
);
2233 void nir_print_instr(const nir_instr
*instr
, FILE *fp
);
2235 nir_shader
*nir_shader_clone(void *mem_ctx
, const nir_shader
*s
);
2236 nir_function_impl
*nir_function_impl_clone(const nir_function_impl
*fi
);
2237 nir_constant
*nir_constant_clone(const nir_constant
*c
, nir_variable
*var
);
2238 nir_variable
*nir_variable_clone(const nir_variable
*c
, nir_shader
*shader
);
2241 void nir_validate_shader(nir_shader
*shader
);
2242 void nir_metadata_set_validation_flag(nir_shader
*shader
);
2243 void nir_metadata_check_validation_flag(nir_shader
*shader
);
2245 #include "util/debug.h"
2247 should_clone_nir(void)
2249 static int should_clone
= -1;
2250 if (should_clone
< 0)
2251 should_clone
= env_var_as_boolean("NIR_TEST_CLONE", false);
2253 return should_clone
;
2256 static inline void nir_validate_shader(nir_shader
*shader
) { (void) shader
; }
2257 static inline void nir_metadata_set_validation_flag(nir_shader
*shader
) { (void) shader
; }
2258 static inline void nir_metadata_check_validation_flag(nir_shader
*shader
) { (void) shader
; }
2259 static inline bool should_clone_nir(void) { return false; }
2262 #define _PASS(nir, do_pass) do { \
2264 nir_validate_shader(nir); \
2265 if (should_clone_nir()) { \
2266 nir_shader *clone = nir_shader_clone(ralloc_parent(nir), nir); \
2272 #define NIR_PASS(progress, nir, pass, ...) _PASS(nir, \
2273 nir_metadata_set_validation_flag(nir); \
2274 if (pass(nir, ##__VA_ARGS__)) { \
2276 nir_metadata_check_validation_flag(nir); \
2280 #define NIR_PASS_V(nir, pass, ...) _PASS(nir, \
2281 pass(nir, ##__VA_ARGS__); \
2284 void nir_calc_dominance_impl(nir_function_impl
*impl
);
2285 void nir_calc_dominance(nir_shader
*shader
);
2287 nir_block
*nir_dominance_lca(nir_block
*b1
, nir_block
*b2
);
2288 bool nir_block_dominates(nir_block
*parent
, nir_block
*child
);
2290 void nir_dump_dom_tree_impl(nir_function_impl
*impl
, FILE *fp
);
2291 void nir_dump_dom_tree(nir_shader
*shader
, FILE *fp
);
2293 void nir_dump_dom_frontier_impl(nir_function_impl
*impl
, FILE *fp
);
2294 void nir_dump_dom_frontier(nir_shader
*shader
, FILE *fp
);
2296 void nir_dump_cfg_impl(nir_function_impl
*impl
, FILE *fp
);
2297 void nir_dump_cfg(nir_shader
*shader
, FILE *fp
);
2299 int nir_gs_count_vertices(const nir_shader
*shader
);
2301 bool nir_split_var_copies(nir_shader
*shader
);
2303 bool nir_lower_returns_impl(nir_function_impl
*impl
);
2304 bool nir_lower_returns(nir_shader
*shader
);
2306 bool nir_inline_functions(nir_shader
*shader
);
2308 void nir_lower_var_copy_instr(nir_intrinsic_instr
*copy
, void *mem_ctx
);
2309 void nir_lower_var_copies(nir_shader
*shader
);
2311 bool nir_lower_global_vars_to_local(nir_shader
*shader
);
2313 bool nir_lower_indirect_derefs(nir_shader
*shader
, nir_variable_mode modes
);
2315 bool nir_lower_locals_to_regs(nir_shader
*shader
);
2317 void nir_lower_outputs_to_temporaries(nir_shader
*shader
,
2318 nir_function
*entrypoint
);
2319 void nir_shader_gather_info(nir_shader
*shader
, nir_function_impl
*entrypoint
);
2321 void nir_assign_var_locations(struct exec_list
*var_list
,
2323 int (*type_size
)(const struct glsl_type
*));
2325 void nir_lower_io(nir_shader
*shader
,
2326 nir_variable_mode modes
,
2327 int (*type_size
)(const struct glsl_type
*));
2328 nir_src
*nir_get_io_offset_src(nir_intrinsic_instr
*instr
);
2329 nir_src
*nir_get_io_vertex_index_src(nir_intrinsic_instr
*instr
);
2331 void nir_lower_vars_to_ssa(nir_shader
*shader
);
2333 bool nir_remove_dead_variables(nir_shader
*shader
, nir_variable_mode modes
);
2335 void nir_move_vec_src_uses_to_dest(nir_shader
*shader
);
2336 bool nir_lower_vec_to_movs(nir_shader
*shader
);
2337 void nir_lower_alu_to_scalar(nir_shader
*shader
);
2338 void nir_lower_load_const_to_scalar(nir_shader
*shader
);
2340 void nir_lower_phis_to_scalar(nir_shader
*shader
);
2342 void nir_lower_samplers(nir_shader
*shader
,
2343 const struct gl_shader_program
*shader_program
);
2345 bool nir_lower_system_values(nir_shader
*shader
);
2347 typedef struct nir_lower_tex_options
{
2349 * bitmask of (1 << GLSL_SAMPLER_DIM_x) to control for which
2350 * sampler types a texture projector is lowered.
2355 * If true, lower rect textures to 2D, using txs to fetch the
2356 * texture dimensions and dividing the texture coords by the
2357 * texture dims to normalize.
2362 * To emulate certain texture wrap modes, this can be used
2363 * to saturate the specified tex coord to [0.0, 1.0]. The
2364 * bits are according to sampler #, ie. if, for example:
2366 * (conf->saturate_s & (1 << n))
2368 * is true, then the s coord for sampler n is saturated.
2370 * Note that clamping must happen *after* projector lowering
2371 * so any projected texture sample instruction with a clamped
2372 * coordinate gets automatically lowered, regardless of the
2373 * 'lower_txp' setting.
2375 unsigned saturate_s
;
2376 unsigned saturate_t
;
2377 unsigned saturate_r
;
2379 /* Bitmask of textures that need swizzling.
2381 * If (swizzle_result & (1 << texture_index)), then the swizzle in
2382 * swizzles[texture_index] is applied to the result of the texturing
2385 unsigned swizzle_result
;
2387 /* A swizzle for each texture. Values 0-3 represent x, y, z, or w swizzles
2388 * while 4 and 5 represent 0 and 1 respectively.
2390 uint8_t swizzles
[32][4];
2393 * Bitmap of textures that need srgb to linear conversion. If
2394 * (lower_srgb & (1 << texture_index)) then the rgb (xyz) components
2395 * of the texture are lowered to linear.
2397 unsigned lower_srgb
;
2398 } nir_lower_tex_options
;
2400 bool nir_lower_tex(nir_shader
*shader
,
2401 const nir_lower_tex_options
*options
);
2403 void nir_lower_idiv(nir_shader
*shader
);
2405 void nir_lower_clip_vs(nir_shader
*shader
, unsigned ucp_enables
);
2406 void nir_lower_clip_fs(nir_shader
*shader
, unsigned ucp_enables
);
2408 void nir_lower_two_sided_color(nir_shader
*shader
);
2410 void nir_lower_atomics(nir_shader
*shader
,
2411 const struct gl_shader_program
*shader_program
);
2412 void nir_lower_to_source_mods(nir_shader
*shader
);
2414 bool nir_lower_gs_intrinsics(nir_shader
*shader
);
2417 nir_lower_drcp
= (1 << 0),
2418 nir_lower_dsqrt
= (1 << 1),
2419 nir_lower_drsq
= (1 << 2),
2420 nir_lower_dtrunc
= (1 << 3),
2421 nir_lower_dfloor
= (1 << 4),
2422 nir_lower_dceil
= (1 << 5),
2423 } nir_lower_doubles_options
;
2425 void nir_lower_doubles(nir_shader
*shader
, nir_lower_doubles_options options
);
2426 void nir_lower_double_pack(nir_shader
*shader
);
2428 bool nir_normalize_cubemap_coords(nir_shader
*shader
);
2430 void nir_live_ssa_defs_impl(nir_function_impl
*impl
);
2431 bool nir_ssa_defs_interfere(nir_ssa_def
*a
, nir_ssa_def
*b
);
2433 void nir_convert_to_ssa_impl(nir_function_impl
*impl
);
2434 void nir_convert_to_ssa(nir_shader
*shader
);
2436 bool nir_repair_ssa_impl(nir_function_impl
*impl
);
2437 bool nir_repair_ssa(nir_shader
*shader
);
2439 /* If phi_webs_only is true, only convert SSA values involved in phi nodes to
2440 * registers. If false, convert all values (even those not involved in a phi
2441 * node) to registers.
2443 void nir_convert_from_ssa(nir_shader
*shader
, bool phi_webs_only
);
2445 bool nir_opt_algebraic(nir_shader
*shader
);
2446 bool nir_opt_algebraic_late(nir_shader
*shader
);
2447 bool nir_opt_constant_folding(nir_shader
*shader
);
2449 bool nir_opt_global_to_local(nir_shader
*shader
);
2451 bool nir_copy_prop(nir_shader
*shader
);
2453 bool nir_opt_cse(nir_shader
*shader
);
2455 bool nir_opt_dce(nir_shader
*shader
);
2457 bool nir_opt_dead_cf(nir_shader
*shader
);
2459 void nir_opt_gcm(nir_shader
*shader
);
2461 bool nir_opt_peephole_select(nir_shader
*shader
);
2463 bool nir_opt_remove_phis(nir_shader
*shader
);
2465 bool nir_opt_undef(nir_shader
*shader
);
2467 void nir_sweep(nir_shader
*shader
);
2469 nir_intrinsic_op
nir_intrinsic_from_system_value(gl_system_value val
);
2470 gl_system_value
nir_system_value_from_intrinsic(nir_intrinsic_op intrin
);