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)
31 #include "util/hash_table.h"
32 #include "compiler/glsl/list.h"
33 #include "GL/gl.h" /* GLenum */
34 #include "util/list.h"
35 #include "util/ralloc.h"
37 #include "util/bitset.h"
38 #include "util/macros.h"
39 #include "compiler/nir_types.h"
40 #include "compiler/shader_enums.h"
41 #include "compiler/shader_info.h"
45 #include "util/debug.h"
48 #include "nir_opcodes.h"
50 #if defined(_WIN32) && !defined(snprintf)
51 #define snprintf _snprintf
59 struct gl_shader_program
;
62 #define NIR_TRUE (~0u)
64 /** Defines a cast function
66 * This macro defines a cast function from in_type to out_type where
67 * out_type is some structure type that contains a field of type out_type.
69 * Note that you have to be a bit careful as the generated cast function
72 #define NIR_DEFINE_CAST(name, in_type, out_type, field, \
73 type_field, type_value) \
74 static inline out_type * \
75 name(const in_type *parent) \
77 assert(parent && parent->type_field == type_value); \
78 return exec_node_data(out_type, parent, field); \
87 * Description of built-in state associated with a uniform
89 * \sa nir_variable::state_slots
92 gl_state_index16 tokens
[STATE_LENGTH
];
97 nir_var_shader_in
= (1 << 0),
98 nir_var_shader_out
= (1 << 1),
99 nir_var_global
= (1 << 2),
100 nir_var_local
= (1 << 3),
101 nir_var_uniform
= (1 << 4),
102 nir_var_shader_storage
= (1 << 5),
103 nir_var_system_value
= (1 << 6),
104 nir_var_param
= (1 << 7),
105 nir_var_shared
= (1 << 8),
113 nir_rounding_mode_undef
= 0,
114 nir_rounding_mode_rtne
= 1, /* round to nearest even */
115 nir_rounding_mode_ru
= 2, /* round up */
116 nir_rounding_mode_rd
= 3, /* round down */
117 nir_rounding_mode_rtz
= 4, /* round towards zero */
133 typedef struct nir_constant
{
135 * Value of the constant.
137 * The field used to back the values supplied by the constant is determined
138 * by the type associated with the \c nir_variable. Constants may be
139 * scalars, vectors, or matrices.
141 nir_const_value values
[4];
143 /* we could get this from the var->type but makes clone *much* easier to
144 * not have to care about the type.
146 unsigned num_elements
;
148 /* Array elements / Structure Fields */
149 struct nir_constant
**elements
;
153 * \brief Layout qualifiers for gl_FragDepth.
155 * The AMD/ARB_conservative_depth extensions allow gl_FragDepth to be redeclared
156 * with a layout qualifier.
159 nir_depth_layout_none
, /**< No depth layout is specified. */
160 nir_depth_layout_any
,
161 nir_depth_layout_greater
,
162 nir_depth_layout_less
,
163 nir_depth_layout_unchanged
167 * Either a uniform, global variable, shader input, or shader output. Based on
168 * ir_variable - it should be easy to translate between the two.
171 typedef struct nir_variable
{
172 struct exec_node node
;
175 * Declared type of the variable
177 const struct glsl_type
*type
;
180 * Declared name of the variable
184 struct nir_variable_data
{
186 * Storage class of the variable.
188 * \sa nir_variable_mode
190 nir_variable_mode mode
;
193 * Is the variable read-only?
195 * This is set for variables declared as \c const, shader inputs,
198 unsigned read_only
:1;
202 unsigned invariant
:1;
205 * When separate shader programs are enabled, only input/outputs between
206 * the stages of a multi-stage separate program can be safely removed
207 * from the shader interface. Other input/outputs must remains active.
209 * This is also used to make sure xfb varyings that are unused by the
210 * fragment shader are not removed.
212 unsigned always_active_io
:1;
215 * Interpolation mode for shader inputs / outputs
217 * \sa glsl_interp_mode
219 unsigned interpolation
:2;
222 * \name ARB_fragment_coord_conventions
225 unsigned origin_upper_left
:1;
226 unsigned pixel_center_integer
:1;
230 * If non-zero, then this variable may be packed along with other variables
231 * into a single varying slot, so this offset should be applied when
232 * accessing components. For example, an offset of 1 means that the x
233 * component of this variable is actually stored in component y of the
234 * location specified by \c location.
236 unsigned location_frac
:2;
239 * If true, this variable represents an array of scalars that should
240 * be tightly packed. In other words, consecutive array elements
241 * should be stored one component apart, rather than one slot apart.
246 * Whether this is a fragment shader output implicitly initialized with
247 * the previous contents of the specified render target at the
248 * framebuffer location corresponding to this shader invocation.
250 unsigned fb_fetch_output
:1;
253 * Non-zero if this variable is considered bindless as defined by
254 * ARB_bindless_texture.
259 * \brief Layout qualifier for gl_FragDepth.
261 * This is not equal to \c ir_depth_layout_none if and only if this
262 * variable is \c gl_FragDepth and a layout qualifier is specified.
264 nir_depth_layout depth_layout
;
267 * Storage location of the base of this variable
269 * The precise meaning of this field depends on the nature of the variable.
271 * - Vertex shader input: one of the values from \c gl_vert_attrib.
272 * - Vertex shader output: one of the values from \c gl_varying_slot.
273 * - Geometry shader input: one of the values from \c gl_varying_slot.
274 * - Geometry shader output: one of the values from \c gl_varying_slot.
275 * - Fragment shader input: one of the values from \c gl_varying_slot.
276 * - Fragment shader output: one of the values from \c gl_frag_result.
277 * - Uniforms: Per-stage uniform slot number for default uniform block.
278 * - Uniforms: Index within the uniform block definition for UBO members.
279 * - Non-UBO Uniforms: uniform slot number.
280 * - Other: This field is not currently used.
282 * If the variable is a uniform, shader input, or shader output, and the
283 * slot has not been assigned, the value will be -1.
288 * The actual location of the variable in the IR. Only valid for inputs
291 unsigned int driver_location
;
294 * Vertex stream output identifier.
296 * For packed outputs, bit 31 is set and bits [2*i+1,2*i] indicate the
297 * stream of the i-th component.
302 * output index for dual source blending.
307 * Descriptor set binding for sampler or UBO.
312 * Initial binding point for a sampler or UBO.
314 * For array types, this represents the binding point for the first element.
319 * Location an atomic counter is stored at.
324 * ARB_shader_image_load_store qualifiers.
327 bool read_only
; /**< "readonly" qualifier. */
328 bool write_only
; /**< "writeonly" qualifier. */
333 /** Image internal format if specified explicitly, otherwise GL_NONE. */
339 * Built-in state that backs this uniform
341 * Once set at variable creation, \c state_slots must remain invariant.
342 * This is because, ideally, this array would be shared by all clones of
343 * this variable in the IR tree. In other words, we'd really like for it
344 * to be a fly-weight.
346 * If the variable is not a uniform, \c num_state_slots will be zero and
347 * \c state_slots will be \c NULL.
350 unsigned num_state_slots
; /**< Number of state slots used */
351 nir_state_slot
*state_slots
; /**< State descriptors. */
355 * Constant expression assigned in the initializer of the variable
357 * This field should only be used temporarily by creators of NIR shaders
358 * and then lower_constant_initializers can be used to get rid of them.
359 * Most of the rest of NIR ignores this field or asserts that it's NULL.
361 nir_constant
*constant_initializer
;
364 * For variables that are in an interface block or are an instance of an
365 * interface block, this is the \c GLSL_TYPE_INTERFACE type for that block.
367 * \sa ir_variable::location
369 const struct glsl_type
*interface_type
;
372 #define nir_foreach_variable(var, var_list) \
373 foreach_list_typed(nir_variable, var, node, var_list)
375 #define nir_foreach_variable_safe(var, var_list) \
376 foreach_list_typed_safe(nir_variable, var, node, var_list)
379 nir_variable_is_global(const nir_variable
*var
)
381 return var
->data
.mode
!= nir_var_local
&& var
->data
.mode
!= nir_var_param
;
384 typedef struct nir_register
{
385 struct exec_node node
;
387 unsigned num_components
; /** < number of vector components */
388 unsigned num_array_elems
; /** < size of array (0 for no array) */
390 /* The bit-size of each channel; must be one of 8, 16, 32, or 64 */
393 /** generic register index. */
396 /** only for debug purposes, can be NULL */
399 /** whether this register is local (per-function) or global (per-shader) */
403 * If this flag is set to true, then accessing channels >= num_components
404 * is well-defined, and simply spills over to the next array element. This
405 * is useful for backends that can do per-component accessing, in
406 * particular scalar backends. By setting this flag and making
407 * num_components equal to 1, structures can be packed tightly into
408 * registers and then registers can be accessed per-component to get to
409 * each structure member, even if it crosses vec4 boundaries.
413 /** set of nir_srcs where this register is used (read from) */
414 struct list_head uses
;
416 /** set of nir_dests where this register is defined (written to) */
417 struct list_head defs
;
419 /** set of nir_ifs where this register is used as a condition */
420 struct list_head if_uses
;
423 #define nir_foreach_register(reg, reg_list) \
424 foreach_list_typed(nir_register, reg, node, reg_list)
425 #define nir_foreach_register_safe(reg, reg_list) \
426 foreach_list_typed_safe(nir_register, reg, node, reg_list)
432 nir_instr_type_intrinsic
,
433 nir_instr_type_load_const
,
435 nir_instr_type_ssa_undef
,
437 nir_instr_type_parallel_copy
,
440 typedef struct nir_instr
{
441 struct exec_node node
;
443 struct nir_block
*block
;
445 /** generic instruction index. */
448 /* A temporary for optimization and analysis passes to use for storing
449 * flags. For instance, DCE uses this to store the "dead/live" info.
454 static inline nir_instr
*
455 nir_instr_next(nir_instr
*instr
)
457 struct exec_node
*next
= exec_node_get_next(&instr
->node
);
458 if (exec_node_is_tail_sentinel(next
))
461 return exec_node_data(nir_instr
, next
, node
);
464 static inline nir_instr
*
465 nir_instr_prev(nir_instr
*instr
)
467 struct exec_node
*prev
= exec_node_get_prev(&instr
->node
);
468 if (exec_node_is_head_sentinel(prev
))
471 return exec_node_data(nir_instr
, prev
, node
);
475 nir_instr_is_first(const nir_instr
*instr
)
477 return exec_node_is_head_sentinel(exec_node_get_prev_const(&instr
->node
));
481 nir_instr_is_last(const nir_instr
*instr
)
483 return exec_node_is_tail_sentinel(exec_node_get_next_const(&instr
->node
));
486 typedef struct nir_ssa_def
{
487 /** for debugging only, can be NULL */
490 /** generic SSA definition index. */
493 /** Index into the live_in and live_out bitfields */
496 nir_instr
*parent_instr
;
498 /** set of nir_instrs where this register is used (read from) */
499 struct list_head uses
;
501 /** set of nir_ifs where this register is used as a condition */
502 struct list_head if_uses
;
504 uint8_t num_components
;
506 /* The bit-size of each channel; must be one of 8, 16, 32, or 64 */
514 struct nir_src
*indirect
; /** < NULL for no indirect offset */
515 unsigned base_offset
;
517 /* TODO use-def chain goes here */
521 nir_instr
*parent_instr
;
522 struct list_head def_link
;
525 struct nir_src
*indirect
; /** < NULL for no indirect offset */
526 unsigned base_offset
;
528 /* TODO def-use chain goes here */
533 typedef struct nir_src
{
535 nir_instr
*parent_instr
;
536 struct nir_if
*parent_if
;
539 struct list_head use_link
;
549 static inline nir_src
552 nir_src src
= { { NULL
} };
556 #define NIR_SRC_INIT nir_src_init()
558 #define nir_foreach_use(src, reg_or_ssa_def) \
559 list_for_each_entry(nir_src, src, &(reg_or_ssa_def)->uses, use_link)
561 #define nir_foreach_use_safe(src, reg_or_ssa_def) \
562 list_for_each_entry_safe(nir_src, src, &(reg_or_ssa_def)->uses, use_link)
564 #define nir_foreach_if_use(src, reg_or_ssa_def) \
565 list_for_each_entry(nir_src, src, &(reg_or_ssa_def)->if_uses, use_link)
567 #define nir_foreach_if_use_safe(src, reg_or_ssa_def) \
568 list_for_each_entry_safe(nir_src, src, &(reg_or_ssa_def)->if_uses, use_link)
579 static inline nir_dest
582 nir_dest dest
= { { { NULL
} } };
586 #define NIR_DEST_INIT nir_dest_init()
588 #define nir_foreach_def(dest, reg) \
589 list_for_each_entry(nir_dest, dest, &(reg)->defs, reg.def_link)
591 #define nir_foreach_def_safe(dest, reg) \
592 list_for_each_entry_safe(nir_dest, dest, &(reg)->defs, reg.def_link)
594 static inline nir_src
595 nir_src_for_ssa(nir_ssa_def
*def
)
597 nir_src src
= NIR_SRC_INIT
;
605 static inline nir_src
606 nir_src_for_reg(nir_register
*reg
)
608 nir_src src
= NIR_SRC_INIT
;
612 src
.reg
.indirect
= NULL
;
613 src
.reg
.base_offset
= 0;
618 static inline nir_dest
619 nir_dest_for_reg(nir_register
*reg
)
621 nir_dest dest
= NIR_DEST_INIT
;
628 static inline unsigned
629 nir_src_bit_size(nir_src src
)
631 return src
.is_ssa
? src
.ssa
->bit_size
: src
.reg
.reg
->bit_size
;
634 static inline unsigned
635 nir_src_num_components(nir_src src
)
637 return src
.is_ssa
? src
.ssa
->num_components
: src
.reg
.reg
->num_components
;
640 static inline unsigned
641 nir_dest_bit_size(nir_dest dest
)
643 return dest
.is_ssa
? dest
.ssa
.bit_size
: dest
.reg
.reg
->bit_size
;
646 static inline unsigned
647 nir_dest_num_components(nir_dest dest
)
649 return dest
.is_ssa
? dest
.ssa
.num_components
: dest
.reg
.reg
->num_components
;
652 void nir_src_copy(nir_src
*dest
, const nir_src
*src
, void *instr_or_if
);
653 void nir_dest_copy(nir_dest
*dest
, const nir_dest
*src
, nir_instr
*instr
);
659 * \name input modifiers
663 * For inputs interpreted as floating point, flips the sign bit. For
664 * inputs interpreted as integers, performs the two's complement negation.
669 * Clears the sign bit for floating point values, and computes the integer
670 * absolute value for integers. Note that the negate modifier acts after
671 * the absolute value modifier, therefore if both are set then all inputs
672 * will become negative.
678 * For each input component, says which component of the register it is
679 * chosen from. Note that which elements of the swizzle are used and which
680 * are ignored are based on the write mask for most opcodes - for example,
681 * a statement like "foo.xzw = bar.zyx" would have a writemask of 1101b and
682 * a swizzle of {2, x, 1, 0} where x means "don't care."
691 * \name saturate output modifier
693 * Only valid for opcodes that output floating-point numbers. Clamps the
694 * output to between 0.0 and 1.0 inclusive.
699 unsigned write_mask
: 4; /* ignored if dest.is_ssa is true */
703 nir_type_invalid
= 0, /* Not a valid type */
708 nir_type_bool32
= 32 | nir_type_bool
,
709 nir_type_int8
= 8 | nir_type_int
,
710 nir_type_int16
= 16 | nir_type_int
,
711 nir_type_int32
= 32 | nir_type_int
,
712 nir_type_int64
= 64 | nir_type_int
,
713 nir_type_uint8
= 8 | nir_type_uint
,
714 nir_type_uint16
= 16 | nir_type_uint
,
715 nir_type_uint32
= 32 | nir_type_uint
,
716 nir_type_uint64
= 64 | nir_type_uint
,
717 nir_type_float16
= 16 | nir_type_float
,
718 nir_type_float32
= 32 | nir_type_float
,
719 nir_type_float64
= 64 | nir_type_float
,
722 #define NIR_ALU_TYPE_SIZE_MASK 0xfffffff8
723 #define NIR_ALU_TYPE_BASE_TYPE_MASK 0x00000007
725 static inline unsigned
726 nir_alu_type_get_type_size(nir_alu_type type
)
728 return type
& NIR_ALU_TYPE_SIZE_MASK
;
731 static inline unsigned
732 nir_alu_type_get_base_type(nir_alu_type type
)
734 return type
& NIR_ALU_TYPE_BASE_TYPE_MASK
;
737 static inline nir_alu_type
738 nir_get_nir_type_for_glsl_base_type(enum glsl_base_type base_type
)
742 return nir_type_bool32
;
745 return nir_type_uint32
;
748 return nir_type_int32
;
750 case GLSL_TYPE_UINT16
:
751 return nir_type_uint16
;
753 case GLSL_TYPE_INT16
:
754 return nir_type_int16
;
756 case GLSL_TYPE_UINT8
:
757 return nir_type_uint8
;
759 return nir_type_int8
;
760 case GLSL_TYPE_UINT64
:
761 return nir_type_uint64
;
763 case GLSL_TYPE_INT64
:
764 return nir_type_int64
;
766 case GLSL_TYPE_FLOAT
:
767 return nir_type_float32
;
769 case GLSL_TYPE_FLOAT16
:
770 return nir_type_float16
;
772 case GLSL_TYPE_DOUBLE
:
773 return nir_type_float64
;
776 unreachable("unknown type");
780 static inline nir_alu_type
781 nir_get_nir_type_for_glsl_type(const struct glsl_type
*type
)
783 return nir_get_nir_type_for_glsl_base_type(glsl_get_base_type(type
));
786 nir_op
nir_type_conversion_op(nir_alu_type src
, nir_alu_type dst
,
787 nir_rounding_mode rnd
);
790 NIR_OP_IS_COMMUTATIVE
= (1 << 0),
791 NIR_OP_IS_ASSOCIATIVE
= (1 << 1),
792 } nir_op_algebraic_property
;
800 * The number of components in the output
802 * If non-zero, this is the size of the output and input sizes are
803 * explicitly given; swizzle and writemask are still in effect, but if
804 * the output component is masked out, then the input component may
807 * If zero, the opcode acts in the standard, per-component manner; the
808 * operation is performed on each component (except the ones that are
809 * masked out) with the input being taken from the input swizzle for
812 * The size of some of the inputs may be given (i.e. non-zero) even
813 * though output_size is zero; in that case, the inputs with a zero
814 * size act per-component, while the inputs with non-zero size don't.
816 unsigned output_size
;
819 * The type of vector that the instruction outputs. Note that the
820 * staurate modifier is only allowed on outputs with the float type.
823 nir_alu_type output_type
;
826 * The number of components in each input
828 unsigned input_sizes
[4];
831 * The type of vector that each input takes. Note that negate and
832 * absolute value are only allowed on inputs with int or float type and
833 * behave differently on the two.
835 nir_alu_type input_types
[4];
837 nir_op_algebraic_property algebraic_properties
;
840 extern const nir_op_info nir_op_infos
[nir_num_opcodes
];
842 typedef struct nir_alu_instr
{
846 /** Indicates that this ALU instruction generates an exact value
848 * This is kind of a mixture of GLSL "precise" and "invariant" and not
849 * really equivalent to either. This indicates that the value generated by
850 * this operation is high-precision and any code transformations that touch
851 * it must ensure that the resulting value is bit-for-bit identical to the
860 void nir_alu_src_copy(nir_alu_src
*dest
, const nir_alu_src
*src
,
861 nir_alu_instr
*instr
);
862 void nir_alu_dest_copy(nir_alu_dest
*dest
, const nir_alu_dest
*src
,
863 nir_alu_instr
*instr
);
865 /* is this source channel used? */
867 nir_alu_instr_channel_used(const nir_alu_instr
*instr
, unsigned src
,
870 if (nir_op_infos
[instr
->op
].input_sizes
[src
] > 0)
871 return channel
< nir_op_infos
[instr
->op
].input_sizes
[src
];
873 return (instr
->dest
.write_mask
>> channel
) & 1;
877 * For instructions whose destinations are SSA, get the number of channels
880 static inline unsigned
881 nir_ssa_alu_instr_src_components(const nir_alu_instr
*instr
, unsigned src
)
883 assert(instr
->dest
.dest
.is_ssa
);
885 if (nir_op_infos
[instr
->op
].input_sizes
[src
] > 0)
886 return nir_op_infos
[instr
->op
].input_sizes
[src
];
888 return instr
->dest
.dest
.ssa
.num_components
;
891 bool nir_alu_srcs_equal(const nir_alu_instr
*alu1
, const nir_alu_instr
*alu2
,
892 unsigned src1
, unsigned src2
);
896 nir_deref_type_array
,
897 nir_deref_type_struct
900 typedef struct nir_deref
{
901 nir_deref_type deref_type
;
902 struct nir_deref
*child
;
903 const struct glsl_type
*type
;
912 /* This enum describes how the array is referenced. If the deref is
913 * direct then the base_offset is used. If the deref is indirect then
914 * offset is given by base_offset + indirect. If the deref is a wildcard
915 * then the deref refers to all of the elements of the array at the same
916 * time. Wildcard dereferences are only ever allowed in copy_var
917 * intrinsics and the source and destination derefs must have matching
921 nir_deref_array_type_direct
,
922 nir_deref_array_type_indirect
,
923 nir_deref_array_type_wildcard
,
924 } nir_deref_array_type
;
929 nir_deref_array_type deref_array_type
;
930 unsigned base_offset
;
940 NIR_DEFINE_CAST(nir_deref_as_var
, nir_deref
, nir_deref_var
, deref
,
941 deref_type
, nir_deref_type_var
)
942 NIR_DEFINE_CAST(nir_deref_as_array
, nir_deref
, nir_deref_array
, deref
,
943 deref_type
, nir_deref_type_array
)
944 NIR_DEFINE_CAST(nir_deref_as_struct
, nir_deref
, nir_deref_struct
, deref
,
945 deref_type
, nir_deref_type_struct
)
947 /* Returns the last deref in the chain. */
948 static inline nir_deref
*
949 nir_deref_tail(nir_deref
*deref
)
952 deref
= deref
->child
;
960 nir_deref_var
**params
;
961 nir_deref_var
*return_deref
;
963 struct nir_function
*callee
;
966 #include "nir_intrinsics.h"
968 #define NIR_INTRINSIC_MAX_CONST_INDEX 3
970 /** Represents an intrinsic
972 * An intrinsic is an instruction type for handling things that are
973 * more-or-less regular operations but don't just consume and produce SSA
974 * values like ALU operations do. Intrinsics are not for things that have
975 * special semantic meaning such as phi nodes and parallel copies.
976 * Examples of intrinsics include variable load/store operations, system
977 * value loads, and the like. Even though texturing more-or-less falls
978 * under this category, texturing is its own instruction type because
979 * trying to represent texturing with intrinsics would lead to a
980 * combinatorial explosion of intrinsic opcodes.
982 * By having a single instruction type for handling a lot of different
983 * cases, optimization passes can look for intrinsics and, for the most
984 * part, completely ignore them. Each intrinsic type also has a few
985 * possible flags that govern whether or not they can be reordered or
986 * eliminated. That way passes like dead code elimination can still work
987 * on intrisics without understanding the meaning of each.
989 * Each intrinsic has some number of constant indices, some number of
990 * variables, and some number of sources. What these sources, variables,
991 * and indices mean depends on the intrinsic and is documented with the
992 * intrinsic declaration in nir_intrinsics.h. Intrinsics and texture
993 * instructions are the only types of instruction that can operate on
999 nir_intrinsic_op intrinsic
;
1003 /** number of components if this is a vectorized intrinsic
1005 * Similarly to ALU operations, some intrinsics are vectorized.
1006 * An intrinsic is vectorized if nir_intrinsic_infos.dest_components == 0.
1007 * For vectorized intrinsics, the num_components field specifies the
1008 * number of destination components and the number of source components
1009 * for all sources with nir_intrinsic_infos.src_components[i] == 0.
1011 uint8_t num_components
;
1013 int const_index
[NIR_INTRINSIC_MAX_CONST_INDEX
];
1015 nir_deref_var
*variables
[2];
1018 } nir_intrinsic_instr
;
1021 * \name NIR intrinsics semantic flags
1023 * information about what the compiler can do with the intrinsics.
1025 * \sa nir_intrinsic_info::flags
1029 * whether the intrinsic can be safely eliminated if none of its output
1030 * value is not being used.
1032 NIR_INTRINSIC_CAN_ELIMINATE
= (1 << 0),
1035 * Whether the intrinsic can be reordered with respect to any other
1036 * intrinsic, i.e. whether the only reordering dependencies of the
1037 * intrinsic are due to the register reads/writes.
1039 NIR_INTRINSIC_CAN_REORDER
= (1 << 1),
1040 } nir_intrinsic_semantic_flag
;
1043 * \name NIR intrinsics const-index flag
1045 * Indicates the usage of a const_index slot.
1047 * \sa nir_intrinsic_info::index_map
1051 * Generally instructions that take a offset src argument, can encode
1052 * a constant 'base' value which is added to the offset.
1054 NIR_INTRINSIC_BASE
= 1,
1057 * For store instructions, a writemask for the store.
1059 NIR_INTRINSIC_WRMASK
= 2,
1062 * The stream-id for GS emit_vertex/end_primitive intrinsics.
1064 NIR_INTRINSIC_STREAM_ID
= 3,
1067 * The clip-plane id for load_user_clip_plane intrinsic.
1069 NIR_INTRINSIC_UCP_ID
= 4,
1072 * The amount of data, starting from BASE, that this instruction may
1073 * access. This is used to provide bounds if the offset is not constant.
1075 NIR_INTRINSIC_RANGE
= 5,
1078 * The Vulkan descriptor set for vulkan_resource_index intrinsic.
1080 NIR_INTRINSIC_DESC_SET
= 6,
1083 * The Vulkan descriptor set binding for vulkan_resource_index intrinsic.
1085 NIR_INTRINSIC_BINDING
= 7,
1090 NIR_INTRINSIC_COMPONENT
= 8,
1093 * Interpolation mode (only meaningful for FS inputs).
1095 NIR_INTRINSIC_INTERP_MODE
= 9,
1098 * A binary nir_op to use when performing a reduction or scan operation
1100 NIR_INTRINSIC_REDUCTION_OP
= 10,
1103 * Cluster size for reduction operations
1105 NIR_INTRINSIC_CLUSTER_SIZE
= 11,
1107 NIR_INTRINSIC_NUM_INDEX_FLAGS
,
1109 } nir_intrinsic_index_flag
;
1111 #define NIR_INTRINSIC_MAX_INPUTS 4
1116 unsigned num_srcs
; /** < number of register/SSA inputs */
1118 /** number of components of each input register
1120 * If this value is 0, the number of components is given by the
1121 * num_components field of nir_intrinsic_instr.
1123 unsigned src_components
[NIR_INTRINSIC_MAX_INPUTS
];
1127 /** number of components of the output register
1129 * If this value is 0, the number of components is given by the
1130 * num_components field of nir_intrinsic_instr.
1132 unsigned dest_components
;
1134 /** the number of inputs/outputs that are variables */
1135 unsigned num_variables
;
1137 /** the number of constant indices used by the intrinsic */
1138 unsigned num_indices
;
1140 /** indicates the usage of intr->const_index[n] */
1141 unsigned index_map
[NIR_INTRINSIC_NUM_INDEX_FLAGS
];
1143 /** semantic flags for calls to this intrinsic */
1144 nir_intrinsic_semantic_flag flags
;
1145 } nir_intrinsic_info
;
1147 extern const nir_intrinsic_info nir_intrinsic_infos
[nir_num_intrinsics
];
1149 static inline unsigned
1150 nir_intrinsic_src_components(nir_intrinsic_instr
*intr
, unsigned srcn
)
1152 const nir_intrinsic_info
*info
= &nir_intrinsic_infos
[intr
->intrinsic
];
1153 assert(srcn
< info
->num_srcs
);
1154 if (info
->src_components
[srcn
])
1155 return info
->src_components
[srcn
];
1157 return intr
->num_components
;
1160 static inline unsigned
1161 nir_intrinsic_dest_components(nir_intrinsic_instr
*intr
)
1163 const nir_intrinsic_info
*info
= &nir_intrinsic_infos
[intr
->intrinsic
];
1164 if (!info
->has_dest
)
1166 else if (info
->dest_components
)
1167 return info
->dest_components
;
1169 return intr
->num_components
;
1172 #define INTRINSIC_IDX_ACCESSORS(name, flag, type) \
1173 static inline type \
1174 nir_intrinsic_##name(const nir_intrinsic_instr *instr) \
1176 const nir_intrinsic_info *info = &nir_intrinsic_infos[instr->intrinsic]; \
1177 assert(info->index_map[NIR_INTRINSIC_##flag] > 0); \
1178 return instr->const_index[info->index_map[NIR_INTRINSIC_##flag] - 1]; \
1180 static inline void \
1181 nir_intrinsic_set_##name(nir_intrinsic_instr *instr, type val) \
1183 const nir_intrinsic_info *info = &nir_intrinsic_infos[instr->intrinsic]; \
1184 assert(info->index_map[NIR_INTRINSIC_##flag] > 0); \
1185 instr->const_index[info->index_map[NIR_INTRINSIC_##flag] - 1] = val; \
1188 INTRINSIC_IDX_ACCESSORS(write_mask
, WRMASK
, unsigned)
1189 INTRINSIC_IDX_ACCESSORS(base
, BASE
, int)
1190 INTRINSIC_IDX_ACCESSORS(stream_id
, STREAM_ID
, unsigned)
1191 INTRINSIC_IDX_ACCESSORS(ucp_id
, UCP_ID
, unsigned)
1192 INTRINSIC_IDX_ACCESSORS(range
, RANGE
, unsigned)
1193 INTRINSIC_IDX_ACCESSORS(desc_set
, DESC_SET
, unsigned)
1194 INTRINSIC_IDX_ACCESSORS(binding
, BINDING
, unsigned)
1195 INTRINSIC_IDX_ACCESSORS(component
, COMPONENT
, unsigned)
1196 INTRINSIC_IDX_ACCESSORS(interp_mode
, INTERP_MODE
, unsigned)
1197 INTRINSIC_IDX_ACCESSORS(reduction_op
, REDUCTION_OP
, unsigned)
1198 INTRINSIC_IDX_ACCESSORS(cluster_size
, CLUSTER_SIZE
, unsigned)
1201 * \group texture information
1203 * This gives semantic information about textures which is useful to the
1204 * frontend, the backend, and lowering passes, but not the optimizer.
1209 nir_tex_src_projector
,
1210 nir_tex_src_comparator
, /* shadow comparator */
1214 nir_tex_src_ms_index
, /* MSAA sample index */
1215 nir_tex_src_ms_mcs
, /* MSAA compression value */
1218 nir_tex_src_texture_offset
, /* < dynamically uniform indirect offset */
1219 nir_tex_src_sampler_offset
, /* < dynamically uniform indirect offset */
1220 nir_tex_src_plane
, /* < selects plane for planar textures */
1221 nir_num_tex_src_types
1226 nir_tex_src_type src_type
;
1230 nir_texop_tex
, /**< Regular texture look-up */
1231 nir_texop_txb
, /**< Texture look-up with LOD bias */
1232 nir_texop_txl
, /**< Texture look-up with explicit LOD */
1233 nir_texop_txd
, /**< Texture look-up with partial derivatives */
1234 nir_texop_txf
, /**< Texel fetch with explicit LOD */
1235 nir_texop_txf_ms
, /**< Multisample texture fetch */
1236 nir_texop_txf_ms_mcs
, /**< Multisample compression value fetch */
1237 nir_texop_txs
, /**< Texture size */
1238 nir_texop_lod
, /**< Texture lod query */
1239 nir_texop_tg4
, /**< Texture gather */
1240 nir_texop_query_levels
, /**< Texture levels query */
1241 nir_texop_texture_samples
, /**< Texture samples query */
1242 nir_texop_samples_identical
, /**< Query whether all samples are definitely
1250 enum glsl_sampler_dim sampler_dim
;
1251 nir_alu_type dest_type
;
1256 unsigned num_srcs
, coord_components
;
1257 bool is_array
, is_shadow
;
1260 * If is_shadow is true, whether this is the old-style shadow that outputs 4
1261 * components or the new-style shadow that outputs 1 component.
1263 bool is_new_style_shadow
;
1265 /* gather component selector */
1266 unsigned component
: 2;
1268 /** The texture index
1270 * If this texture instruction has a nir_tex_src_texture_offset source,
1271 * then the texture index is given by texture_index + texture_offset.
1273 unsigned texture_index
;
1275 /** The size of the texture array or 0 if it's not an array */
1276 unsigned texture_array_size
;
1278 /** The texture deref
1280 * If this is null, use texture_index instead.
1282 nir_deref_var
*texture
;
1284 /** The sampler index
1286 * The following operations do not require a sampler and, as such, this
1287 * field should be ignored:
1289 * - nir_texop_txf_ms
1292 * - nir_texop_query_levels
1293 * - nir_texop_texture_samples
1294 * - nir_texop_samples_identical
1296 * If this texture instruction has a nir_tex_src_sampler_offset source,
1297 * then the sampler index is given by sampler_index + sampler_offset.
1299 unsigned sampler_index
;
1301 /** The sampler deref
1303 * If this is null, use sampler_index instead.
1305 nir_deref_var
*sampler
;
1308 static inline unsigned
1309 nir_tex_instr_dest_size(const nir_tex_instr
*instr
)
1311 switch (instr
->op
) {
1312 case nir_texop_txs
: {
1314 switch (instr
->sampler_dim
) {
1315 case GLSL_SAMPLER_DIM_1D
:
1316 case GLSL_SAMPLER_DIM_BUF
:
1319 case GLSL_SAMPLER_DIM_2D
:
1320 case GLSL_SAMPLER_DIM_CUBE
:
1321 case GLSL_SAMPLER_DIM_MS
:
1322 case GLSL_SAMPLER_DIM_RECT
:
1323 case GLSL_SAMPLER_DIM_EXTERNAL
:
1324 case GLSL_SAMPLER_DIM_SUBPASS
:
1327 case GLSL_SAMPLER_DIM_3D
:
1331 unreachable("not reached");
1333 if (instr
->is_array
)
1341 case nir_texop_texture_samples
:
1342 case nir_texop_query_levels
:
1343 case nir_texop_samples_identical
:
1347 if (instr
->is_shadow
&& instr
->is_new_style_shadow
)
1354 /* Returns true if this texture operation queries something about the texture
1355 * rather than actually sampling it.
1358 nir_tex_instr_is_query(const nir_tex_instr
*instr
)
1360 switch (instr
->op
) {
1363 case nir_texop_texture_samples
:
1364 case nir_texop_query_levels
:
1365 case nir_texop_txf_ms_mcs
:
1372 case nir_texop_txf_ms
:
1376 unreachable("Invalid texture opcode");
1380 static inline nir_alu_type
1381 nir_tex_instr_src_type(const nir_tex_instr
*instr
, unsigned src
)
1383 switch (instr
->src
[src
].src_type
) {
1384 case nir_tex_src_coord
:
1385 switch (instr
->op
) {
1387 case nir_texop_txf_ms
:
1388 case nir_texop_txf_ms_mcs
:
1389 case nir_texop_samples_identical
:
1390 return nir_type_int
;
1393 return nir_type_float
;
1396 case nir_tex_src_lod
:
1397 switch (instr
->op
) {
1400 return nir_type_int
;
1403 return nir_type_float
;
1406 case nir_tex_src_projector
:
1407 case nir_tex_src_comparator
:
1408 case nir_tex_src_bias
:
1409 case nir_tex_src_ddx
:
1410 case nir_tex_src_ddy
:
1411 return nir_type_float
;
1413 case nir_tex_src_offset
:
1414 case nir_tex_src_ms_index
:
1415 case nir_tex_src_texture_offset
:
1416 case nir_tex_src_sampler_offset
:
1417 return nir_type_int
;
1420 unreachable("Invalid texture source type");
1424 static inline unsigned
1425 nir_tex_instr_src_size(const nir_tex_instr
*instr
, unsigned src
)
1427 if (instr
->src
[src
].src_type
== nir_tex_src_coord
)
1428 return instr
->coord_components
;
1430 /* The MCS value is expected to be a vec4 returned by a txf_ms_mcs */
1431 if (instr
->src
[src
].src_type
== nir_tex_src_ms_mcs
)
1434 if (instr
->src
[src
].src_type
== nir_tex_src_ddx
||
1435 instr
->src
[src
].src_type
== nir_tex_src_ddy
) {
1436 if (instr
->is_array
)
1437 return instr
->coord_components
- 1;
1439 return instr
->coord_components
;
1442 /* Usual APIs don't allow cube + offset, but we allow it, with 2 coords for
1443 * the offset, since a cube maps to a single face.
1445 if (instr
->src
[src
].src_type
== nir_tex_src_offset
) {
1446 if (instr
->sampler_dim
== GLSL_SAMPLER_DIM_CUBE
)
1448 else if (instr
->is_array
)
1449 return instr
->coord_components
- 1;
1451 return instr
->coord_components
;
1458 nir_tex_instr_src_index(const nir_tex_instr
*instr
, nir_tex_src_type type
)
1460 for (unsigned i
= 0; i
< instr
->num_srcs
; i
++)
1461 if (instr
->src
[i
].src_type
== type
)
1467 void nir_tex_instr_add_src(nir_tex_instr
*tex
,
1468 nir_tex_src_type src_type
,
1471 void nir_tex_instr_remove_src(nir_tex_instr
*tex
, unsigned src_idx
);
1476 nir_const_value value
;
1479 } nir_load_const_instr
;
1492 /* creates a new SSA variable in an undefined state */
1497 } nir_ssa_undef_instr
;
1500 struct exec_node node
;
1502 /* The predecessor block corresponding to this source */
1503 struct nir_block
*pred
;
1508 #define nir_foreach_phi_src(phi_src, phi) \
1509 foreach_list_typed(nir_phi_src, phi_src, node, &(phi)->srcs)
1510 #define nir_foreach_phi_src_safe(phi_src, phi) \
1511 foreach_list_typed_safe(nir_phi_src, phi_src, node, &(phi)->srcs)
1516 struct exec_list srcs
; /** < list of nir_phi_src */
1522 struct exec_node node
;
1525 } nir_parallel_copy_entry
;
1527 #define nir_foreach_parallel_copy_entry(entry, pcopy) \
1528 foreach_list_typed(nir_parallel_copy_entry, entry, node, &(pcopy)->entries)
1533 /* A list of nir_parallel_copy_entrys. The sources of all of the
1534 * entries are copied to the corresponding destinations "in parallel".
1535 * In other words, if we have two entries: a -> b and b -> a, the values
1538 struct exec_list entries
;
1539 } nir_parallel_copy_instr
;
1541 NIR_DEFINE_CAST(nir_instr_as_alu
, nir_instr
, nir_alu_instr
, instr
,
1542 type
, nir_instr_type_alu
)
1543 NIR_DEFINE_CAST(nir_instr_as_call
, nir_instr
, nir_call_instr
, instr
,
1544 type
, nir_instr_type_call
)
1545 NIR_DEFINE_CAST(nir_instr_as_jump
, nir_instr
, nir_jump_instr
, instr
,
1546 type
, nir_instr_type_jump
)
1547 NIR_DEFINE_CAST(nir_instr_as_tex
, nir_instr
, nir_tex_instr
, instr
,
1548 type
, nir_instr_type_tex
)
1549 NIR_DEFINE_CAST(nir_instr_as_intrinsic
, nir_instr
, nir_intrinsic_instr
, instr
,
1550 type
, nir_instr_type_intrinsic
)
1551 NIR_DEFINE_CAST(nir_instr_as_load_const
, nir_instr
, nir_load_const_instr
, instr
,
1552 type
, nir_instr_type_load_const
)
1553 NIR_DEFINE_CAST(nir_instr_as_ssa_undef
, nir_instr
, nir_ssa_undef_instr
, instr
,
1554 type
, nir_instr_type_ssa_undef
)
1555 NIR_DEFINE_CAST(nir_instr_as_phi
, nir_instr
, nir_phi_instr
, instr
,
1556 type
, nir_instr_type_phi
)
1557 NIR_DEFINE_CAST(nir_instr_as_parallel_copy
, nir_instr
,
1558 nir_parallel_copy_instr
, instr
,
1559 type
, nir_instr_type_parallel_copy
)
1564 * Control flow consists of a tree of control flow nodes, which include
1565 * if-statements and loops. The leaves of the tree are basic blocks, lists of
1566 * instructions that always run start-to-finish. Each basic block also keeps
1567 * track of its successors (blocks which may run immediately after the current
1568 * block) and predecessors (blocks which could have run immediately before the
1569 * current block). Each function also has a start block and an end block which
1570 * all return statements point to (which is always empty). Together, all the
1571 * blocks with their predecessors and successors make up the control flow
1572 * graph (CFG) of the function. There are helpers that modify the tree of
1573 * control flow nodes while modifying the CFG appropriately; these should be
1574 * used instead of modifying the tree directly.
1581 nir_cf_node_function
1584 typedef struct nir_cf_node
{
1585 struct exec_node node
;
1586 nir_cf_node_type type
;
1587 struct nir_cf_node
*parent
;
1590 typedef struct nir_block
{
1591 nir_cf_node cf_node
;
1593 struct exec_list instr_list
; /** < list of nir_instr */
1595 /** generic block index; generated by nir_index_blocks */
1599 * Each block can only have up to 2 successors, so we put them in a simple
1600 * array - no need for anything more complicated.
1602 struct nir_block
*successors
[2];
1604 /* Set of nir_block predecessors in the CFG */
1605 struct set
*predecessors
;
1608 * this node's immediate dominator in the dominance tree - set to NULL for
1611 struct nir_block
*imm_dom
;
1613 /* This node's children in the dominance tree */
1614 unsigned num_dom_children
;
1615 struct nir_block
**dom_children
;
1617 /* Set of nir_blocks on the dominance frontier of this block */
1618 struct set
*dom_frontier
;
1621 * These two indices have the property that dom_{pre,post}_index for each
1622 * child of this block in the dominance tree will always be between
1623 * dom_pre_index and dom_post_index for this block, which makes testing if
1624 * a given block is dominated by another block an O(1) operation.
1626 unsigned dom_pre_index
, dom_post_index
;
1628 /* live in and out for this block; used for liveness analysis */
1629 BITSET_WORD
*live_in
;
1630 BITSET_WORD
*live_out
;
1633 static inline nir_instr
*
1634 nir_block_first_instr(nir_block
*block
)
1636 struct exec_node
*head
= exec_list_get_head(&block
->instr_list
);
1637 return exec_node_data(nir_instr
, head
, node
);
1640 static inline nir_instr
*
1641 nir_block_last_instr(nir_block
*block
)
1643 struct exec_node
*tail
= exec_list_get_tail(&block
->instr_list
);
1644 return exec_node_data(nir_instr
, tail
, node
);
1647 #define nir_foreach_instr(instr, block) \
1648 foreach_list_typed(nir_instr, instr, node, &(block)->instr_list)
1649 #define nir_foreach_instr_reverse(instr, block) \
1650 foreach_list_typed_reverse(nir_instr, instr, node, &(block)->instr_list)
1651 #define nir_foreach_instr_safe(instr, block) \
1652 foreach_list_typed_safe(nir_instr, instr, node, &(block)->instr_list)
1653 #define nir_foreach_instr_reverse_safe(instr, block) \
1654 foreach_list_typed_reverse_safe(nir_instr, instr, node, &(block)->instr_list)
1656 typedef struct nir_if
{
1657 nir_cf_node cf_node
;
1660 struct exec_list then_list
; /** < list of nir_cf_node */
1661 struct exec_list else_list
; /** < list of nir_cf_node */
1667 nir_instr
*conditional_instr
;
1669 nir_block
*break_block
;
1670 nir_block
*continue_from_block
;
1672 bool continue_from_then
;
1674 struct list_head loop_terminator_link
;
1675 } nir_loop_terminator
;
1678 /* Number of instructions in the loop */
1679 unsigned num_instructions
;
1681 /* How many times the loop is run (if known) */
1682 unsigned trip_count
;
1683 bool is_trip_count_known
;
1685 /* Unroll the loop regardless of its size */
1688 nir_loop_terminator
*limiting_terminator
;
1690 /* A list of loop_terminators terminating this loop. */
1691 struct list_head loop_terminator_list
;
1695 nir_cf_node cf_node
;
1697 struct exec_list body
; /** < list of nir_cf_node */
1699 nir_loop_info
*info
;
1703 * Various bits of metadata that can may be created or required by
1704 * optimization and analysis passes
1707 nir_metadata_none
= 0x0,
1708 nir_metadata_block_index
= 0x1,
1709 nir_metadata_dominance
= 0x2,
1710 nir_metadata_live_ssa_defs
= 0x4,
1711 nir_metadata_not_properly_reset
= 0x8,
1712 nir_metadata_loop_analysis
= 0x10,
1716 nir_cf_node cf_node
;
1718 /** pointer to the function of which this is an implementation */
1719 struct nir_function
*function
;
1721 struct exec_list body
; /** < list of nir_cf_node */
1723 nir_block
*end_block
;
1725 /** list for all local variables in the function */
1726 struct exec_list locals
;
1728 /** array of variables used as parameters */
1729 unsigned num_params
;
1730 nir_variable
**params
;
1732 /** variable used to hold the result of the function */
1733 nir_variable
*return_var
;
1735 /** list of local registers in the function */
1736 struct exec_list registers
;
1738 /** next available local register index */
1741 /** next available SSA value index */
1744 /* total number of basic blocks, only valid when block_index_dirty = false */
1745 unsigned num_blocks
;
1747 nir_metadata valid_metadata
;
1748 } nir_function_impl
;
1750 ATTRIBUTE_RETURNS_NONNULL
static inline nir_block
*
1751 nir_start_block(nir_function_impl
*impl
)
1753 return (nir_block
*) impl
->body
.head_sentinel
.next
;
1756 ATTRIBUTE_RETURNS_NONNULL
static inline nir_block
*
1757 nir_impl_last_block(nir_function_impl
*impl
)
1759 return (nir_block
*) impl
->body
.tail_sentinel
.prev
;
1762 static inline nir_cf_node
*
1763 nir_cf_node_next(nir_cf_node
*node
)
1765 struct exec_node
*next
= exec_node_get_next(&node
->node
);
1766 if (exec_node_is_tail_sentinel(next
))
1769 return exec_node_data(nir_cf_node
, next
, node
);
1772 static inline nir_cf_node
*
1773 nir_cf_node_prev(nir_cf_node
*node
)
1775 struct exec_node
*prev
= exec_node_get_prev(&node
->node
);
1776 if (exec_node_is_head_sentinel(prev
))
1779 return exec_node_data(nir_cf_node
, prev
, node
);
1783 nir_cf_node_is_first(const nir_cf_node
*node
)
1785 return exec_node_is_head_sentinel(node
->node
.prev
);
1789 nir_cf_node_is_last(const nir_cf_node
*node
)
1791 return exec_node_is_tail_sentinel(node
->node
.next
);
1794 NIR_DEFINE_CAST(nir_cf_node_as_block
, nir_cf_node
, nir_block
, cf_node
,
1795 type
, nir_cf_node_block
)
1796 NIR_DEFINE_CAST(nir_cf_node_as_if
, nir_cf_node
, nir_if
, cf_node
,
1797 type
, nir_cf_node_if
)
1798 NIR_DEFINE_CAST(nir_cf_node_as_loop
, nir_cf_node
, nir_loop
, cf_node
,
1799 type
, nir_cf_node_loop
)
1800 NIR_DEFINE_CAST(nir_cf_node_as_function
, nir_cf_node
,
1801 nir_function_impl
, cf_node
, type
, nir_cf_node_function
)
1803 static inline nir_block
*
1804 nir_if_first_then_block(nir_if
*if_stmt
)
1806 struct exec_node
*head
= exec_list_get_head(&if_stmt
->then_list
);
1807 return nir_cf_node_as_block(exec_node_data(nir_cf_node
, head
, node
));
1810 static inline nir_block
*
1811 nir_if_last_then_block(nir_if
*if_stmt
)
1813 struct exec_node
*tail
= exec_list_get_tail(&if_stmt
->then_list
);
1814 return nir_cf_node_as_block(exec_node_data(nir_cf_node
, tail
, node
));
1817 static inline nir_block
*
1818 nir_if_first_else_block(nir_if
*if_stmt
)
1820 struct exec_node
*head
= exec_list_get_head(&if_stmt
->else_list
);
1821 return nir_cf_node_as_block(exec_node_data(nir_cf_node
, head
, node
));
1824 static inline nir_block
*
1825 nir_if_last_else_block(nir_if
*if_stmt
)
1827 struct exec_node
*tail
= exec_list_get_tail(&if_stmt
->else_list
);
1828 return nir_cf_node_as_block(exec_node_data(nir_cf_node
, tail
, node
));
1831 static inline nir_block
*
1832 nir_loop_first_block(nir_loop
*loop
)
1834 struct exec_node
*head
= exec_list_get_head(&loop
->body
);
1835 return nir_cf_node_as_block(exec_node_data(nir_cf_node
, head
, node
));
1838 static inline nir_block
*
1839 nir_loop_last_block(nir_loop
*loop
)
1841 struct exec_node
*tail
= exec_list_get_tail(&loop
->body
);
1842 return nir_cf_node_as_block(exec_node_data(nir_cf_node
, tail
, node
));
1848 nir_parameter_inout
,
1849 } nir_parameter_type
;
1852 nir_parameter_type param_type
;
1853 const struct glsl_type
*type
;
1856 typedef struct nir_function
{
1857 struct exec_node node
;
1860 struct nir_shader
*shader
;
1862 unsigned num_params
;
1863 nir_parameter
*params
;
1864 const struct glsl_type
*return_type
;
1866 /** The implementation of this function.
1868 * If the function is only declared and not implemented, this is NULL.
1870 nir_function_impl
*impl
;
1873 typedef struct nir_shader_compiler_options
{
1878 /** Lowers flrp when it does not support doubles */
1885 bool lower_bitfield_extract
;
1886 bool lower_bitfield_insert
;
1887 bool lower_uadd_carry
;
1888 bool lower_usub_borrow
;
1889 /** lowers fneg and ineg to fsub and isub. */
1891 /** lowers fsub and isub to fadd+fneg and iadd+ineg. */
1894 /* lower {slt,sge,seq,sne} to {flt,fge,feq,fne} + b2f: */
1897 /** enables rules to lower idiv by power-of-two: */
1900 /* Does the native fdot instruction replicate its result for four
1901 * components? If so, then opt_algebraic_late will turn all fdotN
1902 * instructions into fdot_replicatedN instructions.
1904 bool fdot_replicates
;
1906 /** lowers ffract to fsub+ffloor: */
1911 bool lower_pack_half_2x16
;
1912 bool lower_pack_unorm_2x16
;
1913 bool lower_pack_snorm_2x16
;
1914 bool lower_pack_unorm_4x8
;
1915 bool lower_pack_snorm_4x8
;
1916 bool lower_unpack_half_2x16
;
1917 bool lower_unpack_unorm_2x16
;
1918 bool lower_unpack_snorm_2x16
;
1919 bool lower_unpack_unorm_4x8
;
1920 bool lower_unpack_snorm_4x8
;
1922 bool lower_extract_byte
;
1923 bool lower_extract_word
;
1925 bool lower_all_io_to_temps
;
1928 * Does the driver support real 32-bit integers? (Otherwise, integers
1929 * are simulated by floats.)
1931 bool native_integers
;
1933 /* Indicates that the driver only has zero-based vertex id */
1934 bool vertex_id_zero_based
;
1936 bool lower_cs_local_index_from_id
;
1938 bool lower_device_index_to_zero
;
1941 * Should nir_lower_io() create load_interpolated_input intrinsics?
1943 * If not, it generates regular load_input intrinsics and interpolation
1944 * information must be inferred from the list of input nir_variables.
1946 bool use_interpolated_input_intrinsics
;
1949 * Do vertex shader double inputs use two locations? The Vulkan spec
1950 * requires two locations to be used, OpenGL allows a single location.
1952 bool vs_inputs_dual_locations
;
1954 unsigned max_unroll_iterations
;
1955 } nir_shader_compiler_options
;
1957 typedef struct nir_shader
{
1958 /** list of uniforms (nir_variable) */
1959 struct exec_list uniforms
;
1961 /** list of inputs (nir_variable) */
1962 struct exec_list inputs
;
1964 /** list of outputs (nir_variable) */
1965 struct exec_list outputs
;
1967 /** list of shared compute variables (nir_variable) */
1968 struct exec_list shared
;
1970 /** Set of driver-specific options for the shader.
1972 * The memory for the options is expected to be kept in a single static
1973 * copy by the driver.
1975 const struct nir_shader_compiler_options
*options
;
1977 /** Various bits of compile-time information about a given shader */
1978 struct shader_info info
;
1980 /** list of global variables in the shader (nir_variable) */
1981 struct exec_list globals
;
1983 /** list of system value variables in the shader (nir_variable) */
1984 struct exec_list system_values
;
1986 struct exec_list functions
; /** < list of nir_function */
1988 /** list of global register in the shader */
1989 struct exec_list registers
;
1991 /** next available global register index */
1995 * the highest index a load_input_*, load_uniform_*, etc. intrinsic can
1998 unsigned num_inputs
, num_uniforms
, num_outputs
, num_shared
;
2001 static inline nir_function_impl
*
2002 nir_shader_get_entrypoint(nir_shader
*shader
)
2004 assert(exec_list_length(&shader
->functions
) == 1);
2005 struct exec_node
*func_node
= exec_list_get_head(&shader
->functions
);
2006 nir_function
*func
= exec_node_data(nir_function
, func_node
, node
);
2007 assert(func
->return_type
== glsl_void_type());
2008 assert(func
->num_params
== 0);
2013 #define nir_foreach_function(func, shader) \
2014 foreach_list_typed(nir_function, func, node, &(shader)->functions)
2016 nir_shader
*nir_shader_create(void *mem_ctx
,
2017 gl_shader_stage stage
,
2018 const nir_shader_compiler_options
*options
,
2021 /** creates a register, including assigning it an index and adding it to the list */
2022 nir_register
*nir_global_reg_create(nir_shader
*shader
);
2024 nir_register
*nir_local_reg_create(nir_function_impl
*impl
);
2026 void nir_reg_remove(nir_register
*reg
);
2028 /** Adds a variable to the appropriate list in nir_shader */
2029 void nir_shader_add_variable(nir_shader
*shader
, nir_variable
*var
);
2032 nir_function_impl_add_variable(nir_function_impl
*impl
, nir_variable
*var
)
2034 assert(var
->data
.mode
== nir_var_local
);
2035 exec_list_push_tail(&impl
->locals
, &var
->node
);
2038 /** creates a variable, sets a few defaults, and adds it to the list */
2039 nir_variable
*nir_variable_create(nir_shader
*shader
,
2040 nir_variable_mode mode
,
2041 const struct glsl_type
*type
,
2043 /** creates a local variable and adds it to the list */
2044 nir_variable
*nir_local_variable_create(nir_function_impl
*impl
,
2045 const struct glsl_type
*type
,
2048 /** creates a function and adds it to the shader's list of functions */
2049 nir_function
*nir_function_create(nir_shader
*shader
, const char *name
);
2051 nir_function_impl
*nir_function_impl_create(nir_function
*func
);
2052 /** creates a function_impl that isn't tied to any particular function */
2053 nir_function_impl
*nir_function_impl_create_bare(nir_shader
*shader
);
2055 nir_block
*nir_block_create(nir_shader
*shader
);
2056 nir_if
*nir_if_create(nir_shader
*shader
);
2057 nir_loop
*nir_loop_create(nir_shader
*shader
);
2059 nir_function_impl
*nir_cf_node_get_function(nir_cf_node
*node
);
2061 /** requests that the given pieces of metadata be generated */
2062 void nir_metadata_require(nir_function_impl
*impl
, nir_metadata required
, ...);
2063 /** dirties all but the preserved metadata */
2064 void nir_metadata_preserve(nir_function_impl
*impl
, nir_metadata preserved
);
2066 /** creates an instruction with default swizzle/writemask/etc. with NULL registers */
2067 nir_alu_instr
*nir_alu_instr_create(nir_shader
*shader
, nir_op op
);
2069 nir_jump_instr
*nir_jump_instr_create(nir_shader
*shader
, nir_jump_type type
);
2071 nir_load_const_instr
*nir_load_const_instr_create(nir_shader
*shader
,
2072 unsigned num_components
,
2075 nir_intrinsic_instr
*nir_intrinsic_instr_create(nir_shader
*shader
,
2076 nir_intrinsic_op op
);
2078 nir_call_instr
*nir_call_instr_create(nir_shader
*shader
,
2079 nir_function
*callee
);
2081 nir_tex_instr
*nir_tex_instr_create(nir_shader
*shader
, unsigned num_srcs
);
2083 nir_phi_instr
*nir_phi_instr_create(nir_shader
*shader
);
2085 nir_parallel_copy_instr
*nir_parallel_copy_instr_create(nir_shader
*shader
);
2087 nir_ssa_undef_instr
*nir_ssa_undef_instr_create(nir_shader
*shader
,
2088 unsigned num_components
,
2091 nir_deref_var
*nir_deref_var_create(void *mem_ctx
, nir_variable
*var
);
2092 nir_deref_array
*nir_deref_array_create(void *mem_ctx
);
2093 nir_deref_struct
*nir_deref_struct_create(void *mem_ctx
, unsigned field_index
);
2095 typedef bool (*nir_deref_foreach_leaf_cb
)(nir_deref_var
*deref
, void *state
);
2096 bool nir_deref_foreach_leaf(nir_deref_var
*deref
,
2097 nir_deref_foreach_leaf_cb cb
, void *state
);
2099 nir_load_const_instr
*
2100 nir_deref_get_const_initializer_load(nir_shader
*shader
, nir_deref_var
*deref
);
2102 nir_const_value
nir_alu_binop_identity(nir_op binop
, unsigned bit_size
);
2105 * NIR Cursors and Instruction Insertion API
2108 * A tiny struct representing a point to insert/extract instructions or
2109 * control flow nodes. Helps reduce the combinatorial explosion of possible
2110 * points to insert/extract.
2112 * \sa nir_control_flow.h
2115 nir_cursor_before_block
,
2116 nir_cursor_after_block
,
2117 nir_cursor_before_instr
,
2118 nir_cursor_after_instr
,
2119 } nir_cursor_option
;
2122 nir_cursor_option option
;
2129 static inline nir_block
*
2130 nir_cursor_current_block(nir_cursor cursor
)
2132 if (cursor
.option
== nir_cursor_before_instr
||
2133 cursor
.option
== nir_cursor_after_instr
) {
2134 return cursor
.instr
->block
;
2136 return cursor
.block
;
2140 bool nir_cursors_equal(nir_cursor a
, nir_cursor b
);
2142 static inline nir_cursor
2143 nir_before_block(nir_block
*block
)
2146 cursor
.option
= nir_cursor_before_block
;
2147 cursor
.block
= block
;
2151 static inline nir_cursor
2152 nir_after_block(nir_block
*block
)
2155 cursor
.option
= nir_cursor_after_block
;
2156 cursor
.block
= block
;
2160 static inline nir_cursor
2161 nir_before_instr(nir_instr
*instr
)
2164 cursor
.option
= nir_cursor_before_instr
;
2165 cursor
.instr
= instr
;
2169 static inline nir_cursor
2170 nir_after_instr(nir_instr
*instr
)
2173 cursor
.option
= nir_cursor_after_instr
;
2174 cursor
.instr
= instr
;
2178 static inline nir_cursor
2179 nir_after_block_before_jump(nir_block
*block
)
2181 nir_instr
*last_instr
= nir_block_last_instr(block
);
2182 if (last_instr
&& last_instr
->type
== nir_instr_type_jump
) {
2183 return nir_before_instr(last_instr
);
2185 return nir_after_block(block
);
2189 static inline nir_cursor
2190 nir_before_cf_node(nir_cf_node
*node
)
2192 if (node
->type
== nir_cf_node_block
)
2193 return nir_before_block(nir_cf_node_as_block(node
));
2195 return nir_after_block(nir_cf_node_as_block(nir_cf_node_prev(node
)));
2198 static inline nir_cursor
2199 nir_after_cf_node(nir_cf_node
*node
)
2201 if (node
->type
== nir_cf_node_block
)
2202 return nir_after_block(nir_cf_node_as_block(node
));
2204 return nir_before_block(nir_cf_node_as_block(nir_cf_node_next(node
)));
2207 static inline nir_cursor
2208 nir_after_phis(nir_block
*block
)
2210 nir_foreach_instr(instr
, block
) {
2211 if (instr
->type
!= nir_instr_type_phi
)
2212 return nir_before_instr(instr
);
2214 return nir_after_block(block
);
2217 static inline nir_cursor
2218 nir_after_cf_node_and_phis(nir_cf_node
*node
)
2220 if (node
->type
== nir_cf_node_block
)
2221 return nir_after_block(nir_cf_node_as_block(node
));
2223 nir_block
*block
= nir_cf_node_as_block(nir_cf_node_next(node
));
2225 return nir_after_phis(block
);
2228 static inline nir_cursor
2229 nir_before_cf_list(struct exec_list
*cf_list
)
2231 nir_cf_node
*first_node
= exec_node_data(nir_cf_node
,
2232 exec_list_get_head(cf_list
), node
);
2233 return nir_before_cf_node(first_node
);
2236 static inline nir_cursor
2237 nir_after_cf_list(struct exec_list
*cf_list
)
2239 nir_cf_node
*last_node
= exec_node_data(nir_cf_node
,
2240 exec_list_get_tail(cf_list
), node
);
2241 return nir_after_cf_node(last_node
);
2245 * Insert a NIR instruction at the given cursor.
2247 * Note: This does not update the cursor.
2249 void nir_instr_insert(nir_cursor cursor
, nir_instr
*instr
);
2252 nir_instr_insert_before(nir_instr
*instr
, nir_instr
*before
)
2254 nir_instr_insert(nir_before_instr(instr
), before
);
2258 nir_instr_insert_after(nir_instr
*instr
, nir_instr
*after
)
2260 nir_instr_insert(nir_after_instr(instr
), after
);
2264 nir_instr_insert_before_block(nir_block
*block
, nir_instr
*before
)
2266 nir_instr_insert(nir_before_block(block
), before
);
2270 nir_instr_insert_after_block(nir_block
*block
, nir_instr
*after
)
2272 nir_instr_insert(nir_after_block(block
), after
);
2276 nir_instr_insert_before_cf(nir_cf_node
*node
, nir_instr
*before
)
2278 nir_instr_insert(nir_before_cf_node(node
), before
);
2282 nir_instr_insert_after_cf(nir_cf_node
*node
, nir_instr
*after
)
2284 nir_instr_insert(nir_after_cf_node(node
), after
);
2288 nir_instr_insert_before_cf_list(struct exec_list
*list
, nir_instr
*before
)
2290 nir_instr_insert(nir_before_cf_list(list
), before
);
2294 nir_instr_insert_after_cf_list(struct exec_list
*list
, nir_instr
*after
)
2296 nir_instr_insert(nir_after_cf_list(list
), after
);
2299 void nir_instr_remove_v(nir_instr
*instr
);
2301 static inline nir_cursor
2302 nir_instr_remove(nir_instr
*instr
)
2305 nir_instr
*prev
= nir_instr_prev(instr
);
2307 cursor
= nir_after_instr(prev
);
2309 cursor
= nir_before_block(instr
->block
);
2311 nir_instr_remove_v(instr
);
2317 typedef bool (*nir_foreach_ssa_def_cb
)(nir_ssa_def
*def
, void *state
);
2318 typedef bool (*nir_foreach_dest_cb
)(nir_dest
*dest
, void *state
);
2319 typedef bool (*nir_foreach_src_cb
)(nir_src
*src
, void *state
);
2320 bool nir_foreach_ssa_def(nir_instr
*instr
, nir_foreach_ssa_def_cb cb
,
2322 bool nir_foreach_dest(nir_instr
*instr
, nir_foreach_dest_cb cb
, void *state
);
2323 bool nir_foreach_src(nir_instr
*instr
, nir_foreach_src_cb cb
, void *state
);
2325 nir_const_value
*nir_src_as_const_value(nir_src src
);
2326 bool nir_src_is_dynamically_uniform(nir_src src
);
2327 bool nir_srcs_equal(nir_src src1
, nir_src src2
);
2328 void nir_instr_rewrite_src(nir_instr
*instr
, nir_src
*src
, nir_src new_src
);
2329 void nir_instr_move_src(nir_instr
*dest_instr
, nir_src
*dest
, nir_src
*src
);
2330 void nir_if_rewrite_condition(nir_if
*if_stmt
, nir_src new_src
);
2331 void nir_instr_rewrite_dest(nir_instr
*instr
, nir_dest
*dest
,
2333 void nir_instr_rewrite_deref(nir_instr
*instr
, nir_deref_var
**deref
,
2334 nir_deref_var
*new_deref
);
2336 void nir_ssa_dest_init(nir_instr
*instr
, nir_dest
*dest
,
2337 unsigned num_components
, unsigned bit_size
,
2339 void nir_ssa_def_init(nir_instr
*instr
, nir_ssa_def
*def
,
2340 unsigned num_components
, unsigned bit_size
,
2343 nir_ssa_dest_init_for_type(nir_instr
*instr
, nir_dest
*dest
,
2344 const struct glsl_type
*type
,
2347 assert(glsl_type_is_vector_or_scalar(type
));
2348 nir_ssa_dest_init(instr
, dest
, glsl_get_components(type
),
2349 glsl_get_bit_size(type
), name
);
2351 void nir_ssa_def_rewrite_uses(nir_ssa_def
*def
, nir_src new_src
);
2352 void nir_ssa_def_rewrite_uses_after(nir_ssa_def
*def
, nir_src new_src
,
2353 nir_instr
*after_me
);
2355 uint8_t nir_ssa_def_components_read(const nir_ssa_def
*def
);
2358 * finds the next basic block in source-code order, returns NULL if there is
2362 nir_block
*nir_block_cf_tree_next(nir_block
*block
);
2364 /* Performs the opposite of nir_block_cf_tree_next() */
2366 nir_block
*nir_block_cf_tree_prev(nir_block
*block
);
2368 /* Gets the first block in a CF node in source-code order */
2370 nir_block
*nir_cf_node_cf_tree_first(nir_cf_node
*node
);
2372 /* Gets the last block in a CF node in source-code order */
2374 nir_block
*nir_cf_node_cf_tree_last(nir_cf_node
*node
);
2376 /* Gets the next block after a CF node in source-code order */
2378 nir_block
*nir_cf_node_cf_tree_next(nir_cf_node
*node
);
2380 /* Macros for loops that visit blocks in source-code order */
2382 #define nir_foreach_block(block, impl) \
2383 for (nir_block *block = nir_start_block(impl); block != NULL; \
2384 block = nir_block_cf_tree_next(block))
2386 #define nir_foreach_block_safe(block, impl) \
2387 for (nir_block *block = nir_start_block(impl), \
2388 *next = nir_block_cf_tree_next(block); \
2390 block = next, next = nir_block_cf_tree_next(block))
2392 #define nir_foreach_block_reverse(block, impl) \
2393 for (nir_block *block = nir_impl_last_block(impl); block != NULL; \
2394 block = nir_block_cf_tree_prev(block))
2396 #define nir_foreach_block_reverse_safe(block, impl) \
2397 for (nir_block *block = nir_impl_last_block(impl), \
2398 *prev = nir_block_cf_tree_prev(block); \
2400 block = prev, prev = nir_block_cf_tree_prev(block))
2402 #define nir_foreach_block_in_cf_node(block, node) \
2403 for (nir_block *block = nir_cf_node_cf_tree_first(node); \
2404 block != nir_cf_node_cf_tree_next(node); \
2405 block = nir_block_cf_tree_next(block))
2407 /* If the following CF node is an if, this function returns that if.
2408 * Otherwise, it returns NULL.
2410 nir_if
*nir_block_get_following_if(nir_block
*block
);
2412 nir_loop
*nir_block_get_following_loop(nir_block
*block
);
2414 void nir_index_local_regs(nir_function_impl
*impl
);
2415 void nir_index_global_regs(nir_shader
*shader
);
2416 void nir_index_ssa_defs(nir_function_impl
*impl
);
2417 unsigned nir_index_instrs(nir_function_impl
*impl
);
2419 void nir_index_blocks(nir_function_impl
*impl
);
2421 void nir_print_shader(nir_shader
*shader
, FILE *fp
);
2422 void nir_print_shader_annotated(nir_shader
*shader
, FILE *fp
, struct hash_table
*errors
);
2423 void nir_print_instr(const nir_instr
*instr
, FILE *fp
);
2425 nir_shader
*nir_shader_clone(void *mem_ctx
, const nir_shader
*s
);
2426 nir_function_impl
*nir_function_impl_clone(const nir_function_impl
*fi
);
2427 nir_constant
*nir_constant_clone(const nir_constant
*c
, nir_variable
*var
);
2428 nir_variable
*nir_variable_clone(const nir_variable
*c
, nir_shader
*shader
);
2429 nir_deref
*nir_deref_clone(const nir_deref
*deref
, void *mem_ctx
);
2430 nir_deref_var
*nir_deref_var_clone(const nir_deref_var
*deref
, void *mem_ctx
);
2432 nir_shader
*nir_shader_serialize_deserialize(void *mem_ctx
, nir_shader
*s
);
2435 void nir_validate_shader(nir_shader
*shader
);
2436 void nir_metadata_set_validation_flag(nir_shader
*shader
);
2437 void nir_metadata_check_validation_flag(nir_shader
*shader
);
2440 should_clone_nir(void)
2442 static int should_clone
= -1;
2443 if (should_clone
< 0)
2444 should_clone
= env_var_as_boolean("NIR_TEST_CLONE", false);
2446 return should_clone
;
2450 should_serialize_deserialize_nir(void)
2452 static int test_serialize
= -1;
2453 if (test_serialize
< 0)
2454 test_serialize
= env_var_as_boolean("NIR_TEST_SERIALIZE", false);
2456 return test_serialize
;
2460 should_print_nir(void)
2462 static int should_print
= -1;
2463 if (should_print
< 0)
2464 should_print
= env_var_as_boolean("NIR_PRINT", false);
2466 return should_print
;
2469 static inline void nir_validate_shader(nir_shader
*shader
) { (void) shader
; }
2470 static inline void nir_metadata_set_validation_flag(nir_shader
*shader
) { (void) shader
; }
2471 static inline void nir_metadata_check_validation_flag(nir_shader
*shader
) { (void) shader
; }
2472 static inline bool should_clone_nir(void) { return false; }
2473 static inline bool should_serialize_deserialize_nir(void) { return false; }
2474 static inline bool should_print_nir(void) { return false; }
2477 #define _PASS(nir, do_pass) do { \
2479 nir_validate_shader(nir); \
2480 if (should_clone_nir()) { \
2481 nir_shader *clone = nir_shader_clone(ralloc_parent(nir), nir); \
2485 if (should_serialize_deserialize_nir()) { \
2486 void *mem_ctx = ralloc_parent(nir); \
2487 nir = nir_shader_serialize_deserialize(mem_ctx, nir); \
2491 #define NIR_PASS(progress, nir, pass, ...) _PASS(nir, \
2492 nir_metadata_set_validation_flag(nir); \
2493 if (should_print_nir()) \
2494 printf("%s\n", #pass); \
2495 if (pass(nir, ##__VA_ARGS__)) { \
2497 if (should_print_nir()) \
2498 nir_print_shader(nir, stdout); \
2499 nir_metadata_check_validation_flag(nir); \
2503 #define NIR_PASS_V(nir, pass, ...) _PASS(nir, \
2504 if (should_print_nir()) \
2505 printf("%s\n", #pass); \
2506 pass(nir, ##__VA_ARGS__); \
2507 if (should_print_nir()) \
2508 nir_print_shader(nir, stdout); \
2511 void nir_calc_dominance_impl(nir_function_impl
*impl
);
2512 void nir_calc_dominance(nir_shader
*shader
);
2514 nir_block
*nir_dominance_lca(nir_block
*b1
, nir_block
*b2
);
2515 bool nir_block_dominates(nir_block
*parent
, nir_block
*child
);
2517 void nir_dump_dom_tree_impl(nir_function_impl
*impl
, FILE *fp
);
2518 void nir_dump_dom_tree(nir_shader
*shader
, FILE *fp
);
2520 void nir_dump_dom_frontier_impl(nir_function_impl
*impl
, FILE *fp
);
2521 void nir_dump_dom_frontier(nir_shader
*shader
, FILE *fp
);
2523 void nir_dump_cfg_impl(nir_function_impl
*impl
, FILE *fp
);
2524 void nir_dump_cfg(nir_shader
*shader
, FILE *fp
);
2526 int nir_gs_count_vertices(const nir_shader
*shader
);
2528 bool nir_split_var_copies(nir_shader
*shader
);
2530 bool nir_lower_returns_impl(nir_function_impl
*impl
);
2531 bool nir_lower_returns(nir_shader
*shader
);
2533 bool nir_inline_functions(nir_shader
*shader
);
2535 bool nir_propagate_invariant(nir_shader
*shader
);
2537 void nir_lower_var_copy_instr(nir_intrinsic_instr
*copy
, nir_shader
*shader
);
2538 bool nir_lower_var_copies(nir_shader
*shader
);
2540 bool nir_lower_global_vars_to_local(nir_shader
*shader
);
2542 bool nir_lower_indirect_derefs(nir_shader
*shader
, nir_variable_mode modes
);
2544 bool nir_lower_locals_to_regs(nir_shader
*shader
);
2546 void nir_lower_io_to_temporaries(nir_shader
*shader
,
2547 nir_function_impl
*entrypoint
,
2548 bool outputs
, bool inputs
);
2550 void nir_shader_gather_info(nir_shader
*shader
, nir_function_impl
*entrypoint
);
2552 void nir_assign_var_locations(struct exec_list
*var_list
, unsigned *size
,
2553 int (*type_size
)(const struct glsl_type
*));
2555 /* Some helpers to do very simple linking */
2556 bool nir_remove_unused_varyings(nir_shader
*producer
, nir_shader
*consumer
);
2557 void nir_compact_varyings(nir_shader
*producer
, nir_shader
*consumer
,
2558 bool default_to_smooth_interp
);
2561 /* If set, this forces all non-flat fragment shader inputs to be
2562 * interpolated as if with the "sample" qualifier. This requires
2563 * nir_shader_compiler_options::use_interpolated_input_intrinsics.
2565 nir_lower_io_force_sample_interpolation
= (1 << 1),
2566 } nir_lower_io_options
;
2567 bool nir_lower_io(nir_shader
*shader
,
2568 nir_variable_mode modes
,
2569 int (*type_size
)(const struct glsl_type
*),
2570 nir_lower_io_options
);
2571 nir_src
*nir_get_io_offset_src(nir_intrinsic_instr
*instr
);
2572 nir_src
*nir_get_io_vertex_index_src(nir_intrinsic_instr
*instr
);
2574 bool nir_is_per_vertex_io(const nir_variable
*var
, gl_shader_stage stage
);
2576 void nir_lower_io_types(nir_shader
*shader
);
2577 bool nir_lower_regs_to_ssa_impl(nir_function_impl
*impl
);
2578 bool nir_lower_regs_to_ssa(nir_shader
*shader
);
2579 bool nir_lower_vars_to_ssa(nir_shader
*shader
);
2581 bool nir_remove_dead_variables(nir_shader
*shader
, nir_variable_mode modes
);
2582 bool nir_lower_constant_initializers(nir_shader
*shader
,
2583 nir_variable_mode modes
);
2585 bool nir_move_vec_src_uses_to_dest(nir_shader
*shader
);
2586 bool nir_lower_vec_to_movs(nir_shader
*shader
);
2587 void nir_lower_alpha_test(nir_shader
*shader
, enum compare_func func
,
2589 bool nir_lower_alu_to_scalar(nir_shader
*shader
);
2590 bool nir_lower_load_const_to_scalar(nir_shader
*shader
);
2591 bool nir_lower_read_invocation_to_scalar(nir_shader
*shader
);
2592 bool nir_lower_phis_to_scalar(nir_shader
*shader
);
2593 void nir_lower_io_arrays_to_elements(nir_shader
*producer
, nir_shader
*consumer
);
2594 void nir_lower_io_arrays_to_elements_no_indirects(nir_shader
*shader
,
2596 void nir_lower_io_to_scalar(nir_shader
*shader
, nir_variable_mode mask
);
2597 void nir_lower_io_to_scalar_early(nir_shader
*shader
, nir_variable_mode mask
);
2599 bool nir_lower_samplers(nir_shader
*shader
,
2600 const struct gl_shader_program
*shader_program
);
2601 bool nir_lower_samplers_as_deref(nir_shader
*shader
,
2602 const struct gl_shader_program
*shader_program
);
2604 typedef struct nir_lower_subgroups_options
{
2605 uint8_t subgroup_size
;
2606 uint8_t ballot_bit_size
;
2607 bool lower_to_scalar
:1;
2608 bool lower_vote_trivial
:1;
2609 bool lower_vote_eq_to_ballot
:1;
2610 bool lower_subgroup_masks
:1;
2611 bool lower_shuffle
:1;
2612 bool lower_shuffle_to_32bit
:1;
2614 } nir_lower_subgroups_options
;
2616 bool nir_lower_subgroups(nir_shader
*shader
,
2617 const nir_lower_subgroups_options
*options
);
2619 bool nir_lower_system_values(nir_shader
*shader
);
2621 typedef struct nir_lower_tex_options
{
2623 * bitmask of (1 << GLSL_SAMPLER_DIM_x) to control for which
2624 * sampler types a texture projector is lowered.
2629 * If true, lower away nir_tex_src_offset for all texelfetch instructions.
2631 bool lower_txf_offset
;
2634 * If true, lower away nir_tex_src_offset for all rect textures.
2636 bool lower_rect_offset
;
2639 * If true, lower rect textures to 2D, using txs to fetch the
2640 * texture dimensions and dividing the texture coords by the
2641 * texture dims to normalize.
2646 * If true, convert yuv to rgb.
2648 unsigned lower_y_uv_external
;
2649 unsigned lower_y_u_v_external
;
2650 unsigned lower_yx_xuxv_external
;
2651 unsigned lower_xy_uxvx_external
;
2654 * To emulate certain texture wrap modes, this can be used
2655 * to saturate the specified tex coord to [0.0, 1.0]. The
2656 * bits are according to sampler #, ie. if, for example:
2658 * (conf->saturate_s & (1 << n))
2660 * is true, then the s coord for sampler n is saturated.
2662 * Note that clamping must happen *after* projector lowering
2663 * so any projected texture sample instruction with a clamped
2664 * coordinate gets automatically lowered, regardless of the
2665 * 'lower_txp' setting.
2667 unsigned saturate_s
;
2668 unsigned saturate_t
;
2669 unsigned saturate_r
;
2671 /* Bitmask of textures that need swizzling.
2673 * If (swizzle_result & (1 << texture_index)), then the swizzle in
2674 * swizzles[texture_index] is applied to the result of the texturing
2677 unsigned swizzle_result
;
2679 /* A swizzle for each texture. Values 0-3 represent x, y, z, or w swizzles
2680 * while 4 and 5 represent 0 and 1 respectively.
2682 uint8_t swizzles
[32][4];
2685 * Bitmap of textures that need srgb to linear conversion. If
2686 * (lower_srgb & (1 << texture_index)) then the rgb (xyz) components
2687 * of the texture are lowered to linear.
2689 unsigned lower_srgb
;
2692 * If true, lower nir_texop_txd on cube maps with nir_texop_txl.
2694 bool lower_txd_cube_map
;
2697 * If true, lower nir_texop_txd on shadow samplers (except cube maps)
2698 * with nir_texop_txl. Notice that cube map shadow samplers are lowered
2699 * with lower_txd_cube_map.
2701 bool lower_txd_shadow
;
2704 * If true, lower nir_texop_txd on all samplers to a nir_texop_txl.
2705 * Implies lower_txd_cube_map and lower_txd_shadow.
2708 } nir_lower_tex_options
;
2710 bool nir_lower_tex(nir_shader
*shader
,
2711 const nir_lower_tex_options
*options
);
2713 bool nir_lower_idiv(nir_shader
*shader
);
2715 bool nir_lower_clip_vs(nir_shader
*shader
, unsigned ucp_enables
);
2716 bool nir_lower_clip_fs(nir_shader
*shader
, unsigned ucp_enables
);
2717 bool nir_lower_clip_cull_distance_arrays(nir_shader
*nir
);
2719 void nir_lower_two_sided_color(nir_shader
*shader
);
2721 bool nir_lower_clamp_color_outputs(nir_shader
*shader
);
2723 void nir_lower_passthrough_edgeflags(nir_shader
*shader
);
2724 void nir_lower_tes_patch_vertices(nir_shader
*tes
, unsigned patch_vertices
);
2726 typedef struct nir_lower_wpos_ytransform_options
{
2727 gl_state_index16 state_tokens
[STATE_LENGTH
];
2728 bool fs_coord_origin_upper_left
:1;
2729 bool fs_coord_origin_lower_left
:1;
2730 bool fs_coord_pixel_center_integer
:1;
2731 bool fs_coord_pixel_center_half_integer
:1;
2732 } nir_lower_wpos_ytransform_options
;
2734 bool nir_lower_wpos_ytransform(nir_shader
*shader
,
2735 const nir_lower_wpos_ytransform_options
*options
);
2736 bool nir_lower_wpos_center(nir_shader
*shader
, const bool for_sample_shading
);
2738 typedef struct nir_lower_drawpixels_options
{
2739 gl_state_index16 texcoord_state_tokens
[STATE_LENGTH
];
2740 gl_state_index16 scale_state_tokens
[STATE_LENGTH
];
2741 gl_state_index16 bias_state_tokens
[STATE_LENGTH
];
2742 unsigned drawpix_sampler
;
2743 unsigned pixelmap_sampler
;
2745 bool scale_and_bias
:1;
2746 } nir_lower_drawpixels_options
;
2748 void nir_lower_drawpixels(nir_shader
*shader
,
2749 const nir_lower_drawpixels_options
*options
);
2751 typedef struct nir_lower_bitmap_options
{
2754 } nir_lower_bitmap_options
;
2756 void nir_lower_bitmap(nir_shader
*shader
, const nir_lower_bitmap_options
*options
);
2758 bool nir_lower_atomics(nir_shader
*shader
,
2759 const struct gl_shader_program
*shader_program
,
2760 bool use_binding_as_idx
);
2761 bool nir_lower_atomics_to_ssbo(nir_shader
*shader
, unsigned ssbo_offset
);
2762 bool nir_lower_to_source_mods(nir_shader
*shader
);
2764 bool nir_lower_gs_intrinsics(nir_shader
*shader
);
2767 nir_lower_imul64
= (1 << 0),
2768 nir_lower_isign64
= (1 << 1),
2769 /** Lower all int64 modulus and division opcodes */
2770 nir_lower_divmod64
= (1 << 2),
2771 } nir_lower_int64_options
;
2773 bool nir_lower_int64(nir_shader
*shader
, nir_lower_int64_options options
);
2776 nir_lower_drcp
= (1 << 0),
2777 nir_lower_dsqrt
= (1 << 1),
2778 nir_lower_drsq
= (1 << 2),
2779 nir_lower_dtrunc
= (1 << 3),
2780 nir_lower_dfloor
= (1 << 4),
2781 nir_lower_dceil
= (1 << 5),
2782 nir_lower_dfract
= (1 << 6),
2783 nir_lower_dround_even
= (1 << 7),
2784 nir_lower_dmod
= (1 << 8)
2785 } nir_lower_doubles_options
;
2787 bool nir_lower_doubles(nir_shader
*shader
, nir_lower_doubles_options options
);
2788 bool nir_lower_64bit_pack(nir_shader
*shader
);
2790 bool nir_normalize_cubemap_coords(nir_shader
*shader
);
2792 void nir_live_ssa_defs_impl(nir_function_impl
*impl
);
2794 void nir_loop_analyze_impl(nir_function_impl
*impl
,
2795 nir_variable_mode indirect_mask
);
2797 bool nir_ssa_defs_interfere(nir_ssa_def
*a
, nir_ssa_def
*b
);
2799 bool nir_repair_ssa_impl(nir_function_impl
*impl
);
2800 bool nir_repair_ssa(nir_shader
*shader
);
2802 void nir_convert_loop_to_lcssa(nir_loop
*loop
);
2804 /* If phi_webs_only is true, only convert SSA values involved in phi nodes to
2805 * registers. If false, convert all values (even those not involved in a phi
2806 * node) to registers.
2808 bool nir_convert_from_ssa(nir_shader
*shader
, bool phi_webs_only
);
2810 bool nir_lower_phis_to_regs_block(nir_block
*block
);
2811 bool nir_lower_ssa_defs_to_regs_block(nir_block
*block
);
2813 bool nir_opt_algebraic(nir_shader
*shader
);
2814 bool nir_opt_algebraic_before_ffma(nir_shader
*shader
);
2815 bool nir_opt_algebraic_late(nir_shader
*shader
);
2816 bool nir_opt_constant_folding(nir_shader
*shader
);
2818 bool nir_opt_global_to_local(nir_shader
*shader
);
2820 bool nir_copy_prop(nir_shader
*shader
);
2822 bool nir_opt_copy_prop_vars(nir_shader
*shader
);
2824 bool nir_opt_cse(nir_shader
*shader
);
2826 bool nir_opt_dce(nir_shader
*shader
);
2828 bool nir_opt_dead_cf(nir_shader
*shader
);
2830 bool nir_opt_gcm(nir_shader
*shader
, bool value_number
);
2832 bool nir_opt_if(nir_shader
*shader
);
2834 bool nir_opt_intrinsics(nir_shader
*shader
);
2836 bool nir_opt_loop_unroll(nir_shader
*shader
, nir_variable_mode indirect_mask
);
2838 bool nir_opt_move_comparisons(nir_shader
*shader
);
2840 bool nir_opt_move_load_ubo(nir_shader
*shader
);
2842 bool nir_opt_peephole_select(nir_shader
*shader
, unsigned limit
);
2844 bool nir_opt_remove_phis(nir_shader
*shader
);
2846 bool nir_opt_shrink_load(nir_shader
*shader
);
2848 bool nir_opt_trivial_continues(nir_shader
*shader
);
2850 bool nir_opt_undef(nir_shader
*shader
);
2852 bool nir_opt_conditional_discard(nir_shader
*shader
);
2854 void nir_sweep(nir_shader
*shader
);
2856 nir_intrinsic_op
nir_intrinsic_from_system_value(gl_system_value val
);
2857 gl_system_value
nir_system_value_from_intrinsic(nir_intrinsic_op intrin
);