2 * Copyright © 2014 Connor Abbott
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
24 * Connor Abbott (cwabbott0@gmail.com)
30 #include "util/hash_table.h"
32 #include "GL/gl.h" /* GLenum */
33 #include "util/list.h"
34 #include "util/ralloc.h"
36 #include "util/bitset.h"
37 #include "nir_types.h"
38 #include "shader_enums.h"
41 #include "nir_opcodes.h"
48 struct gl_shader_program
;
51 #define NIR_TRUE (~0u)
53 /** Defines a cast function
55 * This macro defines a cast function from in_type to out_type where
56 * out_type is some structure type that contains a field of type out_type.
58 * Note that you have to be a bit careful as the generated cast function
61 #define NIR_DEFINE_CAST(name, in_type, out_type, field) \
62 static inline out_type * \
63 name(const in_type *parent) \
65 return exec_node_data(out_type, parent, field); \
68 struct nir_function_overload
;
75 * Description of built-in state associated with a uniform
77 * \sa nir_variable::state_slots
91 nir_var_shader_storage
,
96 * Data stored in an nir_constant
98 union nir_constant_data
{
105 typedef struct nir_constant
{
107 * Value of the constant.
109 * The field used to back the values supplied by the constant is determined
110 * by the type associated with the \c nir_variable. Constants may be
111 * scalars, vectors, or matrices.
113 union nir_constant_data value
;
115 /* we could get this from the var->type but makes clone *much* easier to
116 * not have to care about the type.
118 unsigned num_elements
;
120 /* Array elements / Structure Fields */
121 struct nir_constant
**elements
;
125 * \brief Layout qualifiers for gl_FragDepth.
127 * The AMD/ARB_conservative_depth extensions allow gl_FragDepth to be redeclared
128 * with a layout qualifier.
131 nir_depth_layout_none
, /**< No depth layout is specified. */
132 nir_depth_layout_any
,
133 nir_depth_layout_greater
,
134 nir_depth_layout_less
,
135 nir_depth_layout_unchanged
139 * Either a uniform, global variable, shader input, or shader output. Based on
140 * ir_variable - it should be easy to translate between the two.
144 struct exec_node node
;
147 * Declared type of the variable
149 const struct glsl_type
*type
;
152 * Declared name of the variable
156 struct nir_variable_data
{
159 * Is the variable read-only?
161 * This is set for variables declared as \c const, shader inputs,
164 unsigned read_only
:1;
168 unsigned invariant
:1;
171 * Storage class of the variable.
173 * \sa nir_variable_mode
175 nir_variable_mode mode
:4;
178 * Interpolation mode for shader inputs / outputs
180 * \sa glsl_interp_qualifier
182 unsigned interpolation
:2;
185 * \name ARB_fragment_coord_conventions
188 unsigned origin_upper_left
:1;
189 unsigned pixel_center_integer
:1;
193 * Was the location explicitly set in the shader?
195 * If the location is explicitly set in the shader, it \b cannot be changed
196 * by the linker or by the API (e.g., calls to \c glBindAttribLocation have
199 unsigned explicit_location
:1;
200 unsigned explicit_index
:1;
203 * Was an initial binding explicitly set in the shader?
205 * If so, constant_initializer contains an integer nir_constant
206 * representing the initial binding point.
208 unsigned explicit_binding
:1;
211 * Does this variable have an initializer?
213 * This is used by the linker to cross-validiate initializers of global
216 unsigned has_initializer
:1;
219 * Is this variable a generic output or input that has not yet been matched
220 * up to a variable in another stage of the pipeline?
222 * This is used by the linker as scratch storage while assigning locations
223 * to generic inputs and outputs.
225 unsigned is_unmatched_generic_inout
:1;
228 * If non-zero, then this variable may be packed along with other variables
229 * into a single varying slot, so this offset should be applied when
230 * accessing components. For example, an offset of 1 means that the x
231 * component of this variable is actually stored in component y of the
232 * location specified by \c location.
234 unsigned location_frac
:2;
237 * Non-zero if this variable was created by lowering a named interface
238 * block which was not an array.
240 * Note that this variable and \c from_named_ifc_block_array will never
243 unsigned from_named_ifc_block_nonarray
:1;
246 * Non-zero if this variable was created by lowering a named interface
247 * block which was an array.
249 * Note that this variable and \c from_named_ifc_block_nonarray will never
252 unsigned from_named_ifc_block_array
:1;
255 * \brief Layout qualifier for gl_FragDepth.
257 * This is not equal to \c ir_depth_layout_none if and only if this
258 * variable is \c gl_FragDepth and a layout qualifier is specified.
260 nir_depth_layout depth_layout
;
263 * Storage location of the base of this variable
265 * The precise meaning of this field depends on the nature of the variable.
267 * - Vertex shader input: one of the values from \c gl_vert_attrib.
268 * - Vertex shader output: one of the values from \c gl_varying_slot.
269 * - Geometry shader input: one of the values from \c gl_varying_slot.
270 * - Geometry shader output: one of the values from \c gl_varying_slot.
271 * - Fragment shader input: one of the values from \c gl_varying_slot.
272 * - Fragment shader output: one of the values from \c gl_frag_result.
273 * - Uniforms: Per-stage uniform slot number for default uniform block.
274 * - Uniforms: Index within the uniform block definition for UBO members.
275 * - Non-UBO Uniforms: uniform slot number.
276 * - Other: This field is not currently used.
278 * If the variable is a uniform, shader input, or shader output, and the
279 * slot has not been assigned, the value will be -1.
284 * The actual location of the variable in the IR. Only valid for inputs
287 unsigned int driver_location
;
290 * output index for dual source blending.
295 * Initial binding point for a sampler or UBO.
297 * For array types, this represents the binding point for the first element.
302 * Location an atomic counter is stored at.
309 * ARB_shader_image_load_store qualifiers.
312 bool read_only
; /**< "readonly" qualifier. */
313 bool write_only
; /**< "writeonly" qualifier. */
318 /** Image internal format if specified explicitly, otherwise GL_NONE. */
323 * Highest element accessed with a constant expression array index
325 * Not used for non-array variables.
327 unsigned max_array_access
;
332 * Built-in state that backs this uniform
334 * Once set at variable creation, \c state_slots must remain invariant.
335 * This is because, ideally, this array would be shared by all clones of
336 * this variable in the IR tree. In other words, we'd really like for it
337 * to be a fly-weight.
339 * If the variable is not a uniform, \c num_state_slots will be zero and
340 * \c state_slots will be \c NULL.
343 unsigned num_state_slots
; /**< Number of state slots used */
344 nir_state_slot
*state_slots
; /**< State descriptors. */
348 * Constant expression assigned in the initializer of the variable
350 nir_constant
*constant_initializer
;
353 * For variables that are in an interface block or are an instance of an
354 * interface block, this is the \c GLSL_TYPE_INTERFACE type for that block.
356 * \sa ir_variable::location
358 const struct glsl_type
*interface_type
;
361 #define nir_foreach_variable(var, var_list) \
362 foreach_list_typed(nir_variable, var, node, var_list)
365 struct exec_node node
;
367 unsigned num_components
; /** < number of vector components */
368 unsigned num_array_elems
; /** < size of array (0 for no array) */
370 /** generic register index. */
373 /** only for debug purposes, can be NULL */
376 /** whether this register is local (per-function) or global (per-shader) */
380 * If this flag is set to true, then accessing channels >= num_components
381 * is well-defined, and simply spills over to the next array element. This
382 * is useful for backends that can do per-component accessing, in
383 * particular scalar backends. By setting this flag and making
384 * num_components equal to 1, structures can be packed tightly into
385 * registers and then registers can be accessed per-component to get to
386 * each structure member, even if it crosses vec4 boundaries.
390 /** set of nir_src's where this register is used (read from) */
391 struct list_head uses
;
393 /** set of nir_dest's where this register is defined (written to) */
394 struct list_head defs
;
396 /** set of nir_if's where this register is used as a condition */
397 struct list_head if_uses
;
404 nir_instr_type_intrinsic
,
405 nir_instr_type_load_const
,
407 nir_instr_type_ssa_undef
,
409 nir_instr_type_parallel_copy
,
412 typedef struct nir_instr
{
413 struct exec_node node
;
415 struct nir_block
*block
;
417 /** generic instruction index. */
420 /* A temporary for optimization and analysis passes to use for storing
421 * flags. For instance, DCE uses this to store the "dead/live" info.
426 static inline nir_instr
*
427 nir_instr_next(nir_instr
*instr
)
429 struct exec_node
*next
= exec_node_get_next(&instr
->node
);
430 if (exec_node_is_tail_sentinel(next
))
433 return exec_node_data(nir_instr
, next
, node
);
436 static inline nir_instr
*
437 nir_instr_prev(nir_instr
*instr
)
439 struct exec_node
*prev
= exec_node_get_prev(&instr
->node
);
440 if (exec_node_is_head_sentinel(prev
))
443 return exec_node_data(nir_instr
, prev
, node
);
447 nir_instr_is_first(nir_instr
*instr
)
449 return exec_node_is_head_sentinel(exec_node_get_prev(&instr
->node
));
453 nir_instr_is_last(nir_instr
*instr
)
455 return exec_node_is_tail_sentinel(exec_node_get_next(&instr
->node
));
459 /** for debugging only, can be NULL */
462 /** generic SSA definition index. */
465 /** Index into the live_in and live_out bitfields */
468 nir_instr
*parent_instr
;
470 /** set of nir_instr's where this register is used (read from) */
471 struct list_head uses
;
473 /** set of nir_if's where this register is used as a condition */
474 struct list_head if_uses
;
476 uint8_t num_components
;
483 struct nir_src
*indirect
; /** < NULL for no indirect offset */
484 unsigned base_offset
;
486 /* TODO use-def chain goes here */
490 nir_instr
*parent_instr
;
491 struct list_head def_link
;
494 struct nir_src
*indirect
; /** < NULL for no indirect offset */
495 unsigned base_offset
;
497 /* TODO def-use chain goes here */
502 typedef struct nir_src
{
504 nir_instr
*parent_instr
;
505 struct nir_if
*parent_if
;
508 struct list_head use_link
;
518 #define NIR_SRC_INIT (nir_src) { { NULL } }
520 #define nir_foreach_use(reg_or_ssa_def, src) \
521 list_for_each_entry(nir_src, src, &(reg_or_ssa_def)->uses, use_link)
523 #define nir_foreach_use_safe(reg_or_ssa_def, src) \
524 list_for_each_entry_safe(nir_src, src, &(reg_or_ssa_def)->uses, use_link)
526 #define nir_foreach_if_use(reg_or_ssa_def, src) \
527 list_for_each_entry(nir_src, src, &(reg_or_ssa_def)->if_uses, use_link)
529 #define nir_foreach_if_use_safe(reg_or_ssa_def, src) \
530 list_for_each_entry_safe(nir_src, src, &(reg_or_ssa_def)->if_uses, use_link)
541 #define NIR_DEST_INIT (nir_dest) { { { NULL } } }
543 #define nir_foreach_def(reg, dest) \
544 list_for_each_entry(nir_dest, dest, &(reg)->defs, reg.def_link)
546 #define nir_foreach_def_safe(reg, dest) \
547 list_for_each_entry_safe(nir_dest, dest, &(reg)->defs, reg.def_link)
549 static inline nir_src
550 nir_src_for_ssa(nir_ssa_def
*def
)
552 nir_src src
= NIR_SRC_INIT
;
560 static inline nir_src
561 nir_src_for_reg(nir_register
*reg
)
563 nir_src src
= NIR_SRC_INIT
;
567 src
.reg
.indirect
= NULL
;
568 src
.reg
.base_offset
= 0;
573 static inline nir_dest
574 nir_dest_for_reg(nir_register
*reg
)
576 nir_dest dest
= NIR_DEST_INIT
;
583 void nir_src_copy(nir_src
*dest
, const nir_src
*src
, void *instr_or_if
);
584 void nir_dest_copy(nir_dest
*dest
, const nir_dest
*src
, nir_instr
*instr
);
590 * \name input modifiers
594 * For inputs interpreted as floating point, flips the sign bit. For
595 * inputs interpreted as integers, performs the two's complement negation.
600 * Clears the sign bit for floating point values, and computes the integer
601 * absolute value for integers. Note that the negate modifier acts after
602 * the absolute value modifier, therefore if both are set then all inputs
603 * will become negative.
609 * For each input component, says which component of the register it is
610 * chosen from. Note that which elements of the swizzle are used and which
611 * are ignored are based on the write mask for most opcodes - for example,
612 * a statement like "foo.xzw = bar.zyx" would have a writemask of 1101b and
613 * a swizzle of {2, x, 1, 0} where x means "don't care."
622 * \name saturate output modifier
624 * Only valid for opcodes that output floating-point numbers. Clamps the
625 * output to between 0.0 and 1.0 inclusive.
630 unsigned write_mask
: 4; /* ignored if dest.is_ssa is true */
634 nir_type_invalid
= 0, /* Not a valid type */
642 NIR_OP_IS_COMMUTATIVE
= (1 << 0),
643 NIR_OP_IS_ASSOCIATIVE
= (1 << 1),
644 } nir_op_algebraic_property
;
652 * The number of components in the output
654 * If non-zero, this is the size of the output and input sizes are
655 * explicitly given; swizzle and writemask are still in effect, but if
656 * the output component is masked out, then the input component may
659 * If zero, the opcode acts in the standard, per-component manner; the
660 * operation is performed on each component (except the ones that are
661 * masked out) with the input being taken from the input swizzle for
664 * The size of some of the inputs may be given (i.e. non-zero) even
665 * though output_size is zero; in that case, the inputs with a zero
666 * size act per-component, while the inputs with non-zero size don't.
668 unsigned output_size
;
671 * The type of vector that the instruction outputs. Note that the
672 * staurate modifier is only allowed on outputs with the float type.
675 nir_alu_type output_type
;
678 * The number of components in each input
680 unsigned input_sizes
[4];
683 * The type of vector that each input takes. Note that negate and
684 * absolute value are only allowed on inputs with int or float type and
685 * behave differently on the two.
687 nir_alu_type input_types
[4];
689 nir_op_algebraic_property algebraic_properties
;
692 extern const nir_op_info nir_op_infos
[nir_num_opcodes
];
694 typedef struct nir_alu_instr
{
701 void nir_alu_src_copy(nir_alu_src
*dest
, const nir_alu_src
*src
,
702 nir_alu_instr
*instr
);
703 void nir_alu_dest_copy(nir_alu_dest
*dest
, const nir_alu_dest
*src
,
704 nir_alu_instr
*instr
);
706 /* is this source channel used? */
708 nir_alu_instr_channel_used(nir_alu_instr
*instr
, unsigned src
, unsigned channel
)
710 if (nir_op_infos
[instr
->op
].input_sizes
[src
] > 0)
711 return channel
< nir_op_infos
[instr
->op
].input_sizes
[src
];
713 return (instr
->dest
.write_mask
>> channel
) & 1;
717 * For instructions whose destinations are SSA, get the number of channels
720 static inline unsigned
721 nir_ssa_alu_instr_src_components(const nir_alu_instr
*instr
, unsigned src
)
723 assert(instr
->dest
.dest
.is_ssa
);
725 if (nir_op_infos
[instr
->op
].input_sizes
[src
] > 0)
726 return nir_op_infos
[instr
->op
].input_sizes
[src
];
728 return instr
->dest
.dest
.ssa
.num_components
;
733 nir_deref_type_array
,
734 nir_deref_type_struct
737 typedef struct nir_deref
{
738 nir_deref_type deref_type
;
739 struct nir_deref
*child
;
740 const struct glsl_type
*type
;
749 /* This enum describes how the array is referenced. If the deref is
750 * direct then the base_offset is used. If the deref is indirect then then
751 * offset is given by base_offset + indirect. If the deref is a wildcard
752 * then the deref refers to all of the elements of the array at the same
753 * time. Wildcard dereferences are only ever allowed in copy_var
754 * intrinsics and the source and destination derefs must have matching
758 nir_deref_array_type_direct
,
759 nir_deref_array_type_indirect
,
760 nir_deref_array_type_wildcard
,
761 } nir_deref_array_type
;
766 nir_deref_array_type deref_array_type
;
767 unsigned base_offset
;
777 NIR_DEFINE_CAST(nir_deref_as_var
, nir_deref
, nir_deref_var
, deref
)
778 NIR_DEFINE_CAST(nir_deref_as_array
, nir_deref
, nir_deref_array
, deref
)
779 NIR_DEFINE_CAST(nir_deref_as_struct
, nir_deref
, nir_deref_struct
, deref
)
781 /* Returns the last deref in the chain. */
782 static inline nir_deref
*
783 nir_deref_tail(nir_deref
*deref
)
786 deref
= deref
->child
;
794 nir_deref_var
**params
;
795 nir_deref_var
*return_deref
;
797 struct nir_function_overload
*callee
;
800 #define INTRINSIC(name, num_srcs, src_components, has_dest, dest_components, \
801 num_variables, num_indices, flags) \
802 nir_intrinsic_##name,
804 #define LAST_INTRINSIC(name) nir_last_intrinsic = nir_intrinsic_##name,
807 #include "nir_intrinsics.h"
808 nir_num_intrinsics
= nir_last_intrinsic
+ 1
812 #undef LAST_INTRINSIC
814 /** Represents an intrinsic
816 * An intrinsic is an instruction type for handling things that are
817 * more-or-less regular operations but don't just consume and produce SSA
818 * values like ALU operations do. Intrinsics are not for things that have
819 * special semantic meaning such as phi nodes and parallel copies.
820 * Examples of intrinsics include variable load/store operations, system
821 * value loads, and the like. Even though texturing more-or-less falls
822 * under this category, texturing is its own instruction type because
823 * trying to represent texturing with intrinsics would lead to a
824 * combinatorial explosion of intrinsic opcodes.
826 * By having a single instruction type for handling a lot of different
827 * cases, optimization passes can look for intrinsics and, for the most
828 * part, completely ignore them. Each intrinsic type also has a few
829 * possible flags that govern whether or not they can be reordered or
830 * eliminated. That way passes like dead code elimination can still work
831 * on intrisics without understanding the meaning of each.
833 * Each intrinsic has some number of constant indices, some number of
834 * variables, and some number of sources. What these sources, variables,
835 * and indices mean depends on the intrinsic and is documented with the
836 * intrinsic declaration in nir_intrinsics.h. Intrinsics and texture
837 * instructions are the only types of instruction that can operate on
843 nir_intrinsic_op intrinsic
;
847 /** number of components if this is a vectorized intrinsic
849 * Similarly to ALU operations, some intrinsics are vectorized.
850 * An intrinsic is vectorized if nir_intrinsic_infos.dest_components == 0.
851 * For vectorized intrinsics, the num_components field specifies the
852 * number of destination components and the number of source components
853 * for all sources with nir_intrinsic_infos.src_components[i] == 0.
855 uint8_t num_components
;
859 nir_deref_var
*variables
[2];
862 } nir_intrinsic_instr
;
865 * \name NIR intrinsics semantic flags
867 * information about what the compiler can do with the intrinsics.
869 * \sa nir_intrinsic_info::flags
873 * whether the intrinsic can be safely eliminated if none of its output
874 * value is not being used.
876 NIR_INTRINSIC_CAN_ELIMINATE
= (1 << 0),
879 * Whether the intrinsic can be reordered with respect to any other
880 * intrinsic, i.e. whether the only reordering dependencies of the
881 * intrinsic are due to the register reads/writes.
883 NIR_INTRINSIC_CAN_REORDER
= (1 << 1),
884 } nir_intrinsic_semantic_flag
;
886 #define NIR_INTRINSIC_MAX_INPUTS 4
891 unsigned num_srcs
; /** < number of register/SSA inputs */
893 /** number of components of each input register
895 * If this value is 0, the number of components is given by the
896 * num_components field of nir_intrinsic_instr.
898 unsigned src_components
[NIR_INTRINSIC_MAX_INPUTS
];
902 /** number of components of the output register
904 * If this value is 0, the number of components is given by the
905 * num_components field of nir_intrinsic_instr.
907 unsigned dest_components
;
909 /** the number of inputs/outputs that are variables */
910 unsigned num_variables
;
912 /** the number of constant indices used by the intrinsic */
913 unsigned num_indices
;
915 /** semantic flags for calls to this intrinsic */
916 nir_intrinsic_semantic_flag flags
;
917 } nir_intrinsic_info
;
919 extern const nir_intrinsic_info nir_intrinsic_infos
[nir_num_intrinsics
];
922 * \group texture information
924 * This gives semantic information about textures which is useful to the
925 * frontend, the backend, and lowering passes, but not the optimizer.
930 nir_tex_src_projector
,
931 nir_tex_src_comparitor
, /* shadow comparitor */
935 nir_tex_src_ms_index
, /* MSAA sample index */
938 nir_tex_src_sampler_offset
, /* < dynamically uniform indirect offset */
939 nir_num_tex_src_types
944 nir_tex_src_type src_type
;
948 nir_texop_tex
, /**< Regular texture look-up */
949 nir_texop_txb
, /**< Texture look-up with LOD bias */
950 nir_texop_txl
, /**< Texture look-up with explicit LOD */
951 nir_texop_txd
, /**< Texture look-up with partial derivatvies */
952 nir_texop_txf
, /**< Texel fetch with explicit LOD */
953 nir_texop_txf_ms
, /**< Multisample texture fetch */
954 nir_texop_txs
, /**< Texture size */
955 nir_texop_lod
, /**< Texture lod query */
956 nir_texop_tg4
, /**< Texture gather */
957 nir_texop_query_levels
, /**< Texture levels query */
958 nir_texop_texture_samples
, /**< Texture samples query */
964 enum glsl_sampler_dim sampler_dim
;
965 nir_alu_type dest_type
;
970 unsigned num_srcs
, coord_components
;
971 bool is_array
, is_shadow
;
974 * If is_shadow is true, whether this is the old-style shadow that outputs 4
975 * components or the new-style shadow that outputs 1 component.
977 bool is_new_style_shadow
;
979 /* constant offset - must be 0 if the offset source is used */
982 /* gather component selector */
983 unsigned component
: 2;
985 /** The sampler index
987 * If this texture instruction has a nir_tex_src_sampler_offset source,
988 * then the sampler index is given by sampler_index + sampler_offset.
990 unsigned sampler_index
;
992 /** The size of the sampler array or 0 if it's not an array */
993 unsigned sampler_array_size
;
995 nir_deref_var
*sampler
; /* if this is NULL, use sampler_index instead */
998 static inline unsigned
999 nir_tex_instr_dest_size(nir_tex_instr
*instr
)
1001 switch (instr
->op
) {
1002 case nir_texop_txs
: {
1004 switch (instr
->sampler_dim
) {
1005 case GLSL_SAMPLER_DIM_1D
:
1006 case GLSL_SAMPLER_DIM_BUF
:
1009 case GLSL_SAMPLER_DIM_2D
:
1010 case GLSL_SAMPLER_DIM_CUBE
:
1011 case GLSL_SAMPLER_DIM_MS
:
1012 case GLSL_SAMPLER_DIM_RECT
:
1013 case GLSL_SAMPLER_DIM_EXTERNAL
:
1016 case GLSL_SAMPLER_DIM_3D
:
1020 unreachable("not reached");
1022 if (instr
->is_array
)
1030 case nir_texop_texture_samples
:
1031 case nir_texop_query_levels
:
1035 if (instr
->is_shadow
&& instr
->is_new_style_shadow
)
1042 static inline unsigned
1043 nir_tex_instr_src_size(nir_tex_instr
*instr
, unsigned src
)
1045 if (instr
->src
[src
].src_type
== nir_tex_src_coord
)
1046 return instr
->coord_components
;
1049 if (instr
->src
[src
].src_type
== nir_tex_src_offset
||
1050 instr
->src
[src
].src_type
== nir_tex_src_ddx
||
1051 instr
->src
[src
].src_type
== nir_tex_src_ddy
) {
1052 if (instr
->is_array
)
1053 return instr
->coord_components
- 1;
1055 return instr
->coord_components
;
1062 nir_tex_instr_src_index(nir_tex_instr
*instr
, nir_tex_src_type type
)
1064 for (unsigned i
= 0; i
< instr
->num_srcs
; i
++)
1065 if (instr
->src
[i
].src_type
== type
)
1082 nir_const_value value
;
1085 } nir_load_const_instr
;
1098 /* creates a new SSA variable in an undefined state */
1103 } nir_ssa_undef_instr
;
1106 struct exec_node node
;
1108 /* The predecessor block corresponding to this source */
1109 struct nir_block
*pred
;
1114 #define nir_foreach_phi_src(phi, entry) \
1115 foreach_list_typed(nir_phi_src, entry, node, &(phi)->srcs)
1116 #define nir_foreach_phi_src_safe(phi, entry) \
1117 foreach_list_typed_safe(nir_phi_src, entry, node, &(phi)->srcs)
1122 struct exec_list srcs
; /** < list of nir_phi_src */
1128 struct exec_node node
;
1131 } nir_parallel_copy_entry
;
1133 #define nir_foreach_parallel_copy_entry(pcopy, entry) \
1134 foreach_list_typed(nir_parallel_copy_entry, entry, node, &(pcopy)->entries)
1139 /* A list of nir_parallel_copy_entry's. The sources of all of the
1140 * entries are copied to the corresponding destinations "in parallel".
1141 * In other words, if we have two entries: a -> b and b -> a, the values
1144 struct exec_list entries
;
1145 } nir_parallel_copy_instr
;
1147 NIR_DEFINE_CAST(nir_instr_as_alu
, nir_instr
, nir_alu_instr
, instr
)
1148 NIR_DEFINE_CAST(nir_instr_as_call
, nir_instr
, nir_call_instr
, instr
)
1149 NIR_DEFINE_CAST(nir_instr_as_jump
, nir_instr
, nir_jump_instr
, instr
)
1150 NIR_DEFINE_CAST(nir_instr_as_tex
, nir_instr
, nir_tex_instr
, instr
)
1151 NIR_DEFINE_CAST(nir_instr_as_intrinsic
, nir_instr
, nir_intrinsic_instr
, instr
)
1152 NIR_DEFINE_CAST(nir_instr_as_load_const
, nir_instr
, nir_load_const_instr
, instr
)
1153 NIR_DEFINE_CAST(nir_instr_as_ssa_undef
, nir_instr
, nir_ssa_undef_instr
, instr
)
1154 NIR_DEFINE_CAST(nir_instr_as_phi
, nir_instr
, nir_phi_instr
, instr
)
1155 NIR_DEFINE_CAST(nir_instr_as_parallel_copy
, nir_instr
,
1156 nir_parallel_copy_instr
, instr
)
1161 * Control flow consists of a tree of control flow nodes, which include
1162 * if-statements and loops. The leaves of the tree are basic blocks, lists of
1163 * instructions that always run start-to-finish. Each basic block also keeps
1164 * track of its successors (blocks which may run immediately after the current
1165 * block) and predecessors (blocks which could have run immediately before the
1166 * current block). Each function also has a start block and an end block which
1167 * all return statements point to (which is always empty). Together, all the
1168 * blocks with their predecessors and successors make up the control flow
1169 * graph (CFG) of the function. There are helpers that modify the tree of
1170 * control flow nodes while modifying the CFG appropriately; these should be
1171 * used instead of modifying the tree directly.
1178 nir_cf_node_function
1181 typedef struct nir_cf_node
{
1182 struct exec_node node
;
1183 nir_cf_node_type type
;
1184 struct nir_cf_node
*parent
;
1187 typedef struct nir_block
{
1188 nir_cf_node cf_node
;
1190 struct exec_list instr_list
; /** < list of nir_instr */
1192 /** generic block index; generated by nir_index_blocks */
1196 * Each block can only have up to 2 successors, so we put them in a simple
1197 * array - no need for anything more complicated.
1199 struct nir_block
*successors
[2];
1201 /* Set of nir_block predecessors in the CFG */
1202 struct set
*predecessors
;
1205 * this node's immediate dominator in the dominance tree - set to NULL for
1208 struct nir_block
*imm_dom
;
1210 /* This node's children in the dominance tree */
1211 unsigned num_dom_children
;
1212 struct nir_block
**dom_children
;
1214 /* Set of nir_block's on the dominance frontier of this block */
1215 struct set
*dom_frontier
;
1218 * These two indices have the property that dom_{pre,post}_index for each
1219 * child of this block in the dominance tree will always be between
1220 * dom_pre_index and dom_post_index for this block, which makes testing if
1221 * a given block is dominated by another block an O(1) operation.
1223 unsigned dom_pre_index
, dom_post_index
;
1225 /* live in and out for this block; used for liveness analysis */
1226 BITSET_WORD
*live_in
;
1227 BITSET_WORD
*live_out
;
1230 static inline nir_instr
*
1231 nir_block_first_instr(nir_block
*block
)
1233 struct exec_node
*head
= exec_list_get_head(&block
->instr_list
);
1234 return exec_node_data(nir_instr
, head
, node
);
1237 static inline nir_instr
*
1238 nir_block_last_instr(nir_block
*block
)
1240 struct exec_node
*tail
= exec_list_get_tail(&block
->instr_list
);
1241 return exec_node_data(nir_instr
, tail
, node
);
1244 #define nir_foreach_instr(block, instr) \
1245 foreach_list_typed(nir_instr, instr, node, &(block)->instr_list)
1246 #define nir_foreach_instr_reverse(block, instr) \
1247 foreach_list_typed_reverse(nir_instr, instr, node, &(block)->instr_list)
1248 #define nir_foreach_instr_safe(block, instr) \
1249 foreach_list_typed_safe(nir_instr, instr, node, &(block)->instr_list)
1250 #define nir_foreach_instr_safe_reverse(block, instr) \
1251 foreach_list_typed_safe_reverse(nir_instr, instr, node, &(block)->instr_list)
1253 typedef struct nir_if
{
1254 nir_cf_node cf_node
;
1257 struct exec_list then_list
; /** < list of nir_cf_node */
1258 struct exec_list else_list
; /** < list of nir_cf_node */
1261 static inline nir_cf_node
*
1262 nir_if_first_then_node(nir_if
*if_stmt
)
1264 struct exec_node
*head
= exec_list_get_head(&if_stmt
->then_list
);
1265 return exec_node_data(nir_cf_node
, head
, node
);
1268 static inline nir_cf_node
*
1269 nir_if_last_then_node(nir_if
*if_stmt
)
1271 struct exec_node
*tail
= exec_list_get_tail(&if_stmt
->then_list
);
1272 return exec_node_data(nir_cf_node
, tail
, node
);
1275 static inline nir_cf_node
*
1276 nir_if_first_else_node(nir_if
*if_stmt
)
1278 struct exec_node
*head
= exec_list_get_head(&if_stmt
->else_list
);
1279 return exec_node_data(nir_cf_node
, head
, node
);
1282 static inline nir_cf_node
*
1283 nir_if_last_else_node(nir_if
*if_stmt
)
1285 struct exec_node
*tail
= exec_list_get_tail(&if_stmt
->else_list
);
1286 return exec_node_data(nir_cf_node
, tail
, node
);
1290 nir_cf_node cf_node
;
1292 struct exec_list body
; /** < list of nir_cf_node */
1295 static inline nir_cf_node
*
1296 nir_loop_first_cf_node(nir_loop
*loop
)
1298 return exec_node_data(nir_cf_node
, exec_list_get_head(&loop
->body
), node
);
1301 static inline nir_cf_node
*
1302 nir_loop_last_cf_node(nir_loop
*loop
)
1304 return exec_node_data(nir_cf_node
, exec_list_get_tail(&loop
->body
), node
);
1308 * Various bits of metadata that can may be created or required by
1309 * optimization and analysis passes
1312 nir_metadata_none
= 0x0,
1313 nir_metadata_block_index
= 0x1,
1314 nir_metadata_dominance
= 0x2,
1315 nir_metadata_live_ssa_defs
= 0x4,
1316 nir_metadata_not_properly_reset
= 0x8,
1320 nir_cf_node cf_node
;
1322 /** pointer to the overload of which this is an implementation */
1323 struct nir_function_overload
*overload
;
1325 struct exec_list body
; /** < list of nir_cf_node */
1327 nir_block
*end_block
;
1329 /** list for all local variables in the function */
1330 struct exec_list locals
;
1332 /** array of variables used as parameters */
1333 unsigned num_params
;
1334 nir_variable
**params
;
1336 /** variable used to hold the result of the function */
1337 nir_variable
*return_var
;
1339 /** list of local registers in the function */
1340 struct exec_list registers
;
1342 /** next available local register index */
1345 /** next available SSA value index */
1348 /* total number of basic blocks, only valid when block_index_dirty = false */
1349 unsigned num_blocks
;
1351 nir_metadata valid_metadata
;
1352 } nir_function_impl
;
1354 static inline nir_block
*
1355 nir_start_block(nir_function_impl
*impl
)
1357 return (nir_block
*) exec_list_get_head(&impl
->body
);
1360 static inline nir_cf_node
*
1361 nir_cf_node_next(nir_cf_node
*node
)
1363 struct exec_node
*next
= exec_node_get_next(&node
->node
);
1364 if (exec_node_is_tail_sentinel(next
))
1367 return exec_node_data(nir_cf_node
, next
, node
);
1370 static inline nir_cf_node
*
1371 nir_cf_node_prev(nir_cf_node
*node
)
1373 struct exec_node
*prev
= exec_node_get_prev(&node
->node
);
1374 if (exec_node_is_head_sentinel(prev
))
1377 return exec_node_data(nir_cf_node
, prev
, node
);
1381 nir_cf_node_is_first(const nir_cf_node
*node
)
1383 return exec_node_is_head_sentinel(node
->node
.prev
);
1387 nir_cf_node_is_last(const nir_cf_node
*node
)
1389 return exec_node_is_tail_sentinel(node
->node
.next
);
1392 NIR_DEFINE_CAST(nir_cf_node_as_block
, nir_cf_node
, nir_block
, cf_node
)
1393 NIR_DEFINE_CAST(nir_cf_node_as_if
, nir_cf_node
, nir_if
, cf_node
)
1394 NIR_DEFINE_CAST(nir_cf_node_as_loop
, nir_cf_node
, nir_loop
, cf_node
)
1395 NIR_DEFINE_CAST(nir_cf_node_as_function
, nir_cf_node
, nir_function_impl
, cf_node
)
1400 nir_parameter_inout
,
1401 } nir_parameter_type
;
1404 nir_parameter_type param_type
;
1405 const struct glsl_type
*type
;
1408 typedef struct nir_function_overload
{
1409 struct exec_node node
;
1411 unsigned num_params
;
1412 nir_parameter
*params
;
1413 const struct glsl_type
*return_type
;
1415 nir_function_impl
*impl
; /** < NULL if the overload is only declared yet */
1417 /** pointer to the function of which this is an overload */
1418 struct nir_function
*function
;
1419 } nir_function_overload
;
1421 typedef struct nir_function
{
1422 struct exec_node node
;
1424 struct exec_list overload_list
; /** < list of nir_function_overload */
1426 struct nir_shader
*shader
;
1429 #define nir_function_first_overload(func) \
1430 exec_node_data(nir_function_overload, \
1431 exec_list_get_head(&(func)->overload_list), node)
1433 typedef struct nir_shader_compiler_options
{
1439 /** lowers fneg and ineg to fsub and isub. */
1441 /** lowers fsub and isub to fadd+fneg and iadd+ineg. */
1444 /* lower {slt,sge,seq,sne} to {flt,fge,feq,fne} + b2f: */
1447 /* Does the native fdot instruction replicate its result for four
1448 * components? If so, then opt_algebraic_late will turn all fdotN
1449 * instructions into fdot_replicatedN instructions.
1451 bool fdot_replicates
;
1453 /** lowers ffract to fsub+ffloor: */
1457 * Does the driver support real 32-bit integers? (Otherwise, integers
1458 * are simulated by floats.)
1460 bool native_integers
;
1461 } nir_shader_compiler_options
;
1463 typedef struct nir_shader_info
{
1466 /* Descriptive name provided by the client; may be NULL */
1469 /* Number of textures used by this shader */
1470 unsigned num_textures
;
1471 /* Number of uniform buffers used by this shader */
1473 /* Number of atomic buffers used by this shader */
1475 /* Number of shader storage buffers used by this shader */
1477 /* Number of images used by this shader */
1478 unsigned num_images
;
1480 /* Which inputs are actually read */
1481 uint64_t inputs_read
;
1482 /* Which outputs are actually written */
1483 uint64_t outputs_written
;
1484 /* Which system values are actually read */
1485 uint64_t system_values_read
;
1487 /* Which patch inputs are actually read */
1488 uint32_t patch_inputs_read
;
1489 /* Which patch outputs are actually written */
1490 uint32_t patch_outputs_written
;
1492 /* Whether or not this shader ever uses textureGather() */
1493 bool uses_texture_gather
;
1495 /* Whether or not this shader uses the gl_ClipDistance output */
1496 bool uses_clip_distance_out
;
1498 /* Whether or not separate shader objects were used */
1499 bool separate_shader
;
1501 /** Was this shader linked with any transform feedback varyings? */
1502 bool has_transform_feedback_varyings
;
1506 /** The number of vertices recieves per input primitive */
1507 unsigned vertices_in
;
1509 /** The output primitive type (GL enum value) */
1510 unsigned output_primitive
;
1512 /** The maximum number of vertices the geometry shader might write. */
1513 unsigned vertices_out
;
1515 /** 1 .. MAX_GEOMETRY_SHADER_INVOCATIONS */
1516 unsigned invocations
;
1518 /** Whether or not this shader uses EndPrimitive */
1519 bool uses_end_primitive
;
1521 /** Whether or not this shader uses non-zero streams */
1529 * Whether early fragment tests are enabled as defined by
1530 * ARB_shader_image_load_store.
1532 bool early_fragment_tests
;
1534 /** gl_FragDepth layout for ARB_conservative_depth. */
1535 enum gl_frag_depth_layout depth_layout
;
1539 unsigned local_size
[3];
1543 /** The number of vertices in the TCS output patch. */
1544 unsigned vertices_out
;
1549 typedef struct nir_shader
{
1550 /** list of uniforms (nir_variable) */
1551 struct exec_list uniforms
;
1553 /** list of inputs (nir_variable) */
1554 struct exec_list inputs
;
1556 /** list of outputs (nir_variable) */
1557 struct exec_list outputs
;
1559 /** Set of driver-specific options for the shader.
1561 * The memory for the options is expected to be kept in a single static
1562 * copy by the driver.
1564 const struct nir_shader_compiler_options
*options
;
1566 /** Various bits of compile-time information about a given shader */
1567 struct nir_shader_info info
;
1569 /** list of global variables in the shader (nir_variable) */
1570 struct exec_list globals
;
1572 /** list of system value variables in the shader (nir_variable) */
1573 struct exec_list system_values
;
1575 struct exec_list functions
; /** < list of nir_function */
1577 /** list of global register in the shader */
1578 struct exec_list registers
;
1580 /** next available global register index */
1584 * the highest index a load_input_*, load_uniform_*, etc. intrinsic can
1587 unsigned num_inputs
, num_uniforms
, num_outputs
;
1589 /** The shader stage, such as MESA_SHADER_VERTEX. */
1590 gl_shader_stage stage
;
1593 #define nir_foreach_overload(shader, overload) \
1594 foreach_list_typed(nir_function, func, node, &(shader)->functions) \
1595 foreach_list_typed(nir_function_overload, overload, node, \
1596 &(func)->overload_list)
1598 nir_shader
*nir_shader_create(void *mem_ctx
,
1599 gl_shader_stage stage
,
1600 const nir_shader_compiler_options
*options
);
1602 /** creates a register, including assigning it an index and adding it to the list */
1603 nir_register
*nir_global_reg_create(nir_shader
*shader
);
1605 nir_register
*nir_local_reg_create(nir_function_impl
*impl
);
1607 void nir_reg_remove(nir_register
*reg
);
1609 /** Adds a variable to the appropreate list in nir_shader */
1610 void nir_shader_add_variable(nir_shader
*shader
, nir_variable
*var
);
1613 nir_function_impl_add_variable(nir_function_impl
*impl
, nir_variable
*var
)
1615 assert(var
->data
.mode
== nir_var_local
);
1616 exec_list_push_tail(&impl
->locals
, &var
->node
);
1619 /** creates a variable, sets a few defaults, and adds it to the list */
1620 nir_variable
*nir_variable_create(nir_shader
*shader
,
1621 nir_variable_mode mode
,
1622 const struct glsl_type
*type
,
1624 /** creates a local variable and adds it to the list */
1625 nir_variable
*nir_local_variable_create(nir_function_impl
*impl
,
1626 const struct glsl_type
*type
,
1629 /** creates a function and adds it to the shader's list of functions */
1630 nir_function
*nir_function_create(nir_shader
*shader
, const char *name
);
1632 /** creates a null function returning null */
1633 nir_function_overload
*nir_function_overload_create(nir_function
*func
);
1635 nir_function_impl
*nir_function_impl_create(nir_function_overload
*func
);
1637 nir_block
*nir_block_create(nir_shader
*shader
);
1638 nir_if
*nir_if_create(nir_shader
*shader
);
1639 nir_loop
*nir_loop_create(nir_shader
*shader
);
1641 nir_function_impl
*nir_cf_node_get_function(nir_cf_node
*node
);
1643 /** requests that the given pieces of metadata be generated */
1644 void nir_metadata_require(nir_function_impl
*impl
, nir_metadata required
);
1645 /** dirties all but the preserved metadata */
1646 void nir_metadata_preserve(nir_function_impl
*impl
, nir_metadata preserved
);
1648 /** creates an instruction with default swizzle/writemask/etc. with NULL registers */
1649 nir_alu_instr
*nir_alu_instr_create(nir_shader
*shader
, nir_op op
);
1651 nir_jump_instr
*nir_jump_instr_create(nir_shader
*shader
, nir_jump_type type
);
1653 nir_load_const_instr
*nir_load_const_instr_create(nir_shader
*shader
,
1654 unsigned num_components
);
1656 nir_intrinsic_instr
*nir_intrinsic_instr_create(nir_shader
*shader
,
1657 nir_intrinsic_op op
);
1659 nir_call_instr
*nir_call_instr_create(nir_shader
*shader
,
1660 nir_function_overload
*callee
);
1662 nir_tex_instr
*nir_tex_instr_create(nir_shader
*shader
, unsigned num_srcs
);
1664 nir_phi_instr
*nir_phi_instr_create(nir_shader
*shader
);
1666 nir_parallel_copy_instr
*nir_parallel_copy_instr_create(nir_shader
*shader
);
1668 nir_ssa_undef_instr
*nir_ssa_undef_instr_create(nir_shader
*shader
,
1669 unsigned num_components
);
1671 nir_deref_var
*nir_deref_var_create(void *mem_ctx
, nir_variable
*var
);
1672 nir_deref_array
*nir_deref_array_create(void *mem_ctx
);
1673 nir_deref_struct
*nir_deref_struct_create(void *mem_ctx
, unsigned field_index
);
1675 nir_deref
*nir_copy_deref(void *mem_ctx
, nir_deref
*deref
);
1677 nir_load_const_instr
*
1678 nir_deref_get_const_initializer_load(nir_shader
*shader
, nir_deref_var
*deref
);
1681 * NIR Cursors and Instruction Insertion API
1684 * A tiny struct representing a point to insert/extract instructions or
1685 * control flow nodes. Helps reduce the combinatorial explosion of possible
1686 * points to insert/extract.
1688 * \sa nir_control_flow.h
1691 nir_cursor_before_block
,
1692 nir_cursor_after_block
,
1693 nir_cursor_before_instr
,
1694 nir_cursor_after_instr
,
1695 } nir_cursor_option
;
1698 nir_cursor_option option
;
1705 static inline nir_cursor
1706 nir_before_block(nir_block
*block
)
1709 cursor
.option
= nir_cursor_before_block
;
1710 cursor
.block
= block
;
1714 static inline nir_cursor
1715 nir_after_block(nir_block
*block
)
1718 cursor
.option
= nir_cursor_after_block
;
1719 cursor
.block
= block
;
1723 static inline nir_cursor
1724 nir_before_instr(nir_instr
*instr
)
1727 cursor
.option
= nir_cursor_before_instr
;
1728 cursor
.instr
= instr
;
1732 static inline nir_cursor
1733 nir_after_instr(nir_instr
*instr
)
1736 cursor
.option
= nir_cursor_after_instr
;
1737 cursor
.instr
= instr
;
1741 static inline nir_cursor
1742 nir_after_block_before_jump(nir_block
*block
)
1744 nir_instr
*last_instr
= nir_block_last_instr(block
);
1745 if (last_instr
&& last_instr
->type
== nir_instr_type_jump
) {
1746 return nir_before_instr(last_instr
);
1748 return nir_after_block(block
);
1752 static inline nir_cursor
1753 nir_before_cf_node(nir_cf_node
*node
)
1755 if (node
->type
== nir_cf_node_block
)
1756 return nir_before_block(nir_cf_node_as_block(node
));
1758 return nir_after_block(nir_cf_node_as_block(nir_cf_node_prev(node
)));
1761 static inline nir_cursor
1762 nir_after_cf_node(nir_cf_node
*node
)
1764 if (node
->type
== nir_cf_node_block
)
1765 return nir_after_block(nir_cf_node_as_block(node
));
1767 return nir_before_block(nir_cf_node_as_block(nir_cf_node_next(node
)));
1770 static inline nir_cursor
1771 nir_before_cf_list(struct exec_list
*cf_list
)
1773 nir_cf_node
*first_node
= exec_node_data(nir_cf_node
,
1774 exec_list_get_head(cf_list
), node
);
1775 return nir_before_cf_node(first_node
);
1778 static inline nir_cursor
1779 nir_after_cf_list(struct exec_list
*cf_list
)
1781 nir_cf_node
*last_node
= exec_node_data(nir_cf_node
,
1782 exec_list_get_tail(cf_list
), node
);
1783 return nir_after_cf_node(last_node
);
1787 * Insert a NIR instruction at the given cursor.
1789 * Note: This does not update the cursor.
1791 void nir_instr_insert(nir_cursor cursor
, nir_instr
*instr
);
1794 nir_instr_insert_before(nir_instr
*instr
, nir_instr
*before
)
1796 nir_instr_insert(nir_before_instr(instr
), before
);
1800 nir_instr_insert_after(nir_instr
*instr
, nir_instr
*after
)
1802 nir_instr_insert(nir_after_instr(instr
), after
);
1806 nir_instr_insert_before_block(nir_block
*block
, nir_instr
*before
)
1808 nir_instr_insert(nir_before_block(block
), before
);
1812 nir_instr_insert_after_block(nir_block
*block
, nir_instr
*after
)
1814 nir_instr_insert(nir_after_block(block
), after
);
1818 nir_instr_insert_before_cf(nir_cf_node
*node
, nir_instr
*before
)
1820 nir_instr_insert(nir_before_cf_node(node
), before
);
1824 nir_instr_insert_after_cf(nir_cf_node
*node
, nir_instr
*after
)
1826 nir_instr_insert(nir_after_cf_node(node
), after
);
1830 nir_instr_insert_before_cf_list(struct exec_list
*list
, nir_instr
*before
)
1832 nir_instr_insert(nir_before_cf_list(list
), before
);
1836 nir_instr_insert_after_cf_list(struct exec_list
*list
, nir_instr
*after
)
1838 nir_instr_insert(nir_after_cf_list(list
), after
);
1841 void nir_instr_remove(nir_instr
*instr
);
1845 typedef bool (*nir_foreach_ssa_def_cb
)(nir_ssa_def
*def
, void *state
);
1846 typedef bool (*nir_foreach_dest_cb
)(nir_dest
*dest
, void *state
);
1847 typedef bool (*nir_foreach_src_cb
)(nir_src
*src
, void *state
);
1848 bool nir_foreach_ssa_def(nir_instr
*instr
, nir_foreach_ssa_def_cb cb
,
1850 bool nir_foreach_dest(nir_instr
*instr
, nir_foreach_dest_cb cb
, void *state
);
1851 bool nir_foreach_src(nir_instr
*instr
, nir_foreach_src_cb cb
, void *state
);
1853 nir_const_value
*nir_src_as_const_value(nir_src src
);
1854 bool nir_src_is_dynamically_uniform(nir_src src
);
1855 bool nir_srcs_equal(nir_src src1
, nir_src src2
);
1856 void nir_instr_rewrite_src(nir_instr
*instr
, nir_src
*src
, nir_src new_src
);
1857 void nir_instr_move_src(nir_instr
*dest_instr
, nir_src
*dest
, nir_src
*src
);
1858 void nir_if_rewrite_condition(nir_if
*if_stmt
, nir_src new_src
);
1859 void nir_instr_rewrite_dest(nir_instr
*instr
, nir_dest
*dest
,
1862 void nir_ssa_dest_init(nir_instr
*instr
, nir_dest
*dest
,
1863 unsigned num_components
, const char *name
);
1864 void nir_ssa_def_init(nir_instr
*instr
, nir_ssa_def
*def
,
1865 unsigned num_components
, const char *name
);
1866 void nir_ssa_def_rewrite_uses(nir_ssa_def
*def
, nir_src new_src
);
1868 /* visits basic blocks in source-code order */
1869 typedef bool (*nir_foreach_block_cb
)(nir_block
*block
, void *state
);
1870 bool nir_foreach_block(nir_function_impl
*impl
, nir_foreach_block_cb cb
,
1872 bool nir_foreach_block_reverse(nir_function_impl
*impl
, nir_foreach_block_cb cb
,
1874 bool nir_foreach_block_in_cf_node(nir_cf_node
*node
, nir_foreach_block_cb cb
,
1877 /* If the following CF node is an if, this function returns that if.
1878 * Otherwise, it returns NULL.
1880 nir_if
*nir_block_get_following_if(nir_block
*block
);
1882 nir_loop
*nir_block_get_following_loop(nir_block
*block
);
1884 void nir_index_local_regs(nir_function_impl
*impl
);
1885 void nir_index_global_regs(nir_shader
*shader
);
1886 void nir_index_ssa_defs(nir_function_impl
*impl
);
1887 unsigned nir_index_instrs(nir_function_impl
*impl
);
1889 void nir_index_blocks(nir_function_impl
*impl
);
1891 void nir_print_shader(nir_shader
*shader
, FILE *fp
);
1892 void nir_print_instr(const nir_instr
*instr
, FILE *fp
);
1894 nir_shader
* nir_shader_clone(void *mem_ctx
, const nir_shader
*s
);
1897 void nir_validate_shader(nir_shader
*shader
);
1898 void nir_metadata_set_validation_flag(nir_shader
*shader
);
1899 void nir_metadata_check_validation_flag(nir_shader
*shader
);
1901 static inline void nir_validate_shader(nir_shader
*shader
) { (void) shader
; }
1902 static inline void nir_metadata_set_validation_flag(nir_shader
*shader
) { (void) shader
; }
1903 static inline void nir_metadata_check_validation_flag(nir_shader
*shader
) { (void) shader
; }
1906 void nir_calc_dominance_impl(nir_function_impl
*impl
);
1907 void nir_calc_dominance(nir_shader
*shader
);
1909 nir_block
*nir_dominance_lca(nir_block
*b1
, nir_block
*b2
);
1910 bool nir_block_dominates(nir_block
*parent
, nir_block
*child
);
1912 void nir_dump_dom_tree_impl(nir_function_impl
*impl
, FILE *fp
);
1913 void nir_dump_dom_tree(nir_shader
*shader
, FILE *fp
);
1915 void nir_dump_dom_frontier_impl(nir_function_impl
*impl
, FILE *fp
);
1916 void nir_dump_dom_frontier(nir_shader
*shader
, FILE *fp
);
1918 void nir_dump_cfg_impl(nir_function_impl
*impl
, FILE *fp
);
1919 void nir_dump_cfg(nir_shader
*shader
, FILE *fp
);
1921 int nir_gs_count_vertices(const nir_shader
*shader
);
1923 bool nir_split_var_copies(nir_shader
*shader
);
1925 void nir_lower_var_copy_instr(nir_intrinsic_instr
*copy
, void *mem_ctx
);
1926 void nir_lower_var_copies(nir_shader
*shader
);
1928 bool nir_lower_global_vars_to_local(nir_shader
*shader
);
1930 bool nir_lower_locals_to_regs(nir_shader
*shader
);
1932 void nir_lower_outputs_to_temporaries(nir_shader
*shader
);
1934 void nir_assign_var_locations(struct exec_list
*var_list
,
1936 int (*type_size
)(const struct glsl_type
*));
1938 void nir_lower_io(nir_shader
*shader
,
1939 nir_variable_mode mode
,
1940 int (*type_size
)(const struct glsl_type
*));
1941 nir_src
*nir_get_io_indirect_src(nir_intrinsic_instr
*instr
);
1942 nir_src
*nir_get_io_vertex_index_src(nir_intrinsic_instr
*instr
);
1944 void nir_lower_vars_to_ssa(nir_shader
*shader
);
1946 bool nir_remove_dead_variables(nir_shader
*shader
);
1948 void nir_move_vec_src_uses_to_dest(nir_shader
*shader
);
1949 bool nir_lower_vec_to_movs(nir_shader
*shader
);
1950 void nir_lower_alu_to_scalar(nir_shader
*shader
);
1951 void nir_lower_load_const_to_scalar(nir_shader
*shader
);
1953 void nir_lower_phis_to_scalar(nir_shader
*shader
);
1955 void nir_lower_samplers(nir_shader
*shader
,
1956 const struct gl_shader_program
*shader_program
);
1958 bool nir_lower_system_values(nir_shader
*shader
);
1960 typedef struct nir_lower_tex_options
{
1962 * bitmask of (1 << GLSL_SAMPLER_DIM_x) to control for which
1963 * sampler types a texture projector is lowered.
1968 * If true, lower rect textures to 2D, using txs to fetch the
1969 * texture dimensions and dividing the texture coords by the
1970 * texture dims to normalize.
1975 * To emulate certain texture wrap modes, this can be used
1976 * to saturate the specified tex coord to [0.0, 1.0]. The
1977 * bits are according to sampler #, ie. if, for example:
1979 * (conf->saturate_s & (1 << n))
1981 * is true, then the s coord for sampler n is saturated.
1983 * Note that clamping must happen *after* projector lowering
1984 * so any projected texture sample instruction with a clamped
1985 * coordinate gets automatically lowered, regardless of the
1986 * 'lower_txp' setting.
1988 unsigned saturate_s
;
1989 unsigned saturate_t
;
1990 unsigned saturate_r
;
1991 } nir_lower_tex_options
;
1993 void nir_lower_tex(nir_shader
*shader
,
1994 const nir_lower_tex_options
*options
);
1996 void nir_lower_idiv(nir_shader
*shader
);
1998 void nir_lower_clip_vs(nir_shader
*shader
, unsigned ucp_enables
);
1999 void nir_lower_clip_fs(nir_shader
*shader
, unsigned ucp_enables
);
2001 void nir_lower_two_sided_color(nir_shader
*shader
);
2003 void nir_lower_atomics(nir_shader
*shader
,
2004 const struct gl_shader_program
*shader_program
);
2005 void nir_lower_to_source_mods(nir_shader
*shader
);
2007 bool nir_lower_gs_intrinsics(nir_shader
*shader
);
2009 bool nir_normalize_cubemap_coords(nir_shader
*shader
);
2011 void nir_live_ssa_defs_impl(nir_function_impl
*impl
);
2012 bool nir_ssa_defs_interfere(nir_ssa_def
*a
, nir_ssa_def
*b
);
2014 void nir_convert_to_ssa_impl(nir_function_impl
*impl
);
2015 void nir_convert_to_ssa(nir_shader
*shader
);
2017 /* If phi_webs_only is true, only convert SSA values involved in phi nodes to
2018 * registers. If false, convert all values (even those not involved in a phi
2019 * node) to registers.
2021 void nir_convert_from_ssa(nir_shader
*shader
, bool phi_webs_only
);
2023 bool nir_opt_algebraic(nir_shader
*shader
);
2024 bool nir_opt_algebraic_late(nir_shader
*shader
);
2025 bool nir_opt_constant_folding(nir_shader
*shader
);
2027 bool nir_opt_global_to_local(nir_shader
*shader
);
2029 bool nir_copy_prop(nir_shader
*shader
);
2031 bool nir_opt_cse(nir_shader
*shader
);
2033 bool nir_opt_dce(nir_shader
*shader
);
2035 bool nir_opt_dead_cf(nir_shader
*shader
);
2037 void nir_opt_gcm(nir_shader
*shader
);
2039 bool nir_opt_peephole_select(nir_shader
*shader
);
2041 bool nir_opt_remove_phis(nir_shader
*shader
);
2043 bool nir_opt_undef(nir_shader
*shader
);
2045 void nir_sweep(nir_shader
*shader
);
2047 nir_intrinsic_op
nir_intrinsic_from_system_value(gl_system_value val
);
2048 gl_system_value
nir_system_value_from_intrinsic(nir_intrinsic_op intrin
);