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 "compiler/nir_types.h"
41 #include "compiler/shader_enums.h"
42 #include "compiler/shader_info.h"
46 #include "util/debug.h"
49 #include "nir_opcodes.h"
51 #if defined(_WIN32) && !defined(snprintf)
52 #define snprintf _snprintf
60 #define NIR_TRUE (~0u)
61 #define NIR_MAX_VEC_COMPONENTS 4
62 #define NIR_MAX_MATRIX_COLUMNS 4
63 typedef uint8_t nir_component_mask_t
;
65 /** Defines a cast function
67 * This macro defines a cast function from in_type to out_type where
68 * out_type is some structure type that contains a field of type out_type.
70 * Note that you have to be a bit careful as the generated cast function
73 #define NIR_DEFINE_CAST(name, in_type, out_type, field, \
74 type_field, type_value) \
75 static inline out_type * \
76 name(const in_type *parent) \
78 assert(parent && parent->type_field == type_value); \
79 return exec_node_data(out_type, parent, field); \
89 * Description of built-in state associated with a uniform
91 * \sa nir_variable::state_slots
94 gl_state_index16 tokens
[STATE_LENGTH
];
99 nir_var_shader_in
= (1 << 0),
100 nir_var_shader_out
= (1 << 1),
101 nir_var_shader_temp
= (1 << 2),
102 nir_var_function_temp
= (1 << 3),
103 nir_var_uniform
= (1 << 4),
104 nir_var_mem_ubo
= (1 << 5),
105 nir_var_system_value
= (1 << 6),
106 nir_var_mem_ssbo
= (1 << 7),
107 nir_var_mem_shared
= (1 << 8),
108 nir_var_mem_global
= (1 << 9),
116 nir_rounding_mode_undef
= 0,
117 nir_rounding_mode_rtne
= 1, /* round to nearest even */
118 nir_rounding_mode_ru
= 2, /* round up */
119 nir_rounding_mode_rd
= 3, /* round down */
120 nir_rounding_mode_rtz
= 4, /* round towards zero */
137 #define nir_const_value_to_array(arr, c, components, m) \
139 for (unsigned i = 0; i < components; ++i) \
143 static inline nir_const_value
144 nir_const_value_for_raw_uint(uint64_t x
, unsigned bit_size
)
147 memset(&v
, 0, sizeof(v
));
150 case 1: v
.b
= x
; break;
151 case 8: v
.u8
= x
; break;
152 case 16: v
.u16
= x
; break;
153 case 32: v
.u32
= x
; break;
154 case 64: v
.u64
= x
; break;
156 unreachable("Invalid bit size");
162 static inline nir_const_value
163 nir_const_value_for_int(int64_t i
, unsigned bit_size
)
166 memset(&v
, 0, sizeof(v
));
168 assert(bit_size
<= 64);
170 assert(i
>= (-(1ll << (bit_size
- 1))));
171 assert(i
< (1ll << (bit_size
- 1)));
174 return nir_const_value_for_raw_uint(i
, bit_size
);
177 static inline nir_const_value
178 nir_const_value_for_uint(uint64_t u
, unsigned bit_size
)
181 memset(&v
, 0, sizeof(v
));
183 assert(bit_size
<= 64);
185 assert(u
< (1ull << bit_size
));
187 return nir_const_value_for_raw_uint(u
, bit_size
);
190 static inline nir_const_value
191 nir_const_value_for_bool(bool b
, unsigned bit_size
)
193 /* Booleans use a 0/-1 convention */
194 return nir_const_value_for_int(-(int)b
, bit_size
);
197 /* This one isn't inline because it requires half-float conversion */
198 nir_const_value
nir_const_value_for_float(double b
, unsigned bit_size
);
200 static inline int64_t
201 nir_const_value_as_int(nir_const_value value
, unsigned bit_size
)
204 /* int1_t uses 0/-1 convention */
205 case 1: return -(int)value
.b
;
206 case 8: return value
.i8
;
207 case 16: return value
.i16
;
208 case 32: return value
.i32
;
209 case 64: return value
.i64
;
211 unreachable("Invalid bit size");
215 static inline int64_t
216 nir_const_value_as_uint(nir_const_value value
, unsigned bit_size
)
219 case 1: return value
.b
;
220 case 8: return value
.u8
;
221 case 16: return value
.u16
;
222 case 32: return value
.u32
;
223 case 64: return value
.u64
;
225 unreachable("Invalid bit size");
230 nir_const_value_as_bool(nir_const_value value
, unsigned bit_size
)
232 int64_t i
= nir_const_value_as_int(value
, bit_size
);
234 /* Booleans of any size use 0/-1 convention */
235 assert(i
== 0 || i
== -1);
240 /* This one isn't inline because it requires half-float conversion */
241 double nir_const_value_as_float(nir_const_value value
, unsigned bit_size
);
243 typedef struct nir_constant
{
245 * Value of the constant.
247 * The field used to back the values supplied by the constant is determined
248 * by the type associated with the \c nir_variable. Constants may be
249 * scalars, vectors, or matrices.
251 nir_const_value values
[NIR_MAX_VEC_COMPONENTS
];
253 /* we could get this from the var->type but makes clone *much* easier to
254 * not have to care about the type.
256 unsigned num_elements
;
258 /* Array elements / Structure Fields */
259 struct nir_constant
**elements
;
263 * \brief Layout qualifiers for gl_FragDepth.
265 * The AMD/ARB_conservative_depth extensions allow gl_FragDepth to be redeclared
266 * with a layout qualifier.
269 nir_depth_layout_none
, /**< No depth layout is specified. */
270 nir_depth_layout_any
,
271 nir_depth_layout_greater
,
272 nir_depth_layout_less
,
273 nir_depth_layout_unchanged
277 * Enum keeping track of how a variable was declared.
281 * Normal declaration.
283 nir_var_declared_normally
= 0,
286 * Variable is implicitly generated by the compiler and should not be
287 * visible via the API.
290 } nir_var_declaration_type
;
293 * Either a uniform, global variable, shader input, or shader output. Based on
294 * ir_variable - it should be easy to translate between the two.
297 typedef struct nir_variable
{
298 struct exec_node node
;
301 * Declared type of the variable
303 const struct glsl_type
*type
;
306 * Declared name of the variable
310 struct nir_variable_data
{
312 * Storage class of the variable.
314 * \sa nir_variable_mode
316 nir_variable_mode mode
;
319 * Is the variable read-only?
321 * This is set for variables declared as \c const, shader inputs,
324 unsigned read_only
:1;
328 unsigned invariant
:1;
331 * Can this variable be coalesced with another?
333 * This is set by nir_lower_io_to_temporaries to say that any
334 * copies involving this variable should stay put. Propagating it can
335 * duplicate the resulting load/store, which is not wanted, and may
336 * result in a load/store of the variable with an indirect offset which
337 * the backend may not be able to handle.
339 unsigned cannot_coalesce
:1;
342 * When separate shader programs are enabled, only input/outputs between
343 * the stages of a multi-stage separate program can be safely removed
344 * from the shader interface. Other input/outputs must remains active.
346 * This is also used to make sure xfb varyings that are unused by the
347 * fragment shader are not removed.
349 unsigned always_active_io
:1;
352 * Interpolation mode for shader inputs / outputs
354 * \sa glsl_interp_mode
356 unsigned interpolation
:2;
359 * If non-zero, then this variable may be packed along with other variables
360 * into a single varying slot, so this offset should be applied when
361 * accessing components. For example, an offset of 1 means that the x
362 * component of this variable is actually stored in component y of the
363 * location specified by \c location.
365 unsigned location_frac
:2;
368 * If true, this variable represents an array of scalars that should
369 * be tightly packed. In other words, consecutive array elements
370 * should be stored one component apart, rather than one slot apart.
375 * Whether this is a fragment shader output implicitly initialized with
376 * the previous contents of the specified render target at the
377 * framebuffer location corresponding to this shader invocation.
379 unsigned fb_fetch_output
:1;
382 * Non-zero if this variable is considered bindless as defined by
383 * ARB_bindless_texture.
388 * Was an explicit binding set in the shader?
390 unsigned explicit_binding
:1;
393 * Was a transfer feedback buffer set in the shader?
395 unsigned explicit_xfb_buffer
:1;
398 * Was a transfer feedback stride set in the shader?
400 unsigned explicit_xfb_stride
:1;
403 * Was an explicit offset set in the shader?
405 unsigned explicit_offset
:1;
408 * \brief Layout qualifier for gl_FragDepth.
410 * This is not equal to \c ir_depth_layout_none if and only if this
411 * variable is \c gl_FragDepth and a layout qualifier is specified.
413 nir_depth_layout depth_layout
;
416 * Storage location of the base of this variable
418 * The precise meaning of this field depends on the nature of the variable.
420 * - Vertex shader input: one of the values from \c gl_vert_attrib.
421 * - Vertex shader output: one of the values from \c gl_varying_slot.
422 * - Geometry shader input: one of the values from \c gl_varying_slot.
423 * - Geometry shader output: one of the values from \c gl_varying_slot.
424 * - Fragment shader input: one of the values from \c gl_varying_slot.
425 * - Fragment shader output: one of the values from \c gl_frag_result.
426 * - Uniforms: Per-stage uniform slot number for default uniform block.
427 * - Uniforms: Index within the uniform block definition for UBO members.
428 * - Non-UBO Uniforms: uniform slot number.
429 * - Other: This field is not currently used.
431 * If the variable is a uniform, shader input, or shader output, and the
432 * slot has not been assigned, the value will be -1.
437 * The actual location of the variable in the IR. Only valid for inputs
440 unsigned int driver_location
;
443 * Vertex stream output identifier.
445 * For packed outputs, bit 31 is set and bits [2*i+1,2*i] indicate the
446 * stream of the i-th component.
451 * output index for dual source blending.
456 * Descriptor set binding for sampler or UBO.
461 * Initial binding point for a sampler or UBO.
463 * For array types, this represents the binding point for the first element.
468 * Location an atomic counter or transform feedback is stored at.
473 * Transform feedback buffer.
478 * Transform feedback stride.
483 * How the variable was declared. See nir_var_declaration_type.
485 * This is used to detect variables generated by the compiler, so should
486 * not be visible via the API.
488 unsigned how_declared
:2;
491 * ARB_shader_image_load_store qualifiers.
494 enum gl_access_qualifier access
;
496 /** Image internal format if specified explicitly, otherwise GL_NONE. */
502 * Built-in state that backs this uniform
504 * Once set at variable creation, \c state_slots must remain invariant.
505 * This is because, ideally, this array would be shared by all clones of
506 * this variable in the IR tree. In other words, we'd really like for it
507 * to be a fly-weight.
509 * If the variable is not a uniform, \c num_state_slots will be zero and
510 * \c state_slots will be \c NULL.
513 unsigned num_state_slots
; /**< Number of state slots used */
514 nir_state_slot
*state_slots
; /**< State descriptors. */
518 * Constant expression assigned in the initializer of the variable
520 * This field should only be used temporarily by creators of NIR shaders
521 * and then lower_constant_initializers can be used to get rid of them.
522 * Most of the rest of NIR ignores this field or asserts that it's NULL.
524 nir_constant
*constant_initializer
;
527 * For variables that are in an interface block or are an instance of an
528 * interface block, this is the \c GLSL_TYPE_INTERFACE type for that block.
530 * \sa ir_variable::location
532 const struct glsl_type
*interface_type
;
535 * Description of per-member data for per-member struct variables
537 * This is used for variables which are actually an amalgamation of
538 * multiple entities such as a struct of built-in values or a struct of
539 * inputs each with their own layout specifier. This is only allowed on
540 * variables with a struct or array of array of struct type.
542 unsigned num_members
;
543 struct nir_variable_data
*members
;
546 #define nir_foreach_variable(var, var_list) \
547 foreach_list_typed(nir_variable, var, node, var_list)
549 #define nir_foreach_variable_safe(var, var_list) \
550 foreach_list_typed_safe(nir_variable, var, node, var_list)
553 nir_variable_is_global(const nir_variable
*var
)
555 return var
->data
.mode
!= nir_var_function_temp
;
558 typedef struct nir_register
{
559 struct exec_node node
;
561 unsigned num_components
; /** < number of vector components */
562 unsigned num_array_elems
; /** < size of array (0 for no array) */
564 /* The bit-size of each channel; must be one of 8, 16, 32, or 64 */
567 /** generic register index. */
570 /** only for debug purposes, can be NULL */
573 /** set of nir_srcs where this register is used (read from) */
574 struct list_head uses
;
576 /** set of nir_dests where this register is defined (written to) */
577 struct list_head defs
;
579 /** set of nir_ifs where this register is used as a condition */
580 struct list_head if_uses
;
583 #define nir_foreach_register(reg, reg_list) \
584 foreach_list_typed(nir_register, reg, node, reg_list)
585 #define nir_foreach_register_safe(reg, reg_list) \
586 foreach_list_typed_safe(nir_register, reg, node, reg_list)
588 typedef enum PACKED
{
590 nir_instr_type_deref
,
593 nir_instr_type_intrinsic
,
594 nir_instr_type_load_const
,
596 nir_instr_type_ssa_undef
,
598 nir_instr_type_parallel_copy
,
601 typedef struct nir_instr
{
602 struct exec_node node
;
603 struct nir_block
*block
;
606 /* A temporary for optimization and analysis passes to use for storing
607 * flags. For instance, DCE uses this to store the "dead/live" info.
611 /** generic instruction index. */
615 static inline nir_instr
*
616 nir_instr_next(nir_instr
*instr
)
618 struct exec_node
*next
= exec_node_get_next(&instr
->node
);
619 if (exec_node_is_tail_sentinel(next
))
622 return exec_node_data(nir_instr
, next
, node
);
625 static inline nir_instr
*
626 nir_instr_prev(nir_instr
*instr
)
628 struct exec_node
*prev
= exec_node_get_prev(&instr
->node
);
629 if (exec_node_is_head_sentinel(prev
))
632 return exec_node_data(nir_instr
, prev
, node
);
636 nir_instr_is_first(const nir_instr
*instr
)
638 return exec_node_is_head_sentinel(exec_node_get_prev_const(&instr
->node
));
642 nir_instr_is_last(const nir_instr
*instr
)
644 return exec_node_is_tail_sentinel(exec_node_get_next_const(&instr
->node
));
647 typedef struct nir_ssa_def
{
648 /** for debugging only, can be NULL */
651 /** generic SSA definition index. */
654 /** Index into the live_in and live_out bitfields */
657 /** Instruction which produces this SSA value. */
658 nir_instr
*parent_instr
;
660 /** set of nir_instrs where this register is used (read from) */
661 struct list_head uses
;
663 /** set of nir_ifs where this register is used as a condition */
664 struct list_head if_uses
;
666 uint8_t num_components
;
668 /* The bit-size of each channel; must be one of 8, 16, 32, or 64 */
676 struct nir_src
*indirect
; /** < NULL for no indirect offset */
677 unsigned base_offset
;
679 /* TODO use-def chain goes here */
683 nir_instr
*parent_instr
;
684 struct list_head def_link
;
687 struct nir_src
*indirect
; /** < NULL for no indirect offset */
688 unsigned base_offset
;
690 /* TODO def-use chain goes here */
695 typedef struct nir_src
{
697 /** Instruction that consumes this value as a source. */
698 nir_instr
*parent_instr
;
699 struct nir_if
*parent_if
;
702 struct list_head use_link
;
712 static inline nir_src
715 nir_src src
= { { NULL
} };
719 #define NIR_SRC_INIT nir_src_init()
721 #define nir_foreach_use(src, reg_or_ssa_def) \
722 list_for_each_entry(nir_src, src, &(reg_or_ssa_def)->uses, use_link)
724 #define nir_foreach_use_safe(src, reg_or_ssa_def) \
725 list_for_each_entry_safe(nir_src, src, &(reg_or_ssa_def)->uses, use_link)
727 #define nir_foreach_if_use(src, reg_or_ssa_def) \
728 list_for_each_entry(nir_src, src, &(reg_or_ssa_def)->if_uses, use_link)
730 #define nir_foreach_if_use_safe(src, reg_or_ssa_def) \
731 list_for_each_entry_safe(nir_src, src, &(reg_or_ssa_def)->if_uses, use_link)
742 static inline nir_dest
745 nir_dest dest
= { { { NULL
} } };
749 #define NIR_DEST_INIT nir_dest_init()
751 #define nir_foreach_def(dest, reg) \
752 list_for_each_entry(nir_dest, dest, &(reg)->defs, reg.def_link)
754 #define nir_foreach_def_safe(dest, reg) \
755 list_for_each_entry_safe(nir_dest, dest, &(reg)->defs, reg.def_link)
757 static inline nir_src
758 nir_src_for_ssa(nir_ssa_def
*def
)
760 nir_src src
= NIR_SRC_INIT
;
768 static inline nir_src
769 nir_src_for_reg(nir_register
*reg
)
771 nir_src src
= NIR_SRC_INIT
;
775 src
.reg
.indirect
= NULL
;
776 src
.reg
.base_offset
= 0;
781 static inline nir_dest
782 nir_dest_for_reg(nir_register
*reg
)
784 nir_dest dest
= NIR_DEST_INIT
;
791 static inline unsigned
792 nir_src_bit_size(nir_src src
)
794 return src
.is_ssa
? src
.ssa
->bit_size
: src
.reg
.reg
->bit_size
;
797 static inline unsigned
798 nir_src_num_components(nir_src src
)
800 return src
.is_ssa
? src
.ssa
->num_components
: src
.reg
.reg
->num_components
;
804 nir_src_is_const(nir_src src
)
807 src
.ssa
->parent_instr
->type
== nir_instr_type_load_const
;
810 static inline unsigned
811 nir_dest_bit_size(nir_dest dest
)
813 return dest
.is_ssa
? dest
.ssa
.bit_size
: dest
.reg
.reg
->bit_size
;
816 static inline unsigned
817 nir_dest_num_components(nir_dest dest
)
819 return dest
.is_ssa
? dest
.ssa
.num_components
: dest
.reg
.reg
->num_components
;
822 void nir_src_copy(nir_src
*dest
, const nir_src
*src
, void *instr_or_if
);
823 void nir_dest_copy(nir_dest
*dest
, const nir_dest
*src
, nir_instr
*instr
);
829 * \name input modifiers
833 * For inputs interpreted as floating point, flips the sign bit. For
834 * inputs interpreted as integers, performs the two's complement negation.
839 * Clears the sign bit for floating point values, and computes the integer
840 * absolute value for integers. Note that the negate modifier acts after
841 * the absolute value modifier, therefore if both are set then all inputs
842 * will become negative.
848 * For each input component, says which component of the register it is
849 * chosen from. Note that which elements of the swizzle are used and which
850 * are ignored are based on the write mask for most opcodes - for example,
851 * a statement like "foo.xzw = bar.zyx" would have a writemask of 1101b and
852 * a swizzle of {2, x, 1, 0} where x means "don't care."
854 uint8_t swizzle
[NIR_MAX_VEC_COMPONENTS
];
861 * \name saturate output modifier
863 * Only valid for opcodes that output floating-point numbers. Clamps the
864 * output to between 0.0 and 1.0 inclusive.
869 unsigned write_mask
: NIR_MAX_VEC_COMPONENTS
; /* ignored if dest.is_ssa is true */
872 /** NIR sized and unsized types
874 * The values in this enum are carefully chosen so that the sized type is
875 * just the unsized type OR the number of bits.
878 nir_type_invalid
= 0, /* Not a valid type */
882 nir_type_float
= 128,
883 nir_type_bool1
= 1 | nir_type_bool
,
884 nir_type_bool32
= 32 | nir_type_bool
,
885 nir_type_int1
= 1 | nir_type_int
,
886 nir_type_int8
= 8 | nir_type_int
,
887 nir_type_int16
= 16 | nir_type_int
,
888 nir_type_int32
= 32 | nir_type_int
,
889 nir_type_int64
= 64 | nir_type_int
,
890 nir_type_uint1
= 1 | nir_type_uint
,
891 nir_type_uint8
= 8 | nir_type_uint
,
892 nir_type_uint16
= 16 | nir_type_uint
,
893 nir_type_uint32
= 32 | nir_type_uint
,
894 nir_type_uint64
= 64 | nir_type_uint
,
895 nir_type_float16
= 16 | nir_type_float
,
896 nir_type_float32
= 32 | nir_type_float
,
897 nir_type_float64
= 64 | nir_type_float
,
900 #define NIR_ALU_TYPE_SIZE_MASK 0x79
901 #define NIR_ALU_TYPE_BASE_TYPE_MASK 0x86
903 static inline unsigned
904 nir_alu_type_get_type_size(nir_alu_type type
)
906 return type
& NIR_ALU_TYPE_SIZE_MASK
;
909 static inline unsigned
910 nir_alu_type_get_base_type(nir_alu_type type
)
912 return type
& NIR_ALU_TYPE_BASE_TYPE_MASK
;
915 static inline nir_alu_type
916 nir_get_nir_type_for_glsl_base_type(enum glsl_base_type base_type
)
920 return nir_type_bool1
;
923 return nir_type_uint32
;
926 return nir_type_int32
;
928 case GLSL_TYPE_UINT16
:
929 return nir_type_uint16
;
931 case GLSL_TYPE_INT16
:
932 return nir_type_int16
;
934 case GLSL_TYPE_UINT8
:
935 return nir_type_uint8
;
937 return nir_type_int8
;
938 case GLSL_TYPE_UINT64
:
939 return nir_type_uint64
;
941 case GLSL_TYPE_INT64
:
942 return nir_type_int64
;
944 case GLSL_TYPE_FLOAT
:
945 return nir_type_float32
;
947 case GLSL_TYPE_FLOAT16
:
948 return nir_type_float16
;
950 case GLSL_TYPE_DOUBLE
:
951 return nir_type_float64
;
954 case GLSL_TYPE_SAMPLER
:
955 case GLSL_TYPE_IMAGE
:
956 case GLSL_TYPE_ATOMIC_UINT
:
957 case GLSL_TYPE_STRUCT
:
958 case GLSL_TYPE_INTERFACE
:
959 case GLSL_TYPE_ARRAY
:
961 case GLSL_TYPE_SUBROUTINE
:
962 case GLSL_TYPE_FUNCTION
:
963 case GLSL_TYPE_ERROR
:
964 return nir_type_invalid
;
967 unreachable("unknown type");
970 static inline nir_alu_type
971 nir_get_nir_type_for_glsl_type(const struct glsl_type
*type
)
973 return nir_get_nir_type_for_glsl_base_type(glsl_get_base_type(type
));
976 nir_op
nir_type_conversion_op(nir_alu_type src
, nir_alu_type dst
,
977 nir_rounding_mode rnd
);
980 nir_op_vec(unsigned components
)
982 switch (components
) {
983 case 1: return nir_op_mov
;
984 case 2: return nir_op_vec2
;
985 case 3: return nir_op_vec3
;
986 case 4: return nir_op_vec4
;
987 default: unreachable("bad component count");
993 * Operation where the first two sources are commutative.
995 * For 2-source operations, this just mathematical commutativity. Some
996 * 3-source operations, like ffma, are only commutative in the first two
999 NIR_OP_IS_2SRC_COMMUTATIVE
= (1 << 0),
1000 NIR_OP_IS_ASSOCIATIVE
= (1 << 1),
1001 } nir_op_algebraic_property
;
1006 unsigned num_inputs
;
1009 * The number of components in the output
1011 * If non-zero, this is the size of the output and input sizes are
1012 * explicitly given; swizzle and writemask are still in effect, but if
1013 * the output component is masked out, then the input component may
1016 * If zero, the opcode acts in the standard, per-component manner; the
1017 * operation is performed on each component (except the ones that are
1018 * masked out) with the input being taken from the input swizzle for
1021 * The size of some of the inputs may be given (i.e. non-zero) even
1022 * though output_size is zero; in that case, the inputs with a zero
1023 * size act per-component, while the inputs with non-zero size don't.
1025 unsigned output_size
;
1028 * The type of vector that the instruction outputs. Note that the
1029 * staurate modifier is only allowed on outputs with the float type.
1032 nir_alu_type output_type
;
1035 * The number of components in each input
1037 unsigned input_sizes
[NIR_MAX_VEC_COMPONENTS
];
1040 * The type of vector that each input takes. Note that negate and
1041 * absolute value are only allowed on inputs with int or float type and
1042 * behave differently on the two.
1044 nir_alu_type input_types
[NIR_MAX_VEC_COMPONENTS
];
1046 nir_op_algebraic_property algebraic_properties
;
1048 /* Whether this represents a numeric conversion opcode */
1052 extern const nir_op_info nir_op_infos
[nir_num_opcodes
];
1054 typedef struct nir_alu_instr
{
1058 /** Indicates that this ALU instruction generates an exact value
1060 * This is kind of a mixture of GLSL "precise" and "invariant" and not
1061 * really equivalent to either. This indicates that the value generated by
1062 * this operation is high-precision and any code transformations that touch
1063 * it must ensure that the resulting value is bit-for-bit identical to the
1069 * Indicates that this instruction do not cause wrapping to occur, in the
1070 * form of overflow or underflow.
1072 bool no_signed_wrap
:1;
1073 bool no_unsigned_wrap
:1;
1079 void nir_alu_src_copy(nir_alu_src
*dest
, const nir_alu_src
*src
,
1080 nir_alu_instr
*instr
);
1081 void nir_alu_dest_copy(nir_alu_dest
*dest
, const nir_alu_dest
*src
,
1082 nir_alu_instr
*instr
);
1084 /* is this source channel used? */
1086 nir_alu_instr_channel_used(const nir_alu_instr
*instr
, unsigned src
,
1089 if (nir_op_infos
[instr
->op
].input_sizes
[src
] > 0)
1090 return channel
< nir_op_infos
[instr
->op
].input_sizes
[src
];
1092 return (instr
->dest
.write_mask
>> channel
) & 1;
1095 static inline nir_component_mask_t
1096 nir_alu_instr_src_read_mask(const nir_alu_instr
*instr
, unsigned src
)
1098 nir_component_mask_t read_mask
= 0;
1099 for (unsigned c
= 0; c
< NIR_MAX_VEC_COMPONENTS
; c
++) {
1100 if (!nir_alu_instr_channel_used(instr
, src
, c
))
1103 read_mask
|= (1 << instr
->src
[src
].swizzle
[c
]);
1109 * Get the number of channels used for a source
1111 static inline unsigned
1112 nir_ssa_alu_instr_src_components(const nir_alu_instr
*instr
, unsigned src
)
1114 if (nir_op_infos
[instr
->op
].input_sizes
[src
] > 0)
1115 return nir_op_infos
[instr
->op
].input_sizes
[src
];
1117 return nir_dest_num_components(instr
->dest
.dest
);
1120 bool nir_const_value_negative_equal(nir_const_value c1
, nir_const_value c2
,
1121 nir_alu_type full_type
);
1123 bool nir_alu_srcs_equal(const nir_alu_instr
*alu1
, const nir_alu_instr
*alu2
,
1124 unsigned src1
, unsigned src2
);
1126 bool nir_alu_srcs_negative_equal(const nir_alu_instr
*alu1
,
1127 const nir_alu_instr
*alu2
,
1128 unsigned src1
, unsigned src2
);
1132 nir_deref_type_array
,
1133 nir_deref_type_array_wildcard
,
1134 nir_deref_type_ptr_as_array
,
1135 nir_deref_type_struct
,
1136 nir_deref_type_cast
,
1142 /** The type of this deref instruction */
1143 nir_deref_type deref_type
;
1145 /** The mode of the underlying variable */
1146 nir_variable_mode mode
;
1148 /** The dereferenced type of the resulting pointer value */
1149 const struct glsl_type
*type
;
1152 /** Variable being dereferenced if deref_type is a deref_var */
1155 /** Parent deref if deref_type is not deref_var */
1159 /** Additional deref parameters */
1170 unsigned ptr_stride
;
1174 /** Destination to store the resulting "pointer" */
1178 static inline nir_deref_instr
*nir_src_as_deref(nir_src src
);
1180 static inline nir_deref_instr
*
1181 nir_deref_instr_parent(const nir_deref_instr
*instr
)
1183 if (instr
->deref_type
== nir_deref_type_var
)
1186 return nir_src_as_deref(instr
->parent
);
1189 static inline nir_variable
*
1190 nir_deref_instr_get_variable(const nir_deref_instr
*instr
)
1192 while (instr
->deref_type
!= nir_deref_type_var
) {
1193 if (instr
->deref_type
== nir_deref_type_cast
)
1196 instr
= nir_deref_instr_parent(instr
);
1202 bool nir_deref_instr_has_indirect(nir_deref_instr
*instr
);
1203 bool nir_deref_instr_has_complex_use(nir_deref_instr
*instr
);
1205 bool nir_deref_instr_remove_if_unused(nir_deref_instr
*instr
);
1207 unsigned nir_deref_instr_ptr_as_array_stride(nir_deref_instr
*instr
);
1212 struct nir_function
*callee
;
1214 unsigned num_params
;
1218 #include "nir_intrinsics.h"
1220 #define NIR_INTRINSIC_MAX_CONST_INDEX 4
1222 /** Represents an intrinsic
1224 * An intrinsic is an instruction type for handling things that are
1225 * more-or-less regular operations but don't just consume and produce SSA
1226 * values like ALU operations do. Intrinsics are not for things that have
1227 * special semantic meaning such as phi nodes and parallel copies.
1228 * Examples of intrinsics include variable load/store operations, system
1229 * value loads, and the like. Even though texturing more-or-less falls
1230 * under this category, texturing is its own instruction type because
1231 * trying to represent texturing with intrinsics would lead to a
1232 * combinatorial explosion of intrinsic opcodes.
1234 * By having a single instruction type for handling a lot of different
1235 * cases, optimization passes can look for intrinsics and, for the most
1236 * part, completely ignore them. Each intrinsic type also has a few
1237 * possible flags that govern whether or not they can be reordered or
1238 * eliminated. That way passes like dead code elimination can still work
1239 * on intrisics without understanding the meaning of each.
1241 * Each intrinsic has some number of constant indices, some number of
1242 * variables, and some number of sources. What these sources, variables,
1243 * and indices mean depends on the intrinsic and is documented with the
1244 * intrinsic declaration in nir_intrinsics.h. Intrinsics and texture
1245 * instructions are the only types of instruction that can operate on
1251 nir_intrinsic_op intrinsic
;
1255 /** number of components if this is a vectorized intrinsic
1257 * Similarly to ALU operations, some intrinsics are vectorized.
1258 * An intrinsic is vectorized if nir_intrinsic_infos.dest_components == 0.
1259 * For vectorized intrinsics, the num_components field specifies the
1260 * number of destination components and the number of source components
1261 * for all sources with nir_intrinsic_infos.src_components[i] == 0.
1263 uint8_t num_components
;
1265 int const_index
[NIR_INTRINSIC_MAX_CONST_INDEX
];
1268 } nir_intrinsic_instr
;
1270 static inline nir_variable
*
1271 nir_intrinsic_get_var(nir_intrinsic_instr
*intrin
, unsigned i
)
1273 return nir_deref_instr_get_variable(nir_src_as_deref(intrin
->src
[i
]));
1277 * \name NIR intrinsics semantic flags
1279 * information about what the compiler can do with the intrinsics.
1281 * \sa nir_intrinsic_info::flags
1285 * whether the intrinsic can be safely eliminated if none of its output
1286 * value is not being used.
1288 NIR_INTRINSIC_CAN_ELIMINATE
= (1 << 0),
1291 * Whether the intrinsic can be reordered with respect to any other
1292 * intrinsic, i.e. whether the only reordering dependencies of the
1293 * intrinsic are due to the register reads/writes.
1295 NIR_INTRINSIC_CAN_REORDER
= (1 << 1),
1296 } nir_intrinsic_semantic_flag
;
1299 * \name NIR intrinsics const-index flag
1301 * Indicates the usage of a const_index slot.
1303 * \sa nir_intrinsic_info::index_map
1307 * Generally instructions that take a offset src argument, can encode
1308 * a constant 'base' value which is added to the offset.
1310 NIR_INTRINSIC_BASE
= 1,
1313 * For store instructions, a writemask for the store.
1315 NIR_INTRINSIC_WRMASK
,
1318 * The stream-id for GS emit_vertex/end_primitive intrinsics.
1320 NIR_INTRINSIC_STREAM_ID
,
1323 * The clip-plane id for load_user_clip_plane intrinsic.
1325 NIR_INTRINSIC_UCP_ID
,
1328 * The amount of data, starting from BASE, that this instruction may
1329 * access. This is used to provide bounds if the offset is not constant.
1331 NIR_INTRINSIC_RANGE
,
1334 * The Vulkan descriptor set for vulkan_resource_index intrinsic.
1336 NIR_INTRINSIC_DESC_SET
,
1339 * The Vulkan descriptor set binding for vulkan_resource_index intrinsic.
1341 NIR_INTRINSIC_BINDING
,
1346 NIR_INTRINSIC_COMPONENT
,
1349 * Interpolation mode (only meaningful for FS inputs).
1351 NIR_INTRINSIC_INTERP_MODE
,
1354 * A binary nir_op to use when performing a reduction or scan operation
1356 NIR_INTRINSIC_REDUCTION_OP
,
1359 * Cluster size for reduction operations
1361 NIR_INTRINSIC_CLUSTER_SIZE
,
1364 * Parameter index for a load_param intrinsic
1366 NIR_INTRINSIC_PARAM_IDX
,
1369 * Image dimensionality for image intrinsics
1371 * One of GLSL_SAMPLER_DIM_*
1373 NIR_INTRINSIC_IMAGE_DIM
,
1376 * Non-zero if we are accessing an array image
1378 NIR_INTRINSIC_IMAGE_ARRAY
,
1381 * Image format for image intrinsics
1383 NIR_INTRINSIC_FORMAT
,
1386 * Access qualifiers for image and memory access intrinsics
1388 NIR_INTRINSIC_ACCESS
,
1391 * Alignment for offsets and addresses
1393 * These two parameters, specify an alignment in terms of a multiplier and
1394 * an offset. The offset or address parameter X of the intrinsic is
1395 * guaranteed to satisfy the following:
1397 * (X - align_offset) % align_mul == 0
1399 NIR_INTRINSIC_ALIGN_MUL
,
1400 NIR_INTRINSIC_ALIGN_OFFSET
,
1403 * The Vulkan descriptor type for a vulkan_resource_[re]index intrinsic.
1405 NIR_INTRINSIC_DESC_TYPE
,
1408 * The nir_alu_type of a uniform/input/output
1413 * The swizzle mask for the instructions
1414 * SwizzleInvocationsAMD and SwizzleInvocationsMaskedAMD
1416 NIR_INTRINSIC_SWIZZLE_MASK
,
1418 /* Separate source/dest access flags for copies */
1419 NIR_INTRINSIC_SRC_ACCESS
= 21,
1420 NIR_INTRINSIC_DST_ACCESS
= 22,
1422 NIR_INTRINSIC_NUM_INDEX_FLAGS
,
1424 } nir_intrinsic_index_flag
;
1426 #define NIR_INTRINSIC_MAX_INPUTS 5
1431 unsigned num_srcs
; /** < number of register/SSA inputs */
1433 /** number of components of each input register
1435 * If this value is 0, the number of components is given by the
1436 * num_components field of nir_intrinsic_instr. If this value is -1, the
1437 * intrinsic consumes however many components are provided and it is not
1440 int src_components
[NIR_INTRINSIC_MAX_INPUTS
];
1444 /** number of components of the output register
1446 * If this value is 0, the number of components is given by the
1447 * num_components field of nir_intrinsic_instr.
1449 unsigned dest_components
;
1451 /** bitfield of legal bit sizes */
1452 unsigned dest_bit_sizes
;
1454 /** the number of constant indices used by the intrinsic */
1455 unsigned num_indices
;
1457 /** indicates the usage of intr->const_index[n] */
1458 unsigned index_map
[NIR_INTRINSIC_NUM_INDEX_FLAGS
];
1460 /** semantic flags for calls to this intrinsic */
1461 nir_intrinsic_semantic_flag flags
;
1462 } nir_intrinsic_info
;
1464 extern const nir_intrinsic_info nir_intrinsic_infos
[nir_num_intrinsics
];
1466 static inline unsigned
1467 nir_intrinsic_src_components(nir_intrinsic_instr
*intr
, unsigned srcn
)
1469 const nir_intrinsic_info
*info
= &nir_intrinsic_infos
[intr
->intrinsic
];
1470 assert(srcn
< info
->num_srcs
);
1471 if (info
->src_components
[srcn
] > 0)
1472 return info
->src_components
[srcn
];
1473 else if (info
->src_components
[srcn
] == 0)
1474 return intr
->num_components
;
1476 return nir_src_num_components(intr
->src
[srcn
]);
1479 static inline unsigned
1480 nir_intrinsic_dest_components(nir_intrinsic_instr
*intr
)
1482 const nir_intrinsic_info
*info
= &nir_intrinsic_infos
[intr
->intrinsic
];
1483 if (!info
->has_dest
)
1485 else if (info
->dest_components
)
1486 return info
->dest_components
;
1488 return intr
->num_components
;
1491 #define INTRINSIC_IDX_ACCESSORS(name, flag, type) \
1492 static inline type \
1493 nir_intrinsic_##name(const nir_intrinsic_instr *instr) \
1495 const nir_intrinsic_info *info = &nir_intrinsic_infos[instr->intrinsic]; \
1496 assert(info->index_map[NIR_INTRINSIC_##flag] > 0); \
1497 return (type)instr->const_index[info->index_map[NIR_INTRINSIC_##flag] - 1]; \
1499 static inline void \
1500 nir_intrinsic_set_##name(nir_intrinsic_instr *instr, type val) \
1502 const nir_intrinsic_info *info = &nir_intrinsic_infos[instr->intrinsic]; \
1503 assert(info->index_map[NIR_INTRINSIC_##flag] > 0); \
1504 instr->const_index[info->index_map[NIR_INTRINSIC_##flag] - 1] = val; \
1507 INTRINSIC_IDX_ACCESSORS(write_mask
, WRMASK
, unsigned)
1508 INTRINSIC_IDX_ACCESSORS(base
, BASE
, int)
1509 INTRINSIC_IDX_ACCESSORS(stream_id
, STREAM_ID
, unsigned)
1510 INTRINSIC_IDX_ACCESSORS(ucp_id
, UCP_ID
, unsigned)
1511 INTRINSIC_IDX_ACCESSORS(range
, RANGE
, unsigned)
1512 INTRINSIC_IDX_ACCESSORS(desc_set
, DESC_SET
, unsigned)
1513 INTRINSIC_IDX_ACCESSORS(binding
, BINDING
, unsigned)
1514 INTRINSIC_IDX_ACCESSORS(component
, COMPONENT
, unsigned)
1515 INTRINSIC_IDX_ACCESSORS(interp_mode
, INTERP_MODE
, unsigned)
1516 INTRINSIC_IDX_ACCESSORS(reduction_op
, REDUCTION_OP
, unsigned)
1517 INTRINSIC_IDX_ACCESSORS(cluster_size
, CLUSTER_SIZE
, unsigned)
1518 INTRINSIC_IDX_ACCESSORS(param_idx
, PARAM_IDX
, unsigned)
1519 INTRINSIC_IDX_ACCESSORS(image_dim
, IMAGE_DIM
, enum glsl_sampler_dim
)
1520 INTRINSIC_IDX_ACCESSORS(image_array
, IMAGE_ARRAY
, bool)
1521 INTRINSIC_IDX_ACCESSORS(access
, ACCESS
, enum gl_access_qualifier
)
1522 INTRINSIC_IDX_ACCESSORS(src_access
, SRC_ACCESS
, enum gl_access_qualifier
)
1523 INTRINSIC_IDX_ACCESSORS(dst_access
, DST_ACCESS
, enum gl_access_qualifier
)
1524 INTRINSIC_IDX_ACCESSORS(format
, FORMAT
, unsigned)
1525 INTRINSIC_IDX_ACCESSORS(align_mul
, ALIGN_MUL
, unsigned)
1526 INTRINSIC_IDX_ACCESSORS(align_offset
, ALIGN_OFFSET
, unsigned)
1527 INTRINSIC_IDX_ACCESSORS(desc_type
, DESC_TYPE
, unsigned)
1528 INTRINSIC_IDX_ACCESSORS(type
, TYPE
, nir_alu_type
)
1529 INTRINSIC_IDX_ACCESSORS(swizzle_mask
, SWIZZLE_MASK
, unsigned)
1532 nir_intrinsic_set_align(nir_intrinsic_instr
*intrin
,
1533 unsigned align_mul
, unsigned align_offset
)
1535 assert(util_is_power_of_two_nonzero(align_mul
));
1536 assert(align_offset
< align_mul
);
1537 nir_intrinsic_set_align_mul(intrin
, align_mul
);
1538 nir_intrinsic_set_align_offset(intrin
, align_offset
);
1541 /** Returns a simple alignment for a load/store intrinsic offset
1543 * Instead of the full mul+offset alignment scheme provided by the ALIGN_MUL
1544 * and ALIGN_OFFSET parameters, this helper takes both into account and
1545 * provides a single simple alignment parameter. The offset X is guaranteed
1546 * to satisfy X % align == 0.
1548 static inline unsigned
1549 nir_intrinsic_align(const nir_intrinsic_instr
*intrin
)
1551 const unsigned align_mul
= nir_intrinsic_align_mul(intrin
);
1552 const unsigned align_offset
= nir_intrinsic_align_offset(intrin
);
1553 assert(align_offset
< align_mul
);
1554 return align_offset
? 1 << (ffs(align_offset
) - 1) : align_mul
;
1557 /* Converts a image_deref_* intrinsic into a image_* one */
1558 void nir_rewrite_image_intrinsic(nir_intrinsic_instr
*instr
,
1559 nir_ssa_def
*handle
, bool bindless
);
1561 /* Determine if an intrinsic can be arbitrarily reordered and eliminated. */
1563 nir_intrinsic_can_reorder(nir_intrinsic_instr
*instr
)
1565 if (instr
->intrinsic
== nir_intrinsic_load_deref
||
1566 instr
->intrinsic
== nir_intrinsic_load_ssbo
||
1567 instr
->intrinsic
== nir_intrinsic_bindless_image_load
||
1568 instr
->intrinsic
== nir_intrinsic_image_deref_load
||
1569 instr
->intrinsic
== nir_intrinsic_image_load
) {
1570 return nir_intrinsic_access(instr
) & ACCESS_CAN_REORDER
;
1572 const nir_intrinsic_info
*info
=
1573 &nir_intrinsic_infos
[instr
->intrinsic
];
1574 return (info
->flags
& NIR_INTRINSIC_CAN_ELIMINATE
) &&
1575 (info
->flags
& NIR_INTRINSIC_CAN_REORDER
);
1580 * \group texture information
1582 * This gives semantic information about textures which is useful to the
1583 * frontend, the backend, and lowering passes, but not the optimizer.
1588 nir_tex_src_projector
,
1589 nir_tex_src_comparator
, /* shadow comparator */
1593 nir_tex_src_min_lod
,
1594 nir_tex_src_ms_index
, /* MSAA sample index */
1595 nir_tex_src_ms_mcs
, /* MSAA compression value */
1598 nir_tex_src_texture_deref
, /* < deref pointing to the texture */
1599 nir_tex_src_sampler_deref
, /* < deref pointing to the sampler */
1600 nir_tex_src_texture_offset
, /* < dynamically uniform indirect offset */
1601 nir_tex_src_sampler_offset
, /* < dynamically uniform indirect offset */
1602 nir_tex_src_texture_handle
, /* < bindless texture handle */
1603 nir_tex_src_sampler_handle
, /* < bindless sampler handle */
1604 nir_tex_src_plane
, /* < selects plane for planar textures */
1605 nir_num_tex_src_types
1610 nir_tex_src_type src_type
;
1614 nir_texop_tex
, /**< Regular texture look-up */
1615 nir_texop_txb
, /**< Texture look-up with LOD bias */
1616 nir_texop_txl
, /**< Texture look-up with explicit LOD */
1617 nir_texop_txd
, /**< Texture look-up with partial derivatives */
1618 nir_texop_txf
, /**< Texel fetch with explicit LOD */
1619 nir_texop_txf_ms
, /**< Multisample texture fetch */
1620 nir_texop_txf_ms_fb
, /**< Multisample texture fetch from framebuffer */
1621 nir_texop_txf_ms_mcs
, /**< Multisample compression value fetch */
1622 nir_texop_txs
, /**< Texture size */
1623 nir_texop_lod
, /**< Texture lod query */
1624 nir_texop_tg4
, /**< Texture gather */
1625 nir_texop_query_levels
, /**< Texture levels query */
1626 nir_texop_texture_samples
, /**< Texture samples query */
1627 nir_texop_samples_identical
, /**< Query whether all samples are definitely
1635 enum glsl_sampler_dim sampler_dim
;
1636 nir_alu_type dest_type
;
1641 unsigned num_srcs
, coord_components
;
1642 bool is_array
, is_shadow
;
1645 * If is_shadow is true, whether this is the old-style shadow that outputs 4
1646 * components or the new-style shadow that outputs 1 component.
1648 bool is_new_style_shadow
;
1650 /* gather component selector */
1651 unsigned component
: 2;
1653 /* gather offsets */
1654 int8_t tg4_offsets
[4][2];
1656 /* True if the texture index or handle is not dynamically uniform */
1657 bool texture_non_uniform
;
1659 /* True if the sampler index or handle is not dynamically uniform */
1660 bool sampler_non_uniform
;
1662 /** The texture index
1664 * If this texture instruction has a nir_tex_src_texture_offset source,
1665 * then the texture index is given by texture_index + texture_offset.
1667 unsigned texture_index
;
1669 /** The size of the texture array or 0 if it's not an array */
1670 unsigned texture_array_size
;
1672 /** The sampler index
1674 * The following operations do not require a sampler and, as such, this
1675 * field should be ignored:
1677 * - nir_texop_txf_ms
1680 * - nir_texop_query_levels
1681 * - nir_texop_texture_samples
1682 * - nir_texop_samples_identical
1684 * If this texture instruction has a nir_tex_src_sampler_offset source,
1685 * then the sampler index is given by sampler_index + sampler_offset.
1687 unsigned sampler_index
;
1690 static inline unsigned
1691 nir_tex_instr_dest_size(const nir_tex_instr
*instr
)
1693 switch (instr
->op
) {
1694 case nir_texop_txs
: {
1696 switch (instr
->sampler_dim
) {
1697 case GLSL_SAMPLER_DIM_1D
:
1698 case GLSL_SAMPLER_DIM_BUF
:
1701 case GLSL_SAMPLER_DIM_2D
:
1702 case GLSL_SAMPLER_DIM_CUBE
:
1703 case GLSL_SAMPLER_DIM_MS
:
1704 case GLSL_SAMPLER_DIM_RECT
:
1705 case GLSL_SAMPLER_DIM_EXTERNAL
:
1706 case GLSL_SAMPLER_DIM_SUBPASS
:
1709 case GLSL_SAMPLER_DIM_3D
:
1713 unreachable("not reached");
1715 if (instr
->is_array
)
1723 case nir_texop_texture_samples
:
1724 case nir_texop_query_levels
:
1725 case nir_texop_samples_identical
:
1729 if (instr
->is_shadow
&& instr
->is_new_style_shadow
)
1736 /* Returns true if this texture operation queries something about the texture
1737 * rather than actually sampling it.
1740 nir_tex_instr_is_query(const nir_tex_instr
*instr
)
1742 switch (instr
->op
) {
1745 case nir_texop_texture_samples
:
1746 case nir_texop_query_levels
:
1747 case nir_texop_txf_ms_mcs
:
1754 case nir_texop_txf_ms
:
1755 case nir_texop_txf_ms_fb
:
1759 unreachable("Invalid texture opcode");
1764 nir_alu_instr_is_comparison(const nir_alu_instr
*instr
)
1766 switch (instr
->op
) {
1786 static inline nir_alu_type
1787 nir_tex_instr_src_type(const nir_tex_instr
*instr
, unsigned src
)
1789 switch (instr
->src
[src
].src_type
) {
1790 case nir_tex_src_coord
:
1791 switch (instr
->op
) {
1793 case nir_texop_txf_ms
:
1794 case nir_texop_txf_ms_fb
:
1795 case nir_texop_txf_ms_mcs
:
1796 case nir_texop_samples_identical
:
1797 return nir_type_int
;
1800 return nir_type_float
;
1803 case nir_tex_src_lod
:
1804 switch (instr
->op
) {
1807 return nir_type_int
;
1810 return nir_type_float
;
1813 case nir_tex_src_projector
:
1814 case nir_tex_src_comparator
:
1815 case nir_tex_src_bias
:
1816 case nir_tex_src_ddx
:
1817 case nir_tex_src_ddy
:
1818 return nir_type_float
;
1820 case nir_tex_src_offset
:
1821 case nir_tex_src_ms_index
:
1822 case nir_tex_src_texture_offset
:
1823 case nir_tex_src_sampler_offset
:
1824 return nir_type_int
;
1827 unreachable("Invalid texture source type");
1831 static inline unsigned
1832 nir_tex_instr_src_size(const nir_tex_instr
*instr
, unsigned src
)
1834 if (instr
->src
[src
].src_type
== nir_tex_src_coord
)
1835 return instr
->coord_components
;
1837 /* The MCS value is expected to be a vec4 returned by a txf_ms_mcs */
1838 if (instr
->src
[src
].src_type
== nir_tex_src_ms_mcs
)
1841 if (instr
->src
[src
].src_type
== nir_tex_src_ddx
||
1842 instr
->src
[src
].src_type
== nir_tex_src_ddy
) {
1843 if (instr
->is_array
)
1844 return instr
->coord_components
- 1;
1846 return instr
->coord_components
;
1849 /* Usual APIs don't allow cube + offset, but we allow it, with 2 coords for
1850 * the offset, since a cube maps to a single face.
1852 if (instr
->src
[src
].src_type
== nir_tex_src_offset
) {
1853 if (instr
->sampler_dim
== GLSL_SAMPLER_DIM_CUBE
)
1855 else if (instr
->is_array
)
1856 return instr
->coord_components
- 1;
1858 return instr
->coord_components
;
1865 nir_tex_instr_src_index(const nir_tex_instr
*instr
, nir_tex_src_type type
)
1867 for (unsigned i
= 0; i
< instr
->num_srcs
; i
++)
1868 if (instr
->src
[i
].src_type
== type
)
1874 void nir_tex_instr_add_src(nir_tex_instr
*tex
,
1875 nir_tex_src_type src_type
,
1878 void nir_tex_instr_remove_src(nir_tex_instr
*tex
, unsigned src_idx
);
1880 bool nir_tex_instr_has_explicit_tg4_offsets(nir_tex_instr
*tex
);
1887 nir_const_value value
[];
1888 } nir_load_const_instr
;
1890 #define nir_const_load_to_arr(arr, l, m) \
1892 nir_const_value_to_array(arr, l->value, l->def.num_components, m); \
1906 /* creates a new SSA variable in an undefined state */
1911 } nir_ssa_undef_instr
;
1914 struct exec_node node
;
1916 /* The predecessor block corresponding to this source */
1917 struct nir_block
*pred
;
1922 #define nir_foreach_phi_src(phi_src, phi) \
1923 foreach_list_typed(nir_phi_src, phi_src, node, &(phi)->srcs)
1924 #define nir_foreach_phi_src_safe(phi_src, phi) \
1925 foreach_list_typed_safe(nir_phi_src, phi_src, node, &(phi)->srcs)
1930 struct exec_list srcs
; /** < list of nir_phi_src */
1936 struct exec_node node
;
1939 } nir_parallel_copy_entry
;
1941 #define nir_foreach_parallel_copy_entry(entry, pcopy) \
1942 foreach_list_typed(nir_parallel_copy_entry, entry, node, &(pcopy)->entries)
1947 /* A list of nir_parallel_copy_entrys. The sources of all of the
1948 * entries are copied to the corresponding destinations "in parallel".
1949 * In other words, if we have two entries: a -> b and b -> a, the values
1952 struct exec_list entries
;
1953 } nir_parallel_copy_instr
;
1955 NIR_DEFINE_CAST(nir_instr_as_alu
, nir_instr
, nir_alu_instr
, instr
,
1956 type
, nir_instr_type_alu
)
1957 NIR_DEFINE_CAST(nir_instr_as_deref
, nir_instr
, nir_deref_instr
, instr
,
1958 type
, nir_instr_type_deref
)
1959 NIR_DEFINE_CAST(nir_instr_as_call
, nir_instr
, nir_call_instr
, instr
,
1960 type
, nir_instr_type_call
)
1961 NIR_DEFINE_CAST(nir_instr_as_jump
, nir_instr
, nir_jump_instr
, instr
,
1962 type
, nir_instr_type_jump
)
1963 NIR_DEFINE_CAST(nir_instr_as_tex
, nir_instr
, nir_tex_instr
, instr
,
1964 type
, nir_instr_type_tex
)
1965 NIR_DEFINE_CAST(nir_instr_as_intrinsic
, nir_instr
, nir_intrinsic_instr
, instr
,
1966 type
, nir_instr_type_intrinsic
)
1967 NIR_DEFINE_CAST(nir_instr_as_load_const
, nir_instr
, nir_load_const_instr
, instr
,
1968 type
, nir_instr_type_load_const
)
1969 NIR_DEFINE_CAST(nir_instr_as_ssa_undef
, nir_instr
, nir_ssa_undef_instr
, instr
,
1970 type
, nir_instr_type_ssa_undef
)
1971 NIR_DEFINE_CAST(nir_instr_as_phi
, nir_instr
, nir_phi_instr
, instr
,
1972 type
, nir_instr_type_phi
)
1973 NIR_DEFINE_CAST(nir_instr_as_parallel_copy
, nir_instr
,
1974 nir_parallel_copy_instr
, instr
,
1975 type
, nir_instr_type_parallel_copy
)
1978 #define NIR_DEFINE_SRC_AS_CONST(type, suffix) \
1979 static inline type \
1980 nir_src_comp_as_##suffix(nir_src src, unsigned comp) \
1982 assert(nir_src_is_const(src)); \
1983 nir_load_const_instr *load = \
1984 nir_instr_as_load_const(src.ssa->parent_instr); \
1985 assert(comp < load->def.num_components); \
1986 return nir_const_value_as_##suffix(load->value[comp], \
1987 load->def.bit_size); \
1990 static inline type \
1991 nir_src_as_##suffix(nir_src src) \
1993 assert(nir_src_num_components(src) == 1); \
1994 return nir_src_comp_as_##suffix(src, 0); \
1997 NIR_DEFINE_SRC_AS_CONST(int64_t, int)
1998 NIR_DEFINE_SRC_AS_CONST(uint64_t, uint
)
1999 NIR_DEFINE_SRC_AS_CONST(bool, bool)
2000 NIR_DEFINE_SRC_AS_CONST(double, float)
2002 #undef NIR_DEFINE_SRC_AS_CONST
2008 * Control flow consists of a tree of control flow nodes, which include
2009 * if-statements and loops. The leaves of the tree are basic blocks, lists of
2010 * instructions that always run start-to-finish. Each basic block also keeps
2011 * track of its successors (blocks which may run immediately after the current
2012 * block) and predecessors (blocks which could have run immediately before the
2013 * current block). Each function also has a start block and an end block which
2014 * all return statements point to (which is always empty). Together, all the
2015 * blocks with their predecessors and successors make up the control flow
2016 * graph (CFG) of the function. There are helpers that modify the tree of
2017 * control flow nodes while modifying the CFG appropriately; these should be
2018 * used instead of modifying the tree directly.
2025 nir_cf_node_function
2028 typedef struct nir_cf_node
{
2029 struct exec_node node
;
2030 nir_cf_node_type type
;
2031 struct nir_cf_node
*parent
;
2034 typedef struct nir_block
{
2035 nir_cf_node cf_node
;
2037 struct exec_list instr_list
; /** < list of nir_instr */
2039 /** generic block index; generated by nir_index_blocks */
2043 * Each block can only have up to 2 successors, so we put them in a simple
2044 * array - no need for anything more complicated.
2046 struct nir_block
*successors
[2];
2048 /* Set of nir_block predecessors in the CFG */
2049 struct set
*predecessors
;
2052 * this node's immediate dominator in the dominance tree - set to NULL for
2055 struct nir_block
*imm_dom
;
2057 /* This node's children in the dominance tree */
2058 unsigned num_dom_children
;
2059 struct nir_block
**dom_children
;
2061 /* Set of nir_blocks on the dominance frontier of this block */
2062 struct set
*dom_frontier
;
2065 * These two indices have the property that dom_{pre,post}_index for each
2066 * child of this block in the dominance tree will always be between
2067 * dom_pre_index and dom_post_index for this block, which makes testing if
2068 * a given block is dominated by another block an O(1) operation.
2070 unsigned dom_pre_index
, dom_post_index
;
2072 /* live in and out for this block; used for liveness analysis */
2073 BITSET_WORD
*live_in
;
2074 BITSET_WORD
*live_out
;
2077 static inline nir_instr
*
2078 nir_block_first_instr(nir_block
*block
)
2080 struct exec_node
*head
= exec_list_get_head(&block
->instr_list
);
2081 return exec_node_data(nir_instr
, head
, node
);
2084 static inline nir_instr
*
2085 nir_block_last_instr(nir_block
*block
)
2087 struct exec_node
*tail
= exec_list_get_tail(&block
->instr_list
);
2088 return exec_node_data(nir_instr
, tail
, node
);
2092 nir_block_ends_in_jump(nir_block
*block
)
2094 return !exec_list_is_empty(&block
->instr_list
) &&
2095 nir_block_last_instr(block
)->type
== nir_instr_type_jump
;
2098 #define nir_foreach_instr(instr, block) \
2099 foreach_list_typed(nir_instr, instr, node, &(block)->instr_list)
2100 #define nir_foreach_instr_reverse(instr, block) \
2101 foreach_list_typed_reverse(nir_instr, instr, node, &(block)->instr_list)
2102 #define nir_foreach_instr_safe(instr, block) \
2103 foreach_list_typed_safe(nir_instr, instr, node, &(block)->instr_list)
2104 #define nir_foreach_instr_reverse_safe(instr, block) \
2105 foreach_list_typed_reverse_safe(nir_instr, instr, node, &(block)->instr_list)
2108 nir_selection_control_none
= 0x0,
2109 nir_selection_control_flatten
= 0x1,
2110 nir_selection_control_dont_flatten
= 0x2,
2111 } nir_selection_control
;
2113 typedef struct nir_if
{
2114 nir_cf_node cf_node
;
2116 nir_selection_control control
;
2118 struct exec_list then_list
; /** < list of nir_cf_node */
2119 struct exec_list else_list
; /** < list of nir_cf_node */
2125 /** Instruction that generates nif::condition. */
2126 nir_instr
*conditional_instr
;
2128 /** Block within ::nif that has the break instruction. */
2129 nir_block
*break_block
;
2131 /** Last block for the then- or else-path that does not contain the break. */
2132 nir_block
*continue_from_block
;
2134 /** True when ::break_block is in the else-path of ::nif. */
2135 bool continue_from_then
;
2138 /* This is true if the terminators exact trip count is unknown. For
2141 * for (int i = 0; i < imin(x, 4); i++)
2144 * Here loop analysis would have set a max_trip_count of 4 however we dont
2145 * know for sure that this is the exact trip count.
2147 bool exact_trip_count_unknown
;
2149 struct list_head loop_terminator_link
;
2150 } nir_loop_terminator
;
2153 /* Estimated cost (in number of instructions) of the loop */
2154 unsigned instr_cost
;
2156 /* Guessed trip count based on array indexing */
2157 unsigned guessed_trip_count
;
2159 /* Maximum number of times the loop is run (if known) */
2160 unsigned max_trip_count
;
2162 /* Do we know the exact number of times the loop will be run */
2163 bool exact_trip_count_known
;
2165 /* Unroll the loop regardless of its size */
2168 /* Does the loop contain complex loop terminators, continues or other
2169 * complex behaviours? If this is true we can't rely on
2170 * loop_terminator_list to be complete or accurate.
2174 nir_loop_terminator
*limiting_terminator
;
2176 /* A list of loop_terminators terminating this loop. */
2177 struct list_head loop_terminator_list
;
2181 nir_loop_control_none
= 0x0,
2182 nir_loop_control_unroll
= 0x1,
2183 nir_loop_control_dont_unroll
= 0x2,
2187 nir_cf_node cf_node
;
2189 struct exec_list body
; /** < list of nir_cf_node */
2191 nir_loop_info
*info
;
2192 nir_loop_control control
;
2193 bool partially_unrolled
;
2197 * Various bits of metadata that can may be created or required by
2198 * optimization and analysis passes
2201 nir_metadata_none
= 0x0,
2202 nir_metadata_block_index
= 0x1,
2203 nir_metadata_dominance
= 0x2,
2204 nir_metadata_live_ssa_defs
= 0x4,
2205 nir_metadata_not_properly_reset
= 0x8,
2206 nir_metadata_loop_analysis
= 0x10,
2210 nir_cf_node cf_node
;
2212 /** pointer to the function of which this is an implementation */
2213 struct nir_function
*function
;
2215 struct exec_list body
; /** < list of nir_cf_node */
2217 nir_block
*end_block
;
2219 /** list for all local variables in the function */
2220 struct exec_list locals
;
2222 /** list of local registers in the function */
2223 struct exec_list registers
;
2225 /** next available local register index */
2228 /** next available SSA value index */
2231 /* total number of basic blocks, only valid when block_index_dirty = false */
2232 unsigned num_blocks
;
2234 nir_metadata valid_metadata
;
2235 } nir_function_impl
;
2237 ATTRIBUTE_RETURNS_NONNULL
static inline nir_block
*
2238 nir_start_block(nir_function_impl
*impl
)
2240 return (nir_block
*) impl
->body
.head_sentinel
.next
;
2243 ATTRIBUTE_RETURNS_NONNULL
static inline nir_block
*
2244 nir_impl_last_block(nir_function_impl
*impl
)
2246 return (nir_block
*) impl
->body
.tail_sentinel
.prev
;
2249 static inline nir_cf_node
*
2250 nir_cf_node_next(nir_cf_node
*node
)
2252 struct exec_node
*next
= exec_node_get_next(&node
->node
);
2253 if (exec_node_is_tail_sentinel(next
))
2256 return exec_node_data(nir_cf_node
, next
, node
);
2259 static inline nir_cf_node
*
2260 nir_cf_node_prev(nir_cf_node
*node
)
2262 struct exec_node
*prev
= exec_node_get_prev(&node
->node
);
2263 if (exec_node_is_head_sentinel(prev
))
2266 return exec_node_data(nir_cf_node
, prev
, node
);
2270 nir_cf_node_is_first(const nir_cf_node
*node
)
2272 return exec_node_is_head_sentinel(node
->node
.prev
);
2276 nir_cf_node_is_last(const nir_cf_node
*node
)
2278 return exec_node_is_tail_sentinel(node
->node
.next
);
2281 NIR_DEFINE_CAST(nir_cf_node_as_block
, nir_cf_node
, nir_block
, cf_node
,
2282 type
, nir_cf_node_block
)
2283 NIR_DEFINE_CAST(nir_cf_node_as_if
, nir_cf_node
, nir_if
, cf_node
,
2284 type
, nir_cf_node_if
)
2285 NIR_DEFINE_CAST(nir_cf_node_as_loop
, nir_cf_node
, nir_loop
, cf_node
,
2286 type
, nir_cf_node_loop
)
2287 NIR_DEFINE_CAST(nir_cf_node_as_function
, nir_cf_node
,
2288 nir_function_impl
, cf_node
, type
, nir_cf_node_function
)
2290 static inline nir_block
*
2291 nir_if_first_then_block(nir_if
*if_stmt
)
2293 struct exec_node
*head
= exec_list_get_head(&if_stmt
->then_list
);
2294 return nir_cf_node_as_block(exec_node_data(nir_cf_node
, head
, node
));
2297 static inline nir_block
*
2298 nir_if_last_then_block(nir_if
*if_stmt
)
2300 struct exec_node
*tail
= exec_list_get_tail(&if_stmt
->then_list
);
2301 return nir_cf_node_as_block(exec_node_data(nir_cf_node
, tail
, node
));
2304 static inline nir_block
*
2305 nir_if_first_else_block(nir_if
*if_stmt
)
2307 struct exec_node
*head
= exec_list_get_head(&if_stmt
->else_list
);
2308 return nir_cf_node_as_block(exec_node_data(nir_cf_node
, head
, node
));
2311 static inline nir_block
*
2312 nir_if_last_else_block(nir_if
*if_stmt
)
2314 struct exec_node
*tail
= exec_list_get_tail(&if_stmt
->else_list
);
2315 return nir_cf_node_as_block(exec_node_data(nir_cf_node
, tail
, node
));
2318 static inline nir_block
*
2319 nir_loop_first_block(nir_loop
*loop
)
2321 struct exec_node
*head
= exec_list_get_head(&loop
->body
);
2322 return nir_cf_node_as_block(exec_node_data(nir_cf_node
, head
, node
));
2325 static inline nir_block
*
2326 nir_loop_last_block(nir_loop
*loop
)
2328 struct exec_node
*tail
= exec_list_get_tail(&loop
->body
);
2329 return nir_cf_node_as_block(exec_node_data(nir_cf_node
, tail
, node
));
2333 * Return true if this list of cf_nodes contains a single empty block.
2336 nir_cf_list_is_empty_block(struct exec_list
*cf_list
)
2338 if (exec_list_is_singular(cf_list
)) {
2339 struct exec_node
*head
= exec_list_get_head(cf_list
);
2341 nir_cf_node_as_block(exec_node_data(nir_cf_node
, head
, node
));
2342 return exec_list_is_empty(&block
->instr_list
);
2348 uint8_t num_components
;
2352 typedef struct nir_function
{
2353 struct exec_node node
;
2356 struct nir_shader
*shader
;
2358 unsigned num_params
;
2359 nir_parameter
*params
;
2361 /** The implementation of this function.
2363 * If the function is only declared and not implemented, this is NULL.
2365 nir_function_impl
*impl
;
2371 nir_lower_imul64
= (1 << 0),
2372 nir_lower_isign64
= (1 << 1),
2373 /** Lower all int64 modulus and division opcodes */
2374 nir_lower_divmod64
= (1 << 2),
2375 /** Lower all 64-bit umul_high and imul_high opcodes */
2376 nir_lower_imul_high64
= (1 << 3),
2377 nir_lower_mov64
= (1 << 4),
2378 nir_lower_icmp64
= (1 << 5),
2379 nir_lower_iadd64
= (1 << 6),
2380 nir_lower_iabs64
= (1 << 7),
2381 nir_lower_ineg64
= (1 << 8),
2382 nir_lower_logic64
= (1 << 9),
2383 nir_lower_minmax64
= (1 << 10),
2384 nir_lower_shift64
= (1 << 11),
2385 nir_lower_imul_2x32_64
= (1 << 12),
2386 } nir_lower_int64_options
;
2389 nir_lower_drcp
= (1 << 0),
2390 nir_lower_dsqrt
= (1 << 1),
2391 nir_lower_drsq
= (1 << 2),
2392 nir_lower_dtrunc
= (1 << 3),
2393 nir_lower_dfloor
= (1 << 4),
2394 nir_lower_dceil
= (1 << 5),
2395 nir_lower_dfract
= (1 << 6),
2396 nir_lower_dround_even
= (1 << 7),
2397 nir_lower_dmod
= (1 << 8),
2398 nir_lower_fp64_full_software
= (1 << 9),
2399 } nir_lower_doubles_options
;
2401 typedef struct nir_shader_compiler_options
{
2407 /** Lowers flrp when it does not support doubles */
2413 /** Lowers ibitfield_extract/ubitfield_extract to ibfe/ubfe. */
2414 bool lower_bitfield_extract
;
2415 /** Lowers ibitfield_extract/ubitfield_extract to compares, shifts. */
2416 bool lower_bitfield_extract_to_shifts
;
2417 /** Lowers bitfield_insert to bfi/bfm */
2418 bool lower_bitfield_insert
;
2419 /** Lowers bitfield_insert to compares, and shifts. */
2420 bool lower_bitfield_insert_to_shifts
;
2421 /** Lowers bitfield_insert to bfm/bitfield_select. */
2422 bool lower_bitfield_insert_to_bitfield_select
;
2423 /** Lowers bitfield_reverse to shifts. */
2424 bool lower_bitfield_reverse
;
2425 /** Lowers bit_count to shifts. */
2426 bool lower_bit_count
;
2427 /** Lowers ifind_msb to compare and ufind_msb */
2428 bool lower_ifind_msb
;
2429 /** Lowers find_lsb to ufind_msb and logic ops */
2430 bool lower_find_lsb
;
2431 bool lower_uadd_carry
;
2432 bool lower_usub_borrow
;
2433 /** Lowers imul_high/umul_high to 16-bit multiplies and carry operations. */
2434 bool lower_mul_high
;
2435 /** lowers fneg and ineg to fsub and isub. */
2437 /** lowers fsub and isub to fadd+fneg and iadd+ineg. */
2440 /* lower {slt,sge,seq,sne} to {flt,fge,feq,fne} + b2f: */
2443 /** enables rules to lower idiv by power-of-two: */
2446 /** enable rules to avoid bit shifts */
2447 bool lower_bitshift
;
2449 /** enables rules to lower isign to imin+imax */
2452 /** enables rules to lower fsign to fsub and flt */
2455 /* Does the native fdot instruction replicate its result for four
2456 * components? If so, then opt_algebraic_late will turn all fdotN
2457 * instructions into fdot_replicatedN instructions.
2459 bool fdot_replicates
;
2461 /** lowers ffloor to fsub+ffract: */
2464 /** lowers ffract to fsub+ffloor: */
2467 /** lowers fceil to fneg+ffloor+fneg: */
2474 bool lower_pack_half_2x16
;
2475 bool lower_pack_unorm_2x16
;
2476 bool lower_pack_snorm_2x16
;
2477 bool lower_pack_unorm_4x8
;
2478 bool lower_pack_snorm_4x8
;
2479 bool lower_unpack_half_2x16
;
2480 bool lower_unpack_unorm_2x16
;
2481 bool lower_unpack_snorm_2x16
;
2482 bool lower_unpack_unorm_4x8
;
2483 bool lower_unpack_snorm_4x8
;
2485 bool lower_extract_byte
;
2486 bool lower_extract_word
;
2488 bool lower_all_io_to_temps
;
2489 bool lower_all_io_to_elements
;
2491 /* Indicates that the driver only has zero-based vertex id */
2492 bool vertex_id_zero_based
;
2495 * If enabled, gl_BaseVertex will be lowered as:
2496 * is_indexed_draw (~0/0) & firstvertex
2498 bool lower_base_vertex
;
2501 * If enabled, gl_HelperInvocation will be lowered as:
2503 * !((1 << sample_id) & sample_mask_in))
2505 * This depends on some possibly hw implementation details, which may
2506 * not be true for all hw. In particular that the FS is only executed
2507 * for covered samples or for helper invocations. So, do not blindly
2508 * enable this option.
2510 * Note: See also issue #22 in ARB_shader_image_load_store
2512 bool lower_helper_invocation
;
2515 * Convert gl_SampleMaskIn to gl_HelperInvocation as follows:
2517 * gl_SampleMaskIn == 0 ---> gl_HelperInvocation
2518 * gl_SampleMaskIn != 0 ---> !gl_HelperInvocation
2520 bool optimize_sample_mask_in
;
2522 bool lower_cs_local_index_from_id
;
2523 bool lower_cs_local_id_from_index
;
2525 bool lower_device_index_to_zero
;
2527 /* Set if nir_lower_wpos_ytransform() should also invert gl_PointCoord. */
2528 bool lower_wpos_pntc
;
2534 * Should IO be re-vectorized? Some scalar ISAs still operate on vec4's
2535 * for IO purposes and would prefer loads/stores be vectorized.
2540 * Should nir_lower_io() create load_interpolated_input intrinsics?
2542 * If not, it generates regular load_input intrinsics and interpolation
2543 * information must be inferred from the list of input nir_variables.
2545 bool use_interpolated_input_intrinsics
;
2547 /* Lowers when 32x32->64 bit multiplication is not supported */
2548 bool lower_mul_2x32_64
;
2550 /* Lowers when rotate instruction is not supported */
2553 unsigned max_unroll_iterations
;
2555 nir_lower_int64_options lower_int64_options
;
2556 nir_lower_doubles_options lower_doubles_options
;
2557 } nir_shader_compiler_options
;
2559 typedef struct nir_shader
{
2560 /** list of uniforms (nir_variable) */
2561 struct exec_list uniforms
;
2563 /** list of inputs (nir_variable) */
2564 struct exec_list inputs
;
2566 /** list of outputs (nir_variable) */
2567 struct exec_list outputs
;
2569 /** list of shared compute variables (nir_variable) */
2570 struct exec_list shared
;
2572 /** Set of driver-specific options for the shader.
2574 * The memory for the options is expected to be kept in a single static
2575 * copy by the driver.
2577 const struct nir_shader_compiler_options
*options
;
2579 /** Various bits of compile-time information about a given shader */
2580 struct shader_info info
;
2582 /** list of global variables in the shader (nir_variable) */
2583 struct exec_list globals
;
2585 /** list of system value variables in the shader (nir_variable) */
2586 struct exec_list system_values
;
2588 struct exec_list functions
; /** < list of nir_function */
2591 * the highest index a load_input_*, load_uniform_*, etc. intrinsic can
2594 unsigned num_inputs
, num_uniforms
, num_outputs
, num_shared
;
2596 /** Size in bytes of required scratch space */
2597 unsigned scratch_size
;
2599 /** Constant data associated with this shader.
2601 * Constant data is loaded through load_constant intrinsics. See also
2602 * nir_opt_large_constants.
2604 void *constant_data
;
2605 unsigned constant_data_size
;
2608 #define nir_foreach_function(func, shader) \
2609 foreach_list_typed(nir_function, func, node, &(shader)->functions)
2611 static inline nir_function_impl
*
2612 nir_shader_get_entrypoint(nir_shader
*shader
)
2614 nir_function
*func
= NULL
;
2616 nir_foreach_function(function
, shader
) {
2617 assert(func
== NULL
);
2618 if (function
->is_entrypoint
) {
2629 assert(func
->num_params
== 0);
2634 nir_shader
*nir_shader_create(void *mem_ctx
,
2635 gl_shader_stage stage
,
2636 const nir_shader_compiler_options
*options
,
2639 nir_register
*nir_local_reg_create(nir_function_impl
*impl
);
2641 void nir_reg_remove(nir_register
*reg
);
2643 /** Adds a variable to the appropriate list in nir_shader */
2644 void nir_shader_add_variable(nir_shader
*shader
, nir_variable
*var
);
2647 nir_function_impl_add_variable(nir_function_impl
*impl
, nir_variable
*var
)
2649 assert(var
->data
.mode
== nir_var_function_temp
);
2650 exec_list_push_tail(&impl
->locals
, &var
->node
);
2653 /** creates a variable, sets a few defaults, and adds it to the list */
2654 nir_variable
*nir_variable_create(nir_shader
*shader
,
2655 nir_variable_mode mode
,
2656 const struct glsl_type
*type
,
2658 /** creates a local variable and adds it to the list */
2659 nir_variable
*nir_local_variable_create(nir_function_impl
*impl
,
2660 const struct glsl_type
*type
,
2663 /** creates a function and adds it to the shader's list of functions */
2664 nir_function
*nir_function_create(nir_shader
*shader
, const char *name
);
2666 nir_function_impl
*nir_function_impl_create(nir_function
*func
);
2667 /** creates a function_impl that isn't tied to any particular function */
2668 nir_function_impl
*nir_function_impl_create_bare(nir_shader
*shader
);
2670 nir_block
*nir_block_create(nir_shader
*shader
);
2671 nir_if
*nir_if_create(nir_shader
*shader
);
2672 nir_loop
*nir_loop_create(nir_shader
*shader
);
2674 nir_function_impl
*nir_cf_node_get_function(nir_cf_node
*node
);
2676 /** requests that the given pieces of metadata be generated */
2677 void nir_metadata_require(nir_function_impl
*impl
, nir_metadata required
, ...);
2678 /** dirties all but the preserved metadata */
2679 void nir_metadata_preserve(nir_function_impl
*impl
, nir_metadata preserved
);
2681 /** creates an instruction with default swizzle/writemask/etc. with NULL registers */
2682 nir_alu_instr
*nir_alu_instr_create(nir_shader
*shader
, nir_op op
);
2684 nir_deref_instr
*nir_deref_instr_create(nir_shader
*shader
,
2685 nir_deref_type deref_type
);
2687 nir_jump_instr
*nir_jump_instr_create(nir_shader
*shader
, nir_jump_type type
);
2689 nir_load_const_instr
*nir_load_const_instr_create(nir_shader
*shader
,
2690 unsigned num_components
,
2693 nir_intrinsic_instr
*nir_intrinsic_instr_create(nir_shader
*shader
,
2694 nir_intrinsic_op op
);
2696 nir_call_instr
*nir_call_instr_create(nir_shader
*shader
,
2697 nir_function
*callee
);
2699 nir_tex_instr
*nir_tex_instr_create(nir_shader
*shader
, unsigned num_srcs
);
2701 nir_phi_instr
*nir_phi_instr_create(nir_shader
*shader
);
2703 nir_parallel_copy_instr
*nir_parallel_copy_instr_create(nir_shader
*shader
);
2705 nir_ssa_undef_instr
*nir_ssa_undef_instr_create(nir_shader
*shader
,
2706 unsigned num_components
,
2709 nir_const_value
nir_alu_binop_identity(nir_op binop
, unsigned bit_size
);
2712 * NIR Cursors and Instruction Insertion API
2715 * A tiny struct representing a point to insert/extract instructions or
2716 * control flow nodes. Helps reduce the combinatorial explosion of possible
2717 * points to insert/extract.
2719 * \sa nir_control_flow.h
2722 nir_cursor_before_block
,
2723 nir_cursor_after_block
,
2724 nir_cursor_before_instr
,
2725 nir_cursor_after_instr
,
2726 } nir_cursor_option
;
2729 nir_cursor_option option
;
2736 static inline nir_block
*
2737 nir_cursor_current_block(nir_cursor cursor
)
2739 if (cursor
.option
== nir_cursor_before_instr
||
2740 cursor
.option
== nir_cursor_after_instr
) {
2741 return cursor
.instr
->block
;
2743 return cursor
.block
;
2747 bool nir_cursors_equal(nir_cursor a
, nir_cursor b
);
2749 static inline nir_cursor
2750 nir_before_block(nir_block
*block
)
2753 cursor
.option
= nir_cursor_before_block
;
2754 cursor
.block
= block
;
2758 static inline nir_cursor
2759 nir_after_block(nir_block
*block
)
2762 cursor
.option
= nir_cursor_after_block
;
2763 cursor
.block
= block
;
2767 static inline nir_cursor
2768 nir_before_instr(nir_instr
*instr
)
2771 cursor
.option
= nir_cursor_before_instr
;
2772 cursor
.instr
= instr
;
2776 static inline nir_cursor
2777 nir_after_instr(nir_instr
*instr
)
2780 cursor
.option
= nir_cursor_after_instr
;
2781 cursor
.instr
= instr
;
2785 static inline nir_cursor
2786 nir_after_block_before_jump(nir_block
*block
)
2788 nir_instr
*last_instr
= nir_block_last_instr(block
);
2789 if (last_instr
&& last_instr
->type
== nir_instr_type_jump
) {
2790 return nir_before_instr(last_instr
);
2792 return nir_after_block(block
);
2796 static inline nir_cursor
2797 nir_before_src(nir_src
*src
, bool is_if_condition
)
2799 if (is_if_condition
) {
2800 nir_block
*prev_block
=
2801 nir_cf_node_as_block(nir_cf_node_prev(&src
->parent_if
->cf_node
));
2802 assert(!nir_block_ends_in_jump(prev_block
));
2803 return nir_after_block(prev_block
);
2804 } else if (src
->parent_instr
->type
== nir_instr_type_phi
) {
2806 nir_phi_instr
*cond_phi
= nir_instr_as_phi(src
->parent_instr
);
2808 nir_foreach_phi_src(phi_src
, cond_phi
) {
2809 if (phi_src
->src
.ssa
== src
->ssa
) {
2816 /* The LIST_ENTRY macro is a generic container-of macro, it just happens
2817 * to have a more specific name.
2819 nir_phi_src
*phi_src
= LIST_ENTRY(nir_phi_src
, src
, src
);
2820 return nir_after_block_before_jump(phi_src
->pred
);
2822 return nir_before_instr(src
->parent_instr
);
2826 static inline nir_cursor
2827 nir_before_cf_node(nir_cf_node
*node
)
2829 if (node
->type
== nir_cf_node_block
)
2830 return nir_before_block(nir_cf_node_as_block(node
));
2832 return nir_after_block(nir_cf_node_as_block(nir_cf_node_prev(node
)));
2835 static inline nir_cursor
2836 nir_after_cf_node(nir_cf_node
*node
)
2838 if (node
->type
== nir_cf_node_block
)
2839 return nir_after_block(nir_cf_node_as_block(node
));
2841 return nir_before_block(nir_cf_node_as_block(nir_cf_node_next(node
)));
2844 static inline nir_cursor
2845 nir_after_phis(nir_block
*block
)
2847 nir_foreach_instr(instr
, block
) {
2848 if (instr
->type
!= nir_instr_type_phi
)
2849 return nir_before_instr(instr
);
2851 return nir_after_block(block
);
2854 static inline nir_cursor
2855 nir_after_cf_node_and_phis(nir_cf_node
*node
)
2857 if (node
->type
== nir_cf_node_block
)
2858 return nir_after_block(nir_cf_node_as_block(node
));
2860 nir_block
*block
= nir_cf_node_as_block(nir_cf_node_next(node
));
2862 return nir_after_phis(block
);
2865 static inline nir_cursor
2866 nir_before_cf_list(struct exec_list
*cf_list
)
2868 nir_cf_node
*first_node
= exec_node_data(nir_cf_node
,
2869 exec_list_get_head(cf_list
), node
);
2870 return nir_before_cf_node(first_node
);
2873 static inline nir_cursor
2874 nir_after_cf_list(struct exec_list
*cf_list
)
2876 nir_cf_node
*last_node
= exec_node_data(nir_cf_node
,
2877 exec_list_get_tail(cf_list
), node
);
2878 return nir_after_cf_node(last_node
);
2882 * Insert a NIR instruction at the given cursor.
2884 * Note: This does not update the cursor.
2886 void nir_instr_insert(nir_cursor cursor
, nir_instr
*instr
);
2889 nir_instr_insert_before(nir_instr
*instr
, nir_instr
*before
)
2891 nir_instr_insert(nir_before_instr(instr
), before
);
2895 nir_instr_insert_after(nir_instr
*instr
, nir_instr
*after
)
2897 nir_instr_insert(nir_after_instr(instr
), after
);
2901 nir_instr_insert_before_block(nir_block
*block
, nir_instr
*before
)
2903 nir_instr_insert(nir_before_block(block
), before
);
2907 nir_instr_insert_after_block(nir_block
*block
, nir_instr
*after
)
2909 nir_instr_insert(nir_after_block(block
), after
);
2913 nir_instr_insert_before_cf(nir_cf_node
*node
, nir_instr
*before
)
2915 nir_instr_insert(nir_before_cf_node(node
), before
);
2919 nir_instr_insert_after_cf(nir_cf_node
*node
, nir_instr
*after
)
2921 nir_instr_insert(nir_after_cf_node(node
), after
);
2925 nir_instr_insert_before_cf_list(struct exec_list
*list
, nir_instr
*before
)
2927 nir_instr_insert(nir_before_cf_list(list
), before
);
2931 nir_instr_insert_after_cf_list(struct exec_list
*list
, nir_instr
*after
)
2933 nir_instr_insert(nir_after_cf_list(list
), after
);
2936 void nir_instr_remove_v(nir_instr
*instr
);
2938 static inline nir_cursor
2939 nir_instr_remove(nir_instr
*instr
)
2942 nir_instr
*prev
= nir_instr_prev(instr
);
2944 cursor
= nir_after_instr(prev
);
2946 cursor
= nir_before_block(instr
->block
);
2948 nir_instr_remove_v(instr
);
2954 typedef bool (*nir_foreach_ssa_def_cb
)(nir_ssa_def
*def
, void *state
);
2955 typedef bool (*nir_foreach_dest_cb
)(nir_dest
*dest
, void *state
);
2956 typedef bool (*nir_foreach_src_cb
)(nir_src
*src
, void *state
);
2957 bool nir_foreach_ssa_def(nir_instr
*instr
, nir_foreach_ssa_def_cb cb
,
2959 bool nir_foreach_dest(nir_instr
*instr
, nir_foreach_dest_cb cb
, void *state
);
2960 bool nir_foreach_src(nir_instr
*instr
, nir_foreach_src_cb cb
, void *state
);
2962 nir_const_value
*nir_src_as_const_value(nir_src src
);
2964 #define NIR_SRC_AS_(name, c_type, type_enum, cast_macro) \
2965 static inline c_type * \
2966 nir_src_as_ ## name (nir_src src) \
2968 return src.is_ssa && src.ssa->parent_instr->type == type_enum \
2969 ? cast_macro(src.ssa->parent_instr) : NULL; \
2972 NIR_SRC_AS_(alu_instr
, nir_alu_instr
, nir_instr_type_alu
, nir_instr_as_alu
)
2973 NIR_SRC_AS_(intrinsic
, nir_intrinsic_instr
,
2974 nir_instr_type_intrinsic
, nir_instr_as_intrinsic
)
2975 NIR_SRC_AS_(deref
, nir_deref_instr
, nir_instr_type_deref
, nir_instr_as_deref
)
2977 bool nir_src_is_dynamically_uniform(nir_src src
);
2978 bool nir_srcs_equal(nir_src src1
, nir_src src2
);
2979 void nir_instr_rewrite_src(nir_instr
*instr
, nir_src
*src
, nir_src new_src
);
2980 void nir_instr_move_src(nir_instr
*dest_instr
, nir_src
*dest
, nir_src
*src
);
2981 void nir_if_rewrite_condition(nir_if
*if_stmt
, nir_src new_src
);
2982 void nir_instr_rewrite_dest(nir_instr
*instr
, nir_dest
*dest
,
2985 void nir_ssa_dest_init(nir_instr
*instr
, nir_dest
*dest
,
2986 unsigned num_components
, unsigned bit_size
,
2988 void nir_ssa_def_init(nir_instr
*instr
, nir_ssa_def
*def
,
2989 unsigned num_components
, unsigned bit_size
,
2992 nir_ssa_dest_init_for_type(nir_instr
*instr
, nir_dest
*dest
,
2993 const struct glsl_type
*type
,
2996 assert(glsl_type_is_vector_or_scalar(type
));
2997 nir_ssa_dest_init(instr
, dest
, glsl_get_components(type
),
2998 glsl_get_bit_size(type
), name
);
3000 void nir_ssa_def_rewrite_uses(nir_ssa_def
*def
, nir_src new_src
);
3001 void nir_ssa_def_rewrite_uses_after(nir_ssa_def
*def
, nir_src new_src
,
3002 nir_instr
*after_me
);
3004 nir_component_mask_t
nir_ssa_def_components_read(const nir_ssa_def
*def
);
3007 * finds the next basic block in source-code order, returns NULL if there is
3011 nir_block
*nir_block_cf_tree_next(nir_block
*block
);
3013 /* Performs the opposite of nir_block_cf_tree_next() */
3015 nir_block
*nir_block_cf_tree_prev(nir_block
*block
);
3017 /* Gets the first block in a CF node in source-code order */
3019 nir_block
*nir_cf_node_cf_tree_first(nir_cf_node
*node
);
3021 /* Gets the last block in a CF node in source-code order */
3023 nir_block
*nir_cf_node_cf_tree_last(nir_cf_node
*node
);
3025 /* Gets the next block after a CF node in source-code order */
3027 nir_block
*nir_cf_node_cf_tree_next(nir_cf_node
*node
);
3029 /* Macros for loops that visit blocks in source-code order */
3031 #define nir_foreach_block(block, impl) \
3032 for (nir_block *block = nir_start_block(impl); block != NULL; \
3033 block = nir_block_cf_tree_next(block))
3035 #define nir_foreach_block_safe(block, impl) \
3036 for (nir_block *block = nir_start_block(impl), \
3037 *next = nir_block_cf_tree_next(block); \
3039 block = next, next = nir_block_cf_tree_next(block))
3041 #define nir_foreach_block_reverse(block, impl) \
3042 for (nir_block *block = nir_impl_last_block(impl); block != NULL; \
3043 block = nir_block_cf_tree_prev(block))
3045 #define nir_foreach_block_reverse_safe(block, impl) \
3046 for (nir_block *block = nir_impl_last_block(impl), \
3047 *prev = nir_block_cf_tree_prev(block); \
3049 block = prev, prev = nir_block_cf_tree_prev(block))
3051 #define nir_foreach_block_in_cf_node(block, node) \
3052 for (nir_block *block = nir_cf_node_cf_tree_first(node); \
3053 block != nir_cf_node_cf_tree_next(node); \
3054 block = nir_block_cf_tree_next(block))
3056 /* If the following CF node is an if, this function returns that if.
3057 * Otherwise, it returns NULL.
3059 nir_if
*nir_block_get_following_if(nir_block
*block
);
3061 nir_loop
*nir_block_get_following_loop(nir_block
*block
);
3063 void nir_index_local_regs(nir_function_impl
*impl
);
3064 void nir_index_ssa_defs(nir_function_impl
*impl
);
3065 unsigned nir_index_instrs(nir_function_impl
*impl
);
3067 void nir_index_blocks(nir_function_impl
*impl
);
3069 void nir_print_shader(nir_shader
*shader
, FILE *fp
);
3070 void nir_print_shader_annotated(nir_shader
*shader
, FILE *fp
, struct hash_table
*errors
);
3071 void nir_print_instr(const nir_instr
*instr
, FILE *fp
);
3072 void nir_print_deref(const nir_deref_instr
*deref
, FILE *fp
);
3074 /** Shallow clone of a single ALU instruction. */
3075 nir_alu_instr
*nir_alu_instr_clone(nir_shader
*s
, const nir_alu_instr
*orig
);
3077 nir_shader
*nir_shader_clone(void *mem_ctx
, const nir_shader
*s
);
3078 nir_function_impl
*nir_function_impl_clone(nir_shader
*shader
,
3079 const nir_function_impl
*fi
);
3080 nir_constant
*nir_constant_clone(const nir_constant
*c
, nir_variable
*var
);
3081 nir_variable
*nir_variable_clone(const nir_variable
*c
, nir_shader
*shader
);
3083 void nir_shader_replace(nir_shader
*dest
, nir_shader
*src
);
3085 void nir_shader_serialize_deserialize(nir_shader
*s
);
3088 void nir_validate_shader(nir_shader
*shader
, const char *when
);
3089 void nir_metadata_set_validation_flag(nir_shader
*shader
);
3090 void nir_metadata_check_validation_flag(nir_shader
*shader
);
3093 should_skip_nir(const char *name
)
3095 static const char *list
= NULL
;
3097 /* Comma separated list of names to skip. */
3098 list
= getenv("NIR_SKIP");
3106 return comma_separated_list_contains(list
, name
);
3110 should_clone_nir(void)
3112 static int should_clone
= -1;
3113 if (should_clone
< 0)
3114 should_clone
= env_var_as_boolean("NIR_TEST_CLONE", false);
3116 return should_clone
;
3120 should_serialize_deserialize_nir(void)
3122 static int test_serialize
= -1;
3123 if (test_serialize
< 0)
3124 test_serialize
= env_var_as_boolean("NIR_TEST_SERIALIZE", false);
3126 return test_serialize
;
3130 should_print_nir(void)
3132 static int should_print
= -1;
3133 if (should_print
< 0)
3134 should_print
= env_var_as_boolean("NIR_PRINT", false);
3136 return should_print
;
3139 static inline void nir_validate_shader(nir_shader
*shader
, const char *when
) { (void) shader
; (void)when
; }
3140 static inline void nir_metadata_set_validation_flag(nir_shader
*shader
) { (void) shader
; }
3141 static inline void nir_metadata_check_validation_flag(nir_shader
*shader
) { (void) shader
; }
3142 static inline bool should_skip_nir(UNUSED
const char *pass_name
) { return false; }
3143 static inline bool should_clone_nir(void) { return false; }
3144 static inline bool should_serialize_deserialize_nir(void) { return false; }
3145 static inline bool should_print_nir(void) { return false; }
3148 #define _PASS(pass, nir, do_pass) do { \
3149 if (should_skip_nir(#pass)) { \
3150 printf("skipping %s\n", #pass); \
3154 nir_validate_shader(nir, "after " #pass); \
3155 if (should_clone_nir()) { \
3156 nir_shader *clone = nir_shader_clone(ralloc_parent(nir), nir); \
3157 nir_shader_replace(nir, clone); \
3159 if (should_serialize_deserialize_nir()) { \
3160 nir_shader_serialize_deserialize(nir); \
3164 #define NIR_PASS(progress, nir, pass, ...) _PASS(pass, nir, \
3165 nir_metadata_set_validation_flag(nir); \
3166 if (should_print_nir()) \
3167 printf("%s\n", #pass); \
3168 if (pass(nir, ##__VA_ARGS__)) { \
3170 if (should_print_nir()) \
3171 nir_print_shader(nir, stdout); \
3172 nir_metadata_check_validation_flag(nir); \
3176 #define NIR_PASS_V(nir, pass, ...) _PASS(pass, nir, \
3177 if (should_print_nir()) \
3178 printf("%s\n", #pass); \
3179 pass(nir, ##__VA_ARGS__); \
3180 if (should_print_nir()) \
3181 nir_print_shader(nir, stdout); \
3184 #define NIR_SKIP(name) should_skip_nir(#name)
3186 void nir_calc_dominance_impl(nir_function_impl
*impl
);
3187 void nir_calc_dominance(nir_shader
*shader
);
3189 nir_block
*nir_dominance_lca(nir_block
*b1
, nir_block
*b2
);
3190 bool nir_block_dominates(nir_block
*parent
, nir_block
*child
);
3192 void nir_dump_dom_tree_impl(nir_function_impl
*impl
, FILE *fp
);
3193 void nir_dump_dom_tree(nir_shader
*shader
, FILE *fp
);
3195 void nir_dump_dom_frontier_impl(nir_function_impl
*impl
, FILE *fp
);
3196 void nir_dump_dom_frontier(nir_shader
*shader
, FILE *fp
);
3198 void nir_dump_cfg_impl(nir_function_impl
*impl
, FILE *fp
);
3199 void nir_dump_cfg(nir_shader
*shader
, FILE *fp
);
3201 int nir_gs_count_vertices(const nir_shader
*shader
);
3203 bool nir_shrink_vec_array_vars(nir_shader
*shader
, nir_variable_mode modes
);
3204 bool nir_split_array_vars(nir_shader
*shader
, nir_variable_mode modes
);
3205 bool nir_split_var_copies(nir_shader
*shader
);
3206 bool nir_split_per_member_structs(nir_shader
*shader
);
3207 bool nir_split_struct_vars(nir_shader
*shader
, nir_variable_mode modes
);
3209 bool nir_lower_returns_impl(nir_function_impl
*impl
);
3210 bool nir_lower_returns(nir_shader
*shader
);
3212 void nir_inline_function_impl(struct nir_builder
*b
,
3213 const nir_function_impl
*impl
,
3214 nir_ssa_def
**params
);
3215 bool nir_inline_functions(nir_shader
*shader
);
3217 bool nir_propagate_invariant(nir_shader
*shader
);
3219 void nir_lower_var_copy_instr(nir_intrinsic_instr
*copy
, nir_shader
*shader
);
3220 void nir_lower_deref_copy_instr(struct nir_builder
*b
,
3221 nir_intrinsic_instr
*copy
);
3222 bool nir_lower_var_copies(nir_shader
*shader
);
3224 void nir_fixup_deref_modes(nir_shader
*shader
);
3226 bool nir_lower_global_vars_to_local(nir_shader
*shader
);
3229 nir_lower_direct_array_deref_of_vec_load
= (1 << 0),
3230 nir_lower_indirect_array_deref_of_vec_load
= (1 << 1),
3231 nir_lower_direct_array_deref_of_vec_store
= (1 << 2),
3232 nir_lower_indirect_array_deref_of_vec_store
= (1 << 3),
3233 } nir_lower_array_deref_of_vec_options
;
3235 bool nir_lower_array_deref_of_vec(nir_shader
*shader
, nir_variable_mode modes
,
3236 nir_lower_array_deref_of_vec_options options
);
3238 bool nir_lower_indirect_derefs(nir_shader
*shader
, nir_variable_mode modes
);
3240 bool nir_lower_locals_to_regs(nir_shader
*shader
);
3242 void nir_lower_io_to_temporaries(nir_shader
*shader
,
3243 nir_function_impl
*entrypoint
,
3244 bool outputs
, bool inputs
);
3246 bool nir_lower_vars_to_scratch(nir_shader
*shader
,
3247 nir_variable_mode modes
,
3249 glsl_type_size_align_func size_align
);
3251 void nir_shader_gather_info(nir_shader
*shader
, nir_function_impl
*entrypoint
);
3253 void nir_gather_ssa_types(nir_function_impl
*impl
,
3254 BITSET_WORD
*float_types
,
3255 BITSET_WORD
*int_types
);
3257 void nir_assign_var_locations(struct exec_list
*var_list
, unsigned *size
,
3258 int (*type_size
)(const struct glsl_type
*, bool));
3260 /* Some helpers to do very simple linking */
3261 bool nir_remove_unused_varyings(nir_shader
*producer
, nir_shader
*consumer
);
3262 bool nir_remove_unused_io_vars(nir_shader
*shader
, struct exec_list
*var_list
,
3263 uint64_t *used_by_other_stage
,
3264 uint64_t *used_by_other_stage_patches
);
3265 void nir_compact_varyings(nir_shader
*producer
, nir_shader
*consumer
,
3266 bool default_to_smooth_interp
);
3267 void nir_link_xfb_varyings(nir_shader
*producer
, nir_shader
*consumer
);
3268 bool nir_link_opt_varyings(nir_shader
*producer
, nir_shader
*consumer
);
3271 void nir_assign_io_var_locations(struct exec_list
*var_list
,
3273 gl_shader_stage stage
);
3276 /* If set, this forces all non-flat fragment shader inputs to be
3277 * interpolated as if with the "sample" qualifier. This requires
3278 * nir_shader_compiler_options::use_interpolated_input_intrinsics.
3280 nir_lower_io_force_sample_interpolation
= (1 << 1),
3281 } nir_lower_io_options
;
3282 bool nir_lower_io(nir_shader
*shader
,
3283 nir_variable_mode modes
,
3284 int (*type_size
)(const struct glsl_type
*, bool),
3285 nir_lower_io_options
);
3287 bool nir_io_add_const_offset_to_base(nir_shader
*nir
, nir_variable_mode mode
);
3291 * An address format which is a simple 32-bit global GPU address.
3293 nir_address_format_32bit_global
,
3296 * An address format which is a simple 64-bit global GPU address.
3298 nir_address_format_64bit_global
,
3301 * An address format which is a bounds-checked 64-bit global GPU address.
3303 * The address is comprised as a 32-bit vec4 where .xy are a uint64_t base
3304 * address stored with the low bits in .x and high bits in .y, .z is a
3305 * size, and .w is an offset. When the final I/O operation is lowered, .w
3306 * is checked against .z and the operation is predicated on the result.
3308 nir_address_format_64bit_bounded_global
,
3311 * An address format which is comprised of a vec2 where the first
3312 * component is a buffer index and the second is an offset.
3314 nir_address_format_32bit_index_offset
,
3317 * An address format which is a simple 32-bit offset.
3319 nir_address_format_32bit_offset
,
3322 * An address format representing a purely logical addressing model. In
3323 * this model, all deref chains must be complete from the dereference
3324 * operation to the variable. Cast derefs are not allowed. These
3325 * addresses will be 32-bit scalars but the format is immaterial because
3326 * you can always chase the chain.
3328 nir_address_format_logical
,
3329 } nir_address_format
;
3331 static inline unsigned
3332 nir_address_format_bit_size(nir_address_format addr_format
)
3334 switch (addr_format
) {
3335 case nir_address_format_32bit_global
: return 32;
3336 case nir_address_format_64bit_global
: return 64;
3337 case nir_address_format_64bit_bounded_global
: return 32;
3338 case nir_address_format_32bit_index_offset
: return 32;
3339 case nir_address_format_32bit_offset
: return 32;
3340 case nir_address_format_logical
: return 32;
3342 unreachable("Invalid address format");
3345 static inline unsigned
3346 nir_address_format_num_components(nir_address_format addr_format
)
3348 switch (addr_format
) {
3349 case nir_address_format_32bit_global
: return 1;
3350 case nir_address_format_64bit_global
: return 1;
3351 case nir_address_format_64bit_bounded_global
: return 4;
3352 case nir_address_format_32bit_index_offset
: return 2;
3353 case nir_address_format_32bit_offset
: return 1;
3354 case nir_address_format_logical
: return 1;
3356 unreachable("Invalid address format");
3359 static inline const struct glsl_type
*
3360 nir_address_format_to_glsl_type(nir_address_format addr_format
)
3362 unsigned bit_size
= nir_address_format_bit_size(addr_format
);
3363 assert(bit_size
== 32 || bit_size
== 64);
3364 return glsl_vector_type(bit_size
== 32 ? GLSL_TYPE_UINT
: GLSL_TYPE_UINT64
,
3365 nir_address_format_num_components(addr_format
));
3368 const nir_const_value
*nir_address_format_null_value(nir_address_format addr_format
);
3370 nir_ssa_def
*nir_build_addr_ieq(struct nir_builder
*b
, nir_ssa_def
*addr0
, nir_ssa_def
*addr1
,
3371 nir_address_format addr_format
);
3373 nir_ssa_def
*nir_build_addr_isub(struct nir_builder
*b
, nir_ssa_def
*addr0
, nir_ssa_def
*addr1
,
3374 nir_address_format addr_format
);
3376 nir_ssa_def
* nir_explicit_io_address_from_deref(struct nir_builder
*b
,
3377 nir_deref_instr
*deref
,
3378 nir_ssa_def
*base_addr
,
3379 nir_address_format addr_format
);
3380 void nir_lower_explicit_io_instr(struct nir_builder
*b
,
3381 nir_intrinsic_instr
*io_instr
,
3383 nir_address_format addr_format
);
3385 bool nir_lower_explicit_io(nir_shader
*shader
,
3386 nir_variable_mode modes
,
3387 nir_address_format
);
3389 nir_src
*nir_get_io_offset_src(nir_intrinsic_instr
*instr
);
3390 nir_src
*nir_get_io_vertex_index_src(nir_intrinsic_instr
*instr
);
3392 bool nir_is_per_vertex_io(const nir_variable
*var
, gl_shader_stage stage
);
3394 bool nir_lower_regs_to_ssa_impl(nir_function_impl
*impl
);
3395 bool nir_lower_regs_to_ssa(nir_shader
*shader
);
3396 bool nir_lower_vars_to_ssa(nir_shader
*shader
);
3398 bool nir_remove_dead_derefs(nir_shader
*shader
);
3399 bool nir_remove_dead_derefs_impl(nir_function_impl
*impl
);
3400 bool nir_remove_dead_variables(nir_shader
*shader
, nir_variable_mode modes
);
3401 bool nir_lower_constant_initializers(nir_shader
*shader
,
3402 nir_variable_mode modes
);
3404 bool nir_move_load_const(nir_shader
*shader
);
3405 bool nir_move_vec_src_uses_to_dest(nir_shader
*shader
);
3406 bool nir_lower_vec_to_movs(nir_shader
*shader
);
3407 void nir_lower_alpha_test(nir_shader
*shader
, enum compare_func func
,
3409 bool nir_lower_alu(nir_shader
*shader
);
3411 bool nir_lower_flrp(nir_shader
*shader
, unsigned lowering_mask
,
3412 bool always_precise
, bool have_ffma
);
3414 bool nir_lower_alu_to_scalar(nir_shader
*shader
, BITSET_WORD
*lower_set
);
3415 bool nir_lower_bool_to_float(nir_shader
*shader
);
3416 bool nir_lower_bool_to_int32(nir_shader
*shader
);
3417 bool nir_lower_int_to_float(nir_shader
*shader
);
3418 bool nir_lower_load_const_to_scalar(nir_shader
*shader
);
3419 bool nir_lower_read_invocation_to_scalar(nir_shader
*shader
);
3420 bool nir_lower_phis_to_scalar(nir_shader
*shader
);
3421 void nir_lower_io_arrays_to_elements(nir_shader
*producer
, nir_shader
*consumer
);
3422 void nir_lower_io_arrays_to_elements_no_indirects(nir_shader
*shader
,
3424 void nir_lower_io_to_scalar(nir_shader
*shader
, nir_variable_mode mask
);
3425 void nir_lower_io_to_scalar_early(nir_shader
*shader
, nir_variable_mode mask
);
3426 bool nir_lower_io_to_vector(nir_shader
*shader
, nir_variable_mode mask
);
3428 void nir_lower_fragcoord_wtrans(nir_shader
*shader
);
3429 void nir_lower_viewport_transform(nir_shader
*shader
);
3430 bool nir_lower_uniforms_to_ubo(nir_shader
*shader
, int multiplier
);
3432 typedef struct nir_lower_subgroups_options
{
3433 uint8_t subgroup_size
;
3434 uint8_t ballot_bit_size
;
3435 bool lower_to_scalar
:1;
3436 bool lower_vote_trivial
:1;
3437 bool lower_vote_eq_to_ballot
:1;
3438 bool lower_subgroup_masks
:1;
3439 bool lower_shuffle
:1;
3440 bool lower_shuffle_to_32bit
:1;
3442 } nir_lower_subgroups_options
;
3444 bool nir_lower_subgroups(nir_shader
*shader
,
3445 const nir_lower_subgroups_options
*options
);
3447 bool nir_lower_system_values(nir_shader
*shader
);
3449 enum PACKED nir_lower_tex_packing
{
3450 nir_lower_tex_packing_none
= 0,
3451 /* The sampler returns up to 2 32-bit words of half floats or 16-bit signed
3452 * or unsigned ints based on the sampler type
3454 nir_lower_tex_packing_16
,
3455 /* The sampler returns 1 32-bit word of 4x8 unorm */
3456 nir_lower_tex_packing_8
,
3459 typedef struct nir_lower_tex_options
{
3461 * bitmask of (1 << GLSL_SAMPLER_DIM_x) to control for which
3462 * sampler types a texture projector is lowered.
3467 * If true, lower away nir_tex_src_offset for all texelfetch instructions.
3469 bool lower_txf_offset
;
3472 * If true, lower away nir_tex_src_offset for all rect textures.
3474 bool lower_rect_offset
;
3477 * If true, lower rect textures to 2D, using txs to fetch the
3478 * texture dimensions and dividing the texture coords by the
3479 * texture dims to normalize.
3484 * If true, convert yuv to rgb.
3486 unsigned lower_y_uv_external
;
3487 unsigned lower_y_u_v_external
;
3488 unsigned lower_yx_xuxv_external
;
3489 unsigned lower_xy_uxvx_external
;
3490 unsigned lower_ayuv_external
;
3491 unsigned lower_xyuv_external
;
3494 * To emulate certain texture wrap modes, this can be used
3495 * to saturate the specified tex coord to [0.0, 1.0]. The
3496 * bits are according to sampler #, ie. if, for example:
3498 * (conf->saturate_s & (1 << n))
3500 * is true, then the s coord for sampler n is saturated.
3502 * Note that clamping must happen *after* projector lowering
3503 * so any projected texture sample instruction with a clamped
3504 * coordinate gets automatically lowered, regardless of the
3505 * 'lower_txp' setting.
3507 unsigned saturate_s
;
3508 unsigned saturate_t
;
3509 unsigned saturate_r
;
3511 /* Bitmask of textures that need swizzling.
3513 * If (swizzle_result & (1 << texture_index)), then the swizzle in
3514 * swizzles[texture_index] is applied to the result of the texturing
3517 unsigned swizzle_result
;
3519 /* A swizzle for each texture. Values 0-3 represent x, y, z, or w swizzles
3520 * while 4 and 5 represent 0 and 1 respectively.
3522 uint8_t swizzles
[32][4];
3524 /* Can be used to scale sampled values in range required by the format. */
3525 float scale_factors
[32];
3528 * Bitmap of textures that need srgb to linear conversion. If
3529 * (lower_srgb & (1 << texture_index)) then the rgb (xyz) components
3530 * of the texture are lowered to linear.
3532 unsigned lower_srgb
;
3535 * If true, lower nir_texop_tex on shaders that doesn't support implicit
3536 * LODs to nir_texop_txl.
3538 bool lower_tex_without_implicit_lod
;
3541 * If true, lower nir_texop_txd on cube maps with nir_texop_txl.
3543 bool lower_txd_cube_map
;
3546 * If true, lower nir_texop_txd on 3D surfaces with nir_texop_txl.
3551 * If true, lower nir_texop_txd on shadow samplers (except cube maps)
3552 * with nir_texop_txl. Notice that cube map shadow samplers are lowered
3553 * with lower_txd_cube_map.
3555 bool lower_txd_shadow
;
3558 * If true, lower nir_texop_txd on all samplers to a nir_texop_txl.
3559 * Implies lower_txd_cube_map and lower_txd_shadow.
3564 * If true, lower nir_texop_txb that try to use shadow compare and min_lod
3565 * at the same time to a nir_texop_lod, some math, and nir_texop_tex.
3567 bool lower_txb_shadow_clamp
;
3570 * If true, lower nir_texop_txd on shadow samplers when it uses min_lod
3571 * with nir_texop_txl. This includes cube maps.
3573 bool lower_txd_shadow_clamp
;
3576 * If true, lower nir_texop_txd on when it uses both offset and min_lod
3577 * with nir_texop_txl. This includes cube maps.
3579 bool lower_txd_offset_clamp
;
3582 * If true, lower nir_texop_txd with min_lod to a nir_texop_txl if the
3583 * sampler is bindless.
3585 bool lower_txd_clamp_bindless_sampler
;
3588 * If true, lower nir_texop_txd with min_lod to a nir_texop_txl if the
3589 * sampler index is not statically determinable to be less than 16.
3591 bool lower_txd_clamp_if_sampler_index_not_lt_16
;
3594 * If true, lower nir_texop_txs with a non-0-lod into nir_texop_txs with
3595 * 0-lod followed by a nir_ishr.
3600 * If true, apply a .bagr swizzle on tg4 results to handle Broadcom's
3601 * mixed-up tg4 locations.
3603 bool lower_tg4_broadcom_swizzle
;
3606 * If true, lowers tg4 with 4 constant offsets to 4 tg4 calls
3608 bool lower_tg4_offsets
;
3610 enum nir_lower_tex_packing lower_tex_packing
[32];
3611 } nir_lower_tex_options
;
3613 bool nir_lower_tex(nir_shader
*shader
,
3614 const nir_lower_tex_options
*options
);
3616 enum nir_lower_non_uniform_access_type
{
3617 nir_lower_non_uniform_ubo_access
= (1 << 0),
3618 nir_lower_non_uniform_ssbo_access
= (1 << 1),
3619 nir_lower_non_uniform_texture_access
= (1 << 2),
3620 nir_lower_non_uniform_image_access
= (1 << 3),
3623 bool nir_lower_non_uniform_access(nir_shader
*shader
,
3624 enum nir_lower_non_uniform_access_type
);
3626 bool nir_lower_idiv(nir_shader
*shader
);
3628 bool nir_lower_input_attachments(nir_shader
*shader
, bool use_fragcoord_sysval
);
3630 bool nir_lower_clip_vs(nir_shader
*shader
, unsigned ucp_enables
, bool use_vars
);
3631 bool nir_lower_clip_fs(nir_shader
*shader
, unsigned ucp_enables
);
3632 bool nir_lower_clip_cull_distance_arrays(nir_shader
*nir
);
3634 bool nir_lower_frexp(nir_shader
*nir
);
3636 void nir_lower_two_sided_color(nir_shader
*shader
);
3638 bool nir_lower_clamp_color_outputs(nir_shader
*shader
);
3640 void nir_lower_passthrough_edgeflags(nir_shader
*shader
);
3641 bool nir_lower_patch_vertices(nir_shader
*nir
, unsigned static_count
,
3642 const gl_state_index16
*uniform_state_tokens
);
3644 typedef struct nir_lower_wpos_ytransform_options
{
3645 gl_state_index16 state_tokens
[STATE_LENGTH
];
3646 bool fs_coord_origin_upper_left
:1;
3647 bool fs_coord_origin_lower_left
:1;
3648 bool fs_coord_pixel_center_integer
:1;
3649 bool fs_coord_pixel_center_half_integer
:1;
3650 } nir_lower_wpos_ytransform_options
;
3652 bool nir_lower_wpos_ytransform(nir_shader
*shader
,
3653 const nir_lower_wpos_ytransform_options
*options
);
3654 bool nir_lower_wpos_center(nir_shader
*shader
, const bool for_sample_shading
);
3656 bool nir_lower_fb_read(nir_shader
*shader
);
3658 typedef struct nir_lower_drawpixels_options
{
3659 gl_state_index16 texcoord_state_tokens
[STATE_LENGTH
];
3660 gl_state_index16 scale_state_tokens
[STATE_LENGTH
];
3661 gl_state_index16 bias_state_tokens
[STATE_LENGTH
];
3662 unsigned drawpix_sampler
;
3663 unsigned pixelmap_sampler
;
3665 bool scale_and_bias
:1;
3666 } nir_lower_drawpixels_options
;
3668 void nir_lower_drawpixels(nir_shader
*shader
,
3669 const nir_lower_drawpixels_options
*options
);
3671 typedef struct nir_lower_bitmap_options
{
3674 } nir_lower_bitmap_options
;
3676 void nir_lower_bitmap(nir_shader
*shader
, const nir_lower_bitmap_options
*options
);
3678 bool nir_lower_atomics_to_ssbo(nir_shader
*shader
, unsigned ssbo_offset
);
3681 nir_lower_int_source_mods
= 1 << 0,
3682 nir_lower_float_source_mods
= 1 << 1,
3683 nir_lower_triop_abs
= 1 << 2,
3684 nir_lower_all_source_mods
= (1 << 3) - 1
3685 } nir_lower_to_source_mods_flags
;
3688 bool nir_lower_to_source_mods(nir_shader
*shader
, nir_lower_to_source_mods_flags options
);
3690 bool nir_lower_gs_intrinsics(nir_shader
*shader
);
3692 typedef unsigned (*nir_lower_bit_size_callback
)(const nir_alu_instr
*, void *);
3694 bool nir_lower_bit_size(nir_shader
*shader
,
3695 nir_lower_bit_size_callback callback
,
3696 void *callback_data
);
3698 nir_lower_int64_options
nir_lower_int64_op_to_options_mask(nir_op opcode
);
3699 bool nir_lower_int64(nir_shader
*shader
, nir_lower_int64_options options
);
3701 nir_lower_doubles_options
nir_lower_doubles_op_to_options_mask(nir_op opcode
);
3702 bool nir_lower_doubles(nir_shader
*shader
, const nir_shader
*softfp64
,
3703 nir_lower_doubles_options options
);
3704 bool nir_lower_pack(nir_shader
*shader
);
3707 nir_lower_interpolation_at_sample
= (1 << 1),
3708 nir_lower_interpolation_at_offset
= (1 << 2),
3709 nir_lower_interpolation_centroid
= (1 << 3),
3710 nir_lower_interpolation_pixel
= (1 << 4),
3711 nir_lower_interpolation_sample
= (1 << 5),
3712 } nir_lower_interpolation_options
;
3714 bool nir_lower_interpolation(nir_shader
*shader
,
3715 nir_lower_interpolation_options options
);
3717 bool nir_normalize_cubemap_coords(nir_shader
*shader
);
3719 void nir_live_ssa_defs_impl(nir_function_impl
*impl
);
3721 void nir_loop_analyze_impl(nir_function_impl
*impl
,
3722 nir_variable_mode indirect_mask
);
3724 bool nir_ssa_defs_interfere(nir_ssa_def
*a
, nir_ssa_def
*b
);
3726 bool nir_repair_ssa_impl(nir_function_impl
*impl
);
3727 bool nir_repair_ssa(nir_shader
*shader
);
3729 void nir_convert_loop_to_lcssa(nir_loop
*loop
);
3731 /* If phi_webs_only is true, only convert SSA values involved in phi nodes to
3732 * registers. If false, convert all values (even those not involved in a phi
3733 * node) to registers.
3735 bool nir_convert_from_ssa(nir_shader
*shader
, bool phi_webs_only
);
3737 bool nir_lower_phis_to_regs_block(nir_block
*block
);
3738 bool nir_lower_ssa_defs_to_regs_block(nir_block
*block
);
3739 bool nir_rematerialize_derefs_in_use_blocks_impl(nir_function_impl
*impl
);
3741 /* This is here for unit tests. */
3742 bool nir_opt_comparison_pre_impl(nir_function_impl
*impl
);
3744 bool nir_opt_comparison_pre(nir_shader
*shader
);
3746 bool nir_opt_algebraic(nir_shader
*shader
);
3747 bool nir_opt_algebraic_before_ffma(nir_shader
*shader
);
3748 bool nir_opt_algebraic_late(nir_shader
*shader
);
3749 bool nir_opt_constant_folding(nir_shader
*shader
);
3751 bool nir_opt_combine_stores(nir_shader
*shader
, nir_variable_mode modes
);
3753 bool nir_copy_prop(nir_shader
*shader
);
3755 bool nir_opt_copy_prop_vars(nir_shader
*shader
);
3757 bool nir_opt_cse(nir_shader
*shader
);
3759 bool nir_opt_dce(nir_shader
*shader
);
3761 bool nir_opt_dead_cf(nir_shader
*shader
);
3763 bool nir_opt_dead_write_vars(nir_shader
*shader
);
3765 bool nir_opt_deref_impl(nir_function_impl
*impl
);
3766 bool nir_opt_deref(nir_shader
*shader
);
3768 bool nir_opt_find_array_copies(nir_shader
*shader
);
3770 bool nir_opt_gcm(nir_shader
*shader
, bool value_number
);
3772 bool nir_opt_idiv_const(nir_shader
*shader
, unsigned min_bit_size
);
3774 bool nir_opt_if(nir_shader
*shader
, bool aggressive_last_continue
);
3776 bool nir_opt_intrinsics(nir_shader
*shader
);
3778 bool nir_opt_large_constants(nir_shader
*shader
,
3779 glsl_type_size_align_func size_align
,
3780 unsigned threshold
);
3782 bool nir_opt_loop_unroll(nir_shader
*shader
, nir_variable_mode indirect_mask
);
3784 bool nir_opt_move_comparisons(nir_shader
*shader
);
3786 bool nir_opt_move_load_ubo(nir_shader
*shader
);
3788 bool nir_opt_peephole_select(nir_shader
*shader
, unsigned limit
,
3789 bool indirect_load_ok
, bool expensive_alu_ok
);
3791 bool nir_opt_rematerialize_compares(nir_shader
*shader
);
3793 bool nir_opt_remove_phis(nir_shader
*shader
);
3795 bool nir_opt_shrink_load(nir_shader
*shader
);
3797 bool nir_opt_trivial_continues(nir_shader
*shader
);
3799 bool nir_opt_undef(nir_shader
*shader
);
3801 bool nir_opt_vectorize(nir_shader
*shader
);
3803 bool nir_opt_conditional_discard(nir_shader
*shader
);
3805 void nir_strip(nir_shader
*shader
);
3807 void nir_sweep(nir_shader
*shader
);
3809 void nir_remap_dual_slot_attributes(nir_shader
*shader
,
3810 uint64_t *dual_slot_inputs
);
3811 uint64_t nir_get_single_slot_attribs_mask(uint64_t attribs
, uint64_t dual_slot
);
3813 nir_intrinsic_op
nir_intrinsic_from_system_value(gl_system_value val
);
3814 gl_system_value
nir_system_value_from_intrinsic(nir_intrinsic_op intrin
);
3816 bool nir_lower_sincos(nir_shader
*shader
);
3819 nir_variable_is_in_ubo(const nir_variable
*var
)
3821 return (var
->data
.mode
== nir_var_mem_ubo
&&
3822 var
->interface_type
!= NULL
);
3826 nir_variable_is_in_ssbo(const nir_variable
*var
)
3828 return (var
->data
.mode
== nir_var_mem_ssbo
&&
3829 var
->interface_type
!= NULL
);
3833 nir_variable_is_in_block(const nir_variable
*var
)
3835 return nir_variable_is_in_ubo(var
) || nir_variable_is_in_ssbo(var
);