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/bitscan.h"
38 #include "util/bitset.h"
39 #include "util/macros.h"
40 #include "util/format/u_format.h"
41 #include "compiler/nir_types.h"
42 #include "compiler/shader_enums.h"
43 #include "compiler/shader_info.h"
47 #include "util/debug.h"
50 #include "nir_opcodes.h"
52 #if defined(_WIN32) && !defined(snprintf)
53 #define snprintf _snprintf
61 #define NIR_TRUE (~0u)
62 #define NIR_MAX_VEC_COMPONENTS 16
63 #define NIR_MAX_MATRIX_COLUMNS 4
64 #define NIR_STREAM_PACKED (1 << 8)
65 typedef uint16_t nir_component_mask_t
;
68 nir_num_components_valid(unsigned num_components
)
70 return (num_components
>= 1 &&
71 num_components
<= 4) ||
72 num_components
== 8 ||
76 /** Defines a cast function
78 * This macro defines a cast function from in_type to out_type where
79 * out_type is some structure type that contains a field of type out_type.
81 * Note that you have to be a bit careful as the generated cast function
84 #define NIR_DEFINE_CAST(name, in_type, out_type, field, \
85 type_field, type_value) \
86 static inline out_type * \
87 name(const in_type *parent) \
89 assert(parent && parent->type_field == type_value); \
90 return exec_node_data(out_type, parent, field); \
100 * Description of built-in state associated with a uniform
102 * \sa nir_variable::state_slots
105 gl_state_index16 tokens
[STATE_LENGTH
];
110 nir_var_shader_in
= (1 << 0),
111 nir_var_shader_out
= (1 << 1),
112 nir_var_shader_temp
= (1 << 2),
113 nir_var_function_temp
= (1 << 3),
114 nir_var_uniform
= (1 << 4),
115 nir_var_mem_ubo
= (1 << 5),
116 nir_var_system_value
= (1 << 6),
117 nir_var_mem_ssbo
= (1 << 7),
118 nir_var_mem_shared
= (1 << 8),
119 nir_var_mem_global
= (1 << 9),
120 nir_var_mem_push_const
= (1 << 10), /* not actually used for variables */
121 nir_num_variable_modes
= 11,
122 nir_var_all
= (1 << nir_num_variable_modes
) - 1,
129 nir_rounding_mode_undef
= 0,
130 nir_rounding_mode_rtne
= 1, /* round to nearest even */
131 nir_rounding_mode_ru
= 2, /* round up */
132 nir_rounding_mode_rd
= 3, /* round down */
133 nir_rounding_mode_rtz
= 4, /* round towards zero */
150 #define nir_const_value_to_array(arr, c, components, m) \
152 for (unsigned i = 0; i < components; ++i) \
156 static inline nir_const_value
157 nir_const_value_for_raw_uint(uint64_t x
, unsigned bit_size
)
160 memset(&v
, 0, sizeof(v
));
163 case 1: v
.b
= x
; break;
164 case 8: v
.u8
= x
; break;
165 case 16: v
.u16
= x
; break;
166 case 32: v
.u32
= x
; break;
167 case 64: v
.u64
= x
; break;
169 unreachable("Invalid bit size");
175 static inline nir_const_value
176 nir_const_value_for_int(int64_t i
, unsigned bit_size
)
179 memset(&v
, 0, sizeof(v
));
181 assert(bit_size
<= 64);
183 assert(i
>= (-(1ll << (bit_size
- 1))));
184 assert(i
< (1ll << (bit_size
- 1)));
187 return nir_const_value_for_raw_uint(i
, bit_size
);
190 static inline nir_const_value
191 nir_const_value_for_uint(uint64_t u
, unsigned bit_size
)
194 memset(&v
, 0, sizeof(v
));
196 assert(bit_size
<= 64);
198 assert(u
< (1ull << bit_size
));
200 return nir_const_value_for_raw_uint(u
, bit_size
);
203 static inline nir_const_value
204 nir_const_value_for_bool(bool b
, unsigned bit_size
)
206 /* Booleans use a 0/-1 convention */
207 return nir_const_value_for_int(-(int)b
, bit_size
);
210 /* This one isn't inline because it requires half-float conversion */
211 nir_const_value
nir_const_value_for_float(double b
, unsigned bit_size
);
213 static inline int64_t
214 nir_const_value_as_int(nir_const_value value
, unsigned bit_size
)
217 /* int1_t uses 0/-1 convention */
218 case 1: return -(int)value
.b
;
219 case 8: return value
.i8
;
220 case 16: return value
.i16
;
221 case 32: return value
.i32
;
222 case 64: return value
.i64
;
224 unreachable("Invalid bit size");
228 static inline uint64_t
229 nir_const_value_as_uint(nir_const_value value
, unsigned bit_size
)
232 case 1: return value
.b
;
233 case 8: return value
.u8
;
234 case 16: return value
.u16
;
235 case 32: return value
.u32
;
236 case 64: return value
.u64
;
238 unreachable("Invalid bit size");
243 nir_const_value_as_bool(nir_const_value value
, unsigned bit_size
)
245 int64_t i
= nir_const_value_as_int(value
, bit_size
);
247 /* Booleans of any size use 0/-1 convention */
248 assert(i
== 0 || i
== -1);
253 /* This one isn't inline because it requires half-float conversion */
254 double nir_const_value_as_float(nir_const_value value
, unsigned bit_size
);
256 typedef struct nir_constant
{
258 * Value of the constant.
260 * The field used to back the values supplied by the constant is determined
261 * by the type associated with the \c nir_variable. Constants may be
262 * scalars, vectors, or matrices.
264 nir_const_value values
[NIR_MAX_VEC_COMPONENTS
];
266 /* we could get this from the var->type but makes clone *much* easier to
267 * not have to care about the type.
269 unsigned num_elements
;
271 /* Array elements / Structure Fields */
272 struct nir_constant
**elements
;
276 * \brief Layout qualifiers for gl_FragDepth.
278 * The AMD/ARB_conservative_depth extensions allow gl_FragDepth to be redeclared
279 * with a layout qualifier.
282 nir_depth_layout_none
, /**< No depth layout is specified. */
283 nir_depth_layout_any
,
284 nir_depth_layout_greater
,
285 nir_depth_layout_less
,
286 nir_depth_layout_unchanged
290 * Enum keeping track of how a variable was declared.
294 * Normal declaration.
296 nir_var_declared_normally
= 0,
299 * Variable is implicitly generated by the compiler and should not be
300 * visible via the API.
303 } nir_var_declaration_type
;
306 * Either a uniform, global variable, shader input, or shader output. Based on
307 * ir_variable - it should be easy to translate between the two.
310 typedef struct nir_variable
{
311 struct exec_node node
;
314 * Declared type of the variable
316 const struct glsl_type
*type
;
319 * Declared name of the variable
323 struct nir_variable_data
{
325 * Storage class of the variable.
327 * \sa nir_variable_mode
329 nir_variable_mode mode
:11;
332 * Is the variable read-only?
334 * This is set for variables declared as \c const, shader inputs,
337 unsigned read_only
:1;
341 unsigned invariant
:1;
344 * Precision qualifier.
346 * In desktop GLSL we do not care about precision qualifiers at all, in
347 * fact, the spec says that precision qualifiers are ignored.
349 * To make things easy, we make it so that this field is always
350 * GLSL_PRECISION_NONE on desktop shaders. This way all the variables
351 * have the same precision value and the checks we add in the compiler
352 * for this field will never break a desktop shader compile.
354 unsigned precision
:2;
357 * Can this variable be coalesced with another?
359 * This is set by nir_lower_io_to_temporaries to say that any
360 * copies involving this variable should stay put. Propagating it can
361 * duplicate the resulting load/store, which is not wanted, and may
362 * result in a load/store of the variable with an indirect offset which
363 * the backend may not be able to handle.
365 unsigned cannot_coalesce
:1;
368 * When separate shader programs are enabled, only input/outputs between
369 * the stages of a multi-stage separate program can be safely removed
370 * from the shader interface. Other input/outputs must remains active.
372 * This is also used to make sure xfb varyings that are unused by the
373 * fragment shader are not removed.
375 unsigned always_active_io
:1;
378 * Interpolation mode for shader inputs / outputs
380 * \sa glsl_interp_mode
382 unsigned interpolation
:3;
385 * If non-zero, then this variable may be packed along with other variables
386 * into a single varying slot, so this offset should be applied when
387 * accessing components. For example, an offset of 1 means that the x
388 * component of this variable is actually stored in component y of the
389 * location specified by \c location.
391 unsigned location_frac
:2;
394 * If true, this variable represents an array of scalars that should
395 * be tightly packed. In other words, consecutive array elements
396 * should be stored one component apart, rather than one slot apart.
401 * Whether this is a fragment shader output implicitly initialized with
402 * the previous contents of the specified render target at the
403 * framebuffer location corresponding to this shader invocation.
405 unsigned fb_fetch_output
:1;
408 * Non-zero if this variable is considered bindless as defined by
409 * ARB_bindless_texture.
414 * Was an explicit binding set in the shader?
416 unsigned explicit_binding
:1;
419 * Was the location explicitly set in the shader?
421 * If the location is explicitly set in the shader, it \b cannot be changed
422 * by the linker or by the API (e.g., calls to \c glBindAttribLocation have
425 unsigned explicit_location
:1;
428 * Was a transfer feedback buffer set in the shader?
430 unsigned explicit_xfb_buffer
:1;
433 * Was a transfer feedback stride set in the shader?
435 unsigned explicit_xfb_stride
:1;
438 * Was an explicit offset set in the shader?
440 unsigned explicit_offset
:1;
443 * Layout of the matrix. Uses glsl_matrix_layout values.
445 unsigned matrix_layout
:2;
448 * Non-zero if this variable was created by lowering a named interface
451 unsigned from_named_ifc_block
:1;
454 * How the variable was declared. See nir_var_declaration_type.
456 * This is used to detect variables generated by the compiler, so should
457 * not be visible via the API.
459 unsigned how_declared
:2;
462 * Is this variable per-view? If so, we know it must be an array with
463 * size corresponding to the number of views.
468 * \brief Layout qualifier for gl_FragDepth.
470 * This is not equal to \c ir_depth_layout_none if and only if this
471 * variable is \c gl_FragDepth and a layout qualifier is specified.
473 nir_depth_layout depth_layout
:3;
476 * Vertex stream output identifier.
478 * For packed outputs, NIR_STREAM_PACKED is set and bits [2*i+1,2*i]
479 * indicate the stream of the i-th component.
484 * Access flags for memory variables (SSBO/global), image uniforms, and
485 * bindless images in uniforms/inputs/outputs.
487 enum gl_access_qualifier access
:8;
490 * Descriptor set binding for sampler or UBO.
492 unsigned descriptor_set
:5;
495 * output index for dual source blending.
500 * Initial binding point for a sampler or UBO.
502 * For array types, this represents the binding point for the first element.
507 * Storage location of the base of this variable
509 * The precise meaning of this field depends on the nature of the variable.
511 * - Vertex shader input: one of the values from \c gl_vert_attrib.
512 * - Vertex shader output: one of the values from \c gl_varying_slot.
513 * - Geometry shader input: one of the values from \c gl_varying_slot.
514 * - Geometry shader output: one of the values from \c gl_varying_slot.
515 * - Fragment shader input: one of the values from \c gl_varying_slot.
516 * - Fragment shader output: one of the values from \c gl_frag_result.
517 * - Uniforms: Per-stage uniform slot number for default uniform block.
518 * - Uniforms: Index within the uniform block definition for UBO members.
519 * - Non-UBO Uniforms: uniform slot number.
520 * - Other: This field is not currently used.
522 * If the variable is a uniform, shader input, or shader output, and the
523 * slot has not been assigned, the value will be -1.
528 * The actual location of the variable in the IR. Only valid for inputs,
529 * outputs, and uniforms (including samplers and images).
531 unsigned driver_location
;
534 * Location an atomic counter or transform feedback is stored at.
540 /** Image internal format if specified explicitly, otherwise PIPE_FORMAT_NONE. */
541 enum pipe_format format
;
546 * Transform feedback buffer.
551 * Transform feedback stride.
559 * Identifier for this variable generated by nir_index_vars() that is unique
560 * among other variables in the same exec_list.
564 /* Number of nir_variable_data members */
565 uint16_t num_members
;
568 * Built-in state that backs this uniform
570 * Once set at variable creation, \c state_slots must remain invariant.
571 * This is because, ideally, this array would be shared by all clones of
572 * this variable in the IR tree. In other words, we'd really like for it
573 * to be a fly-weight.
575 * If the variable is not a uniform, \c num_state_slots will be zero and
576 * \c state_slots will be \c NULL.
579 uint16_t num_state_slots
; /**< Number of state slots used */
580 nir_state_slot
*state_slots
; /**< State descriptors. */
584 * Constant expression assigned in the initializer of the variable
586 * This field should only be used temporarily by creators of NIR shaders
587 * and then lower_constant_initializers can be used to get rid of them.
588 * Most of the rest of NIR ignores this field or asserts that it's NULL.
590 nir_constant
*constant_initializer
;
593 * Global variable assigned in the initializer of the variable
594 * This field should only be used temporarily by creators of NIR shaders
595 * and then lower_constant_initializers can be used to get rid of them.
596 * Most of the rest of NIR ignores this field or asserts that it's NULL.
598 struct nir_variable
*pointer_initializer
;
601 * For variables that are in an interface block or are an instance of an
602 * interface block, this is the \c GLSL_TYPE_INTERFACE type for that block.
604 * \sa ir_variable::location
606 const struct glsl_type
*interface_type
;
609 * Description of per-member data for per-member struct variables
611 * This is used for variables which are actually an amalgamation of
612 * multiple entities such as a struct of built-in values or a struct of
613 * inputs each with their own layout specifier. This is only allowed on
614 * variables with a struct or array of array of struct type.
616 struct nir_variable_data
*members
;
619 #define nir_foreach_variable(var, var_list) \
620 foreach_list_typed(nir_variable, var, node, var_list)
622 #define nir_foreach_variable_safe(var, var_list) \
623 foreach_list_typed_safe(nir_variable, var, node, var_list)
626 nir_variable_is_global(const nir_variable
*var
)
628 return var
->data
.mode
!= nir_var_function_temp
;
631 typedef struct nir_register
{
632 struct exec_node node
;
634 unsigned num_components
; /** < number of vector components */
635 unsigned num_array_elems
; /** < size of array (0 for no array) */
637 /* The bit-size of each channel; must be one of 8, 16, 32, or 64 */
640 /** generic register index. */
643 /** only for debug purposes, can be NULL */
646 /** set of nir_srcs where this register is used (read from) */
647 struct list_head uses
;
649 /** set of nir_dests where this register is defined (written to) */
650 struct list_head defs
;
652 /** set of nir_ifs where this register is used as a condition */
653 struct list_head if_uses
;
656 #define nir_foreach_register(reg, reg_list) \
657 foreach_list_typed(nir_register, reg, node, reg_list)
658 #define nir_foreach_register_safe(reg, reg_list) \
659 foreach_list_typed_safe(nir_register, reg, node, reg_list)
661 typedef enum PACKED
{
663 nir_instr_type_deref
,
666 nir_instr_type_intrinsic
,
667 nir_instr_type_load_const
,
669 nir_instr_type_ssa_undef
,
671 nir_instr_type_parallel_copy
,
674 typedef struct nir_instr
{
675 struct exec_node node
;
676 struct nir_block
*block
;
679 /* A temporary for optimization and analysis passes to use for storing
680 * flags. For instance, DCE uses this to store the "dead/live" info.
684 /** generic instruction index. */
688 static inline nir_instr
*
689 nir_instr_next(nir_instr
*instr
)
691 struct exec_node
*next
= exec_node_get_next(&instr
->node
);
692 if (exec_node_is_tail_sentinel(next
))
695 return exec_node_data(nir_instr
, next
, node
);
698 static inline nir_instr
*
699 nir_instr_prev(nir_instr
*instr
)
701 struct exec_node
*prev
= exec_node_get_prev(&instr
->node
);
702 if (exec_node_is_head_sentinel(prev
))
705 return exec_node_data(nir_instr
, prev
, node
);
709 nir_instr_is_first(const nir_instr
*instr
)
711 return exec_node_is_head_sentinel(exec_node_get_prev_const(&instr
->node
));
715 nir_instr_is_last(const nir_instr
*instr
)
717 return exec_node_is_tail_sentinel(exec_node_get_next_const(&instr
->node
));
720 typedef struct nir_ssa_def
{
721 /** for debugging only, can be NULL */
724 /** generic SSA definition index. */
727 /** Index into the live_in and live_out bitfields */
730 /** Instruction which produces this SSA value. */
731 nir_instr
*parent_instr
;
733 /** set of nir_instrs where this register is used (read from) */
734 struct list_head uses
;
736 /** set of nir_ifs where this register is used as a condition */
737 struct list_head if_uses
;
739 uint8_t num_components
;
741 /* The bit-size of each channel; must be one of 8, 16, 32, or 64 */
749 struct nir_src
*indirect
; /** < NULL for no indirect offset */
750 unsigned base_offset
;
752 /* TODO use-def chain goes here */
756 nir_instr
*parent_instr
;
757 struct list_head def_link
;
760 struct nir_src
*indirect
; /** < NULL for no indirect offset */
761 unsigned base_offset
;
763 /* TODO def-use chain goes here */
768 typedef struct nir_src
{
770 /** Instruction that consumes this value as a source. */
771 nir_instr
*parent_instr
;
772 struct nir_if
*parent_if
;
775 struct list_head use_link
;
785 static inline nir_src
788 nir_src src
= { { NULL
} };
792 #define NIR_SRC_INIT nir_src_init()
794 #define nir_foreach_use(src, reg_or_ssa_def) \
795 list_for_each_entry(nir_src, src, &(reg_or_ssa_def)->uses, use_link)
797 #define nir_foreach_use_safe(src, reg_or_ssa_def) \
798 list_for_each_entry_safe(nir_src, src, &(reg_or_ssa_def)->uses, use_link)
800 #define nir_foreach_if_use(src, reg_or_ssa_def) \
801 list_for_each_entry(nir_src, src, &(reg_or_ssa_def)->if_uses, use_link)
803 #define nir_foreach_if_use_safe(src, reg_or_ssa_def) \
804 list_for_each_entry_safe(nir_src, src, &(reg_or_ssa_def)->if_uses, use_link)
815 static inline nir_dest
818 nir_dest dest
= { { { NULL
} } };
822 #define NIR_DEST_INIT nir_dest_init()
824 #define nir_foreach_def(dest, reg) \
825 list_for_each_entry(nir_dest, dest, &(reg)->defs, reg.def_link)
827 #define nir_foreach_def_safe(dest, reg) \
828 list_for_each_entry_safe(nir_dest, dest, &(reg)->defs, reg.def_link)
830 static inline nir_src
831 nir_src_for_ssa(nir_ssa_def
*def
)
833 nir_src src
= NIR_SRC_INIT
;
841 static inline nir_src
842 nir_src_for_reg(nir_register
*reg
)
844 nir_src src
= NIR_SRC_INIT
;
848 src
.reg
.indirect
= NULL
;
849 src
.reg
.base_offset
= 0;
854 static inline nir_dest
855 nir_dest_for_reg(nir_register
*reg
)
857 nir_dest dest
= NIR_DEST_INIT
;
864 static inline unsigned
865 nir_src_bit_size(nir_src src
)
867 return src
.is_ssa
? src
.ssa
->bit_size
: src
.reg
.reg
->bit_size
;
870 static inline unsigned
871 nir_src_num_components(nir_src src
)
873 return src
.is_ssa
? src
.ssa
->num_components
: src
.reg
.reg
->num_components
;
877 nir_src_is_const(nir_src src
)
880 src
.ssa
->parent_instr
->type
== nir_instr_type_load_const
;
883 static inline unsigned
884 nir_dest_bit_size(nir_dest dest
)
886 return dest
.is_ssa
? dest
.ssa
.bit_size
: dest
.reg
.reg
->bit_size
;
889 static inline unsigned
890 nir_dest_num_components(nir_dest dest
)
892 return dest
.is_ssa
? dest
.ssa
.num_components
: dest
.reg
.reg
->num_components
;
895 /* Are all components the same, ie. .xxxx */
897 nir_is_same_comp_swizzle(uint8_t *swiz
, unsigned nr_comp
)
899 for (unsigned i
= 1; i
< nr_comp
; i
++)
900 if (swiz
[i
] != swiz
[0])
905 /* Are all components sequential, ie. .yzw */
907 nir_is_sequential_comp_swizzle(uint8_t *swiz
, unsigned nr_comp
)
909 for (unsigned i
= 1; i
< nr_comp
; i
++)
910 if (swiz
[i
] != (swiz
[0] + i
))
915 void nir_src_copy(nir_src
*dest
, const nir_src
*src
, void *instr_or_if
);
916 void nir_dest_copy(nir_dest
*dest
, const nir_dest
*src
, nir_instr
*instr
);
922 * \name input modifiers
926 * For inputs interpreted as floating point, flips the sign bit. For
927 * inputs interpreted as integers, performs the two's complement negation.
932 * Clears the sign bit for floating point values, and computes the integer
933 * absolute value for integers. Note that the negate modifier acts after
934 * the absolute value modifier, therefore if both are set then all inputs
935 * will become negative.
941 * For each input component, says which component of the register it is
942 * chosen from. Note that which elements of the swizzle are used and which
943 * are ignored are based on the write mask for most opcodes - for example,
944 * a statement like "foo.xzw = bar.zyx" would have a writemask of 1101b and
945 * a swizzle of {2, x, 1, 0} where x means "don't care."
947 uint8_t swizzle
[NIR_MAX_VEC_COMPONENTS
];
954 * \name saturate output modifier
956 * Only valid for opcodes that output floating-point numbers. Clamps the
957 * output to between 0.0 and 1.0 inclusive.
962 unsigned write_mask
: NIR_MAX_VEC_COMPONENTS
; /* ignored if dest.is_ssa is true */
965 /** NIR sized and unsized types
967 * The values in this enum are carefully chosen so that the sized type is
968 * just the unsized type OR the number of bits.
971 nir_type_invalid
= 0, /* Not a valid type */
975 nir_type_float
= 128,
976 nir_type_bool1
= 1 | nir_type_bool
,
977 nir_type_bool8
= 8 | nir_type_bool
,
978 nir_type_bool16
= 16 | nir_type_bool
,
979 nir_type_bool32
= 32 | nir_type_bool
,
980 nir_type_int1
= 1 | nir_type_int
,
981 nir_type_int8
= 8 | nir_type_int
,
982 nir_type_int16
= 16 | nir_type_int
,
983 nir_type_int32
= 32 | nir_type_int
,
984 nir_type_int64
= 64 | nir_type_int
,
985 nir_type_uint1
= 1 | nir_type_uint
,
986 nir_type_uint8
= 8 | nir_type_uint
,
987 nir_type_uint16
= 16 | nir_type_uint
,
988 nir_type_uint32
= 32 | nir_type_uint
,
989 nir_type_uint64
= 64 | nir_type_uint
,
990 nir_type_float16
= 16 | nir_type_float
,
991 nir_type_float32
= 32 | nir_type_float
,
992 nir_type_float64
= 64 | nir_type_float
,
995 #define NIR_ALU_TYPE_SIZE_MASK 0x79
996 #define NIR_ALU_TYPE_BASE_TYPE_MASK 0x86
998 static inline unsigned
999 nir_alu_type_get_type_size(nir_alu_type type
)
1001 return type
& NIR_ALU_TYPE_SIZE_MASK
;
1004 static inline unsigned
1005 nir_alu_type_get_base_type(nir_alu_type type
)
1007 return type
& NIR_ALU_TYPE_BASE_TYPE_MASK
;
1010 static inline nir_alu_type
1011 nir_get_nir_type_for_glsl_base_type(enum glsl_base_type base_type
)
1013 switch (base_type
) {
1014 case GLSL_TYPE_BOOL
:
1015 return nir_type_bool1
;
1017 case GLSL_TYPE_UINT
:
1018 return nir_type_uint32
;
1021 return nir_type_int32
;
1023 case GLSL_TYPE_UINT16
:
1024 return nir_type_uint16
;
1026 case GLSL_TYPE_INT16
:
1027 return nir_type_int16
;
1029 case GLSL_TYPE_UINT8
:
1030 return nir_type_uint8
;
1031 case GLSL_TYPE_INT8
:
1032 return nir_type_int8
;
1033 case GLSL_TYPE_UINT64
:
1034 return nir_type_uint64
;
1036 case GLSL_TYPE_INT64
:
1037 return nir_type_int64
;
1039 case GLSL_TYPE_FLOAT
:
1040 return nir_type_float32
;
1042 case GLSL_TYPE_FLOAT16
:
1043 return nir_type_float16
;
1045 case GLSL_TYPE_DOUBLE
:
1046 return nir_type_float64
;
1049 case GLSL_TYPE_SAMPLER
:
1050 case GLSL_TYPE_IMAGE
:
1051 case GLSL_TYPE_ATOMIC_UINT
:
1052 case GLSL_TYPE_STRUCT
:
1053 case GLSL_TYPE_INTERFACE
:
1054 case GLSL_TYPE_ARRAY
:
1055 case GLSL_TYPE_VOID
:
1056 case GLSL_TYPE_SUBROUTINE
:
1057 case GLSL_TYPE_FUNCTION
:
1058 case GLSL_TYPE_ERROR
:
1059 return nir_type_invalid
;
1062 unreachable("unknown type");
1065 static inline nir_alu_type
1066 nir_get_nir_type_for_glsl_type(const struct glsl_type
*type
)
1068 return nir_get_nir_type_for_glsl_base_type(glsl_get_base_type(type
));
1071 nir_op
nir_type_conversion_op(nir_alu_type src
, nir_alu_type dst
,
1072 nir_rounding_mode rnd
);
1074 static inline nir_op
1075 nir_op_vec(unsigned components
)
1077 switch (components
) {
1078 case 1: return nir_op_mov
;
1079 case 2: return nir_op_vec2
;
1080 case 3: return nir_op_vec3
;
1081 case 4: return nir_op_vec4
;
1082 case 8: return nir_op_vec8
;
1083 case 16: return nir_op_vec16
;
1084 default: unreachable("bad component count");
1089 nir_op_is_vec(nir_op op
)
1105 nir_is_float_control_signed_zero_inf_nan_preserve(unsigned execution_mode
, unsigned bit_size
)
1107 return (16 == bit_size
&& execution_mode
& FLOAT_CONTROLS_SIGNED_ZERO_INF_NAN_PRESERVE_FP16
) ||
1108 (32 == bit_size
&& execution_mode
& FLOAT_CONTROLS_SIGNED_ZERO_INF_NAN_PRESERVE_FP32
) ||
1109 (64 == bit_size
&& execution_mode
& FLOAT_CONTROLS_SIGNED_ZERO_INF_NAN_PRESERVE_FP64
);
1113 nir_is_denorm_flush_to_zero(unsigned execution_mode
, unsigned bit_size
)
1115 return (16 == bit_size
&& execution_mode
& FLOAT_CONTROLS_DENORM_FLUSH_TO_ZERO_FP16
) ||
1116 (32 == bit_size
&& execution_mode
& FLOAT_CONTROLS_DENORM_FLUSH_TO_ZERO_FP32
) ||
1117 (64 == bit_size
&& execution_mode
& FLOAT_CONTROLS_DENORM_FLUSH_TO_ZERO_FP64
);
1121 nir_is_denorm_preserve(unsigned execution_mode
, unsigned bit_size
)
1123 return (16 == bit_size
&& execution_mode
& FLOAT_CONTROLS_DENORM_PRESERVE_FP16
) ||
1124 (32 == bit_size
&& execution_mode
& FLOAT_CONTROLS_DENORM_PRESERVE_FP32
) ||
1125 (64 == bit_size
&& execution_mode
& FLOAT_CONTROLS_DENORM_PRESERVE_FP64
);
1129 nir_is_rounding_mode_rtne(unsigned execution_mode
, unsigned bit_size
)
1131 return (16 == bit_size
&& execution_mode
& FLOAT_CONTROLS_ROUNDING_MODE_RTE_FP16
) ||
1132 (32 == bit_size
&& execution_mode
& FLOAT_CONTROLS_ROUNDING_MODE_RTE_FP32
) ||
1133 (64 == bit_size
&& execution_mode
& FLOAT_CONTROLS_ROUNDING_MODE_RTE_FP64
);
1137 nir_is_rounding_mode_rtz(unsigned execution_mode
, unsigned bit_size
)
1139 return (16 == bit_size
&& execution_mode
& FLOAT_CONTROLS_ROUNDING_MODE_RTZ_FP16
) ||
1140 (32 == bit_size
&& execution_mode
& FLOAT_CONTROLS_ROUNDING_MODE_RTZ_FP32
) ||
1141 (64 == bit_size
&& execution_mode
& FLOAT_CONTROLS_ROUNDING_MODE_RTZ_FP64
);
1145 nir_has_any_rounding_mode_rtz(unsigned execution_mode
)
1147 return (execution_mode
& FLOAT_CONTROLS_ROUNDING_MODE_RTZ_FP16
) ||
1148 (execution_mode
& FLOAT_CONTROLS_ROUNDING_MODE_RTZ_FP32
) ||
1149 (execution_mode
& FLOAT_CONTROLS_ROUNDING_MODE_RTZ_FP64
);
1153 nir_has_any_rounding_mode_rtne(unsigned execution_mode
)
1155 return (execution_mode
& FLOAT_CONTROLS_ROUNDING_MODE_RTE_FP16
) ||
1156 (execution_mode
& FLOAT_CONTROLS_ROUNDING_MODE_RTE_FP32
) ||
1157 (execution_mode
& FLOAT_CONTROLS_ROUNDING_MODE_RTE_FP64
);
1160 static inline nir_rounding_mode
1161 nir_get_rounding_mode_from_float_controls(unsigned execution_mode
,
1164 if (nir_alu_type_get_base_type(type
) != nir_type_float
)
1165 return nir_rounding_mode_undef
;
1167 unsigned bit_size
= nir_alu_type_get_type_size(type
);
1169 if (nir_is_rounding_mode_rtz(execution_mode
, bit_size
))
1170 return nir_rounding_mode_rtz
;
1171 if (nir_is_rounding_mode_rtne(execution_mode
, bit_size
))
1172 return nir_rounding_mode_rtne
;
1173 return nir_rounding_mode_undef
;
1177 nir_has_any_rounding_mode_enabled(unsigned execution_mode
)
1180 nir_has_any_rounding_mode_rtne(execution_mode
) ||
1181 nir_has_any_rounding_mode_rtz(execution_mode
);
1187 * Operation where the first two sources are commutative.
1189 * For 2-source operations, this just mathematical commutativity. Some
1190 * 3-source operations, like ffma, are only commutative in the first two
1193 NIR_OP_IS_2SRC_COMMUTATIVE
= (1 << 0),
1194 NIR_OP_IS_ASSOCIATIVE
= (1 << 1),
1195 } nir_op_algebraic_property
;
1200 unsigned num_inputs
;
1203 * The number of components in the output
1205 * If non-zero, this is the size of the output and input sizes are
1206 * explicitly given; swizzle and writemask are still in effect, but if
1207 * the output component is masked out, then the input component may
1210 * If zero, the opcode acts in the standard, per-component manner; the
1211 * operation is performed on each component (except the ones that are
1212 * masked out) with the input being taken from the input swizzle for
1215 * The size of some of the inputs may be given (i.e. non-zero) even
1216 * though output_size is zero; in that case, the inputs with a zero
1217 * size act per-component, while the inputs with non-zero size don't.
1219 unsigned output_size
;
1222 * The type of vector that the instruction outputs. Note that the
1223 * staurate modifier is only allowed on outputs with the float type.
1226 nir_alu_type output_type
;
1229 * The number of components in each input
1231 unsigned input_sizes
[NIR_MAX_VEC_COMPONENTS
];
1234 * The type of vector that each input takes. Note that negate and
1235 * absolute value are only allowed on inputs with int or float type and
1236 * behave differently on the two.
1238 nir_alu_type input_types
[NIR_MAX_VEC_COMPONENTS
];
1240 nir_op_algebraic_property algebraic_properties
;
1242 /* Whether this represents a numeric conversion opcode */
1246 extern const nir_op_info nir_op_infos
[nir_num_opcodes
];
1248 typedef struct nir_alu_instr
{
1252 /** Indicates that this ALU instruction generates an exact value
1254 * This is kind of a mixture of GLSL "precise" and "invariant" and not
1255 * really equivalent to either. This indicates that the value generated by
1256 * this operation is high-precision and any code transformations that touch
1257 * it must ensure that the resulting value is bit-for-bit identical to the
1263 * Indicates that this instruction do not cause wrapping to occur, in the
1264 * form of overflow or underflow.
1266 bool no_signed_wrap
:1;
1267 bool no_unsigned_wrap
:1;
1273 void nir_alu_src_copy(nir_alu_src
*dest
, const nir_alu_src
*src
,
1274 nir_alu_instr
*instr
);
1275 void nir_alu_dest_copy(nir_alu_dest
*dest
, const nir_alu_dest
*src
,
1276 nir_alu_instr
*instr
);
1278 /* is this source channel used? */
1280 nir_alu_instr_channel_used(const nir_alu_instr
*instr
, unsigned src
,
1283 if (nir_op_infos
[instr
->op
].input_sizes
[src
] > 0)
1284 return channel
< nir_op_infos
[instr
->op
].input_sizes
[src
];
1286 return (instr
->dest
.write_mask
>> channel
) & 1;
1289 static inline nir_component_mask_t
1290 nir_alu_instr_src_read_mask(const nir_alu_instr
*instr
, unsigned src
)
1292 nir_component_mask_t read_mask
= 0;
1293 for (unsigned c
= 0; c
< NIR_MAX_VEC_COMPONENTS
; c
++) {
1294 if (!nir_alu_instr_channel_used(instr
, src
, c
))
1297 read_mask
|= (1 << instr
->src
[src
].swizzle
[c
]);
1303 * Get the number of channels used for a source
1305 static inline unsigned
1306 nir_ssa_alu_instr_src_components(const nir_alu_instr
*instr
, unsigned src
)
1308 if (nir_op_infos
[instr
->op
].input_sizes
[src
] > 0)
1309 return nir_op_infos
[instr
->op
].input_sizes
[src
];
1311 return nir_dest_num_components(instr
->dest
.dest
);
1315 nir_alu_instr_is_comparison(const nir_alu_instr
*instr
)
1317 switch (instr
->op
) {
1337 bool nir_const_value_negative_equal(nir_const_value c1
, nir_const_value c2
,
1338 nir_alu_type full_type
);
1340 bool nir_alu_srcs_equal(const nir_alu_instr
*alu1
, const nir_alu_instr
*alu2
,
1341 unsigned src1
, unsigned src2
);
1343 bool nir_alu_srcs_negative_equal(const nir_alu_instr
*alu1
,
1344 const nir_alu_instr
*alu2
,
1345 unsigned src1
, unsigned src2
);
1349 nir_deref_type_array
,
1350 nir_deref_type_array_wildcard
,
1351 nir_deref_type_ptr_as_array
,
1352 nir_deref_type_struct
,
1353 nir_deref_type_cast
,
1359 /** The type of this deref instruction */
1360 nir_deref_type deref_type
;
1362 /** The mode of the underlying variable */
1363 nir_variable_mode mode
;
1365 /** The dereferenced type of the resulting pointer value */
1366 const struct glsl_type
*type
;
1369 /** Variable being dereferenced if deref_type is a deref_var */
1372 /** Parent deref if deref_type is not deref_var */
1376 /** Additional deref parameters */
1387 unsigned ptr_stride
;
1391 /** Destination to store the resulting "pointer" */
1395 static inline nir_deref_instr
*nir_src_as_deref(nir_src src
);
1397 static inline nir_deref_instr
*
1398 nir_deref_instr_parent(const nir_deref_instr
*instr
)
1400 if (instr
->deref_type
== nir_deref_type_var
)
1403 return nir_src_as_deref(instr
->parent
);
1406 static inline nir_variable
*
1407 nir_deref_instr_get_variable(const nir_deref_instr
*instr
)
1409 while (instr
->deref_type
!= nir_deref_type_var
) {
1410 if (instr
->deref_type
== nir_deref_type_cast
)
1413 instr
= nir_deref_instr_parent(instr
);
1419 bool nir_deref_instr_has_indirect(nir_deref_instr
*instr
);
1420 bool nir_deref_instr_is_known_out_of_bounds(nir_deref_instr
*instr
);
1421 bool nir_deref_instr_has_complex_use(nir_deref_instr
*instr
);
1423 bool nir_deref_instr_remove_if_unused(nir_deref_instr
*instr
);
1425 unsigned nir_deref_instr_ptr_as_array_stride(nir_deref_instr
*instr
);
1430 struct nir_function
*callee
;
1432 unsigned num_params
;
1436 #include "nir_intrinsics.h"
1438 #define NIR_INTRINSIC_MAX_CONST_INDEX 4
1440 /** Represents an intrinsic
1442 * An intrinsic is an instruction type for handling things that are
1443 * more-or-less regular operations but don't just consume and produce SSA
1444 * values like ALU operations do. Intrinsics are not for things that have
1445 * special semantic meaning such as phi nodes and parallel copies.
1446 * Examples of intrinsics include variable load/store operations, system
1447 * value loads, and the like. Even though texturing more-or-less falls
1448 * under this category, texturing is its own instruction type because
1449 * trying to represent texturing with intrinsics would lead to a
1450 * combinatorial explosion of intrinsic opcodes.
1452 * By having a single instruction type for handling a lot of different
1453 * cases, optimization passes can look for intrinsics and, for the most
1454 * part, completely ignore them. Each intrinsic type also has a few
1455 * possible flags that govern whether or not they can be reordered or
1456 * eliminated. That way passes like dead code elimination can still work
1457 * on intrisics without understanding the meaning of each.
1459 * Each intrinsic has some number of constant indices, some number of
1460 * variables, and some number of sources. What these sources, variables,
1461 * and indices mean depends on the intrinsic and is documented with the
1462 * intrinsic declaration in nir_intrinsics.h. Intrinsics and texture
1463 * instructions are the only types of instruction that can operate on
1469 nir_intrinsic_op intrinsic
;
1473 /** number of components if this is a vectorized intrinsic
1475 * Similarly to ALU operations, some intrinsics are vectorized.
1476 * An intrinsic is vectorized if nir_intrinsic_infos.dest_components == 0.
1477 * For vectorized intrinsics, the num_components field specifies the
1478 * number of destination components and the number of source components
1479 * for all sources with nir_intrinsic_infos.src_components[i] == 0.
1481 uint8_t num_components
;
1483 int const_index
[NIR_INTRINSIC_MAX_CONST_INDEX
];
1486 } nir_intrinsic_instr
;
1488 static inline nir_variable
*
1489 nir_intrinsic_get_var(nir_intrinsic_instr
*intrin
, unsigned i
)
1491 return nir_deref_instr_get_variable(nir_src_as_deref(intrin
->src
[i
]));
1495 /* Memory ordering. */
1496 NIR_MEMORY_ACQUIRE
= 1 << 0,
1497 NIR_MEMORY_RELEASE
= 1 << 1,
1498 NIR_MEMORY_ACQ_REL
= NIR_MEMORY_ACQUIRE
| NIR_MEMORY_RELEASE
,
1500 /* Memory visibility operations. */
1501 NIR_MEMORY_MAKE_AVAILABLE
= 1 << 2,
1502 NIR_MEMORY_MAKE_VISIBLE
= 1 << 3,
1503 } nir_memory_semantics
;
1506 NIR_SCOPE_INVOCATION
,
1508 NIR_SCOPE_WORKGROUP
,
1509 NIR_SCOPE_QUEUE_FAMILY
,
1514 * \name NIR intrinsics semantic flags
1516 * information about what the compiler can do with the intrinsics.
1518 * \sa nir_intrinsic_info::flags
1522 * whether the intrinsic can be safely eliminated if none of its output
1523 * value is not being used.
1525 NIR_INTRINSIC_CAN_ELIMINATE
= (1 << 0),
1528 * Whether the intrinsic can be reordered with respect to any other
1529 * intrinsic, i.e. whether the only reordering dependencies of the
1530 * intrinsic are due to the register reads/writes.
1532 NIR_INTRINSIC_CAN_REORDER
= (1 << 1),
1533 } nir_intrinsic_semantic_flag
;
1536 * \name NIR intrinsics const-index flag
1538 * Indicates the usage of a const_index slot.
1540 * \sa nir_intrinsic_info::index_map
1544 * Generally instructions that take a offset src argument, can encode
1545 * a constant 'base' value which is added to the offset.
1547 NIR_INTRINSIC_BASE
= 1,
1550 * For store instructions, a writemask for the store.
1552 NIR_INTRINSIC_WRMASK
,
1555 * The stream-id for GS emit_vertex/end_primitive intrinsics.
1557 NIR_INTRINSIC_STREAM_ID
,
1560 * The clip-plane id for load_user_clip_plane intrinsic.
1562 NIR_INTRINSIC_UCP_ID
,
1565 * The amount of data, starting from BASE, that this instruction may
1566 * access. This is used to provide bounds if the offset is not constant.
1568 NIR_INTRINSIC_RANGE
,
1571 * The Vulkan descriptor set for vulkan_resource_index intrinsic.
1573 NIR_INTRINSIC_DESC_SET
,
1576 * The Vulkan descriptor set binding for vulkan_resource_index intrinsic.
1578 NIR_INTRINSIC_BINDING
,
1583 NIR_INTRINSIC_COMPONENT
,
1586 * Interpolation mode (only meaningful for FS inputs).
1588 NIR_INTRINSIC_INTERP_MODE
,
1591 * A binary nir_op to use when performing a reduction or scan operation
1593 NIR_INTRINSIC_REDUCTION_OP
,
1596 * Cluster size for reduction operations
1598 NIR_INTRINSIC_CLUSTER_SIZE
,
1601 * Parameter index for a load_param intrinsic
1603 NIR_INTRINSIC_PARAM_IDX
,
1606 * Image dimensionality for image intrinsics
1608 * One of GLSL_SAMPLER_DIM_*
1610 NIR_INTRINSIC_IMAGE_DIM
,
1613 * Non-zero if we are accessing an array image
1615 NIR_INTRINSIC_IMAGE_ARRAY
,
1618 * Image format for image intrinsics
1620 NIR_INTRINSIC_FORMAT
,
1623 * Access qualifiers for image and memory access intrinsics
1625 NIR_INTRINSIC_ACCESS
,
1628 * Alignment for offsets and addresses
1630 * These two parameters, specify an alignment in terms of a multiplier and
1631 * an offset. The offset or address parameter X of the intrinsic is
1632 * guaranteed to satisfy the following:
1634 * (X - align_offset) % align_mul == 0
1636 NIR_INTRINSIC_ALIGN_MUL
,
1637 NIR_INTRINSIC_ALIGN_OFFSET
,
1640 * The Vulkan descriptor type for a vulkan_resource_[re]index intrinsic.
1642 NIR_INTRINSIC_DESC_TYPE
,
1645 * The nir_alu_type of a uniform/input/output
1650 * The swizzle mask for the instructions
1651 * SwizzleInvocationsAMD and SwizzleInvocationsMaskedAMD
1653 NIR_INTRINSIC_SWIZZLE_MASK
,
1655 /* Separate source/dest access flags for copies */
1656 NIR_INTRINSIC_SRC_ACCESS
,
1657 NIR_INTRINSIC_DST_ACCESS
,
1659 /* Driver location for nir_load_patch_location_ir3 */
1660 NIR_INTRINSIC_DRIVER_LOCATION
,
1663 * Mask of nir_memory_semantics, includes ordering and visibility.
1665 NIR_INTRINSIC_MEMORY_SEMANTICS
,
1668 * Mask of nir_variable_modes affected by the memory operation.
1670 NIR_INTRINSIC_MEMORY_MODES
,
1673 * Value of nir_scope.
1675 NIR_INTRINSIC_MEMORY_SCOPE
,
1677 NIR_INTRINSIC_NUM_INDEX_FLAGS
,
1679 } nir_intrinsic_index_flag
;
1681 #define NIR_INTRINSIC_MAX_INPUTS 5
1686 unsigned num_srcs
; /** < number of register/SSA inputs */
1688 /** number of components of each input register
1690 * If this value is 0, the number of components is given by the
1691 * num_components field of nir_intrinsic_instr. If this value is -1, the
1692 * intrinsic consumes however many components are provided and it is not
1695 int src_components
[NIR_INTRINSIC_MAX_INPUTS
];
1699 /** number of components of the output register
1701 * If this value is 0, the number of components is given by the
1702 * num_components field of nir_intrinsic_instr.
1704 unsigned dest_components
;
1706 /** bitfield of legal bit sizes */
1707 unsigned dest_bit_sizes
;
1709 /** the number of constant indices used by the intrinsic */
1710 unsigned num_indices
;
1712 /** indicates the usage of intr->const_index[n] */
1713 unsigned index_map
[NIR_INTRINSIC_NUM_INDEX_FLAGS
];
1715 /** semantic flags for calls to this intrinsic */
1716 nir_intrinsic_semantic_flag flags
;
1717 } nir_intrinsic_info
;
1719 extern const nir_intrinsic_info nir_intrinsic_infos
[nir_num_intrinsics
];
1721 static inline unsigned
1722 nir_intrinsic_src_components(nir_intrinsic_instr
*intr
, unsigned srcn
)
1724 const nir_intrinsic_info
*info
= &nir_intrinsic_infos
[intr
->intrinsic
];
1725 assert(srcn
< info
->num_srcs
);
1726 if (info
->src_components
[srcn
] > 0)
1727 return info
->src_components
[srcn
];
1728 else if (info
->src_components
[srcn
] == 0)
1729 return intr
->num_components
;
1731 return nir_src_num_components(intr
->src
[srcn
]);
1734 static inline unsigned
1735 nir_intrinsic_dest_components(nir_intrinsic_instr
*intr
)
1737 const nir_intrinsic_info
*info
= &nir_intrinsic_infos
[intr
->intrinsic
];
1738 if (!info
->has_dest
)
1740 else if (info
->dest_components
)
1741 return info
->dest_components
;
1743 return intr
->num_components
;
1746 #define INTRINSIC_IDX_ACCESSORS(name, flag, type) \
1747 static inline type \
1748 nir_intrinsic_##name(const nir_intrinsic_instr *instr) \
1750 const nir_intrinsic_info *info = &nir_intrinsic_infos[instr->intrinsic]; \
1751 assert(info->index_map[NIR_INTRINSIC_##flag] > 0); \
1752 return (type)instr->const_index[info->index_map[NIR_INTRINSIC_##flag] - 1]; \
1754 static inline void \
1755 nir_intrinsic_set_##name(nir_intrinsic_instr *instr, type val) \
1757 const nir_intrinsic_info *info = &nir_intrinsic_infos[instr->intrinsic]; \
1758 assert(info->index_map[NIR_INTRINSIC_##flag] > 0); \
1759 instr->const_index[info->index_map[NIR_INTRINSIC_##flag] - 1] = val; \
1762 INTRINSIC_IDX_ACCESSORS(write_mask
, WRMASK
, unsigned)
1763 INTRINSIC_IDX_ACCESSORS(base
, BASE
, int)
1764 INTRINSIC_IDX_ACCESSORS(stream_id
, STREAM_ID
, unsigned)
1765 INTRINSIC_IDX_ACCESSORS(ucp_id
, UCP_ID
, unsigned)
1766 INTRINSIC_IDX_ACCESSORS(range
, RANGE
, unsigned)
1767 INTRINSIC_IDX_ACCESSORS(desc_set
, DESC_SET
, unsigned)
1768 INTRINSIC_IDX_ACCESSORS(binding
, BINDING
, unsigned)
1769 INTRINSIC_IDX_ACCESSORS(component
, COMPONENT
, unsigned)
1770 INTRINSIC_IDX_ACCESSORS(interp_mode
, INTERP_MODE
, unsigned)
1771 INTRINSIC_IDX_ACCESSORS(reduction_op
, REDUCTION_OP
, unsigned)
1772 INTRINSIC_IDX_ACCESSORS(cluster_size
, CLUSTER_SIZE
, unsigned)
1773 INTRINSIC_IDX_ACCESSORS(param_idx
, PARAM_IDX
, unsigned)
1774 INTRINSIC_IDX_ACCESSORS(image_dim
, IMAGE_DIM
, enum glsl_sampler_dim
)
1775 INTRINSIC_IDX_ACCESSORS(image_array
, IMAGE_ARRAY
, bool)
1776 INTRINSIC_IDX_ACCESSORS(access
, ACCESS
, enum gl_access_qualifier
)
1777 INTRINSIC_IDX_ACCESSORS(src_access
, SRC_ACCESS
, enum gl_access_qualifier
)
1778 INTRINSIC_IDX_ACCESSORS(dst_access
, DST_ACCESS
, enum gl_access_qualifier
)
1779 INTRINSIC_IDX_ACCESSORS(format
, FORMAT
, enum pipe_format
)
1780 INTRINSIC_IDX_ACCESSORS(align_mul
, ALIGN_MUL
, unsigned)
1781 INTRINSIC_IDX_ACCESSORS(align_offset
, ALIGN_OFFSET
, unsigned)
1782 INTRINSIC_IDX_ACCESSORS(desc_type
, DESC_TYPE
, unsigned)
1783 INTRINSIC_IDX_ACCESSORS(type
, TYPE
, nir_alu_type
)
1784 INTRINSIC_IDX_ACCESSORS(swizzle_mask
, SWIZZLE_MASK
, unsigned)
1785 INTRINSIC_IDX_ACCESSORS(driver_location
, DRIVER_LOCATION
, unsigned)
1786 INTRINSIC_IDX_ACCESSORS(memory_semantics
, MEMORY_SEMANTICS
, nir_memory_semantics
)
1787 INTRINSIC_IDX_ACCESSORS(memory_modes
, MEMORY_MODES
, nir_variable_mode
)
1788 INTRINSIC_IDX_ACCESSORS(memory_scope
, MEMORY_SCOPE
, nir_scope
)
1791 nir_intrinsic_set_align(nir_intrinsic_instr
*intrin
,
1792 unsigned align_mul
, unsigned align_offset
)
1794 assert(util_is_power_of_two_nonzero(align_mul
));
1795 assert(align_offset
< align_mul
);
1796 nir_intrinsic_set_align_mul(intrin
, align_mul
);
1797 nir_intrinsic_set_align_offset(intrin
, align_offset
);
1800 /** Returns a simple alignment for a load/store intrinsic offset
1802 * Instead of the full mul+offset alignment scheme provided by the ALIGN_MUL
1803 * and ALIGN_OFFSET parameters, this helper takes both into account and
1804 * provides a single simple alignment parameter. The offset X is guaranteed
1805 * to satisfy X % align == 0.
1807 static inline unsigned
1808 nir_intrinsic_align(const nir_intrinsic_instr
*intrin
)
1810 const unsigned align_mul
= nir_intrinsic_align_mul(intrin
);
1811 const unsigned align_offset
= nir_intrinsic_align_offset(intrin
);
1812 assert(align_offset
< align_mul
);
1813 return align_offset
? 1 << (ffs(align_offset
) - 1) : align_mul
;
1817 nir_image_intrinsic_coord_components(const nir_intrinsic_instr
*instr
);
1819 /* Converts a image_deref_* intrinsic into a image_* one */
1820 void nir_rewrite_image_intrinsic(nir_intrinsic_instr
*instr
,
1821 nir_ssa_def
*handle
, bool bindless
);
1823 /* Determine if an intrinsic can be arbitrarily reordered and eliminated. */
1825 nir_intrinsic_can_reorder(nir_intrinsic_instr
*instr
)
1827 if (instr
->intrinsic
== nir_intrinsic_load_deref
||
1828 instr
->intrinsic
== nir_intrinsic_load_ssbo
||
1829 instr
->intrinsic
== nir_intrinsic_bindless_image_load
||
1830 instr
->intrinsic
== nir_intrinsic_image_deref_load
||
1831 instr
->intrinsic
== nir_intrinsic_image_load
) {
1832 return nir_intrinsic_access(instr
) & ACCESS_CAN_REORDER
;
1834 const nir_intrinsic_info
*info
=
1835 &nir_intrinsic_infos
[instr
->intrinsic
];
1836 return (info
->flags
& NIR_INTRINSIC_CAN_ELIMINATE
) &&
1837 (info
->flags
& NIR_INTRINSIC_CAN_REORDER
);
1842 * \group texture information
1844 * This gives semantic information about textures which is useful to the
1845 * frontend, the backend, and lowering passes, but not the optimizer.
1850 nir_tex_src_projector
,
1851 nir_tex_src_comparator
, /* shadow comparator */
1855 nir_tex_src_min_lod
,
1856 nir_tex_src_ms_index
, /* MSAA sample index */
1857 nir_tex_src_ms_mcs
, /* MSAA compression value */
1860 nir_tex_src_texture_deref
, /* < deref pointing to the texture */
1861 nir_tex_src_sampler_deref
, /* < deref pointing to the sampler */
1862 nir_tex_src_texture_offset
, /* < dynamically uniform indirect offset */
1863 nir_tex_src_sampler_offset
, /* < dynamically uniform indirect offset */
1864 nir_tex_src_texture_handle
, /* < bindless texture handle */
1865 nir_tex_src_sampler_handle
, /* < bindless sampler handle */
1866 nir_tex_src_plane
, /* < selects plane for planar textures */
1867 nir_num_tex_src_types
1872 nir_tex_src_type src_type
;
1876 nir_texop_tex
, /**< Regular texture look-up */
1877 nir_texop_txb
, /**< Texture look-up with LOD bias */
1878 nir_texop_txl
, /**< Texture look-up with explicit LOD */
1879 nir_texop_txd
, /**< Texture look-up with partial derivatives */
1880 nir_texop_txf
, /**< Texel fetch with explicit LOD */
1881 nir_texop_txf_ms
, /**< Multisample texture fetch */
1882 nir_texop_txf_ms_fb
, /**< Multisample texture fetch from framebuffer */
1883 nir_texop_txf_ms_mcs
, /**< Multisample compression value fetch */
1884 nir_texop_txs
, /**< Texture size */
1885 nir_texop_lod
, /**< Texture lod query */
1886 nir_texop_tg4
, /**< Texture gather */
1887 nir_texop_query_levels
, /**< Texture levels query */
1888 nir_texop_texture_samples
, /**< Texture samples query */
1889 nir_texop_samples_identical
, /**< Query whether all samples are definitely
1892 nir_texop_tex_prefetch
, /**< Regular texture look-up, eligible for pre-dispatch */
1893 nir_texop_fragment_fetch
, /**< Multisample fragment color texture fetch */
1894 nir_texop_fragment_mask_fetch
,/**< Multisample fragment mask texture fetch */
1900 enum glsl_sampler_dim sampler_dim
;
1901 nir_alu_type dest_type
;
1906 unsigned num_srcs
, coord_components
;
1907 bool is_array
, is_shadow
;
1910 * If is_shadow is true, whether this is the old-style shadow that outputs 4
1911 * components or the new-style shadow that outputs 1 component.
1913 bool is_new_style_shadow
;
1915 /* gather component selector */
1916 unsigned component
: 2;
1918 /* gather offsets */
1919 int8_t tg4_offsets
[4][2];
1921 /* True if the texture index or handle is not dynamically uniform */
1922 bool texture_non_uniform
;
1924 /* True if the sampler index or handle is not dynamically uniform */
1925 bool sampler_non_uniform
;
1927 /** The texture index
1929 * If this texture instruction has a nir_tex_src_texture_offset source,
1930 * then the texture index is given by texture_index + texture_offset.
1932 unsigned texture_index
;
1934 /** The sampler index
1936 * The following operations do not require a sampler and, as such, this
1937 * field should be ignored:
1939 * - nir_texop_txf_ms
1942 * - nir_texop_query_levels
1943 * - nir_texop_texture_samples
1944 * - nir_texop_samples_identical
1946 * If this texture instruction has a nir_tex_src_sampler_offset source,
1947 * then the sampler index is given by sampler_index + sampler_offset.
1949 unsigned sampler_index
;
1953 * Returns true if the texture operation requires a sampler as a general rule,
1954 * see the documentation of sampler_index.
1956 * Note that the specific hw/driver backend could require to a sampler
1957 * object/configuration packet in any case, for some other reason.
1960 nir_tex_instr_need_sampler(const nir_tex_instr
*instr
)
1962 switch (instr
->op
) {
1964 case nir_texop_txf_ms
:
1967 case nir_texop_query_levels
:
1968 case nir_texop_texture_samples
:
1969 case nir_texop_samples_identical
:
1976 static inline unsigned
1977 nir_tex_instr_dest_size(const nir_tex_instr
*instr
)
1979 switch (instr
->op
) {
1980 case nir_texop_txs
: {
1982 switch (instr
->sampler_dim
) {
1983 case GLSL_SAMPLER_DIM_1D
:
1984 case GLSL_SAMPLER_DIM_BUF
:
1987 case GLSL_SAMPLER_DIM_2D
:
1988 case GLSL_SAMPLER_DIM_CUBE
:
1989 case GLSL_SAMPLER_DIM_MS
:
1990 case GLSL_SAMPLER_DIM_RECT
:
1991 case GLSL_SAMPLER_DIM_EXTERNAL
:
1992 case GLSL_SAMPLER_DIM_SUBPASS
:
1995 case GLSL_SAMPLER_DIM_3D
:
1999 unreachable("not reached");
2001 if (instr
->is_array
)
2009 case nir_texop_texture_samples
:
2010 case nir_texop_query_levels
:
2011 case nir_texop_samples_identical
:
2012 case nir_texop_fragment_mask_fetch
:
2016 if (instr
->is_shadow
&& instr
->is_new_style_shadow
)
2023 /* Returns true if this texture operation queries something about the texture
2024 * rather than actually sampling it.
2027 nir_tex_instr_is_query(const nir_tex_instr
*instr
)
2029 switch (instr
->op
) {
2032 case nir_texop_texture_samples
:
2033 case nir_texop_query_levels
:
2034 case nir_texop_txf_ms_mcs
:
2041 case nir_texop_txf_ms
:
2042 case nir_texop_txf_ms_fb
:
2046 unreachable("Invalid texture opcode");
2051 nir_tex_instr_has_implicit_derivative(const nir_tex_instr
*instr
)
2053 switch (instr
->op
) {
2063 static inline nir_alu_type
2064 nir_tex_instr_src_type(const nir_tex_instr
*instr
, unsigned src
)
2066 switch (instr
->src
[src
].src_type
) {
2067 case nir_tex_src_coord
:
2068 switch (instr
->op
) {
2070 case nir_texop_txf_ms
:
2071 case nir_texop_txf_ms_fb
:
2072 case nir_texop_txf_ms_mcs
:
2073 case nir_texop_samples_identical
:
2074 return nir_type_int
;
2077 return nir_type_float
;
2080 case nir_tex_src_lod
:
2081 switch (instr
->op
) {
2084 return nir_type_int
;
2087 return nir_type_float
;
2090 case nir_tex_src_projector
:
2091 case nir_tex_src_comparator
:
2092 case nir_tex_src_bias
:
2093 case nir_tex_src_min_lod
:
2094 case nir_tex_src_ddx
:
2095 case nir_tex_src_ddy
:
2096 return nir_type_float
;
2098 case nir_tex_src_offset
:
2099 case nir_tex_src_ms_index
:
2100 case nir_tex_src_plane
:
2101 return nir_type_int
;
2103 case nir_tex_src_ms_mcs
:
2104 case nir_tex_src_texture_deref
:
2105 case nir_tex_src_sampler_deref
:
2106 case nir_tex_src_texture_offset
:
2107 case nir_tex_src_sampler_offset
:
2108 case nir_tex_src_texture_handle
:
2109 case nir_tex_src_sampler_handle
:
2110 return nir_type_uint
;
2112 case nir_num_tex_src_types
:
2113 unreachable("nir_num_tex_src_types is not a valid source type");
2116 unreachable("Invalid texture source type");
2119 static inline unsigned
2120 nir_tex_instr_src_size(const nir_tex_instr
*instr
, unsigned src
)
2122 if (instr
->src
[src
].src_type
== nir_tex_src_coord
)
2123 return instr
->coord_components
;
2125 /* The MCS value is expected to be a vec4 returned by a txf_ms_mcs */
2126 if (instr
->src
[src
].src_type
== nir_tex_src_ms_mcs
)
2129 if (instr
->src
[src
].src_type
== nir_tex_src_ddx
||
2130 instr
->src
[src
].src_type
== nir_tex_src_ddy
) {
2131 if (instr
->is_array
)
2132 return instr
->coord_components
- 1;
2134 return instr
->coord_components
;
2137 /* Usual APIs don't allow cube + offset, but we allow it, with 2 coords for
2138 * the offset, since a cube maps to a single face.
2140 if (instr
->src
[src
].src_type
== nir_tex_src_offset
) {
2141 if (instr
->sampler_dim
== GLSL_SAMPLER_DIM_CUBE
)
2143 else if (instr
->is_array
)
2144 return instr
->coord_components
- 1;
2146 return instr
->coord_components
;
2153 nir_tex_instr_src_index(const nir_tex_instr
*instr
, nir_tex_src_type type
)
2155 for (unsigned i
= 0; i
< instr
->num_srcs
; i
++)
2156 if (instr
->src
[i
].src_type
== type
)
2162 void nir_tex_instr_add_src(nir_tex_instr
*tex
,
2163 nir_tex_src_type src_type
,
2166 void nir_tex_instr_remove_src(nir_tex_instr
*tex
, unsigned src_idx
);
2168 bool nir_tex_instr_has_explicit_tg4_offsets(nir_tex_instr
*tex
);
2175 nir_const_value value
[];
2176 } nir_load_const_instr
;
2189 /* creates a new SSA variable in an undefined state */
2194 } nir_ssa_undef_instr
;
2197 struct exec_node node
;
2199 /* The predecessor block corresponding to this source */
2200 struct nir_block
*pred
;
2205 #define nir_foreach_phi_src(phi_src, phi) \
2206 foreach_list_typed(nir_phi_src, phi_src, node, &(phi)->srcs)
2207 #define nir_foreach_phi_src_safe(phi_src, phi) \
2208 foreach_list_typed_safe(nir_phi_src, phi_src, node, &(phi)->srcs)
2213 struct exec_list srcs
; /** < list of nir_phi_src */
2219 struct exec_node node
;
2222 } nir_parallel_copy_entry
;
2224 #define nir_foreach_parallel_copy_entry(entry, pcopy) \
2225 foreach_list_typed(nir_parallel_copy_entry, entry, node, &(pcopy)->entries)
2230 /* A list of nir_parallel_copy_entrys. The sources of all of the
2231 * entries are copied to the corresponding destinations "in parallel".
2232 * In other words, if we have two entries: a -> b and b -> a, the values
2235 struct exec_list entries
;
2236 } nir_parallel_copy_instr
;
2238 NIR_DEFINE_CAST(nir_instr_as_alu
, nir_instr
, nir_alu_instr
, instr
,
2239 type
, nir_instr_type_alu
)
2240 NIR_DEFINE_CAST(nir_instr_as_deref
, nir_instr
, nir_deref_instr
, instr
,
2241 type
, nir_instr_type_deref
)
2242 NIR_DEFINE_CAST(nir_instr_as_call
, nir_instr
, nir_call_instr
, instr
,
2243 type
, nir_instr_type_call
)
2244 NIR_DEFINE_CAST(nir_instr_as_jump
, nir_instr
, nir_jump_instr
, instr
,
2245 type
, nir_instr_type_jump
)
2246 NIR_DEFINE_CAST(nir_instr_as_tex
, nir_instr
, nir_tex_instr
, instr
,
2247 type
, nir_instr_type_tex
)
2248 NIR_DEFINE_CAST(nir_instr_as_intrinsic
, nir_instr
, nir_intrinsic_instr
, instr
,
2249 type
, nir_instr_type_intrinsic
)
2250 NIR_DEFINE_CAST(nir_instr_as_load_const
, nir_instr
, nir_load_const_instr
, instr
,
2251 type
, nir_instr_type_load_const
)
2252 NIR_DEFINE_CAST(nir_instr_as_ssa_undef
, nir_instr
, nir_ssa_undef_instr
, instr
,
2253 type
, nir_instr_type_ssa_undef
)
2254 NIR_DEFINE_CAST(nir_instr_as_phi
, nir_instr
, nir_phi_instr
, instr
,
2255 type
, nir_instr_type_phi
)
2256 NIR_DEFINE_CAST(nir_instr_as_parallel_copy
, nir_instr
,
2257 nir_parallel_copy_instr
, instr
,
2258 type
, nir_instr_type_parallel_copy
)
2261 #define NIR_DEFINE_SRC_AS_CONST(type, suffix) \
2262 static inline type \
2263 nir_src_comp_as_##suffix(nir_src src, unsigned comp) \
2265 assert(nir_src_is_const(src)); \
2266 nir_load_const_instr *load = \
2267 nir_instr_as_load_const(src.ssa->parent_instr); \
2268 assert(comp < load->def.num_components); \
2269 return nir_const_value_as_##suffix(load->value[comp], \
2270 load->def.bit_size); \
2273 static inline type \
2274 nir_src_as_##suffix(nir_src src) \
2276 assert(nir_src_num_components(src) == 1); \
2277 return nir_src_comp_as_##suffix(src, 0); \
2280 NIR_DEFINE_SRC_AS_CONST(int64_t, int)
2281 NIR_DEFINE_SRC_AS_CONST(uint64_t, uint
)
2282 NIR_DEFINE_SRC_AS_CONST(bool, bool)
2283 NIR_DEFINE_SRC_AS_CONST(double, float)
2285 #undef NIR_DEFINE_SRC_AS_CONST
2294 nir_ssa_scalar_is_const(nir_ssa_scalar s
)
2296 return s
.def
->parent_instr
->type
== nir_instr_type_load_const
;
2299 static inline nir_const_value
2300 nir_ssa_scalar_as_const_value(nir_ssa_scalar s
)
2302 assert(s
.comp
< s
.def
->num_components
);
2303 nir_load_const_instr
*load
= nir_instr_as_load_const(s
.def
->parent_instr
);
2304 return load
->value
[s
.comp
];
2307 #define NIR_DEFINE_SCALAR_AS_CONST(type, suffix) \
2308 static inline type \
2309 nir_ssa_scalar_as_##suffix(nir_ssa_scalar s) \
2311 return nir_const_value_as_##suffix( \
2312 nir_ssa_scalar_as_const_value(s), s.def->bit_size); \
2315 NIR_DEFINE_SCALAR_AS_CONST(int64_t, int)
2316 NIR_DEFINE_SCALAR_AS_CONST(uint64_t, uint
)
2317 NIR_DEFINE_SCALAR_AS_CONST(bool, bool)
2318 NIR_DEFINE_SCALAR_AS_CONST(double, float)
2320 #undef NIR_DEFINE_SCALAR_AS_CONST
2323 nir_ssa_scalar_is_alu(nir_ssa_scalar s
)
2325 return s
.def
->parent_instr
->type
== nir_instr_type_alu
;
2328 static inline nir_op
2329 nir_ssa_scalar_alu_op(nir_ssa_scalar s
)
2331 return nir_instr_as_alu(s
.def
->parent_instr
)->op
;
2334 static inline nir_ssa_scalar
2335 nir_ssa_scalar_chase_alu_src(nir_ssa_scalar s
, unsigned alu_src_idx
)
2337 nir_ssa_scalar out
= { NULL
, 0 };
2339 nir_alu_instr
*alu
= nir_instr_as_alu(s
.def
->parent_instr
);
2340 assert(alu_src_idx
< nir_op_infos
[alu
->op
].num_inputs
);
2342 /* Our component must be written */
2343 assert(s
.comp
< s
.def
->num_components
);
2344 assert(alu
->dest
.write_mask
& (1u << s
.comp
));
2346 assert(alu
->src
[alu_src_idx
].src
.is_ssa
);
2347 out
.def
= alu
->src
[alu_src_idx
].src
.ssa
;
2349 if (nir_op_infos
[alu
->op
].input_sizes
[alu_src_idx
] == 0) {
2350 /* The ALU src is unsized so the source component follows the
2351 * destination component.
2353 out
.comp
= alu
->src
[alu_src_idx
].swizzle
[s
.comp
];
2355 /* This is a sized source so all source components work together to
2356 * produce all the destination components. Since we need to return a
2357 * scalar, this only works if the source is a scalar.
2359 assert(nir_op_infos
[alu
->op
].input_sizes
[alu_src_idx
] == 1);
2360 out
.comp
= alu
->src
[alu_src_idx
].swizzle
[0];
2362 assert(out
.comp
< out
.def
->num_components
);
2371 * Control flow consists of a tree of control flow nodes, which include
2372 * if-statements and loops. The leaves of the tree are basic blocks, lists of
2373 * instructions that always run start-to-finish. Each basic block also keeps
2374 * track of its successors (blocks which may run immediately after the current
2375 * block) and predecessors (blocks which could have run immediately before the
2376 * current block). Each function also has a start block and an end block which
2377 * all return statements point to (which is always empty). Together, all the
2378 * blocks with their predecessors and successors make up the control flow
2379 * graph (CFG) of the function. There are helpers that modify the tree of
2380 * control flow nodes while modifying the CFG appropriately; these should be
2381 * used instead of modifying the tree directly.
2388 nir_cf_node_function
2391 typedef struct nir_cf_node
{
2392 struct exec_node node
;
2393 nir_cf_node_type type
;
2394 struct nir_cf_node
*parent
;
2397 typedef struct nir_block
{
2398 nir_cf_node cf_node
;
2400 struct exec_list instr_list
; /** < list of nir_instr */
2402 /** generic block index; generated by nir_index_blocks */
2406 * Each block can only have up to 2 successors, so we put them in a simple
2407 * array - no need for anything more complicated.
2409 struct nir_block
*successors
[2];
2411 /* Set of nir_block predecessors in the CFG */
2412 struct set
*predecessors
;
2415 * this node's immediate dominator in the dominance tree - set to NULL for
2418 struct nir_block
*imm_dom
;
2420 /* This node's children in the dominance tree */
2421 unsigned num_dom_children
;
2422 struct nir_block
**dom_children
;
2424 /* Set of nir_blocks on the dominance frontier of this block */
2425 struct set
*dom_frontier
;
2428 * These two indices have the property that dom_{pre,post}_index for each
2429 * child of this block in the dominance tree will always be between
2430 * dom_pre_index and dom_post_index for this block, which makes testing if
2431 * a given block is dominated by another block an O(1) operation.
2433 int16_t dom_pre_index
, dom_post_index
;
2435 /* live in and out for this block; used for liveness analysis */
2436 BITSET_WORD
*live_in
;
2437 BITSET_WORD
*live_out
;
2441 nir_block_is_reachable(nir_block
*b
)
2443 /* See also nir_block_dominates */
2444 return b
->dom_post_index
!= -1;
2447 static inline nir_instr
*
2448 nir_block_first_instr(nir_block
*block
)
2450 struct exec_node
*head
= exec_list_get_head(&block
->instr_list
);
2451 return exec_node_data(nir_instr
, head
, node
);
2454 static inline nir_instr
*
2455 nir_block_last_instr(nir_block
*block
)
2457 struct exec_node
*tail
= exec_list_get_tail(&block
->instr_list
);
2458 return exec_node_data(nir_instr
, tail
, node
);
2462 nir_block_ends_in_jump(nir_block
*block
)
2464 return !exec_list_is_empty(&block
->instr_list
) &&
2465 nir_block_last_instr(block
)->type
== nir_instr_type_jump
;
2468 #define nir_foreach_instr(instr, block) \
2469 foreach_list_typed(nir_instr, instr, node, &(block)->instr_list)
2470 #define nir_foreach_instr_reverse(instr, block) \
2471 foreach_list_typed_reverse(nir_instr, instr, node, &(block)->instr_list)
2472 #define nir_foreach_instr_safe(instr, block) \
2473 foreach_list_typed_safe(nir_instr, instr, node, &(block)->instr_list)
2474 #define nir_foreach_instr_reverse_safe(instr, block) \
2475 foreach_list_typed_reverse_safe(nir_instr, instr, node, &(block)->instr_list)
2478 nir_selection_control_none
= 0x0,
2479 nir_selection_control_flatten
= 0x1,
2480 nir_selection_control_dont_flatten
= 0x2,
2481 } nir_selection_control
;
2483 typedef struct nir_if
{
2484 nir_cf_node cf_node
;
2486 nir_selection_control control
;
2488 struct exec_list then_list
; /** < list of nir_cf_node */
2489 struct exec_list else_list
; /** < list of nir_cf_node */
2495 /** Instruction that generates nif::condition. */
2496 nir_instr
*conditional_instr
;
2498 /** Block within ::nif that has the break instruction. */
2499 nir_block
*break_block
;
2501 /** Last block for the then- or else-path that does not contain the break. */
2502 nir_block
*continue_from_block
;
2504 /** True when ::break_block is in the else-path of ::nif. */
2505 bool continue_from_then
;
2508 /* This is true if the terminators exact trip count is unknown. For
2511 * for (int i = 0; i < imin(x, 4); i++)
2514 * Here loop analysis would have set a max_trip_count of 4 however we dont
2515 * know for sure that this is the exact trip count.
2517 bool exact_trip_count_unknown
;
2519 struct list_head loop_terminator_link
;
2520 } nir_loop_terminator
;
2523 /* Estimated cost (in number of instructions) of the loop */
2524 unsigned instr_cost
;
2526 /* Guessed trip count based on array indexing */
2527 unsigned guessed_trip_count
;
2529 /* Maximum number of times the loop is run (if known) */
2530 unsigned max_trip_count
;
2532 /* Do we know the exact number of times the loop will be run */
2533 bool exact_trip_count_known
;
2535 /* Unroll the loop regardless of its size */
2538 /* Does the loop contain complex loop terminators, continues or other
2539 * complex behaviours? If this is true we can't rely on
2540 * loop_terminator_list to be complete or accurate.
2544 nir_loop_terminator
*limiting_terminator
;
2546 /* A list of loop_terminators terminating this loop. */
2547 struct list_head loop_terminator_list
;
2551 nir_loop_control_none
= 0x0,
2552 nir_loop_control_unroll
= 0x1,
2553 nir_loop_control_dont_unroll
= 0x2,
2557 nir_cf_node cf_node
;
2559 struct exec_list body
; /** < list of nir_cf_node */
2561 nir_loop_info
*info
;
2562 nir_loop_control control
;
2563 bool partially_unrolled
;
2567 * Various bits of metadata that can may be created or required by
2568 * optimization and analysis passes
2571 nir_metadata_none
= 0x0,
2572 nir_metadata_block_index
= 0x1,
2573 nir_metadata_dominance
= 0x2,
2574 nir_metadata_live_ssa_defs
= 0x4,
2575 nir_metadata_not_properly_reset
= 0x8,
2576 nir_metadata_loop_analysis
= 0x10,
2580 nir_cf_node cf_node
;
2582 /** pointer to the function of which this is an implementation */
2583 struct nir_function
*function
;
2585 struct exec_list body
; /** < list of nir_cf_node */
2587 nir_block
*end_block
;
2589 /** list for all local variables in the function */
2590 struct exec_list locals
;
2592 /** list of local registers in the function */
2593 struct exec_list registers
;
2595 /** next available local register index */
2598 /** next available SSA value index */
2601 /* total number of basic blocks, only valid when block_index_dirty = false */
2602 unsigned num_blocks
;
2604 nir_metadata valid_metadata
;
2605 } nir_function_impl
;
2607 ATTRIBUTE_RETURNS_NONNULL
static inline nir_block
*
2608 nir_start_block(nir_function_impl
*impl
)
2610 return (nir_block
*) impl
->body
.head_sentinel
.next
;
2613 ATTRIBUTE_RETURNS_NONNULL
static inline nir_block
*
2614 nir_impl_last_block(nir_function_impl
*impl
)
2616 return (nir_block
*) impl
->body
.tail_sentinel
.prev
;
2619 static inline nir_cf_node
*
2620 nir_cf_node_next(nir_cf_node
*node
)
2622 struct exec_node
*next
= exec_node_get_next(&node
->node
);
2623 if (exec_node_is_tail_sentinel(next
))
2626 return exec_node_data(nir_cf_node
, next
, node
);
2629 static inline nir_cf_node
*
2630 nir_cf_node_prev(nir_cf_node
*node
)
2632 struct exec_node
*prev
= exec_node_get_prev(&node
->node
);
2633 if (exec_node_is_head_sentinel(prev
))
2636 return exec_node_data(nir_cf_node
, prev
, node
);
2640 nir_cf_node_is_first(const nir_cf_node
*node
)
2642 return exec_node_is_head_sentinel(node
->node
.prev
);
2646 nir_cf_node_is_last(const nir_cf_node
*node
)
2648 return exec_node_is_tail_sentinel(node
->node
.next
);
2651 NIR_DEFINE_CAST(nir_cf_node_as_block
, nir_cf_node
, nir_block
, cf_node
,
2652 type
, nir_cf_node_block
)
2653 NIR_DEFINE_CAST(nir_cf_node_as_if
, nir_cf_node
, nir_if
, cf_node
,
2654 type
, nir_cf_node_if
)
2655 NIR_DEFINE_CAST(nir_cf_node_as_loop
, nir_cf_node
, nir_loop
, cf_node
,
2656 type
, nir_cf_node_loop
)
2657 NIR_DEFINE_CAST(nir_cf_node_as_function
, nir_cf_node
,
2658 nir_function_impl
, cf_node
, type
, nir_cf_node_function
)
2660 static inline nir_block
*
2661 nir_if_first_then_block(nir_if
*if_stmt
)
2663 struct exec_node
*head
= exec_list_get_head(&if_stmt
->then_list
);
2664 return nir_cf_node_as_block(exec_node_data(nir_cf_node
, head
, node
));
2667 static inline nir_block
*
2668 nir_if_last_then_block(nir_if
*if_stmt
)
2670 struct exec_node
*tail
= exec_list_get_tail(&if_stmt
->then_list
);
2671 return nir_cf_node_as_block(exec_node_data(nir_cf_node
, tail
, node
));
2674 static inline nir_block
*
2675 nir_if_first_else_block(nir_if
*if_stmt
)
2677 struct exec_node
*head
= exec_list_get_head(&if_stmt
->else_list
);
2678 return nir_cf_node_as_block(exec_node_data(nir_cf_node
, head
, node
));
2681 static inline nir_block
*
2682 nir_if_last_else_block(nir_if
*if_stmt
)
2684 struct exec_node
*tail
= exec_list_get_tail(&if_stmt
->else_list
);
2685 return nir_cf_node_as_block(exec_node_data(nir_cf_node
, tail
, node
));
2688 static inline nir_block
*
2689 nir_loop_first_block(nir_loop
*loop
)
2691 struct exec_node
*head
= exec_list_get_head(&loop
->body
);
2692 return nir_cf_node_as_block(exec_node_data(nir_cf_node
, head
, node
));
2695 static inline nir_block
*
2696 nir_loop_last_block(nir_loop
*loop
)
2698 struct exec_node
*tail
= exec_list_get_tail(&loop
->body
);
2699 return nir_cf_node_as_block(exec_node_data(nir_cf_node
, tail
, node
));
2703 * Return true if this list of cf_nodes contains a single empty block.
2706 nir_cf_list_is_empty_block(struct exec_list
*cf_list
)
2708 if (exec_list_is_singular(cf_list
)) {
2709 struct exec_node
*head
= exec_list_get_head(cf_list
);
2711 nir_cf_node_as_block(exec_node_data(nir_cf_node
, head
, node
));
2712 return exec_list_is_empty(&block
->instr_list
);
2718 uint8_t num_components
;
2722 typedef struct nir_function
{
2723 struct exec_node node
;
2726 struct nir_shader
*shader
;
2728 unsigned num_params
;
2729 nir_parameter
*params
;
2731 /** The implementation of this function.
2733 * If the function is only declared and not implemented, this is NULL.
2735 nir_function_impl
*impl
;
2741 nir_lower_imul64
= (1 << 0),
2742 nir_lower_isign64
= (1 << 1),
2743 /** Lower all int64 modulus and division opcodes */
2744 nir_lower_divmod64
= (1 << 2),
2745 /** Lower all 64-bit umul_high and imul_high opcodes */
2746 nir_lower_imul_high64
= (1 << 3),
2747 nir_lower_mov64
= (1 << 4),
2748 nir_lower_icmp64
= (1 << 5),
2749 nir_lower_iadd64
= (1 << 6),
2750 nir_lower_iabs64
= (1 << 7),
2751 nir_lower_ineg64
= (1 << 8),
2752 nir_lower_logic64
= (1 << 9),
2753 nir_lower_minmax64
= (1 << 10),
2754 nir_lower_shift64
= (1 << 11),
2755 nir_lower_imul_2x32_64
= (1 << 12),
2756 nir_lower_extract64
= (1 << 13),
2757 nir_lower_ufind_msb64
= (1 << 14),
2758 } nir_lower_int64_options
;
2761 nir_lower_drcp
= (1 << 0),
2762 nir_lower_dsqrt
= (1 << 1),
2763 nir_lower_drsq
= (1 << 2),
2764 nir_lower_dtrunc
= (1 << 3),
2765 nir_lower_dfloor
= (1 << 4),
2766 nir_lower_dceil
= (1 << 5),
2767 nir_lower_dfract
= (1 << 6),
2768 nir_lower_dround_even
= (1 << 7),
2769 nir_lower_dmod
= (1 << 8),
2770 nir_lower_dsub
= (1 << 9),
2771 nir_lower_ddiv
= (1 << 10),
2772 nir_lower_fp64_full_software
= (1 << 11),
2773 } nir_lower_doubles_options
;
2776 nir_divergence_single_prim_per_subgroup
= (1 << 0),
2777 nir_divergence_single_patch_per_tcs_subgroup
= (1 << 1),
2778 nir_divergence_single_patch_per_tes_subgroup
= (1 << 2),
2779 nir_divergence_view_index_uniform
= (1 << 3),
2780 } nir_divergence_options
;
2782 typedef struct nir_shader_compiler_options
{
2788 /** Lowers flrp when it does not support doubles */
2795 /** Lowers ibitfield_extract/ubitfield_extract to ibfe/ubfe. */
2796 bool lower_bitfield_extract
;
2797 /** Lowers ibitfield_extract/ubitfield_extract to compares, shifts. */
2798 bool lower_bitfield_extract_to_shifts
;
2799 /** Lowers bitfield_insert to bfi/bfm */
2800 bool lower_bitfield_insert
;
2801 /** Lowers bitfield_insert to compares, and shifts. */
2802 bool lower_bitfield_insert_to_shifts
;
2803 /** Lowers bitfield_insert to bfm/bitfield_select. */
2804 bool lower_bitfield_insert_to_bitfield_select
;
2805 /** Lowers bitfield_reverse to shifts. */
2806 bool lower_bitfield_reverse
;
2807 /** Lowers bit_count to shifts. */
2808 bool lower_bit_count
;
2809 /** Lowers ifind_msb to compare and ufind_msb */
2810 bool lower_ifind_msb
;
2811 /** Lowers find_lsb to ufind_msb and logic ops */
2812 bool lower_find_lsb
;
2813 bool lower_uadd_carry
;
2814 bool lower_usub_borrow
;
2815 /** Lowers imul_high/umul_high to 16-bit multiplies and carry operations. */
2816 bool lower_mul_high
;
2817 /** lowers fneg and ineg to fsub and isub. */
2819 /** lowers fsub and isub to fadd+fneg and iadd+ineg. */
2822 /* lower {slt,sge,seq,sne} to {flt,fge,feq,fne} + b2f: */
2825 /* lower fall_equalN/fany_nequalN (ex:fany_nequal4 to sne+fdot4+fsat) */
2826 bool lower_vector_cmp
;
2828 /** enables rules to lower idiv by power-of-two: */
2831 /** enable rules to avoid bit ops */
2834 /** enables rules to lower isign to imin+imax */
2837 /** enables rules to lower fsign to fsub and flt */
2840 /* lower fdph to fdot4 */
2843 /** lower fdot to fmul and fsum/fadd. */
2846 /* Does the native fdot instruction replicate its result for four
2847 * components? If so, then opt_algebraic_late will turn all fdotN
2848 * instructions into fdot_replicatedN instructions.
2850 bool fdot_replicates
;
2852 /** lowers ffloor to fsub+ffract: */
2855 /** lowers ffract to fsub+ffloor: */
2858 /** lowers fceil to fneg+ffloor+fneg: */
2865 bool lower_pack_half_2x16
;
2866 bool lower_pack_unorm_2x16
;
2867 bool lower_pack_snorm_2x16
;
2868 bool lower_pack_unorm_4x8
;
2869 bool lower_pack_snorm_4x8
;
2870 bool lower_unpack_half_2x16
;
2871 bool lower_unpack_unorm_2x16
;
2872 bool lower_unpack_snorm_2x16
;
2873 bool lower_unpack_unorm_4x8
;
2874 bool lower_unpack_snorm_4x8
;
2876 bool lower_pack_split
;
2878 bool lower_extract_byte
;
2879 bool lower_extract_word
;
2881 bool lower_all_io_to_temps
;
2882 bool lower_all_io_to_elements
;
2884 /* Indicates that the driver only has zero-based vertex id */
2885 bool vertex_id_zero_based
;
2888 * If enabled, gl_BaseVertex will be lowered as:
2889 * is_indexed_draw (~0/0) & firstvertex
2891 bool lower_base_vertex
;
2894 * If enabled, gl_HelperInvocation will be lowered as:
2896 * !((1 << sample_id) & sample_mask_in))
2898 * This depends on some possibly hw implementation details, which may
2899 * not be true for all hw. In particular that the FS is only executed
2900 * for covered samples or for helper invocations. So, do not blindly
2901 * enable this option.
2903 * Note: See also issue #22 in ARB_shader_image_load_store
2905 bool lower_helper_invocation
;
2908 * Convert gl_SampleMaskIn to gl_HelperInvocation as follows:
2910 * gl_SampleMaskIn == 0 ---> gl_HelperInvocation
2911 * gl_SampleMaskIn != 0 ---> !gl_HelperInvocation
2913 bool optimize_sample_mask_in
;
2915 bool lower_cs_local_index_from_id
;
2916 bool lower_cs_local_id_from_index
;
2918 bool lower_device_index_to_zero
;
2920 /* Set if nir_lower_wpos_ytransform() should also invert gl_PointCoord. */
2921 bool lower_wpos_pntc
;
2924 * Set if nir_op_[iu]hadd and nir_op_[iu]rhadd instructions should be
2925 * lowered to simple arithmetic.
2927 * If this flag is set, the lowering will be applied to all bit-sizes of
2928 * these instructions.
2930 * \sa ::lower_hadd64
2935 * Set if only 64-bit nir_op_[iu]hadd and nir_op_[iu]rhadd instructions
2936 * should be lowered to simple arithmetic.
2938 * If this flag is set, the lowering will be applied to only 64-bit
2939 * versions of these instructions.
2946 * Set if nir_op_add_sat and nir_op_usub_sat should be lowered to simple
2949 * If this flag is set, the lowering will be applied to all bit-sizes of
2950 * these instructions.
2952 * \sa ::lower_usub_sat64
2957 * Set if only 64-bit nir_op_usub_sat should be lowered to simple
2960 * \sa ::lower_add_sat
2962 bool lower_usub_sat64
;
2965 * Should IO be re-vectorized? Some scalar ISAs still operate on vec4's
2966 * for IO purposes and would prefer loads/stores be vectorized.
2969 bool lower_to_scalar
;
2972 * Should the linker unify inputs_read/outputs_written between adjacent
2973 * shader stages which are linked into a single program?
2975 bool unify_interfaces
;
2978 * Should nir_lower_io() create load_interpolated_input intrinsics?
2980 * If not, it generates regular load_input intrinsics and interpolation
2981 * information must be inferred from the list of input nir_variables.
2983 bool use_interpolated_input_intrinsics
;
2985 /* Lowers when 32x32->64 bit multiplication is not supported */
2986 bool lower_mul_2x32_64
;
2988 /* Lowers when rotate instruction is not supported */
2992 * Backend supports imul24, and would like to use it (when possible)
2993 * for address/offset calculation. If true, driver should call
2994 * nir_lower_amul(). (If not set, amul will automatically be lowered
2999 /** Backend supports umul24, if not set umul24 will automatically be lowered
3000 * to imul with masked inputs */
3003 /** Backend supports umad24, if not set umad24 will automatically be lowered
3004 * to imul with masked inputs and iadd */
3007 /* Whether to generate only scoped_memory_barrier intrinsics instead of the
3008 * set of memory barrier intrinsics based on GLSL.
3010 bool use_scoped_memory_barrier
;
3013 * Is this the Intel vec4 backend?
3015 * Used to inhibit algebraic optimizations that are known to be harmful on
3016 * the Intel vec4 backend. This is generally applicable to any
3017 * optimization that might cause more immediate values to be used in
3018 * 3-source (e.g., ffma and flrp) instructions.
3022 /** Whether 8-bit ALU is supported. */
3023 bool support_8bit_alu
;
3025 /** Whether 16-bit ALU is supported. */
3026 bool support_16bit_alu
;
3028 unsigned max_unroll_iterations
;
3030 nir_lower_int64_options lower_int64_options
;
3031 nir_lower_doubles_options lower_doubles_options
;
3032 } nir_shader_compiler_options
;
3034 typedef struct nir_shader
{
3035 /** list of uniforms (nir_variable) */
3036 struct exec_list uniforms
;
3038 /** list of inputs (nir_variable) */
3039 struct exec_list inputs
;
3041 /** list of outputs (nir_variable) */
3042 struct exec_list outputs
;
3044 /** list of shared compute variables (nir_variable) */
3045 struct exec_list shared
;
3047 /** Set of driver-specific options for the shader.
3049 * The memory for the options is expected to be kept in a single static
3050 * copy by the driver.
3052 const struct nir_shader_compiler_options
*options
;
3054 /** Various bits of compile-time information about a given shader */
3055 struct shader_info info
;
3057 /** list of global variables in the shader (nir_variable) */
3058 struct exec_list globals
;
3060 /** list of system value variables in the shader (nir_variable) */
3061 struct exec_list system_values
;
3063 struct exec_list functions
; /** < list of nir_function */
3066 * the highest index a load_input_*, load_uniform_*, etc. intrinsic can
3069 unsigned num_inputs
, num_uniforms
, num_outputs
, num_shared
;
3071 /** Size in bytes of required scratch space */
3072 unsigned scratch_size
;
3074 /** Constant data associated with this shader.
3076 * Constant data is loaded through load_constant intrinsics. See also
3077 * nir_opt_large_constants.
3079 void *constant_data
;
3080 unsigned constant_data_size
;
3083 #define nir_foreach_function(func, shader) \
3084 foreach_list_typed(nir_function, func, node, &(shader)->functions)
3086 static inline nir_function_impl
*
3087 nir_shader_get_entrypoint(nir_shader
*shader
)
3089 nir_function
*func
= NULL
;
3091 nir_foreach_function(function
, shader
) {
3092 assert(func
== NULL
);
3093 if (function
->is_entrypoint
) {
3104 assert(func
->num_params
== 0);
3109 nir_shader
*nir_shader_create(void *mem_ctx
,
3110 gl_shader_stage stage
,
3111 const nir_shader_compiler_options
*options
,
3114 nir_register
*nir_local_reg_create(nir_function_impl
*impl
);
3116 void nir_reg_remove(nir_register
*reg
);
3118 /** Adds a variable to the appropriate list in nir_shader */
3119 void nir_shader_add_variable(nir_shader
*shader
, nir_variable
*var
);
3122 nir_function_impl_add_variable(nir_function_impl
*impl
, nir_variable
*var
)
3124 assert(var
->data
.mode
== nir_var_function_temp
);
3125 exec_list_push_tail(&impl
->locals
, &var
->node
);
3128 /** creates a variable, sets a few defaults, and adds it to the list */
3129 nir_variable
*nir_variable_create(nir_shader
*shader
,
3130 nir_variable_mode mode
,
3131 const struct glsl_type
*type
,
3133 /** creates a local variable and adds it to the list */
3134 nir_variable
*nir_local_variable_create(nir_function_impl
*impl
,
3135 const struct glsl_type
*type
,
3138 /** creates a function and adds it to the shader's list of functions */
3139 nir_function
*nir_function_create(nir_shader
*shader
, const char *name
);
3141 nir_function_impl
*nir_function_impl_create(nir_function
*func
);
3142 /** creates a function_impl that isn't tied to any particular function */
3143 nir_function_impl
*nir_function_impl_create_bare(nir_shader
*shader
);
3145 nir_block
*nir_block_create(nir_shader
*shader
);
3146 nir_if
*nir_if_create(nir_shader
*shader
);
3147 nir_loop
*nir_loop_create(nir_shader
*shader
);
3149 nir_function_impl
*nir_cf_node_get_function(nir_cf_node
*node
);
3151 /** requests that the given pieces of metadata be generated */
3152 void nir_metadata_require(nir_function_impl
*impl
, nir_metadata required
, ...);
3153 /** dirties all but the preserved metadata */
3154 void nir_metadata_preserve(nir_function_impl
*impl
, nir_metadata preserved
);
3156 /** creates an instruction with default swizzle/writemask/etc. with NULL registers */
3157 nir_alu_instr
*nir_alu_instr_create(nir_shader
*shader
, nir_op op
);
3159 nir_deref_instr
*nir_deref_instr_create(nir_shader
*shader
,
3160 nir_deref_type deref_type
);
3162 nir_jump_instr
*nir_jump_instr_create(nir_shader
*shader
, nir_jump_type type
);
3164 nir_load_const_instr
*nir_load_const_instr_create(nir_shader
*shader
,
3165 unsigned num_components
,
3168 nir_intrinsic_instr
*nir_intrinsic_instr_create(nir_shader
*shader
,
3169 nir_intrinsic_op op
);
3171 nir_call_instr
*nir_call_instr_create(nir_shader
*shader
,
3172 nir_function
*callee
);
3174 nir_tex_instr
*nir_tex_instr_create(nir_shader
*shader
, unsigned num_srcs
);
3176 nir_phi_instr
*nir_phi_instr_create(nir_shader
*shader
);
3178 nir_parallel_copy_instr
*nir_parallel_copy_instr_create(nir_shader
*shader
);
3180 nir_ssa_undef_instr
*nir_ssa_undef_instr_create(nir_shader
*shader
,
3181 unsigned num_components
,
3184 nir_const_value
nir_alu_binop_identity(nir_op binop
, unsigned bit_size
);
3187 * NIR Cursors and Instruction Insertion API
3190 * A tiny struct representing a point to insert/extract instructions or
3191 * control flow nodes. Helps reduce the combinatorial explosion of possible
3192 * points to insert/extract.
3194 * \sa nir_control_flow.h
3197 nir_cursor_before_block
,
3198 nir_cursor_after_block
,
3199 nir_cursor_before_instr
,
3200 nir_cursor_after_instr
,
3201 } nir_cursor_option
;
3204 nir_cursor_option option
;
3211 static inline nir_block
*
3212 nir_cursor_current_block(nir_cursor cursor
)
3214 if (cursor
.option
== nir_cursor_before_instr
||
3215 cursor
.option
== nir_cursor_after_instr
) {
3216 return cursor
.instr
->block
;
3218 return cursor
.block
;
3222 bool nir_cursors_equal(nir_cursor a
, nir_cursor b
);
3224 static inline nir_cursor
3225 nir_before_block(nir_block
*block
)
3228 cursor
.option
= nir_cursor_before_block
;
3229 cursor
.block
= block
;
3233 static inline nir_cursor
3234 nir_after_block(nir_block
*block
)
3237 cursor
.option
= nir_cursor_after_block
;
3238 cursor
.block
= block
;
3242 static inline nir_cursor
3243 nir_before_instr(nir_instr
*instr
)
3246 cursor
.option
= nir_cursor_before_instr
;
3247 cursor
.instr
= instr
;
3251 static inline nir_cursor
3252 nir_after_instr(nir_instr
*instr
)
3255 cursor
.option
= nir_cursor_after_instr
;
3256 cursor
.instr
= instr
;
3260 static inline nir_cursor
3261 nir_after_block_before_jump(nir_block
*block
)
3263 nir_instr
*last_instr
= nir_block_last_instr(block
);
3264 if (last_instr
&& last_instr
->type
== nir_instr_type_jump
) {
3265 return nir_before_instr(last_instr
);
3267 return nir_after_block(block
);
3271 static inline nir_cursor
3272 nir_before_src(nir_src
*src
, bool is_if_condition
)
3274 if (is_if_condition
) {
3275 nir_block
*prev_block
=
3276 nir_cf_node_as_block(nir_cf_node_prev(&src
->parent_if
->cf_node
));
3277 assert(!nir_block_ends_in_jump(prev_block
));
3278 return nir_after_block(prev_block
);
3279 } else if (src
->parent_instr
->type
== nir_instr_type_phi
) {
3281 nir_phi_instr
*cond_phi
= nir_instr_as_phi(src
->parent_instr
);
3283 nir_foreach_phi_src(phi_src
, cond_phi
) {
3284 if (phi_src
->src
.ssa
== src
->ssa
) {
3291 /* The LIST_ENTRY macro is a generic container-of macro, it just happens
3292 * to have a more specific name.
3294 nir_phi_src
*phi_src
= LIST_ENTRY(nir_phi_src
, src
, src
);
3295 return nir_after_block_before_jump(phi_src
->pred
);
3297 return nir_before_instr(src
->parent_instr
);
3301 static inline nir_cursor
3302 nir_before_cf_node(nir_cf_node
*node
)
3304 if (node
->type
== nir_cf_node_block
)
3305 return nir_before_block(nir_cf_node_as_block(node
));
3307 return nir_after_block(nir_cf_node_as_block(nir_cf_node_prev(node
)));
3310 static inline nir_cursor
3311 nir_after_cf_node(nir_cf_node
*node
)
3313 if (node
->type
== nir_cf_node_block
)
3314 return nir_after_block(nir_cf_node_as_block(node
));
3316 return nir_before_block(nir_cf_node_as_block(nir_cf_node_next(node
)));
3319 static inline nir_cursor
3320 nir_after_phis(nir_block
*block
)
3322 nir_foreach_instr(instr
, block
) {
3323 if (instr
->type
!= nir_instr_type_phi
)
3324 return nir_before_instr(instr
);
3326 return nir_after_block(block
);
3329 static inline nir_cursor
3330 nir_after_cf_node_and_phis(nir_cf_node
*node
)
3332 if (node
->type
== nir_cf_node_block
)
3333 return nir_after_block(nir_cf_node_as_block(node
));
3335 nir_block
*block
= nir_cf_node_as_block(nir_cf_node_next(node
));
3337 return nir_after_phis(block
);
3340 static inline nir_cursor
3341 nir_before_cf_list(struct exec_list
*cf_list
)
3343 nir_cf_node
*first_node
= exec_node_data(nir_cf_node
,
3344 exec_list_get_head(cf_list
), node
);
3345 return nir_before_cf_node(first_node
);
3348 static inline nir_cursor
3349 nir_after_cf_list(struct exec_list
*cf_list
)
3351 nir_cf_node
*last_node
= exec_node_data(nir_cf_node
,
3352 exec_list_get_tail(cf_list
), node
);
3353 return nir_after_cf_node(last_node
);
3357 * Insert a NIR instruction at the given cursor.
3359 * Note: This does not update the cursor.
3361 void nir_instr_insert(nir_cursor cursor
, nir_instr
*instr
);
3364 nir_instr_insert_before(nir_instr
*instr
, nir_instr
*before
)
3366 nir_instr_insert(nir_before_instr(instr
), before
);
3370 nir_instr_insert_after(nir_instr
*instr
, nir_instr
*after
)
3372 nir_instr_insert(nir_after_instr(instr
), after
);
3376 nir_instr_insert_before_block(nir_block
*block
, nir_instr
*before
)
3378 nir_instr_insert(nir_before_block(block
), before
);
3382 nir_instr_insert_after_block(nir_block
*block
, nir_instr
*after
)
3384 nir_instr_insert(nir_after_block(block
), after
);
3388 nir_instr_insert_before_cf(nir_cf_node
*node
, nir_instr
*before
)
3390 nir_instr_insert(nir_before_cf_node(node
), before
);
3394 nir_instr_insert_after_cf(nir_cf_node
*node
, nir_instr
*after
)
3396 nir_instr_insert(nir_after_cf_node(node
), after
);
3400 nir_instr_insert_before_cf_list(struct exec_list
*list
, nir_instr
*before
)
3402 nir_instr_insert(nir_before_cf_list(list
), before
);
3406 nir_instr_insert_after_cf_list(struct exec_list
*list
, nir_instr
*after
)
3408 nir_instr_insert(nir_after_cf_list(list
), after
);
3411 void nir_instr_remove_v(nir_instr
*instr
);
3413 static inline nir_cursor
3414 nir_instr_remove(nir_instr
*instr
)
3417 nir_instr
*prev
= nir_instr_prev(instr
);
3419 cursor
= nir_after_instr(prev
);
3421 cursor
= nir_before_block(instr
->block
);
3423 nir_instr_remove_v(instr
);
3429 nir_ssa_def
*nir_instr_ssa_def(nir_instr
*instr
);
3431 typedef bool (*nir_foreach_ssa_def_cb
)(nir_ssa_def
*def
, void *state
);
3432 typedef bool (*nir_foreach_dest_cb
)(nir_dest
*dest
, void *state
);
3433 typedef bool (*nir_foreach_src_cb
)(nir_src
*src
, void *state
);
3434 bool nir_foreach_ssa_def(nir_instr
*instr
, nir_foreach_ssa_def_cb cb
,
3436 bool nir_foreach_dest(nir_instr
*instr
, nir_foreach_dest_cb cb
, void *state
);
3437 bool nir_foreach_src(nir_instr
*instr
, nir_foreach_src_cb cb
, void *state
);
3439 nir_const_value
*nir_src_as_const_value(nir_src src
);
3441 #define NIR_SRC_AS_(name, c_type, type_enum, cast_macro) \
3442 static inline c_type * \
3443 nir_src_as_ ## name (nir_src src) \
3445 return src.is_ssa && src.ssa->parent_instr->type == type_enum \
3446 ? cast_macro(src.ssa->parent_instr) : NULL; \
3449 NIR_SRC_AS_(alu_instr
, nir_alu_instr
, nir_instr_type_alu
, nir_instr_as_alu
)
3450 NIR_SRC_AS_(intrinsic
, nir_intrinsic_instr
,
3451 nir_instr_type_intrinsic
, nir_instr_as_intrinsic
)
3452 NIR_SRC_AS_(deref
, nir_deref_instr
, nir_instr_type_deref
, nir_instr_as_deref
)
3454 bool nir_src_is_dynamically_uniform(nir_src src
);
3455 bool nir_srcs_equal(nir_src src1
, nir_src src2
);
3456 bool nir_instrs_equal(const nir_instr
*instr1
, const nir_instr
*instr2
);
3457 void nir_instr_rewrite_src(nir_instr
*instr
, nir_src
*src
, nir_src new_src
);
3458 void nir_instr_move_src(nir_instr
*dest_instr
, nir_src
*dest
, nir_src
*src
);
3459 void nir_if_rewrite_condition(nir_if
*if_stmt
, nir_src new_src
);
3460 void nir_instr_rewrite_dest(nir_instr
*instr
, nir_dest
*dest
,
3463 void nir_ssa_dest_init(nir_instr
*instr
, nir_dest
*dest
,
3464 unsigned num_components
, unsigned bit_size
,
3466 void nir_ssa_def_init(nir_instr
*instr
, nir_ssa_def
*def
,
3467 unsigned num_components
, unsigned bit_size
,
3470 nir_ssa_dest_init_for_type(nir_instr
*instr
, nir_dest
*dest
,
3471 const struct glsl_type
*type
,
3474 assert(glsl_type_is_vector_or_scalar(type
));
3475 nir_ssa_dest_init(instr
, dest
, glsl_get_components(type
),
3476 glsl_get_bit_size(type
), name
);
3478 void nir_ssa_def_rewrite_uses(nir_ssa_def
*def
, nir_src new_src
);
3479 void nir_ssa_def_rewrite_uses_after(nir_ssa_def
*def
, nir_src new_src
,
3480 nir_instr
*after_me
);
3482 nir_component_mask_t
nir_ssa_def_components_read(const nir_ssa_def
*def
);
3485 * finds the next basic block in source-code order, returns NULL if there is
3489 nir_block
*nir_block_cf_tree_next(nir_block
*block
);
3491 /* Performs the opposite of nir_block_cf_tree_next() */
3493 nir_block
*nir_block_cf_tree_prev(nir_block
*block
);
3495 /* Gets the first block in a CF node in source-code order */
3497 nir_block
*nir_cf_node_cf_tree_first(nir_cf_node
*node
);
3499 /* Gets the last block in a CF node in source-code order */
3501 nir_block
*nir_cf_node_cf_tree_last(nir_cf_node
*node
);
3503 /* Gets the next block after a CF node in source-code order */
3505 nir_block
*nir_cf_node_cf_tree_next(nir_cf_node
*node
);
3507 /* Macros for loops that visit blocks in source-code order */
3509 #define nir_foreach_block(block, impl) \
3510 for (nir_block *block = nir_start_block(impl); block != NULL; \
3511 block = nir_block_cf_tree_next(block))
3513 #define nir_foreach_block_safe(block, impl) \
3514 for (nir_block *block = nir_start_block(impl), \
3515 *next = nir_block_cf_tree_next(block); \
3517 block = next, next = nir_block_cf_tree_next(block))
3519 #define nir_foreach_block_reverse(block, impl) \
3520 for (nir_block *block = nir_impl_last_block(impl); block != NULL; \
3521 block = nir_block_cf_tree_prev(block))
3523 #define nir_foreach_block_reverse_safe(block, impl) \
3524 for (nir_block *block = nir_impl_last_block(impl), \
3525 *prev = nir_block_cf_tree_prev(block); \
3527 block = prev, prev = nir_block_cf_tree_prev(block))
3529 #define nir_foreach_block_in_cf_node(block, node) \
3530 for (nir_block *block = nir_cf_node_cf_tree_first(node); \
3531 block != nir_cf_node_cf_tree_next(node); \
3532 block = nir_block_cf_tree_next(block))
3534 /* If the following CF node is an if, this function returns that if.
3535 * Otherwise, it returns NULL.
3537 nir_if
*nir_block_get_following_if(nir_block
*block
);
3539 nir_loop
*nir_block_get_following_loop(nir_block
*block
);
3541 void nir_index_local_regs(nir_function_impl
*impl
);
3542 void nir_index_ssa_defs(nir_function_impl
*impl
);
3543 unsigned nir_index_instrs(nir_function_impl
*impl
);
3545 void nir_index_blocks(nir_function_impl
*impl
);
3547 void nir_index_vars(nir_shader
*shader
, nir_function_impl
*impl
, nir_variable_mode modes
);
3549 void nir_print_shader(nir_shader
*shader
, FILE *fp
);
3550 void nir_print_shader_annotated(nir_shader
*shader
, FILE *fp
, struct hash_table
*errors
);
3551 void nir_print_instr(const nir_instr
*instr
, FILE *fp
);
3552 void nir_print_deref(const nir_deref_instr
*deref
, FILE *fp
);
3554 /** Shallow clone of a single ALU instruction. */
3555 nir_alu_instr
*nir_alu_instr_clone(nir_shader
*s
, const nir_alu_instr
*orig
);
3557 nir_shader
*nir_shader_clone(void *mem_ctx
, const nir_shader
*s
);
3558 nir_function_impl
*nir_function_impl_clone(nir_shader
*shader
,
3559 const nir_function_impl
*fi
);
3560 nir_constant
*nir_constant_clone(const nir_constant
*c
, nir_variable
*var
);
3561 nir_variable
*nir_variable_clone(const nir_variable
*c
, nir_shader
*shader
);
3563 void nir_shader_replace(nir_shader
*dest
, nir_shader
*src
);
3565 void nir_shader_serialize_deserialize(nir_shader
*s
);
3568 void nir_validate_shader(nir_shader
*shader
, const char *when
);
3569 void nir_metadata_set_validation_flag(nir_shader
*shader
);
3570 void nir_metadata_check_validation_flag(nir_shader
*shader
);
3573 should_skip_nir(const char *name
)
3575 static const char *list
= NULL
;
3577 /* Comma separated list of names to skip. */
3578 list
= getenv("NIR_SKIP");
3586 return comma_separated_list_contains(list
, name
);
3590 should_clone_nir(void)
3592 static int should_clone
= -1;
3593 if (should_clone
< 0)
3594 should_clone
= env_var_as_boolean("NIR_TEST_CLONE", false);
3596 return should_clone
;
3600 should_serialize_deserialize_nir(void)
3602 static int test_serialize
= -1;
3603 if (test_serialize
< 0)
3604 test_serialize
= env_var_as_boolean("NIR_TEST_SERIALIZE", false);
3606 return test_serialize
;
3610 should_print_nir(void)
3612 static int should_print
= -1;
3613 if (should_print
< 0)
3614 should_print
= env_var_as_boolean("NIR_PRINT", false);
3616 return should_print
;
3619 static inline void nir_validate_shader(nir_shader
*shader
, const char *when
) { (void) shader
; (void)when
; }
3620 static inline void nir_metadata_set_validation_flag(nir_shader
*shader
) { (void) shader
; }
3621 static inline void nir_metadata_check_validation_flag(nir_shader
*shader
) { (void) shader
; }
3622 static inline bool should_skip_nir(UNUSED
const char *pass_name
) { return false; }
3623 static inline bool should_clone_nir(void) { return false; }
3624 static inline bool should_serialize_deserialize_nir(void) { return false; }
3625 static inline bool should_print_nir(void) { return false; }
3628 #define _PASS(pass, nir, do_pass) do { \
3629 if (should_skip_nir(#pass)) { \
3630 printf("skipping %s\n", #pass); \
3634 nir_validate_shader(nir, "after " #pass); \
3635 if (should_clone_nir()) { \
3636 nir_shader *clone = nir_shader_clone(ralloc_parent(nir), nir); \
3637 nir_shader_replace(nir, clone); \
3639 if (should_serialize_deserialize_nir()) { \
3640 nir_shader_serialize_deserialize(nir); \
3644 #define NIR_PASS(progress, nir, pass, ...) _PASS(pass, nir, \
3645 nir_metadata_set_validation_flag(nir); \
3646 if (should_print_nir()) \
3647 printf("%s\n", #pass); \
3648 if (pass(nir, ##__VA_ARGS__)) { \
3650 if (should_print_nir()) \
3651 nir_print_shader(nir, stdout); \
3652 nir_metadata_check_validation_flag(nir); \
3656 #define NIR_PASS_V(nir, pass, ...) _PASS(pass, nir, \
3657 if (should_print_nir()) \
3658 printf("%s\n", #pass); \
3659 pass(nir, ##__VA_ARGS__); \
3660 if (should_print_nir()) \
3661 nir_print_shader(nir, stdout); \
3664 #define NIR_SKIP(name) should_skip_nir(#name)
3666 /** An instruction filtering callback
3668 * Returns true if the instruction should be processed and false otherwise.
3670 typedef bool (*nir_instr_filter_cb
)(const nir_instr
*, const void *);
3672 /** A simple instruction lowering callback
3674 * Many instruction lowering passes can be written as a simple function which
3675 * takes an instruction as its input and returns a sequence of instructions
3676 * that implement the consumed instruction. This function type represents
3677 * such a lowering function. When called, a function with this prototype
3678 * should either return NULL indicating that no lowering needs to be done or
3679 * emit a sequence of instructions using the provided builder (whose cursor
3680 * will already be placed after the instruction to be lowered) and return the
3681 * resulting nir_ssa_def.
3683 typedef nir_ssa_def
*(*nir_lower_instr_cb
)(struct nir_builder
*,
3684 nir_instr
*, void *);
3687 * Special return value for nir_lower_instr_cb when some progress occurred
3688 * (like changing an input to the instr) that didn't result in a replacement
3689 * SSA def being generated.
3691 #define NIR_LOWER_INSTR_PROGRESS ((nir_ssa_def *)(uintptr_t)1)
3693 /** Iterate over all the instructions in a nir_function_impl and lower them
3694 * using the provided callbacks
3696 * This function implements the guts of a standard lowering pass for you. It
3697 * iterates over all of the instructions in a nir_function_impl and calls the
3698 * filter callback on each one. If the filter callback returns true, it then
3699 * calls the lowering call back on the instruction. (Splitting it this way
3700 * allows us to avoid some save/restore work for instructions we know won't be
3701 * lowered.) If the instruction is dead after the lowering is complete, it
3702 * will be removed. If new instructions are added, the lowering callback will
3703 * also be called on them in case multiple lowerings are required.
3705 * The metadata for the nir_function_impl will also be updated. If any blocks
3706 * are added (they cannot be removed), dominance and block indices will be
3709 bool nir_function_impl_lower_instructions(nir_function_impl
*impl
,
3710 nir_instr_filter_cb filter
,
3711 nir_lower_instr_cb lower
,
3713 bool nir_shader_lower_instructions(nir_shader
*shader
,
3714 nir_instr_filter_cb filter
,
3715 nir_lower_instr_cb lower
,
3718 void nir_calc_dominance_impl(nir_function_impl
*impl
);
3719 void nir_calc_dominance(nir_shader
*shader
);
3721 nir_block
*nir_dominance_lca(nir_block
*b1
, nir_block
*b2
);
3722 bool nir_block_dominates(nir_block
*parent
, nir_block
*child
);
3723 bool nir_block_is_unreachable(nir_block
*block
);
3725 void nir_dump_dom_tree_impl(nir_function_impl
*impl
, FILE *fp
);
3726 void nir_dump_dom_tree(nir_shader
*shader
, FILE *fp
);
3728 void nir_dump_dom_frontier_impl(nir_function_impl
*impl
, FILE *fp
);
3729 void nir_dump_dom_frontier(nir_shader
*shader
, FILE *fp
);
3731 void nir_dump_cfg_impl(nir_function_impl
*impl
, FILE *fp
);
3732 void nir_dump_cfg(nir_shader
*shader
, FILE *fp
);
3734 int nir_gs_count_vertices(const nir_shader
*shader
);
3736 bool nir_shrink_vec_array_vars(nir_shader
*shader
, nir_variable_mode modes
);
3737 bool nir_split_array_vars(nir_shader
*shader
, nir_variable_mode modes
);
3738 bool nir_split_var_copies(nir_shader
*shader
);
3739 bool nir_split_per_member_structs(nir_shader
*shader
);
3740 bool nir_split_struct_vars(nir_shader
*shader
, nir_variable_mode modes
);
3742 bool nir_lower_returns_impl(nir_function_impl
*impl
);
3743 bool nir_lower_returns(nir_shader
*shader
);
3745 void nir_inline_function_impl(struct nir_builder
*b
,
3746 const nir_function_impl
*impl
,
3747 nir_ssa_def
**params
);
3748 bool nir_inline_functions(nir_shader
*shader
);
3750 bool nir_propagate_invariant(nir_shader
*shader
);
3752 void nir_lower_var_copy_instr(nir_intrinsic_instr
*copy
, nir_shader
*shader
);
3753 void nir_lower_deref_copy_instr(struct nir_builder
*b
,
3754 nir_intrinsic_instr
*copy
);
3755 bool nir_lower_var_copies(nir_shader
*shader
);
3757 void nir_fixup_deref_modes(nir_shader
*shader
);
3759 bool nir_lower_global_vars_to_local(nir_shader
*shader
);
3762 nir_lower_direct_array_deref_of_vec_load
= (1 << 0),
3763 nir_lower_indirect_array_deref_of_vec_load
= (1 << 1),
3764 nir_lower_direct_array_deref_of_vec_store
= (1 << 2),
3765 nir_lower_indirect_array_deref_of_vec_store
= (1 << 3),
3766 } nir_lower_array_deref_of_vec_options
;
3768 bool nir_lower_array_deref_of_vec(nir_shader
*shader
, nir_variable_mode modes
,
3769 nir_lower_array_deref_of_vec_options options
);
3771 bool nir_lower_indirect_derefs(nir_shader
*shader
, nir_variable_mode modes
);
3773 bool nir_lower_locals_to_regs(nir_shader
*shader
);
3775 void nir_lower_io_to_temporaries(nir_shader
*shader
,
3776 nir_function_impl
*entrypoint
,
3777 bool outputs
, bool inputs
);
3779 bool nir_lower_vars_to_scratch(nir_shader
*shader
,
3780 nir_variable_mode modes
,
3782 glsl_type_size_align_func size_align
);
3784 void nir_lower_clip_halfz(nir_shader
*shader
);
3786 void nir_shader_gather_info(nir_shader
*shader
, nir_function_impl
*entrypoint
);
3788 void nir_gather_ssa_types(nir_function_impl
*impl
,
3789 BITSET_WORD
*float_types
,
3790 BITSET_WORD
*int_types
);
3792 void nir_assign_var_locations(struct exec_list
*var_list
, unsigned *size
,
3793 int (*type_size
)(const struct glsl_type
*, bool));
3795 /* Some helpers to do very simple linking */
3796 bool nir_remove_unused_varyings(nir_shader
*producer
, nir_shader
*consumer
);
3797 bool nir_remove_unused_io_vars(nir_shader
*shader
, struct exec_list
*var_list
,
3798 uint64_t *used_by_other_stage
,
3799 uint64_t *used_by_other_stage_patches
);
3800 void nir_compact_varyings(nir_shader
*producer
, nir_shader
*consumer
,
3801 bool default_to_smooth_interp
);
3802 void nir_link_xfb_varyings(nir_shader
*producer
, nir_shader
*consumer
);
3803 bool nir_link_opt_varyings(nir_shader
*producer
, nir_shader
*consumer
);
3805 bool nir_lower_amul(nir_shader
*shader
,
3806 int (*type_size
)(const struct glsl_type
*, bool));
3808 void nir_assign_io_var_locations(struct exec_list
*var_list
,
3810 gl_shader_stage stage
);
3813 uint8_t num_linked_io_vars
;
3814 uint8_t num_linked_patch_io_vars
;
3815 } nir_linked_io_var_info
;
3817 nir_linked_io_var_info
3818 nir_assign_linked_io_var_locations(nir_shader
*producer
,
3819 nir_shader
*consumer
);
3822 /* If set, this causes all 64-bit IO operations to be lowered on-the-fly
3823 * to 32-bit operations. This is only valid for nir_var_shader_in/out
3826 nir_lower_io_lower_64bit_to_32
= (1 << 0),
3828 /* If set, this forces all non-flat fragment shader inputs to be
3829 * interpolated as if with the "sample" qualifier. This requires
3830 * nir_shader_compiler_options::use_interpolated_input_intrinsics.
3832 nir_lower_io_force_sample_interpolation
= (1 << 1),
3833 } nir_lower_io_options
;
3834 bool nir_lower_io(nir_shader
*shader
,
3835 nir_variable_mode modes
,
3836 int (*type_size
)(const struct glsl_type
*, bool),
3837 nir_lower_io_options
);
3839 bool nir_io_add_const_offset_to_base(nir_shader
*nir
, nir_variable_mode mode
);
3842 nir_lower_vars_to_explicit_types(nir_shader
*shader
,
3843 nir_variable_mode modes
,
3844 glsl_type_size_align_func type_info
);
3848 * An address format which is a simple 32-bit global GPU address.
3850 nir_address_format_32bit_global
,
3853 * An address format which is a simple 64-bit global GPU address.
3855 nir_address_format_64bit_global
,
3858 * An address format which is a bounds-checked 64-bit global GPU address.
3860 * The address is comprised as a 32-bit vec4 where .xy are a uint64_t base
3861 * address stored with the low bits in .x and high bits in .y, .z is a
3862 * size, and .w is an offset. When the final I/O operation is lowered, .w
3863 * is checked against .z and the operation is predicated on the result.
3865 nir_address_format_64bit_bounded_global
,
3868 * An address format which is comprised of a vec2 where the first
3869 * component is a buffer index and the second is an offset.
3871 nir_address_format_32bit_index_offset
,
3874 * An address format which is a simple 32-bit offset.
3876 nir_address_format_32bit_offset
,
3879 * An address format representing a purely logical addressing model. In
3880 * this model, all deref chains must be complete from the dereference
3881 * operation to the variable. Cast derefs are not allowed. These
3882 * addresses will be 32-bit scalars but the format is immaterial because
3883 * you can always chase the chain.
3885 nir_address_format_logical
,
3886 } nir_address_format
;
3888 static inline unsigned
3889 nir_address_format_bit_size(nir_address_format addr_format
)
3891 switch (addr_format
) {
3892 case nir_address_format_32bit_global
: return 32;
3893 case nir_address_format_64bit_global
: return 64;
3894 case nir_address_format_64bit_bounded_global
: return 32;
3895 case nir_address_format_32bit_index_offset
: return 32;
3896 case nir_address_format_32bit_offset
: return 32;
3897 case nir_address_format_logical
: return 32;
3899 unreachable("Invalid address format");
3902 static inline unsigned
3903 nir_address_format_num_components(nir_address_format addr_format
)
3905 switch (addr_format
) {
3906 case nir_address_format_32bit_global
: return 1;
3907 case nir_address_format_64bit_global
: return 1;
3908 case nir_address_format_64bit_bounded_global
: return 4;
3909 case nir_address_format_32bit_index_offset
: return 2;
3910 case nir_address_format_32bit_offset
: return 1;
3911 case nir_address_format_logical
: return 1;
3913 unreachable("Invalid address format");
3916 static inline const struct glsl_type
*
3917 nir_address_format_to_glsl_type(nir_address_format addr_format
)
3919 unsigned bit_size
= nir_address_format_bit_size(addr_format
);
3920 assert(bit_size
== 32 || bit_size
== 64);
3921 return glsl_vector_type(bit_size
== 32 ? GLSL_TYPE_UINT
: GLSL_TYPE_UINT64
,
3922 nir_address_format_num_components(addr_format
));
3925 const nir_const_value
*nir_address_format_null_value(nir_address_format addr_format
);
3927 nir_ssa_def
*nir_build_addr_ieq(struct nir_builder
*b
, nir_ssa_def
*addr0
, nir_ssa_def
*addr1
,
3928 nir_address_format addr_format
);
3930 nir_ssa_def
*nir_build_addr_isub(struct nir_builder
*b
, nir_ssa_def
*addr0
, nir_ssa_def
*addr1
,
3931 nir_address_format addr_format
);
3933 nir_ssa_def
* nir_explicit_io_address_from_deref(struct nir_builder
*b
,
3934 nir_deref_instr
*deref
,
3935 nir_ssa_def
*base_addr
,
3936 nir_address_format addr_format
);
3937 void nir_lower_explicit_io_instr(struct nir_builder
*b
,
3938 nir_intrinsic_instr
*io_instr
,
3940 nir_address_format addr_format
);
3942 bool nir_lower_explicit_io(nir_shader
*shader
,
3943 nir_variable_mode modes
,
3944 nir_address_format
);
3946 nir_src
*nir_get_io_offset_src(nir_intrinsic_instr
*instr
);
3947 nir_src
*nir_get_io_vertex_index_src(nir_intrinsic_instr
*instr
);
3949 bool nir_is_per_vertex_io(const nir_variable
*var
, gl_shader_stage stage
);
3951 bool nir_lower_regs_to_ssa_impl(nir_function_impl
*impl
);
3952 bool nir_lower_regs_to_ssa(nir_shader
*shader
);
3953 bool nir_lower_vars_to_ssa(nir_shader
*shader
);
3955 bool nir_remove_dead_derefs(nir_shader
*shader
);
3956 bool nir_remove_dead_derefs_impl(nir_function_impl
*impl
);
3957 bool nir_remove_dead_variables(nir_shader
*shader
, nir_variable_mode modes
);
3958 bool nir_lower_variable_initializers(nir_shader
*shader
,
3959 nir_variable_mode modes
);
3961 bool nir_move_vec_src_uses_to_dest(nir_shader
*shader
);
3962 bool nir_lower_vec_to_movs(nir_shader
*shader
);
3963 void nir_lower_alpha_test(nir_shader
*shader
, enum compare_func func
,
3965 const gl_state_index16
*alpha_ref_state_tokens
);
3966 bool nir_lower_alu(nir_shader
*shader
);
3968 bool nir_lower_flrp(nir_shader
*shader
, unsigned lowering_mask
,
3969 bool always_precise
, bool have_ffma
);
3971 bool nir_lower_alu_to_scalar(nir_shader
*shader
, nir_instr_filter_cb cb
, const void *data
);
3972 bool nir_lower_bool_to_bitsize(nir_shader
*shader
);
3973 bool nir_lower_bool_to_float(nir_shader
*shader
);
3974 bool nir_lower_bool_to_int32(nir_shader
*shader
);
3975 bool nir_lower_int_to_float(nir_shader
*shader
);
3976 bool nir_lower_load_const_to_scalar(nir_shader
*shader
);
3977 bool nir_lower_read_invocation_to_scalar(nir_shader
*shader
);
3978 bool nir_lower_phis_to_scalar(nir_shader
*shader
);
3979 void nir_lower_io_arrays_to_elements(nir_shader
*producer
, nir_shader
*consumer
);
3980 void nir_lower_io_arrays_to_elements_no_indirects(nir_shader
*shader
,
3982 void nir_lower_io_to_scalar(nir_shader
*shader
, nir_variable_mode mask
);
3983 void nir_lower_io_to_scalar_early(nir_shader
*shader
, nir_variable_mode mask
);
3984 bool nir_lower_io_to_vector(nir_shader
*shader
, nir_variable_mode mask
);
3986 void nir_lower_fragcoord_wtrans(nir_shader
*shader
);
3987 void nir_lower_viewport_transform(nir_shader
*shader
);
3988 bool nir_lower_uniforms_to_ubo(nir_shader
*shader
, int multiplier
);
3990 typedef struct nir_lower_subgroups_options
{
3991 uint8_t subgroup_size
;
3992 uint8_t ballot_bit_size
;
3993 bool lower_to_scalar
:1;
3994 bool lower_vote_trivial
:1;
3995 bool lower_vote_eq_to_ballot
:1;
3996 bool lower_subgroup_masks
:1;
3997 bool lower_shuffle
:1;
3998 bool lower_shuffle_to_32bit
:1;
4000 bool lower_quad_broadcast_dynamic
:1;
4001 bool lower_quad_broadcast_dynamic_to_const
:1;
4002 } nir_lower_subgroups_options
;
4004 bool nir_lower_subgroups(nir_shader
*shader
,
4005 const nir_lower_subgroups_options
*options
);
4007 bool nir_lower_system_values(nir_shader
*shader
);
4009 enum PACKED nir_lower_tex_packing
{
4010 nir_lower_tex_packing_none
= 0,
4011 /* The sampler returns up to 2 32-bit words of half floats or 16-bit signed
4012 * or unsigned ints based on the sampler type
4014 nir_lower_tex_packing_16
,
4015 /* The sampler returns 1 32-bit word of 4x8 unorm */
4016 nir_lower_tex_packing_8
,
4019 typedef struct nir_lower_tex_options
{
4021 * bitmask of (1 << GLSL_SAMPLER_DIM_x) to control for which
4022 * sampler types a texture projector is lowered.
4027 * If true, lower away nir_tex_src_offset for all texelfetch instructions.
4029 bool lower_txf_offset
;
4032 * If true, lower away nir_tex_src_offset for all rect textures.
4034 bool lower_rect_offset
;
4037 * If true, lower rect textures to 2D, using txs to fetch the
4038 * texture dimensions and dividing the texture coords by the
4039 * texture dims to normalize.
4044 * If true, convert yuv to rgb.
4046 unsigned lower_y_uv_external
;
4047 unsigned lower_y_u_v_external
;
4048 unsigned lower_yx_xuxv_external
;
4049 unsigned lower_xy_uxvx_external
;
4050 unsigned lower_ayuv_external
;
4051 unsigned lower_xyuv_external
;
4054 * To emulate certain texture wrap modes, this can be used
4055 * to saturate the specified tex coord to [0.0, 1.0]. The
4056 * bits are according to sampler #, ie. if, for example:
4058 * (conf->saturate_s & (1 << n))
4060 * is true, then the s coord for sampler n is saturated.
4062 * Note that clamping must happen *after* projector lowering
4063 * so any projected texture sample instruction with a clamped
4064 * coordinate gets automatically lowered, regardless of the
4065 * 'lower_txp' setting.
4067 unsigned saturate_s
;
4068 unsigned saturate_t
;
4069 unsigned saturate_r
;
4071 /* Bitmask of textures that need swizzling.
4073 * If (swizzle_result & (1 << texture_index)), then the swizzle in
4074 * swizzles[texture_index] is applied to the result of the texturing
4077 unsigned swizzle_result
;
4079 /* A swizzle for each texture. Values 0-3 represent x, y, z, or w swizzles
4080 * while 4 and 5 represent 0 and 1 respectively.
4082 uint8_t swizzles
[32][4];
4084 /* Can be used to scale sampled values in range required by the format. */
4085 float scale_factors
[32];
4088 * Bitmap of textures that need srgb to linear conversion. If
4089 * (lower_srgb & (1 << texture_index)) then the rgb (xyz) components
4090 * of the texture are lowered to linear.
4092 unsigned lower_srgb
;
4095 * If true, lower nir_texop_tex on shaders that doesn't support implicit
4096 * LODs to nir_texop_txl.
4098 bool lower_tex_without_implicit_lod
;
4101 * If true, lower nir_texop_txd on cube maps with nir_texop_txl.
4103 bool lower_txd_cube_map
;
4106 * If true, lower nir_texop_txd on 3D surfaces with nir_texop_txl.
4111 * If true, lower nir_texop_txd on shadow samplers (except cube maps)
4112 * with nir_texop_txl. Notice that cube map shadow samplers are lowered
4113 * with lower_txd_cube_map.
4115 bool lower_txd_shadow
;
4118 * If true, lower nir_texop_txd on all samplers to a nir_texop_txl.
4119 * Implies lower_txd_cube_map and lower_txd_shadow.
4124 * If true, lower nir_texop_txb that try to use shadow compare and min_lod
4125 * at the same time to a nir_texop_lod, some math, and nir_texop_tex.
4127 bool lower_txb_shadow_clamp
;
4130 * If true, lower nir_texop_txd on shadow samplers when it uses min_lod
4131 * with nir_texop_txl. This includes cube maps.
4133 bool lower_txd_shadow_clamp
;
4136 * If true, lower nir_texop_txd on when it uses both offset and min_lod
4137 * with nir_texop_txl. This includes cube maps.
4139 bool lower_txd_offset_clamp
;
4142 * If true, lower nir_texop_txd with min_lod to a nir_texop_txl if the
4143 * sampler is bindless.
4145 bool lower_txd_clamp_bindless_sampler
;
4148 * If true, lower nir_texop_txd with min_lod to a nir_texop_txl if the
4149 * sampler index is not statically determinable to be less than 16.
4151 bool lower_txd_clamp_if_sampler_index_not_lt_16
;
4154 * If true, lower nir_texop_txs with a non-0-lod into nir_texop_txs with
4155 * 0-lod followed by a nir_ishr.
4160 * If true, apply a .bagr swizzle on tg4 results to handle Broadcom's
4161 * mixed-up tg4 locations.
4163 bool lower_tg4_broadcom_swizzle
;
4166 * If true, lowers tg4 with 4 constant offsets to 4 tg4 calls
4168 bool lower_tg4_offsets
;
4170 enum nir_lower_tex_packing lower_tex_packing
[32];
4171 } nir_lower_tex_options
;
4173 bool nir_lower_tex(nir_shader
*shader
,
4174 const nir_lower_tex_options
*options
);
4176 enum nir_lower_non_uniform_access_type
{
4177 nir_lower_non_uniform_ubo_access
= (1 << 0),
4178 nir_lower_non_uniform_ssbo_access
= (1 << 1),
4179 nir_lower_non_uniform_texture_access
= (1 << 2),
4180 nir_lower_non_uniform_image_access
= (1 << 3),
4183 bool nir_lower_non_uniform_access(nir_shader
*shader
,
4184 enum nir_lower_non_uniform_access_type
);
4186 enum nir_lower_idiv_path
{
4187 /* This path is based on NV50LegalizeSSA::handleDIV(). It is the faster of
4188 * the two but it is not exact in some cases (for example, 1091317713u /
4189 * 1034u gives 5209173 instead of 1055432) */
4190 nir_lower_idiv_fast
,
4191 /* This path is based on AMDGPUTargetLowering::LowerUDIVREM() and
4192 * AMDGPUTargetLowering::LowerSDIVREM(). It requires more instructions than
4193 * the nv50 path and many of them are integer multiplications, so it is
4194 * probably slower. It should always return the correct result, though. */
4195 nir_lower_idiv_precise
,
4198 bool nir_lower_idiv(nir_shader
*shader
, enum nir_lower_idiv_path path
);
4200 bool nir_lower_input_attachments(nir_shader
*shader
, bool use_fragcoord_sysval
);
4202 bool nir_lower_clip_vs(nir_shader
*shader
, unsigned ucp_enables
,
4204 bool use_clipdist_array
,
4205 const gl_state_index16 clipplane_state_tokens
[][STATE_LENGTH
]);
4206 bool nir_lower_clip_gs(nir_shader
*shader
, unsigned ucp_enables
,
4207 bool use_clipdist_array
,
4208 const gl_state_index16 clipplane_state_tokens
[][STATE_LENGTH
]);
4209 bool nir_lower_clip_fs(nir_shader
*shader
, unsigned ucp_enables
,
4210 bool use_clipdist_array
);
4211 bool nir_lower_clip_cull_distance_arrays(nir_shader
*nir
);
4213 void nir_lower_point_size_mov(nir_shader
*shader
,
4214 const gl_state_index16
*pointsize_state_tokens
);
4216 bool nir_lower_frexp(nir_shader
*nir
);
4218 void nir_lower_two_sided_color(nir_shader
*shader
);
4220 bool nir_lower_clamp_color_outputs(nir_shader
*shader
);
4222 bool nir_lower_flatshade(nir_shader
*shader
);
4224 void nir_lower_passthrough_edgeflags(nir_shader
*shader
);
4225 bool nir_lower_patch_vertices(nir_shader
*nir
, unsigned static_count
,
4226 const gl_state_index16
*uniform_state_tokens
);
4228 typedef struct nir_lower_wpos_ytransform_options
{
4229 gl_state_index16 state_tokens
[STATE_LENGTH
];
4230 bool fs_coord_origin_upper_left
:1;
4231 bool fs_coord_origin_lower_left
:1;
4232 bool fs_coord_pixel_center_integer
:1;
4233 bool fs_coord_pixel_center_half_integer
:1;
4234 } nir_lower_wpos_ytransform_options
;
4236 bool nir_lower_wpos_ytransform(nir_shader
*shader
,
4237 const nir_lower_wpos_ytransform_options
*options
);
4238 bool nir_lower_wpos_center(nir_shader
*shader
, const bool for_sample_shading
);
4240 bool nir_lower_fb_read(nir_shader
*shader
);
4242 typedef struct nir_lower_drawpixels_options
{
4243 gl_state_index16 texcoord_state_tokens
[STATE_LENGTH
];
4244 gl_state_index16 scale_state_tokens
[STATE_LENGTH
];
4245 gl_state_index16 bias_state_tokens
[STATE_LENGTH
];
4246 unsigned drawpix_sampler
;
4247 unsigned pixelmap_sampler
;
4249 bool scale_and_bias
:1;
4250 } nir_lower_drawpixels_options
;
4252 void nir_lower_drawpixels(nir_shader
*shader
,
4253 const nir_lower_drawpixels_options
*options
);
4255 typedef struct nir_lower_bitmap_options
{
4258 } nir_lower_bitmap_options
;
4260 void nir_lower_bitmap(nir_shader
*shader
, const nir_lower_bitmap_options
*options
);
4262 bool nir_lower_atomics_to_ssbo(nir_shader
*shader
);
4265 nir_lower_int_source_mods
= 1 << 0,
4266 nir_lower_float_source_mods
= 1 << 1,
4267 nir_lower_triop_abs
= 1 << 2,
4268 nir_lower_all_source_mods
= (1 << 3) - 1
4269 } nir_lower_to_source_mods_flags
;
4272 bool nir_lower_to_source_mods(nir_shader
*shader
, nir_lower_to_source_mods_flags options
);
4274 bool nir_lower_gs_intrinsics(nir_shader
*shader
, bool per_stream
);
4276 typedef unsigned (*nir_lower_bit_size_callback
)(const nir_alu_instr
*, void *);
4278 bool nir_lower_bit_size(nir_shader
*shader
,
4279 nir_lower_bit_size_callback callback
,
4280 void *callback_data
);
4282 nir_lower_int64_options
nir_lower_int64_op_to_options_mask(nir_op opcode
);
4283 bool nir_lower_int64(nir_shader
*shader
, nir_lower_int64_options options
);
4285 nir_lower_doubles_options
nir_lower_doubles_op_to_options_mask(nir_op opcode
);
4286 bool nir_lower_doubles(nir_shader
*shader
, const nir_shader
*softfp64
,
4287 nir_lower_doubles_options options
);
4288 bool nir_lower_pack(nir_shader
*shader
);
4290 void nir_lower_mediump_outputs(nir_shader
*nir
);
4292 bool nir_lower_point_size(nir_shader
*shader
, float min
, float max
);
4295 nir_lower_interpolation_at_sample
= (1 << 1),
4296 nir_lower_interpolation_at_offset
= (1 << 2),
4297 nir_lower_interpolation_centroid
= (1 << 3),
4298 nir_lower_interpolation_pixel
= (1 << 4),
4299 nir_lower_interpolation_sample
= (1 << 5),
4300 } nir_lower_interpolation_options
;
4302 bool nir_lower_interpolation(nir_shader
*shader
,
4303 nir_lower_interpolation_options options
);
4305 bool nir_lower_discard_to_demote(nir_shader
*shader
);
4307 bool nir_normalize_cubemap_coords(nir_shader
*shader
);
4309 void nir_live_ssa_defs_impl(nir_function_impl
*impl
);
4311 void nir_loop_analyze_impl(nir_function_impl
*impl
,
4312 nir_variable_mode indirect_mask
);
4314 bool nir_ssa_defs_interfere(nir_ssa_def
*a
, nir_ssa_def
*b
);
4316 bool nir_repair_ssa_impl(nir_function_impl
*impl
);
4317 bool nir_repair_ssa(nir_shader
*shader
);
4319 void nir_convert_loop_to_lcssa(nir_loop
*loop
);
4320 bool nir_convert_to_lcssa(nir_shader
*shader
, bool skip_invariants
, bool skip_bool_invariants
);
4321 bool* nir_divergence_analysis(nir_shader
*shader
, nir_divergence_options options
);
4323 /* If phi_webs_only is true, only convert SSA values involved in phi nodes to
4324 * registers. If false, convert all values (even those not involved in a phi
4325 * node) to registers.
4327 bool nir_convert_from_ssa(nir_shader
*shader
, bool phi_webs_only
);
4329 bool nir_lower_phis_to_regs_block(nir_block
*block
);
4330 bool nir_lower_ssa_defs_to_regs_block(nir_block
*block
);
4331 bool nir_rematerialize_derefs_in_use_blocks_impl(nir_function_impl
*impl
);
4333 bool nir_lower_samplers(nir_shader
*shader
);
4334 bool nir_lower_ssbo(nir_shader
*shader
);
4336 /* This is here for unit tests. */
4337 bool nir_opt_comparison_pre_impl(nir_function_impl
*impl
);
4339 bool nir_opt_comparison_pre(nir_shader
*shader
);
4341 bool nir_opt_access(nir_shader
*shader
);
4342 bool nir_opt_algebraic(nir_shader
*shader
);
4343 bool nir_opt_algebraic_before_ffma(nir_shader
*shader
);
4344 bool nir_opt_algebraic_late(nir_shader
*shader
);
4345 bool nir_opt_algebraic_distribute_src_mods(nir_shader
*shader
);
4346 bool nir_opt_constant_folding(nir_shader
*shader
);
4348 /* Try to combine a and b into a. Return true if combination was possible,
4349 * which will result in b being removed by the pass. Return false if
4350 * combination wasn't possible.
4352 typedef bool (*nir_combine_memory_barrier_cb
)(
4353 nir_intrinsic_instr
*a
, nir_intrinsic_instr
*b
, void *data
);
4355 bool nir_opt_combine_memory_barriers(nir_shader
*shader
,
4356 nir_combine_memory_barrier_cb combine_cb
,
4359 bool nir_opt_combine_stores(nir_shader
*shader
, nir_variable_mode modes
);
4361 bool nir_copy_prop(nir_shader
*shader
);
4363 bool nir_opt_copy_prop_vars(nir_shader
*shader
);
4365 bool nir_opt_cse(nir_shader
*shader
);
4367 bool nir_opt_dce(nir_shader
*shader
);
4369 bool nir_opt_dead_cf(nir_shader
*shader
);
4371 bool nir_opt_dead_write_vars(nir_shader
*shader
);
4373 bool nir_opt_deref_impl(nir_function_impl
*impl
);
4374 bool nir_opt_deref(nir_shader
*shader
);
4376 bool nir_opt_find_array_copies(nir_shader
*shader
);
4378 bool nir_opt_gcm(nir_shader
*shader
, bool value_number
);
4380 bool nir_opt_idiv_const(nir_shader
*shader
, unsigned min_bit_size
);
4382 bool nir_opt_if(nir_shader
*shader
, bool aggressive_last_continue
);
4384 bool nir_opt_intrinsics(nir_shader
*shader
);
4386 bool nir_opt_large_constants(nir_shader
*shader
,
4387 glsl_type_size_align_func size_align
,
4388 unsigned threshold
);
4390 bool nir_opt_loop_unroll(nir_shader
*shader
, nir_variable_mode indirect_mask
);
4393 nir_move_const_undef
= (1 << 0),
4394 nir_move_load_ubo
= (1 << 1),
4395 nir_move_load_input
= (1 << 2),
4396 nir_move_comparisons
= (1 << 3),
4397 nir_move_copies
= (1 << 4),
4400 bool nir_can_move_instr(nir_instr
*instr
, nir_move_options options
);
4402 bool nir_opt_sink(nir_shader
*shader
, nir_move_options options
);
4404 bool nir_opt_move(nir_shader
*shader
, nir_move_options options
);
4406 bool nir_opt_peephole_select(nir_shader
*shader
, unsigned limit
,
4407 bool indirect_load_ok
, bool expensive_alu_ok
);
4409 bool nir_opt_rematerialize_compares(nir_shader
*shader
);
4411 bool nir_opt_remove_phis(nir_shader
*shader
);
4412 bool nir_opt_remove_phis_block(nir_block
*block
);
4414 bool nir_opt_shrink_load(nir_shader
*shader
);
4416 bool nir_opt_trivial_continues(nir_shader
*shader
);
4418 bool nir_opt_undef(nir_shader
*shader
);
4420 bool nir_opt_vectorize(nir_shader
*shader
);
4422 bool nir_opt_conditional_discard(nir_shader
*shader
);
4424 typedef bool (*nir_should_vectorize_mem_func
)(unsigned align
, unsigned bit_size
,
4425 unsigned num_components
, unsigned high_offset
,
4426 nir_intrinsic_instr
*low
, nir_intrinsic_instr
*high
);
4428 bool nir_opt_load_store_vectorize(nir_shader
*shader
, nir_variable_mode modes
,
4429 nir_should_vectorize_mem_func callback
);
4431 void nir_schedule(nir_shader
*shader
, int threshold
);
4433 void nir_strip(nir_shader
*shader
);
4435 void nir_sweep(nir_shader
*shader
);
4437 void nir_remap_dual_slot_attributes(nir_shader
*shader
,
4438 uint64_t *dual_slot_inputs
);
4439 uint64_t nir_get_single_slot_attribs_mask(uint64_t attribs
, uint64_t dual_slot
);
4441 nir_intrinsic_op
nir_intrinsic_from_system_value(gl_system_value val
);
4442 gl_system_value
nir_system_value_from_intrinsic(nir_intrinsic_op intrin
);
4445 nir_variable_is_in_ubo(const nir_variable
*var
)
4447 return (var
->data
.mode
== nir_var_mem_ubo
&&
4448 var
->interface_type
!= NULL
);
4452 nir_variable_is_in_ssbo(const nir_variable
*var
)
4454 return (var
->data
.mode
== nir_var_mem_ssbo
&&
4455 var
->interface_type
!= NULL
);
4459 nir_variable_is_in_block(const nir_variable
*var
)
4461 return nir_variable_is_in_ubo(var
) || nir_variable_is_in_ssbo(var
);